summaryrefslogtreecommitdiff
path: root/src/leap/bitmask/cli/bitmask_cli.py
blob: e133089d1d67642a1e70117b939dfeea07c2c766 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# bitmask_cli
# Copyright (C) 2015, 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 client.
"""
import sys
import signal
import traceback

from colorama import Fore
from twisted.internet import reactor, defer

from leap.bitmask.cli import command
from leap.bitmask.cli.keys import Keys
from leap.bitmask.cli.logs import Logs
from leap.bitmask.cli.mail import Mail
from leap.bitmask.cli.provider import Provider
from leap.bitmask.cli.user import User
from leap.bitmask.cli.vpn import VPN
from leap.bitmask.cli.webui import WebUI
from leap.bitmask.config import Configuration


class BitmaskCLI(command.Command):
    usage = '''bitmaskctl <command> [<args>]

Controls the Bitmask application.

SERVICE COMMANDS:

  user       Handles Bitmask accounts
  mail       Bitmask Encrypted Mail
  vpn        Bitmask VPN
  keys       Bitmask Keymanager
  ui         Bitmask User Interface
  logs       Manages the Bitmask daemon logs

GENERAL COMMANDS:

  version    prints version number and exit
  start      starts the Bitmask backend daemon
  stop       stops the Bitmask backend daemon
  status     displays general status about the running Bitmask services
  stats      show some debug info about bitmask-core
  help       show this help message

OPTIONAL ARGUMENTS:

  --json     print the raw json (useful for scripting)
'''
    epilog = ("Use 'bitmaskctl <command> help' to learn more "
              "about each command.")

    def provider(self, raw_args):
        provider = Provider(self.cfg, self.print_json)
        return provider.execute(raw_args)

    def user(self, raw_args):
        user = User(self.cfg, self.print_json)
        return user.execute(raw_args)

    def mail(self, raw_args):
        mail = Mail(self.cfg, self.print_json)
        return mail.execute(raw_args)

    def vpn(self, raw_args):
        vpn = VPN(self.cfg, self.print_json)
        return vpn.execute(raw_args)

    def keys(self, raw_args):
        keys = Keys(self.cfg, self.print_json)
        return keys.execute(raw_args)

    def ui(self, raw_args):
        webui = WebUI(self.cfg, self.print_json)
        return webui.execute(raw_args)

    def logs(self, raw_args):
        logs = Logs(self.cfg, self.print_json)
        return logs.execute(raw_args)

    # Single commands

    def start(self, raw_args):
        # XXX careful! Should see if the process in PID is running,
        # avoid launching again.
        import commands
        cmd = 'bitmaskd'
        if raw_args and ('--verbose' in raw_args or '-v' in raw_args):
            cmd += ' --verbose'
        commands.getoutput(cmd)
        self.cfg.set('bonafide', 'active', "")
        return defer.succeed(None)

    def version(self, raw_args):
        self.data = ['core', 'version']
        return self._send(printer=self._print_version)

    def _print_version(self, version):
        corever = version['version_core']
        print(Fore.GREEN + 'bitmask_core: ' + Fore.RESET + corever)

    def status(self, raw_args):
        self.data = ['core', 'status']
        return self._send(printer=self._print_status)

    def _print_status(self, status):
        for key, value in status.items():
            color = Fore.GREEN
            if value == 'stopped':
                color = Fore.RED
            print(key.ljust(10) + ': ' + color +
                  value + Fore.RESET)

    def stop(self, raw_args):
        self.data = ['core', 'stop']
        self.cfg.set('bonafide', 'active', "")
        return self._send(printer=command.default_printer)

    def stats(self, raw_args):
        self.data = ['core', 'stats']
        return self._send(printer=command.default_printer)


def should_start(commands):
    # for these commands it makes no sense to start bitmaskd
    skip_start = ('status', 'stop')
    return all(map(lambda item: item not in skip_start, commands))


@defer.inlineCallbacks
def execute():
    cfg = Configuration(".bitmaskctl")
    print_json = '--json' in sys.argv

    cli = BitmaskCLI(cfg)
    cli.data = ['core', 'version']
    args = None if '--noverbose' in sys.argv else ['--verbose']

    if should_start(sys.argv):
        timeout_fun = cli.start
    else:
        def status_timeout(args):
            raise RuntimeError('bitmaskd is not running')
        timeout_fun = status_timeout

    try:
        yield cli._send(
            timeout=0.1, printer=_null_printer,
            errb=lambda: timeout_fun(args))
    except Exception, e:
        print(Fore.RED + "ERROR: " + Fore.RESET +
              "%s" % str(e))
        yield reactor.stop()


    cli.data = []
    cli.print_json = print_json
    args = sys.argv[1:]
    if print_json:
        args.remove('--json')

    try:
        yield cli.execute(args)
        cmdline = ' '.join(sys.argv)
        if 'ctl start' in cmdline or 'ctl restart' in cmdline:
            command.default_printer({'start': 'ok'})
    except Exception as e:
        print(Fore.RED + "ERROR: " + Fore.RESET +
              "%s" % str(e))
        if not hasattr(e, 'expected'):
            print(traceback.format_exc())
    finally:
        yield reactor.stop()


def _null_printer(*args):
    pass


def main():

    def signal_handler(signal, frame):
        if reactor.running:
            reactor.stop()
        sys.exit(0)

    reactor.callWhenRunning(reactor.callLater, 0, execute)
    signal.signal(signal.SIGINT, signal_handler)
    reactor.run()


if __name__ == "__main__":
    main()