aa-killtracker 0.17.0__py3-none-any.whl → 1.0.0__py3-none-any.whl

{aa_killtracker-0.17.0.dist-info → aa_killtracker-1.0.0.dist-info}/METADATA

@@ -1,13 +1,12 @@
 Metadata-Version: 2.4
 Name: aa-killtracker
-Version: 0.17.0
+Version: 1.0.0
 Summary: An app for running killmail trackers with Alliance Auth and Discord.
 Author-email: Erik Kalkoken <kalkoken87@gmail.com>
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 Classifier: Environment :: Web Environment
 Classifier: Framework :: Django
-Classifier: Framework :: Django :: 4.0
 Classifier: Framework :: Django :: 4.2
 Classifier: Intended Audience :: End Users/Desktop
 Classifier: License :: OSI Approved :: MIT License
@@ -17,15 +16,16 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
 License-File: LICENSE
-Requires-Dist: allianceauth-app-utils>=1.19.0
-Requires-Dist: allianceauth>=3
+Requires-Dist: allianceauth-app-utils>=1.26
+Requires-Dist: allianceauth>=4,<5
 Requires-Dist: dacite
-Requires-Dist: dhooks-lite>=1.0
-Requires-Dist: django-eveuniverse>=1.3
-Requires-Dist: redis-simple-mq>=0.5
+Requires-Dist: dhooks-lite>=1.1
+Requires-Dist: django-eveuniverse>=1.5
+Requires-Dist: redis-simple-mq>=1.0
 Project-URL: Home, https://gitlab.com/ErikKalkoken/aa-killtracker
 
 # Killtracker
@@ -242,7 +242,6 @@ Note that all settings are optional and the app will use the documented default
 Name | Description | Default
 -- | -- | --
 `KILLTRACKER_KILLMAIL_MAX_AGE_FOR_TRACKER`| Ignore killmails that are older than the given number in minutes. Sometimes killmails appear belated on ZKB, this feature ensures they don't create new alerts | `60`
-`KILLTRACKER_MAX_KILLMAILS_PER_RUN`| Maximum number of killmails retrieved from ZKB by task run. This value should be set such that the task that fetches new killmails from ZKB every minute will reliable finish within one minute. To test this run a "Catch all" tracker and see how many killmails your system is capable of processing. Note that you can get that information from the worker's log file. It will look something like this: `Total killmails received from ZKB in 49 secs: 100`   | `100`
 `KILLTRACKER_PURGE_KILLMAILS_AFTER_DAYS`| Killmails older than set number of days will be purged from the database. If you want to keep all killmails set this to 0. Note that this setting is only relevant if you have storing killmails enabled.  | `30`
 `KILLTRACKER_QUEUE_ID`| Unique ID used to identify this server when fetching killmails from zKillboard. This setting is mandatory.  | ``
 `KILLTRACKER_STORING_KILLMAILS_ENABLED`| If set to true Killtracker will automatically store all received killmails in the local database. This can be useful if you want to run analytics on killmails etc. However, please note that Killtracker itself currently does not use stored killmails in any way.  | `False`

{aa_killtracker-0.17.0.dist-info → aa_killtracker-1.0.0.dist-info}/RECORD

@@ -1,17 +1,20 @@
-killtracker/__init__.py,sha256=g8DgOYglXz6Q4YuXHKdw2HdUBMexl4BSn7RbdC-hnGo,355
-killtracker/admin.py,sha256=s_O86Ct4prno0cQJE8otumCEqgkZ7H3Q_GFptEOTI_c,14103
-killtracker/app_settings.py,sha256=8owiemErRDKxkYY4XB0vFHTI9EqRMjz2SZGTTsEA2ao,3886
-killtracker/apps.py,sha256=yYOv4_T_eIiK5M7gr9Dre20WaNQXRKYOdfKyrforNhM,380
+killtracker/__init__.py,sha256=Pi-3zSugKHOaitGQHTp9XWoyaiw6k0pRhcNTmCdrBlg,354
+killtracker/admin.py,sha256=IH04Q1etHUnXSJIhm3bnGfIbSU6lPSSaltLERb-OkYg,14229
+killtracker/app_settings.py,sha256=KqWSS4OVKIa7DmBAa5AbwxFVXw5EQebPfBtPo1UJYgY,4295
+killtracker/apps.py,sha256=lWolk2CVEHPNIMEylbK2fSuCSTRW1n6LBmiDjLoqqq4,384
 killtracker/checks.py,sha256=ytqWlhIbCsvGKi3xFbUvAZzbUlgOhiOrB67PZ2WfxM4,1311
 killtracker/constants.py,sha256=W7-VARE3B4_sdzV_9k7qunUzlxTcdSAeSp_ZJVnbUhw,2514
-killtracker/exceptions.py,sha256=aFY6qxQOta1V-qvgKp19Cgy6M16O7Si8moc2205OsX0,846
-killtracker/forms.py,sha256=BqJYcAQ9jbZxTkDsHxrxj0qKKTIGIW0mShbBYdCDlaA,5182
-killtracker/managers.py,sha256=JCrfc3yrKD4uHCfIzPu7y2HF-VIJm1yskdc-CFEf7V4,4390
-killtracker/providers.py,sha256=smkZe_rKHkZeWFzJ0RhIhJVcbrZUpLYR5fKCge-dpXY,348
-killtracker/tasks.py,sha256=GNdX1BGTWgR_wD_Eep6ibPHqC-PFIeVXDiyIJE7vW-E,8109
+killtracker/forms.py,sha256=SUM0U-Sa6FPcGVpsYJbVxHfEtf7hb1Qc_l92Zfa1OLk,5193
+killtracker/managers.py,sha256=hrmpiuMzK-7p-AsT4ee0mMEhQv4b57AGmhlRTxEl7wk,4416
+killtracker/providers.py,sha256=3DiOlklBq5kLGDV9nMlMbP2-S8AodNgR6gtB4cWWCUo,358
+killtracker/signals.py,sha256=rFCg-WYMVPmAhuqX8KHNaicsP1nyj_HYA2O4Qr8wqhk,892
+killtracker/tasks.py,sha256=9ZqItmm2tlzVA-lelNTyzpPuBYCUvfZR2nCV16Xu6fA,9267
 killtracker/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-killtracker/core/discord_messages.py,sha256=mOKiMWq-3WnaSUFbfgVmlkAedGTZ7OWcVxLp7n58-Z0,14132
-killtracker/core/killmails.py,sha256=v7ciMSPHyIg4L4d-Q8UECuqJShfxfd3g_sdfRnKKSPY,20499
+killtracker/core/discord.py,sha256=cJY1qZ1ULlndliqn304B2deZkgL8VRqnAN_E5bXbTPk,5330
+killtracker/core/helpers.py,sha256=Ulwhz96IopCCNPD6m7ylz9IGnxknIvLSCfcLrmJ8uDE,335
+killtracker/core/trackers.py,sha256=ZENNdZ96L9AP3nIaP3_s9uFIVRgq_kLPGLK-rKT5gig,14693
+killtracker/core/workers.py,sha256=m9Vp7C-eXSfQpf0ugzTfuqcPBPKvarfds_4mb-JwJ-o,1278
+killtracker/core/zkb.py,sha256=n9eD9RT5xZ3Mc88ItoaQE_1lJAniqpr_oyps47sdGYQ,21481
 killtracker/management/commands/killtracker_load_eve.py,sha256=5P2wr6LU-EMl9_gG-DKP2yw3eFXOU7ApeuGAWEbvCKk,1159
 killtracker/migrations/0001_initial_new.py,sha256=WszI5DmNFtk45IZ2Zul3_Ak-VXmye9ffJKFAsGIxoXA,27818
 killtracker/migrations/0001_squashed_all.py,sha256=KXwOcRayjGGGmleg7-aTcXeIi-92Mn4BaGkEY3iE9Vc,26221
@@ -29,39 +32,43 @@ killtracker/migrations/0009_remove_old_models.py,sha256=bDIz0hywpFKbHYhdXFXzra5D
 killtracker/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 killtracker/models/__init__.py,sha256=WL6VD9MK7EsZot_RLPz0nX8WxJkp7RtQpw_mYpnVqu8,188
 killtracker/models/killmails.py,sha256=CCdrHkwUSoTOGqavG-TpMxDRleF9UEacOTui8v3-VT8,5181
-killtracker/models/trackers.py,sha256=t3pm29UW_0JqBgHbU0Xx1qgLyft7_EjNtKCJ37OM_fE,31188
-killtracker/models/webhooks.py,sha256=hh1mYE4pBU26YFawkv1z-j4uyX8aT25B0crOTsocSSY,8268
+killtracker/models/trackers.py,sha256=wo6KWl1GOASOquTTdAeo5DaZgRzKai1ek1GjQ49oOhY,31154
+killtracker/models/webhooks.py,sha256=6S1wXwlOMth56oU0hsYH5PiimECMwZyLXiKok2yQo_g,5850
 killtracker/static/killtracker/killtracker_logo.png,sha256=3jc9zmYHqP60Np5piP5RfkX0_II-315DNjZ4FRGbqKc,74625
 killtracker/static/killtracker/zkb_icon.png,sha256=wuVfgyTbTs9qS4KGbDAH3Q9KVPgHqYV5eaVrjEmTjsE,328
 killtracker/templates/admin/killtracker/tracker/killmail_test.html,sha256=TI2ON8qf9pW4rX6G7pT990ZadkipwncQgGUC0FPcWQY,649
 killtracker/tests/__init__.py,sha256=CEt5qqp6ptDrx1lwuA6epZ5bzh1CwUJYXeMZqWK9jT0,278
 killtracker/tests/test_admin.py,sha256=XFAlF_Q4h5Z_agkmRtB30GmCayqQPblLolFrN41xu7Q,5659
 killtracker/tests/test_admin_2.py,sha256=rP0EscM9qUil_ZuXute3R8TQY2P5XSjmxHLbziCGcVw,1140
-killtracker/tests/test_exceptions.py,sha256=wheTwm0JOBqYVI-DJM4KK2usFAZT1Q-O52VMOnSAz8Y,326
-killtracker/tests/test_integration.py,sha256=EX0IQGU_Vwsmjeoqeprg13VuW8AT9I8CT1bm3_cvfPs,3226
-killtracker/tests/test_tasks.py,sha256=ZDoCUBd-1kSOKrvSeTrlDaSGFmzHieT5ef0iBz6nr2I,13929
+killtracker/tests/test_integration.py,sha256=fOAOu-lKYFAk0hYYT-V4F3KgmPcrD7JgcR-w-z3lStg,3516
+killtracker/tests/test_tasks.py,sha256=hTxXKoza-hgAUsK2zj5qMkl4igHKB7SB2OkPFJtgXeA,16274
+killtracker/tests/test_utils.py,sha256=1TA0pzCpq8CAKRBTi_xZ9_45n3rPx7UclkgFPzT1VFY,1130
+killtracker/tests/utils.py,sha256=auwXHSpLwI_Qi3NmQUOCrIAcEsuw04ZaNJW82-jD4DU,1139
 killtracker/tests/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-killtracker/tests/core/test_discord_messages_1.py,sha256=1cYpj4E9pNqQOeE7yWeV1mme-JYGIHfSIibOauEHi88,3101
-killtracker/tests/core/test_discord_messages_2.py,sha256=AppA_FUFQA5I35UKjaEwn_ZQcnscqillR1SIo1unwJg,4774
-killtracker/tests/core/test_killmails.py,sha256=OFV6EbERi0UyMzXblLsNoJrPbLSIgtA27Wt9vGwOYd8,14349
+killtracker/tests/core/test_discord.py,sha256=w_QU1kVfo4uKl1xbj1C5NFQuPqASiveMjf0Q0fEIRWY,6163
+killtracker/tests/core/test_helpers.py,sha256=pQSi9QBOZWOem9NMzcO-qmc_EIWyhyA_aOevuLXrBk4,613
+killtracker/tests/core/test_tracker_1.py,sha256=EjGX2XyHDMAfhevUwi90YcPBSUhTlDv1c7bMgv4qUX0,3528
+killtracker/tests/core/test_tracker_2.py,sha256=ZQ3bZ4tvG3Xf_z8pMQllVlAcWOaltSP2BzqmJAezBEc,4748
+killtracker/tests/core/test_workers.py,sha256=stId22PF5VgrSOpCJV5ZiDak7eKM5rNOS7pbx1QNp6Q,1722
+killtracker/tests/core/test_zkb.py,sha256=lfsJlQgtX-V4rmnkwF60-c2IeRO2tRdead0RAS6WMQg,16557
 killtracker/tests/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-killtracker/tests/models/test_killmails.py,sha256=0ytwIGbTPb1OTzmK8B9VnR1ylxMuaYtp2tvCXzNOwNc,8293
-killtracker/tests/models/test_trackers_1.py,sha256=_ARZKBrQz0QF6_OZEOFOsTqNdfflz7wWenAT-T35nqU,42771
-killtracker/tests/models/test_trackers_2.py,sha256=FmtaWBjV32NlIjYPaG5Kh87oES5ChoDMVJ4ol2uWopE,5404
-killtracker/tests/models/test_webhook.py,sha256=E4BgmQw9mI5ZenV6ncYHbBonlEeWvvdilAS8IKFkbjw,5246
+killtracker/tests/models/test_killmails.py,sha256=pNJ7vSLqSl6BbokePdJnQNFWIDwbxkxugpP-QVoJcKQ,8247
+killtracker/tests/models/test_trackers_1.py,sha256=gqywaysnijyF_DT2TdiSJuLc1FUegftnO1pYECMX_Tc,42788
+killtracker/tests/models/test_trackers_2.py,sha256=-iVWnyFvoRb9Y7yKskjc5mmUl3XX53jdQYo8fri4TgA,5458
+killtracker/tests/models/test_webhooks.py,sha256=PtbTxNfYH-NKpLnLZrzbOOqHlJ9vY4Gy19tf2TsHbzI,2597
 killtracker/tests/testdata/__init__.py,sha256=9aQhf8V-DseZMWjJ_QMXOba6CypoHFSVpYRZEUh-oFc,212
 killtracker/tests/testdata/create_eveuniverse.py,sha256=Ewr5OBiQwjK1kwDCRh3A3f0Z-CCPi8Gp8dpsPgVAU4A,966
 killtracker/tests/testdata/evealliances.json,sha256=i6udrtUnWQjn71Iw17WWz9Eb1fdGUNhI1UYLt0hZHog,307
 killtracker/tests/testdata/evecorporations.json,sha256=Hk4WuplZl69rQcquOU-15lgUyvHRMZW0fnYfKz8oeWw,1229
 killtracker/tests/testdata/eveentities.json,sha256=0yStlAMEhednEiMKvKOYFsyRovtsGxw6IpWAyvnQXv4,1459
 killtracker/tests/testdata/eveuniverse.json,sha256=JagrJ-asKlkxrqj3dtAth6d5bhIpeEmlvBHgXjLTMSI,36117
-killtracker/tests/testdata/factories.py,sha256=WqmIthF6kgrdQrV5CSlub4hBYo42lC_8UORzZ8sGAp0,11019
-killtracker/tests/testdata/helpers.py,sha256=5T35ITnh16pTswR1O4t4IdVSpokC3x8_Me_vk3CgBB8,4741
+killtracker/tests/testdata/factories.py,sha256=MEJLfslB13J_UnN7TXASL6poH1fkQ1NW5dQX_xtfPvA,11013
+killtracker/tests/testdata/helpers.py,sha256=bsHv2HlbORuw5kU8qZ806nXPM0hqNUuj0qVQCm4KoZ8,4735
 killtracker/tests/testdata/killmails.json,sha256=HKfpXQJ_ikymBSewh4wWixYpLwC3kNBqi04cCms1AjA,45366
 killtracker/tests/testdata/load_eveuniverse.py,sha256=FitVc12E_ob56ezK5Y1q07Kbyc7N8poHiCNaLRGU4Jg,388
 killtracker/tools/drop_tables_killtracker.sql,sha256=fJrGY23NKRunpYC3hI-klFkWub4sBuhfP8TaT__zjPg,1726
 killtracker/tools/generate_conditions_text.py,sha256=LxAtTQIX-IbuqaNDMV1XHhq5AbrrlwxLWgXa1M7DWQo,767
-aa_killtracker-0.17.0.dist-info/licenses/LICENSE,sha256=XZiwB_S_40_HhnvLg5xvtBb3g1oGjPrk0rpFwk8iInE,1070
-aa_killtracker-0.17.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
-aa_killtracker-0.17.0.dist-info/METADATA,sha256=ixjtGgUPTMWb4glIZb_EmI-WZMdl9R9BLLR-aUlV9Gg,13927
-aa_killtracker-0.17.0.dist-info/RECORD,,
+aa_killtracker-1.0.0.dist-info/licenses/LICENSE,sha256=XZiwB_S_40_HhnvLg5xvtBb3g1oGjPrk0rpFwk8iInE,1070
+aa_killtracker-1.0.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+aa_killtracker-1.0.0.dist-info/METADATA,sha256=of14ijiJxhikyRX3EjazGngQlvdynnaeZFKyJXK3Qf8,13442
+aa_killtracker-1.0.0.dist-info/RECORD,,

killtracker/__init__.py

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

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.zkb 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,

killtracker/app_settings.py

@@ -6,20 +6,15 @@ 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,
 this feature ensures they don't create new alerts.
 """
 
-KILLTRACKER_MAX_KILLMAILS_PER_RUN = clean_setting(
-    "KILLTRACKER_MAX_KILLMAILS_PER_RUN", 100
-)
-"""Maximum number of killmails retrieved from ZKB by task run."""
-
 KILLTRACKER_PURGE_KILLMAILS_AFTER_DAYS = clean_setting(
-    "KILLTRACKER_PURGE_KILLMAILS_AFTER_DAYS", 30
+    "KILLTRACKER_PURGE_KILLMAILS_AFTER_DAYS", default_value=30, min_value=0
 )
 """Killmails older than set number of days will be purged from the database.
 If you want to keep all killmails set this to 0.
@@ -62,11 +57,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
@@ -100,9 +98,21 @@ KILLTRACKER_STORAGE_KILLMAILS_LIFETIME = clean_setting(
 )
 """Max lifetime of killmails in temporary storage in seconds."""
 
-KILLTRACKER_ZKB_REQUEST_DELAY = clean_setting("KILLTRACKER_ZKB_REQUEST_DELAY", 500)
+KILLTRACKER_ZKB_REQUEST_DELAY = clean_setting(
+    "KILLTRACKER_ZKB_REQUEST_DELAY", default_value=500, min_value=500
+)
 """Delay between subsequent calls to ZKB API in milliseconds.
 
 This delay ensures the app does not breach the CloudFlare rate limit of currently
 two (2) requests per second per IP address.
 """
+
+KILLTRACKER_MAX_KILLMAILS_PER_RUN = clean_setting(
+    "KILLTRACKER_MAX_KILLMAILS_PER_RUN", default_value=500, min_value=1
+)
+"""Maximum number of killmails retrieved from ZKB by task run."""
+
+KILLTRACKER_MAX_MESSAGES_SENT_PER_RUN = clean_setting(
+    "KILLTRACKER_MAX_MESSAGES_SENT_PER_RUN", default_value=10, min_value=1
+)
+"""Maximum number of messages processed per task run."""

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

killtracker/core/discord.py

@@ -0,0 +1,162 @@
+"""Send messages to Discord webhooks."""
+
+import datetime as dt
+import json
+from copy import copy
+from dataclasses import dataclass
+from http import HTTPStatus
+from time import sleep
+from typing import List, Optional
+
+import dhooks_lite
+
+from django.core.cache import cache
+from django.utils.timezone import now
+
+from allianceauth.services.hooks import get_extension_logger
+from app_utils.json import JSONDateTimeDecoder, JSONDateTimeEncoder
+from app_utils.logging import LoggerAddTag
+
+from killtracker import APP_NAME, HOMEPAGE_URL, __title__, __version__
+from killtracker.app_settings import KILLTRACKER_DISCORD_SEND_DELAY
+from killtracker.core.helpers import datetime_or_none
+
+_DEFAULT_429_TIMEOUT = 600
+
+logger = LoggerAddTag(get_extension_logger(__name__), __title__)
+
+
+class HTTPError(Exception):
+    """A HTTP error."""
+
+    def __init__(self, status_code: int):
+        self.status_code = status_code
+
+
+class WebhookRateLimitExhausted(Exception):
+    """The rate limit of a webhook has been exhausted."""
+
+    def __init__(self, retry_at: dt.datetime, is_original: bool = True):
+        self.retry_at = retry_at
+        self.is_original = is_original
+
+
+@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
+    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.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)
+
+
+def send_message_to_webhook(name: str, url: str, message: DiscordMessage) -> int:
+    """Send a message to a Discord webhook and returns the ID of new message."""
+
+    key_retry_at = _make_key_retry_at(url)
+    retry_at = datetime_or_none(cache.get(key_retry_at))
+    if retry_at is not None and retry_at > now():
+        raise WebhookRateLimitExhausted(retry_at=retry_at, is_original=False)
+
+    key_last_request = _make_key_last_request(url)
+    last_request = datetime_or_none(cache.get(key_last_request))
+    if last_request is not None:
+        next_slot = last_request + dt.timedelta(seconds=KILLTRACKER_DISCORD_SEND_DELAY)
+        seconds = (next_slot - now()).total_seconds()
+        if seconds > 0:
+            logger.debug(
+                "%s: Waiting %f seconds for next free slot for webhook", name, seconds
+            )
+            sleep(seconds)
+
+    hook = dhooks_lite.Webhook(
+        url=url,
+        user_agent=dhooks_lite.UserAgent(
+            name=APP_NAME, url=HOMEPAGE_URL, version=__version__
+        ),
+    )
+    response = hook.execute(
+        content=message.content,
+        embeds=message.embeds,
+        username=message.username,
+        avatar_url=message.avatar_url,
+        wait_for_response=True,
+        max_retries=0,  # we will handle retries ourselves
+    )
+    cache.set(key_last_request, now(), timeout=KILLTRACKER_DISCORD_SEND_DELAY + 30)
+    logger.debug(
+        "%s: Response from Discord for creating message from killmail %d: %s %s %s",
+        name,
+        message.killmail_id,
+        response.status_code,
+        response.headers,
+        response.content,
+    )
+    if not response.status_ok:
+        if response.status_code == HTTPStatus.TOO_MANY_REQUESTS:
+            try:
+                retry_after = int(response.headers["Retry-After"])
+            except KeyError:
+                retry_after = _DEFAULT_429_TIMEOUT
+            retry_at = now() + dt.timedelta(seconds=retry_after)
+            cache.set(key_retry_at, retry_at, timeout=retry_after + 60)
+            raise WebhookRateLimitExhausted(retry_at=retry_at, is_original=True)
+
+        raise HTTPError(response.status_code)
+
+    try:
+        message_id = int(response.content.get("id"))
+    except (AttributeError, ValueError):
+        message_id = 0
+
+    return message_id
+
+
+def _make_key_last_request(url):
+    return f"killtracker-webhook-last-request-{url}"
+
+
+def _make_key_retry_at(url):
+    return f"killtracker-webhook-retry-at-{url}"

killtracker/core/helpers.py

@@ -0,0 +1,13 @@
+"""Helper functions for core modules."""
+
+import datetime as dt
+from typing import Any, Optional
+
+
+def datetime_or_none(v: Any) -> Optional[dt.datetime]:
+    """Returns as datetime when it is a datetime else returns None."""
+    if v is None:
+        return None
+    if not isinstance(v, dt.datetime):
+        return None
+    return v