32a3af0be7e66201423d07bd728e79980f7ea422
[librarian.git] / librarian / __init__.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 __future__ import with_statement
7
8 import os
9 import re
10 import shutil
11
12 class ParseError(Exception):
13     def __str__(self):
14         """ Dirty workaround for Python Unicode handling problems. """
15         return self.message
16
17     def __unicode__(self):
18         """ Dirty workaround for Python Unicode handling problems. """
19         return self.message
20
21 class ValidationError(Exception):
22     pass
23
24 class NoDublinCore(ValidationError):
25     """There's no DublinCore section, and it's required."""
26     pass
27
28 class NoProvider(Exception):
29     """There's no DocProvider specified, and it's needed."""
30     pass
31
32 class XMLNamespace(object):
33     '''A handy structure to repsent names in an XML namespace.'''
34
35     def __init__(self, uri):
36         self.uri = uri
37
38     def __call__(self, tag):
39         return '{%s}%s' % (self.uri, tag)
40
41     def __contains__(self, tag):
42         return tag.startswith('{' + str(self) + '}')
43
44     def __repr__(self):
45         return 'XMLNamespace(%r)' % self.uri
46
47     def __str__(self):
48         return '%s' % self.uri
49
50 class EmptyNamespace(XMLNamespace):
51     def __init__(self):
52         super(EmptyNamespace, self).__init__('')
53
54     def __call__(self, tag):
55         return tag
56
57 # some common namespaces we use
58 RDFNS = XMLNamespace('http://www.w3.org/1999/02/22-rdf-syntax-ns#')
59 DCNS = XMLNamespace('http://purl.org/dc/elements/1.1/')
60 XINS = XMLNamespace("http://www.w3.org/2001/XInclude")
61 XHTMLNS = XMLNamespace("http://www.w3.org/1999/xhtml")
62 NCXNS = XMLNamespace("http://www.daisy.org/z3986/2005/ncx/")
63 OPFNS = XMLNamespace("http://www.idpf.org/2007/opf")
64
65 WLNS = EmptyNamespace()
66
67
68 class WLURI(object):
69     """Represents a WL URI. Extracts slug and language from it."""
70     DEFAULT_LANGUAGE = u'pol'
71
72     slug = None
73     language = None
74
75     example = 'http://wolnelektury.pl/katalog/lektura/template/'
76     _re_wl_uri = re.compile('http://wolnelektury.pl/katalog/lektura/'
77             '(?P<slug>[-a-z0-9]+)(/(?P<lang>[a-z]{3}))?/?$')
78
79     def __init__(self, uri=None):
80         if uri is not None:
81             uri = unicode(uri)
82             self.uri = uri
83             match = self._re_wl_uri.match(uri)
84             if not match:
85                 raise ValueError('Supplied URI (%s) does not match '
86                         'the WL document URI template.' % uri)
87             self.slug = match.group('slug')
88             self.language = match.group('lang') or self.DEFAULT_LANGUAGE
89
90     @classmethod
91     def from_slug_and_lang(cls, slug, lang):
92         """Contructs an URI from slug and language code.
93
94         >>> WLURI.from_slug_and_lang('a-slug', WLURI.DEFAULT_LANGUAGE).uri
95         u'http://wolnelektury.pl/katalog/lektura/a-slug/'
96         >>> WLURI.from_slug_and_lang('a-slug', 'deu').uri
97         u'http://wolnelektury.pl/katalog/lektura/a-slug/deu/'
98
99         """
100         if lang is None:
101             lang = cls.DEFAULT_LANGUAGE
102         uri = 'http://wolnelektury.pl/katalog/lektura/%s/' % slug
103         if lang is not None and lang != cls.DEFAULT_LANGUAGE:
104             uri += lang + '/'
105         return cls(uri)
106
107     def __unicode__(self):
108         return self.uri
109
110     def __str__(self):
111         return self.uri
112
113     def __eq__(self, other):
114         return self.slug, self.language == other.slug, other.language
115
116     def filename_stem(self):
117         stem = self.slug
118         if self.language != self.DEFAULT_LANGUAGE:
119             stem += '_' + self.language
120         return stem
121
122     def validate_language(self, language):
123         if language != self.language:
124             raise ValidationError("Incorrect language definition in URI")
125
126
127 class DocProvider(object):
128     """Base class for a repository of XML files.
129
130     Used for generating joined files, like EPUBs.
131     """
132
133     def by_slug_and_lang(self, slug, lang=None):
134         """Should return a file-like object with a WL document XML."""
135         raise NotImplementedError
136
137     def by_slug(self, slug):
138         """Should return a file-like object with a WL document XML."""
139         return self.by_slug_and_lang(slug)
140
141     def by_uri(self, uri):
142         """Should return a file-like object with a WL document XML."""
143         wluri = WLURI(uri)
144         return self.by_slug_and_lang(wluri.slug, wluri.language)
145
146
147 class DirDocProvider(DocProvider):
148     """ Serve docs from a directory of files in form <slug>.xml """
149
150     def __init__(self, dir_):
151         self.dir = dir_
152         self.files = {}
153         return super(DirDocProvider, self).__init__()
154
155     def by_slug_and_lang(self, slug, lang=None):
156         fname = WLURI.from_slug_and_lang(slug, lang).filename_stem() + '.xml'
157         return open(os.path.join(self.dir, fname))
158
159
160 import lxml.etree as etree
161 import dcparser
162
163 DEFAULT_BOOKINFO = dcparser.BookInfo(
164         { RDFNS('about'): u'http://wiki.wolnepodreczniki.pl/Lektury:Template'},
165         { DCNS('creator'): [u'Some, Author'],
166           DCNS('title'): [u'Some Title'],
167           DCNS('subject.period'): [u'Unknown'],
168           DCNS('subject.type'): [u'Unknown'],
169           DCNS('subject.genre'): [u'Unknown'],
170           DCNS('date'): ['1970-01-01'],
171           DCNS('language'): [WLURI.DEFAULT_LANGUAGE],
172           # DCNS('date'): [creation_date],
173           DCNS('publisher'): [u"Fundacja Nowoczesna Polska"],
174           DCNS('description'):
175           [u"""Publikacja zrealizowana w ramach projektu
176              Wolne Lektury (http://wolnelektury.pl). Reprodukcja cyfrowa
177              wykonana przez Bibliotekę Narodową z egzemplarza
178              pochodzącego ze zbiorów BN."""],
179           DCNS('identifier.url'): [WLURI.example],
180           DCNS('rights'):
181             [u"Domena publiczna - zm. [OPIS STANU PRAWNEGO TEKSTU]"] })
182
183 def xinclude_forURI(uri):
184     e = etree.Element(XINS("include"))
185     e.set("href", uri)
186     return etree.tostring(e, encoding=unicode)
187
188 def wrap_text(ocrtext, creation_date, bookinfo=DEFAULT_BOOKINFO):
189     """Wrap the text within the minimal XML structure with a DC template."""
190     bookinfo.created_at = creation_date
191
192     dcstring = etree.tostring(bookinfo.to_etree(), \
193         method='xml', encoding=unicode, pretty_print=True)
194
195     return u'<utwor>\n' + dcstring + u'\n<plain-text>\n' + ocrtext + \
196         u'\n</plain-text>\n</utwor>'
197
198
199 def serialize_raw(element):
200     b = u'' + (element.text or '')
201
202     for child in element.iterchildren():
203         e = etree.tostring(child, method='xml', encoding=unicode,
204                 pretty_print=True)
205         b += e
206
207     return b
208
209 SERIALIZERS = {
210     'raw': serialize_raw,
211 }
212
213 def serialize_children(element, format='raw'):
214     return SERIALIZERS[format](element)
215
216 def get_resource(path):
217     return os.path.join(os.path.dirname(__file__), path)
218
219
220 class OutputFile(object):
221     """Represents a file returned by one of the converters."""
222
223     _string = None
224     _filename = None
225
226     def __del__(self):
227         if self._filename:
228             os.unlink(self._filename)
229
230     def __nonzero__(self):
231         return self._string is not None or self._filename is not None
232
233     @classmethod
234     def from_string(cls, string):
235         """Converter returns contents of a file as a string."""
236
237         instance = cls()
238         instance._string = string
239         return instance
240
241     @classmethod
242     def from_filename(cls, filename):
243         """Converter returns contents of a file as a named file."""
244
245         instance = cls()
246         instance._filename = filename
247         return instance
248
249     def get_string(self):
250         """Get file's contents as a string."""
251
252         if self._filename is not None:
253             with open(self._filename) as f:
254                 return f.read()
255         else:
256             return self._string
257
258     def get_file(self):
259         """Get file as a file-like object."""
260
261         if self._string is not None:
262             from StringIO import StringIO
263             return StringIO(self._string)
264         elif self._filename is not None:
265             return open(self._filename)
266
267     def get_filename(self):
268         """Get file as a fs path."""
269
270         if self._filename is not None:
271             return self._filename
272         elif self._string is not None:
273             from tempfile import NamedTemporaryFile
274             temp = NamedTemporaryFile(prefix='librarian-', delete=False)
275             temp.write(self._string)
276             temp.close()
277             self._filename = temp.name
278             return self._filename
279         else:
280             return None
281
282     def save_as(self, path):
283         """Save file to a path. Create directories, if necessary."""
284
285         dirname = os.path.dirname(os.path.abspath(path))
286         if not os.path.isdir(dirname):
287             os.makedirs(dirname)
288         shutil.copy(self.get_filename(), path)