download favicons for menus that support icons

wip vendor/rewrite favicon dep

update PKGBUILD

Author: pvsr

contrib/PKGBUILD

@@ -5,11 +5,18 @@ pkgver=1.0.rc2.r1
 pkgrel=1
 pkgdesc="A profile manager for qutebrowser"
 url="https://github.com/pvsr/qbpm"
-license=('GPL')
+license=('GPL-3.0-or-later')
 sha512sums=('SKIP')
 arch=('any')
 depends=('python' 'python-pyxdg' 'python-click')
-makedepends=('git' 'python-build' 'python-installer' 'python-wheel' 'python-setuptools' 'scdoc')
+makedepends=('git'
+             'python-build' 
+             'python-installer' 
+             'python-wheel' 
+             'python-setuptools' 
+             'python-httpx'
+             'python-pillow'
+             'scdoc')
 provides=('qbpm')
 source=("git+https://github.com/pvsr/qbpm")
 

default.nix

@@ -4,15 +4,18 @@
   pythonPackages ? builtins.getAttr (python + "Packages") pkgs,
 }:
 with pythonPackages;
-  buildPythonPackage rec {
+  buildPythonApplication rec {
     pname = "qbpm";
     version = "1.0-rc2";
+    pyproject = true;
     src = ./.;
     doCheck = true;
-    format = "pyproject";
-    nativeBuildInputs = [pkgs.scdoc setuptools];
-    propagatedBuildInputs = [pyxdg click];
-    checkInputs = [pytest];
+
+    build-system = [setuptools];
+    nativeBuildInputs = [pkgs.scdoc];
+    dependencies = [pyxdg click httpx pillow];
+    nativeCheckInputs = [pytestCheckHook];
+
     postInstall = ''
       install -D -m644 completions/qbpm.fish $out/share/fish/vendor_completions.d/qbpm.fish
 
@@ -23,4 +26,11 @@ with pythonPackages;
       mkdir -p $out/share/man/man1
       scdoc < qbpm.1.scd > $out/share/man/man1/qbpm.1
     '';
+
+    meta = {
+      homepage = "https://github.com/pvsr/qbpm";
+      changelog = "https://github.com/pvsr/qbpm/blob/main/CHANGELOG.md";
+      description = "A profile manager for qutebrowser";
+      license = lib.licenses.gpl3Plus;
+    };
   }

flake.nix

@@ -39,12 +39,15 @@
           packages = with pkgs;
             [
               ruff
+              scdoc
+              xdg-utils
               (python3.withPackages (ps:
                 with ps; [
                   pytest
                   mypy
                   pylsp-mypy
                   ruff-lsp
+                  types-pillow
                 ]))
             ]
             ++ self.packages.x86_64-linux.default.propagatedBuildInputs;

pyproject.toml

@@ -18,10 +18,12 @@ classifiers = [
     "Typing :: Typed",
 ]
 requires-python = ">= 3.9"
-dependencies = ["pyxdg", "click"]
+dependencies = ["pyxdg", "click", "httpx", "pillow"]
 
 [project.urls]
+homepage = "https://github.com/pvsr/qbpm"
 repository = "https://github.com/pvsr/qbpm"
+changelog = "https://github.com/pvsr/qbpm/blob/main/CHANGELOG.md"
 
 [project.scripts]
 qbpm = "qbpm.main:main"
@@ -42,7 +44,7 @@ warn_return_any = true
 warn_unused_ignores = true
 
 [[tool.mypy.overrides]]
-module = "xdg.*"
+module = ["xdg.*"]
 ignore_missing_imports = true
 
 [[tool.mypy.overrides]]

qbpm.1.scd

@@ -81,6 +81,18 @@ $HOME/.local/share), but this can be set to another directory by passing
 		qbpm launch -n qb-dev --debug --json-logging
 		```
 
+*icon* [options] <profile> <icon>
+	Install an icon to _profile_. _icon_ may be a url, a path to an image file,
+	or, if --by-name is passed, the name of an xdg icon installed on your
+	system. If _icon_ is a url, qbpm will fetch the page and attempt to find a
+	suitable favicon.
+
+	Options:
+
+	*-n, --by-name*
+		Interpret _icon_ as the name of an xdg icon file according to the
+		freedesktop.org icon specification. Likely to only work on Linux.
+
 *choose* [options]
 	Open a menu to choose a qutebrowser profile to launch. On linux this defaults
 	to dmenu or another compatible menu program such as rofi, and on macOS this
@@ -120,4 +132,14 @@ $HOME/.local/share), but this can be set to another directory by passing
 
 Peter Rice
 
-Contribute at https://github.com/pvsr/qbpm
+# CONTRIBUTE
+
+_https://github.com/pvsr/qbpm_
+
+_https://codeberg.org/pvsr/qbpm_
+
+# LICENSE
+
+src/qbpm/favicon.py: MIT
+
+all other code and qbpm as a whole: GPLv3+

qbpm/config.py

@@ -0,0 +1,3 @@
+# TODO real config file
+default_icon = "qutebrowser"
+application_name_suffix = " (qutebrowser profile)"

qbpm/favicon.py

@@ -0,0 +1,118 @@
+"""
+SPDX-License-Identifier: MIT
+derived from favicon.py by Scott Werner
+https://github.com/scottwernervt/favicon/tree/123e431f53b2c4903b540246a85db0b1633d4786
+"""
+
+import re
+from collections import defaultdict, namedtuple
+from html.parser import HTMLParser
+from pathlib import Path
+from typing import Any
+
+import httpx
+
+LINK_RELS = [
+    "icon",
+    "shortcut icon",
+]
+
+SIZE_RE = re.compile(r"(?P<width>\d{2,4})x(?P<height>\d{2,4})", flags=re.IGNORECASE)
+
+Icon = namedtuple("Icon", ["url", "width", "height", "format", "src"])
+
+
+def get(client: httpx.Client) -> list[Icon]:
+    response = client.get("")
+    response.raise_for_status()
+    client.base_url = response.url
+
+    icons = {icon.url: icon for icon in tags(response.text)}
+
+    fallback_icon = fallback(client)
+    if fallback_icon and fallback_icon.src not in icons:
+        icons[fallback_icon.url] = fallback_icon
+
+    # print(f"{icons=}")
+    return list(icons.values())
+    # return sorted(icons, key=lambda i: i.width + i.height, reverse=True)
+
+
+def fallback(client: httpx.Client) -> Icon | None:
+    response = client.head("favicon.ico")
+    if response.status_code == 200 and response.headers["Content-Type"].startswith(
+        "image"
+    ):
+        return Icon(response.url, 0, 0, ".ico", "default")
+    return None
+
+
+class LinkRelParser(HTMLParser):
+    def __init__(self) -> None:
+        super().__init__()
+        self.icons: dict[str, set[str]] = defaultdict(set)
+
+    def handle_starttag(self, tag: str, attrs: list[tuple[str, str | None]]) -> None:
+        if tag == "link":
+            data = dict(attrs)
+            rel = data.get("rel")
+            if rel in LINK_RELS and (href := data.get("href") or data.get("content")):
+                # TODO replace with data
+                self.icons[rel].add(href)
+
+
+def tags(html: str) -> set[Icon]:
+    parser = LinkRelParser()
+    parser.feed(html[0 : html.find("</head>")])
+    hrefs = {link.strip() for links in parser.icons.values() for link in links}
+
+    icons = set()
+    for href in hrefs:
+        if not href or href.startswith("data:image/"):
+            continue
+
+        # url_parsed = urlparse(url)
+        # repair '//cdn.network.com/favicon.png' or `icon.png?v2`
+        href_parsed = httpx.URL(href)
+
+        width, height = (0, 0)  # dimensions(tag)
+        ext = Path(href_parsed.path).suffix
+
+        icon = Icon(
+            href_parsed,
+            width,
+            height,
+            ext.lower(),
+            "TODO",
+        )
+        icons.add(icon)
+
+    return icons
+
+
+def dimensions(tag: Any) -> tuple[int, int]:
+    """Get icon dimensions from size attribute or icon filename.
+
+    :param tag: Link or meta tag.
+    :type tag: :class:`bs4.element.Tag`
+
+    :return: If found, width and height, else (0,0).
+    :rtype: tuple(int, int)
+    """
+    sizes = tag.get("sizes", "")
+    if sizes and sizes != "any":
+        size = sizes.split(" ")  # '16x16 32x32 64x64'
+        size.sort(reverse=True)
+        width, height = re.split(r"[x\xd7]", size[0])
+    else:
+        filename = tag.get("href") or tag.get("content")
+        size = SIZE_RE.search(filename)
+        if size:
+            width, height = size.group("width"), size.group("height")
+        else:
+            width, height = "0", "0"
+
+    # repair bad html attribute values: sizes='192x192+'
+    width = "".join(c for c in width if c.isdigit())
+    height = "".join(c for c in height if c.isdigit())
+    return int(width), int(height)