Skip to content

[SE-4482] Allow delete course content in Studio only for admin users #362

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

Closed
Skchoudhary wants to merge 7 commits into from
Closed

[SE-4482] Allow delete course content in Studio only for admin users #362

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
987bbc9
show delete course content button for onyl admin users
Jun 7, 2021
797019b
test case added for delete button on course-outline page
Jun 7, 2021
4352eb6
fixup! show delete course content button for onyl admin users
Jun 7, 2021
9225de7
fix js testcase
Jun 8, 2021
3ecdc0e
add section delete button hide testcase
Jun 8, 2021
593ec6c
add flag show_delete_button for mockJson
Jun 9, 2021
a3426cd
feat: adds waffle flag to prevent staff from structure deletion
nizarmah Jun 25, 2021
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
12 changes: 12 additions & 0 deletions cms/djangoapps/contentstore/config/waffle.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,3 +56,15 @@ def waffle_flags():
flag_name='library_authoring_mfe',
module_name=__name__,
)

# .. toggle_name: studio.prevent_staff_structure_deletion
# .. toggle_implementation: WaffleFlag
# .. toggle_default: False
# .. toggle_description: Prevents staff from deleting course structures
# .. toggle_use_cases: opt_in
# .. toggle_creation_date: 2021-06-25
PREVENT_STAFF_STRUCTURE_DELETION = WaffleFlag(
waffle_flags(),
'prevent_staff_structure_deletion',
module_name=__name__,
)
10 changes: 10 additions & 0 deletions cms/djangoapps/contentstore/permissions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
"""
Permission definitions for the contentstore djangoapp
"""

from bridgekeeper import perms

from lms.djangoapps.courseware.rules import HasRolesRule

DELETE_COURSE_CONTENT = 'contentstore.delete_course_content'
perms[DELETE_COURSE_CONTENT] = HasRolesRule('instructor')
7 changes: 6 additions & 1 deletion cms/djangoapps/contentstore/views/item.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@
from xblock.core import XBlock
from xblock.fields import Scope

from cms.djangoapps.contentstore.config.waffle import SHOW_REVIEW_RULES_FLAG
from cms.djangoapps.contentstore.config.waffle import PREVENT_STAFF_STRUCTURE_DELETION, SHOW_REVIEW_RULES_FLAG
from cms.djangoapps.contentstore.permissions import DELETE_COURSE_CONTENT
from cms.djangoapps.models.settings.course_grading import CourseGradingModel
from cms.djangoapps.xblock_config.models import CourseEditLTIFieldsEnabledFlag
from cms.lib.xblock.authoring_mixin import VISIBILITY_VIEW
Expand Down Expand Up @@ -1337,6 +1338,10 @@ def create_xblock_info(xblock, data=None, metadata=None, include_ancestor_info=F
else:
xblock_info['staff_only_message'] = False

xblock_info['show_delete_button'] = True
if user is not None and PREVENT_STAFF_STRUCTURE_DELETION.is_enabled():
xblock_info['show_delete_button'] = user.has_perm(DELETE_COURSE_CONTENT, xblock)

xblock_info['has_partition_group_components'] = has_children_visible_to_specific_partition_groups(
xblock
)
Expand Down
35 changes: 35 additions & 0 deletions cms/djangoapps/contentstore/views/tests/test_item.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
from cms.djangoapps.contentstore.utils import reverse_course_url, reverse_usage_url
from cms.djangoapps.contentstore.views import item as item_module
from lms.djangoapps.lms_xblock.mixin import NONSENSICAL_ACCESS_RESTRICTION
from common.djangoapps.student.roles import CourseInstructorRole, CourseStaffRole
from common.djangoapps.student.tests.factories import UserFactory
from common.djangoapps.xblock_django.models import (
XBlockConfiguration, XBlockStudioConfiguration, XBlockStudioConfigurationFlag
Expand Down Expand Up @@ -3369,3 +3370,37 @@ def test_self_paced_item_visibility_state(self, store_type):
# Check that in self paced course content has live state now
xblock_info = self._get_xblock_info(chapter.location)
self._verify_visibility_state(xblock_info, VisibilityState.live)

def test_staff_show_delte_button(self):
"""
Test delete button is *not visible* to user with CourseStaffRole
"""
# add user as course staff
CourseStaffRole(self.course_key).add_users(self.user)

# Get xblock outline
xblock_info = create_xblock_info(
self.course,
include_child_info=True,
course_outline=True,
include_children_predicate=lambda xblock: not xblock.category == 'vertical',
user=self.user
)
self.assertFalse(xblock_info['show_delete_button'])

def test_instructor_show_delete_button(self):
"""
Test delete button is *visible* to user with CourseCreatorRole only
"""
# add user as course instructor
CourseInstructorRole(self.course_key).add_users(self.user)

# Get xblock outline
xblock_info = create_xblock_info(
self.course,
include_child_info=True,
course_outline=True,
include_children_predicate=lambda xblock: not xblock.category == 'vertical',
user=self.user
)
self.assertTrue(xblock_info['show_delete_button'])
22 changes: 17 additions & 5 deletions cms/static/js/spec/views/pages/course_outline_spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@ describe('CourseOutlinePage', function() {
user_partitions: [],
user_partition_info: {},
highlights_enabled: true,
highlights_enabled_for_messaging: false
highlights_enabled_for_messaging: false,
show_delete_button: true
}, options, {child_info: {children: children}});
};

Expand All @@ -67,7 +68,8 @@ describe('CourseOutlinePage', function() {
show_review_rules: true,
user_partition_info: {},
highlights_enabled: true,
highlights_enabled_for_messaging: false
highlights_enabled_for_messaging: false,
show_delete_button: true
}, options, {child_info: {children: children}});
};

Expand All @@ -92,7 +94,8 @@ describe('CourseOutlinePage', function() {
group_access: {},
user_partition_info: {},
highlights: [],
highlights_enabled: true
highlights_enabled: true,
show_delete_button: true
}, options, {child_info: {children: children}});
};

Expand Down Expand Up @@ -122,7 +125,8 @@ describe('CourseOutlinePage', function() {
},
user_partitions: [],
group_access: {},
user_partition_info: {}
user_partition_info: {},
show_delete_button: true
}, options, {child_info: {children: children}});
};

Expand All @@ -140,7 +144,8 @@ describe('CourseOutlinePage', function() {
edited_by: 'MockUser',
user_partitions: [],
group_access: {},
user_partition_info: {}
user_partition_info: {},
show_delete_button: true
}, options);
};

Expand Down Expand Up @@ -868,6 +873,13 @@ describe('CourseOutlinePage', function() {
expect(outlinePage.$('[data-locator="mock-section-2"]')).toExist();
});

it('remains un-visible if show_delete_button is false ', function() {
createCourseOutlinePage(this, createMockCourseJSON({show_delete_button: false}, [
createMockSectionJSON({show_delete_button: false})
]));
expect(getItemHeaders('section').find('.delete-button').first()).not.toExist();
});

it('can be deleted if it is the only section', function() {
var promptSpy = EditHelpers.createPromptSpy();
createCourseOutlinePage(this, mockSingleSectionCourseJSON);
Expand Down
3 changes: 2 additions & 1 deletion cms/static/js/views/xblock_outline.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,8 @@ define(['jquery', 'underscore', 'gettext', 'js/views/baseview', 'common/js/compo
includesChildren: this.shouldRenderChildren(),
hasExplicitStaffLock: this.model.get('has_explicit_staff_lock'),
staffOnlyMessage: this.model.get('staff_only_message'),
course: course
course: course,
showDeleteButton: this.model.get('show_delete_button')
};
},

Expand Down
2 changes: 1 addition & 1 deletion cms/templates/js/course-outline.underscore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ if (is_proctored_exam) {
</a>
</li>
<% } %>
<% if (xblockInfo.isDeletable()) { %>
<% if (xblockInfo.isDeletable() && showDeleteButton) { %>
<li class="action-item action-delete">
<a href="#" data-tooltip="<%- gettext('Delete') %>" class="delete-button action-button">
<span class="icon fa fa-trash-o" aria-hidden="true"></span>
Expand Down