v0.8.4

* config: set samesite cookie to strict
* dep: bump in base

.github/workflows/tests.yml

@@ -20,9 +20,42 @@ jobs:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-          python-version: [3.6, 3.7, 3.8]
+          python-version: [3.6, 3.7, 3.8, 3.9]
           requirements-level: [min, pypi]
+          db-service: [postgresql12]
+          search-service: [elasticsearch7]
+          exclude:
+          - python-version: 3.6
+            requirements-level: pypi
 
+          - python-version: 3.7
+            requirements-level: min
+
+          - python-version: 3.8
+            requirements-level: min
+
+          - python-version: 3.9
+            requirements-level: min
+
+          - db-service: postgresql12
+            requirements-level: min
+
+          - search-service: elasticsearch7
+            requirements-level: min
+
+          include:
+
+          - db-service: postgresql12
+            DB_EXTRAS: "postgresql"
+
+
+          - search-service: elasticsearch7
+            SEARCH_EXTRAS: "elasticsearch7"
+
+    env:
+      DB: ${{ matrix.db-service }}
+      SEARCH: ${{ matrix.search-service }}
+      EXTRAS: all,${{ matrix.DB_EXTRAS }},${{ matrix.SEARCH_EXTRAS }}
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -35,8 +68,7 @@ jobs:
       - name: Generate dependencies
         run: |
           python -m pip install --upgrade pip setuptools py wheel requirements-builder
-          requirements-builder -e all --level=${{ matrix.requirements-level }} setup.py > .${{ matrix.requirements-level }}-${{ matrix.python-version }}-requirements.txt
-
+          requirements-builder -e "$EXTRAS" --level=${{ matrix.requirements-level }} setup.py > .${{ matrix.requirements-level }}-${{ matrix.python-version }}-requirements.txt
       - name: Cache pip
         uses: actions/cache@v2
         with:
@@ -45,10 +77,11 @@ jobs:
 
       - name: Install dependencies
         run: |
-          pip install -r .${{matrix.requirements-level}}-${{ matrix.python-version }}-requirements.txt
-          pip install .[all]
+          pip install -r .${{ matrix.requirements-level }}-${{ matrix.python-version }}-requirements.txt
+          pip install ".[$EXTRAS]"
           pip freeze
-
+          docker --version
+          docker-compose --version
       - name: Run tests
         run: |
           ./run-tests.sh

CHANGES.rst

@@ -1,5 +1,5 @@
 ..
-    Copyright (C) 2020 Mojib Wali.
+    Copyright (C) 2020 - 2022 Graz University of Technology.
 
     invenio-config-tugraz is free software; you can redistribute it and/or
     modify it under the terms of the MIT License; see LICENSE file for more
@@ -7,6 +7,35 @@
 
 Changes
 =======
+Version 0.8.4 (released 2022-03-11)
+
+- config: use gettext
+
+Version 0.8.3 (released 2022-03-10)
+
+- config: fix comment & import
+
+Version 0.8.2 (released 2022-03-03)
+
+- config: new introduced to v8 of invenioRDM
+
+Version 0.8.1 (released 2022-02-28)
+
+- config: set samesite cookie to strict
+- dep: bump in base dependencies
+
+Version 0.8.0 (released 2022-02-09)
+
+- dep: bump rdm-records version
+
+Version 0.7.1 (released 2021-12-07)
+
+- configs: adds new & changed configs for v7 #76
+
+Version 0.7.0 (released 2021-12-06)
+
+- fix: update blueprint reorder #74
+- dep: upgrade rdm-records version & OAI #72
 
 Version 0.1.0 (released TBD)
 

MANIFEST.in

@@ -34,15 +34,21 @@ recursive-include docs *.py
 recursive-include docs *.rst
 recursive-include docs *.txt
 recursive-include docs Makefile
-recursive-include invenio_config_tugraz *.html
 recursive-include tests *.py
 
+
 # added by check_manifest.py
 recursive-include invenio_config_tugraz *.crt
 recursive-include invenio_config_tugraz *.json
 recursive-include invenio_config_tugraz *.key
 recursive-include invenio_config_tugraz *.xml
 recursive-include invenio_config_tugraz *.gitkeep
+recursive-include invenio_config_tugraz *.txt
+recursive-include invenio_config_tugraz *.html
+
 
 # added by check-manifest
 recursive-include invenio_config_tugraz *.csv
+
+# added by check-manifest
+recursive-include invenio_config_tugraz *.pdf

README.rst

@@ -1,5 +1,5 @@
 ..
-    Copyright (C) 2020 Mojib Wali.
+    Copyright (C) 2020-2021 Graz University of Technology.
 
     invenio-config-tugraz is free software; you can redistribute it and/or
     modify it under the terms of the MIT License; see LICENSE file for more
@@ -15,11 +15,11 @@
 .. image:: https://img.shields.io/pypi/dm/invenio-config-tugraz.svg
         :target: https://pypi.python.org/pypi/invenio-config-tugraz
 
-.. image:: https://img.shields.io/github/tag/mb-wali/invenio-config-tugraz.svg
-        :target: https://github.com/mb-wali/invenio-config-tugraz/releases
+.. image:: https://img.shields.io/github/tag/tu-graz-library/invenio-config-tugraz.svg
+        :target: https://github.com/tu-graz-library/invenio-config-tugraz/releases
 
-.. image:: https://img.shields.io/github/license/mb-wali/invenio-config-tugraz.svg
-        :target: https://github.com/mb-wali/invenio-config-tugraz/blob/master/LICENSE
+.. image:: https://img.shields.io/github/license/tu-graz-library/invenio-config-tugraz.svg
+        :target: https://github.com/tu-graz-library/invenio-config-tugraz/blob/master/LICENSE
 
 .. image:: https://readthedocs.org/projects/invenio-config-tugraz/badge/?version=latest
         :target: https://invenio-config-tugraz.readthedocs.io/en/latest/?badge=latest
@@ -38,6 +38,8 @@ Override configs from diffrent invenio modules to meet TU Graz requirement:
 * Invenio-Mail
 * Invenio-shibboleth
 * Invenio-accounts
+* Flask-security
+* Defined routes for TUG
 
 Further documentation is available on
 https://invenio-config-tugraz.readthedocs.io/

babel.ini

@@ -13,7 +13,7 @@ encoding = utf-8
 
 # Extraction from Jinja2 templates
 
-[jinja2: **/templates/**.html]
+[jinja2: **/templates/**.*]
 encoding = utf-8
 extensions = jinja2.ext.autoescape, jinja2.ext.with_
 

docs/conf.py

@@ -332,6 +332,8 @@ texinfo_documents = [
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {
     "python": ("https://docs.python.org/", None),
+    'flask': ('https://flask.palletsprojects.com/', None),
+    'werkzeug': ('https://werkzeug.palletsprojects.com/', None),
     # TODO: Configure external documentation references, eg:
     # 'Flask-Admin': ('https://flask-admin.readthedocs.io/en/latest/', None),
 }

invenio_config_tugraz/base_permissions.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2020 Graz University of Technology.
+# Copyright (C) 2020-2021 Graz University of Technology.
 #
 # invenio-config-tugraz is free software; you can redistribute it and/or
 # modify it under the terms of the MIT License; see LICENSE file for more
@@ -49,40 +49,40 @@ Using Custom Generator for a policy:
 Permissions for Invenio records.
 """
 
-from invenio_records_permissions.generators import (
-    Admin,
-    AnyUser,
-    AnyUserIfPublic,
-    RecordOwners,
-)
-from invenio_records_permissions.policies.base import BasePermissionPolicy
+# from invenio_records_permissions.generators import (
+#     Admin,
+#     AnyUser,
+#     AnyUserIfPublic,
+#     RecordOwners,
+# )
+# from invenio_records_permissions.policies.base import BasePermissionPolicy
 
-from .generators import RecordIp
+# from .generators import RecordIp
 
 
-class TUGRAZPermissionPolicy(BasePermissionPolicy):
-    """Access control configuration for records.
+# class TUGRAZPermissionPolicy(BasePermissionPolicy):
+#     """Access control configuration for records.
 
-    This overrides the /api/records endpoint.
+#     This overrides the /api/records endpoint.
 
-    """
+#     """
 
-    # Read access to API given to everyone.
-    can_search = [AnyUser(), RecordIp()]
+#     # Read access to API given to everyone.
+#     can_search = [AnyUser(), RecordIp()]
 
-    # Read access given to everyone if public record/files and owners always.
-    can_read = [AnyUserIfPublic(), RecordOwners(), RecordIp()]
+#     # Read access given to everyone if public record/files and owners always.
+#     can_read = [AnyUserIfPublic(), RecordOwners(), RecordIp()]
 
-    # Create action given to no one (Not even superusers) bc Deposits should
-    # be used.
-    can_create = [AnyUser()]
+#     # Create action given to no one (Not even superusers) bc Deposits should
+#     # be used.
+#     can_create = [AnyUser()]
 
-    # Update access given to record owners.
-    can_update = [RecordOwners()]
+#     # Update access given to record owners.
+#     can_update = [RecordOwners()]
 
-    # Delete access given to admins only.
-    can_delete = [Admin()]
+#     # Delete access given to admins only.
+#     can_delete = [Admin()]
 
-    # Associated files permissions (which are really bucket permissions)
-    can_read_files = [AnyUserIfPublic(), RecordOwners()]
-    can_update_files = [RecordOwners()]
+#     # Associated files permissions (which are really bucket permissions)
+#     can_read_files = [AnyUserIfPublic(), RecordOwners()]
+#     can_update_files = [RecordOwners()]

invenio_config_tugraz/config.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2020 Graz University of Technology.
+# Copyright (C) 2020-2021 Graz University of Technology.
 #
 # invenio-config-tugraz is free software; you can redistribute it and/or
 # modify it under the terms of the MIT License; see LICENSE file for more
@@ -29,33 +29,26 @@ INVENIO_CONFIG_TUGRAZ_IP_RANGES =
 [["127.0.0.2", "127.0.0.99"], ["127.0.1.3", "127.0.1.5"]]
 """
 
+
+CONFIG_TUGRAZ_ROUTES = {
+    "guide": "/guide",
+    "terms": "/terms",
+    "gdpr": "/gdpr",
+}
+"""Defined routes for TUG."""
+
 # Invenio-App
 # ===========
 # See https://invenio-app.readthedocs.io/en/latest/configuration.html
 
-APP_ALLOWED_HOSTS = [
-    "0.0.0.0",
-    "localhost",
-    "127.0.0.1",
-    "invenio-dev01.tugraz.at",
-    "invenio-test.tugraz.at",
-    "repository.tugraz.at",
-]
-"""Allowed Hosts"""
-
 APP_DEFAULT_SECURE_HEADERS = {
     "content_security_policy": {
         "default-src": [
             "'self'",
-            "fonts.googleapis.com",
-            "*.gstatic.com",
             "data:",
             "'unsafe-inline'",
-            "'unsafe-eval'",
             "blob:",
             "ub-support.tugraz.at",  # zammad contact form
-            "api.datacite.org/dois",  # datacite
-            "api.test.datacite.org/dois",  # datacite test
         ],
     },
     "content_security_policy_report_only": False,
@@ -73,6 +66,15 @@ APP_DEFAULT_SECURE_HEADERS = {
     "strict_transport_security_preload": False,
 }
 
+# Invenio-I18N
+# ============
+# See https://invenio-i18n.readthedocs.io/en/latest/configuration.html
+BABEL_DEFAULT_LOCALE = "en"
+# Default time zone
+BABEL_DEFAULT_TIMEZONE = "Europe/Vienna"
+# Other supported languages (do not include BABEL_DEFAULT_LOCALE in list).
+I18N_LANGUAGES = [("de", _("German"))]
+
 # Invenio-Mail
 # ===========
 # See https://invenio-mail.readthedocs.io/en/latest/configuration.html
@@ -84,7 +86,7 @@ SECURITY_EMAIL_SENDER = "info@invenio-test.tugraz.at"
 """Email address used as sender of account registration emails."""
 """Domain name should match the domain used in web server."""
 
-SECURITY_EMAIL_SUBJECT_REGISTER = _("Welcome to RDM!")
+SECURITY_EMAIL_SUBJECT_REGISTER = _("Welcome to TU Graz Repository!")
 """Email subject for account registration emails."""
 
 MAIL_SUPPRESS_SEND = True
@@ -113,19 +115,22 @@ Set this to False when sending actual emails.
 # ===========
 # See https://invenio-userprofiles.readthedocs.io/en/latest/configuration.html
 
-USERPROFILES_EXTEND_SECURITY_FORMS = False
+USERPROFILES_EXTEND_SECURITY_FORMS = True
 """Set True in order to register user_profile.
 
 This also forces user to add username and fullname
 when register.
 """
 
-USERPROFILES_EMAIL_ENABLED = False
+USERPROFILES_EMAIL_ENABLED = True
 """Exclude the user email in the profile form."""
 
-# Invenio-shibboleth
+USERPROFILES_READ_ONLY = True
+"""Allow users to change profile info (name, email, etc...)."""
+
+# Invenio-saml
 # ===========
-# See https://invenio-shibboleth.readthedocs.io/en/latest/configuration.html
+# See https://invenio-saml.readthedocs.io/en/latest/configuration.html
 
 SSO_SAML_IDPS = {}
 """Configuration of IDPS. Actual values can be find in to invenio.cfg file"""
@@ -153,13 +158,16 @@ SSO_SAML_DEFAULT_SLS_ROUTE = "/sls/<idp>"
 # ===========
 # See https://invenio-accounts.readthedocs.io/en/latest/configuration.html
 
+ACCOUNTS_LOCAL_LOGIN_ENABLED = True
+"""Allow local login."""
+
 SECURITY_CHANGEABLE = False
 """Allow password change by users."""
 
 SECURITY_RECOVERABLE = False
 """Allow password recovery by users."""
 
-SECURITY_REGISTERABLE = False
+SECURITY_REGISTERABLE = True
 """"Allow users to register.
 
 With this variable set to "False" users will not be
@@ -172,6 +180,15 @@ SECURITY_CONFIRMABLE = False
 Instead user will get a welcome email.
 """
 
+# Flask-Security
+# =============
+# See https://pythonhosted.org/Flask-Security/configuration.html
+SECURITY_EMAIL_PLAINTEXT = True
+"""Render email content as plaintext."""
+
+SECURITY_EMAIL_HTML = False
+"""Render email content as HTML."""
+
 
 ACCOUNTS = True
 """Tells if the templates should use the accounts module.
@@ -198,16 +215,9 @@ RECAPTCHA_PRIVATE_KEY = None
 # =======
 # See:
 # https://invenio-records-permissions.readthedocs.io/en/latest/configuration.html
-#
-# Uncomment these to enable overriding Base permissions - (NOT RECOMMANDED)
-# RECORDS_PERMISSIONS_RECORD_POLICY = (
-#    'invenio_config_tugraz.base_permissions.TUGRAZPermissionPolicy'
-# )
-#
 # Uncomment these to enable overriding RDM permissions
-# RDM_RECORDS_BIBLIOGRAPHIC_SERVICE_CONFIG = (
-#     'invenio_config_tugraz.rdm_permissions.TUGRAZBibliographicRecordServiceConfig'
-# )
+# from .rdm_permissions import TUGRAZRDMRecordServiceConfig
+# RDM_RECORDS_BIBLIOGRAPHIC_SERVICE_CONFIG = TUGRAZRDMRecordServiceConfig
 """Access control configuration for records."""
 
 # invenio-rdm-records
@@ -215,9 +225,7 @@ RECAPTCHA_PRIVATE_KEY = None
 # See:
 # https://invenio-rdm-records.readthedocs.io/en/latest/configuration.html
 #
-RDM_RECORDS_USER_FIXTURE_PASSWORDS = {
-    "info@tugraz.at": None
-}
+RDM_RECORDS_USER_FIXTURE_PASSWORDS = {"info@tugraz.at": None}
 """Overrides for the user fixtures' passwords.
 The password set for a user fixture in this dictionary overrides the
 password set in the ``users.yaml`` file. This can be used to set custom
@@ -228,20 +236,22 @@ password from ``users.yaml`` will be used. If that is also absent, a password
 will be generated randomly.
 """
 
-# Custom Access Right
-# RDM_RECORDS_CUSTOM_VOCABULARIES = {
-#     'access_right': {
-#         'path': join(
-#             dirname(abspath(__file__)),
-#             'restrictions', 'access_right', 'access_right_limit.csv'
-#         )
-#     }
-# }
+DATACITE_FORMAT = "{prefix}/{id}"
+"""Customize the generated DOI string."""
+
+DATACITE_DATACENTER_SYMBOL = ""
+""""The OAI-PMH server's metadata format oai_datacite
+that allows you to harvest record from InvenioRDM in DataCite XML needs
+to be configured with your DataCite data center symbol.
+This is only required if you want your records to be harvestable in DataCite XML format.
+"""
 
 # Invenio-app-rdm
 # =========================
 # See https://github.com/inveniosoftware/invenio-app-rdm/blob/master/invenio_app_rdm/config.py
-APP_RDM_DEPOSIT_FORM_DEFAULTS = {}
+APP_RDM_DEPOSIT_FORM_DEFAULTS = {
+    "publisher": "Graz University of Technology",
+}
 """Default values for new records in the deposit UI.
 
 The keys denote the dot-separated path, where in the record's metadata
@@ -250,6 +260,17 @@ If the value is callable, its return value will be used for the field
 (e.g. lambda/function for dynamic calculation of values).
 """
 
+APP_RDM_DEPOSIT_FORM_AUTOCOMPLETE_NAMES = 'off'
+"""Behavior for autocomplete names search field for creators/contributors.
+
+Available options:
+
+- ``search`` (default): Show search field and form always.
+- ``search_only``: Only show search field. Form displayed after selection or
+  explicit "manual" entry.
+- ``off``: Only show person form (no search field).
+"""
+
 SQLALCHEMY_ECHO = False
 """Enable to see all SQL queries."""
 
@@ -311,3 +332,31 @@ reopened regularly.
 
 See https://docs.sqlalchemy.org/en/latest/core/engines.html.
 """
+
+# Redis (cache)
+# ========
+# Cache or Redis configurations
+RATELIMIT_AUTHENTICATED_USER = "25000 per hour;1000 per minute"
+"""Increase defaults for authenticated users."""
+
+RATELIMIT_GUEST_USER = "5000 per hour;500 per minute"
+"""Increase defaults for guest users."""
+
+SESSION_COOKIE_SAMESITE = 'Strict'
+"""Sets cookie with the samesite flag to 'Strict' by default."""
+
+
+# OAI-PMH
+# =======
+# See https://github.com/inveniosoftware/invenio-oaiserver/blob/master/invenio_oaiserver/config.py
+
+OAISERVER_ID_PREFIX = "repository.tugraz.at"
+"""The prefix that will be applied to the generated OAI-PMH ids."""
+
+OAISERVER_ADMIN_EMAILS = [
+    'oai@repository.tugraz.at',
+]
+"""The e-mail addresses of administrators of the repository.
+
+It **must** include one or more instances.
+"""

invenio_config_tugraz/ext.py

@@ -7,6 +7,7 @@
 # details.
 
 """invenio module that adds tugraz configs."""
+from flask import Blueprint
 
 from . import config
 

invenio_config_tugraz/generators.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2020 Mojib Wali.
+# Copyright (C) 2020-2021 Graz University of Technology.
 #
 # invenio-config-tugraz is free software; you can redistribute it and/or
 # modify it under the terms of the MIT License; see LICENSE file for more
@@ -153,7 +153,7 @@ The succinct encoding of the permissions for your instance gives you
 
 from elasticsearch_dsl.query import Q
 from flask import current_app, request
-from invenio_access.permissions import any_user, authenticated_user, superuser_access
+from invenio_access.permissions import any_user, superuser_access
 from invenio_records_permissions.generators import Generator
 
 
@@ -221,20 +221,3 @@ class RecordIp(Generator):
         if user_ip in current_app.config["INVENIO_CONFIG_TUGRAZ_SINGLE_IP"]:
             return True
         return False
-
-
-class AuthenticatedUser(Generator):
-    """Allows authenticated users."""
-
-    def __init__(self):
-        """Constructor."""
-        super(AuthenticatedUser, self).__init__()
-
-    def needs(self, **kwargs):
-        """Enabling Needs."""
-        return [authenticated_user]
-
-    def query_filter(self, **kwargs):
-        """Filters for current identity as super user."""
-        # TODO: Implement with new permissions metadata
-        return []

invenio_config_tugraz/rdm_permissions.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2020 Graz University of Technology.
+# Copyright (C) 2020-2021 Graz University of Technology.
 #
 # invenio-config-tugraz is free software; you can redistribute it and/or
 # modify it under the terms of the MIT License; see LICENSE file for more
@@ -53,59 +53,34 @@ Using Custom Generator for a policy:
 Permissions for Invenio (RDM) Records.
 """
 
-from invenio_rdm_records.services import (
-    BibliographicRecordServiceConfig,
-    RDMRecordPermissionPolicy,
-)
-from invenio_records_permissions.generators import (
-    Admin,
-    AnyUser,
-    RecordOwners,
-    SuperUser,
-)
-
-from .generators import AuthenticatedUser, RecordIp
+# from invenio_rdm_records.services import RDMRecordPermissionPolicy
+# from invenio_rdm_records.services.config import RDMRecordServiceConfig
+# from invenio_rdm_records.services.generators import IfDraft, IfRestricted, RecordOwners
+# from invenio_records_permissions.generators import (
+#     Admin,
+#     AnyUser,
+#     AuthenticatedUser,
+#     Disable,
+#     SuperUser,
+#     SystemProcess,
+# )
 
 
-class TUGRAZPermissionPolicy(RDMRecordPermissionPolicy):
-    """Access control configuration for rdm records.
+# class TUGRAZPermissionPolicy(RDMRecordPermissionPolicy):
+#     """Access control configuration for rdm records.
 
-    This overrides the origin:
-    https://github.com/inveniosoftware/invenio-rdm-records/blob/master/invenio_rdm_records/services/permissions.py.
-
-    """
-
-    # Read access given to:
-    # TODO:
-    # AnyUserIfPublic : grant access if record is public
-    # RecordIp: grant access for single_ip
-    # RecordOwners: owner of records, enable once the deposit is allowed only for loged-in users.
-    # CURRENT:
-    # RecordIp: grant access for single_ip
-    can_read = [RecordIp()]  # RecordOwners()
-
-    # Search access given to:
-    # AnyUser : grant access anyUser
-    # RecordIp: grant access for single_ip
-    can_search = [AnyUser(), RecordIp()]
-
-    # Update access given to record owners.
-    can_update = [RecordOwners()]
-
-    # Delete access given to admins only.
-    can_delete = [Admin()]
-
-    # Create action given to AuthenticatedUser
-    # UI - if user is loged in
-    # API - if user has Access token (Bearer API-TOKEN)
-    can_create = [AuthenticatedUser()]
-
-    # Associated files permissions (which are really bucket permissions)
-    # can_read_files = [AnyUserIfPublic(), RecordOwners()]
-    # can_update_files = [RecordOwners()]
+#     This overrides the origin:
+#     https://github.com/inveniosoftware/invenio-rdm-records/blob/master/invenio_rdm_records/services/permissions.py.
+#     Access control configuration for records.
+#     Note that even if the array is empty, the invenio_access Permission class
+#     always adds the ``superuser-access``, so admins will always be allowed.
+#     - Create action given to everyone for now.
+#     - Read access given to everyone if public record and given to owners
+#       always. (inherited)
+#     - Update access given to record owners. (inherited)
+#     - Delete access given to admins only. (inherited)
+#     """
 
 
-class TUGRAZBibliographicRecordServiceConfig(BibliographicRecordServiceConfig):
-    """Overriding BibliographicRecordServiceConfig."""
-
-    permission_policy_cls = TUGRAZPermissionPolicy
+# class TUGRAZRDMRecordServiceConfig(RDMRecordServiceConfig):
+#     """Overriding BibliographicRecordServiceConfig."""

invenio_config_tugraz/templates/security/email/welcome.txt

@@ -0,0 +1,18 @@
+{{ _('Dear user,') }}
+
+{{ _('Welcome to the Repository of TU Graz!') }}
+
+{{ _('To help you get started, here are some useful links:') }}
+
+    - {{ _('Guidelines:')}} {{ _('Repository Guide')}} ({{ _('how to upload files')}}) (https://{{ config.SITE_HOSTNAME }}{{ url_for('invenio_config_tugraz.guide') }})
+    - {{ _('Search Guide')}} (https://{{ config.SITE_HOSTNAME }}{{url_for('invenio_app_rdm.help_search')}})
+    - {{ _('Terms And Conditions') }} (https://{{ config.SITE_HOSTNAME }}{{ url_for('invenio_config_tugraz.terms') }})
+    - {{ _('Data Protection Rights')}} (https://{{ config.SITE_HOSTNAME }}{{ url_for('invenio_config_tugraz.gdpr') }})
+{% if security.confirmable %}
+{{ _('You can confirm your email through the link below:') }}
+{{ confirmation_link }}">
+{% endif %}
+{{ _('If you require any assistance please do not hesitate to contact us at repository-support@tugraz.at.') }}
+
+{{ _('Best regards,') }}
+{{ _('TU Graz Repository Team') }}

invenio_config_tugraz/translations/de/LC_MESSAGES/messages.po

@@ -1,15 +1,15 @@
 # German translations for invenio-config-tugraz.
-# Copyright (C) 2020 Mojib Wali
+# Copyright (C) 2021 Graz University of Technology
 # This file is distributed under the same license as the
 # invenio-config-tugraz project.
-# FIRST AUTHOR <EMAIL@ADDRESS>, 2020.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2021.
 #
 msgid ""
 msgstr ""
-"Project-Id-Version: invenio-config-tugraz 0.1.5\n"
+"Project-Id-Version: invenio-config-tugraz 0.5.5\n"
 "Report-Msgid-Bugs-To: mojib.wali@tugraz.at\n"
-"POT-Creation-Date: 2020-10-06 09:28+0200\n"
-"PO-Revision-Date: 2020-10-06 09:28+0200\n"
+"POT-Creation-Date: 2021-04-27 15:30+0200\n"
+"PO-Revision-Date: 2021-04-22 11:57+0200\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language: de\n"
 "Language-Team: de <LL@li.org>\n"
@@ -17,9 +17,67 @@ msgstr ""
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=utf-8\n"
 "Content-Transfer-Encoding: 8bit\n"
-"Generated-By: Babel 2.8.0\n"
+"Generated-By: Babel 2.9.0\n"
 
-#: invenio_config_tugraz/config.py:80
-msgid "Welcome to RDM!"
+#: invenio_config_tugraz/config.py:87
+msgid "Welcome to TU Graz Repository!"
+msgstr "Willkommen im TU Graz Repository!"
+
+#: invenio_config_tugraz/templates/security/email/welcome.txt:1
+msgid "Dear user,"
+msgstr "Lieber Nutzer,"
+
+#: invenio_config_tugraz/templates/security/email/welcome.txt:3
+msgid "Welcome to the Repository of TU Graz!"
+msgstr "Willkommen im TU Graz Repository!"
+
+#: invenio_config_tugraz/templates/security/email/welcome.txt:5
+msgid "To help you get started, here are some useful links:"
 msgstr ""
+"Um Ihnen den Einstieg zu erleichtern, finden Sie hier einige nützliche "
+"Links:"
+
+#: invenio_config_tugraz/templates/security/email/welcome.txt:7
+msgid "Guidelines:"
+msgstr "Leitfaden:"
+
+#: invenio_config_tugraz/templates/security/email/welcome.txt:7
+msgid "Repository Guide"
+msgstr "Handbuch"
+
+#: invenio_config_tugraz/templates/security/email/welcome.txt:7
+msgid "how to upload files"
+msgstr "wie man Dateien hochlädt"
+
+#: invenio_config_tugraz/templates/security/email/welcome.txt:8
+msgid "Search Guide"
+msgstr "Suchanleitung"
+
+#: invenio_config_tugraz/templates/security/email/welcome.txt:9
+msgid "Terms And Conditions"
+msgstr "Nutzungsbedingungen"
+
+#: invenio_config_tugraz/templates/security/email/welcome.txt:10
+msgid "Data Protection Rights"
+msgstr "Datenschutzerklärung"
+
+#: invenio_config_tugraz/templates/security/email/welcome.txt:13
+msgid "You can confirm your email through the link below:"
+msgstr "Sie können Ihre E-Mail über den folgenden Link bestätigen:"
+
+#: invenio_config_tugraz/templates/security/email/welcome.txt:16
+msgid ""
+"If you require any assistance please do not hesitate to contact us at "
+"repository-support@tugraz.at."
+msgstr ""
+"Wenn Sie Hilfe benötigen, zögern Sie bitte nicht, uns unter repository-"
+"support@tugraz.at zu kontaktieren."
+
+#: invenio_config_tugraz/templates/security/email/welcome.txt:18
+msgid "Best regards,"
+msgstr "Mit freundlichen Grüßen,"
+
+#: invenio_config_tugraz/templates/security/email/welcome.txt:19
+msgid "TU Graz Repository Team"
+msgstr "TU Graz Repository Team"
 

invenio_config_tugraz/translations/messages.pot

@@ -1,24 +1,78 @@
 # Translations template for invenio-config-tugraz.
-# Copyright (C) 2020 Mojib Wali
+# Copyright (C) 2021 Graz University of Technology
 # This file is distributed under the same license as the
 # invenio-config-tugraz project.
-# FIRST AUTHOR <EMAIL@ADDRESS>, 2020.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2021.
 #
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: invenio-config-tugraz 0.1.5\n"
+"Project-Id-Version: invenio-config-tugraz 0.5.5\n"
 "Report-Msgid-Bugs-To: mojib.wali@tugraz.at\n"
-"POT-Creation-Date: 2020-10-06 09:28+0200\n"
+"POT-Creation-Date: 2021-04-27 15:30+0200\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=utf-8\n"
 "Content-Transfer-Encoding: 8bit\n"
-"Generated-By: Babel 2.8.0\n"
+"Generated-By: Babel 2.9.0\n"
 
-#: invenio_config_tugraz/config.py:80
-msgid "Welcome to RDM!"
+#: invenio_config_tugraz/config.py:87
+msgid "Welcome to TU Graz Repository!"
+msgstr ""
+
+#: invenio_config_tugraz/templates/security/email/welcome.txt:1
+msgid "Dear user,"
+msgstr ""
+
+#: invenio_config_tugraz/templates/security/email/welcome.txt:3
+msgid "Welcome to the Repository of TU Graz!"
+msgstr ""
+
+#: invenio_config_tugraz/templates/security/email/welcome.txt:5
+msgid "To help you get started, here are some useful links:"
+msgstr ""
+
+#: invenio_config_tugraz/templates/security/email/welcome.txt:7
+msgid "Guidelines:"
+msgstr ""
+
+#: invenio_config_tugraz/templates/security/email/welcome.txt:7
+msgid "Repository Guide"
+msgstr ""
+
+#: invenio_config_tugraz/templates/security/email/welcome.txt:7
+msgid "how to upload files"
+msgstr ""
+
+#: invenio_config_tugraz/templates/security/email/welcome.txt:8
+msgid "Search Guide"
+msgstr ""
+
+#: invenio_config_tugraz/templates/security/email/welcome.txt:9
+msgid "Terms And Conditions"
+msgstr ""
+
+#: invenio_config_tugraz/templates/security/email/welcome.txt:10
+msgid "Data Protection Rights"
+msgstr ""
+
+#: invenio_config_tugraz/templates/security/email/welcome.txt:13
+msgid "You can confirm your email through the link below:"
+msgstr ""
+
+#: invenio_config_tugraz/templates/security/email/welcome.txt:16
+msgid ""
+"If you require any assistance please do not hesitate to contact us at "
+"repository-support@tugraz.at."
+msgstr ""
+
+#: invenio_config_tugraz/templates/security/email/welcome.txt:18
+msgid "Best regards,"
+msgstr ""
+
+#: invenio_config_tugraz/templates/security/email/welcome.txt:19
+msgid "TU Graz Repository Team"
 msgstr ""
 

invenio_config_tugraz/version.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2020 Mojib Wali.
+# Copyright (C) 2020-2022 Graz University of Technology.
 #
 # invenio-config-tugraz is free software; you can redistribute it and/or
 # modify it under the terms of the MIT License; see LICENSE file for more
@@ -12,4 +12,4 @@ This file is imported by ``invenio_config_tugraz.__init__``,
 and parsed by ``setup.py``.
 """
 
-__version__ = "0.5.2"
+__version__ = "0.8.4"

invenio_config_tugraz/views.py

@@ -0,0 +1,73 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2020-2021 Graz University of Technology.
+#
+# invenio-config-tugraz 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 module for TUGRAZ config."""
+
+from os import environ
+from typing import Dict
+
+from elasticsearch_dsl.utils import AttrDict
+from flask import Blueprint, current_app, redirect, url_for
+from flask_babelex import get_locale
+
+
+def ui_blueprint(app):
+    """Blueprint for the routes and resources provided by invenio-config-tugraz."""
+    routes = app.config.get("CONFIG_TUGRAZ_ROUTES")
+
+    blueprint = Blueprint(
+        "invenio_config_tugraz",
+        __name__,
+        template_folder="templates",
+        static_folder="static",
+    )
+
+    blueprint.add_url_rule(routes["guide"], view_func=guide)
+    blueprint.add_url_rule(routes["terms"], view_func=terms)
+    blueprint.add_url_rule(routes["gdpr"], view_func=gdpr)
+
+    @blueprint.before_app_first_request
+    def rank_higher():
+        """Rank this modules blueprint higher than blueprint of security module.
+
+        Needed in order to overwrite email templates.
+
+        Since the blueprints are in a dict and the order of insertion is
+         retained, popping and reinserting all items (except ours), ensures
+         our blueprint will be in front.
+        """
+        bps = current_app.blueprints
+        for blueprint_name in list(bps.keys()):
+            if blueprint_name != "invenio_config_tugraz":
+                bps.update({blueprint_name: bps.pop(blueprint_name)})
+
+    return blueprint
+
+
+def guide():
+    """TUGraz_Repository_Guide."""
+    locale = get_locale()
+    return redirect(url_for('static',
+                            filename=f'documents/TUGraz_Repository_Guide_02_{locale}.pdf',
+                            _external=True))
+
+
+def terms():
+    """Terms_And_Conditions."""
+    locale = get_locale()
+    return redirect(url_for('static',
+                            filename=f'documents/TUGraz_Repository_Terms_And_Conditions_{locale}.pdf',
+                            _external=True))
+
+
+def gdpr():
+    """General_Data_Protection_Rights."""
+    locale = get_locale()
+    return redirect(url_for('static',
+                            filename=f'documents/TUGraz_Repository_General_Data_Protection_Rights_{locale}.pdf',
+                            _external=True))

run-tests.sh

@@ -25,9 +25,9 @@ trap cleanup EXIT
 
 
 python -m check_manifest --ignore ".*-requirements.txt"
-python -m sphinx.cmd.build -qnNW docs docs/_build/html
+python -m sphinx.cmd.build -qnN docs docs/_build/html
 eval "$(docker-services-cli up --db ${DB:-postgresql} --search ${SEARCH:-elasticsearch} --cache ${CACHE:-redis} --env)"
 python -m pytest
 tests_exit_code=$?
-python -m sphinx.cmd.build -qnNW -b doctest docs docs/_build/doctest
+python -m sphinx.cmd.build -qnN -b doctest docs docs/_build/doctest
 exit "$tests_exit_code"

setup.cfg

@@ -24,7 +24,7 @@ add_ignore = D401
 directory = invenio_config_tugraz/translations/
 
 [extract_messages]
-copyright_holder = Mojib Wali
+copyright_holder = Graz University of Technology
 msgid_bugs_address = mojib.wali@tugraz.at
 mapping-file = babel.ini
 output-file = invenio_config_tugraz/translations/messages.pot

setup.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2020 Mojib Wali.
+# Copyright (C) 2020-2021 Graz University of Technology.
 #
 # invenio-config-tugraz is free software; you can redistribute it and/or
 # modify it under the terms of the MIT License; see LICENSE file for more
@@ -16,33 +16,43 @@ readme = open("README.rst").read()
 history = open("CHANGES.rst").read()
 
 tests_require = [
-    "pytest-invenio>=1.4.0",
-    "SQLAlchemy-Utils>=0.33.1,<0.36",
-    "invenio-rdm-records~=0.20.8",
-    "invenio-search[elasticsearch7]>=1.4.0",
-    "psycopg2-binary>=2.8.6",
+    "pytest-invenio>=1.4.1",
 ]
 
+# Should follow invenio-app-rdm
+invenio_search_version = ">=1.4.2,<1.5.0"
+invenio_db_version = ">=1.0.11,<1.1.0"
+
 extras_require = {
+    "elasticsearch7": [f"invenio-search[elasticsearch7]{invenio_search_version}"],
+    "mysql": [f"invenio-db[mysql,versioning]{invenio_db_version}"],
+    "postgresql": [f"invenio-db[postgresql,versioning]{invenio_db_version}"],
+    "sqlite": [f"invenio-db[versioning]{invenio_db_version}"],
     "docs": [
-        "Sphinx>=3",
+        "Sphinx==4.2.0",
     ],
     "tests": tests_require,
 }
 
 extras_require["all"] = []
-for reqs in extras_require.values():
+for name, reqs in extras_require.items():
+    if name[0] == ":" or name in (
+        "elasticsearch7",
+        "mysql",
+        "postgresql",
+        "sqlite",
+    ):
+        continue
     extras_require["all"].extend(reqs)
 
 setup_requires = [
-    "Babel>=1.3",
-    "pytest-runner>=3.0.0,<5",
+    "Babel>=2.8,<3",
 ]
 
 install_requires = [
-    "Flask-BabelEx>=0.9.4",
-    "elasticsearch_dsl>=7.2.1",
-    "sqlalchemy-continuum>=1.3.11",
+    # keep this in sync with invenioRDM release
+    "invenio-rdm-records>=0.34.5,<0.35.0",
+    "invenio-cache>=1.1.0"
 ]
 
 packages = find_packages()
@@ -72,6 +82,9 @@ setup(
         "invenio_base.apps": [
             "invenio_config_tugraz = invenio_config_tugraz:InvenioConfigTugraz",
         ],
+        "invenio_base.blueprints": [
+            "invenio_config_tugraz = invenio_config_tugraz.views:ui_blueprint",
+        ],
         "invenio_i18n.translations": [
             "messages = invenio_config_tugraz",
         ],
@@ -95,6 +108,7 @@ setup(
         "Programming Language :: Python :: 3.6",
         "Programming Language :: Python :: 3.7",
         "Programming Language :: Python :: 3.8",
-        "Development Status :: 3 - Alpha",
+        "Programming Language :: Python :: 3.9",
+        "Development Status :: 5 - Production/Stable",
     ],
 )

tests/test_generators.py

@@ -8,9 +8,9 @@
 
 """Test Generators."""
 
-from invenio_access.permissions import any_user, authenticated_user
+from invenio_access.permissions import any_user
 
-from invenio_config_tugraz.generators import AuthenticatedUser, RecordIp
+from invenio_config_tugraz.generators import RecordIp
 
 
 def test_recordip(create_app, open_record, singleip_record):
@@ -27,12 +27,3 @@ def test_recordip(create_app, open_record, singleip_record):
     assert generator.excludes(record=open_record) == []
 
     assert generator.query_filter().to_dict() == {'bool': {'must_not': [{'match': {'access.access_right': 'singleip'}}]}}
-
-
-def test_authenticateduser():
-    """Test Generator AuthenticatedUser."""
-    generator = AuthenticatedUser()
-
-    assert generator.needs() == [authenticated_user]
-    assert generator.excludes() == []
-    assert generator.query_filter() == []