oldaplib 0.3.28__tar.gz → 0.3.29__tar.gz

{oldaplib-0.3.28 → oldaplib-0.3.29}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: oldaplib
-Version: 0.3.28
+Version: 0.3.29
 Summary: Open Media Access Server Library (Linked Open Data middleware/RESTApi)
 License: GNU Affero General Public License version 3
 Author: Lukas Rosenthaler

{oldaplib-0.3.28 → oldaplib-0.3.29}/oldaplib/src/objectfactory.py

@@ -1,4 +1,7 @@
 import re
+import jwt
+
+from datetime import datetime, timedelta
 from enum import Flag, auto
 from functools import partial
 from typing import Type, Any, Self, cast
@@ -1046,6 +1049,7 @@ class ResourceInstance:
                       limit: int = 100,
                       offset: int = 0,
                       indent: int = 0, indent_inc: int = 4) -> dict[Iri, dict[str, Xsd]]:
+        # TODO: PROBLEM: does not work for properties which use MAX_COUNT > 1 !!!!!!!
         """
         Retrieves all resources matching the specified parameters from a data store using a SPARQL query.
         Depending on the `count_only` flag, it can return either a count of matching resources or detailed
@@ -1161,7 +1165,22 @@ class ResourceInstance:
             return result
 
     @staticmethod
-    def get_media_object_by_id(con: IConnection, mediaObjectId: Xsd_string | str) -> dict[str, Xsd] | None:
+    def get_media_object_by_id(con: IConnection, mediaObjectId: Xsd_string | str) -> dict[str, Xsd]:
+        """
+        Retrieves a media object by its ID from the system. This method queries a SPARQL endpoint
+        to fetch details about the media object and constructs a resulting dictionary with the
+        media object attributes and its associated metadata. Additionally, a signed JWT token
+        is included in the result for security purposes.
+
+        :param con: A connection interface that provides access to the SPARQL endpoint and user context.
+        :type con: IConnection
+        :param mediaObjectId: The ID of the media object to be fetched, represented as an XSD string or a Python string.
+        :type mediaObjectId: Xsd_string | str
+        :return: A dictionary containing key-value pairs of media object attributes and metadata,
+            with an additional JWT token for security. Returns None if the media object is not found.
+        :rtype: dict[str, Xsd] | None
+        :raises OldapErrorNotFound: Raised when the media object with the specified ID is not found.
+        """
         if not isinstance(mediaObjectId, Xsd_string):
             mediaObjectId = Xsd_string(mediaObjectId, validate=True)
         blank = ''
@@ -1169,19 +1188,14 @@ class ResourceInstance:
         sparql = context.sparql_context
 
         sparql += f"""
-        SELECT ?subject ?graph ?path ?permval ?originalName ?serverUrl ?protocol ?originalMimeType
+        SELECT ?subject ?graph ?path ?prop ?val ?permval
         WHERE {{
             VALUES ?inputImageId {{ {mediaObjectId.toRdf} }}
-
             ?subject rdf:type shared:MediaObject .
             GRAPH ?graph {{
-                ?subject shared:imageId ?inputImageId .
-                ?subject shared:originalName ?originalName .
-                ?subject shared:originalMimeType ?originalMimeType .
-                ?subject shared:serverUrl ?serverUrl .
-                ?subject shared:path ?path .
-                ?subject shared:protocol ?protocol .
                 ?subject oldap:grantsPermission ?permset .
+                ?subject shared:imageId ?inputImageId .
+                ?subject ?prop ?val .
             }}
             GRAPH oldap:admin {{
                 {con.userIri.toRdf} oldap:hasPermissions ?permset .
@@ -1196,16 +1210,110 @@ class ResourceInstance:
             print(sparql)
             raise
         res = QueryProcessor(context, jsonres)
-        if len(res) == 0 or len(res) > 1:
+        if len(res) == 0:
             raise OldapErrorNotFound(f'Media object with id {mediaObjectId} not found.')
-        return {'iri': res[0]['subject'],
-                'shared:originalName': res[0]['originalName'],
-                'shared:originalMimeType': res[0]['originalMimeType'],
-                'shared:serverUrl': res[0]['serverUrl'],
-                'shared:protocol': res[0]['protocol'],
-                'graph': res[0]['graph'],
-                'shared:path': res[0]['path'],
-                'oldap:permissionValue': res[0]['permval']}
+        result: dict[str, Xsd] = {
+            'iri': res[0].get('subject'),
+            'graph': res[0].get('graph'),
+            'permval': res[0].get('permval')
+        }
+        for r in res:
+            if str(r['prop']) == 'rdf:type':
+                continue
+            if str(r['prop']) in {'oldap:createdBy', 'oldap:creationDate', 'oldap:lastModifiedBy', 'oldap:lastModificationDate',
+                                  'shared:imageId', 'shared:originalName', 'shared:originalMimeType', 'shared:serverUrl', 'shared:path', 'shared:protocol'}:
+                result[str(r['prop'])] = r['val']
+            else:
+                if result.get(str(r['prop'])) is None:
+                    result[str(r['prop'])] = []
+                result[str(r['prop'])].append(r['val'])
+
+        expiration = datetime.now().astimezone() + timedelta(minutes=2)
+        payload = {
+            'userIri': str(con.userIri),
+            'userid': str(con.userid),
+            'id': str(mediaObjectId),
+            'path': str(result.get('shared:path')),
+            'permval': str(result.get('permval')),
+            "exp": expiration.timestamp(),
+            "iat": int(datetime.now().astimezone().timestamp()),
+            "iss": "http://oldap.org"
+        }
+        token = jwt.encode(
+            payload=payload,
+            key=con.jwtkey,
+            algorithm="HS256")
+        result['token'] = token
+
+        return result
+
+    @staticmethod
+    def get_media_object_by_iri(con: IConnection, mediaObjectIri: Iri | str) -> dict[str, Xsd] | None:
+        if not isinstance(mediaObjectIri, Iri):
+            mediaObjectIri = Iri(mediaObjectIri, validate=True)
+        blank = ''
+        context = Context(name=con.context_name)
+        sparql = context.sparql_context
+
+        sparql += f"""
+        SELECT ?graph ?prop ?val ?permval
+        WHERE {{
+            {mediaObjectIri.toRdf} rdf:type shared:MediaObject .
+            GRAPH ?graph {{
+                {mediaObjectIri.toRdf} oldap:grantsPermission ?permset .
+                {mediaObjectIri.toRdf} shared:imageId ?inputImageId .
+                {mediaObjectIri.toRdf} ?prop ?val .
+            }}
+            GRAPH oldap:admin {{
+                {con.userIri.toRdf} oldap:hasPermissions ?permset .
+                ?permset oldap:givesPermission ?DataPermission .
+                ?DataPermission oldap:permissionValue ?permval .
+            }}
+        }}
+        """
+        print(sparql)
+        try:
+            jsonres = con.query(sparql)
+        except OldapError:
+            print(sparql)
+            raise
+        res = QueryProcessor(context, jsonres)
+        if len(res) == 0:
+            raise OldapErrorNotFound(f'Media object with iri {mediaObjectIri} not found.')
+        result: dict[str, Xsd] = {
+            'iri': mediaObjectIri,
+            'graph': res[0].get('graph'),
+            'permval': res[0].get('permval')
+        }
+        for r in res:
+            if str(r['prop']) == 'rdf:type':
+                continue
+            if str(r['prop']) in {'oldap:createdBy', 'oldap:creationDate', 'oldap:lastModifiedBy', 'oldap:lastModificationDate',
+                                  'shared:imageId', 'shared:originalName', 'shared:originalMimeType', 'shared:serverUrl', 'shared:path', 'shared:protocol'}:
+                result[str(r['prop'])] = r['val']
+            else:
+                if result.get(str(r['prop'])) is None:
+                    result[str(r['prop'])] = []
+                result[str(r['prop'])].append(r['val'])
+
+        expiration = datetime.now().astimezone() + timedelta(minutes=2)
+        payload = {
+            'userIri': str(con.userIri),
+            'userid': str(con.userid),
+            'id': str(result.get('shared:imageId')),
+            'path': str(result['shared:path']),
+            'permval': str(result['permval']),
+            "exp": expiration.timestamp(),
+            "iat": int(datetime.now().astimezone().timestamp()),
+            "iss": "http://oldap.org"
+        }
+        token = jwt.encode(
+            payload=payload,
+            key=con.jwtkey,
+            algorithm="HS256")
+        result['token'] = token
+
+        return result
 
 
     def toJsonObject(self) -> dict[str, list[str] | str]:

{oldaplib-0.3.28 → oldaplib-0.3.29}/oldaplib/src/oldaplist_helpers.py

@@ -150,7 +150,7 @@ def dump_list_to(con: IConnection,
                     make_dict(node, listdict[str(listnode.oldapListNodeId)]['nodes'])
 
     #
-    # We need to get the OldapList IRI for aksing the cache...
+    # We need to get the OldapList IRI for asking the cache...
     #
     if not isinstance(project, Project):
         project = Project.read(con, project)

oldaplib-0.3.29/oldaplib/src/version.py

@@ -0,0 +1 @@
+__version__ = "0.3.29"

{oldaplib-0.3.28 → oldaplib-0.3.29}/oldaplib/test/test_objectfactory.py

@@ -5,6 +5,7 @@ import unittest
 from pathlib import Path
 from pprint import pprint
 from time import sleep
+import jwt
 
 from oldaplib.src.cachesingleton import CacheSingletonRedis
 from oldaplib.src.datamodel import DataModel
@@ -702,16 +703,71 @@ class TestObjectFactory(unittest.TestCase):
         self.assertEqual(len(res), 8)
 
     #@unittest.skip('Work in progress')
-    def test_read_media_object(self):
-        res = ResourceInstance.get_media_object_by_id(con=self._connection,mediaObjectId='x_34db.tif')
+    def test_read_media_object_by_id_A(self):
+        res = ResourceInstance.get_media_object_by_id(con=self._connection, mediaObjectId='x_34db.tif')
         self.assertEqual(res['iri'], Iri("urn:uuid:1b8e3f42-6d7a-4c9b-a3f8-93c2e5d7b901"))
+        self.assertEqual(res['permval'], Xsd_integer(2))
+        self.assertEqual(res['shared:imageId'], Xsd_string('x_34db.tif'))
         self.assertEqual(res['shared:originalName'], Xsd_string("testfile.tif"))
         self.assertEqual(res['shared:originalMimeType'], Xsd_string("image/tiff"))
         self.assertEqual(res['shared:serverUrl'], Xsd_string("https://iiif.oldap.org"))
         self.assertEqual(res['shared:protocol'], Xsd_string("iiif"))
         self.assertEqual(res['graph'], Xsd_QName("test:data"))
         self.assertEqual(res['shared:path'], Xsd_string("test/subtest"))
-        self.assertEqual(res['oldap:permissionValue'], Xsd_integer(2))
+        tinfo = jwt.decode(jwt=res['token'], key=self._connection.jwtkey, algorithms="HS256")
+        self.assertEqual(tinfo['id'], 'x_34db.tif')
+        self.assertEqual(tinfo['path'], 'test/subtest')
+        self.assertEqual(tinfo['permval'], '2')
+
+    def test_read_media_object_by_id_B(self):
+        res = ResourceInstance.get_media_object_by_id(con=self._connection, mediaObjectId='x_42db.jpg')
+        self.assertEqual(res['iri'], Iri("urn:uuid:1b8e3f42-6d7a-4c9b-a3f8-93c2e5d7b999"))
+        self.assertEqual(res['permval'], Xsd_integer(2))
+        self.assertEqual(res['shared:imageId'], Xsd_string('x_42db.jpg'))
+        self.assertEqual(res['shared:originalName'], Xsd_string("testfile.jpg"))
+        self.assertEqual(res['shared:originalMimeType'], Xsd_string("image/jpeg"))
+        self.assertEqual(res['shared:serverUrl'], Xsd_string("https://iiif.oldap.org"))
+        self.assertEqual(res['shared:protocol'], Xsd_string("iiif"))
+        self.assertEqual(res['graph'], Xsd_QName("test:data"))
+        self.assertEqual(res['test:caption'], [Xsd_string("This is a non-real, non-existing image")])
+        self.assertEqual(res['shared:path'], Xsd_string("test/subtest"))
+        tinfo = jwt.decode(jwt=res['token'], key=self._connection.jwtkey, algorithms="HS256")
+        self.assertEqual(tinfo['id'], 'x_42db.jpg')
+        self.assertEqual(tinfo['path'], 'test/subtest')
+        self.assertEqual(tinfo['permval'], '2')
+
+    def test_read_media_object_by_iri_A(self):
+        res = ResourceInstance.get_media_object_by_iri(con=self._connection, mediaObjectIri='urn:uuid:1b8e3f42-6d7a-4c9b-a3f8-93c2e5d7b901')
+        self.assertEqual(res['iri'], Iri("urn:uuid:1b8e3f42-6d7a-4c9b-a3f8-93c2e5d7b901"))
+        self.assertEqual(res['permval'], Xsd_integer(2))
+        self.assertEqual(res['shared:imageId'], Xsd_string('x_34db.tif'))
+        self.assertEqual(res['shared:originalName'], Xsd_string("testfile.tif"))
+        self.assertEqual(res['shared:originalMimeType'], Xsd_string("image/tiff"))
+        self.assertEqual(res['shared:serverUrl'], Xsd_string("https://iiif.oldap.org"))
+        self.assertEqual(res['shared:protocol'], Xsd_string("iiif"))
+        self.assertEqual(res['graph'], Xsd_QName("test:data"))
+        self.assertEqual(res['shared:path'], Xsd_string("test/subtest"))
+        tinfo = jwt.decode(jwt=res['token'], key=self._connection.jwtkey, algorithms="HS256")
+        self.assertEqual(tinfo['id'], 'x_34db.tif')
+        self.assertEqual(tinfo['path'], 'test/subtest')
+        self.assertEqual(tinfo['permval'], '2')
+
+    def test_read_media_object_by_iri_B(self):
+        res = ResourceInstance.get_media_object_by_iri(con=self._connection, mediaObjectIri='urn:uuid:1b8e3f42-6d7a-4c9b-a3f8-93c2e5d7b999')
+        self.assertEqual(res['iri'], Iri("urn:uuid:1b8e3f42-6d7a-4c9b-a3f8-93c2e5d7b999"))
+        self.assertEqual(res['permval'], Xsd_integer(2))
+        self.assertEqual(res['shared:imageId'], Xsd_string('x_42db.jpg'))
+        self.assertEqual(res['shared:originalName'], Xsd_string("testfile.jpg"))
+        self.assertEqual(res['shared:originalMimeType'], Xsd_string("image/jpeg"))
+        self.assertEqual(res['shared:serverUrl'], Xsd_string("https://iiif.oldap.org"))
+        self.assertEqual(res['shared:protocol'], Xsd_string("iiif"))
+        self.assertEqual(res['graph'], Xsd_QName("test:data"))
+        self.assertEqual(res['test:caption'], [Xsd_string("This is a non-real, non-existing image")])
+        self.assertEqual(res['shared:path'], Xsd_string("test/subtest"))
+        tinfo = jwt.decode(jwt=res['token'], key=self._connection.jwtkey, algorithms="HS256")
+        self.assertEqual(tinfo['id'], 'x_42db.jpg')
+        self.assertEqual(tinfo['path'], 'test/subtest')
+        self.assertEqual(tinfo['permval'], '2')
 
     def test_create_media_object(self):
         dm = DataModel.read(con=self._connection, project='test')

{oldaplib-0.3.28 → oldaplib-0.3.29}/oldaplib/testdata/instances_test.trig

@@ -132,6 +132,20 @@ test:data {
     shared:protocol 'iiif';
     shared:path 'test/subtest' .
 
+  <urn:uuid:1b8e3f42-6d7a-4c9b-a3f8-93c2e5d7b999> a shared:MediaObject;
+    :createdBy <https://orcid.org/0000-0003-1681-4036>;
+    :creationDate "2025-11-13T16:43:28.861171+01:00"^^xsd:dateTimeStamp;
+    :lastModifiedBy <https://orcid.org/0000-0003-1681-4036>;
+    :lastModificationDate "2025-11-13T16:43:28.861171+01:00"^^xsd:dateTimeStamp;
+    :grantsPermission :GenericView;
+    shared:originalName 'testfile.jpg';
+    shared:originalMimeType 'image/jpeg';
+    shared:serverUrl 'https://iiif.oldap.org';
+    shared:imageId 'x_42db.jpg';
+    shared:protocol 'iiif';
+    shared:path 'test/subtest' ;
+    test:caption 'This is a non-real, non-existing image' .
+
 
 
 }

{oldaplib-0.3.28 → oldaplib-0.3.29}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "oldaplib"
-version = "0.3.28"
+version = "0.3.29"
 description = "Open Media Access Server Library (Linked Open Data middleware/RESTApi)"
 authors = ["Lukas Rosenthaler <lukas.rosenthaler@unibas.ch>"]
 license = "GNU Affero General Public License version 3"

oldaplib-0.3.28/oldaplib/src/version.py

@@ -1 +0,0 @@
-__version__ = "0.3.28"