ca527f66bc6287729ad2bb4566e576422a843ce6
[librarian.git] / librarian / __init__.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 class ParseError(Exception):
9     
10     def __init__(self, cause, message=None):
11         self.cause = cause
12         try:
13             self.message = message or self.cause.message
14         except:
15             self.message = "No message."
16
17 class ValidationError(Exception):
18     pass
19
20 class NoDublinCore(ValidationError):
21     pass
22
23 class XMLNamespace(object):
24     '''A handy structure to repsent names in an XML namespace.'''
25
26     def __init__(self, uri):
27         self.uri = uri
28
29     def __call__(self, tag):
30         return '{%s}%s' % (self.uri, tag)
31
32     def __contains__(self, tag):
33         return tag.startswith('{'+str(self)+'}')
34
35     def __repr__(self):
36         return 'XMLNamespace(%r)' % self.uri
37
38     def __str__(self):
39         return '%s' % self.uri
40
41 class EmptyNamespace(XMLNamespace):
42     def __init__(self):
43         super(EmptyNamespace, self).__init__('')
44
45     def __call__(self, tag):
46         return tag
47
48 # some common namespaces we use
49 RDFNS = XMLNamespace('http://www.w3.org/1999/02/22-rdf-syntax-ns#')
50 DCNS = XMLNamespace('http://purl.org/dc/elements/1.1/')
51 XINS = XMLNamespace("http://www.w3.org/2001/XInclude")
52 XHTMLNS = XMLNamespace("http://www.w3.org/1999/xhtml")
53
54 WLNS = EmptyNamespace()
55
56 import lxml.etree as etree
57 import dcparser
58
59 DEFAULT_BOOKINFO = dcparser.BookInfo(
60         { RDFNS('about'): u'http://wiki.wolnepodreczniki.pl/Lektury:Template'},\
61         { DCNS('creator'): [u'Some, Author'],
62           DCNS('title'): [u'Some Title'],
63           DCNS('subject.period'): [u'Unknown'],
64           DCNS('subject.type'): [u'Unknown'],
65           DCNS('subject.genre'): [u'Unknown'],
66           DCNS('date'): ['1970-01-01'],
67           # DCNS('date'): [creation_date],
68           DCNS('publisher'): [u"Fundacja Nowoczesna Polska"],
69           DCNS('description'):
70           [u"""Publikacja zrealizowana w ramach projektu
71              Wolne Lektury (http://wolnelektury.pl). Reprodukcja cyfrowa
72              wykonana przez Bibliotekę Narodową z egzemplarza
73              pochodzącego ze zbiorów BN."""],
74           DCNS('identifier.url'):
75             [u"http://wolnelektury.pl/katalog/lektura/template"],
76           DCNS('rights'):
77             [u"Domena publiczna - zm. [OPIS STANU PRAWNEGO TEKSTU]"] })
78
79 def xinclude_forURI(uri):
80     e = etree.Element( XINS("include") )
81     e.set("href", uri)
82     return etree.tostring(e, encoding=unicode)
83     
84 def wrap_text(ocrtext, creation_date, bookinfo=DEFAULT_BOOKINFO):
85     """Wrap the text within the minimal XML structure with a DC template."""
86     bookinfo.created_at = creation_date
87     
88     dcstring = etree.tostring(bookinfo.to_etree(),\
89         method='xml', encoding=unicode, pretty_print=True)
90
91     return u'<utwor>\n' + dcstring + u'\n<plain-text>\n' + ocrtext +\
92         u'\n</plain-text>\n</utwor>';
93
94
95 def serialize_raw(element):
96     b = u'' + (element.text or '')
97
98     for child in element.iterchildren():
99         e = etree.tostring(child, method='xml', encoding=unicode, pretty_print=True)
100         b += e
101
102     return b
103
104 SERIALIZERS = {
105     'raw': serialize_raw,
106 }
107
108 def serialize_children(element, format='raw'):
109     return SERIALIZERS[format](element)