librarian/dcparser.py

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