sets support

invenio_oaiserver/config.py

@@ -2,7 +2,7 @@
 #
 # This file is part of Invenio.
 # Copyright (C) 2015-2018 CERN.
-# Copyright (C) 2021 Graz University of Technology.
+# Copyright (C) 2022 Graz University of Technology.
 #
 # Invenio is free software; you can redistribute it and/or modify it
 # under the terms of the MIT License; see LICENSE file for more details.
@@ -124,9 +124,11 @@
 OAISERVER_CREATED_KEY = "_created"
 """Record created key."""
 
-OAISERVER_RECORD_SETS_FETCHER = 'invenio_oaiserver.utils:record_sets_fetcher'
+OAISERVER_RECORD_SETS_FETCHER = 'invenio_oaiserver.percolator:find_sets_for_record'
 """Record's OAI sets function."""
 
+OAISERVER_SET_RECORDS_QUERY_FETCHER = 'invenio_oaiserver.fetchers:set_records_query_fetcher'
+
 OAISERVER_RECORD_CLS = 'invenio_records.api:Record'
 """Record retrieval class."""
 

invenio_oaiserver/errors.py

@@ -2,6 +2,7 @@
 #
 # This file is part of Invenio.
 # Copyright (C) 2016-2018 CERN.
+# Copyright (C) 2022 Graz University of Technology.
 #
 # Invenio is free software; you can redistribute it and/or modify it
 # under the terms of the MIT License; see LICENSE file for more details.
@@ -20,3 +21,11 @@ class OAISetSpecUpdateError(Exception):
 
     The correct way is to delete the set and create a new one.
     """
+
+
+class OAINoRecordsMatchError(Exception):
+    """No records match the query.
+
+    The combination of the values of the from, until, and set arguments
+    results in an empty list.
+    """

invenio_oaiserver/ext.py

@@ -2,7 +2,7 @@
 #
 # This file is part of Invenio.
 # Copyright (C) 2015-2018 CERN.
-# Copyright (C) 2021 Graz University of Technology.
+# Copyright (C) 2021-2022 Graz University of Technology.
 #
 # Invenio is free software; you can redistribute it and/or modify it
 # under the terms of the MIT License; see LICENSE file for more details.
@@ -56,6 +56,11 @@ def record_fetcher(self):
         """Get the record fetcher class for record serialization."""
         return obj_or_import_string(self.app.config['OAISERVER_GETRECORD_FETCHER'])
 
+    @property
+    def set_records_query_fetcher(self):
+        """Get query to retrieve records based on set."""
+        return obj_or_import_string(self.app.config['OAISERVER_SET_RECORDS_QUERY_FETCHER'])
+
     @property
     def last_update_key(self):
         """Get record update key."""
@@ -82,14 +87,6 @@ def sets(self, values):
 
     def register_signals(self):
         """Register signals."""
-        from .receivers import OAIServerUpdater
-
-        # Register Record signals to update OAI informations
-        self.update_function = OAIServerUpdater()
-        records_signals.before_record_insert.connect(self.update_function,
-                                                     weak=False)
-        records_signals.before_record_update.connect(self.update_function,
-                                                     weak=False)
         if self.app.config['OAISERVER_REGISTER_SET_SIGNALS']:
             self.register_signals_oaiset()
 
@@ -105,11 +102,6 @@ def register_signals_oaiset(self):
     def unregister_signals(self):
         """Unregister signals."""
         # Unregister Record signals
-        if hasattr(self, 'update_function'):
-            records_signals.before_record_insert.disconnect(
-                self.update_function)
-            records_signals.before_record_update.disconnect(
-                self.update_function)
         self.unregister_signals_oaiset()
 
     def unregister_signals_oaiset(self):
@@ -168,7 +160,7 @@ def init_config(self, app):
             import warnings
 
             app.config['OAISERVER_ID_PREFIX'] = \
-                'oai:{0}:recid/'.format(socket.gethostname())
+                'oai:{0}:'.format(socket.gethostname())
             warnings.warn(
                 """Please specify the OAISERVER_ID_PREFIX configuration."""
                 """default value is: {0}""".format(

invenio_oaiserver/fetchers.py

@@ -11,10 +11,13 @@
 
 from __future__ import absolute_import, print_function
 
+from elasticsearch_dsl.query import Q
 from invenio_pidstore.errors import PersistentIdentifierError
 from invenio_pidstore.fetchers import FetchedPID
 
+from .models import OAISet
 from .provider import OAIIDProvider
+from .query import query_string_parser
 
 
 def oaiid_fetcher(record_uuid, data):
@@ -33,3 +36,15 @@ def oaiid_fetcher(record_uuid, data):
         pid_type=OAIIDProvider.pid_type,
         pid_value=str(pid_value),
     )
+
+
+def set_records_query_fetcher(setSpec):
+    """Fetch query to retrieve records based on provided set spec."""
+    set = OAISet.query.filter(OAISet.spec == setSpec).first()
+    if set is None:
+        # raise error that no matches can be found ?
+        query = Q('match_none')
+    else:
+        query = Q(query_string_parser(set.search_pattern))
+
+    return query

invenio_oaiserver/models.py

@@ -2,14 +2,13 @@
 #
 # This file is part of Invenio.
 # Copyright (C) 2015-2018 CERN.
+# Copyright (C) 2022 Graz University of Technology.
 #
 # Invenio is free software; you can redistribute it and/or modify it
 # under the terms of the MIT License; see LICENSE file for more details.
 
 """Models for storing information about OAIServer state."""
 
-from datetime import datetime
-
 from flask_babelex import lazy_gettext as _
 from invenio_db import db
 from sqlalchemy.event import listen
@@ -18,7 +17,6 @@
 
 from .errors import OAISetSpecUpdateError
 from .proxies import current_oaiserver
-from .utils import datetime_to_datestamp
 
 
 class OAISet(db.Model, Timestamp):
@@ -76,52 +74,42 @@ def validate_spec(self, key, value):
             raise OAISetSpecUpdateError("Updating spec is not allowed.")
         return value
 
-    def add_record(self, record):
-        """Add a record to the OAISet.
-
-        :param record: Record to be added.
-        :type record: `invenio_records.api.Record` or derivative.
-        """
-        record.setdefault('_oai', {}).setdefault('sets', [])
-
-        assert not self.has_record(record)
-
-        record['_oai']['sets'].append(self.spec)
+    # TODO: Add and remove can be implemented but it will require to
+    # update the `search_pattern`
 
-    def remove_record(self, record):
-        """Remove a record from the OAISet.
+    # def add_record(self, record):
+    #     """Add a record to the OAISet.
 
-        :param record: Record to be removed.
-        :type record: `invenio_records.api.Record` or derivative.
-        """
-        assert self.has_record(record)
+    #     :param record: Record to be added.
+    #     :type record: `invenio_records.api.Record` or derivative.
+    #     """
+    #     record.setdefault('_oai', {}).setdefault('sets', [])
 
-        record['_oai']['sets'] = [
-            s for s in record['_oai']['sets'] if s != self.spec]
+    #     assert not self.has_record(record)
 
-    def has_record(self, record):
-        """Check if the record blongs to the OAISet.
+    #     record['_oai']['sets'].append(self.spec)
 
-        :param record: Record to be checked.
-        :type record: `invenio_records.api.Record` or derivative.
-        """
-        return self.spec in record.get('_oai', {}).get('sets', [])
+    # def remove_record(self, record):
+    #     """Remove a record from the OAISet.
 
+    #     :param record: Record to be removed.
+    #     :type record: `invenio_records.api.Record` or derivative.
+    #     """
+    #     assert self.has_record(record)
 
-def oaiset_removed_or_inserted(mapper, connection, target):
-    """Invalidate cache on collection insert or delete."""
-    current_oaiserver.sets = None
+    #     record['_oai']['sets'] = [
+    #         s for s in record['_oai']['sets'] if s != self.spec]
 
+    # TODO: has_record can be implemented but it will require to
+    # to do a full search.
 
-def oaiset_attribute_changed(target, value, oldvalue, initiator):
-    """Invalidate cache if dbquery change."""
-    if value != oldvalue:
-        current_oaiserver.sets = None
+    # def has_record(self, record):
+    #     """Check if the record blongs to the OAISet.
 
+    #     :param record: Record to be checked.
+    #     :type record: `invenio_records.api.Record` or derivative.
+    #     """
+    #     return self.spec in record.get('_oai', {}).get('sets', [])
 
-# update cache with list of collections
-listen(OAISet, 'after_insert', oaiset_removed_or_inserted)
-listen(OAISet, 'after_delete', oaiset_removed_or_inserted)
-listen(OAISet.search_pattern, 'set', oaiset_attribute_changed)
 
 __all__ = ('OAISet', )