#!/usr/bin/env python
-
import sys, os, subprocess, signal, getopt
argv = sys.argv
-exe = argv[0]
+exe = os.path.realpath(argv[0])
exepath = os.path.split(exe)[0] or '.'
+exeprefix = os.path.split(os.path.abspath(exepath))[0]
# fix the PYTHONPATH to include our lib dir
-libpath = os.path.join(exepath, 'lib')
-cmdpath = os.path.join(exepath, 'cmd')
+if os.path.exists("%s/lib/bup/cmd/." % exeprefix):
+ # installed binary in /.../bin.
+ # eg. /usr/bin/bup means /usr/lib/bup/... is where our libraries are.
+ cmdpath = "%s/lib/bup/cmd" % exeprefix
+ libpath = "%s/lib/bup" % exeprefix
+ resourcepath = libpath
+else:
+ # running from the src directory without being installed first
+ cmdpath = os.path.join(exepath, 'cmd')
+ libpath = os.path.join(exepath, 'lib')
+ resourcepath = libpath
sys.path[:0] = [libpath]
os.environ['PYTHONPATH'] = libpath + ':' + os.environ.get('PYTHONPATH', '')
os.environ['BUP_MAIN_EXE'] = os.path.abspath(exe)
+os.environ['BUP_RESOURCE_PATH'] = resourcepath
+from bup import helpers
from bup.helpers import *
+# after running 'bup newliner', the tty_width() ioctl won't work anymore
+os.environ['WIDTH'] = str(tty_width())
-def columnate(l, prefix):
- l = l[:]
- clen = max(len(s) for s in l)
- ncols = (78 - len(prefix)) / (clen + 2)
- if ncols <= 1:
- ncols = 1
- clen = 0
- cols = []
- while len(l) % ncols:
- l.append('')
- rows = len(l)/ncols
- for s in range(0, len(l), rows):
- cols.append(l[s:s+rows])
- out = ''
- for row in zip(*cols):
- out += prefix + ''.join(('%-*s' % (clen+2, s)) for s in row) + '\n'
- return out
-
-
-def usage():
- log('Usage: bup [-?|--help] [-d=BUP_DIR|--bup-dir=BUP_DIR] COMMAND [ARGS]'
- + '\n\n')
+def usage(msg=""):
+ log('Usage: bup [-?|--help] [-d BUP_DIR] [--debug] [--profile] '
+ '<command> [options...]')
+ log('')
common = dict(
ftp = 'Browse backup sets using an ftp-like client',
fsck = 'Check backup sets for damage and add redundancy information',
fuse = 'Mount your backup sets as a filesystem',
help = 'Print detailed help for the given command',
index = 'Create or display the index of files to back up',
- join = 'Retrieve a file backed up using "bup split"',
- ls = 'Browse the files in your backup sets',
- midx = 'Index objects to speed up future backups',
+ on = 'Backup a remote machine to the local one',
+ restore = 'Extract files from a backup set',
save = 'Save files into a backup set (note: run "bup index" first)',
- split = 'Split a single file into its own backup set',
+ tag = 'Tag commits for easier access',
+ web = 'Launch a web server to examine backup sets',
)
- log('Common commands:\n')
+ log('Common commands:')
for cmd,synopsis in sorted(common.items()):
- log(' %-10s %s\n' % (cmd, synopsis))
- log('\n')
-
- log('Other available commands:\n')
+ log(' %-10s %s' % (cmd, synopsis))
+ log('')
+
+ log('Other available commands:')
cmds = []
for c in sorted(os.listdir(cmdpath) + os.listdir(exepath)):
if c.startswith('bup-') and c.find('.') < 0:
if cname not in common:
cmds.append(c[4:])
log(columnate(cmds, ' '))
- log('\n')
-
+
log("See 'bup help COMMAND' for more information on " +
- "a specific command.\n")
+ "a specific command.")
+ if msg:
+ log('')
+ log("%s" % msg)
sys.exit(99)
# Handle global options.
try:
- global_args, subcmd = getopt.getopt(argv[1:], '?d:', ['help', 'bup-dir='])
+ optspec = ['help', 'version', 'debug', 'profile', 'bup-dir=']
+ global_args, subcmd = getopt.getopt(argv[1:], '?VDd:', optspec)
except getopt.GetoptError, ex:
- log('error: ' + ex.msg + '\n')
- usage()
+ usage('Error: %s!' % ex.msg)
help_requested = None
-dest_dir = None
+do_profile = False
for opt in global_args:
- if opt[0] == '-?' or opt[0] == '--help':
+ if opt[0] in ['-?', '--help']:
help_requested = True
- elif opt[0] == '-d' or opt[0] == '--bup-dir':
- dest_dir = opt[1]
+ elif opt[0] in ['-V', '--version']:
+ subcmd = ['version']
+ elif opt[0] in ['-D', '--debug']:
+ helpers.buglvl += 1
+ os.environ['BUP_DEBUG'] = str(helpers.buglvl)
+ elif opt[0] in ['--profile']:
+ do_profile = True
+ elif opt[0] in ['-d', '--bup-dir']:
+ os.environ['BUP_DIR'] = opt[1]
else:
- log('error: unexpected option "%s"\n' % opt[0])
- usage()
+ usage('Error: Unexpected option "%s"!' % opt[0])
+
+# Make BUP_DIR absolute, so we aren't affected by chdir (i.e. save -C, etc.).
+if 'BUP_DIR' in os.environ:
+ os.environ['BUP_DIR'] = os.path.abspath(os.environ['BUP_DIR'])
if len(subcmd) == 0:
if help_requested:
if not subcmd_name:
usage()
-subcmd_env = os.environ
-if dest_dir:
- subcmd_env.update({"BUP_DIR" : dest_dir})
-
def subpath(s):
sp = os.path.join(exepath, 'bup-%s' % s)
if not os.path.exists(sp):
sp = os.path.join(cmdpath, 'bup-%s' % s)
return sp
-if not os.path.exists(subpath(subcmd_name)):
- log('error: unknown command "%s"\n' % subcmd_name)
- usage()
+subcmd[0] = subpath(subcmd_name)
+if not os.path.exists(subcmd[0]):
+ usage('Error: Unknown command "%s"!' % subcmd_name)
already_fixed = atoi(os.environ.get('BUP_FORCE_TTY'))
-if subcmd_name in ['ftp', 'help']:
+if subcmd_name in ['mux', 'ftp', 'help']:
already_fixed = True
fix_stdout = not already_fixed and os.isatty(1)
fix_stderr = not already_fixed and os.isatty(2)
outf = None
errf = None
+ret = 95
+p = None
+forward_signals = True
-class SigException(Exception):
- def __init__(self, signum):
- self.signum = signum
- Exception.__init__(self, 'signal %d received' % signum)
def handler(signum, frame):
- raise SigException(signum)
+ debug1('bup: Signal %d received!' % signum)
+ if not p or not forward_signals:
+ return
+ if signum != signal.SIGTSTP:
+ os.kill(p.pid, signum)
+ else: # SIGTSTP: stop the child, then ourselves.
+ os.kill(p.pid, signal.SIGSTOP)
+ signal.signal(signal.SIGTSTP, signal.SIG_DFL)
+ os.kill(os.getpid(), signal.SIGTSTP)
+ # Back from suspend -- reestablish the handler.
+ signal.signal(signal.SIGTSTP, handler)
+ ret = 94
signal.signal(signal.SIGTERM, handler)
signal.signal(signal.SIGINT, handler)
+signal.signal(signal.SIGTSTP, handler)
+signal.signal(signal.SIGCONT, handler)
-ret = 95
-p = None
try:
try:
- p = subprocess.Popen([subpath(subcmd_name)] + subcmd[1:],
- stdout=outf, stderr=errf, preexec_fn=force_tty)
+ c = (do_profile and [sys.executable, '-m', 'cProfile'] or []) + subcmd
+ if not n and not outf and not errf:
+ # shortcut when no bup-newliner stuff is needed
+ os.execvp(c[0], c)
+ else:
+ p = subprocess.Popen(c, stdout=outf, stderr=errf,
+ preexec_fn=force_tty)
while 1:
# if we get a signal while waiting, we have to keep waiting, just
# in case our child doesn't die.
- try:
- ret = p.wait()
- break
- except SigException, e:
- log('\nbup: %s\n' % e)
- os.kill(p.pid, e.signum)
- ret = 94
+ ret = p.wait()
+ forward_signals = False
+ break
except OSError, e:
- log('%s: %s\n' % (subpath(subcmd_name), e))
+ log('%s: %s' % (subcmd[0], e))
ret = 98
finally:
if p and p.poll() == None: