narya/src/java/com/threerings/crowd/client/LocationDirector.java

//
// $Id$
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
// http://www.threerings.net/code/narya/
//
// This library is free software; you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License as published
// by the Free Software Foundation; either version 2.1 of the License, or
// (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

package com.threerings.crowd.client;

import com.samskivert.util.ObserverList;
import com.samskivert.util.ObserverList.ObserverOp;
import com.samskivert.util.ResultListener;

import com.threerings.presents.client.BasicDirector;
import com.threerings.presents.client.Client;

import com.threerings.presents.dobj.DObject;
import com.threerings.presents.dobj.ObjectAccessException;
import com.threerings.presents.dobj.Subscriber;

import com.threerings.crowd.Log;
import com.threerings.crowd.data.BodyObject;
import com.threerings.crowd.data.LocationCodes;
import com.threerings.crowd.data.PlaceConfig;
import com.threerings.crowd.data.PlaceObject;
import com.threerings.crowd.util.CrowdContext;

/**
 * The location director provides a means by which entities on the client
 * can request to move from place to place and can be notified if other
 * entities have caused the client to move to a new place. It also
 * provides a mechanism for ratifying a request to move to a new place
 * before actually issuing the request.
 */
public class LocationDirector extends BasicDirector
    implements LocationCodes, Subscriber, LocationReceiver,
               LocationService.MoveListener
{
    /**
     * Used to recover from a moveTo request that was accepted but
     * resulted in a failed attempt to fetch the place object to which we
     * were moving.
     */
    public static interface FailureHandler
    {
        /**
         * Should instruct the client to move to the last known working
         * location (as well as clean up after the failed moveTo request).
         */
        public void recoverFailedMove (int placeId);
    }

    /**
     * Constructs a location director which will configure itself for
     * operation using the supplied context.
     */
    public LocationDirector (CrowdContext ctx)
    {
        super(ctx);

        // keep this around for later
        _ctx = ctx;

        // register for location notifications
        _ctx.getClient().getInvocationDirector().registerReceiver(
            new LocationDecoder(this));
    }

    /**
     * Adds a location observer to the list. This observer will
     * subsequently be notified of potential, effected and failed location
     * changes.
     */
    public void addLocationObserver (LocationObserver observer)
    {
        _observers.add(observer);
    }

    /**
     * Removes a location observer from the list.
     */
    public void removeLocationObserver (LocationObserver observer)
    {
        _observers.remove(observer);
    }

    /**
     * Returns the place object for the location we currently occupy or
     * null if we're not currently occupying any location.
     */
    public PlaceObject getPlaceObject ()
    {
        return _plobj;
    }

    /**
     * Returns true if there is a pending move request.
     */
    public boolean movePending ()
    {
        return (_pendingPlaceId > 0);
    }

    /**
     * Requests that this client be moved to the specified place. A
     * request will be made and when the response is received, the
     * location observers will be notified of success or failure.
     *
     * @return true if the move to request was issued, false if it was
     * rejected by a location observer or because we have another request
     * outstanding.
     */
    public boolean moveTo (int placeId)
    {
        // make sure the placeId is valid
        if (placeId < 0) {
            Log.warning("Refusing moveTo(): invalid placeId " + placeId + ".");
            return false;
        }

        // first check to see if our observers are happy with this move
        // request
        if (!mayMoveTo(placeId, null)) {
            return false;
        }

        // we need to call this both to mark that we're issuing a move
        // request and to check to see if the last issued request should
        // be considered stale
        boolean refuse = checkRepeatMove();

        // complain if we're over-writing a pending request
        if (_pendingPlaceId != -1) {
            // if the pending request has been outstanding more than a
            // minute, go ahead and let this new one through in an attempt
            // to recover from dropped moveTo requests
            if (refuse) {
                Log.warning("Refusing moveTo; We have a request outstanding " +
                            "[ppid=" + _pendingPlaceId +
                            ", npid=" + placeId + "].");
                return false;

            } else {
                Log.warning("Overriding stale moveTo request " +
                            "[ppid=" + _pendingPlaceId +
                            ", npid=" + placeId + "].");
            }
        }

        // make a note of our pending place id
        _pendingPlaceId = placeId;

        // issue a moveTo request
        Log.info("Issuing moveTo(" + placeId + ").");
        _lservice.moveTo(_ctx.getClient(), placeId, this);
        return true;
    }

    /**
     * Requests to move to the room that we last occupied, if such a room
     * exists.
     *
     * @return true if we had a previous room and we requested to move to
     * it, false if we had no previous room.
     */
    public boolean moveBack ()
    {
        if (_previousPlaceId == -1) {
            return false;

        } else {
            moveTo(_previousPlaceId);
            return true;
        }
    }

    /**
     * This can be called by cooperating directors that need to coopt the
     * moving process to extend it in some way or other. In such
     * situations, they should call this method before moving to a new
     * location to check to be sure that all of the registered location
     * observers are amenable to a location change.
     *
     * @param placeId the place oid of our tentative new location.
     *
     * @return true if everyone is happy with the move, false if it was
     * vetoed by one of the location observers.
     */
    public boolean mayMoveTo (final int placeId, ResultListener rl)
    {
        final boolean[] vetoed = new boolean[1];
        _observers.apply(new ObserverOp() {
            public boolean apply (Object obs) {
                LocationObserver lobs = (LocationObserver)obs;
                vetoed[0] = (vetoed[0] || !lobs.locationMayChange(placeId));
                return true;
            }
        });

        // if we're actually going somewhere, let the controller know that
        // we might be leaving
        mayLeavePlace();

        // if we have a result listener, let it know if we failed
        // or keep it for later if we're still going
        if (rl != null) {
            if (vetoed[0]) {
                rl.requestFailed(new MoveVetoedException());
            } else {
                _moveListener = rl;
            }
        }
        // and return the result
        return !vetoed[0];
    }

    /**
     * Called to inform our controller that we may be leaving the current
     * place.
     */
    protected void mayLeavePlace ()
    {
        if (_controller != null) {
            try {
                _controller.mayLeavePlace(_plobj);
            } catch (Exception e) {
                Log.warning("Place controller choked in " +
                            "mayLeavePlace [plobj=" + _plobj + "].");
                Log.logStackTrace(e);
            }
        }
    }

    /**
     * This can be called by cooperating directors that need to coopt the
     * moving process to extend it in some way or other. In such
     * situations, they will be responsible for receiving the successful
     * move response and they should let the location director know that
     * the move has been effected.
     *
     * @param placeId the place oid of our new location.
     * @param config the configuration information for the new place.
     */
    public void didMoveTo (int placeId, PlaceConfig config)
    {
        if (_moveListener != null) {
            _moveListener.requestCompleted(config);
            _moveListener = null;
        }

        // keep track of our previous place id
        _previousPlaceId = _placeId;

        // clear out our last request time
        _lastRequestTime = 0;

        // do some cleaning up in case we were previously in a place
        didLeavePlace();

        // make a note that we're now mostly in the new location
        _placeId = placeId;

        // check whether we should use a custom class loader
        ClassLoader loader = getClassLoader(config);
        if (loader != null) {
            config.setClassLoader(loader);
        }

        Class cclass = config.getControllerClass();
        try {
            // start up a new place controller to manage the new place
            _controller = (PlaceController)cclass.newInstance();
            _controller.init(_ctx, config);

        } catch (Exception e) {
            Log.warning("Error creating or initializing place controller " +
                        "[cclass=" + cclass.getName() +
                        ", config=" + config + "].");
            Log.logStackTrace(e);
        }

        // subscribe to our new place object to complete the move
        _ctx.getDObjectManager().subscribeToObject(_placeId, this);
    }

    /**
     * Called when we're leaving our current location. Informs the
     * location's controller that we're departing, unsubscribes from the
     * location's place object, and clears out our internal place
     * information.
     */
    public void didLeavePlace ()
    {
        if (_plobj != null) {
            // let the old controller know that things are going away
            if (_controller != null) {
                try {
                    _controller.didLeavePlace(_plobj);
                } catch (Exception e) {
                    Log.warning("Place controller choked in " +
                                "didLeavePlace [plobj=" + _plobj + "].");
                    Log.logStackTrace(e);
                }
                _controller = null;
            }

            // unsubscribe from our old place object
            _ctx.getDObjectManager().unsubscribeFromObject(
                _plobj.getOid(), this);
            _plobj = null;

            // and clear out the associated place id
            _placeId = -1;
        }
    }

    /**
     * This can be called by cooperating directors that need to coopt the
     * moving process to extend it in some way or other. If the coopted
     * move request fails, this failure can be propagated to the location
     * observers if appropriate.
     *
     * @param placeId the place oid to which we failed to move.
     * @param reason the reason code given for failure.
     */
    public void failedToMoveTo (int placeId, String reason)
    {
        if (_moveListener != null) {
            _moveListener.requestFailed(new MoveFailedException(reason));
            _moveListener = null;
        }

        // clear out our last request time
        _lastRequestTime = 0;

        // let our observers know what's up
        notifyFailure(placeId, reason);
    }

    /**
     * Called to test and set a time stamp that we use to determine if a
     * pending moveTo request is stale.
     */
    public boolean checkRepeatMove ()
    {
        long now = System.currentTimeMillis();
        if (now - _lastRequestTime < STALE_REQUEST_DURATION) {
            return true;

        } else {
            _lastRequestTime = now;
            return false;
        }
    }

    // documentation inherited from interface
    public void clientDidLogon (Client client)
    {
        super.clientDidLogon(client);

        // subscribe to our body object
        Subscriber sub = new Subscriber() {
            public void objectAvailable (DObject object)
            {
                gotBodyObject((BodyObject)object);
            }

            public void requestFailed (int oid, ObjectAccessException cause)
            {
                Log.warning("Location director unable to fetch body " +
                            "object; all has gone horribly wrong" +
                            "[cause=" + cause + "].");
            }
        };
        int cloid = client.getClientOid();
        client.getDObjectManager().subscribeToObject(cloid, sub);
    }

    // documentation inherited from interface
    public void clientDidLogoff (Client client)
    {
        super.clientDidLogoff(client);

        // clear ourselves out and inform observers of our departure
        mayLeavePlace();
        didLeavePlace();

        // let our observers know that we're no longer in a location
        _observers.apply(_didChangeOp);

        // clear out everything else (it's possible that we were logged
        // off in the middle of a change location request)
        _pendingPlaceId = -1;
        _previousPlaceId = -1;
        _lastRequestTime = 0L;
        _lservice = null;
    }

    // documentation inherited
    protected void fetchServices (Client client)
    {
        // obtain our service handle
        _lservice = (LocationService)
            client.requireService(LocationService.class);
    }

    protected void gotBodyObject (BodyObject clobj)
    {
        // check to see if we are already in a location, in which case
        // we'll want to be going there straight away
    }

    // documentation inherited from interface
    public void moveSucceeded (PlaceConfig config)
    {
        // handle the successful move
        didMoveTo(_pendingPlaceId, config);

        // and clear out the tracked pending oid
        _pendingPlaceId = -1;
    }

    // documentation inherited from interface
    public void requestFailed (String reason)
    {
        // clear out our pending request oid
        int placeId = _pendingPlaceId;
        _pendingPlaceId = -1;

        Log.info("moveTo failed [pid=" + placeId +
                 ", reason=" + reason + "].");

        // let our observers know that something has gone horribly awry
        notifyFailure(placeId, reason);
    }

    // documentation inherited from interface
    public void forcedMove (final int placeId)
    {
        Log.info("Moving at request of server [placeId=" + placeId + "].");

        if (movePending()) {
            // clear out our old place information
            mayLeavePlace();
            didLeavePlace();

            // move to the new place
            moveTo(placeId);
        }
    }

    /**
     * Called when we receive the place object to which we subscribed
     * after a successful moveTo request.
     */
    public void objectAvailable (DObject object)
    {
        // yay, we have our new place object
        _plobj = (PlaceObject)object;

        // let the place controller know that we're ready to roll
        if (_controller != null) {
            try {
                _controller.willEnterPlace(_plobj);
            } catch (Exception e) {
                Log.warning("Controller choked in willEnterPlace " +
                            "[place=" + _plobj + "].");
                Log.logStackTrace(e);
            }
        }

        // let our observers know that all is well on the western front
        _observers.apply(_didChangeOp);
    }

    /**
     * Called if we are unable to subscribe to the place object that was
     * provided to us with our successful moveTo request. This is
     * generally a bad scene and we do our best to recover by going back
     * to the previously known location.
     */
    public void requestFailed (int oid, ObjectAccessException cause)
    {
        // aiya! we were unable to fetch our new place object; something
        // is badly wrong
        Log.warning("Aiya! Unable to fetch place object for new location " +
                    "[plid=" + oid + ", reason=" + cause + "].");

        // clear out our half initialized place info
        int placeId = _placeId;
        _placeId = -1;

        // let the kids know shit be fucked
        notifyFailure(placeId, "m.unable_to_fetch_place_object");

        // we need to sort out what to do about the half-initialized place
        // controller. presently we punt and hope that calling
        // didLeavePlace() without ever having called willEnterPlace()
        // does whatever's necessary

        // try to return to our previous location
        if (_failureHandler != null) {
            _failureHandler.recoverFailedMove(placeId);

        } else {
            // if we were previously somewhere (and that somewhere isn't
            // where we just tried to go), try going back to that happy
            // place
            if (_previousPlaceId != -1 && _previousPlaceId != placeId) {
                moveTo(_previousPlaceId);
            }
        }
    }

    /**
     * Sets the failure handler which will recover from place object
     * fetching failures. In the event that we are unable to fetch our
     * place object after making a successful moveTo request, we attempt
     * to rectify the failure by moving back to the last known working
     * location. Because entites that cooperate with the location director
     * may need to become involved in this failure recovery, we provide
     * this interface whereby they can interject themseves into the
     * failure recovery process and do their own failure recovery.
     */
    public void setFailureHandler (FailureHandler handler)
    {
        if (_failureHandler != null) {
            Log.warning("Requested to set failure handler, but we've " +
                        "already got one. The conflicting entities will " +
                        "likely need to perform more sophisticated " +
                        "coordination to deal with failures. " +
                        "[old=" + _failureHandler + ", new=" + handler + "].");

        } else {
            _failureHandler = handler;
        }
    }

    protected void notifyFailure (final int placeId, final String reason)
    {
        _observers.apply(new ObserverOp() {
            public boolean apply (Object obs) {
                ((LocationObserver)obs).locationChangeFailed(placeId, reason);
                return true;
            }
        });
    }

    /**
     * By overriding this method, it is possible to customize the location
     * director to cause it to load the classes associated with a
     * particular place via a custom class loader. That loader may enforce
     * restricted privileges or obtain the classes from some special
     * source.
     */
    protected ClassLoader getClassLoader (PlaceConfig config)
    {
        return null;
    }

    /** The context through which we access needed services. */
    protected CrowdContext _ctx;

    /** Provides access to location services. */
    protected LocationService _lservice;

    /** Our location observer list. */
    protected ObserverList _observers =
        new ObserverList(ObserverList.SAFE_IN_ORDER_NOTIFY);

    /** The oid of the place we currently occupy. */
    protected int _placeId = -1;

    /** The place object that we currently occupy. */
    protected PlaceObject _plobj;

    /** The place controller in effect for our current place. */
    protected PlaceController _controller;

    /**
     * The oid of the place for which we have an outstanding moveTo
     * request, or -1 if we have no outstanding request.
     */
    protected int _pendingPlaceId = -1;

    /** The oid of the place we previously occupied. */
    protected int _previousPlaceId = -1;

    /** The last time we requested a move to. */
    protected long _lastRequestTime;

    /** The entity that deals when we fail to subscribe to a place
     * object. */
    protected FailureHandler _failureHandler;

    /** A listener that wants to know if we succeeded or
     * how we failed to move.  */
    protected ResultListener _moveListener;

    /** The operation used to inform observers that the location changed. */
    protected ObserverOp _didChangeOp = new ObserverOp() {
        public boolean apply (Object obs) {
            ((LocationObserver)obs).locationDidChange(_plobj);
            return true;
        }
    };

    /** We require that a moveTo request be outstanding for one minute
     * before it is declared to be stale. */
    protected static final long STALE_REQUEST_DURATION = 60L * 1000L;
}