1191 lines
46 KiB
Python
1191 lines
46 KiB
Python
from __future__ import annotations
|
|
|
|
import json
|
|
import os
|
|
import sys
|
|
from datetime import UTC
|
|
from datetime import datetime
|
|
from pathlib import Path
|
|
from typing import Any
|
|
from typing import Literal
|
|
|
|
from colorama import Fore
|
|
from colorama import Style
|
|
from colorama import init as colorama_init
|
|
from django.core.management.base import BaseCommand
|
|
from django.core.management.base import CommandError
|
|
from django.core.management.base import CommandParser
|
|
from django.db import DatabaseError
|
|
from pydantic import ValidationError
|
|
from tqdm import tqdm
|
|
|
|
from twitch.models import Channel
|
|
from twitch.models import DropBenefit
|
|
from twitch.models import DropBenefitEdge
|
|
from twitch.models import DropCampaign
|
|
from twitch.models import Game
|
|
from twitch.models import Organization
|
|
from twitch.models import TimeBasedDrop
|
|
from twitch.schemas import ChannelInfoSchema
|
|
from twitch.schemas import CurrentUserSchema
|
|
from twitch.schemas import DropBenefitEdgeSchema
|
|
from twitch.schemas import DropBenefitSchema
|
|
from twitch.schemas import DropCampaignACLSchema
|
|
from twitch.schemas import DropCampaignSchema
|
|
from twitch.schemas import GameSchema
|
|
from twitch.schemas import GraphQLResponse
|
|
from twitch.schemas import OrganizationSchema
|
|
from twitch.schemas import TimeBasedDropSchema
|
|
from twitch.utils import parse_date
|
|
|
|
|
|
def get_broken_directory_root() -> Path:
|
|
"""Get the root broken directory path from environment or default.
|
|
|
|
Reads from TTVDROPS_BROKEN_DIR environment variable if set,
|
|
otherwise defaults to a directory in the current user's home.
|
|
|
|
Returns:
|
|
Path to the root broken directory.
|
|
"""
|
|
env_path: str | None = os.environ.get("TTVDROPS_BROKEN_DIR")
|
|
if env_path:
|
|
return Path(env_path)
|
|
|
|
# Default to ~/ttvdrops/broken/
|
|
home: Path = Path.home()
|
|
return home / "ttvdrops" / "broken"
|
|
|
|
|
|
def get_imported_directory_root() -> Path:
|
|
"""Get the root imported directory path from environment or default.
|
|
|
|
Reads from TTVDROPS_IMPORTED_DIR environment variable if set,
|
|
otherwise defaults to a directory in the current user's home.
|
|
|
|
Returns:
|
|
Path to the root imported directory.
|
|
"""
|
|
env_path: str | None = os.environ.get("TTVDROPS_IMPORTED_DIR")
|
|
if env_path:
|
|
return Path(env_path)
|
|
|
|
# Default to ~/ttvdrops/imported/
|
|
home: Path = Path.home()
|
|
return home / "ttvdrops" / "imported"
|
|
|
|
|
|
def _build_broken_directory(
|
|
reason: str,
|
|
operation_name: str | None = None,
|
|
) -> Path:
|
|
"""Compute a deeply nested broken directory for triage.
|
|
|
|
Directory pattern: <broken_root>/<reason>/<operation>/<YYYY>/<MM>/<DD>
|
|
This keeps unrelated failures isolated and easy to browse later.
|
|
|
|
Args:
|
|
reason: High-level reason bucket (e.g., validation_failed).
|
|
operation_name: Optional operationName extracted from the payload.
|
|
|
|
Returns:
|
|
Path to the directory where the file should live.
|
|
"""
|
|
safe_reason: str = reason.replace(" ", "_")
|
|
now: datetime = datetime.now(tz=UTC)
|
|
|
|
# If operation_name matches reason, skip it to avoid duplicate directories
|
|
if operation_name and operation_name.replace(" ", "_") == safe_reason:
|
|
broken_dir: Path = get_broken_directory_root() / safe_reason / f"{now:%Y}" / f"{now:%m}" / f"{now:%d}"
|
|
else:
|
|
op_segment: str = (operation_name or "unknown_op").replace(" ", "_")
|
|
broken_dir = get_broken_directory_root() / safe_reason / op_segment / f"{now:%Y}" / f"{now:%m}" / f"{now:%d}"
|
|
|
|
broken_dir.mkdir(parents=True, exist_ok=True)
|
|
return broken_dir
|
|
|
|
|
|
def move_failed_validation_file(file_path: Path, operation_name: str | None = None) -> Path:
|
|
"""Moves a file that failed validation to a 'broken' subdirectory.
|
|
|
|
Args:
|
|
file_path: Path to the file that failed validation
|
|
operation_name: Optional GraphQL operation name for finer grouping
|
|
|
|
Returns:
|
|
Path to the 'broken' directory where the file was moved
|
|
"""
|
|
broken_dir: Path = _build_broken_directory(
|
|
reason="validation_failed",
|
|
operation_name=operation_name,
|
|
)
|
|
|
|
target_file: Path = broken_dir / file_path.name
|
|
file_path.rename(target_file)
|
|
|
|
return broken_dir
|
|
|
|
|
|
def move_file_to_broken_subdir(
|
|
file_path: Path,
|
|
subdir: str,
|
|
operation_name: str | None = None,
|
|
) -> Path:
|
|
"""Move file to broken/<subdir> and return that directory path.
|
|
|
|
Args:
|
|
file_path: The file to move.
|
|
subdir: Subdirectory name under "broken" (e.g., the matched keyword).
|
|
operation_name: Optional GraphQL operation name for finer grouping
|
|
|
|
Returns:
|
|
Path to the directory where the file was moved.
|
|
"""
|
|
broken_dir: Path = _build_broken_directory(
|
|
reason=subdir,
|
|
operation_name=operation_name,
|
|
)
|
|
|
|
target_file: Path = broken_dir / file_path.name
|
|
file_path.rename(target_file)
|
|
|
|
return broken_dir
|
|
|
|
|
|
def move_completed_file(
|
|
file_path: Path,
|
|
operation_name: str | None = None,
|
|
campaign_structure: str | None = None,
|
|
) -> Path:
|
|
"""Move a successfully processed file into an operation-named directory.
|
|
|
|
Moves to <imported_root>/<operation_name>/ or
|
|
<imported_root>/<operation_name>/<campaign_structure>/ if campaign_structure is provided.
|
|
|
|
Args:
|
|
file_path: Path to the processed JSON file.
|
|
operation_name: GraphQL operationName extracted from the payload.
|
|
campaign_structure: Optional campaign structure type (e.g., "user_drop_campaign").
|
|
|
|
Returns:
|
|
Path to the directory where the file was moved.
|
|
"""
|
|
safe_op: str = (operation_name or "unknown_op").replace(" ", "_").replace("/", "_").replace("\\", "_")
|
|
target_dir: Path = get_imported_directory_root() / safe_op
|
|
|
|
if campaign_structure:
|
|
target_dir /= campaign_structure
|
|
|
|
target_dir.mkdir(parents=True, exist_ok=True)
|
|
|
|
target_file: Path = target_dir / file_path.name
|
|
file_path.rename(target_file)
|
|
|
|
return target_dir
|
|
|
|
|
|
# Pre-compute keyword search patterns for faster detection
|
|
_KNOWN_NON_CAMPAIGN_PATTERNS: dict[str, str] = {
|
|
keyword: f'"operationName": "{keyword}"'
|
|
for keyword in [
|
|
"ChannelPointsContext",
|
|
"ClaimCommunityPoints",
|
|
"DirectoryPage_Game",
|
|
"DropCurrentSessionContext",
|
|
"DropsPage_ClaimDropRewards",
|
|
"OnsiteNotifications_DeleteNotification",
|
|
"PlaybackAccessToken",
|
|
"streamPlaybackAccessToken",
|
|
"VideoPlayerStreamInfoOverlayChannel",
|
|
]
|
|
}
|
|
|
|
|
|
def detect_non_campaign_keyword(raw_text: str) -> str | None:
|
|
"""Detect if payload is a known non-drop-campaign response.
|
|
|
|
Looks for operationName values that are commonly present in unrelated
|
|
Twitch API responses. Returns the matched keyword if found.
|
|
|
|
Args:
|
|
raw_text: The raw JSON text to scan.
|
|
|
|
Returns:
|
|
The matched keyword, or None if no match found.
|
|
"""
|
|
for keyword, pattern in _KNOWN_NON_CAMPAIGN_PATTERNS.items():
|
|
if pattern in raw_text:
|
|
return keyword
|
|
return None
|
|
|
|
|
|
def extract_operation_name_from_parsed(
|
|
payload: dict[str, Any] | list[Any],
|
|
) -> str | None:
|
|
"""Extract GraphQL operationName from an already parsed JSON payload.
|
|
|
|
This is safer than substring scanning. The expected location is
|
|
`payload["extensions"]["operationName"]`, but we guard against missing
|
|
keys.
|
|
|
|
Args:
|
|
payload: Parsed JSON object or list.
|
|
|
|
Returns:
|
|
The operation name if found, otherwise None.
|
|
"""
|
|
# Be defensive; never let provenance extraction break the import.
|
|
# If payload is a list, try to extract from the first item
|
|
if isinstance(payload, list):
|
|
if len(payload) > 0 and isinstance(payload[0], dict):
|
|
return extract_operation_name_from_parsed(payload[0])
|
|
return None
|
|
|
|
if not isinstance(payload, dict):
|
|
return None
|
|
|
|
extensions: dict[str, Any] | None = payload.get("extensions")
|
|
if isinstance(extensions, dict):
|
|
op_name: str | None = extensions.get("operationName")
|
|
if isinstance(op_name, str):
|
|
return op_name
|
|
return None
|
|
|
|
|
|
class Command(BaseCommand):
|
|
"""Import Twitch drop campaign data from a JSON file or directory."""
|
|
|
|
help = "Import Twitch drop campaign data from a JSON file or directory"
|
|
requires_migrations_checks = True
|
|
|
|
# In-memory caches prevent repeated DB lookups during batch imports,
|
|
# cutting query volume and keeping runtime predictable.
|
|
game_cache: dict[str, Game] = {}
|
|
organization_cache: dict[str, Organization] = {}
|
|
drop_campaign_cache: dict[str, DropCampaign] = {}
|
|
channel_cache: dict[str, Channel] = {}
|
|
benefit_cache: dict[str, DropBenefit] = {}
|
|
|
|
def add_arguments(self, parser: CommandParser) -> None:
|
|
"""Populate the command with arguments."""
|
|
parser.add_argument(
|
|
"path",
|
|
type=str,
|
|
help="Path to JSON file or directory",
|
|
)
|
|
parser.add_argument(
|
|
"--recursive",
|
|
action="store_true",
|
|
help="Recursively search directories for JSON files",
|
|
)
|
|
parser.add_argument(
|
|
"--crash-on-error",
|
|
dest="crash_on_error",
|
|
action="store_true",
|
|
help="Crash the command on first error instead of continuing",
|
|
)
|
|
parser.add_argument(
|
|
"--verbose",
|
|
action="store_true",
|
|
help="Print per-file success messages",
|
|
)
|
|
parser.add_argument(
|
|
"--skip-broken-moves",
|
|
dest="skip_broken_moves",
|
|
action="store_true",
|
|
help=(
|
|
"Do not move files to the broken directory on failures; useful"
|
|
" during testing to avoid unnecessary file moves"
|
|
),
|
|
)
|
|
|
|
def pre_fill_cache(self) -> None:
|
|
"""Load all existing IDs from DB into memory."""
|
|
self.game_cache = {}
|
|
self.organization_cache = {}
|
|
self.drop_campaign_cache = {}
|
|
self.channel_cache = {}
|
|
self.benefit_cache = {}
|
|
|
|
cache_operations: list[tuple[str, type, str]] = [
|
|
("Games", Game, "game_cache"),
|
|
("Organizations", Organization, "organization_cache"),
|
|
("Drop Campaigns", DropCampaign, "drop_campaign_cache"),
|
|
("Channels", Channel, "channel_cache"),
|
|
("Benefits", DropBenefit, "benefit_cache"),
|
|
]
|
|
|
|
try:
|
|
with tqdm(cache_operations, desc="Loading caches", unit="cache", colour="cyan") as progress_bar:
|
|
for name, model, cache_attr in progress_bar:
|
|
self.load_cache_for_model(progress_bar, name, model, cache_attr)
|
|
tqdm.write("")
|
|
except (DatabaseError, OSError, RuntimeError, ValueError, TypeError):
|
|
# If cache loading fails completely, just use empty caches
|
|
tqdm.write(f"{Fore.YELLOW}⚠{Style.RESET_ALL} Cache preload skipped (database error)\n")
|
|
|
|
def load_cache_for_model(self, progress_bar: tqdm, name: str, model: type, cache_attr: str) -> None:
|
|
"""Load cache for a specific model and attach to the command instance.
|
|
|
|
Args:
|
|
progress_bar: TQDM progress bar instance.
|
|
name: Human-readable name of the model being cached.
|
|
model: Django model class to query.
|
|
cache_attr: Attribute name on the command instance to store the cache.
|
|
"""
|
|
progress_bar.set_description(f"Loading {name}")
|
|
try:
|
|
cache: dict[str, Any] = {str(obj.twitch_id): obj for obj in model.objects.all()}
|
|
setattr(self, cache_attr, cache)
|
|
progress_bar.write(f" {Fore.GREEN}✓{Style.RESET_ALL} {name}: {len(cache):,}")
|
|
except (DatabaseError, OSError, RuntimeError, ValueError, TypeError) as e:
|
|
# Database error - skip this cache
|
|
msg: str = f" {Fore.YELLOW}⚠{Style.RESET_ALL} {name}: Could not load ({type(e).__name__})"
|
|
progress_bar.write(msg)
|
|
|
|
setattr(self, cache_attr, {})
|
|
|
|
def _validate_responses(
|
|
self,
|
|
responses: list[dict[str, Any]],
|
|
file_path: Path,
|
|
options: dict[str, Any],
|
|
) -> tuple[list[GraphQLResponse], Path | None]:
|
|
"""Validate GraphQL response data using Pydantic schema.
|
|
|
|
Args:
|
|
responses: List of raw GraphQL response dictionaries.
|
|
file_path: Path to the file being processed.
|
|
options: Command options.
|
|
|
|
Returns:
|
|
Tuple of validated Pydantic GraphQLResponse models and an optional
|
|
broken directory path when the file was moved during validation.
|
|
|
|
Raises:
|
|
ValidationError: If response data fails Pydantic validation
|
|
and crash-on-error is enabled.
|
|
"""
|
|
valid_responses: list[GraphQLResponse] = []
|
|
broken_dir: Path | None = None
|
|
|
|
if isinstance(responses, list):
|
|
for response_data in responses:
|
|
if isinstance(response_data, dict):
|
|
try:
|
|
response: GraphQLResponse = GraphQLResponse.model_validate(response_data)
|
|
valid_responses.append(response)
|
|
|
|
except ValidationError as e:
|
|
tqdm.write(
|
|
f"{Fore.RED}✗{Style.RESET_ALL} Validation failed for an entry in {file_path.name}: {e}",
|
|
)
|
|
|
|
# Move invalid inputs out of the hot path so future runs can progress.
|
|
if not options.get("skip_broken_moves"):
|
|
op_name: str | None = extract_operation_name_from_parsed(response_data)
|
|
broken_dir = move_failed_validation_file(file_path, operation_name=op_name)
|
|
|
|
# Once the file has been moved, bail out so we don't try to move it again later.
|
|
return [], broken_dir
|
|
|
|
# optionally crash early to surface schema issues.
|
|
if options.get("crash_on_error"):
|
|
raise
|
|
|
|
continue
|
|
|
|
return valid_responses, broken_dir
|
|
|
|
def _get_or_create_organization(
|
|
self,
|
|
org_data: OrganizationSchema,
|
|
) -> Organization:
|
|
"""Get or create an organization from cache or database.
|
|
|
|
Args:
|
|
org_data: Organization data from Pydantic model.
|
|
|
|
Returns:
|
|
Organization instance.
|
|
"""
|
|
# Prefer cache hits to avoid hitting the DB on every campaign item.
|
|
if org_data.twitch_id in self.organization_cache:
|
|
return self.organization_cache[org_data.twitch_id]
|
|
|
|
org_obj, created = Organization.objects.update_or_create(
|
|
twitch_id=org_data.twitch_id,
|
|
defaults={
|
|
"name": org_data.name,
|
|
},
|
|
)
|
|
if created:
|
|
tqdm.write(f"{Fore.GREEN}✓{Style.RESET_ALL} Created new organization: {org_data.name}")
|
|
|
|
# Cache the organization for future lookups.
|
|
self.organization_cache[org_data.twitch_id] = org_obj
|
|
|
|
return org_obj
|
|
|
|
def _get_or_create_game(
|
|
self,
|
|
game_data: GameSchema,
|
|
org_obj: Organization,
|
|
) -> Game:
|
|
"""Get or create a game from cache or database.
|
|
|
|
Args:
|
|
game_data: Game data from Pydantic model.
|
|
org_obj: Organization that owns this game.
|
|
|
|
Returns:
|
|
Game instance.
|
|
"""
|
|
if game_data.twitch_id in self.game_cache:
|
|
game_obj: Game = self.game_cache[game_data.twitch_id]
|
|
|
|
# Maintenance: Ensure the existing game is linked to the
|
|
# correct owner (Sometimes games are imported without owner
|
|
# data first). Use owner_id to avoid triggering a query.
|
|
# Correct stale owner linkage that may exist from earlier
|
|
# partial imports.
|
|
if game_obj.owner_id != org_obj.pk: # type: ignore[attr-defined] # Django adds _id suffix for FK fields
|
|
game_obj.owner = org_obj
|
|
game_obj.save(update_fields=["owner"])
|
|
|
|
return game_obj
|
|
|
|
game_obj, created = Game.objects.update_or_create(
|
|
twitch_id=game_data.twitch_id,
|
|
defaults={
|
|
"display_name": game_data.display_name,
|
|
"box_art": game_data.box_art_url,
|
|
"owner": org_obj,
|
|
},
|
|
)
|
|
if created:
|
|
tqdm.write(f"{Fore.GREEN}✓{Style.RESET_ALL} Created new game: {game_data.display_name}")
|
|
|
|
self.game_cache[game_data.twitch_id] = game_obj
|
|
return game_obj
|
|
|
|
def _get_or_create_channel(self, channel_info: ChannelInfoSchema) -> Channel:
|
|
"""Get or create a channel from cache or database.
|
|
|
|
Args:
|
|
channel_info: Channel info from Pydantic model.
|
|
|
|
Returns:
|
|
Channel instance.
|
|
"""
|
|
# Prefer cache hits to avoid hitting the DB on every campaign item.
|
|
if channel_info.twitch_id in self.channel_cache:
|
|
return self.channel_cache[channel_info.twitch_id]
|
|
|
|
# Use name as display_name fallback if displayName is None
|
|
display_name: str = channel_info.display_name or channel_info.name
|
|
|
|
channel_obj, created = Channel.objects.update_or_create(
|
|
twitch_id=channel_info.twitch_id,
|
|
defaults={
|
|
"name": channel_info.name,
|
|
"display_name": display_name,
|
|
},
|
|
)
|
|
if created:
|
|
tqdm.write(f"{Fore.GREEN}✓{Style.RESET_ALL} Created new channel: {display_name}")
|
|
|
|
# Cache the channel for future lookups.
|
|
self.channel_cache[channel_info.twitch_id] = channel_obj
|
|
|
|
return channel_obj
|
|
|
|
def _should_skip_campaign_update(
|
|
self,
|
|
cached_obj: DropCampaign,
|
|
defaults: dict[str, Any],
|
|
game_obj: Game,
|
|
) -> bool:
|
|
"""Check if campaign update can be skipped based on cache comparison.
|
|
|
|
Args:
|
|
cached_obj: Cached campaign object.
|
|
defaults: New campaign data.
|
|
game_obj: Associated game object.
|
|
|
|
Returns:
|
|
True if no update needed, False otherwise.
|
|
"""
|
|
# Use game_id (Django's auto-generated FK field) to avoid
|
|
# triggering a query. Compare FK IDs to avoid ORM reads; keeps
|
|
# this a pure in-memory check.
|
|
cached_game_id: int | None = getattr(cached_obj, "game_id", None)
|
|
|
|
# Ensure game object has a primary key (should always be true
|
|
# at this point)
|
|
game_id: int | None = game_obj.pk
|
|
|
|
# Short-circuit updates when nothing changed; reduces write
|
|
# load and log noise while keeping caches accurate.
|
|
return bool(
|
|
cached_obj.name == defaults["name"]
|
|
and cached_obj.description == defaults["description"]
|
|
and getattr(cached_obj, "image_url", "") == defaults.get("image_url", "")
|
|
and cached_obj.start_at == defaults["start_at"]
|
|
and cached_obj.end_at == defaults["end_at"]
|
|
and cached_obj.details_url == defaults["details_url"]
|
|
and cached_obj.account_link_url == defaults["account_link_url"]
|
|
and cached_game_id == game_id,
|
|
)
|
|
|
|
def process_responses( # noqa: PLR0914
|
|
self,
|
|
responses: list[dict[str, Any]],
|
|
file_path: Path,
|
|
options: dict[str, Any],
|
|
) -> tuple[bool, Path | None]:
|
|
"""Process, validate, and import campaign data from GraphQL responses.
|
|
|
|
With dependency resolution and caching.
|
|
|
|
Args:
|
|
responses: List of raw GraphQL response dictionaries to process.
|
|
file_path: Path to the file being processed.
|
|
options: Command options dictionary.
|
|
|
|
Raises:
|
|
ValueError: If datetime parsing fails for campaign dates and
|
|
crash-on-error is enabled.
|
|
|
|
Returns:
|
|
Tuple of (success flag, broken directory path if moved).
|
|
"""
|
|
valid_responses, broken_dir = self._validate_responses(
|
|
responses=responses,
|
|
file_path=file_path,
|
|
options=options,
|
|
)
|
|
|
|
if broken_dir is not None:
|
|
# File already moved due to validation failure; signal caller to skip further handling.
|
|
return False, broken_dir
|
|
|
|
for response in valid_responses:
|
|
campaigns_to_process: list[DropCampaignSchema] = []
|
|
|
|
# Source 1: User or CurrentUser field (handles plural, singular, inventory)
|
|
user_obj: CurrentUserSchema | None = response.data.current_user or response.data.user
|
|
if user_obj and user_obj.drop_campaigns:
|
|
campaigns_to_process.extend(user_obj.drop_campaigns)
|
|
|
|
# Source 2: Channel field (viewer drop campaigns)
|
|
channel_obj = response.data.channel
|
|
if channel_obj and channel_obj.viewer_drop_campaigns:
|
|
if isinstance(channel_obj.viewer_drop_campaigns, list):
|
|
campaigns_to_process.extend(channel_obj.viewer_drop_campaigns)
|
|
else:
|
|
campaigns_to_process.append(channel_obj.viewer_drop_campaigns)
|
|
|
|
if not campaigns_to_process:
|
|
continue
|
|
|
|
for drop_campaign in campaigns_to_process:
|
|
# Handle campaigns without owner (e.g., from Inventory operation)
|
|
owner_data: OrganizationSchema | None = getattr(drop_campaign, "owner", None)
|
|
if owner_data:
|
|
org_obj: Organization = self._get_or_create_organization(
|
|
org_data=owner_data,
|
|
)
|
|
else:
|
|
# Create a default organization for campaigns without owner
|
|
org_obj, _ = Organization.objects.get_or_create(
|
|
twitch_id="unknown",
|
|
defaults={"name": "Unknown Organization"},
|
|
)
|
|
self.organization_cache["unknown"] = org_obj
|
|
|
|
game_obj: Game = self._get_or_create_game(
|
|
game_data=drop_campaign.game,
|
|
org_obj=org_obj,
|
|
)
|
|
|
|
start_at_dt: datetime | None = parse_date(drop_campaign.start_at)
|
|
end_at_dt: datetime | None = parse_date(drop_campaign.end_at)
|
|
|
|
if start_at_dt is None or end_at_dt is None:
|
|
tqdm.write(f"{Fore.RED}✗{Style.RESET_ALL} Invalid datetime in campaign: {drop_campaign.name}")
|
|
if options.get("crash_on_error"):
|
|
msg: str = f"Failed to parse datetime for campaign {drop_campaign.name}"
|
|
raise ValueError(msg)
|
|
continue
|
|
|
|
defaults: dict[str, str | datetime | Game | bool] = {
|
|
"name": drop_campaign.name,
|
|
"description": drop_campaign.description,
|
|
"image_url": drop_campaign.image_url,
|
|
"game": game_obj,
|
|
"start_at": start_at_dt,
|
|
"end_at": end_at_dt,
|
|
"details_url": drop_campaign.details_url,
|
|
"account_link_url": drop_campaign.account_link_url,
|
|
}
|
|
|
|
if drop_campaign.twitch_id in self.drop_campaign_cache:
|
|
cached_obj: DropCampaign = self.drop_campaign_cache[drop_campaign.twitch_id]
|
|
if self._should_skip_campaign_update(cached_obj=cached_obj, defaults=defaults, game_obj=game_obj):
|
|
if options.get("verbose"):
|
|
tqdm.write(f"{Fore.YELLOW}→{Style.RESET_ALL} Skipped (No changes): {drop_campaign.name}")
|
|
continue
|
|
|
|
campaign_obj, created = DropCampaign.objects.update_or_create(
|
|
twitch_id=drop_campaign.twitch_id,
|
|
defaults=defaults,
|
|
)
|
|
if created:
|
|
tqdm.write(f"{Fore.GREEN}✓{Style.RESET_ALL} Created new campaign: {drop_campaign.name}")
|
|
|
|
self.drop_campaign_cache[drop_campaign.twitch_id] = campaign_obj
|
|
|
|
action: Literal["Imported new", "Updated"] = "Imported new" if created else "Updated"
|
|
tqdm.write(f"{Fore.GREEN}✓{Style.RESET_ALL} {action} campaign: {drop_campaign.name}")
|
|
|
|
if (
|
|
response.extensions
|
|
and response.extensions.operation_name
|
|
and campaign_obj.operation_name != response.extensions.operation_name
|
|
):
|
|
campaign_obj.operation_name = response.extensions.operation_name
|
|
campaign_obj.save(update_fields=["operation_name"])
|
|
|
|
if drop_campaign.time_based_drops:
|
|
self._process_time_based_drops(
|
|
time_based_drops_schema=drop_campaign.time_based_drops,
|
|
campaign_obj=campaign_obj,
|
|
)
|
|
|
|
# Process allowed channels from the campaign's ACL
|
|
if drop_campaign.allow and drop_campaign.allow.channels:
|
|
self._process_allowed_channels(
|
|
campaign_obj=campaign_obj,
|
|
allow_schema=drop_campaign.allow,
|
|
)
|
|
|
|
return True, None
|
|
|
|
def _process_time_based_drops(
|
|
self,
|
|
time_based_drops_schema: list[TimeBasedDropSchema],
|
|
campaign_obj: DropCampaign,
|
|
) -> None:
|
|
"""Process time-based drops for a campaign.
|
|
|
|
Args:
|
|
time_based_drops_schema: List of TimeBasedDrop Pydantic schemas.
|
|
campaign_obj: The DropCampaign database object.
|
|
"""
|
|
for drop_schema in time_based_drops_schema:
|
|
start_at_dt: datetime | None = parse_date(drop_schema.start_at)
|
|
end_at_dt: datetime | None = parse_date(drop_schema.end_at)
|
|
|
|
drop_defaults: dict[str, str | int | datetime | DropCampaign] = {
|
|
"campaign": campaign_obj,
|
|
"name": drop_schema.name,
|
|
"required_subs": drop_schema.required_subs,
|
|
}
|
|
|
|
if drop_schema.required_minutes_watched is not None:
|
|
drop_defaults["required_minutes_watched"] = drop_schema.required_minutes_watched
|
|
if start_at_dt is not None:
|
|
drop_defaults["start_at"] = start_at_dt
|
|
if end_at_dt is not None:
|
|
drop_defaults["end_at"] = end_at_dt
|
|
|
|
drop_obj, created = TimeBasedDrop.objects.update_or_create(
|
|
twitch_id=drop_schema.twitch_id,
|
|
defaults=drop_defaults,
|
|
)
|
|
if created:
|
|
tqdm.write(f"{Fore.GREEN}✓{Style.RESET_ALL} Created TimeBasedDrop: {drop_schema.name}")
|
|
|
|
self._process_benefit_edges(
|
|
benefit_edges_schema=drop_schema.benefit_edges,
|
|
drop_obj=drop_obj,
|
|
)
|
|
|
|
def _get_or_update_benefit(self, benefit_schema: DropBenefitSchema) -> DropBenefit:
|
|
"""Return a DropBenefit, updating stale cached values when needed."""
|
|
distribution_type: str = (benefit_schema.distribution_type or "").strip()
|
|
benefit_defaults: dict[str, str | int | datetime | bool | None] = {
|
|
"name": benefit_schema.name,
|
|
"image_asset_url": benefit_schema.image_asset_url,
|
|
"entitlement_limit": benefit_schema.entitlement_limit,
|
|
"is_ios_available": benefit_schema.is_ios_available,
|
|
"distribution_type": distribution_type,
|
|
}
|
|
|
|
if benefit_schema.created_at:
|
|
created_at_dt: datetime | None = parse_date(benefit_schema.created_at)
|
|
if created_at_dt:
|
|
benefit_defaults["created_at"] = created_at_dt
|
|
|
|
cached_benefit: DropBenefit | None = self.benefit_cache.get(benefit_schema.twitch_id)
|
|
|
|
if cached_benefit:
|
|
update_fields: list[str] = []
|
|
for field_name, value in benefit_defaults.items():
|
|
if getattr(cached_benefit, field_name) != value:
|
|
setattr(cached_benefit, field_name, value)
|
|
update_fields.append(field_name)
|
|
|
|
if update_fields:
|
|
cached_benefit.save(update_fields=update_fields)
|
|
|
|
benefit_obj: DropBenefit = cached_benefit
|
|
else:
|
|
benefit_obj, created = DropBenefit.objects.update_or_create(
|
|
twitch_id=benefit_schema.twitch_id,
|
|
defaults=benefit_defaults,
|
|
)
|
|
if created:
|
|
tqdm.write(f"{Fore.GREEN}✓{Style.RESET_ALL} Created DropBenefit: {benefit_schema.name}")
|
|
|
|
self.benefit_cache[benefit_schema.twitch_id] = benefit_obj
|
|
return benefit_obj
|
|
|
|
def _process_benefit_edges(
|
|
self,
|
|
benefit_edges_schema: list[DropBenefitEdgeSchema],
|
|
drop_obj: TimeBasedDrop,
|
|
) -> None:
|
|
"""Process benefit edges for a time-based drop.
|
|
|
|
Args:
|
|
benefit_edges_schema: List of DropBenefitEdge Pydantic schemas.
|
|
drop_obj: The TimeBasedDrop database object.
|
|
"""
|
|
for edge_schema in benefit_edges_schema:
|
|
benefit_schema: DropBenefitSchema = edge_schema.benefit
|
|
|
|
benefit_obj: DropBenefit = self._get_or_update_benefit(benefit_schema=benefit_schema)
|
|
|
|
_edge_obj, created = DropBenefitEdge.objects.update_or_create(
|
|
drop=drop_obj,
|
|
benefit=benefit_obj,
|
|
defaults={"entitlement_limit": edge_schema.entitlement_limit},
|
|
)
|
|
if created:
|
|
tqdm.write(f"{Fore.GREEN}✓{Style.RESET_ALL} Linked benefit: {benefit_schema.name} → {drop_obj.name}")
|
|
|
|
def _process_allowed_channels(
|
|
self,
|
|
campaign_obj: DropCampaign,
|
|
allow_schema: DropCampaignACLSchema,
|
|
) -> None:
|
|
"""Process allowed channels for a drop campaign.
|
|
|
|
Updates the campaign's allow_is_enabled flag and M2M relationship
|
|
with allowed channels from the ACL schema.
|
|
|
|
Args:
|
|
campaign_obj: The DropCampaign database object.
|
|
allow_schema: The DropCampaignACL Pydantic schema.
|
|
"""
|
|
# Update the allow_is_enabled flag if changed
|
|
if campaign_obj.allow_is_enabled != allow_schema.is_enabled:
|
|
campaign_obj.allow_is_enabled = allow_schema.is_enabled
|
|
campaign_obj.save(update_fields=["allow_is_enabled"])
|
|
|
|
# Get or create all channels and collect them
|
|
channel_objects: list[Channel] = []
|
|
if allow_schema.channels:
|
|
for channel_schema in allow_schema.channels:
|
|
channel_obj: Channel = self._get_or_create_channel(channel_info=channel_schema)
|
|
channel_objects.append(channel_obj)
|
|
|
|
# Update the M2M relationship with the allowed channels
|
|
campaign_obj.allow_channels.set(channel_objects)
|
|
|
|
def handle(self, *args, **options) -> None: # noqa: ARG002
|
|
"""Main entry point for the command.
|
|
|
|
Raises:
|
|
CommandError: If the provided path does not exist.
|
|
"""
|
|
colorama_init(autoreset=True)
|
|
|
|
input_path: Path = Path(options["path"]).resolve()
|
|
|
|
self.pre_fill_cache()
|
|
|
|
try:
|
|
if input_path.is_file():
|
|
self.process_file(file_path=input_path, options=options)
|
|
elif input_path.is_dir():
|
|
self.process_json_files(input_path=input_path, options=options)
|
|
else:
|
|
msg: str = f"Path does not exist: {input_path}"
|
|
raise CommandError(msg)
|
|
except KeyboardInterrupt:
|
|
tqdm.write(self.style.WARNING("\n\nInterrupted by user!"))
|
|
tqdm.write(self.style.WARNING("Shutting down gracefully..."))
|
|
sys.exit(130) # 128 + 2 (Keyboard Interrupt)
|
|
|
|
def process_json_files(self, input_path: Path, options: dict) -> None:
|
|
"""Process multiple JSON files in a directory.
|
|
|
|
Args:
|
|
input_path: Path to the directory containing JSON files
|
|
options: Command options
|
|
"""
|
|
json_files: list[Path] = self.collect_json_files(options, input_path)
|
|
tqdm.write(f"Found {len(json_files)} JSON files to process\n")
|
|
|
|
success_count = 0
|
|
failed_count = 0
|
|
error_count = 0
|
|
|
|
with tqdm(
|
|
total=len(json_files),
|
|
desc="Processing",
|
|
unit="file",
|
|
bar_format=("{l_bar}{bar}| {n_fmt}/{total_fmt} [{elapsed}<{remaining}, {rate_fmt}]"),
|
|
colour="green",
|
|
dynamic_ncols=True,
|
|
) as progress_bar:
|
|
for file_path in json_files:
|
|
try:
|
|
result: dict[str, bool | str] = self.process_file_worker(
|
|
file_path=file_path,
|
|
options=options,
|
|
)
|
|
if result["success"]:
|
|
success_count += 1
|
|
if options.get("verbose"):
|
|
progress_bar.write(f"{Fore.GREEN}✓{Style.RESET_ALL} {file_path.name}")
|
|
else:
|
|
failed_count += 1
|
|
reason: bool | str | None = result.get("reason") if isinstance(result, dict) else None
|
|
if reason:
|
|
progress_bar.write(
|
|
f"{Fore.RED}✗{Style.RESET_ALL} "
|
|
f"{file_path.name} → {result['broken_dir']}/"
|
|
f"{file_path.name} ({reason})",
|
|
)
|
|
else:
|
|
progress_bar.write(
|
|
f"{Fore.RED}✗{Style.RESET_ALL} "
|
|
f"{file_path.name} → {result['broken_dir']}/"
|
|
f"{file_path.name}",
|
|
)
|
|
except (OSError, ValueError, KeyError) as e:
|
|
error_count += 1
|
|
progress_bar.write(f"{Fore.RED}✗{Style.RESET_ALL} {file_path.name} (error: {e})")
|
|
|
|
# Update postfix with statistics
|
|
progress_bar.set_postfix_str(f"✓ {success_count} | ✗ {failed_count + error_count}", refresh=True)
|
|
progress_bar.update(1)
|
|
|
|
self.print_processing_summary(
|
|
json_files,
|
|
success_count,
|
|
failed_count,
|
|
error_count,
|
|
)
|
|
|
|
def print_processing_summary(
|
|
self,
|
|
json_files: list[Path],
|
|
success_count: int,
|
|
failed_count: int,
|
|
error_count: int,
|
|
) -> None:
|
|
"""Print a summary of the batch processing results.
|
|
|
|
Args:
|
|
json_files: List of JSON file paths that were processed.
|
|
success_count: Number of files processed successfully.
|
|
failed_count: Number of files that failed validation and were
|
|
moved.
|
|
error_count: Number of files that encountered unexpected errors.
|
|
"""
|
|
tqdm.write("\n" + "=" * 50)
|
|
tqdm.write(self.style.SUCCESS(f"✓ Successfully processed: {success_count}"))
|
|
if failed_count > 0:
|
|
tqdm.write(self.style.WARNING(f"✗ Validation failed: {failed_count}"))
|
|
if error_count > 0:
|
|
tqdm.write(self.style.ERROR(f"✗ Errors: {error_count}"))
|
|
tqdm.write(f"Total: {len(json_files)}")
|
|
tqdm.write("=" * 50)
|
|
|
|
def _detect_campaign_structure(self, response: dict[str, Any]) -> str | None:
|
|
"""Detect which campaign structure is present in the response.
|
|
|
|
Used for organizing/categorizing files by their response type.
|
|
|
|
Supported structures:
|
|
- "user_drop_campaign": {"data": {"user": {"dropCampaign": {...}}}}
|
|
- "current_user_drop_campaigns": {"data": {"currentUser": {"dropCampaigns": [...]}}}
|
|
- "inventory_campaigns": {"data": {"currentUser": {"inventory": {"dropCampaignsInProgress": [...]}}}}
|
|
- "channel_viewer_campaigns": {"data": {"channel": {"viewerDropCampaigns": [...] or {...}}}}
|
|
|
|
Args:
|
|
response: The parsed JSON response from Twitch API.
|
|
|
|
Returns:
|
|
String identifier of the structure type, or None if no campaign structure found.
|
|
"""
|
|
if not isinstance(response, dict) or "data" not in response:
|
|
return None
|
|
|
|
data: dict[str, Any] = response["data"]
|
|
|
|
# Check structures in order of specificity
|
|
# Structure: {"data": {"user": {"dropCampaign": {...}}}}
|
|
if (
|
|
"user" in data
|
|
and isinstance(data["user"], dict)
|
|
and "dropCampaign" in data["user"]
|
|
and data["user"]["dropCampaign"]
|
|
):
|
|
return "user_drop_campaign"
|
|
|
|
# Structure: {"data": {"currentUser": {...}}}
|
|
if "currentUser" in data and isinstance(data["currentUser"], dict):
|
|
current_user: dict[str, Any] = data["currentUser"]
|
|
|
|
# Structure: {"data": {"currentUser": {"inventory": {"dropCampaignsInProgress": [...]}}}}
|
|
if (
|
|
"inventory" in current_user
|
|
and isinstance(current_user["inventory"], dict)
|
|
and "dropCampaignsInProgress" in current_user["inventory"]
|
|
and current_user["inventory"]["dropCampaignsInProgress"]
|
|
):
|
|
return "inventory_campaigns"
|
|
|
|
# Structure: {"data": {"currentUser": {"dropCampaigns": [...]}}}
|
|
if "dropCampaigns" in current_user and isinstance(current_user["dropCampaigns"], list):
|
|
return "current_user_drop_campaigns"
|
|
|
|
# Structure: {"data": {"channel": {"viewerDropCampaigns": [...] or {...}}}}
|
|
if "channel" in data and isinstance(data["channel"], dict):
|
|
channel: dict[str, Any] = data["channel"]
|
|
if channel.get("viewerDropCampaigns"):
|
|
return "channel_viewer_campaigns"
|
|
|
|
return None
|
|
|
|
def collect_json_files(
|
|
self,
|
|
options: dict,
|
|
input_path: Path,
|
|
) -> list[Path]:
|
|
"""Collect JSON files from the specified directory.
|
|
|
|
Args:
|
|
options: Command options
|
|
input_path: Path to the directory
|
|
|
|
Returns:
|
|
List of JSON file paths
|
|
"""
|
|
json_files: list[Path] = []
|
|
if options["recursive"]:
|
|
for root, _dirs, files in os.walk(input_path):
|
|
root_path = Path(root)
|
|
json_files.extend(root_path / file for file in files if file.endswith(".json"))
|
|
else:
|
|
json_files = [f for f in input_path.iterdir() if f.is_file() and f.suffix == ".json"]
|
|
return json_files
|
|
|
|
def process_file_worker(
|
|
self,
|
|
file_path: Path,
|
|
options: dict,
|
|
) -> dict[str, bool | str]:
|
|
"""Worker function for processing files.
|
|
|
|
Args:
|
|
file_path: Path to the JSON file to process
|
|
options: Command options
|
|
|
|
Raises:
|
|
ValidationError: If the JSON file fails validation
|
|
json.JSONDecodeError: If the JSON file cannot be parsed
|
|
|
|
Returns:
|
|
Dict with success status and optional broken_dir path
|
|
"""
|
|
try:
|
|
raw_text: str = file_path.read_text(encoding="utf-8", errors="ignore")
|
|
|
|
# Parse JSON early to extract operation name for better directory organization
|
|
parsed_json: dict[str, Any] = json.loads(raw_text)
|
|
operation_name: str | None = extract_operation_name_from_parsed(parsed_json)
|
|
|
|
matched: str | None = detect_non_campaign_keyword(raw_text)
|
|
if matched:
|
|
if not options.get("skip_broken_moves"):
|
|
broken_dir: Path | None = move_file_to_broken_subdir(
|
|
file_path,
|
|
matched,
|
|
operation_name=operation_name,
|
|
)
|
|
return {"success": False, "broken_dir": str(broken_dir), "reason": f"matched '{matched}'"}
|
|
return {"success": False, "broken_dir": "(skipped)", "reason": f"matched '{matched}'"}
|
|
if "dropCampaign" not in raw_text:
|
|
if not options.get("skip_broken_moves"):
|
|
broken_dir: Path | None = move_file_to_broken_subdir(
|
|
file_path,
|
|
"no_dropCampaign",
|
|
operation_name=operation_name,
|
|
)
|
|
return {"success": False, "broken_dir": str(broken_dir), "reason": "no dropCampaign present"}
|
|
return {"success": False, "broken_dir": "(skipped)", "reason": "no dropCampaign present"}
|
|
|
|
# Wrap single response in list for consistent processing
|
|
responses: list[dict[str, Any]] = parsed_json if isinstance(parsed_json, list) else [parsed_json]
|
|
processed, broken_dir = self.process_responses(
|
|
responses=responses,
|
|
file_path=file_path,
|
|
options=options,
|
|
)
|
|
|
|
if not processed:
|
|
# File was already moved to broken during validation
|
|
return {
|
|
"success": False,
|
|
"broken_dir": str(broken_dir) if broken_dir else "(unknown)",
|
|
"reason": "validation failed",
|
|
}
|
|
|
|
campaign_structure: str | None = self._detect_campaign_structure(
|
|
parsed_json if isinstance(parsed_json, dict) else (parsed_json[0] if parsed_json else {}),
|
|
)
|
|
move_completed_file(
|
|
file_path=file_path,
|
|
operation_name=operation_name,
|
|
campaign_structure=campaign_structure,
|
|
)
|
|
|
|
except (ValidationError, json.JSONDecodeError):
|
|
if options["crash_on_error"]:
|
|
raise
|
|
|
|
if not options.get("skip_broken_moves"):
|
|
parsed_json_local: Any | None = locals().get("parsed_json")
|
|
op_name: str | None = (
|
|
extract_operation_name_from_parsed(parsed_json_local)
|
|
if isinstance(parsed_json_local, (dict, list))
|
|
else None
|
|
)
|
|
broken_dir = move_failed_validation_file(file_path, operation_name=op_name)
|
|
return {"success": False, "broken_dir": str(broken_dir)}
|
|
return {"success": False, "broken_dir": "(skipped)"}
|
|
else:
|
|
return {"success": True}
|
|
|
|
def process_file(self, file_path: Path, options: dict) -> None:
|
|
"""Reads a JSON file and processes the campaign data.
|
|
|
|
Args:
|
|
file_path: Path to the JSON file
|
|
options: Command options
|
|
|
|
Raises:
|
|
ValidationError: If the JSON file fails validation
|
|
json.JSONDecodeError: If the JSON file cannot be parsed
|
|
"""
|
|
with tqdm(
|
|
total=1,
|
|
desc=f"Processing {file_path.name}",
|
|
unit="file",
|
|
colour="green",
|
|
dynamic_ncols=True,
|
|
) as progress_bar:
|
|
try:
|
|
raw_text: str = file_path.read_text(encoding="utf-8", errors="ignore")
|
|
|
|
# Parse JSON early to extract operation name for better directory organization
|
|
parsed_json: dict[str, Any] = json.loads(raw_text)
|
|
operation_name: str | None = extract_operation_name_from_parsed(parsed_json)
|
|
|
|
matched: str | None = detect_non_campaign_keyword(raw_text)
|
|
if matched:
|
|
if not options.get("skip_broken_moves"):
|
|
broken_dir: Path | None = move_file_to_broken_subdir(
|
|
file_path,
|
|
matched,
|
|
operation_name=operation_name,
|
|
)
|
|
progress_bar.write(
|
|
f"{Fore.RED}✗{Style.RESET_ALL} {file_path.name} → "
|
|
f"{broken_dir}/{file_path.name} "
|
|
f"(matched '{matched}')",
|
|
)
|
|
else:
|
|
progress_bar.write(
|
|
f"{Fore.RED}✗{Style.RESET_ALL} {file_path.name} (matched '{matched}', move skipped)",
|
|
)
|
|
return
|
|
|
|
if "dropCampaign" not in raw_text:
|
|
if not options.get("skip_broken_moves"):
|
|
broken_dir = move_file_to_broken_subdir(
|
|
file_path,
|
|
"no_dropCampaign",
|
|
operation_name=operation_name,
|
|
)
|
|
progress_bar.write(
|
|
f"{Fore.RED}✗{Style.RESET_ALL} {file_path.name} → "
|
|
f"{broken_dir}/{file_path.name} "
|
|
f"(no dropCampaign present)",
|
|
)
|
|
else:
|
|
progress_bar.write(
|
|
f"{Fore.RED}✗{Style.RESET_ALL} {file_path.name} (no dropCampaign present, move skipped)",
|
|
)
|
|
return
|
|
|
|
# Wrap single response in list for consistent processing
|
|
responses: list[dict[str, Any]] = parsed_json if isinstance(parsed_json, list) else [parsed_json]
|
|
|
|
processed, broken_dir = self.process_responses(
|
|
responses=responses,
|
|
file_path=file_path,
|
|
options=options,
|
|
)
|
|
|
|
if not processed:
|
|
# File already moved during validation; nothing more to do here.
|
|
progress_bar.write(
|
|
f"{Fore.RED}✗{Style.RESET_ALL} {file_path.name} → "
|
|
f"{broken_dir}/{file_path.name} (validation failed)",
|
|
)
|
|
return
|
|
|
|
campaign_structure: str | None = self._detect_campaign_structure(
|
|
parsed_json if isinstance(parsed_json, dict) else (parsed_json[0] if parsed_json else {}),
|
|
)
|
|
move_completed_file(
|
|
file_path=file_path,
|
|
operation_name=operation_name,
|
|
campaign_structure=campaign_structure,
|
|
)
|
|
|
|
progress_bar.update(1)
|
|
progress_bar.write(f"{Fore.GREEN}✓{Style.RESET_ALL} {file_path.name}")
|
|
except (ValidationError, json.JSONDecodeError):
|
|
if options["crash_on_error"]:
|
|
raise
|
|
|
|
if not options.get("skip_broken_moves"):
|
|
parsed_json_local: Any | None = locals().get("parsed_json")
|
|
op_name: str | None = (
|
|
extract_operation_name_from_parsed(parsed_json_local)
|
|
if isinstance(parsed_json_local, (dict, list))
|
|
else None
|
|
)
|
|
broken_dir = move_failed_validation_file(file_path, operation_name=op_name)
|
|
progress_bar.write(f"{Fore.RED}✗{Style.RESET_ALL} {file_path.name} → {broken_dir}/{file_path.name}")
|
|
else:
|
|
progress_bar.write(f"{Fore.RED}✗{Style.RESET_ALL} {file_path.name} (move skipped)")
|