invenio-app-ils 1.0.0a54__py2.py3-none-any.whl → 6.1.0__py2.py3-none-any.whl

invenio_app_ils/patrons/mappings/os-v1/patrons/patron-v1.0.0.json

@@ -0,0 +1,42 @@
+{
+  "settings": {
+    "analysis": {
+      "analyzer": {
+        "email": {
+          "type": "custom",
+          "tokenizer": "uax_url_email"
+        }
+      }
+    }
+  },
+  "mappings": {
+    "date_detection": false,
+    "numeric_detection": false,
+    "properties": {
+      "$schema": {
+        "type": "keyword"
+      },
+      "email": {
+        "type": "text",
+        "analyzer": "email"
+      },
+      "id": {
+        "type": "keyword"
+      },
+      "name": {
+        "type": "text",
+        "fields": {
+          "keyword": {
+            "type": "keyword"
+          }
+        }
+      },
+      "pid": {
+        "type": "keyword"
+      },
+      "location_pid": {
+        "type": "keyword"
+      }
+    }
+  }
+}

invenio_app_ils/patrons/mappings/os-v2/__init__.py

@@ -0,0 +1,8 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2019 CERN.
+#
+# invenio-app-ils is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+
+"""ILS Patrons ES v7 mappings."""

invenio_app_ils/patrons/mappings/os-v2/patrons/patron-v1.0.0.json

@@ -0,0 +1,42 @@
+{
+  "settings": {
+    "analysis": {
+      "analyzer": {
+        "email": {
+          "type": "custom",
+          "tokenizer": "uax_url_email"
+        }
+      }
+    }
+  },
+  "mappings": {
+    "date_detection": false,
+    "numeric_detection": false,
+    "properties": {
+      "$schema": {
+        "type": "keyword"
+      },
+      "email": {
+        "type": "text",
+        "analyzer": "email"
+      },
+      "id": {
+        "type": "keyword"
+      },
+      "name": {
+        "type": "text",
+        "fields": {
+          "keyword": {
+            "type": "keyword"
+          }
+        }
+      },
+      "pid": {
+        "type": "keyword"
+      },
+      "location_pid": {
+        "type": "keyword"
+      }
+    }
+  }
+}

invenio_app_ils/patrons/views.py

@@ -7,7 +7,6 @@
 
 """Invenio App ILS Patrons views."""
 
-from elasticsearch import VERSION as ES_VERSION
 from flask import Blueprint, current_app
 from flask_login import current_user
 from invenio_circulation.search.api import search_by_patron_item_or_document
@@ -17,8 +16,6 @@ from webargs.flaskparser import use_kwargs
 from invenio_app_ils.circulation.search import get_loans_aggregated_by_states
 from invenio_app_ils.permissions import need_permissions
 
-lt_es7 = ES_VERSION[0] < 7
-
 
 def get_user_loan_information_blueprint(_):
     """Add patron views to the blueprint."""
@@ -58,20 +55,17 @@ def retrieve_user_loans_information(patron_pid, document_pid):
     loan_result = loans_search.execute()
     for bucket in loan_result.aggregations.states.buckets:
         if (
-            bucket["key"]
-            in current_app.config["CIRCULATION_STATES_LOAN_ACTIVE"]
+            bucket["key"] in current_app.config["CIRCULATION_STATES_LOAN_ACTIVE"]
             and bucket["doc_count"] > 0
         ):
             user_information["has_active_loan"] = True
         elif (
-            bucket["key"]
-            in current_app.config["CIRCULATION_STATES_LOAN_REQUEST"]
+            bucket["key"] in current_app.config["CIRCULATION_STATES_LOAN_REQUEST"]
             and bucket["doc_count"] > 0
         ):
             user_information["is_requested"] = True
         elif (
-            bucket["key"]
-            in current_app.config["CIRCULATION_STATES_LOAN_COMPLETED"]
+            bucket["key"] in current_app.config["CIRCULATION_STATES_LOAN_COMPLETED"]
             and bucket["doc_count"] > 0
         ):
             search = search_by_patron_item_or_document(
@@ -82,11 +76,7 @@ def retrieve_user_loans_information(patron_pid, document_pid):
 
             search = search.sort({"end_date": {"order": "desc"}})
             search_result = search.execute()
-            has_past_loans = (
-                search_result.hits.total > 0
-                if lt_es7
-                else search_result.hits.total.value > 0
-            )
+            has_past_loans = search_result.hits.total.value > 0
             if has_past_loans:
                 last_loan = search_result.hits[0]
                 user_information["last_loan"] = last_loan["end_date"]

invenio_app_ils/permissions.py

@@ -9,21 +9,18 @@
 
 from functools import wraps
 
-from flask import abort, current_app, has_request_context
+from flask import abort, current_app, g, has_request_context
 from flask_login import current_user
 from flask_principal import UserNeed
 from invenio_access import action_factory
-from invenio_access.permissions import (
-    Permission,
-    authenticated_user,
-    superuser_access,
-)
+from invenio_access.permissions import Permission, authenticated_user, superuser_access
 from invenio_records_rest.utils import allow_all, deny_all
 
-from invenio_app_ils.errors import InvalidLoanExtendError
+from invenio_app_ils.errors import InvalidLoanExtendError, LoanCheckoutByPatronForbidden
 from invenio_app_ils.proxies import current_app_ils
 
 backoffice_access_action = action_factory("ils-backoffice-access")
+backoffice_readonly_access_action = action_factory("ils-backoffice-readonly-access")
 
 
 def need_permissions(action):
@@ -66,6 +63,11 @@ def backoffice_permission(*args, **kwargs):
     return Permission(backoffice_access_action)
 
 
+def backoffice_read_permission(*args, **kwargs):
+    """Return permission for backoffice (full or read-only) read access."""
+    return Permission(backoffice_access_action, backoffice_readonly_access_action)
+
+
 def superuser_permission(*args, **kwargs):
     """Return permission to allow only admins."""
     return Permission(superuser_access)
@@ -107,7 +109,9 @@ def loan_extend_circulation_permission(loan):
     if current_user.is_anonymous:
         abort(401)
 
-    if current_user.id == int(loan["patron_pid"]):
+    is_admin_or_librarian = backoffice_permission().allows(g.identity)
+    is_logged_in_patron_owner = current_user.id == int(loan["patron_pid"])
+    if not is_admin_or_librarian and is_logged_in_patron_owner:
         Document = current_app_ils.document_record_cls
         document_rec = Document.get_record_by_pid(loan["document_pid"])
         document = document_rec.replace_refs()
@@ -133,43 +137,97 @@ def patron_owner_permission(record):
     return PatronOwnerPermission(record)
 
 
-class PatronOwnerPermission(Permission):
-    """Return Permission to evaluate if the current user owns the record."""
+def loan_checkout_permission(*args, **kwargs):
+    """Loan checkout permissions checks.
+
+    Allow admins and librarians to checkout, patrons to self-checkout when enabled.
+    """
+    if not has_request_context():
+        # CLI or Celery task
+        return backoffice_permission()
+
+    if current_user.is_anonymous:
+        abort(401)
+
+    is_admin_or_librarian = backoffice_permission().allows(g.identity)
+    if is_admin_or_librarian:
+        return backoffice_permission()
+
+    # ensure that only the loan's patron can do operations on this loan
+    if len(args):
+        loan = args[0]
+    else:
+        loan = kwargs["record"]
+    is_patron_current_user = current_user.id == int(loan["patron_pid"])
+
+    if current_app.config["ILS_SELF_CHECKOUT_ENABLED"] and is_patron_current_user:
+        return authenticated_user_permission()
+
+    raise LoanCheckoutByPatronForbidden(int(loan["patron_pid"]), current_user.id)
+
+
+class PatronOwnerReadPermission(Permission):
+    """Return Permission to evaluate if the current user owns the record or has backoffice read access."""
 
     def __init__(self, record):
         """Constructor."""
         super().__init__(
-            UserNeed(int(record["patron_pid"])), backoffice_access_action
+            UserNeed(int(record["patron_pid"])),
+            backoffice_access_action,
+            backoffice_readonly_access_action,
         )
 
 
+class PatronOwnerPermission(Permission):
+    """Return Permission to evaluate if the current user owns the record."""
+
+    def __init__(self, record):
+        """Constructor."""
+        super().__init__(UserNeed(int(record["patron_pid"])), backoffice_access_action)
+
+
+_is_authenticated_user = [
+    "circulation-loan-request",
+    "patron-loans",
+    "bulk-loan-extension",
+]
+_is_backoffice_permission = [
+    "circulation-loan-force-checkout",
+    "circulation-overdue-loan-notification",
+    "circulation-loan-update-dates",
+    "relations-create",
+    "relations-delete",
+    "document-request-actions",
+    "bucket-create",
+    "ill-brwreq-patron-loan-create",
+    "ill-brwreq-patron-loan-extension-accept",
+    "ill-brwreq-patron-loan-extension-decline",
+]
+_is_backoffice_read_permission = [
+    "stats-most-loaned",
+    "get-notifications-sent-to-patron",
+]
+_is_patron_owner_permission = [
+    "document-request-decline",
+    "ill-brwreq-patron-loan-extension-request",
+]
+
+
 def views_permissions_factory(action):
     """Return ILS views permissions factory."""
-    is_authenticated_user = ["circulation-loan-request", "patron-loans",
-                             "bulk-loan-extension"]
-    is_backoffice_permission = [
-        "circulation-loan-checkout",
-        "circulation-loan-force-checkout",
-        "circulation-overdue-loan-notification",
-        "circulation-loan-update-dates",
-        "relations-create",
-        "relations-delete",
-        "stats-most-loaned",
-        "document-request-actions",
-        "bucket-create",
-        "ill-brwreq-patron-loan-create",
-        "ill-brwreq-patron-loan-extension-accept",
-        "ill-brwreq-patron-loan-extension-decline",
-        "send-notification-to-patron",
-    ]
-    is_patron_owner_permission = [
-        "document-request-decline",
-        "ill-brwreq-patron-loan-extension-request",
-    ]
-    if action in is_authenticated_user:
+    if action in _is_authenticated_user:
         return authenticated_user_permission()
-    elif action in is_backoffice_permission:
+    elif action in _is_backoffice_permission:
         return backoffice_permission()
-    elif action in is_patron_owner_permission:
+    elif action in _is_backoffice_read_permission:
+        return backoffice_read_permission()
+    elif action in _is_patron_owner_permission:
         return PatronOwnerPermission
+    elif action == "circulation-loan-checkout":
+        return backoffice_permission()
+    elif (
+        action == "circulation-loan-self-checkout"
+        and current_app.config["ILS_SELF_CHECKOUT_ENABLED"]
+    ):
+        return authenticated_user_permission()
     return deny_all()

invenio_app_ils/providers/api.py

@@ -41,14 +41,10 @@ class Provider(IlsRecord):
     def delete(self, **kwargs):
         """Delete record."""
         order_search_cls = current_ils_acq.order_search_cls
-        search_order_res = order_search_cls().search_by_provider_pid(
-            self["pid"]
-        )
+        search_order_res = order_search_cls().search_by_provider_pid(self["pid"])
 
         brwreq_search_cls = current_ils_ill.borrowing_request_search_cls
-        search_brwreq_res = brwreq_search_cls().search_by_provider_pid(
-            self["pid"]
-        )
+        search_brwreq_res = brwreq_search_cls().search_by_provider_pid(self["pid"])
 
         if search_order_res.count() or search_brwreq_res.count():
             order_ref_ids = [res["pid"] for res in search_order_res.scan()]

invenio_app_ils/providers/config.py

@@ -10,14 +10,12 @@
 from invenio_records_rest.facets import terms_filter
 
 from invenio_app_ils.config import RECORDS_REST_MAX_RESULT_WINDOW
-from invenio_app_ils.permissions import backoffice_permission
-
-from .api import (
-    PROVIDER_PID_FETCHER,
-    PROVIDER_PID_MINTER,
-    PROVIDER_PID_TYPE,
-    Provider,
+from invenio_app_ils.permissions import (
+    backoffice_permission,
+    backoffice_read_permission,
 )
+
+from .api import PROVIDER_PID_FETCHER, PROVIDER_PID_MINTER, PROVIDER_PID_TYPE, Provider
 from .indexer import ProviderIndexer
 from .search import ProviderSearch
 
@@ -34,20 +32,14 @@ RECORDS_REST_ENDPOINTS = dict(
         indexer_class=ProviderIndexer,
         record_class=Provider,
         record_loaders={
-            "application/json": (
-                "invenio_app_ils.providers.loaders:provider_loader"
-            )
+            "application/json": "invenio_app_ils.providers.loaders:provider_loader"
         },
         record_serializers={
-            "application/json": (
-                "invenio_app_ils.records.serializers:json_v1_response"
-            )
+            "application/json": "invenio_app_ils.records.serializers:json_v1_response"
         },
         search_serializers={
-            "application/json": (
-                "invenio_app_ils.records.serializers:json_v1_search"
-            ),
-            "text/csv": ("invenio_app_ils.records.serializers:csv_v1_search"),
+            "application/json": "invenio_app_ils.records.serializers:json_v1_search",
+            "text/csv": "invenio_app_ils.records.serializers:csv_v1_search",
         },
         search_serializers_aliases={
             "csv": "text/csv",
@@ -58,8 +50,8 @@ RECORDS_REST_ENDPOINTS = dict(
         default_media_type="application/json",
         max_result_window=RECORDS_REST_MAX_RESULT_WINDOW,
         error_handlers=dict(),
-        read_permission_factory_imp=backoffice_permission,
-        list_permission_factory_imp=backoffice_permission,
+        read_permission_factory_imp=backoffice_read_permission,
+        list_permission_factory_imp=backoffice_read_permission,
         create_permission_factory_imp=backoffice_permission,
         update_permission_factory_imp=backoffice_permission,
         delete_permission_factory_imp=backoffice_permission,

invenio_app_ils/providers/indexer.py

@@ -38,17 +38,13 @@ def provider_index_referenced_records(provider):
     brwreq_pid_type = BORROWING_REQUEST_PID_TYPE
 
     for rec in (
-        vendor_search_cls()
-        .search_by_provider_pid(provider_pid=provider["pid"])
-        .scan()
+        vendor_search_cls().search_by_provider_pid(provider_pid=provider["pid"]).scan()
     ):
         rec = vendor_record_cls.get_record_by_pid(rec["pid"])
         referenced.append(dict(pid_type=vendor_pid_type, record=rec))
 
     for rec in (
-        brwreq_search_cls()
-        .search_by_provider_pid(provider_pid=provider["pid"])
-        .scan()
+        brwreq_search_cls().search_by_provider_pid(provider_pid=provider["pid"]).scan()
     ):
         rec = brwreq_record_cls.get_record_by_pid(rec["pid"])
         referenced.append(dict(pid_type=brwreq_pid_type, record=rec))

invenio_app_ils/providers/mappings/{v6 → os-v1}/__init__.py

@@ -5,4 +5,4 @@
 # invenio-app-ils is free software; you can redistribute it and/or modify it
 # under the terms of the MIT License; see LICENSE file for more details.
 
-"""Invenio Providers ES v6 mappings."""
+"""Invenio Providers OS v1 mappings."""

invenio_app_ils/providers/mappings/os-v1/providers/provider-v1.0.0.json

@@ -0,0 +1,57 @@
+{
+  "settings": {
+    "analysis": {
+      "analyzer": {
+        "email": {
+          "type": "custom",
+          "tokenizer": "uax_url_email"
+        }
+      }
+    }
+  },
+  "mappings": {
+    "date_detection": false,
+    "numeric_detection": false,
+    "properties": {
+      "$schema": {
+        "type": "keyword"
+      },
+      "_created": {
+        "type": "date"
+      },
+      "_updated": {
+        "type": "date"
+      },
+      "address": {
+        "type": "text"
+      },
+      "email": {
+        "type": "text",
+        "analyzer": "email"
+      },
+      "legacy_id": {
+        "type": "keyword"
+      },
+      "name": {
+        "fields": {
+          "keyword": {
+            "type": "keyword"
+          }
+        },
+        "type": "text"
+      },
+      "notes": {
+        "type": "text"
+      },
+      "phone": {
+        "type": "keyword"
+      },
+      "pid": {
+        "type": "keyword"
+      },
+      "type": {
+        "type": "keyword"
+      }
+    }
+  }
+}

invenio_app_ils/providers/mappings/os-v2/__init__.py

@@ -0,0 +1,8 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2021 CERN.
+#
+# invenio-app-ils is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+
+"""Invenio Providers OS v2 mappings."""

invenio_app_ils/providers/mappings/os-v2/providers/provider-v1.0.0.json

@@ -0,0 +1,57 @@
+{
+  "settings": {
+    "analysis": {
+      "analyzer": {
+        "email": {
+          "type": "custom",
+          "tokenizer": "uax_url_email"
+        }
+      }
+    }
+  },
+  "mappings": {
+    "date_detection": false,
+    "numeric_detection": false,
+    "properties": {
+      "$schema": {
+        "type": "keyword"
+      },
+      "_created": {
+        "type": "date"
+      },
+      "_updated": {
+        "type": "date"
+      },
+      "address": {
+        "type": "text"
+      },
+      "email": {
+        "type": "text",
+        "analyzer": "email"
+      },
+      "legacy_id": {
+        "type": "keyword"
+      },
+      "name": {
+        "fields": {
+          "keyword": {
+            "type": "keyword"
+          }
+        },
+        "type": "text"
+      },
+      "notes": {
+        "type": "text"
+      },
+      "phone": {
+        "type": "keyword"
+      },
+      "pid": {
+        "type": "keyword"
+      },
+      "type": {
+        "type": "keyword"
+      }
+    }
+  }
+}

invenio_app_ils/providers/mappings/v7/__init__.py

@@ -5,4 +5,4 @@
 # invenio-app-ils is free software; you can redistribute it and/or modify it
 # under the terms of the MIT License; see LICENSE file for more details.
 
-"""Invenio Providers ES v6 mappings."""
+"""Invenio Providers ES v7 mappings."""

invenio_app_ils/providers/proxies.py

@@ -10,7 +10,5 @@
 from flask import current_app
 from werkzeug.local import LocalProxy
 
-current_ils_prov = LocalProxy(
-    lambda: current_app.extensions["invenio-ils-prov"]
-)
+current_ils_prov = LocalProxy(lambda: current_app.extensions["invenio-ils-prov"])
 """Helper proxy to get the current ILS Providers extension."""

invenio_app_ils/records/api.py

@@ -41,9 +41,7 @@ class IlsRecord(Record):
     @cached_property
     def pid(self):
         """Get the PersistentIdentifier for this record."""
-        return PersistentIdentifier.get(
-            pid_type=self._pid_type, pid_value=self["pid"]
-        )
+        return PersistentIdentifier.get(pid_type=self._pid_type, pid_value=self["pid"])
 
     @staticmethod
     def pid_type_to_record_class(pid_type):
@@ -58,13 +56,9 @@ class IlsRecord(Record):
             pid_type = cls._pid_type
         else:
             new_cls = cls.pid_type_to_record_class(pid_type)
-            return new_cls.get_record_by_pid(
-                pid_value, with_deleted=with_deleted
-            )
+            return new_cls.get_record_by_pid(pid_value, with_deleted=with_deleted)
 
-        resolver = Resolver(
-            pid_type=pid_type, object_type="rec", getter=cls.get_record
-        )
+        resolver = Resolver(pid_type=pid_type, object_type="rec", getter=cls.get_record)
         _, record = resolver.resolve(str(pid_value))
         return record
 

invenio_app_ils/records/loaders/schemas/changed_by.py

@@ -22,9 +22,7 @@ class ChangedBySchema(Schema):
 
         unknown = EXCLUDE
 
-    type = fields.Str(
-        required=True, validate=validate.OneOf(IlsRecord.CURATOR_TYPES)
-    )
+    type = fields.Str(required=True, validate=validate.OneOf(IlsRecord.CURATOR_TYPES))
     value = fields.Str()
 
 

invenio_app_ils/records/loaders/schemas/identifiers.py

@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2024 CERN.
+#
+# invenio-app-ils is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+
+"""Identifiers schema for marshmallow loader."""
+
+from marshmallow import EXCLUDE, Schema, fields
+
+
+class IdentifierSchema(Schema):
+    """Identifier schema."""
+
+    class Meta:
+        """Meta attributes for the schema."""
+
+        unknown = EXCLUDE
+
+    material = fields.Str()
+    scheme = fields.Str(required=True)
+    value = fields.Str(required=True)

invenio_app_ils/records/metadata_extensions.py

@@ -30,10 +30,7 @@ class MetadataExtensions(object):
         def validate_basic_marshmallow_type(_type):
             allowed_types = [Bool, DateString, Integer, SanitizedUnicode]
             assert any(
-                [
-                    isinstance(_type, allowed_type)
-                    for allowed_type in allowed_types
-                ]
+                [isinstance(_type, allowed_type) for allowed_type in allowed_types]
             )
 
         marshmallow_type = field_cfg["marshmallow"]

invenio_app_ils/records/permissions.py

@@ -12,7 +12,10 @@ from flask_principal import ActionNeed, RoleNeed, UserNeed
 from invenio_access import Permission, any_user
 from six import string_types
 
-from invenio_app_ils.permissions import backoffice_access_action
+from invenio_app_ils.permissions import (
+    backoffice_access_action,
+    backoffice_readonly_access_action,
+)
 
 create_records_action = ActionNeed("create-records")
 
@@ -68,7 +71,10 @@ class RecordPermission(Permission):
         if self.is_public():
             return [any_user]
         else:
-            return self.record_needs() + [backoffice_access_action]
+            return self.record_needs() + [
+                backoffice_readonly_access_action,
+                backoffice_access_action,
+            ]
 
     def record_explicit_restrictions(self):
         """Return the list of user ids/roles allowed for the given action."""