Add the OpenSim.ConsoleClient app.

Usage: OpenSim.ConsoleClient -h <host> -p <port> -u <user> -P <pass>
host defaults to localhost, port defaults to 8003.

OpenSim/ConsoleClient/ConsoleClient.cs

@@ -0,0 +1,185 @@
+/*
+ * 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 Nini.Config;
+using log4net;
+using System.Reflection;
+using System;
+using System.Xml;
+using System.Collections.Generic;
+using OpenSim.Server.Base;
+using OpenSim.Framework.Console;
+using OpenMetaverse;
+
+namespace OpenSim.ConsoleClient
+{
+    public class OpenSimConsoleClient
+    {
+        private static readonly ILog m_log =
+                LogManager.GetLogger(
+                MethodBase.GetCurrentMethod().DeclaringType);
+
+        protected static ServicesServerBase m_Server = null;
+        private static string m_Host;
+        private static int m_Port;
+        private static string m_User;
+        private static string m_Pass;
+        private static UUID m_SessionID;
+
+        static int Main(string[] args)
+        {
+            m_Server = new ServicesServerBase("Client", args);
+
+            IConfig serverConfig = m_Server.Config.Configs["Startup"];
+            if (serverConfig == null)
+            {
+                System.Console.WriteLine("Startup config section missing in .ini file");
+                throw new Exception("Configuration error");
+            }
+
+            ArgvConfigSource argvConfig = new ArgvConfigSource(args);
+
+            argvConfig.AddSwitch("Startup", "host", "h");
+            argvConfig.AddSwitch("Startup", "port", "p");
+            argvConfig.AddSwitch("Startup", "user", "u");
+            argvConfig.AddSwitch("Startup", "pass", "P");
+
+            m_Server.Config.Merge(argvConfig);
+
+            m_User = serverConfig.GetString("user", "Test");
+            m_Host = serverConfig.GetString("host", "localhost");
+            m_Port = serverConfig.GetInt("port", 8003);
+            m_Pass = serverConfig.GetString("pass", "secret");
+
+            Requester.MakeRequest("http://"+m_Host+":"+m_Port.ToString()+"/StartSession/", String.Format("USER={0}&PASS={1}", m_User, m_Pass), LoginReply);
+
+            int res = m_Server.Run();
+
+            Environment.Exit(res);
+
+            return 0;
+        }
+
+        private static void SendCommand(string module, string[] cmd)
+        {
+            string sendCmd = String.Join(" ", cmd);
+
+            Requester.MakeRequest("http://"+m_Host+":"+m_Port.ToString()+"/SessionCommand/", String.Format("ID={0}&COMMAND={1}", m_SessionID, sendCmd), CommandReply);
+        }
+
+        public static void LoginReply(string requestUrl, string requestData, string replyData)
+        {
+            XmlDocument doc = new XmlDocument();
+
+            doc.LoadXml(replyData);
+
+            XmlNodeList rootL = doc.GetElementsByTagName("ConsoleSession");
+            if (rootL.Count != 1)
+            {
+                MainConsole.Instance.Output("Connection data info was not valid");
+                Environment.Exit(1);
+            }
+            XmlElement rootNode = (XmlElement)rootL[0];
+
+            if (rootNode == null)
+            {
+                MainConsole.Instance.Output("Connection data info was not valid");
+                Environment.Exit(1);
+            }
+
+            XmlNodeList helpNodeL = rootNode.GetElementsByTagName("HelpTree");
+            if (helpNodeL.Count != 1)
+            {
+                MainConsole.Instance.Output("Connection data info was not valid");
+                Environment.Exit(1);
+            }
+
+            XmlElement helpNode = (XmlElement)helpNodeL[0];
+            if (helpNode == null)
+            {
+                MainConsole.Instance.Output("Connection data info was not valid");
+                Environment.Exit(1);
+            }
+
+            XmlNodeList sessionL = rootNode.GetElementsByTagName("SessionID");
+            if (sessionL.Count != 1)
+            {
+                MainConsole.Instance.Output("Connection data info was not valid");
+                Environment.Exit(1);
+            }
+
+            XmlElement sessionNode = (XmlElement)sessionL[0];
+            if (sessionNode == null)
+            {
+                MainConsole.Instance.Output("Connection data info was not valid");
+                Environment.Exit(1);
+            }
+
+            if (!UUID.TryParse(sessionNode.InnerText, out m_SessionID))
+            {
+                MainConsole.Instance.Output("Connection data info was not valid");
+                Environment.Exit(1);
+            }
+
+            MainConsole.Instance.Commands.FromXml(helpNode, SendCommand);
+
+            Requester.MakeRequest("http://"+m_Host+":"+m_Port.ToString()+"/ReadResponses/"+m_SessionID.ToString()+"/", String.Empty, ReadResponses);
+        }
+
+        public static void ReadResponses(string requestUrl, string requestData, string replyData)
+        {
+            XmlDocument doc = new XmlDocument();
+
+            doc.LoadXml(replyData);
+
+            XmlNodeList rootNodeL = doc.GetElementsByTagName("ConsoleSession");
+            if (rootNodeL.Count != 1 || rootNodeL[0] == null)
+            {
+                Requester.MakeRequest(requestUrl, requestData, ReadResponses);
+                return;
+            }
+            
+            foreach (XmlNode part in rootNodeL[0].ChildNodes)
+            {
+                if (part.Name != "Line")
+                    continue;
+
+                string[] parts = part.InnerText.Split(new char[] {':'}, 3);
+                if (parts.Length != 3)
+                    continue;
+                
+                MainConsole.Instance.Output(parts[2], parts[1]);
+            }
+
+            Requester.MakeRequest(requestUrl, requestData, ReadResponses);
+        }
+
+        public static void CommandReply(string requestUrl, string requestData, string replyData)
+        {
+        }
+    }
+}

OpenSim/ConsoleClient/Requester.cs

@@ -0,0 +1,86 @@
+/*
+ * 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 System.IO;
+using System.Net;
+using System.Reflection;
+using System.Text;
+using System.Xml;
+using System.Xml.Serialization;
+using log4net;
+
+namespace OpenSim.ConsoleClient
+{
+    public delegate void ReplyDelegate(string requestUrl, string requestData, string replyData);
+
+    public class Requester
+    {
+        private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
+        
+        public static void MakeRequest(string requestUrl, string data,
+                ReplyDelegate action)
+        {
+            WebRequest request = WebRequest.Create(requestUrl);
+            WebResponse response = null;
+
+            request.Method = "POST";
+
+            request.ContentType = "application/x-www-form-urlencoded";
+
+            byte[] buffer = new System.Text.ASCIIEncoding().GetBytes(data);
+            int length = (int) buffer.Length;
+            request.ContentLength = length;
+
+            request.BeginGetRequestStream(delegate(IAsyncResult res)
+            {
+                Stream requestStream = request.EndGetRequestStream(res);
+
+                requestStream.Write(buffer, 0, length);
+
+                request.BeginGetResponse(delegate(IAsyncResult ar)
+                {
+                    string reply = String.Empty;
+
+                    response = request.EndGetResponse(ar);
+
+                    try
+                    {
+                        StreamReader r = new StreamReader(response.GetResponseStream());
+                        reply = r.ReadToEnd();
+
+                    }
+                    catch (System.InvalidOperationException)
+                    {
+                    }
+
+                    action(requestUrl, data, reply);
+                }, null);
+            }, null);
+        }
+    }
+}

OpenSim/Framework/Console/CommandConsole.cs

@@ -373,10 +373,28 @@ namespace OpenSim.Framework.Console
 
         public XmlElement GetXml(XmlDocument doc)
         {
+            CommandInfo help = (CommandInfo)((Dictionary<string, object>)tree["help"])[String.Empty];
+            ((Dictionary<string, object>)tree["help"]).Remove(string.Empty);
+            if (((Dictionary<string, object>)tree["help"]).Count == 0)
+                tree.Remove("help");
+
+            CommandInfo quit = (CommandInfo)((Dictionary<string, object>)tree["quit"])[String.Empty];
+            ((Dictionary<string, object>)tree["quit"]).Remove(string.Empty);
+            if (((Dictionary<string, object>)tree["quit"]).Count == 0)
+                tree.Remove("quit");
+
             XmlElement root = doc.CreateElement("", "HelpTree", "");
 
             ProcessTreeLevel(tree, root, doc);
 
+            if (!tree.ContainsKey("help"))
+                tree["help"] = (object) new Dictionary<string, object>();
+            ((Dictionary<string, object>)tree["help"])[String.Empty] = help;
+
+            if (!tree.ContainsKey("quit"))
+                tree["quit"] = (object) new Dictionary<string, object>();
+            ((Dictionary<string, object>)tree["quit"])[String.Empty] = quit;
+
             return root;
         }
 
@@ -426,8 +444,80 @@ namespace OpenSim.Framework.Console
             }
         }
 
-        public void FromXml(XmlElement root)
+        public void FromXml(XmlElement root, CommandDelegate fn)
         {
+            CommandInfo help = (CommandInfo)((Dictionary<string, object>)tree["help"])[String.Empty];
+            ((Dictionary<string, object>)tree["help"]).Remove(string.Empty);
+            if (((Dictionary<string, object>)tree["help"]).Count == 0)
+                tree.Remove("help");
+
+            CommandInfo quit = (CommandInfo)((Dictionary<string, object>)tree["quit"])[String.Empty];
+            ((Dictionary<string, object>)tree["quit"]).Remove(string.Empty);
+            if (((Dictionary<string, object>)tree["quit"]).Count == 0)
+                tree.Remove("quit");
+
+            tree.Clear();
+
+            ReadTreeLevel(tree, root, fn);
+
+            if (!tree.ContainsKey("help"))
+                tree["help"] = (object) new Dictionary<string, object>();
+            ((Dictionary<string, object>)tree["help"])[String.Empty] = help;
+
+            if (!tree.ContainsKey("quit"))
+                tree["quit"] = (object) new Dictionary<string, object>();
+            ((Dictionary<string, object>)tree["quit"])[String.Empty] = quit;
+        }
+
+        private void ReadTreeLevel(Dictionary<string, object> level, XmlNode node, CommandDelegate fn)
+        {
+            Dictionary<string, object> next;
+            string name;
+
+            XmlNodeList nodeL = node.ChildNodes;
+            XmlNodeList cmdL;
+            CommandInfo c;
+
+            foreach (XmlNode part in nodeL)
+            {
+                switch (part.Name)
+                {
+                case "Level":
+                    name = ((XmlElement)part).GetAttribute("Name");
+                    next = new Dictionary<string, object>();
+                    level[name] = next;
+                    ReadTreeLevel(next, part, fn);
+                    break;
+                case "Command":
+                    cmdL = part.ChildNodes;
+                    c = new CommandInfo();
+                    foreach (XmlNode cmdPart in cmdL)
+                    {
+                        switch (cmdPart.Name)
+                        {
+                        case "Module":
+                            c.module = cmdPart.InnerText;
+                            break;
+                        case "Shared":
+                            c.shared = Convert.ToBoolean(cmdPart.InnerText);
+                            break;
+                        case "HelpText":
+                            c.help_text = cmdPart.InnerText;
+                            break;
+                        case "LongHelp":
+                            c.long_help = cmdPart.InnerText;
+                            break;
+                        case "Description":
+                            c.descriptive_help = cmdPart.InnerText;
+                            break;
+                        }
+                    }
+                    c.fn = new List<CommandDelegate>();
+                    c.fn.Add(fn);
+                    level[String.Empty] = c;
+                    break;
+                }
+            }
         }
     }
 

OpenSim/Framework/Console/RemoteConsole.cs

@@ -98,7 +98,12 @@ namespace OpenSim.Framework.Console
                 m_LineNumber++;
                 m_Scrollback.Add(String.Format("{0}", m_LineNumber)+":"+level+":"+text);
             }
-            System.Console.Write(text);
+            System.Console.WriteLine(text.Trim());
+        }
+
+        public override void Output(string text)
+        {
+            Output(text, "normal");
         }
 
         public override string ReadLine(string p, bool isCommand, bool e)
@@ -152,9 +157,8 @@ namespace OpenSim.Framework.Console
 
                 foreach (UUID id in expired)
                 {
-                    System.Console.WriteLine("Expired {0}", id.ToString());
-                    CloseConnection(id);
                     m_Connections.Remove(id);
+                    CloseConnection(id);
                 }
             }
         }
@@ -244,8 +248,8 @@ namespace OpenSim.Framework.Console
             {
                 if (m_Connections.ContainsKey(id))
                 {
-                    CloseConnection(id);
                     m_Connections.Remove(id);
+                    CloseConnection(id);
                 }
             }
 
@@ -345,11 +349,17 @@ namespace OpenSim.Framework.Console
         }
 
         public void CloseConnection(UUID id)
+        {
+            try
             {
                 string uri = "/ReadResponses/" + id.ToString() + "/";
 
                 m_Server.RemovePollServiceHTTPHandler("", uri);
             }
+            catch (Exception)
+            {
+            }
+        }
 
         private bool HasEvents(UUID sessionID)
         {
@@ -394,8 +404,11 @@ namespace OpenSim.Framework.Console
             lock (m_Scrollback)
             {
                 long startLine = m_LineNumber - m_Scrollback.Count;
+                long sendStart = startLine;
+                if (sendStart < c.lastLineSeen)
+                    sendStart = c.lastLineSeen;
 
-                for (long i = startLine ; i < m_LineNumber ; i++)
+                for (long i = sendStart ; i < m_LineNumber ; i++)
                 {
                     XmlElement res = xmldoc.CreateElement("", "Line", "");
                     long line = i + 1;
@@ -422,12 +435,21 @@ namespace OpenSim.Framework.Console
         {
             Hashtable result = new Hashtable();
 
-            result["int_response_code"] = 502;
-            result["content_type"] = "text/plain";
+            XmlDocument xmldoc = new XmlDocument();
+            XmlNode xmlnode = xmldoc.CreateNode(XmlNodeType.XmlDeclaration,
+                    "", "");
+
+            xmldoc.AppendChild(xmlnode);
+            XmlElement rootElement = xmldoc.CreateElement("", "ConsoleSession",
+                    "");
+
+            xmldoc.AppendChild(rootElement);
+
+            result["str_response_string"] = xmldoc.InnerXml;
+            result["int_response_code"] = 200;
+            result["content_type"] = "text/xml";
             result["keepalive"] = false;
             result["reusecontext"] = false;
-            result["str_response_string"] = "Upstream error: ";
-            result["error_status_text"] = "Upstream error:";
 
             return result;
         }

bin/OpenSim.ConsoleClient.exe.config

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<configuration>
+  <configSections>
+    <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler,log4net" />
+  </configSections>
+  <runtime>
+    <gcConcurrent enabled="true" />
+	<gcServer enabled="true" />
+  </runtime>
+  <appSettings>
+  </appSettings>
+  <log4net>
+    <appender name="Console" type="OpenSim.Framework.Console.OpenSimAppender, OpenSim.Framework.Console">
+      <layout type="log4net.Layout.PatternLayout">
+        <conversionPattern value="%date{HH:mm:ss} - %message%newline" />
+      </layout>
+    </appender>
+
+    <appender name="LogFileAppender" type="log4net.Appender.FileAppender">
+      <file value="OpenSim.log" />
+      <appendToFile value="true" />
+      <layout type="log4net.Layout.PatternLayout">
+        <conversionPattern value="%date %-5level - %logger %message%newline" />
+      </layout>
+    </appender>
+
+    <root>
+      <level value="DEBUG" />
+      <appender-ref ref="Console" />
+      <appender-ref ref="LogFileAppender" />
+    </root>
+  </log4net>
+</configuration>

bin/OpenSim.ConsoleClient.ini.example

@@ -0,0 +1 @@
+[Startup]

prebuild.xml

@@ -1595,6 +1595,38 @@
       </Files>
     </Project>
 
+    <Project frameworkVersion="v3_5" name="OpenSim.ConsoleClient" path="OpenSim/ConsoleClient" type="Exe">
+      <Configuration name="Debug">
+        <Options>
+          <OutputPath>../../bin/</OutputPath>
+        </Options>
+      </Configuration>
+      <Configuration name="Release">
+        <Options>
+          <OutputPath>../../bin/</OutputPath>
+        </Options>
+      </Configuration>
+
+      <ReferencePath>../../bin/</ReferencePath>
+      <Reference name="System"/>
+      <Reference name="System.Xml"/>
+      <Reference name="OpenMetaverseTypes.dll"/>
+      <Reference name="OpenMetaverse.dll"/>
+      <Reference name="OpenMetaverse.StructuredData.dll"/>
+      <Reference name="OpenSim.Framework"/>
+      <Reference name="OpenSim.Framework.Console"/>
+      <Reference name="OpenSim.Framework.Servers.HttpServer"/>
+      <Reference name="OpenSim.Server.Base"/>
+      <Reference name="Nini.dll" />
+      <Reference name="log4net.dll"/>
+
+      <Files>
+        <Match pattern="*.cs" recurse="false">
+          <Exclude pattern="Tests" />
+        </Match>
+      </Files>
+    </Project>
+
     <Project frameworkVersion="v3_5" name="OpenSim.Region.CoreModules" path="OpenSim/Region/CoreModules" type="Library">
       <Configuration name="Debug">
         <Options>