From 5c48d7a378ff066f59b9cee02f2803ebe1616481 Mon Sep 17 00:00:00 2001
From: Justin Clark-Casey (justincc)
Date: Thu, 22 Nov 2012 04:05:09 +0000
Subject: factor out common HandleShow code for "show uptime"

---
 OpenSim/Framework/Console/CommandConsole.cs    |  2 +-
 OpenSim/Framework/Console/ConsoleBase.cs       | 10 +-----
 OpenSim/Framework/Console/MockConsole.cs       |  7 +++-
 OpenSim/Framework/ICommandConsole.cs           |  5 +++
 OpenSim/Framework/IConsole.cs                  |  2 +-
 OpenSim/Framework/Servers/BaseOpenSimServer.cs | 39 +++-----------------
 OpenSim/Framework/Servers/ServerBase.cs        | 50 ++++++++++++++++++++++++++
 7 files changed, 69 insertions(+), 46 deletions(-)

(limited to 'OpenSim/Framework')

diff --git a/OpenSim/Framework/Console/CommandConsole.cs b/OpenSim/Framework/Console/CommandConsole.cs
index bd23d1c..d1e29b4 100644
--- a/OpenSim/Framework/Console/CommandConsole.cs
+++ b/OpenSim/Framework/Console/CommandConsole.cs
@@ -711,7 +711,7 @@ namespace OpenSim.Framework.Console
         /// </summary>
         public void Prompt()
         {
-            string line = ReadLine(m_defaultPrompt + "# ", true, true);
+            string line = ReadLine(DefaultPrompt + "# ", true, true);
 
             if (line != String.Empty)
                 Output("Invalid command");
diff --git a/OpenSim/Framework/Console/ConsoleBase.cs b/OpenSim/Framework/Console/ConsoleBase.cs
index 4b375d9..2d8e723 100755
--- a/OpenSim/Framework/Console/ConsoleBase.cs
+++ b/OpenSim/Framework/Console/ConsoleBase.cs
@@ -43,15 +43,7 @@ namespace OpenSim.Framework.Console
 
         public object ConsoleScene { get; set; }
 
-        /// <summary>
-        /// The default prompt text.
-        /// </summary>
-        public string DefaultPrompt
-        {
-            set { m_defaultPrompt = value; }
-            get { return m_defaultPrompt; }
-        }
-        protected string m_defaultPrompt;
+        public string DefaultPrompt { get; set; }
 
         public ConsoleBase(string defaultPrompt)
         {
diff --git a/OpenSim/Framework/Console/MockConsole.cs b/OpenSim/Framework/Console/MockConsole.cs
index b489f93..8ba58e4 100644
--- a/OpenSim/Framework/Console/MockConsole.cs
+++ b/OpenSim/Framework/Console/MockConsole.cs
@@ -46,13 +46,18 @@ namespace OpenSim.Framework.Console
 
         public ICommands Commands { get { return m_commands; } }
 
+        public string DefaultPrompt { get; set; }
+
         public void Prompt() {}
 
         public void RunCommand(string cmd) {}
 
         public string ReadLine(string p, bool isCommand, bool e) { return ""; }
 
-        public object ConsoleScene { get { return null; } }
+        public object ConsoleScene { 
+            get { return null; }
+            set {}
+        }
 
         public void Output(string text, string level) {}
         public void Output(string text) {}
diff --git a/OpenSim/Framework/ICommandConsole.cs b/OpenSim/Framework/ICommandConsole.cs
index 8cd20da..a6573f8 100644
--- a/OpenSim/Framework/ICommandConsole.cs
+++ b/OpenSim/Framework/ICommandConsole.cs
@@ -83,6 +83,11 @@ namespace OpenSim.Framework
         ICommands Commands { get; }
 
         /// <summary>
+        /// The default prompt text.
+        /// </summary>
+        string DefaultPrompt { get; set; }
+
+        /// <summary>
         /// Display a command prompt on the console and wait for user input
         /// </summary>
         void Prompt();
diff --git a/OpenSim/Framework/IConsole.cs b/OpenSim/Framework/IConsole.cs
index 33024b2..79560d8 100644
--- a/OpenSim/Framework/IConsole.cs
+++ b/OpenSim/Framework/IConsole.cs
@@ -32,7 +32,7 @@ namespace OpenSim.Framework
 {
     public interface IConsole
     {
-        object ConsoleScene { get; }
+        object ConsoleScene { get; set; }
 
         void Output(string text, string level);
         void Output(string text);
diff --git a/OpenSim/Framework/Servers/BaseOpenSimServer.cs b/OpenSim/Framework/Servers/BaseOpenSimServer.cs
index 6346279..4f9ac08 100644
--- a/OpenSim/Framework/Servers/BaseOpenSimServer.cs
+++ b/OpenSim/Framework/Servers/BaseOpenSimServer.cs
@@ -62,7 +62,6 @@ namespace OpenSim.Framework.Servers
         /// </summary>
         private Timer m_periodicDiagnosticsTimer = new Timer(60 * 60 * 1000);
 
-        protected CommandConsole m_console;
         protected OpenSimAppender m_consoleAppender;
         protected IAppender m_logFileAppender = null; 
 
@@ -139,7 +138,8 @@ namespace OpenSim.Framework.Servers
                 }
                 else
                 {
-                    m_consoleAppender.Console = m_console;
+                    // FIXME: This should be done through an interface rather than casting.
+                    m_consoleAppender.Console = (ConsoleBase)m_console;
                     
                     // If there is no threshold set then the threshold is effectively everything.
                     if (null == m_consoleAppender.Threshold)
@@ -367,8 +367,10 @@ namespace OpenSim.Framework.Servers
             }
         }
 
-        public virtual void HandleShow(string module, string[] cmd)
+        public override void HandleShow(string module, string[] cmd)
         {
+            base.HandleShow(module, cmd);
+
             List<string> args = new List<string>(cmd);
 
             args.RemoveAt(0);
@@ -385,10 +387,6 @@ namespace OpenSim.Framework.Servers
                     Notice(GetThreadsReport());
                     break;
 
-                case "uptime":
-                    Notice(GetUptimeReport());
-                    break;
-
                 case "version":
                     Notice(GetVersionText());
                     break;
@@ -430,33 +428,6 @@ namespace OpenSim.Framework.Servers
         }
 
         /// <summary>
-        /// Console output is only possible if a console has been established.
-        /// That is something that cannot be determined within this class. So
-        /// all attempts to use the console MUST be verified.
-        /// </summary>
-        /// <param name="msg"></param>
-        protected void Notice(string msg)
-        {
-            if (m_console != null)
-            {
-                m_console.Output(msg);
-            }
-        }
-        
-        /// <summary>
-        /// Console output is only possible if a console has been established.
-        /// That is something that cannot be determined within this class. So
-        /// all attempts to use the console MUST be verified.
-        /// </summary>
-        /// <param name="format"></param>        
-        /// <param name="components"></param>
-        protected void Notice(string format, params string[] components)
-        {
-            if (m_console != null)
-                m_console.OutputFormat(format, components);
-        }
-
-        /// <summary>
         /// Enhance the version string with extra information if it's available.
         /// </summary>
         protected void EnhanceVersionInformation()
diff --git a/OpenSim/Framework/Servers/ServerBase.cs b/OpenSim/Framework/Servers/ServerBase.cs
index d19234b..afe1f73 100644
--- a/OpenSim/Framework/Servers/ServerBase.cs
+++ b/OpenSim/Framework/Servers/ServerBase.cs
@@ -26,13 +26,20 @@
  */
 
 using System;
+using System.Collections.Generic;
 using System.Text;
+using OpenSim.Framework.Console;
 
 namespace OpenSim.Framework.Servers
 {
     public class ServerBase
     {
         /// <summary>
+        /// Console to be used for any command line output.  Can be null, in which case there should be no output.
+        /// </summary>
+        protected ICommandConsole m_console;
+
+        /// <summary>
         /// Time at which this server was started
         /// </summary>
         protected DateTime m_startuptime;
@@ -42,6 +49,22 @@ namespace OpenSim.Framework.Servers
             m_startuptime = DateTime.Now;
         }
 
+        public virtual void HandleShow(string module, string[] cmd)
+        {
+            List<string> args = new List<string>(cmd);
+
+            args.RemoveAt(0);
+
+            string[] showParams = args.ToArray();
+
+            switch (showParams[0])
+            {
+                case "uptime":
+                    Notice(GetUptimeReport());
+                    break;
+            }
+        }
+
         /// <summary>
         /// Return a report about the uptime of this server
         /// </summary>
@@ -54,5 +77,32 @@ namespace OpenSim.Framework.Servers
 
             return sb.ToString();
         }
+
+        /// <summary>
+        /// Console output is only possible if a console has been established.
+        /// That is something that cannot be determined within this class. So
+        /// all attempts to use the console MUST be verified.
+        /// </summary>
+        /// <param name="msg"></param>
+        protected void Notice(string msg)
+        {
+            if (m_console != null)
+            {
+                m_console.Output(msg);
+            }
+        }
+        
+        /// <summary>
+        /// Console output is only possible if a console has been established.
+        /// That is something that cannot be determined within this class. So
+        /// all attempts to use the console MUST be verified.
+        /// </summary>
+        /// <param name="format"></param>        
+        /// <param name="components"></param>
+        protected void Notice(string format, params string[] components)
+        {
+            if (m_console != null)
+                m_console.OutputFormat(format, components);
+        }
     }
 }
\ No newline at end of file
-- 
cgit v1.1