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 private/aliases which contains "
15 "the mapping from alias name to root dirnode URI."
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", None, 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 def getUsage(self, width=None):
95 t = VDriveOptions.getUsage(self, width)
98 % tahoe get FOO |less # write to stdout
99 % tahoe get tahoe:FOO |less # same
100 % tahoe get FOO bar # write to local file
101 % tahoe get tahoe:FOO bar # same
105 class PutOptions(VDriveOptions):
107 ("mutable", "m", "Create a mutable file instead of an immutable one."),
110 def parseArgs(self, arg1=None, arg2=None):
111 # cat FILE > tahoe put # create unlinked file from stdin
112 # cat FILE > tahoe put FOO # create tahoe:FOO from stdin
113 # cat FILE > tahoe put tahoe:FOO # same
114 # tahoe put bar FOO # copy local 'bar' to tahoe:FOO
115 # tahoe put bar tahoe:FOO # same
117 if arg1 is not None and arg2 is not None:
118 self.from_file = arg1
120 elif arg1 is not None and arg2 is None:
121 self.from_file = None
124 self.from_file = arg1
126 if self.from_file == "-":
127 self.from_file = None
129 def getSynopsis(self):
130 return "%s put LOCAL_FILE VDRIVE_FILE" % (os.path.basename(sys.argv[0]),)
132 longdesc = """Put a file into the virtual drive (copying the file's
133 contents from the local filesystem). If LOCAL_FILE is missing or '-',
134 data will be copied from stdin. VDRIVE_FILE is assumed to start with
135 tahoe: unless otherwise specified."""
137 def getUsage(self, width=None):
138 t = VDriveOptions.getUsage(self, width)
141 % cat FILE > tahoe put # create unlinked file from stdin
142 % cat FILE > tahoe put FOO # create tahoe:FOO from stdin
143 % cat FILE > tahoe put tahoe:FOO # same
144 % tahoe put bar FOO # copy local 'bar' to tahoe:FOO
145 % tahoe put bar tahoe:FOO # same
149 class CpOptions(VDriveOptions):
151 ("recursive", "r", "Copy source directory recursively."),
152 ("verbose", "v", "Be noisy about what is happening."),
154 def parseArgs(self, *args):
156 raise usage.UsageError("cp requires at least two arguments")
157 self.sources = args[:-1]
158 self.destination = args[-1]
160 class RmOptions(VDriveOptions):
161 def parseArgs(self, where):
164 def getSynopsis(self):
165 return "%s rm VE_FILE" % (os.path.basename(sys.argv[0]),)
167 class MvOptions(VDriveOptions):
168 def parseArgs(self, frompath, topath):
169 self.from_file = frompath
170 self.to_file = topath
172 def getSynopsis(self):
173 return "%s mv FROM TO" % (os.path.basename(sys.argv[0]),)
175 class LnOptions(VDriveOptions):
176 def parseArgs(self, frompath, topath):
177 self.from_file = frompath
178 self.to_file = topath
180 def getSynopsis(self):
181 return "%s ln FROM TO" % (os.path.basename(sys.argv[0]),)
183 class WebopenOptions(VDriveOptions):
184 def parseArgs(self, vdrive_pathname=""):
185 self['vdrive_pathname'] = vdrive_pathname
187 longdesc = """Opens a webbrowser to the contents of some portion of the virtual drive."""
189 class ReplOptions(usage.Options):
193 ["mkdir", None, MakeDirectoryOptions, "Create a new directory"],
194 ["add-alias", None, AddAliasOptions, "Add a new alias cap"],
195 ["list-aliases", None, ListAliasOptions, "List all alias caps"],
196 ["ls", None, ListOptions, "List a directory"],
197 ["get", None, GetOptions, "Retrieve a file from the virtual drive."],
198 ["put", None, PutOptions, "Upload a file into the virtual drive."],
199 ["cp", None, CpOptions, "Copy one or more files."],
200 ["rm", None, RmOptions, "Unlink a file or directory in the virtual drive."],
201 ["mv", None, MvOptions, "Move a file within the virtual drive."],
202 ["ln", None, LnOptions, "Make an additional link to an existing file."],
203 ["webopen", None, WebopenOptions, "Open a webbrowser to the root_dir"],
204 ["repl", None, ReplOptions, "Open a python interpreter"],
208 from allmydata.scripts import tahoe_mkdir
209 rc = tahoe_mkdir.mkdir(options)
212 def add_alias(options):
213 from allmydata.scripts import tahoe_add_alias
214 rc = tahoe_add_alias.add_alias(options)
217 def list_aliases(options):
218 from allmydata.scripts import tahoe_add_alias
219 rc = tahoe_add_alias.list_aliases(options)
223 from allmydata.scripts import tahoe_ls
224 rc = tahoe_ls.list(options)
228 from allmydata.scripts import tahoe_get
229 rc = tahoe_get.get(options)
231 if options.to_file is None:
232 # be quiet, since the file being written to stdout should be
233 # proof enough that it worked, unless the user is unlucky
234 # enough to have picked an empty file
237 print >>options.stderr, "%s retrieved and written to %s" % \
238 (options.from_file, options.to_file)
242 from allmydata.scripts import tahoe_put
243 rc = tahoe_put.put(options)
247 from allmydata.scripts import tahoe_cp
248 rc = tahoe_cp.copy(options)
252 from allmydata.scripts import tahoe_rm
253 rc = tahoe_rm.rm(options)
257 from allmydata.scripts import tahoe_mv
258 rc = tahoe_mv.mv(options, mode="move")
262 from allmydata.scripts import tahoe_mv
263 rc = tahoe_mv.mv(options, mode="link")
266 def webopen(options):
267 import urllib, webbrowser
268 nodeurl = options['node-url']
269 if nodeurl[-1] != "/":
271 root_cap = options.aliases["tahoe"]
272 url = nodeurl + "uri/%s/" % urllib.quote(root_cap)
273 if options['vdrive_pathname']:
274 url += urllib.quote(options['vdrive_pathname'])
280 return code.interact()
284 "add-alias": add_alias,
285 "list-aliases": list_aliases,