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\n""")
131 sys.stderr.write("""\nActions that take an ID argument can also be \
133 -h <hash> : Lookup by patch hash\n""")
136 def project_id_by_name(rpc, linkname):
137 """Given a project short name, look up the Project ID."""
138 if len(linkname) == 0:
140 projects = rpc.project_list(linkname, 0)
141 for project in projects:
142 if project['linkname'] == linkname:
146 def state_id_by_name(rpc, name):
147 """Given a partial state name, look up the state ID."""
150 states = rpc.state_list(name, 0)
152 if state['name'].lower().startswith(name.lower()):
156 def person_ids_by_name(rpc, name):
157 """Given a partial name or email address, return a list of the
158 person IDs that match."""
161 people = rpc.person_list(name, 0)
162 return map(lambda x: x['id'], people)
164 def list_patches(patches):
165 """Dump a list of patches to stdout."""
166 print("%-5s %-12s %s" % ("ID", "State", "Name"))
167 print("%-5s %-12s %s" % ("--", "-----", "----"))
168 for patch in patches:
169 print("%-5d %-12s %s" % (patch['id'], patch['state'], patch['name']))
171 def action_list(rpc, filter, submitter_str, delegate_str):
172 filter.resolve_ids(rpc)
174 if submitter_str != "":
175 ids = person_ids_by_name(rpc, submitter_str)
177 sys.stderr.write("Note: Nobody found matching *%s*\n" % \
181 person = rpc.person_get(id)
182 print "Patches submitted by %s <%s>:" % \
183 (unicode(person['name']).encode("utf-8"), \
184 unicode(person['email']).encode("utf-8"))
186 f.add("submitter_id", id)
187 patches = rpc.patch_list(f.d)
188 list_patches(patches)
191 if delegate_str != "":
192 ids = person_ids_by_name(rpc, delegate_str)
194 sys.stderr.write("Note: Nobody found matching *%s*\n" % \
198 person = rpc.person_get(id)
199 print "Patches delegated to %s <%s>:" % \
200 (person['name'], person['email'])
202 f.add("delegate_id", id)
203 patches = rpc.patch_list(f.d)
204 list_patches(patches)
207 patches = rpc.patch_list(filter.d)
208 list_patches(patches)
210 def action_projects(rpc):
211 projects = rpc.project_list("", 0)
212 print("%-5s %-24s %s" % ("ID", "Name", "Description"))
213 print("%-5s %-24s %s" % ("--", "----", "-----------"))
214 for project in projects:
215 print("%-5d %-24s %s" % (project['id'], \
216 project['linkname'], \
219 def action_states(rpc):
220 states = rpc.state_list("", 0)
221 print("%-5s %s" % ("ID", "Name"))
222 print("%-5s %s" % ("--", "----"))
224 print("%-5d %s" % (state['id'], state['name']))
226 def action_get(rpc, patch_id):
227 patch = rpc.patch_get(patch_id)
228 s = rpc.patch_get_mbox(patch_id)
230 if patch == {} or len(s) == 0:
231 sys.stderr.write("Unable to get patch %d\n" % patch_id)
234 base_fname = fname = os.path.basename(patch['filename'])
236 while os.path.exists(fname):
237 fname = "%s.%d" % (base_fname, i)
243 sys.stderr.write("Unable to open %s for writing\n" % fname)
247 f.write(unicode(s).encode("utf-8"))
249 print "Saved patch to %s" % fname
251 sys.stderr.write("Failed to write to %s\n" % fname)
254 def action_apply(rpc, patch_id, apply_cmd=None):
255 patch = rpc.patch_get(patch_id)
257 sys.stderr.write("Error getting information on patch ID %d\n" % \
261 if apply_cmd is None:
262 print "Applying patch #%d to current directory" % patch_id
263 apply_cmd = ['patch', '-p1']
265 print "Applying patch #%d using %s" % (
266 patch_id, repr(' '.join(apply_cmd)))
268 print "Description: %s" % patch['name']
269 s = rpc.patch_get_mbox(patch_id)
271 proc = subprocess.Popen(apply_cmd, stdin = subprocess.PIPE)
274 sys.stderr.write("Error: No patch content found\n")
277 def action_update_patch(rpc, patch_id, state = 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
298 success = rpc.patch_set(patch_id, params)
299 except xmlrpclib.Fault, f:
300 sys.stderr.write("Error updating patch: %s\n" % f.faultString)
303 sys.stderr.write("Patch not updated\n")
305 def patch_id_from_hash(rpc, project, hash):
307 patch = rpc.patch_get_by_project_hash(project, hash)
308 except xmlrpclib.Fault:
309 # the server may not have the newer patch_get_by_project_hash function,
310 # so fall back to hash-only.
311 patch = rpc.patch_get_by_hash(hash)
318 auth_actions = ['update']
322 opts, args = getopt.getopt(sys.argv[2:], 's:p:w:d:n:c:h:')
323 except getopt.GetoptError, err:
327 if len(sys.argv) < 2:
330 action = sys.argv[1].lower()
342 config = ConfigParser.ConfigParser()
343 config.read(CONFIG_FILES)
345 # grab settings from config files
346 if config.has_option('base', 'url'):
347 url = config.get('base', 'url')
349 if config.has_option('base', 'project'):
350 project_str = config.get('base', 'project')
352 for name, value in opts:
358 submitter_str = value
367 filt.add("max_count", int(value))
369 sys.stderr.write("Invalid maximum count '%s'\n" % value)
372 sys.stderr.write("Unknown option '%s'\n" % name)
376 sys.stderr.write("Too many arguments specified\n")
379 (username, password) = (None, None)
381 if action in auth_actions:
382 if config.has_option('auth', 'username') and \
383 config.has_option('auth', 'password'):
385 use_https = url.startswith('https')
387 transport = BasicHTTPAuthTransport( \
388 config.get('auth', 'username'),
389 config.get('auth', 'password'),
393 sys.stderr.write(("The %s action requires authentication, "
394 "but no username or password\nis configured\n") % action)
398 filt.add("project", project_str)
401 filt.add("state", state_str)
404 rpc = xmlrpclib.Server(url, transport = transport)
406 sys.stderr.write("Unable to connect to %s\n" % url)
411 patch_id = patch_id_from_hash(rpc, project_str, hash_str)
413 sys.stderr.write("No patch has the hash provided\n")
417 if action == 'list' or action == 'search':
419 filt.add("name__icontains", args[0])
420 action_list(rpc, filt, submitter_str, delegate_str)
422 elif action.startswith('project'):
425 elif action.startswith('state'):
428 elif action == 'view':
430 patch_id = patch_id or int(args[0])
432 sys.stderr.write("Invalid patch ID given\n")
435 s = rpc.patch_get_mbox(patch_id)
437 print unicode(s).encode("utf-8")
439 elif action == 'get' or action == 'save':
441 patch_id = patch_id or int(args[0])
443 sys.stderr.write("Invalid patch ID given\n")
446 action_get(rpc, patch_id)
448 elif action == 'apply':
450 patch_id = patch_id or int(args[0])
452 sys.stderr.write("Invalid patch ID given\n")
455 action_apply(rpc, patch_id)
457 elif action == 'git-am':
459 patch_id = patch_id or int(args[0])
461 sys.stderr.write("Invalid patch ID given\n")
464 action_apply(rpc, patch_id, ['git', 'am'])
466 elif action == 'update':
468 patch_id = patch_id or int(args[0])
470 sys.stderr.write("Invalid patch ID given\n")
473 action_update_patch(rpc, patch_id, state = state_str,
477 sys.stderr.write("Unknown action '%s'\n" % action)
480 if __name__ == "__main__":