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

ledger/helpers/cache.py

@@ -0,0 +1,105 @@
+# Standard Library
+from hashlib import md5
+
+# Django
+from django.core.cache import cache
+
+# Alliance Auth
+from allianceauth.services.hooks import get_extension_logger
+
+# AA Ledger
+from ledger.app_settings import (
+    LEDGER_CACHE_ENABLED,
+    LEDGER_CACHE_KEY,
+    LEDGER_CACHE_STALE,
+)
+from ledger.providers import AppLogger
+
+logger = AppLogger(get_extension_logger(__name__), "Ledger")
+
+
+class CacheManager:
+    """
+    Cache Manager for Ledger Data.
+    """
+
+    @staticmethod
+    def create_ledger_hash(ids: list[int]) -> str:
+        """
+        Create a hash from a list of IDs.
+
+        Args:
+            ids (list[int]): List of IDs to hash.
+
+        Returns:
+            str: The resulting hash string.
+        """
+        hash_object = md5()
+
+        # Handle empty ID list
+        if not ids:
+            return hash_object.hexdigest()
+
+        # Ensure consistent ordering
+        for _id in sorted(set(ids)):
+            hash_object.update(f"{_id},".encode())
+        return hash_object.hexdigest()
+
+    @staticmethod
+    def build_ledger_cache_key(header_key: str) -> str:
+        """Build a cache key for ledger data."""
+        logger.debug(f"Building Ledger Cache Key for Header Key: {header_key}")
+        return f"{LEDGER_CACHE_KEY}-{header_key}"
+
+    def get_cache_key(self, ledger_hash: str, key: str) -> str:
+        """
+        Get the cache for ledger data.
+
+        This function retrieves the cache for ledger data using a key for identification.
+
+        Args:
+            ledger_hash (str): The ledger hash to identify the cache.
+            key (str): The specific key for the cache data.
+        Returns:
+            (str | bool): The cached ledger data or False if not found.
+        """
+        cache_header = cache.get(ledger_hash, False)
+
+        logger.debug(f"Cache Header: {cache_header}, Journal Hash: {ledger_hash}")
+
+        journal_is_up_to_date = cache_header == ledger_hash
+        hash_key = self.build_ledger_cache_key(ledger_hash)
+
+        if journal_is_up_to_date and LEDGER_CACHE_ENABLED:
+            logger.debug(f"Ledger Cache Hit: {hash_key} for Key: {key}")
+            cached_ledger = cache.get(f"{hash_key}-{key}", False)
+            return cached_ledger
+        return False
+
+    def set_cache_key(self, key: str, ledger_hash: str, ledger_data) -> None:
+        """
+        Set the cache for ledger data.
+
+        This function sets the cache for ledger data using a key for identification.
+
+        Args:
+            key: (str): The specific key for the cache data.
+            ledger_hash (str): The ledger hash to identify the cache.
+            ledger_data (LedgerResponse): The ledger data to cache.
+        Returns:
+            None
+        """
+        hash_key = self.build_ledger_cache_key(ledger_hash)
+
+        if LEDGER_CACHE_ENABLED is False:
+            logger.debug("Caching is Disabled")
+            return False
+
+        logger.debug(f"Setting Cache: {hash_key} for Key: {key}")
+        # Set the data in the cache
+        cache.set(
+            key=f"{hash_key}-{key}", value=ledger_data, timeout=LEDGER_CACHE_STALE
+        )
+        # Set the cache header to indicate the cache is up-to-date
+        cache.set(key=ledger_hash, value=ledger_hash, timeout=None)
+        return True

ledger/helpers/discord.py

@@ -12,14 +12,12 @@ from allianceauth.authentication.models import User
 from allianceauth.notifications import notify
 from allianceauth.services.hooks import get_extension_logger
 
-# Alliance Auth (External Libs)
-from app_utils.logging import LoggerAddTag
-
 # AA Ledger
 from ledger import __title__
 from ledger.constants import DISCORD_EMBED_COLOR_MAP
+from ledger.providers import AppLogger
 
-logger = LoggerAddTag(get_extension_logger(__name__), __title__)
+logger = AppLogger(get_extension_logger(__name__), __title__)
 
 
 def allianceauth_discordbot_installed() -> bool:

ledger/helpers/eveonline.py

@@ -0,0 +1,160 @@
+"""This module provides helper functions to get EVE Online related images and renders."""
+
+# Django
+from django.utils.html import format_html
+from django.utils.translation import gettext_lazy as _
+
+# Alliance Auth
+from allianceauth.eveonline.evelinks.eveimageserver import (
+    alliance_logo_url,
+    character_portrait_url,
+    corporation_logo_url,
+    type_icon_url,
+    type_render_url,
+)
+
+
+def get_character_portrait_url(
+    character_id: int, size: int = 32, character_name: str = "", as_html: bool = False
+) -> str:
+    """
+    Get the character portrait for a character ID.
+
+    Args:
+        character_id (int): The ID of the character.
+        size (int, optional): The size of the portrait image.
+        character_name (str, optional): The name of the character.
+        as_html (bool, optional): Whether to return the portrait as an HTML img tag.
+    Returns:
+        str: The URL of the character portrait or an HTML img tag.
+    """
+    try:
+        render_url = character_portrait_url(character_id=character_id, size=size)
+    except ValueError:
+        return ""
+
+    if as_html:
+        render_html = format_html(
+            '<img class="character-portrait rounded-circle" src="{}" alt="{}">',
+            render_url,
+            character_name,
+        )
+        return render_html
+    return render_url
+
+
+def get_corporation_logo_url(
+    corporation_id: int,
+    size: int = 32,
+    corporation_name: str = "",
+    as_html: bool = False,
+) -> str:
+    """
+    Get the corporation logo for a corporation ID.
+
+    Args:
+        corporation_id (int): The ID of the corporation.
+        size (int, optional): The size of the logo image.
+        corporation_name (str, optional): The name of the corporation.
+        as_html (bool, optional): Whether to return the logo as an HTML img tag.
+    Returns:
+        str: The URL of the corporation logo or an HTML img tag.
+    """
+
+    render_url = corporation_logo_url(corporation_id=corporation_id, size=size)
+
+    if as_html:
+        render_html = format_html(
+            '<img class="corporation-logo rounded-circle" src="{}" alt="{}">',
+            render_url,
+            corporation_name,
+        )
+        return render_html
+    return render_url
+
+
+def get_alliance_logo_url(
+    alliance_id: int,
+    size: int = 32,
+    alliance_name: str = "",
+    as_html: bool = False,
+) -> str:
+    """
+    Get the alliance logo for a alliance ID.
+
+    Args:
+        alliance_id (int): The ID of the alliance.
+        size (int, optional): The size of the logo image.
+        alliance_name (str, optional): The name of the alliance.
+        as_html (bool, optional): Whether to return the logo as an HTML img tag.
+
+    Returns:
+        str: The URL of the alliance logo or an HTML img tag.
+    """
+
+    render_url = alliance_logo_url(alliance_id=alliance_id, size=size)
+
+    if as_html:
+        render_html = format_html(
+            '<img class="alliance-logo rounded-circle" src="{}" alt="{}">',
+            render_url,
+            alliance_name,
+        )
+        return render_html
+    return render_url
+
+
+def get_type_render_url(
+    type_id: int, size: int = 32, type_name: str = "", as_html: bool = False
+) -> str:
+    """
+    Get the type render for a type ID.
+
+    Args:
+        type_id (int): The ID of the type.
+        size (int, optional): The size of the render image.
+        type_name (str, optional): The name of the type.
+        as_html (bool): Whether to return the render as an HTML img tag.
+
+    Returns:
+        str: The URL of the type render or an HTML img tag.
+    """
+
+    render_url = type_render_url(type_id=type_id, size=size)
+
+    if as_html:
+        render_html = format_html(
+            '<img class="type-render rounded-circle" src="{}" alt="{}">',
+            render_url,
+            type_name,
+        )
+        return render_html
+    return render_url
+
+
+def get_icon_render_url(
+    type_id: int, size: int = 32, type_name: str = "", as_html: bool = False
+) -> str:
+    """
+    Get the icon render for a type ID.
+
+    Args:
+        type_id (int): The ID of the type.
+        size (int, optional): The size of the icon image.
+        type_name (str, optional): The name of the type.
+        as_html (bool): Whether to return the icon as an HTML img tag.
+
+    Returns:
+        str: The URL of the type icon or an HTML img tag.
+    """
+
+    render_url = type_icon_url(type_id=type_id, size=size)
+
+    if as_html:
+        render_html = format_html(
+            '<img class="type-render rounded-circle" data-bs-tooltip="aa-ledger" src="{}" title="{}">',
+            render_url,
+            type_name,
+        )
+        return render_html
+    return render_url

ledger/helpers/ledger_data.py

@@ -0,0 +1,23 @@
+# Standard Library
+from decimal import Decimal
+
+
+def get_footer_text_class(value: int | float | Decimal, mining=False) -> str:
+    """Get the text class for a value.
+
+    A positive value will return "text-success", a negative value will return "text-danger", and a zero value will return an empty string.
+    If the value is related to mining, a positive value will return "text-primary" instead of "text-success".
+
+    Args:
+        value (int | float | Decimal): The value to get the text class for.
+        mining (bool, optional): Whether the value is related to mining. Defaults to False.
+    Returns:
+        str: The text class for the value.
+    """
+    if value > 0:
+        if mining:
+            return "text-info"
+        return "text-success"
+    if value < 0:
+        return "text-danger"
+    return ""

ledger/helpers/ref_type.py

@@ -2,25 +2,19 @@
 
 # Standard Library
 import enum
-from typing import TYPE_CHECKING
 
 # Django
-from django.utils.translation import gettext as _
+from django.db import models
+from django.utils.translation import gettext_lazy as _
 
 # Alliance Auth
 from allianceauth.services.hooks import get_extension_logger
 
-# Alliance Auth (External Libs)
-from app_utils.logging import LoggerAddTag
-
 # AA Ledger
 from ledger import __title__
+from ledger.providers import AppLogger
 
-if TYPE_CHECKING:
-    # AA Ledger
-    from ledger.helpers.core import LedgerEntity
-
-logger = LoggerAddTag(get_extension_logger(__name__), __title__)
+logger = AppLogger(get_extension_logger(__name__), __title__)
 
 
 # Unified Journal Reference Type Enum - All ref types in one place
@@ -192,13 +186,30 @@ class JournalRefType(enum.Enum):
 class RefTypeManager:
     """Categories for wallet journal reference types."""
 
-    # Translations for reference types
-    _("Corporation Contract")
-    _("Corporation Withdrawal")
-    _("Mission Reward")
-    _("Market")
-    _("Daily Goal Reward")
-    _("Structure Rental")
+    class CategoryChoice(models.TextChoices):
+        BOUNTY = "BOUNTY", _("Bounty")
+        ESS = "ESS", _("ESS")
+        ASSETS = "ASSETS", _("Assets")
+        CONTRACT = "CONTRACT", _("Contract")
+        CORPORATION_ADMINISTRATION = "CORPORATION_ADMINISTRATION", _(
+            "Corporation Administration"
+        )
+        CORPORATION_CONTRACT = "CORPORATION_CONTRACT", _("Corporation Contract")
+        CORPORATION_WITHDRAWAL = "CORPORATION_WITHDRAWAL", _("Corporation Withdrawal")
+        DAILY_GOAL_REWARD = "DAILY_GOAL_REWARD", _("Daily Goal Reward")
+        DONATION = "DONATION", _("Donation")
+        FREELANCE_JOBS = "FREELANCE_JOBS", _("Freelance Jobs")
+        INCURSION = "INCURSION", _("Incursion")
+        INSURANCE = "INSURANCE", _("Insurance")
+        LP = "LP", _("LP Store")
+        MARKET = "MARKET", _("Market")
+        MISSION_REWARD = "MISSION_REWARD", _("Mission Reward")
+        PLANETARY = "PLANETARY", _("Planetary Interaction")
+        PRODUCTION = "PRODUCTION", _("Production")
+        SKILL = "SKILL", _("Skill Training")
+        STRUCTURE_RENTAL = "STRUCTURE_RENTAL", _("Structure Rental")
+        TRAVELING = "TRAVELING", _("Traveling Fees")
+        UNDEFINED = "UNDEFINED", _("Undefined")
 
     # Assets/Items
     ASSETS = [
@@ -372,6 +383,8 @@ class RefTypeManager:
     def get_all_categories(cls) -> dict[str, list[str]]:
         """Get all categories and their ref types, sorted alphabetically by key in the dict literal. Add NO_CATEGORY for missing JournalRefType."""
         categories = {
+            "BOUNTY": cls.BOUNTY_PRIZES,
+            "ESS": cls.ESS_TRANSFER,
             "ASSETS": cls.ASSETS,
             "CONTRACT": cls.CONTRACT,
             "CORPORATION_ADMINISTRATION": cls.CORPORATION_ADMINISTRATION,
@@ -400,76 +413,38 @@ class RefTypeManager:
         # Alle JournalRefType-Namen in Kleinbuchstaben
         all_types = {jt.name.lower() for jt in JournalRefType}
 
-        # Exclude Bounty and ESS
-        pve = set()
-        # Bounty-Prizes
-        if hasattr(cls, "BOUNTY_PRIZES"):
-            pve.update(cls.BOUNTY_PRIZES)
-        # ESS Transfer
-        if hasattr(cls, "ESS_TRANSFER"):
-            pve.update(cls.ESS_TRANSFER)
-
         # Nicht zugeordnete Typen bestimmen, aber special auslassen
-        not_defined = sorted((all_types - assigned) - pve)
+        not_defined = sorted(all_types - assigned)
         if not_defined:
-            categories["NOT_DEFINED_CATEGORY"] = not_defined
+            categories["UNDEFINED"] = not_defined
 
         return categories
 
     @classmethod
-    def all_ref_types(cls) -> list[str]:
-        """Get all ref types from all categories."""
+    def ledger_ref_types(cls) -> list[str]:
+        """
+        Get all ref types from all categories.
+
+        This is used to filter journal entries for ledger processing.
+
+        Excluding Bounty Prizes and ESS transfers for specific handling.
+        """
         all_ref_types = cls.get_all_categories()
         ref_types_items = []
         for __, ref_types in all_ref_types.items():
+            if __ in ["BOUNTY", "ESS"]:
+                continue
             ref_types_items.extend(ref_types)
         return ref_types_items
 
-    @staticmethod
-    def special_cases(row: dict, ids: set[int], account_char_ids: set[int]) -> bool:
-        """Handle special cases in Ledger."""
-        if isinstance(row, dict) is False:
-            logger.debug("Row is not a dictionary, skipping special case checks.")
-            return False
-
-        # Skip Market Transactions from buyer between the corporation and its members (only count transactions from creator)
-        if row["ref_type"] == "market_transaction" and row["first_party_id"] in ids:
-            return True
-
-        # Skip Contract if Contract Creator is Registered as a Member of the Corporation (only count the contract creator)
-        if (
-            row["ref_type"] == "contract_price_payment_corp"
-            and row["first_party_id"] in account_char_ids
-            and row["second_party_id"] in ids
-        ):
-            return True
-        return False
-
-    @staticmethod
-    def special_cases_details(
-        value: list,
-        entity: "LedgerEntity",
-        kwargs: dict[str, int],
-        journal_type: str,
-        char_ids: set[int] = None,
-    ) -> bool:
-        """Handle special cases in Ledger for Details View."""
-        # Skip Contract if Contract Creator is Registered as a Member of the Corporation (only count the contract creator)
-        if (
-            "contract_price_payment_corp" in value
-            and entity.type == "character"
-            and journal_type == "corporation"
-        ):  # Only Count Contract Creator
-            kwargs["first_party"] = entity.entity_id
-            return kwargs
-
-        # Skip Player Donation if it is to own alts
-        if (
-            "player_donation" in value
-            and entity.is_eve_character
-            and journal_type == "character"
-        ):
-            if char_ids is None:
-                return kwargs
-            kwargs["exclude"] = char_ids
-        return kwargs
+    @classmethod
+    def all_ref_types(cls) -> list[str]:
+        """
+        Get all ref types from all categories.
+        This is used to get a complete list of all reference types.
+        """
+        all_ref_types = cls.get_all_categories()
+        ref_types_items = []
+        for __, ref_types in all_ref_types.items():
+            ref_types_items.extend(ref_types)
+        return ref_types_items