##// END OF EJS Templates
API fixes...
marcink -
r1489:b951731f beta
parent child Browse files
Show More
@@ -1,228 +1,225
1 1 # -*- coding: utf-8 -*-
2 2 """
3 3 rhodecode.controllers.api
4 4 ~~~~~~~~~~~~~~~~~~~~~~~~~
5 5
6 6 JSON RPC controller
7 7
8 8 :created_on: Aug 20, 2011
9 9 :author: marcink
10 10 :copyright: (C) 2009-2010 Marcin Kuzminski <marcin@python-works.com>
11 11 :license: GPLv3, see COPYING for more details.
12 12 """
13 13 # This program is free software; you can redistribute it and/or
14 14 # modify it under the terms of the GNU General Public License
15 15 # as published by the Free Software Foundation; version 2
16 16 # of the License or (at your opinion) any later version of the license.
17 17 #
18 18 # This program is distributed in the hope that it will be useful,
19 19 # but WITHOUT ANY WARRANTY; without even the implied warranty of
20 20 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 21 # GNU General Public License for more details.
22 22 #
23 23 # You should have received a copy of the GNU General Public License
24 24 # along with this program; if not, write to the Free Software
25 25 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
26 26 # MA 02110-1301, USA.
27 27
28 28 import inspect
29 29 import json
30 30 import logging
31 31 import types
32 32 import urllib
33 33
34 34 from paste.response import replace_header
35 35
36 36 from pylons.controllers import WSGIController
37 37 from pylons.controllers.util import Response
38 38
39 39 from webob.exc import HTTPNotFound, HTTPForbidden, HTTPInternalServerError, \
40 40 HTTPBadRequest, HTTPError
41 41
42 from rhodecode.model.user import User
42 from rhodecode.model.db import User
43 43 from rhodecode.lib.auth import AuthUser
44 44
45 45 log = logging.getLogger('JSONRPC')
46 46
47 47 class JSONRPCError(BaseException):
48 48
49 49 def __init__(self, message):
50 50 self.message = message
51 51
52 52 def __str__(self):
53 53 return str(self.message)
54 54
55 55
56 56 def jsonrpc_error(message, code=None):
57 57 """Generate a Response object with a JSON-RPC error body"""
58 58 return Response(body=json.dumps(dict(result=None,
59 59 error=message)))
60 60
61 61
62 62 class JSONRPCController(WSGIController):
63 63 """
64 64 A WSGI-speaking JSON-RPC controller class
65 65
66 66 See the specification:
67 67 <http://json-rpc.org/wiki/specification>`.
68 68
69 69 Valid controller return values should be json-serializable objects.
70 70
71 71 Sub-classes should catch their exceptions and raise JSONRPCError
72 72 if they want to pass meaningful errors to the client.
73 73
74 74 """
75 75
76 76 def _get_method_args(self):
77 77 """
78 78 Return `self._rpc_args` to dispatched controller method
79 79 chosen by __call__
80 80 """
81 81 return self._rpc_args
82 82
83 83 def __call__(self, environ, start_response):
84 84 """
85 85 Parse the request body as JSON, look up the method on the
86 86 controller and if it exists, dispatch to it.
87 87 """
88
89 88 if 'CONTENT_LENGTH' not in environ:
90 89 log.debug("No Content-Length")
91 return jsonrpc_error(0, "No Content-Length")
90 return jsonrpc_error(message="No Content-Length in request")
92 91 else:
93 92 length = environ['CONTENT_LENGTH'] or 0
94 93 length = int(environ['CONTENT_LENGTH'])
95 94 log.debug('Content-Length: %s', length)
96 95
97 96 if length == 0:
98 97 log.debug("Content-Length is 0")
99 return jsonrpc_error(0, "Content-Length is 0")
98 return jsonrpc_error(message="Content-Length is 0")
100 99
101 100 raw_body = environ['wsgi.input'].read(length)
102 101
103 102 try:
104 103 json_body = json.loads(urllib.unquote_plus(raw_body))
105 104 except ValueError as e:
106 105 #catch JSON errors Here
107 return jsonrpc_error("JSON parse error ERR:%s RAW:%r" \
106 return jsonrpc_error(message="JSON parse error ERR:%s RAW:%r" \
108 107 % (e, urllib.unquote_plus(raw_body)))
109 108
110
111 109 #check AUTH based on API KEY
112
113 110 try:
114 111 self._req_api_key = json_body['api_key']
115 112 self._req_method = json_body['method']
116 113 self._req_params = json_body['args']
117 114 log.debug('method: %s, params: %s',
118 115 self._req_method,
119 116 self._req_params)
120 117 except KeyError as e:
121 118 return jsonrpc_error(message='Incorrect JSON query missing %s' % e)
122 119
123 120 #check if we can find this session using api_key
124 121 try:
125 122 u = User.get_by_api_key(self._req_api_key)
126 123 auth_u = AuthUser(u.user_id, self._req_api_key)
127 124 except Exception as e:
128 125 return jsonrpc_error(message='Invalid API KEY')
129 126
130 127 self._error = None
131 128 try:
132 129 self._func = self._find_method()
133 130 except AttributeError, e:
134 return jsonrpc_error(str(e))
131 return jsonrpc_error(message=str(e))
135 132
136 133 # now that we have a method, add self._req_params to
137 134 # self.kargs and dispatch control to WGIController
138 135 arglist = inspect.getargspec(self._func)[0][1:]
139 136
140 137 # this is little trick to inject logged in user for
141 138 # perms decorators to work they expect the controller class to have
142 139 # rhodecode_user set
143 140 self.rhodecode_user = auth_u
144 141
145 142 if 'user' not in arglist:
146 return jsonrpc_error('This method [%s] does not support '
143 return jsonrpc_error(message='This method [%s] does not support '
147 144 'authentication (missing user param)' %
148 145 self._func.__name__)
149 146
150 147 # get our arglist and check if we provided them as args
151 148 for arg in arglist:
152 149 if arg == 'user':
153 150 # user is something translated from api key and this is
154 151 # checked before
155 152 continue
156 153
157 154 if not self._req_params or arg not in self._req_params:
158 return jsonrpc_error('Missing %s arg in JSON DATA' % arg)
155 return jsonrpc_error(message='Missing %s arg in JSON DATA' % arg)
159 156
160 157 self._rpc_args = dict(user=u)
161 158 self._rpc_args.update(self._req_params)
162 159
163 160 self._rpc_args['action'] = self._req_method
164 161 self._rpc_args['environ'] = environ
165 162 self._rpc_args['start_response'] = start_response
166 163
167 164 status = []
168 165 headers = []
169 166 exc_info = []
170 167 def change_content(new_status, new_headers, new_exc_info=None):
171 168 status.append(new_status)
172 169 headers.extend(new_headers)
173 170 exc_info.append(new_exc_info)
174 171
175 172 output = WSGIController.__call__(self, environ, change_content)
176 173 output = list(output)
177 174 headers.append(('Content-Length', str(len(output[0]))))
178 175 replace_header(headers, 'Content-Type', 'application/json')
179 176 start_response(status[0], headers, exc_info[0])
180 177
181 178 return output
182 179
183 180 def _dispatch_call(self):
184 181 """
185 182 Implement dispatch interface specified by WSGIController
186 183 """
187 184 try:
188 185 raw_response = self._inspect_call(self._func)
189 186 print raw_response
190 187 if isinstance(raw_response, HTTPError):
191 188 self._error = str(raw_response)
192 189 except JSONRPCError as e:
193 190 self._error = str(e)
194 191 except Exception as e:
195 192 log.debug('Encountered unhandled exception: %s', repr(e))
196 193 json_exc = JSONRPCError('Internal server error')
197 194 self._error = str(json_exc)
198 195
199 196 if self._error is not None:
200 197 raw_response = None
201 198
202 199 response = dict(result=raw_response, error=self._error)
203 200
204 201 try:
205 202 return json.dumps(response)
206 203 except TypeError, e:
207 204 log.debug('Error encoding response: %s', e)
208 205 return json.dumps(dict(result=None,
209 206 error="Error encoding response"))
210 207
211 208 def _find_method(self):
212 209 """
213 210 Return method named by `self._req_method` in controller if able
214 211 """
215 212 log.debug('Trying to find JSON-RPC method: %s', self._req_method)
216 213 if self._req_method.startswith('_'):
217 214 raise AttributeError("Method not allowed")
218 215
219 216 try:
220 217 func = getattr(self, self._req_method, None)
221 218 except UnicodeEncodeError:
222 219 raise AttributeError("Problem decoding unicode in requested "
223 220 "method name.")
224 221
225 222 if isinstance(func, types.MethodType):
226 223 return func
227 224 else:
228 225 raise AttributeError("No such method: %s" % self._req_method)
General Comments 0
You need to be logged in to leave comments. Login now