aa-ledger 1.0.4__py3-none-any.whl → 2.0.0__py3-none-any.whl

ledger/api/{helpers.py → helpers/core.py}

@@ -6,23 +6,21 @@ from django.db.models import QuerySet
 from allianceauth.eveonline.models import EveAllianceInfo
 from allianceauth.services.hooks import get_extension_logger
 
-# Alliance Auth (External Libs)
-from app_utils.logging import LoggerAddTag
-
 # AA Ledger
 from ledger import __title__, models
+from ledger.providers import AppLogger
 
-logger = LoggerAddTag(get_extension_logger(__name__), __title__)
+logger = AppLogger(get_extension_logger(__name__), __title__)
 
 
-def get_character_or_none(
+def get_characterowner_or_none(
     request, character_id
-) -> tuple[bool, models.CharacterAudit | None]:
+) -> tuple[bool, models.CharacterOwner | None]:
     """Get Character and check permissions"""
     perms = True
 
     try:
-        character = models.CharacterAudit.objects.get(
+        owner = models.CharacterOwner.objects.get(
             eve_character__character_id=character_id
         )
     except ObjectDoesNotExist:
@@ -31,27 +29,27 @@ def get_character_or_none(
         return None, None
 
     # check access
-    visible = models.CharacterAudit.objects.visible_eve_characters(request.user)
-    if character.eve_character not in visible:
+    visible = models.CharacterOwner.objects.visible_eve_characters(request.user)
+    if owner.eve_character not in visible:
         perms = False
-    return perms, character
+    return perms, owner
 
 
-def get_corporation(
+def get_corporationowner_or_none(
     request, corporation_id
-) -> tuple[bool | None, models.CorporationAudit | None]:
+) -> tuple[bool | None, models.CorporationOwner | None]:
     """Return Corporation and check permissions"""
     perms = True
 
     try:
-        main_corp = models.CorporationAudit.objects.get(
-            corporation__corporation_id=corporation_id
+        main_corp = models.CorporationOwner.objects.get(
+            eve_corporation__corporation_id=corporation_id
         )
     except ObjectDoesNotExist:
         return None, None
 
     # Check access
-    visible = models.CorporationAudit.objects.visible_to(request.user)
+    visible = models.CorporationOwner.objects.visible_to(request.user)
     if main_corp not in visible:
         perms = False
     return perms, main_corp
@@ -59,37 +57,39 @@ def get_corporation(
 
 def get_manage_corporation(
     request, corporation_id
-) -> tuple[bool | None, models.CorporationAudit | None]:
+) -> tuple[bool | None, models.CorporationOwner | None]:
     """Returns a tuple of the permissions and the corporation object if manageable"""
     perms = True
 
     try:
-        main_corp = models.CorporationAudit.objects.get(
-            corporation__corporation_id=corporation_id
+        main_corp = models.CorporationOwner.objects.get(
+            eve_corporation__corporation_id=corporation_id
         )
     except ObjectDoesNotExist:
         return None, None
 
     # Check access
-    visible = models.CorporationAudit.objects.manage_to(request.user)
+    visible = models.CorporationOwner.objects.manage_to(request.user)
     if main_corp not in visible:
         perms = False
     return perms, main_corp
 
 
-def get_alliance(request, alliance_id) -> tuple[bool | None, EveAllianceInfo | None]:
+def get_alliance_or_none(
+    request, alliance_id
+) -> tuple[bool | None, EveAllianceInfo | None]:
     """Get Alliance and check permissions for each corporation"""
     perms = True
 
-    corporations = models.CorporationAudit.objects.filter(
-        corporation__alliance__alliance_id=alliance_id
+    corporations = models.CorporationOwner.objects.filter(
+        eve_corporation__alliance__alliance_id=alliance_id
     )
 
     if not corporations.exists():
         return None, None
 
     # Check access
-    visible = models.CorporationAudit.objects.visible_to(request.user)
+    visible = models.CorporationOwner.objects.visible_to(request.user)
 
     # Check if there is an intersection between main_corp and visible
     common_corps = corporations.intersection(visible)
@@ -102,19 +102,19 @@ def get_alliance(request, alliance_id) -> tuple[bool | None, EveAllianceInfo | N
 
 def get_all_corporations_from_alliance(
     request, alliance_id
-) -> tuple[bool | None, list[models.CorporationAudit] | None]:
+) -> tuple[bool | None, list[models.CorporationOwner] | None]:
     """Get Alliance and check permissions for each corporation"""
     perms = True
 
-    corporations = models.CorporationAudit.objects.filter(
-        corporation__alliance__alliance_id=alliance_id
+    corporations = models.CorporationOwner.objects.filter(
+        eve_corporation__alliance__alliance_id=alliance_id
     )
 
     if not corporations.exists():
         return None, None
 
     # Check access
-    visible = models.CorporationAudit.objects.visible_to(request.user)
+    visible = models.CorporationOwner.objects.visible_to(request.user)
 
     # Check if there is an intersection between main_corp and visible
     common_corps = corporations.intersection(visible)
@@ -124,19 +124,19 @@ def get_all_corporations_from_alliance(
 
 
 def get_alts_queryset(
-    character: models.CharacterAudit,
-) -> QuerySet[list[models.CharacterAudit]]:
+    owner: models.CharacterOwner,
+) -> QuerySet[list[models.CharacterOwner]]:
     """Get all alts for a main character."""
     try:
         linked_characters = (
-            character.eve_character.character_ownership.user.character_ownerships.all()
+            owner.eve_character.character_ownership.user.character_ownerships.all()
         )
 
         linked_characters = linked_characters.values_list("character_id", flat=True)
-        return models.CharacterAudit.objects.filter(
+        return models.CharacterOwner.objects.filter(
             eve_character__id__in=linked_characters
         )
     except ObjectDoesNotExist:
-        return models.CharacterAudit.objects.filter(
-            eve_character__pk=character.eve_character.pk
+        return models.CharacterOwner.objects.filter(
+            eve_character__pk=owner.eve_character.pk
         )

ledger/api/helpers/icons.py

@@ -0,0 +1,372 @@
+# Django
+from django.db import models
+from django.urls import reverse
+from django.utils.translation import gettext_lazy as _
+
+# Alliance Auth
+from allianceauth.authentication.models import CharacterOwnership
+from allianceauth.services.hooks import get_extension_logger
+
+# AA Ledger
+from ledger import __title__
+from ledger.api.schema import (
+    AllianceLedgerRequestInfo,
+    CorporationLedgerRequestInfo,
+    OwnerLedgerRequestInfo,
+)
+from ledger.helpers.eveonline import get_character_portrait_url
+from ledger.models.planetary import CharacterPlanetDetails
+from ledger.providers import AppLogger
+
+logger = AppLogger(get_extension_logger(__name__), __title__)
+
+
+def get_factory_info_button(
+    planet_details: CharacterPlanetDetails,
+) -> str:
+    """
+    Generate a Factory Info button for the Planetary View.
+
+    When clicked, it triggers a modal to display detailed information about the Factory.
+
+    Args:
+        planet_details (CharacterPlanetDetails): The planetary details object to be viewed.
+    Returns:
+        String: HTML string containing the info button.
+    """
+
+    # Generate the URL for the delete Request
+    button_request_info_url = reverse(
+        "ledger:api:get_factory_details",
+        kwargs={
+            "character_id": planet_details.character.eve_character.character_id,
+            "planet_id": planet_details.planet.id,
+        },
+    )
+
+    # Define the icon and tooltip for the delete button
+    icon = '<i class="fa-solid fa-info"></i>'
+    title = _("View Factory")
+    color = "primary"
+
+    # Create the HTML for the delete icon button
+    factory_info_button = (
+        f'<button data-action="{button_request_info_url}" '
+        f'class="btn btn-{color} btn-sm btn-square me-2" '
+        'data-bs-toggle="modal" '
+        'data-bs-tooltip="aa-ledger" '
+        'data-bs-target="#ledger-view-planetary-factory" '
+        f'title="{title}">{icon}</button>'
+    )
+    return factory_info_button
+
+
+def get_extractor_info_button(
+    planet_details: CharacterPlanetDetails,
+) -> str:
+    """
+    Generate a Extractor Info button for the Planetary View.
+
+    When clicked, it triggers a modal to display detailed information about the Extractor.
+
+    Args:
+        planet_details (CharacterPlanetDetails): The planetary details object to be viewed.
+    Returns:
+        String: HTML string containing the info button.
+    """
+
+    # Generate the URL for the delete Request
+    button_request_info_url = reverse(
+        "ledger:api:get_extractor_details",
+        kwargs={
+            "character_id": planet_details.character.eve_character.character_id,
+            "planet_id": planet_details.planet.id,
+        },
+    )
+
+    # Define the icon and tooltip for the delete button
+    icon = '<i class="fa-solid fa-info"></i>'
+    title = _("View Extractor")
+    color = "primary"
+
+    # Create the HTML for the delete icon button
+    extractor_info_button = (
+        f'<button data-action="{button_request_info_url}" '
+        f'class="btn btn-{color} btn-sm btn-square me-2" '
+        'data-bs-toggle="modal" '
+        'data-bs-tooltip="aa-ledger" '
+        'data-bs-target="#ledger-view-planetary-extractor" '
+        f'title="{title}">{icon}</button>'
+    )
+    return extractor_info_button
+
+
+def get_toggle_notification_button(
+    planet_details: CharacterPlanetDetails,
+) -> str:
+    """
+    Generate a Notification Toggle button for the Planetary View.
+
+    When clicked, it triggers a modal to confirm the action.
+
+    Args:
+        planet_details (CharacterPlanetDetails): The planetary details object to be viewed.
+    Returns:
+        String: HTML string containing the info button.
+    """
+
+    # Generate the URL for the delete Request
+    button_request_info_url = reverse(
+        "ledger:api:toggle_planet_notification",
+        kwargs={
+            "character_id": planet_details.character.eve_character.character_id,
+            "planet_id": planet_details.planet.id,
+        },
+    )
+
+    # Define the icon and tooltip for the delete button
+    icon = '<i class="fa-solid fa-bullhorn"></i>'
+    title = _("Toggle Notification")
+    color = "primary"
+
+    # Create the HTML for the delete icon button
+    notification_toggle_button = (
+        f'<button data-action="{button_request_info_url}" '
+        f'class="btn btn-{color} btn-sm btn-square me-2" '
+        'data-bs-toggle="modal" '
+        'data-bs-tooltip="aa-ledger" '
+        'data-bs-target="#ledger-accept-planet-toggle-notification" '
+        f'title="{title}">{icon}</button>'
+    )
+    return notification_toggle_button
+
+
+def get_character_details_info_button(
+    character_id: int,
+    request_info: OwnerLedgerRequestInfo,
+    section: str = "summary",
+) -> str:
+    """
+    Generate a Character Details Info button for the Character Ledger View.
+
+    When clicked, it triggers a modal to display detailed information about the Character.
+
+    Args:
+        character_id (int): The character ID to be viewed.
+        request_info (LedgerRequestInfo): The request information containing date and section details.
+        section (str, optional): The section of the ledger to view.
+    Returns:
+        String: HTML string containing the info button.
+    """
+
+    kwargs = {"character_id": character_id, "section": section}
+    if request_info.year is not None:
+        kwargs["year"] = request_info.year
+    if request_info.month is not None:
+        kwargs["month"] = request_info.month
+    if request_info.day is not None:
+        kwargs["day"] = request_info.day
+
+    # Generate the URL for the Info Request
+    button_request_info_url = reverse(
+        "ledger:api:get_character_ledger_details", kwargs=kwargs
+    )
+
+    # Define the icon and tooltip for the Info button
+    icon = '<i class="fa-solid fa-info"></i>'
+    title = _("View Details")
+    color = "primary"
+
+    # Create the HTML for the Info icon button
+    ledger_info_button = (
+        f'<button data-action="{button_request_info_url}" '
+        f'class="btn btn-{color} btn-sm btn-square me-2" '
+        'data-bs-toggle="modal" '
+        'data-bs-tooltip="aa-ledger" '
+        'data-bs-target="#ledger-view-character-ledger-details" '
+        f'title="{title}">{icon}</button>'
+    )
+    return ledger_info_button
+
+
+def get_ref_type_details_popover_button(
+    ref_types: list[str],
+) -> str:
+    """
+    Generate a Character Details Popover button for the Character Ledger View.
+
+    When hover, it triggers a popover to display information about the Ref Types.
+
+    Args:
+        ref_types (list[str]): The list of reference types to be viewed.
+    Returns:
+        String: HTML string containing the popover button.
+    """
+
+    # Define the icon and tooltip for the Ref Type button
+    icon = '<i class="fa-solid fa-info-circle"></i>'
+    title = _("Included Reference Types")
+    color = "primary"
+
+    # Create the HTML for the popover icon button
+    ledger_popover_button = (
+        f"<button "
+        f'class="btn btn-{color} btn-sm btn-square me-2" '
+        'data-bs-toggle="popover" '
+        'data-bs-popover="aa-ledger" '
+        'data-bs-trigger="hover" '
+        'data-bs-placement="top" '
+        'data-bs-html="true" '
+        f'data-bs-content="{", ".join(ref_types)}" '
+        f'title="{title}">{icon}</button>'
+    )
+    return ledger_popover_button
+
+
+def get_corporation_ledger_popover_button(
+    alts: models.QuerySet[CharacterOwnership],
+) -> str:
+    """
+    Generate a Corporation Ledger Popover button for the Corporation Ledger View.
+
+    When hover, it triggers a popover to display information about all Alt characters from the Account.
+
+    Args:
+        alts (models.QuerySet[CharacterOwnership]): The queryset of alt characters to be viewed.
+    Returns:
+        String: HTML string containing the popover button.
+    """
+    if not alts:
+        return ""
+
+    # Define the icon and tooltip for the Ref Type button
+    title = _("Included Alt Characters")
+
+    pieces: list[str] = []
+    for alt in alts:
+        portrait = get_character_portrait_url(
+            character_id=alt.character.character_id,
+            character_name=alt.character.character_name,
+            size=32,
+            as_html=True,
+        )
+        pieces.append(f"{portrait} {alt.character.character_name}<br>")
+
+    # join HTML, escape double-quotes for safe attribute embedding
+    content_html = "".join(pieces).replace('"', "&quot;")
+
+    ledger_popover_icon = (
+        f'<i class="fa-solid fa-circle-question" '
+        f'data-bs-toggle="popover" '
+        'data-bs-popover="aa-ledger" '
+        'data-bs-trigger="hover" '
+        'data-bs-placement="top" '
+        'data-bs-html="true" '
+        f'data-bs-content="{content_html}" '
+        f'title="{title}"></i>'
+    )
+    return ledger_popover_icon
+
+
+def get_corporation_details_info_button(
+    entity_id: int,
+    request_info: CorporationLedgerRequestInfo,
+    section: str = "summary",
+) -> str:
+    """
+    Generate a Entity Details Info button for the Corporation Ledger View.
+
+    When clicked, it triggers a modal to display detailed information about the Entity.
+
+    Args:
+        entity_id (int): The entity ID to be viewed.
+        request_info (CorporationLedgerRequestInfo): The request information containing date and section details.
+        section (str, optional): The section of the ledger to view.
+    Returns:
+        String: HTML string containing the info button.
+    """
+
+    kwargs = {
+        "corporation_id": request_info.owner_id,
+        "entity_id": entity_id,
+        "section": section,
+    }
+    if request_info.year is not None:
+        kwargs["year"] = request_info.year
+    if request_info.month is not None:
+        kwargs["month"] = request_info.month
+    if request_info.day is not None:
+        kwargs["day"] = request_info.day
+
+    # Generate the URL for the Info Request
+    button_request_info_url = reverse(
+        "ledger:api:get_corporation_ledger_details", kwargs=kwargs
+    )
+
+    # Define the icon and tooltip for the Info button
+    icon = '<i class="fa-solid fa-info"></i>'
+    title = _("View Details")
+    color = "primary"
+
+    # Create the HTML for the Info icon button
+    ledger_info_button = (
+        f'<button data-action="{button_request_info_url}" '
+        f'class="btn btn-{color} btn-sm btn-square me-2" '
+        'data-bs-toggle="modal" '
+        'data-bs-tooltip="aa-ledger" '
+        'data-bs-target="#ledger-view-corporation-ledger-details" '
+        f'title="{title}">{icon}</button>'
+    )
+    return ledger_info_button
+
+
+def get_alliance_details_info_button(
+    entity_id: int,
+    request_info: AllianceLedgerRequestInfo,
+    section: str = "summary",
+) -> str:
+    """
+    Generate a Entity Details Info button for the Corporation Ledger View.
+
+    When clicked, it triggers a modal to display detailed information about the Entity.
+
+    Args:
+        entity_id (int): The entity ID to be viewed.
+        request_info (AllianceLedgerRequestInfo): The request information containing date and section details.
+        section (str, optional): The section of the ledger to view.
+    Returns:
+        String: HTML string containing the info button.
+    """
+
+    kwargs = {
+        "alliance_id": request_info.owner_id,
+        "entity_id": entity_id,
+        "section": section,
+    }
+    if request_info.year is not None:
+        kwargs["year"] = request_info.year
+    if request_info.month is not None:
+        kwargs["month"] = request_info.month
+    if request_info.day is not None:
+        kwargs["day"] = request_info.day
+
+    # Generate the URL for the Info Request
+    button_request_info_url = reverse(
+        "ledger:api:get_alliance_ledger_details", kwargs=kwargs
+    )
+
+    # Define the icon and tooltip for the Info button
+    icon = '<i class="fa-solid fa-info"></i>'
+    title = _("View Details")
+    color = "primary"
+
+    # Create the HTML for the Info icon button
+    ledger_info_button = (
+        f'<button data-action="{button_request_info_url}" '
+        f'class="btn btn-{color} btn-sm btn-square me-2" '
+        'data-bs-toggle="modal" '
+        'data-bs-tooltip="aa-ledger" '
+        'data-bs-target="#ledger-view-alliance-ledger-details" '
+        f'title="{title}">{icon}</button>'
+    )
+    return ledger_info_button