-
Notifications
You must be signed in to change notification settings - Fork 8
/
resources.py
345 lines (285 loc) · 9.8 KB
/
resources.py
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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
# See http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/resources.html
import logging
from collections import Mapping
from pyramid.decorator import reify
from pyramid.httpexceptions import HTTPInternalServerError
from pyramid.security import (
Allow,
Everyone,
)
from pyramid.traversal import resource_path
from .calculated import (
calculate_properties,
calculated_property,
)
from .interfaces import (
COLLECTIONS,
CONNECTION,
ROOT,
TYPES,
UPGRADER,
)
from .validation import ValidationFailure
from .util import (
ensurelist,
quick_deepcopy,
simple_path_ids,
)
logger = logging.getLogger(__name__)
def includeme(config):
config.scan(__name__)
class Resource(object):
@calculated_property(name='@id', schema={
"title": "ID",
"type": "string",
})
def jsonld_id(self, request):
return request.resource_path(self)
@calculated_property(name='@context', category='page')
def jsonld_context(self, request):
return request.route_path('jsonld_context')
@calculated_property(category='page')
def actions(self, request):
actions = calculate_properties(self, request, category='action')
if actions:
return list(actions.values())
class Root(Resource):
__name__ = ''
__parent__ = None
__acl__ = [
(Allow, 'remoteuser.INDEXER', ['view', 'list', 'index']),
(Allow, 'remoteuser.EMBED', ['view', 'expand', 'audit']),
(Allow, Everyone, ['visible_for_edit']),
]
def __init__(self, registry):
self.registry = registry
@reify
def connection(self):
return self.registry[CONNECTION]
@reify
def collections(self):
return self.registry[COLLECTIONS]
def __getitem__(self, name):
try:
resource = self.get(name)
except KeyError:
# Just in case we get an unexpected KeyError
# FIXME: exception logging.
raise HTTPInternalServerError('Traversal raised KeyError')
if resource is None:
raise KeyError(name)
return resource
def __contains__(self, name):
return self.get(name, None) is not None
def get(self, name, default=None):
resource = self.collections.get(name, None)
if resource is not None:
return resource
resource = self.connection.get_by_uuid(name, None)
if resource is not None:
return resource
return default
def __json__(self, request=None):
return self.properties.copy()
@calculated_property(name='@type', schema={
"title": "Type",
"type": "array",
"items": {
"type": "string",
},
})
def jsonld_type(self):
return ['Portal']
class AbstractCollection(Resource, Mapping):
properties = {}
unique_key = None
def __init__(self, registry, name, type_info, properties=None, acl=None, unique_key=None):
self.registry = registry
self.__name__ = name
self.type_info = type_info
if properties is not None:
self.properties = properties
if acl is not None:
self.__acl__ = acl
if unique_key is not None:
self.unique_key = unique_key
@reify
def connection(self):
return self.registry[CONNECTION]
@reify
def __parent__(self):
return self.registry[ROOT]
def __getitem__(self, name):
try:
item = self.get(name)
except KeyError:
# Just in case we get an unexpected KeyError
# FIXME: exception logging.
raise HTTPInternalServerError('Traversal raised KeyError')
if item is None:
raise KeyError(name)
return item
def __iter__(self):
for uuid in self.connection.__iter__(*self.type_info.subtypes):
yield uuid
def __len__(self):
return self.connection.__len__(*self.type_info.subtypes)
def __hash__(self):
return object.__hash__(self)
def __eq__(self, other):
return self is other
def _allow_contained(self, resource):
return resource.__parent__ is self or \
resource.type_info.name in resource.type_info.subtypes
def get(self, name, default=None):
resource = self.connection.get_by_uuid(name, None)
if resource is not None:
if not self._allow_contained(resource):
return default
return resource
if self.unique_key is not None:
# Give the storage a hint of which index to search.
# If this is a collection of an abstract type,
# the item_type will be None and we'll search all snovault indices.
index = getattr(self.type_info, 'item_type', None)
resource = self.connection.get_by_unique_key(
self.unique_key, name, index=index)
if resource is not None:
if not self._allow_contained(resource):
return default
return resource
return default
def __json__(self, request):
return self.properties.copy()
@calculated_property(name='@type', schema={
"title": "Type",
"type": "array",
"items": {
"type": "string",
},
})
def jsonld_type(self):
return [
'{type_name}Collection'.format(type_name=self.type_info.name),
'Collection',
]
class Collection(AbstractCollection):
''' Separate class so add views do not apply to AbstractCollection '''
class Item(Resource):
item_type = None
base_types = ['Item']
name_key = None
rev = {}
embedded = ()
audit_inherit = []
schema = None
AbstractCollection = AbstractCollection
Collection = Collection
def __init__(self, registry, model):
self.registry = registry
self.model = model
def __repr__(self):
return '<%s at %s>' % (type(self).__name__, resource_path(self))
@reify
def type_info(self):
return self.registry[TYPES][type(self)]
@reify
def collection(self):
collections = self.registry[COLLECTIONS]
return collections[self.type_info.name]
@property
def __parent__(self):
return self.collection
@property
def __name__(self):
if self.name_key is None:
return str(self.uuid)
return self.properties.get(self.name_key, None) or str(self.uuid)
@property
def properties(self):
return self.model.properties
@property
def propsheets(self):
return self.model.propsheets
@property
def uuid(self):
return self.model.uuid
@property
def tid(self):
return self.model.tid
def links(self, properties):
return {
path: set(simple_path_ids(properties, path))
for path in self.type_info.schema_links
}
def get_rev_links(self, name):
types = self.registry[TYPES]
type_name, rel = self.rev[name]
types = types[type_name].subtypes
return self.registry[CONNECTION].get_rev_links(self.model, rel, *types)
def unique_keys(self, properties):
return {
name: [v for prop in props for v in ensurelist(properties.get(prop, ()))]
for name, props in self.type_info.schema_keys.items()
}
def upgrade_properties(self):
properties = quick_deepcopy(self.properties)
current_version = properties.get('schema_version', '')
target_version = self.type_info.schema_version
if target_version is not None and current_version != target_version:
upgrader = self.registry[UPGRADER]
try:
properties = upgrader.upgrade(
self.type_info.name, properties, current_version, target_version,
context=self, registry=self.registry)
except RuntimeError:
raise
except Exception:
logger.warning(
'Unable to upgrade %s from %r to %r',
resource_path(self.__parent__, self.uuid),
current_version, target_version, exc_info=True)
return properties
def __json__(self, request):
# Record embedding objects
request._embedded_uuids.add(str(self.uuid))
return self.upgrade_properties()
def __resource_url__(self, request, info):
# Record linking objects
request._linked_uuids.add(str(self.uuid))
return None
@classmethod
def create(cls, registry, uuid, properties, sheets=None):
model = registry[CONNECTION].create(cls.__name__, uuid)
self = cls(registry, model)
self._update(properties, sheets)
return self
def update(self, properties, sheets=None):
self._update(properties, sheets)
def _update(self, properties, sheets=None):
unique_keys = None
links = None
if properties is not None:
if 'uuid' in properties:
properties = properties.copy()
del properties['uuid']
unique_keys = self.unique_keys(properties)
for k, values in unique_keys.items():
if len(set(values)) != len(values):
msg = "Duplicate keys for %r: %r" % (k, values)
raise ValidationFailure('body', [], msg)
links = self.links(properties)
connection = self.registry[CONNECTION]
connection.update(self.model, properties, sheets, unique_keys, links)
@calculated_property(name='@type', schema={
"title": "Type",
"type": "array",
"items": {
"type": "string",
},
})
def jsonld_type(self):
return [self.type_info.name] + self.base_types
@calculated_property(name='uuid')
def prop_uuid(self):
return str(self.uuid)