]> git.ozlabs.org Git - patchwork/blobdiff - apps/patchwork/bin/pwclient
pwclient: allow multiple IDs
[patchwork] / apps / patchwork / bin / pwclient
index b91a4b7b2d52586772c4048c4744b8d930a26141..bd79b3a601de9d5834fea1bf424a0228bb428333 100755 (executable)
@@ -106,36 +106,6 @@ class BasicHTTPAuthTransport(xmlrpclib.SafeTransport):
             fn = xmlrpclib.Transport.make_connection
         return fn(self, host)
 
-def usage():
-    sys.stderr.write("Usage: %s <action> [options]\n\n" % \
-                        (os.path.basename(sys.argv[0])))
-    sys.stderr.write("Where <action> is one of:\n")
-    sys.stderr.write(
-"""        apply <ID>    : Apply a patch (in the current dir, using -p1)
-        git-am <ID>   : Apply a patch to current git branch using "git am"
-        get <ID>      : Download a patch and save it locally
-        info <ID>     : Display patchwork info about a given patch ID
-        projects      : List all projects
-        states        : Show list of potential patch states
-        list [str]    : List patches, using the optional filters specified
-                        below and an optional substring to search for patches
-                        by name
-        search [str]  : Same as 'list'
-        view <ID>     : View a patch
-        update [-s state] [-c commit-ref] <ID>
-                      : Update patch\n""")
-    sys.stderr.write("""\nFilter options for 'list' and 'search':
-        -s <state>    : Filter by patch state (e.g., 'New', 'Accepted', etc.)
-        -p <project>  : Filter by project name (see 'projects' for list)
-        -w <who>      : Filter by submitter (name, e-mail substring search)
-        -d <who>      : Filter by delegate (name, e-mail substring search)
-        -n <max #>    : Restrict number of results
-        -m <messageid>: Filter by Message-Id\n""")
-    sys.stderr.write("""\nActions that take an ID argument can also be \
-invoked with:
-        -h <hash>     : Lookup by patch hash\n""")
-    sys.exit(1)
-
 def project_id_by_name(rpc, linkname):
     """Given a project short name, look up the Project ID."""
     if len(linkname) == 0:
@@ -322,9 +292,17 @@ def patch_id_from_hash(rpc, project, hash):
         patch = rpc.patch_get_by_hash(hash)
 
     if patch == {}:
-        return None
+        sys.stderr.write("No patch has the hash provided\n")
+        sys.exit(1)
 
-    return patch['id']
+    patch_id = patch['id']
+    # be super paranoid
+    try:
+        patch_id = int(patch_id)
+    except:
+        sys.stderr.write("Invalid patch ID obtained from server\n")
+        sys.exit(1)
+    return patch_id
 
 auth_actions = ['update']
 
@@ -353,13 +331,12 @@ class _RecursiveHelpAction(argparse._HelpAction):
 
 def main():
     hash_parser = argparse.ArgumentParser(add_help=False, version=False)
-    hash_parser_x = hash_parser.add_mutually_exclusive_group(required=True)
-    hash_parser_x.add_argument(
+    hash_parser.add_argument(
         '-h', metavar='HASH', dest='hash', action='store', required=False,
         help='''Lookup by patch hash'''
     )
-    hash_parser_x.add_argument(
-        'id', metavar='ID', nargs='?', action='store', type=int,
+    hash_parser.add_argument(
+        'id', metavar='ID', nargs='*', action='store', type=int,
         help='Patch ID',
     )
 
@@ -399,7 +376,7 @@ def main():
         add_help=False,
         version=False,
         formatter_class=argparse.RawDescriptionHelpFormatter,
-        epilog='''(apply | get | info | view | update) (-h HASH | ID)''',
+        epilog='''(apply | get | info | view | update) (-h HASH | ID [ID ...])''',
     )
     action_parser.add_argument(
         '--help',
@@ -417,11 +394,13 @@ def main():
         add_help=False,
         help='''Apply a patch (in the current dir, using -p1)'''
     )
+    apply_parser.set_defaults(subcmd='apply')
     git_am_parser = subparsers.add_parser(
         'git-am', parents=[hash_parser],
         add_help=False,
         help='''Apply a patch to current git branch using "git am".'''
     )
+    git_am_parser.set_defaults(subcmd='git-am')
     git_am_parser.add_argument(
         '-s', '--signoff',
         action='store_true',
@@ -432,31 +411,38 @@ def main():
         add_help=False,
         help='''Download a patch and save it locally'''
     )
+    get_parser.set_defaults(subcmd='get')
     info_parser = subparsers.add_parser(
         'info', parents=[hash_parser],
         add_help=False,
         help='''Display patchwork info about a given patch ID'''
     )
+    info_parser.set_defaults(subcmd='info')
     projects_parser = subparsers.add_parser(
         'projects',
         add_help=False,
         help='''List all projects'''
     )
+    projects_parser.set_defaults(subcmd='projects')
     states_parser = subparsers.add_parser(
         'states',
         add_help=False,
         help='''Show list of potential patch states'''
     )
+    states_parser.set_defaults(subcmd='states')
     view_parser = subparsers.add_parser(
         'view', parents=[hash_parser],
         add_help=False,
         help='''View a patch'''
     )
+    view_parser.set_defaults(subcmd='view')
     update_parser = subparsers.add_parser(
         'update', parents=[hash_parser],
         add_help=False,
-        help='''Update patch'''
+        help='''Update patch''',
+        epilog='''Using a COMMIT-REF allows for only one ID to be specified''',
     )
+    update_parser.set_defaults(subcmd='update')
     update_parser.add_argument(
         '-c', metavar='COMMIT-REF',
         help='''commit reference hash'''
@@ -475,18 +461,25 @@ def main():
         below and an optional substring to search for patches
         by name'''
     )
+    list_parser.set_defaults(subcmd='list')
     search_parser = subparsers.add_parser("search",
         add_help=False,
         parents=[filter_parser],
         help='''Alias for "list"'''
     )
+    search_parser.set_defaults(subcmd='list')
     if len(sys.argv) < 2:
         action_parser.print_help()
         sys.exit(0)
 
     args = action_parser.parse_args()
+    args=dict(vars(args))
 
-    action = sys.argv[1].lower()
+    if args.get('hash') and len(args.get('id')):
+        # mimic mutual exclusive group
+        sys.stderr.write("[-h HASH] and [ID [ID ...]] are mutually exlusive!\n")
+        action_parser.print_help()
+        sys.exit(1)
 
     # set defaults
     filt = Filter()
@@ -495,12 +488,13 @@ def main():
     project_str = ""
     commit_str = ""
     state_str = ""
-    hash_str = ""
+    hash_str = None
     msgid_str = ""
-    id_str = None
+    patch_ids = None
     url = DEFAULT_URL
 
-    args=dict(vars(args))
+    action = args.get('subcmd')
+
     if args.get('s'):
         state_str = args.get('s')
     if args.get('p'):
@@ -509,12 +503,17 @@ def main():
         submitter_str = args.get('w')
     if args.get('d'):
         delegate_str = args.get('d')
-    if args.get('c'):
-        commit_str = args.get('c')
     if args.get('hash'):
         hash_str = args.get('hash')
     if args.get('id'):
-        id_str = args.get('id')
+        patch_ids = frozenset(args.get('id'))
+    if args.get('c'):
+        # update multiple IDs with a single commit-hash does not make sense
+        if action == 'update' and patch_ids and len(patch_ids) > 1:
+            sys.stderr.write("Declining update with COMMIT-REF on multiple IDs\n")
+            update_parser.print_help()
+            sys.exit(1)
+        commit_str = args.get('c')
     if args.get('m'):
         msgid_str = args.get('m')
     if args.get('n') != None:
@@ -525,6 +524,8 @@ def main():
             action_parser.print_help()
             sys.exit(1)
 
+    do_signoff = args.get('signoff')
+
     # grab settings from config files
     config = ConfigParser.ConfigParser()
     config.read([CONFIG_FILE])
@@ -563,7 +564,8 @@ def main():
             project_str = config.get('options', 'default')
         except:
             sys.stderr.write("No default project configured in ~/.pwclientrc\n")
-            usage()
+            action_parser.print_help()
+            sys.exit(1)
 
     if not config.has_section(project_str):
         sys.stderr.write("No section for project %s\n" % project_str)
@@ -572,6 +574,10 @@ def main():
     if not config.has_option(project_str, 'url'):
         sys.stderr.write("No URL for project %s\n" % project_str)
         sys.exit(1)
+    if not do_signoff and config.has_option('options', 'signoff'):
+        do_signoff = config.getboolean('options', 'signoff')
+    if not do_signoff and config.has_option(project_str, 'signoff'):
+        do_signoff = config.getboolean(project_str, 'signoff')
 
     url = config.get(project_str, 'url')
 
@@ -608,12 +614,9 @@ def main():
         sys.stderr.write("Unable to connect to %s\n" % url)
         sys.exit(1)
 
-    patch_id = None
-    if hash_str:
-        patch_id = patch_id_from_hash(rpc, project_str, hash_str)
-        if patch_id is None:
-            sys.stderr.write("No patch has the hash provided\n")
-            sys.exit(1)
+    # It should be safe to assume hash_str is not zero, but who knows..
+    if hash_str != None:
+        patch_ids = [patch_id_from_hash(rpc, project_str, hash_str)]
 
     if action == 'list' or action == 'search':
         if args.get('patch_name') != None:
@@ -627,62 +630,34 @@ def main():
         action_states(rpc)
 
     elif action == 'view':
-        try:
-            patch_id = patch_id or int(id_str)
-        except:
-            sys.stderr.write("Invalid patch ID given\n")
-            sys.exit(1)
-
-        s = rpc.patch_get_mbox(patch_id)
-        if len(s) > 0:
-            print unicode(s).encode("utf-8")
+        for patch_id in patch_ids:
+            s = rpc.patch_get_mbox(patch_id)
+            if len(s) > 0:
+                print unicode(s).encode("utf-8")
 
     elif action in ('get', 'save', 'info'):
-        try:
-            patch_id = patch_id or int(id_str)
-        except:
-            sys.stderr.write("Invalid patch ID given\n")
-            sys.exit(1)
-
         if action == 'info':
-            action_info(rpc, patch_id)
+            [action_info(rpc, patch_id) for patch_id in patch_ids]
         else:
-            action_get(rpc, patch_id)
+            [action_get(rpc, patch_id) for patch_id in patch_ids]
 
     elif action == 'apply':
-        try:
-            patch_id = patch_id or int(id_str)
-        except:
-            sys.stderr.write("Invalid patch ID given\n")
-            sys.exit(1)
-
-        action_apply(rpc, patch_id)
+        [action_apply(rpc, patch_id) for patch_id in patch_ids]
 
     elif action == 'git-am':
-        try:
-            patch_id = patch_id or int(id_str)
-        except:
-            sys.stderr.write("Invalid patch ID given\n")
-            sys.exit(1)
-
         cmd = ['git', 'am']
-        if args.get('signoff'):
+        if do_signoff:
             cmd.append('-s')
-        action_apply(rpc, patch_id, cmd)
+        [action_apply(rpc, patch_id, cmd) for patch_id in patch_ids]
 
     elif action == 'update':
-        try:
-            patch_id = patch_id or int(id_str)
-        except:
-            sys.stderr.write("Invalid patch ID given\n")
-            sys.exit(1)
-
-        action_update_patch(rpc, patch_id, state = state_str,
-                commit = commit_str)
+        [action_update_patch(rpc, patch_id, state = state_str,
+                commit = commit_str) for patch_id in patch_ids]
 
     else:
         sys.stderr.write("Unknown action '%s'\n" % action)
-        usage()
+        action_parser.print_help()
+        sys.exit(1)
 
 if __name__ == "__main__":
     main()