]> git.rkrishnan.org Git - tahoe-lafs/tahoe-lafs.git/blobdiff - src/allmydata/scripts/magic_folder_cli.py
Improve the error reporting for 'tahoe magic-folder join/leave'. refs #2568
[tahoe-lafs/tahoe-lafs.git] / src / allmydata / scripts / magic_folder_cli.py
index a82e677b5ef35a7bcbc974e362554b4c85f7beeb..e15176d1287e55ac6f8e8d9982764c497028696d 100644 (file)
@@ -1,12 +1,17 @@
 
 import os
+from types import NoneType
 from cStringIO import StringIO
+
 from twisted.python import usage
 
+from allmydata.util.assertutil import precondition
+
 from .common import BaseOptions, BasedirOptions, get_aliases
 from .cli import MakeDirectoryOptions, LnOptions, CreateAliasOptions
 import tahoe_mv
-from allmydata.util.encodingutil import argv_to_abspath
+from allmydata.util.encodingutil import argv_to_abspath, argv_to_unicode, to_str, \
+    quote_local_unicode_path
 from allmydata.util import fileutil
 from allmydata import uri
 
@@ -14,18 +19,22 @@ INVITE_SEPARATOR = "+"
 
 class CreateOptions(BasedirOptions):
     nickname = None
-    localdir = None
-    synopsis = "MAGIC_ALIAS: [NICKNAME LOCALDIR]"
-    def parseArgs(self, alias, nickname=None, localdir=None):
+    local_dir = None
+    synopsis = "MAGIC_ALIAS: [NICKNAME LOCAL_DIR]"
+    def parseArgs(self, alias, nickname=None, local_dir=None):
         BasedirOptions.parseArgs(self)
-        if not alias.endswith(':'):
+        alias = argv_to_unicode(alias)
+        if not alias.endswith(u':'):
             raise usage.UsageError("An alias must end with a ':' character.")
         self.alias = alias[:-1]
-        self.nickname = nickname
-        self.localdir = argv_to_abspath(str(localdir))
-        if self.nickname and not self.localdir:
-            raise usage.UsageError("If NICKNAME is specified then LOCALDIR must also be specified.")
-        node_url_file = os.path.join(self['node-directory'], "node.url")
+        self.nickname = None if nickname is None else argv_to_unicode(nickname)
+
+        # Expand the path relative to the current directory of the CLI command, not the node.
+        self.local_dir = None if local_dir is None else argv_to_abspath(local_dir, long_path=False)
+
+        if self.nickname and not self.local_dir:
+            raise usage.UsageError("If NICKNAME is specified then LOCAL_DIR must also be specified.")
+        node_url_file = os.path.join(self['node-directory'], u"node.url")
         self['node-url'] = fileutil.read(node_url_file).strip()
 
 def _delegate_options(source_options, target_options):
@@ -38,6 +47,10 @@ def _delegate_options(source_options, target_options):
     return target_options
 
 def create(options):
+    precondition(isinstance(options.alias, unicode), alias=options.alias)
+    precondition(isinstance(options.nickname, (unicode, NoneType)), nickname=options.nickname)
+    precondition(isinstance(options.local_dir, (unicode, NoneType)), local_dir=options.local_dir)
+
     from allmydata.scripts import tahoe_add_alias
     create_alias_options = _delegate_options(options, CreateAliasOptions())
     create_alias_options.alias = options.alias
@@ -59,12 +72,8 @@ def create(options):
             return rc
         invite_code = invite_options.stdout.getvalue().strip()
         join_options = _delegate_options(options, JoinOptions())
+        join_options.local_dir = options.local_dir
         join_options.invite_code = invite_code
-        fields = invite_code.split(INVITE_SEPARATOR)
-        if len(fields) != 2:
-            raise usage.UsageError("Invalid invite code.")
-        join_options.magic_readonly_cap, join_options.dmd_write_cap = fields
-        join_options.local_dir = options.localdir
         rc = join(join_options)
         if rc != 0:
             print >>options.stderr, "magic-folder: failed to join after create\n"
@@ -78,16 +87,20 @@ class InviteOptions(BasedirOptions):
     stdin = StringIO("")
     def parseArgs(self, alias, nickname=None):
         BasedirOptions.parseArgs(self)
-        if not alias.endswith(':'):
+        alias = argv_to_unicode(alias)
+        if not alias.endswith(u':'):
             raise usage.UsageError("An alias must end with a ':' character.")
         self.alias = alias[:-1]
-        self.nickname = nickname
-        node_url_file = os.path.join(self['node-directory'], "node.url")
+        self.nickname = argv_to_unicode(nickname)
+        node_url_file = os.path.join(self['node-directory'], u"node.url")
         self['node-url'] = open(node_url_file, "r").read().strip()
         aliases = get_aliases(self['node-directory'])
         self.aliases = aliases
 
 def invite(options):
+    precondition(isinstance(options.alias, unicode), alias=options.alias)
+    precondition(isinstance(options.nickname, unicode), nickname=options.nickname)
+
     from allmydata.scripts import tahoe_mkdir
     mkdir_options = _delegate_options(options, MakeDirectoryOptions())
     mkdir_options.where = None
@@ -96,24 +109,28 @@ def invite(options):
     if rc != 0:
         print >>options.stderr, "magic-folder: failed to mkdir\n"
         return rc
+
+    # FIXME this assumes caps are ASCII.
     dmd_write_cap = mkdir_options.stdout.getvalue().strip()
-    dmd_readonly_cap = unicode(uri.from_string(dmd_write_cap).get_readonly().to_string(), 'utf-8')
+    dmd_readonly_cap = uri.from_string(dmd_write_cap).get_readonly().to_string()
     if dmd_readonly_cap is None:
         print >>options.stderr, "magic-folder: failed to diminish dmd write cap\n"
         return 1
 
     magic_write_cap = get_aliases(options["node-directory"])[options.alias]
-    magic_readonly_cap = unicode(uri.from_string(magic_write_cap).get_readonly().to_string(), 'utf-8')
+    magic_readonly_cap = uri.from_string(magic_write_cap).get_readonly().to_string()
+
     # tahoe ln CLIENT_READCAP COLLECTIVE_WRITECAP/NICKNAME
     ln_options = _delegate_options(options, LnOptions())
-    ln_options.from_file = dmd_readonly_cap
-    ln_options.to_file = u"%s/%s" % (magic_write_cap, options.nickname)
+    ln_options.from_file = unicode(dmd_readonly_cap, 'utf-8')
+    ln_options.to_file = u"%s/%s" % (unicode(magic_write_cap, 'utf-8'), options.nickname)
     rc = tahoe_mv.mv(ln_options, mode="link")
     if rc != 0:
         print >>options.stderr, "magic-folder: failed to create link\n"
         print >>options.stderr, ln_options.stderr.getvalue()
         return rc
 
+    # FIXME: this assumes caps are ASCII.
     print >>options.stdout, "%s%s%s" % (magic_readonly_cap, INVITE_SEPARATOR, dmd_write_cap)
     return 0
 
@@ -121,32 +138,71 @@ class JoinOptions(BasedirOptions):
     synopsis = "INVITE_CODE LOCAL_DIR"
     dmd_write_cap = ""
     magic_readonly_cap = ""
-    def parseInvite(self, invite_code, local_dir):
-        self.local_dir = argv_to_abspath(str(local_dir))
-        fields = invite_code.split(INVITE_SEPARATOR)
-        if len(fields) != 2:
-            raise usage.UsageError("Invalid invite code.")
-        self.magic_readonly_cap, self.dmd_write_cap = fields
     def parseArgs(self, invite_code, local_dir):
         BasedirOptions.parseArgs(self)
-        self.parseInvite(invite_code, local_dir)
+
+        # Expand the path relative to the current directory of the CLI command, not the node.
+        self.local_dir = None if local_dir is None else argv_to_abspath(local_dir, long_path=False)
+        self.invite_code = to_str(argv_to_unicode(invite_code))
 
 def join(options):
-    dmd_cap_file = os.path.join(options["node-directory"], "private/magic_folder_dircap")
-    collective_readcap_file = os.path.join(options["node-directory"], "private/collective_dircap")
+    fields = options.invite_code.split(INVITE_SEPARATOR)
+    if len(fields) != 2:
+        raise usage.UsageError("Invalid invite code.")
+    magic_readonly_cap, dmd_write_cap = fields
+
+    dmd_cap_file = os.path.join(options["node-directory"], u"private", u"magic_folder_dircap")
+    collective_readcap_file = os.path.join(options["node-directory"], u"private", u"collective_dircap")
+    magic_folder_db_file = os.path.join(options["node-directory"], u"private", u"magicfolderdb.sqlite")
+
+    if os.path.exists(dmd_cap_file) or os.path.exists(collective_readcap_file) or os.path.exists(magic_folder_db_file):
+        print >>options.stderr, ("\nThis client has already joined a magic folder."
+                                 "\nUse the 'tahoe magic-folder leave' command first.\n")
+        return 1
 
-    fileutil.write(dmd_cap_file, options.dmd_write_cap)
-    fileutil.write(collective_readcap_file, options.magic_readonly_cap)
-    fileutil.write(os.path.join(options["node-directory"], "tahoe.cfg"),
+    fileutil.write(dmd_cap_file, dmd_write_cap)
+    fileutil.write(collective_readcap_file, magic_readonly_cap)
+
+    # FIXME: modify any existing [magic_folder] fields, rather than appending.
+    fileutil.write(os.path.join(options["node-directory"], u"tahoe.cfg"),
                    "[magic_folder]\nenabled = True\nlocal.directory = %s\n"
                    % (options.local_dir.encode('utf-8'),), mode="ab")
     return 0
 
+class LeaveOptions(BasedirOptions):
+    synopsis = ""
+    def parseArgs(self):
+        BasedirOptions.parseArgs(self)
+
+def leave(options):
+    from ConfigParser import SafeConfigParser
+
+    dmd_cap_file = os.path.join(options["node-directory"], u"private", u"magic_folder_dircap")
+    collective_readcap_file = os.path.join(options["node-directory"], u"private", u"collective_dircap")
+    magic_folder_db_file = os.path.join(options["node-directory"], u"private", u"magicfolderdb.sqlite")
+
+    parser = SafeConfigParser()
+    parser.read(os.path.join(options["node-directory"], u"tahoe.cfg"))
+    parser.remove_section("magic_folder")
+    f = open(os.path.join(options["node-directory"], u"tahoe.cfg"), "w")
+    parser.write(f)
+    f.close()
+
+    for f in [dmd_cap_file, collective_readcap_file, magic_folder_db_file]:
+        try:
+            fileutil.remove(f)
+        except Exception as e:
+            print >>options.stderr, ("Warning: unable to remove %s due to %s: %s"
+                % (quote_local_unicode_path(f), e.__class__.__name__, str(e)))
+
+    return 0
+
 class MagicFolderCommand(BaseOptions):
     subCommands = [
         ["create", None, CreateOptions, "Create a Magic Folder."],
         ["invite", None, InviteOptions, "Invite someone to a Magic Folder."],
         ["join", None, JoinOptions, "Join a Magic Folder."],
+        ["leave", None, LeaveOptions, "Leave a Magic Folder."],
     ]
     def postOptions(self):
         if not hasattr(self, 'subOptions'):
@@ -165,6 +221,7 @@ subDispatch = {
     "create": create,
     "invite": invite,
     "join": join,
+    "leave": leave,
 }
 
 def do_magic_folder(options):