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

ledger/templates/ledger/view-character-planetary-overview.html

@@ -0,0 +1,135 @@
+{% extends 'ledger/base.html' %}
+{% load i18n %}
+
+{% block page_template_title %}
+    {{ title }}
+{% endblock page_template_title %}
+
+{% block page_topic %}
+    <h1 class="page-header text-center">
+        {{ title }}
+    </h1>
+{% endblock page_topic %}
+
+{% block aaledger_header %}
+    <div class="card">
+        <div class="card-header bg-primary rounded d-flex align-items-center">
+            <h3 class="text-white">{% translate "Planetary Overview" %}</h3>
+        </div>
+    </div>
+{% endblock %}
+
+{% block ledger_block %}
+    <div class="card card-body mt-2 rounded">
+        <div class="table-responsive">
+            <table class="table table-striped table-hover w-100" id="overview-table">
+                <thead>
+                    <th class="col-portrait" style="width: 10%;"></th>
+                    <th class="col-user" style="width: 20%;">Character</th>
+                    <th class="col-group" style="width: 20%;">Corporation</th>
+                    <th class="col-actions" style="width: 10%;">{% trans "Actions" %}</th>
+                </thead>
+                <tbody></tbody>
+            </table>
+        </div>
+    </div>
+{% endblock %}
+
+
+{% block extra_css %}
+    {% include 'bundles/datatables-2-css-bs5.html' %}
+    {% include 'bundles/datatables-2-columncontrol-css-bs5.html' %}
+    {% include 'ledger/bundles/aa-ledger-css.html' %}
+{% endblock %}
+
+{% block extra_javascript %}
+    {% include 'ledger/bundles/aa-ledger-js.html' %}
+    {% include 'bundles/datatables-2-js-bs5.html' %}
+    {% include 'bundles/datatables-2-columncontrol-js-bs5.html' %}
+    <script type="application/javascript">
+        /* global aaLedgerSettings, aaLedgerSettingsOverride, _bootstrapTooltip, fetchGet, bootstrap, DataTable*/
+        $(document).ready(() => {
+            /**
+             * Overview :: Urls
+            */
+            const AdminUrl = "{% url 'ledger:api:get_planetary_overview' %}"
+            const PlanetaryOverviewUrl = "{% url 'ledger:planetary_ledger' character_id=1337 %}"
+
+            /**
+            * Table :: IDs
+            */
+            const overviewTable = $('#overview-table');
+
+            fetchGet({
+                url: AdminUrl,
+            })
+            .then((data) => {
+                if (data) {
+                    /**
+                    * DataTable for Corporation Overview Table
+                    * @type {*|jQuery}
+                    */
+                    const overviewDataTable = new DataTable(overviewTable, {
+                        data: Object.values(data[0].character),
+                        language: aaLedgerSettings.dataTables.language,
+                        layout: aaLedgerSettings.dataTables.layout,
+                        ordering: aaLedgerSettings.dataTables.ordering,
+                        columnControl: aaLedgerSettings.dataTables.columnControl,
+                        order: [[1, 'asc']],
+                        columns: [
+                            {
+                                data: 'character_id'
+                            },
+                            {
+                                data: 'character_name'
+                            },
+                            {
+                                data: 'corporation_name'
+                            },
+                        ],
+                        columnDefs: [
+                            {
+                                targets: 0,
+                                render: function (data, type, row) {
+                                    return '<img src="https://images.evetech.net/characters/' + row.character_id + '/portrait?size=32" class="rounded-circle" title="' + row.character_name + '" height="30" data-tooltip-toggle="char-tooltip" data-bs-placement="top">';
+                                },
+                                columnControl: [
+                                    {target: 0, content: []},
+                                    {target: 1, content: []}
+                                ]
+                            },
+                            {
+                                targets: 3,
+                                columnControl: [
+                                    {target: 0, content: []},
+                                    {target: 1, content: []}
+                                ],
+                                render: function (data, type, row) {
+                                    var OverviewUrl = PlanetaryOverviewUrl.replace('1337', row.character_id);
+                                    return `<a href="${OverviewUrl}">
+                                        <button class="btn btn-primary btn-sm"
+                                            title="{% trans "Show" %}"
+                                            data-bs-tooltip="aa-ledger"
+                                            data-bs-placement="left"
+                                        >
+                                            <i class="fa-solid fa-eye"></i>
+                                        </button>
+                                    </a>`;
+                                },
+                            }
+                        ],
+                        initComplete: function() {
+                            _bootstrapTooltip({selector: '#overview-table'});
+                        },
+                        drawCallback: function() {
+                            _bootstrapTooltip({selector: '#overview-table'});
+                        }
+                    })
+                }
+            })
+            .catch((error) => {
+                console.error('Error fetching Character Ledger data:', error);
+            });
+        });
+    </script>
+{% endblock %}

ledger/templates/ledger/view-character-planetary.html

@@ -0,0 +1,73 @@
+{% extends 'ledger/base.html' %}
+{% load i18n %}
+{% load sri %}
+
+{% block page_template_title %}
+    {{ title }}
+{% endblock page_template_title %}
+
+{% block page_topic %}
+    <h1 class="page-header text-center">
+        {{ title }}
+    </h1>
+{% endblock page_topic %}
+
+{% block aaledger_header %}
+    <div class="card">
+        <div class="card-header bg-primary rounded d-flex align-items-center">
+            <h3>{% translate "Planetary Details" %} </h3>
+            <div class="ms-auto">
+                <a class="nav-link py-0" href="{% url 'ledger:planetary_overview' %}">
+                    <span class="btn btn-secondary">{% translate 'Planetary Overview' %}</span>
+                </a>
+            </div>
+        </div>
+    </div>
+{% endblock %}
+
+{% block ledger_block %}
+    {% include 'ledger/partials/view-character-planetary/planetary-table.html' %}
+{% endblock %}
+
+{% block extra_css %}
+    {% include 'bundles/datatables-2-css-bs5.html' %}
+    {% include 'bundles/datatables-2-columncontrol-css-bs5.html' %}
+    {% include 'ledger/bundles/aa-ledger-css.html' %}
+    {% include 'ledger/bundles/view-character-planetary-css.html' %}
+{% endblock %}
+
+{% block extra_javascript %}
+    <script>
+        const urlParams = new URLSearchParams(window.location.search);
+        const singleViewParms = urlParams.get('single');
+
+        /**
+         * Override settings for aaLedger
+         */
+        const aaLedgerSettingsOverride = {
+            characterPk: '{{ character_id }}',
+            updateInterval: '{{ update_interval }}',
+            url: {
+                Planetary: '{% url "ledger:api:get_planetarydetails" character_id=character_id planet_id=0 %}',
+            },
+            translations: {
+                confirmSwitchAlarm: '{% translate "Are you sure to Switch Notification" %}',
+                buttonSwitchAlarm: '{% translate "Switch Notification" %}',
+                notificationActivated: '{% translate "Notification Activated" %}',
+                notificationDeactivated: '{% translate "Notification Deactivated" %}',
+            }
+        };
+
+        // Construct the planetaryUrl with the 'main' parameter
+        if (singleViewParms) {
+            aaLedgerSettings.url.Planetary += '?single=' + singleViewParms;
+        }
+    </script>
+    {% include 'ledger/partials/modal/request-accept-switch-notification.html' %}
+    {% include 'ledger/partials/modal/request-view-factory.html' %}
+    {% include 'ledger/partials/modal/request-view-extractor.html' %}
+    {% include 'ledger/bundles/aa-ledger-js.html' %}
+    {% include 'bundles/datatables-2-js-bs5.html' %}
+    {% include 'bundles/datatables-2-columncontrol-js-bs5.html' %}
+    {% include 'ledger/bundles/view-character-planetary-js.html' %}
+{% endblock %}

ledger/templates/ledger/view-corporation-administration.html

@@ -0,0 +1,42 @@
+{% extends 'ledger/base.html' %}
+{% load i18n %}
+
+{% block page_template_title %}
+    {{ title }}
+{% endblock page_template_title %}
+
+{% block page_topic %}
+    <h1 class="page-header text-center">
+        {{ title }}
+    </h1>
+{% endblock page_topic %}
+
+{% block aaledger_header %}
+    <div class="card">
+        <div class="card-header bg-primary rounded d-flex align-items-center">
+            <h3 class="me-3">{% translate "Administration" %}</h3>
+        </div>
+    </div>
+{% endblock %}
+
+{% block ledger_block %}
+    <!-- Corporation Administration -->
+    <div class="card card-corporation-administration mt-2 rounded">
+        <div class="card-body">
+            <div class="row">
+                <div class="col-lg-6 col-md-12">
+                    {% include 'ledger/partials/view-corporation-administration/dashboard.html' %}
+                </div>
+                <div class="col-lg-6 col-md-12">
+                    {% include 'ledger/partials/view-corporation-administration/corporation.html' %}
+                </div>
+            </div>
+            {% include 'ledger/partials/view-corporation-administration/corporation_characters.html' %}
+        </div>
+    </div>
+{% endblock %}
+
+{% block extra_javascript %}
+    {% include 'bundles/datatables-js-bs5.html' %}
+    {% include 'ledger/bundles/view-corporation-administration-js.html' %}
+{% endblock %}

ledger/templates/ledger/view-corporation-ledger.html

@@ -0,0 +1,73 @@
+{% extends 'ledger/base.html' %}
+{% load i18n %}
+
+{% block page_template_title %}
+    {{ title }}
+{% endblock page_template_title %}
+
+{% block page_topic %}
+    <h1 class="page-header text-center">
+        {{ title }}
+    </h1>
+{% endblock page_topic %}
+
+{% block aaledger_header %}
+    <div class="card">
+        <div class="card-header bg-primary rounded d-flex align-items-center">
+            <h3 class="me-3">{% translate "Corporation Ledger" %}</h3>
+            <div id="dropdown corporation-ledger-dropdown-buttons me-2" class="d-flex">
+                {% if forms.corporation_dropdown %}
+                    <div class="me-2">
+                        <form id="corporation-ledger-dropdown-form" method="post" href="{% url 'ledger:corporation_ledger' corporation_id=corporation_id %}" class="d-flex">
+                            {% csrf_token %}
+                            {{ forms.corporation_dropdown.division }}
+                            {{ forms.corporation_dropdown.year }}
+                            {{ forms.corporation_dropdown.month }}
+                            {{ forms.corporation_dropdown.day }}
+                            <button id="corporation-ledger-submit" type="submit" class="btn btn-success">{% translate "Submit" %}</button>
+                        </form>
+                    </div>
+                {% endif %}
+            </div>
+            <div class="ms-auto">
+                <a class="btn btn-secondary me-2 administration" href="{% url 'ledger:corporation_administration' corporation_id=corporation_id %}" class="administration">{% translate 'Administration' %}{% if issues %} <span class="badge bg-warning">{{ issues }}</span>{% endif %}</a>
+                <a href="{% url 'ledger:corporation_overview' %}" class="overview"><button class="btn btn-secondary overview">{% translate 'Account Overview' %}</button></a>
+            </div>
+        </div>
+    </div>
+{% endblock %}
+
+{% block ledger_block %}
+    {% include 'ledger/partials/view-corporation-ledger/corporation-table.html' %}
+    {% include 'ledger/partials/view-corporation-ledger/corporation-billboard.html' %}
+{% endblock %}
+
+{% block extra_css %}
+    {% include 'bundles/datatables-2-css-bs5.html' %}
+    {% include 'bundles/datatables-2-columncontrol-css-bs5.html' %}
+    {% include 'ledger/bundles/aa-ledger-css.html' %}
+{% endblock %}
+
+{% block extra_javascript %}
+    <script>
+        /**
+         * Override settings for aaLedger
+         */
+        const aaLedgerSettingsOverride = {
+            corporationPk: '{{ corporation_id }}',
+            url: {
+                CorporationLedger: "{{ ledger_url }}",
+            },
+            translations: {
+                ledgerTable: {
+                    summary: "{% translate 'Summary' %}"
+                }
+            }
+        };
+    </script>
+    {% include 'ledger/partials/modal/request-view-corporation-details.html' %}
+    {% include 'ledger/bundles/aa-ledger-js.html' %}
+    {% include 'bundles/datatables-2-js-bs5.html' %}
+    {% include 'bundles/datatables-2-columncontrol-js-bs5.html' %}
+    {% include 'ledger/bundles/view-corporation-ledger-js.html' %}
+{% endblock extra_javascript %}

ledger/templates/ledger/view-corporation-overview.html

@@ -0,0 +1,131 @@
+{% extends 'ledger/base.html' %}
+{% load i18n %}
+
+{% block page_template_title %}
+    {{ title }}
+{% endblock page_template_title %}
+
+{% block page_topic %}
+    <h1 class="page-header text-center">
+        {{ title }}
+    </h1>
+{% endblock page_topic %}
+
+{% block aaledger_header %}
+    <div class="card">
+        <div class="card-header bg-primary rounded d-flex align-items-center">
+            <h3 class="text-white">{% translate "Corporation Overview" %}</h3>
+        </div>
+    </div>
+{% endblock %}
+
+{% block ledger_block %}
+    <div class="card card-body mt-2 rounded">
+        <div class="table-responsive">
+            <table class="table table-striped table-hover w-100" id="overview-table">
+                <thead>
+                    <th class="w-auto"></th>
+                    <th class="w-auto">{% translate "Corporation" %}</th>
+                    <th class="w-auto">{% translate "Actions" %}</th>
+                </thead>
+                <tbody></tbody>
+            </table>
+        </div>
+    </div>
+{% endblock %}
+
+{% block extra_css %}
+    {% include 'bundles/datatables-2-css-bs5.html' %}
+    {% include 'bundles/datatables-2-columncontrol-css-bs5.html' %}
+    {% include 'ledger/bundles/aa-ledger-css.html' %}
+{% endblock %}
+
+{% block extra_javascript %}
+    {% include 'ledger/bundles/aa-ledger-js.html' %}
+    {% include 'bundles/datatables-2-js-bs5.html' %}
+    {% include 'bundles/datatables-2-columncontrol-js-bs5.html' %}
+    <script type="application/javascript">
+        /* global aaLedgerSettings, aaLedgerSettingsOverride, _bootstrapTooltip, fetchGet, bootstrap, DataTable*/
+        $(document).ready(() => {
+            /**
+             * Overview :: Urls
+            */
+            const AdminUrl = "{% url 'ledger:api:get_corporation_overview' %}"
+            const CorporationOverviewUrl = "{% url 'ledger:corporation_ledger' corporation_id=1337 year=year month=month %}"
+
+            /**
+            * Table :: IDs
+            */
+            const overviewTable = $('#overview-table');
+
+            fetchGet({
+                url: AdminUrl,
+            })
+            .then((data) => {
+                if (data) {
+                    /**
+                    * DataTable for Corporation Overview Table
+                    * @type {*|jQuery}
+                    */
+                    const overviewDataTable = new DataTable(overviewTable, {
+                        data: Object.values(data[0].corporation),
+                        language: aaLedgerSettings.dataTables.language,
+                        layout: aaLedgerSettings.dataTables.layout,
+                        ordering: aaLedgerSettings.dataTables.ordering,
+                        columnControl: aaLedgerSettings.dataTables.columnControl,
+                        order: [[1, 'asc']],
+                        columns: [
+                            {
+                                data: 'corporation_id'
+                            },
+                            {
+                                data: 'corporation_name'
+                            }
+                        ],
+                        columnDefs: [
+                            {
+                                targets: 0,
+                                render: function (data, type, row) {
+                                    return '<img src="https://images.evetech.net/corporations/' + row.corporation_id + '/logo?size=32" class="rounded-circle" title="' + row.corporation_name + '" height="30" data-tooltip-toggle="corp-tooltip" data-bs-placement="top">';
+                                },
+                                columnControl: [
+                                    {target: 0, content: []},
+                                    {target: 1, content: []}
+                                ]
+                            },
+                            {
+                                targets: 2,
+                                className: 'text-end',
+                                columnControl: [
+                                    {target: 0, content: []},
+                                    {target: 1, content: []}
+                                ],
+                                render: function (data, type, row) {
+                                    var OverviewUrl = CorporationOverviewUrl.replace('1337', row.corporation_id);
+                                    return `<a href="${OverviewUrl}">
+                                        <button class="btn btn-primary btn-sm"
+                                            title="{% trans "Show" %}"
+                                            data-bs-tooltip="aa-ledger"
+                                            data-bs-placement="left"
+                                        >
+                                            <i class="fa-solid fa-eye"></i>
+                                        </button>
+                                    </a>`;
+                            },
+                            }
+                        ],
+                        initComplete: function() {
+                            _bootstrapTooltip({selector: '#overview-table'});
+                        },
+                        drawCallback: function() {
+                            _bootstrapTooltip({selector: '#overview-table'});
+                        }
+                    })
+                }
+            })
+            .catch((error) => {
+                console.error('Error fetching Character Ledger data:', error);
+            });
+        });
+    </script>
+{% endblock %}

ledger/templatetags/ledger.py

@@ -4,18 +4,16 @@ import calendar
 # Django
 from django.template.defaultfilters import register
 from django.utils import timezone
-from django.utils.translation import gettext as _
+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__, __version__
+from ledger.providers import AppLogger
 
-logger = LoggerAddTag(get_extension_logger(__name__), __title__)
+logger = AppLogger(get_extension_logger(__name__), __title__)
 
 
 @register.filter

ledger/tests/__init__.py

@@ -0,0 +1,187 @@
+# Standard Library
+import socket
+from unittest.mock import Mock
+
+# Django
+from django.contrib.messages.middleware import MessageMiddleware
+from django.contrib.sessions.middleware import SessionMiddleware
+from django.core.handlers.wsgi import WSGIRequest
+from django.test import RequestFactory, TestCase
+from django.urls import reverse
+
+# AA Ledger
+from ledger.tests.testdata.integrations.allianceauth import load_allianceauth
+from ledger.tests.testdata.integrations.eveentity import load_eveentity
+from ledger.tests.testdata.integrations.eveuniverse import load_eveuniverse
+from ledger.tests.testdata.utils import create_user_from_evecharacter
+from ledger.views.alliance.add_ally import add_ally
+from ledger.views.character.add_char import add_char
+from ledger.views.corporation.add_corp import add_corp
+
+
+class SocketAccessError(Exception):
+    """Error raised when a test script accesses the network"""
+
+
+class NoSocketsTestCase(TestCase):
+    """Variation of Django's TestCase class that prevents any network use.
+
+    Example:
+
+        .. code-block:: python
+
+            class TestMyStuff(BaseTestCase):
+                def test_should_do_what_i_need(self): ...
+
+    """
+
+    @classmethod
+    def setUpClass(cls):
+        cls.socket_original = socket.socket
+        socket.socket = cls.guard
+        return super().setUpClass()
+
+    @classmethod
+    def tearDownClass(cls):
+        socket.socket = cls.socket_original
+        return super().tearDownClass()
+
+    @staticmethod
+    def guard(*args, **kwargs):
+        raise SocketAccessError("Attempted to access network")
+
+
+class LedgerTestCase(NoSocketsTestCase):
+    """
+    Preloaded Testcase class for Ledger tests without Network access.
+
+    Pre-Load:
+        * Alliance Auth Characters, Corporation, Alliance Data
+        * Eve Universe Data
+        * Eve Entity Data
+        * Taken User IDs: 1001, 1002, 1003, 1004, 1005
+
+    Available Request Factory:
+        `self.factory`
+
+    Available test users:
+        * `user` User with standard Ledger access.
+            * 'ledger.basic_access' Permission
+            * Character ID 1001
+            * Corporation ID 2001
+            * Alliance ID 3001
+        * `user2` Second user with standard Ledger access.
+            * 'ledger.basic_access' Permission
+            * Character ID 1002
+            * Corporation ID 2002
+            * Alliance ID 3002
+        * `superuser` Superuser.
+            * Access to whole Application
+            * Character ID 1003
+        * `manage_own_user` User with manage own corporation access.
+            * 'ledger.basic_access' Permission
+            * 'ledger.advanced_access' Permission
+            * 'ledger.corp_audit_manager' Permission
+            * 'ledger.manage_access' Permission
+            * Character ID 1004
+            * Corporation ID 2001
+            * Alliance ID 3001
+        * `manage_user` User with manage corporations access.
+            * 'ledger.basic_access' Permission
+            * 'ledger.advanced_access' Permission
+            * 'ledger.corp_audit_admin_manager' Permission
+            * 'ledger.manage_access' Permission
+            * Character ID 1005
+            * Corporation ID 2001
+            * Alliance ID 3001
+
+    Example:
+        .. code-block:: python
+
+            class TestMyLedgerStuff(LedgerTestCase):
+                def test_should_do_what_i_need(self):
+                    user = self.user
+    """
+
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        # Initialize Alliance Auth test data
+        load_allianceauth()
+        load_eveuniverse()
+        load_eveentity()
+
+        # Request Factory
+        cls.factory = RequestFactory()
+
+        # User with Standard Access - Corporation 2001
+        cls.user, cls.user_character = create_user_from_evecharacter(
+            character_id=1001,
+            permissions=["ledger.basic_access"],
+        )
+        # User with Standard Access - Corporation 2002
+        cls.user2, cls.user2_character = create_user_from_evecharacter(
+            character_id=1002,
+            permissions=["ledger.basic_access"],
+        )
+        # User with Superuser Access - Corporation 2003
+        cls.superuser, cls.superuser_character = create_user_from_evecharacter(
+            character_id=1003,
+            permissions=[],
+        )
+        cls.superuser.is_superuser = True
+        cls.superuser.save()
+        # User with Manage Own Corporation Access - Corporation 2001
+        cls.manage_own_user, cls.manage_own_character = create_user_from_evecharacter(
+            character_id=1004,
+            permissions=[
+                "ledger.basic_access",
+                "ledger.advanced_access",
+                "ledger.corp_audit_manager",
+                "ledger.manage_access",
+            ],
+        )
+        # User with Manage Corporations Access - Corporation 2001
+        cls.manage_user, cls.manage_character = create_user_from_evecharacter(
+            character_id=1005,
+            permissions=[
+                "ledger.basic_access",
+                "ledger.advanced_access",
+                "ledger.corp_audit_admin_manager",
+                "ledger.manage_access",
+            ],
+        )
+
+    def _add_character(self, user, token):
+        request = self.factory.get(reverse("ledger:add_char"))
+        request.user = user
+        request.token = token
+        middleware = SessionMiddleware(Mock())
+        middleware.process_request(request)
+        orig_view = add_char.__wrapped__.__wrapped__.__wrapped__
+        return orig_view(request, token)
+
+    def _add_corporation(self, user, token):
+        request = self.factory.get(reverse("ledger:add_corp"))
+        request.user = user
+        request.token = token
+        middleware = SessionMiddleware(Mock())
+        middleware.process_request(request)
+        orig_view = add_corp.__wrapped__.__wrapped__.__wrapped__
+        return orig_view(request, token)
+
+    def _add_alliance(self, user, token):
+        request = self.factory.get(reverse("ledger:add_ally"))
+        request.user = user
+        request.token = token
+        middleware = SessionMiddleware(Mock())
+        middleware.process_request(request)
+        orig_view = add_ally.__wrapped__.__wrapped__.__wrapped__
+        return orig_view(request, token)
+
+    def _middleware_process_request(self, request: WSGIRequest):
+        """Helper method to process middleware for a request."""
+        session_middleware = SessionMiddleware(Mock())
+        session_middleware.process_request(request)
+        message_middleware = MessageMiddleware(Mock())
+        message_middleware.process_request(request)