root / lib / rapi / baserlib.py @ b166ef84
History | View | Annotate | Download (11.2 kB)
1 | c2dca9af | Oleksiy Mishchenko | #
|
---|---|---|---|
2 | c2dca9af | Oleksiy Mishchenko | #
|
3 | c2dca9af | Oleksiy Mishchenko | |
4 | c2dca9af | Oleksiy Mishchenko | # Copyright (C) 2006, 2007, 2008 Google Inc.
|
5 | c2dca9af | Oleksiy Mishchenko | #
|
6 | c2dca9af | Oleksiy Mishchenko | # This program is free software; you can redistribute it and/or modify
|
7 | c2dca9af | Oleksiy Mishchenko | # it under the terms of the GNU General Public License as published by
|
8 | c2dca9af | Oleksiy Mishchenko | # the Free Software Foundation; either version 2 of the License, or
|
9 | c2dca9af | Oleksiy Mishchenko | # (at your option) any later version.
|
10 | c2dca9af | Oleksiy Mishchenko | #
|
11 | c2dca9af | Oleksiy Mishchenko | # This program is distributed in the hope that it will be useful, but
|
12 | c2dca9af | Oleksiy Mishchenko | # WITHOUT ANY WARRANTY; without even the implied warranty of
|
13 | c2dca9af | Oleksiy Mishchenko | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
14 | c2dca9af | Oleksiy Mishchenko | # General Public License for more details.
|
15 | c2dca9af | Oleksiy Mishchenko | #
|
16 | c2dca9af | Oleksiy Mishchenko | # You should have received a copy of the GNU General Public License
|
17 | c2dca9af | Oleksiy Mishchenko | # along with this program; if not, write to the Free Software
|
18 | c2dca9af | Oleksiy Mishchenko | # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
19 | c2dca9af | Oleksiy Mishchenko | # 02110-1301, USA.
|
20 | c2dca9af | Oleksiy Mishchenko | |
21 | c2dca9af | Oleksiy Mishchenko | |
22 | c2dca9af | Oleksiy Mishchenko | """Remote API base resources library.
|
23 | c2dca9af | Oleksiy Mishchenko |
|
24 | c2dca9af | Oleksiy Mishchenko | """
|
25 | c2dca9af | Oleksiy Mishchenko | |
26 | fe267188 | Iustin Pop | # pylint: disable-msg=C0103
|
27 | fe267188 | Iustin Pop | |
28 | fe267188 | Iustin Pop | # C0103: Invalid name, since the R_* names are not conforming
|
29 | fe267188 | Iustin Pop | |
30 | 59b4eeef | Iustin Pop | import logging |
31 | 59b4eeef | Iustin Pop | |
32 | 441e7cfd | Oleksiy Mishchenko | from ganeti import luxi |
33 | b5b67ef9 | Michael Hanselmann | from ganeti import rapi |
34 | 3d103742 | Iustin Pop | from ganeti import http |
35 | 25e39bfa | Iustin Pop | from ganeti import ssconf |
36 | 25e39bfa | Iustin Pop | from ganeti import constants |
37 | 59b4eeef | Iustin Pop | from ganeti import opcodes |
38 | 59b4eeef | Iustin Pop | from ganeti import errors |
39 | 441e7cfd | Oleksiy Mishchenko | |
40 | c2dca9af | Oleksiy Mishchenko | |
41 | af6433c6 | Michael Hanselmann | # Dummy value to detect unchanged parameters
|
42 | af6433c6 | Michael Hanselmann | _DEFAULT = object()
|
43 | af6433c6 | Michael Hanselmann | |
44 | af6433c6 | Michael Hanselmann | |
45 | c2dca9af | Oleksiy Mishchenko | def BuildUriList(ids, uri_format, uri_fields=("name", "uri")): |
46 | c2dca9af | Oleksiy Mishchenko | """Builds a URI list as used by index resources.
|
47 | c2dca9af | Oleksiy Mishchenko |
|
48 | c41eea6e | Iustin Pop | @param ids: list of ids as strings
|
49 | c41eea6e | Iustin Pop | @param uri_format: format to be applied for URI
|
50 | c41eea6e | Iustin Pop | @param uri_fields: optional parameter for field IDs
|
51 | c2dca9af | Oleksiy Mishchenko |
|
52 | c2dca9af | Oleksiy Mishchenko | """
|
53 | c2dca9af | Oleksiy Mishchenko | (field_id, field_uri) = uri_fields |
54 | dca1764e | Iustin Pop | |
55 | c2dca9af | Oleksiy Mishchenko | def _MapId(m_id): |
56 | c2dca9af | Oleksiy Mishchenko | return { field_id: m_id, field_uri: uri_format % m_id, }
|
57 | c2dca9af | Oleksiy Mishchenko | |
58 | c2dca9af | Oleksiy Mishchenko | # Make sure the result is sorted, makes it nicer to look at and simplifies
|
59 | c2dca9af | Oleksiy Mishchenko | # unittests.
|
60 | c2dca9af | Oleksiy Mishchenko | ids.sort() |
61 | c2dca9af | Oleksiy Mishchenko | |
62 | c2dca9af | Oleksiy Mishchenko | return map(_MapId, ids) |
63 | c2dca9af | Oleksiy Mishchenko | |
64 | c2dca9af | Oleksiy Mishchenko | |
65 | c2dca9af | Oleksiy Mishchenko | def ExtractField(sequence, index): |
66 | c2dca9af | Oleksiy Mishchenko | """Creates a list containing one column out of a list of lists.
|
67 | c2dca9af | Oleksiy Mishchenko |
|
68 | c41eea6e | Iustin Pop | @param sequence: sequence of lists
|
69 | c41eea6e | Iustin Pop | @param index: index of field
|
70 | c2dca9af | Oleksiy Mishchenko |
|
71 | c2dca9af | Oleksiy Mishchenko | """
|
72 | c2dca9af | Oleksiy Mishchenko | return map(lambda item: item[index], sequence) |
73 | c2dca9af | Oleksiy Mishchenko | |
74 | c2dca9af | Oleksiy Mishchenko | |
75 | c2dca9af | Oleksiy Mishchenko | def MapFields(names, data): |
76 | c2dca9af | Oleksiy Mishchenko | """Maps two lists into one dictionary.
|
77 | c2dca9af | Oleksiy Mishchenko |
|
78 | c41eea6e | Iustin Pop | Example::
|
79 | c41eea6e | Iustin Pop | >>> MapFields(["a", "b"], ["foo", 123])
|
80 | c41eea6e | Iustin Pop | {'a': 'foo', 'b': 123}
|
81 | c2dca9af | Oleksiy Mishchenko |
|
82 | c41eea6e | Iustin Pop | @param names: field names (list of strings)
|
83 | c41eea6e | Iustin Pop | @param data: field data (list)
|
84 | c2dca9af | Oleksiy Mishchenko |
|
85 | c2dca9af | Oleksiy Mishchenko | """
|
86 | c2dca9af | Oleksiy Mishchenko | if len(names) != len(data): |
87 | c2dca9af | Oleksiy Mishchenko | raise AttributeError("Names and data must have the same length") |
88 | dca1764e | Iustin Pop | return dict(zip(names, data)) |
89 | c2dca9af | Oleksiy Mishchenko | |
90 | c2dca9af | Oleksiy Mishchenko | |
91 | 64246438 | Iustin Pop | def _Tags_GET(kind, name): |
92 | c2dca9af | Oleksiy Mishchenko | """Helper function to retrieve tags.
|
93 | c2dca9af | Oleksiy Mishchenko |
|
94 | c2dca9af | Oleksiy Mishchenko | """
|
95 | 25e39bfa | Iustin Pop | if kind == constants.TAG_INSTANCE or kind == constants.TAG_NODE: |
96 | 25e39bfa | Iustin Pop | if not name: |
97 | 59b4eeef | Iustin Pop | raise http.HttpBadRequest("Missing name on tag request") |
98 | 59b4eeef | Iustin Pop | cl = GetClient() |
99 | 25e39bfa | Iustin Pop | if kind == constants.TAG_INSTANCE:
|
100 | 25e39bfa | Iustin Pop | fn = cl.QueryInstances |
101 | 25e39bfa | Iustin Pop | else:
|
102 | 25e39bfa | Iustin Pop | fn = cl.QueryNodes |
103 | 25e39bfa | Iustin Pop | result = fn(names=[name], fields=["tags"], use_locking=False) |
104 | 25e39bfa | Iustin Pop | if not result or not result[0]: |
105 | 25e39bfa | Iustin Pop | raise http.HttpBadGateway("Invalid response from tag query") |
106 | 25e39bfa | Iustin Pop | tags = result[0][0] |
107 | 25e39bfa | Iustin Pop | elif kind == constants.TAG_CLUSTER:
|
108 | 25e39bfa | Iustin Pop | ssc = ssconf.SimpleStore() |
109 | 25e39bfa | Iustin Pop | tags = ssc.GetClusterTags() |
110 | 25e39bfa | Iustin Pop | |
111 | c2dca9af | Oleksiy Mishchenko | return list(tags) |
112 | c2dca9af | Oleksiy Mishchenko | |
113 | c2dca9af | Oleksiy Mishchenko | |
114 | 64246438 | Iustin Pop | def _Tags_PUT(kind, tags, name, dry_run): |
115 | 441e7cfd | Oleksiy Mishchenko | """Helper function to set tags.
|
116 | 441e7cfd | Oleksiy Mishchenko |
|
117 | 441e7cfd | Oleksiy Mishchenko | """
|
118 | d1602edc | Iustin Pop | return SubmitJob([opcodes.OpTagsSet(kind=kind, name=name,
|
119 | 64246438 | Iustin Pop | tags=tags, dry_run=dry_run)]) |
120 | 441e7cfd | Oleksiy Mishchenko | |
121 | 441e7cfd | Oleksiy Mishchenko | |
122 | 64246438 | Iustin Pop | def _Tags_DELETE(kind, tags, name, dry_run): |
123 | 15fd9fd5 | Oleksiy Mishchenko | """Helper function to delete tags.
|
124 | 15fd9fd5 | Oleksiy Mishchenko |
|
125 | 15fd9fd5 | Oleksiy Mishchenko | """
|
126 | 3f0ab95f | Iustin Pop | return SubmitJob([opcodes.OpTagsDel(kind=kind, name=name,
|
127 | 64246438 | Iustin Pop | tags=tags, dry_run=dry_run)]) |
128 | 15fd9fd5 | Oleksiy Mishchenko | |
129 | 15fd9fd5 | Oleksiy Mishchenko | |
130 | 51ee2f49 | Oleksiy Mishchenko | def MapBulkFields(itemslist, fields): |
131 | 51ee2f49 | Oleksiy Mishchenko | """Map value to field name in to one dictionary.
|
132 | 51ee2f49 | Oleksiy Mishchenko |
|
133 | c41eea6e | Iustin Pop | @param itemslist: a list of items values
|
134 | c41eea6e | Iustin Pop | @param fields: a list of items names
|
135 | c41eea6e | Iustin Pop |
|
136 | c41eea6e | Iustin Pop | @return: a list of mapped dictionaries
|
137 | 51ee2f49 | Oleksiy Mishchenko |
|
138 | 51ee2f49 | Oleksiy Mishchenko | """
|
139 | 51ee2f49 | Oleksiy Mishchenko | items_details = [] |
140 | 51ee2f49 | Oleksiy Mishchenko | for item in itemslist: |
141 | 51ee2f49 | Oleksiy Mishchenko | mapped = MapFields(fields, item) |
142 | 51ee2f49 | Oleksiy Mishchenko | items_details.append(mapped) |
143 | 51ee2f49 | Oleksiy Mishchenko | return items_details
|
144 | 51ee2f49 | Oleksiy Mishchenko | |
145 | 51ee2f49 | Oleksiy Mishchenko | |
146 | d50b3059 | Oleksiy Mishchenko | def MakeParamsDict(opts, params): |
147 | c41eea6e | Iustin Pop | """Makes params dictionary out of a option set.
|
148 | d50b3059 | Oleksiy Mishchenko |
|
149 | d50b3059 | Oleksiy Mishchenko | This function returns a dictionary needed for hv or be parameters. But only
|
150 | d50b3059 | Oleksiy Mishchenko | those fields which provided in the option set. Takes parameters frozensets
|
151 | d50b3059 | Oleksiy Mishchenko | from constants.
|
152 | d50b3059 | Oleksiy Mishchenko |
|
153 | d50b3059 | Oleksiy Mishchenko | @type opts: dict
|
154 | d50b3059 | Oleksiy Mishchenko | @param opts: selected options
|
155 | d50b3059 | Oleksiy Mishchenko | @type params: frozenset
|
156 | d50b3059 | Oleksiy Mishchenko | @param params: subset of options
|
157 | d50b3059 | Oleksiy Mishchenko | @rtype: dict
|
158 | d50b3059 | Oleksiy Mishchenko | @return: dictionary of options, filtered by given subset.
|
159 | d50b3059 | Oleksiy Mishchenko |
|
160 | d50b3059 | Oleksiy Mishchenko | """
|
161 | d50b3059 | Oleksiy Mishchenko | result = {} |
162 | d50b3059 | Oleksiy Mishchenko | |
163 | d50b3059 | Oleksiy Mishchenko | for p in params: |
164 | d50b3059 | Oleksiy Mishchenko | try:
|
165 | d50b3059 | Oleksiy Mishchenko | value = opts[p] |
166 | d50b3059 | Oleksiy Mishchenko | except KeyError: |
167 | d50b3059 | Oleksiy Mishchenko | continue
|
168 | d50b3059 | Oleksiy Mishchenko | result[p] = value |
169 | d50b3059 | Oleksiy Mishchenko | |
170 | d50b3059 | Oleksiy Mishchenko | return result
|
171 | d50b3059 | Oleksiy Mishchenko | |
172 | d50b3059 | Oleksiy Mishchenko | |
173 | b166ef84 | Michael Hanselmann | def FillOpcode(opcls, body, static, rename=None): |
174 | cfaeaaf7 | Michael Hanselmann | """Fills an opcode with body parameters.
|
175 | cfaeaaf7 | Michael Hanselmann |
|
176 | cfaeaaf7 | Michael Hanselmann | Parameter types are checked.
|
177 | cfaeaaf7 | Michael Hanselmann |
|
178 | cfaeaaf7 | Michael Hanselmann | @type opcls: L{opcodes.OpCode}
|
179 | cfaeaaf7 | Michael Hanselmann | @param opcls: Opcode class
|
180 | cfaeaaf7 | Michael Hanselmann | @type body: dict
|
181 | cfaeaaf7 | Michael Hanselmann | @param body: Body parameters as received from client
|
182 | cfaeaaf7 | Michael Hanselmann | @type static: dict
|
183 | cfaeaaf7 | Michael Hanselmann | @param static: Static parameters which can't be modified by client
|
184 | b166ef84 | Michael Hanselmann | @type rename: dict
|
185 | b166ef84 | Michael Hanselmann | @param rename: Renamed parameters, key as old name, value as new name
|
186 | cfaeaaf7 | Michael Hanselmann | @return: Opcode object
|
187 | cfaeaaf7 | Michael Hanselmann |
|
188 | cfaeaaf7 | Michael Hanselmann | """
|
189 | cfaeaaf7 | Michael Hanselmann | CheckType(body, dict, "Body contents") |
190 | cfaeaaf7 | Michael Hanselmann | |
191 | b166ef84 | Michael Hanselmann | # Make copy to be modified
|
192 | b166ef84 | Michael Hanselmann | params = body.copy() |
193 | b166ef84 | Michael Hanselmann | |
194 | b166ef84 | Michael Hanselmann | if rename:
|
195 | b166ef84 | Michael Hanselmann | for old, new in rename.items(): |
196 | b166ef84 | Michael Hanselmann | if new in params and old in params: |
197 | b166ef84 | Michael Hanselmann | raise http.HttpBadRequest("Parameter '%s' was renamed to '%s', but" |
198 | b166ef84 | Michael Hanselmann | " both are specified" %
|
199 | b166ef84 | Michael Hanselmann | (old, new)) |
200 | b166ef84 | Michael Hanselmann | if old in params: |
201 | b166ef84 | Michael Hanselmann | assert new not in params |
202 | b166ef84 | Michael Hanselmann | params[new] = params.pop(old) |
203 | b166ef84 | Michael Hanselmann | |
204 | cfaeaaf7 | Michael Hanselmann | if static:
|
205 | b166ef84 | Michael Hanselmann | overwritten = set(params.keys()) & set(static.keys()) |
206 | cfaeaaf7 | Michael Hanselmann | if overwritten:
|
207 | cfaeaaf7 | Michael Hanselmann | raise http.HttpBadRequest("Can't overwrite static parameters %r" % |
208 | cfaeaaf7 | Michael Hanselmann | overwritten) |
209 | cfaeaaf7 | Michael Hanselmann | |
210 | cfaeaaf7 | Michael Hanselmann | params.update(static) |
211 | cfaeaaf7 | Michael Hanselmann | |
212 | cfaeaaf7 | Michael Hanselmann | # Convert keys to strings (simplejson decodes them as unicode)
|
213 | cfaeaaf7 | Michael Hanselmann | params = dict((str(key), value) for (key, value) in params.items()) |
214 | cfaeaaf7 | Michael Hanselmann | |
215 | cfaeaaf7 | Michael Hanselmann | try:
|
216 | cfaeaaf7 | Michael Hanselmann | op = opcls(**params) # pylint: disable-msg=W0142
|
217 | cfaeaaf7 | Michael Hanselmann | op.Validate(False)
|
218 | cfaeaaf7 | Michael Hanselmann | except (errors.OpPrereqError, TypeError), err: |
219 | cfaeaaf7 | Michael Hanselmann | raise http.HttpBadRequest("Invalid body parameters: %s" % err) |
220 | cfaeaaf7 | Michael Hanselmann | |
221 | cfaeaaf7 | Michael Hanselmann | return op
|
222 | cfaeaaf7 | Michael Hanselmann | |
223 | cfaeaaf7 | Michael Hanselmann | |
224 | 59b4eeef | Iustin Pop | def SubmitJob(op, cl=None): |
225 | 59b4eeef | Iustin Pop | """Generic wrapper for submit job, for better http compatibility.
|
226 | 59b4eeef | Iustin Pop |
|
227 | 59b4eeef | Iustin Pop | @type op: list
|
228 | 59b4eeef | Iustin Pop | @param op: the list of opcodes for the job
|
229 | 59b4eeef | Iustin Pop | @type cl: None or luxi.Client
|
230 | 59b4eeef | Iustin Pop | @param cl: optional luxi client to use
|
231 | 59b4eeef | Iustin Pop | @rtype: string
|
232 | 59b4eeef | Iustin Pop | @return: the job ID
|
233 | 59b4eeef | Iustin Pop |
|
234 | 59b4eeef | Iustin Pop | """
|
235 | 59b4eeef | Iustin Pop | try:
|
236 | 59b4eeef | Iustin Pop | if cl is None: |
237 | 59b4eeef | Iustin Pop | cl = GetClient() |
238 | 59b4eeef | Iustin Pop | return cl.SubmitJob(op)
|
239 | 59b4eeef | Iustin Pop | except errors.JobQueueFull:
|
240 | 59b4eeef | Iustin Pop | raise http.HttpServiceUnavailable("Job queue is full, needs archiving") |
241 | 59b4eeef | Iustin Pop | except errors.JobQueueDrainError:
|
242 | 59b4eeef | Iustin Pop | raise http.HttpServiceUnavailable("Job queue is drained, cannot submit") |
243 | 59b4eeef | Iustin Pop | except luxi.NoMasterError, err:
|
244 | 5a1c22fe | Iustin Pop | raise http.HttpBadGateway("Master seems to be unreachable: %s" % str(err)) |
245 | 5a1c22fe | Iustin Pop | except luxi.PermissionError:
|
246 | 5a1c22fe | Iustin Pop | raise http.HttpInternalServerError("Internal error: no permission to" |
247 | 5a1c22fe | Iustin Pop | " connect to the master daemon")
|
248 | 59b4eeef | Iustin Pop | except luxi.TimeoutError, err:
|
249 | 59b4eeef | Iustin Pop | raise http.HttpGatewayTimeout("Timeout while talking to the master" |
250 | 59b4eeef | Iustin Pop | " daemon. Error: %s" % str(err)) |
251 | 59b4eeef | Iustin Pop | |
252 | e8ebbd2b | Michael Hanselmann | |
253 | e8ebbd2b | Michael Hanselmann | def HandleItemQueryErrors(fn, *args, **kwargs): |
254 | e8ebbd2b | Michael Hanselmann | """Converts errors when querying a single item.
|
255 | e8ebbd2b | Michael Hanselmann |
|
256 | e8ebbd2b | Michael Hanselmann | """
|
257 | e8ebbd2b | Michael Hanselmann | try:
|
258 | e8ebbd2b | Michael Hanselmann | return fn(*args, **kwargs)
|
259 | e8ebbd2b | Michael Hanselmann | except errors.OpPrereqError, err:
|
260 | e8ebbd2b | Michael Hanselmann | if len(err.args) == 2 and err.args[1] == errors.ECODE_NOENT: |
261 | e8ebbd2b | Michael Hanselmann | raise http.HttpNotFound()
|
262 | e8ebbd2b | Michael Hanselmann | |
263 | e8ebbd2b | Michael Hanselmann | raise
|
264 | e8ebbd2b | Michael Hanselmann | |
265 | e8ebbd2b | Michael Hanselmann | |
266 | 59b4eeef | Iustin Pop | def GetClient(): |
267 | 59b4eeef | Iustin Pop | """Geric wrapper for luxi.Client(), for better http compatiblity.
|
268 | 59b4eeef | Iustin Pop |
|
269 | 59b4eeef | Iustin Pop | """
|
270 | 59b4eeef | Iustin Pop | try:
|
271 | 59b4eeef | Iustin Pop | return luxi.Client()
|
272 | 59b4eeef | Iustin Pop | except luxi.NoMasterError, err:
|
273 | 59b4eeef | Iustin Pop | raise http.HttpBadGateway("Master seems to unreachable: %s" % str(err)) |
274 | 5a1c22fe | Iustin Pop | except luxi.PermissionError:
|
275 | 5a1c22fe | Iustin Pop | raise http.HttpInternalServerError("Internal error: no permission to" |
276 | 5a1c22fe | Iustin Pop | " connect to the master daemon")
|
277 | 59b4eeef | Iustin Pop | |
278 | 59b4eeef | Iustin Pop | |
279 | e51ca051 | Michael Hanselmann | def FeedbackFn(msg): |
280 | e51ca051 | Michael Hanselmann | """Feedback logging function for jobs.
|
281 | 59b4eeef | Iustin Pop |
|
282 | 59b4eeef | Iustin Pop | We don't have a stdout for printing log messages, so log them to the
|
283 | 59b4eeef | Iustin Pop | http log at least.
|
284 | 59b4eeef | Iustin Pop |
|
285 | e51ca051 | Michael Hanselmann | @param msg: the message
|
286 | 2d54e29c | Iustin Pop |
|
287 | 59b4eeef | Iustin Pop | """
|
288 | e51ca051 | Michael Hanselmann | (_, log_type, log_msg) = msg |
289 | 59b4eeef | Iustin Pop | logging.info("%s: %s", log_type, log_msg)
|
290 | 59b4eeef | Iustin Pop | |
291 | 59b4eeef | Iustin Pop | |
292 | af6433c6 | Michael Hanselmann | def CheckType(value, exptype, descr): |
293 | af6433c6 | Michael Hanselmann | """Abort request if value type doesn't match expected type.
|
294 | af6433c6 | Michael Hanselmann |
|
295 | af6433c6 | Michael Hanselmann | @param value: Value
|
296 | af6433c6 | Michael Hanselmann | @type exptype: type
|
297 | af6433c6 | Michael Hanselmann | @param exptype: Expected type
|
298 | af6433c6 | Michael Hanselmann | @type descr: string
|
299 | af6433c6 | Michael Hanselmann | @param descr: Description of value
|
300 | af6433c6 | Michael Hanselmann | @return: Value (allows inline usage)
|
301 | af6433c6 | Michael Hanselmann |
|
302 | af6433c6 | Michael Hanselmann | """
|
303 | af6433c6 | Michael Hanselmann | if not isinstance(value, exptype): |
304 | af6433c6 | Michael Hanselmann | raise http.HttpBadRequest("%s: Type is '%s', but '%s' is expected" % |
305 | af6433c6 | Michael Hanselmann | (descr, type(value).__name__, exptype.__name__))
|
306 | af6433c6 | Michael Hanselmann | |
307 | af6433c6 | Michael Hanselmann | return value
|
308 | af6433c6 | Michael Hanselmann | |
309 | af6433c6 | Michael Hanselmann | |
310 | af6433c6 | Michael Hanselmann | def CheckParameter(data, name, default=_DEFAULT, exptype=_DEFAULT): |
311 | af6433c6 | Michael Hanselmann | """Check and return the value for a given parameter.
|
312 | af6433c6 | Michael Hanselmann |
|
313 | af6433c6 | Michael Hanselmann | If no default value was given and the parameter doesn't exist in the input
|
314 | af6433c6 | Michael Hanselmann | data, an error is raise.
|
315 | af6433c6 | Michael Hanselmann |
|
316 | af6433c6 | Michael Hanselmann | @type data: dict
|
317 | af6433c6 | Michael Hanselmann | @param data: Dictionary containing input data
|
318 | af6433c6 | Michael Hanselmann | @type name: string
|
319 | af6433c6 | Michael Hanselmann | @param name: Parameter name
|
320 | af6433c6 | Michael Hanselmann | @param default: Default value (can be None)
|
321 | af6433c6 | Michael Hanselmann | @param exptype: Expected type (can be None)
|
322 | af6433c6 | Michael Hanselmann |
|
323 | af6433c6 | Michael Hanselmann | """
|
324 | af6433c6 | Michael Hanselmann | try:
|
325 | af6433c6 | Michael Hanselmann | value = data[name] |
326 | af6433c6 | Michael Hanselmann | except KeyError: |
327 | af6433c6 | Michael Hanselmann | if default is not _DEFAULT: |
328 | af6433c6 | Michael Hanselmann | return default
|
329 | af6433c6 | Michael Hanselmann | |
330 | af6433c6 | Michael Hanselmann | raise http.HttpBadRequest("Required parameter '%s' is missing" % |
331 | af6433c6 | Michael Hanselmann | name) |
332 | af6433c6 | Michael Hanselmann | |
333 | af6433c6 | Michael Hanselmann | if exptype is _DEFAULT: |
334 | af6433c6 | Michael Hanselmann | return value
|
335 | af6433c6 | Michael Hanselmann | |
336 | af6433c6 | Michael Hanselmann | return CheckType(value, exptype, "'%s' parameter" % name) |
337 | af6433c6 | Michael Hanselmann | |
338 | af6433c6 | Michael Hanselmann | |
339 | c2dca9af | Oleksiy Mishchenko | class R_Generic(object): |
340 | c2dca9af | Oleksiy Mishchenko | """Generic class for resources.
|
341 | c2dca9af | Oleksiy Mishchenko |
|
342 | c2dca9af | Oleksiy Mishchenko | """
|
343 | b5b67ef9 | Michael Hanselmann | # Default permission requirements
|
344 | b5b67ef9 | Michael Hanselmann | GET_ACCESS = [] |
345 | b5b67ef9 | Michael Hanselmann | PUT_ACCESS = [rapi.RAPI_ACCESS_WRITE] |
346 | b5b67ef9 | Michael Hanselmann | POST_ACCESS = [rapi.RAPI_ACCESS_WRITE] |
347 | b5b67ef9 | Michael Hanselmann | DELETE_ACCESS = [rapi.RAPI_ACCESS_WRITE] |
348 | b5b67ef9 | Michael Hanselmann | |
349 | 7a8f64da | Oleksiy Mishchenko | def __init__(self, items, queryargs, req): |
350 | c2dca9af | Oleksiy Mishchenko | """Generic resource constructor.
|
351 | c2dca9af | Oleksiy Mishchenko |
|
352 | c41eea6e | Iustin Pop | @param items: a list with variables encoded in the URL
|
353 | c41eea6e | Iustin Pop | @param queryargs: a dictionary with additional options from URL
|
354 | c2dca9af | Oleksiy Mishchenko |
|
355 | c2dca9af | Oleksiy Mishchenko | """
|
356 | c2dca9af | Oleksiy Mishchenko | self.items = items
|
357 | c2dca9af | Oleksiy Mishchenko | self.queryargs = queryargs
|
358 | 627ad739 | Michael Hanselmann | self._req = req
|
359 | 627ad739 | Michael Hanselmann | |
360 | 2feecf12 | Michael Hanselmann | def _GetRequestBody(self): |
361 | 2feecf12 | Michael Hanselmann | """Returns the body data.
|
362 | 2feecf12 | Michael Hanselmann |
|
363 | 2feecf12 | Michael Hanselmann | """
|
364 | 2feecf12 | Michael Hanselmann | return self._req.private.body_data |
365 | 2feecf12 | Michael Hanselmann | |
366 | 2feecf12 | Michael Hanselmann | request_body = property(fget=_GetRequestBody)
|
367 | 3d103742 | Iustin Pop | |
368 | 3fb8680a | Michael Hanselmann | def _checkIntVariable(self, name, default=0): |
369 | 3d103742 | Iustin Pop | """Return the parsed value of an int argument.
|
370 | 3d103742 | Iustin Pop |
|
371 | 3d103742 | Iustin Pop | """
|
372 | 3fb8680a | Michael Hanselmann | val = self.queryargs.get(name, default)
|
373 | 3d103742 | Iustin Pop | if isinstance(val, list): |
374 | 3d103742 | Iustin Pop | if val:
|
375 | 3d103742 | Iustin Pop | val = val[0]
|
376 | 3d103742 | Iustin Pop | else:
|
377 | 3fb8680a | Michael Hanselmann | val = default |
378 | 3d103742 | Iustin Pop | try:
|
379 | 3d103742 | Iustin Pop | val = int(val)
|
380 | 7c4d6c7b | Michael Hanselmann | except (ValueError, TypeError): |
381 | 6e99c5a0 | Iustin Pop | raise http.HttpBadRequest("Invalid value for the" |
382 | 3d103742 | Iustin Pop | " '%s' parameter" % (name,))
|
383 | 3d103742 | Iustin Pop | return val
|
384 | 3d103742 | Iustin Pop | |
385 | e5b7c4ca | Iustin Pop | def _checkStringVariable(self, name, default=None): |
386 | e5b7c4ca | Iustin Pop | """Return the parsed value of an int argument.
|
387 | e5b7c4ca | Iustin Pop |
|
388 | e5b7c4ca | Iustin Pop | """
|
389 | e5b7c4ca | Iustin Pop | val = self.queryargs.get(name, default)
|
390 | e5b7c4ca | Iustin Pop | if isinstance(val, list): |
391 | e5b7c4ca | Iustin Pop | if val:
|
392 | e5b7c4ca | Iustin Pop | val = val[0]
|
393 | e5b7c4ca | Iustin Pop | else:
|
394 | e5b7c4ca | Iustin Pop | val = default |
395 | e5b7c4ca | Iustin Pop | return val
|
396 | 3d103742 | Iustin Pop | |
397 | 6e99c5a0 | Iustin Pop | def getBodyParameter(self, name, *args): |
398 | 6e99c5a0 | Iustin Pop | """Check and return the value for a given parameter.
|
399 | 6e99c5a0 | Iustin Pop |
|
400 | 6e99c5a0 | Iustin Pop | If a second parameter is not given, an error will be returned,
|
401 | 6e99c5a0 | Iustin Pop | otherwise this parameter specifies the default value.
|
402 | 6e99c5a0 | Iustin Pop |
|
403 | 6e99c5a0 | Iustin Pop | @param name: the required parameter
|
404 | 6e99c5a0 | Iustin Pop |
|
405 | 6e99c5a0 | Iustin Pop | """
|
406 | af6433c6 | Michael Hanselmann | if args:
|
407 | 1c54156d | Luca Bigliardi | return CheckParameter(self.request_body, name, default=args[0]) |
408 | ab221ddf | Michael Hanselmann | |
409 | 1c54156d | Luca Bigliardi | return CheckParameter(self.request_body, name) |
410 | 6e99c5a0 | Iustin Pop | |
411 | 3d103742 | Iustin Pop | def useLocking(self): |
412 | 3d103742 | Iustin Pop | """Check if the request specifies locking.
|
413 | 3d103742 | Iustin Pop |
|
414 | 3d103742 | Iustin Pop | """
|
415 | b939de46 | Michael Hanselmann | return bool(self._checkIntVariable("lock")) |
416 | 3d103742 | Iustin Pop | |
417 | 3d103742 | Iustin Pop | def useBulk(self): |
418 | 3d103742 | Iustin Pop | """Check if the request specifies bulk querying.
|
419 | 3d103742 | Iustin Pop |
|
420 | 3d103742 | Iustin Pop | """
|
421 | b939de46 | Michael Hanselmann | return bool(self._checkIntVariable("bulk")) |
422 | 6f59b964 | Iustin Pop | |
423 | 3427d34f | Michael Hanselmann | def useForce(self): |
424 | 3427d34f | Michael Hanselmann | """Check if the request specifies a forced operation.
|
425 | 3427d34f | Michael Hanselmann |
|
426 | 3427d34f | Michael Hanselmann | """
|
427 | b939de46 | Michael Hanselmann | return bool(self._checkIntVariable("force")) |
428 | 3427d34f | Michael Hanselmann | |
429 | 6f59b964 | Iustin Pop | def dryRun(self): |
430 | 6f59b964 | Iustin Pop | """Check if the request specifies dry-run mode.
|
431 | 6f59b964 | Iustin Pop |
|
432 | 6f59b964 | Iustin Pop | """
|
433 | b939de46 | Michael Hanselmann | return bool(self._checkIntVariable("dry-run")) |