From 61e6d72cbcdbd362ed8779fc79fbf81ec3481931 Mon Sep 17 00:00:00 2001 From: Dr Scofield Date: Wed, 20 Aug 2008 10:11:58 +0000 Subject: oops. forgot. --- .../Rest/Inventory/IRestHandler.cs | 64 ++++++ .../Rest/Inventory/tests/Remote.cs | 225 +++++++++++++++++++++ 2 files changed, 289 insertions(+) create mode 100644 OpenSim/ApplicationPlugins/Rest/Inventory/IRestHandler.cs create mode 100644 OpenSim/ApplicationPlugins/Rest/Inventory/tests/Remote.cs (limited to 'OpenSim/ApplicationPlugins/Rest') diff --git a/OpenSim/ApplicationPlugins/Rest/Inventory/IRestHandler.cs b/OpenSim/ApplicationPlugins/Rest/Inventory/IRestHandler.cs new file mode 100644 index 0000000..f67f8b1 --- /dev/null +++ b/OpenSim/ApplicationPlugins/Rest/Inventory/IRestHandler.cs @@ -0,0 +1,64 @@ +/* + * Copyright (c) Contributors, http://opensimulator.org/ + * See CONTRIBUTORS.TXT for a full list of copyright holders. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * * Neither the name of the OpenSim Project nor the + * names of its contributors may be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY + * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY + * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + */ + +using System; +using OpenSim.Framework.Servers; + +namespace OpenSim.ApplicationPlugins.Rest.Inventory +{ + + /// + /// The handler delegates are not noteworthy. The allocator allows + /// a given handler to optionally subclass the base RequestData + /// structure to carry any locally required per-request state + /// needed. + /// + + public delegate void RestMethodHandler(RequestData rdata); + public delegate RequestData RestMethodAllocator(OSHttpRequest request, OSHttpResponse response); + + /// + /// This interface represents the boundary between the general purpose + /// REST plugin handling, and the functionally specific handlers. The + /// handler knows only to initialize and terminate all such handlers + /// that it finds. Implementing this interface identifies the class as + /// a REST handler implementation. + /// + + internal interface IRestHandler + { + + string MsgId { get; } + string RequestId { get; } + + void AddPathHandler(RestMethodHandler mh, string path, RestMethodAllocator ma); + void AddStreamHandler(string httpMethod, string path, RestMethod method); + + } + +} diff --git a/OpenSim/ApplicationPlugins/Rest/Inventory/tests/Remote.cs b/OpenSim/ApplicationPlugins/Rest/Inventory/tests/Remote.cs new file mode 100644 index 0000000..c50a945 --- /dev/null +++ b/OpenSim/ApplicationPlugins/Rest/Inventory/tests/Remote.cs @@ -0,0 +1,225 @@ +/* + * Copyright (c) Contributors, http://opensimulator.org/ + * See CONTRIBUTORS.TXT for a full list of copyright holders. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * * Neither the name of the OpenSim Project nor the + * names of its contributors may be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY + * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY + * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + */ + +using libsecondlife; +using Nini.Config; +using System; +using System.Collections.Generic; +using System.IO; +using System.Threading; +using System.Xml; +using OpenSim.Framework; +using OpenSim.Region.Environment.Scenes; +using OpenSim.Framework.Servers; +using OpenSim.Framework.Communications; +using OpenSim.Framework.Communications.Cache; + +namespace OpenSim.ApplicationPlugins.Rest.Inventory.Tests +{ + + public class Remote : ITest + { + + private static readonly int PARM_TESTID = 0; + private static readonly int PARM_COMMAND = 1; + + private static readonly int PARM_MOVE_AVATAR = 2; + private static readonly int PARM_MOVE_X = 3; + private static readonly int PARM_MOVE_Y = 4; + private static readonly int PARM_MOVE_Z = 5; + + private bool enabled = false; + + // No constructor code is required. + + public Remote() + { + Rest.Log.InfoFormat("{0} Remote services constructor", MsgId); + } + + // Post-construction, pre-enabled initialization opportunity + // Not currently exploited. + + public void Initialize() + { + enabled = true; + Rest.Log.InfoFormat("{0} Remote services initialize", MsgId); + } + + // Called by the plug-in to halt REST processing. Local processing is + // disabled, and control blocks until all current processing has + // completed. No new processing will be started + + public void Close() + { + enabled = false; + Rest.Log.InfoFormat("{0} Remote services closing down", MsgId); + } + + // Properties + + internal string MsgId + { + get { return Rest.MsgId; } + } + + // Remote Handler + // Key information of interest here is the Parameters array, each + // entry represents an element of the URI, with element zero being + // the + + public void Execute(RequestData rdata) + { + + if (!enabled) return; + + // If we can't relate to what's there, leave it for others. + + if (rdata.Parameters.Length == 0 || rdata.Parameters[PARM_TESTID] != "remote") + return; + + Rest.Log.DebugFormat("{0} REST Remote handler ENTRY", MsgId); + + // Remove the prefix and what's left are the parameters. If we don't have + // the parameters we need, fail the request. Parameters do NOT include + // any supplied query values. + + if (rdata.Parameters.Length > 1) + { + switch (rdata.Parameters[PARM_COMMAND].ToLower()) + { + case "move" : + DoMove(rdata); + break; + default : + DoHelp(rdata); + break; + } + } + else + { + DoHelp(rdata); + } + } + + private void DoHelp(RequestData rdata) + { + rdata.body = Help; + rdata.Complete(); + rdata.Respond("Help"); + } + + private void DoMove(RequestData rdata) + { + if (rdata.Parameters.Length >= 6) + { + + string[] names = rdata.Parameters[PARM_MOVE_AVATAR].Split(Rest.CA_SPACE); + ScenePresence avatar = null; + Scene scene = null; + + if (names.Length != 2) + { + rdata.Fail(Rest.HttpStatusCodeBadRequest, + String.Format("invalid avatar name: <{0}>",rdata.Parameters[PARM_MOVE_AVATAR])); + } + + Rest.Log.WarnFormat("{0} '{1}' command received for {2} {3}", + MsgId, rdata.Parameters[0], names[0], names[1]); + + // The first parameter should be an avatar name, look for the + // avatar in the known regions first. + + foreach (Scene cs in Rest.main.SceneManager.Scenes) + { + foreach (ScenePresence presence in cs.GetAvatars()) + { + if (presence.Firstname == names[0] && + presence.Lastname == names[1]) + { + scene = cs; + avatar = presence; + break; + } + } + } + + if (avatar != null) + { + + Rest.Log.DebugFormat("{0} Move : Avatar {1} located in region {2}", + MsgId, rdata.Parameters[PARM_MOVE_AVATAR], scene.RegionInfo.RegionName); + + try + { + float x = Convert.ToSingle(rdata.Parameters[PARM_MOVE_X]); + float y = Convert.ToSingle(rdata.Parameters[PARM_MOVE_Y]); + float z = Convert.ToSingle(rdata.Parameters[PARM_MOVE_Z]); + LLVector3 vector = new LLVector3(x,y,z); + avatar.DoAutoPilot(0,vector,avatar.ControllingClient); + } + catch (Exception e) + { + rdata.Fail(Rest.HttpStatusCodeBadRequest, + String.Format("invalid parameters: {0}", e.Message)); + } + + } + else + { + rdata.Fail(Rest.HttpStatusCodeBadRequest, + String.Format("avatar {0} not present", rdata.Parameters[PARM_MOVE_AVATAR])); + } + + rdata.Complete(); + rdata.Respond("OK"); + + } + else + { + Rest.Log.WarnFormat("{0} Move: No movement information provided", MsgId); + rdata.Fail(Rest.HttpStatusCodeBadRequest, "no movement information provided"); + } + + } + + private static readonly string Help = + "" + + "Remote Command Usage" + + "" + + "

Supported commands are:

" + + "
" + + "
move/avatar-name/x/y/z
" + + "
moves the specified avatar to another location
" + + "
" + + "" + + "" + ; + + } +} -- cgit v1.1