3 # Patchwork command line client
4 # Copyright (C) 2008 Nate Case <ncase@xes-inc.com>
6 # This file is part of the Patchwork package.
8 # Patchwork is free software; you can redistribute it and/or modify
9 # it under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 2 of the License, or
11 # (at your option) any later version.
13 # Patchwork is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with Patchwork; if not, write to the Free Software
20 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
33 # Default Patchwork remote XML-RPC server URL
34 # This script will check the PW_XMLRPC_URL environment variable
35 # for the URL to access. If that is unspecified, it will fallback to
36 # the hardcoded default value specified here.
37 DEFAULT_URL = "http://patchwork/xmlrpc/"
38 CONFIG_FILE = os.path.expanduser('~/.pwclientrc')
41 """Filter for selecting patches."""
43 # These fields refer to specific objects, so they are special
44 # because we have to resolve them to IDs before passing the
45 # filter to the server
49 # The dictionary that gets passed to via XML-RPC
52 def add(self, field, value):
55 elif field == 'project':
61 def resolve_ids(self, rpc):
62 """Resolve State, Project, and Person IDs based on filter strings."""
64 id = state_id_by_name(rpc, self.state)
66 sys.stderr.write("Note: No State found matching %s*, " \
67 "ignoring filter\n" % self.state)
69 self.d['state_id'] = id
71 if self.project != None:
72 id = project_id_by_name(rpc, self.project)
74 sys.stderr.write("Note: No Project found matching %s, " \
75 "ignoring filter\n" % self.project)
77 self.d['project_id'] = id
80 """Return human-readable description of the filter."""
83 class BasicHTTPAuthTransport(xmlrpclib.SafeTransport):
85 def __init__(self, username = None, password = None, use_https = False):
86 self.username = username
87 self.password = password
88 self.use_https = use_https
89 xmlrpclib.SafeTransport.__init__(self)
91 def authenticated(self):
92 return self.username != None and self.password != None
94 def send_host(self, connection, host):
95 xmlrpclib.Transport.send_host(self, connection, host)
96 if not self.authenticated():
98 credentials = '%s:%s' % (self.username, self.password)
99 auth = 'Basic ' + base64.encodestring(credentials).strip()
100 connection.putheader('Authorization', auth)
102 def make_connection(self, host):
104 fn = xmlrpclib.SafeTransport.make_connection
106 fn = xmlrpclib.Transport.make_connection
107 return fn(self, host)
109 def project_id_by_name(rpc, linkname):
110 """Given a project short name, look up the Project ID."""
111 if len(linkname) == 0:
113 projects = rpc.project_list(linkname, 0)
114 for project in projects:
115 if project['linkname'] == linkname:
119 def state_id_by_name(rpc, name):
120 """Given a partial state name, look up the state ID."""
123 states = rpc.state_list(name, 0)
125 if state['name'].lower().startswith(name.lower()):
129 def person_ids_by_name(rpc, name):
130 """Given a partial name or email address, return a list of the
131 person IDs that match."""
134 people = rpc.person_list(name, 0)
135 return map(lambda x: x['id'], people)
137 def list_patches(patches):
138 """Dump a list of patches to stdout."""
139 print("%-7s %-12s %s" % ("ID", "State", "Name"))
140 print("%-7s %-12s %s" % ("--", "-----", "----"))
141 for patch in patches:
142 print("%-7d %-12s %s" % (patch['id'], patch['state'], patch['name']))
144 def action_list(rpc, filter, submitter_str, delegate_str):
145 filter.resolve_ids(rpc)
147 if submitter_str != None:
148 ids = person_ids_by_name(rpc, submitter_str)
150 sys.stderr.write("Note: Nobody found matching *%s*\n" % \
154 person = rpc.person_get(id)
155 print "Patches submitted by %s <%s>:" % \
156 (unicode(person['name']).encode("utf-8"), \
157 unicode(person['email']).encode("utf-8"))
159 f.add("submitter_id", id)
160 patches = rpc.patch_list(f.d)
161 list_patches(patches)
164 if delegate_str != None:
165 ids = person_ids_by_name(rpc, delegate_str)
167 sys.stderr.write("Note: Nobody found matching *%s*\n" % \
171 person = rpc.person_get(id)
172 print "Patches delegated to %s <%s>:" % \
173 (person['name'], person['email'])
175 f.add("delegate_id", id)
176 patches = rpc.patch_list(f.d)
177 list_patches(patches)
180 patches = rpc.patch_list(filter.d)
181 list_patches(patches)
183 def action_projects(rpc):
184 projects = rpc.project_list("", 0)
185 print("%-5s %-24s %s" % ("ID", "Name", "Description"))
186 print("%-5s %-24s %s" % ("--", "----", "-----------"))
187 for project in projects:
188 print("%-5d %-24s %s" % (project['id'], \
189 project['linkname'], \
192 def action_states(rpc):
193 states = rpc.state_list("", 0)
194 print("%-5s %s" % ("ID", "Name"))
195 print("%-5s %s" % ("--", "----"))
197 print("%-5d %s" % (state['id'], state['name']))
199 def action_info(rpc, patch_id):
200 patch = rpc.patch_get(patch_id)
201 s = "Information for patch id %d" % (patch_id)
204 for key, value in sorted(patch.iteritems()):
205 print("- %- 14s: %s" % (key, unicode(value).encode("utf-8")))
207 def action_get(rpc, patch_id):
208 patch = rpc.patch_get(patch_id)
209 s = rpc.patch_get_mbox(patch_id)
211 if patch == {} or len(s) == 0:
212 sys.stderr.write("Unable to get patch %d\n" % patch_id)
215 base_fname = fname = os.path.basename(patch['filename'])
217 while os.path.exists(fname):
218 fname = "%s.%d" % (base_fname, i)
224 sys.stderr.write("Unable to open %s for writing\n" % fname)
228 f.write(unicode(s).encode("utf-8"))
230 print "Saved patch to %s" % fname
232 sys.stderr.write("Failed to write to %s\n" % fname)
235 def action_apply(rpc, patch_id, apply_cmd=None):
236 patch = rpc.patch_get(patch_id)
238 sys.stderr.write("Error getting information on patch ID %d\n" % \
242 if apply_cmd is None:
243 print "Applying patch #%d to current directory" % patch_id
244 apply_cmd = ['patch', '-p1']
246 print "Applying patch #%d using %s" % (
247 patch_id, repr(' '.join(apply_cmd)))
249 print "Description: %s" % patch['name']
250 s = rpc.patch_get_mbox(patch_id)
252 proc = subprocess.Popen(apply_cmd, stdin = subprocess.PIPE)
253 proc.communicate(unicode(s).encode('utf-8'))
255 sys.stderr.write("Error: No patch content found\n")
258 def action_update_patch(rpc, patch_id, state = None, commit = None):
259 patch = rpc.patch_get(patch_id)
261 sys.stderr.write("Error getting information on patch ID %d\n" % \
268 state_id = state_id_by_name(rpc, state)
270 sys.stderr.write("Error: No State found matching %s*\n" % state)
272 params['state'] = state_id
275 params['commit_ref'] = commit
279 success = rpc.patch_set(patch_id, params)
280 except xmlrpclib.Fault, f:
281 sys.stderr.write("Error updating patch: %s\n" % f.faultString)
284 sys.stderr.write("Patch not updated\n")
286 def patch_id_from_hash(rpc, project, hash):
288 patch = rpc.patch_get_by_project_hash(project, hash)
289 except xmlrpclib.Fault:
290 # the server may not have the newer patch_get_by_project_hash function,
291 # so fall back to hash-only.
292 patch = rpc.patch_get_by_hash(hash)
295 sys.stderr.write("No patch has the hash provided\n")
298 patch_id = patch['id']
301 patch_id = int(patch_id)
303 sys.stderr.write("Invalid patch ID obtained from server\n")
307 auth_actions = ['update']
309 # unfortunately we currently have to revert to this ugly hack..
310 class _RecursiveHelpAction(argparse._HelpAction):
312 def __call__(self, parser, namespace, values, option_string=None):
316 subparsers_actions = [
317 action for action in parser._actions
318 if isinstance(action, argparse._SubParsersAction)
320 hash_n_id_actions = set(['hash', 'id', 'help'])
321 for subparsers_action in subparsers_actions:
322 for choice, subparser in subparsers_action.choices.items():
323 # gross but the whole thing is..
324 if (len(subparser._actions) == 3 \
325 and set([a.dest for a in subparser._actions]) \
326 == hash_n_id_actions) \
327 or len(subparser._actions) == 0:
329 print("command '{}'".format(choice))
330 print(subparser.format_help())
335 hash_parser = argparse.ArgumentParser(add_help=False, version=False)
336 hash_parser.add_argument(
337 '-h', metavar='HASH', dest='hash', action='store',
338 help='''Lookup by patch hash'''
340 hash_parser.add_argument(
341 'id', metavar='ID', nargs='*', action='store', type=int,
345 filter_parser = argparse.ArgumentParser(add_help=False, version=False)
346 filter_parser.add_argument(
347 '-s', metavar='STATE',
348 help='''Filter by patch state (e.g., 'New', 'Accepted', etc.)'''
350 filter_parser.add_argument(
351 '-p', metavar='PROJECT',
352 help='''Filter by project name (see 'projects' for list)'''
354 filter_parser.add_argument(
356 help='''Filter by submitter (name, e-mail substring search)'''
358 filter_parser.add_argument(
360 help='''Filter by delegate (name, e-mail substring search)'''
362 filter_parser.add_argument(
363 '-n', metavar='MAX#',
365 help='''Restrict number of results'''
367 filter_parser.add_argument(
368 '-m', metavar='MESSAGEID',
369 help='''Filter by Message-Id'''
371 filter_parser.add_argument(
372 'patch_name', metavar='STR', nargs='?',
373 help='substring to search for patches by name',
375 help_parser = argparse.ArgumentParser(add_help=False, version=False)
376 help_parser.add_argument(
377 '--help', action='help', help=argparse.SUPPRESS,
378 #help='''show this help message and exit'''
381 action_parser = argparse.ArgumentParser(
385 formatter_class=argparse.RawDescriptionHelpFormatter,
386 epilog='''(apply | get | info | view | update) (-h HASH | ID [ID ...])''',
388 action_parser.add_argument(
391 action=_RecursiveHelpAction,
392 help='''Print this help text'''
395 subparsers = action_parser.add_subparsers(
399 apply_parser = subparsers.add_parser(
400 'apply', parents=[hash_parser, help_parser],
402 help='''Apply a patch (in the current dir, using -p1)'''
404 apply_parser.set_defaults(subcmd='apply')
405 git_am_parser = subparsers.add_parser(
406 'git-am', parents=[hash_parser, help_parser],
408 help='''Apply a patch to current git branch using "git am".'''
410 git_am_parser.set_defaults(subcmd='git_am')
411 git_am_parser.add_argument(
414 help='''pass --signoff to git-am'''
416 get_parser = subparsers.add_parser(
417 'get', parents=[hash_parser, help_parser],
419 help='''Download a patch and save it locally'''
421 get_parser.set_defaults(subcmd='get')
422 info_parser = subparsers.add_parser(
423 'info', parents=[hash_parser, help_parser],
425 help='''Display patchwork info about a given patch ID'''
427 info_parser.set_defaults(subcmd='info')
428 projects_parser = subparsers.add_parser(
431 help='''List all projects'''
433 projects_parser.set_defaults(subcmd='projects')
434 states_parser = subparsers.add_parser(
437 help='''Show list of potential patch states'''
439 states_parser.set_defaults(subcmd='states')
440 view_parser = subparsers.add_parser(
441 'view', parents=[hash_parser, help_parser],
443 help='''View a patch'''
445 view_parser.set_defaults(subcmd='view')
446 update_parser = subparsers.add_parser(
447 'update', parents=[hash_parser, help_parser],
449 help='''Update patch''',
450 epilog='''Using a COMMIT-REF allows for only one ID to be specified''',
452 update_parser.add_argument(
453 '-c', metavar='COMMIT-REF',
454 help='''commit reference hash'''
456 update_parser.add_argument(
457 '-s', metavar='STATE',
459 help='''Set patch state (e.g., 'Accepted', 'Superseded' etc.)'''
461 update_parser.set_defaults(subcmd='update')
462 list_parser = subparsers.add_parser("list",
465 parents=[filter_parser, help_parser],
466 help='''List patches, using the optional filters specified
467 below and an optional substring to search for patches
470 list_parser.set_defaults(subcmd='list')
471 search_parser = subparsers.add_parser("search",
473 parents=[filter_parser, help_parser],
474 help='''Alias for "list"'''
476 # Poor man's argparse aliases:
477 # We register the "search" parser but effectively use "list" for the
479 search_parser.set_defaults(subcmd='list')
480 if len(sys.argv) < 2:
481 action_parser.print_help()
484 args = action_parser.parse_args()
485 args = dict(vars(args))
486 action = args.get('subcmd')
488 if args.get('hash') and len(args.get('id')):
489 # mimic mutual exclusive group
490 sys.stderr.write("Error: [-h HASH] and [ID [ID ...]] " +
491 "are mutually exlusive\n")
492 locals()[action + '_parser'].print_help()
500 state_str = args.get('s')
501 project_str = args.get('p')
502 submitter_str = args.get('w')
503 delegate_str = args.get('d')
504 hash_str = args.get('hash')
505 patch_ids = args.get('id')
506 msgid_str = args.get('m')
508 # update multiple IDs with a single commit-hash does not make sense
509 if action == 'update' and patch_ids and len(patch_ids) > 1:
511 "Declining update with COMMIT-REF on multiple IDs\n"
513 update_parser.print_help()
515 commit_str = args.get('c')
517 if args.get('n') != None:
519 filt.add("max_count", args.get('n'))
521 sys.stderr.write("Invalid maximum count '%s'\n" % args.get('n'))
522 action_parser.print_help()
525 do_signoff = args.get('signoff')
527 # grab settings from config files
528 config = ConfigParser.ConfigParser()
529 config.read([CONFIG_FILE])
531 if not config.has_section('options'):
532 sys.stderr.write('~/.pwclientrc is in the old format. Migrating it...')
534 old_project = config.get('base','project')
536 new_config = ConfigParser.ConfigParser()
537 new_config.add_section('options')
539 new_config.set('options','default',old_project)
540 new_config.add_section(old_project)
542 new_config.set(old_project,'url',config.get('base','url'))
543 if config.has_option('auth', 'username'):
544 new_config.set(old_project,'username',config.get('auth','username'))
545 if config.has_option('auth', 'password'):
546 new_config.set(old_project,'password',config.get('auth','password'))
548 old_config_file = CONFIG_FILE + '.orig'
549 shutil.copy2(CONFIG_FILE,old_config_file)
551 with open(CONFIG_FILE, 'wb') as fd:
554 sys.stderr.write(' Done.\n')
555 sys.stderr.write('Your old ~/.pwclientrc was saved to %s\n' % old_config_file)
556 sys.stderr.write('and was converted to the new format. You may want to\n')
557 sys.stderr.write('inspect it before continuing.\n')
562 project_str = config.get('options', 'default')
564 sys.stderr.write("No default project configured in ~/.pwclientrc\n")
565 action_parser.print_help()
568 if not config.has_section(project_str):
569 sys.stderr.write("No section for project %s\n" % project_str)
571 if not config.has_option(project_str, 'url'):
572 sys.stderr.write("No URL for project %s\n" % project_str)
574 if not do_signoff and config.has_option('options', 'signoff'):
575 do_signoff = config.getboolean('options', 'signoff')
576 if not do_signoff and config.has_option(project_str, 'signoff'):
577 do_signoff = config.getboolean(project_str, 'signoff')
579 url = config.get(project_str, 'url')
581 (username, password) = (None, None)
583 if action in auth_actions:
584 if config.has_option(project_str, 'username') and \
585 config.has_option(project_str, 'password'):
587 use_https = url.startswith('https')
589 transport = BasicHTTPAuthTransport( \
590 config.get(project_str, 'username'),
591 config.get(project_str, 'password'),
595 sys.stderr.write(("The %s action requires authentication, "
596 "but no username or password\nis configured\n") % action)
600 filt.add("project", project_str)
603 filt.add("state", state_str)
606 filt.add("msgid", msgid_str)
609 rpc = xmlrpclib.Server(url, transport = transport)
611 sys.stderr.write("Unable to connect to %s\n" % url)
614 # It should be safe to assume hash_str is not zero, but who knows..
616 patch_ids = [patch_id_from_hash(rpc, project_str, hash_str)]
618 # helper for non_empty() to print correct helptext
619 h = locals()[action + '_parser']
621 # Require either hash_str or IDs for
622 def non_empty(h, patch_ids):
623 """Error out if no patch IDs were specified"""
624 if patch_ids == None or len(patch_ids) < 1:
625 sys.stderr.write("Error: Missing Argument! " +
626 "Either [-h HASH] or [ID [ID ...]] are required\n")
632 if action == 'list' or action == 'search':
633 if args.get('patch_name') != None:
634 filt.add("name__icontains", args.get('patch_name'))
635 action_list(rpc, filt, submitter_str, delegate_str)
637 elif action.startswith('project'):
640 elif action.startswith('state'):
643 elif action == 'view':
644 for patch_id in non_empty(h, patch_ids):
645 s = rpc.patch_get_mbox(patch_id)
647 print unicode(s).encode("utf-8")
649 elif action == 'info':
650 for patch_id in non_empty(h, patch_ids):
651 action_info(rpc, patch_id)
653 elif action in ('get', 'save'):
654 for patch_id in non_empty(h, patch_ids):
655 action_get(rpc, patch_id)
657 elif action == 'apply':
658 for patch_id in non_empty(h, patch_ids):
659 action_apply(rpc, patch_id)
661 elif action == 'git_am':
665 for patch_id in non_empty(h, patch_ids):
666 action_apply(rpc, patch_id, cmd)
668 elif action == 'update':
669 for patch_id in non_empty(h, patch_ids):
670 action_update_patch(rpc, patch_id, state = state_str,
675 sys.stderr.write("Unknown action '%s'\n" % action)
676 action_parser.print_help()
679 if __name__ == "__main__":