invenio-app-rdm 5.0.0.dev0__py2.py3-none-any.whl → 14.0.0b4.dev4__py2.py3-none-any.whl

invenio_app_rdm/records_ui/views/filters.py

@@ -1,25 +1,28 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2019-2020 CERN.
+# Copyright (C) 2019-2024 CERN.
 # Copyright (C) 2019-2020 Northwestern University.
 # Copyright (C)      2021 TU Wien.
+# Copyright (C) 2024 Graz University of Technology.
 #
 # Invenio App RDM is free software; you can redistribute it and/or modify it
 # under the terms of the MIT License; see LICENSE file for more details.
 
 """Filters to be used in the Jinja templates."""
 
-from operator import itemgetter
 from os.path import splitext
 
 import idutils
-from flask import current_app
+from babel.numbers import format_compact_decimal, format_decimal
+from flask import current_app, url_for
+from invenio_base.utils import obj_or_import_string
+from invenio_i18n import get_locale
 from invenio_previewer.views import is_previewable
-from invenio_rdm_records.resources.serializers import UIJSONSerializer
-from invenio_rdm_records.vocabularies import Vocabularies
 from invenio_records_files.api import FileObject
 from invenio_records_permissions.policies import get_record_permission_policy
 
+from ..previewer.iiif_simple import previewable_extensions as image_extensions
+
 
 def make_files_preview_compatible(files):
     """Processes a list of RecordFiles to a list of FileObjects.
@@ -28,9 +31,7 @@ def make_files_preview_compatible(files):
     """
     file_objects = []
     for file in files:
-        file_objects.append(
-            FileObject(obj=files[file].object_version, data={}).dumps()
-        )
+        file_objects.append(FileObject(obj=files[file].object_version, data={}).dumps())
     return file_objects
 
 
@@ -76,9 +77,7 @@ def pid_url(identifier, scheme=None, url_scheme="https"):
             scheme = None
     try:
         if scheme and identifier:
-            return idutils.to_url(
-                identifier, scheme, url_scheme=url_scheme
-            )
+            return idutils.to_url(identifier, scheme, url_scheme=url_scheme)
     except Exception:
         current_app.logger.warning(
             f"URL generation for identifier {identifier} failed.",
@@ -87,34 +86,18 @@ def pid_url(identifier, scheme=None, url_scheme="https"):
     return ""
 
 
-def doi_identifier(identifiers):
-    """Extract DOI from sequence of identifiers."""
-    doi_identifier = identifiers.get("doi")
-    return doi_identifier['identifier'] if doi_identifier else None
-
-
-def vocabulary_title(dict_key, vocabulary_key, alt_key=None):
-    """Returns formatted vocabulary-corresponding human-readable string.
-
-    In some cases the dict needs to be reconstructed. `alt_key` will be the
-    key while `dict_key` will become the value.
-    """
-    if alt_key:
-        dict_key = {alt_key: dict_key}
-    vocabulary = Vocabularies.get_vocabulary(vocabulary_key)
-    return vocabulary.get_title_by_dict(dict_key) if vocabulary else ""
-
-
 def has_previewable_files(files):
     """Check if any of the files is previewable."""
     # 'splitext' inclues the dot of the file extension in the
     # extension, we have to get rid of that
-    extensions = [
-        ext[1:] if ext.startswith(".") else ext
-        for ext in (splitext(f["key"])[-1] for f in files)
-    ]
+    extensions = [splitext(f["key"])[-1].strip(".").lower() for f in files]
+    return any([is_previewable(ext) for ext in extensions])
+
 
-    return any([is_previewable(ext.lower()) for ext in extensions])
+def has_images(files):
+    """Check if any of the files are images (previewable by iiif_simple)."""
+    extensions = [splitext(f["key"])[-1].strip(".").lower() for f in files]
+    return any(ext in image_extensions for ext in extensions)
 
 
 def order_entries(files):
@@ -131,5 +114,113 @@ def order_entries(files):
             return files_.pop(idx)
 
         files = [get_file(key) for key in order]
+    else:
+        # sort alphabetically by filekey
+        files = sorted(files, key=lambda x: x["key"].lower())
 
     return files
+
+
+def get_scheme_label(scheme):
+    """Convert backend scheme to frontend label."""
+    configs = [
+        current_app.config.get("RDM_RECORDS_IDENTIFIERS_SCHEMES", {}),
+        current_app.config.get("RDM_RECORDS_RELATED_IDENTIFIERS_SCHEMES", {}),
+    ]
+
+    for cfg in configs:
+        if scheme in cfg:
+            return cfg[scheme].get("label", scheme)
+
+    return scheme
+
+
+def localize_number(value):
+    """Format number according to locale value."""
+    locale_value = current_app.config.get("BABEL_DEFAULT_LOCALE")
+    number = int(value)
+    return format_decimal(number, locale=locale_value)
+
+
+def compact_number(value, max_value):
+    """Format long numbers."""
+    locale_value = current_app.config.get("BABEL_DEFAULT_LOCALE")
+    number = int(value)
+    decimals = 0
+
+    if number > max_value:
+        decimals = 2
+    return format_compact_decimal(
+        int(value), format_type="short", locale=locale_value, fraction_digits=decimals
+    )
+
+
+def truncate_number(value, max_value):
+    """Make number compact if too long."""
+    number = localize_number(value)
+    if int(value) > max_value:
+        number = compact_number(value, max_value=1_000_000)
+    return number
+
+
+def namespace_url(field):
+    """Get custom field namespace url."""
+    namespace_array = field.split(":")
+    namespace = namespace_array[0]
+    namespace_value = namespace_array[1]
+    namespaces = current_app.config.get("RDM_NAMESPACES")
+
+    if not namespaces.get(namespace):
+        return None
+
+    return namespaces[namespace] + namespace_value
+
+
+def custom_fields_search(field, field_value, field_cfg=None):
+    """Get custom field search url."""
+    namespace_array = field.split(":")
+    namespace = namespace_array[0]
+    namespaces = current_app.config.get("RDM_NAMESPACES")
+
+    if not namespaces.get(namespace):
+        return None
+
+    localised_title = (field_cfg or {}).get("locale")
+    if localised_title:
+        locale = get_locale()
+        if not locale:
+            locale = current_app.config.get("BABEL_DEFAULT_LOCALE", "en")
+        # example: cern:experiments.title.en
+        # the \ is necessary for the lucene syntax but produces a SyntaxWarning.
+        # The r marks the string as raw and prevents the warning
+        # https://docs.python.org/3/reference/lexical_analysis.html#escape-sequences
+        namespace_string = r"\:".join(namespace_array) + rf".{localised_title}.{locale}"
+    else:
+        namespace_string = r"\:".join(namespace_array)
+        # Check if the field config has a landing page search attribute to search by
+        landing_page_search_attr = (field_cfg or {}).get(
+            "landing_page_search_attr", False
+        )
+        if landing_page_search_attr:
+            namespace_string += rf".{landing_page_search_attr}"
+
+    return url_for(
+        "invenio_search_ui.search",
+        q=f'custom_fields.{namespace_string}:"{field_value}"',
+    )
+
+
+def transform_record(record, serializer, module=None, throws=True, **kwargs):
+    """Transform a record using a serializer."""
+    try:
+        module = module or "invenio_rdm_records.resources.serializers"
+        import_str = f"{module}:{serializer}"
+        serializer = obj_or_import_string(import_str)
+        if serializer:
+            return serializer().dump_obj(record)
+        if throws:
+            raise Exception("No serializer found.")
+    except Exception:
+        current_app.logger.exception("Record transformation failed.")
+        if throws:
+            raise