#950: visibly mark author's annotations,

[librarian.git] / librarian / __init__.py

diff --git a/librarian/__init__.py b/librarian/__init__.py
index 9132f5c..5c4a355 100644 (file)
--- a/librarian/__init__.py
+++ b/librarian/__init__.py
@@ -1,5 +1,9 @@
 # -*- coding: utf-8 -*-
 # -*- coding: utf-8 -*-

-# exception classes
+#
+# This file is part of Librarian, licensed under GNU Affero GPLv3 or later.
+# Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
+#
+import os

 
 class ParseError(Exception):
     pass
 
 class ParseError(Exception):
     pass


@@ -9,3 +13,124 @@ class ValidationError(Exception):
 
 class NoDublinCore(ValidationError):
     pass
 
 class NoDublinCore(ValidationError):
     pass

+
+class XMLNamespace(object):
+    '''A handy structure to repsent names in an XML namespace.'''
+
+    def __init__(self, uri):
+        self.uri = uri
+
+    def __call__(self, tag):
+        return '{%s}%s' % (self.uri, tag)
+
+    def __contains__(self, tag):
+        return tag.startswith('{' + str(self) + '}')
+
+    def __repr__(self):
+        return 'XMLNamespace(%r)' % self.uri
+
+    def __str__(self):
+        return '%s' % self.uri
+
+class EmptyNamespace(XMLNamespace):
+    def __init__(self):
+        super(EmptyNamespace, self).__init__('')
+
+    def __call__(self, tag):
+        return tag
+
+# some common namespaces we use
+RDFNS = XMLNamespace('http://www.w3.org/1999/02/22-rdf-syntax-ns#')
+DCNS = XMLNamespace('http://purl.org/dc/elements/1.1/')
+XINS = XMLNamespace("http://www.w3.org/2001/XInclude")
+XHTMLNS = XMLNamespace("http://www.w3.org/1999/xhtml")
+NCXNS = XMLNamespace("http://www.daisy.org/z3986/2005/ncx/")
+OPFNS = XMLNamespace("http://www.idpf.org/2007/opf")
+
+WLNS = EmptyNamespace()
+
+
+class DocProvider(object):
+    """ Base class for a repository of XML files.
+        Used for generating joined files, like EPUBs
+    """
+
+    def by_slug(self, slug):
+        raise NotImplemented
+
+    def __getitem__(self, slug):
+        return self.by_slug(slug)
+
+    def by_uri(self, uri):
+        return self.by_slug(uri.rsplit('/', 1)[1])
+
+
+class DirDocProvider(DocProvider):
+    """ Serve docs from a directory of files in form <slug>.xml """
+
+    def __init__(self, dir):
+        self.dir = dir
+        self.files = {}
+
+    def by_slug(self, slug):
+        return open(os.path.join(self.dir, '%s.xml' % slug))
+
+
+import lxml.etree as etree
+import dcparser
+
+DEFAULT_BOOKINFO = dcparser.BookInfo(
+        { RDFNS('about'): u'http://wiki.wolnepodreczniki.pl/Lektury:Template'}, \
+        { DCNS('creator'): [u'Some, Author'],
+          DCNS('title'): [u'Some Title'],
+          DCNS('subject.period'): [u'Unknown'],
+          DCNS('subject.type'): [u'Unknown'],
+          DCNS('subject.genre'): [u'Unknown'],
+          DCNS('date'): ['1970-01-01'],
+          # DCNS('date'): [creation_date],
+          DCNS('publisher'): [u"Fundacja Nowoczesna Polska"],
+          DCNS('description'):
+          [u"""Publikacja zrealizowana w ramach projektu
+             Wolne Lektury (http://wolnelektury.pl). Reprodukcja cyfrowa
+             wykonana przez Bibliotekę Narodową z egzemplarza
+             pochodzącego ze zbiorów BN."""],
+          DCNS('identifier.url'):
+            [u"http://wolnelektury.pl/katalog/lektura/template"],
+          DCNS('rights'):
+            [u"Domena publiczna - zm. [OPIS STANU PRAWNEGO TEKSTU]"] })
+
+def xinclude_forURI(uri):
+    e = etree.Element(XINS("include"))
+    e.set("href", uri)
+    return etree.tostring(e, encoding=unicode)
+
+def wrap_text(ocrtext, creation_date, bookinfo=DEFAULT_BOOKINFO):
+    """Wrap the text within the minimal XML structure with a DC template."""
+    bookinfo.created_at = creation_date
+
+    dcstring = etree.tostring(bookinfo.to_etree(), \
+        method='xml', encoding=unicode, pretty_print=True)
+
+    return u'<utwor>\n' + dcstring + u'\n<plain-text>\n' + ocrtext + \
+        u'\n</plain-text>\n</utwor>';
+
+
+def serialize_raw(element):
+    b = u'' + (element.text or '')
+
+    for child in element.iterchildren():
+        e = etree.tostring(child, method='xml', encoding=unicode, pretty_print=True)
+        b += e
+
+    return b
+
+SERIALIZERS = {
+    'raw': serialize_raw,
+}
+
+def serialize_children(element, format='raw'):
+    return SERIALIZERS[format](element)
+
+def get_resource(path):
+    return os.path.join(os.path.dirname(__file__), path)
+