-
Notifications
You must be signed in to change notification settings - Fork 2k
/
resource.py
241 lines (194 loc) · 7.88 KB
/
resource.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
# encoding: utf-8
import datetime
from sqlalchemy.util import OrderedDict
from sqlalchemy.ext.orderinglist import ordering_list
from sqlalchemy import orm
from ckan.common import config
import vdm.sqlalchemy
import vdm.sqlalchemy.stateful
from sqlalchemy import types, func, Column, Table, ForeignKey, and_
import meta
import core
import package as _package
import types as _types
import extension
import activity
import domain_object
import ckan.lib.dictization
from .package import Package
import ckan.model
__all__ = ['Resource', 'resource_table',
'ResourceRevision', 'resource_revision_table',
]
CORE_RESOURCE_COLUMNS = ['url', 'format', 'description', 'hash', 'name',
'resource_type', 'mimetype', 'mimetype_inner',
'size', 'created', 'last_modified', 'cache_url',
'cache_last_updated', 'url_type']
##formally package_resource
resource_table = Table(
'resource', meta.metadata,
Column('id', types.UnicodeText, primary_key=True,
default=_types.make_uuid),
Column('package_id', types.UnicodeText,
ForeignKey('package.id')),
Column('url', types.UnicodeText, nullable=False),
Column('format', types.UnicodeText),
Column('description', types.UnicodeText),
Column('hash', types.UnicodeText),
Column('position', types.Integer),
Column('name', types.UnicodeText),
Column('resource_type', types.UnicodeText),
Column('mimetype', types.UnicodeText),
Column('mimetype_inner', types.UnicodeText),
Column('size', types.BigInteger),
Column('created', types.DateTime, default=datetime.datetime.now),
Column('last_modified', types.DateTime),
Column('cache_url', types.UnicodeText),
Column('cache_last_updated', types.DateTime),
Column('url_type', types.UnicodeText),
Column('extras', _types.JsonDictType),
)
vdm.sqlalchemy.make_table_stateful(resource_table)
resource_revision_table = core.make_revisioned_table(resource_table)
class Resource(vdm.sqlalchemy.RevisionedObjectMixin,
vdm.sqlalchemy.StatefulObjectMixin,
domain_object.DomainObject):
extra_columns = None
def __init__(self, url=u'', format=u'', description=u'', hash=u'',
extras=None, package_id=None, **kwargs):
self.id = _types.make_uuid()
self.url = url
self.format = format
self.description = description
self.hash = hash
self.package_id = package_id
# The base columns historically defaulted to empty strings
# not None (Null). This is why they are seperate here.
base_columns = ['url', 'format', 'description', 'hash']
for key in set(CORE_RESOURCE_COLUMNS) - set(base_columns):
setattr(self, key, kwargs.pop(key, None))
self.extras = extras or {}
extra_columns = self.get_extra_columns()
for field in extra_columns:
value = kwargs.pop(field, None)
if value is not None:
setattr(self, field, value)
if kwargs:
raise TypeError('unexpected keywords %s' % kwargs)
def as_dict(self, core_columns_only=False):
_dict = OrderedDict()
cols = self.get_columns()
if not core_columns_only:
cols = ['id'] + cols + ['position']
for col in cols:
value = getattr(self, col)
if isinstance(value, datetime.datetime):
value = value.isoformat()
_dict[col] = value
for k, v in self.extras.items() if self.extras else []:
_dict[k] = v
if self.package_id and not core_columns_only:
_dict["package_id"] = self.package_id
return _dict
def get_package_id(self):
'''Returns the package id for a resource. '''
return self.package_id
@classmethod
def get(cls, reference):
'''Returns a resource object referenced by its name or id.'''
if not reference:
return None
resource = meta.Session.query(cls).get(reference)
if resource is None:
resource = cls.by_name(reference)
return resource
@classmethod
def get_columns(cls, extra_columns=True):
'''Returns the core editable columns of the resource.'''
if extra_columns:
return CORE_RESOURCE_COLUMNS + cls.get_extra_columns()
else:
return CORE_RESOURCE_COLUMNS
@classmethod
def get_extra_columns(cls):
if cls.extra_columns is None:
cls.extra_columns = config.get(
'ckan.extra_resource_fields', '').split()
for field in cls.extra_columns:
setattr(cls, field, DictProxy(field, 'extras'))
return cls.extra_columns
@classmethod
def get_all_without_views(cls, formats=[]):
'''Returns all resources that have no resource views
:param formats: if given, returns only resources that have no resource
views and are in any of the received formats
:type formats: list
:rtype: list of ckan.model.Resource objects
'''
query = meta.Session.query(cls).outerjoin(ckan.model.ResourceView) \
.filter(ckan.model.ResourceView.id == None)
if formats:
lowercase_formats = [f.lower() for f in formats]
query = query.filter(func.lower(cls.format).in_(lowercase_formats))
return query.all()
def related_packages(self):
return [self.package]
def activity_stream_detail(self, activity_id, activity_type):
import ckan.model as model
# Handle 'deleted' resources.
# When the user marks a resource as deleted this comes through here as
# a 'changed' resource activity. We detect this and change it to a
# 'deleted' activity.
if activity_type == 'changed' and self.state == u'deleted':
activity_type = 'deleted'
res_dict = ckan.lib.dictization.table_dictize(self,
context={'model': model})
return activity.ActivityDetail(activity_id, self.id, u"Resource",
activity_type,
{'resource': res_dict})
## Mappers
meta.mapper(Resource, resource_table, properties={
'package': orm.relation(
Package,
# all resources including deleted
# formally package_resources_all
backref=orm.backref('resources_all',
collection_class=ordering_list('position'),
cascade='all, delete',
order_by=resource_table.c.position,
),
)
},
extension=[vdm.sqlalchemy.Revisioner(resource_revision_table),
extension.PluginMapperExtension(),
],
)
## VDM
vdm.sqlalchemy.modify_base_object_mapper(Resource, core.Revision, core.State)
ResourceRevision = vdm.sqlalchemy.create_object_version(
meta.mapper, Resource, resource_revision_table)
ResourceRevision.related_packages = lambda self: [
self.continuity.resouce_group.package
]
def resource_identifier(obj):
return obj.id
class DictProxy(object):
def __init__(self, target_key, target_dict, data_type=unicode):
self.target_key = target_key
self.target_dict = target_dict
self.data_type = data_type
def __get__(self, obj, type):
if not obj:
return self
proxied_dict = getattr(obj, self.target_dict)
if proxied_dict:
return proxied_dict.get(self.target_key)
def __set__(self, obj, value):
proxied_dict = getattr(obj, self.target_dict)
if proxied_dict is None:
proxied_dict = {}
setattr(obj, self.target_dict, proxied_dict)
proxied_dict[self.target_key] = self.data_type(value)
def __delete__(self, obj):
proxied_dict = getattr(obj, self.target_dict)
proxied_dict.pop(self.target_key)