Merge pull request #1956 from edx/feature/cdodge/autoprovision-forums-master

Feature/cdodge/autoprovision forums master

common/djangoapps/django_comment_common/migrations/0001_initial.py

@@ -0,0 +1,92 @@
+# -*- coding: utf-8 -*-
+from south.v2 import SchemaMigration
+
+
+class Migration(SchemaMigration):
+#
+# cdodge: This is basically an empty migration since everything has - up to now - managed in the django_comment_client app
+# But going forward we should be using this migration
+#
+    def forwards(self, orm):
+        pass
+
+    def backwards(self, orm):
+        pass
+
+    models = {
+        'auth.group': {
+            'Meta': {'object_name': 'Group'},
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '80'}),
+            'permissions': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['auth.Permission']", 'symmetrical': 'False', 'blank': 'True'})
+        },
+        'auth.permission': {
+            'Meta': {'ordering': "('content_type__app_label', 'content_type__model', 'codename')", 'unique_together': "(('content_type', 'codename'),)", 'object_name': 'Permission'},
+            'codename': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
+            'content_type': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['contenttypes.ContentType']"}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '50'})
+        },
+        'auth.user': {
+            'Meta': {'object_name': 'User'},
+            'about': ('django.db.models.fields.TextField', [], {'blank': 'True'}),
+            'avatar_type': ('django.db.models.fields.CharField', [], {'default': "'n'", 'max_length': '1'}),
+            'bronze': ('django.db.models.fields.SmallIntegerField', [], {'default': '0'}),
+            'consecutive_days_visit_count': ('django.db.models.fields.IntegerField', [], {'default': '0'}),
+            'country': ('django_countries.fields.CountryField', [], {'max_length': '2', 'blank': 'True'}),
+            'date_joined': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}),
+            'date_of_birth': ('django.db.models.fields.DateField', [], {'null': 'True', 'blank': 'True'}),
+            'display_tag_filter_strategy': ('django.db.models.fields.SmallIntegerField', [], {'default': '0'}),
+            'email': ('django.db.models.fields.EmailField', [], {'max_length': '75', 'blank': 'True'}),
+            'email_isvalid': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
+            'email_key': ('django.db.models.fields.CharField', [], {'max_length': '32', 'null': 'True'}),
+            'email_tag_filter_strategy': ('django.db.models.fields.SmallIntegerField', [], {'default': '1'}),
+            'first_name': ('django.db.models.fields.CharField', [], {'max_length': '30', 'blank': 'True'}),
+            'gold': ('django.db.models.fields.SmallIntegerField', [], {'default': '0'}),
+            'gravatar': ('django.db.models.fields.CharField', [], {'max_length': '32'}),
+            'groups': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['auth.Group']", 'symmetrical': 'False', 'blank': 'True'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'ignored_tags': ('django.db.models.fields.TextField', [], {'blank': 'True'}),
+            'interesting_tags': ('django.db.models.fields.TextField', [], {'blank': 'True'}),
+            'is_active': ('django.db.models.fields.BooleanField', [], {'default': 'True'}),
+            'is_staff': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
+            'is_superuser': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
+            'last_login': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}),
+            'last_name': ('django.db.models.fields.CharField', [], {'max_length': '30', 'blank': 'True'}),
+            'last_seen': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}),
+            'location': ('django.db.models.fields.CharField', [], {'max_length': '100', 'blank': 'True'}),
+            'new_response_count': ('django.db.models.fields.IntegerField', [], {'default': '0'}),
+            'password': ('django.db.models.fields.CharField', [], {'max_length': '128'}),
+            'questions_per_page': ('django.db.models.fields.SmallIntegerField', [], {'default': '10'}),
+            'real_name': ('django.db.models.fields.CharField', [], {'max_length': '100', 'blank': 'True'}),
+            'reputation': ('django.db.models.fields.PositiveIntegerField', [], {'default': '1'}),
+            'seen_response_count': ('django.db.models.fields.IntegerField', [], {'default': '0'}),
+            'show_country': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
+            'silver': ('django.db.models.fields.SmallIntegerField', [], {'default': '0'}),
+            'status': ('django.db.models.fields.CharField', [], {'default': "'w'", 'max_length': '2'}),
+            'user_permissions': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['auth.Permission']", 'symmetrical': 'False', 'blank': 'True'}),
+            'username': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '30'}),
+            'website': ('django.db.models.fields.URLField', [], {'max_length': '200', 'blank': 'True'})
+        },
+        'contenttypes.contenttype': {
+            'Meta': {'ordering': "('name',)", 'unique_together': "(('app_label', 'model'),)", 'object_name': 'ContentType', 'db_table': "'django_content_type'"},
+            'app_label': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'model': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '100'})
+        },
+        'django_comment_common.permission': {
+            'Meta': {'object_name': 'Permission'},
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '30', 'primary_key': 'True'}),
+            'roles': ('django.db.models.fields.related.ManyToManyField', [], {'related_name': "'permissions'", 'symmetrical': 'False', 'to': "orm['django_comment_common.Role']"})
+        },
+        'django_comment_common.role': {
+            'Meta': {'object_name': 'Role'},
+            'course_id': ('django.db.models.fields.CharField', [], {'db_index': 'True', 'max_length': '255', 'blank': 'True'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '30'}),
+            'users': ('django.db.models.fields.related.ManyToManyField', [], {'related_name': "'roles'", 'symmetrical': 'False', 'to': "orm['auth.User']"})
+        }
+    }
+
+    complete_apps = ['django_comment_common']

common/djangoapps/django_comment_common/models.py

@@ -0,0 +1,74 @@
+import logging
+
+from django.db import models
+from django.contrib.auth.models import User
+
+from django.dispatch import receiver
+from django.db.models.signals import post_save
+
+from student.models import CourseEnrollment
+
+from xmodule.modulestore.django import modulestore
+from xmodule.course_module import CourseDescriptor
+
+FORUM_ROLE_ADMINISTRATOR = 'Administrator'
+FORUM_ROLE_MODERATOR = 'Moderator'
+FORUM_ROLE_COMMUNITY_TA = 'Community TA'
+FORUM_ROLE_STUDENT = 'Student'
+
+
+@receiver(post_save, sender=CourseEnrollment)
+def assign_default_role(sender, instance, **kwargs):
+    if instance.user.is_staff:
+        role = Role.objects.get_or_create(course_id=instance.course_id, name="Moderator")[0]
+    else:
+        role = Role.objects.get_or_create(course_id=instance.course_id, name="Student")[0]
+
+    logging.info("assign_default_role: adding %s as %s" % (instance.user, role))
+    instance.user.roles.add(role)
+
+
+class Role(models.Model):
+    name = models.CharField(max_length=30, null=False, blank=False)
+    users = models.ManyToManyField(User, related_name="roles")
+    course_id = models.CharField(max_length=255, blank=True, db_index=True)
+
+    class Meta:
+        # use existing table that was originally created from django_comment_client app
+        db_table = 'django_comment_client_role'
+
+    def __unicode__(self):
+        return self.name + " for " + (self.course_id if self.course_id else "all courses")
+
+    def inherit_permissions(self, role):   # TODO the name of this method is a little bit confusing,
+                                         # since it's one-off and doesn't handle inheritance later
+        if role.course_id and role.course_id != self.course_id:
+            logging.warning("%s cannot inherit permissions from %s due to course_id inconsistency", \
+                            self, role)
+        for per in role.permissions.all():
+            self.add_permission(per)
+
+    def add_permission(self, permission):
+        self.permissions.add(Permission.objects.get_or_create(name=permission)[0])
+
+    def has_permission(self, permission):
+        course_loc = CourseDescriptor.id_to_location(self.course_id)
+        course = modulestore().get_instance(self.course_id, course_loc)
+        if self.name == FORUM_ROLE_STUDENT and \
+           (permission.startswith('edit') or permission.startswith('update') or permission.startswith('create')) and \
+           (not course.forum_posts_allowed):
+            return False
+
+        return self.permissions.filter(name=permission).exists()
+
+
+class Permission(models.Model):
+    name = models.CharField(max_length=30, null=False, blank=False, primary_key=True)
+    roles = models.ManyToManyField(Role, related_name="permissions")
+
+    class Meta:
+        # use existing table that was originally created from django_comment_client app
+        db_table = 'django_comment_client_permission'
+
+    def __unicode__(self):
+        return self.name

common/djangoapps/django_comment_common/utils.py

@@ -0,0 +1,56 @@
+from django_comment_common.models import Role
+
+_STUDENT_ROLE_PERMISSIONS = ["vote", "update_thread", "follow_thread", "unfollow_thread",
+                             "update_comment", "create_sub_comment", "unvote", "create_thread",
+                             "follow_commentable", "unfollow_commentable", "create_comment", ]
+
+_MODERATOR_ROLE_PERMISSIONS = ["edit_content", "delete_thread", "openclose_thread",
+                               "endorse_comment", "delete_comment", "see_all_cohorts"]
+
+_ADMINISTRATOR_ROLE_PERMISSIONS = ["manage_moderator"]
+
+def seed_permissions_roles(course_id):
+    administrator_role = Role.objects.get_or_create(name="Administrator", course_id=course_id)[0]
+    moderator_role = Role.objects.get_or_create(name="Moderator", course_id=course_id)[0]
+    community_ta_role = Role.objects.get_or_create(name="Community TA", course_id=course_id)[0]
+    student_role = Role.objects.get_or_create(name="Student", course_id=course_id)[0]
+
+    for per in _STUDENT_ROLE_PERMISSIONS:
+        student_role.add_permission(per)
+
+    for per in _MODERATOR_ROLE_PERMISSIONS:
+        moderator_role.add_permission(per)
+
+    for per in _ADMINISTRATOR_ROLE_PERMISSIONS:
+        administrator_role.add_permission(per)
+
+    moderator_role.inherit_permissions(student_role)
+
+    # For now, Community TA == Moderator, except for the styling.
+    community_ta_role.inherit_permissions(moderator_role)
+
+    administrator_role.inherit_permissions(moderator_role)
+
+
+def are_permissions_roles_seeded(course_id):
+
+    try:
+        administrator_role = Role.objects.get(name="Administrator", course_id=course_id)
+        moderator_role = Role.objects.get(name="Moderator", course_id=course_id)
+        student_role = Role.objects.get(name="Student", course_id=course_id)
+    except:
+        return False
+
+    for per in _STUDENT_ROLE_PERMISSIONS:
+        if not student_role.has_permission(per):
+            return False
+
+    for per in _MODERATOR_ROLE_PERMISSIONS + _STUDENT_ROLE_PERMISSIONS:
+        if not moderator_role.has_permission(per):
+            return False
+
+    for per in _ADMINISTRATOR_ROLE_PERMISSIONS + _MODERATOR_ROLE_PERMISSIONS + _STUDENT_ROLE_PERMISSIONS:
+        if not administrator_role.has_permission(per):
+            return False
+
+    return True

common/lib/xmodule/xmodule/modulestore/__init__.py

@@ -9,7 +9,7 @@ import re
 from collections import namedtuple
 
 from .exceptions import InvalidLocationError, InsufficientSpecificationError
-from xmodule.errortracker import ErrorLog, make_error_tracker
+from xmodule.errortracker import make_error_tracker
 from bson.son import SON
 
 log = logging.getLogger('mitx.' + 'modulestore')
@@ -64,7 +64,6 @@ class Location(_LocationBase):
         """
         return re.sub('_+', '_', invalid.sub('_', value))
 
-
     @staticmethod
     def clean(value):
         """
@@ -72,7 +71,6 @@ class Location(_LocationBase):
         """
         return Location._clean(value, INVALID_CHARS)
 
-
     @staticmethod
     def clean_keeping_underscores(value):
         """
@@ -82,7 +80,6 @@ class Location(_LocationBase):
         """
         return INVALID_CHARS.sub('_', value)
 
-
     @staticmethod
     def clean_for_url_name(value):
         """
@@ -154,9 +151,7 @@ class Location(_LocationBase):
         to mean wildcard selection.
         """
 
-
-        if (org is None and course is None and category is None and
-            name is None and revision is None):
+        if (org is None and course is None and category is None and name is None and revision is None):
             location = loc_or_tag
         else:
             location = (loc_or_tag, org, course, category, name, revision)
@@ -191,7 +186,7 @@ class Location(_LocationBase):
                 match = MISSING_SLASH_URL_RE.match(location)
                 if match is None:
                     log.debug('location is instance of %s but no URL match' % basestring)
-                    raise InvalidLocationError(location)    
+                    raise InvalidLocationError(location)
             groups = match.groupdict()
             check_dict(groups)
             return _LocationBase.__new__(_cls, **groups)
@@ -233,7 +228,7 @@ class Location(_LocationBase):
         html id attributes
         """
         s = "-".join(str(v) for v in self.list()
-                        if v is not None)
+                     if v is not None)
         return Location.clean_for_html(s)
 
     def dict(self):
@@ -258,6 +253,12 @@ class Location(_LocationBase):
         at the location URL hierachy"""
         return "/".join([self.org, self.course, self.name])
 
+    def replace(self, **kwargs):
+        '''
+        Expose a public method for replacing location elements
+        '''
+        return self._replace(**kwargs)
+
 
 class ModuleStore(object):
     """
@@ -382,12 +383,6 @@ class ModuleStore(object):
         '''
         raise NotImplementedError
 
-    def get_course(self, course_id):
-        '''
-        Look for a specific course id.  Returns the course descriptor, or None if not found.
-        '''
-        raise NotImplementedError
-
     def get_parent_locations(self, location, course_id):
         '''Find all locations that are the parents of this location in this
         course.  Needed for path_to_location().
@@ -406,8 +401,7 @@ class ModuleStore(object):
         courses = [
             course
             for course in self.get_courses()
-            if course.location.org == location.org
-               and course.location.course == location.course
+            if course.location.org == location.org and course.location.course == location.course
         ]
 
         return courses

common/lib/xmodule/xmodule/modulestore/draft.py

@@ -13,11 +13,12 @@ def as_draft(location):
     """
     return Location(location)._replace(revision=DRAFT)
 
+
 def as_published(location):
     """
     Returns the Location that is the published version for `location`
     """
-    return Location(location)._replace(revision=None)    
+    return Location(location)._replace(revision=None)
 
 
 def wrap_draft(item):

common/lib/xmodule/xmodule/modulestore/tests/factories.py

@@ -3,7 +3,6 @@ from time import gmtime
 from uuid import uuid4
 from xmodule.modulestore import Location
 from xmodule.modulestore.django import modulestore
-from xmodule.timeparse import stringify_time
 from xmodule.modulestore.inheritance import own_metadata