2 import os.path, re, sys
3 from twisted.python import usage
4 from allmydata.scripts.common import BaseOptions, get_aliases
6 NODEURL_RE=re.compile("http://([^:]*)(:([1-9][0-9]*))?")
8 class VDriveOptions(BaseOptions, usage.Options):
10 ["node-directory", "d", "~/.tahoe",
11 "Look here to find out which Tahoe node should be used for all "
12 "operations. The directory should either contain a full Tahoe node, "
13 "or a file named node.url which points to some other Tahoe node. "
14 "It should also contain a file named root_dir.cap which contains "
15 "the root dirnode URI that should be used."
17 ["node-url", "u", None,
18 "URL of the tahoe node to use, a URL like \"http://127.0.0.1:8123\". "
19 "This overrides the URL found in the --node-directory ."],
20 ["dir-cap", "r", None,
21 "Which dirnode URI should be used as the 'tahoe' alias."]
24 def postOptions(self):
25 # compute a node-url from the existing options, put in self['node-url']
26 if self['node-directory']:
27 if sys.platform == 'win32' and self['node-directory'] == '~/.tahoe':
28 from allmydata.windows import registry
29 self['node-directory'] = registry.get_base_dir_path()
31 self['node-directory'] = os.path.expanduser(self['node-directory'])
33 if (not isinstance(self['node-url'], basestring)
34 or not NODEURL_RE.match(self['node-url'])):
35 msg = ("--node-url is required to be a string and look like "
36 "\"http://HOSTNAMEORADDR:PORT\", not: %r" %
38 raise usage.UsageError(msg)
40 node_url_file = os.path.join(self['node-directory'], "node.url")
41 self['node-url'] = open(node_url_file, "r").read().strip()
43 aliases = get_aliases(self['node-directory'])
45 aliases["tahoe"] = self['dir-cap']
46 self.aliases = aliases # maps alias name to dircap
49 class MakeDirectoryOptions(VDriveOptions):
50 def parseArgs(self, where=""):
52 longdesc = """Create a new directory, either unlinked or as a subdirectory."""
54 class AddAliasOptions(VDriveOptions):
55 def parseArgs(self, alias, cap):
59 class ListAliasOptions(VDriveOptions):
62 class ListOptions(VDriveOptions):
64 ("long", "l", "Use long format: show file sizes, and timestamps"),
65 ("uri", "u", "Show file/directory URIs"),
66 ("readonly-uri", None, "Show readonly file/directory URIs"),
67 ("classify", "F", "Append '/' to directory names, and '*' to mutable"),
68 ("json", None, "Show the raw JSON output"),
70 def parseArgs(self, where=""):
73 longdesc = """List the contents of some portion of the virtual drive."""
75 class GetOptions(VDriveOptions):
76 def parseArgs(self, arg1, arg2=None):
77 # tahoe get FOO |less # write to stdout
78 # tahoe get tahoe:FOO |less # same
79 # tahoe get FOO bar # write to local file
80 # tahoe get tahoe:FOO bar # same
84 if self.to_file == "-":
87 def getSynopsis(self):
88 return "%s get VDRIVE_FILE LOCAL_FILE" % (os.path.basename(sys.argv[0]),)
90 longdesc = """Retrieve a file from the virtual drive and write it to the
91 local filesystem. If LOCAL_FILE is omitted or '-', the contents of the file
92 will be written to stdout."""
94 class PutOptions(VDriveOptions):
96 ("mutable", "m", "Create a mutable file instead of an immutable one."),
99 def parseArgs(self, arg1=None, arg2=None):
100 # cat FILE > tahoe put # create unlinked file from stdin
101 # cat FILE > tahoe put FOO # create tahoe:FOO from stdin
102 # cat FILE > tahoe put tahoe:FOO # same
103 # tahoe put bar FOO # copy local 'bar' to tahoe:FOO
104 # tahoe put bar tahoe:FOO # same
106 if arg1 is not None and arg2 is not None:
107 self.from_file = arg1
109 elif arg1 is not None and arg2 is None:
110 self.from_file = None
113 self.from_file = arg1
115 if self.from_file == "-":
116 self.from_file = None
118 def getSynopsis(self):
119 return "%s put LOCAL_FILE VDRIVE_FILE" % (os.path.basename(sys.argv[0]),)
121 longdesc = """Put a file into the virtual drive (copying the file's
122 contents from the local filesystem). LOCAL_FILE is required to be a
123 local file (it can't be stdin)."""
125 class RmOptions(VDriveOptions):
126 def parseArgs(self, where):
129 def getSynopsis(self):
130 return "%s rm VE_FILE" % (os.path.basename(sys.argv[0]),)
132 class MvOptions(VDriveOptions):
133 def parseArgs(self, frompath, topath):
134 self.from_file = frompath
135 self.to_file = topath
137 def getSynopsis(self):
138 return "%s mv FROM TO" % (os.path.basename(sys.argv[0]),)
140 class LnOptions(VDriveOptions):
141 def parseArgs(self, frompath, topath):
142 self.from_file = frompath
143 self.to_file = topath
145 def getSynopsis(self):
146 return "%s ln FROM TO" % (os.path.basename(sys.argv[0]),)
148 class WebopenOptions(VDriveOptions):
149 def parseArgs(self, vdrive_pathname=""):
150 self['vdrive_pathname'] = vdrive_pathname
152 longdesc = """Opens a webbrowser to the contents of some portion of the virtual drive."""
154 class ReplOptions(usage.Options):
158 ["mkdir", None, MakeDirectoryOptions, "Create a new directory"],
159 ["add-alias", None, AddAliasOptions, "Add a new alias cap"],
160 ["list-aliases", None, ListAliasOptions, "List all alias caps"],
161 ["ls", None, ListOptions, "List a directory"],
162 ["get", None, GetOptions, "Retrieve a file from the virtual drive."],
163 ["put", None, PutOptions, "Upload a file into the virtual drive."],
164 ["rm", None, RmOptions, "Unlink a file or directory in the virtual drive."],
165 ["mv", None, MvOptions, "Move a file within the virtual drive."],
166 ["ln", None, LnOptions, "Make an additional link to an existing file."],
167 ["webopen", None, WebopenOptions, "Open a webbrowser to the root_dir"],
168 ["repl", None, ReplOptions, "Open a python interpreter"],
171 def mkdir(config, stdout, stderr):
172 from allmydata.scripts import tahoe_mkdir
173 rc = tahoe_mkdir.mkdir(config['node-url'],
179 def add_alias(config, stdout, stderr):
180 from allmydata.scripts import tahoe_add_alias
181 rc = tahoe_add_alias.add_alias(config['node-directory'],
187 def list_aliases(config, stdout, stderr):
188 from allmydata.scripts import tahoe_add_alias
189 rc = tahoe_add_alias.list_aliases(config['node-directory'],
193 def list(config, stdout, stderr):
194 from allmydata.scripts import tahoe_ls
195 rc = tahoe_ls.list(config['node-url'],
202 def get(config, stdout, stderr):
203 from allmydata.scripts import tahoe_get
204 rc = tahoe_get.get(config['node-url'],
210 if config.to_file is None:
211 # be quiet, since the file being written to stdout should be
212 # proof enough that it worked, unless the user is unlucky
213 # enough to have picked an empty file
216 print >>stderr, "%s retrieved and written to %s" % \
217 (config.from_file, config.to_file)
220 def put(config, stdout, stderr, stdin=sys.stdin):
221 from allmydata.scripts import tahoe_put
226 rc = tahoe_put.put(config['node-url'],
232 stdin, stdout, stderr)
235 def rm(config, stdout, stderr):
236 from allmydata.scripts import tahoe_rm
241 rc = tahoe_rm.rm(config['node-url'],
248 def mv(config, stdout, stderr):
249 from allmydata.scripts import tahoe_mv
250 rc = tahoe_mv.mv(config['node-url'],
258 def ln(config, stdout, stderr):
259 from allmydata.scripts import tahoe_mv
260 rc = tahoe_mv.mv(config['node-url'],
268 def webopen(config, stdout, stderr):
269 import urllib, webbrowser
270 nodeurl = config['node-url']
271 if nodeurl[-1] != "/":
273 url = nodeurl + "uri/%s/" % urllib.quote(config['dir-cap'])
274 if config['vdrive_pathname']:
275 url += urllib.quote(config['vdrive_pathname'])
279 def repl(config, stdout, stderr):
281 return code.interact()
285 "add-alias": add_alias,
286 "list-aliases": list_aliases,