forked from errbotio/errbot
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcli.py
More file actions
executable file
·294 lines (247 loc) · 12.5 KB
/
cli.py
File metadata and controls
executable file
·294 lines (247 loc) · 12.5 KB
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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
#!/usr/bin/env python
# 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, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
import argparse
import locale
import logging
import os
import sys
from os import path, sep, getcwd, access, W_OK
from platform import system
import ast
from errbot.logs import root_logger
from errbot.plugin_wizard import new_plugin_wizard
from errbot.version import VERSION
log = logging.getLogger(__name__)
# noinspection PyUnusedLocal
def debug(sig, frame):
"""Interrupt running process, and provide a python prompt for
interactive debugging."""
d = {'_frame': frame} # Allow access to frame object.
d.update(frame.f_globals) # Unless shadowed by global
d.update(frame.f_locals)
i = code.InteractiveConsole(d)
message = 'Signal received : entering python shell.\nTraceback:\n'
message += ''.join(traceback.format_stack(frame))
i.interact(message)
ON_WINDOWS = system() == 'Windows'
if not ON_WINDOWS:
from daemonize import Daemonize
import code
import traceback
import signal
signal.signal(signal.SIGUSR1, debug) # Register handler for debugging
def get_config(config_path):
config_fullpath = config_path
if not path.exists(config_fullpath):
log.error(f'I cannot find the config file {config_path}.')
log.error('You can change this path with the -c parameter see --help')
log.info(f'You can use the template {os.path.realpath(os.path.join(__file__, os.pardir, "config-template.py"))}'
f' as a base and copy it to {config_path}.')
log.info('You can then customize it.')
exit(-1)
try:
config = __import__(path.splitext(path.basename(config_fullpath))[0])
log.info('Config check passed...')
return config
except Exception:
log.exception(f'I could not import your config from {config_fullpath}, please check the error below...')
exit(-1)
def _read_dict():
import collections
new_dict = ast.literal_eval(sys.stdin.read())
if not isinstance(new_dict, collections.Mapping):
raise ValueError(f'A dictionary written in python is needed from stdin. '
f'Type={type(new_dict)}, Value = {repr(new_dict)}.')
return new_dict
def main():
execution_dir = getcwd()
# By default insert the execution path (useful to be able to execute Errbot from
# the source tree directly without installing it.
sys.path.insert(0, execution_dir)
parser = argparse.ArgumentParser(description='The main entry point of the errbot.')
parser.add_argument('-c', '--config', default=None,
help='Full path to your config.py (default: config.py in current working directory).')
mode_selection = parser.add_mutually_exclusive_group()
mode_selection.add_argument('-v', '--version', action='version', version=f'Errbot version {VERSION}')
mode_selection.add_argument('-r', '--restore', nargs='?', default=None, const='default',
help='restore a bot from backup.py (default: backup.py from the bot data directory)')
mode_selection.add_argument('-l', '--list', action='store_true', help='list all available backends')
mode_selection.add_argument('--new-plugin', nargs='?', default=None, const='current_dir',
help='create a new plugin in the specified directory')
mode_selection.add_argument('-i', '--init',
nargs='?',
default=None,
const='.',
help='Initialize a simple bot minimal configuration in the optionally '
'given directory (otherwise it will be the working directory). '
'This will create a data subdirectory for the bot data dir and a plugins directory'
' for your plugin development with an example in it to get you started.')
# storage manipulation
mode_selection.add_argument('--storage-set', nargs=1, help='DANGER: Delete the given storage namespace '
'and set the python dictionary expression '
'passed on stdin.')
mode_selection.add_argument('--storage-merge', nargs=1, help='DANGER: Merge in the python dictionary expression '
'passed on stdin into the given storage namespace.')
mode_selection.add_argument('--storage-get', nargs=1, help='Dump the given storage namespace in a '
'format compatible for --storage-set and '
'--storage-merge.')
mode_selection.add_argument('-T', '--text', dest="backend", action='store_const', const="Text",
help='force local text backend')
mode_selection.add_argument('-G', '--graphic', dest="backend", action='store_const', const="Graphic",
help='force local graphical backend')
if not ON_WINDOWS:
option_group = parser.add_argument_group('optional daemonization arguments')
option_group.add_argument('-d', '--daemon', action='store_true', help='Detach the process from the console')
option_group.add_argument('-p', '--pidfile', default=None,
help='Specify the pid file for the daemon (default: current bot data directory)')
args = vars(parser.parse_args()) # create a dictionary of args
if args['init']:
try:
import jinja2
import shutil
base_dir = os.getcwd() if args['init'] == '.' else args['init']
if not os.path.isdir(base_dir):
print(f'Target directory {base_dir} must exist. Please create it.')
base_dir = os.path.abspath(base_dir)
data_dir = os.path.join(base_dir, 'data')
extra_plugin_dir = os.path.join(base_dir, 'plugins')
example_plugin_dir = os.path.join(extra_plugin_dir, 'err-example')
log_path = os.path.join(base_dir, 'errbot.log')
templates_dir = os.path.join(os.path.dirname(__file__), 'templates', 'initdir')
env = jinja2.Environment(loader=jinja2.FileSystemLoader(templates_dir), autoescape=True)
config_template = env.get_template('config.py.tmpl')
os.mkdir(data_dir)
os.mkdir(extra_plugin_dir)
os.mkdir(example_plugin_dir)
with open(os.path.join(base_dir, 'config.py'), 'w') as f:
f.write(config_template.render(data_dir=data_dir,
extra_plugin_dir=extra_plugin_dir,
log_path=log_path))
shutil.copyfile(os.path.join(templates_dir, 'example.plug'),
os.path.join(example_plugin_dir, 'example.plug'))
shutil.copyfile(os.path.join(templates_dir, 'example.py'), os.path.join(example_plugin_dir, 'example.py'))
print('Your Errbot directory has been correctly initialized !')
if base_dir == os.getcwd():
print('Just do "errbot" and it should start in text/development mode.')
else:
print(f'Just do "cd {args["init"]}" then "errbot" and it should start in text/development mode.')
sys.exit(0)
except Exception as e:
print(f'The initialization of your errbot directory failed: {e}.')
sys.exit(1)
# This must come BEFORE the config is loaded below, to avoid printing
# logs as a side effect of config loading.
if args['new_plugin']:
directory = os.getcwd() if args['new_plugin'] == "current_dir" else args['new_plugin']
for handler in logging.getLogger().handlers:
root_logger.removeHandler(handler)
try:
new_plugin_wizard(directory)
except KeyboardInterrupt:
sys.exit(1)
except Exception as e:
sys.stderr.write(str(e) + "\n")
sys.exit(1)
finally:
sys.exit(0)
config_path = args['config']
# setup the environment to be able to import the config.py
if config_path:
# appends the current config in order to find config.py
sys.path.insert(0, path.dirname(path.abspath(config_path)))
else:
config_path = execution_dir + sep + 'config.py'
config = get_config(config_path) # will exit if load fails
if args['list']:
from errbot.bootstrap import enumerate_backends
print('Available backends:')
for backend_name in enumerate_backends(config):
print(f'\t\t{backend_name}')
sys.exit(0)
def storage_action(namespace, fn):
# Used to defer imports until it is really necessary during the loading time.
from errbot.bootstrap import get_storage_plugin
from errbot.storage import StoreMixin
try:
with StoreMixin() as sdm:
sdm.open_storage(get_storage_plugin(config), namespace)
fn(sdm)
return 0
except Exception as e:
print(str(e), file=sys.stderr)
return -3
if args['storage_get']:
def p(sdm):
print(repr(dict(sdm)))
err_value = storage_action(args['storage_get'][0], p)
sys.exit(err_value)
if args['storage_set']:
def replace(sdm):
new_dict = _read_dict() # fail early and don't erase the storage if the input is invalid.
sdm.clear()
sdm.update(new_dict)
err_value = storage_action(args['storage_set'][0], replace)
sys.exit(err_value)
if args['storage_merge']:
def merge(sdm):
new_dict = _read_dict()
sdm.update(new_dict)
err_value = storage_action(args['storage_merge'][0], merge)
sys.exit(err_value)
if args['restore']:
backend = 'Null' # we don't want any backend when we restore
elif args['backend'] is None:
if not hasattr(config, 'BACKEND'):
log.fatal("The BACKEND configuration option is missing in config.py")
sys.exit(1)
backend = config.BACKEND
else:
backend = args['backend']
log.info(f'Selected backend {backend}.')
# Check if at least we can start to log something before trying to start
# the bot (esp. daemonize it).
log.info(f'Checking for {config.BOT_DATA_DIR}...')
if not path.exists(config.BOT_DATA_DIR):
raise Exception(f'The data directory "{config.BOT_DATA_DIR}" for the bot does not exist.')
if not access(config.BOT_DATA_DIR, W_OK):
raise Exception(f'The data directory "{config.BOT_DATA_DIR}" should be writable for the bot.')
if (not ON_WINDOWS) and args['daemon']:
if args['backend'] == 'Text':
raise Exception('You cannot run in text and daemon mode at the same time')
if args['restore']:
raise Exception('You cannot restore a backup in daemon mode.')
if args['pidfile']:
pid = args['pidfile']
else:
pid = config.BOT_DATA_DIR + sep + 'err.pid'
# noinspection PyBroadException
try:
def action():
from errbot.bootstrap import bootstrap
bootstrap(backend, root_logger, config)
daemon = Daemonize(app="err", pid=pid, action=action, chdir=os.getcwd())
log.info("Daemonizing")
daemon.start()
except Exception:
log.exception('Failed to daemonize the process')
exit(0)
from errbot.bootstrap import bootstrap
restore = args['restore']
if restore == 'default': # restore with no argument, get the default location
restore = path.join(config.BOT_DATA_DIR, 'backup.py')
bootstrap(backend, root_logger, config, restore)
log.info('Process exiting')
if __name__ == "__main__":
main()