com.threerings.crowd.chat.client

Class ChatDirector

java.lang.Object

com.threerings.presents.client.BasicDirector

com.threerings.crowd.chat.client.ChatDirector

All Implemented Interfaces:

ChatCodes, LocationObserver, SessionObserver, InvocationCodes, ChangeListener, MessageListener

public class ChatDirector
extends BasicDirector
implements ChatCodes, LocationObserver, MessageListener

The chat director is the client side coordinator of all chat related services. It handles both place constrained chat as well as direct messaging.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ChatDirector.ChatterObserver An interface to receive information about the MAX_CHATTERS most recent users that we've been chatting with.
static interface	ChatDirector.ChatterValidator An interface for those who would like to validate whether usernames may be added to the chatter list.
static class	ChatDirector.CommandHandler Used to implement a slash command (e.g.

Field Summary

Fields inherited from interface com.threerings.crowd.chat.data.ChatCodes

BROADCAST_ACCESS, BROADCAST_MODE, CHAT_ACCESS, CHAT_CHANNEL_NOTIFICATION, CHAT_NOTIFICATION, DEFAULT_IDLE_TIME, DEFAULT_MODE, EMOTE_MODE, IDLE_TIME_KEY, LAST_MODE, PLACE_CHAT_TYPE, SHOUT_MODE, SUCCESS, THINK_MODE, USER_CHAT_TYPE, USER_DISCONNECTED, USER_NOT_ONLINE, XLATE_MODES

Fields inherited from interface com.threerings.presents.data.InvocationCodes

ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR

Constructor Summary

Constructors

Constructor and Description
ChatDirector(CrowdContext ctx, String bundle) Creates a chat director and initializes it with the supplied context.

Method Summary

Modifier and Type	Method and Description
void	addAuxiliarySource(DObject source, String localtype) Adds an additional object via which chat messages may arrive.
boolean	addChatDisplay(ChatDisplay display) Adds the supplied chat display to the end of the chat display list.
boolean	addChatFilter(ChatFilter filter) Adds the specified chat filter to the list of filters.
boolean	addChatterObserver(ChatDirector.ChatterObserver co) Adds an observer that watches the chatters list, and updates it immediately.
void	clearCommandHistory() Clear the chat command history.
void	clearDisplays() Requests that all chat displays clear their contents.
void	clientDidLogoff(Client client) Called after the client has been logged off of the server and has disconnected.
void	clientDidLogon(Client client) Called after the client successfully connected to and authenticated with the server.
void	clientObjectDidChange(Client client) For systems that allow switching screen names after logon, this method is called whenever a screen name change takes place to report that the client object has been replaced to potential client-side subscribers.
void	dispatchMessage(ChatMessage message, String localType) Dispatches the provided message to our chat displays.
void	displayAttention(String bundle, String message) Display a system ATTENTION message as if it had come from the server.
void	displayFeedback(String bundle, String message) Display a system FEEDBACK message as if it had come from the server.
void	displayInfo(String bundle, String message) Display a system INFO message as if it had come from the server.
void	displayInfo(String bundle, String message, String localtype) Display a system INFO message as if it had come from the server.
String	filter(String msg, Name otherUser, boolean outgoing) Run a message through all the currently registered filters.
String	getCommandHistory(int index) Get the chat history entry at the specified index, with 0 being the oldest.
int	getCommandHistorySize() Return the current size of the history.
HistoryList	getHistory() Returns the history list containing a trailing window of messages that have passed through this chat director.
void	locationChangeFailed(int placeId, String reason) This is called on all location observers when a location change request is rejected by the server or fails for some other reason.
void	locationDidChange(PlaceObject place) Called when we have switched to a new location.
boolean	locationMayChange(int placeId) Called when someone has requested that we switch to a new location.
void	messageReceived(MessageEvent event) Called when an message event has been dispatched on an object.
String	mogrifyChat(String text) Runs the supplied message through the various chat mogrifications.
void	pushChatDisplay(ChatDisplay display) Adds the supplied chat display to the front of the chat display list.
void	registerCommandHandler(com.threerings.util.MessageBundle msg, String command, ChatDirector.CommandHandler handler) Registers a chat command handler.
void	removeAuxiliarySource(DObject source) Removes a previously added auxiliary chat source.
boolean	removeChatDisplay(ChatDisplay display) Removes the specified chat display from the chat display list.
boolean	removeChatFilter(ChatFilter filter) Removes the specified chat filter from the list of chat filter.
boolean	removeChatterObserver(ChatDirector.ChatterObserver co) Removes an observer from the list of chatter observers.
void	requestBroadcast(String message) Requests to send a site-wide broadcast message.
String	requestChat(SpeakService speakSvc, String text, boolean record) Parses and delivers the supplied chat message.
void	requestSpeak(SpeakService speakService, String message, byte mode) Requests that a speak message with the specified mode be generated and delivered via the supplied speak service instance (which will be associated with a particular "speak object").
<T extends Name> void	requestTell(T target, String msg, ResultListener<T> rl) Requests that a tell message be delivered to the specified target user.
void	setAwayMessage(String message) Configures a message that will be automatically reported to anyone that sends a tell message to this client to indicate that we are busy or away from the keyboard.
void	setChatterValidator(ChatDirector.ChatterValidator validator) Sets the validator that decides if a username is valid to be added to the chatter list, or null if no such filtering is desired.
void	setMogrifyChat(boolean mogrifyChat) Enables or disables the chat mogrifier.

Methods inherited from class com.threerings.presents.client.BasicDirector

clientWillLogon, isAvailableInStandalone, setAvailableInStandalone

Methods inherited from class java.lang.Object

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

Constructor Detail

ChatDirector

public ChatDirector(CrowdContext ctx,
                    String bundle)

Creates a chat director and initializes it with the supplied context. The chat director will register itself as a location observer so that it can automatically process place constrained chat.

Parameters:

bundle - the message bundle from which we obtain our chat-related translation strings.

Method Detail

pushChatDisplay

public void pushChatDisplay(ChatDisplay display)

Adds the supplied chat display to the front of the chat display list. It will subsequently be notified of incoming chat messages as well as tell responses.

addChatDisplay

public boolean addChatDisplay(ChatDisplay display)

Adds the supplied chat display to the end of the chat display list. It will subsequently be notified of incoming chat messages as well as tell responses.

removeChatDisplay

public boolean removeChatDisplay(ChatDisplay display)

Removes the specified chat display from the chat display list. The display will no longer receive chat related notifications.

addChatFilter

public boolean addChatFilter(ChatFilter filter)

Adds the specified chat filter to the list of filters. All chat requests and receipts will be filtered with all filters before they being sent or dispatched locally.

removeChatFilter

public boolean removeChatFilter(ChatFilter filter)

Removes the specified chat filter from the list of chat filter.

addChatterObserver

public boolean addChatterObserver(ChatDirector.ChatterObserver co)

Adds an observer that watches the chatters list, and updates it immediately.

removeChatterObserver

public boolean removeChatterObserver(ChatDirector.ChatterObserver co)

Removes an observer from the list of chatter observers.

setChatterValidator

public void setChatterValidator(ChatDirector.ChatterValidator validator)

Sets the validator that decides if a username is valid to be added to the chatter list, or null if no such filtering is desired.

setMogrifyChat

public void setMogrifyChat(boolean mogrifyChat)

Enables or disables the chat mogrifier. The mogrifier converts chat speak like LOL, WTF, etc. into phrases, words and can also transform them into emotes. The mogrifier is configured via the x.mogrifies and x.transforms translation properties.

registerCommandHandler

public void registerCommandHandler(com.threerings.util.MessageBundle msg,
                                   String command,
                                   ChatDirector.CommandHandler handler)

Registers a chat command handler.

Parameters:

msg - the message bundle via which the slash command will be translated (as c.command). If no translation exists the command will be /command.

command - the name of the command that will be used to invoke this handler (e.g. tell if the command will be invoked as /tell).

handler - the chat command handler itself.

getCommandHistorySize

public int getCommandHistorySize()

Return the current size of the history.

getCommandHistory

public String getCommandHistory(int index)

Get the chat history entry at the specified index, with 0 being the oldest.

clearCommandHistory

public void clearCommandHistory()

Clear the chat command history.

clearDisplays

public void clearDisplays()

Requests that all chat displays clear their contents.

displayInfo

public void displayInfo(String bundle,
                        String message)

Display a system INFO message as if it had come from the server. The localtype of the message will be PLACE_CHAT_TYPE. Info messages are sent when something happens that was neither directly triggered by the user, nor requires direct action.

displayInfo

public void displayInfo(String bundle,
                        String message,
                        String localtype)

Display a system INFO message as if it had come from the server. Info messages are sent when something happens that was neither directly triggered by the user, nor requires direct action.

displayFeedback

public void displayFeedback(String bundle,
                            String message)

Display a system FEEDBACK message as if it had come from the server. The localtype of the message will be PLACE_CHAT_TYPE. Feedback messages are sent in direct response to a user action, usually to indicate success or failure of the user's action.

displayAttention

public void displayAttention(String bundle,
                             String message)

Display a system ATTENTION message as if it had come from the server. The localtype of the message will be PLACE_CHAT_TYPE. Attention messages are sent when something requires user action that did not result from direct action by the user.

dispatchMessage

public void dispatchMessage(ChatMessage message,
                            String localType)

Dispatches the provided message to our chat displays.

requestChat

public String requestChat(SpeakService speakSvc,
                          String text,
                          boolean record)

Parses and delivers the supplied chat message. Slash command processing and mogrification are performed and the message is added to the chat history if appropriate.

Parameters:

speakSvc - the SpeakService representing the target dobj of the speak or null if we should speak in the "default" way.

text - the text to be parsed and sent.

record - if text is a command, should it be added to the history?

Returns:

ChatCodes#SUCCESS if the message was parsed and sent correctly, a translatable error string if there was some problem.

requestSpeak

public void requestSpeak(SpeakService speakService,
                         String message,
                         byte mode)

Requests that a speak message with the specified mode be generated and delivered via the supplied speak service instance (which will be associated with a particular "speak object"). The message will first be validated by all registered ChatFilters (and possibly vetoed) before being dispatched.

Parameters:

speakService - the speak service to use when generating the speak request or null if we should speak in the current "place".

message - the contents of the speak message.

mode - a speech mode that will be interpreted by the ChatDisplay implementations that eventually display this speak message.

requestBroadcast

public void requestBroadcast(String message)

Requests to send a site-wide broadcast message.

Parameters:

message - the contents of the message.

requestTell

public <T extends Name> void requestTell(T target,
                                         String msg,
                                         ResultListener<T> rl)

Requests that a tell message be delivered to the specified target user.

Parameters:

target - the username of the user to which the tell message should be delivered.

msg - the contents of the tell message.

rl - an optional result listener if you'd like to be notified of success or failure.

setAwayMessage

public void setAwayMessage(String message)

Configures a message that will be automatically reported to anyone that sends a tell message to this client to indicate that we are busy or away from the keyboard.

addAuxiliarySource

public void addAuxiliarySource(DObject source,
                               String localtype)

Adds an additional object via which chat messages may arrive. The chat director assumes the caller will be managing the subscription to this object and will remain subscribed to it for as long as it remains in effect as an auxiliary chat source.

Parameters:

localtype - a type to be associated with all chat messages that arrive on the specified DObject.

removeAuxiliarySource

public void removeAuxiliarySource(DObject source)

Removes a previously added auxiliary chat source.

getHistory

public HistoryList getHistory()

Returns the history list containing a trailing window of messages that have passed through this chat director. The history list is created on demand so that systems which don't make use of chat history need not incur the overhead of tracking historical chat messages. Thus messages will only be added to the history after this method has been called at least once.

filter

public String filter(String msg,
                     Name otherUser,
                     boolean outgoing)

Run a message through all the currently registered filters.

mogrifyChat

public String mogrifyChat(String text)

Runs the supplied message through the various chat mogrifications.

locationMayChange

public boolean locationMayChange(int placeId)

Description copied from interface: LocationObserver

Called when someone has requested that we switch to a new location. An observer may choose to veto the location change request for some reason or other.

Specified by:

locationMayChange in interface LocationObserver

Returns:

true if it's OK for the location to change, false if the change request should be aborted.

locationDidChange

public void locationDidChange(PlaceObject place)

Description copied from interface: LocationObserver

Called when we have switched to a new location.

Specified by:

locationDidChange in interface LocationObserver

Parameters:

place - the place object that represents the new location or null if we have switched to no location.

locationChangeFailed

public void locationChangeFailed(int placeId,
                                 String reason)

Description copied from interface: LocationObserver

This is called on all location observers when a location change request is rejected by the server or fails for some other reason.

Specified by:

locationChangeFailed in interface LocationObserver

Parameters:

placeId - the place id to which we attempted to relocate, but failed.

reason - the reason code that explains why the location change request was rejected or otherwise failed.

messageReceived

public void messageReceived(MessageEvent event)

Description copied from interface: MessageListener

Called when an message event has been dispatched on an object.

Specified by:

messageReceived in interface MessageListener

Parameters:

event - The event that was dispatched on the object.

clientDidLogon

public void clientDidLogon(Client client)

Description copied from interface: SessionObserver

Called after the client successfully connected to and authenticated with the server. The entire object system is up and running by the time this method is called.

Specified by:

clientDidLogon in interface SessionObserver

Overrides:

clientDidLogon in class BasicDirector

clientObjectDidChange

public void clientObjectDidChange(Client client)

Description copied from interface: SessionObserver

For systems that allow switching screen names after logon, this method is called whenever a screen name change takes place to report that the client object has been replaced to potential client-side subscribers.

Specified by:

clientObjectDidChange in interface SessionObserver

Overrides:

clientObjectDidChange in class BasicDirector

clientDidLogoff

public void clientDidLogoff(Client client)

Description copied from interface: SessionObserver

Called after the client has been logged off of the server and has disconnected.

Specified by:

clientDidLogoff in interface SessionObserver

Overrides:

clientDidLogoff in class BasicDirector