aa-intel-tool 0.0.1a9__tar.gz → 0.0.1a10__tar.gz

{aa_intel_tool-0.0.1a9 → aa_intel_tool-0.0.1a10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aa-intel-tool
-Version: 0.0.1a9
+Version: 0.0.1a10
 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
@@ -254,13 +254,15 @@ Restart your Nginx service.
 To customize the app, the following settings are available and can be made in
 your `local.py`.
 
-| Name                              | Description                                                                                                      | Default |
-|:----------------------------------|:-----------------------------------------------------------------------------------------------------------------|:--------|
-| INTELTOOL_ENABLE_MODULE_CHATSCAN  | Enable or disable the chat scan module.                                                                          | False   |
-| INTELTOOL_ENABLE_MODULE_DSCAN     | Enable or disable the d-scan module.                                                                             | True    |
-| INTELTOOL_ENABLE_MODULE_FLEETCOMP | Enable or disable the fleet composition module.                                                                  | True    |
-| INTELTOOL_SCAN_RETENTION_TIME     | Sets the time in days for how long the scans will be kept in the database. Set to 0 to keep scans indefinitely.  | 30      |
-| INTELTOOL_CHATSCAN_MAX_PILOTS     | Sets the limit of pilots for chat scans, since these can take quite a long time to process. Set to 0 to disable. | 500     |
+| Name                              | Description                                                                                                                              | Default |
+|:----------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------|:--------|
+| INTELTOOL_ENABLE_MODULE_CHATSCAN  | Enable or disable the chat scan module.                                                                                                  | False   |
+| INTELTOOL_ENABLE_MODULE_DSCAN     | Enable or disable the d-scan module.                                                                                                     | True    |
+| INTELTOOL_ENABLE_MODULE_FLEETCOMP | Enable or disable the fleet composition module.                                                                                          | True    |
+| INTELTOOL_SCAN_RETENTION_TIME     | Set the time in days for how long the scans will be kept in the database. Set to 0 to keep scans indefinitely.                           | 30      |
+| INTELTOOL_CHATSCAN_MAX_PILOTS     | Set the limit of pilots for chat scans, since these can take quite a long time to process. Set to 0 to disable.                          | 500     |
+| INTELTOOL_DSCAN_GRID_SIZE         | Set the grid size for D-Scans. This defines <br/>the size of the grid in km in which ships and structures are considered to be "on grid" | 10000   |
+
 
 > **Note**
 >

{aa_intel_tool-0.0.1a9 → aa_intel_tool-0.0.1a10}/README.md

@@ -221,13 +221,15 @@ Restart your Nginx service.
 To customize the app, the following settings are available and can be made in
 your `local.py`.
 
-| Name                              | Description                                                                                                      | Default |
-|:----------------------------------|:-----------------------------------------------------------------------------------------------------------------|:--------|
-| INTELTOOL_ENABLE_MODULE_CHATSCAN  | Enable or disable the chat scan module.                                                                          | False   |
-| INTELTOOL_ENABLE_MODULE_DSCAN     | Enable or disable the d-scan module.                                                                             | True    |
-| INTELTOOL_ENABLE_MODULE_FLEETCOMP | Enable or disable the fleet composition module.                                                                  | True    |
-| INTELTOOL_SCAN_RETENTION_TIME     | Sets the time in days for how long the scans will be kept in the database. Set to 0 to keep scans indefinitely.  | 30      |
-| INTELTOOL_CHATSCAN_MAX_PILOTS     | Sets the limit of pilots for chat scans, since these can take quite a long time to process. Set to 0 to disable. | 500     |
+| Name                              | Description                                                                                                                              | Default |
+|:----------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------|:--------|
+| INTELTOOL_ENABLE_MODULE_CHATSCAN  | Enable or disable the chat scan module.                                                                                                  | False   |
+| INTELTOOL_ENABLE_MODULE_DSCAN     | Enable or disable the d-scan module.                                                                                                     | True    |
+| INTELTOOL_ENABLE_MODULE_FLEETCOMP | Enable or disable the fleet composition module.                                                                                          | True    |
+| INTELTOOL_SCAN_RETENTION_TIME     | Set the time in days for how long the scans will be kept in the database. Set to 0 to keep scans indefinitely.                           | 30      |
+| INTELTOOL_CHATSCAN_MAX_PILOTS     | Set the limit of pilots for chat scans, since these can take quite a long time to process. Set to 0 to disable.                          | 500     |
+| INTELTOOL_DSCAN_GRID_SIZE         | Set the grid size for D-Scans. This defines <br/>the size of the grid in km in which ships and structures are considered to be "on grid" | 10000   |
+
 
 > **Note**
 >

{aa_intel_tool-0.0.1a9 → aa_intel_tool-0.0.1a10}/aa_intel_tool/app_settings.py

@@ -50,3 +50,10 @@ class AppSettings:  # pylint: disable=too-few-public-methods
     INTELTOOL_CHATSCAN_MAX_PILOTS = clean_setting(
         name="INTELTOOL_CHATSCAN_MAX_PILOTS", default_value=500, required_type=int
     )
+
+    # Set the grid size for D-Scans.
+    # This defines the size of teh grid in which ships and
+    # structure are considered to be "on grid"
+    INTELTOOL_DSCAN_GRID_SIZE = clean_setting(
+        name="INTELTOOL_DSCAN_GRID_SIZE", default_value=10000, required_type=int
+    )

{aa_intel_tool-0.0.1a9 → aa_intel_tool-0.0.1a10}/aa_intel_tool/constants.py

@@ -18,6 +18,7 @@ from aa_intel_tool import __version__
 # All internal URLs need to start with this prefix
 INTERNAL_URL_PREFIX = "-"
 
+
 # Localised units
 distance_units_on_grid: str = """
     km|m    # Latin (English, German and so on)
@@ -31,6 +32,7 @@ distance_units_off_grid: str = """
 
 distance_units = f"{distance_units_on_grid}|{distance_units_off_grid}"
 
+
 # Pre-compiled regex patterns used throughout the app
 REGEX_PATTERN = {
     # "chatlist": re.compile(pattern=r"(?im)^[a-zA-Z0-9\u0080-\uFFFF -_]{3,37}$"),
@@ -49,6 +51,8 @@ REGEX_PATTERN = {
     ),
 }
 
+
+# Supported intel types and their parameters
 SUPPORTED_INTEL_TYPES = {
     # "chatlist": {
     #     "name": _("Chat List"),
@@ -68,9 +72,8 @@ SUPPORTED_INTEL_TYPES = {
 }
 
 
+# Building our user agent for ESI calls
 VERBOSE_NAME = "AA Intel Tool"
-
 verbose_name_slugified: str = slugify(VERBOSE_NAME, allow_unicode=True)
 github_url: str = "https://github.com/ppfeufer/aa-intel-tool"
-
 USER_AGENT = f"{verbose_name_slugified} v{__version__} {github_url}"

aa_intel_tool-0.0.1a10/aa_intel_tool/migrations/0006_alter_scandata_unique_together.py

@@ -0,0 +1,17 @@
+# Generated by Django 4.0.10 on 2023-08-22 18:41
+
+# Django
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("aa_intel_tool", "0005_alter_scan_options_alter_scandata_options_and_more"),
+    ]
+
+    operations = [
+        migrations.AlterUniqueTogether(
+            name="scandata",
+            unique_together={("scan", "section")},
+        ),
+    ]

{aa_intel_tool-0.0.1a9 → aa_intel_tool-0.0.1a10}/aa_intel_tool/models.py

@@ -147,3 +147,5 @@ class ScanData(models.Model):
         default_permissions = ()
         verbose_name = _("Scan data")
         verbose_name_plural = _("Scan data")
+
+        unique_together = ("scan", "section")

{aa_intel_tool-0.0.1a9 → aa_intel_tool-0.0.1a10}/aa_intel_tool/parser/module/dscan.py

@@ -29,6 +29,33 @@ from aa_intel_tool.parser.helper.db import safe_scan_to_db
 logger = LoggerAddTag(my_logger=get_extension_logger(name=__name__), prefix=__title__)
 
 
+def _is_on_grid(distance: str) -> bool:
+    """
+    Determine if something is "on grid" or not
+
+    :param distance:
+    :type distance:
+    :return:
+    :rtype:
+    """
+
+    # AA Intel Tool
+    from aa_intel_tool.constants import (  # pylint: disable=import-outside-toplevel
+        REGEX_PATTERN,
+    )
+
+    if re.search(pattern=REGEX_PATTERN["localised_on_grid"], string=distance):
+        # line = re.split(pattern=r" ", string=distance)
+        distance_sanitised = int(re.sub(r"[^0-9]", "", distance))
+
+        if distance_sanitised <= AppSettings.INTELTOOL_DSCAN_GRID_SIZE:
+            return True
+
+        return False
+
+    return False
+
+
 def _get_type_info_dict(eve_type: tuple) -> dict:
     """
     Get the eve_type info dict
@@ -53,9 +80,9 @@ def _get_type_info_dict(eve_type: tuple) -> dict:
     }
 
 
-def _parse_ships(eve_types: QuerySet, counter: dict) -> dict:
+def _get_ships(eve_types: QuerySet, counter: dict) -> dict:
     """
-    Parse ships
+    Get the ships
     This will be the content of the following tables in the D-Scan view:
     » All Ships
     » On Grid
@@ -103,6 +130,7 @@ def _parse_ships(eve_types: QuerySet, counter: dict) -> dict:
                 "count": 0,
             }
 
+        # Add the count to the ship types
         ships["types"][eve_type[3]]["count"] += counter["all"][eve_type[0]]
 
     # Leaving this here just in case the method in the first loop turns out to be faulty
@@ -130,6 +158,38 @@ def _parse_ships(eve_types: QuerySet, counter: dict) -> dict:
     }
 
 
+def _get_upwell_structures_on_grid(eve_types: QuerySet, dscan_list: list) -> list:
+    """
+    Get all Upwell structures that are on grid
+
+    :param eve_types:
+    :type eve_types:
+    :param counter:
+    :type counter:
+    :return:
+    :rtype:
+    """
+
+    eve_types_structures = eve_types.filter(
+        eve_group__eve_category_id__exact=EveCategoryId.STRUCTURE
+    )
+
+    structures_on_grid = {}
+
+    for item in dscan_list:
+        if eve_types_structures.filter(id=item[0]).exists() and _is_on_grid(item[3]):
+            if item[0] not in structures_on_grid:
+                structures_on_grid[item[0]] = {
+                    "id": item[0],
+                    "type": item[2],
+                    "count": 0,
+                }
+
+            structures_on_grid[item[0]]["count"] += 1
+
+    return dict_to_list(structures_on_grid)
+
+
 def parse(scan_data: list) -> Scan:
     """
     Parse D-Scan
@@ -150,6 +210,8 @@ def parse(scan_data: list) -> Scan:
 
         counter = {"all": {}, "ongrid": {}, "offgrid": {}, "type": {}}
         eve_ids = {"all": [], "ongrid": [], "offgrid": []}
+        dscan_lines = []
+        parsed_data = {}
 
         # Let's split this list up
         #
@@ -179,32 +241,52 @@ def parse(scan_data: list) -> Scan:
 
             counter["all"][entry_id] += 1
             eve_ids["all"].append(entry_id)
+            dscan_lines.append([entry_id, line[1], line[2], line[3]])
 
         eve_types = EveType.objects.bulk_get_or_create_esi(
             ids=set(eve_ids["all"]), include_children=True
-        ).values_list("id", "name", "eve_group__id", "eve_group__name")
+        ).values_list("id", "name", "eve_group__id", "eve_group__name", named=True)
 
         # Parse the data
-        ships = _parse_ships(eve_types=eve_types, counter=counter)
+        ships = _get_ships(eve_types=eve_types, counter=counter)
+        upwell_structures = _get_upwell_structures_on_grid(
+            eve_types=eve_types, dscan_list=dscan_lines
+        )
 
-        parsed_data = {
-            "shiptypes": {
+        # Add "ship types" to parsed data when available
+        if len(ships["types"]):
+            parsed_data["shiptypes"] = {
                 "section": ScanData.Section.SHIPTYPES,
                 "data": ships["types"],
-            },
-            "all": {
+            }
+
+        # Add "ships all" to parsed data when available
+        if len(ships["all"]):
+            parsed_data["all"] = {
                 "section": ScanData.Section.SHIPLIST,
                 "data": ships["all"],
-            },
-            "ongrid": {
+            }
+
+        # Add "ships on grid" to parsed data when available
+        if len(ships["ongrid"]):
+            parsed_data["ongrid"] = {
                 "section": ScanData.Section.SHIPLIST_ON_GRID,
                 "data": ships["ongrid"],
-            },
-            "offgrid": {
+            }
+
+        # Add "ships off grid" to parsed data when available
+        if len(ships["offgrid"]):
+            parsed_data["offgrid"] = {
                 "section": ScanData.Section.SHIPLIST_OFF_GRID,
                 "data": ships["offgrid"],
-            },
-        }
+            }
+
+        # Add "Upwell structures on grid" to parsed data when available
+        if len(upwell_structures):
+            parsed_data["sructures_on_grid"] = {
+                "section": ScanData.Section.STRUCTURES_ON_GRID,
+                "data": upwell_structures,
+            }
 
         return safe_scan_to_db(scan_type=Scan.Type.DSCAN, parsed_data=parsed_data)
 

{aa_intel_tool-0.0.1a9 → aa_intel_tool-0.0.1a10}/aa_intel_tool/tests/test-data/dscan-russian-client.txt

@@ -1,20 +1,13 @@
 35835	UC3H-Y - Harvester 1	Athanor*	444 141 км
-35835	UC3H-Y - Wasser	Athanor*	420 226 км
 35827	UC3H-Y - Factory 56	Sotiyo*	4 236 км
 670	ledu derhauer's Capsule	Capsule*	1 943 км
 11963	cyno up	Rapier*	1 903 км
 11129	ttjzj	Gallente Shuttle*	1 898 км
 16	RD-G2R*	Stargate (Caldari System)*	1 799 км
 35841	UC3H-Y » U-INPD - Way to the Light	Ansiblex Jump Gate*	1 042 км
-35833	UC3H-Y - Restart	Fortizar*	603 км
 35840	UC3H-Y - The Bacon is Lit	Pharolux Cyno Beacon*	594 км
-35836	UC3H-Y - Refinery	Tatara*	407 км
 28665	Vargur I	Vargur*	-
-35835	UC3H-Y - Harvester 1	Athanor*	2,4 а.е.
-35827	UC3H-Y - Factory 56	Sotiyo*	2,4 а.е.
-35841	UC3H-Y » U-INPD - Way to the Light	Ansiblex Jump Gate*	2,4 а.е.
 35833	UC3H-Y - Restart	Fortizar*	2,4 а.е.
-35840	UC3H-Y - The Bacon is Lit	Pharolux Cyno Beacon*	2,4 а.е.
 35836	UC3H-Y - Refinery	Tatara*	2,4 а.е.
 35835	UC3H-Y - Wasser	Athanor*	2,4 а.е.
 11963	cyno up	Rapier*	-

{aa_intel_tool-0.0.1a9 → aa_intel_tool-0.0.1a10}/aa_intel_tool/tests/test-data/dscan.txt

@@ -7,7 +7,7 @@
 1529	Perimeter II - Moon 1 - Caldari Navy Assembly Plant	Caldari Administrative Station	14.0 AU
 4023	Perimeter VII - Poksu Mineral Group Mineral Reserve	Caldari Mining Station	12.1 AU
 35833	Perimeter - Tranquility Trading Tower	Fortizar	3,808 km
-35833	Perimeter - TEST War Headquarters	Fortizar	5,209 km
+35833	Perimeter - TEST War Headquarters	Fortizar	50,209 km
 12236	Gallente Control Tower	Gallente Control Tower	-
 20064	P7 M2 Blocker	Gallente Control Tower Small	-
 20064	P7 M1 Blocker	Gallente Control Tower Small	-

{aa_intel_tool-0.0.1a9 → aa_intel_tool-0.0.1a10}/aa_intel_tool/tests/test_app_settings.py

@@ -72,3 +72,30 @@ class TestAppSettings(TestCase):
         expected_max_pilots = 1000
 
         self.assertEqual(first=max_pilots, second=expected_max_pilots)
+
+    def test_dscan_grid_size(self):
+        """
+        Test for the default INTELTOOL_DSCAN_GRID_SIZE
+
+        :return:
+        :rtype:
+        """
+
+        grid_size = AppSettings.INTELTOOL_DSCAN_GRID_SIZE
+        expected_grid_size = 10000
+
+        self.assertEqual(first=grid_size, second=expected_grid_size)
+
+    @mock.patch(SETTINGS_PATH + ".AppSettings.INTELTOOL_DSCAN_GRID_SIZE", 1000)
+    def test_dscan_grid_size_custom(self):
+        """
+        Test for a custom INTELTOOL_DSCAN_GRID_SIZE
+
+        :return:
+        :rtype:
+        """
+
+        grid_size = AppSettings.INTELTOOL_DSCAN_GRID_SIZE
+        expected_grid_size = 1000
+
+        self.assertEqual(first=grid_size, second=expected_grid_size)

{aa_intel_tool-0.0.1a9 → aa_intel_tool-0.0.1a10}/aa_intel_tool/views/ajax.py

@@ -29,16 +29,11 @@ def get_scan_data(
     """
 
     try:
-        scan_data = (
-            ScanData.objects.filter(  # pylint: disable=no-member
-                scan_id__exact=scan_hash,
-                section__exact=scan_section,
-            )
-            .exclude(section=ScanData.Section.INVALID)
-            .get()
-        )
+        scan_data = ScanData.objects.filter(  # pylint: disable=no-member
+            scan_id__exact=scan_hash, section__exact=scan_section
+        ).get()
         processed_data = scan_data.processed_data
     except ScanData.DoesNotExist:  # pylint: disable=no-member
-        processed_data = None
+        processed_data = {}
 
     return JsonResponse(data=processed_data, safe=False)

{aa_intel_tool-0.0.1a9 → aa_intel_tool-0.0.1a10}/pyproject.toml

@@ -6,7 +6,7 @@ requires = [
 
 [project]
 name = "aa-intel-tool"
-version = "0.0.1-alpha.9"
+version = "0.0.1-alpha.10"
 description = "A simple parser for D-Scans and more for Alliance Auth"
 readme = "README.md"
 keywords = [