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
34 # Default Patchwork remote XML-RPC server URL
35 # This script will check the PW_XMLRPC_URL environment variable
36 # for the URL to access. If that is unspecified, it will fallback to
37 # the hardcoded default value specified here.
38 DEFAULT_URL = "http://patchwork/xmlrpc/"
39 CONFIG_FILE = os.path.expanduser('~/.pwclientrc')
42 """Filter for selecting patches."""
44 # These fields refer to specific objects, so they are special
45 # because we have to resolve them to IDs before passing the
46 # filter to the server
50 # The dictionary that gets passed to via XML-RPC
53 def add(self, field, value):
56 elif field == 'project':
62 def resolve_ids(self, rpc):
63 """Resolve State, Project, and Person IDs based on filter strings."""
65 id = state_id_by_name(rpc, self.state)
67 sys.stderr.write("Note: No State found matching %s*, " \
68 "ignoring filter\n" % self.state)
70 self.d['state_id'] = id
72 if self.project != None:
73 id = project_id_by_name(rpc, self.project)
75 sys.stderr.write("Note: No Project found matching %s, " \
76 "ignoring filter\n" % self.project)
78 self.d['project_id'] = id
81 """Return human-readable description of the filter."""
84 class BasicHTTPAuthTransport(xmlrpclib.SafeTransport):
86 def __init__(self, username = None, password = None, use_https = False):
87 self.username = username
88 self.password = password
89 self.use_https = use_https
90 xmlrpclib.SafeTransport.__init__(self)
92 def authenticated(self):
93 return self.username != None and self.password != None
95 def send_host(self, connection, host):
96 xmlrpclib.Transport.send_host(self, connection, host)
97 if not self.authenticated():
99 credentials = '%s:%s' % (self.username, self.password)
100 auth = 'Basic ' + base64.encodestring(credentials).strip()
101 connection.putheader('Authorization', auth)
103 def make_connection(self, host):
105 fn = xmlrpclib.SafeTransport.make_connection
107 fn = xmlrpclib.Transport.make_connection
108 return fn(self, host)
110 def project_id_by_name(rpc, linkname):
111 """Given a project short name, look up the Project ID."""
112 if len(linkname) == 0:
114 projects = rpc.project_list(linkname, 0)
115 for project in projects:
116 if project['linkname'] == linkname:
120 def state_id_by_name(rpc, name):
121 """Given a partial state name, look up the state ID."""
124 states = rpc.state_list(name, 0)
126 if state['name'].lower().startswith(name.lower()):
130 def person_ids_by_name(rpc, name):
131 """Given a partial name or email address, return a list of the
132 person IDs that match."""
135 people = rpc.person_list(name, 0)
136 return map(lambda x: x['id'], people)
138 def list_patches(patches, format_str=None):
139 """Dump a list of patches to stdout."""
141 format_field_re = re.compile("%{([a-z0-9_]+)}")
143 def patch_field(matchobj):
144 fieldname = matchobj.group(1)
146 if fieldname == "_msgid_":
147 # naive way to strip < and > from message-id
148 val = string.strip(str(patch["msgid"]), "<>")
150 val = str(patch[fieldname])
154 for patch in patches:
155 print(format_field_re.sub(patch_field, format_str))
157 print("%-7s %-12s %s" % ("ID", "State", "Name"))
158 print("%-7s %-12s %s" % ("--", "-----", "----"))
159 for patch in patches:
160 print("%-7d %-12s %s" % (patch['id'], patch['state'], patch['name']))
162 def action_list(rpc, filter, submitter_str, delegate_str, format_str=None):
163 filter.resolve_ids(rpc)
165 if submitter_str != None:
166 ids = person_ids_by_name(rpc, submitter_str)
168 sys.stderr.write("Note: Nobody found matching *%s*\n" % \
172 person = rpc.person_get(id)
173 print "Patches submitted by %s <%s>:" % \
174 (unicode(person['name']).encode("utf-8"), \
175 unicode(person['email']).encode("utf-8"))
177 f.add("submitter_id", id)
178 patches = rpc.patch_list(f.d)
179 list_patches(patches, format_str)
182 if delegate_str != None:
183 ids = person_ids_by_name(rpc, delegate_str)
185 sys.stderr.write("Note: Nobody found matching *%s*\n" % \
189 person = rpc.person_get(id)
190 print "Patches delegated to %s <%s>:" % \
191 (person['name'], person['email'])
193 f.add("delegate_id", id)
194 patches = rpc.patch_list(f.d)
195 list_patches(patches, format_str)
198 patches = rpc.patch_list(filter.d)
199 list_patches(patches, format_str)
201 def action_projects(rpc):
202 projects = rpc.project_list("", 0)
203 print("%-5s %-24s %s" % ("ID", "Name", "Description"))
204 print("%-5s %-24s %s" % ("--", "----", "-----------"))
205 for project in projects:
206 print("%-5d %-24s %s" % (project['id'], \
207 project['linkname'], \
210 def action_states(rpc):
211 states = rpc.state_list("", 0)
212 print("%-5s %s" % ("ID", "Name"))
213 print("%-5s %s" % ("--", "----"))
215 print("%-5d %s" % (state['id'], state['name']))
217 def action_info(rpc, patch_id):
218 patch = rpc.patch_get(patch_id)
219 s = "Information for patch id %d" % (patch_id)
222 for key, value in sorted(patch.iteritems()):
223 print("- %- 14s: %s" % (key, unicode(value).encode("utf-8")))
225 def action_get(rpc, patch_id):
226 patch = rpc.patch_get(patch_id)
227 s = rpc.patch_get_mbox(patch_id)
229 if patch == {} or len(s) == 0:
230 sys.stderr.write("Unable to get patch %d\n" % patch_id)
233 base_fname = fname = os.path.basename(patch['filename'])
235 while os.path.exists(fname):
236 fname = "%s.%d" % (base_fname, i)
242 sys.stderr.write("Unable to open %s for writing\n" % fname)
246 f.write(unicode(s).encode("utf-8"))
248 print "Saved patch to %s" % fname
250 sys.stderr.write("Failed to write to %s\n" % fname)
253 def action_apply(rpc, patch_id, apply_cmd=None):
254 patch = rpc.patch_get(patch_id)
256 sys.stderr.write("Error getting information on patch ID %d\n" % \
260 if apply_cmd is None:
261 print "Applying patch #%d to current directory" % patch_id
262 apply_cmd = ['patch', '-p1']
264 print "Applying patch #%d using %s" % (
265 patch_id, repr(' '.join(apply_cmd)))
267 print "Description: %s" % patch['name']
268 s = rpc.patch_get_mbox(patch_id)
270 proc = subprocess.Popen(apply_cmd, stdin = subprocess.PIPE)
271 proc.communicate(unicode(s).encode('utf-8'))
272 return proc.returncode
274 sys.stderr.write("Error: No patch content found\n")
277 def action_update_patch(rpc, patch_id, state = None, archived = None, commit = None):
278 patch = rpc.patch_get(patch_id)
280 sys.stderr.write("Error getting information on patch ID %d\n" % \
287 state_id = state_id_by_name(rpc, state)
289 sys.stderr.write("Error: No State found matching %s*\n" % state)
291 params['state'] = state_id
294 params['commit_ref'] = commit
297 params['archived'] = archived == 'yes'
301 success = rpc.patch_set(patch_id, params)
302 except xmlrpclib.Fault, f:
303 sys.stderr.write("Error updating patch: %s\n" % f.faultString)
306 sys.stderr.write("Patch not updated\n")
308 def patch_id_from_hash(rpc, project, hash):
310 patch = rpc.patch_get_by_project_hash(project, hash)
311 except xmlrpclib.Fault:
312 # the server may not have the newer patch_get_by_project_hash function,
313 # so fall back to hash-only.
314 patch = rpc.patch_get_by_hash(hash)
317 sys.stderr.write("No patch has the hash provided\n")
320 patch_id = patch['id']
323 patch_id = int(patch_id)
325 sys.stderr.write("Invalid patch ID obtained from server\n")
329 auth_actions = ['update']
331 # unfortunately we currently have to revert to this ugly hack..
332 class _RecursiveHelpAction(argparse._HelpAction):
334 def __call__(self, parser, namespace, values, option_string=None):
338 subparsers_actions = [
339 action for action in parser._actions
340 if isinstance(action, argparse._SubParsersAction)
342 hash_n_id_actions = set(['hash', 'id', 'help'])
343 for subparsers_action in subparsers_actions:
344 for choice, subparser in subparsers_action.choices.items():
345 # gross but the whole thing is..
346 if (len(subparser._actions) == 3 \
347 and set([a.dest for a in subparser._actions]) \
348 == hash_n_id_actions) \
349 or len(subparser._actions) == 0:
351 print("command '{}'".format(choice))
352 print(subparser.format_help())
357 hash_parser = argparse.ArgumentParser(add_help=False, version=False)
358 hash_parser.add_argument(
359 '-h', metavar='HASH', dest='hash', action='store',
360 help='''Lookup by patch hash'''
362 hash_parser.add_argument(
363 'id', metavar='ID', nargs='*', action='store', type=int,
366 hash_parser.add_argument(
367 '-p', metavar='PROJECT',
368 help='''Lookup patch in project'''
371 filter_parser = argparse.ArgumentParser(add_help=False, version=False)
372 filter_parser.add_argument(
373 '-s', metavar='STATE',
374 help='''Filter by patch state (e.g., 'New', 'Accepted', etc.)'''
376 filter_parser.add_argument(
377 '-a', choices=['yes','no'],
378 help='''Filter by patch archived state'''
380 filter_parser.add_argument(
381 '-p', metavar='PROJECT',
382 help='''Filter by project name (see 'projects' for list)'''
384 filter_parser.add_argument(
386 help='''Filter by submitter (name, e-mail substring search)'''
388 filter_parser.add_argument(
390 help='''Filter by delegate (name, e-mail substring search)'''
392 filter_parser.add_argument(
393 '-n', metavar='MAX#',
395 help='''Restrict number of results'''
397 filter_parser.add_argument(
398 '-m', metavar='MESSAGEID',
399 help='''Filter by Message-Id'''
401 filter_parser.add_argument(
402 '-f', metavar='FORMAT',
403 help='''Print output in the given format. You can use tags matching '''
404 '''fields, e.g. %%{id}, %%{state}, or %%{msgid}.'''
406 filter_parser.add_argument(
407 'patch_name', metavar='STR', nargs='?',
408 help='substring to search for patches by name',
410 help_parser = argparse.ArgumentParser(add_help=False, version=False)
411 help_parser.add_argument(
412 '--help', action='help', help=argparse.SUPPRESS,
413 #help='''show this help message and exit'''
416 action_parser = argparse.ArgumentParser(
420 formatter_class=argparse.RawDescriptionHelpFormatter,
421 epilog='''(apply | get | info | view | update) (-h HASH | ID [ID ...])''',
423 action_parser.add_argument(
426 action=_RecursiveHelpAction,
427 help='''Print this help text'''
430 subparsers = action_parser.add_subparsers(
434 apply_parser = subparsers.add_parser(
435 'apply', parents=[hash_parser, help_parser],
437 help='''Apply a patch (in the current dir, using -p1)'''
439 apply_parser.set_defaults(subcmd='apply')
440 git_am_parser = subparsers.add_parser(
441 'git-am', parents=[hash_parser, help_parser],
443 help='''Apply a patch to current git branch using "git am".'''
445 git_am_parser.set_defaults(subcmd='git_am')
446 git_am_parser.add_argument(
449 help='''pass --signoff to git-am'''
451 get_parser = subparsers.add_parser(
452 'get', parents=[hash_parser, help_parser],
454 help='''Download a patch and save it locally'''
456 get_parser.set_defaults(subcmd='get')
457 info_parser = subparsers.add_parser(
458 'info', parents=[hash_parser, help_parser],
460 help='''Display patchwork info about a given patch ID'''
462 info_parser.set_defaults(subcmd='info')
463 projects_parser = subparsers.add_parser(
466 help='''List all projects'''
468 projects_parser.set_defaults(subcmd='projects')
469 states_parser = subparsers.add_parser(
472 help='''Show list of potential patch states'''
474 states_parser.set_defaults(subcmd='states')
475 view_parser = subparsers.add_parser(
476 'view', parents=[hash_parser, help_parser],
478 help='''View a patch'''
480 view_parser.set_defaults(subcmd='view')
481 update_parser = subparsers.add_parser(
482 'update', parents=[hash_parser, help_parser],
484 help='''Update patch''',
485 epilog='''Using a COMMIT-REF allows for only one ID to be specified''',
487 update_parser.add_argument(
488 '-c', metavar='COMMIT-REF',
489 help='''commit reference hash'''
491 update_parser.add_argument(
492 '-s', metavar='STATE',
494 help='''Set patch state (e.g., 'Accepted', 'Superseded' etc.)'''
496 update_parser.add_argument(
497 '-a', choices=['yes', 'no'],
498 help='''Set patch archived state'''
500 update_parser.set_defaults(subcmd='update')
501 list_parser = subparsers.add_parser("list",
504 parents=[filter_parser, help_parser],
505 help='''List patches, using the optional filters specified
506 below and an optional substring to search for patches
509 list_parser.set_defaults(subcmd='list')
510 search_parser = subparsers.add_parser("search",
512 parents=[filter_parser, help_parser],
513 help='''Alias for "list"'''
515 # Poor man's argparse aliases:
516 # We register the "search" parser but effectively use "list" for the
518 search_parser.set_defaults(subcmd='list')
519 if len(sys.argv) < 2:
520 action_parser.print_help()
523 args = action_parser.parse_args()
524 args = dict(vars(args))
525 action = args.get('subcmd')
527 if args.get('hash') and len(args.get('id')):
528 # mimic mutual exclusive group
529 sys.stderr.write("Error: [-h HASH] and [ID [ID ...]] " +
530 "are mutually exlusive\n")
531 locals()[action + '_parser'].print_help()
539 archived_str = args.get('a')
540 state_str = args.get('s')
541 project_str = args.get('p')
542 submitter_str = args.get('w')
543 delegate_str = args.get('d')
544 format_str = args.get('f')
545 hash_str = args.get('hash')
546 patch_ids = args.get('id')
547 msgid_str = args.get('m')
549 # update multiple IDs with a single commit-hash does not make sense
550 if action == 'update' and patch_ids and len(patch_ids) > 1:
552 "Declining update with COMMIT-REF on multiple IDs\n"
554 update_parser.print_help()
556 commit_str = args.get('c')
558 if args.get('n') != None:
560 filt.add("max_count", args.get('n'))
562 sys.stderr.write("Invalid maximum count '%s'\n" % args.get('n'))
563 action_parser.print_help()
566 do_signoff = args.get('signoff')
568 # grab settings from config files
569 config = ConfigParser.ConfigParser()
570 config.read([CONFIG_FILE])
572 if not config.has_section('options'):
573 sys.stderr.write('~/.pwclientrc is in the old format. Migrating it...')
575 old_project = config.get('base','project')
577 new_config = ConfigParser.ConfigParser()
578 new_config.add_section('options')
580 new_config.set('options','default',old_project)
581 new_config.add_section(old_project)
583 new_config.set(old_project,'url',config.get('base','url'))
584 if config.has_option('auth', 'username'):
585 new_config.set(old_project,'username',config.get('auth','username'))
586 if config.has_option('auth', 'password'):
587 new_config.set(old_project,'password',config.get('auth','password'))
589 old_config_file = CONFIG_FILE + '.orig'
590 shutil.copy2(CONFIG_FILE,old_config_file)
592 with open(CONFIG_FILE, 'wb') as fd:
595 sys.stderr.write(' Done.\n')
596 sys.stderr.write('Your old ~/.pwclientrc was saved to %s\n' % old_config_file)
597 sys.stderr.write('and was converted to the new format. You may want to\n')
598 sys.stderr.write('inspect it before continuing.\n')
603 project_str = config.get('options', 'default')
605 sys.stderr.write("No default project configured in ~/.pwclientrc\n")
606 action_parser.print_help()
609 if not config.has_section(project_str):
610 sys.stderr.write("No section for project %s\n" % project_str)
612 if not config.has_option(project_str, 'url'):
613 sys.stderr.write("No URL for project %s\n" % project_str)
615 if not do_signoff and config.has_option('options', 'signoff'):
616 do_signoff = config.getboolean('options', 'signoff')
617 if not do_signoff and config.has_option(project_str, 'signoff'):
618 do_signoff = config.getboolean(project_str, 'signoff')
620 url = config.get(project_str, 'url')
623 if action in auth_actions:
624 if config.has_option(project_str, 'username') and \
625 config.has_option(project_str, 'password'):
627 use_https = url.startswith('https')
629 transport = BasicHTTPAuthTransport( \
630 config.get(project_str, 'username'),
631 config.get(project_str, 'password'),
635 sys.stderr.write(("The %s action requires authentication, "
636 "but no username or password\nis configured\n") % action)
640 filt.add("project", project_str)
643 filt.add("state", state_str)
646 filt.add("archived", archived_str == 'yes')
649 filt.add("msgid", msgid_str)
652 rpc = xmlrpclib.Server(url, transport = transport)
654 sys.stderr.write("Unable to connect to %s\n" % url)
657 # It should be safe to assume hash_str is not zero, but who knows..
659 patch_ids = [patch_id_from_hash(rpc, project_str, hash_str)]
661 # helper for non_empty() to print correct helptext
662 h = locals()[action + '_parser']
664 # Require either hash_str or IDs for
665 def non_empty(h, patch_ids):
666 """Error out if no patch IDs were specified"""
667 if patch_ids == None or len(patch_ids) < 1:
668 sys.stderr.write("Error: Missing Argument! " +
669 "Either [-h HASH] or [ID [ID ...]] are required\n")
675 if action == 'list' or action == 'search':
676 if args.get('patch_name') != None:
677 filt.add("name__icontains", args.get('patch_name'))
678 action_list(rpc, filt, submitter_str, delegate_str, format_str)
680 elif action.startswith('project'):
683 elif action.startswith('state'):
686 elif action == 'view':
687 pager = os.environ.get('PAGER')
689 pager = subprocess.Popen(
690 pager.split(), stdin=subprocess.PIPE
694 for patch_id in non_empty(h, patch_ids):
695 s = rpc.patch_get_mbox(patch_id)
697 i.append(unicode(s).encode("utf-8"))
699 pager.communicate(input="\n".join(i))
702 for patch_id in non_empty(h, patch_ids):
703 s = rpc.patch_get_mbox(patch_id)
705 print unicode(s).encode("utf-8")
707 elif action == 'info':
708 for patch_id in non_empty(h, patch_ids):
709 action_info(rpc, patch_id)
711 elif action == 'get':
712 for patch_id in non_empty(h, patch_ids):
713 action_get(rpc, patch_id)
715 elif action == 'apply':
716 for patch_id in non_empty(h, patch_ids):
717 ret = action_apply(rpc, patch_id)
719 sys.stderr.write("Apply failed with exit status %d\n" % ret)
722 elif action == 'git_am':
726 for patch_id in non_empty(h, patch_ids):
727 ret = action_apply(rpc, patch_id, cmd)
729 sys.stderr.write("'git am' failed with exit status %d\n" % ret)
732 elif action == 'update':
733 for patch_id in non_empty(h, patch_ids):
734 action_update_patch(rpc, patch_id, state = state_str,
735 archived = archived_str, commit = commit_str
739 sys.stderr.write("Unknown action '%s'\n" % action)
740 action_parser.print_help()
743 if __name__ == "__main__":