diff options
Diffstat (limited to 'OpenSim/Region/Environment/Modules/Framework')
-rw-r--r-- | OpenSim/Region/Environment/Modules/Framework/InterfaceCommander/Command.cs | 204 | ||||
-rw-r--r-- | OpenSim/Region/Environment/Modules/Framework/InterfaceCommander/Commander.cs | 171 |
2 files changed, 204 insertions, 171 deletions
diff --git a/OpenSim/Region/Environment/Modules/Framework/InterfaceCommander/Command.cs b/OpenSim/Region/Environment/Modules/Framework/InterfaceCommander/Command.cs new file mode 100644 index 0000000..6642bdc --- /dev/null +++ b/OpenSim/Region/Environment/Modules/Framework/InterfaceCommander/Command.cs | |||
@@ -0,0 +1,204 @@ | |||
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.Environment.Interfaces; | ||
31 | |||
32 | namespace OpenSim.Region.Environment.Modules.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 void ShowConsoleHelp() | ||
92 | { | ||
93 | Console.WriteLine("== " + Name + " =="); | ||
94 | Console.WriteLine(m_help); | ||
95 | Console.WriteLine("= Parameters ="); | ||
96 | foreach (CommandArgument arg in m_args) | ||
97 | { | ||
98 | Console.WriteLine("* " + arg.Name + " (" + arg.ArgumentType + ")"); | ||
99 | Console.WriteLine("\t" + arg.HelpText); | ||
100 | } | ||
101 | } | ||
102 | |||
103 | public void Run(Object[] args) | ||
104 | { | ||
105 | Object[] cleanArgs = new Object[m_args.Count]; | ||
106 | |||
107 | if (args.Length < cleanArgs.Length) | ||
108 | { | ||
109 | Console.WriteLine("ERROR: Missing " + (cleanArgs.Length - args.Length) + " argument(s)"); | ||
110 | ShowConsoleHelp(); | ||
111 | return; | ||
112 | } | ||
113 | if (args.Length > cleanArgs.Length) | ||
114 | { | ||
115 | Console.WriteLine("ERROR: Too many arguments for this command. Type '<module> <command> help' for help."); | ||
116 | return; | ||
117 | } | ||
118 | |||
119 | int i = 0; | ||
120 | foreach (Object arg in args) | ||
121 | { | ||
122 | if (string.IsNullOrEmpty(arg.ToString())) | ||
123 | { | ||
124 | Console.WriteLine("ERROR: Empty arguments are not allowed"); | ||
125 | return; | ||
126 | } | ||
127 | try | ||
128 | { | ||
129 | switch (m_args[i].ArgumentType) | ||
130 | { | ||
131 | case "String": | ||
132 | m_args[i].ArgumentValue = arg.ToString(); | ||
133 | break; | ||
134 | case "Integer": | ||
135 | m_args[i].ArgumentValue = Int32.Parse(arg.ToString()); | ||
136 | break; | ||
137 | case "Double": | ||
138 | m_args[i].ArgumentValue = Double.Parse(arg.ToString()); | ||
139 | break; | ||
140 | case "Boolean": | ||
141 | m_args[i].ArgumentValue = Boolean.Parse(arg.ToString()); | ||
142 | break; | ||
143 | default: | ||
144 | Console.WriteLine("ERROR: Unknown desired type for argument " + m_args[i].Name + " on command " + m_name); | ||
145 | break; | ||
146 | } | ||
147 | } | ||
148 | catch (FormatException) | ||
149 | { | ||
150 | Console.WriteLine("ERROR: Argument number " + (i + 1) + | ||
151 | " (" + m_args[i].Name + ") must be a valid " + | ||
152 | m_args[i].ArgumentType.ToLower() + "."); | ||
153 | return; | ||
154 | } | ||
155 | cleanArgs[i] = m_args[i].ArgumentValue; | ||
156 | |||
157 | i++; | ||
158 | } | ||
159 | |||
160 | m_command.Invoke(cleanArgs); | ||
161 | } | ||
162 | |||
163 | #endregion | ||
164 | } | ||
165 | |||
166 | /// <summary> | ||
167 | /// A single command argument, contains name, type and at runtime, value. | ||
168 | /// </summary> | ||
169 | public class CommandArgument | ||
170 | { | ||
171 | private string m_help; | ||
172 | private string m_name; | ||
173 | private string m_type; | ||
174 | private Object m_val; | ||
175 | |||
176 | public CommandArgument(string name, string help, string type) | ||
177 | { | ||
178 | m_name = name; | ||
179 | m_help = help; | ||
180 | m_type = type; | ||
181 | } | ||
182 | |||
183 | public string Name | ||
184 | { | ||
185 | get { return m_name; } | ||
186 | } | ||
187 | |||
188 | public string HelpText | ||
189 | { | ||
190 | get { return m_help; } | ||
191 | } | ||
192 | |||
193 | public string ArgumentType | ||
194 | { | ||
195 | get { return m_type; } | ||
196 | } | ||
197 | |||
198 | public Object ArgumentValue | ||
199 | { | ||
200 | get { return m_val; } | ||
201 | set { m_val = value; } | ||
202 | } | ||
203 | } | ||
204 | } | ||
diff --git a/OpenSim/Region/Environment/Modules/Framework/InterfaceCommander/Commander.cs b/OpenSim/Region/Environment/Modules/Framework/InterfaceCommander/Commander.cs index ae34d37..8b19043 100644 --- a/OpenSim/Region/Environment/Modules/Framework/InterfaceCommander/Commander.cs +++ b/OpenSim/Region/Environment/Modules/Framework/InterfaceCommander/Commander.cs | |||
@@ -36,177 +36,6 @@ using OpenSim.Region.Environment.Interfaces; | |||
36 | namespace OpenSim.Region.Environment.Modules.Framework.InterfaceCommander | 36 | namespace OpenSim.Region.Environment.Modules.Framework.InterfaceCommander |
37 | { | 37 | { |
38 | /// <summary> | 38 | /// <summary> |
39 | /// A single function call encapsulated in a class which enforces arguments when passing around as Object[]'s. | ||
40 | /// Used for console commands and script API generation | ||
41 | /// </summary> | ||
42 | public class Command : ICommand | ||
43 | { | ||
44 | //private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType); | ||
45 | private List<CommandArgument> m_args = new List<CommandArgument>(); | ||
46 | |||
47 | private Action<object[]> m_command; | ||
48 | private string m_help; | ||
49 | private string m_name; | ||
50 | private CommandIntentions m_intentions; //A permission type system could implement this and know what a command intends on doing. | ||
51 | |||
52 | public Command(string name, CommandIntentions intention, Action<Object[]> command, string help) | ||
53 | { | ||
54 | m_name = name; | ||
55 | m_command = command; | ||
56 | m_help = help; | ||
57 | m_intentions = intention; | ||
58 | } | ||
59 | |||
60 | #region ICommand Members | ||
61 | |||
62 | public void AddArgument(string name, string helptext, string type) | ||
63 | { | ||
64 | m_args.Add(new CommandArgument(name, helptext, type)); | ||
65 | } | ||
66 | |||
67 | public string Name | ||
68 | { | ||
69 | get { return m_name; } | ||
70 | } | ||
71 | |||
72 | public CommandIntentions Intentions | ||
73 | { | ||
74 | get { return m_intentions; } | ||
75 | } | ||
76 | |||
77 | public string Help | ||
78 | { | ||
79 | get { return m_help; } | ||
80 | } | ||
81 | |||
82 | public Dictionary<string, string> Arguments | ||
83 | { | ||
84 | get | ||
85 | { | ||
86 | Dictionary<string, string> tmp = new Dictionary<string, string>(); | ||
87 | foreach (CommandArgument arg in m_args) | ||
88 | { | ||
89 | tmp.Add(arg.Name, arg.ArgumentType); | ||
90 | } | ||
91 | return tmp; | ||
92 | } | ||
93 | } | ||
94 | |||
95 | public void ShowConsoleHelp() | ||
96 | { | ||
97 | Console.WriteLine("== " + Name + " =="); | ||
98 | Console.WriteLine(m_help); | ||
99 | Console.WriteLine("= Parameters ="); | ||
100 | foreach (CommandArgument arg in m_args) | ||
101 | { | ||
102 | Console.WriteLine("* " + arg.Name + " (" + arg.ArgumentType + ")"); | ||
103 | Console.WriteLine("\t" + arg.HelpText); | ||
104 | } | ||
105 | } | ||
106 | |||
107 | public void Run(Object[] args) | ||
108 | { | ||
109 | Object[] cleanArgs = new Object[m_args.Count]; | ||
110 | |||
111 | if (args.Length < cleanArgs.Length) | ||
112 | { | ||
113 | Console.WriteLine("ERROR: Missing " + (cleanArgs.Length - args.Length) + " argument(s)"); | ||
114 | ShowConsoleHelp(); | ||
115 | return; | ||
116 | } | ||
117 | if (args.Length > cleanArgs.Length) | ||
118 | { | ||
119 | Console.WriteLine("ERROR: Too many arguments for this command. Type '<module> <command> help' for help."); | ||
120 | return; | ||
121 | } | ||
122 | |||
123 | int i = 0; | ||
124 | foreach (Object arg in args) | ||
125 | { | ||
126 | if (string.IsNullOrEmpty(arg.ToString())) | ||
127 | { | ||
128 | Console.WriteLine("ERROR: Empty arguments are not allowed"); | ||
129 | return; | ||
130 | } | ||
131 | try | ||
132 | { | ||
133 | switch (m_args[i].ArgumentType) | ||
134 | { | ||
135 | case "String": | ||
136 | m_args[i].ArgumentValue = arg.ToString(); | ||
137 | break; | ||
138 | case "Integer": | ||
139 | m_args[i].ArgumentValue = Int32.Parse(arg.ToString()); | ||
140 | break; | ||
141 | case "Double": | ||
142 | m_args[i].ArgumentValue = Double.Parse(arg.ToString()); | ||
143 | break; | ||
144 | case "Boolean": | ||
145 | m_args[i].ArgumentValue = Boolean.Parse(arg.ToString()); | ||
146 | break; | ||
147 | default: | ||
148 | Console.WriteLine("ERROR: Unknown desired type for argument " + m_args[i].Name + " on command " + m_name); | ||
149 | break; | ||
150 | } | ||
151 | } | ||
152 | catch (FormatException) | ||
153 | { | ||
154 | Console.WriteLine("ERROR: Argument number " + (i + 1) + | ||
155 | " (" + m_args[i].Name + ") must be a valid " + | ||
156 | m_args[i].ArgumentType.ToLower() + "."); | ||
157 | return; | ||
158 | } | ||
159 | cleanArgs[i] = m_args[i].ArgumentValue; | ||
160 | |||
161 | i++; | ||
162 | } | ||
163 | |||
164 | m_command.Invoke(cleanArgs); | ||
165 | } | ||
166 | |||
167 | #endregion | ||
168 | } | ||
169 | |||
170 | /// <summary> | ||
171 | /// A single command argument, contains name, type and at runtime, value. | ||
172 | /// </summary> | ||
173 | public class CommandArgument | ||
174 | { | ||
175 | private string m_help; | ||
176 | private string m_name; | ||
177 | private string m_type; | ||
178 | private Object m_val; | ||
179 | |||
180 | public CommandArgument(string name, string help, string type) | ||
181 | { | ||
182 | m_name = name; | ||
183 | m_help = help; | ||
184 | m_type = type; | ||
185 | } | ||
186 | |||
187 | public string Name | ||
188 | { | ||
189 | get { return m_name; } | ||
190 | } | ||
191 | |||
192 | public string HelpText | ||
193 | { | ||
194 | get { return m_help; } | ||
195 | } | ||
196 | |||
197 | public string ArgumentType | ||
198 | { | ||
199 | get { return m_type; } | ||
200 | } | ||
201 | |||
202 | public Object ArgumentValue | ||
203 | { | ||
204 | get { return m_val; } | ||
205 | set { m_val = value; } | ||
206 | } | ||
207 | } | ||
208 | |||
209 | /// <summary> | ||
210 | /// A class to enable modules to register console and script commands, which enforces typing and valid input. | 39 | /// A class to enable modules to register console and script commands, which enforces typing and valid input. |
211 | /// </summary> | 40 | /// </summary> |
212 | public class Commander : ICommander | 41 | public class Commander : ICommander |