Some prelim work on builder api.

[librarian.git] / src / librarian / builders / html.py

diff --git a/src/librarian/builders/html.py b/src/librarian/builders/html.py
index ed222d3..66db675 100644 (file)
--- a/src/librarian/builders/html.py
+++ b/src/librarian/builders/html.py
@@ -1,33 +1,75 @@
-# coding: utf-8
-from __future__ import unicode_literals
-
-try:
-    from urllib.request import urlopen
-except ImportError:
-    from urllib2 import urlopen
+# This file is part of Librarian, licensed under GNU Affero GPLv3 or later.
+# Copyright © Fundacja Wolne Lektury. See NOTICE for more information.
+#
+from collections import defaultdict
+import os
+from urllib.request import urlopen

 from lxml import etree
 from lxml import etree

-from librarian.html import add_anchors, add_table_of_contents, add_table_of_themes
+from librarian.html import add_table_of_contents, add_table_of_themes, add_image_sizes

 from librarian import OutputFile
 
 
 from librarian import OutputFile
 
 

-class HtmlBuilder:
+class TreeBuilder:
+    @property
+    def cursor(self):
+        return self.current_cursors[-1]
+
+    def enter_fragment(self, fragment):
+        cursor = self.cursors.get(fragment, self.cursor)
+        self.current_cursors.append(cursor)
+
+    def exit_fragment(self):
+        self.current_cursors.pop()
+
+    def create_fragment(self, name, element):
+        assert name not in self.cursors
+        self.cursors[name] = element
+
+    def forget_fragment(self, name):
+        del self.cursors[name]
+
+    def start_element(self, tag, attrib=None):
+        self.current_cursors.append(etree.SubElement(
+            self.cursor,
+            tag,
+            **(attrib or {})
+        ))
+
+    def end_element(self):
+        self.current_cursors.pop()
+
+    def push_text(self, text):
+        cursor = self.cursor
+        if len(cursor):
+            cursor[-1].tail = (cursor[-1].tail or '') + text
+        else:
+            cursor.text = (cursor.text or '') + text
+
+
+class HtmlBuilder(TreeBuilder):
+    build_method_fn = 'html_build'

     file_extension = "html"
     file_extension = "html"

-    with_anchors = True

     with_themes = True
     with_toc = True
     with_footnotes = True
     with_nota_red = True
     with_themes = True
     with_toc = True
     with_footnotes = True
     with_nota_red = True

+    with_ids = True
+    with_numbering = True

     no_externalities = False
     orphans = True
 
     no_externalities = False
     orphans = True
 

-    def __init__(self, base_url=None):
+    root_tag = 'div'
+    root_attrib = {'id': 'book-text'}
+
+    def __init__(self, gallery_path=None, gallery_url=None, base_url=None):

         self._base_url = base_url
         self._base_url = base_url

+        self.gallery_path = gallery_path
+        self.gallery_url = gallery_url

 
 

-        self.tree = text = etree.Element('div', **{'id': 'book-text'})
-        self.header = etree.SubElement(text, 'h1')
+        self.tree = text = etree.Element(self.root_tag, **self.root_attrib)
+        self.header = etree.Element('h1')

 
         self.footnotes = etree.Element('div', id='footnotes')
 
         self.footnotes = etree.Element('div', id='footnotes')

-        self.footnote_counter = 0

 
         self.nota_red = etree.Element('div', id='nota_red')
 
 
         self.nota_red = etree.Element('div', id='nota_red')
 


@@ -46,36 +88,31 @@ class HtmlBuilder:
         else:
             return 'https://wolnelektury.pl/media/book/pictures/{}/'.format(self.document.meta.url.slug)
 
         else:
             return 'https://wolnelektury.pl/media/book/pictures/{}/'.format(self.document.meta.url.slug)
 

-    @property
-    def cursor(self):
-        return self.current_cursors[-1]
-
-    def enter_fragment(self, fragment):
-        self.current_cursors.append(self.cursors[fragment])
-
-    def exit_fragment(self):
-        self.current_cursors.pop()
-
-    def create_fragment(self, name, element):
-        assert name not in self.cursors
-        self.cursors[name] = element
-
-    def forget_fragment(self, name):
-        del self.cursors[name]
-
-    def preprocess(self, document):
-        document._compat_assign_ordered_ids()
-        document._compat_assign_section_ids()
-
-    def build(self, document, **kwargs):
+    def build(self, document, element=None, **kwargs):

         self.document = document
         self.document = document

+        self.document.assign_ids()
+        self.prepare_images()
+
+        if element is None:
+            element = document.tree.getroot()

 
 

-        self.preprocess(document)
-        document.tree.getroot().html_build(self)
+        element.html_build(self)

         self.postprocess(document)
         return self.output()
 
         self.postprocess(document)
         return self.output()
 

+    def prepare_images(self):
+        # Temporarily use the legacy method, before transitioning to external generators.
+        if self.gallery_path is None:
+            return
+        try:
+            os.makedirs(self.gallery_path)
+        except OSError:
+            pass
+        add_image_sizes(self.document.tree, self.gallery_path, self.gallery_url, self.base_url)
+

     def output(self):
     def output(self):

+        if not len(self.tree):
+            return None

         return OutputFile.from_bytes(
             etree.tostring(
                 self.tree,
         return OutputFile.from_bytes(
             etree.tostring(
                 self.tree,


@@ -86,7 +123,7 @@ class HtmlBuilder:
         )
 
     def postprocess(self, document):
         )
 
     def postprocess(self, document):

-        _ = document.tree.getroot().master.gettext
+        _ = document.tree.getroot().gettext

 
         if document.meta.translators:
             self.enter_fragment('header')
 
         if document.meta.translators:
             self.enter_fragment('header')


@@ -100,8 +137,9 @@ class HtmlBuilder:
             )
             self.exit_fragment()
 
             )
             self.exit_fragment()
 

-        if self.with_anchors:
-            add_anchors(self.tree)
+        if len(self.header):
+            self.tree.insert(0, self.header)
+            

         if self.with_nota_red and len(self.nota_red):
             self.tree.append(self.nota_red)
         if self.with_themes:
         if self.with_nota_red and len(self.nota_red):
             self.tree.append(self.nota_red)
         if self.with_themes:


@@ -109,28 +147,20 @@ class HtmlBuilder:
         if self.with_toc:
             add_table_of_contents(self.tree)
 
         if self.with_toc:
             add_table_of_contents(self.tree)
 

-        if self.footnote_counter:
+        if len(self.footnotes):

             fnheader = etree.Element("h3")
             fnheader.text = _("Footnotes")
             self.footnotes.insert(0, fnheader)
             self.tree.append(self.footnotes)
 
             fnheader = etree.Element("h3")
             fnheader.text = _("Footnotes")
             self.footnotes.insert(0, fnheader)
             self.tree.append(self.footnotes)
 

-    def start_element(self, tag, attrib=None):
-        self.current_cursors.append(etree.SubElement(
-            self.cursor,
-            tag,
-            **(attrib or {})
-        ))
-
-    def end_element(self):
-        self.current_cursors.pop()
-
-    def push_text(self, text):
-        cursor = self.cursor
-        if len(cursor):
-            cursor[-1].tail = (cursor[-1].tail or '') + text
-        else:
-            cursor.text = (cursor.text or '') + text
+    def add_visible_number(self, element):
+        assert '_id' in element.attrib, etree.tostring(element)
+        self.start_element('a', {
+            'href': f'#{element.attrib["_id"]}',
+            'class': 'wl-num',
+        })
+        self.push_text(element.attrib['_visible_numbering'])
+        self.end_element()

 
 
 class StandaloneHtmlBuilder(HtmlBuilder):
 
 
 class StandaloneHtmlBuilder(HtmlBuilder):


@@ -147,7 +177,6 @@ class StandaloneHtmlBuilder(HtmlBuilder):
         head = etree.Element('head')
         tree.insert(0, head)
 
         head = etree.Element('head')
         tree.insert(0, head)
 

-

         etree.SubElement(head, 'meta', charset='utf-8')
         etree.SubElement(head, 'title').text = document.meta.title
 
         etree.SubElement(head, 'meta', charset='utf-8')
         etree.SubElement(head, 'title').text = document.meta.title
 


@@ -183,15 +212,44 @@ class StandaloneHtmlBuilder(HtmlBuilder):
             )
 
 
             )
 
 

+class SnippetHtmlBuilder(HtmlBuilder):
+    with_themes = False
+    with_toc = False
+    with_footnotes = False
+    with_nota_red = False
+    with_ids = False
+    with_numbering = False
+
+
+class AbstraktHtmlBuilder(HtmlBuilder):
+    with_themes = False
+    with_toc = False
+    with_footnotes = False
+    with_nota_red = False
+    with_ids = False
+    with_numbering = False
+
+    root_tag = 'blockquote'
+    root_attrib = {}
+
+    def build(self, document, element=None, **kwargs):
+        if element is None:
+            element = document.tree.find('//abstrakt')
+        if element is None:
+            return OutputFile.from_bytes(b'')
+        element.attrib['_force'] = '1'
+        return super().build(document, element, **kwargs)
+
+            

 class DaisyHtmlBuilder(StandaloneHtmlBuilder):
     file_extension = 'xhtml'
 class DaisyHtmlBuilder(StandaloneHtmlBuilder):
     file_extension = 'xhtml'

-    with_anchors = False

     with_themes = False
     with_toc = False
     with_footnotes = False
     with_nota_red = False
     with_deep_identifiers = False
     no_externalities = True
     with_themes = False
     with_toc = False
     with_footnotes = False
     with_nota_red = False
     with_deep_identifiers = False
     no_externalities = True

+    with_numbering = False

 
     def output(self):
         tree = etree.ElementTree(self.tree)
 
     def output(self):
         tree = etree.ElementTree(self.tree)