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