-
-
Notifications
You must be signed in to change notification settings - Fork 3.1k
/
moderator.py
258 lines (204 loc) · 9.84 KB
/
moderator.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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
# -*- coding: utf-8 -*-
import datetime
from django.utils.translation import ugettext as _
from django.conf import settings
from cms.models import Page, PageModeratorState, PageModerator, CMSPlugin, Title
I_APPROVE = 100 # current user should approve page
I_APPROVE_DELETE = 200
def page_changed(page, old_page=None, force_moderation_action=None):
"""Called from page post save signal. If page already had pk, old version
of page is provided in old_page argument.
"""
# get user from thread locals
from cms.utils.permissions import get_current_user
user = get_current_user()
force_moderation_action = force_moderation_action or getattr(page, 'force_moderation_action', None)
if force_moderation_action:
PageModeratorState(user=user, page=page, action=force_moderation_action).save()
return
if not old_page:
# just newly created page
PageModeratorState(user=user, page=page, action=PageModeratorState.ACTION_ADD).save()
if (old_page is None and page.published) or \
(old_page and not old_page.published == page.published):
action = page.published and PageModeratorState.ACTION_PUBLISH or PageModeratorState.ACTION_UNPUBLISH
PageModeratorState(user=user, page=page, action=action).save()
if ((old_page and not old_page.moderator_state == page.moderator_state) or not old_page) \
and page.requires_approvement():
# update_moderation_message can be called after this :S -> recipient will not
# see the last message
mail_approvement_request(page, user)
# TODO: if page was changed, remove all approvements from higher instances,
# but keep approvements by lower instances, if there are any
def update_moderation_message(page, message):
"""This is bit special.. It updates last page state made from current user
for given page. Its called after page is saved - page state is created when
page gets saved (in signal), so this might have a concurrency issue, but
probably will work in 99,999%.
If any page state is'nt found in last UPDATE_TOLERANCE seconds, a new state
will be created instead of affecting old message.
"""
UPDATE_TOLERANCE = 30 # max in last 30 seconds
from cms.utils.permissions import get_current_user
user = get_current_user()
created = datetime.datetime.now() - datetime.timedelta(seconds=UPDATE_TOLERANCE)
try:
state = page.pagemoderatorstate_set.filter(user=user, created__gt=created).order_by('-created')[0]
# just state without message!!
assert not state.message
except (IndexError, AssertionError):
state = PageModeratorState(user=user, page=page, action=PageModeratorState.ACTION_CHANGED)
state.message = message
state.save()
def page_moderator_state(request, page):
"""Return moderator page state from page.moderator_state, but also takes
look if current user is in the approvement path, and should approve the this
page. In this case return 100 as an state value.
Returns:
dict(state=state, label=label)
"""
state, label = page.moderator_state, ""
under_moderation = page.get_moderator_queryset()
# TODO: OPTIMIZE!! calls 1 or 2 q per list item (page)
if settings.CMS_MODERATOR:
if state == Page.MODERATOR_APPROVED_WAITING_FOR_PARENTS:
label = _('parent first')
elif page.requires_approvement() and page.has_moderate_permission(request) \
and under_moderation.filter(user=request.user).count() \
and not page.pagemoderatorstate_set.filter(user=request.user, action=PageModeratorState.ACTION_APPROVE).count():
# only if he didn't approve already...
is_delete = state == Page.MODERATOR_NEED_DELETE_APPROVEMENT
state = is_delete and I_APPROVE_DELETE or I_APPROVE
label = is_delete and _('delete') or _('approve')
elif not page.is_approved():
# if no moderator, we have just 2 states => changed / unchanged
state = Page.MODERATOR_NEED_APPROVEMENT
if not page.is_approved() and not label:
if under_moderation.count():
label = dict(page.moderator_state_choices)[state]
return dict(state=state, label=label)
def moderator_should_approve(request, page):
"""Says if user should approve given page. (just helper)
"""
return page_moderator_state(request, page)['state'] >= I_APPROVE
def requires_moderation(page):
"""Returns True if page requires moderation
"""
return bool(page.get_moderator_queryset().count())
def will_require_moderation(target_id, position):
"""Check if newly added page will require moderation
"""
if not settings.CMS_MODERATOR:
return False
target = Page.objects.get(pk=target_id)
if position == 'first-child':
return requires_moderation(target)
elif position in ('left', 'right'):
if target.parent:
return requires_moderation(target.parent)
return False
def get_test_moderation_level(page, user=None, include_user=True):
"""Returns min moderation level for page, and result of user test if
user is given, so output is always tuple of:
(moderation_level, requires_approvement)
Meaning of requires_approvement is - somebody of higher instance must
approve changes made on this page by given user.
NOTE: May require some optimization, might call 3 huge sql queries in
worse case
"""
qs = page.get_moderator_queryset()
if not settings.CMS_MODERATOR or (user and user.is_superuser):
if include_user and qs.filter(user__id=user.id, moderate_page=True).count():
return 0, True
return 0, False
if qs.filter(user__is_superuser=True).count():
return 0, True
if user:
if qs.filter(user__id=user.id, user__globalpagepermission__gt=0).count():
return 0, False
try:
moderator = qs.filter(user__id=user.id).select_related()[0]
return moderator.page.level, False
except IndexError:
pass
else:
if qs.filter(user__globalpagepermission__gt=0).count():
return 0, True
try:
moderator = qs.select_related()[0]
except IndexError:
return PageModerator.MAX_MODERATION_LEVEL, False
return moderator.page.level, True
def approve_page(request, page):
"""Main approving function. Two things can happen here, depending on user
level:
1.) User is somewhere in the approvement path, but not on the top. In this
case just mark this page as approved by this user.
2.) User is on top of approvement path. Draft page with all dependencies
will be `copied` to public model, page states log will be cleaned.
"""
moderation_level, moderation_required = get_test_moderation_level(page, request.user, False)
if not moderator_should_approve(request, page):
# escape soon if there isn't any approval required by this user
if not page.publisher_public or page.get_absolute_url() != page.publisher_public.get_absolute_url():
page.publish()
else:
return
if not moderation_required:
# this is a second case - user can publish changes
if page.pagemoderatorstate_set.get_delete_actions().count():
# it is a delete request for this page!!
page.delete_with_public()
else:
page.publish()
else:
# first case - just mark page as approved from this user
PageModeratorState(user=request.user, page=page, action=PageModeratorState.ACTION_APPROVE).save()
page.save(change_state=False)
def get_model_queryset(model, request=None):
"""Decision function used in frontend - says which model should be used.
Public models are used only if CMS_MODERATOR.
"""
if not settings.CMS_MODERATOR:
# We do not use moderator
return model.objects.drafts()
# We do use moderator
if request:
preview_draft = ('preview' in request.GET and 'draft' in request.GET)
edit_mode = ('edit' in request.GET or request.session.get('cms_edit', False))
if preview_draft or edit_mode:
return model.objects.drafts()
# Default case / moderator is used but there is no request
return model.objects.public()
# queryset helpers for basic models
get_page_queryset = lambda request=None: get_model_queryset(Page, request)
get_title_queryset = lambda request=None: Title.objects.all() # not sure if we need to only grab public items here
get_cmsplugin_queryset = lambda request=None: CMSPlugin.objects.all() # CMSPlugin is no longer extending from Publisher
def mail_approvement_request(page, user=None):
"""Sends approvement request over email to all users which should approve
this page if they have an email entered.
Don't send it to current user - he should know about it, because he made the
change.
"""
if not settings.CMS_MODERATOR or not page.requires_approvement():
return
recipient_list = []
for moderator in page.get_moderator_queryset():
email = moderator.user.email
if email and not email in recipient_list:
recipient_list.append(email)
if user and user.email in recipient_list:
recipient_list.remove(user.email)
if not recipient_list:
return
from django.contrib import admin
from django.contrib.sites.models import Site
from cms.utils.urlutils import urljoin
from cms.utils.mail import send_mail
site = Site.objects.get_current()
subject = _('CMS - Page %s requires approvement.') % unicode(page)
context = {
'page': page,
'admin_url': "http://%s" % urljoin(site.domain, admin.site.root_path, 'cms/page', page.id),
}
send_mail(subject, 'admin/cms/mail/approvement_required.txt', recipient_list, context, 'admin/cms/mail/approvement_required.html')