Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unpublish flow #161

Closed
wants to merge 5 commits into from
Closed

Unpublish flow #161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ed7937e
Add a way to execute unpublishing
jonathan-s Oct 10, 2019
0ba4d10
Add unpublish_selected among actions
jonathan-s Oct 14, 2019
9370420
Fix isort errors
jonathan-s Oct 21, 2019
7ce61de
Add a separate signal for when something is being unpublished
jonathan-s Oct 21, 2019
4a5d60b
Fighting isort...
jonathan-s Oct 22, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
199 changes: 128 additions & 71 deletions djangocms_moderation/admin.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
from django.contrib.contenttypes.models import ContentType
from django.core.exceptions import PermissionDenied
from django.db import transaction
from django.http import Http404, HttpResponseRedirect
from django.http import Http404, HttpResponseNotAllowed, HttpResponseRedirect
from django.shortcuts import get_object_or_404, render
from django.template.loader import render_to_string
from django.urls import reverse
Expand All @@ -27,9 +27,9 @@
delete_selected,
post_bulk_actions,
publish_selected,
publish_version,
reject_selected,
resubmit_selected,
unpublish_selected,
)
from .emails import notify_collection_author, notify_collection_moderators
from .filters import ModeratorFilter, ReviewerFilter
Expand Down Expand Up @@ -120,6 +120,7 @@ class Media:

actions = [ # filtered out in `self.get_actions`
delete_selected,
unpublish_selected,
publish_selected,
approve_selected,
reject_selected,
Expand Down Expand Up @@ -290,31 +291,50 @@ def get_actions(self, request):
) # publish_selected, approve_selected, reject_selected, resubmit_selected
else:
# If the collection is archived, then no other action than
# `publish_selected` is possible.
# `publish_selected` or `unpublish_selected` is possible.
_max_to_keep = 1 # publish_selected

for mr in collection.moderation_requests.all().select_related("version"):
if len(actions_to_keep) == _max_to_keep:
break # We have found all the actions, so no need to loop anymore
if "publish_selected" not in actions_to_keep:
if (
request.user == collection.author
and mr.version_can_be_published()
):
actions_to_keep.append("publish_selected")
if (
collection.status == constants.IN_REVIEW
and "approve_selected" not in actions_to_keep
):
if mr.user_can_take_moderation_action(request.user):
actions_to_keep.append("approve_selected")
actions_to_keep.append("reject_selected")
if (
collection.status == constants.IN_REVIEW
and "resubmit_selected" not in actions_to_keep
):
if mr.user_can_resubmit(request.user):
actions_to_keep.append("resubmit_selected")

publish_condition = all([
"publish_selected" not in actions_to_keep,
request.user == collection.author,
collection.workflow.is_unpublishing is False,
mr.version_can_be_published()
])

unpublish_condition = all([
"unpublish_selected" not in actions_to_keep,
collection.workflow.is_unpublishing is True,
mr.version_can_be_unpublished()
])

approve_condition = all([
"approve_selected" not in actions_to_keep,
collection.status == constants.IN_REVIEW,
mr.user_can_take_moderation_action(request.user)
])

resubmit_condition = all([
"resubmit_selected" not in actions_to_keep,
collection.status == constants.IN_REVIEW,
mr.user_can_resubmit(request.user)
])

if unpublish_condition:
actions_to_keep.append("unpublish_selected")

if publish_condition:
actions_to_keep.append("publish_selected")

if approve_condition:
actions_to_keep.append("approve_selected")
actions_to_keep.append("reject_selected")

if resubmit_condition:
actions_to_keep.append("resubmit_selected")

# Only collection author can delete moderation requests
if collection.author == request.user:
Expand Down Expand Up @@ -496,39 +516,37 @@ def _get_selected_tree_nodes(self, request):
).select_related('moderation_request')
return treenodes

def _custom_view_context(self, request):
def _custom_view_context(self, request, collection):
treenodes = self._get_selected_tree_nodes(request)
collection_id = request.GET.get('collection_id')
redirect_url = self._redirect_to_changeview_url(collection_id)
redirect_url = self._redirect_to_changeview_url(collection.pk)
return dict(
ids=request.GET.getlist("ids"),
back_url=redirect_url,
queryset=[n.moderation_request for n in treenodes]
queryset=[n.moderation_request for n in treenodes],
collection=collection
)

def resubmit_view(self, request):
collection_id = request.GET.get('collection_id')
treenodes = self._get_selected_tree_nodes(request)
redirect_url = self._redirect_to_changeview_url(collection_id)

try:
collection = ModerationCollection.objects.get(id=int(collection_id))
except (ValueError, ModerationCollection.DoesNotExist):
raise Http404
treenodes = self._get_selected_tree_nodes(request)
redirect_url = self._redirect_to_changeview_url(collection_id)

if collection.author != request.user:
raise PermissionDenied

if request.method != 'POST':
context = self._custom_view_context(request)
context = self._custom_view_context(request, collection)
return render(
request,
'admin/djangocms_moderation/moderationrequest/resubmit_confirmation.html',
context
)
else:
resubmitted_requests = []

for node in treenodes.all():
mr = node.moderation_request
if mr.user_can_resubmit(request.user):
Expand All @@ -552,6 +570,7 @@ def resubmit_view(self, request):
moderation_requests=resubmitted_requests,
user=request.user,
rework=True,
workflow=collection.workflow
)

messages.success(
Expand All @@ -565,81 +584,118 @@ def resubmit_view(self, request):
)
return HttpResponseRedirect(redirect_url)

def _publish_flow(self, request, queryset):
"""Handles the published workflow"""
published_moderation_requests = []
for node in queryset.all():
mr = node.moderation_request
if mr.version_can_be_published():
mr.version.publish(request.user)
published_moderation_requests.append(mr)
mr.update_status(
action=constants.ACTION_FINISHED, by_user=request.user
)

messages.success(
request,
ungettext(
"%(count)d request successfully published",
"%(count)d requests successfully published",
len(published_moderation_requests),
)
% {"count": len(published_moderation_requests)},
)
return published_moderation_requests

def _unpublish_flow(self, request, queryset):
unpublished_moderation_requests = []
for node in queryset.all():
mr = node.moderation_request
if mr.version_can_be_unpublished():
mr.version.unpublish(request.user)
unpublished_moderation_requests.append(mr)
mr.update_status(
action=constants.ACTION_FINISHED, by_user=request.user
)

messages.success(
request,
ungettext(
"%(count)d request successfully unpublished",
"%(count)d requests successfully unpublished",
len(unpublished_moderation_requests),
)
% {"count": len(unpublished_moderation_requests)},
)
return unpublished_moderation_requests

def published_view(self, request):
collection_id = request.GET.get('collection_id')
treenodes = self._get_selected_tree_nodes(request)
redirect_url = self._redirect_to_changeview_url(collection_id)

try:
collection = ModerationCollection.objects.get(id=int(collection_id))
except (ValueError, ModerationCollection.DoesNotExist):
raise Http404
treenodes = self._get_selected_tree_nodes(request)
redirect_url = self._redirect_to_changeview_url(collection_id)

if request.user != collection.author:
raise PermissionDenied

if request.method != 'POST':
context = self._custom_view_context(request)
if request.method not in ['POST', 'GET']:
return HttpResponseNotAllowed

if request.method == 'GET':
context = self._custom_view_context(request, collection)
return render(
request,
"admin/djangocms_moderation/moderationrequest/publish_confirmation.html",
context,
)

if collection.workflow.is_unpublishing:
moderation_requests = self._unpublish_flow(request, treenodes)
else:
published_moderation_requests = []
for node in treenodes.all():
mr = node.moderation_request
if mr.version_can_be_published():
if publish_version(mr.version, request.user):
published_moderation_requests.append(mr)
mr.update_status(
action=constants.ACTION_FINISHED, by_user=request.user
)
else:
# TODO provide some feedback back to the user?
pass
moderation_requests = self._publish_flow(request, treenodes)

messages.success(
request,
ungettext(
"%(count)d request successfully published",
"%(count)d requests successfully published",
len(published_moderation_requests),
)
% {"count": len(published_moderation_requests)},
post_bulk_actions(collection)
if collection.workflow.is_unpublishing:
signals.unpublished.send(
sender=self.model,
collection=collection,
moderator=collection.author,
moderation_requests=moderation_requests,
workflow=collection.workflow
)

post_bulk_actions(collection)
else:
signals.published.send(
sender=self.model,
collection=collection,
moderator=collection.author,
moderation_requests=published_moderation_requests,
moderation_requests=moderation_requests,
workflow=collection.workflow
)

return HttpResponseRedirect(redirect_url)

def rework_view(self, request):
collection_id = request.GET.get('collection_id')
try:
collection = ModerationCollection.objects.get(id=int(collection_id))
except (ValueError, ModerationCollection.DoesNotExist):
raise Http404

treenodes = self._get_selected_tree_nodes(request)
redirect_url = self._redirect_to_changeview_url(collection_id)

if request.method != 'POST':
context = self._custom_view_context(request)
context = self._custom_view_context(request, collection)
return render(
request,
"admin/djangocms_moderation/moderationrequest/rework_confirmation.html",
context,
)
else:
try:
collection = ModerationCollection.objects.get(id=int(collection_id))
except (ValueError, ModerationCollection.DoesNotExist):
raise Http404

rejected_requests = []

for node in treenodes.all():
moderation_request = node.moderation_request
if moderation_request.user_can_take_moderation_action(request.user):
Expand Down Expand Up @@ -671,11 +727,15 @@ def rework_view(self, request):

def approved_view(self, request):
collection_id = request.GET.get('collection_id')
try:
collection = ModerationCollection.objects.get(id=int(collection_id))
except (ValueError, ModerationCollection.DoesNotExist):
raise Http404
treenodes = self._get_selected_tree_nodes(request)
redirect_url = self._redirect_to_changeview_url(collection_id)

if request.method != 'POST':
context = self._custom_view_context(request)
context = self._custom_view_context(request, collection)
return render(
request,
"admin/djangocms_moderation/moderationrequest/approve_confirmation.html",
Expand All @@ -696,10 +756,6 @@ def approved_view(self, request):
and some in the second, then the reviewers we need to notify are
different per request, depending on which stage the request is in
"""
try:
collection = ModerationCollection.objects.get(id=int(collection_id))
except (ValueError, ModerationCollection.DoesNotExist):
raise Http404

approved_requests = []
# Variable we are using to group the requests by action.step_approved
Expand Down Expand Up @@ -955,6 +1011,7 @@ class WorkflowAdmin(admin.ModelAdmin):
fields = [
"name",
"is_default",
"is_unpublishing",
"identifier",
"requires_compliance_number",
"compliance_number_backend",
Expand Down
Loading