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.Transport):
84 def __init__(self, username = None, password = None):
85 self.username = username
86 self.password = password
87 xmlrpclib.Transport.__init__(self)
89 def authenticated(self):
90 return self.username != None and self.password != None
92 def send_host(self, connection, host):
93 xmlrpclib.Transport.send_host(self, connection, host)
94 if not self.authenticated():
96 credentials = '%s:%s' % (self.username, self.password)
97 auth = 'Basic ' + base64.encodestring(credentials).strip()
98 connection.putheader('Authorization', auth)
101 sys.stderr.write("Usage: %s <action> [options]\n\n" % \
102 (os.path.basename(sys.argv[0])))
103 sys.stderr.write("Where <action> is one of:\n")
105 """ apply <ID> : Apply a patch (in the current dir, using -p1)
106 get <ID> : Download a patch and save it locally
107 projects : List all projects
108 states : Show list of potential patch states
109 list [str] : List patches, using the optional filters specified
110 below and an optional substring to search for patches
112 search [str] : Same as 'list'
113 view <ID> : View a patch
114 update [-s state] [-c commit-ref] <ID>
116 sys.stderr.write("""\nFilter options for 'list' and 'search':
117 -s <state> : Filter by patch state (e.g., 'New', 'Accepted', etc.)
118 -p <project> : Filter by project name (see 'projects' for list)
119 -w <who> : Filter by submitter (name, e-mail substring search)
120 -d <who> : Filter by delegate (name, e-mail substring search)
121 -n <max #> : Restrict number of results\n""")
124 def project_id_by_name(rpc, linkname):
125 """Given a project short name, look up the Project ID."""
126 if len(linkname) == 0:
128 # The search requires - instead of _
129 search = linkname.replace("_", "-")
130 projects = rpc.project_list(search, 0)
131 for project in projects:
132 if project['linkname'].replace("_", "-") == search:
136 def state_id_by_name(rpc, name):
137 """Given a partial state name, look up the state ID."""
140 states = rpc.state_list(name, 0)
142 if state['name'].lower().startswith(name.lower()):
146 def person_ids_by_name(rpc, name):
147 """Given a partial name or email address, return a list of the
148 person IDs that match."""
151 people = rpc.person_list(name, 0)
152 return map(lambda x: x['id'], people)
154 def list_patches(patches):
155 """Dump a list of patches to stdout."""
156 print("%-5s %-12s %s" % ("ID", "State", "Name"))
157 print("%-5s %-12s %s" % ("--", "-----", "----"))
158 for patch in patches:
159 print("%-5d %-12s %s" % (patch['id'], patch['state'], patch['name']))
161 def action_list(rpc, filter, submitter_str, delegate_str):
162 filter.resolve_ids(rpc)
164 if submitter_str != "":
165 ids = person_ids_by_name(rpc, submitter_str)
167 sys.stderr.write("Note: Nobody found matching *%s*\n", \
171 person = rpc.person_get(id)
172 print "Patches submitted by %s <%s>:" % \
173 (person['name'], person['email'])
175 f.add("submitter_id", id)
176 patches = rpc.patch_list(f.d)
177 list_patches(patches)
180 if delegate_str != "":
181 ids = person_ids_by_name(rpc, delegate_str)
183 sys.stderr.write("Note: Nobody found matching *%s*\n", \
187 person = rpc.person_get(id)
188 print "Patches delegated to %s <%s>:" % \
189 (person['name'], person['email'])
191 f.add("delegate_id", id)
192 patches = rpc.patch_list(f.d)
193 list_patches(patches)
196 patches = rpc.patch_list(filter.d)
197 list_patches(patches)
199 def action_projects(rpc):
200 projects = rpc.project_list("", 0)
201 print("%-5s %-24s %s" % ("ID", "Name", "Description"))
202 print("%-5s %-24s %s" % ("--", "----", "-----------"))
203 for project in projects:
204 print("%-5d %-24s %s" % (project['id'], \
205 project['linkname'].replace("_", "-"), \
208 def action_states(rpc):
209 states = rpc.state_list("", 0)
210 print("%-5s %s" % ("ID", "Name"))
211 print("%-5s %s" % ("--", "----"))
213 print("%-5d %s" % (state['id'], state['name']))
215 def action_get(rpc, patch_id):
216 patch = rpc.patch_get(patch_id)
217 s = rpc.patch_get_mbox(patch_id)
219 if patch == {} or len(s) == 0:
220 sys.stderr.write("Unable to get patch %d\n" % patch_id)
223 base_fname = fname = os.path.basename(patch['filename'])
225 while os.path.exists(fname):
226 fname = "%s.%d" % (base_fname, i)
232 sys.stderr.write("Unable to open %s for writing\n" % fname)
238 print "Saved patch to %s" % fname
240 sys.stderr.write("Failed to write to %s\n" % fname)
243 def action_apply(rpc, patch_id):
244 patch = rpc.patch_get(patch_id)
246 sys.stderr.write("Error getting information on patch ID %d\n" % \
249 print "Applying patch #%d to current directory" % patch_id
250 print "Description: %s" % patch['name']
251 s = rpc.patch_get_mbox(patch_id)
253 proc = subprocess.Popen(['patch', '-p1'], stdin = subprocess.PIPE)
256 sys.stderr.write("Error: No patch content found\n")
259 def action_update_patch(rpc, patch_id, state = None, commit = None):
260 patch = rpc.patch_get(patch_id)
262 sys.stderr.write("Error getting information on patch ID %d\n" % \
269 state_id = state_id_by_name(rpc, state)
271 sys.stderr.write("Error: No State found matching %s*\n" % state)
273 params['state'] = state_id
276 params['commit_ref'] = commit
280 success = rpc.patch_set(patch_id, params)
281 except xmlrpclib.Fault, f:
282 sys.stderr.write("Error updating patch: %s\n" % f.faultString)
285 sys.stderr.write("Patch not updated\n")
287 auth_actions = ['update']
291 opts, args = getopt.getopt(sys.argv[2:], 's:p:w:d:n:c:')
292 except getopt.GetoptError, err:
296 if len(sys.argv) < 2:
299 action = sys.argv[1].lower()
310 config = ConfigParser.ConfigParser()
311 config.read(CONFIG_FILES)
313 # grab settings from config files
314 if config.has_option('base', 'url'):
315 url = config.get('base', 'url')
317 if config.has_option('base', 'project'):
318 project_str = config.get('base', 'project')
320 for name, value in opts:
326 submitter_str = value
333 filt.add("max_count", int(value))
335 sys.stderr.write("Invalid maximum count '%s'\n" % value)
338 sys.stderr.write("Unknown option '%s'\n" % name)
342 sys.stderr.write("Too many arguments specified\n")
345 (username, password) = (None, None)
347 if action in auth_actions:
348 if config.has_option('auth', 'username') and \
349 config.has_option('auth', 'password'):
351 transport = BasicHTTPAuthTransport( \
352 config.get('auth', 'username'),
353 config.get('auth', 'password'))
356 sys.stderr.write(("The %s action requires authentication, "
357 "but no username or password\nis configured\n") % action)
361 filt.add("project", project_str)
364 filt.add("state", state_str)
367 rpc = xmlrpclib.Server(url, transport = transport)
369 sys.stderr.write("Unable to connect to %s\n" % url)
372 if action == 'list' or action == 'search':
374 filt.add("name__icontains", args[0])
375 action_list(rpc, filt, submitter_str, delegate_str)
377 elif action.startswith('project'):
380 elif action.startswith('state'):
383 elif action == 'view':
385 patch_id = int(args[0])
387 sys.stderr.write("Invalid patch ID given\n")
390 s = rpc.patch_get_mbox(patch_id)
394 elif action == 'get' or action == 'save':
396 patch_id = int(args[0])
398 sys.stderr.write("Invalid patch ID given\n")
401 action_get(rpc, patch_id)
403 elif action == 'apply':
405 patch_id = int(args[0])
407 sys.stderr.write("Invalid patch ID given\n")
410 action_apply(rpc, patch_id)
412 elif action == 'update':
414 patch_id = int(args[0])
416 sys.stderr.write("Invalid patch ID given\n")
419 action_update_patch(rpc, patch_id, state = state_str,
423 sys.stderr.write("Unknown action '%s'\n" % action)
426 if __name__ == "__main__":