cmd/meta-cmd.py

   1 #!/usr/bin/env python
   2
   3 # Copyright (C) 2010 Rob Browning
   4 #
   5 # This code is covered under the terms of the GNU Library General
   6 # Public License as described in the bup LICENSE file.
   7
   8 # TODO: Add tar-like -C option.
   9
  10 import sys
  11 from bup import metadata
  12 from bup import options
  13 from bup.helpers import handle_ctrl_c, log, saved_errors
  14
  15
  16 def open_input(name):
  17     if not name or name == '-':
  18         return sys.stdin
  19     return open(name, 'r')
  20
  21
  22 def open_output(name):
  23     if not name or name == '-':
  24         return sys.stdout
  25     return open(name, 'w')
  26
  27
  28 optspec = """
  29 bup meta --create [OPTION ...] <PATH ...>
  30 bup meta --extract [OPTION ...]
  31 bup meta --start-extract [OPTION ...]
  32 bup meta --finish-extract [OPTION ...]
  33 bup meta --edit [OPTION ...] <PATH ...>
  34 --
  35 c,create       write metadata for PATHs to stdout (or --file)
  36 t,list         display metadata
  37 x,extract      perform --start-extract followed by --finish-extract
  38 start-extract  build tree matching metadata provided on standard input (or --file)
  39 finish-extract finish applying standard input (or --file) metadata to filesystem
  40 edit           alter metadata; write to stdout (or --file)
  41 f,file=        specify source or destination file
  42 R,recurse      recurse into subdirectories
  43 xdev,one-file-system  don't cross filesystem boundaries
  44 numeric-ids    apply numeric IDs (user, group, etc.) rather than names
  45 symlinks       handle symbolic links (default is true)
  46 paths          include paths in metadata (default is true)
  47 set-uid=       set metadata uid (via --edit)
  48 set-gid=       set metadata gid (via --edit)
  49 set-user=      set metadata user (via --edit)
  50 unset-user     remove metadata user (via --edit)
  51 set-group=     set metadata group (via --edit)
  52 unset-group    remove metadata group (via --edit)
  53 v,verbose      increase log output (can be used more than once)
  54 q,quiet        don't show progress meter
  55 """
  56
  57 handle_ctrl_c()
  58
  59 o = options.Options(optspec)
  60 (opt, flags, remainder) = o.parse(['--paths', '--symlinks'] + sys.argv[1:])
  61
  62 opt.verbose = opt.verbose or 0
  63 opt.quiet = opt.quiet or 0
  64 metadata.verbose = opt.verbose - opt.quiet
  65
  66 action_count = sum([bool(x) for x in [opt.create, opt.list, opt.extract,
  67                                       opt.start_extract, opt.finish_extract,
  68                                       opt.edit]])
  69 if action_count > 1:
  70     o.fatal("bup: only one action permitted: --create --list --extract --edit")
  71 if action_count == 0:
  72     o.fatal("bup: no action specified")
  73
  74 if opt.create:
  75     if len(remainder) < 1:
  76         o.fatal("no paths specified for create")
  77     output_file = open_output(opt.file)
  78     metadata.save_tree(output_file,
  79                        remainder,
  80                        recurse=opt.recurse,
  81                        write_paths=opt.paths,
  82                        save_symlinks=opt.symlinks,
  83                        xdev=opt.xdev)
  84 elif opt.list:
  85     if len(remainder) > 0:
  86         o.fatal("cannot specify paths for --list")
  87     src = open_input(opt.file)
  88     metadata.display_archive(src)
  89 elif opt.start_extract:
  90     if len(remainder) > 0:
  91         o.fatal("cannot specify paths for --start-extract")
  92     src = open_input(opt.file)
  93     metadata.start_extract(src, create_symlinks=opt.symlinks)
  94 elif opt.finish_extract:
  95     if len(remainder) > 0:
  96         o.fatal("cannot specify paths for --finish-extract")
  97     src = open_input(opt.file)
  98     metadata.finish_extract(src, restore_numeric_ids=opt.numeric_ids)
  99 elif opt.extract:
 100     if len(remainder) > 0:
 101         o.fatal("cannot specify paths for --extract")
 102     src = open_input(opt.file)
 103     metadata.extract(src,
 104                      restore_numeric_ids=opt.numeric_ids,
 105                      create_symlinks=opt.symlinks)
 106 elif opt.edit:
 107     if len(remainder) < 1:
 108         o.fatal("no paths specified for edit")
 109     output_file = open_output(opt.file)
 110
 111     unset_user = False # True if --unset-user was the last relevant option.
 112     unset_group = False # True if --unset-group was the last relevant option.
 113     for flag in flags:
 114         if flag[0] == '--set-user':
 115             unset_user = False
 116         elif flag[0] == '--unset-user':
 117             unset_user = True
 118         elif flag[0] == '--set-group':
 119             unset_group = False
 120         elif flag[0] == '--unset-group':
 121             unset_group = True
 122
 123     for path in remainder:
 124         f = open(path, 'r')
 125         try:
 126             for m in metadata._ArchiveIterator(f):
 127                 if opt.set_uid is not None:
 128                     try:
 129                         m.uid = int(opt.set_uid)
 130                     except ValueError:
 131                         o.fatal("uid must be an integer")
 132
 133                 if opt.set_gid is not None:
 134                     try:
 135                         m.gid = int(opt.set_gid)
 136                     except ValueError:
 137                         o.fatal("gid must be an integer")
 138
 139                 if unset_user:
 140                     m.user = ''
 141                 elif opt.set_user is not None:
 142                     m.user = opt.set_user
 143
 144                 if unset_group:
 145                     m.group = ''
 146                 elif opt.set_group is not None:
 147                     m.group = opt.set_group
 148
 149                 m.write(output_file)
 150         finally:
 151             f.close()
 152
 153
 154 if saved_errors:
 155     log('WARNING: %d errors encountered.\n' % len(saved_errors))
 156     sys.exit(1)
 157 else:
 158     sys.exit(0)