django-cookie-consent 0.7.0__tar.gz → 0.9.0__tar.gz

django_cookie_consent-0.9.0/PKG-INFO

@@ -0,0 +1,95 @@
+Metadata-Version: 2.4
+Name: django-cookie-consent
+Version: 0.9.0
+Summary: Django cookie consent application
+Author-email: Informatika Mihelac <bmihelac@mihelac.org>
+License-Expression: BSD-2-Clause-first-lines
+Project-URL: Documentation, https://django-cookie-consent.readthedocs.io/en/latest/
+Project-URL: Changelog, https://github.com/django-commons/django-cookie-consent/blob/master/docs/changelog.rst
+Project-URL: Bug Tracker, https://github.com/django-commons/django-cookie-consent/issues
+Project-URL: Source Code, https://github.com/django-commons/django-cookie-consent
+Keywords: cookies,cookie-consent,cookie bar
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.1
+Classifier: Framework :: Django :: 5.2
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: Unix
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: django>=4.2
+Requires-Dist: django-appconf
+Provides-Extra: tests
+Requires-Dist: pytest; extra == "tests"
+Requires-Dist: pytest-cov; extra == "tests"
+Requires-Dist: pytest-django; extra == "tests"
+Requires-Dist: pytest-playwright; extra == "tests"
+Requires-Dist: hypothesis; extra == "tests"
+Requires-Dist: tox; extra == "tests"
+Requires-Dist: ruff; extra == "tests"
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx-rtd-theme; extra == "docs"
+Provides-Extra: release
+Requires-Dist: tbump; extra == "release"
+Dynamic: license-file
+
+Django cookie consent
+=====================
+
+Manage cookie information and let visitors give or reject consent for them.
+
+![License](https://img.shields.io/pypi/l/django-cookie-consent)
+[![Build status][badge:GithubActions:CI]][GithubActions:CI]
+[![Code Quality][badge:GithubActions:CQ]][GithubActions:CQ]
+[![Code style: ruff][badge:ruff]][ruff]
+[![Test coverage][badge:codecov]][codecov]
+[![Documentation][badge:docs]][docs]
+
+![Supported python versions](https://img.shields.io/pypi/pyversions/django-cookie-consent)
+![Supported Django versions](https://img.shields.io/pypi/djversions/django-cookie-consent)
+[![PyPI version][badge:pypi]][pypi]
+[![NPM version][badge:npm]][npm]
+
+**Features**
+
+* cookies and cookie groups are stored in models for easy management
+  through Django admin interface
+* support for both opt-in and opt-out cookie consent schemes
+* removing declined cookies (or non accepted when opt-in scheme is used)
+* logging user actions when they accept and decline various cookies
+* easy adding new cookies and seamlessly re-asking for consent for new cookies
+
+Documentation
+-------------
+
+The documentation is hosted on [readthedocs][docs] and contains all instructions
+to get started.
+
+Alternatively, if the documentation is not available, you can consult or build the docs
+from the `docs` directory in this repository.
+
+[GithubActions:CI]: https://github.com/django-commons/django-cookie-consent/actions?query=workflow%3A%22Run+CI%22
+[badge:GithubActions:CI]: https://github.com/django-commons/django-cookie-consent/workflows/Run%20CI/badge.svg
+[GithubActions:CQ]: https://github.com/django-commons/django-cookie-consent/actions?query=workflow%3A%22Code+quality+checks%22
+[badge:GithubActions:CQ]: https://github.com/django-commons/django-cookie-consent/workflows/Code%20quality%20checks/badge.svg
+[ruff]: https://github.com/astral-sh/ruff
+[badge:ruff]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+[codecov]: https://codecov.io/gh/django-commons/django-cookie-consent
+[badge:codecov]: https://codecov.io/gh/django-commons/django-cookie-consent/branch/master/graph/badge.svg
+[docs]: https://django-cookie-consent.readthedocs.io/en/latest/?badge=latest
+[badge:docs]: https://readthedocs.org/projects/django-cookie-consent/badge/?version=latest
+[pypi]: https://pypi.org/project/django-cookie-consent/
+[badge:pypi]: https://img.shields.io/pypi/v/django-cookie-consent.svg
+[npm]: https://www.npmjs.com/package/django-cookie-consent
+[badge:npm]: https://img.shields.io/npm/v/django-cookie-consent

{django_cookie_consent-0.7.0 → django_cookie_consent-0.9.0}/README.md

@@ -3,18 +3,17 @@ Django cookie consent
 
 Manage cookie information and let visitors give or reject consent for them.
 
-[![Jazzband][badge:jazzband]][jazzband]
-
 ![License](https://img.shields.io/pypi/l/django-cookie-consent)
 [![Build status][badge:GithubActions:CI]][GithubActions:CI]
 [![Code Quality][badge:GithubActions:CQ]][GithubActions:CQ]
-[![Code style: black][badge:black]][black]
+[![Code style: ruff][badge:ruff]][ruff]
 [![Test coverage][badge:codecov]][codecov]
 [![Documentation][badge:docs]][docs]
 
 ![Supported python versions](https://img.shields.io/pypi/pyversions/django-cookie-consent)
 ![Supported Django versions](https://img.shields.io/pypi/djversions/django-cookie-consent)
 [![PyPI version][badge:pypi]][pypi]
+[![NPM version][badge:npm]][npm]
 
 **Features**
 
@@ -34,17 +33,17 @@ to get started.
 Alternatively, if the documentation is not available, you can consult or build the docs
 from the `docs` directory in this repository.
 
-[jazzband]: https://jazzband.co/
-[badge:jazzband]: https://jazzband.co/static/img/badge.svg
-[GithubActions:CI]: https://github.com/jazzband/django-cookie-consent/actions?query=workflow%3A%22Run+CI%22
-[badge:GithubActions:CI]: https://github.com/jazzband/django-cookie-consent/workflows/Run%20CI/badge.svg
-[GithubActions:CQ]: https://github.com/jazzband/django-cookie-consent/actions?query=workflow%3A%22Code+quality+checks%22
-[badge:GithubActions:CQ]: https://github.com/jazzband/django-cookie-consent/workflows/Code%20quality%20checks/badge.svg
-[black]: https://github.com/psf/black
-[badge:black]: https://img.shields.io/badge/code%20style-black-000000.svg
-[codecov]: https://codecov.io/gh/jazzband/django-cookie-consent
-[badge:codecov]: https://codecov.io/gh/jazzband/django-cookie-consent/branch/master/graph/badge.svg
+[GithubActions:CI]: https://github.com/django-commons/django-cookie-consent/actions?query=workflow%3A%22Run+CI%22
+[badge:GithubActions:CI]: https://github.com/django-commons/django-cookie-consent/workflows/Run%20CI/badge.svg
+[GithubActions:CQ]: https://github.com/django-commons/django-cookie-consent/actions?query=workflow%3A%22Code+quality+checks%22
+[badge:GithubActions:CQ]: https://github.com/django-commons/django-cookie-consent/workflows/Code%20quality%20checks/badge.svg
+[ruff]: https://github.com/astral-sh/ruff
+[badge:ruff]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+[codecov]: https://codecov.io/gh/django-commons/django-cookie-consent
+[badge:codecov]: https://codecov.io/gh/django-commons/django-cookie-consent/branch/master/graph/badge.svg
 [docs]: https://django-cookie-consent.readthedocs.io/en/latest/?badge=latest
 [badge:docs]: https://readthedocs.org/projects/django-cookie-consent/badge/?version=latest
 [pypi]: https://pypi.org/project/django-cookie-consent/
 [badge:pypi]: https://img.shields.io/pypi/v/django-cookie-consent.svg
+[npm]: https://www.npmjs.com/package/django-cookie-consent
+[badge:npm]: https://img.shields.io/npm/v/django-cookie-consent

django_cookie_consent-0.9.0/cookie_consent/__init__.py

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

{django_cookie_consent-0.7.0 → django_cookie_consent-0.9.0}/cookie_consent/admin.py

@@ -1,5 +1,9 @@
-# -*- coding: utf-8 -*-
 from django.contrib import admin
+from django.db.models import Count
+from django.templatetags.l10n import localize
+from django.templatetags.static import static
+from django.utils.html import format_html
+from django.utils.translation import gettext_lazy as _
 
 from .conf import settings
 from .models import Cookie, CookieGroup, LogItem
@@ -13,7 +17,14 @@ class CookieAdmin(admin.ModelAdmin):
 
 
 class CookieGroupAdmin(admin.ModelAdmin):
-    list_display = ("varname", "name", "is_required", "is_deletable", "get_version")
+    list_display = (
+        "varname",
+        "name",
+        "is_required",
+        "is_deletable",
+        "num_cookies",
+        "get_version",
+    )
     search_fields = (
         "varname",
         "name",
@@ -23,6 +34,22 @@ class CookieGroupAdmin(admin.ModelAdmin):
         "is_deletable",
     )
 
+    def get_queryset(self, request):
+        qs = super().get_queryset(request)
+        return qs.annotate(num_cookies=Count("cookie"))
+
+    @admin.display(ordering="num_cookies", description=_("# cookies"))
+    def num_cookies(self, obj):
+        if (count := obj.num_cookies) > 0:
+            return localize(count)
+
+        return format_html(
+            '{count} <img src="{src}" alt="{alt}">',
+            count=localize(count),
+            src=static("admin/img/icon-alert.svg"),
+            alt=_("Warning icon for missing cookies in cookie group."),
+        )
+
 
 class LogItemAdmin(admin.ModelAdmin):
     list_display = ("action", "cookiegroup", "version", "created")

{django_cookie_consent-0.7.0 → django_cookie_consent-0.9.0}/cookie_consent/cache.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 from django.core.cache import caches
 
 from .conf import settings

{django_cookie_consent-0.7.0 → django_cookie_consent-0.9.0}/cookie_consent/conf.py

@@ -1,7 +1,7 @@
-# -*- coding: utf-8 -*-
 from django.conf import settings  # NOQA
 
 from appconf import AppConf
+from django.urls import reverse_lazy
 
 __all__ = ["settings"]
 
@@ -25,3 +25,5 @@ class CookieConsentConf(AppConf):
     CACHE_BACKEND = "default"
 
     LOG_ENABLED = True
+
+    SUCCESS_URL = reverse_lazy("cookie_consent_cookie_group_list")

{django_cookie_consent-0.7.0 → django_cookie_consent-0.9.0}/cookie_consent/middleware.py

@@ -1,12 +1,9 @@
-# -*- coding: utf-8 -*-
-from typing import Optional
-
 from .cache import all_cookie_groups
 from .conf import settings
 from .util import get_cookie_dict_from_request, is_cookie_consent_enabled
 
 
-def _should_delete_cookie(group_version: Optional[str]) -> bool:
+def _should_delete_cookie(group_version: str | None) -> bool:
     # declined after it was accepted (and set) before
     if group_version == settings.COOKIE_CONSENT_DECLINE:
         return True

{django_cookie_consent-0.7.0 → django_cookie_consent-0.9.0}/cookie_consent/migrations/0001_initial.py

@@ -68,7 +68,8 @@ class Migration(migrations.Migration):
                         validators=[
                             django.core.validators.RegexValidator(
                                 re.compile("^[-_a-zA-Z0-9]+$"),
-                                "Enter a valid 'varname' consisting of letters, numbers, underscores or hyphens.",
+                                "Enter a valid 'varname' consisting of letters, "
+                                "numbers, underscores or hyphens.",
                                 "invalid",
                             )
                         ],

{django_cookie_consent-0.7.0 → django_cookie_consent-0.9.0}/cookie_consent/migrations/0003_alter_cookiegroup_varname.py

@@ -7,7 +7,6 @@ from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("cookie_consent", "0002_auto__add_logitem"),
     ]
@@ -22,7 +21,8 @@ class Migration(migrations.Migration):
                 validators=[
                     django.core.validators.RegexValidator(
                         re.compile("^[-_a-zA-Z0-9]+$"),
-                        "Enter a valid 'varname' consisting of letters, numbers, underscores or hyphens.",
+                        "Enter a valid 'varname' consisting of letters, numbers, "
+                        "underscores or hyphens.",
                         "invalid",
                     )
                 ],

{django_cookie_consent-0.7.0 → django_cookie_consent-0.9.0}/cookie_consent/migrations/0004_cookie_natural_key.py

@@ -4,7 +4,6 @@ from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("cookie_consent", "0003_alter_cookiegroup_varname"),
     ]

{django_cookie_consent-0.7.0 → django_cookie_consent-0.9.0}/cookie_consent/models.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 import re
 from typing import TypedDict
 
@@ -144,7 +143,7 @@ class Cookie(models.Model):
         ordering = ["-created"]
 
     def __str__(self):
-        return "%s %s%s" % (self.name, self.domain, self.path)
+        return f"{self.name} {self.domain}{self.path}"
 
     @clear_cache_after
     def save(self, *args, **kwargs):
@@ -161,7 +160,8 @@ class Cookie(models.Model):
 
     @property
     def varname(self):
-        return "%s=%s:%s" % (self.cookiegroup.varname, self.name, self.domain)
+        group_varname = self.cookiegroup.varname
+        return f"{group_varname}={self.name}:{self.domain}"
 
     def get_version(self):
         return self.created.isoformat()
@@ -185,10 +185,10 @@ class LogItem(models.Model):
     version = models.CharField(_("Version"), max_length=32)
     created = models.DateTimeField(_("Created"), auto_now_add=True, blank=True)
 
-    def __str__(self):
-        return "%s %s" % (self.cookiegroup.name, self.version)
-
     class Meta:
         verbose_name = _("Log item")
         verbose_name_plural = _("Log items")
         ordering = ["-created"]
+
+    def __str__(self):
+        return f"{self.cookiegroup.name} {self.version}"

django_cookie_consent-0.9.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\n/**\n * A simple wrapper around window.fetch that understands the django-cookie-consent\n * backend endpoints.\n *\n * @private - while exported, use at your own risk. This class is not part of the\n * public API covered by SemVer.\n */\nexport class 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;AASO,IAAM,cAAN,MAAkB;AAAA,EAKvB,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,KAAM,OAAM,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,OAAQ;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,KAAM,OAAM,IAAI,MAAM,kCAAkC,YAAY,IAAI;AAC9F,mBAAe,eAAeA,cAAa;AAAA,EAC7C,IACE,CAACA,mBAAwB,eAAe,cAAcA,cAAa;AAGzE,MAAI,CAAC,UAAW,OAAM,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,OAAQ,sCAAW;AACtC,QAAM,iBAAiB,mBAAmB,cAAc,oBAAoB;AAC5E,MAAI,eAAe,OAAQ,wCAAY;AAGvC,MAAI,CAAC,kCAAkC,OAAQ;AAI/C,QAAM,eAAe,aAAa,QAAQ;AAC1C,MAAI,iBAAiB,KAAM,OAAM,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.9.0/cookie_consent/templatetags/__init__.py

@@ -0,0 +1 @@
+#!/usr/bin/env python

{django_cookie_consent-0.7.0 → django_cookie_consent-0.9.0}/cookie_consent/templatetags/cookie_consent_tags.py

@@ -97,6 +97,7 @@ def get_accept_cookie_groups_cookie_string(request, cookie_groups):  # pragma: n
         "Cookie string template tags for JS are deprecated and will be removed "
         "in django-cookie-consent 1.0",
         DeprecationWarning,
+        stacklevel=1,
     )
     cookie_dic = get_cookie_dict_from_request(request)
     for cookie_group in cookie_groups:
@@ -113,6 +114,7 @@ def get_decline_cookie_groups_cookie_string(request, cookie_groups):
         "Cookie string template tags for JS are deprecated and will be removed "
         "in django-cookie-consent 1.0",
         DeprecationWarning,
+        stacklevel=1,
     )
     cookie_dic = get_cookie_dict_from_request(request)
     for cookie_group in cookie_groups:
@@ -133,12 +135,14 @@ 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).
+    # 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,
+        stacklevel=1,
     )
     enabled = is_cookie_consent_enabled(request)
     if not enabled:
@@ -162,6 +166,12 @@ def accepted_cookies(request):
         {{ request|accepted_cookies }}
 
     """
+    warnings.warn(
+        "The 'accepted_cookies' template filter is deprecated and will be removed"
+        "in django-cookie-consent 1.0.",
+        DeprecationWarning,
+        stacklevel=1,
+    )
     return [c.varname for c in get_accepted_cookies(request)]
 
 

{django_cookie_consent-0.7.0 → django_cookie_consent-0.9.0}/cookie_consent/urls.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 from django.urls import path, re_path
 from django.views.decorators.csrf import csrf_exempt
 

{django_cookie_consent-0.7.0 → django_cookie_consent-0.9.0}/cookie_consent/util.py

@@ -1,24 +1,62 @@
-# -*- coding: utf-8 -*-
 import datetime
-from typing import Union
+import logging
 
 from .cache import all_cookie_groups, get_cookie, get_cookie_group
 from .conf import settings
 from .models import ACTION_ACCEPTED, ACTION_DECLINED, LogItem
 
+logger = logging.getLogger(__name__)
 
-def parse_cookie_str(cookie):
-    dic = {}
+COOKIE_GROUP_SEP = "|"
+KEY_VALUE_SEP = "="
+
+
+def parse_cookie_str(cookie: str) -> dict[str, str]:
     if not cookie:
-        return dic
-    for c in cookie.split("|"):
-        key, value = c.split("=")
-        dic[key] = value
-    return dic
+        return {}
+
+    bits = cookie.split(COOKIE_GROUP_SEP)
+
+    def _gen_pairs():
+        for possible_pair in bits:
+            parts = possible_pair.split(KEY_VALUE_SEP)
+            if len(parts) == 2:
+                yield parts
+            else:
+                logger.debug("cookie_value_discarded", extra={"value": possible_pair})
+
+    return dict(_gen_pairs())
+
+
+def _contains_invalid_characters(*inputs: str) -> bool:
+    # = and | are special separators. They are unexpected characters in both
+    # keys and values.
+    for separator in (COOKIE_GROUP_SEP, KEY_VALUE_SEP):
+        for value in inputs:
+            if separator in value:
+                logger.debug("skip_separator", extra={"value": value, "sep": separator})
+                return True
+    return False
+
+
+def dict_to_cookie_str(dic) -> str:
+    """
+    Serialize a dictionary of cookie-group metadata to a string.
+
+    The result is stored in a cookie itself. Note that the dictionary keys are expected
+    to be cookie group ``varname`` fields, which are validated against a slug regex. The
+    values are supposed to be ISO-8601 timestamps.
+
+    Invalid key/value pairs are dropped.
+    """
 
+    def _gen_pairs():
+        for key, value in dic.items():
+            if _contains_invalid_characters(key, value):
+                continue
+            yield f"{key}={value}"
 
-def dict_to_cookie_str(dic):
-    return "|".join(["%s=%s" % (k, v) for k, v in dic.items() if v])
+    return "|".join(_gen_pairs())
 
 
 def get_cookie_dict_from_request(request):
@@ -131,7 +169,7 @@ def are_all_cookies_accepted(request):
     )
 
 
-def _get_cookie_groups_by_state(request, state: Union[bool, None]):
+def _get_cookie_groups_by_state(request, state: bool | None):
     return [
         cookie_group
         for cookie_group in get_cookie_groups()
@@ -171,6 +209,7 @@ def is_cookie_consent_enabled(request):
         return enabled
 
 
+# Deprecated
 def get_cookie_string(cookie_dic):
     """
     Returns cookie in format suitable for use in javascript.
@@ -178,7 +217,7 @@ def get_cookie_string(cookie_dic):
     expires = datetime.datetime.now() + datetime.timedelta(
         seconds=settings.COOKIE_CONSENT_MAX_AGE
     )
-    cookie_str = "%s=%s; expires=%s; path=/" % (
+    cookie_str = "{}={}; expires={}; path=/".format(
         settings.COOKIE_CONSENT_NAME,
         dict_to_cookie_str(cookie_dic),
         expires.strftime("%a, %d %b %Y %H:%M:%S GMT"),
@@ -198,5 +237,5 @@ def get_accepted_cookies(request):
             continue
         for cookie in cookie_group.cookie_set.all():
             if version >= cookie.get_version():
-                accepted_cookies.append(cookie)
+                accepted_cookies.append(cookie)  # noqa: PERF401
     return accepted_cookies

{django_cookie_consent-0.7.0 → django_cookie_consent-0.9.0}/cookie_consent/views.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 from django.contrib.auth.views import RedirectURLMixin
 from django.core.exceptions import SuspiciousOperation
 from django.http import HttpRequest, HttpResponse, HttpResponseRedirect, JsonResponse
@@ -7,6 +6,7 @@ from django.urls import reverse
 from django.utils.http import url_has_allowed_host_and_scheme
 from django.views.generic import ListView, View
 
+from .conf import settings
 from .models import CookieGroup
 from .util import (
     accept_cookies,
@@ -49,7 +49,7 @@ class CookieGroupBaseProcessView(RedirectURLMixin, View):
             require_https=self.request.is_secure(),
         ):
             raise SuspiciousOperation("Unsafe open redirect suspected.")
-        return redirect_to or reverse("cookie_consent_cookie_group_list")
+        return redirect_to or settings.COOKIE_CONSENT_SUCCESS_URL
 
     def process(self, request, response, varname):  # pragma: no cover
         raise NotImplementedError()

django_cookie_consent-0.9.0/django_cookie_consent.egg-info/PKG-INFO

@@ -0,0 +1,95 @@
+Metadata-Version: 2.4
+Name: django-cookie-consent
+Version: 0.9.0
+Summary: Django cookie consent application
+Author-email: Informatika Mihelac <bmihelac@mihelac.org>
+License-Expression: BSD-2-Clause-first-lines
+Project-URL: Documentation, https://django-cookie-consent.readthedocs.io/en/latest/
+Project-URL: Changelog, https://github.com/django-commons/django-cookie-consent/blob/master/docs/changelog.rst
+Project-URL: Bug Tracker, https://github.com/django-commons/django-cookie-consent/issues
+Project-URL: Source Code, https://github.com/django-commons/django-cookie-consent
+Keywords: cookies,cookie-consent,cookie bar
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.1
+Classifier: Framework :: Django :: 5.2
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: Unix
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: django>=4.2
+Requires-Dist: django-appconf
+Provides-Extra: tests
+Requires-Dist: pytest; extra == "tests"
+Requires-Dist: pytest-cov; extra == "tests"
+Requires-Dist: pytest-django; extra == "tests"
+Requires-Dist: pytest-playwright; extra == "tests"
+Requires-Dist: hypothesis; extra == "tests"
+Requires-Dist: tox; extra == "tests"
+Requires-Dist: ruff; extra == "tests"
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx-rtd-theme; extra == "docs"
+Provides-Extra: release
+Requires-Dist: tbump; extra == "release"
+Dynamic: license-file
+
+Django cookie consent
+=====================
+
+Manage cookie information and let visitors give or reject consent for them.
+
+![License](https://img.shields.io/pypi/l/django-cookie-consent)
+[![Build status][badge:GithubActions:CI]][GithubActions:CI]
+[![Code Quality][badge:GithubActions:CQ]][GithubActions:CQ]
+[![Code style: ruff][badge:ruff]][ruff]
+[![Test coverage][badge:codecov]][codecov]
+[![Documentation][badge:docs]][docs]
+
+![Supported python versions](https://img.shields.io/pypi/pyversions/django-cookie-consent)
+![Supported Django versions](https://img.shields.io/pypi/djversions/django-cookie-consent)
+[![PyPI version][badge:pypi]][pypi]
+[![NPM version][badge:npm]][npm]
+
+**Features**
+
+* cookies and cookie groups are stored in models for easy management
+  through Django admin interface
+* support for both opt-in and opt-out cookie consent schemes
+* removing declined cookies (or non accepted when opt-in scheme is used)
+* logging user actions when they accept and decline various cookies
+* easy adding new cookies and seamlessly re-asking for consent for new cookies
+
+Documentation
+-------------
+
+The documentation is hosted on [readthedocs][docs] and contains all instructions
+to get started.
+
+Alternatively, if the documentation is not available, you can consult or build the docs
+from the `docs` directory in this repository.
+
+[GithubActions:CI]: https://github.com/django-commons/django-cookie-consent/actions?query=workflow%3A%22Run+CI%22
+[badge:GithubActions:CI]: https://github.com/django-commons/django-cookie-consent/workflows/Run%20CI/badge.svg
+[GithubActions:CQ]: https://github.com/django-commons/django-cookie-consent/actions?query=workflow%3A%22Code+quality+checks%22
+[badge:GithubActions:CQ]: https://github.com/django-commons/django-cookie-consent/workflows/Code%20quality%20checks/badge.svg
+[ruff]: https://github.com/astral-sh/ruff
+[badge:ruff]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+[codecov]: https://codecov.io/gh/django-commons/django-cookie-consent
+[badge:codecov]: https://codecov.io/gh/django-commons/django-cookie-consent/branch/master/graph/badge.svg
+[docs]: https://django-cookie-consent.readthedocs.io/en/latest/?badge=latest
+[badge:docs]: https://readthedocs.org/projects/django-cookie-consent/badge/?version=latest
+[pypi]: https://pypi.org/project/django-cookie-consent/
+[badge:pypi]: https://img.shields.io/pypi/v/django-cookie-consent.svg
+[npm]: https://www.npmjs.com/package/django-cookie-consent
+[badge:npm]: https://img.shields.io/npm/v/django-cookie-consent

{django_cookie_consent-0.7.0 → django_cookie_consent-0.9.0}/django_cookie_consent.egg-info/SOURCES.txt

@@ -3,7 +3,6 @@ LICENSE
 MANIFEST.in
 README.md
 pyproject.toml
-setup.cfg
 cookie_consent/__init__.py
 cookie_consent/admin.py
 cookie_consent/apps.py
@@ -33,6 +32,7 @@ django_cookie_consent.egg-info/SOURCES.txt
 django_cookie_consent.egg-info/dependency_links.txt
 django_cookie_consent.egg-info/requires.txt
 django_cookie_consent.egg-info/top_level.txt
+tests/test_admin.py
 tests/test_cache.py
 tests/test_cookie_group_model.py
 tests/test_cookie_model.py