blob: 84d8d8133bf06248575a0aad72ae28eed10a7ce7 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
|
# -*- coding: utf-8 -*-
# errors.py
# Copyright (C) 2013 LEAP
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
"""
Soledad errors.
"""
from u1db import errors
from u1db.remote import http_errors
def register_exception(cls):
"""
A small decorator that registers exceptions in u1db maps.
"""
# update u1db "wire description to status" and "wire description to
# exception" maps.
http_errors.wire_description_to_status.update({
cls.wire_description: cls.status})
errors.wire_description_to_exc.update({
cls.wire_description: cls})
# do not modify the exception
return cls
class SoledadError(errors.U1DBError):
"""
Base Soledad HTTP errors.
"""
pass
#
# Authorization errors
#
class DatabaseAccessError(Exception):
pass
@register_exception
class InvalidAuthTokenError(errors.Unauthorized):
"""
Exception raised when failing to get authorization for some action because
the provided token either does not exist in the tokens database, has a
distinct structure from the expected one, or is associated with a user
with a distinct uuid than the one provided by the client.
"""
wire_descrition = "invalid auth token"
status = 401
#
# LockResource errors
#
@register_exception
class InvalidTokenError(SoledadError):
"""
Exception raised when trying to unlock shared database with invalid token.
"""
wire_description = "unlock unauthorized"
status = 401
@register_exception
class NotLockedError(SoledadError):
"""
Exception raised when trying to unlock shared database when it is not
locked.
"""
wire_description = "lock not found"
status = 404
@register_exception
class AlreadyLockedError(SoledadError):
"""
Exception raised when trying to lock shared database but it is already
locked.
"""
wire_description = "lock is locked"
status = 403
@register_exception
class LockTimedOutError(SoledadError):
"""
Exception raised when timing out while trying to lock the shared database.
"""
wire_description = "lock timed out"
status = 408
@register_exception
class CouldNotObtainLockError(SoledadError):
"""
Exception raised when timing out while trying to lock the shared database.
"""
wire_description = "error obtaining lock"
status = 500
#
# SoledadBackend errors
#
@register_exception
class MissingDesignDocError(SoledadError):
"""
Raised when trying to access a missing couch design document.
"""
wire_description = "missing design document"
status = 500
@register_exception
class MissingDesignDocNamedViewError(SoledadError):
"""
Raised when trying to access a missing named view on a couch design
document.
"""
wire_description = "missing design document named function"
status = 500
@register_exception
class MissingDesignDocListFunctionError(SoledadError):
"""
Raised when trying to access a missing list function on a couch design
document.
"""
wire_description = "missing design document list function"
status = 500
@register_exception
class MissingDesignDocDeletedError(SoledadError):
"""
Raised when trying to access a deleted couch design document.
"""
wire_description = "design document was deleted"
status = 500
@register_exception
class DesignDocUnknownError(SoledadError):
"""
Raised when trying to access a couch design document and getting an
unknown error.
"""
wire_description = "missing design document unknown error"
status = 500
# u1db error statuses also have to be updated
http_errors.ERROR_STATUSES = set(
http_errors.wire_description_to_status.values())
class InvalidURLError(Exception):
"""
Exception raised when Soledad encounters a malformed URL.
"""
def raise_missing_design_doc_error(exc, ddoc_path):
"""
Raise an appropriate exception when catching a ResourceNotFound when
accessing a design document.
:param exc: The exception cought.
:type exc: ResourceNotFound
:param ddoc_path: A list representing the requested path.
:type ddoc_path: list
:raise MissingDesignDocError: Raised when tried to access a missing design
document.
:raise MissingDesignDocListFunctionError: Raised when trying to access a
missing list function on a
design document.
:raise MissingDesignDocNamedViewError: Raised when trying to access a
missing named view on a design
document.
:raise MissingDesignDocDeletedError: Raised when trying to access a
deleted design document.
:raise MissingDesignDocUnknownError: Raised when failed to access a design
document for an yet unknown reason.
"""
path = "".join(ddoc_path)
if exc.message[1] == 'missing':
raise MissingDesignDocError(path)
elif exc.message[1] == 'missing function' or \
exc.message[1].startswith('missing lists function'):
raise MissingDesignDocListFunctionError(path)
elif exc.message[1] == 'missing_named_view':
raise MissingDesignDocNamedViewError(path)
elif exc.message[1] == 'deleted':
raise MissingDesignDocDeletedError(path)
# other errors are unknown for now
raise DesignDocUnknownError("%s: %s" % (path, str(exc.message)))
def raise_server_error(exc, ddoc_path):
"""
Raise an appropriate exception when catching a ServerError when
accessing a design document.
:param exc: The exception cought.
:type exc: ResourceNotFound
:param ddoc_path: A list representing the requested path.
:type ddoc_path: list
:raise MissingDesignDocListFunctionError: Raised when trying to access a
missing list function on a
design document.
:raise MissingDesignDocUnknownError: Raised when failed to access a design
document for an yet unknown reason.
"""
path = "".join(ddoc_path)
msg = exc.message[1][0]
if msg == 'unnamed_error':
raise MissingDesignDocListFunctionError(path)
elif msg == 'TypeError':
if 'point is undefined' in exc.message[1][1]:
raise MissingDesignDocListFunctionError
# other errors are unknown for now
raise DesignDocUnknownError("%s: %s" % (path, str(exc.message)))
|
