df_config 1.2.55__py3-none-any.whl

df_config/__init__.py

@@ -0,0 +1,22 @@
+# #############################################################################
+#  This file is part of df_config                                             #
+#                                                                             #
+#  Copyright (C) 2020 Matthieu Gallet <df_config@19pouces.net>                #
+#  All Rights Reserved                                                        #
+#                                                                             #
+#  You may use, distribute and modify this code under the                     #
+#  terms of the (BSD-like) CeCILL-B license.                                  #
+#                                                                             #
+#  You should have received a copy of the CeCILL-B license with               #
+#  this file. If not, please visit:                                           #
+#  https://cecill.info/licences/Licence_CeCILL-B_V1-en.txt (English)          #
+#  or https://cecill.info/licences/Licence_CeCILL-B_V1-fr.txt (French)        #
+#                                                                             #
+# #############################################################################
+"""__init__ file."""
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("df_config")
+except PackageNotFoundError:
+    __version__ = "1.0.0"

df_config/__main__.py

@@ -0,0 +1,3 @@
+from df_config.manage import manage
+
+manage()

df_config/application.py

@@ -0,0 +1,24 @@
+# ##############################################################################
+#  This file is part of df_config                                              #
+#                                                                              #
+#  Copyright (C) 2020 Matthieu Gallet <df_config@19pouces.net>                    #
+#  All Rights Reserved                                                         #
+#                                                                              #
+#  You may use, distribute and modify this code under the                      #
+#  terms of the (BSD-like) CeCILL-B license.                                   #
+#                                                                              #
+#  You should have received a copy of the CeCILL-B license with                #
+#  this file. If not, please visit:                                            #
+#  https://cecill.info/licences/Licence_CeCILL-B_V1-en.txt (English)           #
+#  or https://cecill.info/licences/Licence_CeCILL-B_V1-fr.txt (French)         #
+#                                                                              #
+# ##############################################################################
+from django.core.wsgi import get_wsgi_application
+
+try:
+    from django.core.asgi import get_asgi_application
+except ImportError:
+    get_asgi_application = get_wsgi_application
+
+wsgi_application = get_wsgi_application()
+asgi_application = get_asgi_application()

df_config/apps/__init__.py

@@ -0,0 +1,15 @@
+# ##############################################################################
+#  This file is part of df_config                                              #
+#                                                                              #
+#  Copyright (C) 2020 Matthieu Gallet <df_config@19pouces.net>                    #
+#  All Rights Reserved                                                         #
+#                                                                              #
+#  You may use, distribute and modify this code under the                      #
+#  terms of the (BSD-like) CeCILL-B license.                                   #
+#                                                                              #
+#  You should have received a copy of the CeCILL-B license with                #
+#  this file. If not, please visit:                                            #
+#  https://cecill.info/licences/Licence_CeCILL-B_V1-en.txt (English)           #
+#  or https://cecill.info/licences/Licence_CeCILL-B_V1-fr.txt (French)         #
+#                                                                              #
+# ##############################################################################

df_config/apps/allauth.py

@@ -0,0 +1,28 @@
+# ##############################################################################
+#  This file is part of df_config                                              #
+#                                                                              #
+#  Copyright (C) 2020 Matthieu Gallet <df_config@19pouces.net>                    #
+#  All Rights Reserved                                                         #
+#                                                                              #
+#  You may use, distribute and modify this code under the                      #
+#  terms of the (BSD-like) CeCILL-B license.                                   #
+#                                                                              #
+#  You should have received a copy of the CeCILL-B license with                #
+#  this file. If not, please visit:                                            #
+#  https://cecill.info/licences/Licence_CeCILL-B_V1-en.txt (English)           #
+#  or https://cecill.info/licences/Licence_CeCILL-B_V1-fr.txt (French)         #
+#                                                                              #
+# ##############################################################################
+
+from django.conf import settings
+
+try:
+    from allauth.account.adapter import DefaultAccountAdapter
+except ImportError:
+    DefaultAccountAdapter = object
+
+
+class AccountAdapter(DefaultAccountAdapter):
+    # noinspection PyMethodMayBeStatic,PyUnusedLocal
+    def is_open_for_signup(self, request):
+        return settings.DF_ALLOW_USER_CREATION and settings.DF_ALLOW_LOCAL_USERS

df_config/apps/backends.py

@@ -0,0 +1,72 @@
+# ##############################################################################
+#  This file is part of df_config                                              #
+#                                                                              #
+#  Copyright (C) 2020 Matthieu Gallet <df_config@19pouces.net>                    #
+#  All Rights Reserved                                                         #
+#                                                                              #
+#  You may use, distribute and modify this code under the                      #
+#  terms of the (BSD-like) CeCILL-B license.                                   #
+#                                                                              #
+#  You should have received a copy of the CeCILL-B license with                #
+#  this file. If not, please visit:                                            #
+#  https://cecill.info/licences/Licence_CeCILL-B_V1-en.txt (English)           #
+#  or https://cecill.info/licences/Licence_CeCILL-B_V1-fr.txt (French)         #
+#                                                                              #
+# ##############################################################################
+import logging
+
+from django.conf import settings
+from django.contrib.auth.backends import RemoteUserBackend
+from django.contrib.auth.models import Group
+from django.utils.functional import cached_property
+
+logger = logging.getLogger("django.request")
+
+_CACHED_GROUPS = {}
+
+
+class DefaultGroupsRemoteUserBackend(RemoteUserBackend):
+    """Add groups to new users.
+    Based on :class:`django.contrib.auth.backends.RemoteUserBackend`.
+    Only overrides the `configure_user` method to add the required groups.
+
+    """
+
+    @property
+    def create_unknown_user(self):
+        return settings.DF_ALLOW_USER_CREATION
+
+    @cached_property
+    def ldap_backend(self):
+        # noinspection PyUnresolvedReferences
+        from django_auth_ldap.backend import LDAPBackend
+
+        return LDAPBackend()
+
+    def authenticate(self, *args, **kwargs):
+        remote_user = kwargs.get("remote_user")
+        if (
+            remote_user
+            and settings.AUTH_LDAP_SERVER_URI
+            and settings.AUTH_LDAP_ALWAYS_UPDATE_USER
+        ):
+            user = self.ldap_backend.populate_user(remote_user)
+            if user:
+                return user
+        return super().authenticate(*args, remote_user)
+
+    def configure_user(self, request, user=None, created=True):
+        """
+        Configure a user after creation and returns the updated user.
+
+        By default, returns the user unmodified; only add it to the default group.
+        """
+        if user is None:  # compatibility
+            user = request
+        for group_name in settings.DF_DEFAULT_GROUPS:
+            if group_name not in _CACHED_GROUPS:
+                _CACHED_GROUPS[group_name] = Group.objects.get_or_create(
+                    name=str(group_name)
+                )[0]
+            user.groups.add(_CACHED_GROUPS[group_name])
+        return user

df_config/apps/middleware.py

@@ -0,0 +1,136 @@
+# ##############################################################################
+#  This file is part of df_config                                              #
+#                                                                              #
+#  Copyright (C) 2020 Matthieu Gallet <df_config@19pouces.net>                    #
+#  All Rights Reserved                                                         #
+#                                                                              #
+#  You may use, distribute and modify this code under the                      #
+#  terms of the (BSD-like) CeCILL-B license.                                   #
+#                                                                              #
+#  You should have received a copy of the CeCILL-B license with                #
+#  this file. If not, please visit:                                            #
+#  https://cecill.info/licences/Licence_CeCILL-B_V1-en.txt (English)           #
+#  or https://cecill.info/licences/Licence_CeCILL-B_V1-fr.txt (French)         #
+#                                                                              #
+# ##############################################################################
+import base64
+import binascii
+import logging
+from functools import lru_cache
+
+from django.conf import settings
+from django.contrib import auth
+from django.contrib.auth.middleware import (
+    RemoteUserMiddleware as BaseRemoteUserMiddleware,
+)
+from django.core.exceptions import ImproperlyConfigured
+from django.http import HttpRequest
+from django.utils.functional import cached_property
+
+logger = logging.getLogger("django.request")
+
+
+class DFConfigMiddleware(BaseRemoteUserMiddleware):
+    """Like :class:`django.contrib.auth.middleware.RemoteUserMiddleware` but:
+
+    * can use any header defined by the setting `DF_REMOTE_USER_HEADER`,
+    * handle the HTTP_X_FORWARDED_FOR HTTP header (set the right client IP)
+    * handle HTTP basic authentication
+    * set response header for Internet Explorer (to use its most recent render engine)
+    """
+
+    @lru_cache()
+    def get_remoteuser_header(self):
+        # avoid cached_property to ease unittests
+        header = settings.DF_REMOTE_USER_HEADER
+        if header:
+            header = header.upper().replace("-", "_")
+        return header
+
+    def process_request(self, request: HttpRequest):
+        request.remote_username = None
+
+        if settings.USE_X_FORWARDED_FOR and "HTTP_X_FORWARDED_FOR" in request.META:
+            request.META["REMOTE_ADDR"] = (
+                request.META["HTTP_X_FORWARDED_FOR"].split(",")[0].strip()
+            )
+
+        if settings.USE_HTTP_BASIC_AUTH and "HTTP_AUTHORIZATION" in request.META:
+            authentication = request.META["HTTP_AUTHORIZATION"]
+            authmeth, sep, auth_data = authentication.partition(" ")
+            if sep == " " and authmeth.lower() == "basic":
+                try:
+                    auth_data = base64.b64decode(auth_data.strip()).decode("utf-8")
+                except binascii.Error:
+                    auth_data = ""
+                except UnicodeDecodeError:
+                    auth_data = ""
+                username, sep, password = auth_data.partition(":")
+                if sep == ":":
+                    user = auth.authenticate(username=username, password=password)
+                    if user:
+                        request.user = user
+                        auth.login(request, user)
+        username = getattr(settings, "DF_FAKE_AUTHENTICATION_USERNAME", None)
+
+        header = self.get_remoteuser_header()
+        if header and username and settings.DEBUG:
+            remote_addr = request.META.get("REMOTE_ADDR")
+            if remote_addr in settings.INTERNAL_IPS:
+                request.META[header] = username
+            elif remote_addr:
+                logger.warning(
+                    "Unable to use `settings.DF_FAKE_AUTHENTICATION_USERNAME`. "
+                    "You should add %s to the list `settings.INTERNAL_IPS`."
+                    % remote_addr
+                )
+
+        if header and header in request.META:
+            remote_username = request.META.get(header)
+            if (
+                not remote_username or remote_username == "(null)"
+            ):  # special case due to apache2+auth_mod_kerb :-(
+                return
+            remote_username = self.format_remote_username(remote_username)
+            # noinspection PyTypeChecker
+            self.remote_user_authentication(request, remote_username)
+
+    # noinspection PyUnusedLocal,PyMethodMayBeStatic
+    def process_response(self, request, response):
+        response["X-UA-Compatible"] = "IE=edge,chrome=1"
+        return response
+
+    def remote_user_authentication(self, request, username):
+        # AuthenticationMiddleware is required so that request.user exists.
+        # noinspection PyTypeChecker
+        if not hasattr(request, "user"):
+            raise ImproperlyConfigured(
+                "The Django remote user auth middleware requires the"
+                " authentication middleware to be installed.  Edit your"
+                " MIDDLEWARE_CLASSES setting to insert"
+                " 'django.contrib.auth.middleware.AuthenticationMiddleware'"
+                " before the RemoteUserMiddleware class."
+            )
+        # If the user is already authenticated and that user is the user we are
+        # getting passed in the headers, then the correct user is already
+        # persisted in the session and we don't need to continue.
+        if request.user.is_authenticated:
+            cleaned_username = self.clean_username(username, request)
+            if request.user.get_username() == cleaned_username:
+                request.remote_username = cleaned_username
+                return
+            else:
+                self._remove_invalid_user(request)
+        # We are seeing this user for the first time in this session, attempt
+        # to authenticate the user.
+        user = auth.authenticate(remote_user=username)
+        if user:
+            # User is valid.  Set request.user and persist user in the session
+            # by logging the user in.
+            request.user = user
+            auth.login(request, user)
+            request.remote_username = user.username
+
+    # noinspection PyMethodMayBeStatic
+    def format_remote_username(self, remote_username):
+        return remote_username.partition("@")[0]

df_config/apps/pipeline.py

@@ -0,0 +1,180 @@
+# ##############################################################################
+#  This file is part of df_config                                              #
+#                                                                              #
+#  Copyright (C) 2020 Matthieu Gallet <df_config@19pouces.net>                    #
+#  All Rights Reserved                                                         #
+#                                                                              #
+#  You may use, distribute and modify this code under the                      #
+#  terms of the (BSD-like) CeCILL-B license.                                   #
+#                                                                              #
+#  You should have received a copy of the CeCILL-B license with                #
+#  this file. If not, please visit:                                            #
+#  https://cecill.info/licences/Licence_CeCILL-B_V1-en.txt (English)           #
+#  or https://cecill.info/licences/Licence_CeCILL-B_V1-fr.txt (French)         #
+#                                                                              #
+# ##############################################################################
+"""Define extra compressors or compilers for django-pipeline."""
+
+import os
+from pathlib import Path
+
+from django.conf import settings
+
+if settings.USE_PIPELINE:
+    from pipeline.compilers import SubProcessCompiler
+    from pipeline.compressors import SubProcessCompressor
+    from pipeline.storage import PipelineManifestStorage, PipelineMixin
+else:
+    SubProcessCompressor = object
+    SubProcessCompiler = object
+    PipelineManifestStorage = None
+    PipelineMixin = None
+
+
+if settings.USE_WHITENOISE:
+    # noinspection PyPackageRequirements,PyUnresolvedReferences
+    from whitenoise.storage import CompressedManifestStaticFilesStorage
+else:
+    CompressedManifestStaticFilesStorage = None
+
+
+class RcssCompressor(SubProcessCompressor):
+    """CSS compressor based on the Python library rcssmin.
+
+    (https://github.com/ndparker/rcssmin).
+    """
+
+    def filter_css(self, css):
+        """Not implemented."""
+        raise NotImplementedError
+
+    def filter_js(self, js):
+        """Not implemented."""
+        raise NotImplementedError
+
+    # noinspection PyMethodMayBeStatic
+    def compress_css(self, css):
+        """Compress a block of CSS code using the "rcssmin" module."""
+        # noinspection PyUnresolvedReferences,PyPackageRequirements
+        from rcssmin import cssmin
+
+        return cssmin(css)
+
+
+class CssNanoCompressor(SubProcessCompressor):
+    """CSS compressor based on the "cssnano" command."""
+
+    def compress_css(self, css):
+        """Compress a block of CSS code using the "cssnano" command."""
+        command = [settings.CSSNANO_BINARY] + settings.CSSNANO_ARGUMENTS
+        return self.execute_command(command, css)
+
+    def filter_css(self, css):
+        """Not implemented."""
+        raise NotImplementedError
+
+    def filter_js(self, js):
+        """Not implemented."""
+        raise NotImplementedError
+
+
+class TerserCompressor(SubProcessCompressor):
+    """JavaScript compressor based on the "terser" command."""
+
+    def compress_js(self, js):
+        """Compress a block of JavaScript code using the "terser" command."""
+        command = [settings.TERSER_BINARY, settings.TERSER_ARGUMENTS, "--"]
+        if self.verbose:
+            command += ["--verbose"]
+        return self.execute_command(command, js)
+
+    def filter_css(self, css):
+        """Not implemented."""
+        raise NotImplementedError
+
+    def filter_js(self, js):
+        """Not implemented."""
+        raise NotImplementedError
+
+
+class PyScssCompiler(SubProcessCompiler):
+    """SASS (.scss) compiler based on the Python library pyScss.
+
+    (http://pyscss.readthedocs.io/en/latest/ ).
+    However, this compiler is limited to SASS 3.2 and cannot compile modern projets like Bootstrap 4.
+    Please use :class:`pipeline.compilers.sass.SASSCompiler` if you use modern SCSS files.
+
+    """
+
+    output_extension = "css"
+
+    # noinspection PyMethodMayBeStatic
+    def match_file(self, filename):
+        """Return True if the file is a SASS file."""
+        return filename.endswith(".scss") or filename.endswith(".sass")
+
+    # noinspection PyUnusedLocal
+    def compile_file(self, infile, outfile, outdated=False, force=False):
+        """Compile a SASS file using the "scss" command."""
+        # noinspection PyUnresolvedReferences,PyUnresolvedReferences,PyPackageRequirements
+        from scss import Compiler
+
+        root = Path(os.path.abspath(settings.STATIC_ROOT))
+        compiler = Compiler(root=root, search_path=("./",))
+        css_content = compiler.compile(infile)
+        with open(outfile, "w") as fd:
+            fd.write(css_content)
+        # noinspection PyUnresolvedReferences
+        if self.verbose:
+            print(css_content)
+
+
+class TypescriptCompiler(SubProcessCompiler):
+    """TypeScript (.ts) compiler using "tsc" (https://www.typescriptlang.org)."""
+
+    output_extension = "js"
+
+    # noinspection PyMethodMayBeStatic
+    def match_file(self, filename):
+        """Return True if the file is a TypeScript file."""
+        return filename.endswith(".ts")
+
+    # noinspection PyMethodMayBeStatic,PyUnusedLocal
+    def compile_file(self, infile, outfile, outdated=False, force=False):
+        """Compile a TypeScript file using the "tsc" command."""
+        command = (
+            [settings.TYPESCRIPT_BINARY]
+            + settings.TYPESCRIPT_ARGUMENTS
+            + ["--outFile", outfile, infile]
+        )
+        self.execute_command(command)
+
+
+if PipelineManifestStorage:
+
+    class NicerPipelineCachedStorage(PipelineManifestStorage):
+        """Display a better exception."""
+
+        def hashed_name(self, name, content=None, filename=None):
+            """Display a better exception if the file is not found."""
+            try:
+                return super().hashed_name(name, content=content)
+            except ValueError as e:
+                raise ValueError(
+                    "%s. Did you run the command 'collectstatic'?" % e.args[0]
+                )
+
+else:
+    NicerPipelineCachedStorage = None
+
+if PipelineMixin and CompressedManifestStaticFilesStorage:
+
+    class PipelineCompressedManifestStaticFilesStorage(
+        PipelineMixin, CompressedManifestStaticFilesStorage
+    ):
+        """Mix django-pipeline and whitenoise."""
+
+        pass
+
+else:
+    PipelineCompressedManifestStaticFilesStorage = None

df_config/checks.py

@@ -0,0 +1,26 @@
+# ##############################################################################
+#  This file is part of Interdiode                                             #
+#                                                                              #
+#  Copyright (C) 2020 Matthieu Gallet <matthieu.gallet@19pouces.net>           #
+#  All Rights Reserved                                                         #
+#                                                                              #
+# ##############################################################################
+import os
+import sys
+
+from django.core.checks import Warning
+
+settings_check_results = []
+
+
+def missing_package(package_name, desc=""):
+    if hasattr(sys, "real_prefix"):  # inside a virtualenv
+        cmd = f"Try 'python -m pip install {package_name}' to install it."
+    elif __file__.startswith(os.environ.get("HOME", "/home")):
+        cmd = f"Try 'python3 -m pip install --user {package_name}' to install it."
+    else:
+        cmd = f"Try 'sudo python3 -m pip install {package_name}' to install it."
+    return Warning(
+        f"Python package '{package_name}' is required{desc}. {cmd}",
+        obj="configuration",
+    )

df_config/config/__init__.py

@@ -0,0 +1,15 @@
+# ##############################################################################
+#  This file is part of df_config                                              #
+#                                                                              #
+#  Copyright (C) 2020 Matthieu Gallet <df_config@19pouces.net>                    #
+#  All Rights Reserved                                                         #
+#                                                                              #
+#  You may use, distribute and modify this code under the                      #
+#  terms of the (BSD-like) CeCILL-B license.                                   #
+#                                                                              #
+#  You should have received a copy of the CeCILL-B license with                #
+#  this file. If not, please visit:                                            #
+#  https://cecill.info/licences/Licence_CeCILL-B_V1-en.txt (English)           #
+#  or https://cecill.info/licences/Licence_CeCILL-B_V1-fr.txt (French)         #
+#                                                                              #
+# ##############################################################################

df_config/config/base.py

@@ -0,0 +1,27 @@
+# ##############################################################################
+#  This file is part of df_config                                              #
+#                                                                              #
+#  Copyright (C) 2020 Matthieu Gallet <df_config@19pouces.net>                    #
+#  All Rights Reserved                                                         #
+#                                                                              #
+#  You may use, distribute and modify this code under the                      #
+#  terms of the (BSD-like) CeCILL-B license.                                   #
+#                                                                              #
+#  You should have received a copy of the CeCILL-B license with                #
+#  this file. If not, please visit:                                            #
+#  https://cecill.info/licences/Licence_CeCILL-B_V1-en.txt (English)           #
+#  or https://cecill.info/licences/Licence_CeCILL-B_V1-fr.txt (French)         #
+#                                                                              #
+# ##############################################################################
+"""This module should be used as DJANGO_SETTINGS_MODULE.
+
+Merge several sources of settings: env. variable, Python modules or .ini files.
+"""
+from df_config.manage import get_merger_from_env
+
+merger = get_merger_from_env()
+merger.process()
+merger.post_process()
+
+__settings = globals()
+__settings.update(merger.settings)