Behold Vilya, Ring of Air and repository for our game and virtual worldly

extensions to the distributed environment provided by Narya. git-svn-id: svn+ssh://src.earth.threerings.net/vilya/trunk@1 c613c5cb-e716-0410-b11b-feb51c14d237
2006-06-23 17:58:11 +00:00
commit a4df87e52f
317 changed files with 45818 additions and 0 deletions
@@ -0,0 +1,51 @@
+//
+// $Id: ZoneAdapter.java 4191 2006-06-13 22:42:20Z ray $
+//
+// 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.whirled.zone.client;
+
+import com.threerings.whirled.zone.data.ZoneSummary;
+
+/**
+ * The zone adapter makes life easier for a class that really only cares
+ * about one or two of the zone observer callbacks and doesn't want to
+ * provide empty implementations of the others. One can either extend zone
+ * adapter, or create an anonymous instance that overrides the desired
+ * callback(s).
+ *
+ * @see ZoneObserver
+ */
+public class ZoneAdapter implements ZoneObserver
+{
+    // documentation inherited from interface
+    public void zoneWillChange (int zoneId)
+    {
+    }
+
+    // documentation inherited from interface
+    public void zoneDidChange (ZoneSummary summary)
+    {
+    }
+
+    // documentation inherited from interface
+    public void zoneChangeFailed (String reason)
+    {
+    }
+}
@@ -0,0 +1,69 @@
+//
+// $Id: ZoneDecoder.java 4145 2006-05-24 01:24:24Z ray $
+//
+// Narya library - tools for developing networked games
+// Copyright (C) 2002-2006 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.whirled.zone.client;
+
+import com.threerings.presents.client.InvocationDecoder;
+import com.threerings.whirled.zone.client.ZoneReceiver;
+
+/**
+ * Dispatches calls to a {@link ZoneReceiver} instance.
+ */
+public class ZoneDecoder extends InvocationDecoder
+{
+    /** The generated hash code used to identify this receiver class. */
+    public static final String RECEIVER_CODE = "2d900cf54355111b4bb4befcdff42b82";
+
+    /** The method id used to dispatch {@link ZoneReceiver#forcedMove}
+     * notifications. */
+    public static final int FORCED_MOVE = 1;
+
+    /**
+     * Creates a decoder that may be registered to dispatch invocation
+     * service notifications to the specified receiver.
+     */
+    public ZoneDecoder (ZoneReceiver receiver)
+    {
+        this.receiver = receiver;
+    }
+
+    // documentation inherited
+    public String getReceiverCode ()
+    {
+        return RECEIVER_CODE;
+    }
+
+    // documentation inherited
+    public void dispatchNotification (int methodId, Object[] args)
+    {
+        switch (methodId) {
+        case FORCED_MOVE:
+            ((ZoneReceiver)receiver).forcedMove(
+                ((Integer)args[0]).intValue(), ((Integer)args[1]).intValue()
+            );
+            return;
+
+        default:
+            super.dispatchNotification(methodId, args);
+            return;
+        }
+    }
+}
@@ -0,0 +1,315 @@
+//
+// $Id: ZoneDirector.java 4145 2006-05-24 01:24:24Z ray $
+//
+// 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.whirled.zone.client;
+
+import java.util.ArrayList;
+
+import com.samskivert.util.ResultListener;
+
+import com.threerings.presents.client.BasicDirector;
+import com.threerings.presents.client.Client;
+
+import com.threerings.crowd.data.PlaceConfig;
+
+import com.threerings.whirled.client.SceneDirector;
+import com.threerings.whirled.data.SceneModel;
+import com.threerings.whirled.data.SceneUpdate;
+import com.threerings.whirled.util.WhirledContext;
+
+import com.threerings.whirled.zone.Log;
+import com.threerings.whirled.zone.data.ZoneSummary;
+import com.threerings.whirled.zone.util.ZoneUtil;
+
+/**
+ * The zone director augments the scene services with the notion of zones.
+ * Zones are self-contained, connected groups of scenes. The normal scene
+ * director services can be used to move from scene to scene, but moving
+ * to a new zone requires a special move request which can be accomplished
+ * via the zone director. The zone director also makes available the zone
+ * summary which provides information on the zone which can be used to
+ * generate an overview map or similar.
+ */
+public class ZoneDirector extends BasicDirector
+    implements ZoneReceiver, ZoneService.ZoneMoveListener,
+               SceneDirector.MoveHandler
+{
+    /**
+     * Constructs a zone director with the supplied context, and delegate
+     * scene director (which the zone director will coordinate with when
+     * moving from scene to scene). A zone director is required on the
+     * client side for systems that wish to use the zone services.
+     */
+    public ZoneDirector (WhirledContext ctx, SceneDirector scdir)
+    {
+        super(ctx);
+        _ctx = ctx;
+        _scdir = scdir;
+        _scdir.setMoveHandler(this);
+
+        // register for zone notifications
+        _ctx.getClient().getInvocationDirector().registerReceiver(
+            new ZoneDecoder(this));
+    }
+
+    /**
+     * Returns the summary for the zone currently occupied by the client
+     * or null if the client does not currently occupy a zone (not a
+     * normal situation).
+     */
+    public ZoneSummary getZoneSummary ()
+    {
+        return _summary;
+    }
+
+    /**
+     * Adds a zone observer to the list. This observer will subsequently
+     * be notified of effected and failed zone changes.
+     */
+    public void addZoneObserver (ZoneObserver observer)
+    {
+        _observers.add(observer);
+    }
+
+    /**
+     * Removes a zone observer from the list.
+     */
+    public void removeZoneObserver (ZoneObserver observer)
+    {
+        _observers.remove(observer);
+    }
+
+    /**
+     * Requests that this client move the specified scene in the specified
+     * zone. A request will be made and when the response is received, the
+     * location observers will be notified of success or failure.
+     */
+    public boolean moveTo (int zoneId, int sceneId)
+    {
+        return moveTo(zoneId, sceneId, null);
+    }
+
+    /**
+     * Requests that this client move the specified scene in the specified
+     * zone. A request will be made and when the response is received, the
+     * location observers will be notified of success or failure.
+     */
+    public boolean moveTo (int zoneId, int sceneId, ResultListener rl)
+    {
+        // make sure the zoneId and sceneId are valid
+        if (zoneId < 0 || sceneId < 0) {
+            Log.warning("Refusing moveTo(): invalid sceneId or zoneId " +
+                        "[zoneId=" + zoneId + ", sceneId=" + sceneId + "].");
+            return false;
+        }
+
+        // if the requested zone is the same as our current zone, we just
+        // want a regular old moveTo request
+        if (_summary != null && zoneId == _summary.zoneId) {
+            return _scdir.moveTo(sceneId);
+        }
+
+        // otherwise, we make a zoned moveTo request; prepare to move to
+        // this scene (sets up pending data)
+        if (!_scdir.prepareMoveTo(sceneId, rl)) {
+            return false;
+        }
+
+        // let our zone observers know that we're attempting to switch
+        // zones
+        notifyObservers(Integer.valueOf(zoneId));
+
+        // check the version of our cached copy of the scene to which
+        // we're requesting to move; if we were unable to load it, assume
+        // a cached version of zero
+        int sceneVers = 0;
+        SceneModel pendingModel = _scdir.getPendingModel();
+        if (pendingModel != null) {
+            sceneVers = pendingModel.version;
+        }
+
+        // issue a moveTo request
+        Log.info("Issuing zoned moveTo(" + ZoneUtil.toString(zoneId) +
+                 ", " + sceneId + ", " + sceneVers + ").");
+        _zservice.moveTo(_ctx.getClient(), zoneId, sceneId, sceneVers, this);
+        return true;
+    }
+
+    // documentation inherited
+    protected void fetchServices (Client client)
+    {
+        _zservice = (ZoneService)client.requireService(ZoneService.class);
+    }
+
+    // documentation inherited
+    public void clientDidLogoff (Client client)
+    {
+        super.clientDidLogoff(client);
+
+        // clear out our business
+        _zservice = null;
+        _summary = null;
+        _previousZoneId = -1;
+    }
+
+    /**
+     * Called in response to a successful {@link ZoneService#moveTo}
+     * request.
+     */
+    public void moveSucceeded (
+        int placeId, PlaceConfig config, ZoneSummary summary)
+    {
+        if (_summary != null) {
+            // keep track of our previous zone info
+            _previousZoneId = _summary.zoneId;
+        }
+        
+        // keep track of the summary
+        _summary = summary;
+
+        // pass the rest off to the standard scene transition code
+        _scdir.moveSucceeded(placeId, config);
+
+        // and let the zone observers know what's up
+        notifyObservers(summary);
+    }
+
+    /**
+     * Called in response to a successful {@link ZoneService#moveTo}
+     * request when our cached scene was out of date and the server
+     * determined that we needed some updates.
+     */
+    public void moveSucceededWithUpdates (
+        int placeId, PlaceConfig config, ZoneSummary summary,
+        SceneUpdate[] updates)
+    {
+        // keep track of the summary
+        _summary = summary;
+
+        // pass the rest off to the standard scene transition code
+        _scdir.moveSucceededWithUpdates(placeId, config, updates);
+
+        // and let the zone observers know what's up
+        notifyObservers(summary);
+    }
+
+    /**
+     * Called in response to a successful {@link ZoneService#moveTo}
+     * request when our cached scene was out of date and the server
+     * determined that we needed an updated copy.
+     */
+    public void moveSucceededWithScene (
+        int placeId, PlaceConfig config, ZoneSummary summary, SceneModel model)
+    {
+        // keep track of the summary
+        _summary = summary;
+
+        // pass the rest off to the standard scene transition code
+        _scdir.moveSucceededWithScene(placeId, config, model);
+
+        // and let the zone observers know what's up
+        notifyObservers(summary);
+    }
+
+    /**
+     * Called in response to a failed zoned <code>moveTo</code> request.
+     */
+    public void requestFailed (String reason)
+    {
+        // let the scene director cope
+        _scdir.requestFailed(reason);
+
+        // and let the observers know what's up
+        notifyObservers(reason);
+    }
+
+    // documentation inherited from interface
+    public void forcedMove (int zoneId, int sceneId)
+    {
+        Log.info("Moving at request of server [zoneId=" + zoneId +
+                 ", sceneId=" + sceneId + "].");
+
+        // clear out our old scene and place data
+        _scdir.didLeaveScene();
+
+        // move to the new zone and scene
+        moveTo(zoneId, sceneId, null);
+    }
+
+    /**
+     * Called when something breaks down after successfully completely a
+     * <code>moveTo</code> request.
+     */
+    public void recoverMoveTo (int sceneId)
+    {
+        if (_previousZoneId != -1) {
+            moveTo(_previousZoneId, sceneId);
+
+        } else {
+            _scdir.moveTo(sceneId);
+        }
+    }
+
+    /**
+     * Notifies observers of success or failure, depending on the type of
+     * object provided as data.
+     */
+    protected void notifyObservers (Object data)
+    {
+        // let our observers know that all is well on the western front
+        for (int i = 0; i < _observers.size(); i++) {
+            ZoneObserver obs = (ZoneObserver)_observers.get(i);
+            try {
+                if (data instanceof Integer) {
+                    obs.zoneWillChange(((Integer)data).intValue());
+                } else if (data instanceof ZoneSummary) {
+                    obs.zoneDidChange((ZoneSummary)data);
+                } else {
+                    obs.zoneChangeFailed((String)data);
+                }
+
+            } catch (Throwable t) {
+                Log.warning("Zone observer choked during notification " +
+                            "[data=" + data + ", obs=" + obs + "].");
+                Log.logStackTrace(t);
+            }
+        }
+    }
+
+    /** A reference to the active client context. */
+    protected WhirledContext _ctx;
+
+    /** A reference to the scene director with which we coordinate. */
+    protected SceneDirector _scdir;
+
+    /** Provides access to zone services. */
+    protected ZoneService _zservice;
+
+    /** A reference to the zone summary for the currently occupied
+     * zone. */
+    protected ZoneSummary _summary;
+
+    /** Our zone observer list. */
+    protected ArrayList _observers = new ArrayList();
+
+    /** Our previous zone id. */
+    protected int _previousZoneId = -1;
+}
@@ -0,0 +1,58 @@
+//
+// $Id: ZoneObserver.java 4191 2006-06-13 22:42:20Z ray $
+//
+// 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.whirled.zone.client;
+
+import com.threerings.whirled.zone.data.ZoneSummary;
+
+/**
+ * The zone observer interface makes it possible for entities to be
+ * notified when the client moves to a new zone.
+ */
+public interface ZoneObserver
+{
+    /**
+     * Called when we begin the process of switching to a new zone. This
+     * will be followed by a call to {@link #zoneDidChange} to indicate
+     * that the change was successful or {@link #zoneChangeFailed} if the
+     * change fails.
+     *
+     * @param zoneId the zone id of the zone to which we are changing.
+     */
+    public void zoneWillChange (int zoneId);
+
+    /**
+     * Called when we have switched to a new zone.
+     *
+     * @param summary the summary information for the new zone or null if
+     * we have switched to no zone.
+     */
+    public void zoneDidChange (ZoneSummary summary);
+
+    /**
+     * This is called on all zone observers when a zone change request is
+     * rejected by the server or fails for some other reason.
+     *
+     * @param reason the reason code that explains why the zone change
+     * request was rejected or otherwise failed.
+     */
+    public void zoneChangeFailed (String reason);
+}
@@ -0,0 +1,40 @@
+//
+// $Id: ZoneReceiver.java 4145 2006-05-24 01:24:24Z ray $
+//
+// 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.whirled.zone.client;
+
+import com.threerings.presents.client.InvocationReceiver;
+
+/**
+ * Defines, for the zone services, a set of notifications delivered
+ * asynchronously by the server to the client.
+ */
+public interface ZoneReceiver extends InvocationReceiver
+{
+    /**
+     * Used to communicate a required move notification to the client. The
+     * server will have removed the client from their existing scene and
+     * the client is then responsible for generating a {@link
+     * ZoneService#moveTo} request to move to the new scene in the
+     * specified zone.
+     */
+    public void forcedMove (int zoneId, int sceneId);
+}
@@ -0,0 +1,67 @@
+//
+// $Id: ZoneService.java 4145 2006-05-24 01:24:24Z ray $
+//
+// 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.whirled.zone.client;
+
+import com.threerings.presents.client.Client;
+import com.threerings.presents.client.InvocationService;
+
+import com.threerings.crowd.data.PlaceConfig;
+import com.threerings.whirled.data.SceneModel;
+import com.threerings.whirled.data.SceneUpdate;
+
+import com.threerings.whirled.zone.data.ZoneSummary;
+
+/**
+ * Defines the client interface to the zone related invocation services
+ * (e.g. moving between zones).
+ */
+public interface ZoneService extends InvocationService
+{
+    /** Used to deliver responses to {@link #moveTo} requests. */
+    public static interface ZoneMoveListener extends InvocationListener
+    {
+        public void moveSucceeded (
+            int placeId, PlaceConfig config, ZoneSummary summary);
+
+        public void moveSucceededWithUpdates (
+            int placeId, PlaceConfig config, ZoneSummary summary,
+            SceneUpdate[] updates);
+
+        public void moveSucceededWithScene (
+            int placeId, PlaceConfig config, ZoneSummary summary,
+            SceneModel model);
+    }
+
+    /**
+     * Requests that that this client's body be moved to the specified
+     * scene in the specified zone.
+     *
+     * @param zoneId the zone id to which we want to move.
+     * @param sceneId the scene id to which we want to move.
+     * @param version the version number of the scene object that we have
+     * in our local repository.
+     * @param listener the object that will receive the callback when the
+     * request succeeds or fails.
+     */
+    public void moveTo (Client client, int zoneId, int sceneId,
+                        int version, ZoneMoveListener listener);
+}