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 private/aliases which contains the mapping from alias name "
  17          "to root dirnode URI." + (
  18             _default_nodedir and (" [default for most commands: " + 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 -                  # 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, special files (device
 230     nodes, named pipes), and non-ASCII filenames are not handled very well.
 231     Arguments should probably not have trailing slashes. 'tahoe cp' does not
 232     behave as much like /bin/cp as you would wish, especially with respect to
 233     trailing 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         try:
 311             exclude_file = file(filepath)
 312         except:
 313             raise BackupConfigurationError('Error opening exclude file %r.' % filepath)
 314         try:
 315             for line in exclude_file:
 316                 self.opt_exclude(line)
 317         finally:
 318             exclude_file.close()
 319
 320     def opt_exclude_vcs(self):
 321         """Exclude files and directories used by following version control
 322         systems: CVS, RCS, SCCS, Git, SVN, Arch, Bazaar(bzr), Mercurial,
 323         Darcs."""
 324         for pattern in self.vcs_patterns:
 325             self.opt_exclude(pattern)
 326
 327     def filter_listdir(self, listdir):
 328         """Yields non-excluded childpaths in path."""
 329         exclude = self['exclude']
 330         exclude_regexps = [re.compile(fnmatch.translate(pat)) for pat in exclude]
 331         for filename in listdir:
 332             for regexp in exclude_regexps:
 333                 if regexp.match(filename):
 334                     break
 335             else:
 336                 yield filename
 337
 338     longdesc = """
 339     Add a versioned backup of the local FROM directory to a timestamped
 340     subdirectory of the TO/Archives directory on the grid, sharing as many
 341     files and directories as possible with earlier backups. Create TO/Latest
 342     as a reference to the latest backup. Behaves somewhat like 'rsync -a
 343     --link-dest=TO/Archives/(previous) FROM TO/Archives/(new); ln -sf
 344     TO/Archives/(new) TO/Latest'."""
 345
 346 class WebopenOptions(VDriveOptions):
 347     optFlags = [
 348         ("info", "i", "Open the t=info page for the file"),
 349         ]
 350     def parseArgs(self, where=''):
 351         self.where = argv_to_unicode(where)
 352
 353     def getSynopsis(self):
 354         return "%s webopen [ALIAS:PATH]" % (os.path.basename(sys.argv[0]),)
 355
 356     longdesc = """Open a web browser to the contents of some file or
 357     directory on the grid. When run without arguments, open the Welcome
 358     page."""
 359
 360 class ManifestOptions(VDriveOptions):
 361     optFlags = [
 362         ("storage-index", "s", "Only print storage index strings, not pathname+cap."),
 363         ("verify-cap", None, "Only print verifycap, not pathname+cap."),
 364         ("repair-cap", None, "Only print repaircap, not pathname+cap."),
 365         ("raw", "r", "Display raw JSON data instead of parsed."),
 366         ]
 367     def parseArgs(self, where=''):
 368         self.where = argv_to_unicode(where)
 369
 370     def getSynopsis(self):
 371         return "%s manifest [ALIAS:PATH]" % (os.path.basename(sys.argv[0]),)
 372
 373     longdesc = """Print a list of all files and directories reachable from
 374     the given starting point."""
 375
 376 class StatsOptions(VDriveOptions):
 377     optFlags = [
 378         ("raw", "r", "Display raw JSON data instead of parsed"),
 379         ]
 380     def parseArgs(self, where=''):
 381         self.where = argv_to_unicode(where)
 382
 383     def getSynopsis(self):
 384         return "%s stats [ALIAS:PATH]" % (os.path.basename(sys.argv[0]),)
 385
 386     longdesc = """Print statistics about of all files and directories
 387     reachable from the given starting point."""
 388
 389 class CheckOptions(VDriveOptions):
 390     optFlags = [
 391         ("raw", None, "Display raw JSON data instead of parsed."),
 392         ("verify", None, "Verify all hashes, instead of merely querying share presence."),
 393         ("repair", None, "Automatically repair any problems found."),
 394         ("add-lease", None, "Add/renew lease on all shares."),
 395         ]
 396     def parseArgs(self, where=''):
 397         self.where = argv_to_unicode(where)
 398
 399     def getSynopsis(self):
 400         return "%s check [ALIAS:PATH]" % (os.path.basename(sys.argv[0]),)
 401
 402     longdesc = """
 403     Check a single file or directory: count how many shares are available and
 404     verify their hashes. Optionally repair the file if any problems were
 405     found."""
 406
 407 class DeepCheckOptions(VDriveOptions):
 408     optFlags = [
 409         ("raw", None, "Display raw JSON data instead of parsed."),
 410         ("verify", None, "Verify all hashes, instead of merely querying share presence."),
 411         ("repair", None, "Automatically repair any problems found."),
 412         ("add-lease", None, "Add/renew lease on all shares."),
 413         ("verbose", "v", "Be noisy about what is happening."),
 414         ]
 415     def parseArgs(self, where=''):
 416         self.where = argv_to_unicode(where)
 417
 418     def getSynopsis(self):
 419         return "%s deep-check [ALIAS:PATH]" % (os.path.basename(sys.argv[0]),)
 420
 421     longdesc = """
 422     Check all files and directories reachable from the given starting point
 423     (which must be a directory), like 'tahoe check' but for multiple files.
 424     Optionally repair any problems found."""
 425
 426 subCommands = [
 427     ["mkdir", None, MakeDirectoryOptions, "Create a new directory."],
 428     ["add-alias", None, AddAliasOptions, "Add a new alias cap."],
 429     ["create-alias", None, CreateAliasOptions, "Create a new alias cap."],
 430     ["list-aliases", None, ListAliasOptions, "List all alias caps."],
 431     ["ls", None, ListOptions, "List a directory."],
 432     ["get", None, GetOptions, "Retrieve a file from the grid."],
 433     ["put", None, PutOptions, "Upload a file into the grid."],
 434     ["cp", None, CpOptions, "Copy one or more files."],
 435     ["rm", None, RmOptions, "Unlink a file or directory on the grid."],
 436     ["unlink", None, UnlinkOptions, "Unlink a file or directory on the grid (same as rm)."],
 437     ["mv", None, MvOptions, "Move a file within the grid."],
 438     ["ln", None, LnOptions, "Make an additional link to an existing file."],
 439     ["backup", None, BackupOptions, "Make target dir look like local dir."],
 440     ["webopen", None, WebopenOptions, "Open a web browser to a grid file or directory."],
 441     ["manifest", None, ManifestOptions, "List all files/directories in a subtree."],
 442     ["stats", None, StatsOptions, "Print statistics about all files/directories in a subtree."],
 443     ["check", None, CheckOptions, "Check a single file or directory."],
 444     ["deep-check", None, DeepCheckOptions, "Check all files/directories reachable from a starting point."],
 445     ]
 446
 447 def mkdir(options):
 448     from allmydata.scripts import tahoe_mkdir
 449     rc = tahoe_mkdir.mkdir(options)
 450     return rc
 451
 452 def add_alias(options):
 453     from allmydata.scripts import tahoe_add_alias
 454     rc = tahoe_add_alias.add_alias(options)
 455     return rc
 456
 457 def create_alias(options):
 458     from allmydata.scripts import tahoe_add_alias
 459     rc = tahoe_add_alias.create_alias(options)
 460     return rc
 461
 462 def list_aliases(options):
 463     from allmydata.scripts import tahoe_add_alias
 464     rc = tahoe_add_alias.list_aliases(options)
 465     return rc
 466
 467 def list(options):
 468     from allmydata.scripts import tahoe_ls
 469     rc = tahoe_ls.list(options)
 470     return rc
 471
 472 def get(options):
 473     from allmydata.scripts import tahoe_get
 474     rc = tahoe_get.get(options)
 475     if rc == 0:
 476         if options.to_file is None:
 477             # be quiet, since the file being written to stdout should be
 478             # proof enough that it worked, unless the user is unlucky
 479             # enough to have picked an empty file
 480             pass
 481         else:
 482             print >>options.stderr, "%s retrieved and written to %s" % \
 483                   (options.from_file, options.to_file)
 484     return rc
 485
 486 def put(options):
 487     from allmydata.scripts import tahoe_put
 488     rc = tahoe_put.put(options)
 489     return rc
 490
 491 def cp(options):
 492     from allmydata.scripts import tahoe_cp
 493     rc = tahoe_cp.copy(options)
 494     return rc
 495
 496 def rm(options):
 497     from allmydata.scripts import tahoe_rm
 498     rc = tahoe_rm.rm(options)
 499     return rc
 500
 501 def mv(options):
 502     from allmydata.scripts import tahoe_mv
 503     rc = tahoe_mv.mv(options, mode="move")
 504     return rc
 505
 506 def ln(options):
 507     from allmydata.scripts import tahoe_mv
 508     rc = tahoe_mv.mv(options, mode="link")
 509     return rc
 510
 511 def backup(options):
 512     from allmydata.scripts import tahoe_backup
 513     rc = tahoe_backup.backup(options)
 514     return rc
 515
 516 def webopen(options, opener=None):
 517     from allmydata.scripts import tahoe_webopen
 518     rc = tahoe_webopen.webopen(options, opener=opener)
 519     return rc
 520
 521 def manifest(options):
 522     from allmydata.scripts import tahoe_manifest
 523     rc = tahoe_manifest.manifest(options)
 524     return rc
 525
 526 def stats(options):
 527     from allmydata.scripts import tahoe_manifest
 528     rc = tahoe_manifest.stats(options)
 529     return rc
 530
 531 def check(options):
 532     from allmydata.scripts import tahoe_check
 533     rc = tahoe_check.check(options)
 534     return rc
 535
 536 def deepcheck(options):
 537     from allmydata.scripts import tahoe_check
 538     rc = tahoe_check.deepcheck(options)
 539     return rc
 540
 541 dispatch = {
 542     "mkdir": mkdir,
 543     "add-alias": add_alias,
 544     "create-alias": create_alias,
 545     "list-aliases": list_aliases,
 546     "ls": list,
 547     "get": get,
 548     "put": put,
 549     "cp": cp,
 550     "rm": rm,
 551     "unlink": rm,
 552     "mv": mv,
 553     "ln": ln,
 554     "backup": backup,
 555     "webopen": webopen,
 556     "manifest": manifest,
 557     "stats": stats,
 558     "check": check,
 559     "deep-check": deepcheck,
 560     }