mirror of
https://github.com/tahoe-lafs/tahoe-lafs.git
synced 2025-01-01 10:46:42 +00:00
555 lines
20 KiB
Python
555 lines
20 KiB
Python
import os.path, re, sys, fnmatch
|
|
from twisted.python import usage
|
|
from allmydata.scripts.common import BaseOptions, get_aliases
|
|
from allmydata.util.stringutils import argv_to_unicode
|
|
|
|
NODEURL_RE=re.compile("http(s?)://([^:]*)(:([1-9][0-9]*))?")
|
|
|
|
class VDriveOptions(BaseOptions, usage.Options):
|
|
optParameters = [
|
|
["node-directory", "d", "~/.tahoe",
|
|
"Look here to find out which Tahoe node should be used for all "
|
|
"operations. The directory should either contain a full Tahoe node, "
|
|
"or a file named node.url which points to some other Tahoe node. "
|
|
"It should also contain a file named private/aliases which contains "
|
|
"the mapping from alias name to root dirnode URI."
|
|
],
|
|
["node-url", "u", None,
|
|
"URL of the tahoe node to use, a URL like \"http://127.0.0.1:3456\". "
|
|
"This overrides the URL found in the --node-directory ."],
|
|
["dir-cap", None, None,
|
|
"Which dirnode URI should be used as the 'tahoe' alias."]
|
|
]
|
|
|
|
def postOptions(self):
|
|
# TODO: allow Unicode node-dir
|
|
# compute a node-url from the existing options, put in self['node-url']
|
|
if self['node-directory']:
|
|
if sys.platform == 'win32' and self['node-directory'] == '~/.tahoe':
|
|
from allmydata.windows import registry
|
|
self['node-directory'] = registry.get_base_dir_path()
|
|
else:
|
|
self['node-directory'] = os.path.expanduser(self['node-directory'])
|
|
if self['node-url']:
|
|
if (not isinstance(self['node-url'], basestring)
|
|
or not NODEURL_RE.match(self['node-url'])):
|
|
msg = ("--node-url is required to be a string and look like "
|
|
"\"http://HOSTNAMEORADDR:PORT\", not: %r" %
|
|
(self['node-url'],))
|
|
raise usage.UsageError(msg)
|
|
else:
|
|
node_url_file = os.path.join(self['node-directory'], "node.url")
|
|
self['node-url'] = open(node_url_file, "r").read().strip()
|
|
if self['node-url'][-1] != "/":
|
|
self['node-url'] += "/"
|
|
|
|
aliases = get_aliases(self['node-directory'])
|
|
if self['dir-cap']:
|
|
aliases["tahoe"] = self['dir-cap']
|
|
self.aliases = aliases # maps alias name to dircap
|
|
|
|
|
|
class MakeDirectoryOptions(VDriveOptions):
|
|
def parseArgs(self, where=""):
|
|
self.where = argv_to_unicode(where)
|
|
longdesc = """Create a new directory, either unlinked or as a subdirectory."""
|
|
|
|
class AddAliasOptions(VDriveOptions):
|
|
def parseArgs(self, alias, cap):
|
|
self.alias = argv_to_unicode(alias)
|
|
self.cap = cap
|
|
|
|
def getSynopsis(self):
|
|
return "%s add-alias ALIAS DIRCAP" % (os.path.basename(sys.argv[0]),)
|
|
|
|
longdesc = """Add a new alias for an existing directory."""
|
|
|
|
class CreateAliasOptions(VDriveOptions):
|
|
def parseArgs(self, alias):
|
|
self.alias = argv_to_unicode(alias)
|
|
|
|
def getSynopsis(self):
|
|
return "%s create-alias ALIAS" % (os.path.basename(sys.argv[0]),)
|
|
|
|
longdesc = """Create a new directory and add an alias for it."""
|
|
|
|
class ListAliasOptions(VDriveOptions):
|
|
longdesc = """Display a table of all configured aliases."""
|
|
|
|
class ListOptions(VDriveOptions):
|
|
optFlags = [
|
|
("long", "l", "Use long format: show file sizes, and timestamps"),
|
|
("uri", "u", "Show file/directory URIs"),
|
|
("readonly-uri", None, "Show readonly file/directory URIs"),
|
|
("classify", "F", "Append '/' to directory names, and '*' to mutable"),
|
|
("json", None, "Show the raw JSON output"),
|
|
]
|
|
def parseArgs(self, where=""):
|
|
self.where = argv_to_unicode(where)
|
|
|
|
longdesc = """
|
|
List the contents of some portion of the grid.
|
|
|
|
When the -l or --long option is used, each line is shown in the
|
|
following format:
|
|
|
|
drwx <size> <date/time> <name in this directory>
|
|
|
|
where each of the letters on the left may be replaced by '-'.
|
|
If 'd' is present, it indicates that the object is a directory.
|
|
If the 'd' is replaced by a '?', the object type is unknown.
|
|
'rwx' is a Unix-like permissions mask: if the mask includes 'w',
|
|
then the object is writeable through its link in this directory
|
|
(note that the link might be replaceable even if the object is
|
|
not writeable through the current link).
|
|
The 'x' is a legacy of Unix filesystems. In Tahoe it is used
|
|
only to indicate that the contents of a directory can be listed.
|
|
|
|
Directories have no size, so their size field is shown as '-'.
|
|
Otherwise the size of the file, when known, is given in bytes.
|
|
The size of mutable files or unknown objects is shown as '?'.
|
|
|
|
The date/time shows when this link in the Tahoe filesystem was
|
|
last modified.
|
|
"""
|
|
|
|
class GetOptions(VDriveOptions):
|
|
def parseArgs(self, arg1, arg2=None):
|
|
# tahoe get FOO |less # write to stdout
|
|
# tahoe get tahoe:FOO |less # same
|
|
# tahoe get FOO bar # write to local file
|
|
# tahoe get tahoe:FOO bar # same
|
|
|
|
self.from_file = argv_to_unicode(arg1)
|
|
|
|
if arg2:
|
|
self.to_file = argv_to_unicode(arg2)
|
|
else:
|
|
self.to_file = None
|
|
|
|
if self.to_file == "-":
|
|
self.to_file = None
|
|
|
|
def getSynopsis(self):
|
|
return "%s get REMOTE_FILE LOCAL_FILE" % (os.path.basename(sys.argv[0]),)
|
|
|
|
longdesc = """
|
|
Retrieve a file from the grid and write it to the local filesystem. If
|
|
LOCAL_FILE is omitted or '-', the contents of the file will be written to
|
|
stdout."""
|
|
|
|
def getUsage(self, width=None):
|
|
t = VDriveOptions.getUsage(self, width)
|
|
t += """
|
|
Examples:
|
|
% tahoe get FOO |less # write to stdout
|
|
% tahoe get tahoe:FOO |less # same
|
|
% tahoe get FOO bar # write to local file
|
|
% tahoe get tahoe:FOO bar # same
|
|
"""
|
|
return t
|
|
|
|
class PutOptions(VDriveOptions):
|
|
optFlags = [
|
|
("mutable", "m", "Create a mutable file instead of an immutable one."),
|
|
]
|
|
|
|
def parseArgs(self, arg1=None, arg2=None):
|
|
# see Examples below
|
|
|
|
if arg1 is not None and arg2 is not None:
|
|
self.from_file = argv_to_unicode(arg1)
|
|
self.to_file = argv_to_unicode(arg2)
|
|
elif arg1 is not None and arg2 is None:
|
|
self.from_file = argv_to_unicode(arg1) # might be "-"
|
|
self.to_file = None
|
|
else:
|
|
self.from_file = None
|
|
self.to_file = None
|
|
if self.from_file == u"-":
|
|
self.from_file = None
|
|
|
|
def getSynopsis(self):
|
|
return "%s put LOCAL_FILE REMOTE_FILE" % (os.path.basename(sys.argv[0]),)
|
|
|
|
longdesc = """
|
|
Put a file into the grid, copying its contents from the local filesystem.
|
|
If REMOTE_FILE is missing, upload the file but do not link it into a
|
|
directory; also print the new filecap to stdout. If LOCAL_FILE is missing
|
|
or '-', data will be copied from stdin. REMOTE_FILE is assumed to start
|
|
with tahoe: unless otherwise specified."""
|
|
|
|
def getUsage(self, width=None):
|
|
t = VDriveOptions.getUsage(self, width)
|
|
t += """
|
|
Examples:
|
|
% cat FILE | tahoe put # create unlinked file from stdin
|
|
% cat FILE | tahoe - # same
|
|
% tahoe put bar # create unlinked file from local 'bar'
|
|
% cat FILE | tahoe put - FOO # create tahoe:FOO from stdin
|
|
% tahoe put bar FOO # copy local 'bar' to tahoe:FOO
|
|
% tahoe put bar tahoe:FOO # same
|
|
% tahoe put bar MUTABLE-FILE-WRITECAP # modify the mutable file in-place
|
|
"""
|
|
return t
|
|
|
|
class CpOptions(VDriveOptions):
|
|
optFlags = [
|
|
("recursive", "r", "Copy source directory recursively."),
|
|
("verbose", "v", "Be noisy about what is happening."),
|
|
("caps-only", None,
|
|
"When copying to local files, write out filecaps instead of actual "
|
|
"data (only useful for debugging and tree-comparison purposes)."),
|
|
]
|
|
def parseArgs(self, *args):
|
|
if len(args) < 2:
|
|
raise usage.UsageError("cp requires at least two arguments")
|
|
self.sources = map(argv_to_unicode, args[:-1])
|
|
self.destination = argv_to_unicode(args[-1])
|
|
def getSynopsis(self):
|
|
return "Usage: tahoe [options] cp FROM.. TO"
|
|
longdesc = """
|
|
Use 'tahoe cp' to copy files between a local filesystem and a Tahoe grid.
|
|
Any FROM/TO arguments that begin with an alias indicate Tahoe-side
|
|
files or non-file arguments. Directories will be copied recursively.
|
|
New Tahoe-side directories will be created when necessary. Assuming that
|
|
you have previously set up an alias 'home' with 'tahoe create-alias home',
|
|
here are some examples:
|
|
|
|
tahoe cp ~/foo.txt home: # creates tahoe-side home:foo.txt
|
|
|
|
tahoe cp ~/foo.txt /tmp/bar.txt home: # copies two files to home:
|
|
|
|
tahoe cp ~/Pictures home:stuff/my-pictures # copies directory recursively
|
|
|
|
You can also use a dircap as either FROM or TO target:
|
|
|
|
tahoe cp URI:DIR2-RO:j74uhg25nwdpjpacl6rkat2yhm:kav7ijeft5h7r7rxdp5bgtlt3viv32yabqajkrdykozia5544jqa/wiki.html ./ # copy Zooko's wiki page to a local file
|
|
|
|
This command still has some limitations: symlinks, special files (device
|
|
nodes, named pipes), and non-ASCII filenames are not handled very well.
|
|
Arguments should probably not have trailing slashes. 'tahoe cp' does not
|
|
behave as much like /bin/cp as you would wish, especially with respect to
|
|
trailing slashes.
|
|
"""
|
|
|
|
class RmOptions(VDriveOptions):
|
|
def parseArgs(self, where):
|
|
self.where = argv_to_unicode(where)
|
|
|
|
def getSynopsis(self):
|
|
return "%s rm REMOTE_FILE" % (os.path.basename(sys.argv[0]),)
|
|
|
|
class MvOptions(VDriveOptions):
|
|
def parseArgs(self, frompath, topath):
|
|
self.from_file = argv_to_unicode(frompath)
|
|
self.to_file = argv_to_unicode(topath)
|
|
|
|
def getSynopsis(self):
|
|
return "%s mv FROM TO" % (os.path.basename(sys.argv[0]),)
|
|
longdesc = """
|
|
Use 'tahoe mv' to move files that are already on the grid elsewhere on
|
|
the grid, e.g., 'tahoe mv alias:some_file alias:new_file'.
|
|
|
|
If moving a remote file into a remote directory, you'll need to append a
|
|
'/' to the name of the remote directory, e.g., 'tahoe mv tahoe:file1
|
|
tahoe:dir/', not 'tahoe mv tahoe:file1 tahoe:dir'.
|
|
|
|
Note that it is not possible to use this command to move local files to
|
|
the grid -- use 'tahoe cp' for that.
|
|
"""
|
|
|
|
class LnOptions(VDriveOptions):
|
|
def parseArgs(self, frompath, topath):
|
|
self.from_file = argv_to_unicode(frompath)
|
|
self.to_file = argv_to_unicode(topath)
|
|
|
|
def getSynopsis(self):
|
|
return "%s ln FROM TO" % (os.path.basename(sys.argv[0]),)
|
|
|
|
class BackupConfigurationError(Exception):
|
|
pass
|
|
|
|
class BackupOptions(VDriveOptions):
|
|
optFlags = [
|
|
("verbose", "v", "Be noisy about what is happening."),
|
|
("ignore-timestamps", None, "Do not use backupdb timestamps to decide whether a local file is unchanged."),
|
|
]
|
|
|
|
vcs_patterns = ('CVS', 'RCS', 'SCCS', '.git', '.gitignore', '.cvsignore',
|
|
'.svn', '.arch-ids','{arch}', '=RELEASE-ID',
|
|
'=meta-update', '=update', '.bzr', '.bzrignore',
|
|
'.bzrtags', '.hg', '.hgignore', '_darcs')
|
|
|
|
def __init__(self):
|
|
super(BackupOptions, self).__init__()
|
|
self['exclude'] = set()
|
|
|
|
def parseArgs(self, localdir, topath):
|
|
self.from_dir = argv_to_unicode(localdir)
|
|
self.to_dir = argv_to_unicode(topath)
|
|
|
|
def getSynopsis(Self):
|
|
return "%s backup FROM ALIAS:TO" % os.path.basename(sys.argv[0])
|
|
|
|
def opt_exclude(self, pattern):
|
|
"""Ignore files matching a glob pattern. You may give multiple
|
|
'--exclude' options."""
|
|
g = pattern.strip()
|
|
if g:
|
|
exclude = self['exclude']
|
|
exclude.add(g)
|
|
|
|
def opt_exclude_from(self, filepath):
|
|
"""Ignore file matching glob patterns listed in file, one per
|
|
line."""
|
|
try:
|
|
exclude_file = file(filepath)
|
|
except:
|
|
raise BackupConfigurationError('Error opening exclude file %r.' % filepath)
|
|
try:
|
|
for line in exclude_file:
|
|
self.opt_exclude(line)
|
|
finally:
|
|
exclude_file.close()
|
|
|
|
def opt_exclude_vcs(self):
|
|
"""Exclude files and directories used by following version control
|
|
systems: CVS, RCS, SCCS, Git, SVN, Arch, Bazaar(bzr), Mercurial,
|
|
Darcs."""
|
|
for pattern in self.vcs_patterns:
|
|
self.opt_exclude(pattern)
|
|
|
|
def filter_listdir(self, listdir):
|
|
"""Yields non-excluded childpaths in path."""
|
|
exclude = self['exclude']
|
|
exclude_regexps = [re.compile(fnmatch.translate(pat)) for pat in exclude]
|
|
for filename in listdir:
|
|
for regexp in exclude_regexps:
|
|
if regexp.match(filename):
|
|
break
|
|
else:
|
|
yield filename
|
|
|
|
longdesc = """
|
|
Add a versioned backup of the local FROM directory to a timestamped
|
|
subdirectory of the TO/Archives directory on the grid, sharing as many
|
|
files and directories as possible with earlier backups. Create TO/Latest
|
|
as a reference to the latest backup. Behaves somewhat like 'rsync -a
|
|
--link-dest=TO/Archives/(previous) FROM TO/Archives/(new); ln -sf
|
|
TO/Archives/(new) TO/Latest'."""
|
|
|
|
class WebopenOptions(VDriveOptions):
|
|
optFlags = [
|
|
("info", "i", "Open the t=info page for the file"),
|
|
]
|
|
def parseArgs(self, where=''):
|
|
self.where = argv_to_unicode(where)
|
|
|
|
def getSynopsis(self):
|
|
return "%s webopen [ALIAS:PATH]" % (os.path.basename(sys.argv[0]),)
|
|
|
|
longdesc = """Open a web browser to the contents of some file or
|
|
directory on the grid. When run without arguments, open the Welcome
|
|
page."""
|
|
|
|
class ManifestOptions(VDriveOptions):
|
|
optFlags = [
|
|
("storage-index", "s", "Only print storage index strings, not pathname+cap"),
|
|
("verify-cap", None, "Only print verifycap, not pathname+cap"),
|
|
("repair-cap", None, "Only print repaircap, not pathname+cap"),
|
|
("raw", "r", "Display raw JSON data instead of parsed"),
|
|
]
|
|
def parseArgs(self, where=''):
|
|
self.where = argv_to_unicode(where)
|
|
|
|
def getSynopsis(self):
|
|
return "%s manifest [ALIAS:PATH]" % (os.path.basename(sys.argv[0]),)
|
|
|
|
longdesc = """Print a list of all files and directories reachable from
|
|
the given starting point."""
|
|
|
|
class StatsOptions(VDriveOptions):
|
|
optFlags = [
|
|
("raw", "r", "Display raw JSON data instead of parsed"),
|
|
]
|
|
def parseArgs(self, where=''):
|
|
self.where = argv_to_unicode(where)
|
|
|
|
def getSynopsis(self):
|
|
return "%s stats [ALIAS:PATH]" % (os.path.basename(sys.argv[0]),)
|
|
|
|
longdesc = """Print statistics about of all files and directories
|
|
reachable from the given starting point."""
|
|
|
|
class CheckOptions(VDriveOptions):
|
|
optFlags = [
|
|
("raw", None, "Display raw JSON data instead of parsed"),
|
|
("verify", None, "Verify all hashes, instead of merely querying share presence"),
|
|
("repair", None, "Automatically repair any problems found"),
|
|
("add-lease", None, "Add/renew lease on all shares"),
|
|
]
|
|
def parseArgs(self, where=''):
|
|
self.where = argv_to_unicode(where)
|
|
|
|
def getSynopsis(self):
|
|
return "%s check [ALIAS:PATH]" % (os.path.basename(sys.argv[0]),)
|
|
|
|
longdesc = """
|
|
Check a single file or directory: count how many shares are available and
|
|
verify their hashes. Optionally repair the file if any problems were
|
|
found."""
|
|
|
|
class DeepCheckOptions(VDriveOptions):
|
|
optFlags = [
|
|
("raw", None, "Display raw JSON data instead of parsed"),
|
|
("verify", None, "Verify all hashes, instead of merely querying share presence"),
|
|
("repair", None, "Automatically repair any problems found"),
|
|
("add-lease", None, "Add/renew lease on all shares"),
|
|
("verbose", "v", "Be noisy about what is happening."),
|
|
]
|
|
def parseArgs(self, where=''):
|
|
self.where = argv_to_unicode(where)
|
|
|
|
def getSynopsis(self):
|
|
return "%s deep-check [ALIAS:PATH]" % (os.path.basename(sys.argv[0]),)
|
|
|
|
longdesc = """
|
|
Check all files and directories reachable from the given starting point
|
|
(which must be a directory), like 'tahoe check' but for multiple files.
|
|
Optionally repair any problems found."""
|
|
|
|
subCommands = [
|
|
["mkdir", None, MakeDirectoryOptions, "Create a new directory"],
|
|
["add-alias", None, AddAliasOptions, "Add a new alias cap"],
|
|
["create-alias", None, CreateAliasOptions, "Create a new alias cap"],
|
|
["list-aliases", None, ListAliasOptions, "List all alias caps"],
|
|
["ls", None, ListOptions, "List a directory"],
|
|
["get", None, GetOptions, "Retrieve a file from the grid."],
|
|
["put", None, PutOptions, "Upload a file into the grid."],
|
|
["cp", None, CpOptions, "Copy one or more files."],
|
|
["rm", None, RmOptions, "Unlink a file or directory on the grid."],
|
|
["mv", None, MvOptions, "Move a file within the grid."],
|
|
["ln", None, LnOptions, "Make an additional link to an existing file."],
|
|
["backup", None, BackupOptions, "Make target dir look like local dir."],
|
|
["webopen", None, WebopenOptions, "Open a web browser to a grid file or directory."],
|
|
["manifest", None, ManifestOptions, "List all files/directories in a subtree"],
|
|
["stats", None, StatsOptions, "Print statistics about all files/directories in a subtree"],
|
|
["check", None, CheckOptions, "Check a single file or directory"],
|
|
["deep-check", None, DeepCheckOptions, "Check all files/directories reachable from a starting point"],
|
|
]
|
|
|
|
def mkdir(options):
|
|
from allmydata.scripts import tahoe_mkdir
|
|
rc = tahoe_mkdir.mkdir(options)
|
|
return rc
|
|
|
|
def add_alias(options):
|
|
from allmydata.scripts import tahoe_add_alias
|
|
rc = tahoe_add_alias.add_alias(options)
|
|
return rc
|
|
|
|
def create_alias(options):
|
|
from allmydata.scripts import tahoe_add_alias
|
|
rc = tahoe_add_alias.create_alias(options)
|
|
return rc
|
|
|
|
def list_aliases(options):
|
|
from allmydata.scripts import tahoe_add_alias
|
|
rc = tahoe_add_alias.list_aliases(options)
|
|
return rc
|
|
|
|
def list(options):
|
|
from allmydata.scripts import tahoe_ls
|
|
rc = tahoe_ls.list(options)
|
|
return rc
|
|
|
|
def get(options):
|
|
from allmydata.scripts import tahoe_get
|
|
rc = tahoe_get.get(options)
|
|
if rc == 0:
|
|
if options.to_file is None:
|
|
# be quiet, since the file being written to stdout should be
|
|
# proof enough that it worked, unless the user is unlucky
|
|
# enough to have picked an empty file
|
|
pass
|
|
else:
|
|
print >>options.stderr, "%s retrieved and written to %s" % \
|
|
(options.from_file, options.to_file)
|
|
return rc
|
|
|
|
def put(options):
|
|
from allmydata.scripts import tahoe_put
|
|
rc = tahoe_put.put(options)
|
|
return rc
|
|
|
|
def cp(options):
|
|
from allmydata.scripts import tahoe_cp
|
|
rc = tahoe_cp.copy(options)
|
|
return rc
|
|
|
|
def rm(options):
|
|
from allmydata.scripts import tahoe_rm
|
|
rc = tahoe_rm.rm(options)
|
|
return rc
|
|
|
|
def mv(options):
|
|
from allmydata.scripts import tahoe_mv
|
|
rc = tahoe_mv.mv(options, mode="move")
|
|
return rc
|
|
|
|
def ln(options):
|
|
from allmydata.scripts import tahoe_mv
|
|
rc = tahoe_mv.mv(options, mode="link")
|
|
return rc
|
|
|
|
def backup(options):
|
|
from allmydata.scripts import tahoe_backup
|
|
rc = tahoe_backup.backup(options)
|
|
return rc
|
|
|
|
def webopen(options, opener=None):
|
|
from allmydata.scripts import tahoe_webopen
|
|
rc = tahoe_webopen.webopen(options, opener=opener)
|
|
return rc
|
|
|
|
def manifest(options):
|
|
from allmydata.scripts import tahoe_manifest
|
|
rc = tahoe_manifest.manifest(options)
|
|
return rc
|
|
|
|
def stats(options):
|
|
from allmydata.scripts import tahoe_manifest
|
|
rc = tahoe_manifest.stats(options)
|
|
return rc
|
|
|
|
def check(options):
|
|
from allmydata.scripts import tahoe_check
|
|
rc = tahoe_check.check(options)
|
|
return rc
|
|
|
|
def deepcheck(options):
|
|
from allmydata.scripts import tahoe_check
|
|
rc = tahoe_check.deepcheck(options)
|
|
return rc
|
|
|
|
dispatch = {
|
|
"mkdir": mkdir,
|
|
"add-alias": add_alias,
|
|
"create-alias": create_alias,
|
|
"list-aliases": list_aliases,
|
|
"ls": list,
|
|
"get": get,
|
|
"put": put,
|
|
"cp": cp,
|
|
"rm": rm,
|
|
"mv": mv,
|
|
"ln": ln,
|
|
"backup": backup,
|
|
"webopen": webopen,
|
|
"manifest": manifest,
|
|
"stats": stats,
|
|
"check": check,
|
|
"deep-check": deepcheck,
|
|
}
|