"""
crate_anon/crateweb/core/context_processors.py
===============================================================================
Copyright (C) 2015, University of Cambridge, Department of Psychiatry.
Created by Rudolf Cardinal (rnc1001@cam.ac.uk).
This file is part of CRATE.
CRATE is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
CRATE is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with CRATE. If not, see <https://www.gnu.org/licenses/>.
===============================================================================
**A common context dictionary for all Django requests.**
"""
from typing import Any, Dict
from django.conf import settings
from django.http.request import HttpRequest
from crate_anon.common.constants import CRATE_DOCS_URL, HelpUrl
# noinspection PyUnusedLocal
[docs]def common_context(request: HttpRequest) -> Dict[str, Any]:
"""
Returns a context used across the site.
Args:
request: the :class:`django.http.request.HttpRequest`
Returns:
dict: a context dictionary
"""
return {
"CRATE_DOCS_URL": CRATE_DOCS_URL,
"HelpUrl": HelpUrl,
"nav_on_main_menu": False,
"RESEARCH_DB_TITLE": settings.RESEARCH_DB_TITLE,
}
# Try to minimize SQL here (ideally none!), as these calls will be used for
# EVERY request.
# This problem can partially be circumvented with a per-request cache; see
# https://stackoverflow.com/questions/3151469/per-request-cache-in-django
# But good practice is: keep queries to a minimum.