Package com.planet_ink.coffee_mud.Libraries

Class CMEncoder

java.lang.Object

com.planet_ink.coffee_mud.Libraries.StdLibrary

com.planet_ink.coffee_mud.Libraries.CMEncoder

All Implemented Interfaces:

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

public class CMEncoder
extends StdLibrary
implements TextEncoders

Field Summary

Fields

Modifier and Type	Field	Description
protected static byte[]	encrFilter

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
CMEncoder()

Method Summary

Modifier and Type	Method	Description
protected boolean	checkHashStringPairs(java.lang.String hashString1, java.lang.String hashString2)
protected boolean	checkPasswordAgainstRandomHashString(java.lang.String passwordString, java.lang.String hashString)
byte[]	compressString(java.lang.String s)	Compress a string into a binary data buffer.
java.lang.String	decompressString(byte[] b)	Decompress a string from a binary data buffer.
protected byte[]	enDeCrypt(byte[] bytes)
java.lang.String	filterDecrypt(java.lang.String str)	Decrypts a weakly encrypted string.
java.lang.String	filterEncrypt(java.lang.String str)	Weakly encrypts a string.
java.lang.String	generateRandomPassword()	Generates a random 10 char password string.
static byte[]	getFilter()
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
protected boolean	isARandomHashString(java.lang.String password)
java.lang.String	makeFinalPasswordString(java.lang.String rawPassword)	Checks whether hash passwords are used, and if so, hashes the password and returns the encoded string, and otherwise, just returns the raw password back.
protected java.lang.String	makeRandomHashString(java.lang.String password)
java.lang.String	makeRepeatableHashString(java.lang.String str)	Hashes the given string and returns an encoding of it.
boolean	passwordCheck(java.lang.String pass1, java.lang.String pass2)	Compares two passwords to see if they are the same.

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, initializeClass, 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, initializeClass, L, name, newInstance, propertiesLoaded, setThreadStatus, shutdown, tick

Field Detail

encrFilter

protected static byte[] encrFilter

Constructor Detail

CMEncoder

public CMEncoder()

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

decompressString

public java.lang.String decompressString(byte[] b)

Description copied from interface: TextEncoders

Decompress a string from a binary data buffer.

Specified by:

decompressString in interface TextEncoders

Parameters:

b - the compressed data buffer

Returns:

the uncompressed string

See Also:

TextEncoders.compressString(String)

compressString

public byte[] compressString(java.lang.String s)

Description copied from interface: TextEncoders

Compress a string into a binary data buffer.

Specified by:

compressString in interface TextEncoders

Parameters:

s - the uncompressed string

Returns:

the compressed data buffer

See Also:

TextEncoders.decompressString(byte[])

makeRandomHashString

protected java.lang.String makeRandomHashString(java.lang.String password)

makeFinalPasswordString

public java.lang.String makeFinalPasswordString(java.lang.String rawPassword)

Description copied from interface: TextEncoders

Checks whether hash passwords are used, and if so, hashes the password and returns the encoded string, and otherwise, just returns the raw password back.

Specified by:

makeFinalPasswordString in interface TextEncoders

Parameters:

rawPassword - the raw password straight from the user

Returns:

the final password to store

makeRepeatableHashString

public java.lang.String makeRepeatableHashString(java.lang.String str)

Description copied from interface: TextEncoders

Hashes the given string and returns an encoding of it.

Specified by:

makeRepeatableHashString in interface TextEncoders

Parameters:

str - the string to encode

Returns:

the encoded string

isARandomHashString

protected boolean isARandomHashString(java.lang.String password)

checkPasswordAgainstRandomHashString

protected boolean checkPasswordAgainstRandomHashString(java.lang.String passwordString,
                                                       java.lang.String hashString)

checkHashStringPairs

protected boolean checkHashStringPairs(java.lang.String hashString1,
                                       java.lang.String hashString2)

generateRandomPassword

public java.lang.String generateRandomPassword()

Description copied from interface: TextEncoders

Generates a random 10 char password string. Not encoded or anything.

Specified by:

generateRandomPassword in interface TextEncoders

Returns:

a random password string

passwordCheck

public boolean passwordCheck(java.lang.String pass1,
                             java.lang.String pass2)

Description copied from interface: TextEncoders

Compares two passwords to see if they are the same. It does not matter which is which, or which is encoded and which is not, or anything else. This Just Works.

Specified by:

passwordCheck in interface TextEncoders

Parameters:

pass1 - one of the passwords

pass2 - the other password

Returns:

true if they match, false otherwise

getFilter

public static byte[] getFilter()

enDeCrypt

protected byte[] enDeCrypt(byte[] bytes)

filterEncrypt

public java.lang.String filterEncrypt(java.lang.String str)

Description copied from interface: TextEncoders

Weakly encrypts a string.

Specified by:

filterEncrypt in interface TextEncoders

Parameters:

str - the string to encrypt

Returns:

the encrypted string

See Also:

TextEncoders.filterDecrypt(String)

filterDecrypt

public java.lang.String filterDecrypt(java.lang.String str)

Description copied from interface: TextEncoders

Decrypts a weakly encrypted string.

Specified by:

filterDecrypt in interface TextEncoders

Parameters:

str - the string to decrypt

Returns:

the original string

See Also:

TextEncoders.filterEncrypt(String), TextEncoders.filterDecrypt(String)