invenio.cfg

"""
InvenioRDM settings for Zenodo project.

This file was automatically generated by 'invenio-cli init'.

For the full list of settings and their values, see
https://invenio-app-rdm.readthedocs.io/en/latest/configuration.html
and the config.py files of your installed modules
https://invenio.readthedocs.io/en/latest/general/bundles.html

Only configuration created via cookiecutter or very likely to be edited
by installer are included here.
"""

import os
import socket
from celery.schedules import crontab
from copy import deepcopy

from datetime import timedelta
from invenio_administration.permissions import administration_permission
from invenio_app_rdm.config import (
    CELERY_BEAT_SCHEDULE,
    APP_RDM_ROUTES,
    APP_RDM_DEPOSIT_FORM_DEFAULTS as DEPOSIT_FORM_DEFAULTS,
)
from invenio_i18n import lazy_gettext as _
from invenio_oauthclient.contrib.keycloak import KeycloakSettingsHelper
from invenio_oauthclient.contrib.orcid import (
    REMOTE_MEMBER_APP,
    REMOTE_SANDBOX_MEMBER_APP,
)
from invenio_github.oauth.remote_app import github_app as github_remote_app
from invenio_records_resources.services.records.queryparser import FieldValueMapper
from invenio_rdm_records.config import (
    RDM_SORT_OPTIONS as BASE_SORT_OPTIONS,
    RDM_FACETS,
)
from invenio_rdm_records.contrib.journal import JOURNAL_SORT_OPTIONS
from invenio_rdm_records.contrib.meeting import MEETING_SORT_OPTIONS
from invenio_records_resources.services.records.queryparser import (
    QueryParser,
    SearchFieldTransformer,
)
from invenio_vocabularies.services.custom_fields import (
    SUBJECT_FIELDS_UI,
    SUBJECT_FIELDS,
)
from invenio_rdm_records.services.components.signal import SignalComponent
from invenio_rdm_records.services.components import DefaultRecordsComponents
from invenio_oauthclient.views.client import auto_redirect_login

from invenio_communities.communities.services import facets as community_facets
from zenodo_rdm.custom_fields import (
    CUSTOM_FIELDS_UI,
    CUSTOM_FIELDS,
    CUSTOM_FIELDS_FACETS,
    NAMESPACES,
)
from zenodo_rdm.views import frontpage_view_function
from zenodo_rdm.permissions import (
    ZenodoCommunityPermissionPolicy,
    ZenodoRDMRecordPermissionPolicy,
)
from zenodo_rdm.api import ZenodoRDMRecord, ZenodoRDMDraft
from zenodo_rdm.files import storage_factory
from zenodo_rdm.legacy.resources import record_serializers
from zenodo_rdm.tokens import RATSubjectSchema
from zenodo_rdm import providers as zenodo_providers
from zenodo_rdm import facets as zenodo_community_facets
from zenodo_rdm.metrics.config import METRICS_CACHE_UPDATE_INTERVAL
from zenodo_rdm.openaire.records.components import OpenAIREComponent
from zenodo_rdm.github.schemas import CitationMetadataSchema
from zenodo_rdm.queryparser import word_doi, word_communities
from zenodo_rdm.subcommunities import ZenodoSubCommunityRequest, ZenodoSubcommunityRequestSchema

try:
    from invenio_rdm_records.resources.iiif import IIPServerProxy
except ImportError:
    IIPServerProxy = None

# Flask
# =====
# See https://flask.palletsprojects.com/en/1.1.x/config/

SECRET_KEY = "CHANGE_ME"
# Since HAProxy and Nginx route all requests no matter the host header
# provided, the allowed hosts variable is set to localhost. In production it
# should be set to the correct host and it is strongly recommended to only
# route correct hosts to the application.
APP_ALLOWED_HOSTS = ["0.0.0.0", "localhost", "127.0.0.1"]

APP_RDM_ROUTES["index"] = ("/", frontpage_view_function)

ZENODO_ENV = os.environ.get("ZENODO_ENV", "production").lower()


# Flask-SQLAlchemy
# ================
# See https://flask-sqlalchemy.palletsprojects.com/en/2.x/config/
def _parse_env_bool(var_name, default=None):
    if str(os.environ.get(var_name)).lower() == "true":
        return True
    elif str(os.environ.get(var_name)).lower() == "false":
        return False
    return default


SQLALCHEMY_ENGINE_OPTIONS = {
    "connect_args": {"application_name": socket.gethostname()},
}
if _parse_env_bool("INVENIO_PGBOUNCER_ENABLED", False):
    from sqlalchemy.pool import NullPool

    SQLALCHEMY_ENGINE_OPTIONS["poolclass"] = NullPool
else:
    SQLALCHEMY_DATABASE_URI = "postgresql+psycopg2://zenodo:zenodo@localhost/zenodo"

# Invenio-App
# ===========
# See https://invenio-app.readthedocs.io/en/latest/configuration.html

APP_DEFAULT_SECURE_HEADERS = {
    "content_security_policy": {
        "default-src": [
            "'self'",
            "fonts.googleapis.com",  # for fonts
            "*.gstatic.com",  # for fonts
            "data:",  # for fonts
            "'unsafe-inline'",  # for inline scripts and styles
            "'unsafe-eval'",  # for webpack build
            "blob:",  # for pdf preview
            "zenodo-broker.web.cern.ch",
            "zenodo-broker-qa.web.cern.ch",
            # Profiler reprot viewer dependencies
            "maxcdn.bootstrapcdn.com",
            "cdnjs.cloudflare.com",
            "ajax.googleapis.com",
            # For CERN Matomo
            "webanalytics.web.cern.ch",
        ],
    },
    "content_security_policy_report_only": False,
    "content_security_policy_report_uri": None,
    "force_file_save": False,
    "force_https": True,
    "force_https_permanent": False,
    "frame_options": "sameorigin",
    "frame_options_allow_from": None,
    "session_cookie_http_only": True,
    "session_cookie_secure": True,
    "strict_transport_security": True,
    "strict_transport_security_include_subdomains": True,
    "strict_transport_security_max_age": 31556926,  # One year in seconds
    "strict_transport_security_preload": False,
}

# Celery
# ======

# Remove file integrity checks
CELERY_BEAT_SCHEDULE.pop("file-integrity-report", None)

CELERY_BEAT_SCHEDULE = {
    **CELERY_BEAT_SCHEDULE,
    "metrics-calculate": {
        "task": "zenodo_rdm.metrics.tasks.calculate_metrics",
        "kwargs": {
            "metric_id": "openaire-nexus",
        },
        "schedule": METRICS_CACHE_UPDATE_INTERVAL,
    },
    "sitemap-updater": {
        "task": "zenodo_rdm.sitemap.tasks.update_sitemap_cache",
        "schedule": timedelta(hours=24),
    },
    "openaire-failures-retry": {
        "task": "zenodo_rdm.openaire.tasks.retry_openaire_failures",
        "schedule": crontab(minute=0, hour=9),  # Every day at 09:00 UTC
    },
    "stats-export": {
        "task": "zenodo_rdm.stats.tasks.export_stats",
        "schedule": crontab(minute=0, hour=4),
        "kwargs": {
            "retry": True,
        },
    },
    "cleanup-swh-depositions": {
        "task": "invenio_swh.tasks.cleanup_depositions",
        "schedule": crontab(minute=0, hour=6), # Every day at 06:00 UTC
    },
    'hard-file-checks': {
        'task': 'invenio_files_rest.tasks.schedule_checksum_verification',
        'schedule': timedelta(hours=1),
        'kwargs': {
            'batch_interval': {'hours': 1},
            # Manually check and calculate checksums of files biannually
            'frequency': {'days': 180},
            # Split batches based on total files size
            'max_size': 0,
            # Query taking into account only files with URI prefixes defined by
            # the FILES_REST_CHECKSUM_VERIFICATION_URI_PREFIXES config variable
            'files_query':
                'invenio_app_rdm.utils.files.checksum_verification_files_query',
            # Actual checksum calculation, instead of relying on a EOS query
            'checksum_kwargs': {'use_default_impl': True},
        },
    },
}

# The URI prefix for files checksum files query
FILES_REST_CHECKSUM_VERIFICATION_URI_PREFIXES = { "root://eosmedia.cern.ch//eos/media/zenodo/prod" }

CELERY_TASK_ROUTES = {
    # Low
    "invenio_files_rest.tasks.verify_checksum": {"queue": "low"},
    "invenio_rdm_records.services.iiif.tasks.generate_tiles": {"queue": "low"},
    "invenio_records_resources.tasks.extract_file_metadata": {"queue": "low"},
    "zenodo_rdm.openaire.tasks.openaire_delete": {"queue": "low"},
    # Spam
    "invenio_users_resources.services.users.tasks.execute_moderation_actions": {"queue": "spam"},
    "invenio_rdm_records.requests.user_moderation.tasks.delete_record": {"queue": "spam"},
    "invenio_rdm_records.requests.user_moderation.tasks.restore_record": {"queue": "spam"},
    "invenio_communities.requests.user_moderation.tasks.delete_community": {"queue": "spam"},
    "invenio_communities.requests.user_moderation.tasks.restore_community": {"queue": "spam"},
}

# Flask-Babel
# ===========
# See https://flask-babel.tkte.ch/#configuration

# Default locale (language)
BABEL_DEFAULT_LOCALE = "en"
# Default time zone
BABEL_DEFAULT_TIMEZONE = "Europe/Zurich"


# Invenio-I18N
# ============
# See https://invenio-i18n.readthedocs.io/en/latest/configuration.html

BABEL_DEFAULT_LOCALE = "en"
# Other supported languages (do not include BABEL_DEFAULT_LOCALE in list).
I18N_LANGUAGES = []


# Invenio-Theme
# =============
# See https://invenio-theme.readthedocs.io/en/latest/configuration.html

# Frontpage title
THEME_FRONTPAGE_TITLE = "Zenodo"
# Header logo
THEME_LOGO = "images/invenio-rdm.svg"
THEME_SITENAME = "Zenodo"
# Templates
THEME_FRONTPAGE_TEMPLATE = "zenodo_rdm/frontpage.html"
THEME_FOOTER_TEMPLATE = "zenodo_rdm/footer.html"

# Site tracking code template for matomo analytics
# Enable the below on the dedicated environment
# THEME_TRACKINGCODE_TEMPLATE = "zenodo_rdm/trackingcode/trackingcode-qa.html"

COOKIE_POLICY_URL = "https://about.zenodo.org/cookie-policy"

# Invenio-App-RDM
# ===============
# See https://invenio-app-rdm.readthedocs.io/en/latest/configuration.html

# Set default file quuota to 50GB
APP_RDM_DEPOSIT_FORM_QUOTA = {
    "maxFiles": 100,
    "maxStorage": 5 * 10**10,
}

# Instance's theme entrypoint file. Path relative to the ``assets/`` folder.
INSTANCE_THEME_FILE = "./less/theme.less"

# For invenio-vocabularies
# Silent warnings
JSONSCHEMAS_HOST = "unused"


# Invenio-RDM-Records
# ===================
# See https://github.com/inveniosoftware/invenio-rdm-records/blob/master/invenio_rdm_records/config.py

DATACITE_ENABLED = True
DATACITE_PREFIX = "10.5281"
DATACITE_FORMAT = "{prefix}/zenodo.{id}"
DATACITE_TEST_MODE = True
DATACITE_DATACENTER_SYMBOL = "CERN.ZENODO"
OAISERVER_ID_PREFIX = "zenodo.org"
OAISERVER_ADMIN_EMAILS = ["info@zenodo.org"]
RDM_ALLOW_METADATA_ONLY_RECORDS = False
RDM_ALLOW_RESTRICTED_RECORDS = False
RDM_ALLOW_EXTERNAL_DOI_VERSIONING = False
RDM_PERMISSION_POLICY = ZenodoRDMRecordPermissionPolicy

# Override record and draft API classes
RDM_RECORD_CLS = ZenodoRDMRecord
RDM_DRAFT_CLS = ZenodoRDMDraft
RDM_RECORDS_SERIALIZERS = record_serializers

RDM_PARENT_PERSISTENT_IDENTIFIER_PROVIDERS = (
    zenodo_providers.RDM_PARENT_PERSISTENT_IDENTIFIER_PROVIDERS
)
RDM_PARENT_PERSISTENT_IDENTIFIERS = zenodo_providers.RDM_PARENT_PERSISTENT_IDENTIFIERS


RDM_RESOURCE_ACCESS_TOKENS_ENABLED = True
RDM_RESOURCE_ACCESS_TOKEN_REQUEST_ARG = "resource-token"
RDM_RESOURCE_ACCESS_TOKENS_SUBJECT_SCHEMA = RATSubjectSchema

# Invenio-Search
# ==============
SEARCH_INDEX_PREFIX = "zenodo-"

INDEXER_MQ_PUBLISH_KWARGS = {
    "retry": True,
    "retry_policy": {  # Setting for maximum waiting time of ~10min:
        "interval_start": 0,  # First retry immediately,
        "interval_step": 2,  # then increase by 2s for every retry.
        "interval_max": 30,  # but don't exceed 30s between retries.
        "max_retries": 20,  # give up after 30 tries.
    },
}

ZENODO_LEGACY_SEARCH_MAP = {
    "resource_type.subtype": "metadata.resource_type.props.subtype",
    "resource_type.type": "metadata.resource_type.props.type",
    "access_right": "access.status",
    "alternate.identifier": "metadata.identifiers.identifier",
    "alternate.scheme": "metadata.identifiers.scheme",
    "communities": FieldValueMapper("parent.communities.ids", word=word_communities),
    "conceptdoi": FieldValueMapper("parent.pids.doi.identifier", word=word_doi),
    "conceptrecid": "parent.id",
    "created": "created",
    # Creators
    "creators.affiliation": "metadata.creators.affiliations.name",
    "creators.name": "metadata.creators.person_or_org.name",
    "creators.orcid": "metadata.creators.person_or_org.identifiers.identifier",
    "creators.gnd": "metadata.creators.person_or_org.identifiers.identifier",
    # Contributors
    "contributors.affiliation": "metadata.contributors.affiliations.name",
    "contributors.name": "metadata.contributors.person_or_org.name",
    "contributors.orcid": "metadata.contributors.person_or_org.identifiers.identifier",
    "contributors.gnd": "metadata.contributors.person_or_org.identifiers.identifier",
    "contributors.type": "metadata.contributors.role.id",
    "description": "metadata.description",
    "doi": FieldValueMapper("pids.doi.identifier", word=word_doi),
    "embargodate": "access.embargo.until",
    "grants.code": "metadata.funding.award.number",
    "grants.acronym": "metadata.funding.award.acronym",
    "grants.program": "metadata.funding.award.program",
    "grants.title": "metadata.funding.award.title.en",
    # owner
    "owners": "parent.access.owned_by.user",
    # TODO: Add `grants.funder.*` mappings
    "grants.funder.doi": FieldValueMapper(
        "metadata.funding.funder.identifiers.identifier", word=word_doi
    ),
    "grants.funder.name": "metadata.funding.funder.name",
    "keywords": "metadata.subjects.subject",
    "language": "metadata.languages.id",
    "license.identifier": "metadata.rights.id",
    "license.url": "metadata.rights.props.url",
    "publicationdate": "metadata.publication_date",
    "publication_date": "metadata.publication_date",
    "recid": "id",
    "related.identifier": "metadata.related_identifiers.identifier",
    "related.scheme": "metadata.related_identifiers.scheme",
    "related.relation": "metadata.related_identifiers.relation_type.id",
    "title": "metadata.title",
    "type": "metadata.resource_type.props.type",
    "version": "versions.index",
    # journal custom field mappings
    "journal.title": "custom_fields.journal\:journal.title",
    "journal.pages": "custom_fields.journal\:journal.pages",
    "journal.volume": "custom_fields.journal\:journal.volume",
    "journal.issn": "custom_fields.journal\:journal.issn",
    # meeting custom field mappings
    "meeting.title": "custom_fields.meeting\:meeting.title",
    "meeting.acronym": "custom_fields.meeting\:meeting.acronym",
    "meeting.dates": "custom_fields.meeting\:meeting.dates",
    "meeting.place": "custom_fields.meeting\:meeting.place",
    "meeting.url": "custom_fields.meeting\:meeting.url",
    "meeting.session": "custom_fields.meeting\:meeting.session",
    "meeting.session_part": "custom_fields.meeting\:meeting.session_part",
    "part_of.title": "custom_fields.imprint\:imprint.title",
    "part_of.pages": "custom_fields.imprint\:imprint.pages",
    # imprint custom field mappings
    "imprint.isbn": "custom_fields.imprint\:imprint.isbn",
    "imprint.place": "custom_fields.imprint\:imprint.place",
    "imprint.publisher": "custom_fields.imprint\:imprint.publisher",
    # notes custom field mappings
    "notes": "metadata.additional_descriptions.description",
    # thesis custom field mappings
    "thesis.university": "custom_fields.thesis\:university",
    # Files
    "filecount": "files.count",
    "filename": "files.entries.key",
    "filetype": "files.types",
    "filesize": "files.totalbytes",
    "size": "files.totalbytes",
    "_files.checksum": "files.entries.checksum",
    "_files.size": "files.entries.size",
    # New mappings
    "user": "parent.access.owned_by.user",
}

LEGACY_SORT_OPTIONS = {
    "-bestmatch": dict(
        title=_("Best match [Least relevant]"),
        fields=["-_score"],
    ),
    "publication_date": {
        "title": _("Publication date [Newest]"),
        "fields": ["-metadata.publication_date", "-created"],
    },
    "-publication_date": {
        "title": _("Publication date [Oldest]"),
        "fields": ["metadata.publication_date", "created"],
    },
    "mostrecent": {
        "title": _("Newest"),
        "fields": ["-created"],
    },
    "-mostrecent": {
        "title": _("Oldest"),
        "fields": ["created"],
    },
    "-mostviewed": dict(
        title=_("Most viewed [Least views first]"),
        fields=["stats.all_versions.unique_views"],
    ),
    "journal": {
        "title": _("Journal [Newest]"),
        "fields": [
            "-metadata.publication_date",
            "custom_fields.journal:journal.volume",
            "custom_fields.journal:journal.issue",
            "custom_fields.journal:journal.pages",
        ],
    },
    "-journal": {
        "title": _("Journal [Oldest]"),
        "fields": [
            "metadata.publication_date",
            "custom_fields.journal:journal.volume",
            "custom_fields.journal:journal.issue",
            "custom_fields.journal:journal.pages",
        ],
    },
    "conference_session": {
        "title": _("Conference session [Newest]"),
        "fields": [
            "-custom_fields.meeting:meeting.session",
            "-custom_fields.meeting:meeting.session_part",
        ],
    },
    "-conference_session": {
        "title": _("Conference session [Oldest]"),
        "fields": [
            "custom_fields.meeting:meeting.session",
            "custom_fields.meeting:meeting.session_part",
        ],
    },
    "-version": dict(
        title=_("Version [Oldest]"),
        fields=["versions.index"],
    ),
}

RDM_SORT_OPTIONS = {
    # base brings bestmatch, newest, oldest, updated-desc, updated-asc, versions
    # FIXME: there is no conceptrecid for versions, use parent id?
    **BASE_SORT_OPTIONS,
    "publication-desc": {
        "title": _("Published [Newest]"),
        "fields": ["-metadata.publication_date", "-created"],
    },
    "publication-asc": {
        "title": ("Published [Oldest]"),
        "fields": ["metadata.publication_date", "created"],
    },
    **MEETING_SORT_OPTIONS,  # conference asc and desc
    **JOURNAL_SORT_OPTIONS,  # journal asc and desc
    **LEGACY_SORT_OPTIONS,  # legacy sort options available only in REST API
}

RDM_SEARCH = {
    "facets": ["access_status", "resource_type", "subject", "file_type"]
    + list(CUSTOM_FIELDS_FACETS.keys()),
    "sort": [
        "mostviewed",
        "bestmatch",
        "newest",
        "oldest",
        "version",
        "publication-desc",
        "publication-asc",
        "conference-desc",
        "journal-desc",
    ],
    "query_parser_cls": QueryParser.factory(
        mapping=ZENODO_LEGACY_SEARCH_MAP,
        tree_transformer_cls=SearchFieldTransformer,
    ),
    "sort_default_no_query": "newest",
    "sort_default": "bestmatch",
}

COMMUNITIES_RECORDS_SEARCH = deepcopy(RDM_SEARCH)
"""Communities record search config is the same as the main record search."""

ZENODO_COMMUNITIES_FACETS = {
    "type": {
        "facet": community_facets.type,
        "ui": {
            "field": "type",
        },
    },
    "funder": {
        "facet": zenodo_community_facets.funder,
        "ui": {
            "field": "metadata.funding.funder",
        },
    },
    "organization": {
        "facet": zenodo_community_facets.organization,
        "ui": {
            "field": "metadata.organizations",
        },
    },
}

COMMUNITIES_FACETS = {
    **ZENODO_COMMUNITIES_FACETS,
}

COMMUNITIES_SEARCH = {
    "facets": ["type", "funder", "organization"],
    "sort": ["bestmatch", "newest", "oldest"],
}

RDM_SEARCH_USER_COMMUNITIES = {
    "facets": ["type", "funder", "organization"],
    "sort": ["bestmatch", "newest", "oldest"],
}
RDM_FACETS = {**RDM_FACETS, **CUSTOM_FIELDS_FACETS}

RDM_SEARCH_DRAFTS = {
    **RDM_SEARCH,
    "sort_default_no_query": "newest",
    "sort_default": "bestmatch",
}

# User moderation feature enabled
RDM_USER_MODERATION_ENABLED = True

# Invenio-Accounts
# ================
# See https://github.com/inveniosoftware/invenio-accounts/blob/master/invenio_accounts/config.py

ACCOUNTS_LOCAL_LOGIN_ENABLED = True  # enable local login
ACCOUNTS_DEFAULT_USER_VISIBILITY = "public"
SECURITY_REGISTERABLE = True  # local login: allow users to register
SECURITY_RECOVERABLE = True  # local login: allow users to reset the password
SECURITY_CHANGEABLE = True  # local login: allow users to change psw
SECURITY_CONFIRMABLE = True  # local login: users can confirm e-mail address
SECURITY_LOGIN_WITHOUT_CONFIRMATION = (
    False  # don't allow users to login without confirming
)
SECURITY_EMAIL_SUBJECT_REGISTER = "Welcome to Zenodo!"
PERMANENT_SESSION_LIFETIME = timedelta(days=10)

# Invenio-OAuthclient
# ===================
_openaire_helper = KeycloakSettingsHelper(
    title="OpenAIRE",
    description="Open Science Services.",
    base_url="https://aai.openaire.eu"
    if ZENODO_ENV == "production"
    else "https://beta.aai.openaire.eu",
    realm="openaire",
    scopes="openid profile email eduperson_entitlement orcid",
    app_key="OPENAIRE_APP_CREDENTIALS",
    signup_options={
        "auto_confirm": False,
        "send_register_msg": True,
    },
)


OAUTHCLIENT_OPENAIRE_AAI_VERIFY_EXP = True
OAUTHCLIENT_OPENAIRE_AAI_VERIFY_AUD = True
OAUTHCLIENT_OPENAIRE_AAI_USER_INFO_FROM_ENDPOINT = True
OAUTHCLIENT_OPENAIRE_AAI_REALM_URL = "https://aai.openaire.eu/auth/realms/openaire"
OAUTHCLIENT_OPENAIRE_AAI_USER_INFO_URL = (
    "https://aai.openaire.eu/auth/realms/openaire/protocol/openid-connect/userinfo"
)


if ZENODO_ENV == "production":
    OAUTHCLIENT_REMOTE_APPS = {
        "orcid": REMOTE_MEMBER_APP,
        "github": github_remote_app,
        "openaire_aai": _openaire_helper.remote_app,
    }
    OAUTHCLIENT_REST_REMOTE_APPS = {
        "github": github_remote_app,
    }
else:
    OAUTHCLIENT_REMOTE_APPS = {
        "orcid": REMOTE_SANDBOX_MEMBER_APP,
        "github": github_remote_app,
        "openaire_aai": _openaire_helper.remote_app,
    }
    OAUTHCLIENT_REST_REMOTE_APPS = {
        "github": github_remote_app,
    }


# secrets will be injected on deployment
ORCID_APP_CREDENTIALS = {
    "consumer_key": "CHANGE ME",
    "consumer_secret": "CHANGE ME",
}
OPENAIRE_APP_CREDENTIALS = {
    "consumer_key": "CHANGE ME",
    "consumer_secret": "CHANGE ME",
}
GITHUB_APP_CREDENTIALS = {
    "consumer_key": "CHANGE ME",
    "consumer_secret": "CHANGE ME",
}

# OpenAIRE API configs
OPENAIRE_API_CREDENTIALS = {"username": "CHANGE ME", "password": "CHANGE ME"}
"""API credentials."""


ACCOUNTS_LOGIN_VIEW_FUNCTION = (
    auto_redirect_login  # autoredirect to external login if enabled
)
OAUTHCLIENT_AUTO_REDIRECT_TO_EXTERNAL_LOGIN = False  # autoredirect to external login

# Invenio-GitHub
# ==============
GITHUB_INTEGRATION_ENABLED = True
GITHUB_WEBHOOK_RECEIVER_ID = "github"
GITHUB_WEBHOOK_RECEIVER_URL = "CHANGE ME"
GITHUB_SHARED_SECRET = "CHANGE ME"
GITHUB_INSECURE_SSL = False
GITHUB_RELEASE_CLASS = "zenodo_rdm.github.release:ZenodoGithubRelease"
GITHUB_CITATION_METADATA_SCHEMA = CitationMetadataSchema
GITHUB_CITATION_FILE = "CITATION.cff"


# Invenio-UserProfiles
# --------------------
USERPROFILES_READ_ONLY = (
    False  #  allow users to change profile info (name, email, etc...)
)

THEME_SHOW_FRONTPAGE_INTRO_SECTION = False
APP_RDM_RECORD_LANDING_PAGE_TEMPLATE = "zenodo_rdm/records/detail.html"

from zenodo_rdm.utils import (
    blr_link_render,
    briefideas_link_render,
    f1000_link_render,
    github_link_render,
    openaire_link_render,
    reana_link_render,
    swh_link_render,
)

APP_RDM_RECORD_LANDING_PAGE_EXTERNAL_LINKS = [
    {"id": "f1000", "render": f1000_link_render},
    {"id": "reana", "render": reana_link_render},
    {"id": "github", "render": github_link_render},
    {"id": "briefideas", "render": briefideas_link_render},
    {"id": "openaire", "render": openaire_link_render},
    {"id": "softwareheritage", "render": swh_link_render},
    {"id": "blr", "render": blr_link_render},
]

APP_RDM_DEPOSIT_FORM_DEFAULTS = {
    **DEPOSIT_FORM_DEFAULTS,
    "publisher": "Zenodo",
}
"""Default values for new records in the deposit UI."""


# Invenio-Base
# ============
BLUEPRINTS_URL_PREFIXES = {
    # We want to override the legacy files endpoints with our own resource/service
    "invenio_files_rest": "/legacy-files",
}

# Profiler
# ========
PROFILER_PERMISSION = lambda: administration_permission.can()

# Custom Fields
# =============

RDM_NAMESPACES = NAMESPACES

RDM_CUSTOM_FIELDS = CUSTOM_FIELDS

RDM_CUSTOM_FIELDS_UI = CUSTOM_FIELDS_UI  #  UI components

COMMUNITIES_CUSTOM_FIELDS_UI = SUBJECT_FIELDS_UI

COMMUNITIES_CUSTOM_FIELDS = SUBJECT_FIELDS

# Invenio-Communities
# ==============
COMMUNITIES_ALLOW_RESTRICTED = False

COMMUNITIES_OAI_SETS_PREFIX = "user-"

COMMUNITIES_PERMISSION_POLICY = ZenodoCommunityPermissionPolicy

COMMUNITIES_SEARCH_SORT_BY_VERIFIED = True
"""Enable the sorting of communities by verified."""

# Citations
# ==============
ZENODO_RECORDS_UI_CITATIONS_ENABLE = True

METRICS_UPTIME_ROBOT_METRIC_IDS = {}
METRICS_UPTIME_ROBOT_URL = "https://api.uptimerobot.com/v2/getMonitors"
METRICS_UPTIME_ROBOT_API_KEY = None

# Other configs
RDM_RECORDS_SERVICE_COMPONENTS = DefaultRecordsComponents + [
    OpenAIREComponent,
    SignalComponent,
]
"""Addd OpenAIRE component to records service."""

RDM_SEARCH_SORT_BY_VERIFIED = True
"""Enable the sorting of records by verified."""

USERS_RESOURCES_ADMINISTRATION_ENABLED = True
"""Enable user administration."""

USERS_RESOURCES_GROUPS_ENABLED = False
"""Config to enable features related to existence of groups."""

COMMUNITIES_ADMINISTRATION_DISABLED = False
"""Enable communities administration."""

MAIL_DEFAULT_SENDER = "Zenodo <noreply@zenodo.org>"
"""Default e-mail address sender."""

REST_ENABLE_CORS = True
"""Enable CORS validation."""

REST_CSRF_ENABLED = True
"""Enable CSRF."""


# Invenio logging
LOGGING_SENTRY_INIT_KWARGS = {
    # instuct sentry to send user data attached to the event
    "send_default_pii": True
}

THEME_TWITTERHANDLE = "@zenodo_org"
"""Twitter handle."""

# Invenio-Files-REST
# ==================
XROOTD_ENABLED = False
# control file download offloading
FILES_REST_STORAGE_FACTORY = storage_factory
FILES_REST_XSENDFILE_ENABLED = False
ZENODO_EOS_OFFLOAD_ENABLED = False
ZENODO_EOS_OFFLOAD_HTTPHOST = ""
ZENODO_EOS_OFFLOAD_REDIRECT_BASE_PATH = ""
# control EOS offload authentication
ZENODO_EOS_OFFLOAD_AUTH_X509 = False
"""Specifies whether to use X509 authentication for EOS offload."""
ZENODO_EOS_OFFLOAD_X509_CERT_PATH = ""
"""The path to the X509 certificate file."""
ZENODO_EOS_OFFLOAD_X509_KEY_PATH = ""
"""The path to the X509 private key file."""

# TODO: Remove once https://github.com/inveniosoftware/invenio-rdm-records/pull/1789 is merged
FILES_REST_DEFAULT_QUOTA_SIZE = 5 * 10**10
FILES_REST_DEFAULT_MAX_FILE_SIZE = 5 * 10**10

RDM_FILES_DEFAULT_QUOTA_SIZE = 50 * 10**9     # 50GB
RDM_FILES_DEFAULT_MAX_FILE_SIZE = 50 * 10**9  # 50GB

RDM_MEDIA_FILES_DEFAULT_QUOTA_SIZE = 5 * 10**9
RDM_MEDIA_FILES_DEFAULT_MAX_FILE_SIZE = 5 * 10**9

RDM_RECORDS_MAX_MEDIA_FILES_COUNT = 1000
"""Max amount of media files allowed to upload in the deposit form."""

# Rate limiting
RATELIMIT_PER_ENDPOINT = {
    # Badges
    "invenio_formatter_badges.badge": "120 per minute",
    "invenio_github_badge.index": "120 per minute",
    "invenio_github_badge.index_old": "120 per minute",
    "invenio_github_badge.latest_doi": "120 per minute",
    "invenio_github_badge.latest_doi_old": "120 per minute",
    # Support
    "zenodo_rdm.support_form": "10 per second",
    # Login and registration
    "security.login": "10 per minute",
    "security.register": "10 per minute",
    "security.forgot_password": "10 per minute",
    "security.reset_password": "10 per minute",
    # Front page
    "invenio_app_rdm.frontpage_view_function": "10 per second",
    # Records
    "invenio_app_rdm_records.record_thumbnail": "20 per second",
    # OAI-PMH
    "invenio_oaiserver.response": "120 per minute",
    # 'zenodo_redirector.contact': '10 per second',
    # TODO most similar view found was: invenio_redirector.redirect_contact
}
"""Rate limits per endpoint."""


RATELIMIT_GUEST_USER = "8000 per hour;133 per minute"
"""Rate limits for guest users."""

OAISERVER_RESUMPTION_TOKEN_EXPIRE_TIME = 1 * 120
OAISERVER_PAGE_SIZE = 100
OAISERVER_XSL_URL = "/static/oai2.xsl"

RDM_DATACITE_FUNDER_IDENTIFIERS_PRIORITY = ("doi", "ror", "grid", "isni", "gnd")
"""Priority of funder identifiers types for Datacite serialization, prioritize DOI."""

RECORDS_RESOURCES_ALLOW_EMPTY_FILES = False
"""Disable empty files for Zenodo."""

IIIF_PROXY_CLASS = IIPServerProxy
"""IIIF proxy class for IIIF server."""

# Only used for proxying requests to the IIP server Docker container
RDM_IIIF_SERVER_URL = "http://127.0.0.1:8080"
"""IIIF image server URL."""

IIIF_TILES_VALID_EXTENSIONS = [
    "jp2",
    "jpeg",
    "jpg",
    "pdf",
    "png",
    "png",
    "tif",
    "tiff",
]
"""Valid extensions for IIIF tiles generation."""

IIIF_TILES_GENERATION_ENABLED = True
"""Enable IIIF tiles generation."""

IIIF_TILES_STORAGE_BASE_PATH = "images/"  # relative to the instance path
"""IIIF tiles storage path."""

# Invenio-Previewer
# =================
# See https://github.com/inveniosoftware/invenio-previewer/blob/master/invenio_previewer/config.py  # noqa
PREVIEWER_PREFERENCE = [
    "csv_papaparsejs",
    "pdfjs",
    "image_previewer",
    "json_prismjs",
    "xml_prismjs",
    "mistune",
    "video_videojs",
    "audio_videojs",
    "ipynb",
    "zip",
    "txt",
]
"""Preferred previewers."""

PREVIEWER_MAX_IMAGE_SIZE_BYTES = 15 * (10**6) # 15 MB
"""Maximum file size in bytes for image files."""

PREVIEWER_IMAGE_FAILED_PROCESSING_TIMEDELTA = {
    "hours": 1,
}
"""Threshold time for image processing time for failed images."""

MIRADOR_PREVIEW_EXTENSIONS = [
    "png",
    "jp2",
    "jpeg",
    "jpg",
    "png",
    "tif",
    "tiff",
]
"""Mirador previewer allowed extensions."""

MIRADOR_PREVIEW_CONFIG = {
    "window": {
        "allowClose": False,
        "allowFullscreen": True,
        "allowTopMenuButton": True,
        "allowMaximize": False,
        "allowWindowSideBar": True,
        "defaultSidebarPanelHeight": 201,
        "defaultSidebarPanelWidth": 235,
        "defaultView": "single",
        "hideWindowTitle": True,
        "highlightAllAnnotations": True,
        "sideBarOpen": False,
        "switchCanvasOnSearch": False,
        "panels": {
            "info": True,
            "attribution": False,
            "canvas": False,
            "annotations": False,
            "search": False,
            "layers": False,
        },
        "views": [
            {"key": "single", "behaviors": ["individuals"]},
            {"key": "book", "behaviors": ["paged"]},
            {"key": "scroll", "behaviors": ["continuous"]},
            {"key": "gallery"},
        ],
    },
    "workspace": {
        "draggingEnabled": True,
        "showZoomControls": True,
        "height": 4000,
    },
}
"""Config for the Mirador previewer."""


COMMUNITIES_SUB_SERVICE_SCHEMA = ZenodoSubcommunityRequestSchema
"""Schema for subcommunity requests."""

COMMUNITIES_SUB_REQUEST_CLS = ZenodoSubCommunityRequest
"""Request type for subcommunities."""