plcsh

   1 #!/usr/bin/python
   2 #
   3 # Interactive shell for testing PLCAPI
   4 #
   5 # Mark Huang <mlhuang@cs.princeton.edu>
   6 # Copyright (C) 2005 The Trustees of Princeton University
   7 #
   8 # $Id: plcsh,v 1.6 2007/02/08 21:49:41 mlhuang Exp $
   9 #
  10
  11 import os
  12 import sys
  13 from socket import gethostname
  14 from optparse import OptionParser
  15 from getpass import getpass
  16 from traceback import print_exc
  17
  18 sys.path.append(os.path.dirname(os.path.realpath(sys.argv[0])))
  19 from PLC.Shell import Shell
  20
  21 parser = OptionParser(add_help_option = False)
  22 parser.add_option("-f", "--config", help = "PLC configuration file")
  23 parser.add_option("-h", "--url", help = "API URL")
  24 parser.add_option("-c", "--cacert", help = "API SSL certificate")
  25 parser.add_option("-k", "--insecure", help = "Do not check SSL certificate")
  26 parser.add_option("-m", "--method", help = "API authentication method")
  27 parser.add_option("-s", "--session", help = "API session key")
  28 parser.add_option("-u", "--user", help = "API user name")
  29 parser.add_option("-p", "--password", help = "API password")
  30 parser.add_option("-r", "--role", help = "API role")
  31 parser.add_option("-x", "--xmlrpc", action = "store_true", default = False, help = "Use XML-RPC interface")
  32 parser.add_option("--help", action = "help", help = "show this help message and exit")
  33 (options, args) = parser.parse_args()
  34
  35 # If user is specified but password is not
  36 if options.user is not None and options.password is None:
  37     try:
  38         options.password = getpass()
  39     except (EOFError, KeyboardInterrupt):
  40         print
  41         sys.exit(0)
  42
  43 # Initialize a single global instance (scripts may re-initialize
  44 # this instance and/or create additional instances).
  45 try:
  46     shell = Shell(globals = globals(),
  47                   config = options.config,
  48                   url = options.url, xmlrpc = options.xmlrpc, cacert = options.cacert,
  49                   method = options.method, role = options.role,
  50                   user = options.user, password = options.password,
  51                   session = options.session)
  52     # Register a few more globals for backward compatibility
  53     auth = shell.auth
  54     api = shell.api
  55     config = shell.config
  56 except Exception, err:
  57     print "Error:", err
  58     print
  59     parser.print_help()
  60     sys.exit(1)
  61
  62 # If called by a script
  63 if len(sys.argv) > 1 and os.path.exists(sys.argv[1]):
  64     # Pop us off the argument stack
  65     sys.argv.pop(0)
  66     execfile(sys.argv[0])
  67
  68 # Otherwise, run an interactive shell environment
  69 else:
  70     if shell.server is None:
  71         print "PlanetLab Central Direct API Access"
  72         prompt = ""
  73     elif shell.auth['AuthMethod'] == "anonymous":
  74         prompt = "[anonymous]"
  75         print "Connected anonymously"
  76     elif shell.auth['AuthMethod'] == "session":
  77         # XXX No way to tell node and user sessions apart from the
  78         # client point of view.
  79         prompt = "[%s]" % gethostname()
  80         print "%s connected using session authentication" % gethostname()
  81     else:
  82         prompt = "[%s]" % shell.auth['Username']
  83         print "%s connected using %s authentication" % \
  84               (shell.auth['Username'], shell.auth['AuthMethod'])
  85
  86     # Readline and tab completion support
  87     import atexit
  88     import readline
  89     import rlcompleter
  90
  91     print 'Type "system.listMethods()" or "help(method)" for more information.'
  92     # Load command history
  93     history_path = os.path.join(os.environ["HOME"], ".plcapi_history")
  94     try:
  95         file(history_path, 'a').close()
  96         readline.read_history_file(history_path)
  97         atexit.register(readline.write_history_file, history_path)
  98     except IOError:
  99         pass
 100
 101     # Enable tab completion
 102     readline.parse_and_bind("tab: complete")
 103
 104     try:
 105         while True:
 106             command = ""
 107             while True:
 108                 # Get line
 109                 try:
 110                     if command == "":
 111                         sep = ">>> "
 112                     else:
 113                         sep = "... "
 114                     line = raw_input(prompt + sep)
 115                 # Ctrl-C
 116                 except KeyboardInterrupt:
 117                     command = ""
 118                     print
 119                     break
 120
 121                 # Build up multi-line command
 122                 command += line
 123
 124                 # Blank line or first line does not end in :
 125                 if line == "" or (command == line and line[-1] != ':'):
 126                     break
 127
 128                 command += os.linesep
 129
 130             # Blank line
 131             if command == "":
 132                 continue
 133             # Quit
 134             elif command in ["q", "quit", "exit"]:
 135                 break
 136
 137             try:
 138                 try:
 139                     # Try evaluating as an expression and printing the result
 140                     result = eval(command)
 141                     if result is not None:
 142                         print result
 143                 except SyntaxError:
 144                     # Fall back to executing as a statement
 145                     exec command
 146             except Exception, err:
 147                 print_exc()
 148
 149     except EOFError:
 150         print
 151         pass