summaryrefslogtreecommitdiff
path: root/src/leap/bitmask/cli/command.py
diff options
context:
space:
mode:
authorKali Kaneko (leap communications) <kali@leap.se>2016-08-30 10:53:32 -0400
committerKali Kaneko (leap communications) <kali@leap.se>2016-08-30 10:53:32 -0400
commit22eec36ff81ae2ec2b924087ed6253894b92278a (patch)
tree43d6fb8b41c55739fb18e3d005f601b2ecd254e8 /src/leap/bitmask/cli/command.py
parenta039711adaf25cc43681fa89f49d9ef574f255ad (diff)
[pkg] initial migration of bitmask.{core,cli}
Diffstat (limited to 'src/leap/bitmask/cli/command.py')
-rw-r--r--src/leap/bitmask/cli/command.py120
1 files changed, 120 insertions, 0 deletions
diff --git a/src/leap/bitmask/cli/command.py b/src/leap/bitmask/cli/command.py
new file mode 100644
index 00000000..36552c03
--- /dev/null
+++ b/src/leap/bitmask/cli/command.py
@@ -0,0 +1,120 @@
+# -*- coding: utf-8 -*-
+# sender
+# Copyright (C) 2016 LEAP
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+"""
+Bitmask Command Line interface: zmq sender.
+"""
+import argparse
+import json
+import sys
+
+from colorama import init as color_init
+from colorama import Fore
+from twisted.internet import defer
+from txzmq import ZmqEndpoint, ZmqEndpointType
+from txzmq import ZmqFactory, ZmqREQConnection
+from txzmq import ZmqRequestTimeoutError
+
+from leap.bitmask.core import ENDPOINT
+
+
+appname = 'bitmaskctl'
+
+
+def _print_result(result):
+ print Fore.GREEN + '%s' % result + Fore.RESET
+
+
+def default_dict_printer(result):
+ for key, value in result.items():
+ if value is None:
+ value = str(value)
+ print(Fore.RESET + key.ljust(10) + Fore.GREEN + value + Fore.RESET)
+
+
+class Command(object):
+ """A generic command dispatcher.
+ Any command in the class attribute `commands` will be dispached and
+ represented with a generic printer."""
+ service = ''
+ usage = '''{name} <subcommand>'''.format(name=appname)
+ epilog = ("Use bitmaskctl <subcommand> --help' to learn more "
+ "about each command.")
+ commands = []
+
+ def __init__(self):
+ color_init()
+ zf = ZmqFactory()
+ e = ZmqEndpoint(ZmqEndpointType.connect, ENDPOINT)
+ self._conn = ZmqREQConnection(zf, e)
+
+ self.data = []
+ if self.service:
+ self.data = [self.service]
+
+ def execute(self, raw_args):
+ self.parser = argparse.ArgumentParser(usage=self.usage,
+ epilog=self.epilog)
+ self.parser.add_argument('command', help='Subcommand to run')
+ try:
+ args = self.parser.parse_args(raw_args[0:1])
+ except SystemExit:
+ return defer.succeed(None)
+
+ # if command is in the default list, send the bare command
+ # and use the default printer
+ if args.command in self.commands:
+ self.data += [args.command]
+ return self._send(printer=default_dict_printer)
+
+ elif (args.command == 'execute' or
+ args.command.startswith('_') or
+ not hasattr(self, args.command)):
+ print 'Unrecognized command'
+ return self.help([])
+
+ try:
+ # use dispatch pattern to invoke method with same name
+ return getattr(self, args.command)(raw_args[1:])
+ except SystemExit:
+ return defer.succeed(None)
+
+ def help(self, raw_args):
+ self.parser.print_help()
+ return defer.succeed(None)
+
+ def _send(self, printer=_print_result):
+ d = self._conn.sendMsg(*self.data, timeout=60)
+ d.addCallback(self._check_err, printer)
+ d.addErrback(self._timeout_handler)
+ return d
+
+ def _error(self, msg):
+ print Fore.RED + "[!] %s" % msg + Fore.RESET
+ sys.exit(1)
+
+ def _check_err(self, stuff, printer):
+ obj = json.loads(stuff[0])
+ if not obj['error']:
+ return printer(obj['result'])
+ else:
+ print Fore.RED + 'ERROR:' + '%s' % obj['error'] + Fore.RESET
+
+ def _timeout_handler(self, failure):
+ # TODO ---- could try to launch the bitmask daemon here and retry
+ if failure.trap(ZmqRequestTimeoutError) == ZmqRequestTimeoutError:
+ print (Fore.RED + "[ERROR] Timeout contacting the bitmask daemon. "
+ "Is it running?" + Fore.RESET)