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
|
# -*- coding: utf-8 -*-
# _blobs/resource.py
# Copyright (C) 2017 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/>.
"""
A Twisted Web resource for blobs.
"""
import json
from twisted.python.compat import intToBytes
from twisted.python.compat import networkString
from twisted.web import resource
from twisted.web.client import FileBodyProducer
from twisted.web.server import NOT_DONE_YET
from leap.soledad.common.blobs import InvalidFlag
from leap.soledad.server import interfaces
from .fs_backend import FilesystemBlobsBackend
from .errors import BlobNotFound
from .errors import BlobExists
from .errors import ImproperlyConfiguredException
from .errors import QuotaExceeded
from .errors import RangeNotSatisfiable
from .util import VALID_STRINGS
from leap.soledad.common.log import getLogger
logger = getLogger(__name__)
def _catchBlobNotFound(failure, request, user, blob_id):
failure.trap(BlobNotFound)
logger.error("Error 404: Blob %s does not exist for user %s"
% (blob_id, user))
request.setResponseCode(404)
request.write("Blob doesn't exist: %s" % blob_id)
request.finish()
def _catchBlobExists(failure, request, user, blob_id):
failure.trap(BlobExists)
logger.error("Error 409: Blob %s already exists for user %s"
% (blob_id, user))
request.setResponseCode(409)
request.write("Blob already exists: %s" % blob_id)
request.finish()
def _catchQuotaExceeded(failure, request, user):
failure.trap(QuotaExceeded)
logger.error("Error 507: Quota exceeded for user: %s" % user)
request.setResponseCode(507)
request.write('Quota Exceeded!')
request.finish()
def _catchInvalidFlag(failure, request, user, blob_id):
failure.trap(InvalidFlag)
flag = failure.value.message
logger.error("Error 406: Attempted to set invalid flag %s for blob %s "
"for user %s" % (flag, blob_id, user))
request.setResponseCode(406)
request.write("Invalid flag: %s" % str(flag))
request.finish()
def _catchAllErrors(self, e, request):
logger.error('Error processing request: %s' % e.getErrorMessage())
request.setResponseCode(500)
request.finish()
class BlobsResource(resource.Resource):
isLeaf = True
# Allowed backend classes are defined here
handlers = {"filesystem": FilesystemBlobsBackend}
def __init__(self, backend, blobs_path, **backend_kwargs):
resource.Resource.__init__(self)
self._blobs_path = blobs_path
backend_kwargs.update({'blobs_path': blobs_path})
if backend not in self.handlers:
raise ImproperlyConfiguredException("No such backend: %s", backend)
self._handler = self.handlers[backend](**backend_kwargs)
assert interfaces.IBlobsBackend.providedBy(self._handler)
# TODO double check credentials, we can have then
# under request.
def _only_count(self, request, user, namespace):
d = self._handler.count(user, namespace)
d.addCallback(lambda count: json.dumps({"count": count}))
d.addCallback(lambda count: request.write(count))
d.addCallback(lambda _: request.finish())
return NOT_DONE_YET
def _list(self, request, user, namespace):
order = request.args.get('order_by', [None])[0]
filter_flag = request.args.get('filter_flag', [False])[0]
deleted = request.args.get('deleted', [False])[0]
d = self._handler.list_blobs(user, namespace,
order_by=order, deleted=deleted,
filter_flag=filter_flag)
d.addCallback(lambda blobs: json.dumps(blobs))
d.addCallback(lambda blobs: request.write(blobs))
d.addCallback(lambda _: request.finish())
return NOT_DONE_YET
def _only_flags(self, request, user, blob_id, namespace):
d = self._handler.get_flags(user, blob_id, namespace)
d.addCallback(lambda flags: json.dumps(flags))
d.addCallback(lambda flags: request.write(flags))
d.addCallback(lambda _: request.finish())
d.addErrback(_catchBlobNotFound, request, user, blob_id)
d.addErrback(_catchAllErrors, request)
return NOT_DONE_YET
def _get_blob(self, request, user, blob_id, namespace, range):
def _set_tag_header(tag):
request.responseHeaders.setRawHeaders('Tag', [tag])
def _read_blob(_):
handler = self._handler
consumer = request
d = handler.read_blob(
user, blob_id, consumer, namespace=namespace, range=range)
return d
d = self._handler.get_tag(user, blob_id, namespace)
d.addCallback(_set_tag_header)
d.addCallback(_read_blob)
d.addErrback(_catchBlobNotFound, request, user, blob_id)
d.addErrback(_catchAllErrors, request, finishRequest=True)
return NOT_DONE_YET
def _parseRange(self, range):
if not range:
return None
try:
kind, value = range.split(b'=', 1)
if kind.strip() != b'bytes':
raise Exception('Unknown unit: %s' % kind)
start, end = value.split('-')
start = int(start) if start else None
end = int(end) if end else None
return start, end
except Exception as e:
raise RangeNotSatisfiable(e)
def render_GET(self, request):
logger.info("http get: %s" % request.path)
user, blob_id, namespace = self._validate(request)
only_flags = request.args.get('only_flags', [False])[0]
if not blob_id and request.args.get('only_count', [False])[0]:
return self._only_count(request, user, namespace)
if not blob_id:
return self._list(request, user, namespace)
if only_flags:
return self._only_flags(request, user, blob_id, namespace)
def _handleRangeHeader(size):
try:
range = self._parseRange(request.getHeader('Range'))
except RangeNotSatisfiable:
content_range = 'bytes */%d' % size
content_range = networkString(content_range)
request.setResponseCode(416)
request.setHeader(b'content-range', content_range)
request.finish()
return
if not range:
start = end = None
request.setResponseCode(200)
request.setHeader(b'content-length', intToBytes(size))
else:
start, end = range
content_range = 'bytes %d-%d/%d' % (start, end, size)
content_range = networkString(content_range)
length = intToBytes(end - start)
request.setResponseCode(206)
request.setHeader(b'content-range', content_range)
request.setHeader(b'content-length', length)
return self._get_blob(request, user, blob_id, namespace, range)
d = self._handler.get_blob_size(user, blob_id, namespace=namespace)
d.addCallback(_handleRangeHeader)
d.addErrback(_catchBlobNotFound, request, user, blob_id)
d.addErrback(_catchAllErrors, request)
return NOT_DONE_YET
def render_DELETE(self, request):
logger.info("http put: %s" % request.path)
user, blob_id, namespace = self._validate(request)
d = self._handler.delete_blob(user, blob_id, namespace=namespace)
d.addCallback(lambda _: request.finish())
d.addErrback(_catchBlobNotFound, request, user, blob_id)
d.addErrback(_catchAllErrors, request)
return NOT_DONE_YET
def render_PUT(self, request):
logger.info("http put: %s" % request.path)
user, blob_id, namespace = self._validate(request)
producer = FileBodyProducer(request.content)
handler = self._handler
d = handler.write_blob(user, blob_id, producer, namespace=namespace)
d.addCallback(lambda _: request.finish())
d.addErrback(_catchBlobExists, request, user, blob_id)
d.addErrback(_catchQuotaExceeded, request, user)
d.addErrback(_catchAllErrors, request)
return NOT_DONE_YET
def render_POST(self, request):
logger.info("http post: %s" % request.path)
user, blob_id, namespace = self._validate(request)
raw_flags = request.content.read()
flags = json.loads(raw_flags)
d = self._handler.set_flags(user, blob_id, flags, namespace=namespace)
d.addCallback(lambda _: request.write(''))
d.addCallback(lambda _: request.finish())
d.addErrback(_catchBlobNotFound, request, user, blob_id)
d.addErrback(_catchInvalidFlag, request, user, blob_id)
d.addErrback(_catchAllErrors, request)
return NOT_DONE_YET
def _validate(self, request):
for arg in request.postpath:
if arg and not VALID_STRINGS.match(arg):
raise Exception('Invalid blob resource argument: %s' % arg)
namespace = request.args.get('namespace', ['default'])[0]
if namespace and not VALID_STRINGS.match(namespace):
raise Exception('Invalid blob namespace: %s' % namespace)
return request.postpath + [namespace]
|
