librarian/dcparser.py

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