oldaplib 0.3.30__py3-none-any.whl → 0.4.0__py3-none-any.whl

oldaplib/src/userdataclass.py

@@ -1,9 +1,11 @@
+import textwrap
 from datetime import datetime
-from typing import Self, Set, Iterable
+from typing import Self, Dict
 
 from oldaplib.src.enums.adminpermissions import AdminPermission
 from oldaplib.src.helpers.context import Context
 from oldaplib.src.helpers.irincname import IriOrNCName
+from oldaplib.src.helpers.observable_dict import ObservableDict
 from oldaplib.src.helpers.oldaperror import OldapErrorNotFound
 from oldaplib.src.helpers.query_processor import QueryProcessor
 from oldaplib.src.helpers.serializeableset import SerializeableSet
@@ -13,39 +15,45 @@ from oldaplib.src.xsd.iri import Iri
 from oldaplib.src.xsd.xsd_boolean import Xsd_boolean
 from oldaplib.src.xsd.xsd_datetime import Xsd_dateTime
 from oldaplib.src.xsd.xsd_ncname import Xsd_NCName
+from oldaplib.src.xsd.xsd_qname import Xsd_QName
 from oldaplib.src.xsd.xsd_string import Xsd_string
 
 
-
 @serializer
 class UserData:
     """
-    Represents a user entity and provides management and query functionalities for a user
-    in a specific project context.
+    Represents user data, including personal information, roles, and project involvement,
+    while adhering to a structured and serializable format.
 
-    This class is designed to encapsulate properties and behaviors associated with a user.
-    It provides attributes for managing user metadata, permissions, and project associations.
-    Additionally, it includes utility methods for constructing SPARQL queries and processing
-    query results to instantiate user data instances.
+    The class serves as a model for user-related information in a SPARQL-based system,
+    providing methods for querying, constructing, and managing user-related data.
 
-    :ivar userIri: The IRI uniquely identifying the user.
-    :ivar userId: The NCName uniquely identifying the user.
-    :ivar familyName: The family name of the user.
-    :ivar givenName: The given name of the user.
-    :ivar email: The email address of the user.
-    :ivar credentials: The hashed credentials or identifier for user authentication.
-    :ivar isActive: Indicates whether the user's account is active.
-    :ivar inProject: A representation of the user's association within projects.
-    :ivar hasPermissions: The set of permissions associated with the user.
+    :ivar creator: The IRI of the user who created this entity.
+    :type creator: Iri | None
+    :ivar created: The datetime when this entity was created.
+    :type created: Xsd_dateTime | datetime | None
+    :ivar contributor: The IRI of the user who contributed to this entity.
+    :type contributor: Iri | None
+    :ivar modified: The datetime when this entity was last modified.
+    :type modified: Xsd_dateTime | datetime | None
+    :ivar userIri: The unique IRI identifying the user.
     :type userIri: Iri
+    :ivar userId: The unique non-colonized identifier (NCName) for the user.
     :type userId: Xsd_NCName
+    :ivar familyName: The family name (surname) of the user.
     :type familyName: Xsd_string
+    :ivar givenName: The given name (first name) of the user.
     :type givenName: Xsd_string
+    :ivar email: The user's email address.
     :type email: Xsd_string
-    :type credentials: Xsd_string
+    :ivar credentials: The credentials or authentication key for the user, if provided.
+    :type credentials: Xsd_string | None
+    :ivar isActive: A boolean indicating whether the user is currently active.
     :type isActive: Xsd_boolean
+    :ivar inProject: The project object or relation associated with the user.
     :type inProject: InProjectClass | None
-    :type hasPermissions: SerializeableSet[Iri] | None
+    :ivar hasRole: A serializable set containing the roles or permissions assigned to the user.
+    :type hasRole: SerializeableSet[Iri] | None
     """
     _creator: Iri | None
     _created: Xsd_dateTime | datetime | None
@@ -58,7 +66,8 @@ class UserData:
     _email: Xsd_string
     _credentials: Xsd_string
     _isActive: Xsd_boolean
-    _inProject: InProjectClass
+    _inProject: InProjectClass | None
+    _hasRole: ObservableDict | None
 
     def __init__(self, *,
                  creator: Iri | None = None,
@@ -73,7 +82,7 @@ class UserData:
                  credentials: Xsd_string | None = None,
                  isActive: Xsd_boolean,
                  inProject: InProjectClass | None = None,
-                 hasPermissions: SerializeableSet[Iri] | set[Iri] | None = None,
+                 hasRole: ObservableDict | Dict[Xsd_QName, Xsd_QName | None] | Dict[str, str] | None = None,
                  validate: bool = False):
         self._creator = creator
         self._created = created
@@ -87,7 +96,13 @@ class UserData:
         self._credentials = credentials
         self._isActive = isActive
         self._inProject = inProject or InProjectClass()
-        self._hasPermissions = hasPermissions if isinstance(hasPermissions, SerializeableSet) else SerializeableSet(hasPermissions)
+        if isinstance(hasRole, ObservableDict):
+            self._hasRole = hasRole
+        elif isinstance(hasRole, dict):
+            tmp = {Xsd_QName(key, validate=validate): Xsd_QName(val, validate=validate) if val else None for key, val in hasRole.items()}
+            self._hasRole = ObservableDict(tmp)
+        else:
+            self._hasRole = None
 
     def __str__(self) -> str:
         res = f'userIri: {self._userIri}\n'
@@ -98,7 +113,7 @@ class UserData:
         res += f', credentials: {self._credentials}\n'
         res += f', isActive: {self._isActive}\n'
         res += f', inProject: {self._inProject}\n'
-        res += f', hasPermissions: {self._hasPermissions}\n'
+        res += f', hasRole: {self._hasRole}\n'
         return res
 
     @property
@@ -150,8 +165,8 @@ class UserData:
         return self._inProject
 
     @property
-    def hasPermissions(self) -> SerializeableSet[Iri] | None:
-        return self._hasPermissions
+    def hasRole(self) -> Dict[Xsd_QName, Xsd_QName | None] | None:
+        return self._hasRole
 
     @staticmethod
     def sparql_query(context: Context, userId: IriOrNCName, validate: bool = False) -> str:
@@ -181,8 +196,8 @@ class UserData:
         user_id, user_iri = userId.value()
         sparql = context.sparql_context
         if user_id is not None:
-            sparql += f"""
-            SELECT ?user ?prop ?val ?proj ?rval
+            sparql += textwrap.dedent(f"""
+            SELECT ?user ?prop ?val ?proj ?rval ?role ?defdp
             FROM oldap:admin
             WHERE {{
                 {{
@@ -193,12 +208,16 @@ class UserData:
                     ?user a oldap:User .
                     ?user oldap:userId {user_id.toRdf} .
                     <<?user oldap:inProject ?proj>> oldap:hasAdminPermission ?rval
+                }} UNION {{
+                    ?user a oldap:User .
+                    ?user oldap:userId {user_id.toRdf} .
+                    <<?user oldap:hasRole ?role>> oldap:hasDefaultDataPermission ?defdp
                 }}
             }}
-            """
+            """)
         elif user_iri is not None:
-            sparql += f"""
-            SELECT ?user ?prop ?val ?proj ?rval
+            sparql += textwrap.dedent(f"""
+            SELECT ?user ?prop ?val ?proj ?rval ?role ?defdp
             FROM oldap:admin
             WHERE {{
                 BIND({user_iri.toRdf} as ?user)
@@ -208,9 +227,12 @@ class UserData:
                 }} UNION {{
                     ?user a oldap:User .
                     <<?user oldap:inProject ?proj>> oldap:hasAdminPermission ?rval
+                }} UNION {{
+                    ?user a oldap:User .
+                    <<?user oldap:hasRole ?role>> oldap:hasDefaultDataPermission ?defdp
                 }}
             }}
-            """
+            """)
 
         return sparql
 
@@ -245,7 +267,7 @@ class UserData:
         credentials: Xsd_string | None = None
         isActive: Xsd_boolean | None = None
         inProjectDict: dict[Iri | str, set[AdminPermission]] | None = None
-        hasPermissions: set[Iri] | None = None
+        hasRoleDict: ObservableDict | None = None
         for r in queryresult:
             match str(r.get('prop')):
                 case 'dcterms:creator':
@@ -274,10 +296,11 @@ class UserData:
                         inProjectDict = {r['val']: set()}
                     else:
                         inProjectDict[r['val']] = set()
-                case 'oldap:hasPermissions':
-                    if not hasPermissions:
-                        hasPermissions = set()
-                    hasPermissions.add(r['val'])
+                case 'oldap:hasRole':
+                    if not hasRoleDict:
+                        hasRoleDict = ObservableDict({r['val']: None})
+                    else:
+                        hasRoleDict[r['val']] = None
                 case _:
                     if r.get('proj') and r.get('rval'):
                         if not inProjectDict:
@@ -285,6 +308,12 @@ class UserData:
                         if inProjectDict.get(r['proj']) is None:
                             inProjectDict[r['proj']] = set()
                         inProjectDict[r['proj']].add(AdminPermission.from_string(str(r['rval'])))
+                    if r.get('role') and r.get('defdp'):
+                        if not hasRoleDict:
+                            hasRoleDict = {r['role']: None}
+                        if hasRoleDict.get(r['role']) is None:
+                            hasRoleDict[r['role']] = None
+                        hasRoleDict[r['role']] = r['defdp']
         inProject = InProjectClass(inProjectDict) if inProjectDict else InProjectClass()
         return cls(created=created,
                    creator=creator,
@@ -298,7 +327,7 @@ class UserData:
                    credentials=credentials,
                    isActive=isActive,
                    inProject=inProject,
-                   hasPermissions=hasPermissions,
+                   hasRole=hasRoleDict,
                    validate=False)
 
     def _as_dict(self) -> dict:
@@ -309,7 +338,7 @@ class UserData:
                 'givenName': self._givenName,
                 'email': self._email,
                 'isActive': self._isActive,
-                'hasPermissions': self._hasPermissions,
+                'hasRole': self._hasRole,
                 'inProject': self._inProject
         }
 

oldaplib/src/version.py

@@ -1 +1 @@
-__version__ = "0.3.30"
+__version__ = "0.4.0"

oldaplib/test/test_datamodel.py

@@ -368,6 +368,8 @@ class TestDataModel(unittest.TestCase):
     def test_datamodel_read(self):
         model = DataModel.read(self._connection, self._sysproject, ignore_cache=True)
         self.assertEqual(set(model.get_propclasses()), {
+            Xsd_QName("oldap:hasDataPermission"),
+            Xsd_QName("oldap:hasDefaultDataPermission"),
             Xsd_QName("oldap:hasAdminPermission"),
             Xsd_QName("oldap:statementProperty"),
             Xsd_QName("oldap:namespaceIri"),
@@ -379,10 +381,11 @@ class TestDataModel(unittest.TestCase):
             Xsd_QName("oldap:OldapListNode"),
             Xsd_QName("oldap:AdminPermission"),
             Xsd_QName("oldap:DataPermission"),
-            Xsd_QName("oldap:PermissionSet"),
+            Xsd_QName("oldap:Role"),
             Xsd_QName("oldap:Thing"),
             Xsd_QName("oldap:ExternalOntology"),
-            Xsd_QName("oldap:inProjectStatement")
+            Xsd_QName("oldap:inProjectStatement"),
+            Xsd_QName("oldap:hasRoleStatement")
         })
 
     def test_datamodel_read_shared(self):

oldaplib/test/test_in_project.py

@@ -11,8 +11,9 @@ from oldaplib.src.xsd.xsd_string import Xsd_string
 
 
 class TestInproject(unittest.TestCase):
+
     def test_creation(self):
-        ip = InProjectClass({'test:proj': {AdminPermission.ADMIN_PERMISSION_SETS, 'oldap:ADMIN_RESOURCES'},
+        ip = InProjectClass({'test:proj': {AdminPermission.ADMIN_ROLES, 'oldap:ADMIN_RESOURCES'},
                              'https://gaga.com/test': {'ADMIN_MODEL'},
                              Iri('gaga:gugus'): set()})
         self.assertEqual(len(ip), 3)
@@ -30,10 +31,10 @@ class TestInproject(unittest.TestCase):
             ip = InProjectClass({'test:proj': {'MODEL_T'}})
 
     def test_get_item(self):
-        ip = InProjectClass({'test:proj': {AdminPermission.ADMIN_PERMISSION_SETS, 'oldap:ADMIN_RESOURCES'},
+        ip = InProjectClass({'test:proj': {AdminPermission.ADMIN_ROLES, 'oldap:ADMIN_RESOURCES'},
                              'https://gaga.com/test': {'ADMIN_MODEL'},
                              Iri('gaga:gugus'): set()})
-        self.assertEqual(ip['test:proj'], {AdminPermission.ADMIN_PERMISSION_SETS, AdminPermission.ADMIN_RESOURCES})
+        self.assertEqual(ip['test:proj'], {AdminPermission.ADMIN_ROLES, AdminPermission.ADMIN_RESOURCES})
         self.assertEqual(ip['https://gaga.com/test'], {AdminPermission.ADMIN_MODEL})
         self.assertEqual(ip[Iri('gaga:gugus')], set())
 
@@ -45,13 +46,13 @@ class TestInproject(unittest.TestCase):
             tmp = ip[Xsd_string('test:proj')]
 
     def test_set_item(self):
-        ip = InProjectClass({'test:proj': {AdminPermission.ADMIN_PERMISSION_SETS, 'oldap:ADMIN_RESOURCES'},
+        ip = InProjectClass({'test:proj': {AdminPermission.ADMIN_ROLES, 'oldap:ADMIN_RESOURCES'},
                              'https://gaga.com/test': {'ADMIN_MODEL'},
                              Xsd_QName('gaga:gugus'): set()})
         ip['test:proj'] = {AdminPermission.ADMIN_OLDAP}
         self.assertEqual(ip['test:proj'], {AdminPermission.ADMIN_OLDAP})
-        ip['https://gaga.com/test'] = {AdminPermission.ADMIN_PERMISSION_SETS, 'oldap:ADMIN_RESOURCES'}
-        self.assertEqual(ip['https://gaga.com/test'], {AdminPermission.ADMIN_PERMISSION_SETS, AdminPermission.ADMIN_RESOURCES})
+        ip['https://gaga.com/test'] = {AdminPermission.ADMIN_ROLES, 'oldap:ADMIN_RESOURCES'}
+        self.assertEqual(ip['https://gaga.com/test'], {AdminPermission.ADMIN_ROLES, AdminPermission.ADMIN_RESOURCES})
         ip[Xsd_QName('gaga:gugus')] = {'ADMIN_MODEL'}
         self.assertEqual(ip[Xsd_QName('gaga:gugus')], {AdminPermission.ADMIN_MODEL})
 
@@ -61,7 +62,7 @@ class TestInproject(unittest.TestCase):
             ip[Xsd_QName('XYZ')] = {'ADMIN_MODEL'}
 
     def test_del_item(self):
-        ip = InProjectClass({'test:proj': {AdminPermission.ADMIN_PERMISSION_SETS, 'oldap:ADMIN_RESOURCES'},
+        ip = InProjectClass({'test:proj': {AdminPermission.ADMIN_ROLES, 'oldap:ADMIN_RESOURCES'},
                              'https://gaga.com/test': {'ADMIN_MODEL'},
                              Xsd_QName('gaga:gugus'): set()})
         del ip['test:proj']
@@ -72,7 +73,7 @@ class TestInproject(unittest.TestCase):
             del ip[Xsd_QName('gaga:blabla')]
 
     def test_str(self):
-        ip = InProjectClass({'test:proj': {AdminPermission.ADMIN_PERMISSION_SETS, 'oldap:ADMIN_RESOURCES'},
+        ip = InProjectClass({'test:proj': {AdminPermission.ADMIN_ROLES, 'oldap:ADMIN_RESOURCES'},
                              'https://gaga.com/test': {'ADMIN_MODEL'},
                              Xsd_QName('gaga:gugus'): set()})
         projs = str(ip).strip().split('\n')
@@ -81,7 +82,7 @@ class TestInproject(unittest.TestCase):
             proj, permset = projstr.split(' : ')
             match proj:
                 case 'test:proj':
-                    self.assertEqual(permset, "['oldap:ADMIN_PERMISSION_SETS', 'oldap:ADMIN_RESOURCES']")
+                    self.assertEqual(permset, "['oldap:ADMIN_RESOURCES', 'oldap:ADMIN_ROLES']")
                 case 'https://gaga.com/test':
                     self.assertEqual(permset, "['oldap:ADMIN_MODEL']")
                 case 'gaga:gugus':
@@ -90,13 +91,13 @@ class TestInproject(unittest.TestCase):
                     raise Exception("Unexpected project")
 
     def test_bool(self):
-        ip = InProjectClass({'test:proj': {AdminPermission.ADMIN_PERMISSION_SETS, 'oldap:ADMIN_RESOURCES'},
+        ip = InProjectClass({'test:proj': {AdminPermission.ADMIN_ROLES, 'oldap:ADMIN_RESOURCES'},
                              'https://gaga.com/test': {'ADMIN_MODEL'},
                              Xsd_QName('gaga:gugus'): set()})
         self.assertTrue(bool(ip))
 
     def test_serialization(self):
-        val = InProjectClass({'test:proj': {AdminPermission.ADMIN_PERMISSION_SETS, 'oldap:ADMIN_RESOURCES'},
+        val = InProjectClass({'test:proj': {AdminPermission.ADMIN_ROLES, 'oldap:ADMIN_RESOURCES'},
                               'https://gaga.com/test': {'ADMIN_MODEL'},
                               Xsd_QName('gaga:gugus'): set()})
         jsonstr = json.dumps(val, default=serializer.encoder_default)
@@ -104,43 +105,43 @@ class TestInproject(unittest.TestCase):
         self.assertEqual(val, val2)
 
     def test_copy_eq_ne(self):
-        val = InProjectClass({'test:proj': {AdminPermission.ADMIN_PERMISSION_SETS, 'oldap:ADMIN_RESOURCES'},
+        val = InProjectClass({'test:proj': {AdminPermission.ADMIN_ROLES, 'oldap:ADMIN_RESOURCES'},
                               'https://gaga.com/test': {'ADMIN_MODEL'},
                               Xsd_QName('gaga:gugus'): set()})
-        val2 = InProjectClass({'test:proj': {AdminPermission.ADMIN_PERMISSION_SETS, 'oldap:ADMIN_RESOURCES'},
+        val2 = InProjectClass({'test:proj': {AdminPermission.ADMIN_ROLES, 'oldap:ADMIN_RESOURCES'},
                               'https://gaga.com/test': {'ADMIN_MODEL'},
                               Xsd_QName('gaga:gugus'): set()})
         self.assertTrue(val == val2)
         self.assertFalse(val != val2)
 
-        val = InProjectClass({'test:proj': {AdminPermission.ADMIN_PERMISSION_SETS, 'oldap:ADMIN_RESOURCES'},
+        val = InProjectClass({'test:proj': {AdminPermission.ADMIN_ROLES, 'oldap:ADMIN_RESOURCES'},
                               'https://gaga.com/test': {'ADMIN_MODEL'},
                               Xsd_QName('gaga:gugus'): set()})
-        val2 = InProjectClass({'test:proj': {AdminPermission.ADMIN_PERMISSION_SETS, 'oldap:ADMIN_RESOURCES'},
+        val2 = InProjectClass({'test:proj': {AdminPermission.ADMIN_ROLES, 'oldap:ADMIN_RESOURCES'},
                               'https://gaga.com/test': {'ADMIN_MODEL'},
                               Xsd_QName('gaga:gaga'): set()})
         self.assertFalse(val == val2)
         self.assertTrue(val != val2)
 
-        val = InProjectClass({'test:proj': {AdminPermission.ADMIN_PERMISSION_SETS, 'oldap:ADMIN_RESOURCES'},
+        val = InProjectClass({'test:proj': {AdminPermission.ADMIN_ROLES, 'oldap:ADMIN_RESOURCES'},
                               'https://gaga.com/test': {'ADMIN_MODEL'},
                               Xsd_QName('gaga:gugus'): {AdminPermission.ADMIN_RESOURCES}})
-        val2 = InProjectClass({'test:proj': {AdminPermission.ADMIN_PERMISSION_SETS, 'oldap:ADMIN_RESOURCES'},
+        val2 = InProjectClass({'test:proj': {AdminPermission.ADMIN_ROLES, 'oldap:ADMIN_RESOURCES'},
                               'https://gaga.com/test': {'ADMIN_MODEL'},
-                              Xsd_QName('gaga:gugus'): {AdminPermission.ADMIN_RESOURCES, AdminPermission.ADMIN_PERMISSION_SETS}})
+                              Xsd_QName('gaga:gugus'): {AdminPermission.ADMIN_RESOURCES, AdminPermission.ADMIN_ROLES}})
         self.assertFalse(val == val2)
         self.assertTrue(val != val2)
 
 
     def test_items(self):
-        ip = InProjectClass({'test:proj': {AdminPermission.ADMIN_PERMISSION_SETS, 'oldap:ADMIN_RESOURCES'},
+        ip = InProjectClass({'test:proj': {AdminPermission.ADMIN_ROLES, 'oldap:ADMIN_RESOURCES'},
                              'https://gaga.com/test': {'ADMIN_MODEL'},
                              Xsd_QName('gaga:gugus'): set()})
         for proj, perms in ip.items():
             self.assertTrue(proj in ['test:proj', 'https://gaga.com/test', Iri('gaga:gugus')])
 
     def test_keys(self):
-        ip = InProjectClass({'test:proj': {AdminPermission.ADMIN_PERMISSION_SETS, 'oldap:ADMIN_RESOURCES'},
+        ip = InProjectClass({'test:proj': {AdminPermission.ADMIN_ROLES, 'oldap:ADMIN_RESOURCES'},
                              'https://gaga.com/test': {'ADMIN_MODEL'},
                              Iri('gaga:gugus'): set()})
         keys = set(ip.keys())