bvandeusen
abafc3265e
Operator-requested 2026-05-27: centralize the per-platform quirks that
had been accumulating across credential_service, sidecar, and platforms
into a single per-platform module so adding/updating quirks becomes
"edit one file."
**Layout**
services/platforms/
base.py PlatformInfo dataclass + module-default key
chains + shared helpers (str_id_value, str_field)
__init__.py PLATFORMS dict + public API (auth_type_for,
known_platform_keys, to_dict,
external_post_id_keys_for, description_keys_for)
patreon.py metadata only — the reference platform, no quirks
subscribestar.py metadata + augment_cookies (18+ agreement) +
derive_post_url (synthetic /posts/<post_id>)
hentaifoundry.py metadata + augment_cookies (host-only PHPSESSID
duplicate) + derive_post_url (/pictures/user/...)
pixiv.py metadata + derive_post_url (/artworks/<id>)
discord.py metadata + derive_post_url
(channels/<server>/<channel>/<message>)
deviantart.py metadata only — un-audited; quirks to be added
when an operator first exercises DA
**PlatformInfo extensions**
Existing fields preserved. Four new optional fields:
external_post_id_keys: tuple[str, ...] | None
Override the sidecar external_post_id lookup chain. None falls
back to DEFAULT_EXTERNAL_POST_ID_KEYS in base.py
("post_id", "id", "index", "message_id") — covers every current
platform.
description_keys: tuple[str, ...] | None
Override the description body lookup chain. None falls back to
DEFAULT_DESCRIPTION_KEYS ("content", "description", "caption",
"message") — Discord's "message" body field is covered by the
default's trailing entry.
derive_post_url: Callable[[dict], str | None] | None
Synthesize the post permalink from sidecar metadata. None = trust
the bare `url` / `post_url` field (patreon, deviantart).
subscribestar/pixiv/hf/discord override this because their `url`
is the file CDN URL.
augment_cookies: Callable[[str], str] | None
Post-process the materialized cookies.txt before gallery-dl
consumes it. None = no-op. Used by subscribestar (age cookie) and
hentaifoundry (host-only PHPSESSID duplicate).
**Consumer changes**
- credential_service._augment_cookies(platform, netscape) shrunk from a
per-platform-conditional dispatcher (~80 lines of inlined helpers) to
a 5-line lookup: `info.augment_cookies(netscape) if info and
info.augment_cookies else netscape`. The platform-specific helper
bodies moved verbatim into the per-platform modules.
- sidecar.parse_sidecar similarly delegates: external_post_id chain via
external_post_id_keys_for(category), description chain via
description_keys_for(category), post_url via
PLATFORMS[category].derive_post_url. The _DERIVED_URL_PLATFORMS set
and inline _derive_post_url body both gone. Added a shared `_first_id`
helper for bool-safe id coercion.
**Public API preserved**
PLATFORMS, PlatformInfo, auth_type_for, known_platform_keys, to_dict
are all re-exported from the package's __init__.py. test_platforms_registry
test_credential_service, and test_sidecar_util pass without changes
because the behavior is identical; only the implementation moved.
**Adding a new platform**
1. Create services/platforms/<name>.py with `INFO = PlatformInfo(...)`
and any of the four optional hooks.
2. Import it in services/platforms/__init__.py + add to the PLATFORMS
tuple-comprehension.
3. Done. sidecar parsing, cookie materialization, /api/platforms all
pick it up automatically.
99 lines
2.8 KiB
Python
99 lines
2.8 KiB
Python
"""FC-3b platforms registry — single source of truth for what
|
|
FabledCurator supports + where each platform's quirks live.
|
|
|
|
Adding a new platform: drop a new module `<platform>.py` next to this
|
|
one, declare an `INFO = PlatformInfo(...)`, add the import + entry in
|
|
PLATFORMS below. Sidecar parsing, cookie materialization, and
|
|
`/api/platforms` pick it up automatically.
|
|
|
|
Lifted from GallerySubscriber's
|
|
~/Nextcloud/Projects/GallerySubscriber/backend/app/api/platforms.py
|
|
and ~/.../extension/lib/platforms.js. Six platforms; auth_type and
|
|
URL patterns match GS exactly so the existing browser extension
|
|
hits FC unmodified.
|
|
"""
|
|
|
|
from . import (
|
|
deviantart,
|
|
discord,
|
|
hentaifoundry,
|
|
patreon,
|
|
pixiv,
|
|
subscribestar,
|
|
)
|
|
from .base import (
|
|
DEFAULT_DESCRIPTION_KEYS,
|
|
DEFAULT_EXTERNAL_POST_ID_KEYS,
|
|
PlatformInfo,
|
|
)
|
|
|
|
|
|
PLATFORMS: dict[str, PlatformInfo] = {
|
|
info.key: info
|
|
for info in (
|
|
patreon.INFO,
|
|
subscribestar.INFO,
|
|
hentaifoundry.INFO,
|
|
discord.INFO,
|
|
pixiv.INFO,
|
|
deviantart.INFO,
|
|
)
|
|
}
|
|
|
|
|
|
def known_platform_keys() -> frozenset[str]:
|
|
return frozenset(PLATFORMS.keys())
|
|
|
|
|
|
def auth_type_for(platform: str) -> str | None:
|
|
info = PLATFORMS.get(platform)
|
|
return info.auth_type if info else None
|
|
|
|
|
|
def to_dict(info: PlatformInfo) -> dict:
|
|
"""Serialize a PlatformInfo to a JSON-safe dict for /api/platforms.
|
|
|
|
Behavioral fields (callables, sidecar-chain overrides) are
|
|
intentionally omitted — they aren't useful to API consumers.
|
|
"""
|
|
return {
|
|
"key": info.key,
|
|
"name": info.name,
|
|
"description": info.description,
|
|
"auth_type": info.auth_type,
|
|
"requires_auth": info.requires_auth,
|
|
"url_pattern": info.url_pattern,
|
|
"url_examples": info.url_examples,
|
|
"default_config": info.default_config,
|
|
"notes": info.notes,
|
|
}
|
|
|
|
|
|
def external_post_id_keys_for(platform: str | None) -> tuple[str, ...]:
|
|
"""Resolve the external_post_id lookup chain for a given platform,
|
|
falling back to the module default when the platform isn't
|
|
registered or hasn't overridden the chain."""
|
|
info = PLATFORMS.get(platform) if platform else None
|
|
if info is not None and info.external_post_id_keys is not None:
|
|
return info.external_post_id_keys
|
|
return DEFAULT_EXTERNAL_POST_ID_KEYS
|
|
|
|
|
|
def description_keys_for(platform: str | None) -> tuple[str, ...]:
|
|
"""Resolve the description body lookup chain for a given platform."""
|
|
info = PLATFORMS.get(platform) if platform else None
|
|
if info is not None and info.description_keys is not None:
|
|
return info.description_keys
|
|
return DEFAULT_DESCRIPTION_KEYS
|
|
|
|
|
|
__all__ = [
|
|
"PLATFORMS",
|
|
"PlatformInfo",
|
|
"auth_type_for",
|
|
"description_keys_for",
|
|
"external_post_id_keys_for",
|
|
"known_platform_keys",
|
|
"to_dict",
|
|
]
|