main.py

   1 #!/usr/bin/env python
   2 import sys, os, subprocess, signal, getopt
   3
   4 argv = sys.argv
   5 exe = argv[0]
   6 exepath = os.path.split(exe)[0] or '.'
   7 exeprefix = os.path.split(os.path.abspath(exepath))[0]
   8
   9 # fix the PYTHONPATH to include our lib dir
  10 if os.path.exists("%s/lib/bup/cmd/." % exeprefix):
  11     # installed binary in /.../bin.
  12     # eg. /usr/bin/bup means /usr/lib/bup/... is where our libraries are.
  13     cmdpath = "%s/lib/bup/cmd" % exeprefix
  14     libpath = "%s/lib/bup" % exeprefix
  15     resourcepath = libpath
  16 else:
  17     # running from the src directory without being installed first
  18     cmdpath = os.path.join(exepath, 'cmd')
  19     libpath = os.path.join(exepath, 'lib')
  20     resourcepath = libpath
  21 sys.path[:0] = [libpath]
  22 os.environ['PYTHONPATH'] = libpath + ':' + os.environ.get('PYTHONPATH', '')
  23 os.environ['BUP_MAIN_EXE'] = os.path.abspath(exe)
  24 os.environ['BUP_RESOURCE_PATH'] = resourcepath
  25
  26 from bup import helpers
  27 from bup.helpers import *
  28
  29 # after running 'bup newliner', the tty_width() ioctl won't work anymore
  30 os.environ['WIDTH'] = str(tty_width())
  31
  32 def usage():
  33     log('Usage: bup [-?|--help] [-d BUP_DIR] [--debug] '
  34         '<command> [options...]\n\n')
  35     common = dict(
  36         ftp = 'Browse backup sets using an ftp-like client',
  37         fsck = 'Check backup sets for damage and add redundancy information',
  38         fuse = 'Mount your backup sets as a filesystem',
  39         help = 'Print detailed help for the given command',
  40         index = 'Create or display the index of files to back up',
  41         on = 'Backup a remote machine to the local one',
  42         restore = 'Extract files from a backup set',
  43         save = 'Save files into a backup set (note: run "bup index" first)',
  44         tag = 'Tag commits for easier access',
  45         web = 'Launch a web server to examine backup sets',
  46     )
  47
  48     log('Common commands:\n')
  49     for cmd,synopsis in sorted(common.items()):
  50         log('    %-10s %s\n' % (cmd, synopsis))
  51     log('\n')
  52
  53     log('Other available commands:\n')
  54     cmds = []
  55     for c in sorted(os.listdir(cmdpath) + os.listdir(exepath)):
  56         if c.startswith('bup-') and c.find('.') < 0:
  57             cname = c[4:]
  58             if cname not in common:
  59                 cmds.append(c[4:])
  60     log(columnate(cmds, '    '))
  61     log('\n')
  62
  63     log("See 'bup help COMMAND' for more information on " +
  64         "a specific command.\n")
  65     sys.exit(99)
  66
  67
  68 if len(argv) < 2:
  69     usage()
  70
  71 # Handle global options.
  72 try:
  73     global_args, subcmd = getopt.getopt(argv[1:], '?VDd:',
  74                                     ['help', 'version', 'debug', 'bup-dir='])
  75 except getopt.GetoptError, ex:
  76     log('error: ' + ex.msg + '\n')
  77     usage()
  78
  79 help_requested = None
  80 dest_dir = None
  81
  82 for opt in global_args:
  83     if opt[0] in ['-?', '--help']:
  84         help_requested = True
  85     elif opt[0] in ['-V', '--version']:
  86         subcmd = ['version']
  87     elif opt[0] in ['-D', '--debug']:
  88         helpers.buglvl += 1
  89         os.environ['BUP_DEBUG'] = str(helpers.buglvl)
  90     elif opt[0] in ['-d', '--bup-dir']:
  91         dest_dir = opt[1]
  92     else:
  93         log('error: unexpected option "%s"\n' % opt[0])
  94         usage()
  95
  96 if len(subcmd) == 0:
  97     if help_requested:
  98         subcmd = ['help']
  99     else:
 100         usage()
 101
 102 if help_requested and subcmd[0] != 'help':
 103     subcmd = ['help'] + subcmd
 104
 105 if len(subcmd) > 1 and subcmd[1] == '--help' and subcmd[0] != 'help':
 106     subcmd = ['help', subcmd[0]] + subcmd[2:]
 107
 108 subcmd_name = subcmd[0]
 109 if not subcmd_name:
 110     usage()
 111
 112 subcmd_env = os.environ
 113 if dest_dir:
 114     subcmd_env.update({"BUP_DIR" : dest_dir})
 115
 116 def subpath(s):
 117     sp = os.path.join(exepath, 'bup-%s' % s)
 118     if not os.path.exists(sp):
 119         sp = os.path.join(cmdpath, 'bup-%s' % s)
 120     return sp
 121
 122 if not os.path.exists(subpath(subcmd_name)):
 123     log('error: unknown command "%s"\n' % subcmd_name)
 124     usage()
 125
 126 already_fixed = atoi(os.environ.get('BUP_FORCE_TTY'))
 127 if subcmd_name in ['ftp', 'help']:
 128     already_fixed = True
 129 fix_stdout = not already_fixed and os.isatty(1)
 130 fix_stderr = not already_fixed and os.isatty(2)
 131
 132 def force_tty():
 133     if fix_stdout or fix_stderr:
 134         amt = (fix_stdout and 1 or 0) + (fix_stderr and 2 or 0)
 135         os.environ['BUP_FORCE_TTY'] = str(amt)
 136     os.setsid()  # make sure ctrl-c is sent just to us, not to child too
 137
 138 if fix_stdout or fix_stderr:
 139     realf = fix_stderr and 2 or 1
 140     drealf = os.dup(realf)  # Popen goes crazy with stdout=2
 141     n = subprocess.Popen([subpath('newliner')],
 142                          stdin=subprocess.PIPE, stdout=drealf,
 143                          close_fds=True, preexec_fn=force_tty)
 144     os.close(drealf)
 145     outf = fix_stdout and n.stdin.fileno() or None
 146     errf = fix_stderr and n.stdin.fileno() or None
 147 else:
 148     n = None
 149     outf = None
 150     errf = None
 151
 152
 153 class SigException(Exception):
 154     def __init__(self, signum):
 155         self.signum = signum
 156         Exception.__init__(self, 'signal %d received' % signum)
 157 def handler(signum, frame):
 158     raise SigException(signum)
 159
 160 signal.signal(signal.SIGTERM, handler)
 161 signal.signal(signal.SIGINT, handler)
 162
 163 ret = 95
 164 p = None
 165 try:
 166     try:
 167         p = subprocess.Popen([subpath(subcmd_name)] + subcmd[1:],
 168                              stdout=outf, stderr=errf, preexec_fn=force_tty)
 169         while 1:
 170             # if we get a signal while waiting, we have to keep waiting, just
 171             # in case our child doesn't die.
 172             try:
 173                 ret = p.wait()
 174                 break
 175             except SigException, e:
 176                 log('\nbup: %s\n' % e)
 177                 os.kill(p.pid, e.signum)
 178                 ret = 94
 179     except OSError, e:
 180         log('%s: %s\n' % (subpath(subcmd_name), e))
 181         ret = 98
 182 finally:
 183     if p and p.poll() == None:
 184         os.kill(p.pid, signal.SIGTERM)
 185         p.wait()
 186     if n:
 187         n.stdin.close()
 188         try:
 189             n.wait()
 190         except:
 191             pass
 192 sys.exit(ret)