aa-killtracker 0.14.0__tar.gz → 0.15.0__tar.gz

{aa_killtracker-0.14.0 → aa_killtracker-0.15.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aa-killtracker
-Version: 0.14.0
+Version: 0.15.0
 Summary: "An app for running killmail trackers with Alliance Auth and Discord.
 Author-email: Erik Kalkoken <kalkoken87@gmail.com>
 Requires-Python: >=3.8
@@ -90,6 +90,8 @@ And here is how posted killmails look on Discord:
 
 2. Killtracker needs the app [django-eveuniverse](https://gitlab.com/ErikKalkoken/django-eveuniverse) to function. Please make sure it is installed, before continuing.
 
+3. Killtracker will generate a lot of tasks. For optimal performance we recommend a threads-based configuration of your celery workers. Please see [this guide](https://aa-memberaudit.readthedocs.io/en/latest/operations.html#configuring-celery-workers) for details.
+
 ### Step 2 - Install app
 
 Make sure you are in the virtual environment (venv) of your Alliance Auth installation. Then install the newest release from PyPI:
@@ -179,6 +181,8 @@ To test that your webhook works correctly you can send a test notification.
 
 Next you can create your trackers under **Tracker**. Make sure you link each tracker to the right webhook. Once you save a tracker that is **enabled** it will start working.
 
+>**Hint**:<br>A common mistake is to set both attacker alliance and victim alliance to your alliance in the same tracker. This will only match awox kills though, which is usually not what you want. Instead create separate trackers to capture kills and losses for your alliance.
+
 As final test that your setup is correct you may want to create a "Catch all" tracker. for that just create a new tracker without any conditions and it will forward all killmails to your Discord channel as they are received.
 
 Congratulations you are now ready to use killtracker!

{aa_killtracker-0.14.0 → aa_killtracker-0.15.0}/README.md

@@ -61,6 +61,8 @@ And here is how posted killmails look on Discord:
 
 2. Killtracker needs the app [django-eveuniverse](https://gitlab.com/ErikKalkoken/django-eveuniverse) to function. Please make sure it is installed, before continuing.
 
+3. Killtracker will generate a lot of tasks. For optimal performance we recommend a threads-based configuration of your celery workers. Please see [this guide](https://aa-memberaudit.readthedocs.io/en/latest/operations.html#configuring-celery-workers) for details.
+
 ### Step 2 - Install app
 
 Make sure you are in the virtual environment (venv) of your Alliance Auth installation. Then install the newest release from PyPI:
@@ -150,6 +152,8 @@ To test that your webhook works correctly you can send a test notification.
 
 Next you can create your trackers under **Tracker**. Make sure you link each tracker to the right webhook. Once you save a tracker that is **enabled** it will start working.
 
+>**Hint**:<br>A common mistake is to set both attacker alliance and victim alliance to your alliance in the same tracker. This will only match awox kills though, which is usually not what you want. Instead create separate trackers to capture kills and losses for your alliance.
+
 As final test that your setup is correct you may want to create a "Catch all" tracker. for that just create a new tracker without any conditions and it will forward all killmails to your Discord channel as they are received.
 
 Congratulations you are now ready to use killtracker!

{aa_killtracker-0.14.0 → aa_killtracker-0.15.0}/killtracker/__init__.py

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

{aa_killtracker-0.14.0 → aa_killtracker-0.15.0}/killtracker/admin.py

@@ -101,13 +101,17 @@ class TrackerAdmin(admin.ModelAdmin):
         "require_constellations",
         "require_solar_systems",
         "exclude_attacker_alliances",
-        "exclude_attacker_corporations",
+        "exclude_victim_alliances",
+        "require_victim_alliances",
         "require_attacker_alliances",
+        "exclude_attacker_corporations",
         "require_attacker_corporations",
-        "require_victim_alliances",
-        "exclude_victim_alliances",
-        "require_victim_corporations",
         "exclude_victim_corporations",
+        "require_victim_corporations",
+        "exclude_attacker_factions",
+        "require_attacker_factions",
+        "exclude_victim_factions",
+        "require_victim_factions",
         "require_attackers_ship_types",
         "require_attackers_ship_groups",
         "require_attackers_weapon_groups",
@@ -118,6 +122,7 @@ class TrackerAdmin(admin.ModelAdmin):
     filter_horizontal = (
         "exclude_attacker_states",
         "require_attacker_states",
+        "exclude_victim_states",
         "require_victim_states",
         "ping_groups",
     )
@@ -154,28 +159,33 @@ class TrackerAdmin(admin.ModelAdmin):
             },
         ),
         (
-            "Organizations",
+            "Attackers",
             {
                 "fields": (
-                    "exclude_attacker_alliances",
-                    "exclude_attacker_corporations",
                     "require_attacker_alliances",
+                    "exclude_attacker_alliances",
                     "require_attacker_corporations",
+                    "exclude_attacker_corporations",
+                    "require_attacker_factions",
+                    "exclude_attacker_factions",
+                    "require_attacker_states",
+                    "exclude_attacker_states",
                     "require_attacker_organizations_final_blow",
-                    "require_victim_alliances",
-                    "exclude_victim_alliances",
-                    "require_victim_corporations",
-                    "exclude_victim_corporations",
                 ),
             },
         ),
         (
-            "Auth State",
+            "Victims",
             {
                 "fields": (
-                    "exclude_attacker_states",
-                    "require_attacker_states",
+                    "require_victim_alliances",
+                    "exclude_victim_alliances",
+                    "require_victim_corporations",
+                    "exclude_victim_corporations",
+                    "require_victim_factions",
+                    "exclude_victim_factions",
                     "require_victim_states",
+                    "exclude_victim_states",
                 ),
             },
         ),

{aa_killtracker-0.14.0 → aa_killtracker-0.15.0}/killtracker/core/killmails.py

@@ -182,6 +182,10 @@ class Killmail(_KillmailBase):
         """Return distinct character IDs of all attackers."""
         return {obj.character_id for obj in self.attackers if obj.character_id}
 
+    def attackers_distinct_faction_ids(self) -> Set[int]:
+        """Return distinct faction IDs of all attackers."""
+        return {obj.faction_id for obj in self.attackers if obj.faction_id}
+
     def attackers_ship_type_ids(self) -> List[int]:
         """Returns ship type IDs of all attackers with duplicates."""
         return [obj.ship_type_id for obj in self.attackers if obj.ship_type_id]

aa_killtracker-0.15.0/killtracker/migrations/0004_add_faction_clauses.py

@@ -0,0 +1,69 @@
+# Generated by Django 4.0.10 on 2024-07-04 12:40
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("authentication", "0021_alter_userprofile_language"),
+        ("eveonline", "0017_alliance_and_corp_names_are_not_unique"),
+        ("killtracker", "0003_optimize_tracker_form"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="tracker",
+            name="exclude_attacker_factions",
+            field=models.ManyToManyField(
+                blank=True,
+                default=None,
+                help_text="Exclude killmails with attackers from one of these factions. ",
+                related_name="+",
+                to="eveonline.evefactioninfo",
+            ),
+        ),
+        migrations.AddField(
+            model_name="tracker",
+            name="exclude_victim_factions",
+            field=models.ManyToManyField(
+                blank=True,
+                default=None,
+                help_text="Exclude killmails where the victim belongs to one of these factions. ",
+                related_name="+",
+                to="eveonline.evefactioninfo",
+            ),
+        ),
+        migrations.AddField(
+            model_name="tracker",
+            name="exclude_victim_states",
+            field=models.ManyToManyField(
+                blank=True,
+                default=None,
+                help_text="Exclude killmails where the victim belongs to one of these Auth states. ",
+                related_name="+",
+                to="authentication.state",
+            ),
+        ),
+        migrations.AddField(
+            model_name="tracker",
+            name="require_attacker_factions",
+            field=models.ManyToManyField(
+                blank=True,
+                default=None,
+                help_text="Only include killmails with attackers from one of these factions. ",
+                related_name="+",
+                to="eveonline.evefactioninfo",
+            ),
+        ),
+        migrations.AddField(
+            model_name="tracker",
+            name="require_victim_factions",
+            field=models.ManyToManyField(
+                blank=True,
+                default=None,
+                help_text="Only include killmails where the victim belongs to one of these factions. ",
+                related_name="+",
+                to="eveonline.evefactioninfo",
+            ),
+        ),
+    ]

{aa_killtracker-0.14.0 → aa_killtracker-0.15.0}/killtracker/models/trackers.py

@@ -17,7 +17,11 @@ from eveuniverse.models import (
 )
 
 from allianceauth.authentication.models import State
-from allianceauth.eveonline.models import EveAllianceInfo, EveCorporationInfo
+from allianceauth.eveonline.models import (
+    EveAllianceInfo,
+    EveCorporationInfo,
+    EveFactionInfo,
+)
 from allianceauth.services.hooks import get_extension_logger
 from app_utils.logging import LoggerAddTag
 
@@ -170,6 +174,25 @@ class Tracker(models.Model):
         blank=True,
         help_text="Only include killmails with attackers from one of these alliances. ",
     )
+    require_victim_alliances = models.ManyToManyField(
+        EveAllianceInfo,
+        related_name="+",
+        default=None,
+        blank=True,
+        help_text=(
+            "Only include killmails where the victim belongs "
+            "to one of these alliances. "
+        ),
+    )
+    exclude_victim_alliances = models.ManyToManyField(
+        EveAllianceInfo,
+        related_name="+",
+        default=None,
+        blank=True,
+        help_text=(
+            "Exclude killmails where the victim belongs to one of these alliances. "
+        ),
+    )
     exclude_attacker_corporations = models.ManyToManyField(
         EveCorporationInfo,
         related_name="+",
@@ -196,6 +219,25 @@ class Tracker(models.Model):
             "has the final blow."
         ),
     )
+    require_victim_corporations = models.ManyToManyField(
+        EveCorporationInfo,
+        related_name="+",
+        default=None,
+        blank=True,
+        help_text=(
+            "Only include killmails where the victim belongs "
+            "to one of these corporations. "
+        ),
+    )
+    exclude_victim_corporations = models.ManyToManyField(
+        EveCorporationInfo,
+        related_name="+",
+        default=None,
+        blank=True,
+        help_text=(
+            "Exclude killmails where the victim belongs to one of these corporations. "
+        ),
+    )
     exclude_attacker_states = models.ManyToManyField(
         State,
         related_name="+",
@@ -216,52 +258,58 @@ class Tracker(models.Model):
             "to users with these Auth states. "
         ),
     )
-    require_victim_alliances = models.ManyToManyField(
-        EveAllianceInfo,
+    exclude_victim_states = models.ManyToManyField(
+        State,
         related_name="+",
         default=None,
         blank=True,
         help_text=(
-            "Only include killmails where the victim belongs "
-            "to one of these alliances. "
+            "Exclude killmails where the victim belongs to one of these Auth states. "
         ),
     )
-    exclude_victim_alliances = models.ManyToManyField(
-        EveAllianceInfo,
+    require_victim_states = models.ManyToManyField(
+        State,
         related_name="+",
         default=None,
         blank=True,
         help_text=(
-            "Exclude killmails where the victim belongs to one of these alliances. "
+            "Only include killmails where the victim characters belong "
+            "to users with these Auth states. "
         ),
     )
-    require_victim_corporations = models.ManyToManyField(
-        EveCorporationInfo,
+    exclude_attacker_factions = models.ManyToManyField(
+        EveFactionInfo,
+        related_name="+",
+        default=None,
+        blank=True,
+        help_text="Exclude killmails with attackers from one of these factions. ",
+    )
+    require_attacker_factions = models.ManyToManyField(
+        EveFactionInfo,
         related_name="+",
         default=None,
         blank=True,
         help_text=(
-            "Only include killmails where the victim belongs "
-            "to one of these corporations. "
+            "Only include killmails with attackers from one of these factions. "
         ),
     )
-    exclude_victim_corporations = models.ManyToManyField(
-        EveCorporationInfo,
+    require_victim_factions = models.ManyToManyField(
+        EveFactionInfo,
         related_name="+",
         default=None,
         blank=True,
         help_text=(
-            "Exclude killmails where the victim belongs to one of these corporations. "
+            "Only include killmails where the victim belongs "
+            "to one of these factions. "
         ),
     )
-    require_victim_states = models.ManyToManyField(
-        State,
+    exclude_victim_factions = models.ManyToManyField(
+        EveFactionInfo,
         related_name="+",
         default=None,
         blank=True,
         help_text=(
-            "Only include killmails where the victim characters belong "
-            "to users with these Auth states. "
+            "Exclude killmails where the victim belongs to one of these factions. "
         ),
     )
     identify_fleets = models.BooleanField(
@@ -506,6 +554,7 @@ class Tracker(models.Model):
             is_matching = self._match_value(killmail, is_matching)
             is_matching, jumps, distance = self._match_geography(killmail, is_matching)
             is_matching = self._match_attackers(killmail, is_matching)
+            is_matching = self._match_states(killmail, is_matching)
             is_matching, matching_ship_type_ids = self._match_attacker_ships(
                 killmail, is_matching, matching_ship_type_ids
             )
@@ -641,6 +690,16 @@ class Tracker(models.Model):
                 corporation_id__in=killmail.attackers_distinct_corporation_ids()
             ).exists()
 
+        if is_matching and self.require_attacker_factions.exists():
+            is_matching = self.require_attacker_factions.filter(
+                faction_id__in=killmail.attackers_distinct_faction_ids()
+            ).exists()
+
+        if is_matching and self.exclude_attacker_factions.exists():
+            is_matching = self.exclude_attacker_factions.exclude(
+                faction_id__in=killmail.attackers_distinct_faction_ids()
+            ).exists()
+
         if is_matching:
             if self.require_attacker_organizations_final_blow:
                 attacker_final_blow = killmail.attacker_final_blow()
@@ -668,6 +727,9 @@ class Tracker(models.Model):
                         corporation_id__in=killmail.attackers_distinct_corporation_ids()
                     ).exists()
 
+        return is_matching
+
+    def _match_states(self, killmail: Killmail, is_matching: bool) -> bool:
         if is_matching and self.require_attacker_states.exists():
             is_matching = User.objects.filter(
                 profile__state__in=list(self.require_attacker_states.all()),
@@ -684,6 +746,14 @@ class Tracker(models.Model):
                 ),
             ).exists()
 
+        if is_matching and self.require_victim_states.exists():
+            is_matching = User.objects.filter(
+                profile__state__in=list(self.require_victim_states.all()),
+                character_ownerships__character__character_id=(
+                    killmail.victim.character_id
+                ),
+            ).exists()
+
         return is_matching
 
     def _match_attacker_ships(
@@ -765,12 +835,14 @@ class Tracker(models.Model):
                 corporation_id=killmail.victim.corporation_id
             ).exists()
 
-        if is_matching and self.require_victim_states.exists():
-            is_matching = User.objects.filter(
-                profile__state__in=list(self.require_victim_states.all()),
-                character_ownerships__character__character_id=(
-                    killmail.victim.character_id
-                ),
+        if is_matching and self.require_victim_factions.exists():
+            is_matching = self.require_victim_factions.filter(
+                faction_id=killmail.victim.faction_id
+            ).exists()
+
+        if is_matching and self.exclude_victim_factions.exists():
+            is_matching = self.exclude_victim_factions.exclude(
+                faction_id=killmail.victim.faction_id
             ).exists()
 
         return is_matching

{aa_killtracker-0.14.0 → aa_killtracker-0.15.0}/killtracker/tests/core/test_killmails.py

@@ -262,6 +262,12 @@ class TestKillmailBasics(NoSocketsTestCase):
         # then
         self.assertSetEqual(set(result), {3001})
 
+    def test_should_return_attacker_faction_ids(self):
+        # when
+        result = self.killmail.attackers_distinct_faction_ids()
+        # then
+        self.assertSetEqual(set(result), {500001})
+
     def test_should_return_attacker_corporation_ids(self):
         # when
         result = self.killmail.attackers_distinct_corporation_ids()