GeneralManager 0.20.0__py3-none-any.whl → 0.21.0__py3-none-any.whl

general_manager/permission/permission_checks.py

@@ -1,25 +1,26 @@
 """Registry of reusable permission checks and their queryset filters."""
 
+from __future__ import annotations
+
 from typing import Any, Callable, TYPE_CHECKING, TypedDict, Literal
 
 if TYPE_CHECKING:
-    from django.contrib.auth.models import AbstractUser, AnonymousUser
+    from django.contrib.auth.models import AbstractBaseUser, AnonymousUser
     from general_manager.permission.permission_data_manager import (
         PermissionDataManager,
     )
     from general_manager.manager.general_manager import GeneralManager
     from general_manager.manager.meta import GeneralManagerMeta
 
-
 type permission_filter = Callable[
-    [AbstractUser | AnonymousUser, list[str]],
-    dict[Literal["filter", "exclude"], dict[str, str]] | None,
+    [AbstractBaseUser | AnonymousUser, list[str]],
+    dict[Literal["filter", "exclude"], dict[str, Any]] | None,
 ]
 
 type permission_method = Callable[
     [
         PermissionDataManager | GeneralManager | GeneralManagerMeta,
-        AbstractUser | AnonymousUser,
+        AbstractBaseUser | AnonymousUser,
         list[str],
     ],
     bool,
@@ -33,36 +34,205 @@ class PermissionDict(TypedDict):
     permission_filter: permission_filter
 
 
-permission_functions: dict[str, PermissionDict] = {
-    "public": {
-        "permission_method": lambda _instance, _user, _config: True,
-        "permission_filter": lambda _user, _config: None,
-    },
-    "matches": {
-        "permission_method": lambda instance, _user, config: getattr(
-            instance, config[0]
-        )
-        == config[1],
-        "permission_filter": lambda _user, config: {"filter": {config[0]: config[1]}},
-    },
-    "ends_with": {
-        "permission_method": lambda instance, _user, config: getattr(
-            instance, config[0]
-        ).endswith(config[1]),
-        "permission_filter": lambda _user, config: {
-            "filter": {f"{config[0]}__endswith": config[1]}
-        },
-    },
-    "isAdmin": {
-        "permission_method": lambda _instance, user, _config: user.is_staff,
-        "permission_filter": lambda _user, _config: None,
-    },
-    "isSelf": {
-        "permission_method": lambda instance, user, _config: instance.creator == user,  # type: ignore
-        "permission_filter": lambda user, _config: {"filter": {"creator_id": user.id}},  # type: ignore
-    },
-    "isAuthenticated": {
-        "permission_method": lambda _instance, user, _config: user.is_authenticated,
-        "permission_filter": lambda _user, _config: None,
-    },
-}
+permission_functions: dict[str, PermissionDict] = {}
+
+__all__ = ["permission_functions", "register_permission"]
+
+_PERMISSION_ALREADY_REGISTERED_MESSAGE = "Permission function is already registered."
+
+
+def _default_permission_filter(
+    _user: AbstractBaseUser | AnonymousUser, _config: list[str]
+) -> dict[Literal["filter", "exclude"], dict[str, Any]] | None:
+    return None
+
+
+def register_permission(
+    name: str, *, permission_filter: permission_filter | None = None
+) -> Callable[[permission_method], permission_method]:
+    """
+    Register a permission function in the global registry.
+
+    Parameters:
+        name (str): Identifier used in permission expressions.
+        permission_filter (permission_filter | None): Optional callable that
+            provides queryset filters corresponding to the permission.
+
+    Returns:
+        Callable[[permission_method], permission_method]: Decorator that
+        registers the decorated function and returns it unchanged.
+
+    Raises:
+        ValueError: If another permission with the same name has already been
+            registered.
+    """
+
+    def decorator(func: permission_method) -> permission_method:
+        if name in permission_functions:
+            raise ValueError(_PERMISSION_ALREADY_REGISTERED_MESSAGE)
+        filter_callable = permission_filter or _default_permission_filter
+        permission_functions[name] = {
+            "permission_method": func,
+            "permission_filter": filter_callable,
+        }
+        return func
+
+    return decorator
+
+
+@register_permission("public")
+def _permission_public(
+    _instance: PermissionDataManager | GeneralManager | GeneralManagerMeta,
+    _user: AbstractBaseUser | AnonymousUser,
+    _config: list[str],
+) -> bool:
+    return True
+
+
+def _matches_permission_filter(
+    _user: AbstractBaseUser | AnonymousUser, config: list[str]
+) -> dict[Literal["filter", "exclude"], dict[str, Any]] | None:
+    if len(config) < 2:
+        return None
+    return {"filter": {config[0]: config[1]}}
+
+
+@register_permission("matches", permission_filter=_matches_permission_filter)
+def _permission_matches(
+    instance: PermissionDataManager | GeneralManager | GeneralManagerMeta,
+    _user: AbstractBaseUser | AnonymousUser,
+    config: list[str],
+) -> bool:
+    return bool(
+        len(config) >= 2 and str(getattr(instance, config[0], None)) == config[1]
+    )
+
+
+@register_permission("isAdmin")
+def _permission_is_admin(
+    _instance: PermissionDataManager | GeneralManager | GeneralManagerMeta,
+    user: AbstractBaseUser | AnonymousUser,
+    _config: list[str],
+) -> bool:
+    return bool(getattr(user, "is_staff", False))
+
+
+def _is_self_permission_filter(
+    user: AbstractBaseUser | AnonymousUser,
+    _config: list[str],
+) -> dict[Literal["filter", "exclude"], dict[str, Any]] | None:
+    return {"filter": {"creator_id": getattr(user, "id", None)}}
+
+
+@register_permission("isSelf", permission_filter=_is_self_permission_filter)
+def _permission_is_self(
+    instance: PermissionDataManager | GeneralManager | GeneralManagerMeta,
+    user: AbstractBaseUser | AnonymousUser,
+    _config: list[str],
+) -> bool:
+    return bool(instance.creator == user)  # type: ignore[union-attr]
+
+
+@register_permission("isAuthenticated")
+def _permission_is_authenticated(
+    _instance: PermissionDataManager | GeneralManager | GeneralManagerMeta,
+    user: AbstractBaseUser | AnonymousUser,
+    _config: list[str],
+) -> bool:
+    return bool(getattr(user, "is_authenticated", False))
+
+
+@register_permission("isActive")
+def _permission_is_active(
+    _instance: PermissionDataManager | GeneralManager | GeneralManagerMeta,
+    user: AbstractBaseUser | AnonymousUser,
+    _config: list[str],
+) -> bool:
+    return bool(getattr(user, "is_active", False))
+
+
+@register_permission("hasPermission")
+def _permission_has_permission(
+    _instance: PermissionDataManager | GeneralManager | GeneralManagerMeta,
+    user: AbstractBaseUser | AnonymousUser,
+    config: list[str],
+) -> bool:
+    if not config:
+        return False
+    has_perm = getattr(user, "has_perm", None)
+    if not callable(has_perm):
+        return False
+    return bool(has_perm(config[0]))
+
+
+@register_permission("inGroup")
+def _permission_in_group(
+    _instance: PermissionDataManager | GeneralManager | GeneralManagerMeta,
+    user: AbstractBaseUser | AnonymousUser,
+    config: list[str],
+) -> bool:
+    if not config:
+        return False
+    group_manager = getattr(user, "groups", None)
+    if group_manager is None or not hasattr(group_manager, "filter"):
+        return False
+    filtered = group_manager.filter(name=config[0])  # type: ignore[attr-defined]
+    return bool(hasattr(filtered, "exists") and filtered.exists())  # type: ignore[call-arg]
+
+
+def _related_user_field_permission_filter(
+    user: AbstractBaseUser | AnonymousUser, config: list[str]
+) -> dict[Literal["filter", "exclude"], dict[str, Any]] | None:
+    if not config:
+        return None
+    user_id = getattr(user, "id", None)
+    if user_id is None:
+        return None
+    return {"filter": {f"{config[0]}_id": user_id}}
+
+
+@register_permission(
+    "relatedUserField",
+    permission_filter=_related_user_field_permission_filter,
+)
+def _permission_related_user_field(
+    instance: PermissionDataManager | GeneralManager | GeneralManagerMeta,
+    user: AbstractBaseUser | AnonymousUser,
+    config: list[str],
+) -> bool:
+    if not config:
+        return False
+    related_object = getattr(instance, config[0], None)
+    return bool(related_object == user)  # type: ignore[arg-type]
+
+
+def _many_to_many_contains_user_permission_filter(
+    user: AbstractBaseUser | AnonymousUser, config: list[str]
+) -> dict[Literal["filter", "exclude"], dict[str, Any]] | None:
+    if not config:
+        return None
+    user_id = getattr(user, "id", None)
+    if user_id is None:
+        return None
+    return {"filter": {f"{config[0]}__id": user_id}}
+
+
+@register_permission(
+    "manyToManyContainsUser",
+    permission_filter=_many_to_many_contains_user_permission_filter,
+)
+def _permission_many_to_many_contains_user(
+    instance: PermissionDataManager | GeneralManager | GeneralManagerMeta,
+    user: AbstractBaseUser | AnonymousUser,
+    config: list[str],
+) -> bool:
+    if not config:
+        return False
+    related_manager = getattr(instance, config[0], None)
+    if related_manager is None or not hasattr(related_manager, "filter"):
+        return False
+    user_pk = getattr(user, "pk", None)
+    if user_pk is None:
+        return False
+    filtered = related_manager.filter(pk=user_pk)  # type: ignore[attr-defined]
+    return bool(hasattr(filtered, "exists") and filtered.exists())  # type: ignore[call-arg]

general_manager/permission/permission_data_manager.py

@@ -2,7 +2,6 @@
 
 from __future__ import annotations
 from typing import Callable, Optional, TypeVar, Generic, cast
-from django.contrib.auth.models import AbstractUser
 
 from general_manager.manager.general_manager import GeneralManager
 

general_manager/permission/utils.py

@@ -4,7 +4,7 @@ from general_manager.permission.permission_checks import (
     permission_functions,
 )
 from general_manager.permission.permission_data_manager import PermissionDataManager
-from django.contrib.auth.models import AbstractUser, AnonymousUser
+from django.contrib.auth.models import AbstractBaseUser, AnonymousUser
 
 from general_manager.manager.general_manager import GeneralManager
 from general_manager.manager.meta import GeneralManagerMeta
@@ -26,7 +26,7 @@ class PermissionNotFoundError(ValueError):
 def validate_permission_string(
     permission: str,
     data: PermissionDataManager | GeneralManager | GeneralManagerMeta,
-    request_user: AbstractUser | AnonymousUser,
+    request_user: AbstractBaseUser | AnonymousUser,
 ) -> bool:
     """
     Evaluate a compound permission expression joined by '&' operators.
@@ -34,7 +34,7 @@ def validate_permission_string(
     Parameters:
         permission (str): Permission expression where sub-permissions are joined with '&'. Individual sub-permissions may include ':'-separated configuration parts (for example, "isAuthenticated&admin:level").
         data (PermissionDataManager | GeneralManager | GeneralManagerMeta): Object passed to each permission function.
-        request_user (AbstractUser | AnonymousUser): User for whom permissions are evaluated.
+        request_user (AbstractBaseUser | AnonymousUser): User for whom permissions are evaluated.
 
     Returns:
         `true` if every sub-permission evaluates to True, `false` otherwise.

general_manager/public_api_registry.py

@@ -35,6 +35,14 @@ GENERAL_MANAGER_EXPORTS: LazyExportMap = {
         "general_manager.permission.manager_based_permission",
         "ManagerBasedPermission",
     ),
+    "register_permission": (
+        "general_manager.permission.permission_checks",
+        "register_permission",
+    ),
+    "permission_functions": (
+        "general_manager.permission.permission_checks",
+        "permission_functions",
+    ),
     "Rule": ("general_manager.rule.rule", "Rule"),
 }
 
@@ -124,6 +132,35 @@ PERMISSION_EXPORTS: LazyExportMap = {
         "general_manager.permission.mutation_permission",
         "MutationPermission",
     ),
+    "register_permission": (
+        "general_manager.permission.permission_checks",
+        "register_permission",
+    ),
+    "permission_functions": (
+        "general_manager.permission.permission_checks",
+        "permission_functions",
+    ),
+    "configure_audit_logger": (
+        "general_manager.permission.audit",
+        "configure_audit_logger",
+    ),
+    "configure_audit_logger_from_settings": (
+        "general_manager.permission.audit",
+        "configure_audit_logger_from_settings",
+    ),
+    "FileAuditLogger": (
+        "general_manager.permission.audit",
+        "FileAuditLogger",
+    ),
+    "DatabaseAuditLogger": (
+        "general_manager.permission.audit",
+        "DatabaseAuditLogger",
+    ),
+    "PermissionAuditEvent": (
+        "general_manager.permission.audit",
+        "PermissionAuditEvent",
+    ),
+    "AuditLogger": ("general_manager.permission.audit", "AuditLogger"),
 }
 
 

{generalmanager-0.20.0.dist-info → generalmanager-0.21.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: GeneralManager
-Version: 0.20.0
+Version: 0.21.0
 Summary: Modular Django-based data management framework with ORM, GraphQL, fine-grained permissions, rule validation, calculations and caching.
 Author-email: Tim Kleindick <tkleindick@yahoo.de>
 License: MIT License

{generalmanager-0.20.0.dist-info → generalmanager-0.21.0.dist-info}/RECORD

@@ -1,18 +1,18 @@
 general_manager/__init__.py,sha256=Xy4_fFjChIYtlBPDv7K3JEHOulq9_IFXkCc4CElS32Q,1035
-general_manager/apps.py,sha256=bz_A2IfgVba2b8lZC5aeQqe40IH7GaavpTEg828Ltm4,27343
+general_manager/apps.py,sha256=1wzMof8IKn_Zw4QyD3WwD7zVedAvsZKhCwsa0ajx6U8,27480
 general_manager/logging.py,sha256=bL2dEdNnxo74qRmhOCG06lbPtVCOozfF3GS133T9HH8,4250
-general_manager/public_api_registry.py,sha256=mDpKIE3fmFAMTbQnQdLAZGc_CKNNA6p22Jrql9R6Y4w,7817
+general_manager/public_api_registry.py,sha256=zAYG6UPfbv5NDSM59kvLxUZBJce5NF8lzEB4op8LnPM,8974
 general_manager/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 general_manager/_types/__init__.py,sha256=RmS0Ok-1-CwWOZL_socLWksEk9MfsshL9eQx879I4mU,60
 general_manager/_types/api.py,sha256=i5fi7O3C3frI74oqPT-tAoztDplgNDOShyvPNxhw7CY,496
 general_manager/_types/bucket.py,sha256=DZ3GC-1iR4RiNBKydsMhp_R4GTaYMfsonwe7MCADVP4,435
 general_manager/_types/cache.py,sha256=jMbIEXDq1pUvVxTN8hvD8rSH7QRjE3ewrMx2gEhYP3w,660
 general_manager/_types/factory.py,sha256=cPG_td05KCWv2j6_h_vYCKETPol3k_nXkEMWCcUdNHM,1726
-general_manager/_types/general_manager.py,sha256=Izs47-pOnYJqPmMF7m5DRodSISEztXKSxtBGIHgN8sA,1031
+general_manager/_types/general_manager.py,sha256=m-VA1968DYEFiunWyA72fUI1EicMLKarYJ5bkSyKJ7I,1241
 general_manager/_types/interface.py,sha256=JlPn3G3ompn1PRfFQfsrIJv2Pf0I3n1RL2ki5_fDX54,605
 general_manager/_types/manager.py,sha256=rXM6NrQaPdfE9CQoRV_jhbI3SK23rvdpvyBpybVgWi8,506
 general_manager/_types/measurement.py,sha256=Unkpf3H7TGaUKfkjmFDR7QWBU4lPp5I2A4GlK8pps-Y,443
-general_manager/_types/permission.py,sha256=HJBEOIDYbkYSZkEbT4_6qRDyUk2Ek153K_RchmeYd5I,416
+general_manager/_types/permission.py,sha256=olbtZNPkYoI1mbtzs6FDuVlKyGiP6VfGwufe8G56CQQ,1196
 general_manager/_types/rule.py,sha256=aNbx3jlVinAYQGJlmFwW8rOwTjf19F6khq5xbGTdD3U,238
 general_manager/_types/utils.py,sha256=8VyD6EKkcRIzdVs6FANP5Ri71eT4BT4c3dTUeyjDr40,1043
 general_manager/api/__init__.py,sha256=ChV1UPCUjW1Lci0BajmXVtE-3C-WLQTvjO058BMu1Bs,1020
@@ -41,7 +41,7 @@ general_manager/interface/calculation_interface.py,sha256=dsu2pjFgaOv-Kif5YbrsbE
 general_manager/interface/database_based_interface.py,sha256=1L0Q22nEWiO_i--3AtuseAytiXMEkIUF4HL5rTB0s0M,25623
 general_manager/interface/database_interface.py,sha256=ALFQKl7jXNQMHegmUkNKyDGJruMmAmprDiiyYsfZZ_A,11825
 general_manager/interface/models.py,sha256=MWCgr-Qzauu7jq-15_iEdI0C9B99MsRONV9jUcjkkMU,3699
-general_manager/interface/read_only_interface.py,sha256=pOi2KNE_eyAMDZMsphaMfsXWa8sy4A-_xVzAV7FZVDM,15177
+general_manager/interface/read_only_interface.py,sha256=w1XrTeOyf3T7lDfC7ponAMhfNw5LTM46lTOEsocE244,16000
 general_manager/manager/__init__.py,sha256=Dbka86jtcS2NIxKXA0mohqnLZwLb6NDRX-HeD1_R6UQ,933
 general_manager/manager/general_manager.py,sha256=GperYpkoTg_CZlwYBsqGhnaMFENR6jyxanKYdHsvZjg,12083
 general_manager/manager/group_manager.py,sha256=EhiW2cEnr7J4Ft-FBfuW4hCT5mYg_RCD_-mYF4an9dw,7320
@@ -51,13 +51,13 @@ general_manager/measurement/__init__.py,sha256=38-6kTERbw7EeOQAw3eZ9DDEu6hwwqkGJ
 general_manager/measurement/measurement.py,sha256=ArEnntLu3ffHID71uFbXwiB5e5tpsBT2_TbBPJfCWJI,26070
 general_manager/measurement/measurement_field.py,sha256=zQbyLZT7E9Lx4f3u_wQ-rEoLPqH0FWhfWyOd1BaW--M,13950
 general_manager/permission/__init__.py,sha256=s4Ka11uYBrymM5O-n5kIxOjwUprZ394jTuzGf5prO_8,981
-general_manager/permission/base_permission.py,sha256=IKi5n8t1sKUP_F2eZnzTC8lg7HI8OVo5p1jxCBpyCgw,11961
-general_manager/permission/file_based_permission.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-general_manager/permission/manager_based_permission.py,sha256=OdDGKwutkHTT13bhSeGGycd3xr7wGhuRXsYym3Z9j2A,10613
-general_manager/permission/mutation_permission.py,sha256=5JV6pluIFPGzJPQ_pr-44zwFg_TgzNwDTHcdpwHettU,4606
-general_manager/permission/permission_checks.py,sha256=4OVQz0QVnmHN-KPge4pz2Zm_oMxo2PUytW7JoDoHjL0,2297
-general_manager/permission/permission_data_manager.py,sha256=vNWbPrcw1NUZ-oTRjc3PME479ubbOqxlKx020GY5wzQ,3905
-general_manager/permission/utils.py,sha256=yojrcF1kD6KjKugrGyiaf8XOyS_tUA4yB5_RideKJeg,2905
+general_manager/permission/audit.py,sha256=mOT4Dj5LnAMbHWXKf6JCM01L-jd7GsMSmAIBTR1hTS0,12802
+general_manager/permission/base_permission.py,sha256=69mgDS7iuxEA1V8lDanDBAH20BY3yc4vp8E0sjrqzmE,16045
+general_manager/permission/manager_based_permission.py,sha256=SfqEvC3RbXjWxxm6JOgEJI9li_6uiB4-avihhgfjynw,11902
+general_manager/permission/mutation_permission.py,sha256=QG-cH1T8anIS4DYRdUHwHOilpop9UzkwMUTiak-sG8s,6871
+general_manager/permission/permission_checks.py,sha256=S0agZzG-tdZWLKWAF_1jdrvsLVbhVk1k1MrBdqNYc8o,7710
+general_manager/permission/permission_data_manager.py,sha256=aqmj5rpslOgCT0GdXnsBtjpFoRerFOa3xG84Jus17b8,3853
+general_manager/permission/utils.py,sha256=Q3E9aq3jUOhBXOdLwWSQsXgNMuV6Bp7R84xM_JLB6Y0,2917
 general_manager/rule/__init__.py,sha256=dFQLJNr0qpkpuzuBbMY-74jz_Y033YyB9X_OfeJYhSs,1026
 general_manager/rule/handler.py,sha256=qSBXmXvl7fRgjxUo4wyUOzdZm14a8Umd2Jec4zPXJQc,16309
 general_manager/rule/rule.py,sha256=41VXFTSWkBEOj8045vZTezm38VEGimjrk22J4YRl144,22691
@@ -71,8 +71,8 @@ general_manager/utils/none_to_zero.py,sha256=Z2KVXBKCz02V2ZBs-7tIs_32n7YDxiXyood
 general_manager/utils/path_mapping.py,sha256=f3sd3OFh9aJgyF-ayqr22mHnCo-uoIXqio5DRQmziGM,9931
 general_manager/utils/public_api.py,sha256=bas4SKchJUg2dI2SLRQwkF_CoXJKKwkzQx_JOjMJ2VY,3272
 general_manager/utils/testing.py,sha256=_V4Y5SXvu-ocoq-AntPFPd140igclUJUT2xVXxhRrSs,14954
-generalmanager-0.20.0.dist-info/licenses/LICENSE,sha256=OcRwUgM4iiESN1oNELgyuwuah39XX-EPZiPDDHndNVI,1070
-generalmanager-0.20.0.dist-info/METADATA,sha256=dpVHVlqT7Mp593hrJnPwNztTzT2E_xf10n-91hrMARE,8266
-generalmanager-0.20.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-generalmanager-0.20.0.dist-info/top_level.txt,sha256=sTDtExP9ga-YP3h3h42yivUY-A2Q23C2nw6LNKOho4I,16
-generalmanager-0.20.0.dist-info/RECORD,,
+generalmanager-0.21.0.dist-info/licenses/LICENSE,sha256=OcRwUgM4iiESN1oNELgyuwuah39XX-EPZiPDDHndNVI,1070
+generalmanager-0.21.0.dist-info/METADATA,sha256=ubnYLTNd5AzlLYju1ykPewMtGIMF-e7lVKl4Hqo2Os8,8266
+generalmanager-0.21.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+generalmanager-0.21.0.dist-info/top_level.txt,sha256=sTDtExP9ga-YP3h3h42yivUY-A2Q23C2nw6LNKOho4I,16
+generalmanager-0.21.0.dist-info/RECORD,,