librarian/picture.py

   1
   2 from dcparser import (as_person, as_date, Field, WorkInfo, DCNS)
   3 from librarian import (RDFNS, ValidationError, NoDublinCore, ParseError, WLURI)
   4 from xml.parsers.expat import ExpatError
   5 from os import path
   6 from StringIO import StringIO
   7 from lxml import etree
   8 from lxml.etree import (XMLSyntaxError, XSLTApplyError, Element)
   9 import re
  10 from functools import *
  11 from operator import *
  12
  13 class WLPictureURI(WLURI):
  14     _re_wl_uri = re.compile('http://wolnelektury.pl/katalog/obraz/'
  15             '(?P<slug>[-a-z0-9]+)/?$')
  16
  17     @classmethod
  18     def from_slug(cls, slug):
  19         uri = 'http://wolnelektury.pl/katalog/obraz/%s/' % slug
  20         return cls(uri)
  21
  22 def as_wlpictureuri_strict(text):
  23     return WLPictureURI.strict(text)
  24
  25
  26 class PictureInfo(WorkInfo):
  27     """
  28     Dublin core metadata for a picture
  29     """
  30     FIELDS = (
  31         Field(DCNS('language'), 'language', required=False),
  32         Field(DCNS('subject.period'), 'epochs', salias='epoch', multiple=True),
  33         Field(DCNS('subject.type'), 'kinds', salias='kind', multiple=True),
  34         Field(DCNS('subject.genre'), 'genres', salias='genre', multiple=True, required=False),
  35
  36         Field(DCNS('format.dimensions'), 'dimensions', required=False),
  37         Field(DCNS('format.checksum.sha1'), 'sha1', required=True),
  38         Field(DCNS('description.medium'), 'medium', required=False),
  39         Field(DCNS('description.dimensions'), 'original_dimensions', required=False),
  40         Field(DCNS('format'), 'mime_type', required=False),
  41         Field(DCNS('identifier.url'), 'url', WLPictureURI,
  42             strict=as_wlpictureuri_strict),
  43         )
  44
  45
  46 class ImageStore(object):
  47     EXT = ['gif', 'jpeg', 'png', 'swf', 'psd', 'bmp'
  48             'tiff', 'tiff', 'jpc', 'jp2', 'jpf', 'jb2', 'swc',
  49             'aiff', 'wbmp', 'xbm']
  50     MIME = ['image/gif', 'image/jpeg', 'image/png',
  51             'application/x-shockwave-flash', 'image/psd', 'image/bmp',
  52             'image/tiff', 'image/tiff', 'application/octet-stream',
  53             'image/jp2', 'application/octet-stream', 'application/octet-stream',
  54             'application/x-shockwave-flash', 'image/iff', 'image/vnd.wap.wbmp', 'image/xbm']
  55
  56     def __init__(self, dir_):
  57         self.dir = dir_
  58         return super(ImageStore, self).__init__()
  59
  60     def path(self, slug, mime_type):
  61         """
  62         Finds file by slug and mime type in our iamge store.
  63         Returns a file objects (perhaps should return a filename?)
  64         """
  65         try:
  66             i = self.MIME.index(mime_type)
  67         except ValueError:
  68             err = ValueError("Picture %s has unknown mime type: %s" % (slug, mime_type))
  69             err.slug = slug
  70             err.mime_type = mime_type
  71             raise err
  72         ext = self.EXT[i]
  73         # add some common extensions tiff->tif, jpeg->jpg
  74         return path.join(self.dir, slug + '.' + ext)
  75
  76
  77 class WLPicture(object):
  78     def __init__(self, edoc, parse_dublincore=True, image_store=None):
  79         self.edoc = edoc
  80         self.image_store = image_store
  81
  82         root_elem = edoc.getroot()
  83
  84         dc_path = './/' + RDFNS('RDF')
  85
  86         if root_elem.tag != 'picture':
  87             raise ValidationError("Invalid root element. Found '%s', should be 'picture'" % root_elem.tag)
  88
  89         if parse_dublincore:
  90             self.rdf_elem = root_elem.find(dc_path)
  91
  92             if self.rdf_elem is None:
  93                 raise NoDublinCore('Document has no DublinCore - which is required.')
  94
  95             self.picture_info = PictureInfo.from_element(self.rdf_elem)
  96         else:
  97             self.picture_info = None
  98
  99     @classmethod
 100     def from_string(cls, xml, *args, **kwargs):
 101         return cls.from_file(StringIO(xml), *args, **kwargs)
 102
 103     @classmethod
 104     def from_file(cls, xmlfile, parse_dublincore=True, image_store=None):
 105
 106         # first, prepare for parsing
 107         if isinstance(xmlfile, basestring):
 108             file = open(xmlfile, 'rb')
 109             try:
 110                 data = file.read()
 111             finally:
 112                 file.close()
 113         else:
 114             data = xmlfile.read()
 115
 116         if not isinstance(data, unicode):
 117             data = data.decode('utf-8')
 118
 119         data = data.replace(u'\ufeff', '')
 120
 121         # assume images are in the same directory
 122         if image_store is None and xmlfile.name is not None:
 123             image_store = ImageStore(path.dirname(xmlfile.name))
 124
 125         try:
 126             parser = etree.XMLParser(remove_blank_text=False)
 127             tree = etree.parse(StringIO(data.encode('utf-8')), parser)
 128
 129             me =  cls(tree, parse_dublincore=parse_dublincore, image_store=image_store)
 130             me.load_frame_info()
 131             return me
 132         except (ExpatError, XMLSyntaxError, XSLTApplyError), e:
 133             raise ParseError(e)
 134
 135     @property
 136     def mime_type(self):
 137         if self.picture_info is None:
 138             raise ValueError('DC is not loaded, hence we don\'t know the image type')
 139         return self.picture_info.mime_type
 140
 141     @property
 142     def slug(self):
 143         return self.picture_info.url.slug
 144
 145     @property
 146     def image_path(self):
 147         if self.image_store is None:
 148             raise ValueError("No image store associated with whis WLPicture.")
 149
 150         return self.image_store.path(self.slug, self.mime_type)
 151
 152     def image_file(self, *args, **kwargs):
 153         return open(self.image_path, *args, **kwargs)
 154
 155     def get_sem_coords(self, sem):
 156         area = sem.find("div[@type='rect']")
 157         if area is None:
 158             area = sem.find("div[@type='whole']")
 159             return [[0, 0], [-1, -1]]
 160
 161         def has_all_props(node, props):
 162             return reduce(and_, map(lambda prop: prop in node.attrib, props))
 163
 164         if has_all_props(area,  ['x1', 'x2', 'y1', 'y2']) == False:
 165             return None
 166
 167         def n(prop): return int(area.get(prop))
 168         return [[n('x1'), n('y1')], [n('x2'), n('y2')]]
 169
 170
 171     def partiter(self):
 172         """
 173         Iterates the parts of this picture and returns them and their metadata
 174         """
 175         # omg no support for //sem[(@type='theme') or (@type='object')] ?
 176         for part in list(self.edoc.iterfind("//sem[@type='theme']")) + list(self.edoc.iterfind("//sem[@type='object']")):
 177             pd = {}
 178             pd['type'] = part.get('type')
 179
 180             coords = self.get_sem_coords(part)
 181             if coords is None: continue
 182             pd['coords'] = coords
 183
 184             def want_unicode(x):
 185                 if not isinstance(x, unicode): return x.decode('utf-8')
 186                 else: return x
 187             pd['object'] = part.attrib['type'] == 'object' and want_unicode(part.attrib.get('object', u'')) or None
 188             pd['themes'] = part.attrib['type'] == 'theme' and [part.attrib.get('theme', u'')] or []
 189             yield pd
 190
 191     def load_frame_info(self):
 192         k = self.edoc.find("//sem[@object='kadr']")
 193
 194         if k is not None:
 195             clip = self.get_sem_coords(k)
 196             self.frame = clip
 197             frm = Element("sem", {"type": "frame"})
 198             frm.append(k.iter("div").next())
 199             self.edoc.getroot().append(frm)
 200             k.getparent().remove(k)
 201         else:
 202             frm = self.edoc.find("//sem[@type='frame']")
 203             if frm:
 204                 self.frame = self.get_sem_coords(frm)
 205             else:
 206                 self.frame = None
 207         return self