File: MetaData.py

package info (click to toggle)
lodju 2.2-1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 456 kB
  • ctags: 814
  • sloc: python: 4,698; ansic: 139; makefile: 64; sh: 21
file content (657 lines) | stat: -rw-r--r-- 15,067 bytes parent folder | download
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
import os
import string
import xml.sax
import UserDict

import lodjusetup
import Storage


def protect(str):
    str = u"&".join(str.split(u"&"))
    str = u"&lt;".join(str.split(u"<"))
    str = u"&gt;".join(str.split(u">"))
    assert type(str) == type(u"")
    return str


def real_indent(lines, level):
    return map(lambda line: u"%*s%s" % (level * 4, u"", line), lines)

def indent(lines, level):
    return lines


def lines_to_string(lines):
    return string.join(lines, u"\n") + u"\n"


def xml_front_matter(root_element):
    return ['<?xml version="1.0"?>',
            '<!DOCTYPE %s SYSTEM "lodju.dtd">' % root_element]


def encode_photos(photos):
    list = xml_front_matter(u"photos")
    list.append(u'<photos>')
    for photo in photos:
    	list = list + indent(photo.get_xml_lines(), 1)
    list.append(u'</photos>')
    return lines_to_string(list)


class Element:

    def __init__(self, name):
    	self.name = name
	self.content = u""
	self.children = []
	
    	if name == u"folder":
	    self.meta = Folder()
    	elif name == u"folders":
	    self.meta = Folders()
	elif name == u"photos":
	    self.meta = Photos()
	elif name == u"photo":
	    self.meta = Photo()
	elif name == u"lodju-document":
	    self.meta = Document()
	else:
	    self.meta = None

    def get_child(self, name):
    	for child in self.children:
	    if child.name == name:
	    	assert child.children == []
	    	return child.get_content()

    def add_child(self, child):
    	self.children.append(child)
	
    def add_content(self, content):
    	self.content = self.content + content

    def get_content(self):
    	return self.content.strip()

    def dump(self, level=0):
    	content = self.get_content()
	if content:
	    print u"%*s%s = %s" % (level*2, u"", self.name, content)
	else:
	    print u"%*s%s" % (level*2, u"", self.name)
	for child in self.children:
	    child.dump(level + 1)


class ContentHandler(xml.sax.ContentHandler):

    def __init__(self):
    	xml.sax.ContentHandler.__init__(self)
	self._stack = []
	self.root = None

    def push(self, item):
    	self._stack.append(item)

    def top(self):
    	if self._stack:
	    return self._stack[-1]
	else:
	    return None

    def pop(self):
    	if self._stack:
	    item = self._stack[-1]
	    del self._stack[-1]
	    return item
	else:
	    return None

    def startElement(self, name, attrs):
    	e = Element(name)
    	o = self.top()
	if o:
	    o.add_child(e)
    	else:
	    self.root = e
    	self.push(e)

    def characters(self, content):
    	o = self.top()
	o.add_content(content)

    def endElement(self, name):
    	e = self.pop()
	p = self.top()
	if e.name == u"attribute":
	    p.meta[e.get_child(u"name")] = e.get_child(u"value")
    	elif e.name == u"photo":
	    assert p.name == u"photos"
	    p.meta.add(e.meta)
    	elif e.name == u"photos" and p is not None:
	    assert p.name == u"folder"
	    p.meta.set_photos(e.meta)
    	elif e.name == u"folder" and p is not None:
	    assert p.name == u"folders"
	    p.meta.add(e.meta)
	elif e.name == u"folders" and p is not None:
	    assert p.name in [u"folder", u"lodju-document"]
	    if p.name == u"folder":
		p.meta.set_subfolders(e.meta)
    	    else:
	    	p.meta.set_folders(e.meta)


class EntityResolver(xml.sax.handler.EntityResolver):

    def resolveEntity(self, publicId, systemId):
    	if systemId == "lodju.dtd":
	    return lodjusetup.LODJU_DTD
	else:
	    return systemId


class Parser:

    def __init__(self):
    	self.handler = ContentHandler()
	self.parser = xml.sax.make_parser()
	self.parser.setContentHandler(self.handler)
	self.parser.setEntityResolver(EntityResolver())

    def feed(self, data):
    	self.parser.feed(data)

    def close(self):
    	self.parser.close()
	self.handler.root.meta.clear_dirty()
	return self.handler.root.meta


class Counter:

    def __init__(self):
	self.used = []

    def remember(self, id):
    	if id not in self.used:
	    self.used.append(id)

    def get(self):
    	if self.used == []:
	    id = 1
	else:
	    id = self.used[-1]
	    while id in self.used:
	    	id = id + 1
    	self.remember(id)
	return id

id_counter = Counter()


class Attribute:

    def __init__(self, name, visible_name, editable):
    	self.name = name
	self.visible_name = visible_name
	self.editable = editable

    def get_name(self):
    	return self.name
	
    def get_visible_name(self):
    	return self.visible_name
	
    def set_visible_name(self, new_visible_name):
    	self.visible_name = new_visible_name
	
    def is_editable(self):
    	return self.editable


class UserDefinedAttribute(Attribute):

    def __init__(self, visible_name):
    	name = "user:" + visible_name # XXX shouldn't be derived from vname
    	Attribute.__init__(self, name, visible_name, 1)


class StockAttribute(Attribute):

    # The following defines the list of stock attributes.
    # Eventually this should be read in from a file, I guess.
    stock = {
	u"id": (u"ID", 0),
	u"angle": (u"Angle", 0),
	u"name": (u"Name", 1),
	u"description": (u"Description", 1),
	u"file-size": (u"File size", 0),
	u"imported-from": (u"Imported from", 0),
	u"imported-at": (u"Imported at", 0),

	u"exif:exposure-time": (u"Exposure time", 0),
	u"exif:flash": (u"Flash used", 0),
	u"exif:focal-length": (u"Focal length", 0),
	u"exif:iso-speed": (u"ISO speed", 0),
	u"exif:date-time": (u"Capture time", 0),
    }

    def __init__(self, name):
	x = self.stock[name]
    	Attribute.__init__(self, name, x[0], x[1])


class AttributeList:

    def __init__(self):
	self.attrs = []
	
    def get_all(self):
    	return map(lambda a: a.get_name(), self.attrs)
	
    def get_editable(self):
    	return map(lambda a: a.get_name(), 
	    	   filter(lambda a: a.is_editable(), self.attrs))

    def find(self, name):
    	for attr in self.attrs:
	    if attr.get_name() == name:
	    	return attr
	return None

    def find_visible_name(self, vname):
    	for attr in self.attrs:
	    if attr.get_visible_name() == vname:
	    	return attr
	return None

    def exists(self, name):
    	return self.find(name) != None
    
    def is_editable(self, name):
    	return self.find(name).is_editable()
    	
    def add_user_defined(self, visible_name):
    	if not self.find_visible_name(visible_name):
	    self.attrs.append(UserDefinedAttribute(visible_name))

    def add_stock(self, name):
    	if not self.find(name):
	    self.attrs.append(StockAttribute(name))

    def remove(self, name):
    	attr = self.find(name)
    	if attr:
	    self.attrs.remove(attr)
    
    def get_visible_name(self, name):
    	return self.find(name).get_visible_name()
	
    def set_visible_name(self, name, new_visible_name):
    	self.find(name).set_visible_name(new_visible_name)


class MetaData(UserDict.UserDict):

    type = u"MetaData"
    internals = [u"id"]
    nosave_prefixes = ["dnd:"]

    def __init__(self):
    	UserDict.UserDict.__init__(self)
	self.listeners = []
	self[u"id"] = u"%d" % id_counter.get()
	self.clear_dirty()

    def has_dirty_children(self):
    	return 0

    def is_dirty(self):
    	return self.dirty or self.has_dirty_children()

    def clear_dirty_children(self):
    	pass

    def clear_dirty(self):
    	self.dirty = 0
	self.clear_dirty_children()
	
    def make_dirty(self):
    	self.dirty = 1

    def listen(self, func):
    	if func not in self.listeners:
	    self.listeners.append(func)

    def dont_listen(self, func):
    	if func in self.listeners:
	    self.listeners.remove(func)

    def normalize(self, str):
    	if type(str) == type(u""):
	    return str
	else:
	    return unicode(str)

    def __getitem__(self, key):
	key = self.normalize(key)
	if self.data.has_key(key):
	    return self.data[key]
	else:
	    return u""

    def __setitem__(self, key, value):
	key = self.normalize(key)
	value = self.normalize(value)
	UserDict.UserDict.__setitem__(self, key, value)
	if key == u"id":
	    id_counter.remember(int(value))
	self.make_dirty()
	for func in self.listeners:
	    func(self, key)

    def dump_children(self, level):
    	pass

    def dump(self, level=0):
    	print "%*s%s" % (level * 2, "", self.type)
	for key in self.keys():
	    print "%*s  %s=%s" % (level * 2, "", key, self[key])
    	self.dump_children(level + 1)

    def get_attributes_as_xml_lines(self):
    	list = []
	keys = self.keys()
	for prefix in self.nosave_prefixes:
	    keys = filter(lambda k: k[:len(prefix)] != prefix, keys)
	for key in keys:
	    list.append(
		u"<attribute><name>%s</name><value>%s</value></attribute>" %
	    	    	(protect(key), protect(self[key])))
	return list

    def get_children_as_xml_lines(self):
    	return []

    def get_xml_lines(self):
    	list = []
	list.append(u"<%s>" % self.type)
	list = list + indent(self.get_attributes_as_xml_lines(), 1)
	list = list + indent(self.get_children_as_xml_lines(), 1)
	list.append(u"</%s>" % self.type)
	return list

    def get_xml_document(self):
    	list = xml_front_matter(self.type)
	list = list + self.get_xml_lines()
	return lines_to_string(list)

    def restore(self, dict):
    	for key in self.data.keys():
	    del self.data[key]
	for key in dict.keys():
	    self[key] = dict[key]


class Document(MetaData):

    type = u"lodju-document"

    def __init__(self):
	self.folders = Folders()
	self.storage = Storage.Storage(u"")
	
    	MetaData.__init__(self)
	
	self[u"filename"] = u""
	self.unnamed = 1

    	self.docattrs = AttributeList()

	self.folderattrs = AttributeList()
	self.folderattrs.add_stock(u"name")

    	self.photoattrs = AttributeList()
	self.photoattrs.add_stock(u"id")
	self.photoattrs.add_stock(u"angle")
	self.photoattrs.add_stock(u"name")
	self.photoattrs.add_stock(u"description")
	self.photoattrs.add_stock(u"file-size")
	self.photoattrs.add_stock(u"imported-from")
	self.photoattrs.add_stock(u"imported-at")
	self.photoattrs.add_stock(u"exif:exposure-time")
	self.photoattrs.add_stock(u"exif:flash")
	self.photoattrs.add_stock(u"exif:focal-length")
	self.photoattrs.add_stock(u"exif:iso-speed")
	self.photoattrs.add_stock(u"exif:date-time")

	self.clear_dirty()

    def is_empty(self):
    	return self.folders.get() == [] and \
	       self[u"filename"] == u"" and \
	       not self.is_dirty()

    def has_dirty_children(self):
    	return self.folders.is_dirty()

    def clear_dirty_children(self):
    	self.folders.clear_dirty()

    def dump_children(self, level):
    	self.folders.dump(level)

    def set_folders(self, folders):
    	self.folders = folders

    def get_children_as_xml_lines(self):
    	return self.folders.get_xml_lines()

    def save(self):
    	assert self[u"filename"] != u""
    	if self.unnamed:
	    self.storage.rename(self[u"filename"])
    	elif self.storage.filename != self[u"filename"]:
	    self.storage.save_as(self[u"filename"])
    	xml = self.get_xml_document()
    	self.storage.new_file(u"lodju.xml", xml)
    	self.storage.save()
	self.clear_dirty()
	self.unnamed = 0

class ManyMetaDatas(MetaData):

    type = u"ManyMetaDatas"
    
    def __init__(self):
	self.list = []
    	MetaData.__init__(self)

    def has_dirty_children(self):
    	for child in self.list:
	    if child.is_dirty():
	    	return 1
	return 0
	
    def clear_dirty_children(self):
    	for child in self.list:
	    child.clear_dirty()

    def get_attributes_as_xml_lines(self):
    	return []

    def get_children_as_xml_lines(self):
    	lines = []
	for item in self.list:
	    lines = lines + item.get_xml_lines()
	return lines

    def dump_children(self, level):
    	for item in self.list:
	    item.dump(level)

    def set(self, children):
    	self.list = children
	self.make_dirty()

    def get(self):
    	return self.list

    def has(self, item):
    	return item in self.list

    def add(self, item):
    	self.list.append(item)
	self.make_dirty()
	# XXX reparent?

    def remove(self, item):
    	if item in self.list:
	    self.list.remove(item)
	    self.make_dirty()

    def clear(self):
    	self.set([])


class Folders(ManyMetaDatas):

    type = u"folders"


class Folder(MetaData):

    type = u"folder"
    internals = [u"id", u"name"]

    def __init__(self):
	self.subfolders = Folders()
	self.photos = Photos()
    	MetaData.__init__(self)

    def has_dirty_children(self):
    	return self.photos.is_dirty() or self.subfolders.is_dirty()
	
    def clear_dirty_children(self):
    	self.photos.clear_dirty()
	self.subfolders.clear_dirty()

    def dump_children(self, level):
    	self.photos.dump(level)
	self.subfolders.dump(level)

    def set_subfolders(self, subfolders):
    	assert subfolders.type == u"folders"
    	self.subfolders = subfolders

    def set_photos(self, photos):
    	assert photos.type == u"photos"
    	self.photos = photos
	self.make_dirty()

    def get_children_as_xml_lines(self):
    	return self.photos.get_xml_lines() + self.subfolders.get_xml_lines()


class Photos(ManyMetaDatas):

    type = u"photos"

    def set(self, photos):
    	ManyMetaDatas.set(self, photos)
	self.dirty = 1
    
    def add(self, photo):
    	ManyMetaDatas.add(self, photo)
	self.dirty = 1

    
class Photo(MetaData):

    type = u"photo"
    internals = [u"id", u"angle"]

    def __init__(self):
    	MetaData.__init__(self)
	self[u"angle"] = u"0"
	self.clear_dirty()

    def set_image_filenames(self, storage):
	self[u"dnd:original-filename"] = \
	    storage.get_original_filename(self[u"id"]) or u""
	self[u"dnd:thumbnail-filename"] = \
	    storage.get_thumbnail_filename(self[u"id"]) or u""

    def unset_image_filenames(self):
    	for key in [u"dnd:original-filename", u"dnd:thumbnail-filename"]:
	    if self.has_key(key):
	    	del self[key]

    def get_angle(self):
    	return int(self[u"angle"])

    def set_angle(self, angle):
    	while angle < 0:
	    angle = angle + 360
	while angle >= 360:
	    angle = angle - 360
    	if angle not in [0, 90, 180, 270]:
	    angle = 0
	self[u"angle"] = u"%d" % angle


def test():
    doc = Document()
    folder = Folder()
    folder[u"name"] = u"Wedding pictures: all"
    folder.photos = Photos()
    folder.photos.add(Photo())
    folder.photos.add(Photo())
    folder.photos.add(Photo())
    subfolder = Folder()
    subfolder.photos.add(Photo())
    subfolder[u"name"] = u"Wedding pictures"
    folder.subfolders.add(subfolder)
    doc.folders.set([folder])
    print doc.get_xml_document()

def test2():
    import sys
    import time
    import profile
    import pstats
    
    global doc
    
    p = Parser()
    p.feed(sys.stdin.read())
    doc = p.close()

    doc[u"filename"] = u"test-metadata-save"
    profile.run("doc.save()", "metadata.prof")
    
    p = pstats.Stats("metadata.prof")
    p.strip_dirs().sort_stats("time").print_stats()

def test3():
    import sys
    import time
    import profile
    import pstats
    
    global p, data
    
    data = sys.stdin.read()

    p = Parser()
    profile.run("p.feed(data)", "metadata.prof")
    p.close()

    p = pstats.Stats("metadata.prof")
    p.strip_dirs().sort_stats("time").print_stats()

if __name__ == "__main__":
    test3()