From 750f341a52cde572ccbc9a408cb5933f017c7c36 Mon Sep 17 00:00:00 2001
From: dece <shgck@pistache.land>
Date: Fri, 11 Jun 2021 15:48:21 +0200
Subject: [PATCH] gopher: add a command to force an item type

---
 plugins/gopher/bebop_gopher/plugin.py | 75 ++++++++++++++++++++++++---
 1 file changed, 69 insertions(+), 6 deletions(-)

diff --git a/plugins/gopher/bebop_gopher/plugin.py b/plugins/gopher/bebop_gopher/plugin.py
index 219099e..6540ebe 100644
--- a/plugins/gopher/bebop_gopher/plugin.py
+++ b/plugins/gopher/bebop_gopher/plugin.py
@@ -8,9 +8,9 @@ from bebop.browser.browser import Browser
 from bebop.command_line import CommandLine
 from bebop.links import Links
 from bebop.metalines import LineType
-from bebop.navigation import parse_url, parse_host_and_port
+from bebop.navigation import parse_url, parse_host_and_port, unparse_url
 from bebop.page import Page
-from bebop.plugins import SchemePlugin
+from bebop.plugins import PluginCommand, SchemePlugin
 
 
 class ItemType(Enum):
@@ -36,10 +36,16 @@ class ItemType(Enum):
     _missing_ = lambda s: ItemType.FILE
 
 
+# Types that are not rendered by this plugin; should be handled by a separate
+# program, but for now we simply do nothing with them.
 UNHANDLED_TYPES = (
     ItemType.CCSO, ItemType.ERROR, ItemType.TELNET, ItemType.REDUNDANT,
     ItemType.TN3270
 )
+# Map item types lowercase names to the actual type, to easily set a type from
+# the command-line.
+USER_FRIENDLY_TYPES = {t.name.lower(): t for t in ItemType}
+# Icons to display for some item types in a Gopher map.
 ICONS = {
     ItemType.FILE: "📄",
     ItemType.DIR: "📂",
@@ -64,8 +70,20 @@ class GopherPlugin(SchemePlugin):
 
     def __init__(self) -> None:
         super().__init__("gopher")
+        self.commands = [
+            PluginCommand(
+                "set-item-type",
+                "display current page as another item type (Gopher only)"
+            )
+        ]
 
     def open_url(self, browser: Browser, url: str) -> Optional[str]:
+        """Request an selector from a Gopher host.
+
+        As Bebop works only with URLs and not really the Gopher host/selector
+        format, we use RFC 4266 (“The gopher URI Scheme”) for consistency with
+        other schemes and to get that sweet item type hint in the URL path.
+        """
         parts = parse_url(url)
         host = parts["netloc"]
         host_and_port = parse_host_and_port(host, 70)
@@ -121,8 +139,43 @@ class GopherPlugin(SchemePlugin):
         browser.current_url = url
         return url
 
+    def use_command(self, browser: Browser, name: str, text: str):
+        if name == "set-item-type":
+            given_type = text[len(name):].strip()
+            valid_types = [
+                t for t in USER_FRIENDLY_TYPES
+                if USER_FRIENDLY_TYPES[t] not in UNHANDLED_TYPES
+            ]
+            if given_type not in valid_types:
+                error = "Valid types: " + ", ".join(valid_types)
+                browser.set_status_error(error)
+                return
+            item_type = USER_FRIENDLY_TYPES[given_type]
+            self.set_item_type(browser, item_type)
 
-def request(host: str, port: int, path: str, timeout: int):
+    def set_item_type(self, browser: Browser, item_type: ItemType):
+        """Re-parse the current page using this item type."""
+        if browser.current_scheme != self.scheme or not browser.current_page:
+            browser.set_status_error("Can only set item types on Gopher URLs.")
+            return
+
+        logging.debug(f"Force parsing current page as {item_type}…")
+        current_source = browser.current_page.source
+        new_page = get_page_from_source(current_source, item_type)
+        browser.load_page(new_page)
+
+        # If possible, set the correct item type in the URL path as well.
+        url = browser.current_url
+        parts = parse_url(browser.current_url)
+        type_path_match = TYPE_PATH_RE.match(parts["path"])
+        if type_path_match:
+            path = type_path_match.group(2)
+            parts["path"] = f"/{item_type.value}{path}"
+            browser.current_url = unparse_url(parts)
+
+
+def request(host: str, port: int, path: str, timeout: int) -> bytes:
+    """Send a Gopher request and return the received bytes."""
     try:
         sock = socket.create_connection((host, port), timeout=timeout)
     except OSError as exc:
@@ -147,12 +200,19 @@ def request(host: str, port: int, path: str, timeout: int):
 
 
 def parse_response(response: bytes, item_type: ItemType, encoding: str ="utf8"):
+    """Parse a Gopher response."""
     decoded = response.decode(encoding=encoding, errors="replace")
-    metalines, links = parse_source(decoded, item_type)
-    return Page(decoded, metalines, links)
+    return get_page_from_source(decoded, item_type)
+
+
+def get_page_from_source(source: str, item_type: ItemType):
+    """Get a Page object from a decoded source text."""
+    metalines, links = parse_source(source, item_type)
+    return Page(source, metalines, links)
 
 
 def parse_source(source: str, item_type: ItemType):
+    """Generate metalines and a Links instance for this source text."""
     metalines = []
     links = Links()
 
@@ -165,7 +225,10 @@ def parse_source(source: str, item_type: ItemType):
     # parse any kind of text data.
     elif item_type == ItemType.DIR:
         current_link_id = 1
-        for line in source.split("\r\n"):
+        # Split lines on \n and discard \r separately because some maps do not
+        # end lines with \r\n all the time.
+        for line in source.split("\n"):
+            line = line.rstrip("\r")
             ltype, tline = line[:1], line[1:]
             if ltype == "." and not tline:
                 break