Merge remote-tracking branch 'os/master'

1 files changed, 117 insertions, 0 deletions

diff --git a/OpenSim/Framework/Servers/HttpServer/BaseRequestHandler.cs b/OpenSim/Framework/Servers/HttpServer/BaseRequestHandler.cs
new file mode 100644
index 0000000..d4a1ec3
--- /dev/null
+++ b/OpenSim/Framework/Servers/HttpServer/BaseRequestHandler.cs
@@ -0,0 +1,117 @@
+/*
+ * 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 OpenSimulator 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.Monitoring;
+
+namespace OpenSim.Framework.Servers.HttpServer
+{
+    public abstract class BaseRequestHandler
+    {
+        public int RequestsReceived { get; protected set; }
+
+        public int RequestsHandled { get; protected set; }
+
+        public virtual string ContentType
+        {
+            get { return "application/xml"; }
+        }
+
+        private readonly string m_httpMethod;
+
+        public virtual string HttpMethod
+        {
+            get { return m_httpMethod; }
+        }
+
+        private readonly string m_path;
+
+        public string Name { get; private set; }
+
+        public string Description { get; private set; }
+
+        protected BaseRequestHandler(string httpMethod, string path) : this(httpMethod, path, null, null) {}
+
+        protected BaseRequestHandler(string httpMethod, string path, string name, string description)
+        {
+            Name = name;
+            Description = description;
+            m_httpMethod = httpMethod;
+            m_path = path;
+
+            // FIXME: A very temporary measure to stop the simulator stats being overwhelmed with user CAPS info.
+            // Needs to be fixed properly in stats display
+            if (!path.StartsWith("/CAPS/"))
+            {
+                StatsManager.RegisterStat(
+                    new Stat(
+                    "requests", 
+                    "requests", 
+                    "Number of requests received by this service endpoint", 
+                    "requests", 
+                    "service", 
+                    string.Format("{0}:{1}", httpMethod, path), 
+                    StatType.Pull, 
+                    MeasuresOfInterest.AverageChangeOverTime,
+                    s => s.Value = RequestsReceived,
+                    StatVerbosity.Debug));
+            }
+        }
+
+        public virtual string Path
+        {
+            get { return m_path; }
+        }
+
+        public string GetParam(string path)
+        {
+            if (CheckParam(path))
+            {
+                return path.Substring(m_path.Length);
+            }
+
+            return String.Empty;
+        }
+
+        protected bool CheckParam(string path)
+        {
+            if (String.IsNullOrEmpty(path))
+            {
+                return false;
+            }
+
+            return path.StartsWith(Path);
+        }
+
+        public string[] SplitParams(string path)
+        {
+            string param = GetParam(path);
+
+            return param.Split(new char[] { '/', '?', '&' }, StringSplitOptions.RemoveEmptyEntries);
+        }
+    }
+}