Files

908 lines
31 KiB
Python
Raw Permalink Normal View History

2025-12-11 19:04:02 -08:00
from __future__ import annotations
import re
2026-01-19 03:14:30 -08:00
from abc import ABC
2025-12-11 19:04:02 -08:00
from dataclasses import dataclass, field
from pathlib import Path
2026-01-07 05:09:59 -08:00
from typing import Any, Dict, List, Optional, Sequence, Tuple, Callable
2025-12-11 19:04:02 -08:00
@dataclass
class SearchResult:
"""Unified search result format across all search plugins."""
2025-12-11 19:04:02 -08:00
table: str # Plugin name: "libgen", "soulseek", "bandcamp", "youtube", etc.
2025-12-11 19:04:02 -08:00
title: str # Display title/filename
path: str # Download target (URL, path, magnet, identifier)
detail: str = "" # Additional description
annotations: List[str] = field(
default_factory=list
) # Tags: ["120MB", "flac", "ready"]
2025-12-11 19:04:02 -08:00
media_kind: str = "other" # Type: "book", "audio", "video", "game", "magnet"
size_bytes: Optional[int] = None
2025-12-11 23:21:45 -08:00
tag: set[str] = field(default_factory=set) # Searchable tag values
2025-12-11 19:04:02 -08:00
columns: List[Tuple[str, str]] = field(default_factory=list) # Display columns
2026-01-19 06:24:09 -08:00
selection_action: Optional[List[str]] = None
2026-01-11 04:54:27 -08:00
selection_args: Optional[List[str]] = None
2025-12-11 19:04:02 -08:00
full_metadata: Dict[str, Any] = field(default_factory=dict) # Extra metadata
def to_dict(self) -> Dict[str, Any]:
"""Convert to dictionary for pipeline processing."""
2026-04-30 18:56:22 -07:00
full_metadata = self.full_metadata if isinstance(self.full_metadata, dict) else {}
2026-01-05 07:51:19 -08:00
out = {
2025-12-11 19:04:02 -08:00
"table": self.table,
"title": self.title,
"path": self.path,
"detail": self.detail,
"annotations": self.annotations,
"media_kind": self.media_kind,
"size_bytes": self.size_bytes,
2025-12-11 23:21:45 -08:00
"tag": list(self.tag),
2025-12-11 19:04:02 -08:00
"columns": list(self.columns),
2026-04-30 18:56:22 -07:00
"full_metadata": full_metadata,
2025-12-11 19:04:02 -08:00
}
2026-04-30 18:56:22 -07:00
for key in (
"url",
"hash",
"hash_hex",
"store",
"name",
"mime",
"file_id",
"ext",
"size",
):
value = None
try:
value = getattr(self, key, None)
except Exception:
value = None
if value is None and key in full_metadata:
value = full_metadata.get(key)
if value is not None:
out[key] = value
2026-01-05 07:51:19 -08:00
try:
selection_args = getattr(self, "selection_args", None)
except Exception:
selection_args = None
if selection_args is None:
try:
fm = getattr(self, "full_metadata", None)
if isinstance(fm, dict):
selection_args = fm.get("_selection_args") or fm.get("selection_args")
except Exception:
selection_args = None
if selection_args:
out["_selection_args"] = selection_args
2026-01-07 05:09:59 -08:00
try:
selection_action = getattr(self, "selection_action", None)
except Exception:
selection_action = None
if selection_action is None:
try:
fm = getattr(self, "full_metadata", None)
if isinstance(fm, dict):
selection_action = fm.get("_selection_action") or fm.get("selection_action")
except Exception:
selection_action = None
if selection_action:
normalized = [str(x) for x in selection_action if x is not None]
if normalized:
out["_selection_action"] = normalized
2026-01-05 07:51:19 -08:00
return out
2025-12-11 19:04:02 -08:00
def parse_inline_query_arguments(raw_query: str) -> Tuple[str, Dict[str, str]]:
"""Extract inline key:value arguments from a plugin search query."""
query_text = str(raw_query or "").strip()
if not query_text:
return "", {}
tokens = re.split(r"[,\s]+", query_text)
leftover: List[str] = []
parsed_args: Dict[str, str] = {}
for token in tokens:
if not token:
continue
sep_index = token.find(":")
if sep_index < 0:
sep_index = token.find("=")
if sep_index > 0:
key = token[:sep_index].strip().lower()
value = token[sep_index + 1 :].strip()
if key and value:
parsed_args[key] = value
continue
leftover.append(token)
return " ".join(leftover).strip(), parsed_args
2025-12-19 02:29:42 -08:00
class Provider(ABC):
"""Unified plugin base class.
2025-12-19 02:29:42 -08:00
This replaces the older split between search and upload plugins.
Concrete plugins may implement any subset of:
2025-12-19 02:29:42 -08:00
- search(query, ...)
- download(result, output_dir)
- upload(file_path, ...)
- login(...)
- validate()
"""
2025-12-11 19:04:02 -08:00
2026-01-01 20:37:27 -08:00
URL: Sequence[str] = ()
PLUGIN_NAME: str = ""
PLUGIN_ALIASES: Sequence[str] = ()
2026-01-01 20:37:27 -08:00
# Optional plugin-driven defaults for what to do when a user selects @N from a
# plugin table. The CLI uses this to auto-insert stages (e.g. download-file)
2026-01-03 03:37:48 -08:00
# without hardcoding table names.
#
# Example:
# TABLE_AUTO_STAGES = {"youtube": ["download-file"]}
2026-01-11 14:46:41 -08:00
# TABLE_AUTO_PREFIXES = {"tidal": ["download-file"]} # matches tidal.*
2026-01-03 03:37:48 -08:00
TABLE_AUTO_STAGES: Dict[str, Sequence[str]] = {}
TABLE_AUTO_PREFIXES: Dict[str, Sequence[str]] = {}
AUTO_STAGE_USE_SELECTION_ARGS: bool = False
# Optional plugin-declared configuration keys.
2026-01-03 03:37:48 -08:00
# Used for dynamically generating config panels (e.g., missing credentials).
REQUIRED_CONFIG_KEYS: Sequence[str] = ()
# Some plugins implement `upload()` but are not intended to be used as
# generic "file host" plugins via `add-file -plugin ...`.
2026-02-11 18:16:07 -08:00
EXPOSE_AS_FILE_PROVIDER: bool = True
2026-05-03 21:20:05 -07:00
# Set to True for plugins that support multiple named instances in config.
# When True, config is expected at config["plugin"][<PLUGIN_NAME>][<instance_name>]
# rather than config["plugin"][<PLUGIN_NAME>] directly.
# Examples: hydrusnetwork (home/work), matrix (personal/work), ftp.
MULTI_INSTANCE: bool = False
# Declare which top-level cmdlet names this plugin handles.
# Cmdlet dispatch and capability discovery use this to route operations.
2026-05-24 12:32:57 -07:00
# Example: frozenset({"add-file", "download-file", "get-tag", "search-file"})
2026-05-03 21:20:05 -07:00
SUPPORTED_CMDLETS: frozenset = frozenset()
2025-12-11 19:04:02 -08:00
def __init__(self, config: Optional[Dict[str, Any]] = None):
self.config = config or {}
2026-01-12 12:17:50 -08:00
self.name = str(
getattr(self, "PLUGIN_NAME", None)
2026-01-12 12:17:50 -08:00
or self.__class__.__name__
).lower()
2025-12-11 19:04:02 -08:00
2026-02-01 19:01:47 -08:00
@property
def label(self) -> str:
"""Friendly display name for the plugin."""
name = str(getattr(self, "PLUGIN_NAME", None) or self.__class__.__name__)
if name:
2026-02-01 19:01:47 -08:00
if name.lower() == "loc":
return "LoC"
if name.lower() == "openlibrary":
return "OpenLibrary"
if name.lower() == "internetarchive":
return "Internet Archive"
if name.lower() == "alldebrid":
return "AllDebrid"
return name[:1].upper() + name[1:]
return self.__class__.__name__
2026-01-31 23:41:47 -08:00
@property
def preserve_order(self) -> bool:
"""True if search result order is significant and should be preserved in displays."""
return False
def get_table_type(self, query: str, filters: Optional[Dict[str, Any]] = None) -> str:
"""Return the table type identifier for results from this plugin."""
2026-01-31 23:41:47 -08:00
return self.name
def get_table_title(self, query: str, filters: Optional[Dict[str, Any]] = None) -> str:
"""Return a descriptive title for the results table."""
q = str(query or "").strip() or "*"
return f"{self.label}: {q}"
def get_table_metadata(self, query: str, filters: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
"""Return metadata for the results table."""
return {"plugin": self.name}
2026-01-31 23:41:47 -08:00
def get_source_command(self, args_list: List[str]) -> Tuple[str, List[str]]:
"""Return the command and arguments that produced this search result.
Used for @N expansion to re-run the search if needed.
"""
return "search-file", list(args_list)
2026-04-30 18:56:22 -07:00
def resolve_pipe_item_context(
self,
item: Any,
*,
metadata: Optional[Dict[str, Any]] = None,
store: Optional[str] = None,
file_hash: Optional[str] = None,
targets: Optional[Sequence[str]] = None,
) -> Optional[Tuple[Optional[str], Optional[str]]]:
"""Optionally normalize store/hash context for pipe playback helpers."""
_ = item, metadata, store, file_hash, targets
return None
def infer_playlist_store(
self,
item: Any,
*,
target: str,
file_storage: Any = None,
) -> Optional[str]:
"""Optionally infer a friendly store label for an MPV playlist entry."""
_ = item, target, file_storage
return None
2026-01-31 23:41:47 -08:00
@property
def prefers_transfer_progress(self) -> bool:
"""True if this plugin prefers explicit transfer progress tracking (begin/finish) during download."""
2026-01-31 23:41:47 -08:00
return False
2026-01-11 03:24:49 -08:00
@classmethod
2026-01-19 06:24:09 -08:00
def config_schema(cls) -> List[Dict[str, Any]]:
"""Return configuration schema for this plugin.
2026-01-11 03:24:49 -08:00
Returns a list of dicts, each defining a field:
{
"key": "api_key",
"label": "API Key",
2026-04-21 14:18:52 -07:00
"group": "Authentication",
"type": "text", # text|boolean|integer|float|path|secret|multiline
2026-01-11 03:24:49 -08:00
"default": "",
"required": True,
2026-01-11 03:47:25 -08:00
"secret": True,
2026-04-21 14:18:52 -07:00
"choices": ["Option 1", "Option 2"],
"placeholder": "Paste value here"
2026-01-11 03:24:49 -08:00
}
"""
return []
2026-01-03 03:37:48 -08:00
@classmethod
def required_config_keys(cls) -> List[str]:
keys = getattr(cls, "REQUIRED_CONFIG_KEYS", None)
if not keys:
return []
out: List[str] = []
try:
for k in list(keys):
s = str(k or "").strip()
if s:
out.append(s)
except Exception:
return []
return out
@classmethod
def plugin_config_key(cls) -> str:
return str(getattr(cls, "PLUGIN_NAME", None) or cls.__name__ or "").strip().lower()
@classmethod
def plugin_instance_filter_keys(cls) -> Tuple[str, ...]:
return ("instance", "store")
@classmethod
def plugin_config_field_keys(cls) -> set[str]:
keys: set[str] = set()
try:
for field in cls.config_schema() or []:
if not isinstance(field, dict):
continue
key = str(field.get("key") or "").strip().lower()
if key:
keys.add(key)
except Exception:
return set()
return keys
def requested_instance_name(
self,
filters: Optional[Dict[str, Any]] = None,
**kwargs: Any,
) -> Optional[str]:
for key in self.plugin_instance_filter_keys():
value = kwargs.get(key)
if value in (None, "") and isinstance(filters, dict):
value = filters.get(key)
text = str(value or "").strip()
if text:
return text
return None
def plugin_config_root(self) -> Dict[str, Any]:
if not isinstance(self.config, dict):
return {}
2026-05-26 15:32:01 -07:00
section_cfg = self.config.get("plugin")
if isinstance(section_cfg, dict):
entry = section_cfg.get(self.plugin_config_key())
if isinstance(entry, dict):
return dict(entry)
2026-05-03 21:20:05 -07:00
return {}
def plugin_instance_configs(self) -> Dict[str, Dict[str, Any]]:
entry = self.plugin_config_root()
if not entry:
return {}
schema_keys = self.plugin_config_field_keys()
entry_keys = {str(key or "").strip().lower() for key in entry.keys()}
looks_like_single = bool(schema_keys and entry_keys.intersection(schema_keys))
if not looks_like_single and entry:
looks_like_single = not all(isinstance(value, dict) for value in entry.values())
if looks_like_single:
return {"default": dict(entry)}
instances: Dict[str, Dict[str, Any]] = {}
for raw_name, raw_value in entry.items():
if not isinstance(raw_value, dict):
continue
name = str(raw_name or "").strip()
if not name:
continue
instances[name] = dict(raw_value)
return instances
def configured_instances(self) -> List[str]:
instances = self.plugin_instance_configs()
if not instances:
return []
if set(instances.keys()) == {"default"}:
return []
return list(instances.keys())
def resolve_plugin_instance(
self,
instance_name: Optional[str] = None,
*,
require_explicit: bool = False,
) -> Tuple[Optional[str], Dict[str, Any]]:
instances = self.plugin_instance_configs()
if not instances:
return None, {}
requested = str(instance_name or "").strip()
if not requested:
first_name = next(iter(instances.keys()))
resolved = dict(instances[first_name])
if first_name != "default":
resolved.setdefault("_instance_name", first_name)
return (None if first_name == "default" else first_name), resolved
requested_lower = requested.lower()
for name, cfg in instances.items():
aliases = {str(name).strip().lower()}
explicit_name = str(cfg.get("_instance_name") or cfg.get("instance") or cfg.get("name") or "").strip().lower()
if explicit_name:
aliases.add(explicit_name)
if requested_lower in aliases:
resolved = dict(cfg)
if name != "default":
resolved.setdefault("_instance_name", name)
return (None if name == "default" else name), resolved
if require_explicit:
return None, {}
first_name = next(iter(instances.keys()))
resolved = dict(instances[first_name])
if first_name != "default":
resolved.setdefault("_instance_name", first_name)
return (None if first_name == "default" else first_name), resolved
def extract_query_arguments(self, query: str) -> Tuple[str, Dict[str, Any]]:
"""Allow plugins to normalize query text and parse inline arguments."""
normalized = str(query or "").strip()
return normalized, {}
2026-02-11 18:16:07 -08:00
def postprocess_search_results(
self,
*,
query: str,
results: List[SearchResult],
filters: Optional[Dict[str, Any]] = None,
limit: int = 50,
table_type: str = "",
table_meta: Optional[Dict[str, Any]] = None,
) -> Tuple[List[SearchResult], Optional[str], Optional[Dict[str, Any]]]:
"""Optional hook for plugin-specific result transforms.
2026-02-11 18:16:07 -08:00
Cmdlets should avoid hardcoding plugin quirks. Plugins can override
2026-02-11 18:16:07 -08:00
this to:
- expand/replace result sets (e.g., artist -> albums)
- override the table type
- override table metadata
Returns:
(results, table_type_override, table_meta_override)
"""
_ = query
_ = filters
_ = limit
_ = table_type
_ = table_meta
return results, None, None
2025-12-19 02:29:42 -08:00
# Standard lifecycle/auth hook.
def login(self, **_kwargs: Any) -> bool:
return True
2025-12-11 19:04:02 -08:00
def search(
self,
query: str,
limit: int = 50,
filters: Optional[Dict[str,
Any]] = None,
2025-12-11 19:04:02 -08:00
**kwargs: Any,
) -> List[SearchResult]:
"""Search for items matching the query."""
raise NotImplementedError(f"Plugin '{self.name}' does not support search")
2025-12-11 19:04:02 -08:00
def download(self, result: SearchResult, output_dir: Path) -> Optional[Path]:
"""Download an item from a search result."""
return None
2026-01-07 05:09:59 -08:00
def download_items(
self,
result: SearchResult,
output_dir: Path,
*,
emit: Callable[[Path, str, str, Dict[str, Any]], None],
progress: Any,
quiet_mode: bool,
path_from_result: Callable[[Any], Path],
config: Optional[Dict[str, Any]] = None,
) -> int:
"""Optional multi-item download hook (default no-op)."""
_ = result
_ = output_dir
_ = emit
_ = progress
_ = quiet_mode
_ = path_from_result
_ = config
return 0
def resolve_pipe_result_download(
self,
result: Any,
pipe_obj: Any,
) -> Tuple[Optional[Path], Optional[str], Optional[Path]]:
"""Materialize a piped plugin result into a local file for add-file."""
_ = result
_ = pipe_obj
return None, None, None
def expand_selection(
self,
selected_items: List[Any],
*,
ctx: Any,
stage_is_last: bool = True,
table_type: str = "",
**_kwargs: Any,
) -> Optional[List[Any]]:
"""Optionally expand a selection into downstream items for non-terminal pipelines."""
_ = selected_items
_ = ctx
_ = stage_is_last
_ = table_type
return None
def status_summary(self) -> Dict[str, Any]:
"""Return plugin-owned status details for startup/status views."""
enabled = False
try:
enabled = bool(self.validate())
except Exception:
enabled = False
return {
"status": "ENABLED" if enabled else "DISABLED",
"name": self.label,
"plugin": self.name,
"detail": "Configured" if enabled else "Not configured",
}
2026-01-19 06:24:09 -08:00
def handle_url(self, url: str, *, output_dir: Optional[Path] = None) -> Tuple[bool, Optional[Path | Dict[str, Any]]]:
"""Optional plugin override to parse and act on URLs."""
2026-01-07 05:09:59 -08:00
_ = url
_ = output_dir
return False, None
def download_url(self, url: str, output_dir: Path, **_kwargs: Any) -> Optional[Any]:
"""Optional direct-URL download hook used by generic cmdlets."""
_ = url
_ = output_dir
return None
def resolve_url(self, url: str, **_kwargs: Any) -> str:
"""Optionally normalize or exchange a URL before downstream use."""
return str(url or "")
def resolve_playback_path(self, item: Any, **_kwargs: Any) -> Optional[str]:
"""Optionally turn a plugin-owned item into a playable local path or URL."""
_ = item
return None
def list_url_formats(self, url: str, **_kwargs: Any) -> Optional[List[Dict[str, Any]]]:
"""Optionally return picker-friendly format metadata for a URL."""
_ = url
return None
def filter_picker_formats(
self,
formats: List[Dict[str, Any]],
**_kwargs: Any,
) -> List[Dict[str, Any]]:
"""Optionally filter or reorder raw format rows before UI display."""
return list(formats or [])
def enrich_playlist_entries(
self,
entries: List[Dict[str, Any]],
**_kwargs: Any,
) -> Optional[List[Dict[str, Any]]]:
"""Optionally expand lightweight playlist entries with richer metadata."""
_ = entries
return None
def maybe_show_picker(
self,
*,
url: str,
item: Optional[Any] = None,
parsed: Optional[Dict[str, Any]] = None,
config: Optional[Dict[str, Any]] = None,
quiet_mode: bool = False,
) -> Optional[int]:
"""Optional hook for plugins that want to render an interactive picker/table."""
_ = url
_ = item
_ = parsed
_ = config
_ = quiet_mode
return None
def config_helper_text(self) -> str:
"""Optional helper text shown in the config editor."""
return ""
def config_actions(self) -> List[Dict[str, Any]]:
"""Optional actions exposed in the config editor for this plugin."""
return []
def run_config_action(self, action_id: str, **_kwargs: Any) -> Dict[str, Any]:
"""Execute a plugin-owned config action from the config editor."""
return {
"ok": False,
"message": f"Plugin '{self.name}' does not support config action '{action_id}'.",
}
2025-12-19 02:29:42 -08:00
def upload(self, file_path: str, **kwargs: Any) -> str:
"""Upload a file and return a URL or identifier."""
raise NotImplementedError(f"Plugin '{self.name}' does not support upload")
2025-12-19 02:29:42 -08:00
2026-05-03 21:20:05 -07:00
# -----------------------------------------------------------------------
2026-05-23 13:49:47 -07:00
# Storage interface — mirrors PluginCore.backend_base.BackendBase.
2026-05-03 21:20:05 -07:00
# Plugins that act as file repositories override these methods.
# All raise NotImplementedError by default; override selectively.
# -----------------------------------------------------------------------
@property
def is_remote(self) -> bool:
"""True if this plugin stores files on a remote service."""
return False
@property
def prefer_defer_tags(self) -> bool:
"""True if tag writes should be deferred until after file ingest."""
return False
2026-05-04 18:41:01 -07:00
@property
def supports_url_association(self) -> bool:
"""True when this provider supports associating URLs to files."""
return False
@property
def supports_note_association(self) -> bool:
"""True when this provider supports per-file named notes."""
return False
@property
def supports_relationship_association(self) -> bool:
"""True when this provider supports file relationship links (king/alt/related)."""
return False
2026-05-03 21:20:05 -07:00
def add_file(self, file_path: Path, **kwargs: Any) -> str:
"""Ingest a file and return its canonical hash."""
raise NotImplementedError(f"Plugin '{self.name}' does not support add_file")
def get_file(self, file_hash: str, **kwargs: Any) -> Optional[Path]:
"""Retrieve a stored file by hash, returning a local Path or None."""
raise NotImplementedError(f"Plugin '{self.name}' does not support get_file")
def get_metadata(self, file_hash: str, **kwargs: Any) -> Optional[Dict[str, Any]]:
"""Return metadata dict for a stored file."""
raise NotImplementedError(f"Plugin '{self.name}' does not support get_metadata")
def get_tag(self, file_identifier: str, **kwargs: Any) -> Tuple[List[str], str]:
"""Return (tags, hash) for a stored file identifier."""
raise NotImplementedError(f"Plugin '{self.name}' does not support get_tag")
def add_tag(self, file_identifier: str, tags: List[str], **kwargs: Any) -> bool:
"""Add tags to a stored file. Returns True on success."""
raise NotImplementedError(f"Plugin '{self.name}' does not support add_tag")
def delete_tag(self, file_identifier: str, tags: List[str], **kwargs: Any) -> bool:
"""Remove tags from a stored file. Returns True on success."""
raise NotImplementedError(f"Plugin '{self.name}' does not support delete_tag")
def get_url(self, file_identifier: str, **kwargs: Any) -> List[str]:
"""Return associated URLs for a stored file."""
raise NotImplementedError(f"Plugin '{self.name}' does not support get_url")
def add_url(self, file_identifier: str, urls: List[str], **kwargs: Any) -> bool:
"""Associate URLs with a stored file. Returns True on success."""
raise NotImplementedError(f"Plugin '{self.name}' does not support add_url")
def delete_url(self, file_identifier: str, urls: List[str], **kwargs: Any) -> bool:
"""Remove URL associations from a stored file. Returns True on success."""
raise NotImplementedError(f"Plugin '{self.name}' does not support delete_url")
def get_note(self, file_identifier: str, **kwargs: Any) -> Dict[str, str]:
"""Return notes dict (name -> text) for a stored file."""
raise NotImplementedError(f"Plugin '{self.name}' does not support get_note")
def set_note(self, file_identifier: str, name: str, text: str, **kwargs: Any) -> bool:
"""Write a named note on a stored file. Returns True on success."""
raise NotImplementedError(f"Plugin '{self.name}' does not support set_note")
def delete_note(self, file_identifier: str, name: str, **kwargs: Any) -> bool:
"""Delete a named note from a stored file. Returns True on success."""
raise NotImplementedError(f"Plugin '{self.name}' does not support delete_note")
2025-12-11 19:04:02 -08:00
def validate(self) -> bool:
"""Check if the plugin is available and properly configured."""
2025-12-11 19:04:02 -08:00
return True
2025-12-29 17:05:03 -08:00
def selector(
self,
selected_items: List[Any],
*,
ctx: Any,
stage_is_last: bool = True,
**_kwargs: Any
2025-12-29 17:05:03 -08:00
) -> bool:
2025-12-19 02:29:42 -08:00
"""Optional hook for handling `@N` selection semantics.
2025-12-11 19:04:02 -08:00
The CLI can delegate selection behavior to a plugin/store instead of
2025-12-19 02:29:42 -08:00
applying the default selection filtering.
2025-12-11 19:04:02 -08:00
2025-12-19 02:29:42 -08:00
Return True if the selection was handled and default behavior should be skipped.
"""
2025-12-11 19:04:02 -08:00
2025-12-19 02:29:42 -08:00
_ = selected_items
_ = ctx
_ = stage_is_last
return False
2025-12-11 19:04:02 -08:00
def show_selection_details(
self,
selected_items: List[Any],
*,
ctx: Any,
stage_is_last: bool = True,
source_command: str = "",
table_type: str = "",
table_metadata: Optional[Dict[str, Any]] = None,
**_kwargs: Any,
) -> bool:
"""Optionally render a terminal detail view for a selected plugin row."""
_selected_item, payload, _metadata = self.resolve_selection_detail_subject(
selected_items,
stage_is_last=stage_is_last,
source_command=source_command,
)
_ = table_type
_ = table_metadata
if not isinstance(payload, dict):
return False
detail_title = self.label
item_title = str(payload.get("title") or "").strip()
if item_title:
detail_title = f"{self.label}: {item_title}"
try:
from SYS.rich_display import render_item_details_panel
render_item_details_panel(payload, title=detail_title)
except Exception:
return False
try:
if hasattr(ctx, "set_last_result_items_only"):
ctx.set_last_result_items_only([payload])
except Exception:
pass
return True
def resolve_selection_detail_subject(
self,
selected_items: List[Any],
*,
stage_is_last: bool = True,
source_command: str = "",
require_media_kind: Optional[str] = None,
) -> Tuple[Optional[Any], Optional[Dict[str, Any]], Optional[Dict[str, Any]]]:
"""Normalize a terminal `@N` selection into `(item, payload, metadata)`.
Custom plugin detail hooks can use this to share the common preconditions
for item panels instead of re-checking terminal/single-row/search-file
state in each plugin.
"""
if not stage_is_last or len(selected_items or []) != 1:
return None, None, None
normalized_source = str(source_command or "").replace("_", "-").strip().lower()
if normalized_source != "search-file":
return None, None, None
item: Any = selected_items[0]
payload: Optional[Dict[str, Any]]
if isinstance(item, dict):
payload = item
else:
payload = None
to_dict = getattr(item, "to_dict", None)
if callable(to_dict):
try:
maybe = to_dict()
except Exception:
maybe = None
if isinstance(maybe, dict):
payload = maybe
if not isinstance(payload, dict):
return item, None, None
meta: Dict[str, Any] = {}
nested = payload.get("full_metadata") or payload.get("metadata")
if isinstance(nested, dict):
meta = nested
if require_media_kind:
media_kind = str(payload.get("media_kind") or meta.get("media_kind") or "").strip().lower()
if media_kind != str(require_media_kind or "").strip().lower():
return item, None, None
return item, payload, meta
2026-01-03 03:37:48 -08:00
@classmethod
def selection_auto_stage(
cls,
table_type: str,
stage_args: Optional[Sequence[str]] = None,
) -> Optional[List[str]]:
"""Return a stage to auto-run after selecting from `table_type`.
This is used by the CLI to auto-insert default stages for plugin tables
2026-01-03 03:37:48 -08:00
(e.g. select a YouTube row -> auto-run download-file).
Plugins can implement this via class attributes (TABLE_AUTO_STAGES /
2026-01-03 03:37:48 -08:00
TABLE_AUTO_PREFIXES) or by overriding this method.
"""
t = str(table_type or "").strip().lower()
if not t:
return None
stage: Optional[Sequence[str]] = None
try:
stage = cls.TABLE_AUTO_STAGES.get(t)
except Exception:
stage = None
if stage is None:
try:
for prefix, cmd in (cls.TABLE_AUTO_PREFIXES or {}).items():
p = str(prefix or "").strip().lower()
if not p:
continue
if t == p or t.startswith(p + ".") or t.startswith(p):
stage = cmd
break
except Exception:
stage = None
if not stage:
return None
out = [str(x) for x in stage if str(x or "").strip()]
if not out:
return None
if cls.AUTO_STAGE_USE_SELECTION_ARGS and stage_args:
try:
out.extend([str(x) for x in stage_args if str(x or "").strip()])
except Exception:
pass
return out
2026-01-01 20:37:27 -08:00
@classmethod
def url_patterns(cls) -> Tuple[str, ...]:
"""Return normalized URL patterns that this plugin handles."""
2026-01-01 20:37:27 -08:00
patterns: List[str] = []
maybe_urls = getattr(cls, "URL", None)
if isinstance(maybe_urls, (list, tuple)):
for entry in maybe_urls:
try:
candidate = str(entry or "").strip().lower()
except Exception:
continue
if candidate:
patterns.append(candidate)
maybe_domains = getattr(cls, "URL_DOMAINS", None)
if isinstance(maybe_domains, (list, tuple)):
for entry in maybe_domains:
try:
candidate = str(entry or "").strip().lower()
except Exception:
continue
if candidate and candidate not in patterns:
patterns.append(candidate)
return tuple(patterns)
@classmethod
def selection_url_prefixes(cls) -> Tuple[str, ...]:
"""Return URL-like prefixes that selection parsing should treat as URLs."""
prefixes: List[str] = []
seen: set[str] = set()
for pattern in cls.url_patterns():
try:
candidate = str(pattern or "").strip().lower()
except Exception:
continue
if not candidate:
continue
if "://" in candidate or candidate.endswith(":") or "🧲" in candidate:
if candidate not in seen:
seen.add(candidate)
prefixes.append(candidate)
return tuple(prefixes)
2025-12-11 19:04:02 -08:00