com.martinambrus.adminAnything.commands

Class Aa_mutecommand

java.lang.Object

com.martinambrus.adminAnything.commands.AbstractCommand

com.martinambrus.adminAnything.commands.Aa_mutecommand

All Implemented Interfaces:

org.bukkit.command.CommandExecutor

public class Aa_mutecommand
extends AbstractCommand

Command which mutes any possible output from the given executed command. The methodology here is a little complicated, so let's get into explanations here. First, all methods containing a call to the sendMessage() method are instrumented (i.e. changed in-memory), so we first check whether a muted command was run beforehand. If a muted command was run before just before sendMessage() was called, we simply cancel it. There is no way for us to know exactly which command has requested this because of the events system, so we have to mute everything until a certain time has passed. This timeout time is set to 1.5 seconds by default, which is by far enough to mute anything that should be trying to call sendMessage(). After this timeout is reached, we reset our internal status and will no longer be muting any commands up until another command that should be muted is run - at which point this whole circus starts over :-P

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	captureNextCommandSender Determined whether we should capture the name of the current class that calls sendMessage().
static boolean	lastClassMuted Determines whether the last class that called sendMessage() was muted.
static int	lastMuteTimestamp Determines how long ago has the last command that should be muted ran.
static LogFilter	logFilter This will hold a LogFilter that's used when we cannot run instrumentation for any reason.
static java.lang.String	newMutedClass Stores a name for the class which called a muted command.
static boolean	readyToRetransform Determines whether we're ready to start the instrumentation.
static boolean	retransformationTried Used to check whether we need to try to download the javassist library, if it's not present.
static boolean	retransformed Determines whether we've re-transformed any classes yet.

Constructor Summary

Constructors

Constructor and Description
Aa_mutecommand(org.bukkit.plugin.Plugin aa) Constructor, takes AdminAnything as a parameter, since we'll be needing it later to set up a delayed task (as not to overload server by all the action :P).

Method Summary

Modifier and Type	Method and Description
static void	checkIsClassMuted() Checks whether the previously saved class name should be muted and sets the internal variables accordingly.
boolean	onCommand(org.bukkit.command.CommandSender sender, org.bukkit.command.Command cmd, java.lang.String unused, java.lang.String[] args) /aa_muteCommand - mutes a command, so it won't broadcast any messaged to console or player chat
static void	retransformCBMC() Instruments CraftBukkit and Minecraft classes to enable us cancelling out the sendMessage() method calls from them as needed.
static void	setCurrentClassMuted() Sets previously saved class as one that should be muted.
static java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	transformations() Prepares a map of transformable classes that we need to check for on the server.
static void	verifyMuteCheckTimeout() Checks whether we're still within a timeout to mute all commands that call sendMessage() and sets the internal variables accordingly.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

lastMuteTimestamp

public static int lastMuteTimestamp

Determines how long ago has the last command that should be muted ran.

newMutedClass

public static java.lang.String newMutedClass

Stores a name for the class which called a muted command.

lastClassMuted

public static boolean lastClassMuted

Determines whether the last class that called sendMessage() was muted.

captureNextCommandSender

public static boolean captureNextCommandSender

Determined whether we should capture the name of the current class that calls sendMessage().

retransformed

public static boolean retransformed

Determines whether we've re-transformed any classes yet. This will be set to true after the first instrumentation, so we don't do this unnecessarily again and again.

retransformationTried

public static boolean retransformationTried

Used to check whether we need to try to download the javassist library, if it's not present.

readyToRetransform

public static boolean readyToRetransform

Determines whether we're ready to start the instrumentation.

logFilter

public static LogFilter logFilter

This will hold a LogFilter that's used when we cannot run instrumentation for any reason. It will not mute much but still can be used to mute at least some output.

Constructor Detail

Aa_mutecommand

public Aa_mutecommand(org.bukkit.plugin.Plugin aa)

Constructor, takes AdminAnything as a parameter, since we'll be needing it later to set up a delayed task (as not to overload server by all the action :P). Also starts the commandPreprocessor listener if it was not started yet, so our fixed, muted, disabled... commands can get pre-processed by AdminAnything.

Parameters:

aa - Instance of AdminAnything.

Method Detail

transformations

public static java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> transformations()

Prepares a map of transformable classes that we need to check for on the server.

Returns:

Returns a map of all transformable classes that we need to check for.

checkIsClassMuted

public static void checkIsClassMuted()

Checks whether the previously saved class name should be muted and sets the internal variables accordingly.

verifyMuteCheckTimeout

public static void verifyMuteCheckTimeout()

Checks whether we're still within a timeout to mute all commands that call sendMessage() and sets the internal variables accordingly.

setCurrentClassMuted

public static void setCurrentClassMuted()

Sets previously saved class as one that should be muted.

retransformCBMC

public static void retransformCBMC()

Instruments CraftBukkit and Minecraft classes to enable us cancelling out the sendMessage() method calls from them as needed.

onCommand

public boolean onCommand(org.bukkit.command.CommandSender sender,
                         org.bukkit.command.Command cmd,
                         java.lang.String unused,
                         java.lang.String[] args)

/aa_muteCommand - mutes a command, so it won't broadcast any messaged to console or player chat

Specified by:

onCommand in interface org.bukkit.command.CommandExecutor

Overrides:

onCommand in class AbstractCommand

Parameters:

sender - The player who is calling this command.

cmd - The actual command that is being executed.

unused - Name of the command which is being executed.

args - Any arguments passed to this command.

Returns:

Returns true if we can instrument server classes and use this command, false otherwise.