forked from jazzband/django-cookie-consent
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathutil.py
182 lines (147 loc) · 5.34 KB
/
util.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
# -*- coding: utf-8 -*-
from __future__ import unicode_literals
import datetime
from django.utils.encoding import smart_str
from cookie_consent.cache import (
get_cookie_group,
all_cookie_groups,
get_cookie,
)
from cookie_consent.models import (
ACTION_ACCEPTED,
ACTION_DECLINED,
LogItem,
)
from cookie_consent.conf import settings
def parse_cookie_str(cookie):
dic = {}
if not cookie:
return dic
for c in cookie.split("|"):
key, value = c.split("=")
dic[key] = value
return dic
def dict_to_cookie_str(dic):
return "|".join(["%s=%s" % (k, v) for k, v in dic.items() if v])
def get_cookie_dict_from_request(request):
try:
cookie_str = request.COOKIES.get(settings.COOKIE_CONSENT_NAME)
return parse_cookie_str(cookie_str)
except:
pass
def set_cookie_dict_to_response(response, dic):
response.set_cookie(settings.COOKIE_CONSENT_NAME,
dict_to_cookie_str(dic),
settings.COOKIE_CONSENT_MAX_AGE)
def get_cookie_value_from_request(request, varname, cookie=None):
"""
Returns if cookie group or its specific cookie has been accepted.
Returns True or False when cookie is accepted or declined or None
if cookie is not set.
"""
cookie_dic = get_cookie_dict_from_request(request)
if not cookie_dic:
return None
cookie_group = get_cookie_group(varname=varname)
if not cookie_group:
return None
if cookie:
name, domain = cookie.split(":")
cookie = get_cookie(cookie_group, name, domain)
else:
cookie = None
version = cookie_dic.get(varname, None)
if version == settings.COOKIE_CONSENT_DECLINE:
return False
if version is None:
return None
if not cookie:
v = cookie_group.get_version()
else:
v = cookie.get_version()
if version >= v:
return True
return None
def get_cookie_groups(varname=None):
if not varname:
return all_cookie_groups().values()
keys = varname.split(",")
return [g for k, g in all_cookie_groups().items() if k in keys]
def accept_cookies(request, response, varname=None):
"""
Accept cookies in Cookie Group specified by ``varname``.
"""
cookie_dic = get_cookie_dict_from_request(request)
for cookie_group in get_cookie_groups(varname):
cookie_dic[cookie_group.varname] = cookie_group.get_version()
if settings.COOKIE_CONSENT_LOG_ENABLED:
LogItem.objects.create(action=ACTION_ACCEPTED,
cookiegroup=cookie_group,
version=cookie_group.get_version())
set_cookie_dict_to_response(response, cookie_dic)
def delete_cookies(response, cookie_group):
if cookie_group.is_deletable:
for cookie in cookie_group.cookie_set.all():
response.delete_cookie(smart_str(cookie.name),
cookie.path, cookie.domain)
def decline_cookies(request, response, varname=None):
"""
Decline and delete cookies in CookieGroup specified by ``varname``.
"""
cookie_dic = get_cookie_dict_from_request(request)
for cookie_group in get_cookie_groups(varname):
cookie_dic[cookie_group.varname] = settings.COOKIE_CONSENT_DECLINE
delete_cookies(response, cookie_group)
if settings.COOKIE_CONSENT_LOG_ENABLED:
LogItem.objects.create(action=ACTION_DECLINED,
cookiegroup=cookie_group,
version=cookie_group.get_version())
set_cookie_dict_to_response(response, cookie_dic)
def are_all_cookies_accepted(request):
"""
Returns if all cookies are accepted.
"""
return all([get_cookie_value_from_request(request, cookie_group.varname)
for cookie_group in get_cookie_groups()])
def get_not_accepted_or_declined_cookie_groups(request):
"""
Returns all cookie groups that are neither accepted or declined.
"""
return [cookie_group for cookie_group in get_cookie_groups()
if get_cookie_value_from_request(
request, cookie_group.varname) is None]
def is_cookie_consent_enabled(request):
"""
Returns if django-cookie-consent is enabled for given request.
"""
enabled = settings.COOKIE_CONSENT_ENABLED
if callable(enabled):
return enabled(request)
else:
return enabled
def get_cookie_string(cookie_dic):
"""
Returns cookie in format suitable for use in javascript.
"""
expires = datetime.datetime.now() + datetime.timedelta(
seconds=settings.COOKIE_CONSENT_MAX_AGE)
cookie_str = "%s=%s; expires=%s; path=/" % (
settings.COOKIE_CONSENT_NAME,
dict_to_cookie_str(cookie_dic),
expires.strftime("%a, %d %b %Y %H:%M:%S GMT")
)
return cookie_str
def get_accepted_cookies(request):
"""
Returns all accepted cookies.
"""
cookie_dic = get_cookie_dict_from_request(request)
accepted_cookies = []
for cookie_group in all_cookie_groups().values():
version = cookie_dic.get(cookie_group.varname, None)
if not version or version == settings.COOKIE_CONSENT_DECLINE:
continue
for cookie in cookie_group.cookie_set.all():
if version >= cookie.get_version():
accepted_cookies.append(cookie)
return accepted_cookies