Render links as footnotes

[paperdoorknob] / glowfic.py

diff --git a/glowfic.py b/glowfic.py
index 901246b10533f390ff565263fc9d5b1465b0af3c..573050872d3d3d3ef6e5647c02dcb4f238e65e21 100644 (file)
--- a/glowfic.py
+++ b/glowfic.py
@@ -5,22 +5,54 @@
 # Free Software Foundation, version 3.
 
 
 # Free Software Foundation, version 3.
 
 

+from abc import ABC, abstractmethod
+from dataclasses import dataclass

 import itertools
 import itertools

+from urllib.parse import parse_qsl, urlencode, urlparse, urlunparse

 
 from typing import Iterable
 
 from bs4 import BeautifulSoup
 from bs4.element import Tag
 
 
 from typing import Iterable
 
 from bs4 import BeautifulSoup
 from bs4.element import Tag
 

+from images import ImageStore
+from texify import Texifier
+
+
+def _removeViewFromURL(url: str) -> str:
+    u = urlparse(url)
+    old_qs = parse_qsl(u.query)
+    new_qs = [(k, v) for k, v in old_qs if k != 'view']
+    return urlunparse(u._replace(query=urlencode(new_qs)))
+
+
+def nonFlatURL(url: str) -> str:
+    return _removeViewFromURL(url)
+
+
+def flatURL(url: str) -> str:
+    u = urlparse(_removeViewFromURL(url))
+    qs = parse_qsl(u.query) + [('view', 'flat')]
+    return urlunparse(u._replace(query=urlencode(qs)))
+
+
+@dataclass(frozen=True)
+class Chunk:
+    icon: str | None
+    character: str | None
+    screen_name: str | None
+    author: str | None
+    content: Tag
+

 # We avoid the name "post" because the Glowfic community uses the term
 # inconsistently:
 #  * The Glowfic software sometimes uses "post" to refer to a whole thread
 # We avoid the name "post" because the Glowfic community uses the term
 # inconsistently:
 #  * The Glowfic software sometimes uses "post" to refer to a whole thread

-#    (eg: in the URL), but more often uses "post" to refer to just the first
-#    chunk in a thread.  The non-first chunks are "replies".
+#    (in the URL), sometimes uses "post" to refer to chunks (in the CSS),
+#    but mostly uses "post" to refer to just the first chunk in a thread
+#    (in the HTML and UI).  The non-first chunks are "replies".

 #  * Readers and this software don't need to distinguish first-chunks and
 #    non-first-chunks.
 #  * Readers and this software don't need to distinguish first-chunks and
 #    non-first-chunks.

-#  * Humans in the community tend to use "posts" to mean "chunks" ("replies"
-#    in the Glowfic software's lexicon).
+#  * Humans in the community tend to use "posts" to mean chunks.

 
 
 def chunkDOMs(html: BeautifulSoup) -> Iterable[Tag]:
 
 
 def chunkDOMs(html: BeautifulSoup) -> Iterable[Tag]:


@@ -37,3 +69,127 @@ def chunkDOMs(html: BeautifulSoup) -> Iterable[Tag]:
         return rs
 
     return itertools.chain([text()], the_replies())
         return rs
 
     return itertools.chain([text()], the_replies())

+
+
+def makeChunk(chunk_dom: Tag, image_store: ImageStore) -> Chunk:
+
+    def getIcon() -> str | None:
+        icon_div = chunk_dom.find_next('div', class_='post-icon')
+        if icon_div is None:
+            return None
+        icon_img = icon_div.find_next('img')
+        if icon_img is None:
+            return None
+        assert isinstance(icon_img, Tag)
+        return image_store.get_image(icon_img.attrs['src'])
+
+    def getTextByClass(css_class: str) -> str | None:
+        div = chunk_dom.find_next('div', class_=css_class)
+        if div is None:
+            return None
+        return div.text.strip()
+
+    content = chunk_dom.find_next('div', class_='post-content')
+    assert isinstance(content, Tag)
+
+    return Chunk(getIcon(),
+                 getTextByClass('post-character'),
+                 getTextByClass('post-screenname'),
+                 getTextByClass('post-author'),
+                 content)
+
+
+def renderIcon(icon_path: str | None, image_size: float) -> str | None:
+    params = f'width={image_size}mm,height={image_size}mm,keepaspectratio'
+    return f'\\includegraphics[{params}]{{{icon_path}}}' if icon_path else None
+
+
+class Layout(ABC):
+
+    @abstractmethod
+    def renderChunk(self, chunk: Chunk) -> bytes:
+        raise NotImplementedError()
+
+
+class ContentOnlyLayout(Layout):
+
+    def __init__(self, texifier: Texifier) -> None:
+        self._texifier = texifier
+
+    def renderChunk(self, chunk: Chunk) -> bytes:
+        return self._texifier.texify(chunk.content) + b'\n'
+
+
+class BelowIconLayout(Layout):
+
+    def __init__(self, texifier: Texifier, image_size: float) -> None:
+        self._texifier = texifier
+        self._image_size = image_size
+
+    def renderChunk(self, chunk: Chunk) -> bytes:
+        meta = [
+            renderIcon(chunk.icon, self._image_size),
+            chunk.character,
+            chunk.screen_name,
+            chunk.author,
+        ]
+
+        return b'''\\wrapstuffclear
+\\begin{wrapstuff}[l]
+\\fbox{
+\\begin{varwidth}{0.5\\textwidth}
+  \\smash{\\parbox[t][0pt]{0pt}{
+    \\setlength{\\fboxrule}{0.2pt}
+    \\setlength{\\fboxsep}{0pt}
+    \\vspace{-3.4pt}
+    \\fbox{\\hspace{107mm}}
+  }\\\\*}
+  \\vspace{-1em}
+\\begin{center}
+%s
+\\end{center}
+\\end{varwidth}
+}
+\\end{wrapstuff}
+
+\\strut
+
+\\noindent %s
+''' % (
+            b'\\\\*'.join(x.encode('UTF-8') for x in meta if x is not None),
+            self._texifier.texify(chunk.content))
+
+
+class BesideIconLayout(Layout):
+
+    def __init__(self, texifier: Texifier, image_size: float) -> None:
+        self._texifier = texifier
+        self._image_size = image_size
+
+    def renderChunk(self, chunk: Chunk) -> bytes:
+        icon = renderIcon(chunk.icon, self._image_size)
+        meta = [
+            chunk.character,
+            chunk.screen_name,
+            chunk.author,
+        ]
+
+        # Why is \textwidth not the width of the text?
+        # Why is the width of the text .765\textwidth?
+        return b'''\\noindent\\fbox{
+%s
+\\parbox[b]{.765\\textwidth}{
+\\begin{center}
+%s
+\\end{center}
+}
+}\\\\*
+\\vspace{-0.75em}\\\\*
+\\noindent %s
+
+\\strut
+
+''' % (
+            icon.encode('UTF-8') if icon else b'',
+            b'\\\\*'.join(x.encode('UTF-8') for x in meta if x is not None),
+            self._texifier.texify(chunk.content))