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
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
|
#
# Author: Sascha Silbe <sascha-pgp@silbe.org> (OpenPGP signed mails only)
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 3
# as published by the Free Software Foundation.
#
# 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/>.
#
# TODO: investigate python-fs
#
import collections
import errno
import functools
import logging
import os
import stat
import threading
import time
import dbus
import sugar.mime
DS_DBUS_SERVICE = 'org.laptop.sugar.DataStore'
DS_DBUS_INTERFACE1 = 'org.laptop.sugar.DataStore'
DS_DBUS_PATH1 = '/org/laptop/sugar/DataStore'
DS_DBUS_INTERFACE2 = 'org.laptop.sugar.DataStore2'
DS_DBUS_PATH2 = '/org/laptop/sugar/DataStore2'
# nearly infinite
DBUS_TIMEOUT_MAX = 2 ** 31 / 1000
DBUS_PYTHON_VALUE_ERROR = 'org.freedesktop.DBus.Python.ValueError'
_USEFUL_PROPS = ['mime_type', 'tags', 'timestamp', 'title']
"""Metadata properties used for determining the file name of an entry"""
def synchronised(func):
@functools.wraps(func)
def wrapper(self, *args, **kwargs):
with self._lock:
return func(self, *args, **kwargs)
return wrapper
class _LRU(collections.MutableMapping):
"""Simple, but reasonably fast Least Recently Used (LRU) cache"""
def __init__(self, capacity):
self.capacity = capacity
self._dict = {}
self._q = collections.deque()
self.__contains__ = self._dict.__contains__
def __delitem__(self, key):
self._q.remove(key)
del self._dict[key]
def __iter__(self):
return self._dict.__iter__()
def __getitem__(self, key):
value = self._dict[key]
if self._q[-1] == key:
return value
self._q.remove(key)
self._q.append(key)
return value
def __len__(self):
return len(self._q)
def __setitem__(self, key, value):
if key in self._dict:
self._q.remove(key)
elif len(self._dict) == self.capacity:
del self._dict[self._q.popleft()]
self._q.append(key)
self._dict[key] = value
def clear(self):
self._q.clear()
self._dict.clear()
class DataStore(object):
def __init__(self, root_query):
self._root_query = root_query
self.supports_versions = False
self._lock = threading.RLock()
self._data_store_version = 0
bus = dbus.SessionBus()
try:
self._data_store = dbus.Interface(bus.get_object(DS_DBUS_SERVICE,
DS_DBUS_PATH2), DS_DBUS_INTERFACE2)
self._data_store.find({'tree_id': 'invalid'},
{'metadata': ['tree_id']})
self.supports_versions = True
logging.info('Data store with version support found')
return
except dbus.DBusException:
logging.debug('No data store with version support found')
self._data_store = dbus.Interface(bus.get_object(DS_DBUS_SERVICE,
DS_DBUS_PATH1), DS_DBUS_INTERFACE1)
self._data_store.find({'uid': 'invalid'}, ['uid'])
logging.info('Data store without version support found')
if 'uri' in self._data_store.mounts()[0]:
self._data_store_version = 82
data_store_path = '/home/olpc/.sugar/default/datastore'
self._data_store_mount_id = [mount['id']
for mount in self._data_store.mounts()
if mount['uri'] == data_store_path][0]
logging.info('0.82 data store found')
else:
logging.info('0.84+ data store without version support found')
self._data_store_version = 84
@synchronised
def list_object_ids(self, query=None):
"""Retrieve the object_ids of all (matching) data store entries
Only return the latest version of each entry for data stores with
version support.
"""
query = self._merge_root_query(query)
if self._data_store.dbus_interface == DS_DBUS_INTERFACE2:
options = {'metadata': ['tree_id', 'version_id'],
'order_by': ['-timestamp']}
return [(unicode(entry['tree_id']), unicode(entry['version_id']))
for entry in self._data_store.find(query, options,
timeout=DBUS_TIMEOUT_MAX, byte_arrays=True)[0]]
elif self._data_store_version == 82:
properties = ['uid', 'mountpoint']
return [unicode(entry['uid'])
for entry in self._data_store.find(query, properties,
byte_arrays=True, timeout=DBUS_TIMEOUT_MAX)[0]
if entry['mountpoint'] == self._data_store_mount_id]
else:
return [unicode(entry['uid'])
for entry in self._data_store.find(query, ['uid'],
byte_arrays=True, timeout=DBUS_TIMEOUT_MAX)[0]]
@synchronised
def list_metadata(self, query=None):
"""Retrieve object_id and selected metadata of matching entries
Only return the latest version of each entry for data stores with
version support.
Returns a list of tuples containing the object_id and metadata.
"""
query = self._merge_root_query(query)
properties = list(_USEFUL_PROPS)
if self._data_store.dbus_interface == DS_DBUS_INTERFACE2:
properties += ['parent_id', 'tree_id', 'version_id']
options = {'metadata': properties,
'all_versions': True, 'order_by': ['-timestamp']}
return [((unicode(entry['tree_id']),
unicode(entry['version_id'])),
self._convert_metadata(entry))
for entry in self._data_store.find(query, options,
timeout=DBUS_TIMEOUT_MAX, byte_arrays=True)[0]]
elif self._data_store_version == 82:
properties += ['uid', 'mountpoint']
return [(unicode(entry['uid']), self._convert_metadata(entry))
for entry in self._data_store.find(query, properties,
timeout=DBUS_TIMEOUT_MAX, byte_arrays=True)[0]
if entry['mountpoint'] == self._data_store_mount_id]
else:
properties += ['uid']
return [(unicode(entry['uid']), self._convert_metadata(entry))
for entry in self._data_store.find(query, properties,
timeout=DBUS_TIMEOUT_MAX, byte_arrays=True)[0]]
@synchronised
def list_versions(self, tree_id):
"""Retrieve all version_ids of the given data store entry"""
query = dict(self._root_query)
query['tree_id'] = tree_id
options = {'all_versions': True, 'order_by': ['-timestamp']}
return [unicode(entry['version_id'])
for entry in self._data_store.find(query,
options, timeout=DBUS_TIMEOUT_MAX, byte_arrays=True)[0]]
@synchronised
def list_tree_ids(self, query=None):
"""Retrieve the tree_ids of all (matching) data store entries"""
query = self._merge_root_query(query)
return [unicode(entry[0]) for entry in self.list_object_ids(query)]
@synchronised
def list_property_values(self, name, query=None):
"""Return all unique values of the given property"""
assert isinstance(name, unicode)
query = self._merge_root_query(query)
if self._data_store.dbus_interface == DS_DBUS_INTERFACE2:
options = {'metadata': [name], 'all_versions': True}
entries = self._data_store.find(query, options,
timeout=DBUS_TIMEOUT_MAX,
byte_arrays=True)[0]
else:
# We can't use get_uniquevaluesfor() as sugar-datastore
# only supports it for activity_id, which is not what
# we need.
entries = self._data_store.find(query, [name],
timeout=DBUS_TIMEOUT_MAX,
byte_arrays=True)[0]
return dict.fromkeys([entry.get(name) for entry in entries]).keys()
@synchronised
def check_object_id(self, object_id):
"""Return True if the given object_id identifies a data store entry"""
try:
entry = self.get_properties(object_id, self._root_query.keys())
except dbus.DBusException, exception:
if exception.get_dbus_name() == DBUS_PYTHON_VALUE_ERROR:
return False
raise
return True
@synchronised
def check_tree_id(self, tree_id):
"""Return True if the given tree_id identifies a data store entry"""
assert isinstance(tree_id, unicode)
query = dict(self._root_query)
query['tree_id'] = tree_id
results = self._data_store.find(query, {},
timeout=DBUS_TIMEOUT_MAX,
byte_arrays=True)[0]
return bool(results)
@synchronised
def check_property_contains(self, name, word):
"""Return True if there is at least one entry containing word in the
given property
"""
assert isinstance(name, unicode)
assert isinstance(word, unicode)
query_string = u'%s:"%s"' % (name, word.replace(u'"', u''))
query = dict(self._root_query)
if self._data_store.dbus_interface == DS_DBUS_INTERFACE2:
options = {'limit': 1}
results = self._data_store.text_search(query, query_string,
options,
timeout=DBUS_TIMEOUT_MAX,
byte_arrays=True)[0]
else:
query['query'] = query_string
query['limit'] = 1
results = self._data_store.find(query, [name],
timeout=DBUS_TIMEOUT_MAX,
byte_arrays=True)[0]
return bool(results)
@synchronised
def get_properties(self, object_id, names=None):
"""Read given properties for data store entry identified by object_id
Returns a dictionary with unicode strings as keys and values.
"""
query = dict(self._root_query)
if self._data_store.dbus_interface == DS_DBUS_INTERFACE2:
tree_id, version_id = object_id
assert isinstance(tree_id, unicode)
assert isinstance(version_id, unicode)
query['tree_id'] = tree_id
query['version_id'] = version_id
options = {}
if names:
options['metadata'] = names
results = self._data_store.find(query, options,
timeout=DBUS_TIMEOUT_MAX,
byte_arrays=True)[0]
if not results:
raise ValueError('Object %r does not exist' % (object_id, ))
return self._convert_metadata(results[0])
else:
assert isinstance(object_id, unicode)
query['uid'] = object_id
results = self._data_store.find(query, names or [],
timeout=DBUS_TIMEOUT_MAX,
byte_arrays=True)[0]
metadata = self._data_store.get_properties(object_id,
byte_arrays=True)
if not results:
raise ValueError('Object %r does not exist' % (object_id, ))
metadata = results[0]
metadata['uid'] = object_id
if names:
metadata = dict([(name, metadata[name]) for name in names
if name in metadata])
return self._convert_metadata(metadata)
@synchronised
def list_properties(self, object_id):
"""List the names of all properties for this entry
Returns a list of unicode strings.
"""
return self.get_properties(object_id).keys()
@synchronised
def create_property(self, object_id, name, value):
"""Set the given property, raising an error if it already exists"""
assert isinstance(name, unicode)
metadata = self.get_properties(object_id)
if name in metadata:
raise IOError(errno.EEXIST, os.strerror(errno.EEXIST))
metadata[name] = value
self._change_metadata(object_id, metadata)
@synchronised
def replace_property(self, object_id, name, value):
"""Modify the given, already existing property"""
assert isinstance(name, unicode)
assert isinstance(value, unicode)
metadata = self.get_properties(object_id)
if name not in metadata:
# on Linux ENOATTR=ENODATA (Python errno doesn't contain ENOATTR)
raise IOError(errno.ENODATA, os.strerror(errno.ENODATA))
metadata[name] = value
self._change_metadata(object_id, metadata)
@synchronised
def set_properties(self, object_id, properties):
"""Write the given (sub)set of properties
properties -- metadata as dictionary with unicode strings as
keys and values
"""
assert not [True for key, value in properties.items()
if (not isinstance(key, unicode)) or
(not isinstance(value, unicode))]
metadata = self.get_properties(object_id)
metadata.update(properties)
self._change_metadata(object_id, metadata)
@synchronised
def remove_properties(self, object_id, names):
"""Remove the given (sub)set of properties
names -- list of property names (unicode strings)
"""
metadata = self.get_properties(object_id)
for name in names:
assert isinstance(name, unicode)
if name not in metadata:
# on Linux ENOATTR=ENODATA (and no ENOATTR in errno module)
raise IOError(errno.ENODATA, os.strerror(errno.ENODATA))
del metadata[name]
self._change_metadata(object_id, metadata)
@synchronised
def remove_entry(self, object_id):
"""Remove a single (version of a) data store entry"""
# Make sure we don't allow deleting entries that don't match
# the root query.
if not self.check_object_id(object_id):
raise ValueError('Object %r does not exist' % (object_id, ))
if self._data_store.dbus_interface == DS_DBUS_INTERFACE2:
tree_id, version_id = object_id
self._data_store.delete(tree_id, version_id,
timeout=DBUS_TIMEOUT_MAX)
else:
self._data_store.delete(object_id, timeout=DBUS_TIMEOUT_MAX)
@synchronised
def create_new(self, properties):
"""Create a new data store entry
properties -- metadata as dictionary with unicode strings as
keys and values
"""
assert not [True for key, value in properties.items()
if (not isinstance(key, unicode)) or
(not isinstance(value, unicode))]
if self._data_store.dbus_interface == DS_DBUS_INTERFACE2:
return self._data_store.save('', '', properties, '', False,
timeout=DBUS_TIMEOUT_MAX)
else:
return self._data_store.create(properties, '', False)
@synchronised
def get_data(self, object_id):
"""Return path to data for data store entry identified by object_id."""
# Make sure we don't allow deleting entries that don't match
# the root query.
if not self.check_object_id(object_id):
raise ValueError('Object %r does not exist' % (object_id, ))
if self._data_store.dbus_interface == DS_DBUS_INTERFACE2:
tree_id, version_id = object_id
return self._data_store.get_data(tree_id, version_id,
byte_arrays=True)
else:
return self._data_store.get_filename(object_id, byte_arrays=True)
@synchronised
def get_size(self, object_id):
# FIXME: make use of filesize property if available
path = self.get_data(object_id)
if not path:
return 0
size = os.stat(path).st_size
os.remove(path)
return size
@synchronised
def write_data(self, object_id, path):
"""Update data for data store entry identified by object_id.
Return object_id of the updated entry. If the data store does not
support versions, this will be the same as the one given as parameter.
path -- Path of data file in real file system (string)
"""
assert isinstance(path, str)
properties = self.get_properties(object_id)
if self._data_store.dbus_interface == DS_DBUS_INTERFACE2:
tree_id, parent_id = object_id
res = self._data_store.save(tree_id, parent_id, properties, path,
False, timeout=DBUS_TIMEOUT_MAX,
byte_arrays=True)
tree_id_, child_id = res
assert tree_id == tree_id_
return unicode(tree_id), unicode(child_id)
else:
self._data_store.update(object_id, properties, path, False,
timeout=DBUS_TIMEOUT_MAX)
return unicode(object_id)
def _merge_root_query(self, query):
query = dict(query or {})
xapian_query = query.get('query', '')
query.update(self._root_query)
if ('query' in self._root_query) and xapian_query:
query['query'] = '(%s) AND (%s)' % (self._root_query['query'],
xapian_query)
return query
def _convert_metadata(self, metadata):
"""Convert metadata (as returned by the data store) to a unicode dict
The data store may keep the data type it got as input or convert
it to a string, at it's own discretion. To keep our processing
sane and independent of the data store implementation, we pass
unicode strings as input and convert output to unicode strings.
As an exception, we keep values that cannot be converted from
UTF-8 (e.g. previews in PNG format) as (binary) strings.
"""
metadata_unicode = dict()
for key, value in metadata.items():
if isinstance(key, str):
key_unicode = unicode(key, 'utf-8')
else:
key_unicode = unicode(key)
if isinstance(value, str):
try:
value_unicode = unicode(value, 'utf-8')
except UnicodeDecodeError:
# Keep binary strings as-is
value_unicode = value
else:
value_unicode = unicode(value)
metadata_unicode[key_unicode] = value_unicode
return metadata_unicode
def _change_metadata(self, object_id, metadata):
if self._data_store.dbus_interface == DS_DBUS_INTERFACE2:
tree_id, version_id = object_id
self._data_store.change_metadata(tree_id, version_id, metadata)
else:
self._data_store.update(object_id, metadata, '', False)
class FSEntry(object):
def __init__(self, file_system, mode):
self._fs = file_system
self._ds = file_system.data_store
self.mode = mode
def get_properties(self, names=None, use_cache=False):
"""Read the given properties (default: all)
Returns a dictionary with unicode strings as keys and values.
As an exception, values that cannot be converted from UTF-8
(e.g. previews in PNG format) are represented by (binary)
strings.
"""
return []
def list_properties(self):
"""List the names of all properties for this entry
Returns a list of unicode strings.
"""
return []
def lookup(self, name_):
raise IOError(errno.ENOENT, os.strerror(errno.ENOENT))
def mkdir(self, name_):
raise IOError(errno.EACCES, os.strerror(errno.EACCES))
def readlink(self):
raise IOError(errno.EINVAL, os.strerror(errno.EINVAL))
def remove(self):
"""Remove this entry"""
raise IOError(errno.EACCES, os.strerror(errno.EACCES))
def create_property(self, name, value):
"""Set the given property, raising an error if it already exists"""
raise IOError(errno.EOPNOTSUPP, os.strerror(errno.EOPNOTSUPP))
def replace_property(self, name, value):
"""Modify the given, already existing property"""
raise IOError(errno.EOPNOTSUPP, os.strerror(errno.EOPNOTSUPP))
def set_properties(self, properties):
"""Write the given (sub)set of properties
properties -- dictionary with unicode strings as keys and values
"""
raise IOError(errno.EOPNOTSUPP, os.strerror(errno.EOPNOTSUPP))
def remove_properties(self, names):
"""Remove the given (sub)set of properties
names -- list of property names (unicode strings)
"""
raise IOError(errno.EOPNOTSUPP, os.strerror(errno.EOPNOTSUPP))
def get_ctime(self):
"""Return the time the object was originally created
Return POSIX timestamp as float."""
return 0.
def get_mtime(self):
"""Return the time the object was last modified
Return POSIX timestamp as float."""
return time.time()
def get_data(self):
"""Return the entire content of this entry"""
# FIXME: inefficient or even impractical for large files
raise IOError(errno.EISDIR, os.strerror(errno.EISDIR))
def get_size(self):
"""Return the size of the content in bytes"""
return 0
class Symlink(FSEntry):
def __init__(self, file_system, target):
assert isinstance(target, unicode)
FSEntry.__init__(self, file_system, stat.S_IFLNK | 0777)
self.target = target
def readlink(self):
return self.target
def __repr__(self):
return 'Symlink(%r, %r)' % (self._fs, self.target)
class DSObjectBase(FSEntry):
def __init__(self, file_system, mode, object_id, metadata=None):
FSEntry.__init__(self, file_system, mode)
self.object_id = object_id
self._metadata = metadata
self._have_nonstandard = False
def get_properties(self, names=None, use_cache=False):
nonstandard_names = bool([True for name in names
if name not in _USEFUL_PROPS])
if names and not nonstandard_names:
fetch_names = names
else:
fetch_names = None
if ((not use_cache) or (self._metadata is None) or
(nonstandard_names and not self._have_nonstandard)):
self._metadata = self._ds.get_properties(self.object_id,
fetch_names)
self._have_nonstandard = nonstandard_names
if not names:
return self._metadata
return dict([(name, self._metadata[name])
for name in names
if name in self._metadata])
def get_ctime(self):
props = self.get_properties([u'creation_time', u'timestamp'])
try:
return float(props[u'creation_time'])
except (KeyError, ValueError, TypeError):
pass
try:
return float(props[u'timestamp'])
except (KeyError, ValueError, TypeError):
return time.time()
def get_mtime(self):
props = self.get_properties([u'creation_time', u'timestamp'])
try:
return float(props[u'timestamp'])
except (KeyError, ValueError, TypeError):
return time.time()
class ObjectSymlink(Symlink, DSObjectBase):
def __init__(self, file_system, target, object_id, metadata=None):
assert isinstance(target, unicode)
DSObjectBase.__init__(self, file_system, stat.S_IFLNK | 0777,
object_id, metadata)
self.target = target
class DSObject(DSObjectBase):
def __init__(self, file_system, object_id, metadata=None):
DSObjectBase.__init__(self, file_system, stat.S_IFREG | 0750,
object_id, metadata)
def list_properties(self):
return self._ds.list_properties(self.object_id)
def create_property(self, name, value):
return self._ds.create_property(self.object_id, name, value)
def replace_property(self, name, value):
return self._ds.replace_property(self.object_id, name, value)
def set_properties(self, properties):
return self._ds.set_properties(self.object_id, properties)
def remove(self):
self._ds.remove_entry(self.object_id)
def remove_properties(self, names):
return self._ds.remove_properties(self.object_id, names)
def get_data(self):
return self._ds.get_data(self.object_id)
def write_data(self, file_name):
return self._ds.write_data(self.object_id, file_name)
def get_size(self):
return self._ds.get_size(self.object_id)
class Directory(FSEntry):
def __init__(self, file_system, level, mode, parent=None):
self.parent = parent
self._level = level
FSEntry.__init__(self, file_system, stat.S_IFDIR | mode)
def listdir(self):
yield u'.'
yield u'..'
def readdir(self):
yield (u'.', self)
if self.parent is not None:
yield (u'..', self.parent)
def _get_symlink(self, object_id, metadata=None):
directory_path = u'../' * self._level + u'by-id/'
if isinstance(object_id, tuple):
assert (isinstance(object_id[0], unicode) and
isinstance(object_id[1], unicode))
return ObjectSymlink(self._fs,
directory_path + u'/'.join(object_id),
object_id, metadata)
else:
assert isinstance(object_id, unicode)
return ObjectSymlink(self._fs, directory_path + object_id,
object_id, metadata)
class ByTitleDirectory(Directory):
def __init__(self, file_system, level, parent):
Directory.__init__(self, file_system, level, 0550, parent)
self._query = None
def listdir(self):
for name in Directory.listdir(self):
yield name
for object_id in self._ds.list_object_ids(self._query):
name = self._fs.lookup_title_name(object_id)
yield name
def readdir(self):
for name, entry in Directory.readdir(self):
yield name, entry
for object_id, metadata in self._ds.list_metadata(self._query):
name = self._fs.lookup_title_name(object_id, metadata)
yield (name, self._get_symlink(object_id, metadata))
def lookup(self, name):
object_id = self._fs.resolve_title_name(name)
return self._get_symlink(object_id)
def mknod(self, name):
if self._fs.try_resolve_title_name(name):
raise IOError(errno.EEXIST, os.strerror(errno.EEXIST))
object_id_ = self._ds.create_new({'title': name})
class ByUidDirectory(Directory):
def __init__(self, file_system, level, parent):
Directory.__init__(self, file_system, level, 0550, parent)
def lookup(self, object_id):
if not self._ds.check_object_id(object_id):
raise IOError(errno.ENOENT, os.strerror(errno.ENOENT))
return DSObject(self._fs, object_id)
def listdir(self):
for name in Directory.listdir(self):
yield name
for object_id in self._ds.list_object_ids():
yield object_id
def readdir(self):
for name, entry in Directory.readdir(self):
yield name, entry
for object_id in self._ds.list_object_ids():
yield (object_id, DSObject(self._fs, object_id))
class ByVersionIdDirectory(Directory):
def __init__(self, file_system, level, parent, tree_id):
self._tree_id = tree_id
Directory.__init__(self, file_system, level, 0550, parent)
def lookup(self, version_id):
object_id = (self._tree_id, version_id)
if not self._ds.check_object_id(object_id):
raise IOError(errno.ENOENT, os.strerror(errno.ENOENT))
return DSObject(self._fs, object_id)
def listdir(self):
for name in Directory.listdir(self):
yield name
for version_id in self._ds.list_versions(self._tree_id):
yield (self._tree_id, version_id)
def readdir(self):
for name, entry in Directory.readdir(self):
yield name, entry
for version_id in self._ds.list_versions(self._tree_id):
object_id = (self._tree_id, version_id)
yield (object_id, DSObject(self._fs, object_id))
class ByTreeIdDirectory(Directory):
def __init__(self, file_system, level, parent):
Directory.__init__(self, file_system, level, 0550, parent)
def lookup(self, tree_id):
if not self._ds.check_tree_id(tree_id):
raise IOError(errno.ENOENT, os.strerror(errno.ENOENT))
return ByVersionIdDirectory(self._fs, self._level + 1, self, tree_id)
def listdir(self):
for name in Directory.listdir(self):
yield name
for tree_id in self._ds.list_tree_ids():
yield tree_id
def readdir(self):
for name, entry in Directory.readdir(self):
yield name, entry
for tree_id in self._ds.list_tree_ids():
yield (tree_id, ByVersionIdDirectory(self._fs, self._level + 1,
self, tree_id))
class ByTagsSubDirectory(ByTitleDirectory):
def __init__(self, file_system, level, parent, tags):
self._tags = frozenset(tags)
ByTitleDirectory.__init__(self, file_system, level, parent)
def mknod(self, name):
if self._fs.try_resolve_title_name(name):
raise IOError(errno.EEXIST, os.strerror(errno.EEXIST))
props = {'title': name, 'tags': ' '.join(self._tags)}
object_id_ = self._ds.create_new(props)
def listdir(self):
for name in Directory.listdir(self):
yield name
for object_id, metadata in self._find_entries():
name = self._fs.lookup_title_name(object_id, metadata)
yield name
def readdir(self):
for name, entry in Directory.readdir(self):
yield name, entry
for object_id, metadata in self._find_entries():
name = self._fs.lookup_title_name(object_id, metadata)
yield (name, self._get_symlink(object_id, metadata))
def _find_entries(self):
query = {'query': ' '.join(self._tags)}
for object_id, props in self._ds.list_metadata(query):
entry_tags = frozenset(props.get('tags', '').split())
if self._tags - entry_tags:
continue
yield object_id, props
class ByTagsDirectory(Directory):
def __init__(self, file_system, level, parent):
Directory.__init__(self, file_system, level, 0550, parent)
self._tag_dirs = {}
def listdir(self):
for name in Directory.listdir(self):
yield name
for tag in self._list_tags():
if u'/' in tag or tag.startswith(u'.'):
continue
yield tag
def readdir(self):
for name, entry in Directory.readdir(self):
yield name, entry
for tag in self._list_tags():
if u'/' in tag or tag.startswith(u'.'):
continue
if tag not in self._tag_dirs:
self._tag_dirs[tag] = ByTagsSubDirectory(self._fs,
self._level + 1,
self, [tag])
yield (tag, self._tag_dirs[tag])
def lookup(self, name):
if name not in self._tag_dirs:
if not self._check_tag(name):
raise IOError(errno.ENOENT, os.strerror(errno.ENOENT))
self._tag_dirs[name] = ByTagsSubDirectory(self._fs,
self._level + 1, self,
[name])
return self._tag_dirs[name]
def _check_tag(self, name):
return self._ds.check_property_contains(u'tags', name)
def _list_tags(self):
tags = set()
for value in self._ds.list_property_values(u'tags'):
tags.update((value or u'').split())
tags.discard(u'')
return tags
class SearchResultDirectory(ByTitleDirectory):
def __init__(self, file_system, level, parent, query):
ByTitleDirectory.__init__(self, file_system, level, parent)
self._query = query
class RootDirectory(Directory):
def __init__(self, file_system, mode):
Directory.__init__(self, file_system, 0, mode, None)
self._by_tags_directory = ByTagsDirectory(file_system, 1, self)
self._by_title_directory = ByTitleDirectory(file_system, 1, self)
if self._ds.supports_versions:
self._by_id_directory = ByTreeIdDirectory(file_system, 1, self)
else:
self._by_id_directory = ByUidDirectory(file_system, 1, self)
def listdir(self):
for name in Directory.listdir(self):
yield name
yield u'by-id'
yield u'by-tags'
yield u'by-title'
def readdir(self):
for name, entry in Directory.readdir(self):
yield name, entry
yield (u'by-id', self._by_id_directory)
yield (u'by-tags', self._by_tags_directory)
yield (u'by-title', self._by_title_directory)
def lookup(self, name):
if name == u'by-id':
return self._by_id_directory
elif name == u'by-tags':
return self._by_tags_directory
elif name == u'by-title':
return self._by_title_directory
raise IOError(errno.ENOENT, os.strerror(errno.ENOENT))
class FSEmulation(object):
# public API
def __init__(self, root_query=None):
self.data_store = DataStore(root_query or {})
# FIXME: determine good LRU size
self._cache = _LRU(500)
self._root_dir = RootDirectory(self, 0550)
self._object_id_to_title_name = {}
self._title_name_to_object_id = {}
def resolve(self, path, follow_links=False):
assert isinstance(path, unicode)
stripped_path = path.strip(u'/')
if not stripped_path:
return self._root_dir
partial_path = u''
entry = self._root_dir
for component in stripped_path.split(u'/'):
partial_path += u'/' + component
# FIXME: add cache (in)validation
if partial_path not in self._cache:
self._cache[partial_path] = entry.lookup(component)
entry = self._cache[partial_path]
if path.endswith(u'/') and not isinstance(entry, Directory):
raise IOError(errno.ENOTDIR, os.strerror(errno.ENOTDIR))
if isinstance(entry, Symlink) and follow_links:
target = u'/%s/../%s' % (stripped_path, entry.readlink())
target_abs = os.path.abspath(target)
return self.resolve(target_abs, follow_links=True)
return entry
def search(self, query):
return SearchResultDirectory(self, 1, self._root_dir, query)
# internal API
def resolve_title_name(self, name):
if name not in self._title_name_to_object_id:
# FIXME: Hack to fill self._title_name_to_object_id. To be
# replaced by parsing the name and doing a specific search.
list(self.resolve(u'/by-title').readdir())
try:
return self._title_name_to_object_id[name]
except KeyError:
raise IOError(errno.ENOENT, os.strerror(errno.ENOENT))
def try_resolve_title_name(self, name):
return self._title_name_to_object_id.get(name)
def lookup_title_name(self, object_id, metadata=None):
name = self._object_id_to_title_name.get(object_id)
if name:
return name
if metadata is None:
metadata = self.data_store.get_properties(object_id,
_USEFUL_PROPS)
name = self._generate_title_name(metadata, object_id)
self._add_title_name(name, object_id)
return name
# private methods
def _add_title_name(self, name, object_id):
self._object_id_to_title_name[object_id] = name
self._title_name_to_object_id[name] = object_id
return name
def _generate_title_name(self, metadata, object_id):
title = metadata.get(u'title')
try:
mtime = float(metadata[u'timestamp'])
except (KeyError, ValueError):
mtime = time.time()
time_human = time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(mtime))
name = u'%s - %s' % (title, time_human)
name = safe_name(name)
extension = self._guess_extension(metadata.get('mime_type'), object_id)
if extension:
current_name = u'%s.%s' % (name, extension)
else:
current_name = name
counter = 1
while current_name in self._title_name_to_object_id:
counter += 1
if extension:
current_name = u'%s %d.%s' % (name, counter, extension)
else:
current_name = u'%s %d' % (name, counter)
return current_name
def _remove_title_name_by_object_id(self, object_id):
name = self._object_id_to_title_name.pop(object_id, None)
if name:
del self._title_name_to_object_id[name]
def _remove_title_name_by_name(self, name):
object_id = self._title_name_to_object_id.pop(name, None)
if object_id:
del self._object_id_to_title_name[object_id]
def _guess_extension(self, mime_type, object_id):
extension = None
if not mime_type:
file_name = self.data_store.get_data(object_id)
if file_name:
try:
mime_type = sugar.mime.get_for_file(file_name)
finally:
os.remove(file_name)
if mime_type:
extension = sugar.mime.get_primary_extension(mime_type)
return extension
def safe_name(name):
return name.replace(u'/', u'_')
|