import logging import re from typing import TYPE_CHECKING from typing import Literal from django.contrib.humanize.templatetags.humanize import naturaltime from django.contrib.syndication.views import Feed from django.db.models import Prefetch from django.db.models.query import QuerySet from django.urls import reverse from django.utils import feedgenerator from django.utils import timezone from django.utils.html import format_html from django.utils.html import format_html_join from django.utils.safestring import SafeText from twitch.models import Channel from twitch.models import ChatBadge from twitch.models import DropCampaign from twitch.models import Game from twitch.models import Organization from twitch.models import RewardCampaign from twitch.models import TimeBasedDrop if TYPE_CHECKING: import datetime from django.db.models import Model from django.db.models import QuerySet from django.http import HttpRequest from django.http import HttpResponse from django.utils.safestring import SafeString from twitch.models import DropBenefit logger: logging.Logger = logging.getLogger("ttvdrops") def _with_campaign_related(queryset: QuerySet[DropCampaign]) -> QuerySet[DropCampaign]: """Apply related-selects/prefetches needed by feed rendering to avoid N+1 queries. Returns: QuerySet[DropCampaign]: Queryset with related data preloaded for feed rendering. """ drops_prefetch: Prefetch = Prefetch( "time_based_drops", queryset=TimeBasedDrop.objects.prefetch_related("benefits"), ) return queryset.select_related("game").prefetch_related( "game__owners", Prefetch( "allow_channels", queryset=Channel.objects.order_by("display_name"), to_attr="channels_ordered", ), drops_prefetch, ) def insert_date_info(item: Model, parts: list[SafeText]) -> None: """Insert start and end date information into parts list. Args: item (Model): The campaign item containing start_at and end_at. parts (list[SafeText]): The list of HTML parts to append to. """ end_at: datetime.datetime | None = getattr(item, "end_at", None) start_at: datetime.datetime | None = getattr(item, "start_at", None) if start_at or end_at: start_part: SafeString = ( format_html( "Starts: {} ({})", start_at.strftime("%Y-%m-%d %H:%M %Z"), naturaltime(start_at), ) if start_at else SafeText("") ) end_part: SafeString = ( format_html( "Ends: {} ({})", end_at.strftime("%Y-%m-%d %H:%M %Z"), naturaltime(end_at), ) if end_at else SafeText("") ) # Start date and end date separated by a line break if both present if start_part and end_part: parts.append(format_html("
{}
{}
{}
", start_part)) elif end_part: parts.append(format_html("{}
", end_part)) def _build_drops_data(drops_qs: QuerySet[TimeBasedDrop]) -> list[dict]: """Build a simplified data structure for rendering drops in a template. Returns: list[dict]: A list of dictionaries each containing `name`, `benefits`, `requirements`, and `period` for a drop, suitable for template rendering. """ drops_data: list[dict] = [] for drop in drops_qs: requirements: str = "" required_minutes: int | None = getattr(drop, "required_minutes_watched", None) required_subs: int = getattr(drop, "required_subs", 0) or 0 if required_minutes: requirements = f"{required_minutes} minutes watched" if required_subs > 0: sub_word: Literal["subs", "sub"] = "subs" if required_subs > 1 else "sub" if requirements: requirements += f" and {required_subs} {sub_word} required" else: requirements = f"{required_subs} {sub_word} required" period: str = "" drop_start: datetime.datetime | None = getattr(drop, "start_at", None) drop_end: datetime.datetime | None = getattr(drop, "end_at", None) if drop_start is not None: period += drop_start.strftime("%Y-%m-%d %H:%M %Z") if drop_end is not None: if period: period += " - " + drop_end.strftime("%Y-%m-%d %H:%M %Z") else: period = drop_end.strftime("%Y-%m-%d %H:%M %Z") drops_data.append({ "name": getattr(drop, "name", str(drop)), "benefits": list(drop.benefits.all()), "requirements": requirements, "period": period, }) return drops_data def _build_channels_html( channels: list[Channel] | QuerySet[Channel], game: Game | None, ) -> SafeText: """Render up to max_links channel links as{game_name} has been added to ttvdrops.lovinator.space!\nOwned by {game_owner}.\n\n" f"[Details] " f"[Twitch] " f"[RSS feed]\n
", ), ) return SafeText("".join(str(part) for part in description_parts)) def item_link(self, item: Game) -> str: """Return the link to the game detail.""" return reverse("twitch:game_detail", args=[item.twitch_id]) def item_pubdate(self, item: Game) -> datetime.datetime: """Returns the publication date to the feed item. Fallback to added_at or now if missing. """ added_at: datetime.datetime | None = getattr(item, "added_at", None) if added_at: return added_at return timezone.now() def item_updateddate(self, item: Game) -> datetime.datetime: """Returns the game's last update time.""" updated_at: datetime.datetime | None = getattr(item, "updated_at", None) if updated_at: return updated_at return timezone.now() def item_guid(self, item: Game) -> str: """Return a unique identifier for each game.""" twitch_id: str = getattr(item, "twitch_id", "unknown") return twitch_id + "@ttvdrops.com" def item_author_name(self, item: Game) -> str: """Return the author name for the game, typically the owner organization name.""" owner: Organization | None = item.owners.first() if owner and owner.name: return owner.name return "Twitch" def item_enclosure_url(self, item: Game) -> str: """Returns the URL of the game's box art for enclosure.""" box_art: str = item.box_art_best_url if box_art: return box_art return "" def item_enclosure_length(self, item: Game) -> int: """Returns the length of the enclosure. Prefer the newly-added ``box_art_size_bytes`` field so that the RSS feed can include an accurate ``length`` attribute. Fall back to 0 if the value is missing or ``None``. """ try: size = getattr(item, "box_art_size_bytes", None) return int(size) if size is not None else 0 except TypeError, ValueError: return 0 def item_enclosure_mime_type(self, item: Game) -> str: """Returns the MIME type of the enclosure. Use the ``box_art_mime_type`` field when available, otherwise fall back to a generic JPEG string (as was previously hard-coded). """ mime: str = getattr(item, "box_art_mime_type", "") return mime or "image/jpeg" # MARK: /rss/campaigns/ class DropCampaignFeed(Feed): """RSS feed for latest drop campaigns.""" title: str = "Twitch Drop Campaigns" link: str = "/campaigns/" description: str = "Latest Twitch drop campaigns on TTVDrops" feed_url: str = "/rss/campaigns/" feed_copyright: str = "Information wants to be free." _limit: int | None = None def __call__( self, request: HttpRequest, *args: object, **kwargs: object, ) -> HttpResponse: """Override to capture limit parameter from request. Args: request (HttpRequest): The incoming HTTP request, potentially containing a 'limit' query parameter. *args: Additional positional arguments. **kwargs: Additional keyword arguments. Returns: HttpResponse: The HTTP response generated by the parent Feed class after processing the request. """ if request.GET.get("limit"): try: self._limit = int(request.GET.get("limit", 200)) except ValueError, TypeError: self._limit = None return super().__call__(request, *args, **kwargs) def items(self) -> list[DropCampaign]: """Return the latest drop campaigns ordered by most recent start date (default 200, or limited by ?limit query param).""" limit: int = self._limit if self._limit is not None else 200 queryset: QuerySet[DropCampaign] = DropCampaign.objects.order_by("-start_at") return list(_with_campaign_related(queryset)[:limit]) def item_title(self, item: DropCampaign) -> SafeText: """Return the campaign name as the item title (SafeText for RSS).""" return SafeText(item.get_feed_title()) def item_description(self, item: DropCampaign) -> SafeText: """Return a description of the campaign.""" drops_data: list[dict] = [] channels: list[Channel] | None = getattr(item, "channels_ordered", None) channel_name: str | None = channels[0].name if channels else None drops: QuerySet[TimeBasedDrop] | None = getattr(item, "time_based_drops", None) if drops: drops_data = _build_drops_data(drops.all()) parts: list[SafeText] = [] image_url: str | None = getattr(item, "image_url", None) if image_url: item_name: str = getattr(item, "name", str(object=item)) parts.append( format_html( '{}
", desc_text)) # Insert start and end date info insert_date_info(item, parts) if drops_data: parts.append( format_html( "{}
", _construct_drops_summary(drops_data, channel_name=channel_name), ), ) # Only show channels if drop is not subscription only if not getattr(item, "is_subscription_only", False) and channels is not None: game: Game | None = getattr(item, "game", None) parts.append(_build_channels_html(channels, game=game)) details_url: str | None = getattr(item, "details_url", None) if details_url: parts.append(format_html('About', details_url)) return SafeText("".join(str(p) for p in parts)) def item_link(self, item: DropCampaign) -> str: """Return the link to the campaign detail.""" return item.get_feed_link() def item_pubdate(self, item: DropCampaign) -> datetime.datetime: """Returns the publication date to the feed item. Fallback to updated_at or now if missing. """ return item.get_feed_pubdate() def item_updateddate(self, item: DropCampaign) -> datetime.datetime: """Returns the campaign's last update time.""" return item.updated_at def item_categories(self, item: DropCampaign) -> tuple[str, ...]: """Returns the associated game's name as a category.""" return item.get_feed_categories() def item_guid(self, item: DropCampaign) -> str: """Return a unique identifier for each campaign.""" return item.get_feed_guid() def item_author_name(self, item: DropCampaign) -> str: """Return the author name for the campaign, typically the game name.""" return item.get_feed_author_name() def item_enclosure_url(self, item: DropCampaign) -> str: """Returns the URL of the campaign image for enclosure.""" return item.get_feed_enclosure_url() def item_enclosure_length(self, item: DropCampaign) -> int: """Returns the length of the enclosure. Reads the `image_size_bytes` field added to the model. If the field is unset it returns `0` to match previous behavior. """ try: size = getattr(item, "image_size_bytes", None) return int(size) if size is not None else 0 except TypeError, ValueError: return 0 def item_enclosure_mime_type(self, item: DropCampaign) -> str: """Returns the MIME type of the enclosure. Uses `image_mime_type` on the campaign if set, falling back to the previous hard-coded `image/jpeg`. """ mime: str = getattr(item, "image_mime_type", "") return mime or "image/jpeg" # MARK: /rss/games/{}
", desc_text)) # Insert start and end date info insert_date_info(item, parts) if drops_data: parts.append( format_html( "{}
", _construct_drops_summary(drops_data, channel_name=channel_name), ), ) # Only show channels if drop is not subscription only if not getattr(item, "is_subscription_only", False) and channels is not None: game: Game | None = getattr(item, "game", None) parts.append(_build_channels_html(channels, game=game)) details_url: str | None = getattr(item, "details_url", None) if details_url: parts.append(format_html('About', details_url)) account_link_url: str | None = getattr(item, "account_link_url", None) if account_link_url: parts.append( format_html(' | Link Account', account_link_url), ) return SafeText("".join(str(p) for p in parts)) def item_pubdate(self, item: DropCampaign) -> datetime.datetime: """Returns the publication date to the feed item. Uses start_at (when the drop starts). Fallback to added_at or now if missing. """ if isinstance(item, DropCampaign): if item.start_at: return item.start_at if item.added_at: return item.added_at return timezone.now() def item_updateddate(self, item: DropCampaign) -> datetime.datetime: """Returns the campaign's last update time.""" return item.updated_at def item_categories(self, item: DropCampaign) -> tuple[str, ...]: """Returns the associated game's name as a category.""" return item.get_feed_categories() def item_guid(self, item: DropCampaign) -> str: """Return a unique identifier for each campaign.""" return item.get_feed_guid() def item_author_name(self, item: DropCampaign) -> str: """Return the author name for the campaign, typically the game name.""" return item.get_feed_author_name() def item_enclosure_url(self, item: DropCampaign) -> str: """Returns the URL of the campaign image for enclosure.""" return item.get_feed_enclosure_url() def item_enclosure_length(self, item: DropCampaign) -> int: """Returns the length of the enclosure. Reads the ``image_size_bytes`` field added to the model when rendering a game-specific campaign feed. """ try: size = getattr(item, "image_size_bytes", None) return int(size) if size is not None else 0 except TypeError, ValueError: return 0 def item_enclosure_mime_type(self, item: DropCampaign) -> str: """Returns the MIME type of the enclosure. Prefers `image_mime_type` on the campaign object; falls back to `image/jpeg` when not available. """ mime: str = getattr(item, "image_mime_type", "") return mime or "image/jpeg" # MARK: /rss/reward-campaigns/ class RewardCampaignFeed(Feed): """RSS feed for latest reward campaigns (Quest rewards).""" title: str = "Twitch Reward Campaigns (Quest Rewards)" link: str = "/campaigns/" description: str = "Latest Twitch reward campaigns (Quest rewards) on TTVDrops" feed_url: str = "/rss/reward-campaigns/" feed_copyright: str = "Information wants to be free." _limit: int | None = None def __call__( self, request: HttpRequest, *args: object, **kwargs: object, ) -> HttpResponse: """Override to capture limit parameter from request. Args: request (HttpRequest): The incoming HTTP request, potentially containing a 'limit' query parameter. *args: Additional positional arguments. **kwargs: Additional keyword arguments. Returns: HttpResponse: The HTTP response generated by the parent Feed class after processing the request. """ if request.GET.get("limit"): try: self._limit = int(request.GET.get("limit", 200)) except ValueError, TypeError: self._limit = None return super().__call__(request, *args, **kwargs) def items(self) -> list[RewardCampaign]: """Return the latest reward campaigns (default 200, or limited by ?limit query param).""" limit: int = self._limit if self._limit is not None else 200 return list( RewardCampaign.objects.select_related("game").order_by("-added_at")[:limit], ) def item_title(self, item: RewardCampaign) -> SafeText: """Return the reward campaign name as the item title.""" return SafeText(item.get_feed_title()) def item_description(self, item: RewardCampaign) -> SafeText: """Return a description of the reward campaign.""" return SafeText(item.get_feed_description()) def item_link(self, item: RewardCampaign) -> str: """Return the link to the reward campaign (external URL or dashboard).""" return item.get_feed_link() def item_pubdate(self, item: RewardCampaign) -> datetime.datetime: """Returns the publication date to the feed item. Uses starts_at (when the reward starts). Fallback to added_at or now if missing. """ return item.get_feed_pubdate() def item_updateddate(self, item: RewardCampaign) -> datetime.datetime: """Returns the reward campaign's last update time.""" return item.updated_at def item_categories(self, item: RewardCampaign) -> tuple[str, ...]: """Returns the associated game's name and brand as categories.""" return item.get_feed_categories() def item_guid(self, item: RewardCampaign) -> str: """Return a unique identifier for each reward campaign.""" return item.get_feed_guid() def item_author_name(self, item: RewardCampaign) -> str: """Return the author name for the reward campaign.""" return item.get_feed_author_name() # Atom feed variants: reuse existing logic but switch the feed generator to Atom class OrganizationAtomFeed(OrganizationRSSFeed): """Atom feed for latest organizations (reuses OrganizationRSSFeed).""" feed_type = feedgenerator.Atom1Feed class GameAtomFeed(GameFeed): """Atom feed for newly added games (reuses GameFeed).""" feed_type = feedgenerator.Atom1Feed class DropCampaignAtomFeed(DropCampaignFeed): """Atom feed for latest drop campaigns (reuses DropCampaignFeed).""" feed_type = feedgenerator.Atom1Feed class GameCampaignAtomFeed(GameCampaignFeed): """Atom feed for latest drop campaigns for a specific game (reuses GameCampaignFeed).""" feed_type = feedgenerator.Atom1Feed class RewardCampaignAtomFeed(RewardCampaignFeed): """Atom feed for latest reward campaigns (reuses RewardCampaignFeed).""" feed_type = feedgenerator.Atom1Feed