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,
42 def _dumps(obj, *args, **kwargs):
43 kwargs['allow_none'] = self.allow_none
44 kwargs['encoding'] = self.encoding
45 return xmlrpclib.dumps(obj, *args, **kwargs)
47 def _dumps(obj, *args, **kwargs):
48 return xmlrpclib.dumps(obj, *args, **kwargs)
49 SimpleXMLRPCDispatcher.__init__(self)
53 # map of name => (auth, func)
56 def register_function(self, fn, auth_required):
57 self.func_map[fn.__name__] = (auth_required, fn)
60 def _user_for_request(self, request):
63 if request.META.has_key('HTTP_AUTHORIZATION'):
64 auth_header = request.META.get('HTTP_AUTHORIZATION')
65 elif request.META.has_key('Authorization'):
66 auth_header = request.META.get('Authorization')
68 if auth_header is None or auth_header == '':
69 raise Exception("No authentication credentials given")
71 str = auth_header.strip()
73 if not str.startswith('Basic '):
74 raise Exception("Authentication scheme not supported")
76 str = str[len('Basic '):].strip()
79 decoded = base64.decodestring(str)
80 username, password = decoded.split(':', 1)
82 raise Exception("Invalid authentication credentials")
84 return authenticate(username = username, password = password)
87 def _dispatch(self, request, method, params):
88 if method not in self.func_map.keys():
89 raise Exception('method "%s" is not supported' % method)
91 auth_required, fn = self.func_map[method]
94 user = self._user_for_request(request)
96 raise Exception("Invalid username/password")
98 params = (user,) + params
102 def _marshaled_dispatch(self, request):
104 params, method = xmlrpclib.loads(request.raw_post_data)
106 response = self._dispatch(request, method, params)
107 # wrap response in a singleton tuple
108 response = (response,)
109 response = self.dumps(response, methodresponse=1)
110 except xmlrpclib.Fault, fault:
111 response = self.dumps(fault)
113 # report exception back to server
114 response = self.dumps(
115 xmlrpclib.Fault(1, "%s:%s" % (sys.exc_type, sys.exc_value)),
120 dispatcher = PatchworkXMLRPCDispatcher()
122 # XMLRPC view function
124 if request.method != 'POST':
125 return HttpResponseRedirect(
126 urlresolvers.reverse('patchwork.views.help',
127 kwargs = {'path': 'pwclient/'}))
129 response = HttpResponse()
131 ret = dispatcher._marshaled_dispatch(request)
134 return HttpResponseServerError()
138 # decorator for XMLRPC methods. Setting login_required to true will call
139 # the decorated function with a non-optional user as the first argument.
140 def xmlrpc_method(login_required = False):
142 dispatcher.register_function(f, login_required)
149 # We allow most of the Django field lookup types for remote queries
150 LOOKUP_TYPES = ["iexact", "contains", "icontains", "gt", "gte", "lt",
151 "in", "startswith", "istartswith", "endswith",
152 "iendswith", "range", "year", "month", "day", "isnull" ]
154 #######################################################################
156 #######################################################################
158 def project_to_dict(obj):
159 """Return a trimmed down dictionary representation of a Project
160 object which is OK to send to the client."""
164 'linkname' : obj.linkname,
168 def person_to_dict(obj):
169 """Return a trimmed down dictionary representation of a Person
170 object which is OK to send to the client."""
176 'user' : str(obj.user),
179 def patch_to_dict(obj):
180 """Return a trimmed down dictionary representation of a Patch
181 object which is OK to send to the client."""
185 'date' : str(obj.date),
186 'filename' : obj.filename(),
189 'project' : str(obj.project),
190 'project_id' : obj.project_id,
191 'state' : str(obj.state),
192 'state_id' : obj.state_id,
193 'submitter' : str(obj.submitter),
194 'submitter_id' : obj.submitter_id,
195 'delegate' : str(obj.delegate),
196 'delegate_id' : max(obj.delegate_id, 0),
197 'commit_ref' : max(obj.commit_ref, ''),
200 def bundle_to_dict(obj):
201 """Return a trimmed down dictionary representation of a Bundle
202 object which is OK to send to the client."""
207 'n_patches' : obj.n_patches(),
208 'public_url' : obj.public_url(),
211 def state_to_dict(obj):
212 """Return a trimmed down dictionary representation of a State
213 object which is OK to send to the client."""
220 #######################################################################
221 # Public XML-RPC methods
222 #######################################################################
224 @xmlrpc_method(False)
225 def pw_rpc_version():
226 """Return Patchwork XML-RPC interface version."""
229 @xmlrpc_method(False)
230 def project_list(search_str="", max_count=0):
231 """Get a list of projects matching the given filters."""
233 if len(search_str) > 0:
234 projects = Project.objects.filter(linkname__icontains = search_str)
236 projects = Project.objects.all()
239 return map(project_to_dict, projects)[:max_count]
241 return map(project_to_dict, projects)
245 @xmlrpc_method(False)
246 def project_get(project_id):
247 """Return structure for the given project ID."""
249 project = Project.objects.filter(id = project_id)[0]
250 return project_to_dict(project)
254 @xmlrpc_method(False)
255 def person_list(search_str="", max_count=0):
256 """Get a list of Person objects matching the given filters."""
258 if len(search_str) > 0:
259 people = (Person.objects.filter(name__icontains = search_str) |
260 Person.objects.filter(email__icontains = search_str))
262 people = Person.objects.all()
265 return map(person_to_dict, people)[:max_count]
267 return map(person_to_dict, people)
272 @xmlrpc_method(False)
273 def person_get(person_id):
274 """Return structure for the given person ID."""
276 person = Person.objects.filter(id = person_id)[0]
277 return person_to_dict(person)
281 @xmlrpc_method(False)
282 def patch_list(filter={}):
283 """Get a list of patches matching the given filters."""
285 # We allow access to many of the fields. But, some fields are
286 # filtered by raw object so we must lookup by ID instead over
307 parts = key.split("__")
308 if parts[0] not in ok_fields:
309 # Invalid field given
312 if LOOKUP_TYPES.count(parts[1]) == 0:
313 # Invalid lookup type given
316 if parts[0] == 'project_id':
317 dfilter['project'] = Project.objects.filter(id =
319 elif parts[0] == 'submitter_id':
320 dfilter['submitter'] = Person.objects.filter(id =
322 elif parts[0] == 'state_id':
323 dfilter['state'] = State.objects.filter(id =
325 elif parts[0] == 'max_count':
326 max_count = filter[key]
328 dfilter[key] = filter[key]
330 patches = Patch.objects.filter(**dfilter)
333 return map(patch_to_dict, patches)[:max_count]
335 return map(patch_to_dict, patches)
340 @xmlrpc_method(False)
341 def patch_get(patch_id):
342 """Return structure for the given patch ID."""
344 patch = Patch.objects.filter(id = patch_id)[0]
345 return patch_to_dict(patch)
349 @xmlrpc_method(False)
350 def patch_get_by_hash(hash):
351 """Return structure for the given patch hash."""
353 patch = Patch.objects.filter(hash = hash)[0]
354 return patch_to_dict(patch)
358 @xmlrpc_method(False)
359 def patch_get_mbox(patch_id):
360 """Return mbox string for the given patch ID."""
362 patch = Patch.objects.filter(id = patch_id)[0]
363 return patch.mbox().as_string()
367 @xmlrpc_method(False)
368 def patch_get_diff(patch_id):
369 """Return diff for the given patch ID."""
371 patch = Patch.objects.filter(id = patch_id)[0]
377 def patch_set(user, patch_id, params):
378 """Update a patch with the key,value pairs in params. Only some parameters
381 ok_params = ['state', 'commit_ref', 'archived']
383 patch = Patch.objects.get(id = patch_id)
385 if not patch.is_editable(user):
386 raise Exception('No permissions to edit this patch')
388 for (k, v) in params.iteritems():
389 if k not in ok_params:
393 patch.state = State.objects.get(id = v)
405 @xmlrpc_method(False)
406 def state_list(search_str="", max_count=0):
407 """Get a list of state structures matching the given search string."""
409 if len(search_str) > 0:
410 states = State.objects.filter(name__icontains = search_str)
412 states = State.objects.all()
415 return map(state_to_dict, states)[:max_count]
417 return map(state_to_dict, states)
421 @xmlrpc_method(False)
422 def state_get(state_id):
423 """Return structure for the given state ID."""
425 state = State.objects.filter(id = state_id)[0]
426 return state_to_dict(state)