django-cookie-consent 0.4.0.dev0__tar.gz → 0.6.0__tar.gz

{django-cookie-consent-0.4.0.dev0 → django_cookie_consent-0.6.0}/AUTHORS

@@ -11,3 +11,4 @@ The following is a list of much appreciated contributors:
 * Abdullah Alahdal (alahdal)
 * some1ataplace
 * binoyudayan
+* adilhussain540

{django-cookie-consent-0.4.0.dev0/django_cookie_consent.egg-info → django_cookie_consent-0.6.0}/PKG-INFO

@@ -1,21 +1,41 @@
 Metadata-Version: 2.1
 Name: django-cookie-consent
-Version: 0.4.0.dev0
+Version: 0.6.0
 Summary: Django cookie consent application
-Home-page: https://github.com/jazzband/django-cookie-consent
-Author: Informatika Mihelac
-Author-email: bmihelac@mihelac.org
-License: BSD
+Author-email: Informatika Mihelac <bmihelac@mihelac.org>
+License: Copyright (c) Bojan Mihelac and individual contributors.
+        All rights reserved.
+        
+        Redistribution and use in source and binary forms, with or without modification,
+        are permitted provided that the following conditions are met:
+        
+            1. Redistributions of source code must retain the above copyright notice, 
+               this list of conditions and the following disclaimer.
+            
+            2. Redistributions in binary form must reproduce the above copyright 
+               notice, this list of conditions and the following disclaimer in the
+               documentation and/or other materials provided with the distribution.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+        ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+        WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+        ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+        (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+        LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+        ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+        (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+        SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+        
 Project-URL: Documentation, https://django-cookie-consent.readthedocs.io/en/latest/
 Project-URL: Changelog, https://github.com/jazzband/django-cookie-consent/blob/master/docs/changelog.rst
 Project-URL: Bug Tracker, https://github.com/jazzband/django-cookie-consent/issues
 Project-URL: Source Code, https://github.com/jazzband/django-cookie-consent
 Keywords: cookies,cookie-consent,cookie bar
-Classifier: Development Status :: 3 - Alpha
+Classifier: Development Status :: 4 - Beta
 Classifier: Framework :: Django
-Classifier: Framework :: Django :: 3.2
-Classifier: Framework :: Django :: 4.1
 Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.0
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: Unix
@@ -26,15 +46,29 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
 Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: AUTHORS
+Requires-Dist: django>=4.2
+Requires-Dist: django-appconf
 Provides-Extra: tests
-Provides-Extra: pep8
+Requires-Dist: pytest; extra == "tests"
+Requires-Dist: pytest-django; extra == "tests"
+Requires-Dist: pytest-playwright; extra == "tests"
+Requires-Dist: tox; extra == "tests"
+Requires-Dist: isort; extra == "tests"
+Requires-Dist: black; extra == "tests"
+Requires-Dist: flake8; extra == "tests"
 Provides-Extra: coverage
+Requires-Dist: pytest-cov; extra == "coverage"
 Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx-rtd-theme; extra == "docs"
 Provides-Extra: release
-License-File: LICENSE
-License-File: AUTHORS
+Requires-Dist: tbump; extra == "release"
 
 Django cookie consent
 =====================

django_cookie_consent-0.6.0/cookie_consent/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.6.0"

{django-cookie-consent-0.4.0.dev0 → django_cookie_consent-0.6.0}/cookie_consent/cache.py

@@ -1,10 +1,11 @@
 # -*- coding: utf-8 -*-
 from django.core.cache import caches
 
-from cookie_consent.conf import settings
+from .conf import settings
+from .models import CookieGroup
 
 CACHE_KEY = "cookie_consent_cache"
-CACHE_TIMEOUT = 60 * 60
+CACHE_TIMEOUT = 60 * 60  # 60 minutes
 
 
 def _get_cache():
@@ -23,17 +24,22 @@ def delete_cache():
     cache.delete(CACHE_KEY)
 
 
+def _get_cookie_groups_from_db():
+    qs = CookieGroup.objects.filter(is_required=False).prefetch_related("cookie_set")
+    return qs.in_bulk(field_name="varname")
+
+
 def all_cookie_groups():
+    """
+    Get all cookie groups that are optional.
+
+    Reads from the cache where possible, sets the value in the cache if there's a
+    cache miss.
+    """
     cache = _get_cache()
-    items = cache.get(CACHE_KEY)
-    if items is None:
-        from cookie_consent.models import CookieGroup
-
-        qs = CookieGroup.objects.filter(is_required=False)
-        qs = qs.prefetch_related("cookie_set")
-        items = dict([(g.varname, g) for g in qs])
-        cache.set(CACHE_KEY, items, CACHE_TIMEOUT)
-    return items
+    return cache.get_or_set(
+        CACHE_KEY, _get_cookie_groups_from_db, timeout=CACHE_TIMEOUT
+    )
 
 
 def get_cookie_group(varname):

django_cookie_consent-0.6.0/cookie_consent/migrations/0003_alter_cookiegroup_varname.py

@@ -0,0 +1,32 @@
+# Generated by Django 4.2.13 on 2024-05-09 19:01
+
+import re
+
+import django.core.validators
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("cookie_consent", "0002_auto__add_logitem"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="cookiegroup",
+            name="varname",
+            field=models.CharField(
+                max_length=32,
+                unique=True,
+                validators=[
+                    django.core.validators.RegexValidator(
+                        re.compile("^[-_a-zA-Z0-9]+$"),
+                        "Enter a valid 'varname' consisting of letters, numbers, underscores or hyphens.",
+                        "invalid",
+                    )
+                ],
+                verbose_name="Variable name",
+            ),
+        ),
+    ]

django_cookie_consent-0.6.0/cookie_consent/migrations/0004_cookie_natural_key.py

@@ -0,0 +1,19 @@
+# Generated by Django 4.2.13 on 2024-05-09 20:22
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("cookie_consent", "0003_alter_cookiegroup_varname"),
+    ]
+
+    operations = [
+        migrations.AddConstraint(
+            model_name="cookie",
+            constraint=models.UniqueConstraint(
+                fields=("cookiegroup", "name", "domain"), name="natural_key"
+            ),
+        ),
+    ]

{django-cookie-consent-0.4.0.dev0 → django_cookie_consent-0.6.0}/cookie_consent/models.py

@@ -1,12 +1,11 @@
 # -*- coding: utf-8 -*-
 import re
+from typing import TypedDict
 
 from django.core.validators import RegexValidator
 from django.db import models
 from django.utils.translation import gettext_lazy as _
 
-from cookie_consent.cache import delete_cache
-
 COOKIE_NAME_RE = re.compile(r"^[-_a-zA-Z0-9]+$")
 validate_cookie_name = RegexValidator(
     COOKIE_NAME_RE,
@@ -18,9 +17,48 @@ validate_cookie_name = RegexValidator(
 )
 
 
+def clear_cache_after(func):
+    def wrapper(*args, **kwargs):
+        from .cache import delete_cache
+
+        return_value = func(*args, **kwargs)
+        delete_cache()
+        return return_value
+
+    return wrapper
+
+
+class CookieGroupDict(TypedDict):
+    varname: str
+    name: str
+    description: str
+    is_required: bool
+    # TODO: should we output this? page cache busting would be
+    # required if we do this. Alternatively, set up a JSONView to output these?
+    # version: str
+
+
+class BaseQueryset(models.query.QuerySet):
+    @clear_cache_after
+    def delete(self):
+        return super().delete()
+
+    @clear_cache_after
+    def update(self, **kwargs):
+        return super().update(**kwargs)
+
+
+class CookieGroupManager(models.Manager.from_queryset(BaseQueryset)):
+    def get_by_natural_key(self, varname):
+        return self.get(varname=varname)
+
+
 class CookieGroup(models.Model):
     varname = models.CharField(
-        _("Variable name"), max_length=32, validators=[validate_cookie_name]
+        _("Variable name"),
+        max_length=32,
+        unique=True,
+        validators=[validate_cookie_name],
     )
     name = models.CharField(_("Name"), max_length=100, blank=True)
     description = models.TextField(_("Description"), blank=True)
@@ -37,6 +75,8 @@ class CookieGroup(models.Model):
     ordering = models.IntegerField(_("Ordering"), default=0)
     created = models.DateTimeField(_("Created"), auto_now_add=True, blank=True)
 
+    objects = CookieGroupManager()
+
     class Meta:
         verbose_name = _("Cookie Group")
         verbose_name_plural = _("Cookie Groups")
@@ -45,19 +85,37 @@ class CookieGroup(models.Model):
     def __str__(self):
         return self.name
 
-    def get_version(self):
+    @clear_cache_after
+    def save(self, *args, **kwargs):
+        super().save(*args, **kwargs)
+
+    @clear_cache_after
+    def delete(self, *args, **kwargs):
+        return super().delete(*args, **kwargs)
+
+    def natural_key(self):
+        return (self.varname,)
+
+    def get_version(self) -> str:
         try:
             return str(self.cookie_set.all()[0].get_version())
         except IndexError:
             return ""
 
-    def delete(self, *args, **kwargs):
-        super(CookieGroup, self).delete(*args, **kwargs)
-        delete_cache()
+    def for_json(self) -> CookieGroupDict:
+        return {
+            "varname": self.varname,
+            "name": self.name,
+            "description": self.description,
+            "is_required": self.is_required,
+            # "version": self.get_version(),
+        }
 
-    def save(self, *args, **kwargs):
-        super(CookieGroup, self).save(*args, **kwargs)
-        delete_cache()
+
+class CookieManager(models.Manager.from_queryset(BaseQueryset)):
+    def get_by_natural_key(self, name, domain, cookiegroup):
+        group = CookieGroup.objects.get_by_natural_key(cookiegroup)
+        return self.get(cookiegroup=group, name=name, domain=domain)
 
 
 class Cookie(models.Model):
@@ -72,14 +130,35 @@ class Cookie(models.Model):
     domain = models.CharField(_("Domain"), max_length=250, blank=True)
     created = models.DateTimeField(_("Created"), auto_now_add=True, blank=True)
 
+    objects = CookieManager()
+
     class Meta:
         verbose_name = _("Cookie")
         verbose_name_plural = _("Cookies")
+        constraints = [
+            models.UniqueConstraint(
+                fields=("cookiegroup", "name", "domain"),
+                name="natural_key",
+            ),
+        ]
         ordering = ["-created"]
 
     def __str__(self):
         return "%s %s%s" % (self.name, self.domain, self.path)
 
+    @clear_cache_after
+    def save(self, *args, **kwargs):
+        super().save(*args, **kwargs)
+
+    @clear_cache_after
+    def delete(self, *args, **kwargs):
+        return super().delete(*args, **kwargs)
+
+    def natural_key(self):
+        return (self.name, self.domain) + self.cookiegroup.natural_key()
+
+    natural_key.dependencies = ["cookie_consent.cookiegroup"]
+
     @property
     def varname(self):
         return "%s=%s:%s" % (self.cookiegroup.varname, self.name, self.domain)
@@ -87,14 +166,6 @@ class Cookie(models.Model):
     def get_version(self):
         return self.created.isoformat()
 
-    def delete(self, *args, **kwargs):
-        super(Cookie, self).delete(*args, **kwargs)
-        delete_cache()
-
-    def save(self, *args, **kwargs):
-        super(Cookie, self).save(*args, **kwargs)
-        delete_cache()
-
 
 ACTION_ACCEPTED = 1
 ACTION_DECLINED = -1

{django-cookie-consent-0.4.0.dev0 → django_cookie_consent-0.6.0}/cookie_consent/static/cookie_consent/cookiebar.js

@@ -10,7 +10,7 @@ function evalXCookieConsent(script) {
   script.remove();
 }
 
-function showCookieBar (options) {
+function lecacyShowCookieBar (options) {
   const defaults = {
     content: '',
     cookie_groups: [],
@@ -64,3 +64,4 @@ function showCookieBar (options) {
   });
 }
 
+window.legacyShowCookieBar = window.showCookieBar = lecacyShowCookieBar;

django_cookie_consent-0.6.0/cookie_consent/static/cookie_consent/cookiebar.module.js

@@ -0,0 +1,163 @@
+// src/cookiebar.ts
+var DEFAULT_FETCH_HEADERS = {
+  "X-Cookie-Consent-Fetch": "1"
+};
+var FetchClient = class {
+  constructor(statusUrl, csrfHeaderName) {
+    this.statusUrl = statusUrl;
+    this.csrfHeaderName = csrfHeaderName;
+    this.cookieStatus = null;
+  }
+  async getCookieStatus() {
+    if (this.cookieStatus === null) {
+      const response = await window.fetch(
+        this.statusUrl,
+        {
+          method: "GET",
+          credentials: "same-origin",
+          headers: DEFAULT_FETCH_HEADERS
+        }
+      );
+      this.cookieStatus = await response.json();
+    }
+    if (this.cookieStatus === null) {
+      throw new Error("Unexpectedly received null cookie status");
+    }
+    return this.cookieStatus;
+  }
+  async saveCookiesStatusBackend(urlProperty) {
+    const cookieStatus = await this.getCookieStatus();
+    const url = cookieStatus[urlProperty];
+    if (!url) {
+      throw new Error(`Missing url for ${urlProperty} - was the cookie status not loaded properly?`);
+    }
+    await window.fetch(url, {
+      method: "POST",
+      credentials: "same-origin",
+      headers: {
+        ...DEFAULT_FETCH_HEADERS,
+        [this.csrfHeaderName]: cookieStatus.csrftoken
+      }
+    });
+  }
+};
+var loadCookieGroups = (selector) => {
+  const node = document.querySelector(selector);
+  if (!node) {
+    throw new Error(`No cookie groups (script) tag found, using selector: '${selector}'`);
+  }
+  return JSON.parse(node.innerText);
+};
+var doInsertBefore = (beforeNode, newNode) => {
+  const parent = beforeNode.parentNode;
+  if (parent === null)
+    throw new Error("Reference node doesn't have a parent.");
+  parent.insertBefore(newNode, beforeNode);
+};
+var registerEvents = ({
+  client,
+  cookieBarNode,
+  cookieGroups,
+  acceptSelector,
+  onAccept,
+  declineSelector,
+  onDecline,
+  acceptedCookieGroups: accepted,
+  declinedCookieGroups: declined,
+  notAcceptedOrDeclinedCookieGroups: undecided
+}) => {
+  const acceptNode = cookieBarNode.querySelector(acceptSelector);
+  if (acceptNode) {
+    acceptNode.addEventListener("click", (event) => {
+      event.preventDefault();
+      const acceptedGroups = filterCookieGroups(cookieGroups, accepted.concat(undecided));
+      onAccept == null ? void 0 : onAccept(acceptedGroups, event);
+      client.saveCookiesStatusBackend("acceptUrl");
+      cookieBarNode.parentNode.removeChild(cookieBarNode);
+    });
+  }
+  const declineNode = cookieBarNode.querySelector(declineSelector);
+  if (declineNode) {
+    declineNode.addEventListener("click", (event) => {
+      event.preventDefault();
+      const declinedGroups = filterCookieGroups(cookieGroups, declined.concat(undecided));
+      onDecline == null ? void 0 : onDecline(declinedGroups, event);
+      client.saveCookiesStatusBackend("declineUrl");
+      cookieBarNode.parentNode.removeChild(cookieBarNode);
+    });
+  }
+};
+var filterCookieGroups = (cookieGroups, varNames) => {
+  return cookieGroups.filter((group) => varNames.includes(group.varname));
+};
+function cloneNode(node) {
+  return node.cloneNode(true);
+}
+var showCookieBar = async (options = {}) => {
+  const {
+    templateSelector = "#cookie-consent__cookie-bar",
+    cookieGroupsSelector = "#cookie-consent__cookie-groups",
+    acceptSelector = ".cookie-consent__accept",
+    declineSelector = ".cookie-consent__decline",
+    insertBefore = null,
+    onShow,
+    onAccept,
+    onDecline,
+    statusUrl = "",
+    csrfHeaderName = "X-CSRFToken"
+    // Django's default, can be overridden with settings.CSRF_HEADER_NAME
+  } = options;
+  const cookieGroups = loadCookieGroups(cookieGroupsSelector);
+  if (!cookieGroups.length)
+    return;
+  const templateNode = document.querySelector(templateSelector);
+  if (!templateNode) {
+    throw new Error(`No (template) element found for selector '${templateSelector}'.`);
+  }
+  const doInsert = insertBefore === null ? (cookieBarNode2) => document.querySelector("body").appendChild(cookieBarNode2) : typeof insertBefore === "string" ? (cookieBarNode2) => {
+    const referenceNode = document.querySelector(insertBefore);
+    if (referenceNode === null)
+      throw new Error(`No element found for selector '${insertBefore}'.`);
+    doInsertBefore(referenceNode, cookieBarNode2);
+  } : (cookieBarNode2) => doInsertBefore(insertBefore, cookieBarNode2);
+  if (!statusUrl)
+    throw new Error("Missing status URL option, did you forget to pass the `statusUrl` option?");
+  const client = new FetchClient(statusUrl, csrfHeaderName);
+  const cookieStatus = await client.getCookieStatus();
+  const {
+    acceptedCookieGroups,
+    declinedCookieGroups,
+    notAcceptedOrDeclinedCookieGroups
+  } = cookieStatus;
+  const acceptedGroups = filterCookieGroups(cookieGroups, acceptedCookieGroups);
+  if (acceptedGroups.length)
+    onAccept == null ? void 0 : onAccept(acceptedGroups);
+  const declinedGroups = filterCookieGroups(cookieGroups, declinedCookieGroups);
+  if (declinedGroups.length)
+    onDecline == null ? void 0 : onDecline(declinedGroups);
+  if (!notAcceptedOrDeclinedCookieGroups.length)
+    return;
+  const childToClone = templateNode.content.firstElementChild;
+  if (childToClone === null)
+    throw new Error("The cookie bar template element may not be empty.");
+  const cookieBarNode = cloneNode(childToClone);
+  registerEvents({
+    client,
+    cookieBarNode,
+    cookieGroups,
+    acceptSelector,
+    onAccept,
+    declineSelector,
+    onDecline,
+    acceptedCookieGroups,
+    declinedCookieGroups,
+    notAcceptedOrDeclinedCookieGroups
+  });
+  doInsert(cookieBarNode);
+  onShow == null ? void 0 : onShow();
+};
+export {
+  loadCookieGroups,
+  showCookieBar
+};
+//# sourceMappingURL=cookiebar.module.js.map

django_cookie_consent-0.6.0/cookie_consent/static/cookie_consent/cookiebar.module.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../js/src/cookiebar.ts"],
+  "sourcesContent": ["/**\n * Cookiebar functionality, as a TS/JS module.\n *\n * About modules: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules\n *\n * The code is organized here in a way to make the templates work with Django's page\n * cache. This means that anything user-specific (so different django session and even\n * cookie consent cookies) cannot be baked into the templates, as that breaks caches.\n *\n * The cookie bar operates on the following principles:\n *\n * - The developer using the library includes the desired template in their django\n *   templates, using the HTML <template> element. This contains the content for the\n *   cookie bar.\n * - The developer is responsible for loading some Javascript that loads this script.\n * - The main export of this script needs to be called (showCookieBar), with the\n *   appropriate options.\n * - The options include the backend URLs where the retrieve data, which selectors/DOM\n *   nodes to use for various functionality and the hooks to tap into the accept/decline\n *   life-cycle.\n * - When a user accepts or declines (all) cookies, the call to the backend is made via\n *   a fetch request, bypassing any page caches and preventing full-page reloads.\n */\n\n/**\n * A serialized cookie group.\n *\n * See the backend model method `CookieGroup.as_json()`.\n */\nexport interface CookieGroup {\n  varname: string;\n  name: string;\n  description: string;\n  is_required: boolean;\n}\n\nexport interface Options {\n  statusUrl: string;\n  // TODO: also accept element rather than selector?\n  templateSelector: string;\n  /**\n   * DOM selector to the (script) tag holding the JSON-serialized cookie groups.\n   *\n   * This is typically rendered in a template with a template tag, e.g.\n   *\n   * ```django\n   * {% all_cookie_groups 'cookie-consent__cookie-groups' %}\n   * ```\n   *\n   * resulting in the selector: `'#cookie-consent__cookie-groups'`.\n   */\n  cookieGroupsSelector: string;\n  acceptSelector: string;\n  declineSelector: string;\n  /**\n   * Either a string (selector), DOMNode or null.\n   *\n   * If null, the bar is appended to the body. If provided, the node is used or looked\n   * up.\n   */\n  insertBefore: string | HTMLElement | null;\n  /**\n   * Optional callback for when the cookie bar is being shown.\n   *\n   * You can use this to add a CSS class name to the body, for example.\n   */\n  onShow?: () => void;\n  /**\n   * Optional callback called when cookies are accepted.\n   */\n  onAccept?: (acceptedGroups: CookieGroup[], event?: MouseEvent) => void;\n  /**\n   * Optional callback called when cookies are accepted.\n   */\n  onDecline?: (declinedGroups: CookieGroup[], event?: MouseEvent) => void;\n  /**\n   * Name of the header to use for the CSRF token.\n   *\n   * If needed, this can be read/set via `settings.CSRF_HEADER_NAME` in the backend.\n   */\n  csrfHeaderName: string;\n};\n\nexport interface CookieStatus {\n  csrftoken: string;\n  /**\n   * Backend endpoint to POST to to accept the cookie groups.\n   */\n  acceptUrl: string;\n  /**\n   * Backend endpoint to POST to to decline the cookie groups.\n   */\n  declineUrl: string;\n  /**\n   * Array of accepted cookie group varnames.\n   */\n  acceptedCookieGroups: string[];\n  /**\n   * Array of declined cookie group varnames.\n   */\n  declinedCookieGroups: string[];\n  /**\n   * Array of undecided cookie group varnames.\n   */\n  notAcceptedOrDeclinedCookieGroups: string[];\n}\n\nconst DEFAULT_FETCH_HEADERS: Record<string, string> = {\n  'X-Cookie-Consent-Fetch': '1'\n};\n\nclass FetchClient {\n  protected statusUrl: string;\n  protected csrfHeaderName: string;\n  protected cookieStatus: CookieStatus | null;\n\n  constructor(statusUrl: string, csrfHeaderName: string) {\n    this.statusUrl = statusUrl;\n    this.csrfHeaderName = csrfHeaderName;\n    this.cookieStatus = null;\n  }\n\n  async getCookieStatus(): Promise<CookieStatus> {\n    if (this.cookieStatus === null) {\n      const response = await window.fetch(\n        this.statusUrl,\n        {\n          method: 'GET',\n          credentials: 'same-origin',\n          headers: DEFAULT_FETCH_HEADERS,\n        }\n      );\n      this.cookieStatus = await response.json();\n    }\n\n    // type checker sanity check\n    if (this.cookieStatus === null) {\n      throw new Error('Unexpectedly received null cookie status');\n    }\n    return this.cookieStatus;\n  };\n\n  async saveCookiesStatusBackend (urlProperty: 'acceptUrl' | 'declineUrl') {\n    const cookieStatus = await this.getCookieStatus();\n    const url = cookieStatus[urlProperty];\n    if (!url) {\n      throw new Error(`Missing url for ${urlProperty} - was the cookie status not loaded properly?`);\n    }\n\n    await window.fetch(url, {\n      method: 'POST',\n      credentials: 'same-origin',\n      headers: {\n        ...DEFAULT_FETCH_HEADERS,\n        [this.csrfHeaderName]: cookieStatus.csrftoken\n      }\n    });\n  }\n}\n\n/**\n * Read the JSON script node contents and parse the content as JSON.\n *\n * The result is the list of available/configured cookie groups.\n * Use the status URL to get the accepted/declined status for an individual user.\n */\nexport const loadCookieGroups = (selector: string): CookieGroup[] => {\n  const node = document.querySelector<HTMLScriptElement>(selector);\n  if (!node) {\n    throw new Error(`No cookie groups (script) tag found, using selector: '${selector}'`);\n  }\n  return JSON.parse(node.innerText);\n};\n\nconst doInsertBefore = (beforeNode: HTMLElement, newNode: Node): void => {\n  const parent = beforeNode.parentNode;\n  if (parent === null) throw new Error('Reference node doesn\\'t have a parent.');\n  parent.insertBefore(newNode, beforeNode);\n}\n\ntype RegisterEventsOptions = Pick<\n  Options,\n  'acceptSelector' | 'onAccept' | 'declineSelector' | 'onDecline'\n> & Pick<\n  CookieStatus,\n  'acceptedCookieGroups' | 'declinedCookieGroups' | 'notAcceptedOrDeclinedCookieGroups'\n> & {\n  client: FetchClient,\n  cookieBarNode: Element;\n  cookieGroups: CookieGroup[];\n}\n\n/**\n * Register the accept/decline event handlers.\n *\n * Note that we can't just set the decline or accept cookie purely client-side, as the\n * cookie possibly has the httpOnly flag set.\n */\nconst registerEvents = ({\n  client,\n  cookieBarNode,\n  cookieGroups,\n  acceptSelector,\n  onAccept,\n  declineSelector,\n  onDecline,\n  acceptedCookieGroups: accepted,\n  declinedCookieGroups: declined,\n  notAcceptedOrDeclinedCookieGroups: undecided,\n}: RegisterEventsOptions): void => {\n\n  const acceptNode = cookieBarNode.querySelector<HTMLElement>(acceptSelector);\n  if (acceptNode) {\n    acceptNode.addEventListener('click', event => {\n      event.preventDefault();\n      const acceptedGroups = filterCookieGroups(cookieGroups, accepted.concat(undecided));\n      onAccept?.(acceptedGroups, event);\n      // trigger async action, but don't wait for completion\n      client.saveCookiesStatusBackend('acceptUrl');\n      cookieBarNode.parentNode!.removeChild(cookieBarNode);\n    });\n  }\n\n  const declineNode = cookieBarNode.querySelector<HTMLElement>(declineSelector);\n  if (declineNode) {\n    declineNode.addEventListener('click', event => {\n      event.preventDefault();\n      const declinedGroups = filterCookieGroups(cookieGroups, declined.concat(undecided));\n      onDecline?.(declinedGroups, event);\n      // trigger async action, but don't wait for completion\n      client.saveCookiesStatusBackend('declineUrl');\n      cookieBarNode.parentNode!.removeChild(cookieBarNode);\n    });\n  }\n};\n\n/**\n * Filter the cookie groups down to a subset of specified varnames.\n */\nconst filterCookieGroups = (cookieGroups: CookieGroup[], varNames: string[]) => {\n  return cookieGroups.filter(group => varNames.includes(group.varname));\n};\n\n// See https://github.com/microsoft/TypeScript/issues/283\nfunction cloneNode<T extends Node>(node: T) {\n  return <T>node.cloneNode(true);\n}\n\nexport const showCookieBar = async (options: Partial<Options> = {}): Promise<void> => {\n  const {\n    templateSelector = '#cookie-consent__cookie-bar',\n    cookieGroupsSelector = '#cookie-consent__cookie-groups',\n    acceptSelector = '.cookie-consent__accept',\n    declineSelector = '.cookie-consent__decline',\n    insertBefore = null,\n    onShow,\n    onAccept,\n    onDecline,\n    statusUrl = '',\n    csrfHeaderName = 'X-CSRFToken', // Django's default, can be overridden with settings.CSRF_HEADER_NAME\n  } = options;\n\n  const cookieGroups = loadCookieGroups(cookieGroupsSelector);\n\n  // no cookie groups -> abort, nothing to do\n  if (!cookieGroups.length) return;\n\n  const templateNode = document.querySelector<HTMLTemplateElement>(templateSelector);\n  if (!templateNode) {\n    throw new Error(`No (template) element found for selector '${templateSelector}'.`)\n  }\n\n  // insert before a given node, if specified, or append to the body as default behaviour\n  const doInsert = insertBefore === null\n    ? (cookieBarNode: Node) => document.querySelector('body')!.appendChild(cookieBarNode)\n    : typeof insertBefore === 'string'\n      ? (cookieBarNode: Node) => {\n        const referenceNode = document.querySelector<HTMLElement>(insertBefore);\n        if (referenceNode === null) throw new Error(`No element found for selector '${insertBefore}'.`)\n        doInsertBefore(referenceNode, cookieBarNode);\n      }\n      : (cookieBarNode: Node) => doInsertBefore(insertBefore, cookieBarNode)\n  ;\n\n  if (!statusUrl) throw new Error('Missing status URL option, did you forget to pass the `statusUrl` option?');\n\n  const client = new FetchClient(statusUrl, csrfHeaderName);\n  const cookieStatus = await client.getCookieStatus();\n\n  // calculate the cookie groups to invoke the callbacks. We deliberately fire those\n  // without awaiting so that our cookie bar is shown/hidden as soon as possible.\n  const {\n    acceptedCookieGroups,\n    declinedCookieGroups,\n    notAcceptedOrDeclinedCookieGroups\n  } = cookieStatus;\n\n  const acceptedGroups = filterCookieGroups(cookieGroups, acceptedCookieGroups);\n  if (acceptedGroups.length) onAccept?.(acceptedGroups);\n  const declinedGroups = filterCookieGroups(cookieGroups, declinedCookieGroups);\n  if (declinedGroups.length) onDecline?.(declinedGroups);\n\n  // there are no (more) cookie groups to accept, don't show the bar\n  if (!notAcceptedOrDeclinedCookieGroups.length) return;\n\n  // grab the contents from the template node and add them to the DOM, optionally\n  // calling the onShow callback\n  const childToClone = templateNode.content.firstElementChild;\n  if (childToClone === null) throw new Error('The cookie bar template element may not be empty.');\n  const cookieBarNode = cloneNode(childToClone);\n  registerEvents({\n    client,\n    cookieBarNode,\n    cookieGroups,\n    acceptSelector,\n    onAccept,\n    declineSelector,\n    onDecline,\n    acceptedCookieGroups,\n    declinedCookieGroups,\n    notAcceptedOrDeclinedCookieGroups,\n  });\n  doInsert(cookieBarNode);\n  onShow?.();\n};\n"],
+  "mappings": ";AA2GA,IAAM,wBAAgD;AAAA,EACpD,0BAA0B;AAC5B;AAEA,IAAM,cAAN,MAAkB;AAAA,EAKhB,YAAY,WAAmB,gBAAwB;AACrD,SAAK,YAAY;AACjB,SAAK,iBAAiB;AACtB,SAAK,eAAe;AAAA,EACtB;AAAA,EAEA,MAAM,kBAAyC;AAC7C,QAAI,KAAK,iBAAiB,MAAM;AAC9B,YAAM,WAAW,MAAM,OAAO;AAAA,QAC5B,KAAK;AAAA,QACL;AAAA,UACE,QAAQ;AAAA,UACR,aAAa;AAAA,UACb,SAAS;AAAA,QACX;AAAA,MACF;AACA,WAAK,eAAe,MAAM,SAAS,KAAK;AAAA,IAC1C;AAGA,QAAI,KAAK,iBAAiB,MAAM;AAC9B,YAAM,IAAI,MAAM,0CAA0C;AAAA,IAC5D;AACA,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,MAAM,yBAA0B,aAAyC;AACvE,UAAM,eAAe,MAAM,KAAK,gBAAgB;AAChD,UAAM,MAAM,aAAa,WAAW;AACpC,QAAI,CAAC,KAAK;AACR,YAAM,IAAI,MAAM,mBAAmB,WAAW,+CAA+C;AAAA,IAC/F;AAEA,UAAM,OAAO,MAAM,KAAK;AAAA,MACtB,QAAQ;AAAA,MACR,aAAa;AAAA,MACb,SAAS;AAAA,QACP,GAAG;AAAA,QACH,CAAC,KAAK,cAAc,GAAG,aAAa;AAAA,MACtC;AAAA,IACF,CAAC;AAAA,EACH;AACF;AAQO,IAAM,mBAAmB,CAAC,aAAoC;AACnE,QAAM,OAAO,SAAS,cAAiC,QAAQ;AAC/D,MAAI,CAAC,MAAM;AACT,UAAM,IAAI,MAAM,yDAAyD,QAAQ,GAAG;AAAA,EACtF;AACA,SAAO,KAAK,MAAM,KAAK,SAAS;AAClC;AAEA,IAAM,iBAAiB,CAAC,YAAyB,YAAwB;AACvE,QAAM,SAAS,WAAW;AAC1B,MAAI,WAAW;AAAM,UAAM,IAAI,MAAM,uCAAwC;AAC7E,SAAO,aAAa,SAAS,UAAU;AACzC;AAoBA,IAAM,iBAAiB,CAAC;AAAA,EACtB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA,sBAAsB;AAAA,EACtB,sBAAsB;AAAA,EACtB,mCAAmC;AACrC,MAAmC;AAEjC,QAAM,aAAa,cAAc,cAA2B,cAAc;AAC1E,MAAI,YAAY;AACd,eAAW,iBAAiB,SAAS,WAAS;AAC5C,YAAM,eAAe;AACrB,YAAM,iBAAiB,mBAAmB,cAAc,SAAS,OAAO,SAAS,CAAC;AAClF,2CAAW,gBAAgB;AAE3B,aAAO,yBAAyB,WAAW;AAC3C,oBAAc,WAAY,YAAY,aAAa;AAAA,IACrD,CAAC;AAAA,EACH;AAEA,QAAM,cAAc,cAAc,cAA2B,eAAe;AAC5E,MAAI,aAAa;AACf,gBAAY,iBAAiB,SAAS,WAAS;AAC7C,YAAM,eAAe;AACrB,YAAM,iBAAiB,mBAAmB,cAAc,SAAS,OAAO,SAAS,CAAC;AAClF,6CAAY,gBAAgB;AAE5B,aAAO,yBAAyB,YAAY;AAC5C,oBAAc,WAAY,YAAY,aAAa;AAAA,IACrD,CAAC;AAAA,EACH;AACF;AAKA,IAAM,qBAAqB,CAAC,cAA6B,aAAuB;AAC9E,SAAO,aAAa,OAAO,WAAS,SAAS,SAAS,MAAM,OAAO,CAAC;AACtE;AAGA,SAAS,UAA0B,MAAS;AAC1C,SAAU,KAAK,UAAU,IAAI;AAC/B;AAEO,IAAM,gBAAgB,OAAO,UAA4B,CAAC,MAAqB;AACpF,QAAM;AAAA,IACJ,mBAAmB;AAAA,IACnB,uBAAuB;AAAA,IACvB,iBAAiB;AAAA,IACjB,kBAAkB;AAAA,IAClB,eAAe;AAAA,IACf;AAAA,IACA;AAAA,IACA;AAAA,IACA,YAAY;AAAA,IACZ,iBAAiB;AAAA;AAAA,EACnB,IAAI;AAEJ,QAAM,eAAe,iBAAiB,oBAAoB;AAG1D,MAAI,CAAC,aAAa;AAAQ;AAE1B,QAAM,eAAe,SAAS,cAAmC,gBAAgB;AACjF,MAAI,CAAC,cAAc;AACjB,UAAM,IAAI,MAAM,6CAA6C,gBAAgB,IAAI;AAAA,EACnF;AAGA,QAAM,WAAW,iBAAiB,OAC9B,CAACA,mBAAwB,SAAS,cAAc,MAAM,EAAG,YAAYA,cAAa,IAClF,OAAO,iBAAiB,WACtB,CAACA,mBAAwB;AACzB,UAAM,gBAAgB,SAAS,cAA2B,YAAY;AACtE,QAAI,kBAAkB;AAAM,YAAM,IAAI,MAAM,kCAAkC,YAAY,IAAI;AAC9F,mBAAe,eAAeA,cAAa;AAAA,EAC7C,IACE,CAACA,mBAAwB,eAAe,cAAcA,cAAa;AAGzE,MAAI,CAAC;AAAW,UAAM,IAAI,MAAM,2EAA2E;AAE3G,QAAM,SAAS,IAAI,YAAY,WAAW,cAAc;AACxD,QAAM,eAAe,MAAM,OAAO,gBAAgB;AAIlD,QAAM;AAAA,IACJ;AAAA,IACA;AAAA,IACA;AAAA,EACF,IAAI;AAEJ,QAAM,iBAAiB,mBAAmB,cAAc,oBAAoB;AAC5E,MAAI,eAAe;AAAQ,yCAAW;AACtC,QAAM,iBAAiB,mBAAmB,cAAc,oBAAoB;AAC5E,MAAI,eAAe;AAAQ,2CAAY;AAGvC,MAAI,CAAC,kCAAkC;AAAQ;AAI/C,QAAM,eAAe,aAAa,QAAQ;AAC1C,MAAI,iBAAiB;AAAM,UAAM,IAAI,MAAM,mDAAmD;AAC9F,QAAM,gBAAgB,UAAU,YAAY;AAC5C,iBAAe;AAAA,IACb;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC;AACD,WAAS,aAAa;AACtB;AACF;",
+  "names": ["cookieBarNode"]
+}

{django-cookie-consent-0.4.0.dev0 → django_cookie_consent-0.6.0}/cookie_consent/templatetags/cookie_consent_tags.py

@@ -1,13 +1,12 @@
-# -*- coding: utf-8 -*-
-from django import template
+import warnings
 
-try:
-    from django.urls import reverse
-except ImportError:
-    from django.core.urlresolvers import reverse
+from django import template
+from django.urls import reverse
+from django.utils.html import json_script
 
-from cookie_consent.conf import settings
-from cookie_consent.util import (
+from ..cache import all_cookie_groups as get_all_cookie_groups
+from ..conf import settings
+from ..util import (
     are_all_cookies_accepted,
     get_accepted_cookies,
     get_cookie_dict_from_request,
@@ -90,10 +89,15 @@ def cookie_consent_decline_url(cookie_groups):
 
 
 @register.simple_tag
-def get_accept_cookie_groups_cookie_string(request, cookie_groups):
+def get_accept_cookie_groups_cookie_string(request, cookie_groups):  # pragma: no cover
     """
     Tag returns accept cookie string suitable to use in javascript.
     """
+    warnings.warn(
+        "Cookie string template tags for JS are deprecated and will be removed "
+        "in django-cookie-consent 1.0",
+        DeprecationWarning,
+    )
     cookie_dic = get_cookie_dict_from_request(request)
     for cookie_group in cookie_groups:
         cookie_dic[cookie_group.varname] = cookie_group.get_version()
@@ -105,6 +109,11 @@ def get_decline_cookie_groups_cookie_string(request, cookie_groups):
     """
     Tag returns decline cookie string suitable to use in javascript.
     """
+    warnings.warn(
+        "Cookie string template tags for JS are deprecated and will be removed "
+        "in django-cookie-consent 1.0",
+        DeprecationWarning,
+    )
     cookie_dic = get_cookie_dict_from_request(request)
     for cookie_group in cookie_groups:
         cookie_dic[cookie_group.varname] = settings.COOKIE_CONSENT_DECLINE
@@ -124,6 +133,13 @@ def js_type_for_cookie_consent(request, varname, cookie=None):
         alert("Social cookie accepted");
       </script>
     """
+    # This approach doesn't work with page caches and/or strict Content-Security-Policies
+    # (unless you use nonces, which again doesn't work with aggressive page caching).
+    warnings.warn(
+        "Template tags for use in/with JS are deprecated and will be removed "
+        "in django-cookie-consent 1.0",
+        DeprecationWarning,
+    )
     enabled = is_cookie_consent_enabled(request)
     if not enabled:
         res = True
@@ -147,3 +163,17 @@ def accepted_cookies(request):
 
     """
     return [c.varname for c in get_accepted_cookies(request)]
+
+
+@register.simple_tag
+def all_cookie_groups(element_id: str):
+    """
+    Serialize all cookie groups to JSON and output them in a script tag.
+
+    :param element_id: The ID for the script tag so you can look it up in JS later.
+
+    This uses Django's core json_script filter under the hood.
+    """
+    groups = get_all_cookie_groups()
+    value = [group.for_json() for group in groups.values()]
+    return json_script(value, element_id)