5492f7ab19c80983e2f9827879ef4c2fb81ef821
[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 class Field(object):
83     def __init__(self, uri, attr_name, type=as_unicode, multiple=False, salias=None, **kwargs):
84         self.uri = uri
85         self.name = attr_name
86         self.validator = type
87         self.multiple = multiple
88         self.salias = salias
89
90         self.required = kwargs.get('required', True) and not kwargs.has_key('default')
91         self.default = kwargs.get('default', [] if multiple else [None])
92
93     def validate_value(self, val):
94         try:
95             if self.multiple:
96                 if self.validator is None:
97                     return val
98                 return [ self.validator(v) if v is not None else v for v in val ]
99             elif len(val) > 1:
100                 raise ValidationError("Multiple values not allowed for field '%s'" % self.uri)
101             elif len(val) == 0:
102                 raise ValidationError("Field %s has no value to assign. Check your defaults." % self.uri)
103             else:
104                 if self.validator is None or val[0] is None:
105                     return val[0]
106                 return self.validator(val[0])
107         except ValueError, e:
108             raise ValidationError("Field '%s' - invald value: %s" % (self.uri, e.message))
109
110     def validate(self, fdict):
111         if not fdict.has_key(self.uri):
112             if not self.required:
113                 f = self.default
114             else:
115                 raise ValidationError("Required field %s not found" % self.uri)
116         else:
117             f = fdict[self.uri]
118
119         return self.validate_value(f)
120
121
122
123
124 class BookInfo(object):
125     FIELDS = (
126         Field( DCNS('creator'), 'author', as_person),
127         Field( DCNS('title'), 'title'),
128         Field( DCNS('subject.period'), 'epochs', salias='epoch', multiple=True),
129         Field( DCNS('subject.type'), 'kinds', salias='kind', multiple=True),
130         Field( DCNS('subject.genre'), 'genres', salias='genre', multiple=True),
131         Field( DCNS('audience'), 'audiences', salias='audience', multiple=True,
132                 required=False),
133         Field( DCNS('date'), 'created_at', as_date),
134         Field( DCNS('date.pd'), 'released_to_public_domain_at', as_date, required=False),
135         Field( DCNS('contributor.editor'), 'editors', \
136             as_person, salias='editor', multiple=True, default=[]),
137         Field( DCNS('contributor.translator'), 'translators', \
138             as_person,  salias='translator', multiple=True, default=[]),
139         Field( DCNS('contributor.technical_editor'), 'technical_editors',
140             as_person, salias='technical_editor', multiple=True, default=[]),
141         Field( DCNS('publisher'), 'publisher'),
142         Field( DCNS('source'), 'source_name', required=False),
143         Field( DCNS('source.URL'), 'source_url', required=False),
144         Field( DCNS('identifier.url'), 'url'),
145         Field( DCNS('relation.hasPart'), 'parts', multiple=True, required=False),
146         Field( DCNS('rights.license'), 'license', required=False),
147         Field( DCNS('rights'), 'license_description'),
148         Field( DCNS('language'), 'language'),
149         Field( DCNS('description'), 'description', required=False),
150     )
151
152     @property
153     def slug(self):
154         return WLURI(self.url).slug
155
156     @classmethod
157     def from_string(cls, xml):
158         from StringIO import StringIO
159         return cls.from_file(StringIO(xml))
160
161     @classmethod
162     def from_file(cls, xmlfile):
163         desc_tag = None
164         try:
165             iter = etree.iterparse(xmlfile, ['start', 'end'])
166             for (event, element) in iter:
167                 if element.tag == RDFNS('RDF') and event == 'start':
168                     desc_tag = element
169                     break
170
171             if desc_tag is None:
172                 raise NoDublinCore("DublinCore section not found. \
173                     Check if there are rdf:RDF and rdf:Description tags.")
174
175             # continue 'till the end of RDF section
176             for (event, element) in iter:
177                 if element.tag == RDFNS('RDF') and event == 'end':
178                     break
179
180             # if there is no end, Expat should yell at us with an ExpatError
181
182             # extract data from the element and make the info
183             return cls.from_element(desc_tag)
184         except XMLSyntaxError, e:
185             raise ParseError(e)
186         except ExpatError, e:
187             raise ParseError(e)
188
189     @classmethod
190     def from_element(cls, rdf_tag):
191         # the tree is already parsed, so we don't need to worry about Expat errors
192         field_dict = {}
193         desc = rdf_tag.find(".//" + RDFNS('Description') )
194
195         if desc is None:
196             raise NoDublinCore("No DublinCore section found.")
197
198         for e in desc.getchildren():
199             fv = field_dict.get(e.tag, [])
200             fv.append(e.text)
201             field_dict[e.tag] = fv
202
203         return cls( desc.attrib, field_dict )
204
205     def __init__(self, rdf_attrs, dc_fields):
206         """rdf_attrs should be a dictionary-like object with any attributes of the RDF:Description.
207         dc_fields - dictionary mapping DC fields (with namespace) to list of text values for the
208         given field. """
209
210         self.about = rdf_attrs.get(RDFNS('about'))
211         self.fmap = {}
212
213         for field in self.FIELDS:
214             value = field.validate( dc_fields )
215             setattr(self, 'prop_' + field.name, value)
216             self.fmap[field.name] = field
217             if field.salias: self.fmap[field.salias] = field
218
219     def __getattribute__(self, name):
220         try:
221             field = object.__getattribute__(self, 'fmap')[name]
222             value = object.__getattribute__(self, 'prop_'+field.name)
223             if field.name == name:
224                 return value
225             else: # singular alias
226                 if not field.multiple:
227                     raise "OUCH!! for field %s" % name
228
229                 return value[0]
230         except (KeyError, AttributeError):
231             return object.__getattribute__(self, name)
232
233     def __setattr__(self, name, newvalue):
234         try:
235             field = object.__getattribute__(self, 'fmap')[name]
236             if field.name == name:
237                 object.__setattr__(self, 'prop_'+field.name, newvalue)
238             else: # singular alias
239                 if not field.multiple:
240                     raise "OUCH! while setting field %s" % name
241
242                 object.__setattr__(self, 'prop_'+field.name, [newvalue])
243         except (KeyError, AttributeError):
244             return object.__setattr__(self, name, newvalue)
245
246     def update(self, field_dict):
247         """Update using field_dict. Verify correctness, but don't check if all
248         required fields are present."""
249         for field in self.FIELDS:
250             if field_dict.has_key(field.name):
251                 setattr(self, field.name, field_dict[field.name])
252
253     def to_etree(self, parent = None):
254         """XML representation of this object."""
255         #etree._namespace_map[str(self.RDF)] = 'rdf'
256         #etree._namespace_map[str(self.DC)] = 'dc'
257
258         if parent is None:
259             root = etree.Element(RDFNS('RDF'))
260         else:
261             root = parent.makeelement(RDFNS('RDF'))
262
263         description = etree.SubElement(root, RDFNS('Description'))
264
265         if self.about:
266             description.set(RDFNS('about'), self.about)
267
268         for field in self.FIELDS:
269             v = getattr(self, field.name, None)
270             if v is not None:
271                 if field.multiple:
272                     if len(v) == 0: continue
273                     for x in v:
274                         e = etree.Element(field.uri)
275                         if x is not None:
276                             e.text = unicode(x)
277                         description.append(e)
278                 else:
279                     e = etree.Element(field.uri)
280                     e.text = unicode(v)
281                     description.append(e)
282
283         return root
284
285
286     def serialize(self):
287         rdf = {}
288         rdf['about'] = { 'uri': RDFNS('about'), 'value': self.about }
289
290         dc = {}
291         for field in self.FIELDS:
292             v = getattr(self, field.name, None)
293             if v is not None:
294                 if field.multiple:
295                     if len(v) == 0: continue
296                     v = [ unicode(x) for x in v if x is not None ]
297                 else:
298                     v = unicode(v)
299
300                 dc[field.name] = {'uri': field.uri, 'value': v}
301         rdf['fields'] = dc
302         return rdf
303
304     def to_dict(self):
305         result = {'about': self.about}
306         for field in self.FIELDS:
307             v = getattr(self, field.name, None)
308
309             if v is not None:
310                 if field.multiple:
311                     if len(v) == 0: continue
312                     v = [ unicode(x) for x in v if x is not None ]
313                 else:
314                     v = unicode(v)
315                 result[field.name] = v
316
317             if field.salias:
318                 v = getattr(self, field.salias)
319                 if v is not None: result[field.salias] = unicode(v)
320
321         return result
322
323 def parse(file_name):
324     return BookInfo.from_file(file_name)