src/allmydata/scripts/cli.py

   1 import os.path, re, sys, fnmatch
   2 from twisted.python import usage
   3 from allmydata.scripts.common import BaseOptions, get_aliases, get_default_nodedir, DEFAULT_ALIAS
   4 from allmydata.util.encodingutil import argv_to_unicode, argv_to_abspath, quote_output
   5
   6 NODEURL_RE=re.compile("http(s?)://([^:]*)(:([1-9][0-9]*))?")
   7
   8 _default_nodedir = get_default_nodedir()
   9
  10 class VDriveOptions(BaseOptions):
  11     optParameters = [
  12         ["node-directory", "d", None,
  13          "Specify which Tahoe node directory should be used. The directory "
  14          "should either contain a full Tahoe node, or a file named node.url "
  15          "that points to some other Tahoe node. It should also contain a file "
  16          "named '" + os.path.join('private', 'aliases') + "' which contains the "
  17          "mapping from alias name to root dirnode URI." + (
  18             _default_nodedir and (" [default: " + quote_output(_default_nodedir) + "]") or "")],
  19         ["node-url", "u", None,
  20          "Specify the URL of the Tahoe gateway node, such as 'http://127.0.0.1:3456'. "
  21          "This overrides the URL found in the --node-directory ."],
  22         ["dir-cap", None, None,
  23          "Specify which dirnode URI should be used as the 'tahoe' alias."]
  24         ]
  25
  26     def postOptions(self):
  27         if self['node-directory']:
  28             self['node-directory'] = argv_to_abspath(self['node-directory'])
  29         else:
  30             self['node-directory'] = _default_nodedir
  31
  32         # compute a node-url from the existing options, put in self['node-url']
  33         if self['node-url']:
  34             if (not isinstance(self['node-url'], basestring)
  35                 or not NODEURL_RE.match(self['node-url'])):
  36                 msg = ("--node-url is required to be a string and look like "
  37                        "\"http://HOSTNAMEORADDR:PORT\", not: %r" %
  38                        (self['node-url'],))
  39                 raise usage.UsageError(msg)
  40         else:
  41             node_url_file = os.path.join(self['node-directory'], "node.url")
  42             self['node-url'] = open(node_url_file, "r").read().strip()
  43         if self['node-url'][-1] != "/":
  44             self['node-url'] += "/"
  45
  46         aliases = get_aliases(self['node-directory'])
  47         if self['dir-cap']:
  48             aliases[DEFAULT_ALIAS] = self['dir-cap']
  49         self.aliases = aliases # maps alias name to dircap
  50
  51
  52 class MakeDirectoryOptions(VDriveOptions):
  53     def parseArgs(self, where=""):
  54         self.where = argv_to_unicode(where)
  55     longdesc = """Create a new directory, either unlinked or as a subdirectory."""
  56
  57 class AddAliasOptions(VDriveOptions):
  58     def parseArgs(self, alias, cap):
  59         self.alias = argv_to_unicode(alias)
  60         self.cap = cap
  61
  62     def getSynopsis(self):
  63         return "%s add-alias ALIAS DIRCAP" % (os.path.basename(sys.argv[0]),)
  64
  65     longdesc = """Add a new alias for an existing directory."""
  66
  67 class CreateAliasOptions(VDriveOptions):
  68     def parseArgs(self, alias):
  69         self.alias = argv_to_unicode(alias)
  70
  71     def getSynopsis(self):
  72         return "%s create-alias ALIAS" % (os.path.basename(sys.argv[0]),)
  73
  74     longdesc = """Create a new directory and add an alias for it."""
  75
  76 class ListAliasOptions(VDriveOptions):
  77     longdesc = """Display a table of all configured aliases."""
  78
  79 class ListOptions(VDriveOptions):
  80     optFlags = [
  81         ("long", "l", "Use long format: show file sizes, and timestamps."),
  82         ("uri", "u", "Show file/directory URIs."),
  83         ("readonly-uri", None, "Show read-only file/directory URIs."),
  84         ("classify", "F", "Append '/' to directory names, and '*' to mutable."),
  85         ("json", None, "Show the raw JSON output."),
  86         ]
  87     def parseArgs(self, where=""):
  88         self.where = argv_to_unicode(where)
  89
  90     longdesc = """
  91     List the contents of some portion of the grid.
  92
  93     When the -l or --long option is used, each line is shown in the
  94     following format:
  95
  96     drwx <size> <date/time> <name in this directory>
  97
  98     where each of the letters on the left may be replaced by '-'.
  99     If 'd' is present, it indicates that the object is a directory.
 100     If the 'd' is replaced by a '?', the object type is unknown.
 101     'rwx' is a Unix-like permissions mask: if the mask includes 'w',
 102     then the object is writeable through its link in this directory
 103     (note that the link might be replaceable even if the object is
 104     not writeable through the current link).
 105     The 'x' is a legacy of Unix filesystems. In Tahoe it is used
 106     only to indicate that the contents of a directory can be listed.
 107
 108     Directories have no size, so their size field is shown as '-'.
 109     Otherwise the size of the file, when known, is given in bytes.
 110     The size of mutable files or unknown objects is shown as '?'.
 111
 112     The date/time shows when this link in the Tahoe filesystem was
 113     last modified.
 114     """
 115
 116 class GetOptions(VDriveOptions):
 117     def parseArgs(self, arg1, arg2=None):
 118         # tahoe get FOO |less            # write to stdout
 119         # tahoe get tahoe:FOO |less      # same
 120         # tahoe get FOO bar              # write to local file
 121         # tahoe get tahoe:FOO bar        # same
 122
 123         self.from_file = argv_to_unicode(arg1)
 124
 125         if arg2:
 126             self.to_file = argv_to_unicode(arg2)
 127         else:
 128             self.to_file = None
 129
 130         if self.to_file == "-":
 131             self.to_file = None
 132
 133     def getSynopsis(self):
 134         return "%s get REMOTE_FILE LOCAL_FILE" % (os.path.basename(sys.argv[0]),)
 135
 136     longdesc = """
 137     Retrieve a file from the grid and write it to the local filesystem. If
 138     LOCAL_FILE is omitted or '-', the contents of the file will be written to
 139     stdout."""
 140
 141     def getUsage(self, width=None):
 142         t = VDriveOptions.getUsage(self, width)
 143         t += """
 144 Examples:
 145  % tahoe get FOO |less            # write to stdout
 146  % tahoe get tahoe:FOO |less      # same
 147  % tahoe get FOO bar              # write to local file
 148  % tahoe get tahoe:FOO bar        # same
 149 """
 150         return t
 151
 152 class PutOptions(VDriveOptions):
 153     optFlags = [
 154         ("mutable", "m", "Create a mutable file instead of an immutable one."),
 155         ]
 156
 157     def parseArgs(self, arg1=None, arg2=None):
 158         # see Examples below
 159
 160         if arg1 is not None and arg2 is not None:
 161             self.from_file = argv_to_unicode(arg1)
 162             self.to_file =  argv_to_unicode(arg2)
 163         elif arg1 is not None and arg2 is None:
 164             self.from_file = argv_to_unicode(arg1) # might be "-"
 165             self.to_file = None
 166         else:
 167             self.from_file = None
 168             self.to_file = None
 169         if self.from_file == u"-":
 170             self.from_file = None
 171
 172     def getSynopsis(self):
 173         return "%s put LOCAL_FILE REMOTE_FILE" % (os.path.basename(sys.argv[0]),)
 174
 175     longdesc = """
 176     Put a file into the grid, copying its contents from the local filesystem.
 177     If REMOTE_FILE is missing, upload the file but do not link it into a
 178     directory; also print the new filecap to stdout. If LOCAL_FILE is missing
 179     or '-', data will be copied from stdin. REMOTE_FILE is assumed to start
 180     with tahoe: unless otherwise specified."""
 181
 182     def getUsage(self, width=None):
 183         t = VDriveOptions.getUsage(self, width)
 184         t += """
 185 Examples:
 186  % cat FILE | tahoe put                # create unlinked file from stdin
 187  % cat FILE | tahoe put -              # same
 188  % tahoe put bar                       # create unlinked file from local 'bar'
 189  % cat FILE | tahoe put - FOO          # create tahoe:FOO from stdin
 190  % tahoe put bar FOO                   # copy local 'bar' to tahoe:FOO
 191  % tahoe put bar tahoe:FOO             # same
 192  % tahoe put bar MUTABLE-FILE-WRITECAP # modify the mutable file in-place
 193 """
 194         return t
 195
 196 class CpOptions(VDriveOptions):
 197     optFlags = [
 198         ("recursive", "r", "Copy source directory recursively."),
 199         ("verbose", "v", "Be noisy about what is happening."),
 200         ("caps-only", None,
 201          "When copying to local files, write out filecaps instead of actual "
 202          "data (only useful for debugging and tree-comparison purposes)."),
 203         ]
 204     def parseArgs(self, *args):
 205         if len(args) < 2:
 206             raise usage.UsageError("cp requires at least two arguments")
 207         self.sources = map(argv_to_unicode, args[:-1])
 208         self.destination = argv_to_unicode(args[-1])
 209     def getSynopsis(self):
 210         return "Usage: tahoe [options] cp FROM.. TO"
 211     longdesc = """
 212     Use 'tahoe cp' to copy files between a local filesystem and a Tahoe grid.
 213     Any FROM/TO arguments that begin with an alias indicate Tahoe-side
 214     files or non-file arguments. Directories will be copied recursively.
 215     New Tahoe-side directories will be created when necessary. Assuming that
 216     you have previously set up an alias 'home' with 'tahoe create-alias home',
 217     here are some examples:
 218
 219     tahoe cp ~/foo.txt home:  # creates tahoe-side home:foo.txt
 220
 221     tahoe cp ~/foo.txt /tmp/bar.txt home:  # copies two files to home:
 222
 223     tahoe cp ~/Pictures home:stuff/my-pictures  # copies directory recursively
 224
 225     You can also use a dircap as either FROM or TO target:
 226
 227     tahoe cp URI:DIR2-RO:ixqhc4kdbjxc7o65xjnveoewym:5x6lwoxghrd5rxhwunzavft2qygfkt27oj3fbxlq4c6p45z5uneq/blog.html ./   # copy Zooko's wiki page to a local file
 228
 229     This command still has some limitations: symlinks and special files
 230     (device nodes, named pipes) are not handled very well. Arguments should
 231     probably not have trailing slashes. 'tahoe cp' does not behave as much
 232     like /bin/cp as you would wish, especially with respect to trailing
 233     slashes.
 234     """
 235
 236 class RmOptions(VDriveOptions):
 237     def parseArgs(self, where):
 238         self.where = argv_to_unicode(where)
 239
 240     def getSynopsis(self):
 241         return "%s rm REMOTE_FILE" % (os.path.basename(sys.argv[0]),)
 242
 243 class UnlinkOptions(RmOptions):
 244     def getSynopsis(self):
 245         return "%s unlink REMOTE_FILE" % (os.path.basename(sys.argv[0]),)
 246
 247 class MvOptions(VDriveOptions):
 248     def parseArgs(self, frompath, topath):
 249         self.from_file = argv_to_unicode(frompath)
 250         self.to_file = argv_to_unicode(topath)
 251
 252     def getSynopsis(self):
 253         return "%s mv FROM TO" % (os.path.basename(sys.argv[0]),)
 254     longdesc = """
 255     Use 'tahoe mv' to move files that are already on the grid elsewhere on
 256     the grid, e.g., 'tahoe mv alias:some_file alias:new_file'.
 257
 258     If moving a remote file into a remote directory, you'll need to append a
 259     '/' to the name of the remote directory, e.g., 'tahoe mv tahoe:file1
 260     tahoe:dir/', not 'tahoe mv tahoe:file1 tahoe:dir'.
 261
 262     Note that it is not possible to use this command to move local files to
 263     the grid -- use 'tahoe cp' for that.
 264     """
 265
 266 class LnOptions(VDriveOptions):
 267     def parseArgs(self, frompath, topath):
 268         self.from_file = argv_to_unicode(frompath)
 269         self.to_file = argv_to_unicode(topath)
 270
 271     def getSynopsis(self):
 272         return "%s ln FROM TO" % (os.path.basename(sys.argv[0]),)
 273
 274 class BackupConfigurationError(Exception):
 275     pass
 276
 277 class BackupOptions(VDriveOptions):
 278     optFlags = [
 279         ("verbose", "v", "Be noisy about what is happening."),
 280         ("ignore-timestamps", None, "Do not use backupdb timestamps to decide whether a local file is unchanged."),
 281         ]
 282
 283     vcs_patterns = ('CVS', 'RCS', 'SCCS', '.git', '.gitignore', '.cvsignore',
 284                     '.svn', '.arch-ids','{arch}', '=RELEASE-ID',
 285                     '=meta-update', '=update', '.bzr', '.bzrignore',
 286                     '.bzrtags', '.hg', '.hgignore', '_darcs')
 287
 288     def __init__(self):
 289         super(BackupOptions, self).__init__()
 290         self['exclude'] = set()
 291
 292     def parseArgs(self, localdir, topath):
 293         self.from_dir = argv_to_unicode(localdir)
 294         self.to_dir = argv_to_unicode(topath)
 295
 296     def getSynopsis(Self):
 297         return "%s backup FROM ALIAS:TO" % os.path.basename(sys.argv[0])
 298
 299     def opt_exclude(self, pattern):
 300         """Ignore files matching a glob pattern. You may give multiple
 301         '--exclude' options."""
 302         g = argv_to_unicode(pattern).strip()
 303         if g:
 304             exclude = self['exclude']
 305             exclude.add(g)
 306
 307     def opt_exclude_from(self, filepath):
 308         """Ignore file matching glob patterns listed in file, one per
 309         line. The file is assumed to be in the argv encoding."""
 310         abs_filepath = argv_to_abspath(filepath)
 311         try:
 312             exclude_file = file(abs_filepath)
 313         except:
 314             raise BackupConfigurationError('Error opening exclude file %s.' % quote_output(abs_filepath))
 315         try:
 316             for line in exclude_file:
 317                 self.opt_exclude(line)
 318         finally:
 319             exclude_file.close()
 320
 321     def opt_exclude_vcs(self):
 322         """Exclude files and directories used by following version control
 323         systems: CVS, RCS, SCCS, Git, SVN, Arch, Bazaar(bzr), Mercurial,
 324         Darcs."""
 325         for pattern in self.vcs_patterns:
 326             self.opt_exclude(pattern)
 327
 328     def filter_listdir(self, listdir):
 329         """Yields non-excluded childpaths in path."""
 330         exclude = self['exclude']
 331         exclude_regexps = [re.compile(fnmatch.translate(pat)) for pat in exclude]
 332         for filename in listdir:
 333             for regexp in exclude_regexps:
 334                 if regexp.match(filename):
 335                     break
 336             else:
 337                 yield filename
 338
 339     longdesc = """
 340     Add a versioned backup of the local FROM directory to a timestamped
 341     subdirectory of the TO/Archives directory on the grid, sharing as many
 342     files and directories as possible with earlier backups. Create TO/Latest
 343     as a reference to the latest backup. Behaves somewhat like 'rsync -a
 344     --link-dest=TO/Archives/(previous) FROM TO/Archives/(new); ln -sf
 345     TO/Archives/(new) TO/Latest'."""
 346
 347 class WebopenOptions(VDriveOptions):
 348     optFlags = [
 349         ("info", "i", "Open the t=info page for the file"),
 350         ]
 351     def parseArgs(self, where=''):
 352         self.where = argv_to_unicode(where)
 353
 354     def getSynopsis(self):
 355         return "%s webopen [ALIAS:PATH]" % (os.path.basename(sys.argv[0]),)
 356
 357     longdesc = """Open a web browser to the contents of some file or
 358     directory on the grid. When run without arguments, open the Welcome
 359     page."""
 360
 361 class ManifestOptions(VDriveOptions):
 362     optFlags = [
 363         ("storage-index", "s", "Only print storage index strings, not pathname+cap."),
 364         ("verify-cap", None, "Only print verifycap, not pathname+cap."),
 365         ("repair-cap", None, "Only print repaircap, not pathname+cap."),
 366         ("raw", "r", "Display raw JSON data instead of parsed."),
 367         ]
 368     def parseArgs(self, where=''):
 369         self.where = argv_to_unicode(where)
 370
 371     def getSynopsis(self):
 372         return "%s manifest [ALIAS:PATH]" % (os.path.basename(sys.argv[0]),)
 373
 374     longdesc = """Print a list of all files and directories reachable from
 375     the given starting point."""
 376
 377 class StatsOptions(VDriveOptions):
 378     optFlags = [
 379         ("raw", "r", "Display raw JSON data instead of parsed"),
 380         ]
 381     def parseArgs(self, where=''):
 382         self.where = argv_to_unicode(where)
 383
 384     def getSynopsis(self):
 385         return "%s stats [ALIAS:PATH]" % (os.path.basename(sys.argv[0]),)
 386
 387     longdesc = """Print statistics about of all files and directories
 388     reachable from the given starting point."""
 389
 390 class CheckOptions(VDriveOptions):
 391     optFlags = [
 392         ("raw", None, "Display raw JSON data instead of parsed."),
 393         ("verify", None, "Verify all hashes, instead of merely querying share presence."),
 394         ("repair", None, "Automatically repair any problems found."),
 395         ("add-lease", None, "Add/renew lease on all shares."),
 396         ]
 397     def parseArgs(self, where=''):
 398         self.where = argv_to_unicode(where)
 399
 400     def getSynopsis(self):
 401         return "%s check [ALIAS:PATH]" % (os.path.basename(sys.argv[0]),)
 402
 403     longdesc = """
 404     Check a single file or directory: count how many shares are available and
 405     verify their hashes. Optionally repair the file if any problems were
 406     found."""
 407
 408 class DeepCheckOptions(VDriveOptions):
 409     optFlags = [
 410         ("raw", None, "Display raw JSON data instead of parsed."),
 411         ("verify", None, "Verify all hashes, instead of merely querying share presence."),
 412         ("repair", None, "Automatically repair any problems found."),
 413         ("add-lease", None, "Add/renew lease on all shares."),
 414         ("verbose", "v", "Be noisy about what is happening."),
 415         ]
 416     def parseArgs(self, where=''):
 417         self.where = argv_to_unicode(where)
 418
 419     def getSynopsis(self):
 420         return "%s deep-check [ALIAS:PATH]" % (os.path.basename(sys.argv[0]),)
 421
 422     longdesc = """
 423     Check all files and directories reachable from the given starting point
 424     (which must be a directory), like 'tahoe check' but for multiple files.
 425     Optionally repair any problems found."""
 426
 427 subCommands = [
 428     ["mkdir", None, MakeDirectoryOptions, "Create a new directory."],
 429     ["add-alias", None, AddAliasOptions, "Add a new alias cap."],
 430     ["create-alias", None, CreateAliasOptions, "Create a new alias cap."],
 431     ["list-aliases", None, ListAliasOptions, "List all alias caps."],
 432     ["ls", None, ListOptions, "List a directory."],
 433     ["get", None, GetOptions, "Retrieve a file from the grid."],
 434     ["put", None, PutOptions, "Upload a file into the grid."],
 435     ["cp", None, CpOptions, "Copy one or more files."],
 436     ["rm", None, RmOptions, "Unlink a file or directory on the grid."],
 437     ["unlink", None, UnlinkOptions, "Unlink a file or directory on the grid (same as rm)."],
 438     ["mv", None, MvOptions, "Move a file within the grid."],
 439     ["ln", None, LnOptions, "Make an additional link to an existing file."],
 440     ["backup", None, BackupOptions, "Make target dir look like local dir."],
 441     ["webopen", None, WebopenOptions, "Open a web browser to a grid file or directory."],
 442     ["manifest", None, ManifestOptions, "List all files/directories in a subtree."],
 443     ["stats", None, StatsOptions, "Print statistics about all files/directories in a subtree."],
 444     ["check", None, CheckOptions, "Check a single file or directory."],
 445     ["deep-check", None, DeepCheckOptions, "Check all files/directories reachable from a starting point."],
 446     ]
 447
 448 def mkdir(options):
 449     from allmydata.scripts import tahoe_mkdir
 450     rc = tahoe_mkdir.mkdir(options)
 451     return rc
 452
 453 def add_alias(options):
 454     from allmydata.scripts import tahoe_add_alias
 455     rc = tahoe_add_alias.add_alias(options)
 456     return rc
 457
 458 def create_alias(options):
 459     from allmydata.scripts import tahoe_add_alias
 460     rc = tahoe_add_alias.create_alias(options)
 461     return rc
 462
 463 def list_aliases(options):
 464     from allmydata.scripts import tahoe_add_alias
 465     rc = tahoe_add_alias.list_aliases(options)
 466     return rc
 467
 468 def list(options):
 469     from allmydata.scripts import tahoe_ls
 470     rc = tahoe_ls.list(options)
 471     return rc
 472
 473 def get(options):
 474     from allmydata.scripts import tahoe_get
 475     rc = tahoe_get.get(options)
 476     if rc == 0:
 477         if options.to_file is None:
 478             # be quiet, since the file being written to stdout should be
 479             # proof enough that it worked, unless the user is unlucky
 480             # enough to have picked an empty file
 481             pass
 482         else:
 483             print >>options.stderr, "%s retrieved and written to %s" % \
 484                   (options.from_file, options.to_file)
 485     return rc
 486
 487 def put(options):
 488     from allmydata.scripts import tahoe_put
 489     rc = tahoe_put.put(options)
 490     return rc
 491
 492 def cp(options):
 493     from allmydata.scripts import tahoe_cp
 494     rc = tahoe_cp.copy(options)
 495     return rc
 496
 497 def rm(options):
 498     from allmydata.scripts import tahoe_rm
 499     rc = tahoe_rm.rm(options)
 500     return rc
 501
 502 def mv(options):
 503     from allmydata.scripts import tahoe_mv
 504     rc = tahoe_mv.mv(options, mode="move")
 505     return rc
 506
 507 def ln(options):
 508     from allmydata.scripts import tahoe_mv
 509     rc = tahoe_mv.mv(options, mode="link")
 510     return rc
 511
 512 def backup(options):
 513     from allmydata.scripts import tahoe_backup
 514     rc = tahoe_backup.backup(options)
 515     return rc
 516
 517 def webopen(options, opener=None):
 518     from allmydata.scripts import tahoe_webopen
 519     rc = tahoe_webopen.webopen(options, opener=opener)
 520     return rc
 521
 522 def manifest(options):
 523     from allmydata.scripts import tahoe_manifest
 524     rc = tahoe_manifest.manifest(options)
 525     return rc
 526
 527 def stats(options):
 528     from allmydata.scripts import tahoe_manifest
 529     rc = tahoe_manifest.stats(options)
 530     return rc
 531
 532 def check(options):
 533     from allmydata.scripts import tahoe_check
 534     rc = tahoe_check.check(options)
 535     return rc
 536
 537 def deepcheck(options):
 538     from allmydata.scripts import tahoe_check
 539     rc = tahoe_check.deepcheck(options)
 540     return rc
 541
 542 dispatch = {
 543     "mkdir": mkdir,
 544     "add-alias": add_alias,
 545     "create-alias": create_alias,
 546     "list-aliases": list_aliases,
 547     "ls": list,
 548     "get": get,
 549     "put": put,
 550     "cp": cp,
 551     "rm": rm,
 552     "unlink": rm,
 553     "mv": mv,
 554     "ln": ln,
 555     "backup": backup,
 556     "webopen": webopen,
 557     "manifest": manifest,
 558     "stats": stats,
 559     "check": check,
 560     "deep-check": deepcheck,
 561     }