howler-api 2.12.0.dev265__tar.gz → 2.12.0.dev278__tar.gz

{howler_api-2.12.0.dev265 → howler_api-2.12.0.dev278}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: howler-api
-Version: 2.12.0.dev265
+Version: 2.12.0.dev278
 Summary: Howler - API server
 License: MIT
 Keywords: howler,alerting,gc,canada,cse-cst,cse,cst,cyber,cccs

{howler_api-2.12.0.dev265 → howler_api-2.12.0.dev278}/howler/services/analytic_service.py

@@ -2,6 +2,7 @@ from typing import Any, Union
 
 from howler.common.loader import datastore
 from howler.common.logging import get_logger
+from howler.datastore.exceptions import SearchException
 from howler.datastore.operations import OdmUpdateOperation
 from howler.odm.models.analytic import Analytic
 from howler.odm.models.hit import Hit
@@ -46,17 +47,24 @@ def get_matching_analytics(hits: Union[list[Hit], list[dict[str, Any]]]) -> list
     Returns:
         list[Analytic]: A list of Analytic objects that match the analytics referenced in the hits.
     """
+    if len(hits) < 1:
+        return []
+
     storage = datastore()
 
     analytic_names: set[str] = set()
     for hit in hits:
         analytic_names.add(f'"{sanitize_lucene_query(hit["howler"]["analytic"])}"')
 
-    existing_analytics: list[Analytic] = storage.analytic.search(f'name:({" OR ".join(analytic_names)})', as_obj=True)[
-        "items"
-    ]
+    try:
+        existing_analytics: list[Analytic] = storage.analytic.search(
+            f'name:({" OR ".join(analytic_names)})', as_obj=True
+        )["items"]
 
-    return existing_analytics
+        return existing_analytics
+    except SearchException:
+        logger.exception("Exception on analytic matching")
+        return []
 
 
 def save_from_hit(hit: Hit, user: User):

{howler_api-2.12.0.dev265 → howler_api-2.12.0.dev278}/howler/services/hit_service.py

@@ -30,11 +30,11 @@ from howler.odm.models.ecs.event import Event
 from howler.odm.models.hit import Hit
 from howler.odm.models.howler_data import HitOperationType, HitStatus, HitStatusTransition, Log
 from howler.odm.models.user import User
-from howler.services import action_service, analytic_service, dossier_service
+from howler.services import action_service, analytic_service, dossier_service, overview_service, template_service
 from howler.utils.dict_utils import extra_keys, flatten
 from howler.utils.uid import get_random_id
 
-log = get_logger(__file__)
+logger = get_logger(__file__)
 
 odm_helper = OdmHelper(Hit)
 
@@ -535,7 +535,7 @@ def _update_hit(
         else:
             operation_type = HitOperationType.SET
 
-        log.debug("%s - %s - %s -> %s", hit_id, operation.key, previous_value, operation.value)
+        logger.debug("%s - %s - %s -> %s", hit_id, operation.key, previous_value, operation.value)
         final_operations.append(operation)
 
         if not operation.silent:
@@ -640,7 +640,7 @@ def transition_hit(
 
     # Log all hits that will be transitioned
     all_hit_ids = [h["howler"]["id"] for h in ([primary_hit] + [ch for ch in child_hits if ch])]
-    log.debug("Transitioning (%s)", ", ".join(all_hit_ids))
+    logger.debug("Transitioning (%s)", ", ".join(all_hit_ids))
 
     # Process each hit (primary + children) with the workflow transition
     for current_hit in [primary_hit] + [ch for ch in child_hits if ch]:
@@ -650,7 +650,7 @@ def transition_hit(
         # Skip hits that don't match the primary hit's status
         # This ensures consistent state transitions across bundles
         if current_hit_status != primary_hit_status:
-            log.debug("Skipping %s (status mismatch)", current_hit_id)
+            logger.debug("Skipping %s (status mismatch)", current_hit_id)
             continue
 
         # Apply the workflow transition to get required updates
@@ -837,33 +837,37 @@ def augment_metadata(data: list[dict[str, Any]] | dict[str, Any], metadata: list
         This function modifies the input data in-place, adding metadata fields.
         Templates are filtered based on user permissions (global or owned by user).
     """
-    hits = data if isinstance(data, list) else [data]
+    if isinstance(data, list):
+        hits = data
+    elif data is not None:
+        hits = [data]
+    else:
+        hits = []
+
+    if len(hits) < 1:
+        return
+
+    logger.debug("Augmenting %s hits with %s", len(hits), ",".join(metadata))
 
-    analytics: set[str] = set()
-    for hit in hits:
-        analytics.add(f'"{hit["howler"]["analytic"]}"')
+    if "template" in metadata:
+        template_candidates = template_service.get_matching_templates(hits, user["uname"], as_odm=False)
 
-    if len(analytics) > 0:
-        if "template" in metadata:
-            template_candidates = datastore().template.search(
-                f"analytic:({' OR '.join(analytics)}) AND (type:global OR owner:{user['uname']})",
-                as_obj=False,
-            )["items"]
+        logger.debug("\tRetrieved %s matching templates", len(template_candidates))
 
-            for hit in hits:
-                hit["__template"] = __match_metadata(template_candidates, hit)
+        for hit in hits:
+            hit["__template"] = __match_metadata(cast(list[dict[str, Any]], template_candidates), hit)
+
+    if "overview" in metadata:
+        overview_candidates = overview_service.get_matching_overviews(hits, as_odm=False)
 
-        if "overview" in metadata:
-            overview_candidates = datastore().overview.search(
-                f"analytic:({' OR '.join(analytics)})",
-                as_obj=False,
-            )["items"]
+        logger.debug("\tRetrieved %s matching overviews", len(overview_candidates))
 
-            for hit in hits:
-                hit["__overview"] = __match_metadata(overview_candidates, hit)
+        for hit in hits:
+            hit["__overview"] = __match_metadata(cast(list[dict[str, Any]], overview_candidates), hit)
 
     if "analytic" in metadata:
         matched_analytics = analytic_service.get_matching_analytics(hits)
+        logger.debug("\tRetrieved %s matching analytics", len(matched_analytics))
 
         for hit in hits:
             matched_analytic = next(

howler_api-2.12.0.dev278/howler/services/overview_service.py

@@ -0,0 +1,44 @@
+from typing import Any, Union
+
+from howler.common.loader import datastore
+from howler.common.logging import get_logger
+from howler.datastore.exceptions import SearchException
+from howler.odm.models.hit import Hit
+from howler.odm.models.overview import Overview
+from howler.utils.str_utils import sanitize_lucene_query
+
+logger = get_logger(__file__)
+
+
+def get_matching_overviews(
+    hits: Union[list[Hit], list[dict[str, Any]]], as_odm: bool = False
+) -> Union[list[dict[str, Any]], list[Overview]]:
+    """Generate a list of overviews matching a given list of analytic names from the provided hits.
+
+    Args:
+        hits (list[Hit] | list[dict[str, Any]]): A list of Hit objects or dictionaries containing analytic information.
+        as_odm (bool, optional): If True, return Overview objects; otherwise, return dictionaries. Defaults to False.
+
+    Returns:
+        list[dict[str, Any]] | list[Overview]: A list of matching overviews, either as dictionaries or Overview objects.
+    """
+    if len(hits) < 1:
+        return []
+
+    analytic_names: set[str] = set()
+    for hit in hits:
+        analytic_names.add(f'"{sanitize_lucene_query(hit["howler"]["analytic"])}"')
+
+    if len(analytic_names) < 1:
+        return []
+
+    try:
+        overview_candidates = datastore().overview.search(
+            f"analytic:({' OR '.join(analytic_names)})",
+            as_obj=as_odm,
+        )["items"]
+
+        return overview_candidates
+    except SearchException:
+        logger.exception("Exception on analytic matching")
+        return []

howler_api-2.12.0.dev278/howler/services/template_service.py

@@ -0,0 +1,45 @@
+from typing import Any, Optional, Union
+
+from howler.common.loader import datastore
+from howler.common.logging import get_logger
+from howler.datastore.exceptions import SearchException
+from howler.odm.models.analytic import Analytic
+from howler.odm.models.hit import Hit
+from howler.utils.str_utils import sanitize_lucene_query
+
+logger = get_logger(__file__)
+
+
+def get_matching_templates(
+    hits: Union[list[Hit], list[dict[str, Any]]], uname: Optional[str] = None, as_odm: bool = False
+) -> Union[list[dict[str, Any]], list[Analytic]]:
+    """Generate a list of templates matching a given list of analytic names, and optionally a user.
+
+    Args:
+        hits (list[Hit] | list[dict[str, Any]]]: List of hits, each containing analytic information.
+        uname (Optional[str], optional): Username to filter templates by owner. Defaults to None.
+        as_odm (bool, optional): If True, return results as ODM objects. If False, return as dicts. Defaults to False.
+
+    Returns:
+        list[dict[str, Any]] | list[Analytic]: List of matching templates, either as dicts or Analytic ODM objects.
+    """
+    if len(hits) < 1:
+        return []
+
+    analytic_names: set[str] = set()
+    for hit in hits:
+        analytic_names.add(f'"{sanitize_lucene_query(hit["howler"]["analytic"])}"')
+
+    if len(analytic_names) < 1:
+        return []
+
+    try:
+        template_candidates = datastore().template.search(
+            f"analytic:({' OR '.join(analytic_names)}) AND (type:global OR owner:{uname or '*'})",
+            as_obj=as_odm,
+        )["items"]
+
+        return template_candidates
+    except SearchException:
+        logger.exception("Exception on analytic matching")
+        return []

{howler_api-2.12.0.dev265 → howler_api-2.12.0.dev278}/pyproject.toml

@@ -148,7 +148,7 @@ suppress-none-returning = true
 [tool.poetry]
 package-mode = true
 name = "howler-api"
-version = "2.12.0.dev265"
+version = "2.12.0.dev278"
 description = "Howler - API server"
 authors = [
     "Canadian Centre for Cyber Security <howler@cyber.gc.ca>",