cms.utils.moderator: 130 total statements, 0.0% covered

Generated: Wed 2013-03-13 10:33 CET

Source file: /media/Envs/Envs/filer-gallery/lib/python2.7/site-packages/cms/utils/moderator.py

Stats: 0 executed, 119 missed, 11 excluded, 128 ignored

1. # -*- coding: utf-8 -*-
2. import datetime
3. from django.utils.translation import ugettext as _
4. from django.conf import settings
5. from cms.models import Page, PageModeratorState, PageModerator, CMSPlugin, Title
6. from cms.utils import timezone
8. I_APPROVE = 100 # current user should approve page
9. I_APPROVE_DELETE = 200
11. def page_changed(page, old_page=None, force_moderation_action=None):
12. """Called from page post save signal. If page already had pk, old version
13. of page is provided in old_page argument.
14. """
15. # get user from thread locals
16. from cms.utils.permissions import get_current_user
17. user = get_current_user()
19. force_moderation_action = force_moderation_action or getattr(page, 'force_moderation_action', None)
20. if force_moderation_action:
21. PageModeratorState(user=user, page=page, action=force_moderation_action).save()
22. return
24. if not old_page:
25. # just newly created page
26. PageModeratorState(user=user, page=page, action=PageModeratorState.ACTION_ADD).save()
28. if (old_page is None and page.published) or \
29. (old_page and not old_page.published == page.published):
30. action = page.published and PageModeratorState.ACTION_PUBLISH or PageModeratorState.ACTION_UNPUBLISH
31. PageModeratorState(user=user, page=page, action=action).save()
33. if ((old_page and not old_page.moderator_state == page.moderator_state) or not old_page) \
34. and page.requires_approvement():
35. # update_moderation_message can be called after this :S -> recipient will not
36. # see the last message
37. mail_approvement_request(page, user)
39. # TODO: if page was changed, remove all approvements from higher instances,
40. # but keep approvements by lower instances, if there are any
43. def update_moderation_message(page, message):
44. """This is bit special.. It updates last page state made from current user
45. for given page. Its called after page is saved - page state is created when
46. page gets saved (in signal), so this might have a concurrency issue, but
47. probably will work in 99,999%.
49. If any page state is'nt found in last UPDATE_TOLERANCE seconds, a new state
50. will be created instead of affecting old message.
51. """
53. UPDATE_TOLERANCE = 30 # max in last 30 seconds
55. from cms.utils.permissions import get_current_user
56. user = get_current_user()
57. created = timezone.now() - datetime.timedelta(seconds=UPDATE_TOLERANCE)
58. try:
59. state = page.pagemoderatorstate_set.filter(user=user, created__gt=created).order_by('-created')[0]
60. # just state without message!!
61. assert not state.message
62. except (IndexError, AssertionError):
63. state = PageModeratorState(user=user, page=page, action=PageModeratorState.ACTION_CHANGED)
65. state.message = message
66. state.save()
68. def page_moderator_state(request, page):
69. """Return moderator page state from page.moderator_state, but also takes
70. look if current user is in the approvement path, and should approve the this
71. page. In this case return 100 as an state value.
73. Returns:
74. dict(state=state, label=label)
75. """
76. state, label = page.moderator_state, ""
78. under_moderation = page.get_moderator_queryset()
80. # TODO: OPTIMIZE!! calls 1 or 2 q per list item (page)
82. if settings.CMS_MODERATOR:
83. if state == Page.MODERATOR_APPROVED_WAITING_FOR_PARENTS:
84. label = _('parent first')
85. elif page.requires_approvement() and page.has_moderate_permission(request) \
86. and under_moderation.filter(user=request.user).count() \
87. and not page.pagemoderatorstate_set.filter(user=request.user, action=PageModeratorState.ACTION_APPROVE).count():
88. # only if he didn't approve already...
89. is_delete = state == Page.MODERATOR_NEED_DELETE_APPROVEMENT
90. state = is_delete and I_APPROVE_DELETE or I_APPROVE
91. label = is_delete and _('delete') or _('approve')
93. elif not page.is_approved():
94. # if no moderator, we have just 2 states => changed / unchanged
95. state = Page.MODERATOR_NEED_APPROVEMENT
97. if not page.is_approved() and not label:
98. if under_moderation.count():
99. label = dict(page.moderator_state_choices)[state]
100. return dict(state=state, label=label)
103. def moderator_should_approve(request, page):
104. """Says if user should approve given page. (just helper)
105. """
106. return page_moderator_state(request, page)['state'] >= I_APPROVE
109. def requires_moderation(page):
110. """Returns True if page requires moderation
111. """
112. return bool(page.get_moderator_queryset().count())
114. def will_require_moderation(target_id, position):
115. """Check if newly added page will require moderation
116. """
117. if not settings.CMS_MODERATOR:
118. return False
119. target = Page.objects.get(pk=target_id)
120. if position == 'first-child':
121. return requires_moderation(target)
122. elif position in ('left', 'right'):
123. if target.parent:
124. return requires_moderation(target.parent)
125. return False
128. def get_test_moderation_level(page, user=None, include_user=True):
129. """Returns min moderation level for page, and result of user test if
130. user is given, so output is always tuple of:
132. (moderation_level, requires_approvement)
134. Meaning of requires_approvement is - somebody of higher instance must
135. approve changes made on this page by given user.
137. NOTE: May require some optimization, might call 3 huge sql queries in
138. worse case
139. """
141. qs = page.get_moderator_queryset()
143. if not settings.CMS_MODERATOR or (user and user.is_superuser):
144. if include_user and qs.filter(user__id=user.id, moderate_page=True).count():
145. return 0, True
146. return 0, False
148. if qs.filter(user__is_superuser=True).count():
149. return 0, True
151. if user:
152. if qs.filter(user__id=user.id, user__globalpagepermission__gt=0).count():
153. return 0, False
155. try:
156. moderator = qs.filter(user__id=user.id).select_related()[0]
157. return moderator.page.level, False
158. except IndexError:
159. pass
160. else:
161. if qs.filter(user__globalpagepermission__gt=0).count():
162. return 0, True
164. try:
165. moderator = qs.select_related()[0]
166. except IndexError:
167. return PageModerator.MAX_MODERATION_LEVEL, False
168. return moderator.page.level, True
170. def approve_page(request, page):
171. """Main approving function. Two things can happen here, depending on user
172. level:
174. 1.) User is somewhere in the approvement path, but not on the top. In this
175. case just mark this page as approved by this user.
177. 2.) User is on top of approvement path. Draft page with all dependencies
178. will be `copied` to public model, page states log will be cleaned.
180. """
181. moderation_level, moderation_required = get_test_moderation_level(page, request.user, False)
182. if not moderator_should_approve(request, page):
183. # escape soon if there isn't any approval required by this user
184. if not page.publisher_public or page.get_absolute_url() != page.publisher_public.get_absolute_url():
185. page.publish()
186. else:
187. return
188. if not moderation_required:
189. # this is a second case - user can publish changes
190. if page.pagemoderatorstate_set.get_delete_actions().count():
191. # it is a delete request for this page!!
192. page.delete_with_public()
193. else:
194. page.publish()
195. else:
196. # first case - just mark page as approved from this user
197. PageModeratorState(user=request.user, page=page, action=PageModeratorState.ACTION_APPROVE).save()
198. page.save(change_state=False)
201. def get_model_queryset(model, request=None):
202. """Decision function used in frontend - says which model should be used.
203. Public models are used only if CMS_MODERATOR.
204. """
205. if not settings.CMS_MODERATOR:
206. # We do not use moderator
207. return model.objects.drafts()
208. # We do use moderator
209. if request:
210. preview_draft = ('preview' in request.GET and 'draft' in request.GET)
211. edit_mode = ('edit' in request.GET or request.session.get('cms_edit', False))
212. if preview_draft or edit_mode:
213. return model.objects.drafts()
214. # Default case / moderator is used but there is no request
215. return model.objects.public()
217. # queryset helpers for basic models
218. get_page_queryset = lambda request=None: get_model_queryset(Page, request)
219. get_title_queryset = lambda request=None: Title.objects.all() # not sure if we need to only grab public items here
220. get_cmsplugin_queryset = lambda request=None: CMSPlugin.objects.all() # CMSPlugin is no longer extending from Publisher
223. def mail_approvement_request(page, user=None):
224. """Sends approvement request over email to all users which should approve
225. this page if they have an email entered.
227. Don't send it to current user - he should know about it, because he made the
228. change.
229. """
230. if not settings.CMS_MODERATOR or not page.requires_approvement():
231. return
233. recipient_list = []
234. for moderator in page.get_moderator_queryset():
235. email = moderator.user.email
236. if email and not email in recipient_list:
237. recipient_list.append(email)
239. if user and user.email in recipient_list:
240. recipient_list.remove(user.email)
242. if not recipient_list:
243. return
245. from django.core.urlresolvers import reverse
246. from django.contrib.sites.models import Site
247. from cms.utils.urlutils import urljoin
248. from cms.utils.mail import send_mail
250. site = Site.objects.get_current()
252. subject = _('CMS - Page %s requires approvement.') % unicode(page)
253. context = {
254. 'page': page,
255. 'admin_url': "http://%s" % urljoin(site.domain, reverse('admin:index'), 'cms/page', page.id),
256. }
258. send_mail(subject, 'admin/cms/mail/approvement_required.txt', recipient_list, context, 'admin/cms/mail/approvement_required.html')