bvandeusen
19aece1fc4
Routine subscription polls walked the entire post history every tick
even when nothing had changed, because gallery-dl's default `skip: True`
continues iterating archived posts. A creator with ~550 archived posts
(Knuxy patreon) saturates the 870s wall-clock cap before completing,
even with zero downloads needed. Plus, a tier-limited run that
downloaded hundreds of files but ran out the clock should be a
warning, not an error.
Two coupled changes, both operator-flagged 2026-06-01:
* **Tick mode (default, cron polls).** New `TICK_SKIP_VALUE = "exit:20"`
asks gallery-dl to exit after 20 contiguous archived items. Fresh
subscriptions + new-content cases still walk normally; established
subscription with zero new content exits in ~30s of HEAD requests
instead of pegging the timeout. 20 (not 5) gives headroom against
paywall warnings interleaving with archived items.
* **Backfill mode (explicit, operator-triggered).** Sticky for N runs
via new `Source.backfill_runs_remaining` (alembic 0031). While > 0,
downloads use `skip: True` + 1800s timeout. Auto-decrements per run
with early-reset to 0 when a clean run finds zero files (queue
drained). N defaults to 3 — multiple runs give the system enough
budget to finish a deep walk across timeout boundaries. New
`POST /api/sources/{id}/backfill` arms the source; "Deep scan"
button on each SourceRow (chip shows remaining count) wires it.
Plus partial-success classifier: non-zero gallery-dl exit + ≥1 file
downloaded + no source-level error fires `ErrorType.PARTIAL`, which
download_service maps to `status=\"ok\"`. The run did real work; the
next tick continues via gallery-dl's archive. No more red events for
"timed out mid-walk after downloading 300 files."
Retires `SourceConfig.skip_existing` — skip value is now derived from
the source state and passed as a separate `skip_value` parameter
through download() / _build_config_for_source(). `GD_DEFAULTS` drops
the now-dead key (was inert data after this refactor).
Tests cover:
* tick + backfill skip-value emission in _build_config_for_source
* PARTIAL classifier branch + TIER_LIMITED-wins-over-PARTIAL ordering
* SourceService.set_backfill_runs validation + persistence
* /api/sources/{id}/backfill 200/400/404 paths
* download_service auto-decrement / auto-reset / tick-mode-no-touch
* PARTIAL → status=ok in the orchestrator (no consecutive_failures bump)
108 lines
4.0 KiB
Python
108 lines
4.0 KiB
Python
"""PlatformInfo dataclass + shared defaults + small helpers.
|
|
|
|
Per-platform modules import from here, register their PlatformInfo via
|
|
INFO, optionally attaching `derive_post_url` and/or `augment_cookies`
|
|
callables for behavior that diverges from gallery-dl's mainline shape
|
|
(Patreon).
|
|
|
|
Adding a new platform: drop a new module under `services/platforms/`,
|
|
declare an INFO, and add it to the import list in
|
|
`services/platforms/__init__.py`. Sidecar parsing, cookie
|
|
materialization, and the /api/platforms response pick it up
|
|
automatically.
|
|
"""
|
|
|
|
from collections.abc import Callable
|
|
from dataclasses import dataclass
|
|
from typing import Literal
|
|
|
|
# Sidecar parsing defaults. Per-platform PlatformInfo entries can
|
|
# override these by setting `external_post_id_keys=` /
|
|
# `description_keys=`. Most don't need to — the defaults already cover
|
|
# every platform FC supports.
|
|
#
|
|
# external_post_id chain: `post_id` MUST come before `id` because
|
|
# SubscribeStar gallery-dl puts the per-attachment id in `id` and the
|
|
# actual post id in `post_id`; picking `id` first fragments
|
|
# multi-image SubscribeStar posts into N Post rows. Patreon/Pixiv have
|
|
# no `post_id` so `id` still wins for them; HF uses `index`, Discord
|
|
# uses `message_id` — all reached via the remaining chain entries.
|
|
# (Banked 2026-05-27 during the sidecar audit.)
|
|
DEFAULT_EXTERNAL_POST_ID_KEYS: tuple[str, ...] = (
|
|
"post_id", "id", "index", "message_id",
|
|
)
|
|
|
|
# Description body chain: Discord's gallery-dl extractor uses `message`
|
|
# (no `content`); appended to the chain so Discord posts surface body
|
|
# text.
|
|
DEFAULT_DESCRIPTION_KEYS: tuple[str, ...] = (
|
|
"content", "description", "caption", "message",
|
|
)
|
|
|
|
|
|
@dataclass(frozen=True)
|
|
class PlatformInfo:
|
|
# --- Identity / metadata ---
|
|
key: str
|
|
name: str
|
|
description: str
|
|
auth_type: Literal["cookies", "token"]
|
|
requires_auth: bool
|
|
url_pattern: str
|
|
url_examples: list[str]
|
|
default_config: dict
|
|
notes: str | None = None
|
|
|
|
# --- Sidecar parsing overrides ---
|
|
# Each is None to mean "use the module default above"; a platform
|
|
# only sets one of these when its sidecar shape genuinely differs.
|
|
external_post_id_keys: tuple[str, ...] | None = None
|
|
description_keys: tuple[str, ...] | None = None
|
|
|
|
# --- Behavioral hooks ---
|
|
# Synthesize a post permalink from sidecar data. Required when
|
|
# gallery-dl's `url` field is the file/CDN URL rather than the post
|
|
# permalink (subscribestar/pixiv/hf/discord). None = trust the bare
|
|
# `url` field (patreon, deviantart).
|
|
derive_post_url: Callable[[dict], str | None] | None = None
|
|
|
|
# Post-process the materialized cookies.txt for gallery-dl. Used by
|
|
# platforms whose server gates or extractor quirks need synthetic
|
|
# cookies the extension can't capture (subscribestar age cookie, HF
|
|
# host-only PHPSESSID duplicate). None = no-op.
|
|
augment_cookies: Callable[[str], str] | None = None
|
|
|
|
|
|
def str_id_value(v) -> str | None:
|
|
"""Coerce a JSON scalar id into a non-empty string, rejecting bool
|
|
(Python's bool is an int subclass so `isinstance(True, int)` is
|
|
True; without this guard a sidecar with `"id": true` would produce
|
|
external_post_id="True")."""
|
|
if isinstance(v, bool):
|
|
return None
|
|
if isinstance(v, (str, int)) and str(v).strip():
|
|
return str(v).strip()
|
|
return None
|
|
|
|
|
|
def str_field(v) -> str | None:
|
|
"""Same idea as str_id_value but for plain string fields (no int
|
|
coercion)."""
|
|
if isinstance(v, str) and v.strip():
|
|
return v.strip()
|
|
return None
|
|
|
|
|
|
# Shared gallery-dl invocation defaults. Embedded in each platform's
|
|
# default_config (with platform-specific overrides) so per-platform
|
|
# choices stay explicit.
|
|
# Note: the gallery-dl `skip` value (tick "exit:20" vs backfill True) is
|
|
# NOT here — it's derived from Source.backfill_runs_remaining at download
|
|
# time. See plan #544 / gallery_dl.TICK_SKIP_VALUE,BACKFILL_SKIP_VALUE.
|
|
GD_DEFAULTS = {
|
|
"sleep": 3.0,
|
|
"sleep_request": 1.5,
|
|
"save_metadata": True,
|
|
"timeout": 3600,
|
|
}
|