aa-intel-tool 2.5.2__py3-none-any.whl → 2.6.1__py3-none-any.whl

aa_intel_tool/templates/aa_intel_tool/base.html

@@ -1,6 +1,7 @@
 {% extends "allianceauth/base-bs5.html" %}
 
 {% load i18n %}
+{% load aa_i18n %}
 
 {% block page_title %}
     {% translate "Intel Parser" %}
@@ -17,6 +18,37 @@
         </div>
 
         <div class="aa-intel-tool-body">
+            {% get_datatables_language_static LANGUAGE_CODE as DT_LANG_PATH %}
+
+            {% translate "Permalink successfully copied" as copyToClipboardSuccess %}
+            {% translate "Something went wrong. Nothing copied. Maybe your browser does not support this function." as copyToClipboardError %}
+            {% translate "Unaffiliated / No Alliance" as scanDataEmpty %}
+            {% translate "NPC Corp" as scanDataNpcCorp %}
+
+            <script>
+                const aaIntelToolJsSettingsDefaults = {
+                    language: {
+                        django: '{{ LANGUAGE_CODE }}',
+                        dataTables: {url: '{{ DT_LANG_PATH }}'}
+                    },
+                    url: {},
+                    translation: {
+                        copyToClipboard: {
+                            permalink: {
+                                text: {
+                                    success: '{{ copyToClipboardSuccess|escapejs }}',
+                                    error: '{{ copyToClipboardError|escapejs }}'
+                                }
+                            }
+                        },
+                        scanData: {
+                            empty: '{{ scanDataEmpty|escapejs }}',
+                            npcCorp: '{{ scanDataNpcCorp|escapejs }}',
+                        }
+                    }
+                }
+            </script>
+
             {% block aa_intel_tool_body %}{% endblock %}
         </div>
 

aa_intel_tool/templates/aa_intel_tool/bundles/aa-intel-tool-chatscan-highlight-js.html

@@ -0,0 +1,3 @@
+{% load aa_intel_tool %}
+
+{% aa_intel_tool_static "javascript/aa-intel-tool-chatscan-highlight.min.js" %}

aa_intel_tool/templates/aa_intel_tool/bundles/aa-intel-tool-chatscan-js.html

@@ -1,5 +1,8 @@
 {% load aa_intel_tool %}
 
-<script src="{% aa_intel_tool_static 'aa_intel_tool/javascript/aa-intel-tool-scan-result-common.min.js' %}"></script>
-<script src="{% aa_intel_tool_static 'aa_intel_tool/javascript/aa-intel-tool-chatscan-highlight.min.js' %}"></script>
-<script src="{% aa_intel_tool_static 'aa_intel_tool/javascript/aa-intel-tool-chatscan.min.js' %}"></script>
+{% if not common_already_loaded %}
+    {% include "aa_intel_tool/bundles/aa-intel-tool-scan-result-common-js.html" %}
+    {% include "aa_intel_tool/bundles/aa-intel-tool-chatscan-highlight-js.html" %}
+{% endif %}
+
+{% aa_intel_tool_static "javascript/aa-intel-tool-chatscan.min.js" %}

aa_intel_tool/templates/aa_intel_tool/bundles/aa-intel-tool-css.html

@@ -1,3 +1,3 @@
 {% load aa_intel_tool %}
 
-<link rel="stylesheet" href="{% aa_intel_tool_static 'aa_intel_tool/css/aa-intel-tool.min.css' %}">
+{% aa_intel_tool_static "css/aa-intel-tool.min.css" %}

aa_intel_tool/templates/aa_intel_tool/bundles/aa-intel-tool-dscan-highlight-js.html

@@ -0,0 +1,3 @@
+{% load aa_intel_tool %}
+
+{% aa_intel_tool_static "javascript/aa-intel-tool-dscan-highlight.min.js" %}

aa_intel_tool/templates/aa_intel_tool/bundles/aa-intel-tool-dscan-js.html

@@ -1,5 +1,6 @@
 {% load aa_intel_tool %}
 
-<script src="{% aa_intel_tool_static 'aa_intel_tool/javascript/aa-intel-tool-scan-result-common.min.js' %}"></script>
-<script src="{% aa_intel_tool_static 'aa_intel_tool/javascript/aa-intel-tool-dscan-highlight.min.js' %}"></script>
-<script src="{% aa_intel_tool_static 'aa_intel_tool/javascript/aa-intel-tool-dscan.min.js' %}"></script>
+{% include "aa_intel_tool/bundles/aa-intel-tool-scan-result-common-js.html" %}
+{% include "aa_intel_tool/bundles/aa-intel-tool-dscan-highlight-js.html" %}
+
+{% aa_intel_tool_static "javascript/aa-intel-tool-dscan.min.js" %}

aa_intel_tool/templates/aa_intel_tool/bundles/aa-intel-tool-fleetcomp-js.html

@@ -1,10 +1,11 @@
 {% load aa_intel_tool %}
 
-<script src="{% aa_intel_tool_static 'aa_intel_tool/javascript/aa-intel-tool-scan-result-common.min.js' %}"></script>
-<script src="{% aa_intel_tool_static 'aa_intel_tool/javascript/aa-intel-tool-fleetcomposition-highlight.min.js' %}"></script>
-<script src="{% aa_intel_tool_static 'aa_intel_tool/javascript/aa-intel-tool-fleetcomposition.min.js' %}"></script>
+{% include "aa_intel_tool/bundles/aa-intel-tool-scan-result-common-js.html" %}
+{% include "aa_intel_tool/bundles/aa-intel-tool-fleetcomposition-highlight-js.html" %}
+
+{% aa_intel_tool_static "javascript/aa-intel-tool-fleetcomposition.min.js" %}
 
 {% if app_settings.INTELTOOL_ENABLE_MODULE_CHATSCAN %}
-    <script src="{% aa_intel_tool_static 'aa_intel_tool/javascript/aa-intel-tool-chatscan-highlight.min.js' %}"></script>
-    <script src="{% aa_intel_tool_static 'aa_intel_tool/javascript/aa-intel-tool-chatscan.min.js' %}"></script>
+    {% include "aa_intel_tool/bundles/aa-intel-tool-chatscan-highlight-js.html" with common_already_loaded=True %}
+    {% include "aa_intel_tool/bundles/aa-intel-tool-chatscan-js.html" with common_already_loaded=True %}
 {% endif %}

aa_intel_tool/templates/aa_intel_tool/bundles/aa-intel-tool-fleetcomposition-highlight-js.html

@@ -0,0 +1,3 @@
+{% load aa_intel_tool %}
+
+{% aa_intel_tool_static "javascript/aa-intel-tool-fleetcomposition-highlight.min.js" %}

aa_intel_tool/templates/aa_intel_tool/bundles/aa-intel-tool-js.html

@@ -1,3 +1,3 @@
 {% load aa_intel_tool %}
 
-<script src="{% aa_intel_tool_static 'aa_intel_tool/javascript/aa-intel-tool.min.js' %}"></script>
+{% aa_intel_tool_static "javascript/aa-intel-tool.min.js" %}

aa_intel_tool/templates/aa_intel_tool/bundles/aa-intel-tool-scan-result-common-js.html

@@ -0,0 +1,3 @@
+{% load aa_intel_tool %}
+
+{% aa_intel_tool_static "javascript/aa-intel-tool-scan-result-common.min.js" %}

aa_intel_tool/templates/aa_intel_tool/views/scan/chatlist.html

@@ -28,8 +28,8 @@
 
 {% block extra_javascript %}
     <script>
-        const aaIntelToolJsOptions = {
-            ajax: {
+        const aaIntelToolJsSettingsOverride = {
+            url: {
                 getPilotList: '{% url "aa_intel_tool:ajax_get_scan_data" scan_hash scan_data_section.PILOTLIST.value %}',
                 getCorporationList: '{% url "aa_intel_tool:ajax_get_scan_data" scan_hash scan_data_section.CORPORATIONLIST.value %}',
                 getAllianceList: '{% url "aa_intel_tool:ajax_get_scan_data" scan_hash scan_data_section.ALLIANCELIST.value %}'
@@ -39,6 +39,6 @@
 
     {% include "bundles/datatables-js-bs5.html" %}
     {% include "bundles/clipboard-js.html" %}
-    {% include "aa_intel_tool/bundles/aa-intel-tool-js-l10n.html" %}
+    {% include "aa_intel_tool/bundles/aa-intel-tool-js.html" %}
     {% include "aa_intel_tool/bundles/aa-intel-tool-chatscan-js.html" %}
 {% endblock extra_javascript %}

aa_intel_tool/templates/aa_intel_tool/views/scan/dscan.html

@@ -26,8 +26,8 @@
 
 {% block extra_javascript %}
     <script>
-        const aaIntelToolJsOptions = {
-            ajax: {
+        const aaIntelToolJsSettingsOverride = {
+            url: {
                 getShipClassesAll: '{% url "aa_intel_tool:ajax_get_scan_data" scan_hash scan_data_section.SHIPLIST.value %}',
                 getShipClassesOngrid: '{% url "aa_intel_tool:ajax_get_scan_data" scan_hash scan_data_section.SHIPLIST_ON_GRID.value %}',
                 getShipClassesOffgrid: '{% url "aa_intel_tool:ajax_get_scan_data" scan_hash scan_data_section.SHIPLIST_OFF_GRID.value %}',
@@ -41,6 +41,6 @@
 
     {% include "bundles/datatables-js-bs5.html" %}
     {% include "bundles/clipboard-js.html" %}
-    {% include "aa_intel_tool/bundles/aa-intel-tool-js-l10n.html" %}
+    {% include "aa_intel_tool/bundles/aa-intel-tool-js.html" %}
     {% include "aa_intel_tool/bundles/aa-intel-tool-dscan-js.html" %}
 {% endblock extra_javascript %}

aa_intel_tool/templates/aa_intel_tool/views/scan/fleetcomp.html

@@ -28,8 +28,8 @@
 
 {% block extra_javascript %}
     <script>
-        const aaIntelToolJsOptions = {
-            ajax: {
+        const aaIntelToolJsSettingsOverride = {
+            url: {
                 getShipClasses: '{% url "aa_intel_tool:ajax_get_scan_data" scan_hash scan_data_section.SHIPLIST.value %}',
                 getShipTypes: '{% url "aa_intel_tool:ajax_get_scan_data" scan_hash scan_data_section.SHIPTYPES.value %}',
                 getFleetComposition: '{% url "aa_intel_tool:ajax_get_scan_data" scan_hash scan_data_section.FLEETCOMPOSITION.value %}',
@@ -42,6 +42,6 @@
 
     {% include "bundles/datatables-js-bs5.html" %}
     {% include "bundles/clipboard-js.html" %}
-    {% include "aa_intel_tool/bundles/aa-intel-tool-js-l10n.html" %}
+    {% include "aa_intel_tool/bundles/aa-intel-tool-js.html" %}
     {% include "aa_intel_tool/bundles/aa-intel-tool-fleetcomp-js.html" %}
 {% endblock extra_javascript %}

aa_intel_tool/templatetags/aa_intel_tool.py

@@ -2,25 +2,87 @@
 Versioned static URLs to break browser caches when changing the app version
 """
 
+# Standard Library
+import os
+
 # Django
 from django.template.defaulttags import register
 from django.templatetags.static import static
+from django.utils.safestring import mark_safe
+
+# Alliance Auth
+from allianceauth.services.hooks import get_extension_logger
+
+# Alliance Auth (External Libs)
+from app_utils.logging import LoggerAddTag
 
 # AA Intel Tool
-from aa_intel_tool import __version__
+from aa_intel_tool import __title__, __version__
+from aa_intel_tool.app_settings import debug_enabled
+from aa_intel_tool.constants import PACKAGE_NAME
+from aa_intel_tool.helper.static_files import calculate_integrity_hash
+
+logger = LoggerAddTag(my_logger=get_extension_logger(__name__), prefix=__title__)
 
 
 @register.simple_tag
-def aa_intel_tool_static(path: str) -> str:
+def aa_intel_tool_static(
+    relative_file_path: str, script_type: str = None
+) -> str | None:
     """
     Versioned static URL
-    :param path:
-    :type path:
-    :return:
-    :rtype:
+
+    :param relative_file_path: The file path relative to the `{APP_NAME}/{PACKAGE_NAME}/static/{PACKAGE_NAME}` folder
+    :type relative_file_path: str
+    :param script_type: The script type
+    :type script_type: str
+    :return: Versioned static URL
+    :rtype: str
     """
 
-    static_url = static(path)
-    versioned_url = static_url + "?v=" + __version__
+    logger.debug(f"Getting versioned static URL for: {relative_file_path}")
+
+    file_type = os.path.splitext(relative_file_path)[1][1:]
+
+    logger.debug(f"File extension: {file_type}")
+
+    # Only support CSS and JS files
+    if file_type not in ["css", "js"]:
+        raise ValueError(f"Unsupported file type: {file_type}")
+
+    static_file_path = os.path.join(PACKAGE_NAME, relative_file_path)
+    static_url = static(static_file_path)
+
+    # Integrity hash calculation only for non-debug mode
+    sri_string = (
+        f' integrity="{calculate_integrity_hash(relative_file_path)}" crossorigin="anonymous"'
+        if not debug_enabled()
+        else ""
+    )
+
+    # Versioned URL for CSS and JS files
+    # Add version query parameter to break browser caches when changing the app version
+    # Do not add version query parameter for libs as they are already versioned through their file path
+    versioned_url = (
+        static_url
+        if relative_file_path.startswith("libs/")
+        else static_url + "?v=" + __version__
+    )
+
+    return_value = None
+
+    # Return the versioned URL with integrity hash for CSS
+    if file_type == "css":
+        return_value = mark_safe(
+            f'<link rel="stylesheet" href="{versioned_url}"{sri_string}>'
+        )
+
+    # Return the versioned URL with integrity hash for JS files
+    if file_type == "js":
+        js_type = f' type="{script_type}"' if script_type else ""
+
+        return_value = mark_safe(
+            f'<script{js_type} src="{versioned_url}"{sri_string}></script>'
+        )
 
-    return versioned_url
+    return return_value

aa_intel_tool/tests/test_app_settings.py

@@ -6,10 +6,11 @@ Test the app settings in local.py
 from unittest import mock
 
 # Django
-from django.test import TestCase
+from django.conf import settings
+from django.test import TestCase, override_settings
 
 # AA Intel Tool
-from aa_intel_tool.app_settings import AppSettings
+from aa_intel_tool.app_settings import AppSettings, debug_enabled
 
 SETTINGS_PATH = "aa_intel_tool.app_settings"
 
@@ -46,6 +47,7 @@ class TestAppSettings(TestCase):
 
         self.assertEqual(first=retention_time, second=expected_retention_time)
 
+    @override_settings()
     def test_chatscan_max_pilots_default(self):
         """
         Test for the default INTELTOOL_CHATSCAN_MAX_PILOTS
@@ -54,9 +56,13 @@ class TestAppSettings(TestCase):
         :rtype:
         """
 
+        del settings.INTELTOOL_CHATSCAN_MAX_PILOTS
+
         max_pilots = AppSettings.INTELTOOL_CHATSCAN_MAX_PILOTS
         expected_max_pilots = 500
 
+        print("max_pilots:", max_pilots)
+
         self.assertEqual(first=max_pilots, second=expected_max_pilots)
 
     @mock.patch(SETTINGS_PATH + ".AppSettings.INTELTOOL_CHATSCAN_MAX_PILOTS", 1000)
@@ -99,3 +105,25 @@ class TestAppSettings(TestCase):
         expected_grid_size = 1000
 
         self.assertEqual(first=grid_size, second=expected_grid_size)
+
+    @override_settings(DEBUG=True)
+    def test_debug_enabled_with_debug_true(self) -> None:
+        """
+        Test debug_enabled with DEBUG = True
+
+        :return:
+        :rtype:
+        """
+
+        self.assertTrue(debug_enabled())
+
+    @override_settings(DEBUG=False)
+    def test_debug_enabled_with_debug_false(self) -> None:
+        """
+        Test debug_enabled with DEBUG = False
+
+        :return:
+        :rtype:
+        """
+
+        self.assertFalse(debug_enabled())

aa_intel_tool/tests/test_templatetags.py

@@ -3,35 +3,101 @@ Tests for the template tags
 """
 
 # Django
-from django.test import TestCase
+from django.template import Context, Template
+from django.test import TestCase, override_settings
 
 # AA Intel Tool
 from aa_intel_tool import __version__
-from aa_intel_tool.tests.utils import render_template
+from aa_intel_tool.constants import PACKAGE_NAME
+from aa_intel_tool.helper.static_files import calculate_integrity_hash
 
 
-class TestForumVersionedStatic(TestCase):
+class TestVersionedStatic(TestCase):
     """
     Tests for aa_intel_tool template tag
     """
 
+    @override_settings(DEBUG=False)
     def test_versioned_static(self):
         """
         Test should return static URL string with a version
         :return:
         """
 
-        context = {"version": __version__}
+        context = Context(dict_={"version": __version__})
 
-        rendered_template = render_template(
-            string=(
+        template_to_render = Template(
+            template_string=(
                 "{% load aa_intel_tool %}"
-                "{% aa_intel_tool_static 'aa_intel_tool/css/aa-intel-tool.min.css' %}"
-            ),
-            context=context,
+                "{% aa_intel_tool_static 'css/aa-intel-tool.min.css' %}"
+                "{% aa_intel_tool_static 'javascript/aa-intel-tool.min.js' %}"
+            )
         )
 
-        self.assertEqual(
-            rendered_template,
-            f'/static/aa_intel_tool/css/aa-intel-tool.min.css?v={context["version"]}',
+        rendered_template = template_to_render.render(context=context)
+
+        expected_static_css_src = (
+            f'/static/{PACKAGE_NAME}/css/aa-intel-tool.min.css?v={context["version"]}'
+        )
+        expected_static_css_src_integrity = calculate_integrity_hash(
+            "css/aa-intel-tool.min.css"
+        )
+        expected_static_js_src = f'/static/{PACKAGE_NAME}/javascript/aa-intel-tool.min.js?v={context["version"]}'
+        expected_static_js_src_integrity = calculate_integrity_hash(
+            "javascript/aa-intel-tool.min.js"
+        )
+
+        self.assertIn(member=expected_static_css_src, container=rendered_template)
+        self.assertIn(
+            member=expected_static_css_src_integrity, container=rendered_template
+        )
+        self.assertIn(member=expected_static_js_src, container=rendered_template)
+        self.assertIn(
+            member=expected_static_js_src_integrity, container=rendered_template
+        )
+
+    @override_settings(DEBUG=True)
+    def test_versioned_static_with_debug_enabled(self) -> None:
+        """
+        Test versioned static template tag with DEBUG enabled
+
+        :return:
+        :rtype:
+        """
+
+        context = Context({"version": __version__})
+        template_to_render = Template(
+            template_string=(
+                "{% load aa_intel_tool %}"
+                "{% aa_intel_tool_static 'css/aa-intel-tool.min.css' %}"
+            )
         )
+
+        rendered_template = template_to_render.render(context=context)
+
+        expected_static_css_src = (
+            f'/static/{PACKAGE_NAME}/css/aa-intel-tool.min.css?v={context["version"]}'
+        )
+
+        self.assertIn(member=expected_static_css_src, container=rendered_template)
+        self.assertNotIn(member="integrity=", container=rendered_template)
+
+    @override_settings(DEBUG=False)
+    def test_invalid_file_type(self) -> None:
+        """
+        Test should raise a ValueError for an invalid file type
+
+        :return:
+        :rtype:
+        """
+
+        context = Context({"version": __version__})
+        template_to_render = Template(
+            template_string=(
+                "{% load aa_intel_tool %}"
+                "{% aa_intel_tool_static 'invalid/invalid.txt' %}"
+            )
+        )
+
+        with self.assertRaises(ValueError):
+            template_to_render.render(context=context)

{aa_intel_tool-2.5.2.dist-info → aa_intel_tool-2.6.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: aa-intel-tool
-Version: 2.5.2
+Version: 2.6.1
 Summary: A simple parser for D-Scans and more for Alliance Auth
 Project-URL: Changelog, https://github.com/ppfeufer/aa-intel-tool/blob/master/CHANGELOG.md
 Project-URL: Documentation, https://github.com/ppfeufer/aa-intel-tool/blob/master/README.md
@@ -683,6 +683,7 @@ License:                     GNU GENERAL PUBLIC LICENSE
         the library.  If this is what you want to do, use the GNU Lesser General
         Public License instead of this License.  But first, please read
         <https://www.gnu.org/licenses/why-not-lgpl.html>.
+License-File: LICENSE
 Keywords: allianceauth,eveonline
 Classifier: Environment :: Web Environment
 Classifier: Framework :: Django
@@ -700,7 +701,7 @@ Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
 Requires-Python: >=3.10
 Requires-Dist: allianceauth-app-utils>=1.19.1
-Requires-Dist: allianceauth<5,>=4.3.1
+Requires-Dist: allianceauth<5,>=4.6
 Requires-Dist: django-eveuniverse>=1.3
 Provides-Extra: tests-allianceauth-latest
 Requires-Dist: coverage; extra == 'tests-allianceauth-latest'
@@ -985,9 +986,9 @@ Please make sure to read the [Contribution Guidelines].\
 [code of conduct]: https://github.com/ppfeufer/aa-intel-tool/blob/master/CODE_OF_CONDUCT.md
 [contribution guidelines]: https://github.com/ppfeufer/aa-intel-tool/blob/master/CONTRIBUTING.md "Contribution Guidelines"
 [eve universe]: https://gitlab.com/ErikKalkoken/django-eveuniverse "Eve Universe"
-[image: chat scan module]: https://raw.githubusercontent.com/ppfeufer/aa-intel-tool/master/docs/images/representation/chat-scan.jpg "Chat Scan Module"
-[image: d-scan module]: https://raw.githubusercontent.com/ppfeufer/aa-intel-tool/master/docs/images/representation/d-scan.jpg "D-Scan Module"
-[image: fleet composition module]: https://raw.githubusercontent.com/ppfeufer/aa-intel-tool/master/docs/images/representation/fleet-composition.jpg "Fleet Composition Module"
+[image: chat scan module]: https://raw.githubusercontent.com/ppfeufer/aa-intel-tool/master/docs/images/presentation/chat-scan.jpg "Chat Scan Module"
+[image: d-scan module]: https://raw.githubusercontent.com/ppfeufer/aa-intel-tool/master/docs/images/presentation/d-scan.jpg "D-Scan Module"
+[image: fleet composition module]: https://raw.githubusercontent.com/ppfeufer/aa-intel-tool/master/docs/images/presentation/fleet-composition.jpg "Fleet Composition Module"
 [ppfeufer on ko-fi]: https://ko-fi.com/ppfeufer "Buy Me a Coffee!"
 [pre-commit.ci status]: https://results.pre-commit.ci/latest/github/ppfeufer/aa-intel-tool/master "pre-commit.ci"
 [support discord]: https://discord.gg/zmh52wnfvM "Alliance Auth Community Apps Support Discord"