From 1b8bafdb56034191261b1978a1c99a4ddf9bed7b Mon Sep 17 00:00:00 2001
From: Nick Sweeting <github@sweeting.me>
Date: Sun, 17 Nov 2024 20:10:33 -0800
Subject: [PATCH] add abx-spec-abx-pkg pkg

---
 archivebox/pkgs/abx-spec-abx-pkg/README.md    |   0
 .../pkgs/abx-spec-abx-pkg/abx_spec_abx_pkg.py | 123 ++++++++++++++++++
 .../pkgs/abx-spec-abx-pkg/pyproject.toml      |  17 +++
 3 files changed, 140 insertions(+)
 create mode 100644 archivebox/pkgs/abx-spec-abx-pkg/README.md
 create mode 100644 archivebox/pkgs/abx-spec-abx-pkg/abx_spec_abx_pkg.py
 create mode 100644 archivebox/pkgs/abx-spec-abx-pkg/pyproject.toml

diff --git a/archivebox/pkgs/abx-spec-abx-pkg/README.md b/archivebox/pkgs/abx-spec-abx-pkg/README.md
new file mode 100644
index 00000000..e69de29b
diff --git a/archivebox/pkgs/abx-spec-abx-pkg/abx_spec_abx_pkg.py b/archivebox/pkgs/abx-spec-abx-pkg/abx_spec_abx_pkg.py
new file mode 100644
index 00000000..b9867db9
--- /dev/null
+++ b/archivebox/pkgs/abx-spec-abx-pkg/abx_spec_abx_pkg.py
@@ -0,0 +1,123 @@
+import os
+
+from typing import Dict, cast
+from pathlib import Path
+
+from abx_pkg import Binary, BinProvider
+
+import abx
+
+from abx_spec_config import ConfigPluginSpec
+
+###########################################################################################
+
+class AbxPkgPluginSpec:
+    __order__ = 10
+
+    @staticmethod
+    @abx.hookspec(firstresult=True)
+    @abx.hookimpl
+    def get_LIB_DIR() -> Path:
+        """Get the directory where shared runtime libraries/dependencies should be installed"""
+        FLAT_CONFIG = pm.hook.get_FLAT_CONFIG()
+        LIB_DIR = Path(FLAT_CONFIG.get('LIB_DIR', '/usr/local/share/abx'))
+        return LIB_DIR
+        
+    @staticmethod
+    @abx.hookspec(firstresult=True)
+    @abx.hookimpl
+    def get_BIN_DIR() -> Path:
+        """Get the directory where binaries should be symlinked to"""
+        FLAT_CONFIG = pm.hook.get_FLAT_CONFIG()
+        LIB_DIR = pm.hook.get_LIB_DIR()
+        BIN_DIR = Path(FLAT_CONFIG.get('BIN_DIR') or LIB_DIR / 'bin')
+        return BIN_DIR
+    
+    @staticmethod
+    @abx.hookspec
+    @abx.hookimpl
+    def get_BINPROVIDERS() -> Dict[str, BinProvider]:
+        return {
+            # to be implemented by plugins, e.g.:
+            # 'npm': NpmBinProvider(npm_prefix=Path('/usr/local/share/abx/npm')),
+        }
+    @staticmethod
+
+    @abx.hookimpl
+    @abx.hookspec
+    def get_BINARIES() -> Dict[str, Binary]:
+        return {
+            # to be implemented by plugins, e.g.:
+            # 'yt-dlp': Binary(name='yt-dlp', binproviders=[npm]),
+        }
+
+    @staticmethod
+    @abx.hookspec(firstresult=True)
+    @abx.hookimpl
+    def get_BINPROVIDER(binprovider_name: str) -> BinProvider:
+        """Get a specific BinProvider by name"""
+        return abx.as_dict(pm.hook.get_BINPROVIDERS())[binprovider_name]
+
+    @staticmethod
+    @abx.hookspec(firstresult=True)
+    @abx.hookimpl
+    def get_BINARY(bin_name: str) -> Binary:
+        """Get a specific Binary by name"""
+        return abx.as_dict(pm.hook.get_BINARIES())[bin_name]
+
+
+    @staticmethod
+    @abx.hookspec(firstresult=True)
+    @abx.hookimpl
+    def binary_load(binary: Binary, **kwargs) -> Binary:
+        """Load a binary from the filesystem (override to load a binary from a different source, e.g. DB, cache, etc.)"""
+        loaded_binary = binary.load(**kwargs)
+        pm.hook.binary_symlink_to_bin_dir(binary=loaded_binary)
+        return loaded_binary
+
+    @staticmethod
+    @abx.hookspec(firstresult=True)
+    @abx.hookimpl
+    def binary_install(binary: Binary, **kwargs) -> Binary:
+        """Override to change how a binary is installed (e.g. by downloading from a remote source, etc.)"""
+        loaded_binary = binary.install(**kwargs)
+        pm.hook.binary_symlink_to_bin_dir(binary=loaded_binary)
+        return loaded_binary
+        
+    @staticmethod
+    @abx.hookspec(firstresult=True)
+    @abx.hookimpl
+    def binary_load_or_install(binary: Binary, **kwargs) -> Binary:
+        """Override to change how a binary is loaded or installed (e.g. by downloading from a remote source, etc.)"""
+        loaded_binary = binary.load_or_install(**kwargs)
+        pm.hook.binary_symlink_to_bin_dir(binary=loaded_binary)
+        return loaded_binary
+
+    @staticmethod
+    @abx.hookspec(firstresult=True)
+    @abx.hookimpl
+    def binary_symlink_to_bin_dir(binary: Binary, bin_dir: Path | None=None):
+        if not (binary.abspath and os.path.isfile(binary.abspath)):
+            return
+                
+        BIN_DIR = pm.hook.get_BIN_DIR()
+        try:
+            BIN_DIR.mkdir(parents=True, exist_ok=True)
+            symlink = BIN_DIR / binary.name
+            symlink.unlink(missing_ok=True)
+            symlink.symlink_to(binary.abspath)
+            symlink.chmod(0o777)   # make sure its executable by everyone
+        except Exception:
+            # print(f'[red]:warning: Failed to symlink {symlink} -> {binary.abspath}[/red] {err}')
+            # not actually needed, we can just run without it
+            pass
+
+
+PLUGIN_SPEC = AbxPkgPluginSpec
+
+
+class RequiredSpecsAvailable(ConfigPluginSpec, AbxPkgPluginSpec):
+    pass
+
+TypedPluginManager = abx.ABXPluginManager[RequiredSpecsAvailable]
+pm = cast(TypedPluginManager, abx.pm)
diff --git a/archivebox/pkgs/abx-spec-abx-pkg/pyproject.toml b/archivebox/pkgs/abx-spec-abx-pkg/pyproject.toml
new file mode 100644
index 00000000..58a08852
--- /dev/null
+++ b/archivebox/pkgs/abx-spec-abx-pkg/pyproject.toml
@@ -0,0 +1,17 @@
+[project]
+name = "abx-spec-abx-pkg"
+version = "0.1.1"
+description = "The ABX plugin specification for Binaries and BinProviders"
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+    "abx>=0.1.0",
+    "abx-pkg>=0.6.0",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project.entry-points.abx]
+abx_spec_abx_pkg = "abx_spec_abx_pkg"