narya/src/java/com/threerings/crowd/chat/server/ChatProvider.java

//
// $Id: ChatProvider.java,v 1.20 2003/06/14 00:55:19 mdb Exp $

package com.threerings.crowd.chat.server;

import java.util.Iterator;

import com.threerings.util.MessageBundle;
import com.threerings.util.TimeUtil;

import com.threerings.presents.client.InvocationService.InvocationListener;
import com.threerings.presents.data.ClientObject;
import com.threerings.presents.dobj.DObjectManager;
import com.threerings.presents.dobj.MessageEvent;

import com.threerings.presents.server.InvocationException;
import com.threerings.presents.server.InvocationManager;
import com.threerings.presents.server.InvocationProvider;

import com.threerings.crowd.Log;
import com.threerings.crowd.data.BodyObject;
import com.threerings.crowd.data.OccupantInfo;
import com.threerings.crowd.data.PlaceObject;
import com.threerings.crowd.server.CrowdServer;

import com.threerings.crowd.chat.client.ChatService.TellListener;
import com.threerings.crowd.chat.data.ChatCodes;
import com.threerings.crowd.chat.data.UserMessage;

/**
 * The chat provider handles the server side of the chat-related
 * invocation services.
 */
public class ChatProvider
    implements ChatCodes, InvocationProvider
{
    /** The access control identifier for broadcast chat privileges. */
    public static final String BROADCAST_TOKEN = "crowd.chat.broadcast";

    /**
     * Initializes the chat services and registers a chat provider with
     * the invocation manager.
     */
    public static void init (InvocationManager invmgr, DObjectManager omgr)
    {
        _omgr = omgr;

        // register a chat provider with the invocation manager
        invmgr.registerDispatcher(new ChatDispatcher(
                                      new ChatProvider()), true);
    }

    /**
     * Processes a request from a client to deliver a tell message to
     * another client.
     */
    public void tell (ClientObject caller, String target, String message,
                      TellListener listener)
        throws InvocationException
    {
        // make sure the target user is online
        BodyObject tobj = CrowdServer.lookupBody(target);
        if (tobj == null) {
            throw new InvocationException(USER_NOT_ONLINE);
        }

        if (tobj.status == OccupantInfo.DISCONNECTED) {
            throw new InvocationException(MessageBundle.compose(
                USER_DISCONNECTED, TimeUtil.getTimeOrderString(
                System.currentTimeMillis() - tobj.statusTime,
                TimeUtil.SECOND)));
        }

        // deliver a tell notification to the target player
        BodyObject source = (BodyObject)caller;
        sendTellMessage(tobj, source.username, null, message);

        // let the teller know it went ok
        if (tobj.status == OccupantInfo.IDLE) {
            listener.tellSucceededIdle(
                System.currentTimeMillis() - tobj.statusTime);

        } else {
            // normal success
            listener.tellSucceeded();
        }
    }

    /**
     * Processes a {@link ClientService#broadcast} request.
     */
    public void broadcast (ClientObject caller, String message,
                           InvocationListener listener)
        throws InvocationException
    {
        BodyObject body = (BodyObject)caller;

        // make sure the requesting user has broadcast privileges
        if (!CrowdServer.actrl.checkAccess(body, BROADCAST_TOKEN)) {
            throw new InvocationException(CrowdServer.actrl.LACK_ACCESS);
        }

        Iterator iter = CrowdServer.plreg.enumeratePlaces();
        while (iter.hasNext()) {
            PlaceObject plobj = (PlaceObject)iter.next();
            SpeakProvider.sendSpeak(plobj, body.username, null,
                                    message, BROADCAST_MODE);
        }
    }

    /**
     * Delivers a tell notification to the specified target player,
     * originating with the specified speaker.
     *
     * @param target the body object of the user that will receive the
     * tell message.
     * @param speaker the username of the user that generated the message
     * (or some special speaker name for server messages).
     * @param bundle the bundle identifier that will be used by the client
     * to translate the message text (this would be null in all cases
     * except where the message originated from some server entity that
     * was "faking" a tell to a real player).
     * @param message the text of the chat message.
     */
    public static void sendTellMessage (
        BodyObject target, String speaker, String bundle, String message)
    {
        UserMessage msg =
            new UserMessage(message, bundle, speaker, DEFAULT_MODE);
        SpeakProvider.sendMessage(target, msg);

        // note that the teller "heard" what they said
        SpeakProvider.noteMessage(speaker, msg);
    }

    /** The distributed object manager used by the chat services. */
    protected static DObjectManager _omgr;
}