Package com.planet_ink.coffee_mud.Libraries

Class CoffeeFilter

java.lang.Object

com.planet_ink.coffee_mud.Libraries.StdLibrary

com.planet_ink.coffee_mud.Libraries.CoffeeFilter

All Implemented Interfaces:

CMObject, Tickable, CMLibrary, TelnetFilter, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class CoffeeFilter
extends StdLibrary
implements TelnetFilter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CoffeeFilter.Pronoun	One of the most useful enum in the game, listing the pronoun conversions that are correctly rendered at runtime by context.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	hexStr

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

idConverter

Fields inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary

isDebugging, name, serviceClient, tickStatus

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.Tickable

STATUS_AFFECT, STATUS_ALIVE, STATUS_BEHAVIOR, STATUS_CLASS, STATUS_DEAD, STATUS_END, STATUS_FIGHT, STATUS_MISC, STATUS_MISC2, STATUS_MISC3, STATUS_MISC4, STATUS_MISC5, STATUS_MISC6, STATUS_MISC7, STATUS_NOT, STATUS_OTHER, STATUS_RACE, STATUS_REBIRTH, STATUS_SCRIPT, STATUS_START, STATUS_WEATHER, TICKID_AREA, TICKID_BALLISTICK, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, TICKID_EVENT, TICKID_EXIT_BEHAVIOR, TICKID_EXIT_REOPEN, TICKID_ITEM_BEHAVIOR, TICKID_ITEM_BOUNCEBACK, TICKID_LIGHT_FLICKERS, TICKID_LIVEAUCTION, TICKID_LONGERMASK, TICKID_MISCELLANEOUS, TICKID_MOB, TICKID_PROPERTY_SPECIAL, TICKID_QUEST, TICKID_READYTOSTOP, TICKID_ROOM_BEHAVIOR, TICKID_ROOM_ITEM_REJUV, TICKID_SHORTERMASK, TICKID_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET

Constructor Summary

Constructors

Constructor	Description
CoffeeFilter()

Method Summary

Modifier and Type	Method	Description
java.lang.String	colorOnlyFilter(java.lang.String msg, Session S)	Does MXP and normal CM ^ color codes, and that's about it.
protected int	convertEscape(Session S, java.lang.StringBuffer str, int index)
java.lang.String	fullInFilter(java.lang.String input)	Safety filter for user input.
java.lang.String	fullOutFilter(Session S, MOB mob, Physical source, Environmental target, Environmental tool, java.lang.String msg, boolean wrapOnly)	The real workhorse of this library, which does ALL filtering, including word wrap, MXP and MSP tags, % and \\ escape codes, pronoun tags, (s), and all the rest.
protected java.lang.String	getLastWord(java.lang.StringBuffer buf, int lastSp, int lastSpace)
java.util.Set<java.lang.String>	getPronounSuffixes()	Returns the suffix strings for the various pronoun tags.
protected java.util.Map<java.lang.String,CoffeeFilter.Pronoun>	getPronounTagTable()
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
void	initializeClass()	Called ONCE after all objects are loaded, but before the map is read in during initialization.
java.lang.String	mxpSafetyFilter(java.lang.String msg, Session S)	Does MXP tag correction if MXP is on, and that's it.
java.lang.String	safetyInFilter(java.lang.String s)	Removes carriage returns, linefeeds, and converts ' to `
java.lang.String	secondaryUserInputFilter(java.lang.String s)	Converts pronoun tags and at-sign variables to neutral characters, rendering them useless.
java.lang.String	simpleInFilter(java.lang.StringBuilder input)	Safety filter for user input.
java.lang.String	simpleInFilter(java.lang.StringBuilder input, boolean permitMXPTags, boolean isArchon)	Safety filter for user input.
java.lang.String	simpleOutFilter(java.lang.String msg)	Simplest, least things done filter.
java.lang.String[]	wrapOnlyFilter(java.lang.String msg, int wrap)	Does word wrapping, % and backslash \\ escape codes.

Methods inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CMLibrary

activate, getServiceClient, L, propertiesLoaded, shutdown

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

copyOf, name, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from class java.lang.Object

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

Methods inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary

activate, checkDatabase, compareTo, copyOf, getServiceClient, getTickStatus, L, name, newInstance, propertiesLoaded, setThreadStatus, shutdown, tick

Field Detail

hexStr

public static final java.lang.String hexStr

See Also:

Constant Field Values

Constructor Detail

CoffeeFilter

public CoffeeFilter()

Method Detail

ID

public java.lang.String ID()

Description copied from interface: CMObject

The CoffeeMud Java Class ID shared by all instances of this object. Unlike the Java Class name, this method does not include package information. However, it must return a String value unique to its class category in the ClassLoader. Class categories include Libraries, Common, Areas, Abilities, Behaviors, CharClasses, Commands, Exits Locales, MOBS, Races, WebMacros, Basic Items, Armor, Weapons, ClanItems, Tech. The name is typically identical to the class name.

Specified by:

ID in interface CMObject

Overrides:

ID in class StdLibrary

Returns:

the name of this class

initializeClass

public void initializeClass()

Description copied from interface: CMObject

Called ONCE after all objects are loaded, but before the map is read in during initialization.

Specified by:

initializeClass in interface CMObject

Overrides:

initializeClass in class StdLibrary

getPronounTagTable

protected java.util.Map<java.lang.String,CoffeeFilter.Pronoun> getPronounTagTable()

getPronounSuffixes

public java.util.Set<java.lang.String> getPronounSuffixes()

Description copied from interface: TelnetFilter

Returns the suffix strings for the various pronoun tags. These are like -NAME and -HE-SHE, without the prefix STO.

Specified by:

getPronounSuffixes in interface TelnetFilter

Returns:

the suffix strings

simpleOutFilter

public java.lang.String simpleOutFilter(java.lang.String msg)

Description copied from interface: TelnetFilter

Simplest, least things done filter. Only does ', and backslash \ escape codes (\n)

Specified by:

simpleOutFilter in interface TelnetFilter

Parameters:

msg - the filtered message

Returns:

the filtered message

wrapOnlyFilter

public java.lang.String[] wrapOnlyFilter(java.lang.String msg,
                                         int wrap)

Description copied from interface: TelnetFilter

Does word wrapping, % and backslash \\ escape codes. Removes most other things entirely.

Specified by:

wrapOnlyFilter in interface TelnetFilter

Parameters:

msg - the string to filter

wrap - the column to wrap at

Returns:

the lines of the final message

secondaryUserInputFilter

public java.lang.String secondaryUserInputFilter(java.lang.String s)

Description copied from interface: TelnetFilter

Converts pronoun tags and at-sign variables to neutral characters, rendering them useless.

Specified by:

secondaryUserInputFilter in interface TelnetFilter

Parameters:

s - the input string to filter

Returns:

the filtered string

convertEscape

protected int convertEscape(Session S,
                            java.lang.StringBuffer str,
                            int index)

colorOnlyFilter

public java.lang.String colorOnlyFilter(java.lang.String msg,
                                        Session S)

Description copied from interface: TelnetFilter

Does MXP and normal CM ^ color codes, and that's about it. no word-wrapping, text filtering or ('\','n') to '\n' translations

Specified by:

colorOnlyFilter in interface TelnetFilter

Parameters:

msg - the message to translate

S - null, or the session object, for color codes

Returns:

the filtered message

mxpSafetyFilter

public java.lang.String mxpSafetyFilter(java.lang.String msg,
                                        Session S)

Description copied from interface: TelnetFilter

Does MXP tag correction if MXP is on, and that's it. Nothing else. No word wrapping, coloring, anything.

Specified by:

mxpSafetyFilter in interface TelnetFilter

Parameters:

msg - the string to translate

S - null, or the session for MXP status

Returns:

the filtered string

getLastWord

protected java.lang.String getLastWord(java.lang.StringBuffer buf,
                                       int lastSp,
                                       int lastSpace)

fullOutFilter

public java.lang.String fullOutFilter(Session S,
                                      MOB mob,
                                      Physical source,
                                      Environmental target,
                                      Environmental tool,
                                      java.lang.String msg,
                                      boolean wrapOnly)

Description copied from interface: TelnetFilter

The real workhorse of this library, which does ALL filtering, including word wrap, MXP and MSP tags, % and \\ escape codes, pronoun tags, (s), and all the rest.

Specified by:

fullOutFilter in interface TelnetFilter

Parameters:

S - null, or the session for wrap, tags, other info

mob - the mob who will see the message

source - the source for S-pronouns

target - the target for T-pronouns

tool - the tool for O-pronouns

msg - the string to filter

wrapOnly - true to skip pronouns, and (s)

Returns:

the fully filtered string

simpleInFilter

public java.lang.String simpleInFilter(java.lang.StringBuilder input)

Description copied from interface: TelnetFilter

Safety filter for user input. Does the ' conversion, % escape codes, and checks for mxp input and does not permit them.

Specified by:

simpleInFilter in interface TelnetFilter

Parameters:

input - the input string

Returns:

the filtered input

simpleInFilter

public java.lang.String simpleInFilter(java.lang.StringBuilder input,
                                       boolean permitMXPTags,
                                       boolean isArchon)

Description copied from interface: TelnetFilter

Safety filter for user input. Does the ' conversion, % escape codes, and checks for mxp input.

Specified by:

simpleInFilter in interface TelnetFilter

Parameters:

input - the input string

permitMXPTags - true to allow mxp tags from users

isArchon - true to allow certain escape codes from users

Returns:

the filtered input

fullInFilter

public java.lang.String fullInFilter(java.lang.String input)

Description copied from interface: TelnetFilter

Safety filter for user input. Does the ' conversion, % escape codes, and checks for mxp input and does not permit them. It also converts 10 and 13 to backslash escape codes.

Specified by:

fullInFilter in interface TelnetFilter

Parameters:

input - the input string

Returns:

the filtered input

safetyInFilter

public java.lang.String safetyInFilter(java.lang.String s)

Description copied from interface: TelnetFilter

Removes carriage returns, linefeeds, and converts ' to `

Specified by:

safetyInFilter in interface TelnetFilter

Parameters:

s - the string to filter

Returns:

the filtered string