From 3bf88587277b83c0b6f058fabba7d46a3b5a6a00 Mon Sep 17 00:00:00 2001 From: Jeff Ames Date: Thu, 28 Aug 2008 14:41:54 +0000 Subject: Update svn properties, formatting cleanup. --- .../Rest/Inventory/IRestHandler.cs | 7 +- .../Rest/Inventory/RequestData.cs | 147 +++++----- OpenSim/ApplicationPlugins/Rest/Inventory/Rest.cs | 40 +-- .../Rest/Inventory/RestAssetServices.cs | 31 +- .../Rest/Inventory/RestHandler.cs | 70 ++--- .../Rest/Inventory/RestInventoryServices.cs | 325 ++++++++------------- .../Rest/Inventory/tests/Remote.cs | 26 +- 7 files changed, 258 insertions(+), 388 deletions(-) (limited to 'OpenSim/ApplicationPlugins/Rest/Inventory') diff --git a/OpenSim/ApplicationPlugins/Rest/Inventory/IRestHandler.cs b/OpenSim/ApplicationPlugins/Rest/Inventory/IRestHandler.cs index 69f91e4..82dc2e4 100644 --- a/OpenSim/ApplicationPlugins/Rest/Inventory/IRestHandler.cs +++ b/OpenSim/ApplicationPlugins/Rest/Inventory/IRestHandler.cs @@ -23,7 +23,6 @@ * 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; @@ -41,11 +40,11 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory public delegate void RestMethodHandler(RequestData rdata); public delegate RequestData RestMethodAllocator(OSHttpRequest request, OSHttpResponse response, string path); - + /// /// 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 + /// handler knows only to initialize and terminate all such handlers /// that it finds. Implementing this interface identifies the class as /// a REST handler implementation. /// @@ -55,7 +54,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory 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/RequestData.cs b/OpenSim/ApplicationPlugins/Rest/Inventory/RequestData.cs index 6742402..24e5ada 100644 --- a/OpenSim/ApplicationPlugins/Rest/Inventory/RequestData.cs +++ b/OpenSim/ApplicationPlugins/Rest/Inventory/RequestData.cs @@ -23,7 +23,6 @@ * 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; @@ -44,14 +43,14 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory /// /// This class represents the current REST request. It - /// encapsulates the request/response state and takes care + /// encapsulates the request/response state and takes care /// of response generation without exposing the REST handler /// to the actual mechanisms involved. /// /// This structure is created on entry to the Handler /// method and is disposed of upon return. It is part of /// the plug-in infrastructure, rather than the functionally - /// specific REST handler, and fundamental changes to + /// specific REST handler, and fundamental changes to /// this should be reflected in the Rest HandlerVersion. The /// object is instantiated, and may be extended by, any /// given handler. See the inventory handler for an example @@ -84,7 +83,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory // Storing information in body will suppress the return of // statusBody which is only intended to report status on // requests which do not themselves ordinarily generate - // an informational response. All of this is handled in + // an informational response. All of this is handled in // Respond(). internal byte[] buffer = null; @@ -92,8 +91,8 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory internal string bodyType = "text/html"; // The encoding in effect is set to a server default. It may - // subsequently be overridden by a Content header. This - // value is established during construction and is used + // subsequently be overridden by a Content header. This + // value is established during construction and is used // wherever encoding services are needed. internal Encoding encoding = Rest.Encoding; @@ -110,7 +109,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory // The path part of the URI is decomposed. pathNodes // is an array of every element in the URI. Parameters - // is an array that contains only those nodes that + // is an array that contains only those nodes that // are not a part of the authority prefix private string[] pathNodes = null; @@ -118,7 +117,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory private static readonly string[] EmptyPath = { String.Empty }; // The status code gets set during the course of processing - // and is the HTTP completion code. The status body is + // and is the HTTP completion code. The status body is // initialized during construction, is appended to during the // course of execution, and is finalized during Respond // processing. @@ -166,7 +165,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory // force selection of a particular authentication model // (choosing from amongst those supported of course) // - + internal bool authenticated = false; internal string scheme = null; internal string realm = Rest.Realm; @@ -183,7 +182,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory internal string userPass = String.Empty; // Session related tables. These are only needed if QOP is set to "auth-sess" - // and for now at least, it is not. Session related authentication is of + // and for now at least, it is not. Session related authentication is of // questionable merit in the context of REST anyway, but it is, arguably, more // secure. @@ -199,23 +198,23 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory private static Regex schema = new Regex("^\\s*(?\\w+)\\s*.*", RegexOptions.Compiled | RegexOptions.IgnoreCase); - + private static Regex basicParms = new Regex("^\\s*(?:\\w+)\\s+(?\\S+)\\s*", RegexOptions.Compiled | RegexOptions.IgnoreCase); - + private static Regex digestParm1 = new Regex("\\s*(?\\w+)\\s*=\\s*\"(?[^\"]+)\"", RegexOptions.Compiled | RegexOptions.IgnoreCase); - + private static Regex digestParm2 = new Regex("\\s*(?\\w+)\\s*=\\s*(?[^\\p{P}\\s]+)", RegexOptions.Compiled | RegexOptions.IgnoreCase); - + private static Regex reuserPass = new Regex("(?[^:]+):(?[\\S\\s]*)", RegexOptions.Compiled | RegexOptions.IgnoreCase); - + // For efficiency, we create static instances of these objects private static MD5 md5hash = MD5.Create(); - + private static StringComparer sc = StringComparer.OrdinalIgnoreCase; #region properties @@ -228,15 +227,15 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory } /// - /// Return a boolean indication of whether or no an authenticated user is - /// associated with this request. This could be wholly integrated, but + /// Return a boolean indication of whether or no an authenticated user is + /// associated with this request. This could be wholly integrated, but /// that would make authentication mandatory. /// internal bool IsAuthenticated { get - { + { if (Rest.Authenticate) { if (!authenticated) @@ -258,31 +257,31 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory internal string[] PathNodes { get - { + { return pathNodes; } } - + /// /// Access to all non-prefix 'nodes' in the supplied URI as an - /// array of strings. These identify a specific resource that + /// array of strings. These identify a specific resource that /// is managed by the authority (the prefix). /// internal string[] Parameters { get - { + { return parameters; } } - + #endregion properties #region constructors // Constructor - + internal RequestData(OSHttpRequest p_request, OSHttpResponse p_response, string p_qprefix) { @@ -315,7 +314,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory /// Realm, domain, etc. /// /// This method checks to see if the current request is already - /// authenticated for this domain. If it is, then it returns + /// authenticated for this domain. If it is, then it returns /// true. If it is not, then it issues a challenge to the client /// and responds negatively to the request. /// @@ -339,7 +338,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory Rest.Log.DebugFormat("{0} Challenge reason: No authorization data", MsgId); DoChallenge(); } - + // So, we have authentication data, now we have to check to // see what we got and whether or not it is valid for the // current domain. To do this we need to interpret the data @@ -438,7 +437,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory // The service provider can force a particular scheme by // assigning a value to scheme. - + // Basic authentication is pretty simple. // Just specify the realm in question. @@ -468,8 +467,8 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory sbuilder.Append(" "); // Specify the effective realm. This should - // never be null if we are uthenticating, as it is required for all - // authentication schemes. It defines, in conjunction with the + // never be null if we are uthenticating, as it is required for all + // authentication schemes. It defines, in conjunction with the // absolute URI information, the domain to which the authentication // applies. It is an arbitrary string. I *believe* this allows an // authentication to apply to disjoint resources within the same @@ -485,7 +484,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory } // Share our nonce. This is *uniquely* generated each time a 401 is - // returned. We do not generate a very sophisticated nonce at the + // returned. We do not generate a very sophisticated nonce at the // moment (it's simply a base64 encoded UUID). if (nonce != null) @@ -532,7 +531,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory sbuilder.Append(Rest.CS_COMMA); } - // Theoretically QOP is optional, but it is required by a compliant + // Theoretically QOP is optional, but it is required by a compliant // with current versions of the scheme. In fact IE requires that QOP // be specified and will refuse to authenticate otherwise. @@ -555,7 +554,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory } // We don't know the userid that will be used - // so we cannot make any authentication domain + // so we cannot make any authentication domain // assumptions. So the prefix will determine // this. @@ -582,7 +581,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory /// understand this and also expect it to be the first one /// offered. So we do. /// OpenSim also needs this, as it is the only scheme that allows - /// authentication using the hashed passwords stored in the + /// authentication using the hashed passwords stored in the /// user database. /// @@ -599,7 +598,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory foreach (Match m in matches) { authparms.Add("response",m.Groups["pval"].Value); - Rest.Log.DebugFormat("{0} Parameter matched : {1} = {2}", + Rest.Log.DebugFormat("{0} Parameter matched : {1} = {2}", MsgId, "response", m.Groups["pval"].Value); } @@ -623,7 +622,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory } /// - /// This method provides validation in support of the BASIC + /// This method provides validation in support of the BASIC /// authentication method. This is not normaly expected to be /// used, but is included for completeness (and because I tried /// it first). @@ -664,12 +663,12 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory string last; // Distinguish the parts, if necessary - + if ((x=user.IndexOf(Rest.C_SPACE)) != -1) { first = user.Substring(0,x); last = user.Substring(x+1); - } + } else { first = user; @@ -685,9 +684,9 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory HA1 = HashToString(pass); HA1 = HashToString(String.Format("{0}:{1}",HA1,udata.PasswordSalt)); - + return (0 == sc.Compare(HA1, udata.PasswordHash)); - + } #endregion authentication_basic @@ -712,7 +711,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory foreach (Match m in matches) { authparms.Add(m.Groups["parm"].Value,m.Groups["pval"].Value); - Rest.Log.DebugFormat("{0} String Parameter matched : {1} = {2}", + Rest.Log.DebugFormat("{0} String Parameter matched : {1} = {2}", MsgId, m.Groups["parm"].Value,m.Groups["pval"].Value); } @@ -723,7 +722,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory foreach (Match m in matches) { authparms.Add(m.Groups["parm"].Value,m.Groups["pval"].Value); - Rest.Log.DebugFormat("{0} Tokenized Parameter matched : {1} = {2}", + Rest.Log.DebugFormat("{0} Tokenized Parameter matched : {1} = {2}", MsgId, m.Groups["parm"].Value,m.Groups["pval"].Value); } @@ -760,7 +759,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory if (!authparms.TryGetValue("nonce", out nonce) || nonce == null) { - Rest.Log.WarnFormat("{0} Authentication failed: nonce missing", MsgId); + Rest.Log.WarnFormat("{0} Authentication failed: nonce missing", MsgId); break; } @@ -771,7 +770,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory { if (temp != opaque) { - Rest.Log.WarnFormat("{0} Authentication failed: bad opaque value", MsgId); + Rest.Log.WarnFormat("{0} Authentication failed: bad opaque value", MsgId); break; } } @@ -783,7 +782,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory { if (temp != algorithm) { - Rest.Log.WarnFormat("{0} Authentication failed: bad algorithm value", MsgId); + Rest.Log.WarnFormat("{0} Authentication failed: bad algorithm value", MsgId); break; } } @@ -800,7 +799,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory if (!authparms.ContainsKey("cnonce")) { - Rest.Log.WarnFormat("{0} Authentication failed: cnonce missing", MsgId); + Rest.Log.WarnFormat("{0} Authentication failed: cnonce missing", MsgId); break; } @@ -808,7 +807,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory if (!authparms.TryGetValue("nc", out nck) || nck == null) { - Rest.Log.WarnFormat("{0} Authentication failed: cnonce counter missing", MsgId); + Rest.Log.WarnFormat("{0} Authentication failed: cnonce counter missing", MsgId); break; } @@ -820,7 +819,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory if (Rest.Hex2Int(ncl) >= Rest.Hex2Int(nck)) { - Rest.Log.WarnFormat("{0} Authentication failed: bad cnonce counter", MsgId); + Rest.Log.WarnFormat("{0} Authentication failed: bad cnonce counter", MsgId); break; } cntable[nonce] = nck; @@ -840,12 +839,12 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory // these MUST NOT be present. if (authparms.ContainsKey("cnonce")) { - Rest.Log.WarnFormat("{0} Authentication failed: invalid cnonce", MsgId); + Rest.Log.WarnFormat("{0} Authentication failed: invalid cnonce", MsgId); break; } if (authparms.ContainsKey("nc")) { - Rest.Log.WarnFormat("{0} Authentication failed: invalid cnonce counter[2]", MsgId); + Rest.Log.WarnFormat("{0} Authentication failed: invalid cnonce counter[2]", MsgId); break; } } @@ -854,7 +853,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory authenticated = ValidateDigest(userName, nonce, cnonce, nck, authPrefix, response); - } + } while (false); } @@ -864,10 +863,10 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory /// /// This mechanism is used by the digest authentication mechanism /// to return the user's password. In fact, because the OpenSim - /// user's passwords are already hashed, and the HTTP mechanism - /// does not supply an open password, the hashed passwords cannot + /// user's passwords are already hashed, and the HTTP mechanism + /// does not supply an open password, the hashed passwords cannot /// be used unless the client has used the same salting mechanism - /// to has the password before using it in the authentication + /// to has the password before using it in the authentication /// algorithn. This is not inconceivable... /// @@ -879,12 +878,12 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory string last; // Distinguish the parts, if necessary - + if ((x=user.IndexOf(Rest.C_SPACE)) != -1) { first = user.Substring(0,x); last = user.Substring(x+1); - } + } else { first = user; @@ -955,7 +954,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory HA2 = HashToString(patt); // Generate Digest - + if (qop != String.Empty) { patt = String.Format("{0}:{1}:{2}:{3}:{4}:{5}", HA1, nonce, nck, cnonce, qop, HA2); @@ -1011,7 +1010,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory } /// - /// Indicate a functionally-dependent conclusion to the + /// Indicate a functionally-dependent conclusion to the /// request. See Rest.cs for a list of possible values. /// @@ -1023,7 +1022,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory /// /// Indicate that a request should be redirected, using /// the HTTP completion codes. Permanent and temporary - /// redirections may be indicated. The supplied URL is + /// redirections may be indicated. The supplied URL is /// the new location of the resource. /// @@ -1057,7 +1056,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory } /// - /// For the more adventurous. This failure also includes a + /// For the more adventurous. This failure also includes a /// specified entity to be appended to the code-related /// status string. /// @@ -1101,12 +1100,12 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory fail = true; - // Respond to the client's request, tag the response (for the + // Respond to the client's request, tag the response (for the // benefit of trace) to indicate the reason. Respond(String.Format("Failure response: ({0}) : {1}", code, Rest.HttpStatusDesc[code])); - + // Finally initialize and the throw a RestException. All of the // handler's infrastructure knows that this is a "normal" // completion from a code point-of-view. @@ -1129,7 +1128,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory Fail(Rest.HttpStatusCodeNotImplemented, "request rejected (not implemented)"); } - // This MUST be called by an agent handler before it returns + // This MUST be called by an agent handler before it returns // control to Handle, otherwise the request will be ignored. // This is called implciitly for the REST stream handlers and // is harmless if it is called twice. @@ -1222,7 +1221,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory } - // Set the status code & description. If nothing has been stored, + // Set the status code & description. If nothing has been stored, // we consider that a success. if (statusCode == 0) @@ -1236,7 +1235,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory // For a redirect we need to set the relocation header accordingly - if (response.StatusCode == (int) Rest.HttpStatusCodeTemporaryRedirect || + if (response.StatusCode == (int) Rest.HttpStatusCodeTemporaryRedirect || response.StatusCode == (int) Rest.HttpStatusCodePermanentRedirect) { Rest.Log.DebugFormat("{0} Re-direct location is {1}", MsgId, redirectLocation); @@ -1252,7 +1251,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory // We've left the setting of handled' until the // last minute because the header settings included // above are pretty harmless. But everything from - // here on down probably leaves the response + // here on down probably leaves the response // element unusable by anyone else. handled = true; @@ -1267,7 +1266,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory if (buffer != null && buffer.Length != 0) { - Rest.Log.DebugFormat("{0} Entity buffer, length = {1} : <{2}>", + Rest.Log.DebugFormat("{0} Entity buffer, length = {1} : <{2}>", MsgId, buffer.Length, encoding.GetString(buffer)); response.OutputStream.Write(buffer, 0, buffer.Length); } @@ -1295,11 +1294,11 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory { if (Rest.DEBUG) { - Rest.Log.DebugFormat("{0} Adding header: <{1}: {2}>", + Rest.Log.DebugFormat("{0} Adding header: <{1}: {2}>", MsgId, hdr, data); if (response.Headers.Get(hdr) != null) { - Rest.Log.DebugFormat("{0} Multipe {1} headers will be generated>", + Rest.Log.DebugFormat("{0} Multipe {1} headers will be generated>", MsgId, hdr); } } @@ -1313,7 +1312,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory Rest.Log.DebugFormat("{0} Removing header: <{1}>", MsgId, hdr); if (response.Headers.Get(hdr) == null) { - Rest.Log.DebugFormat("{0} No such header existed", + Rest.Log.DebugFormat("{0} No such header existed", MsgId, hdr); } } @@ -1326,7 +1325,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory { for (int i=0;i @@ -88,7 +86,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory static Rest() { - HttpStatusDesc = new Dictionary(); + HttpStatusDesc = new Dictionary(); if (HttpStatusCodeArray.Length != HttpStatusDescArray.Length) { Log.ErrorFormat("{0} HTTP Status Code and Description arrays do not match"); @@ -143,7 +141,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory /// supported by all servers. See Respond /// to see how these are handled. /// - + // REST AGENT 1.0 interpretations public const string GET = "get"; // information retrieval - server state unchanged public const string HEAD = "head"; // same as get except only the headers are returned. @@ -175,7 +173,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory public static readonly char C_PERIOD = '.'; public static readonly char C_COMMA = ','; public static readonly char C_DQUOTE = '"'; - + public static readonly string CS_SPACE = " "; public static readonly string CS_SLASH = "/"; public static readonly string CS_PATHSEP = "/"; @@ -184,7 +182,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory public static readonly string CS_PERIOD = "."; public static readonly string CS_COMMA = ","; public static readonly string CS_DQUOTE = "\""; - + public static readonly char[] CA_SPACE = { C_SPACE }; public static readonly char[] CA_SLASH = { C_SLASH }; public static readonly char[] CA_PATHSEP = { C_PATHSEP }; @@ -392,7 +390,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory public const string AS_DIGEST = "Digest"; /// Supported Digest algorithms - + public const string Digest_MD5 = "MD5"; // assumedd efault if omitted public const string Digest_MD5Sess = "MD5-sess"; @@ -440,7 +438,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory int val = 0; int sum = 0; string tmp = null; - + if (hex != null) { tmp = hex.ToLower(); @@ -455,7 +453,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory } return sum; - } // Nonce management @@ -465,17 +462,15 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory return StringToBase64(CreationDate + Guid.NewGuid().ToString()); } - // Dump he specified data stream; + // Dump the specified data stream public static void Dump(byte[] data) { - char[] buffer = new char[Rest.DumpLineSize]; int cc = 0; for (int i = 0; i < data.Length; i++) { - if (i % Rest.DumpLineSize == 0) Console.Write("\n{0}: ",i.ToString("d8")); if (i % 4 == 0) Console.Write(" "); @@ -494,7 +489,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory Console.Write(" |"+(new String(buffer))+"|"); cc = 0; } - } // Finish off any incomplete line @@ -504,33 +498,29 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory for (int i = cc ; i < Rest.DumpLineSize; i++) { if (i % 4 == 0) Console.Write(" "); - Console.Write(" "); + Console.Write(" "); buffer[i % Rest.DumpLineSize] = ' '; } Console.WriteLine(" |"+(new String(buffer))+"|"); } else { - Console.Write("\n"); + Console.Write("\n"); } - } - } - + // Local exception type public class RestException : Exception { - internal int statusCode; internal string statusDesc; internal string httpmethod; internal string httppath; - public RestException(string msg) : base(msg) - { + public RestException(string msg) : base(msg) + { } } - } diff --git a/OpenSim/ApplicationPlugins/Rest/Inventory/RestAssetServices.cs b/OpenSim/ApplicationPlugins/Rest/Inventory/RestAssetServices.cs index 6b802d3..1b94741 100644 --- a/OpenSim/ApplicationPlugins/Rest/Inventory/RestAssetServices.cs +++ b/OpenSim/ApplicationPlugins/Rest/Inventory/RestAssetServices.cs @@ -23,7 +23,6 @@ * 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; @@ -40,10 +39,8 @@ using OpenSim.Framework.Communications.Cache; namespace OpenSim.ApplicationPlugins.Rest.Inventory { - public class RestAssetServices : IRest { - private bool enabled = false; private string qPrefix = "assets"; @@ -52,7 +49,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory public RestAssetServices() { - Rest.Log.InfoFormat("{0} Asset services initializing", MsgId); Rest.Log.InfoFormat("{0} Using REST Implementation Version {1}", MsgId, Rest.Version); @@ -73,7 +69,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory enabled = true; Rest.Log.InfoFormat("{0} Asset services initialization complete", MsgId); - } // Post-construction, pre-enabled initialization opportunity @@ -84,7 +79,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory } // Called by the plug-in to halt REST processing. Local processing is - // disabled, and control blocks until all current processing has + // disabled, and control blocks until all current processing has // completed. No new processing will be started public void Close() @@ -111,14 +106,13 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory private void DoAsset(RequestData rparm) { - if (!enabled) return; AssetRequestData rdata = (AssetRequestData) rparm; Rest.Log.DebugFormat("{0} REST Asset handler ENTRY", MsgId); - // Now that we know this is a serious attempt to + // Now that we know this is a serious attempt to // access inventory data, we should find out who // is asking, and make sure they are authorized // to do so. We need to validate the caller's @@ -129,9 +123,9 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory // With the present HTTP server we can't use the // builtin authentication mechanisms because they // would be enforced for all in-bound requests. - // Instead we look at the headers ourselves and + // Instead we look at the headers ourselves and // handle authentication directly. - + try { if (!rdata.IsAuthenticated) @@ -144,13 +138,13 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory if (e.statusCode == Rest.HttpStatusCodeNotAuthorized) { Rest.Log.WarnFormat("{0} User not authenticated", MsgId); - Rest.Log.DebugFormat("{0} Authorization header: {1}", MsgId, + Rest.Log.DebugFormat("{0} Authorization header: {1}", MsgId, rdata.request.Headers.Get("Authorization")); } else { Rest.Log.ErrorFormat("{0} User authentication failed", MsgId); - Rest.Log.DebugFormat("{0} Authorization header: {1}", MsgId, + Rest.Log.DebugFormat("{0} Authorization header: {1}", MsgId, rdata.request.Headers.Get("Authorization")); } throw (e); @@ -173,7 +167,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory case "post" : case "delete" : default : - Rest.Log.WarnFormat("{0} Asset: Method not supported: {1}", + Rest.Log.WarnFormat("{0} Asset: Method not supported: {1}", MsgId, rdata.method); rdata.Fail(Rest.HttpStatusCodeBadRequest,String.Format("method <{0}> not supported", rdata.method)); break; @@ -186,14 +180,12 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory } Rest.Log.DebugFormat("{0} REST Asset handler EXIT", MsgId); - } #endregion Interface private void DoGet(AssetRequestData rdata) { - bool istexture = false; Rest.Log.DebugFormat("{0} REST Asset handler, Method = <{1}> ENTRY", MsgId, rdata.method); @@ -203,13 +195,11 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory if (rdata.Parameters.Length == 1) { - LLUUID uuid = new LLUUID(rdata.Parameters[0]); AssetBase asset = Rest.AssetServices.GetAsset(uuid, istexture); if (asset != null) { - Rest.Log.DebugFormat("{0} Asset located <{1}>", MsgId, rdata.Parameters[0]); rdata.initXmlWriter(); @@ -237,7 +227,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory rdata.Complete(); rdata.Respond("Asset " + rdata.method + ": Normal completion"); - } private void DoPut(AssetRequestData rdata) @@ -255,7 +244,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory if (!xml.ReadToFollowing("Asset")) { Rest.Log.DebugFormat("{0} Invalid request data: <{1}>", MsgId, rdata.path); - rdata.Fail(Rest.HttpStatusCodeBadRequest,"invalid request data"); + rdata.Fail(Rest.HttpStatusCodeBadRequest,"invalid request data"); } AssetBase asset = new AssetBase(); @@ -272,12 +261,11 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory else { Rest.Log.DebugFormat("{0} Invalid parameters: <{1}>", MsgId, rdata.path); - rdata.Fail(Rest.HttpStatusCodeNotFound, "invalid parameters"); + rdata.Fail(Rest.HttpStatusCodeNotFound, "invalid parameters"); } rdata.Complete(); rdata.Respond("Asset " + rdata.method + ": Normal completion"); - } internal class AssetRequestData : RequestData @@ -287,6 +275,5 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory { } } - } } diff --git a/OpenSim/ApplicationPlugins/Rest/Inventory/RestHandler.cs b/OpenSim/ApplicationPlugins/Rest/Inventory/RestHandler.cs index 61cf0e4..ab6128f 100644 --- a/OpenSim/ApplicationPlugins/Rest/Inventory/RestHandler.cs +++ b/OpenSim/ApplicationPlugins/Rest/Inventory/RestHandler.cs @@ -23,7 +23,6 @@ * 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; @@ -35,7 +34,6 @@ using OpenSim.ApplicationPlugins.Rest; namespace OpenSim.ApplicationPlugins.Rest.Inventory { - /// /// The class signature reveals the roles that RestHandler plays. /// @@ -74,10 +72,10 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory /// /// This static initializer scans the ASSEMBLY for classes that /// export the IRest interface and builds a list of them. These - /// are later activated by the handler. To add a new handler it + /// are later activated by the handler. To add a new handler it /// is only necessary to create a new services class that implements /// the IRest interface, and recompile the handler. This gives - /// all of the build-time flexibility of a modular approach + /// all of the build-time flexibility of a modular approach /// while not introducing yet-another module loader. Note that /// multiple assembles can still be built, each with its own set /// of handlers. Examples of services classes are RestInventoryServices @@ -86,13 +84,12 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory static RestHandler() { - Module[] mods = Assembly.GetExecutingAssembly().GetModules(); foreach (Module m in mods) { Type[] types = m.GetTypes(); - foreach (Type t in types) + foreach (Type t in types) { try { @@ -108,7 +105,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory } } } - } #endregion local static state @@ -117,13 +113,13 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory /// /// This routine loads all of the handlers discovered during - /// instance initialization. + /// instance initialization. /// A table of all loaded and successfully constructed handlers /// is built, and this table is then used by the constructor to /// initialize each of the handlers in turn. /// NOTE: The loading process does not automatically imply that - /// the handler has registered any kind of an interface, that - /// may be (optionally) done by the handler either during + /// the handler has registered any kind of an interface, that + /// may be (optionally) done by the handler either during /// construction, or during initialization. /// /// I was not able to make this code work within a constructor @@ -136,7 +132,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory { if (!handlersLoaded) { - ConstructorInfo ci; Object ht; @@ -167,8 +162,8 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory // Name is used to differentiate the message header. - public override string Name - { + public override string Name + { get { return "HANDLER"; } } @@ -181,7 +176,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory // We have to rename these because we want // to be able to share the values with other - // classes in our assembly and the base + // classes in our assembly and the base // names are protected. public string MsgId @@ -211,7 +206,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory { try { - // This plugin will only be enabled if the broader // REST plugin mechanism is enabled. @@ -222,7 +216,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory // IsEnabled is implemented by the base class and // reflects an overall RestPlugin status - if (!IsEnabled) + if (!IsEnabled) { Rest.Log.WarnFormat("{0} Plugins are disabled", MsgId); return; @@ -278,15 +272,15 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory Rest.DumpLineSize); } - // Load all of the handlers present in the + // Load all of the handlers present in the // assembly // In principle, as we're an application plug-in, // most of what needs to be done could be done using - // static resources, however the Open Sim plug-in - // model makes this an instance, so that's what we + // static resources, however the Open Sim plug-in + // model makes this an instance, so that's what we // need to be. - // There is only one Communications manager per + // There is only one Communications manager per // server, and by inference, only one each of the // user, asset, and inventory servers. So we can cache // those using a static initializer. @@ -329,13 +323,12 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory { Rest.Log.ErrorFormat("{0} Plugin initialization has failed: {1}", MsgId, e.Message); } - } /// /// In the interests of efficiency, and because we cannot determine whether /// or not this instance will actually be harvested, we clobber the only - /// anchoring reference to the working state for this plug-in. What the + /// anchoring reference to the working state for this plug-in. What the /// call to close does is irrelevant to this class beyond knowing that it /// can nullify the reference when it returns. /// To make sure everything is copacetic we make sure the primary interface @@ -344,7 +337,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory public override void Close() { - Rest.Log.InfoFormat("{0} Plugin is terminating", MsgId); try @@ -352,12 +344,11 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory RemoveAgentHandler(Rest.Name, this); } catch (KeyNotFoundException){} - + foreach (IRest handler in handlers) { handler.Close(); } - } #endregion overriding methods @@ -383,7 +374,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory foreach (string key in pathHandlers.Keys) { Rest.Log.DebugFormat("{0} Match testing {1} against agent prefix <{2}>", MsgId, path, key); - + // Note that Match will not necessarily find the handler that will // actually be used - it does no test for the "closest" fit. It // simply reflects that at least one possible handler exists. @@ -393,7 +384,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory Rest.Log.DebugFormat("{0} Matched prefix <{1}>", MsgId, key); // This apparently odd evaluation is needed to prevent a match - // on anything other than a URI token boundary. Otherwise we + // on anything other than a URI token boundary. Otherwise we // may match on URL's that were not intended for this handler. return ( path.Length == key.Length || @@ -406,9 +397,8 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory foreach (string key in streamHandlers.Keys) { - Rest.Log.DebugFormat("{0} Match testing {1} against stream prefix <{2}>", MsgId, path, key); - + // Note that Match will not necessarily find the handler that will // actually be used - it does no test for the "closest" fit. It // simply reflects that at least one possible handler exists. @@ -418,7 +408,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory Rest.Log.DebugFormat("{0} Matched prefix <{1}>", MsgId, key); // This apparently odd evaluation is needed to prevent a match - // on anything other than a URI token boundary. Otherwise we + // on anything other than a URI token boundary. Otherwise we // may match on URL's that were not intended for this handler. return ( path.Length == key.Length || @@ -426,7 +416,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory } } - } catch (Exception e) { @@ -460,7 +449,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory for (int i = 0; i < request.Headers.Count; i++) { - Rest.Log.DebugFormat("{0} Header [{1}] : <{2}> = <{3}>", + Rest.Log.DebugFormat("{0} Header [{1}] : <{2}> = <{3}>", MsgId, i, request.Headers.GetKey(i), request.Headers.Get(i)); } Rest.Log.DebugFormat("{0} URI: {1}", MsgId, request.RawUrl); @@ -486,7 +475,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory Rest.Log.DebugFormat("{0} EXIT", MsgId); return handled; - } #endregion interface methods @@ -534,7 +522,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory } return rdata.handled; - } /// @@ -547,13 +534,12 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory public void AddStreamHandler(string httpMethod, string path, RestMethod method) { - if (!IsEnabled) { return; } - if (!path.StartsWith(Rest.Prefix)) + if (!path.StartsWith(Rest.Prefix)) { path = String.Format("{0}{1}", Rest.Prefix, path); } @@ -571,7 +557,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory { Rest.Log.WarnFormat("{0} Ignoring duplicate handler for {1}", MsgId, path); } - } /// @@ -586,10 +571,9 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory internal bool FindPathHandler(OSHttpRequest request, OSHttpResponse response) { - RequestData rdata = null; string bestMatch = null; - + if (!IsEnabled) { return false; @@ -612,7 +596,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory if (!String.IsNullOrEmpty(bestMatch)) { - rdata = pathAllocators[bestMatch](request, response, bestMatch); Rest.Log.DebugFormat("{0} Path based REST handler matched with <{1}>", MsgId, bestMatch); @@ -621,7 +604,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory { pathHandlers[bestMatch](rdata); } - + // A plugin generated error indicates a request-related error // that has been handled by the plugin. @@ -629,11 +612,9 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory { Rest.Log.WarnFormat("{0} Request failed: {1}", MsgId, r.Message); } - } return (rdata == null) ? false : rdata.handled; - } /// @@ -643,7 +624,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory public void AddPathHandler(RestMethodHandler mh, string path, RestMethodAllocator ra) { - if (!IsEnabled) { return; @@ -665,8 +645,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory pathHandlers.Add(path, mh); pathAllocators.Add(path, ra); - } } - } diff --git a/OpenSim/ApplicationPlugins/Rest/Inventory/RestInventoryServices.cs b/OpenSim/ApplicationPlugins/Rest/Inventory/RestInventoryServices.cs index 1ea598e..82e9a13 100644 --- a/OpenSim/ApplicationPlugins/Rest/Inventory/RestInventoryServices.cs +++ b/OpenSim/ApplicationPlugins/Rest/Inventory/RestInventoryServices.cs @@ -23,7 +23,6 @@ * 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; @@ -42,11 +41,9 @@ using Nini.Config; namespace OpenSim.ApplicationPlugins.Rest.Inventory { - public class RestInventoryServices : IRest { - - private static readonly int PARM_USERID = 0; + private static readonly int PARM_USERID = 0; private static readonly int PARM_PATH = 1; private bool enabled = false; @@ -61,11 +58,10 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory public RestInventoryServices() { - Rest.Log.InfoFormat("{0} Inventory services initializing", MsgId); Rest.Log.InfoFormat("{0} Using REST Implementation Version {1}", MsgId, Rest.Version); - // If a relative path was specified for the handler's domain, + // If a relative path was specified for the handler's domain, // add the standard prefix to make it absolute, e.g. /admin if (!qPrefix.StartsWith(Rest.UrlPathSeparator)) @@ -82,7 +78,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory enabled = true; Rest.Log.InfoFormat("{0} Inventory services initialization complete", MsgId); - } /// @@ -143,7 +138,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory private void DoInventory(RequestData hdata) { - InventoryRequestData rdata = (InventoryRequestData) hdata; Rest.Log.DebugFormat("{0} DoInventory ENTRY", MsgId); @@ -155,7 +149,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory return; } - // Now that we know this is a serious attempt to + // Now that we know this is a serious attempt to // access inventory data, we should find out who // is asking, and make sure they are authorized // to do so. We need to validate the caller's @@ -166,9 +160,9 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory // With the present HTTP server we can't use the // builtin authentication mechanisms because they // would be enforced for all in-bound requests. - // Instead we look at the headers ourselves and + // Instead we look at the headers ourselves and // handle authentication directly. - + try { if (!rdata.IsAuthenticated) @@ -205,7 +199,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory // // Indicating that this is an inventory request for // an avatar named Arthur Dent. This is ALL that is - // required to designate a GET for an entire + // required to designate a GET for an entire // inventory. // // Do we have at least a user agent name? @@ -247,7 +241,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory if (rdata.userProfile != null) { - Rest.Log.DebugFormat("{0} Profile obtained for agent {1} {2}", + Rest.Log.DebugFormat("{0} Profile obtained for agent {1} {2}", MsgId, rdata.userProfile.FirstName, rdata.userProfile.SurName); } else @@ -269,18 +263,17 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory // response is not recieved in a timely fashion. rdata.uuid = rdata.userProfile.ID; - + if (Rest.InventoryServices.HasInventoryForUser(rdata.uuid)) { - rdata.root = Rest.InventoryServices.RequestRootFolder(rdata.uuid); - Rest.Log.DebugFormat("{0} Inventory Root retrieved for {1} {2}", + Rest.Log.DebugFormat("{0} Inventory Root retrieved for {1} {2}", MsgId, rdata.userProfile.FirstName, rdata.userProfile.SurName); Rest.InventoryServices.RequestInventoryForUser(rdata.uuid, rdata.GetUserInventory); - Rest.Log.DebugFormat("{0} Inventory catalog requested for {1} {2}", + Rest.Log.DebugFormat("{0} Inventory catalog requested for {1} {2}", MsgId, rdata.userProfile.FirstName, rdata.userProfile.SurName); lock (rdata) @@ -293,7 +286,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory if (rdata.root == null) { - Rest.Log.WarnFormat("{0} Inventory is not available [1] for agent {1} {2}", + Rest.Log.WarnFormat("{0} Inventory is not available [1] for agent {1} {2}", MsgId, rdata.userProfile.FirstName, rdata.userProfile.SurName); rdata.Fail(Rest.HttpStatusCodeServerError, "inventory retrieval failed"); } @@ -301,7 +294,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory } else { - Rest.Log.WarnFormat("{0} Inventory is not locally available for agent {1} {2}", + Rest.Log.WarnFormat("{0} Inventory is not locally available for agent {1} {2}", MsgId, rdata.userProfile.FirstName, rdata.userProfile.SurName); rdata.Fail(Rest.HttpStatusCodeNotFound, "no local inventory for user"); } @@ -311,7 +304,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory switch (rdata.method) { - case Rest.HEAD : // Do the processing, set the status code, suppress entity DoGet(rdata); rdata.buffer = null; @@ -334,12 +326,11 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory break; default : - Rest.Log.WarnFormat("{0} Method {1} not supported for {2}", + Rest.Log.WarnFormat("{0} Method {1} not supported for {2}", MsgId, rdata.method, rdata.path); rdata.Fail(Rest.HttpStatusCodeMethodNotAllowed, rdata.method+" not supported"); - break; + break; } - } #endregion Interface @@ -355,18 +346,17 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory private void DoGet(InventoryRequestData rdata) { - rdata.initXmlWriter(); rdata.writer.WriteStartElement(String.Empty,"Inventory",String.Empty); // If there are additional parameters, then these represent // a path relative to the root of the inventory. This path - // must be traversed before we format the sub-tree thus + // must be traversed before we format the sub-tree thus // identified. traverse(rdata, rdata.root, PARM_PATH); - + // Close all open elements rdata.writer.WriteFullEndElement(); @@ -379,9 +369,8 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory // constructed from the result of the XML writer. rdata.Respond(String.Format("Inventory {0} Normal completion", rdata.method)); - } - + /// /// In the case of the inventory, and probably in general, /// the distinction between PUT and POST is not always @@ -392,7 +381,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory /// consistency across different implementations. /// /// For OpenSim PUT is an update and POST is an addition. This - /// is the behavior required by the HTTP specification and + /// is the behavior required by the HTTP specification and /// therefore as required by REST. /// /// The best way to explain the distinction is to @@ -401,53 +390,51 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory /// actual entity to be modified or replaced, i.e. the /// enclosed entity. /// - /// If the operation is POST,then the URI describes the + /// If the operation is POST,then the URI describes the /// context into which the new entity will be added. /// /// As an example, suppose the URI contains: /// /admin/inventory/Clothing /// /// A PUT request will normally result in some modification of - /// the folder or item named "Clothing". Whereas a POST - /// request will normally add some new information into the + /// the folder or item named "Clothing". Whereas a POST + /// request will normally add some new information into the /// content identified by Clothing. It follows from this /// that for POST, the element identified by the URI MUST /// be a folder. /// /// - /// POST adds new information to the inventory in the + /// POST adds new information to the inventory in the /// context identified by the URI. /// /// HTTP service request work area private void DoExtend(InventoryRequestData rdata) { - bool created = false; bool modified = false; string newnode = String.Empty; // Resolve the context node specified in the URI. Entity // data will be ADDED beneath this node. rdata already contains - // information about the current content of the user's + // information about the current content of the user's // inventory. Object InventoryNode = getInventoryNode(rdata, rdata.root, PARM_PATH, Rest.Fill); // Processing depends upon the type of inventory node // identified in the URI. This is the CONTEXT for the - // change. We either got a context or we threw an + // change. We either got a context or we threw an // exception. // It follows that we can only add information if the URI - // has identified a folder. So only a type of folder is supported + // has identified a folder. So only a type of folder is supported // in this case. if (typeof(InventoryFolderBase) == InventoryNode.GetType() || typeof(InventoryFolderImpl) == InventoryNode.GetType()) { - // Cast the context node appropriately. InventoryFolderBase context = (InventoryFolderBase) InventoryNode; @@ -466,12 +453,11 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory XmlInventoryCollection entity = ReconstituteEntity(rdata); // Inlined assets can be included in entity. These must be incorporated into - // the asset database before we attempt to update the inventory. If anything + // the asset database before we attempt to update the inventory. If anything // fails, return a failure to requestor. if (entity.Assets.Count > 0) { - Rest.Log.DebugFormat("{0} Adding {1} assets to server", MsgId, entity.Assets.Count); @@ -489,9 +475,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory { Rest.Dump(asset.Data); } - } - } // Modify the context using the collection of folders and items @@ -499,7 +483,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory foreach (InventoryFolderBase folder in entity.Folders) { - InventoryFolderBase found; // If the parentID is zero, then this folder is going @@ -544,7 +527,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory modified = true; rdata.appendStatus(String.Format("

Created folder {0}, UUID {1}

", - folder.Name, folder.ID)); + folder.Name, folder.ID)); } else { @@ -553,10 +536,8 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory created = true; rdata.appendStatus(String.Format("

Modified folder {0}, UUID {1}

", - folder.Name, folder.ID)); - + folder.Name, folder.ID)); } - } // Now we repeat a similar process for the items included @@ -564,7 +545,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory foreach (InventoryItemBase item in entity.Items) { - InventoryItemBase found = null; // If the parentID is zero, then this is going @@ -575,7 +555,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory item.Folder = context.ID; } - // Determine whether this is a new item or a + // Determine whether this is a new item or a // replacement definition. foreach (InventoryItemBase xi in rdata.items) @@ -604,7 +584,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory created = true; rdata.appendStatus(String.Format("

Created item {2}, UUID {3}

", item.Name, item.ID)); } - } if (created) @@ -627,7 +606,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory } rdata.Respond("Inventory " + rdata.method + ": Normal completion"); - } else { @@ -635,35 +613,33 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory MsgId, rdata.method, rdata.path, InventoryNode.GetType()); rdata.Fail(Rest.HttpStatusCodeBadRequest, "invalid resource context"); } - } ///

/// PUT updates the URI-identified element in the inventory. This /// is actually far more flexible than it might at first sound. For /// PUT the URI serves two purposes: - /// [1] It identifies the user whose inventory is to be + /// [1] It identifies the user whose inventory is to be /// processed. /// [2] It optionally specifies a subtree of the inventory - /// that is to be used to resolve any relative subtree + /// that is to be used to resolve any relative subtree /// specifications in the entity. If nothing is specified /// then the whole of the private inventory is implied. /// Please note that the subtree specified by the URI is only relevant /// to an entity containing a URI relative specification, i.e. one or - /// more elements do not specify parent folder information. These + /// more elements do not specify parent folder information. These /// elements will be implicitly referenced within the context identified /// by the URI. /// If an element in the entity specifies an explicit parent folder, then /// that parent is effective, regardless of any value specified in the /// URI. If the parent does not exist, then the element, and any dependent - /// elements, are ignored. This case is actually detected and handled + /// elements, are ignored. This case is actually detected and handled /// during the reconstitution process. /// /// HTTP service request work area private void DoUpdate(InventoryRequestData rdata) { - int count = 0; bool created = false; bool modified = false; @@ -675,8 +651,8 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory Object InventoryNode = getInventoryNode(rdata, rdata.root, PARM_PATH, Rest.Fill); // As long as we have a node, then we have something - // meaningful to do, unlike POST. So we reconstitute the - // subtree before doing anything else. Note that we + // meaningful to do, unlike POST. So we reconstitute the + // subtree before doing anything else. Note that we // etiher got a valid node or we threw an exception. XmlInventoryCollection entity = ReconstituteEntity(rdata); @@ -705,33 +681,31 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory { Rest.Dump(asset.Data); } - } } // The URI specifies either a folder or an item to be updated. // // The root node in the entity will replace the node identified - // by the URI. This means the parent will remain the same, but + // by the URI. This means the parent will remain the same, but // any or all attributes associated with the named element // will change. // // If the inventory collection contains an element with a zero - // parent ID, then this is taken to be the replacement for the - // named node. The collection MAY also specify an explicit + // parent ID, then this is taken to be the replacement for the + // named node. The collection MAY also specify an explicit // parent ID, in this case it MAY identify the same parent as - // the current node, or it MAY specify a different parent, + // the current node, or it MAY specify a different parent, // indicating that the folder is being moved in addition to any // other modifications being made. if (typeof(InventoryFolderBase) == InventoryNode.GetType() || typeof(InventoryFolderImpl) == InventoryNode.GetType()) { - bool rfound = false; InventoryFolderBase uri = (InventoryFolderBase) InventoryNode; InventoryFolderBase xml = null; - + // If the entity to be replaced resolved to be the root // directory itself (My Inventory), then make sure that // the supplied data include as appropriately typed and @@ -741,7 +715,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory if (uri == rdata.root) { - foreach (InventoryFolderBase folder in entity.Folders) { if ((rfound = (folder.Name == PRIVATE_ROOT_NAME))) @@ -757,7 +730,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory MsgId, rdata.method, rdata.path); rdata.Fail(Rest.HttpStatusCodeBadRequest, "invalid inventory structure"); } - } // Scan the set of folders in the entity collection for an @@ -768,7 +740,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory // ambiguity in this case because this is POST and we are // supposed to be modifying a specific node. // We assign any element IDs required as an economy; we don't - // want to iterate over the fodler set again if it can be + // want to iterate over the fodler set again if it can be // helped. foreach (InventoryFolderBase folder in entity.Folders) @@ -795,13 +767,12 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory // Exactly one entry means we ARE replacing the node // identified by the URI. So we delete the old folder // by moving it to the trash and then purging it. - // We then add all of the folders and items we + // We then add all of the folders and items we // included in the entity. The subtree has been // modified. if (count == 1) { - InventoryFolderBase TrashCan = GetTrashCan(rdata); // All went well, so we generate a UUID is one is @@ -816,10 +787,9 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory Rest.InventoryServices.MoveFolder(uri); Rest.InventoryServices.PurgeFolder(TrashCan); modified = true; - } - // Now, regardelss of what they represent, we + // Now, regardelss of what they represent, we // integrate all of the elements in the entity. foreach (InventoryFolderBase f in entity.Folders) @@ -833,7 +803,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory rdata.appendStatus(String.Format("

Storing item {0} UUID {1}

", it.Name, it.ID)); Rest.InventoryServices.AddItem(it); } - } ///

@@ -846,7 +815,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory else { - InventoryItemBase uri = (InventoryItemBase) InventoryNode; InventoryItemBase xml = null; @@ -865,7 +833,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory } xml = entity.Items[0]; - + if (xml.ID == LLUUID.Zero) { xml.ID = LLUUID.Random(); @@ -884,7 +852,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory Rest.InventoryServices.AddItem(xml); rdata.appendStatus(String.Format("

Storing item {0} UUID {1}

", xml.Name, xml.ID)); - } if (created) @@ -904,7 +871,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory } rdata.Respond("Inventory " + rdata.method + ": Normal completion"); - } ///

@@ -917,7 +883,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory /// /// Folders are deleted by moving them to another folder and then /// purging that folder. We'll do that by creating a temporary - /// sub-folder in the TrashCan and purging that folder's + /// sub-folder in the TrashCan and purging that folder's /// contents. If we can't can it, we don't delete it... /// So, if no trashcan is available, the request does nothing. /// Items are summarily deleted. @@ -930,13 +896,11 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory private void DoDelete(InventoryRequestData rdata) { - Object InventoryNode = getInventoryNode(rdata, rdata.root, PARM_PATH, false); if (typeof(InventoryFolderBase) == InventoryNode.GetType() || typeof(InventoryFolderImpl) == InventoryNode.GetType()) { - InventoryFolderBase TrashCan = GetTrashCan(rdata); InventoryFolderBase folder = (InventoryFolderBase) InventoryNode; @@ -947,7 +911,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory Rest.InventoryServices.PurgeFolder(TrashCan); rdata.appendStatus(String.Format("

Deleted folder {0} UUID {1}

", folder.Name, folder.ID)); - } // Deleting items is much more straight forward. @@ -963,7 +926,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory rdata.Complete(); rdata.Respond("Inventory " + rdata.method + ": Normal completion"); - } #endregion method-specific processing @@ -971,10 +933,10 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory ///

/// This method is called to obtain the OpenSim inventory object identified /// by the supplied URI. This may be either an Item or a Folder, so a suitably - /// ambiguous return type is employed (Object). This method recurses as + /// ambiguous return type is employed (Object). This method recurses as /// necessary to process the designated hierarchy. - /// - /// If we reach the end of the URI then we return the contextual folder to + /// + /// If we reach the end of the URI then we return the contextual folder to /// our caller. /// /// If we are not yet at the end of the URI we attempt to find a child folder @@ -1000,7 +962,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory InventoryFolderBase folder, int pi, bool fill) { - InventoryFolderBase foundf = null; int fk = 0; @@ -1013,18 +974,19 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory return folder; } - // There are more names in the parameter sequence, - // look for the folder named by param[pi] as a + // There are more names in the parameter sequence, + // look for the folder named by param[pi] as a // child of the folder supplied as an argument. // Note that a UUID may have been supplied as the // identifier (it is the ONLY guaranteed unambiguous - // option. + // option. if (rdata.folders != null) + { foreach (InventoryFolderBase f in rdata.folders) { // Look for the present node in the directory list - if (f.ParentID == folder.ID && + if (f.ParentID == folder.ID && (f.Name == rdata.Parameters[pi] || f.ID.ToString() == rdata.Parameters[pi])) { @@ -1032,7 +994,8 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory fk++; } } - + } + // If more than one node matched, then the path, as specified // is ambiguous. @@ -1063,7 +1026,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory InventoryItemBase li = null; foreach (InventoryItemBase i in rdata.items) { - if (i.Folder == folder.ID && + if (i.Folder == folder.ID && (i.Name == rdata.Parameters[pi] || i.ID.ToString() == rdata.Parameters[pi])) { @@ -1099,11 +1062,10 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory rdata.Fail(Rest.HttpStatusCodeNotFound, "resource "+rdata.path+" not found"); return null; /* Never reached */ - } /// - /// This routine traverse the inventory's structure until the end-point identified + /// This routine traverse the inventory's structure until the end-point identified /// in the URI is reached, the remainder of the inventory (if any) is then formatted /// and returned to the requestor. /// @@ -1119,13 +1081,11 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory private void traverse(InventoryRequestData rdata, InventoryFolderBase folder, int pi) { - Rest.Log.DebugFormat("{0} Traverse[initial] : {1} {2} [{3}]", MsgId, folder.ID, folder.Name, pi); if (rdata.folders != null) { - - // If there was only one parameter (avatar name), then the entire + // If there was only one parameter (avatar name), then the entire // inventory is being requested. if (rdata.Parameters.Length == 1) @@ -1159,18 +1119,16 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory } return; - } } /// - /// This is the recursive method. I've separated them in this way so that + /// This is the recursive method. I've separated them in this way so that /// we do not have to waste cycles on any first-case-only processing. /// private void traverseInventory(InventoryRequestData rdata, InventoryFolderBase folder, int pi) { - int fk = 0; InventoryFolderBase ffound = null; InventoryItemBase ifound = null; @@ -1179,7 +1137,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory foreach (InventoryFolderBase f in rdata.folders) { - if (f.ParentID == folder.ID && + if (f.ParentID == folder.ID && (f.Name == rdata.Parameters[pi] || f.ID.ToString() == rdata.Parameters[pi])) { @@ -1194,14 +1152,13 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory if (pi == rdata.Parameters.Length-1) { - // Only if there are any items, and there pretty much always are. if (rdata.items != null) { foreach (InventoryItemBase i in rdata.items) { - if (i.Folder == folder.ID && + if (i.Folder == folder.ID && (i.Name == rdata.Parameters[pi] || i.ID.ToString() == rdata.Parameters[pi])) { @@ -1230,7 +1187,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory { // Fetching an Item has a special significance. In this // case we also want to fetch the associated asset. - // To make it interesting, we'll d this via redirection. + // To make it interesting, we'll d this via redirection. string asseturl = "http://" + rdata.hostname + ":" + rdata.port + "/admin/assets" + Rest.UrlPathSeparator + ifound.AssetID.ToString(); rdata.Redirect(asseturl,Rest.PERMANENT); @@ -1240,14 +1197,14 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory else if (fk > 1) { rdata.Fail(Rest.HttpStatusCodeConflict, - String.Format("ambiguous element ({0}) in path specified: <{1}>", - pi, rdata.path)); + String.Format("ambiguous element ({0}) in path specified: <{1}>", + pi, rdata.path)); } - Rest.Log.DebugFormat("{0} Inventory does not contain item/folder: <{1}>", + Rest.Log.DebugFormat("{0} Inventory does not contain item/folder: <{1}>", MsgId, rdata.path); rdata.Fail(Rest.HttpStatusCodeNotFound,String.Format("no such item/folder : {0}", - rdata.Parameters[pi])); + rdata.Parameters[pi])); } @@ -1264,10 +1221,9 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory private void formatInventory(InventoryRequestData rdata, InventoryFolderBase folder, string indent) { - if (Rest.DEBUG) { - Rest.Log.DebugFormat("{0} Folder : {1} {2} {3} type = {4}", + Rest.Log.DebugFormat("{0} Folder : {1} {2} {3} type = {4}", MsgId, folder.ID, indent, folder.Name, folder.Type); indent += "\t"; } @@ -1307,7 +1263,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory // End folder item rdata.writer.WriteEndElement(); - } /// @@ -1319,8 +1274,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory private void formatItem(InventoryRequestData rdata, InventoryItemBase i, string indent) { - - Rest.Log.DebugFormat("{0} Item : {1} {2} {3} Type = {4}, AssetType = {5}", + Rest.Log.DebugFormat("{0} Item : {1} {2} {3} Type = {4}, AssetType = {5}", MsgId, i.ID, indent, i.Name, i.InvType, i.AssetType); rdata.writer.WriteStartElement(String.Empty,"Item",String.Empty); @@ -1350,11 +1304,10 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory rdata.writer.WriteElementString("Asset",i.AssetID.ToString()); rdata.writer.WriteEndElement(); - } /// - /// This method creates a "trashcan" folder to support folder and item + /// This method creates a "trashcan" folder to support folder and item /// deletions by this interface. The xisting trash folder is found and /// this folder is created within it. It is called "tmp" to indicate to /// the client that it is OK to delete this folder. The REST interface @@ -1366,7 +1319,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory private InventoryFolderBase GetTrashCan(InventoryRequestData rdata) { - InventoryFolderBase TrashCan = null; foreach (InventoryFolderBase f in rdata.folders) @@ -1393,7 +1345,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory } } } - + if (TrashCan == null) { Rest.Log.DebugFormat("{0} No Trash Can available", MsgId); @@ -1401,7 +1353,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory } return TrashCan; - } /// @@ -1413,11 +1364,11 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory private bool FolderHasChanged(InventoryFolderBase newf, InventoryFolderBase oldf) { - return ( newf.Name != oldf.Name - || newf.ParentID != oldf.ParentID - || newf.Owner != oldf.Owner - || newf.Type != oldf.Type - || newf.Version != oldf.Version + return (newf.Name != oldf.Name + || newf.ParentID != oldf.ParentID + || newf.Owner != oldf.Owner + || newf.Type != oldf.Type + || newf.Version != oldf.Version ); } @@ -1430,24 +1381,24 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory private bool ItemHasChanged(InventoryItemBase newf, InventoryItemBase oldf) { - return ( newf.Name != oldf.Name - || newf.Folder != oldf.Description - || newf.Description != oldf.Description - || newf.Owner != oldf.Owner - || newf.Creator != oldf.Creator - || newf.AssetID != oldf.AssetID - || newf.GroupID != oldf.GroupID - || newf.GroupOwned != oldf.GroupOwned - || newf.InvType != oldf.InvType - || newf.AssetType != oldf.AssetType + return (newf.Name != oldf.Name + || newf.Folder != oldf.Description + || newf.Description != oldf.Description + || newf.Owner != oldf.Owner + || newf.Creator != oldf.Creator + || newf.AssetID != oldf.AssetID + || newf.GroupID != oldf.GroupID + || newf.GroupOwned != oldf.GroupOwned + || newf.InvType != oldf.InvType + || newf.AssetType != oldf.AssetType ); } /// /// This method is called by PUT and POST to create an XmlInventoryCollection /// instance that reflects the content of the entity supplied on the request. - /// Any elements in the completed collection whose UUID is zero, are - /// considered to be located relative to the end-point identified int he + /// Any elements in the completed collection whose UUID is zero, are + /// considered to be located relative to the end-point identified int he /// URI. In this way, an entire sub-tree can be conveyed in a single REST /// PUT or POST request. /// @@ -1455,27 +1406,25 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory /// has an entity, it is more completely initialized. thus, if no entity was /// provided the collection is valid, but empty. /// - /// The entity is then scanned and each tag is processed to produce the + /// The entity is then scanned and each tag is processed to produce the /// appropriate inventory elements. At the end f the scan, teh XmlInventoryCollection /// will reflect the subtree described by the entity. /// /// This is a very flexible mechanism, the entity may contain arbitrary, /// discontiguous tree fragments, or may contain single element. The caller is - /// responsible for integrating this collection (and ensuring that any + /// responsible for integrating this collection (and ensuring that any /// missing parent IDs are resolved). /// /// HTTP service request work area internal XmlInventoryCollection ReconstituteEntity(InventoryRequestData rdata) { - Rest.Log.DebugFormat("{0} Reconstituting entity", MsgId); XmlInventoryCollection ic = new XmlInventoryCollection(); if (rdata.request.HasEntityBody) { - Rest.Log.DebugFormat("{0} Entity present", MsgId); ic.init(rdata); @@ -1571,7 +1520,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory Rest.Log.WarnFormat("{0} Unexpected XML parsing error: {1}", MsgId, e.Message); throw e; } - } else { @@ -1587,14 +1535,13 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory } return ic; - } /// /// This method creates an inventory Folder from the /// information supplied in the request's entity. - /// A folder instance is created and initialized to reflect - /// default values. These values are then overridden + /// A folder instance is created and initialized to reflect + /// default values. These values are then overridden /// by information supplied in the entity. /// If context was not explicitly provided, then the /// appropriate ID values are determined. @@ -1602,7 +1549,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory private void CollectFolder(XmlInventoryCollection ic) { - Rest.Log.DebugFormat("{0} Interpret folder element", MsgId); InventoryFolderBase result = new InventoryFolderBase(); @@ -1614,7 +1560,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory result.Owner = ic.UserID; result.ParentID = LLUUID.Zero; // Context result.Type = (short) AssetType.Folder; - result.Version = 1; + result.Version = 1; if (ic.xml.HasAttributes) { @@ -1642,7 +1588,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory result.Version = UInt16.Parse(ic.xml.Value); break; default : - Rest.Log.DebugFormat("{0} Folder: unrecognized attribute: {1}:{2}", + Rest.Log.DebugFormat("{0} Folder: unrecognized attribute: {1}:{2}", MsgId, ic.xml.Name, ic.xml.Value); ic.Fail(Rest.HttpStatusCodeBadRequest, String.Format("unrecognized attribute <{0}>", ic.xml.Name)); @@ -1664,7 +1610,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory } else { - bool found = false; foreach (InventoryFolderBase parent in ic.rdata.folders) @@ -1678,11 +1623,10 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory if (!found) { - Rest.Log.ErrorFormat("{0} Invalid parent ID ({1}) in folder {2}", + Rest.Log.ErrorFormat("{0} Invalid parent ID ({1}) in folder {2}", MsgId, ic.Item.Folder, result.ID); ic.Fail(Rest.HttpStatusCodeBadRequest, "invalid parent"); } - } // This is a new folder, so no existing UUID is available @@ -1697,15 +1641,14 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory // obsolete as a consequence. ic.Push(result); - } /// /// This method is called to handle the construction of an Item - /// instance from the supplied request entity. It is called + /// instance from the supplied request entity. It is called /// whenever an Item start tag is detected. /// An instance of an Item is created and initialized to default - /// values. These values are then overridden from values supplied + /// values. These values are then overridden from values supplied /// as attributes to the Item element. /// This item is then stored in the XmlInventoryCollection and /// will be verified by Validate. @@ -1715,7 +1658,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory private void CollectItem(XmlInventoryCollection ic) { - Rest.Log.DebugFormat("{0} Interpret item element", MsgId); InventoryItemBase result = new InventoryItemBase(); @@ -1736,7 +1678,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory { for (int i = 0; i < ic.xml.AttributeCount; i++) { - ic.xml.MoveToAttribute(i); switch (ic.xml.Name) @@ -1785,37 +1726,36 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory break; default : - Rest.Log.DebugFormat("{0} Item: Unrecognized attribute: {1}:{2}", + Rest.Log.DebugFormat("{0} Item: Unrecognized attribute: {1}:{2}", MsgId, ic.xml.Name, ic.xml.Value); ic.Fail(Rest.HttpStatusCodeBadRequest, String.Format("unrecognized attribute", ic.xml.Name)); break; } } - } - + } + ic.xml.MoveToElement(); ic.Push(result); - } /// - /// This method assembles an asset instance from the - /// information supplied in the request's entity. It is - /// called as a result of detecting a start tag for a + /// This method assembles an asset instance from the + /// information supplied in the request's entity. It is + /// called as a result of detecting a start tag for a /// type of Asset. /// The information is collected locally, and an asset /// instance is created only if the basic XML parsing /// completes successfully. - /// Default values for all parts of the asset are + /// Default values for all parts of the asset are /// established before overriding them from the supplied /// XML. /// If an asset has inline=true as an attribute, then /// the element contains the data representing the /// asset. This is saved as the data component. /// inline=false means that the element's payload is - /// simply the UUID of the asset referenced by the + /// simply the UUID of the asset referenced by the /// item being constructed. /// An asset, if created is stored in the /// XmlInventoryCollection @@ -1876,9 +1816,9 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory break; default : - Rest.Log.DebugFormat("{0} Asset: Unrecognized attribute: {1}:{2}", + Rest.Log.DebugFormat("{0} Asset: Unrecognized attribute: {1}:{2}", MsgId, ic.xml.Name, ic.xml.Value); - ic.Fail(Rest.HttpStatusCodeBadRequest, + ic.Fail(Rest.HttpStatusCodeBadRequest, String.Format("unrecognized attribute <{0}>", ic.xml.Name)); break; } @@ -1889,7 +1829,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory // If this is a reference to an existing asset, just store the // asset ID into the item. - + if (!inline) { if (ic.Item != null) @@ -1904,13 +1844,12 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory } } - // Otherwise, generate an asset ID, store that into the item, and + // Otherwise, generate an asset ID, store that into the item, and // create an entry in the asset list for the inlined asset. But // only if the size is non-zero. else { - string b64string = null; // Generate a UUID of none were given, and generally none should @@ -1923,17 +1862,17 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory // Create AssetBase entity to hold the inlined asset - asset = new AssetBase(uuid, name); + asset = new AssetBase(uuid, name); asset.Description = desc; asset.Type = type; // type == 0 == texture asset.Local = local; asset.Temporary = temp; - + b64string = ic.xml.ReadElementContentAsString(); Rest.Log.DebugFormat("{0} Data length is {1}", MsgId, b64string.Length); - Rest.Log.DebugFormat("{0} Data content starts with: \n\t<{1}>", MsgId, + Rest.Log.DebugFormat("{0} Data content starts with: \n\t<{1}>", MsgId, b64string.Substring(0, b64string.Length > 132 ? 132 : b64string.Length)); asset.Data = Convert.FromBase64String(b64string); @@ -1952,7 +1891,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory { ic.Item.AssetID = uuid; } - } ic.Push(asset); @@ -1961,13 +1899,12 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory /// /// Store any permissions information provided by the request. - /// This overrides the default permissions set when the + /// This overrides the default permissions set when the /// XmlInventoryCollection object was created. /// private void CollectPermissions(XmlInventoryCollection ic) { - if (ic.xml.HasAttributes) { for (int i = 0; i < ic.xml.AttributeCount; i++) @@ -1990,7 +1927,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory default : Rest.Log.DebugFormat("{0} Permissions: invalid attribute {1}:{2}", MsgId,ic.xml.Name, ic.xml.Value); - ic.Fail(Rest.HttpStatusCodeBadRequest, + ic.Fail(Rest.HttpStatusCodeBadRequest, String.Format("invalid attribute <{0}>", ic.xml.Name)); break; } @@ -1998,7 +1935,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory } ic.xml.MoveToElement(); - } /// @@ -2013,7 +1949,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory private void Validate(XmlInventoryCollection ic) { - // There really should be an item present if we've // called validate. So fail if there is not. @@ -2022,7 +1957,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory Rest.Log.ErrorFormat("{0} Unable to parse request", MsgId); ic.Fail(Rest.HttpStatusCodeBadRequest, "request parse error"); } - + // Every item is required to have a name (via REST anyway) if (ic.Item.Name == String.Empty) @@ -2030,18 +1965,16 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory Rest.Log.ErrorFormat("{0} An item name MUST be specified", MsgId); ic.Fail(Rest.HttpStatusCodeBadRequest, "item name required"); } - - // An item MUST have an asset ID. AssetID should never be zero + + // An item MUST have an asset ID. AssetID should never be zero // here. It should always get set from the information stored // when the Asset element was processed. if (ic.Item.AssetID == LLUUID.Zero) { - Rest.Log.ErrorFormat("{0} Unable to complete request", MsgId); Rest.Log.InfoFormat("{0} Asset information is missing", MsgId); ic.Fail(Rest.HttpStatusCodeBadRequest, "asset information required"); - } // If the item is new, then assign it an ID @@ -2054,14 +1987,13 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory // If the context is being implied, obtain the current // folder item's ID. If it was specified explicitly, make // sure that theparent folder exists. - + if (ic.Item.Folder == LLUUID.Zero) { ic.Item.Folder = ic.Parent(); } else { - bool found = false; foreach (InventoryFolderBase parent in ic.rdata.folders) @@ -2075,11 +2007,10 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory if (!found) { - Rest.Log.ErrorFormat("{0} Invalid parent ID ({1}) in item {2}", + Rest.Log.ErrorFormat("{0} Invalid parent ID ({1}) in item {2}", MsgId, ic.Item.Folder, ic.Item.ID); ic.Fail(Rest.HttpStatusCodeBadRequest, "parent information required"); } - } // If this is an inline asset being constructed in the context @@ -2101,13 +2032,12 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory ic.Item.NextPermissions = ic.NextPermissions; // If no type was specified for this item, we can attempt to - // infer something from the file type maybe. This is NOT as + // infer something from the file type maybe. This is NOT as // good as having type be specified in the XML. if (ic.Item.AssetType == (int) AssetType.Unknown || ic.Item.InvType == (int) AssetType.Unknown) { - Rest.Log.DebugFormat("{0} Attempting to infer item type", MsgId); string[] parts = ic.Item.Name.Split(Rest.CA_PERIOD); @@ -2127,7 +2057,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory if (parts.Length > 1) { - Rest.Log.DebugFormat("{0} File type is {1}", + Rest.Log.DebugFormat("{0} File type is {1}", MsgId, parts[parts.Length - 1]); switch (parts[parts.Length - 1]) { @@ -2135,7 +2065,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory case "jpeg-2000" : case "jpg2000" : case "jpg-2000" : - Rest.Log.DebugFormat("{0} Type {1} inferred", + Rest.Log.DebugFormat("{0} Type {1} inferred", MsgId, parts[parts.Length-1]); if (ic.Item.AssetType == (int) AssetType.Unknown) ic.Item.AssetType = (int) AssetType.ImageJPEG; @@ -2144,7 +2074,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory break; case "jpg" : case "jpeg" : - Rest.Log.DebugFormat("{0} Type {1} inferred", + Rest.Log.DebugFormat("{0} Type {1} inferred", MsgId, parts[parts.Length - 1]); if (ic.Item.AssetType == (int) AssetType.Unknown) ic.Item.AssetType = (int) AssetType.ImageJPEG; @@ -2168,7 +2098,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory } break; default : - Rest.Log.DebugFormat("{0} Asset/Inventory type could not be inferred for {1}", + Rest.Log.DebugFormat("{0} Asset/Inventory type could not be inferred for {1}", MsgId,ic.Item.Name); break; } @@ -2186,16 +2116,14 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory temp = OpenJPEGNet.LoadTGAClass.LoadTGA(tgadata); ic.Asset.Data = OpenJPEGNet.OpenJPEG.EncodeFromImage(temp, true); } - - ic.reset(); + ic.reset(); } #region Inventory RequestData extension internal class InventoryRequestData : RequestData { - /// /// These are the inventory specific request/response state /// extensions. @@ -2214,7 +2142,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory } /// - /// This is the callback method required by inventory services. The + /// This is the callback method required by inventory services. The /// requestor issues an inventory request and then blocks until this /// method signals the monitor. /// @@ -2230,7 +2158,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory Monitor.Pulse(this); } } - } #endregion Inventory RequestData extension @@ -2243,7 +2170,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory internal class XmlInventoryCollection : InventoryCollection { - internal InventoryRequestData rdata; private Stack stk; @@ -2336,7 +2262,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory { rdata.Fail(code, addendum); } - } } } diff --git a/OpenSim/ApplicationPlugins/Rest/Inventory/tests/Remote.cs b/OpenSim/ApplicationPlugins/Rest/Inventory/tests/Remote.cs index c50a945..1cbe38f 100644 --- a/OpenSim/ApplicationPlugins/Rest/Inventory/tests/Remote.cs +++ b/OpenSim/ApplicationPlugins/Rest/Inventory/tests/Remote.cs @@ -23,7 +23,6 @@ * 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; @@ -41,10 +40,8 @@ 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; @@ -72,7 +69,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory.Tests } // Called by the plug-in to halt REST processing. Local processing is - // disabled, and control blocks until all current processing has + // disabled, and control blocks until all current processing has // completed. No new processing will be started public void Close() @@ -91,11 +88,10 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory.Tests // Remote Handler // Key information of interest here is the Parameters array, each // entry represents an element of the URI, with element zero being - // the + // the public void Execute(RequestData rdata) { - if (!enabled) return; // If we can't relate to what's there, leave it for others. @@ -125,7 +121,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory.Tests { DoHelp(rdata); } - } + } private void DoHelp(RequestData rdata) { @@ -138,7 +134,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory.Tests { if (rdata.Parameters.Length >= 6) { - string[] names = rdata.Parameters[PARM_MOVE_AVATAR].Split(Rest.CA_SPACE); ScenePresence avatar = null; Scene scene = null; @@ -149,7 +144,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory.Tests String.Format("invalid avatar name: <{0}>",rdata.Parameters[PARM_MOVE_AVATAR])); } - Rest.Log.WarnFormat("{0} '{1}' command received for {2} {3}", + 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 @@ -171,8 +166,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory.Tests if (avatar != null) { - - Rest.Log.DebugFormat("{0} Move : Avatar {1} located in region {2}", + Rest.Log.DebugFormat("{0} Move : Avatar {1} located in region {2}", MsgId, rdata.Parameters[PARM_MOVE_AVATAR], scene.RegionInfo.RegionName); try @@ -185,16 +179,16 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory.Tests } catch (Exception e) { - rdata.Fail(Rest.HttpStatusCodeBadRequest, - String.Format("invalid parameters: {0}", e.Message)); + rdata.Fail(Rest.HttpStatusCodeBadRequest, + String.Format("invalid parameters: {0}", e.Message)); } } else { - rdata.Fail(Rest.HttpStatusCodeBadRequest, + rdata.Fail(Rest.HttpStatusCodeBadRequest, String.Format("avatar {0} not present", rdata.Parameters[PARM_MOVE_AVATAR])); - } + } rdata.Complete(); rdata.Respond("OK"); @@ -205,7 +199,6 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory.Tests Rest.Log.WarnFormat("{0} Move: No movement information provided", MsgId); rdata.Fail(Rest.HttpStatusCodeBadRequest, "no movement information provided"); } - } private static readonly string Help = @@ -220,6 +213,5 @@ namespace OpenSim.ApplicationPlugins.Rest.Inventory.Tests + "" + "" ; - } } -- cgit v1.1