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
32 # Default Patchwork remote XML-RPC server URL
33 # This script will check the PW_XMLRPC_URL environment variable
34 # for the URL to access. If that is unspecified, it will fallback to
35 # the hardcoded default value specified here.
36 DEFAULT_URL = "http://patchwork/xmlrpc/"
37 CONFIG_FILES = [os.path.expanduser('~/.pwclientrc')]
40 """Filter for selecting patches."""
42 # These fields refer to specific objects, so they are special
43 # because we have to resolve them to IDs before passing the
44 # filter to the server
48 # The dictionary that gets passed to via XML-RPC
51 def add(self, field, value):
54 elif field == 'project':
60 def resolve_ids(self, rpc):
61 """Resolve State, Project, and Person IDs based on filter strings."""
63 id = state_id_by_name(rpc, self.state)
65 sys.stderr.write("Note: No State found matching %s*, " \
66 "ignoring filter\n" % self.state)
68 self.d['state_id'] = id
70 if self.project != "":
71 id = project_id_by_name(rpc, self.project)
73 sys.stderr.write("Note: No Project found matching %s, " \
74 "ignoring filter\n" % self.project)
76 self.d['project_id'] = id
79 """Return human-readable description of the filter."""
82 class BasicHTTPAuthTransport(xmlrpclib.SafeTransport):
84 def __init__(self, username = None, password = None, use_https = False):
85 self.username = username
86 self.password = password
87 self.use_https = use_https
88 xmlrpclib.SafeTransport.__init__(self)
90 def authenticated(self):
91 return self.username != None and self.password != None
93 def send_host(self, connection, host):
94 xmlrpclib.Transport.send_host(self, connection, host)
95 if not self.authenticated():
97 credentials = '%s:%s' % (self.username, self.password)
98 auth = 'Basic ' + base64.encodestring(credentials).strip()
99 connection.putheader('Authorization', auth)
101 def make_connection(self, host):
103 fn = xmlrpclib.SafeTransport.make_connection
105 fn = xmlrpclib.Transport.make_connection
106 return fn(self, host)
109 sys.stderr.write("Usage: %s <action> [options]\n\n" % \
110 (os.path.basename(sys.argv[0])))
111 sys.stderr.write("Where <action> is one of:\n")
113 """ apply <ID> : Apply a patch (in the current dir, using -p1)
114 git-am <ID> : Apply a patch to current git branch using "git am"
115 get <ID> : Download a patch and save it locally
116 projects : List all projects
117 states : Show list of potential patch states
118 list [str] : List patches, using the optional filters specified
119 below and an optional substring to search for patches
121 search [str] : Same as 'list'
122 view <ID> : View a patch
123 update [-s state] [-c commit-ref] <ID>
125 sys.stderr.write("""\nFilter options for 'list' and 'search':
126 -s <state> : Filter by patch state (e.g., 'New', 'Accepted', etc.)
127 -p <project> : Filter by project name (see 'projects' for list)
128 -w <who> : Filter by submitter (name, e-mail substring search)
129 -d <who> : Filter by delegate (name, e-mail substring search)
130 -n <max #> : Restrict number of results
131 -m <messageid>: Filter by Message-Id\n""")
132 sys.stderr.write("""\nActions that take an ID argument can also be \
134 -h <hash> : Lookup by patch hash\n""")
137 def project_id_by_name(rpc, linkname):
138 """Given a project short name, look up the Project ID."""
139 if len(linkname) == 0:
141 projects = rpc.project_list(linkname, 0)
142 for project in projects:
143 if project['linkname'] == linkname:
147 def state_id_by_name(rpc, name):
148 """Given a partial state name, look up the state ID."""
151 states = rpc.state_list(name, 0)
153 if state['name'].lower().startswith(name.lower()):
157 def person_ids_by_name(rpc, name):
158 """Given a partial name or email address, return a list of the
159 person IDs that match."""
162 people = rpc.person_list(name, 0)
163 return map(lambda x: x['id'], people)
165 def list_patches(patches):
166 """Dump a list of patches to stdout."""
167 print("%-5s %-12s %s" % ("ID", "State", "Name"))
168 print("%-5s %-12s %s" % ("--", "-----", "----"))
169 for patch in patches:
170 print("%-5d %-12s %s" % (patch['id'], patch['state'], patch['name']))
172 def action_list(rpc, filter, submitter_str, delegate_str):
173 filter.resolve_ids(rpc)
175 if submitter_str != "":
176 ids = person_ids_by_name(rpc, submitter_str)
178 sys.stderr.write("Note: Nobody found matching *%s*\n" % \
182 person = rpc.person_get(id)
183 print "Patches submitted by %s <%s>:" % \
184 (unicode(person['name']).encode("utf-8"), \
185 unicode(person['email']).encode("utf-8"))
187 f.add("submitter_id", id)
188 patches = rpc.patch_list(f.d)
189 list_patches(patches)
192 if delegate_str != "":
193 ids = person_ids_by_name(rpc, delegate_str)
195 sys.stderr.write("Note: Nobody found matching *%s*\n" % \
199 person = rpc.person_get(id)
200 print "Patches delegated to %s <%s>:" % \
201 (person['name'], person['email'])
203 f.add("delegate_id", id)
204 patches = rpc.patch_list(f.d)
205 list_patches(patches)
208 patches = rpc.patch_list(filter.d)
209 list_patches(patches)
211 def action_projects(rpc):
212 projects = rpc.project_list("", 0)
213 print("%-5s %-24s %s" % ("ID", "Name", "Description"))
214 print("%-5s %-24s %s" % ("--", "----", "-----------"))
215 for project in projects:
216 print("%-5d %-24s %s" % (project['id'], \
217 project['linkname'], \
220 def action_states(rpc):
221 states = rpc.state_list("", 0)
222 print("%-5s %s" % ("ID", "Name"))
223 print("%-5s %s" % ("--", "----"))
225 print("%-5d %s" % (state['id'], state['name']))
227 def action_get(rpc, patch_id):
228 patch = rpc.patch_get(patch_id)
229 s = rpc.patch_get_mbox(patch_id)
231 if patch == {} or len(s) == 0:
232 sys.stderr.write("Unable to get patch %d\n" % patch_id)
235 base_fname = fname = os.path.basename(patch['filename'])
237 while os.path.exists(fname):
238 fname = "%s.%d" % (base_fname, i)
244 sys.stderr.write("Unable to open %s for writing\n" % fname)
248 f.write(unicode(s).encode("utf-8"))
250 print "Saved patch to %s" % fname
252 sys.stderr.write("Failed to write to %s\n" % fname)
255 def action_apply(rpc, patch_id, apply_cmd=None):
256 patch = rpc.patch_get(patch_id)
258 sys.stderr.write("Error getting information on patch ID %d\n" % \
262 if apply_cmd is None:
263 print "Applying patch #%d to current directory" % patch_id
264 apply_cmd = ['patch', '-p1']
266 print "Applying patch #%d using %s" % (
267 patch_id, repr(' '.join(apply_cmd)))
269 print "Description: %s" % patch['name']
270 s = rpc.patch_get_mbox(patch_id)
272 proc = subprocess.Popen(apply_cmd, stdin = subprocess.PIPE)
273 proc.communicate(unicode(s).encode('utf-8'))
275 sys.stderr.write("Error: No patch content found\n")
278 def action_update_patch(rpc, patch_id, state = None, commit = None):
279 patch = rpc.patch_get(patch_id)
281 sys.stderr.write("Error getting information on patch ID %d\n" % \
288 state_id = state_id_by_name(rpc, state)
290 sys.stderr.write("Error: No State found matching %s*\n" % state)
292 params['state'] = state_id
295 params['commit_ref'] = commit
299 success = rpc.patch_set(patch_id, params)
300 except xmlrpclib.Fault, f:
301 sys.stderr.write("Error updating patch: %s\n" % f.faultString)
304 sys.stderr.write("Patch not updated\n")
306 def patch_id_from_hash(rpc, project, hash):
308 patch = rpc.patch_get_by_project_hash(project, hash)
309 except xmlrpclib.Fault:
310 # the server may not have the newer patch_get_by_project_hash function,
311 # so fall back to hash-only.
312 patch = rpc.patch_get_by_hash(hash)
319 auth_actions = ['update']
323 opts, args = getopt.getopt(sys.argv[2:], 's:p:w:d:n:c:h:m:')
324 except getopt.GetoptError, err:
328 if len(sys.argv) < 2:
331 action = sys.argv[1].lower()
344 config = ConfigParser.ConfigParser()
345 config.read(CONFIG_FILES)
347 # grab settings from config files
348 if config.has_option('base', 'url'):
349 url = config.get('base', 'url')
351 if config.has_option('base', 'project'):
352 project_str = config.get('base', 'project')
354 for name, value in opts:
360 submitter_str = value
371 filt.add("max_count", int(value))
373 sys.stderr.write("Invalid maximum count '%s'\n" % value)
376 sys.stderr.write("Unknown option '%s'\n" % name)
380 sys.stderr.write("Too many arguments specified\n")
383 (username, password) = (None, None)
385 if action in auth_actions:
386 if config.has_option('auth', 'username') and \
387 config.has_option('auth', 'password'):
389 use_https = url.startswith('https')
391 transport = BasicHTTPAuthTransport( \
392 config.get('auth', 'username'),
393 config.get('auth', 'password'),
397 sys.stderr.write(("The %s action requires authentication, "
398 "but no username or password\nis configured\n") % action)
402 filt.add("project", project_str)
405 filt.add("state", state_str)
408 filt.add("msgid", msgid_str)
411 rpc = xmlrpclib.Server(url, transport = transport)
413 sys.stderr.write("Unable to connect to %s\n" % url)
418 patch_id = patch_id_from_hash(rpc, project_str, hash_str)
420 sys.stderr.write("No patch has the hash provided\n")
424 if action == 'list' or action == 'search':
426 filt.add("name__icontains", args[0])
427 action_list(rpc, filt, submitter_str, delegate_str)
429 elif action.startswith('project'):
432 elif action.startswith('state'):
435 elif action == 'view':
437 patch_id = patch_id or int(args[0])
439 sys.stderr.write("Invalid patch ID given\n")
442 s = rpc.patch_get_mbox(patch_id)
444 print unicode(s).encode("utf-8")
446 elif action == 'get' or action == 'save':
448 patch_id = patch_id or int(args[0])
450 sys.stderr.write("Invalid patch ID given\n")
453 action_get(rpc, patch_id)
455 elif action == 'apply':
457 patch_id = patch_id or int(args[0])
459 sys.stderr.write("Invalid patch ID given\n")
462 action_apply(rpc, patch_id)
464 elif action == 'git-am':
466 patch_id = patch_id or int(args[0])
468 sys.stderr.write("Invalid patch ID given\n")
471 action_apply(rpc, patch_id, ['git', 'am'])
473 elif action == 'update':
475 patch_id = patch_id or int(args[0])
477 sys.stderr.write("Invalid patch ID given\n")
480 action_update_patch(rpc, patch_id, state = state_str,
484 sys.stderr.write("Unknown action '%s'\n" % action)
487 if __name__ == "__main__":