add plugin blacklist

Author: antheas

src/hhd/__main__.py

@@ -30,6 +30,8 @@
     save_profile_yaml,
     save_state_yaml,
     validate_config,
+    load_blacklist_yaml,
+    save_blacklist_yaml,
 )
 from .utils import expanduser, fix_perms, get_context, switch_priviledge
 
@@ -142,6 +144,14 @@ def main():
         except Exception:
             pass
 
+        # Remove old dir
+        try:
+            os.rename(
+                join(hhd_dir, "plugins"), join(hhd_dir, "plugins_old_USE_STATEYML")
+            )
+        except Exception:
+            pass
+
         set_log_plugin("main")
         setup_logger(join(CONFIG_DIR, "log"), ctx=ctx)
 
@@ -152,12 +162,27 @@ def main():
             else:
                 logger.error(f"Command '{args.command[0]}' is unknown. Ignoring...")
 
+        # Use blacklist
+        blacklist_fn = join(hhd_dir, "plugins.yml")
+        blacklist = load_blacklist_yaml(blacklist_fn)
+
+        logger.info(f"Running autodetection...")
+
+        detector_names = []
         for autodetect in pkg_resources.iter_entry_points("hhd.plugins"):
-            detectors[autodetect.name] = autodetect.resolve()
+            name = autodetect.name
+            detector_names.append(name)
+            if name in blacklist:
+                logger.info(f"Skipping blacklisted provider '{name}'.")
+            else:
+                detectors[autodetect.name] = autodetect.resolve()
+
+        # Save new blacklist file
+        save_blacklist_yaml(blacklist_fn, detector_names, blacklist)
+        fix_perms(blacklist_fn, ctx)
 
         logger.info(f"Found plugin providers: {', '.join(list(detectors))}")
 
-        logger.info(f"Running autodetection...")
         for name, autodetect in detectors.items():
             plugins[name] = autodetect([])
 

src/hhd/plugins/settings.py

@@ -487,6 +487,40 @@ def save_state_yaml(fn: str, set: HHDSettings, conf: Config):
     return True
 
 
+def save_blacklist_yaml(fn: str, avail: Sequence[str], blacklist: Sequence[str]):
+    import yaml
+
+    with open(fn, "w") as f:
+        f.write(
+            (
+                ""
+                + "# \n"
+                + "# Plugin blacklist\n"
+                + "# The plugin providers under blacklist will not run.\n"
+                + "# \n"
+                + "# Warning: this file is read only on startup.\n"
+                + "# `sudo systemctl restart hhd@$(whoami)`\n"
+                + "# \n"
+                + "# Available providers:\n"
+                + f"# [{', '.join(avail)}]\n\n"
+            )
+        )
+        yaml.safe_dump({"blacklist": blacklist}, f, width=85, sort_keys=False)
+
+    return True
+
+
+def load_blacklist_yaml(fn: str):
+    import yaml
+
+    try:
+        with open(fn, "r") as f:
+            return yaml.safe_load(f)["blacklist"]
+    except Exception as e:
+        logger.warning(f"Plugin blacklist not found, using default (empty).")
+        return ["myplugin1"]
+
+
 def save_profile_yaml(fn: str, set: HHDSettings, conf: Config | None = None):
     import yaml