031a73110ca0527214d88c958620af022a889dfc
[librarian.git] / librarian / dcparser.py
1 # -*- coding: utf-8 -*-
2 #
3 # This file is part of Librarian, licensed under GNU Affero GPLv3 or later.
4 # Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
5 #
6 from xml.parsers.expat import ExpatError
7 from datetime import date
8 import time
9
10 from librarian import (ValidationError, NoDublinCore, ParseError, DCNS, RDFNS,
11                        WLURI)
12
13 import lxml.etree as etree # ElementTree API using libxml2
14 from lxml.etree import XMLSyntaxError
15
16
17 # ==============
18 # = Converters =
19 # ==============
20 class Person(object):
21     """Single person with last name and a list of first names."""
22     def __init__(self, last_name, *first_names):
23         self.last_name = last_name
24         self.first_names = first_names
25
26     @classmethod
27     def from_text(cls, text):
28         parts = [ token.strip() for token in text.split(',') ]
29         if len(parts) == 1:
30             surname = parts[0]
31             names = []
32         elif len(parts) != 2:
33             raise ValueError("Invalid person name. There should be at most one comma: \"%s\"." % text)
34         else:
35             surname = parts[0]
36             if len(parts[1]) == 0:
37                 # there is no non-whitespace data after the comma
38                 raise ValueError("Found a comma, but no names given: \"%s\" -> %r." % (text, parts))
39             names = [ name for name in parts[1].split() if len(name) ] # all non-whitespace tokens
40         return cls(surname, *names)
41
42     def readable(self):
43         return u" ".join(self.first_names + (self.last_name,))
44
45     def __eq__(self, right):
46         return self.last_name == right.last_name and self.first_names == right.first_names
47
48     def __cmp__(self, other):
49         return cmp((self.last_name, self.first_names), (other.last_name, other.first_names))
50
51     def __hash__(self):
52         return hash((self.last_name, self.first_names))
53
54     def __unicode__(self):
55         if len(self.first_names) > 0:
56             return '%s, %s' % (self.last_name, ' '.join(self.first_names))
57         else:
58             return self.last_name
59
60     def __repr__(self):
61         return 'Person(last_name=%r, first_names=*%r)' % (self.last_name, self.first_names)
62
63 def as_date(text):
64     try:
65         try:
66             t = time.strptime(text, '%Y-%m-%d')
67         except ValueError:
68             t = time.strptime(text, '%Y')
69         return date(t[0], t[1], t[2])
70     except ValueError, e:
71         raise ValueError("Unrecognized date format. Try YYYY-MM-DD or YYYY.")
72
73 def as_person(text):
74     return Person.from_text(text)
75
76 def as_unicode(text):
77     if isinstance(text, unicode):
78         return text
79     else:
80         return text.decode('utf-8')
81
82 def as_wluri_strict(text):
83     return WLURI.strict(text)
84
85 class Field(object):
86     def __init__(self, uri, attr_name, validator=as_unicode, strict=None, multiple=False, salias=None, **kwargs):
87         self.uri = uri
88         self.name = attr_name
89         self.validator = validator
90         self.strict = strict
91         self.multiple = multiple
92         self.salias = salias
93
94         self.required = kwargs.get('required', True) and not kwargs.has_key('default')
95         self.default = kwargs.get('default', [] if multiple else [None])
96
97     def validate_value(self, val, strict=False):
98         val = [v.strip() if v is not None else v for v in val]
99         if strict and self.strict is not None:
100             validator = self.strict
101         else:
102             validator = self.validator
103         try:
104             if self.multiple:
105                 if validator is None:
106                     return val
107                 return [ validator(v) if v is not None else v for v in val ]
108             elif len(val) > 1:
109                 raise ValidationError("Multiple values not allowed for field '%s'" % self.uri)
110             elif len(val) == 0:
111                 raise ValidationError("Field %s has no value to assign. Check your defaults." % self.uri)
112             else:
113                 if validator is None or val[0] is None:
114                     return val[0]
115                 return validator(val[0])
116         except ValueError, e:
117             raise ValidationError("Field '%s' - invald value: %s" % (self.uri, e.message))
118
119     def validate(self, fdict, fallbacks=None, strict=False):
120         if fallbacks is None:
121             fallbacks = {}
122         if not fdict.has_key(self.uri):
123             if not self.required:
124                 # Accept single value for single fields and saliases.
125                 if self.name in fallbacks:
126                     if self.multiple:
127                         f = fallbacks[self.name]
128                     else:
129                         f = [fallbacks[self.name]]
130                 elif self.salias and self.salias in fallbacks:
131                     f = [fallbacks[self.salias]]
132                 else:
133                     f = self.default
134             else:
135                 raise ValidationError("Required field %s not found" % self.uri)
136         else:
137             f = fdict[self.uri]
138
139         return self.validate_value(f, strict=strict)
140
141     def __eq__(self, other):
142         if isinstance(other, Field) and other.name == self.name:
143             return True
144         return False
145
146
147 class DCInfo(type):
148     def __new__(meta, classname, bases, class_dict):
149         fields = list(class_dict['FIELDS'])
150
151         for base in bases[::-1]:
152             if hasattr(base, 'FIELDS'):
153                 for field in base.FIELDS[::-1]:
154                     try:
155                         fields.index(field)
156                     except ValueError:
157                         fields.insert(0, field)
158
159         class_dict['FIELDS'] = tuple(fields)
160         return super(DCInfo, meta).__new__(meta, classname, bases, class_dict)
161
162
163 class WorkInfo(object):
164     __metaclass__ = DCInfo
165
166     FIELDS = (
167         Field( DCNS('creator.expert'), 'authors', as_person, salias='author', multiple=True),
168         Field( DCNS('creator.scenario'), 'authors', as_person, salias='author', multiple=True),
169         Field( DCNS('creator.textbook'), 'authors', as_person, salias='author', multiple=True),
170         Field( DCNS('title'), 'title'),
171         Field( DCNS('type'), 'type', required=False, multiple=True),
172
173         Field( DCNS('contributor.editor'), 'editors', \
174             as_person, salias='editor', multiple=True, default=[]),
175         Field( DCNS('contributor.technical_editor'), 'technical_editors',
176             as_person, salias='technical_editor', multiple=True, default=[]),
177
178         Field( DCNS('date'), 'created_at', as_date),
179         Field( DCNS('date.pd'), 'released_to_public_domain_at', as_date, required=False),
180         Field( DCNS('publisher'), 'publisher'),
181
182         Field( DCNS('subject.competence'), 'competences', multiple=True, required=False),
183         Field( DCNS('subject.curriculum'), 'curriculum', multiple=True, required=False),
184
185         Field( DCNS('language'), 'language'),
186         Field( DCNS('description'), 'description', required=False),
187
188         Field( DCNS('source'), 'source_name', required=False),
189         Field( DCNS('source.URL'), 'source_url', required=False),
190         Field( DCNS('identifier.url'), 'url', WLURI, strict=as_wluri_strict),
191         Field( DCNS('rights.license'), 'license', required=False),
192         Field( DCNS('rights'), 'license_description'),
193     )
194
195     @classmethod
196     def from_string(cls, xml, *args, **kwargs):
197         from StringIO import StringIO
198         return cls.from_file(StringIO(xml), *args, **kwargs)
199
200     @classmethod
201     def from_file(cls, xmlfile, *args, **kwargs):
202         desc_tag = None
203         try:
204             iter = etree.iterparse(xmlfile, ['start', 'end'])
205             for (event, element) in iter:
206                 if element.tag == RDFNS('RDF') and event == 'start':
207                     desc_tag = element
208                     break
209
210             if desc_tag is None:
211                 raise NoDublinCore("DublinCore section not found. \
212                     Check if there are rdf:RDF and rdf:Description tags.")
213
214             # continue 'till the end of RDF section
215             for (event, element) in iter:
216                 if element.tag == RDFNS('RDF') and event == 'end':
217                     break
218
219             # if there is no end, Expat should yell at us with an ExpatError
220
221             # extract data from the element and make the info
222             return cls.from_element(desc_tag, *args, **kwargs)
223         except XMLSyntaxError, e:
224             raise ParseError(e)
225         except ExpatError, e:
226             raise ParseError(e)
227
228     @classmethod
229     def from_element(cls, rdf_tag, *args, **kwargs):
230         # the tree is already parsed, so we don't need to worry about Expat errors
231         field_dict = {}
232         desc = rdf_tag.find(".//" + RDFNS('Description'))
233
234         if desc is None:
235             raise NoDublinCore("No DublinCore section found.")
236
237         for e in desc.getchildren():
238             fv = field_dict.get(e.tag, [])
239             fv.append(e.text)
240             field_dict[e.tag] = fv
241
242         return cls(desc.attrib, field_dict, *args, **kwargs)
243
244     def __init__(self, rdf_attrs, dc_fields, fallbacks=None, strict=False):
245         """rdf_attrs should be a dictionary-like object with any attributes of the RDF:Description.
246         dc_fields - dictionary mapping DC fields (with namespace) to list of text values for the
247         given field. """
248
249         self.about = rdf_attrs.get(RDFNS('about'))
250         self.fmap = {}
251
252         for field in self.FIELDS:
253             value = field.validate(dc_fields, fallbacks=fallbacks,
254                             strict=strict)
255             setattr(self, 'prop_' + field.name, value)
256             self.fmap[field.name] = field
257             if field.salias: self.fmap[field.salias] = field
258
259     def __getattribute__(self, name):
260         try:
261             field = object.__getattribute__(self, 'fmap')[name]
262             value = object.__getattribute__(self, 'prop_'+field.name)
263             if field.name == name:
264                 return value
265             else: # singular alias
266                 if not field.multiple:
267                     raise "OUCH!! for field %s" % name
268
269                 return value[0] if value else None
270         except (KeyError, AttributeError):
271             return object.__getattribute__(self, name)
272
273     def __setattr__(self, name, newvalue):
274         try:
275             field = object.__getattribute__(self, 'fmap')[name]
276             if field.name == name:
277                 object.__setattr__(self, 'prop_'+field.name, newvalue)
278             else: # singular alias
279                 if not field.multiple:
280                     raise "OUCH! while setting field %s" % name
281
282                 object.__setattr__(self, 'prop_'+field.name, [newvalue])
283         except (KeyError, AttributeError):
284             return object.__setattr__(self, name, newvalue)
285
286     def update(self, field_dict):
287         """Update using field_dict. Verify correctness, but don't check if all
288         required fields are present."""
289         for field in self.FIELDS:
290             if field_dict.has_key(field.name):
291                 setattr(self, field.name, field_dict[field.name])
292
293     def to_etree(self, parent = None):
294         """XML representation of this object."""
295         #etree._namespace_map[str(self.RDF)] = 'rdf'
296         #etree._namespace_map[str(self.DC)] = 'dc'
297
298         if parent is None:
299             root = etree.Element(RDFNS('RDF'))
300         else:
301             root = parent.makeelement(RDFNS('RDF'))
302
303         description = etree.SubElement(root, RDFNS('Description'))
304
305         if self.about:
306             description.set(RDFNS('about'), self.about)
307
308         for field in self.FIELDS:
309             v = getattr(self, field.name, None)
310             if v is not None:
311                 if field.multiple:
312                     if len(v) == 0: continue
313                     for x in v:
314                         e = etree.Element(field.uri)
315                         if x is not None:
316                             e.text = unicode(x)
317                         description.append(e)
318                 else:
319                     e = etree.Element(field.uri)
320                     e.text = unicode(v)
321                     description.append(e)
322
323         return root
324
325     def serialize(self):
326         rdf = {}
327         rdf['about'] = { 'uri': RDFNS('about'), 'value': self.about }
328
329         dc = {}
330         for field in self.FIELDS:
331             v = getattr(self, field.name, None)
332             if v is not None:
333                 if field.multiple:
334                     if len(v) == 0: continue
335                     v = [ unicode(x) for x in v if x is not None ]
336                 else:
337                     v = unicode(v)
338
339                 dc[field.name] = {'uri': field.uri, 'value': v}
340         rdf['fields'] = dc
341         return rdf
342
343     def to_dict(self):
344         result = {'about': self.about}
345         for field in self.FIELDS:
346             v = getattr(self, field.name, None)
347
348             if v is not None:
349                 if field.multiple:
350                     if len(v) == 0: continue
351                     v = [ unicode(x) for x in v if x is not None ]
352                 else:
353                     v = unicode(v)
354                 result[field.name] = v
355
356             if field.salias:
357                 v = getattr(self, field.salias)
358                 if v is not None: result[field.salias] = unicode(v)
359
360         return result
361
362
363 class BookInfo(WorkInfo):
364     FIELDS = (
365         Field( DCNS('audience'), 'audiences', salias='audience', multiple=True,
366                 required=False),
367
368         Field( DCNS('subject.period'), 'epochs', salias='epoch', multiple=True,
369                 required=False),
370         Field( DCNS('subject.type'), 'kinds', salias='kind', multiple=True,
371                 required=False),
372         Field( DCNS('subject.genre'), 'genres', salias='genre', multiple=True,
373                 required=False),
374                 
375         Field( DCNS('contributor.translator'), 'translators', \
376             as_person,  salias='translator', multiple=True, default=[]),
377         Field( DCNS('relation.hasPart'), 'parts', 
378             WLURI, strict=as_wluri_strict, multiple=True, required=False),
379         Field( DCNS('relation.isVariantOf'), 'variant_of', 
380             WLURI, strict=as_wluri_strict, required=False),
381
382         Field( DCNS('relation.coverImage.url'), 'cover_url', required=False),
383         Field( DCNS('relation.coverImage.attribution'), 'cover_by', required=False),
384         Field( DCNS('relation.coverImage.source'), 'cover_source', required=False),
385     )
386
387
388 def parse(file_name, cls=BookInfo):
389     return cls.from_file(file_name)