4 srfsh.py - provides a basic shell for issuing OpenSRF requests
10 - runs <count> opensrf.math requests and reports the average time
12 request <service> <method> [<param1>, <param2>, ...]
13 - performs an opensrf request
16 - sets an environment variable
18 Environment variables:
19 SRFSH_OUTPUT = pretty - print pretty JSON and key/value pairs for network objects
20 = raw - print formatted JSON
22 SRFSH_LOCALE = <locale> - request responses to be returned in locale <locale> if available
25 import os, sys, time, readline, atexit, re
26 import osrf.json, osrf.system, osrf.ses, osrf.conf, osrf.log, osrf.net
28 # -------------------------------------------------------------------
30 # -------------------------------------------------------------------
35 line = raw_input("srfsh% ")
38 if str.lower(line) == 'exit' or str.lower(line) == 'quit':
40 parts = str.split(line)
44 if command == 'request':
49 if command == 'math_bench':
51 handle_math_bench(parts)
68 except KeyboardInterrupt:
76 # -------------------------------------------------------------------
77 # Set env variables to control behavior
78 # -------------------------------------------------------------------
79 def handle_set(parts):
81 pattern = re.compile('(.*)=(.*)').match(cmd)
82 key = pattern.group(1)
83 val = pattern.group(2)
85 print "%s = %s" % (key, val)
87 def handle_get(parts):
89 print get_var(parts[0])
94 # -------------------------------------------------------------------
96 # -------------------------------------------------------------------
100 # -------------------------------------------------------------------
101 # performs an opensrf request
102 # -------------------------------------------------------------------
103 def handle_request(parts):
104 service = parts.pop(0)
105 method = parts.pop(0)
106 locale = __get_locale()
107 jstr = '[%s]' % "".join(parts)
111 params = osrf.json.to_object(jstr)
113 print "Error parsing JSON: %s" % jstr
116 ses = osrf.ses.ClientSession(service, locale=locale)
120 req = ses.request2(method, tuple(params))
126 resp = req.recv(timeout=120)
127 except osrf.net.XMPPNoRecipient:
128 print "Unable to communicate with %s" % service
132 osrf.log.log_internal("Looping through receive request")
135 total = time.time() - start
137 print str(resp.content())
138 otp = get_var('SRFSH_OUTPUT')
140 print "\n" + osrf.json.debug_net_object(resp.content())
142 print osrf.json.pprint(osrf.json.to_json(resp.content()))
148 print "Total request time: %f" % total
152 def handle_math_bench(parts):
154 count = int(parts.pop(0))
155 ses = osrf.ses.ClientSession('opensrf.math')
158 for cnt in range(100):
160 sys.stdout.write('.')
162 sys.stdout.write( str( cnt / 10 ) )
166 for cnt in range(count):
168 starttime = time.time()
169 req = ses.request('add', 1, 2)
170 resp = req.recv(timeout=2)
171 endtime = time.time()
173 if resp.content() == 3:
174 sys.stdout.write("+")
176 times.append( endtime - starttime )
178 print "What happened? %s" % str(resp.content())
181 if not ( (cnt + 1) % 100):
182 print ' [%d]' % (cnt + 1)
188 print "\naverage time %f" % (total / len(times))
193 # -------------------------------------------------------------------
194 # Defines the tab-completion handling and sets up the readline history
195 # -------------------------------------------------------------------
196 def setup_readline():
197 class SrfshCompleter(object):
198 def __init__(self, words):
202 def complete(self, prefix, index):
203 if prefix != self.prefix:
204 # find all words that start with this prefix
205 self.matching_words = [
206 w for w in self.words if w.startswith(prefix)
210 return self.matching_words[index]
214 words = 'request', 'help', 'exit', 'quit', 'opensrf.settings', 'opensrf.math', 'set'
215 completer = SrfshCompleter(words)
216 readline.parse_and_bind("tab: complete")
217 readline.set_completer(completer.complete)
219 histfile = os.path.join(get_var('HOME'), ".srfsh_history")
221 readline.read_history_file(histfile)
224 atexit.register(readline.write_history_file, histfile)
227 file = os.path.join(get_var('HOME'), ".srfsh.xml")
228 print_stdout("Connecting to opensrf...")
229 osrf.system.System.connect(config_file=file, config_context='srfsh')
233 # Load the user defined external plugins
234 # XXX Make this a real module interface, with tab-complete words, commands, etc.
236 plugins = osrf.conf.get('plugins')
239 # XXX standard srfsh.xml does not yet define <plugins> element
240 #print_stdout("No plugins defined in /srfsh/plugins/plugin\n")
243 plugins = osrf.conf.get('plugins.plugin')
244 if not isinstance(plugins, list):
247 for module in plugins:
248 name = module['module']
249 init = module['init']
250 print_stdout("Loading module %s..." % name)
253 string = 'import %s\n%s.%s()' % (name, name, init)
258 sys.stderr.write("\nError importing plugin %s, with init symbol %s: \n%s\n" % (name, init, e))
261 if not get_var('SRFSH_OUTPUT'):
262 set_var('SRFSH_OUTPUT', 'raw')
264 # XXX Do we need to differ between LANG and LC_MESSAGES?
265 if not get_var('SRFSH_LOCALE'):
266 set_var('SRFSH_LOCALE', get_var('LC_ALL'))
268 def set_var(key, val):
269 os.environ[key] = val
272 return os.environ.get(key, '')
276 Return the defined locale for this srfsh session.
278 A locale in OpenSRF is currently defined as a [a-z]{2}-[A-Z]{2} pattern.
279 This function munges the LC_ALL setting to conform to that pattern; for
280 example, trimming en_CA.UTF-8 to en-CA.
283 >>> srfsh.set_var('SRFSH_LOCALE', 'zz-ZZ')
284 >>> print __get_locale()
286 >>> srfsh.set_var('SRFSH_LOCALE', 'en_CA.UTF-8')
287 >>> print __get_locale()
291 env_locale = get_var('SRFSH_LOCALE')
293 pattern = re.compile(r'^\s*([a-z]+)[^a-zA-Z]([A-Z]+)').search(env_locale)
294 lang = pattern.group(1)
295 region = pattern.group(2)
296 locale = "%s-%s" % (lang, region)
302 def print_stdout(string):
303 sys.stdout.write(string)
307 if __name__ == '__main__':