django-cms-qe 3.1.0__py3-none-any.whl → 3.2.0__py3-none-any.whl

cms_qe/apps.py

@@ -0,0 +1,12 @@
+from django.apps import AppConfig
+
+
+class CmsQEConfig(AppConfig):
+    name = 'cms_qe'
+
+    def ready(self):
+        from cms.signals import urls_need_reloading  # pylint: disable=import-outside-toplevel
+
+        from .signals import reload_site  # pylint: disable=import-outside-toplevel
+
+        urls_need_reloading.connect(reload_site)

cms_qe/settings/base/app.py

@@ -131,3 +131,6 @@ MIDDLEWARE = [
     # Must be the last.
     'django.middleware.cache.FetchFromCacheMiddleware',
 ]
+
+# Reload site. For example ['uwsgi', '--reload', '/var/run/uwsgi.pid'] or ['touch', 'manage.py'].
+RELOAD_SITE: list[str] = []

cms_qe/signals.py

@@ -0,0 +1,42 @@
+import logging
+import subprocess
+import time
+from multiprocessing import Lock, Process
+from typing import Any, Optional, Union
+
+from django.conf import settings
+from django.db.models import Model
+
+DelayType = Union[int, float]
+ArgsType = Union[tuple[str, ...], list[str]]
+
+logger = logging.getLogger(__name__)
+lock = Lock()
+
+
+def run_subprocess(args: ArgsType, delay: Optional[DelayType] = None) -> Optional[subprocess.CompletedProcess]:
+    """Run the system command in subprocess."""
+    if delay is not None:
+        time.sleep(delay)
+    logger.info('subprocess.run(%s)', args)
+    lock.acquire()
+    try:
+        return subprocess.run(args, check=False)
+    except Exception as err:  # pylint: disable=broad-exception-caught
+        logger.error(str(err))
+    finally:
+        lock.release()
+    return None
+
+
+def run_process(args: ArgsType, delay: Optional[DelayType] = None) -> Process:
+    """Run the process and no wait for the result."""
+    proc = Process(target=run_subprocess, args=(args, delay))
+    proc.start()
+    return proc
+
+
+def reload_site(sender: Optional[Model], **kwargs: dict[str, Any]) -> None:  # pylint: disable=unused-argument
+    "Reload the site."
+    if settings.RELOAD_SITE:
+        run_process(settings.RELOAD_SITE, 3)

cms_qe/urls.py

@@ -13,6 +13,7 @@ from django.contrib.sitemaps.views import sitemap
 from django.urls import include, path
 from django.views.i18n import JavaScriptCatalog
 
+from cms_qe.views.maintenance import HealthCheckView, ReloadSiteView
 from cms_qe.views.search_result import SiteSearchView
 from cms_qe.views.security import SecurityTxtView
 
@@ -41,6 +42,8 @@ urlpatterns = [
     path('api/monitoring', views.get_monitoring),
     path('.well-known/security.txt', SecurityTxtView.as_view(), name='security-txt'),
     path('site-search-result/', SiteSearchView.as_view(), name='site-search-result'),
+    path("healthcheck/", HealthCheckView.as_view(), name='healthcheck'),  # Used by uwsgi in docker.
+    path("superuser/reload-site/", ReloadSiteView.as_view(), name='reload-site'),
 ]
 
 # django-simple-captcha

cms_qe/views/maintenance.py

@@ -0,0 +1,39 @@
+from django.conf import settings
+from django.contrib.sites.models import Site
+from django.core.cache import cache
+from django.http import HttpRequest, HttpResponse
+from django.views import View
+
+from cms_qe.signals import run_subprocess
+
+
+class HealthCheckView(View):
+    """Health check View."""
+
+    def get(self, request: HttpRequest, *args, **kwargs) -> HttpResponse:
+        """Apply HTTP GET. Used by uwsgi in docker."""
+        # Check database connection.
+        site = Site.objects.first()
+        if not site.domain:
+            raise RuntimeError('db')
+        # Check cache.
+        key = 'health-check-test'
+        cache.set(key, 'OK', 2)
+        if cache.get(key) != 'OK':
+            raise RuntimeError('cache')
+        return HttpResponse("OK", content_type="text/plain")
+
+
+class ReloadSiteView(View):
+    """Reload site View."""
+
+    def get(self, request: HttpRequest, *args, **kwargs) -> HttpResponse:
+        """Run subprocess defined in settings."""
+        if request.user.is_superuser:
+            if settings.RELOAD_SITE:
+                msg = str(run_subprocess(settings.RELOAD_SITE))
+            else:
+                msg = "SKIP: No settings.RELOAD_SITE."
+        else:
+            msg = "ERROR: User is not is_superuser."
+        return HttpResponse(msg, content_type="text/plain")

cms_qe_analytical/templates/cms_qe_analytical/google_tag_manager.html

@@ -0,0 +1,11 @@
+{% if config.GOOGLE_TAG_MANAGER_ID %}
+    <!-- Google tag (gtag.js) -->
+    <script async src="https://www.googletagmanager.com/gtag/js?id={{ config.GOOGLE_TAG_MANAGER_ID }}"></script>
+    <script>
+        window.dataLayer = window.dataLayer || [];
+        function gtag() {dataLayer.push(arguments)}
+        gtag('js', new Date());
+        gtag('config', '{{ config.GOOGLE_TAG_MANAGER_ID }}');
+        {{ config.GOOGLE_TAG_MANAGER_SCRIPT|safe }}
+    </script>
+{% endif %}

{django_cms_qe-3.1.0.dist-info → django_cms_qe-3.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-cms-qe
-Version: 3.1.0
+Version: 3.2.0
 Summary: Django CMS Quick & Easy provides all important modules to run new page withouta lot of coding. Aims to do it very easily and securely.
 Home-page: https://websites.pages.nic.cz/django-cms-qe
 Author: CZ.NIC, z.s.p.o.
@@ -73,6 +73,7 @@ Requires-Dist: pytest-watch ==4.2.0 ; extra == 'test'
 Requires-Dist: PyVirtualDisplay ==1.3.2 ; extra == 'test'
 Requires-Dist: webdriverwrapper ==2.8.0 ; extra == 'test'
 Requires-Dist: django-simple-captcha ==0.5.14 ; extra == 'test'
+Requires-Dist: testfixtures ; extra == 'test'
 Requires-Dist: tzdata ; extra == 'test'
 
 # Django CMS QE

{django_cms_qe-3.1.0.dist-info → django_cms_qe-3.2.0.dist-info}/RECORD

@@ -1,11 +1,13 @@
 cms_qe/__init__.py,sha256=do1c4s8BgjukMZMMMhBHs_lG9j8ncnAjR3oTICWEq5w,684
 cms_qe/admin.py,sha256=eLqAF3UIDWWyA0xE0Ft5WP5_3HImSWk3EYL2cRfL_8A,171
+cms_qe/apps.py,sha256=AeRcBWwGs7rKLlzHhnV8M_2BEnkoO9959VwesxfHaio,338
 cms_qe/constants.py,sha256=YWUWCIabSwcamGZynvkJ9i8OWGtfHf-wFirm8GtqQpI,90
 cms_qe/export.py,sha256=PyKzMoFGzMdwCTKIYP1zri0Pn8zR_2e0-IkbHYfAv3g,8138
 cms_qe/fixtures.py,sha256=cq_wnZnqBwPBOHpp_0bHk424iCXKvwmN6ZaKwDvguXk,755
 cms_qe/monitoring.py,sha256=5t_o7o0htmAAxVjkN2oz0O0v9XdzfePhSfPGcLNPmE8,769
+cms_qe/signals.py,sha256=MbuLSxPlJA147LEg-lDWDoUNTV1y0OKjwoI3HzgR97g,1253
 cms_qe/staticfiles.py,sha256=OHkfDfpIxN0B-eCRagZzHDHyBgaulcyYgKhp_3mPZuk,1363
-cms_qe/urls.py,sha256=DoOO3xijoxLpdfJAfl4DNna0q0nwG-OKGOdhzpWV1Ss,2790
+cms_qe/urls.py,sha256=vNiiN7NwFFT48SBNIg6lzjTRMN6BicwH_zz6p-EApsw,3042
 cms_qe/utils.py,sha256=gxsWZmS34ZC0Tv1VW8A7VeGlrPyDshodF1ZWXj7xyWE,3057
 cms_qe/boilerplates/bootstrap3/static/cms_qe/css/bootstrap-theme.css,sha256=xOpS-e_dER8z72w-qryCieOGysQI8cELAVt3MHG0phY,26132
 cms_qe/boilerplates/bootstrap3/static/cms_qe/css/bootstrap-theme.css.map,sha256=cZQbJTuJQjdM1XuKhdRzSJ8hMRQ4up491P76Iq2_D1M,47706
@@ -45,7 +47,7 @@ cms_qe/settings/__init__.py,sha256=GJwHXMHwMuGYE-3ZzePJ-26I2WwE8bAIMUDoiTFr0L8,9
 cms_qe/settings/dev.py,sha256=51CBwiclE8LLoNB2uioIK_L3JhM1yzukQ0gZimkcFqw,1487
 cms_qe/settings/unittest.py,sha256=folLIMJb1Arh60_Sn0eNQrvIlx0OsAs6v1tDfyRZVuQ,514
 cms_qe/settings/base/__init__.py,sha256=5yHfne9gPD_xuTaG3voZP23yzuCwROmif2mmKs-hG_A,446
-cms_qe/settings/base/app.py,sha256=vzHEMzjghEuBrF0iALbvV5KE3rq4lZ8CVoaY-I5JXnA,3839
+cms_qe/settings/base/app.py,sha256=vAq5Eo2LK6yU19cvbLrpLpWLV_REhdVRs9NfCZGEeu8,3966
 cms_qe/settings/base/auth.py,sha256=axEmEG5UYxyY3EE0keQjGZzkTv2iwxwfULr4LcvZPns,207
 cms_qe/settings/base/cache.py,sha256=9p6C5lOz1pG-6k15PyvxlShUjBYIbU0ewpA8AX_YFus,297
 cms_qe/settings/base/cms.py,sha256=8icCNxcEp_KRDyP8-LXB21UurJL4wNysY39whAyt3I4,1855
@@ -78,6 +80,7 @@ cms_qe/templatetags/cms_qe_filters.py,sha256=ciYCXLuMVde-f_-B_7a5mHfAJPWPMxYEUMg
 cms_qe/templatetags/kwacros.py,sha256=r2oHLltu8BgKKlrpgzXgvLjbIqwcrH13Lww3zTF-nr8,6275
 cms_qe/views/__init__.py,sha256=3b5FCZ5MaqgiWglC7c5mfvP3WYLWTtNp3YpVb9BgYi8,106
 cms_qe/views/errors.py,sha256=zUbCoyXy_MPsQv3UV1mgq-q2bwqPw9G4KgKU2-oue4w,3169
+cms_qe/views/maintenance.py,sha256=rBfovOGETlfGNF7jlv-vuTEfjZIb5x9dYCSIyFTgHgQ,1312
 cms_qe/views/monitoring.py,sha256=1r2s_jm6B6P0gEmiqjH9m3loUW3BmJivvpg6qcUOxVM,1909
 cms_qe/views/search_result.py,sha256=H1eMOmtONnWqBDsBvz3MartyHhh42vyi0jPoxWb0X8c,296
 cms_qe/views/security.py,sha256=SNdJe4NSm1vuOGchVF3VqlmFDopt9xYoO-b4Y0UxkFU,1108
@@ -86,6 +89,7 @@ cms_qe/whoosh/backend.py,sha256=YOVJGz3htWdcSUbYtX2a9VqywAU3EJP_EvxXHCY0QVA,5418
 cms_qe_analytical/LICENSE.txt,sha256=ptQIrnsiWFFf2LZ60DTAO6XA7CQYFuwhX1m4kzhv5_8,1072
 cms_qe_analytical/__init__.py,sha256=G2QJmxgo4HbUvG4GObM7PcCodfo8SM2auAVQoa36mBY,4189
 cms_qe_analytical/utils.py,sha256=oQRPUyGIWW4lfaVNBPuwBwvnLg-D2JWaRHgNQrwvjcU,5149
+cms_qe_analytical/templates/cms_qe_analytical/google_tag_manager.html,sha256=MJJJWSWfKAx4Z_7NFvhILlZWs0sO4zWaV5wZmEDXmd4,473
 cms_qe_analytical/templatetags/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cms_qe_analytical/templatetags/google_analytics.py,sha256=cN87jJzwVcjhqSS2JKTmPt9WntuBLnzxEcwgjrQMJSg,7370
 cms_qe_analytical/templatetags/piwik.py,sha256=EHOaojmewFpMqHzm_QCtCXGc_HGoiCJ_G-LPc8IfjM4,4131
@@ -3936,6 +3940,8 @@ cms_qe_video/templates/cms_qe/video/video_source_file.html,sha256=QJF5fs88s9Fznp
 cms_qe_video/templates/cms_qe/video/video_widget.html,sha256=Yumciq6bGlAYI1lYx5j9V6IF8QYrncNYygPTkXEz6Wk,925
 cms_qe_video/templatetags/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cms_qe_video/templatetags/cms_qe_video.py,sha256=NR_mGv91J0rEreZrQjCzaaXSrZsKvrSas12wMJ-Dg24,1168
+django_mail_backends/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+django_mail_backends/filebased.py,sha256=tsvMFFlm7-U5krIly53DArYZmrDrNZwQowKHScE8qQ4,612
 example/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 example/urls.py,sha256=H-IJsRGFVZGw6FD9gvK-0B0dLeSOsduziHvDvcHCQZ0,399
 example/wsgi.py,sha256=lCKhvtFZlorSIA8qYEqc3pZ1Oflrz_Tc696MWJ62ue4,396
@@ -3956,8 +3962,8 @@ test_selenium/pages/cms/__init__.py,sha256=_qe4YZYaQbrXp7Szmmeo4TUSkXlE5Rozu8E3t
 test_selenium/pages/cms/login.py,sha256=UPzJQcYff8NUAT4nvmfQoJQxzOJyPrJ_cKtH35NVfNg,521
 test_selenium/pages/cms/page.py,sha256=YQnpZkopfVnhoyQKpRDGqjNeV6xUl-pEHjEcZ9HRiPk,489
 test_selenium/pages/cms/wizard.py,sha256=yatbXH-rf1ap4O1hY0I13WikM3zkm_NrAiSK6bqENIU,545
-django_cms_qe-3.1.0.dist-info/LICENSE,sha256=5wLaeUil0gfU9p8C4zn2Yu_PvZBNieUoYl0z9FcFWdA,1521
-django_cms_qe-3.1.0.dist-info/METADATA,sha256=6kP2n_UW8LwIUQSYP4edBzVbs-5_SDdLPKBNDAYUS1Y,4631
-django_cms_qe-3.1.0.dist-info/WHEEL,sha256=Xo9-1PvkuimrydujYJAjF7pCkriuXBpUPEjma1nZyJ0,92
-django_cms_qe-3.1.0.dist-info/top_level.txt,sha256=Gx3iR7ga_mwVi-a0WHznNn16KhciCv31fUrdh0sr8IM,157
-django_cms_qe-3.1.0.dist-info/RECORD,,
+django_cms_qe-3.2.0.dist-info/LICENSE,sha256=5wLaeUil0gfU9p8C4zn2Yu_PvZBNieUoYl0z9FcFWdA,1521
+django_cms_qe-3.2.0.dist-info/METADATA,sha256=6MBxVvDvwZR8z0sS-gYogsECKcYxogAu9YMsCNReG1o,4677
+django_cms_qe-3.2.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+django_cms_qe-3.2.0.dist-info/top_level.txt,sha256=sns93tUvzAUoyPpolDHe0Orka1l44A4BJnYFko7EIKU,178
+django_cms_qe-3.2.0.dist-info/RECORD,,

{django_cms_qe-3.1.0.dist-info → django_cms_qe-3.2.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.41.3)
+Generator: bdist_wheel (0.43.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

{django_cms_qe-3.1.0.dist-info → django_cms_qe-3.2.0.dist-info}/top_level.txt

@@ -8,5 +8,6 @@ cms_qe_newsletter
 cms_qe_table
 cms_qe_test
 cms_qe_video
+django_mail_backends
 example
 test_selenium

django_mail_backends/filebased.py

@@ -0,0 +1,17 @@
+# EMAIL_BACKEND = 'django.core.mail.backends.filebased.EmailBackend'
+# EMAIL_BACKEND = 'django_mail_backends.filebased.EmailBackend'
+import datetime
+import os
+
+from django.core.mail.backends.filebased import EmailBackend as DjangoEmailBackend
+
+
+class EmailBackend(DjangoEmailBackend):
+
+    def _get_filename(self):
+        """Return a unique file name."""
+        if self._fname is None:
+            timestamp = datetime.datetime.now().strftime("%Y%m%d-%H%M%S")
+            fname = "%s-%s.eml" % (timestamp, abs(id(self)))
+            self._fname = os.path.join(self.file_path, fname)
+        return self._fname