/
resource.py
637 lines (512 loc) · 21.1 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
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
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
#
# Copyright (c) 2016 Helmut Merz helmutm@cy55.de
#
# 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 2 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, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
"""
Definition of the Concept class.
"""
from cStringIO import StringIO
from logging import getLogger
from persistent import Persistent
from zope import component, schema
from zope.app.container.btree import BTreeContainer
from zope.app.container.contained import Contained
from zope.app.file.image import Image
from zope.app.security.interfaces import IAuthentication
from zope.contenttype import guess_content_type
from zope.filerepresentation.interfaces import IReadFile, IWriteFile
from zope.cachedescriptors.property import Lazy
from zope.component import adapts
from zope.dublincore.interfaces import IZopeDublinCore
from zope.filerepresentation.interfaces import IFileFactory
from zope.i18nmessageid import MessageFactory
from zope.interface import implements
from zope.size.interfaces import ISized
from zope.security.proxy import removeSecurityProxy
from zope.traversing.api import getName, getParent
from zope.lifecycleevent import ObjectModifiedEvent, Attributes
from zope.event import notify
from cybertools.relation.registry import getRelations
from cybertools.relation.interfaces import IRelatable
from cybertools.storage.interfaces import IExternalStorage
from cybertools.text.interfaces import ITextTransform
from cybertools.typology.interfaces import IType, ITypeManager
from cybertools.util.jeep import Jeep
from loops.base import ParentInfo
from loops.common import ResourceAdapterBase, adapted
from loops.concept import ResourceRelation
from loops.interfaces import IBaseResource, IResource
from loops.interfaces import IFile, IExternalFile, INote
from loops.interfaces import IDocument, ITextDocument, IDocumentSchema, IDocumentView
from loops.interfaces import IMediaAsset, IMediaAssetView
from loops.interfaces import IResourceManager, IResourceManagerContained
from loops.interfaces import ITypeConcept
from loops.interfaces import ILoopsContained
from loops.interfaces import IIndexAttributes
from loops.security.common import canListObject
from loops import util
from loops.versioning.util import getMaster
from loops.view import TargetRelation
logger = getLogger('loops.resource')
_ = MessageFactory('loops')
class ResourceManager(BTreeContainer):
implements(IResourceManager, ILoopsContained)
def getLoopsRoot(self):
return getParent(self)
def getConceptManager(self):
return self.getLoopsRoot().getConceptManager()
def getViewManager(self):
return self.getLoopsRoot().getViewManager()
def getAllParents(self, collectGrants=False):
return Jeep()
class Resource(Image, Contained):
# TODO: remove dependency on Image
implements(IBaseResource, IResource, IResourceManagerContained,
IRelatable, ISized)
proxyInterface = IMediaAssetView # obsolete!
storageName = None
metaInfo = u''
_size = _width = _height = 0
def __init__(self, title=u''):
super(Resource, self).__init__()
self.title = title
_title = u''
def getTitle(self): return self._title
def setTitle(self, title): self._title = title
title = property(getTitle, setTitle)
_description = u''
def getDescription(self): return self._description
def setDescription(self, description): self._description = description
description = property(getDescription, setDescription)
def getResourceType(self):
cm = self.getLoopsRoot().getConceptManager()
typePred = cm.getTypePredicate()
if typePred is None:
return None
concepts = self.getConcepts([typePred], noSecurityCheck=True)
# TODO (?): check for multiple types (->Error)
return concepts and concepts[0] or cm.get('file', None)
def setResourceType(self, concept):
if concept is None: # this should not happen
return
current = self.getResourceType()
if current != concept:
# change storage if necessary, and migrate data
oldType = IType(self)
from loops.type import ConceptTypeInfo
newType = ConceptTypeInfo(concept)
self.migrateStorage(oldType, newType)
# assign new type parent
typePred = self.getLoopsRoot().getConceptManager().getTypePredicate()
if typePred is None:
raise ValueError('No type predicate found for ' + getName(self))
if current is not None:
self.deassignConcept(current, [typePred])
self.assignConcept(concept, typePred)
resourceType = property(getResourceType, setResourceType)
def getType(self):
return self.resourceType
def setType(self, value):
self.resourceType = value
def _setData(self, data):
dataFile = StringIO(data) # let File tear it into pieces
super(Resource, self)._setData(dataFile)
if not self.contentType:
self.guessContentType(data)
self._size = len(data)
data = property(Image._getData, _setData)
def guessContentType(self, data):
# probably obsolete, use zope.contenttype.guess_content_type()
if not isinstance(data, str): # seems to be a file object
data = data.read(20)
if data.startswith('%PDF'):
self.contentType = 'application/pdf'
_contentType = u''
def setContentType(self, contentType):
if contentType:
self._contentType = contentType
def getContentType(self): return self._contentType
contentType = property(getContentType, setContentType)
def getLoopsRoot(self):
return getParent(self).getLoopsRoot()
def getConceptManager(self):
return self.getLoopsRoot().getConceptManager()
def getAllParents(self, collectGrants=False, ignoreTypes=False):
result = Jeep()
for rel in self.getConceptRelations():
if (ignoreTypes and
rel.predicate == self.getConceptManager().getTypePredicate()):
continue
obj = rel.first
uid = util.getUidForObject(obj)
pi = result.setdefault(uid, ParentInfo(obj))
if rel not in pi.relations:
pi.relations.append(rel)
obj.getAllParents(collectGrants, result, ignoreTypes)
return result
# concept relations
# note: we always use the master version for relations, see getMaster()
def getClients(self, relationships=None):
if relationships is None:
relationships = [TargetRelation]
obj = getMaster(self) # use the master version for relations
rels = getRelations(second=obj, relationships=relationships)
return [r.first for r in rels if canListObject(r.first)]
def getConceptRelations (self, predicates=None, concept=None, sort='default',
noSecurityCheck=False):
predicates = predicates is None and ['r*'] or predicates
obj = getMaster(self)
relationships = [ResourceRelation(None, obj, p) for p in predicates]
if sort == 'default':
#sort = lambda x: (x.order, x.first.title.lower())
sort = lambda x: (x.first.title.lower())
rels = (r for r in getRelations(first=concept, second=obj,
relationships=relationships)
if canListObject(r.first, noSecurityCheck))
return sorted(rels, key=sort)
def getConcepts(self, predicates=None, noSecurityCheck=False):
obj = getMaster(self)
return [r.first for r in obj.getConceptRelations(predicates,
noSecurityCheck=noSecurityCheck)]
# simplify common access for concepts and resources:
getParentRelations = getConceptRelations
getParents = getConcepts
def assignConcept(self, concept, predicate=None, order=0, relevance=1.0):
obj = getMaster(self)
concept.assignResource(obj, predicate, order, relevance)
def deassignConcept(self, concept, predicates=None):
obj = getMaster(self)
concept.deassignResource(obj, predicates)
# ISized interface
def getSize(self):
if self._size:
return self._size
adobj = adapted(self)
size = getattr(adobj, 'size', None)
if size is None:
return len(adobj.data)
return size
def sizeForSorting(self):
return 'byte', self.getSize()
def sizeForDisplay(self):
size = self.getSize()
kb = 1024.0
unit = 'B'
if size < kb:
return '%.0f %s' % (size, unit)
unit = 'kB'
size = size / kb
if size >= kb:
unit = 'MB'
size = size / kb
size = round(size, 1)
return '%.1f %s' % (size, unit)
#return '%s %s' % (util.getNiceNumber(size), unit)
# storage migration
def migrateStorage(self, oldType, newType):
oldType = removeSecurityProxy(oldType)
newType = removeSecurityProxy(newType)
context = removeSecurityProxy(self)
oldAdapted = newAdapted = context
oldTi = removeSecurityProxy(oldType.typeInterface)
if oldTi is not None:
oldAdapted = oldTi(context, None)
if oldAdapted is None: # nothing to migrate
return
newTi = removeSecurityProxy(newType.typeInterface)
newOptions = {}
if newTi is not None:
newAdapted = newTi(context, None)
if newAdapted is not None:
# make sure we use options of new type:
newOptions = newType.optionsDict
object.__setattr__(newAdapted, 'options', newOptions)
#print 'migrateStorage:', newAdapted, newOptions, oldAdapted, oldAdapted.storageName
if newAdapted is not None and newOptions.get('storage') != oldAdapted.storageName:
data = oldAdapted.data
#print 'data', data
oldAdapted.data = '' # clear old storage
context._storageName = None # let's take storage from new type options
context._storageParams = None # "
if data: # do not write empty files
newAdapted.data = data
# Document and MediaAsset are legacy classes, will become obsolete
class Document(Resource):
implements(IDocument)
proxyInterface = IDocumentView
def __init__(self, title=u''):
self.title = title
_data = u''
def setData(self, data):
self._data = data.replace('\r', '')
self._size = len(data)
def getData(self):
return self._data
data = property(getData, setData)
class MediaAsset(Resource):
implements(IMediaAsset)
# type adapters
class FileAdapter(ResourceAdapterBase):
""" A type adapter for providing file functionality for resources.
"""
implements(IFile)
_contextAttributes = list(IFile) + list(IBaseResource)
_adapterAttributes = ResourceAdapterBase._adapterAttributes + ('data',)
externalAddress = None
def setData(self, data):
#if self.storageName is None:
# self.storageName = 'zopefile'
self.storageName = None
self.context.data = data
def getData(self): return self.context.data
data = property(getData, setData)
@Lazy
def options(self):
return IType(self.context).optionsDict
def getStorageName(self):
return (getattr(self.context, '_storageName', None)
or self.options.get('storage', None))
def setStorageName(self, value):
self.context._storageName = value
storageName = property(getStorageName, setStorageName)
class ExternalFileAdapter(FileAdapter):
implements(IExternalFile)
_adapterAttributes = (FileAdapter._adapterAttributes
+ ('storageParams', 'externalAddress', 'uniqueAddress',
'processingErrors'))
processingErrors = []
def getStorageParams(self):
params = getattr(self.context, '_storageParams', None)
if params is not None:
return params
else:
value = self.options.get('storage_parameters') or 'extfiles'
return dict(subdirectory=value)
def setStorageParams(self, value):
self.context._storageParams = value
storageParams = property(getStorageParams, setStorageParams)
def getExternalAddress(self):
return getattr(self.context, '_externalAddress', None) or self.context.__name__
def setExternalAddress(self, addr):
self.context._externalAddress = addr
if addr:
data = self.data
self.context._size = len(data)
contentType = guess_content_type(addr, self.data[:100])
if contentType:
self.contentType = contentType[0]
externalAddress = property(getExternalAddress, setExternalAddress)
localFilename = externalAddress
@property
def uniqueAddress(self):
storageParams = self.storageParams
storageName = self.storageName
storage = component.getUtility(IExternalStorage, name=storageName)
return storage.getUniqueAddress(self.externalAddress, storageParams)
def setData(self, data):
storageParams = self.storageParams
storageName = self.storageName
externalAddress = self.externalAddress
storage = component.getUtility(IExternalStorage, name=storageName)
storage.setData(self.externalAddress, data, params=storageParams)
self.context._size = len(data)
# remember storage settings:
self.storageParams = storageParams
self.storageName = storageName
self.externalAddress = externalAddress
def getData(self):
if self.storageName in ('unknown', None): # object not set up yet
return ''
return self.storage.getData(self.externalAddress, params=self.storageParams)
data = property(getData, setData)
@property
def size(self):
if self.storageName in ('unknown', None): # object not set up yet
return ''
return self.storage.getSize(self.externalAddress, params=self.storageParams)
@Lazy
def storage(self):
return component.getUtility(IExternalStorage, name=self.storageName)
@Lazy
def modified(self):
return self.storage.getMTime(self.externalAddress, self.storageParams)
def copyDataFile(self, targetParams, targetAddress=None):
storageParams = self.storageParams
externalAddress = self.externalAddress
self.storage.copyDataFile(self.externalAddress, self.storageParams,
targetAddress or self.externalAddress,
targetParams)
class DocumentAdapter(ResourceAdapterBase):
""" Common base class for all resource types with a text-like
data attribute.
"""
# let the adapter handle the data attribute:
_adapterAttributes = ResourceAdapterBase._adapterAttributes + ('data',)
def setData(self, data):
self.context._data = data.replace('\r', '')
self.context._size = len(data)
def getData(self): return self.context._data
data = property(getData, setData)
class TextDocumentAdapter(DocumentAdapter):
""" A type adapter for providing text document functionality for resources.
"""
implements(ITextDocument)
_contextAttributes = list(ITextDocument) + list(IBaseResource)
class NoteAdapter(DocumentAdapter):
""" A note is a short text document with an associated link.
"""
implements(INote)
_contextAttributes = list(INote) + list(IBaseResource)
@property
def description(self):
return self.data.replace('\n', ' ')
# other adapters
class DocumentWriteFileAdapter(object):
implements(IWriteFile)
adapts(IResource)
def __init__(self, context):
self.context = context
def write(self, data):
#ti = IType(self.context).typeInterface
#context = ti is None and self.context or ti(self.context)
context = adapted(self.context)
if ITextDocument.providedBy(context) or IDocument.providedBy(context):
#context.data = unicode(data.replace('\r', ''), 'UTF-8')
context.data = util.toUnicode(data.replace('\r', ''))
else:
# don't decode files or external files even if contentType == 'text/...'
# TODO: make use of tmpfile when using external files
context.data = data
notify(ObjectModifiedEvent(self.context, Attributes(IResource, 'data')))
class DocumentReadFileAdapter(object):
implements(IReadFile)
adapts(IResource)
def __init__(self, context):
self.context = context
@Lazy
def data(self):
return adapted(self.context).data
def read(self):
data = self.data
if type(data) is unicode:
return self.data.encode('UTF-8')
else:
return data
def size(self):
return len(self.data)
class ExternalFileFactory(object):
implements(IFileFactory)
adapts(IResourceManager)
def __init__(self, context):
self.context = removeSecurityProxy(context)
def __call__(self, name, contentType, data):
res = Resource()
self.context[name] = res # to be able to set resourceType
cm = self.context.getLoopsRoot().getConceptManager()
res.resourceType = cm['extfile']
obj = adapted(res)
obj.contentType = contentType
obj.data = data
notify(ObjectModifiedEvent(res))
del self.context[name] # will be set again by put
return res
class IndexAttributes(object):
implements(IIndexAttributes)
adapts(IResource)
def __init__(self, context):
self.context = context
def text(self):
actx = adapted(self.context)
txt = transformToText(actx)
if txt is not None:
return txt
if not actx.contentType.startswith('text'):
return u''
data = actx.data
if type(data) != unicode:
try:
data = data.decode('UTF-8')
except UnicodeDecodeError:
data = data.decode('ISO8859-15')
return data
def xx_text(self):
context = self.context
ti = IType(context).typeInterface
if ti is not None:
adapted = ti(context)
transform = component.queryAdapter(adapted, ITextTransform,
name=context.contentType)
if transform is not None:
rfa = component.queryAdapter(IReadFile, adapted)
if rfa is None:
data = transform(StringIO(adapted.data))
return data
else:
return transform(rfa)
if not context.contentType.startswith('text'):
return u''
data = context.data
if type(data) != unicode:
data = data.decode('UTF-8')
return data
def title(self):
context = self.context
return ' '.join([getName(context),
context.title, context.description] +
self.creators()).strip()
def creators(self):
cr = IZopeDublinCore(self.context).creators or []
pau = component.getUtility(IAuthentication)
creators = []
for c in cr:
principal = pau.getPrincipal(c)
if principal is not None:
creators.append(principal.title)
return creators
def identifier(self):
return getName(self.context)
def transformToText(obj, data=None, contentType=None):
if data is None:
data = obj.data
if contentType is None:
contentType = obj.contentType
transform = component.queryAdapter(obj, ITextTransform, name=contentType)
if transform is not None:
#rfa = component.queryAdapter(IReadFile, obj)
rfa = IReadFile(obj, None)
if rfa is None:
if isinstance(data, unicode):
data = data.encode('UTF-8')
try:
return transform(StringIO(data))
except:
import traceback
logger.warn(traceback.format_exc())
return u''
else:
return transform(rfa)
class ResourceTypeSourceList(object):
implements(schema.interfaces.IIterableSource)
def __init__(self, context):
self.context = context
def __iter__(self):
return iter(self.resourceTypes)
@Lazy
def resourceTypes(self):
types = ITypeManager(self.context).listTypes(include=('resource',))
return [t.typeProvider for t in types if t.typeProvider is not None]
def __len__(self):
return len(self.resourceTypes)