Filling in the blanks: The "meat" of the REST console

OpenSim/Framework/Console/CommandConsole.cs

@@ -26,6 +26,7 @@
  */
 
 using System;
+using System.Xml;
 using System.Collections.Generic;
 using System.Diagnostics;
 using System.Reflection;
@@ -369,6 +370,65 @@ namespace OpenSim.Framework.Console
             
             return new string[0];
         }
+
+        public XmlElement GetXml(XmlDocument doc)
+        {
+            XmlElement root = doc.CreateElement("", "HelpTree", "");
+
+            ProcessTreeLevel(tree, root, doc);
+
+            return root;
+        }
+
+        private void ProcessTreeLevel(Dictionary<string, object> level, XmlElement xml, XmlDocument doc)
+        {
+            foreach (KeyValuePair<string, object> kvp in level)
+            {
+                if (kvp.Value is Dictionary<string, Object>)
+                {
+                    XmlElement next = doc.CreateElement("", "Level", "");
+                    next.SetAttribute("Name", kvp.Key);
+
+                    xml.AppendChild(next);
+
+                    ProcessTreeLevel((Dictionary<string, object>)kvp.Value, next, doc);
+                }
+                else
+                {
+                    CommandInfo c = (CommandInfo)kvp.Value;
+
+                    XmlElement cmd = doc.CreateElement("", "Command", "");
+
+                    XmlElement e;
+
+                    e = doc.CreateElement("", "Module", "");
+                    cmd.AppendChild(e);
+                    e.AppendChild(doc.CreateTextNode(c.module));
+
+                    e = doc.CreateElement("", "Shared", "");
+                    cmd.AppendChild(e);
+                    e.AppendChild(doc.CreateTextNode(c.shared.ToString()));
+
+                    e = doc.CreateElement("", "HelpText", "");
+                    cmd.AppendChild(e);
+                    e.AppendChild(doc.CreateTextNode(c.help_text));
+
+                    e = doc.CreateElement("", "LongHelp", "");
+                    cmd.AppendChild(e);
+                    e.AppendChild(doc.CreateTextNode(c.long_help));
+
+                    e = doc.CreateElement("", "Description", "");
+                    cmd.AppendChild(e);
+                    e.AppendChild(doc.CreateTextNode(c.descriptive_help));
+
+                    xml.AppendChild(cmd);
+                }
+            }
+        }
+
+        public void FromXml(XmlElement root)
+        {
+        }
     }
 
     public class Parser

OpenSim/Framework/Console/RemoteConsole.cs

@@ -26,30 +26,43 @@
  */
 
 using System;
+using System.Xml;
+using System.Collections;
 using System.Collections.Generic;
 using System.Diagnostics;
 using System.Reflection;
 using System.Text;
 using System.Threading;
+using OpenMetaverse;
 using Nini.Config;
 using OpenSim.Framework.Servers.HttpServer;
 using log4net;
 
 namespace OpenSim.Framework.Console
 {
+    public class ConsoleConnection
+    {
+        public int last;
+        public long lastLineSeen;
+    }
+
     // A console that uses REST interfaces
     //
     public class RemoteConsole : CommandConsole
     {
-//        private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
+        private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
 
-        // private IHttpServer m_Server = null;
+        private IHttpServer m_Server = null;
-        // private IConfigSource m_Config = null;
+        private IConfigSource m_Config = null;
 
         private List<string> m_Scrollback = new List<string>();
         private ManualResetEvent m_DataEvent = new ManualResetEvent(false);
         private List<string> m_InputData = new List<string>();
-        private uint m_LineNumber = 1;
+        private long m_LineNumber = 0;
+        private Dictionary<UUID, ConsoleConnection> m_Connections =
+                new Dictionary<UUID, ConsoleConnection>();
+        private string m_UserName = String.Empty;
+        private string m_Password = String.Empty;
 
         public RemoteConsole(string defaultPrompt) : base(defaultPrompt)
         {
@@ -57,12 +70,23 @@ namespace OpenSim.Framework.Console
 
         public void ReadConfig(IConfigSource config)
         {
-            // m_Config = config;
+            m_Config = config;
+
+            IConfig netConfig = m_Config.Configs["Network"];
+            if (netConfig == null)
+                return;
+
+            m_UserName = netConfig.GetString("ConsoleUser", String.Empty);
+            m_Password = netConfig.GetString("ConsolePass", String.Empty);
         }
 
         public void SetServer(IHttpServer server)
         {
-            // m_Server = server;
+            m_Server = server;
+
+            m_Server.AddHTTPHandler("/StartSession/", HandleHttpStartSession);
+            m_Server.AddHTTPHandler("/CloseSession/", HandleHttpCloseSession);
+            m_Server.AddHTTPHandler("/SessionCommand/", HandleHttpSessionCommand);
         }
 
         public override void Output(string text, string level)
@@ -71,16 +95,14 @@ namespace OpenSim.Framework.Console
             {
                 while (m_Scrollback.Count >= 1000)
                     m_Scrollback.RemoveAt(0);
-                m_Scrollback.Add(String.Format("{0}", m_LineNumber)+":"+level+":"+text);
                 m_LineNumber++;
+                m_Scrollback.Add(String.Format("{0}", m_LineNumber)+":"+level+":"+text);
             }
             System.Console.Write(text);
         }
 
         public override string ReadLine(string p, bool isCommand, bool e)
         {
-            System.Console.Write("{0}", prompt);
-            
             m_DataEvent.WaitOne();
 
             lock (m_InputData)
@@ -115,5 +137,299 @@ namespace OpenSim.Framework.Console
                 return cmdinput;
             }
         }
+
+        private void DoExpire()
+        {
+            List<UUID> expired = new List<UUID>();
+
+            lock (m_Connections)
+            {
+                foreach (KeyValuePair<UUID, ConsoleConnection> kvp in m_Connections)
+                {
+                    if (System.Environment.TickCount - kvp.Value.last > 500000)
+                        expired.Add(kvp.Key);
+                }
+
+                foreach (UUID id in expired)
+                {
+                    System.Console.WriteLine("Expired {0}", id.ToString());
+                    CloseConnection(id);
+                    m_Connections.Remove(id);
+                }
+            }
+        }
+
+        private Hashtable HandleHttpStartSession(Hashtable request)
+        {
+            DoExpire();
+
+            Hashtable post = DecodePostString(request["body"].ToString());
+            Hashtable reply = new Hashtable();
+
+            reply["str_response_string"] = "";
+            reply["int_response_code"] = 401;
+            reply["content_type"] = "text/plain";
+
+            if (m_UserName == String.Empty)
+                return reply;
+
+            if (post["USER"] == null || post["PASS"] == null)
+                return reply;
+
+            if (m_UserName != post["USER"].ToString() ||
+                m_Password != post["PASS"].ToString())
+            {
+                return reply;
+            }
+
+            ConsoleConnection c = new ConsoleConnection();
+            c.last = System.Environment.TickCount;
+            c.lastLineSeen = 0;
+
+            UUID sessionID = UUID.Random();
+
+            lock (m_Connections)
+            {
+                m_Connections[sessionID] = c;
+            }
+
+            string uri = "/ReadResponses/" + sessionID.ToString() + "/";
+
+            m_Server.AddPollServiceHTTPHandler(uri, HandleHttpCloseSession,
+                    new PollServiceEventArgs(HasEvents, GetEvents, NoEvents,
+                    sessionID));
+
+            XmlDocument xmldoc = new XmlDocument();
+            XmlNode xmlnode = xmldoc.CreateNode(XmlNodeType.XmlDeclaration,
+                    "", "");
+
+            xmldoc.AppendChild(xmlnode);
+            XmlElement rootElement = xmldoc.CreateElement("", "ConsoleSession",
+                    "");
+
+            xmldoc.AppendChild(rootElement);
+
+            XmlElement id = xmldoc.CreateElement("", "SessionID", "");
+            id.AppendChild(xmldoc.CreateTextNode(sessionID.ToString()));
+
+            rootElement.AppendChild(id);
+            rootElement.AppendChild(MainConsole.Instance.Commands.GetXml(xmldoc));
+
+            reply["str_response_string"] = xmldoc.InnerXml;
+            reply["int_response_code"] = 200;
+            reply["content_type"] = "text/xml";
+
+            return reply;
+        }
+
+        private Hashtable HandleHttpCloseSession(Hashtable request)
+        {
+            DoExpire();
+
+            Hashtable post = DecodePostString(request["body"].ToString());
+            Hashtable reply = new Hashtable();
+
+            reply["str_response_string"] = "";
+            reply["int_response_code"] = 404;
+            reply["content_type"] = "text/plain";
+
+            if (post["ID"] == null)
+                return reply;
+
+            UUID id;
+            if (!UUID.TryParse(post["ID"].ToString(), out id))
+                return reply;
+
+            lock (m_Connections)
+            {
+                if (m_Connections.ContainsKey(id))
+                {
+                    CloseConnection(id);
+                    m_Connections.Remove(id);
+                }
+            }
+
+            XmlDocument xmldoc = new XmlDocument();
+            XmlNode xmlnode = xmldoc.CreateNode(XmlNodeType.XmlDeclaration,
+                    "", "");
+
+            xmldoc.AppendChild(xmlnode);
+            XmlElement rootElement = xmldoc.CreateElement("", "ConsoleSession",
+                    "");
+
+            xmldoc.AppendChild(rootElement);
+
+            XmlElement res = xmldoc.CreateElement("", "Result", "");
+            res.AppendChild(xmldoc.CreateTextNode("OK"));
+
+            rootElement.AppendChild(res);
+
+            reply["str_response_string"] = xmldoc.InnerXml;
+            reply["int_response_code"] = 200;
+            reply["content_type"] = "text/plain";
+
+            return reply;
+        }
+
+        private Hashtable HandleHttpSessionCommand(Hashtable request)
+        {
+            DoExpire();
+
+            Hashtable post = DecodePostString(request["body"].ToString());
+            Hashtable reply = new Hashtable();
+
+            reply["str_response_string"] = "";
+            reply["int_response_code"] = 404;
+            reply["content_type"] = "text/plain";
+
+            if (post["ID"] == null)
+                return reply;
+
+            UUID id;
+            if (!UUID.TryParse(post["ID"].ToString(), out id))
+                return reply;
+
+            if (post["COMMAND"] == null || post["COMMAND"].ToString() == String.Empty)
+                return reply;
+
+            lock (m_InputData)
+            {
+                m_DataEvent.Set();
+                m_InputData.Add(post["COMMAND"].ToString());
+            }
+
+            XmlDocument xmldoc = new XmlDocument();
+            XmlNode xmlnode = xmldoc.CreateNode(XmlNodeType.XmlDeclaration,
+                    "", "");
+
+            xmldoc.AppendChild(xmlnode);
+            XmlElement rootElement = xmldoc.CreateElement("", "ConsoleSession",
+                    "");
+
+            xmldoc.AppendChild(rootElement);
+
+            XmlElement res = xmldoc.CreateElement("", "Result", "");
+            res.AppendChild(xmldoc.CreateTextNode("OK"));
+
+            rootElement.AppendChild(res);
+
+            reply["str_response_string"] = xmldoc.InnerXml;
+            reply["int_response_code"] = 200;
+            reply["content_type"] = "text/plain";
+
+            return reply;
+        }
+
+        private Hashtable DecodePostString(string data)
+        {
+            Hashtable result = new Hashtable();
+
+            string[] terms = data.Split(new char[] {'&'});
+
+            foreach (string term in terms)
+            {
+                string[] elems = term.Split(new char[] {'='});
+                if (elems.Length == 0)
+                    continue;
+
+                string name = System.Web.HttpUtility.UrlDecode(elems[0]);
+                string value = String.Empty;
+
+                if (elems.Length > 1)
+                    value = System.Web.HttpUtility.UrlDecode(elems[1]);
+                
+                result[name] = value;
+            }
+
+            return result;
+        }
+
+        public void CloseConnection(UUID id)
+        {
+            string uri = "/ReadResponses/" + id.ToString() + "/";
+
+            m_Server.RemovePollServiceHTTPHandler("", uri);
+        }
+
+        private bool HasEvents(UUID sessionID)
+        {
+            ConsoleConnection c = null;
+
+            lock (m_Connections)
+            {
+                if (!m_Connections.ContainsKey(sessionID))
+                    return false;
+                c = m_Connections[sessionID];
+            }
+            c.last = System.Environment.TickCount;
+            if (c.lastLineSeen < m_LineNumber)
+                return true;
+            return false;
+        }
+
+        private Hashtable GetEvents(UUID sessionID, string request)
+        {
+            ConsoleConnection c = null;
+
+            lock (m_Connections)
+            {
+                if (!m_Connections.ContainsKey(sessionID))
+                    return NoEvents();
+                c = m_Connections[sessionID];
+            }
+            c.last = System.Environment.TickCount;
+            if (c.lastLineSeen >= m_LineNumber)
+                return NoEvents();
+
+            Hashtable result = new Hashtable();
+
+            XmlDocument xmldoc = new XmlDocument();
+            XmlNode xmlnode = xmldoc.CreateNode(XmlNodeType.XmlDeclaration,
+                    "", "");
+
+            xmldoc.AppendChild(xmlnode);
+            XmlElement rootElement = xmldoc.CreateElement("", "ConsoleSession",
+                    "");
+
+            lock (m_Scrollback)
+            {
+                long startLine = m_LineNumber - m_Scrollback.Count;
+
+                for (long i = startLine ; i < m_LineNumber ; i++)
+                {
+                    XmlElement res = xmldoc.CreateElement("", "Line", "");
+                    long line = i + 1;
+                    res.SetAttribute("Number", line.ToString());
+                    res.AppendChild(xmldoc.CreateTextNode(m_Scrollback[(int)(i - startLine)]));
+
+                    rootElement.AppendChild(res);
+                }
+            }
+            c.lastLineSeen = m_LineNumber;
+
+            xmldoc.AppendChild(rootElement);
+
+            result["str_response_string"] = xmldoc.InnerXml;
+            result["int_response_code"] = 200;
+            result["content_type"] = "application/xml";
+            result["keepalive"] = false;
+            result["reusecontext"] = false;
+
+            return result;
+        }
+
+        private Hashtable NoEvents()
+        {
+            Hashtable result = new Hashtable();
+
+            result["int_response_code"] = 502;
+            result["content_type"] = "text/plain";
+            result["keepalive"] = false;
+            result["reusecontext"] = false;
+            result["str_response_string"] = "Upstream error: ";
+            result["error_status_text"] = "Upstream error:";
+
+            return result;
+        }
     }
 }

OpenSim/Server/Base/HttpServerBase.cs

@@ -77,16 +77,16 @@ namespace OpenSim.Server.Base
             m_HttpServer = new BaseHttpServer(port);
 
             MainServer.Instance = m_HttpServer;
+        }
+
+        protected override void Initialise()
+        {
+            m_HttpServer.Start();
 
             if (MainConsole.Instance is RemoteConsole)
             {
                 ((RemoteConsole)MainConsole.Instance).SetServer(m_HttpServer);
             }
         }
-
-        protected override void Initialise()
-        {
-            m_HttpServer.Start();
-        }
     }
 }

prebuild.xml

@@ -105,9 +105,11 @@
 
       <ReferencePath>../../../bin/</ReferencePath>
       <Reference name="System"/>
+      <Reference name="System.Web"/>
       <Reference name="log4net.dll"/>
       <Reference name="Nini.dll"/>
       <Reference name="OpenSim.Framework.Servers.HttpServer"/>
+      <Reference name="OpenMetaverseTypes.dll"/>
       <Files>
         <Match pattern="*.cs" recurse="true"/>
       </Files>