aa-structures 2.13.0__tar.gz → 2.14.0__tar.gz

{aa_structures-2.13.0 → aa_structures-2.14.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aa-structures
-Version: 2.13.0
+Version: 2.14.0
 Summary: App for managing Eve Online structures with Alliance Auth.
 Author-email: Erik Kalkoken <kalkoken87@gmail.com>
 Requires-Python: >=3.8

{aa_structures-2.13.0 → aa_structures-2.14.0}/structures/__init__.py

@@ -3,5 +3,5 @@
 # pylint: disable = invalid-name
 default_app_config = "structures.apps.StructuresConfig"
 
-__version__ = "2.13.0"
+__version__ = "2.14.0"
 __title__ = "Structures"

{aa_structures-2.13.0 → aa_structures-2.14.0}/structures/admin.py

@@ -324,7 +324,7 @@ class NotificationBaseAdmin(admin.ModelAdmin):
             message = format_lazy("{first} {second}", first=first, second=second)
         else:
             message = first
-        message = format_lazy({first})
+        message = format_lazy(first)
         self.message_user(request, message)
 
 

{aa_structures-2.13.0 → aa_structures-2.14.0}/structures/app_settings.py

@@ -49,6 +49,10 @@ STRUCTURES_FEATURE_REFUELED_NOTIFICATIONS = clean_setting(
 )
 """Enable / disable refueled notifications feature."""
 
+STRUCTURES_FEATURE_SKYHOOKS = clean_setting("STRUCTURES_FEATURE_SKYHOOKS", False)
+"""Show skyhooks in structures list."""
+
+
 STRUCTURES_FEATURE_STARBASES = clean_setting("STRUCTURES_FEATURE_STARBASES", True)
 """Enable / disable starbases feature."""
 

{aa_structures-2.13.0 → aa_structures-2.14.0}/structures/constants.py

@@ -42,6 +42,7 @@ class EveTypeId(IntEnum):
     IHUB = 32458
     JUMP_GATE = 35841
     LIQUID_OZONE = 16273
+    ORBITAL_SKYHOOK = 81080
     NITROGEN_FUEL_BLOCK = 4051
     STRONTIUM = 16275
     TCU = 32226

{aa_structures-2.13.0 → aa_structures-2.14.0}/structures/core/notification_timers.py

@@ -53,7 +53,9 @@ def add_or_remove_timer(notif: Notification) -> bool:
     elif notif.notif_type == NotificationType.SOV_STRUCTURE_REINFORCED:
         timer_processed = _gen_timer_sov_reinforcements(notif)
     elif notif.notif_type == NotificationType.ORBITAL_REINFORCED:
-        timer_processed = _gen_timer_orbital_reinforcements(notif)
+        timer_processed = _gen_timer_customs_office_reinforcements(notif)
+    elif notif.notif_type == NotificationType.SKYHOOK_LOST_SHIELDS:
+        timer_processed = _gen_timer_skyhook_reinforcements(notif)
     elif notif.notif_type in [
         NotificationType.MOONMINING_EXTRACTION_STARTED,
         NotificationType.MOONMINING_EXTRACTION_CANCELLED,
@@ -65,9 +67,7 @@ def add_or_remove_timer(notif: Notification) -> bool:
     elif notif.notif_type == NotificationType.TOWER_REINFORCED_EXTRA:
         timer_processed = _gen_timer_tower_reinforcements(notif)
     else:
-        raise NotImplementedError(
-            f"Unsupported notification type for timers: {notif.notif_type}"
-        )
+        raise NotImplementedError(notif.notif_type)
     if timer_processed:
         logger.info("%s: Created timer for notification", notif.notification_id)
         notif.is_timer_added = True
@@ -181,8 +181,8 @@ def _gen_timer_sov_reinforcements(notif: Notification) -> bool:
     return timer_processed
 
 
-def _gen_timer_orbital_reinforcements(notif: Notification) -> bool:
-    """Generate timer for orbital reinforcements."""
+def _gen_timer_customs_office_reinforcements(notif: Notification) -> bool:
+    """Generate timer for customs office reinforcements."""
 
     solar_system = notif.eve_solar_system()
     planet = notif.eve_planet()
@@ -231,6 +231,53 @@ def _gen_timer_orbital_reinforcements(notif: Notification) -> bool:
     return timer_processed
 
 
+def _gen_timer_skyhook_reinforcements(notif: Notification) -> bool:
+    """Generate timer for skyhook reinforcements."""
+
+    solar_system = notif.eve_solar_system("solarsystemID")
+    structure_type = notif.eve_structure_type("typeID")
+    planet = notif.eve_planet()
+    eve_time = ldap_time_2_datetime(notif.parsed_text()["timestamp"])
+    timer_processed = False
+
+    if AuthTimer:
+        AuthTimer.objects.create(
+            details=gettext("Final timer"),
+            system=solar_system.name,
+            planet_moon=planet.name,
+            structure="POCO",  # Auth timer does not support the Skyhook type yet
+            objective="Friendly",
+            eve_time=eve_time,
+            eve_corp=notif.owner.corporation,
+            corp_timer=STRUCTURES_TIMERS_ARE_CORP_RESTRICTED,
+        )
+        timer_processed = True
+
+    if Timer:
+        visibility = (
+            Timer.Visibility.CORPORATION
+            if STRUCTURES_TIMERS_ARE_CORP_RESTRICTED
+            else Timer.Visibility.UNRESTRICTED
+        )
+        Timer.objects.create(
+            eve_solar_system=solar_system,
+            structure_type=structure_type,
+            timer_type=Timer.Type.FINAL,
+            objective=Timer.Objective.FRIENDLY,
+            date=eve_time,
+            location_details=planet.name,
+            eve_corporation=notif.owner.corporation,
+            eve_alliance=notif.owner.corporation.alliance,
+            visibility=visibility,
+            structure_name=structure_type.name,
+            owner_name=notif.owner.corporation.corporation_name,
+            details_notes=_timer_details_notes(notif),
+        )
+        timer_processed = True
+
+    return timer_processed
+
+
 def _gen_timer_moon_extraction(notif: Notification) -> bool:
     """Generate timer for moon mining extractions."""
     solar_system = notif.eve_solar_system()

{aa_structures-2.13.0 → aa_structures-2.14.0}/structures/core/notification_types.py

@@ -221,6 +221,7 @@ class NotificationType(models.TextChoices):
             cls.STRUCTURE_LOST_ARMOR,
             cls.STRUCTURE_LOST_SHIELD,
             cls.TOWER_REINFORCED_EXTRA,
+            cls.SKYHOOK_LOST_SHIELDS,
         }
 
     @classmethod

{aa_structures-2.13.0 → aa_structures-2.14.0}/structures/managers.py

@@ -2,9 +2,11 @@
 
 # pylint: disable=missing-class-docstring
 
+from __future__ import annotations
+
 import datetime as dt
 import itertools
-from typing import Any, Iterable, Optional, Set, Tuple
+from typing import TYPE_CHECKING, Any, Iterable, Optional, Set, Tuple
 
 from django.contrib.auth.models import User
 from django.db import models, transaction
@@ -24,6 +26,9 @@ from .core.notification_types import NotificationType
 from .providers import esi
 from .webhooks.managers import WebhookBaseManager
 
+if TYPE_CHECKING:
+    from .models import Owner
+
 logger = LoggerAddTag(get_extension_logger(__name__), __title__)
 
 
@@ -231,6 +236,10 @@ class StructureQuerySet(models.QuerySet):
         """Filter for starbases."""
         return self.filter(eve_type__eve_group__eve_category=EveCategoryId.STARBASE)
 
+    def filter_skyhooks(self) -> models.QuerySet:
+        """Filter for skyhooks."""
+        return self.filter(eve_type=EveTypeId.ORBITAL_SKYHOOK)
+
     def ids(self) -> Set[int]:
         """Return ids as set."""
         return set(self.values_list("id", flat=True))
@@ -380,7 +389,9 @@ class StructureManagerBase(models.Manager):
         obj, created = self.update_or_create_from_dict(structure=structure, owner=owner)
         return obj, created
 
-    def update_or_create_from_dict(self, structure: dict, owner) -> Tuple[Any, bool]:
+    def update_or_create_from_dict(
+        self, structure: dict, owner: Owner
+    ) -> Tuple[Any, bool]:
         """update or create structure from given dict"""
 
         eve_type: EveType = EveType.objects.get_or_create_esi(id=structure["type_id"])[

{aa_structures-2.13.0 → aa_structures-2.14.0}/structures/models/owners.py

@@ -37,6 +37,7 @@ from structures.app_settings import (
     STRUCTURES_DEVELOPER_MODE,
     STRUCTURES_ESI_DIRECTOR_ERROR_MAX_RETRIES,
     STRUCTURES_FEATURE_CUSTOMS_OFFICES,
+    STRUCTURES_FEATURE_SKYHOOKS,
     STRUCTURES_FEATURE_STARBASES,
     STRUCTURES_HOURS_UNTIL_STALE_NOTIFICATION,
     STRUCTURES_NOTIFICATION_SYNC_GRACE_MINUTES,
@@ -545,14 +546,14 @@ class Owner(models.Model):
                 )
 
     def _remove_structures_not_returned_from_esi(
-        self, structures_qs: models.QuerySet, new_structures: Iterable
+        self, existing_structures: models.QuerySet, new_structures: Iterable[dict]
     ):
         """Remove structures no longer returned from ESI."""
-        ids_local = {x.id for x in structures_qs}
+        ids_local = {x.id for x in existing_structures}
         ids_from_esi = {x["structure_id"] for x in new_structures}
         ids_to_remove = ids_local - ids_from_esi
         if len(ids_to_remove) > 0:
-            structures_qs.filter(id__in=ids_to_remove).delete()
+            existing_structures.filter(id__in=ids_to_remove).delete()
             logger.info(
                 "Removed %d structures which apparently no longer exist.",
                 len(ids_to_remove),
@@ -650,7 +651,7 @@ class Owner(models.Model):
             self._store_raw_data("structures", structures)
 
         self._remove_structures_not_returned_from_esi(
-            structures_qs=self.structures.filter_upwell_structures(),
+            existing_structures=self.structures.filter_upwell_structures(),
             new_structures=structures,
         )
         return is_ok
@@ -701,7 +702,7 @@ class Owner(models.Model):
             return False
 
         self._remove_structures_not_returned_from_esi(
-            structures_qs=self.structures.filter_customs_offices(),
+            existing_structures=self.structures.filter_customs_offices(),
             new_structures=structures.values(),
         )
         return True
@@ -868,7 +869,7 @@ class Owner(models.Model):
             return False
 
         self._remove_structures_not_returned_from_esi(
-            structures_qs=self.structures.filter_starbases(),
+            existing_structures=self.structures.filter_starbases(),
             new_structures=structures,
         )
         character.reset_error_counter()
@@ -1214,15 +1215,18 @@ class Owner(models.Model):
     def update_asset_esi(self, user: Optional[User] = None):
         """Update assets from ESI."""
         token = self.fetch_token()
-        assets_data = self._fetch_structure_assets_from_esi(token)
+        assets_data = self._fetch_owner_assets_from_esi(token)
         self._store_items_for_upwell_structures(assets_data)
         self._store_items_for_starbases(assets_data)
+        if STRUCTURES_FEATURE_SKYHOOKS:
+            self._update_skyhooks_from_assets(assets_data)
+            self._resolve_skyhook_planets()
         if user:
             self._send_report_to_user(
                 topic="assets", topic_count=self.structures.count(), user=user
             )
 
-    def _fetch_structure_assets_from_esi(self, token: Token) -> dict:
+    def _fetch_owner_assets_from_esi(self, token: Token) -> dict:
         assets_raw = esi.client.Assets.get_corporations_corporation_id_assets(
             corporation_id=self.corporation.corporation_id,
             token=token.valid_access_token(),
@@ -1306,6 +1310,62 @@ class Owner(models.Model):
                     )
             structure.update_items(structure_items)
 
+    def _update_skyhooks_from_assets(self, assets_data: dict):
+        skyhooks = {
+            item_id: item
+            for item_id, item in assets_data.items()
+            if item["type_id"] == EveTypeId.ORBITAL_SKYHOOK
+            and item["location_type"] == "solar_system"
+            and item["location_flag"] == "AutoFit"
+            and item["is_singleton"]
+            and item["position"]
+        }
+        structures = []
+        for item in skyhooks.values():
+            structures.append(
+                {
+                    "corporation_id": self.corporation.corporation_id,
+                    "type_id": item["type_id"],
+                    "position": item["position"],
+                    "structure_id": item["item_id"],
+                    "system_id": item["location_id"],
+                }
+            )
+
+        for s in structures:
+            Structure.objects.update_or_create_from_dict(s, self)
+
+        self._remove_structures_not_returned_from_esi(
+            existing_structures=self.structures.filter_skyhooks(),
+            new_structures=structures,
+        )
+
+    def _resolve_skyhook_planets(self):
+        """Add planets to all unresolved Skyhooks."""
+        s: Structure
+        for s in self.structures.filter_skyhooks().filter(
+            eve_planet__isnull=True,
+            position_x__isnull=False,
+            position_y__isnull=False,
+            position_z__isnull=False,
+        ):
+            try:
+                celestial = s.eve_solar_system.nearest_celestial(
+                    x=s.position_x,
+                    y=s.position_y,
+                    z=s.position_z,
+                    group_id=EveGroupId.PLANET,
+                )
+            except OSError:
+                continue
+
+            if not celestial or not isinstance(celestial.eve_object, EvePlanet):
+                continue
+
+            s.eve_planet = celestial.eve_object
+            s.name = celestial.eve_type.name
+            s.save()
+
     @staticmethod
     def get_esi_scopes() -> List[str]:
         """Return all required ESI scopes."""

{aa_structures-2.13.0 → aa_structures-2.14.0}/structures/models/structures_1.py

@@ -464,6 +464,11 @@ class Structure(models.Model):  # pylint: disable = too-many-public-methods
         """Return True if this structure is a starbase, else False."""
         return starbases.is_starbase(self.eve_type)
 
+    @property
+    def is_skyhook(self) -> bool:
+        """Return True if this structure is a skyhook, else False."""
+        return self.eve_type_id == EveTypeId.ORBITAL_SKYHOOK
+
     @cached_property
     def is_upwell_structure(self) -> bool:
         """Return True if this structure is an upwell structure, else False."""

{aa_structures-2.13.0 → aa_structures-2.14.0}/structures/templates/structures/public.html

@@ -28,7 +28,7 @@
     <ul id="public-tabs" class="nav nav-tabs" role="tablist">
 
         <li role="presentation" class="active">
-            <a href="#pocos" aria-controls="pocos" role="tab" data-toggle="tab">
+            <a href="#pocos" aria-controls="orbitals" role="tab" data-toggle="tab">
                 {% translate "Customs Offices" %} <small>({{ pocos_count|default:"-" }})</small>
             </a>
         </li>
@@ -39,7 +39,7 @@
         <div class="panel-body">
             <div class="tab-content">
 
-                <div role="tabpanel" class="tab-pane active" id="pocos">
+                <div role="tabpanel" class="tab-pane active" id="orbitals">
                     {% include "structures/partials/public/poco_list.html" %}
                 </div>
 

{aa_structures-2.13.0 → aa_structures-2.14.0}/structures/templates/structures/structures.html

@@ -48,8 +48,8 @@
         </li>
 
         <li role="presentation">
-            <a href="#pocos" aria-controls="pocos" role="tab" data-toggle="tab">
-                {% trans "Customs Offices" %} <small>({{ pocos_count|default:"-" }})</small>
+            <a href="#orbitals" aria-controls="orbitals" role="tab" data-toggle="tab">
+                {% trans "Orbitals" %} <small>({{ orbitals_count|default:"-" }})</small>
             </a>
         </li>
 
@@ -77,7 +77,7 @@
                     {% include "structures/partials/structures/structure_list.html" %}
                 </div>
 
-                <div role="tabpanel" class="tab-pane" id="pocos">
+                <div role="tabpanel" class="tab-pane" id="orbitals">
                     {% include "structures/partials/structures/poco_list.html" %}
                 </div>
 

aa_structures-2.13.0/structures/tests/core/test_notifications_timerboard.py → aa_structures-2.14.0/structures/tests/core/test_notifications_timers.py

@@ -4,6 +4,7 @@ from app_utils.django import app_labels
 from app_utils.testing import NoSocketsTestCase
 
 from structures.core import notification_timers
+from structures.core.notification_types import NotificationType
 from structures.models import Notification
 from structures.tests.testdata.factories import (
     GeneratedNotificationFactory,
@@ -107,7 +108,11 @@ if "timerboard" in app_labels():
         @patch(MODULE_PATH + ".STRUCTURES_MOON_EXTRACTION_TIMERS_ENABLED", True)
         def test_run_all(self):
             for obj in Notification.objects.all():
-                obj.add_or_remove_timer()
+                timer_types = NotificationType.relevant_for_timerboard()
+                with self.subTest(notif_type=obj.notif_type):
+                    is_timer = obj.notif_type in timer_types
+                    is_added = obj.add_or_remove_timer()
+                    self.assertEqual(is_timer, is_added)
 
         @patch(MODULE_PATH + ".STRUCTURES_TIMERS_ARE_CORP_RESTRICTED", False)
         def test_corp_restriction_1(self):

{aa_structures-2.13.0 → aa_structures-2.14.0}/structures/tests/integration/test_tasks.py

@@ -7,7 +7,7 @@ import yaml
 
 from django.test import TestCase, override_settings
 from django.utils.timezone import now
-from eveuniverse.models import EveSolarSystem
+from eveuniverse.models import EvePlanet, EveSolarSystem
 
 from app_utils.django import app_labels
 from app_utils.esi import EsiStatus
@@ -22,11 +22,13 @@ from structures.tests.testdata.factories import (
     NotificationFactory,
     OwnerFactory,
     RawNotificationFactory,
+    SkyhookFactory,
     StarbaseFactory,
     StructureFactory,
     WebhookFactory,
     datetime_to_esi,
 )
+from structures.tests.testdata.helpers import NearestCelestial
 from structures.tests.testdata.load_eveuniverse import load_eveuniverse
 
 if "structuretimers" in app_labels():
@@ -613,3 +615,102 @@ class TestTasks(TestCase):
         self.assertEqual(len(embeds), 1)
         embed = embeds[0]
         self.assertIn("Territorial Claim Unit", embed.title)
+
+    @patch(OWNERS_PATH + ".STRUCTURES_FEATURE_SKYHOOKS", True)
+    def test_should_fetch_new_skyhooks_from_esi(
+        self, mock_esi_2, mock_esi, mock_execute
+    ):
+        # given
+        owner = OwnerFactory()
+        structure = SkyhookFactory(owner=owner)
+        eve_planet = EvePlanet.objects.get(id=40161469)
+        corporation_id = owner.corporation.corporation_id
+        endpoints = [
+            EsiEndpoint(
+                "Assets",
+                "get_corporations_corporation_id_assets",
+                "corporation_id",
+                needs_token=True,
+                data={
+                    str(corporation_id): [
+                        {
+                            "is_singleton": True,
+                            "item_id": structure.id,
+                            "location_flag": "AutoFit",
+                            "location_id": 30002537,
+                            "location_type": "solar_system",
+                            "quantity": 1,
+                            "type_id": 81080,
+                        },
+                    ]
+                },
+            ),
+            EsiEndpoint(
+                "Assets",
+                "post_corporations_corporation_id_assets_names",
+                "corporation_id",
+                needs_token=True,
+                data={str(corporation_id): []},
+            ),
+            EsiEndpoint(
+                "Assets",
+                "post_corporations_corporation_id_assets_locations",
+                "corporation_id",
+                needs_token=True,
+                data={
+                    str(corporation_id): [
+                        {"item_id": structure.id, "position": {"x": 1, "y": 2, "z": 3}}
+                    ]
+                },
+            ),
+            EsiEndpoint(
+                "Corporation",
+                "get_corporations_corporation_id_starbases",
+                "corporation_id",
+                needs_token=True,
+                data={str(corporation_id): []},
+            ),
+            EsiEndpoint(
+                "Corporation",
+                "get_corporations_corporation_id_structures",
+                "corporation_id",
+                needs_token=True,
+                data={str(corporation_id): []},
+            ),
+            EsiEndpoint(
+                "Planetary_Interaction",
+                "get_corporations_corporation_id_customs_offices",
+                "corporation_id",
+                needs_token=True,
+                data={str(corporation_id): []},
+            ),
+            EsiEndpoint(
+                "Sovereignty",
+                "get_sovereignty_map",
+                needs_token=False,
+                data=[],
+            ),
+            EsiEndpoint(
+                "Universe",
+                "get_universe_structures_structure_id",
+                "structure_id",
+                needs_token=True,
+                data={},
+            ),
+        ]
+        mock_esi.client = mock_esi_2.client = EsiClientStub.create_from_endpoints(
+            endpoints
+        )
+        structure_id = structure.id
+        structure.delete()
+        # when
+
+        with patch(OWNERS_PATH + ".EveSolarSystem.nearest_celestial") as m:
+            m.return_value = NearestCelestial(
+                eve_object=eve_planet,
+                distance=35_000_000,
+                eve_type=eve_planet.eve_type,
+            )
+            tasks.update_all_structures.delay()
+        # then
+        self.assertTrue(owner.structures.filter(id=structure_id).exists())

{aa_structures-2.13.0 → aa_structures-2.14.0}/structures/tests/integration/test_views.py

@@ -46,7 +46,7 @@ class TestStructureListView(TestCase):
         # then
         self.assertEqual(response.status_code, 200)
         self.assertEqual(response.context["structures_count"], 2)
-        self.assertEqual(response.context["pocos_count"], 1)
+        self.assertEqual(response.context["orbitals_count"], 1)
         self.assertEqual(response.context["starbases_count"], 1)
         self.assertEqual(response.context["jump_gates_count"], 1)
         self.assertIn("data_export", response.context)