diff options
Diffstat (limited to 'OpenSim/Region/CoreModules/Framework/InterfaceCommander')
-rw-r--r-- | OpenSim/Region/CoreModules/Framework/InterfaceCommander/Command.cs | 216 | ||||
-rw-r--r-- | OpenSim/Region/CoreModules/Framework/InterfaceCommander/Commander.cs | 182 |
2 files changed, 398 insertions, 0 deletions
diff --git a/OpenSim/Region/CoreModules/Framework/InterfaceCommander/Command.cs b/OpenSim/Region/CoreModules/Framework/InterfaceCommander/Command.cs new file mode 100644 index 0000000..fe29e0c --- /dev/null +++ b/OpenSim/Region/CoreModules/Framework/InterfaceCommander/Command.cs | |||
@@ -0,0 +1,216 @@ | |||
1 | /* | ||
2 | * Copyright (c) Contributors, http://opensimulator.org/ | ||
3 | * See CONTRIBUTORS.TXT for a full list of copyright holders. | ||
4 | * | ||
5 | * Redistribution and use in source and binary forms, with or without | ||
6 | * modification, are permitted provided that the following conditions are met: | ||
7 | * * Redistributions of source code must retain the above copyright | ||
8 | * notice, this list of conditions and the following disclaimer. | ||
9 | * * Redistributions in binary form must reproduce the above copyright | ||
10 | * notice, this list of conditions and the following disclaimer in the | ||
11 | * documentation and/or other materials provided with the distribution. | ||
12 | * * Neither the name of the OpenSim Project nor the | ||
13 | * names of its contributors may be used to endorse or promote products | ||
14 | * derived from this software without specific prior written permission. | ||
15 | * | ||
16 | * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY | ||
17 | * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | ||
18 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
19 | * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY | ||
20 | * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | ||
21 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
22 | * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND | ||
23 | * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
24 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | ||
25 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
26 | */ | ||
27 | |||
28 | using System; | ||
29 | using System.Collections.Generic; | ||
30 | using OpenSim.Region.Framework.Interfaces; | ||
31 | |||
32 | namespace OpenSim.Region.CoreModules.Framework.InterfaceCommander | ||
33 | { | ||
34 | /// <summary> | ||
35 | /// A single function call encapsulated in a class which enforces arguments when passing around as Object[]'s. | ||
36 | /// Used for console commands and script API generation | ||
37 | /// </summary> | ||
38 | public class Command : ICommand | ||
39 | { | ||
40 | //private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType); | ||
41 | private List<CommandArgument> m_args = new List<CommandArgument>(); | ||
42 | |||
43 | private Action<object[]> m_command; | ||
44 | private string m_help; | ||
45 | private string m_name; | ||
46 | private CommandIntentions m_intentions; //A permission type system could implement this and know what a command intends on doing. | ||
47 | |||
48 | public Command(string name, CommandIntentions intention, Action<Object[]> command, string help) | ||
49 | { | ||
50 | m_name = name; | ||
51 | m_command = command; | ||
52 | m_help = help; | ||
53 | m_intentions = intention; | ||
54 | } | ||
55 | |||
56 | #region ICommand Members | ||
57 | |||
58 | public void AddArgument(string name, string helptext, string type) | ||
59 | { | ||
60 | m_args.Add(new CommandArgument(name, helptext, type)); | ||
61 | } | ||
62 | |||
63 | public string Name | ||
64 | { | ||
65 | get { return m_name; } | ||
66 | } | ||
67 | |||
68 | public CommandIntentions Intentions | ||
69 | { | ||
70 | get { return m_intentions; } | ||
71 | } | ||
72 | |||
73 | public string Help | ||
74 | { | ||
75 | get { return m_help; } | ||
76 | } | ||
77 | |||
78 | public Dictionary<string, string> Arguments | ||
79 | { | ||
80 | get | ||
81 | { | ||
82 | Dictionary<string, string> tmp = new Dictionary<string, string>(); | ||
83 | foreach (CommandArgument arg in m_args) | ||
84 | { | ||
85 | tmp.Add(arg.Name, arg.ArgumentType); | ||
86 | } | ||
87 | return tmp; | ||
88 | } | ||
89 | } | ||
90 | |||
91 | public string ShortHelp() | ||
92 | { | ||
93 | string help = m_name; | ||
94 | |||
95 | foreach (CommandArgument arg in m_args) | ||
96 | { | ||
97 | help += " <" + arg.Name + ">"; | ||
98 | } | ||
99 | |||
100 | return help; | ||
101 | } | ||
102 | |||
103 | public void ShowConsoleHelp() | ||
104 | { | ||
105 | Console.WriteLine("== " + Name + " =="); | ||
106 | Console.WriteLine(m_help); | ||
107 | Console.WriteLine("= Parameters ="); | ||
108 | foreach (CommandArgument arg in m_args) | ||
109 | { | ||
110 | Console.WriteLine("* " + arg.Name + " (" + arg.ArgumentType + ")"); | ||
111 | Console.WriteLine("\t" + arg.HelpText); | ||
112 | } | ||
113 | } | ||
114 | |||
115 | public void Run(Object[] args) | ||
116 | { | ||
117 | Object[] cleanArgs = new Object[m_args.Count]; | ||
118 | |||
119 | if (args.Length < cleanArgs.Length) | ||
120 | { | ||
121 | Console.WriteLine("ERROR: Missing " + (cleanArgs.Length - args.Length) + " argument(s)"); | ||
122 | ShowConsoleHelp(); | ||
123 | return; | ||
124 | } | ||
125 | if (args.Length > cleanArgs.Length) | ||
126 | { | ||
127 | Console.WriteLine("ERROR: Too many arguments for this command. Type '<module> <command> help' for help."); | ||
128 | return; | ||
129 | } | ||
130 | |||
131 | int i = 0; | ||
132 | foreach (Object arg in args) | ||
133 | { | ||
134 | if (string.IsNullOrEmpty(arg.ToString())) | ||
135 | { | ||
136 | Console.WriteLine("ERROR: Empty arguments are not allowed"); | ||
137 | return; | ||
138 | } | ||
139 | try | ||
140 | { | ||
141 | switch (m_args[i].ArgumentType) | ||
142 | { | ||
143 | case "String": | ||
144 | m_args[i].ArgumentValue = arg.ToString(); | ||
145 | break; | ||
146 | case "Integer": | ||
147 | m_args[i].ArgumentValue = Int32.Parse(arg.ToString()); | ||
148 | break; | ||
149 | case "Double": | ||
150 | m_args[i].ArgumentValue = Double.Parse(arg.ToString()); | ||
151 | break; | ||
152 | case "Boolean": | ||
153 | m_args[i].ArgumentValue = Boolean.Parse(arg.ToString()); | ||
154 | break; | ||
155 | default: | ||
156 | Console.WriteLine("ERROR: Unknown desired type for argument " + m_args[i].Name + " on command " + m_name); | ||
157 | break; | ||
158 | } | ||
159 | } | ||
160 | catch (FormatException) | ||
161 | { | ||
162 | Console.WriteLine("ERROR: Argument number " + (i + 1) + | ||
163 | " (" + m_args[i].Name + ") must be a valid " + | ||
164 | m_args[i].ArgumentType.ToLower() + "."); | ||
165 | return; | ||
166 | } | ||
167 | cleanArgs[i] = m_args[i].ArgumentValue; | ||
168 | |||
169 | i++; | ||
170 | } | ||
171 | |||
172 | m_command.Invoke(cleanArgs); | ||
173 | } | ||
174 | |||
175 | #endregion | ||
176 | } | ||
177 | |||
178 | /// <summary> | ||
179 | /// A single command argument, contains name, type and at runtime, value. | ||
180 | /// </summary> | ||
181 | public class CommandArgument | ||
182 | { | ||
183 | private string m_help; | ||
184 | private string m_name; | ||
185 | private string m_type; | ||
186 | private Object m_val; | ||
187 | |||
188 | public CommandArgument(string name, string help, string type) | ||
189 | { | ||
190 | m_name = name; | ||
191 | m_help = help; | ||
192 | m_type = type; | ||
193 | } | ||
194 | |||
195 | public string Name | ||
196 | { | ||
197 | get { return m_name; } | ||
198 | } | ||
199 | |||
200 | public string HelpText | ||
201 | { | ||
202 | get { return m_help; } | ||
203 | } | ||
204 | |||
205 | public string ArgumentType | ||
206 | { | ||
207 | get { return m_type; } | ||
208 | } | ||
209 | |||
210 | public Object ArgumentValue | ||
211 | { | ||
212 | get { return m_val; } | ||
213 | set { m_val = value; } | ||
214 | } | ||
215 | } | ||
216 | } | ||
diff --git a/OpenSim/Region/CoreModules/Framework/InterfaceCommander/Commander.cs b/OpenSim/Region/CoreModules/Framework/InterfaceCommander/Commander.cs new file mode 100644 index 0000000..cd905ab --- /dev/null +++ b/OpenSim/Region/CoreModules/Framework/InterfaceCommander/Commander.cs | |||
@@ -0,0 +1,182 @@ | |||
1 | /* | ||
2 | * Copyright (c) Contributors, http://opensimulator.org/ | ||
3 | * See CONTRIBUTORS.TXT for a full list of copyright holders. | ||
4 | * | ||
5 | * Redistribution and use in source and binary forms, with or without | ||
6 | * modification, are permitted provided that the following conditions are met: | ||
7 | * * Redistributions of source code must retain the above copyright | ||
8 | * notice, this list of conditions and the following disclaimer. | ||
9 | * * Redistributions in binary form must reproduce the above copyright | ||
10 | * notice, this list of conditions and the following disclaimer in the | ||
11 | * documentation and/or other materials provided with the distribution. | ||
12 | * * Neither the name of the OpenSim Project nor the | ||
13 | * names of its contributors may be used to endorse or promote products | ||
14 | * derived from this software without specific prior written permission. | ||
15 | * | ||
16 | * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY | ||
17 | * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | ||
18 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
19 | * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY | ||
20 | * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | ||
21 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
22 | * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND | ||
23 | * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
24 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | ||
25 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
26 | */ | ||
27 | |||
28 | using System; | ||
29 | using System.Collections.Generic; | ||
30 | using System.Reflection; | ||
31 | using System.Text; | ||
32 | using log4net; | ||
33 | using OpenSim.Framework; | ||
34 | using OpenSim.Region.Framework.Interfaces; | ||
35 | |||
36 | namespace OpenSim.Region.CoreModules.Framework.InterfaceCommander | ||
37 | { | ||
38 | /// <summary> | ||
39 | /// A class to enable modules to register console and script commands, which enforces typing and valid input. | ||
40 | /// </summary> | ||
41 | public class Commander : ICommander | ||
42 | { | ||
43 | private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType); | ||
44 | |||
45 | /// <value> | ||
46 | /// Used in runtime class generation | ||
47 | /// </summary> | ||
48 | private string m_generatedApiClassName; | ||
49 | |||
50 | public string Name | ||
51 | { | ||
52 | get { return m_name; } | ||
53 | } | ||
54 | private string m_name; | ||
55 | |||
56 | public string Help | ||
57 | { | ||
58 | get | ||
59 | { | ||
60 | StringBuilder sb = new StringBuilder(); | ||
61 | |||
62 | sb.AppendLine("=== " + m_name + " ==="); | ||
63 | |||
64 | foreach (ICommand com in m_commands.Values) | ||
65 | { | ||
66 | sb.AppendLine("* " + Name + " " + com.Name + " - " + com.Help); | ||
67 | } | ||
68 | |||
69 | return sb.ToString(); | ||
70 | } | ||
71 | } | ||
72 | |||
73 | /// <summary> | ||
74 | /// Constructor | ||
75 | /// </summary> | ||
76 | /// <param name="name"></param> | ||
77 | public Commander(string name) | ||
78 | { | ||
79 | m_name = name; | ||
80 | m_generatedApiClassName = m_name[0].ToString().ToUpper(); | ||
81 | |||
82 | if (m_name.Length > 1) | ||
83 | m_generatedApiClassName += m_name.Substring(1); | ||
84 | } | ||
85 | |||
86 | public Dictionary<string, ICommand> Commands | ||
87 | { | ||
88 | get { return m_commands; } | ||
89 | } | ||
90 | private Dictionary<string, ICommand> m_commands = new Dictionary<string, ICommand>(); | ||
91 | |||
92 | #region ICommander Members | ||
93 | |||
94 | public void RegisterCommand(string commandName, ICommand command) | ||
95 | { | ||
96 | m_commands[commandName] = command; | ||
97 | } | ||
98 | |||
99 | /// <summary> | ||
100 | /// Generates a runtime C# class which can be compiled and inserted via reflection to enable modules to register new script commands | ||
101 | /// </summary> | ||
102 | /// <returns>Returns C# source code to create a binding</returns> | ||
103 | public string GenerateRuntimeAPI() | ||
104 | { | ||
105 | string classSrc = "\n\tpublic class " + m_generatedApiClassName + " {\n"; | ||
106 | foreach (ICommand com in m_commands.Values) | ||
107 | { | ||
108 | classSrc += "\tpublic void " + EscapeRuntimeAPICommand(com.Name) + "( "; | ||
109 | foreach (KeyValuePair<string, string> arg in com.Arguments) | ||
110 | { | ||
111 | classSrc += arg.Value + " " + Util.Md5Hash(arg.Key) + ","; | ||
112 | } | ||
113 | classSrc = classSrc.Remove(classSrc.Length - 1); // Delete the last comma | ||
114 | classSrc += " )\n\t{\n"; | ||
115 | classSrc += "\t\tObject[] args = new Object[" + com.Arguments.Count.ToString() + "];\n"; | ||
116 | int i = 0; | ||
117 | foreach (KeyValuePair<string, string> arg in com.Arguments) | ||
118 | { | ||
119 | classSrc += "\t\targs[" + i.ToString() + "] = " + Util.Md5Hash(arg.Key) + " " + ";\n"; | ||
120 | i++; | ||
121 | } | ||
122 | classSrc += "\t\tGetCommander(\"" + m_name + "\").Run(\"" + com.Name + "\", args);\n"; | ||
123 | classSrc += "\t}\n"; | ||
124 | } | ||
125 | classSrc += "}\n"; | ||
126 | |||
127 | return classSrc; | ||
128 | } | ||
129 | |||
130 | /// <summary> | ||
131 | /// Runs a specified function with attached arguments | ||
132 | /// *** <b>DO NOT CALL DIRECTLY.</b> *** | ||
133 | /// Call ProcessConsoleCommand instead if handling human input. | ||
134 | /// </summary> | ||
135 | /// <param name="function">The function name to call</param> | ||
136 | /// <param name="args">The function parameters</param> | ||
137 | public void Run(string function, object[] args) | ||
138 | { | ||
139 | m_commands[function].Run(args); | ||
140 | } | ||
141 | |||
142 | public void ProcessConsoleCommand(string function, string[] args) | ||
143 | { | ||
144 | if (m_commands.ContainsKey(function)) | ||
145 | { | ||
146 | if (args.Length > 0 && args[0] == "help") | ||
147 | { | ||
148 | m_commands[function].ShowConsoleHelp(); | ||
149 | } | ||
150 | else | ||
151 | { | ||
152 | m_commands[function].Run(args); | ||
153 | } | ||
154 | } | ||
155 | else | ||
156 | { | ||
157 | if (function == "api") | ||
158 | { | ||
159 | m_log.Info(GenerateRuntimeAPI()); | ||
160 | } | ||
161 | else | ||
162 | { | ||
163 | if (function != "help") | ||
164 | Console.WriteLine("ERROR: Invalid command - No such command exists"); | ||
165 | |||
166 | Console.Write(Help); | ||
167 | } | ||
168 | } | ||
169 | } | ||
170 | |||
171 | #endregion | ||
172 | |||
173 | private string EscapeRuntimeAPICommand(string command) | ||
174 | { | ||
175 | command = command.Replace('-', '_'); | ||
176 | StringBuilder tmp = new StringBuilder(command); | ||
177 | tmp[0] = tmp[0].ToString().ToUpper().ToCharArray()[0]; | ||
178 | |||
179 | return tmp.ToString(); | ||
180 | } | ||
181 | } | ||
182 | } \ No newline at end of file | ||