48ad7effb1
Current State (before this commit): Studio, as of today doesn't have a way to restrict a user to create a course in a particular organization. What Studio provides right now is a CourseCreator permission which gives an Admin the power to grant a user the permission to create a course. For example: If the Admin has given a user Spiderman the permission to create courses, Spiderman can now create courses in any organization i.e Marvel as well as DC. There is no way to restrict Spiderman from creating courses under DC. Purpose of this commit: The changes done here gives Admin the ability to restrict a user on an Organization level from creating courses via the Course Creators section of the Studio Django administration panel. For example: Now, the Admin can give the user Spiderman the privilege of creating courses only under Marvel organization. The moment Spiderman tries to create a course under some other organization(i.e DC), Studio will show an error message. This change is available to all Studio instances that enable the FEATURES['ENABLE_CREATOR_GROUP'] flag. Regardless of the flag, it will not affect any instances that choose not to use it. BB-3622
112 lines
3.5 KiB
Python
112 lines
3.5 KiB
Python
"""
|
|
Methods for interacting programmatically with the user creator table.
|
|
"""
|
|
|
|
|
|
from cms.djangoapps.course_creators.models import CourseCreator
|
|
from common.djangoapps.student import auth
|
|
from common.djangoapps.student.roles import CourseCreatorRole, OrgContentCreatorRole
|
|
|
|
|
|
def add_user_with_status_unrequested(user):
|
|
"""
|
|
Adds a user to the course creator table with status 'unrequested'.
|
|
|
|
If the user is already in the table, this method is a no-op
|
|
(state will not be changed).
|
|
|
|
If the user is marked as is_staff, this method is a no-op (user
|
|
will not be added to table).
|
|
"""
|
|
_add_user(user, CourseCreator.UNREQUESTED)
|
|
|
|
|
|
def add_user_with_status_granted(caller, user):
|
|
"""
|
|
Adds a user to the course creator table with status 'granted'.
|
|
|
|
If appropriate, this method also adds the user to the course creator group maintained by authz.py.
|
|
Caller must have staff permissions.
|
|
|
|
If the user is already in the table, this method is a no-op
|
|
(state will not be changed).
|
|
|
|
If the user is marked as is_staff, this method is a no-op (user
|
|
will not be added to table, nor added to authz.py group).
|
|
"""
|
|
if _add_user(user, CourseCreator.GRANTED):
|
|
update_course_creator_group(caller, user, True)
|
|
|
|
|
|
def update_course_creator_group(caller, user, add):
|
|
"""
|
|
Method for adding and removing users from the creator group.
|
|
|
|
Caller must have staff permissions.
|
|
"""
|
|
if add:
|
|
auth.add_users(caller, CourseCreatorRole(), user)
|
|
else:
|
|
auth.remove_users(caller, CourseCreatorRole(), user)
|
|
|
|
|
|
def update_org_content_creator_role(caller, user, orgs):
|
|
"""
|
|
Method for updating users for OrgContentCreatorRole, this method
|
|
takes care of creating and deleting the role as required.
|
|
|
|
Caller must have staff permissions.
|
|
"""
|
|
auth.update_org_role(caller, OrgContentCreatorRole, user, orgs)
|
|
|
|
|
|
def get_course_creator_status(user):
|
|
"""
|
|
Returns the status for a particular user, or None if user is not in the table.
|
|
|
|
Possible return values are:
|
|
'unrequested' = user has not requested course creation rights
|
|
'pending' = user has requested course creation rights
|
|
'granted' = user has been granted course creation rights
|
|
'denied' = user has been denied course creation rights
|
|
None = user does not exist in the table
|
|
"""
|
|
user = CourseCreator.objects.filter(user=user)
|
|
if user.count() == 0:
|
|
return None
|
|
else:
|
|
# User is defined to be unique, can assume a single entry.
|
|
return user[0].state
|
|
|
|
|
|
def user_requested_access(user):
|
|
"""
|
|
User has requested course creator access.
|
|
|
|
This changes the user state to CourseCreator.PENDING, unless the user
|
|
state is already CourseCreator.GRANTED, in which case this method is a no-op.
|
|
"""
|
|
user = CourseCreator.objects.get(user=user)
|
|
if user.state != CourseCreator.GRANTED:
|
|
user.state = CourseCreator.PENDING
|
|
user.save()
|
|
|
|
|
|
def _add_user(user, state):
|
|
"""
|
|
Adds a user to the course creator table with the specified state.
|
|
|
|
Returns True if user was added to table, else False.
|
|
|
|
If the user is already in the table, this method is a no-op
|
|
(state will not be changed, method will return False).
|
|
|
|
If the user is marked as is_staff, this method is a no-op (False will be returned).
|
|
"""
|
|
if not user.is_staff and CourseCreator.objects.filter(user=user).count() == 0:
|
|
entry = CourseCreator(user=user, state=state)
|
|
entry.save()
|
|
return True
|
|
|
|
return False
|