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