mmisp-lib 0.7.1__tar.gz → 0.7.3__tar.gz

{mmisp_lib-0.7.1 → mmisp_lib-0.7.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mmisp-lib
-Version: 0.7.1
+Version: 0.7.3
 Requires-Python: >=3.11.0
 Description-Content-Type: text/markdown
 License-File: LICENSE

{mmisp_lib-0.7.1 → mmisp_lib-0.7.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mmisp-lib"
-version = "0.7.1"
+version = "0.7.3"
 description = ""
 authors = []
 readme = "README.md"

{mmisp_lib-0.7.1 → mmisp_lib-0.7.3}/src/mmisp/api_schemas/galaxy_clusters.py

@@ -1,4 +1,5 @@
 from datetime import datetime
+from uuid import UUID
 
 from pydantic import BaseModel
 
@@ -17,7 +18,7 @@ class ExportGalaxyGalaxyElement(BaseModel):
 
 class GetGalaxyClusterResponse(BaseModel):
     id: int | None = None
-    uuid: str | None = None
+    uuid: UUID | None = None
     collection_uuid: str
     type: str
     value: str
@@ -86,6 +87,12 @@ class AddGalaxyElement(BaseModel):
     value: str
 
 
+class AddUpdateGalaxyElement(BaseModel):
+    id: int | None = None
+    key: str
+    value: str
+
+
 class AddGalaxyClusterRequest(BaseModel):
     value: str
     description: str
@@ -95,5 +102,18 @@ class AddGalaxyClusterRequest(BaseModel):
     GalaxyElement: list[AddGalaxyElement]
 
 
+class PutGalaxyClusterRequest(BaseModel):
+    id: int
+    value: str
+    description: str
+    source: str
+    type: str
+    uuid: UUID
+    version: int
+    authors: list[str]
+    distribution: DistributionLevels
+    GalaxyElement: list[AddUpdateGalaxyElement]
+
+
 class AddGalaxyClusterResponse(BaseModel):
     pass

mmisp_lib-0.7.3/src/mmisp/db/mixins.py

@@ -0,0 +1,62 @@
+from typing import Self
+
+from sqlalchemy import inspect
+from sqlalchemy.ext.hybrid import hybrid_property
+
+
+class DictMixin:
+    def asdict(self: Self, omit: set[str] | None = None) -> dict:
+        if omit is None:
+            omit = set()
+
+        unloaded = inspect(self).unloaded
+        d = {}
+        for key in self.__mapper__.c.keys():  # type:ignore[attr-defined]
+            if key in omit:
+                continue
+            if not key.startswith("_") and key not in unloaded:
+                d[key] = getattr(self, key)
+
+        for key, prop in inspect(self.__class__).all_orm_descriptors.items():  # type:ignore[union-attr]
+            if key in omit:
+                continue
+            if isinstance(prop, hybrid_property):
+                d[key] = getattr(self, key)
+        return d
+
+
+class UpdateMixin:
+    def patch(self: Self, **kwargs) -> None:
+        """
+        Update model fields with provided keyword arguments.
+        Do not alter attributes not in kwargs
+
+        Args:
+            **kwargs: Key-value pairs to update the model fields.
+        """
+        for key, value in kwargs.items():
+            if hasattr(self, key):
+                setattr(self, key, value)
+
+    def put(self: Self, **kwargs) -> None:
+        """
+        Update all model fields with provided keyword arguments or set them to none.
+
+        Args:
+            **kwargs: Key-value pairs to update the model fields.
+        """
+        for key in self.__mapper__.c.keys():  # type:ignore[attr-defined]
+            if key.startswith("_"):
+                continue
+            if key in kwargs:
+                setattr(self, key, kwargs[key])
+            else:
+                setattr(self, key, None)
+
+        for key, prop in inspect(self.__class__).all_orm_descriptors.items():  # type:ignore[union-attr]
+            if not isinstance(prop, hybrid_property):
+                continue
+            if key in kwargs:
+                setattr(self, key, kwargs[key])
+            else:
+                setattr(self, key, None)

{mmisp_lib-0.7.1 → mmisp_lib-0.7.3}/src/mmisp/db/models/galaxy_cluster.py

@@ -1,18 +1,24 @@
+import json
+from typing import Self
+
 from sqlalchemy import Boolean, ForeignKey, Integer, String, Text
+from sqlalchemy.ext.hybrid import hybrid_property
 from sqlalchemy.orm import relationship
 
+from mmisp.db.mixins import DictMixin, UpdateMixin
 from mmisp.db.mypy import Mapped, mapped_column
+from mmisp.db.uuid_type import DBUUID
 from mmisp.lib.uuid import uuid
 
 from ..database import Base
 from .galaxy import Galaxy
 
 
-class GalaxyCluster(Base):
+class GalaxyCluster(Base, UpdateMixin, DictMixin):
     __tablename__ = "galaxy_clusters"
 
     id: Mapped[int] = mapped_column(Integer, primary_key=True, nullable=False)
-    uuid: Mapped[str] = mapped_column(String(255), unique=True, default=uuid, index=True)
+    uuid: Mapped[str] = mapped_column(DBUUID, unique=True, default=uuid, index=True)
     collection_uuid: Mapped[str] = mapped_column(String(255), nullable=False, index=True, default="")
     type: Mapped[str] = mapped_column(String(255), nullable=False, index=True)
     value: Mapped[str] = mapped_column(Text, nullable=False)
@@ -22,7 +28,7 @@ class GalaxyCluster(Base):
         Integer, ForeignKey(Galaxy.id, ondelete="CASCADE"), nullable=False, index=True
     )
     source: Mapped[str] = mapped_column(String(255), nullable=False, default="")
-    authors: Mapped[str] = mapped_column(Text, nullable=False)
+    _authors: Mapped[str] = mapped_column("authors", Text, nullable=False)
     version: Mapped[int] = mapped_column(Integer, default=0, index=True)
     distribution: Mapped[int] = mapped_column(Integer, nullable=False, default=0)
     sharing_group_id: Mapped[int] = mapped_column(Integer, index=True, nullable=True, default=None)
@@ -69,8 +75,22 @@ class GalaxyCluster(Base):
         uselist=False,
     )  # type:ignore[assignment,var-annotated]
 
+    def __init__(self: Self, *arg, **kwargs) -> None:
+        if "authors" in kwargs:
+            self._authors = json.dumps(kwargs["authors"])
+            del kwargs["authors"]
+        super().__init__(*arg, **kwargs)
+
+    @hybrid_property
+    def authors(self: Self) -> list[str]:
+        return json.loads(self._authors)
+
+    @authors.setter  # type: ignore[no-redef]
+    def authors(self: Self, value: list[str]) -> None:
+        self._authors = json.dumps(value)
+
 
-class GalaxyElement(Base):
+class GalaxyElement(Base, DictMixin, UpdateMixin):
     __tablename__ = "galaxy_elements"
 
     id: Mapped[int] = mapped_column(Integer, primary_key=True, nullable=False)

mmisp_lib-0.7.3/src/mmisp/db/uuid_type.py

@@ -0,0 +1,19 @@
+from typing import Any, Self
+
+from sqlalchemy.engine import Dialect
+from sqlalchemy.types import String, TypeDecorator
+
+
+class DBUUID(TypeDecorator):
+    impl = String
+
+    def load_dialect_impl(self: Self, dialect: Dialect) -> Any:
+        return dialect.type_descriptor(String(36))
+
+    def process_bind_param(self: Self, value: Any, dialect: Dialect) -> str | None:
+        if value is None:
+            return None
+        return str(value)
+
+    def process_result_value(self: Self, value: Any, dialect: Dialect) -> str:
+        return value

{mmisp_lib-0.7.1 → mmisp_lib-0.7.3}/src/mmisp/lib/galaxies.py

@@ -8,7 +8,9 @@ def json_or_original_string(s: str) -> str | dict | list:
         return s
 
 
-def parse_galaxy_authors(str_authors: str) -> list[str]:
+def parse_galaxy_authors(str_authors: str | list) -> list[str]:
+    if isinstance(str_authors, list):
+        return str_authors
     parsed_author = json_or_original_string(str_authors)
     if isinstance(parsed_author, str):
         parsed_author = [parsed_author]  # force to be a list

mmisp_lib-0.7.3/src/mmisp/lib/galaxy_clusters.py

@@ -0,0 +1,29 @@
+from sqlalchemy.ext.asyncio import AsyncSession
+
+from mmisp.api_schemas.galaxy_clusters import AddUpdateGalaxyElement
+from mmisp.db.models.galaxy_cluster import GalaxyCluster, GalaxyElement
+
+
+async def update_galaxy_cluster_elements(
+    db: AsyncSession, galaxy_cluster: GalaxyCluster, new: list[AddUpdateGalaxyElement]
+) -> None:
+    """Update the relationship of GalaxyCluster to GalaxyElements as defined by new_dict"""
+    old = [ge.asdict(omit={"galaxy_cluster_id"}) for ge in galaxy_cluster.galaxy_elements]
+
+    maybe_updated_dict = {item.id: item.dict() for item in new if item.id is not None}
+    added_dict = [item for item in new if item.id is None]
+    new_ids = {item.id for item in new if item.id is not None}
+    old_ids = {item["id"] for item in old if "id" in item}
+
+    to_delete = old_ids - new_ids
+    if new_ids - old_ids != set():
+        raise ValueError("new_ids are not a subset of old_ids")
+
+    for ge in galaxy_cluster.galaxy_elements:
+        if ge.id in to_delete:
+            await db.delete(ge)
+        else:
+            ge.patch(**maybe_updated_dict[ge.id])
+
+    for ge_dict in added_dict:
+        db.add(GalaxyElement(galaxy_cluster_id=galaxy_cluster.id, **ge_dict.dict(exclude_none=True)))

{mmisp_lib-0.7.1 → mmisp_lib-0.7.3}/src/mmisp/tests/fixtures.py

@@ -580,7 +580,7 @@ async def test_default_galaxy(db, galaxy_default_cluster_one_uuid, galaxy_defaul
         description="test",
         galaxy_id=galaxy.id,
         source="me",
-        authors='["Konstantin Zangerle", "Test Writer"]',
+        authors=["Konstantin Zangerle", "Test Writer"],
         version=1,
         distribution=3,
         sharing_group_id=None,
@@ -602,7 +602,7 @@ async def test_default_galaxy(db, galaxy_default_cluster_one_uuid, galaxy_defaul
         description="test",
         galaxy_id=galaxy.id,
         source="me",
-        authors='["Konstantin Zangerle", "Test Writer"]',
+        authors=["Konstantin Zangerle", "Test Writer"],
         version=1,
         distribution=3,
         sharing_group_id=None,
@@ -692,7 +692,7 @@ async def test_galaxy(db, instance_owner_org, galaxy_cluster_one_uuid, galaxy_cl
         description="test",
         galaxy_id=galaxy.id,
         source="me",
-        authors='["Konstantin Zangerle", "Test Writer"]',
+        authors=["Konstantin Zangerle", "Test Writer"],
         version=1,
         distribution=3,
         sharing_group_id=None,
@@ -714,7 +714,7 @@ async def test_galaxy(db, instance_owner_org, galaxy_cluster_one_uuid, galaxy_cl
         description="test",
         galaxy_id=galaxy.id,
         source="me",
-        authors='["Konstantin Zangerle", "Test Writer"]',
+        authors=["Konstantin Zangerle", "Test Writer"],
         version=1,
         distribution=3,
         sharing_group_id=None,

{mmisp_lib-0.7.1 → mmisp_lib-0.7.3}/src/mmisp_lib.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mmisp-lib
-Version: 0.7.1
+Version: 0.7.3
 Requires-Python: >=3.11.0
 Description-Content-Type: text/markdown
 License-File: LICENSE

{mmisp_lib-0.7.1 → mmisp_lib-0.7.3}/src/mmisp_lib.egg-info/SOURCES.txt

@@ -48,6 +48,7 @@ src/mmisp/db/mixins.py
 src/mmisp/db/mypy.py
 src/mmisp/db/print_changes.py
 src/mmisp/db/py.typed
+src/mmisp/db/uuid_type.py
 src/mmisp/db/models/__init__.py
 src/mmisp/db/models/admin_setting.py
 src/mmisp/db/models/attribute.py
@@ -84,6 +85,7 @@ src/mmisp/lib/attributes.py
 src/mmisp/lib/distribution.py
 src/mmisp/lib/fallbacks.py
 src/mmisp/lib/galaxies.py
+src/mmisp/lib/galaxy_clusters.py
 src/mmisp/lib/logger.py
 src/mmisp/lib/logging.py
 src/mmisp/lib/permissions.py

mmisp_lib-0.7.1/src/mmisp/db/mixins.py

@@ -1,18 +0,0 @@
-from typing import Self
-
-from sqlalchemy import inspect
-from sqlalchemy.ext.hybrid import hybrid_property
-
-
-class DictMixin:
-    def asdict(self: Self) -> dict:
-        unloaded = inspect(self).unloaded
-        d = {}
-        for key in self.__mapper__.c.keys():  # type:ignore[attr-defined]
-            if not key.startswith("_") and key not in unloaded:
-                d[key] = getattr(self, key)
-
-        for key, prop in inspect(self.__class__).all_orm_descriptors.items():  # type:ignore[union-attr]
-            if isinstance(prop, hybrid_property):
-                d[key] = getattr(self, key)
-        return d