howler-api 4.0.0.dev657__tar.gz → 4.0.0.dev669__tar.gz

{howler_api-4.0.0.dev657 → howler_api-4.0.0.dev669}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: howler-api
-Version: 4.0.0.dev657
+Version: 4.0.0.dev669
 Summary: Howler - API server
 License: MIT
 Keywords: howler,alerting,gc,canada,cse-cst,cse,cst,cyber,cccs

{howler_api-4.0.0.dev657 → howler_api-4.0.0.dev669}/howler/api/v2/case.py

@@ -246,42 +246,88 @@ def append_item(id: str, user: User, **kwargs):  # noqa: C901
 
 
 @generate_swagger_docs()
-@case_api.route("/<id>/items", methods=["DELETE"])
+@case_api.route("/<case_id>/items", methods=["DELETE"])
 @api_login(required_priv=["R", "W"])
-def delete_item(id: str, **kwargs):
-    """Delete an item from a case
+def delete_item(case_id: str, **kwargs):
+    """Delete one or more items from a case
 
-    This endpoint removes an item from a case's items list. If the item is a hit or
+    This endpoint removes items from a case's items list. If an item is a hit or
     observable, the bidirectional relationship is cleaned up - the case reference will
     be removed from the backing object's related.cases list.
 
     Variables:
-    id       => The id of the case to modify
+    case_id       => The id of the case to modify
 
     Arguments:
     None
 
     Data Block:
     {
-        "value": "item-id-123"   # The value of the item to delete
+        "values": ["item-id-123", "item-id-456"]   # The values of the items to delete
     }
 
     Result Example:
     {
-        "success": true     # Did the deletion succeed?
+        ...case     # The updated case data
     }
     """
     body = request.json
 
-    if not body or not isinstance(body, dict) or "value" not in body:
-        return bad_request(err="Request body must be a JSON object with a 'value' field.")
+    if not body or not isinstance(body, dict) or "values" not in body:
+        return bad_request(err="Request body must be a JSON object with a 'values' field.")
+
+    values = body["values"]
+    if not isinstance(values, list) or not values:
+        return bad_request(err="'values' must be a non-empty list.")
 
     try:
-        case_service.remove_case_item(id, item_value=body["value"])
+        return ok(case_service.remove_case_items(case_id, values))
     except DataStoreException as e:
         logger.exception("Save Error")
         return internal_error(err=str(e))
-    except InvalidDataException as e:
+    except (InvalidDataException, NotFoundException) as e:
         return bad_request(err=str(e))
 
-    return ok()
+
+@generate_swagger_docs()
+@case_api.route("/<case_id>/items", methods=["PATCH"])
+@api_login(required_priv=["R", "W"])
+def rename_item(case_id: str, **kwargs):
+    """Rename (re-path) an item within a case
+
+    Updates the path of a single item identified by its value. The new path must
+    not already be used by another item in the case.
+
+    Variables:
+    case_id       => The id of the case to modify
+
+    Arguments:
+    None
+
+    Data Block:
+    {
+        "value": "item-id-123",          # The value of the item to rename
+        "new_path": "folder/New Name"    # The new path for the item
+    }
+
+    Result Example:
+    {
+        ...case     # The updated case data
+    }
+    """
+    body = request.json
+
+    if not body or not isinstance(body, dict):
+        return bad_request(err="Request body must be a JSON object.")
+
+    for field in ["value", "new_path"]:
+        if field not in body:
+            return bad_request(err=f"'{field}' is required.")
+
+    try:
+        return ok(case_service.rename_case_item(case_id, item_value=body["value"], new_path=body["new_path"]))
+    except DataStoreException as e:
+        logger.exception("Save Error")
+        return internal_error(err=str(e))
+    except (InvalidDataException, NotFoundException) as e:
+        return bad_request(err=str(e))

{howler_api-4.0.0.dev657 → howler_api-4.0.0.dev669}/howler/services/case_service.py

@@ -320,8 +320,14 @@ def append_hit(case_id: str, item: CaseItem) -> Case:
 
     hit = ds.hit.get(item.value)
 
+    if hit is None:
+        raise NotFoundException(f"Hit {item.value} not found, cannot be added to case")
+
     _case.items.append(item)
 
+    if not ds.case.save(_case.case_id, _case):
+        raise DataStoreException(f"Failed to save {_case.case_id} with new item {item.value}")
+
     _add_backreference(hit, _case.case_id)
 
     _sync_case_metadata(_case.case_id)
@@ -362,7 +368,7 @@ def append_observable(case_id: str, item: CaseItem) -> Case:
 
     _case.items.append(item)
 
-    if not datastore().case.save(_case.case_id, _case):
+    if not ds.case.save(_case.case_id, _case):
         raise DataStoreException(f"Failed to save {_case.case_id} with new item {item.value}")
 
     _add_backreference(observable, _case.case_id)
@@ -585,20 +591,26 @@ def remove_backreference(backing_obj: Hit | Observable | None, case_id: str):
         datastore()[backing_obj.__class__.__name__.lower()].save(backing_obj.howler.id, backing_obj)
 
 
-def remove_case_item(case_id: str, item_value: str):
-    """Remove an item from a case and clean up any associated back-references.
+def remove_case_items(case_id: str, values: list[str]):
+    """Remove one or more items from a case in a single atomic operation.
 
-    Locates the item within the case by its value, removes it from the case's
-    items list, persists the updated case, and removes the back-reference from
-    the backing hit or observable if applicable.
+    Validates that every requested value exists within the case before making
+    any modifications.  If any value is missing the call raises NotFoundException
+    without altering the case.  When all values are confirmed, all matching
+    items are removed in memory, the case is persisted once, and back-references
+    are cleaned up from any associated hits or observables.
 
     Args:
-        case_id: Unique identifier of the case to remove the item from.
-        item_value: The value/identifier of the item to remove.
+        case_id: Unique identifier of the case to remove items from.
+        item_values: List of item values (IDs / URLs) to remove.
+
+    Returns:
+        The updated Case object.
 
     Raises:
-        NotFoundException: If the case does not exist.
-        DataStoreException: If saving the updated case fails.
+        NotFoundException: If the case does not exist, or if any requested value
+            is not present in the case's items list.
+        DataStoreException: If persisting the updated case fails.
     """
     ds = datastore()
 
@@ -607,20 +619,80 @@ def remove_case_item(case_id: str, item_value: str):
     if not _case:
         raise NotFoundException(f"Case {case_id} does not exist")
 
-    item = next((_item for _item in _case.items if _item["value"] == item_value), None)
-    if not item:
-        raise NotFoundException(f"Case item {item_value} does not exist")
+    # Build a lookup of value → item for all items currently in the case.
+    items_by_value = {_item["value"]: _item for _item in _case.items}
+
+    # Pre-validate all requested values before touching anything.
+    missing = [v for v in values if v not in items_by_value]
+    if missing:
+        raise NotFoundException(f"Case item(s) not found in case: {', '.join(missing)}")
 
-    backing_obj: Hit | Observable | None = None
-    if item.type in [CaseItemTypes.HIT, CaseItemTypes.OBSERVABLE]:
-        backing_obj = ds[item.type].get(item.value)
+    # Resolve items and collect backing objects that need back-reference cleanup.
+    items_to_remove = [items_by_value[v] for v in values]
+    backing_objs: list[Hit | Observable] = []
+    for item in items_to_remove:
+        if item.type in [CaseItemTypes.HIT, CaseItemTypes.OBSERVABLE]:
+            obj = ds[item.type].get(item.value)
+            if obj:
+                backing_objs.append(obj)
 
-    _case.items.remove(item)
+    # Remove all items in memory, then persist the case once.
+    for item in items_to_remove:
+        _case.items.remove(item)
 
     if not ds.case.save(_case.case_id, _case):
         raise DataStoreException("Failed to save case after item removal")
 
-    if backing_obj:
+    # Clean up back-references after the case is safely persisted.
+    for backing_obj in backing_objs:
         remove_backreference(backing_obj, _case.case_id)
 
     _sync_case_metadata(case_id)
+
+    return _case
+
+
+def rename_case_item(case_id: str, item_value: str, new_path: str) -> Case:
+    """Rename (re-path) a single item within a case.
+
+    Validates that the target item exists in the case, that the new path is not
+    already used by another item, then updates the item's path in memory and
+    persists the case once.
+
+    Args:
+        case_id: Unique identifier of the case to modify.
+        item_value: The value/identifier of the item to rename.
+        new_path: The new path for the item (must not end with '/').
+
+    Returns:
+        The updated Case object.
+
+    Raises:
+        NotFoundException: If the case does not exist or the item is not found.
+        InvalidDataException: If new_path ends with '/' or is already taken by
+            another item in the case.
+        DataStoreException: If persisting the updated case fails.
+    """
+    if not new_path or new_path.endswith("/"):
+        raise InvalidDataException("new_path must be a non-empty string and must not end with '/'")
+
+    ds = datastore()
+
+    _case = ds.case.get(key=case_id)
+
+    if not _case:
+        raise NotFoundException(f"Case {case_id} does not exist")
+
+    item = next((_item for _item in _case.items if _item["value"] == item_value), None)
+    if not item:
+        raise NotFoundException(f"Case item {item_value} does not exist in case {case_id}")
+
+    if any(_item["path"] == new_path for _item in _case.items if _item["value"] != item_value):
+        raise InvalidDataException(f"An item already exists at path '{new_path}' in case {case_id}")
+
+    item.path = new_path
+
+    if not ds.case.save(_case.case_id, _case):
+        raise DataStoreException("Failed to save case after item rename")
+
+    return _case

{howler_api-4.0.0.dev657 → howler_api-4.0.0.dev669}/pyproject.toml

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