3 from types import NoneType
4 from cStringIO import StringIO
6 from twisted.python import usage
8 from allmydata.util.assertutil import precondition
10 from .common import BaseOptions, BasedirOptions, get_aliases
11 from .cli import MakeDirectoryOptions, LnOptions, CreateAliasOptions
13 from allmydata.util.encodingutil import argv_to_abspath, argv_to_unicode, to_str
14 from allmydata.util import fileutil
15 from allmydata import uri
17 INVITE_SEPARATOR = "+"
19 class CreateOptions(BasedirOptions):
22 synopsis = "MAGIC_ALIAS: [NICKNAME LOCAL_DIR]"
23 def parseArgs(self, alias, nickname=None, local_dir=None):
24 BasedirOptions.parseArgs(self)
25 alias = argv_to_unicode(alias)
26 if not alias.endswith(u':'):
27 raise usage.UsageError("An alias must end with a ':' character.")
28 self.alias = alias[:-1]
29 self.nickname = None if nickname is None else argv_to_unicode(nickname)
31 # Expand the path relative to the current directory of the CLI command, not the node.
32 self.local_dir = None if local_dir is None else argv_to_abspath(local_dir, long_path=False)
34 if self.nickname and not self.local_dir:
35 raise usage.UsageError("If NICKNAME is specified then LOCAL_DIR must also be specified.")
36 node_url_file = os.path.join(self['node-directory'], u"node.url")
37 self['node-url'] = fileutil.read(node_url_file).strip()
39 def _delegate_options(source_options, target_options):
40 target_options.aliases = get_aliases(source_options['node-directory'])
41 target_options["node-url"] = source_options["node-url"]
42 target_options["node-directory"] = source_options["node-directory"]
43 target_options.stdin = StringIO("")
44 target_options.stdout = StringIO()
45 target_options.stderr = StringIO()
49 precondition(isinstance(options.alias, unicode), alias=options.alias)
50 precondition(isinstance(options.nickname, (unicode, NoneType)), nickname=options.nickname)
51 precondition(isinstance(options.local_dir, (unicode, NoneType)), local_dir=options.local_dir)
53 from allmydata.scripts import tahoe_add_alias
54 create_alias_options = _delegate_options(options, CreateAliasOptions())
55 create_alias_options.alias = options.alias
57 rc = tahoe_add_alias.create_alias(create_alias_options)
59 print >>options.stderr, create_alias_options.stderr.getvalue()
61 print >>options.stdout, create_alias_options.stdout.getvalue()
63 if options.nickname is not None:
64 invite_options = _delegate_options(options, InviteOptions())
65 invite_options.alias = options.alias
66 invite_options.nickname = options.nickname
67 rc = invite(invite_options)
69 print >>options.stderr, "magic-folder: failed to invite after create\n"
70 print >>options.stderr, invite_options.stderr.getvalue()
72 invite_code = invite_options.stdout.getvalue().strip()
73 join_options = _delegate_options(options, JoinOptions())
74 join_options.local_dir = options.local_dir
75 join_options.invite_code = invite_code
76 rc = join(join_options)
78 print >>options.stderr, "magic-folder: failed to join after create\n"
79 print >>options.stderr, join_options.stderr.getvalue()
83 class InviteOptions(BasedirOptions):
85 synopsis = "MAGIC_ALIAS: NICKNAME"
87 def parseArgs(self, alias, nickname=None):
88 BasedirOptions.parseArgs(self)
89 alias = argv_to_unicode(alias)
90 if not alias.endswith(u':'):
91 raise usage.UsageError("An alias must end with a ':' character.")
92 self.alias = alias[:-1]
93 self.nickname = argv_to_unicode(nickname)
94 node_url_file = os.path.join(self['node-directory'], u"node.url")
95 self['node-url'] = open(node_url_file, "r").read().strip()
96 aliases = get_aliases(self['node-directory'])
97 self.aliases = aliases
100 precondition(isinstance(options.alias, unicode), alias=options.alias)
101 precondition(isinstance(options.nickname, unicode), nickname=options.nickname)
103 from allmydata.scripts import tahoe_mkdir
104 mkdir_options = _delegate_options(options, MakeDirectoryOptions())
105 mkdir_options.where = None
107 rc = tahoe_mkdir.mkdir(mkdir_options)
109 print >>options.stderr, "magic-folder: failed to mkdir\n"
112 # FIXME this assumes caps are ASCII.
113 dmd_write_cap = mkdir_options.stdout.getvalue().strip()
114 dmd_readonly_cap = uri.from_string(dmd_write_cap).get_readonly().to_string()
115 if dmd_readonly_cap is None:
116 print >>options.stderr, "magic-folder: failed to diminish dmd write cap\n"
119 magic_write_cap = get_aliases(options["node-directory"])[options.alias]
120 magic_readonly_cap = uri.from_string(magic_write_cap).get_readonly().to_string()
122 # tahoe ln CLIENT_READCAP COLLECTIVE_WRITECAP/NICKNAME
123 ln_options = _delegate_options(options, LnOptions())
124 ln_options.from_file = unicode(dmd_readonly_cap, 'utf-8')
125 ln_options.to_file = u"%s/%s" % (unicode(magic_write_cap, 'utf-8'), options.nickname)
126 rc = tahoe_mv.mv(ln_options, mode="link")
128 print >>options.stderr, "magic-folder: failed to create link\n"
129 print >>options.stderr, ln_options.stderr.getvalue()
132 # FIXME: this assumes caps are ASCII.
133 print >>options.stdout, "%s%s%s" % (magic_readonly_cap, INVITE_SEPARATOR, dmd_write_cap)
136 class JoinOptions(BasedirOptions):
137 synopsis = "INVITE_CODE LOCAL_DIR"
139 magic_readonly_cap = ""
140 def parseArgs(self, invite_code, local_dir):
141 BasedirOptions.parseArgs(self)
143 # Expand the path relative to the current directory of the CLI command, not the node.
144 self.local_dir = None if local_dir is None else argv_to_abspath(local_dir, long_path=False)
145 self.invite_code = to_str(argv_to_unicode(invite_code))
148 fields = options.invite_code.split(INVITE_SEPARATOR)
150 raise usage.UsageError("Invalid invite code.")
151 magic_readonly_cap, dmd_write_cap = fields
153 dmd_cap_file = os.path.join(options["node-directory"], u"private", u"magic_folder_dircap")
154 collective_readcap_file = os.path.join(options["node-directory"], u"private", u"collective_dircap")
156 fileutil.write(dmd_cap_file, dmd_write_cap)
157 fileutil.write(collective_readcap_file, magic_readonly_cap)
159 # FIXME: modify any existing [magic_folder] fields, rather than appending.
160 fileutil.write(os.path.join(options["node-directory"], u"tahoe.cfg"),
161 "[magic_folder]\nenabled = True\nlocal.directory = %s\n"
162 % (options.local_dir.encode('utf-8'),), mode="ab")
165 class MagicFolderCommand(BaseOptions):
167 ["create", None, CreateOptions, "Create a Magic Folder."],
168 ["invite", None, InviteOptions, "Invite someone to a Magic Folder."],
169 ["join", None, JoinOptions, "Join a Magic Folder."],
171 def postOptions(self):
172 if not hasattr(self, 'subOptions'):
173 raise usage.UsageError("must specify a subcommand")
174 def getSynopsis(self):
175 return "Usage: tahoe [global-options] magic SUBCOMMAND"
176 def getUsage(self, width=None):
177 t = BaseOptions.getUsage(self, width)
179 Please run e.g. 'tahoe magic-folder create --help' for more details on each
190 def do_magic_folder(options):
191 so = options.subOptions
192 so.stdout = options.stdout
193 so.stderr = options.stderr
194 f = subDispatch[options.subCommand]
198 ["magic-folder", None, MagicFolderCommand,
199 "Magic Folder subcommands: use 'tahoe magic-folder' for a list."],
203 "magic-folder": do_magic_folder,