aa-killtracker 0.17.0__tar.gz → 0.18.0a2__tar.gz

{aa_killtracker-0.17.0 → aa_killtracker-0.18.0a2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aa-killtracker
-Version: 0.17.0
+Version: 0.18.0a2
 Summary: An app for running killmail trackers with Alliance Auth and Discord.
 Author-email: Erik Kalkoken <kalkoken87@gmail.com>
 Requires-Python: >=3.8

{aa_killtracker-0.17.0 → aa_killtracker-0.18.0a2}/killtracker/__init__.py

@@ -3,7 +3,7 @@
 # pylint: disable = invalid-name
 default_app_config = "killtracker.apps.KillmailsConfig"
 
-__version__ = "0.17.0"
+__version__ = "0.18.0a2"
 __title__ = "Killtracker"
 
 APP_NAME = "aa-killtracker"

{aa_killtracker-0.17.0 → aa_killtracker-0.18.0a2}/killtracker/admin.py

@@ -4,16 +4,21 @@
 
 
 from django.contrib import admin
+from django.db.models import QuerySet
 from django.http import HttpResponseRedirect
 from django.shortcuts import render
 from django.utils.safestring import mark_safe
 
 from allianceauth import NAME as site_header
 
-from . import tasks
-from .core.killmails import Killmail
-from .forms import TrackerAdminForm, TrackerAdminKillmailIdForm, field_nice_display
-from .models import EveKillmail, EveKillmailAttacker, Tracker, Webhook
+from killtracker import tasks
+from killtracker.core.killmails import Killmail
+from killtracker.forms import (
+    TrackerAdminForm,
+    TrackerAdminKillmailIdForm,
+    field_nice_display,
+)
+from killtracker.models import EveKillmail, EveKillmailAttacker, Tracker, Webhook
 
 
 class EveKillmailAttackerInline(admin.TabularInline):
@@ -46,17 +51,17 @@ class WebhookAdmin(admin.ModelAdmin):
     list_filter = ("is_enabled",)
     ordering = ("name",)
 
-    def _messages_in_queue(self, obj):
-        return obj.main_queue.size()
+    def _messages_in_queue(self, obj: Webhook):
+        return obj.messages_queued()
 
     actions = ["send_test_message", "purge_messages"]
 
     @admin.display(description="Purge queued messages of selected webhooks")
-    def purge_messages(self, request, queryset):
+    def purge_messages(self, request, queryset: QuerySet[Webhook]):
         actions_count = 0
         killmails_deleted = 0
         for webhook in queryset:
-            killmails_deleted += webhook.main_queue.clear()
+            killmails_deleted += webhook.delete_queued_messages()
             actions_count += 1
         self.message_user(
             request,

{aa_killtracker-0.17.0 → aa_killtracker-0.18.0a2}/killtracker/app_settings.py

@@ -6,7 +6,7 @@ KILLTRACKER_REDISQ_LOCK_TIMEOUT = clean_setting("KILLTRACKER_REDISQ_LOCK_TIMEOUT
 """Timeout for lock to ensure atomic access to ZKB RedisQ."""
 
 KILLTRACKER_KILLMAIL_MAX_AGE_FOR_TRACKER = clean_setting(
-    "KILLTRACKER_KILLMAIL_MAX_AGE_FOR_TRACKER", 60
+    "KILLTRACKER_KILLMAIL_MAX_AGE_FOR_TRACKER", 600
 )
 """Ignore killmails that are older than the given number in minutes
 sometimes killmails appear belated on ZKB,
@@ -14,7 +14,7 @@ this feature ensures they don't create new alerts.
 """
 
 KILLTRACKER_MAX_KILLMAILS_PER_RUN = clean_setting(
-    "KILLTRACKER_MAX_KILLMAILS_PER_RUN", 100
+    "KILLTRACKER_MAX_KILLMAILS_PER_RUN", 500
 )
 """Maximum number of killmails retrieved from ZKB by task run."""
 
@@ -62,11 +62,14 @@ when creating trackers.
 #####################
 # INTERNAL SETTINGS
 
-KILLTRACKER_REDISQ_TTW = clean_setting("KILLTRACKER_REDISQ_TTW", 5)
+KILLTRACKER_REDISQ_TTW = clean_setting("KILLTRACKER_REDISQ_TTW", 1)
 """Max duration to wait for new killmails from redisq in seconds."""
 
 KILLTRACKER_TASKS_TIMEOUT = clean_setting("KILLTRACKER_TASKS_TIMEOUT", 1_800)
-"""Tasks hard timeout."""
+"""Tasks hard timeout in seconds."""
+
+KILLTRACKER_RUN_TIMEOUT = clean_setting("KILLTRACKER_RUN_TIMEOUT", 55)
+"""Timeout for killtracker run in seconds."""
 
 KILLTRACKER_DISCORD_SEND_DELAY = clean_setting(
     "KILLTRACKER_DISCORD_SEND_DELAY", default_value=2, min_value=1, max_value=900

{aa_killtracker-0.17.0 → aa_killtracker-0.18.0a2}/killtracker/apps.py

@@ -9,7 +9,5 @@ class KillmailsConfig(AppConfig):
     verbose_name = f"Killtracker v{__version__}"
 
     def ready(self) -> None:
-        from . import checks  # noqa: F401 pylint: disable=unused-import
-        from .core.killmails import Killmail
-
-        Killmail.reset_lock_key()
+        import killtracker.checks  # noqa: F401 pylint: disable=unused-import
+        import killtracker.signals  # noqa: F401 pylint: disable=unused-import

{aa_killtracker-0.17.0 → aa_killtracker-0.18.0a2}/killtracker/core/discord_messages.py

@@ -1,6 +1,11 @@
-"""Create discord messages from killmails."""
+"""This module allows to create Discord messages from killmails."""
 
-from typing import NamedTuple, Optional
+from __future__ import annotations
+
+import json
+from copy import copy
+from dataclasses import dataclass
+from typing import TYPE_CHECKING, List, Optional
 
 import dhooks_lite
 from requests.exceptions import HTTPError
@@ -11,38 +16,116 @@ from eveuniverse.models import EveEntity, EveSolarSystem
 from allianceauth.eveonline.evelinks import dotlan, eveimageserver, zkillboard
 from allianceauth.services.hooks import get_extension_logger
 from app_utils.django import app_labels
+from app_utils.json import JSONDateTimeDecoder, JSONDateTimeEncoder
 from app_utils.logging import LoggerAddTag
 from app_utils.urls import static_file_absolute_url
 from app_utils.views import humanize_value
 
 from killtracker import __title__
-from killtracker.models import Tracker
 
 from .killmails import ZKB_KILLMAIL_BASEURL, Killmail, TrackerInfo
 
-ICON_SIZE = 128
+if TYPE_CHECKING:
+    from killtracker.models import Tracker
+
+
+_ICON_SIZE = 128
 
 
 logger = LoggerAddTag(get_extension_logger(__name__), __title__)
 
 
-class MainOrgInfo(NamedTuple):
+@dataclass
+class DiscordMessage:
+    """A Discord message created from a Killmail."""
+
+    avatar_url: Optional[str] = None
+    content: Optional[str] = None
+    embeds: Optional[List[dhooks_lite.Embed]] = None
+    killmail_id: int = 0  # Killmail ID this message from created from
+    tts: Optional[bool] = None
+    username: Optional[str] = None
+
+    def __post_init__(self):
+        if not self.content and not self.embeds:
+            raise ValueError("Message must have content or embeds to be valid")
+
+    def to_json(self) -> str:
+        """Converts a Discord message into a JSON object and returns it."""
+
+        if self.embeds:
+            embeds_list = [obj.asdict() for obj in self.embeds]
+        else:
+            embeds_list = None
+
+        message = {}
+        if self.killmail_id:
+            message["killmail_id"] = self.killmail_id
+        if self.content:
+            message["content"] = self.content
+        if embeds_list:
+            message["embeds"] = embeds_list
+        if self.tts:
+            message["tts"] = self.tts
+        if self.username:
+            message["username"] = self.username
+        if self.avatar_url:
+            message["avatar_url"] = self.avatar_url
+
+        return json.dumps(message, cls=JSONDateTimeEncoder)
+
+    @classmethod
+    def from_json(cls, s: str) -> "DiscordMessage":
+        """Creates a DiscordMessage object from an JSON object and returns it."""
+        message1: dict = json.loads(s, cls=JSONDateTimeDecoder)
+        message2 = copy(message1)
+        if message1.get("embeds"):
+            message2["embeds"] = [
+                dhooks_lite.Embed.from_dict(embed_dict)
+                for embed_dict in message1.get("embeds")
+            ]
+        else:
+            message2["embeds"] = None
+        return cls(**message2)
+
+    @classmethod
+    def from_killmail(
+        cls, tracker: Tracker, killmail: Killmail, intro_text: Optional[str] = None
+    ) -> "DiscordMessage":
+        """Creates a DiscordMessage object from a Killmail and returns it."""
+        m = DiscordMessage(
+            killmail_id=killmail.id,
+            content=_create_content(tracker, intro_text),
+            embeds=[_create_embed(tracker, killmail)],
+        )
+        return m
+
+
+@dataclass(frozen=True)
+class _MainOrgInfo:
     """Infos about a main organization."""
 
-    text: str = ""
+    icon_url: str = ""
     name: str = ""
-    icon_url: str = eveimageserver.alliance_logo_url(1, size=ICON_SIZE)
     show_as_fleet_kill: bool = False
+    text: str = ""
+
+    def __post_init__(self):
+        if self.icon_url == "":
+            icon_url = eveimageserver.alliance_logo_url(1, size=_ICON_SIZE)
+            object.__setattr__(self, "icon_url", icon_url)
 
 
-class FinalAttackerInfo(NamedTuple):
+@dataclass(frozen=True)
+class _FinalAttackerInfo:
     """Infos about the final attacker on a killmail."""
 
     name: str = ""
     ship_type: str = ""
 
 
-class VictimInfo(NamedTuple):
+@dataclass(frozen=True)
+class _VictimInfo:
     """Infos about the victim of a killmail."""
 
     name: str
@@ -53,9 +136,11 @@ class VictimInfo(NamedTuple):
     ship_type_icon_url: str
 
 
-def create_content(tracker: Tracker, intro_text: Optional[str] = None) -> str:
+def _create_content(tracker: Tracker, intro_text: Optional[str] = None) -> str:
     """Create content for Discord message for a killmail."""
 
+    from killtracker.models import Tracker
+
     intro_parts = []
 
     if tracker.ping_type == Tracker.ChannelPingType.EVERYBODY:
@@ -102,7 +187,7 @@ def _import_discord_user():
     return DiscordUser
 
 
-def create_embed(tracker: Tracker, killmail: Killmail) -> dhooks_lite.Embed:
+def _create_embed(tracker: Tracker, killmail: Killmail) -> dhooks_lite.Embed:
     """Create Discord embed for a killmail."""
 
     resolver: EveEntityNameResolver = EveEntity.objects.bulk_resolve_names(  # type: ignore
@@ -111,7 +196,7 @@ def create_embed(tracker: Tracker, killmail: Killmail) -> dhooks_lite.Embed:
 
     # self info
     distance_text = ""
-    main_org = MainOrgInfo()
+    main_org = _MainOrgInfo()
     main_ship_group_text = ""
     tracked_ship_types_text = ""
 
@@ -137,10 +222,24 @@ def create_embed(tracker: Tracker, killmail: Killmail) -> dhooks_lite.Embed:
     title = _calc_title(killmail, resolver, main_org, victim)
     thumbnail_url = _calc_thumbnail_url(victim, main_org)
 
-    return _create_embed(killmail, tracker, victim, description, title, thumbnail_url)
+    author = _calc_author(victim)
+    zkb_icon_url = static_file_absolute_url("killtracker/zkb_icon.png")
+    embed_color = int(tracker.color[1:], 16) if tracker and tracker.color else None
 
+    embed = dhooks_lite.Embed(
+        author=author,
+        description=description,
+        title=title,
+        url=f"{ZKB_KILLMAIL_BASEURL}{killmail.id}/",
+        thumbnail=dhooks_lite.Thumbnail(url=thumbnail_url),
+        footer=dhooks_lite.Footer(text="zKillboard", icon_url=zkb_icon_url),
+        timestamp=killmail.time,
+        color=embed_color,
+    )
+    return embed
 
-def _calc_author(victim: VictimInfo):
+
+def _calc_author(victim: _VictimInfo):
     # TODO This is a workaround for Embed.Author.name. Address in dhooks_lite
     return (
         dhooks_lite.Author(
@@ -158,10 +257,10 @@ def _calc_description(
     killmail: Killmail,
     resolver: EveEntityNameResolver,
     distance_text: str,
-    main_org: MainOrgInfo,
+    main_org: _MainOrgInfo,
     main_ship_group_text: str,
     tracked_ship_types_text: str,
-    victim: VictimInfo,
+    victim: _VictimInfo,
 ):
     solar_system_text = _calc_solar_system(tracker, killmail)
     total_value = (
@@ -186,18 +285,18 @@ def _calc_description(
 
 def _calc_victim(
     tracker: Tracker, killmail: Killmail, resolver: EveEntityNameResolver
-) -> VictimInfo:
+) -> _VictimInfo:
     if killmail.victim.alliance_id:
         victim_organization = resolver.to_name(killmail.victim.alliance_id)
         victim_org_url = zkillboard.alliance_url(killmail.victim.alliance_id)
         victim_org_icon_url = eveimageserver.alliance_logo_url(
-            killmail.victim.alliance_id, size=ICON_SIZE
+            killmail.victim.alliance_id, size=_ICON_SIZE
         )
     elif killmail.victim.corporation_id:
         victim_organization = resolver.to_name(killmail.victim.corporation_id)
         victim_org_url = zkillboard.corporation_url(killmail.victim.corporation_id)
         victim_org_icon_url = eveimageserver.corporation_logo_url(
-            killmail.victim.corporation_id, size=ICON_SIZE
+            killmail.victim.corporation_id, size=_ICON_SIZE
         )
     else:
         victim_organization = ""
@@ -229,12 +328,12 @@ def _calc_victim(
     ship_type = resolver.to_name(ship_type_id) if ship_type_id else ""
 
     ship_type_icon_url = (
-        eveimageserver.type_icon_url(ship_type_id, size=ICON_SIZE)
+        eveimageserver.type_icon_url(ship_type_id, size=_ICON_SIZE)
         if ship_type_id
         else ""
     )
 
-    return VictimInfo(
+    return _VictimInfo(
         organization=victim_organization,
         org_url=victim_org_url,
         org_icon_url=victim_org_icon_url,
@@ -246,7 +345,7 @@ def _calc_victim(
 
 def _calc_final_attacker(
     tracker: Tracker, killmail: Killmail, resolver: EveEntityNameResolver
-) -> FinalAttackerInfo:
+) -> _FinalAttackerInfo:
     for attacker in killmail.attackers:
         if attacker.is_final_blow:
             final_attacker = attacker
@@ -255,7 +354,7 @@ def _calc_final_attacker(
         final_attacker = None
 
     if not final_attacker:
-        return FinalAttackerInfo()
+        return _FinalAttackerInfo()
 
     if final_attacker.corporation_id:
         final_attacker_corporation_zkb_link = _corporation_zkb_link(
@@ -286,7 +385,7 @@ def _calc_final_attacker(
 
     ship_type = resolver.to_name(ship_type_id) if ship_type_id else ""
 
-    return FinalAttackerInfo(name=final_attacker_str, ship_type=ship_type)
+    return _FinalAttackerInfo(name=final_attacker_str, ship_type=ship_type)
 
 
 def _calc_solar_system(tracker: Tracker, killmail: Killmail):
@@ -338,12 +437,12 @@ def _calc_main_group(
         if main_org_entity.is_corporation:
             main_org_link = _corporation_zkb_link(tracker, main_org_entity.id, resolver)
             main_org_icon_url = eveimageserver.corporation_logo_url(
-                main_org_entity.id, size=ICON_SIZE
+                main_org_entity.id, size=_ICON_SIZE
             )
         else:
             main_org_link = _alliance_zkb_link(tracker, main_org_entity.id, resolver)
             main_org_icon_url = eveimageserver.alliance_logo_url(
-                main_org_entity.id, size=ICON_SIZE
+                main_org_entity.id, size=_ICON_SIZE
             )
         main_org_text = f" | Main group: {main_org_link} ({main_org_entity.count})"
         show_as_fleet_kill = tracker.identify_fleets
@@ -351,7 +450,7 @@ def _calc_main_group(
         show_as_fleet_kill = False
         main_org_text = main_org_name = main_org_icon_url = ""
 
-    return MainOrgInfo(
+    return _MainOrgInfo(
         text=main_org_text,
         name=main_org_name,
         icon_url=main_org_icon_url,
@@ -380,7 +479,7 @@ def _calc_tracked_ship_types(
     return f"\nTracked ship types involved: **{ship_types_text}**"
 
 
-def _calc_thumbnail_url(victim: VictimInfo, main_org: MainOrgInfo):
+def _calc_thumbnail_url(victim: _VictimInfo, main_org: _MainOrgInfo):
     if main_org.show_as_fleet_kill:
         return main_org.icon_url
 
@@ -390,8 +489,8 @@ def _calc_thumbnail_url(victim: VictimInfo, main_org: MainOrgInfo):
 def _calc_title(
     killmail: Killmail,
     resolver: EveEntityNameResolver,
-    main_org: MainOrgInfo,
-    victim: VictimInfo,
+    main_org: _MainOrgInfo,
+    victim: _VictimInfo,
 ):
     solar_system_name = (
         resolver.to_name(killmail.solar_system_id) if killmail.solar_system_id else ""
@@ -403,31 +502,6 @@ def _calc_title(
     return f"{solar_system_name} | {victim.ship_type} | Killmail"
 
 
-def _create_embed(
-    killmail: Killmail,
-    tracker: Tracker,
-    victim: VictimInfo,
-    description: str,
-    title: str,
-    thumbnail_url: str,
-):
-    author = _calc_author(victim)
-    zkb_icon_url = static_file_absolute_url("killtracker/zkb_icon.png")
-    embed_color = int(tracker.color[1:], 16) if tracker and tracker.color else None
-
-    embed = dhooks_lite.Embed(
-        author=author,
-        description=description,
-        title=title,
-        url=f"{ZKB_KILLMAIL_BASEURL}{killmail.id}/",
-        thumbnail=dhooks_lite.Thumbnail(url=thumbnail_url),
-        footer=dhooks_lite.Footer(text="zKillboard", icon_url=zkb_icon_url),
-        timestamp=killmail.time,
-        color=embed_color,
-    )
-    return embed
-
-
 def _character_zkb_link(
     tracker: Tracker, entity_id: int, resolver: EveEntityNameResolver
 ) -> str: