diff --git a/cms/djangoapps/contentstore/management/commands/delete_course.py b/cms/djangoapps/contentstore/management/commands/delete_course.py index 50f9b82e80..085fce5fe5 100644 --- a/cms/djangoapps/contentstore/management/commands/delete_course.py +++ b/cms/djangoapps/contentstore/management/commands/delete_course.py @@ -2,13 +2,8 @@ ### Script for cloning a course ### from django.core.management.base import BaseCommand, CommandError -from xmodule.modulestore.store_utilities import delete_course -from xmodule.modulestore.django import modulestore -from xmodule.contentstore.django import contentstore -from xmodule.course_module import CourseDescriptor from .prompt import query_yes_no - -from auth.authz import _delete_course_group +from contentstore.utils import delete_course_and_groups # @@ -30,20 +25,6 @@ class Command(BaseCommand): if commit: print 'Actually going to delete the course from DB....' - ms = modulestore('direct') - cs = contentstore() - - org, course_num, run = course_id.split("/") - ms.ignore_write_events_on_courses.append('{0}/{1}'.format(org, course_num)) - if query_yes_no("Deleting course {0}. Confirm?".format(course_id), default="no"): if query_yes_no("Are you sure. This action cannot be undone!", default="no"): - loc = CourseDescriptor.id_to_location(course_id) - if delete_course(ms, cs, loc, commit): - print 'removing User permissions from course....' - # in the django layer, we need to remove all the user permissions groups associated with this course - if commit: - try: - _delete_course_group(loc) - except Exception as err: - print("Error in deleting course groups for {0}: {1}".format(loc, err)) + delete_course_and_groups(course_id, commit) diff --git a/cms/djangoapps/contentstore/tests/test_contentstore.py b/cms/djangoapps/contentstore/tests/test_contentstore.py index c4f5f4ee61..c4e6ff23dd 100644 --- a/cms/djangoapps/contentstore/tests/test_contentstore.py +++ b/cms/djangoapps/contentstore/tests/test_contentstore.py @@ -55,6 +55,8 @@ from uuid import uuid4 from pymongo import MongoClient from student.models import CourseEnrollment +from contentstore.utils import delete_course_and_groups + TEST_DATA_CONTENTSTORE = copy.deepcopy(settings.CONTENTSTORE) TEST_DATA_CONTENTSTORE['OPTIONS']['db'] = 'test_xcontent_%s' % uuid4().hex @@ -1292,6 +1294,28 @@ class ContentStoreTest(ModuleStoreTestCase): test_course_data = self.assert_created_course(number_suffix=uuid4().hex) self.assertTrue(are_permissions_roles_seeded(self._get_course_id(test_course_data))) + def test_forum_unseeding_on_delete(self): + """Test new course creation and verify forum unseeding """ + test_course_data = self.assert_created_course(number_suffix=uuid4().hex) + self.assertTrue(are_permissions_roles_seeded(self._get_course_id(test_course_data))) + course_id = self._get_course_id(test_course_data) + delete_course_and_groups(course_id, commit=True) + self.assertFalse(are_permissions_roles_seeded(course_id)) + + def test_forum_unseeding_with_multiple_courses(self): + """Test new course creation and verify forum unseeding when there are multiple courses""" + test_course_data = self.assert_created_course(number_suffix=uuid4().hex) + second_course_data = self.assert_created_course(number_suffix=uuid4().hex) + + # unseed the forums for the first course + course_id = self._get_course_id(test_course_data) + delete_course_and_groups(course_id, commit=True) + self.assertFalse(are_permissions_roles_seeded(course_id)) + + second_course_id = self._get_course_id(second_course_data) + # permissions should still be there for the other course + self.assertTrue(are_permissions_roles_seeded(second_course_id)) + def _get_course_id(self, test_course_data): """Returns the course ID (org/number/run).""" return "{org}/{number}/{run}".format(**test_course_data) diff --git a/cms/djangoapps/contentstore/utils.py b/cms/djangoapps/contentstore/utils.py index e5ae6bb66b..09d04e4929 100644 --- a/cms/djangoapps/contentstore/utils.py +++ b/cms/djangoapps/contentstore/utils.py @@ -5,12 +5,16 @@ from xmodule.modulestore import Location from xmodule.modulestore.django import modulestore from xmodule.modulestore.exceptions import ItemNotFoundError from xmodule.contentstore.content import StaticContent -from django.core.urlresolvers import reverse +from xmodule.contentstore.django import contentstore import copy import logging import re from xmodule.modulestore.draft import DIRECT_ONLY_CATEGORIES from django.utils.translation import ugettext as _ +from django_comment_common.utils import unseed_permissions_roles +from auth.authz import _delete_course_group +from xmodule.modulestore.store_utilities import delete_course +from xmodule.course_module import CourseDescriptor log = logging.getLogger(__name__) @@ -20,6 +24,31 @@ NOTES_PANEL = {"name": _("My Notes"), "type": "notes"} EXTRA_TAB_PANELS = dict([(p['type'], p) for p in [OPEN_ENDED_PANEL, NOTES_PANEL]]) +def delete_course_and_groups(course_id, commit=False): + """ + This deletes the courseware associated with a course_id as well as cleaning update_item + the various user table stuff (groups, permissions, etc.) + """ + module_store = modulestore('direct') + content_store = contentstore() + + org, course_num, run = course_id.split("/") + module_store.ignore_write_events_on_courses.append('{0}/{1}'.format(org, course_num)) + + loc = CourseDescriptor.id_to_location(course_id) + if delete_course(module_store, content_store, loc, commit): + print 'removing forums permissions and roles...' + unseed_permissions_roles(course_id) + + print 'removing User permissions from course....' + # in the django layer, we need to remove all the user permissions groups associated with this course + if commit: + try: + _delete_course_group(loc) + except Exception as err: + log.error("Error in deleting course groups for {0}: {1}".format(loc, err)) + + def get_modulestore(category_or_location): """ Returns the correct modulestore to use for modifying the specified location diff --git a/common/djangoapps/django_comment_common/utils.py b/common/djangoapps/django_comment_common/utils.py index f74116d59f..388474395c 100644 --- a/common/djangoapps/django_comment_common/utils.py +++ b/common/djangoapps/django_comment_common/utils.py @@ -32,8 +32,30 @@ def seed_permissions_roles(course_id): administrator_role.inherit_permissions(moderator_role) -def are_permissions_roles_seeded(course_id): +def _remove_permission_role(course_id, name): + try: + role = Role.objects.get(name=name, course_id=course_id) + if role.course_id == course_id: + role.delete() + except Role.DoesNotExist: + pass + +def unseed_permissions_roles(course_id): + """ + A utility method to clean up all forum related permissions and roles + """ + _remove_permission_role(name="Administrator", course_id=course_id) + _remove_permission_role(name="Moderator", course_id=course_id) + _remove_permission_role(name="Community TA", course_id=course_id) + _remove_permission_role(name="Student", course_id=course_id) + + +def are_permissions_roles_seeded(course_id): + """ + Returns whether the forums permissions for a course have been provisioned in + the database + """ try: administrator_role = Role.objects.get(name="Administrator", course_id=course_id) moderator_role = Role.objects.get(name="Moderator", course_id=course_id)