1 # Patchwork - automated patch tracking system
2 # Copyright (C) 2008 Jeremy Kerr <jk@ozlabs.org>
4 # This file is part of the Patchwork package.
6 # Patchwork is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2 of the License, or
9 # (at your option) any later version.
11 # Patchwork is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with Patchwork; if not, write to the Free Software
18 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 # Patchwork XMLRPC interface
23 from django.core.exceptions import ImproperlyConfigured
24 from SimpleXMLRPCServer import SimpleXMLRPCDispatcher
25 from django.http import HttpResponse, HttpResponseRedirect, \
26 HttpResponseServerError
27 from django.conf import settings
28 from django.core import urlresolvers
29 from django.shortcuts import render_to_response
30 from django.contrib.auth import authenticate
31 from patchwork.models import Patch, Project, Person, Bundle, State
37 class PatchworkXMLRPCDispatcher(SimpleXMLRPCDispatcher):
39 if sys.version_info[:3] >= (2,5,):
40 SimpleXMLRPCDispatcher.__init__(self, allow_none=False,
43 SimpleXMLRPCDispatcher.__init__(self)
45 # map of name => (auth, func)
49 def register_function(self, fn, auth_required):
50 self.func_map[fn.__name__] = (auth_required, fn)
53 def _user_for_request(self, request):
56 if request.META.has_key('HTTP_AUTHORIZATION'):
57 auth_header = request.META.get('HTTP_AUTHORIZATION')
58 elif request.META.has_key('Authorization'):
59 auth_header = request.META.get('Authorization')
61 if auth_header is None or auth_header == '':
62 raise Exception("No authentication credentials given")
64 str = auth_header.strip()
66 if not str.startswith('Basic '):
67 raise Exception("Authentication scheme not supported")
69 str = str[len('Basic '):].strip()
72 decoded = base64.decodestring(str)
73 username, password = decoded.split(':', 1)
75 raise Exception("Invalid authentication credentials")
77 return authenticate(username = username, password = password)
80 def _dispatch(self, request, method, params):
81 if method not in self.func_map.keys():
82 raise Exception('method "%s" is not supported' % method)
84 auth_required, fn = self.func_map[method]
87 user = self._user_for_request(request)
89 raise Exception("Invalid username/password")
91 params = (user,) + params
95 def _marshaled_dispatch(self, request):
97 params, method = xmlrpclib.loads(request.raw_post_data)
99 response = self._dispatch(request, method, params)
100 # wrap response in a singleton tuple
101 response = (response,)
102 response = xmlrpclib.dumps(response, methodresponse=1,
103 allow_none=self.allow_none, encoding=self.encoding)
104 except xmlrpclib.Fault, fault:
105 response = xmlrpclib.dumps(fault, allow_none=self.allow_none,
106 encoding=self.encoding)
108 # report exception back to server
109 response = xmlrpclib.dumps(
110 xmlrpclib.Fault(1, "%s:%s" % (sys.exc_type, sys.exc_value)),
111 encoding=self.encoding, allow_none=self.allow_none,
116 dispatcher = PatchworkXMLRPCDispatcher()
118 # XMLRPC view function
120 if request.method != 'POST':
121 return HttpResponseRedirect(
122 urlresolvers.reverse('patchwork.views.help',
123 kwargs = {'path': 'pwclient/'}))
125 response = HttpResponse()
127 ret = dispatcher._marshaled_dispatch(request)
130 return HttpResponseServerError()
134 # decorator for XMLRPC methods. Setting login_required to true will call
135 # the decorated function with a non-optional user as the first argument.
136 def xmlrpc_method(login_required = False):
138 dispatcher.register_function(f, login_required)
145 # We allow most of the Django field lookup types for remote queries
146 LOOKUP_TYPES = ["iexact", "contains", "icontains", "gt", "gte", "lt",
147 "in", "startswith", "istartswith", "endswith",
148 "iendswith", "range", "year", "month", "day", "isnull" ]
150 #######################################################################
152 #######################################################################
154 def project_to_dict(obj):
155 """Return a trimmed down dictionary representation of a Project
156 object which is OK to send to the client."""
160 'linkname' : obj.linkname,
164 def person_to_dict(obj):
165 """Return a trimmed down dictionary representation of a Person
166 object which is OK to send to the client."""
172 'user' : str(obj.user),
175 def patch_to_dict(obj):
176 """Return a trimmed down dictionary representation of a Patch
177 object which is OK to send to the client."""
181 'date' : str(obj.date),
182 'filename' : obj.filename(),
185 'project' : str(obj.project),
186 'project_id' : obj.project_id,
187 'state' : str(obj.state),
188 'state_id' : obj.state_id,
189 'submitter' : str(obj.submitter),
190 'submitter_id' : obj.submitter_id,
191 'delegate' : str(obj.delegate),
192 'delegate_id' : max(obj.delegate_id, 0),
193 'commit_ref' : max(obj.commit_ref, ''),
196 def bundle_to_dict(obj):
197 """Return a trimmed down dictionary representation of a Bundle
198 object which is OK to send to the client."""
203 'n_patches' : obj.n_patches(),
204 'public_url' : obj.public_url(),
207 def state_to_dict(obj):
208 """Return a trimmed down dictionary representation of a State
209 object which is OK to send to the client."""
216 #######################################################################
217 # Public XML-RPC methods
218 #######################################################################
220 @xmlrpc_method(False)
221 def pw_rpc_version():
222 """Return Patchwork XML-RPC interface version."""
225 @xmlrpc_method(False)
226 def project_list(search_str="", max_count=0):
227 """Get a list of projects matching the given filters."""
229 if len(search_str) > 0:
230 projects = Project.objects.filter(linkname__icontains = search_str)
232 projects = Project.objects.all()
235 return map(project_to_dict, projects)[:max_count]
237 return map(project_to_dict, projects)
241 @xmlrpc_method(False)
242 def project_get(project_id):
243 """Return structure for the given project ID."""
245 project = Project.objects.filter(id = project_id)[0]
246 return project_to_dict(project)
250 @xmlrpc_method(False)
251 def person_list(search_str="", max_count=0):
252 """Get a list of Person objects matching the given filters."""
254 if len(search_str) > 0:
255 people = (Person.objects.filter(name__icontains = search_str) |
256 Person.objects.filter(email__icontains = search_str))
258 people = Person.objects.all()
261 return map(person_to_dict, people)[:max_count]
263 return map(person_to_dict, people)
268 @xmlrpc_method(False)
269 def person_get(person_id):
270 """Return structure for the given person ID."""
272 person = Person.objects.filter(id = person_id)[0]
273 return person_to_dict(person)
277 @xmlrpc_method(False)
278 def patch_list(filter={}):
279 """Get a list of patches matching the given filters."""
281 # We allow access to many of the fields. But, some fields are
282 # filtered by raw object so we must lookup by ID instead over
303 parts = key.split("__")
304 if parts[0] not in ok_fields:
305 # Invalid field given
308 if LOOKUP_TYPES.count(parts[1]) == 0:
309 # Invalid lookup type given
312 if parts[0] == 'project_id':
313 dfilter['project'] = Project.objects.filter(id =
315 elif parts[0] == 'submitter_id':
316 dfilter['submitter'] = Person.objects.filter(id =
318 elif parts[0] == 'state_id':
319 dfilter['state'] = State.objects.filter(id =
321 elif parts[0] == 'max_count':
322 max_count = filter[key]
324 dfilter[key] = filter[key]
326 patches = Patch.objects.filter(**dfilter)
329 return map(patch_to_dict, patches)[:max_count]
331 return map(patch_to_dict, patches)
336 @xmlrpc_method(False)
337 def patch_get(patch_id):
338 """Return structure for the given patch ID."""
340 patch = Patch.objects.filter(id = patch_id)[0]
341 return patch_to_dict(patch)
345 @xmlrpc_method(False)
346 def patch_get_by_hash(hash):
347 """Return structure for the given patch hash."""
349 patch = Patch.objects.filter(hash = hash)[0]
350 return patch_to_dict(patch)
354 @xmlrpc_method(False)
355 def patch_get_mbox(patch_id):
356 """Return mbox string for the given patch ID."""
358 patch = Patch.objects.filter(id = patch_id)[0]
359 return patch.mbox().as_string()
363 @xmlrpc_method(False)
364 def patch_get_diff(patch_id):
365 """Return diff for the given patch ID."""
367 patch = Patch.objects.filter(id = patch_id)[0]
373 def patch_set(user, patch_id, params):
374 """Update a patch with the key,value pairs in params. Only some parameters
377 ok_params = ['state', 'commit_ref', 'archived']
379 patch = Patch.objects.get(id = patch_id)
381 if not patch.is_editable(user):
382 raise Exception('No permissions to edit this patch')
384 for (k, v) in params.iteritems():
385 if k not in ok_params:
389 patch.state = State.objects.get(id = v)
401 @xmlrpc_method(False)
402 def state_list(search_str="", max_count=0):
403 """Get a list of state structures matching the given search string."""
405 if len(search_str) > 0:
406 states = State.objects.filter(name__icontains = search_str)
408 states = State.objects.all()
411 return map(state_to_dict, states)[:max_count]
413 return map(state_to_dict, states)
417 @xmlrpc_method(False)
418 def state_get(state_id):
419 """Return structure for the given state ID."""
421 state = State.objects.filter(id = state_id)[0]
422 return state_to_dict(state)