4 # https://sourceware.org/bugzilla/show_bug.cgi?id=26034
5 export "BUP_ARGV_0"="$0"
8 export "BUP_ARGV_${arg_i}"="$arg"
12 # Here to end of preamble replaced during install
16 # loop because macos doesn't have recursive readlink/realpath utils
17 while test -L "$cmdpath"; do
18 link="$(readlink "$cmdpath")"
19 cd "$(dirname "$cmdpath")"
22 script_home="$(cd "$(dirname "$cmdpath")" && pwd -P)"
24 exec "$script_home/../../config/bin/python" "$0"
28 from __future__ import absolute_import, print_function
31 sys.path[:0] = [os.path.dirname(os.path.realpath(__file__)) + '/..']
33 from importlib import import_module
34 from pkgutil import iter_modules
35 from subprocess import PIPE
36 from threading import Thread
37 import errno, getopt, os, re, select, signal, subprocess, sys
39 from bup import compat, path, helpers
40 from bup.compat import (
50 from bup.compat import add_ex_tb, add_ex_ctx, argv_bytes, wrap_main
51 from bup.helpers import (
59 from bup.git import close_catpipes
60 from bup.io import byte_stream, path_msg
61 from bup.options import _tty_width
64 def maybe_import_early(argv):
65 """Scan argv and import any modules specified by --import-py-module."""
67 if argv[0] != '--import-py-module':
71 log("bup: --import-py-module must have an argument\n")
77 maybe_import_early(compat.argv)
81 cmdpath = path.cmddir()
83 # Remove once we finish the internal command transition
84 transition_cmdpath = path.libdir() + b'/bup/cmd'
86 # We manipulate the subcmds here as strings, but they must be ASCII
87 # compatible, since we're going to be looking for exactly
88 # b'bup-SUBCMD' to exec.
91 log('Usage: bup [-?|--help] [-d BUP_DIR] [--debug] [--profile] '
92 '<command> [options...]\n\n')
94 ftp = 'Browse backup sets using an ftp-like client',
95 fsck = 'Check backup sets for damage and add redundancy information',
96 fuse = 'Mount your backup sets as a filesystem',
97 help = 'Print detailed help for the given command',
98 index = 'Create or display the index of files to back up',
99 on = 'Backup a remote machine to the local one',
100 restore = 'Extract files from a backup set',
101 save = 'Save files into a backup set (note: run "bup index" first)',
102 tag = 'Tag commits for easier access',
103 web = 'Launch a web server to examine backup sets',
106 log('Common commands:\n')
107 for cmd,synopsis in sorted(common.items()):
108 log(' %-10s %s\n' % (cmd, synopsis))
111 log('Other available commands:\n')
113 for c in sorted(os.listdir(cmdpath)):
114 if c.startswith(b'bup-') and c.find(b'.') < 0:
115 cname = fsdecode(c[4:])
116 if cname not in common:
117 cmds.add(c[4:].decode(errors='backslashreplace'))
118 # built-in commands take precedence
119 for _, name, _ in iter_modules(path=bup.cmd.__path__):
120 name = name.replace('_','-')
121 if name not in common:
124 log(columnate(sorted(cmds), ' '))
127 log("See 'bup help COMMAND' for more information on " +
128 "a specific command.\n")
137 # Handle global options.
139 optspec = ['help', 'version', 'debug', 'profile', 'bup-dir=',
141 global_args, subcmd = getopt.getopt(argv[1:], '?VDd:', optspec)
142 except getopt.GetoptError as ex:
143 usage('error: %s' % ex.msg)
145 subcmd = [argv_bytes(x) for x in subcmd]
146 help_requested = None
150 for opt in global_args:
151 if opt[0] in ['-?', '--help']:
152 help_requested = True
153 elif opt[0] in ['-V', '--version']:
154 subcmd = [b'version']
155 elif opt[0] in ['-D', '--debug']:
157 environ[b'BUP_DEBUG'] = b'%d' % helpers.buglvl
158 elif opt[0] in ['--profile']:
160 elif opt[0] in ['-d', '--bup-dir']:
161 bup_dir = argv_bytes(opt[1])
162 elif opt[0] == '--import-py-module':
165 usage('error: unexpected option "%s"' % opt[0])
167 # Make BUP_DIR absolute, so we aren't affected by chdir (i.e. save -C, etc.).
169 environ[b'BUP_DIR'] = os.path.abspath(bup_dir)
177 if help_requested and subcmd[0] != b'help':
178 subcmd = [b'help'] + subcmd
180 if len(subcmd) > 1 and subcmd[1] == b'--help' and subcmd[0] != b'help':
181 subcmd = [b'help', subcmd[0]] + subcmd[2:]
183 subcmd_name = subcmd[0]
188 if subcmd_name not in (b'bloom',
199 raise ModuleNotFoundError()
200 cmd_module = import_module('bup.cmd.'
201 + subcmd_name.decode('ascii').replace('-', '_'))
202 except ModuleNotFoundError as ex:
206 subcmd[0] = os.path.join(cmdpath, b'bup-' + subcmd_name)
207 if not os.path.exists(subcmd[0]):
208 subcmd[0] = b'%s/%s.py' % (transition_cmdpath,
209 subcmd_name.replace(b'-', b'_'))
210 if not os.path.exists(subcmd[0]):
211 usage('error: unknown command "%s"' % path_msg(subcmd_name))
213 already_fixed = int(environ.get(b'BUP_FORCE_TTY', 0))
214 if subcmd_name in [b'mux', b'ftp', b'help']:
216 fix_stdout = not already_fixed and os.isatty(1)
217 fix_stderr = not already_fixed and os.isatty(2)
219 if fix_stdout or fix_stderr:
220 tty_env = merge_dict(environ,
221 {b'BUP_FORCE_TTY': (b'%d'
222 % ((fix_stdout and 1 or 0)
223 + (fix_stderr and 2 or 0))),
224 b'BUP_TTY_WIDTH': b'%d' % _tty_width(), })
229 sep_rx = re.compile(br'([\r\n])')
231 def print_clean_line(dest, content, width, sep=None):
232 """Write some or all of content, followed by sep, to the dest fd after
233 padding the content with enough spaces to fill the current
234 terminal width or truncating it to the terminal width if sep is a
237 assert sep in (b'\r', b'\n', None)
243 assert not sep_rx.match(x)
244 content = b''.join(content)
245 if sep == b'\r' and len(content) > width:
246 content = content[width:]
247 os.write(dest, content)
248 if len(content) < width:
249 os.write(dest, b' ' * (width - len(content)))
253 def filter_output(srcs, dests):
254 """Transfer data from file descriptors in srcs to the corresponding
255 file descriptors in dests print_clean_line until all of the srcs
260 assert all(type(x) in int_types for x in srcs)
261 assert all(type(x) in int_types for x in srcs)
262 assert len(srcs) == len(dests)
264 dest_for = dict(zip(srcs, dests))
269 ready_fds, _, _ = select.select(srcs, [], [])
272 buf = os.read(fd, 4096)
275 srcs = tuple([x for x in srcs if x is not fd])
276 print_clean_line(dest, pending.pop(fd, []), width)
278 split = sep_rx.split(buf)
279 while len(split) > 1:
280 content, sep = split[:2]
282 print_clean_line(dest,
283 pending.pop(fd, []) + [content],
286 assert len(split) == 1
288 pending.setdefault(fd, []).extend(split)
289 except BaseException as ex:
290 pending_ex = add_ex_ctx(add_ex_tb(ex), pending_ex)
292 # Try to finish each of the streams
293 for fd, pending_items in compat.items(pending):
297 print_clean_line(dest, pending_items, width)
298 except (EnvironmentError, EOFError) as ex:
299 pending_ex = add_ex_ctx(add_ex_tb(ex), pending_ex)
300 except BaseException as ex:
301 pending_ex = add_ex_ctx(add_ex_tb(ex), pending_ex)
306 def import_and_run_main(module, args):
309 f = compile('module.main(args)', __file__, 'exec')
310 cProfile.runctx(f, globals(), locals())
315 def run_module_cmd(module, args):
316 if not (fix_stdout or fix_stderr):
317 import_and_run_main(module, args)
319 # Interpose filter_output between all attempts to write to the
320 # stdout/stderr and the real stdout/stderr (e.g. the fds that
321 # connect directly to the terminal) via a thread that runs
322 # filter_output in a pipeline.
325 real_out_fd = real_err_fd = stdout_pipe = stderr_pipe = None
326 filter_thread = filter_thread_started = None
331 stdout_pipe = os.pipe() # monitored_by_filter, stdout_everyone_uses
332 real_out_fd = os.dup(sys.stdout.fileno())
333 os.dup2(stdout_pipe[1], sys.stdout.fileno())
334 srcs.append(stdout_pipe[0])
335 dests.append(real_out_fd)
338 stderr_pipe = os.pipe() # monitored_by_filter, stderr_everyone_uses
339 real_err_fd = os.dup(sys.stderr.fileno())
340 os.dup2(stderr_pipe[1], sys.stderr.fileno())
341 srcs.append(stderr_pipe[0])
342 dests.append(real_err_fd)
344 filter_thread = Thread(name='output filter',
345 target=lambda : filter_output(srcs, dests))
346 filter_thread.start()
347 filter_thread_started = True
348 import_and_run_main(module, args)
349 except Exception as ex:
354 # Try to make sure that whatever else happens, we restore
355 # stdout and stderr here, if that's possible, so that we don't
356 # risk just losing some output.
358 real_out_fd is not None and os.dup2(real_out_fd, sys.stdout.fileno())
359 except Exception as ex:
361 add_ex_ctx(ex, pending_ex)
363 real_err_fd is not None and os.dup2(real_err_fd, sys.stderr.fileno())
364 except Exception as ex:
366 add_ex_ctx(ex, pending_ex)
369 stdout_pipe is not None and os.close(stdout_pipe[1])
370 except Exception as ex:
372 add_ex_ctx(ex, pending_ex)
374 stderr_pipe is not None and os.close(stderr_pipe[1])
375 except Exception as ex:
377 add_ex_ctx(ex, pending_ex)
380 except Exception as ex:
382 add_ex_ctx(ex, pending_ex)
385 # There's no point in trying to join unless we finished the finally block.
386 if filter_thread_started:
390 def run_subproc_cmd(args):
392 c = (do_profile and [sys.executable, b'-m', b'cProfile'] or []) + args
393 if not (fix_stdout or fix_stderr):
398 out = byte_stream(sys.stdout)
399 err = byte_stream(sys.stderr)
402 p = subprocess.Popen(c,
403 stdout=PIPE if fix_stdout else out,
404 stderr=PIPE if fix_stderr else err,
405 env=tty_env, bufsize=4096, close_fds=True)
406 # Assume p will receive these signals and quit, which will
407 # then cause us to quit.
408 for sig in (signal.SIGINT, signal.SIGTERM, signal.SIGQUIT):
409 signal.signal(sig, signal.SIG_IGN)
414 srcs.append(p.stdout.fileno())
415 dests.append(out.fileno())
417 srcs.append(p.stderr.fileno())
418 dests.append(err.fileno())
419 filter_output(srcs, dests)
421 except BaseException as ex:
424 if p and p.poll() == None:
425 os.kill(p.pid, signal.SIGTERM)
427 except BaseException as kill_ex:
428 raise add_ex_ctx(add_ex_tb(kill_ex), ex)
432 def run_subcmd(module, args):
434 run_module_cmd(module, args)
436 run_subproc_cmd(args)
439 wrap_main(lambda : run_subcmd(cmd_module, subcmd))