151bd13666
* Generate common/djangoapps import shims for LMS * Generate common/djangoapps import shims for Studio * Stop appending project root to sys.path * Stop appending common/djangoapps to sys.path * Import from common.djangoapps.course_action_state instead of course_action_state * Import from common.djangoapps.course_modes instead of course_modes * Import from common.djangoapps.database_fixups instead of database_fixups * Import from common.djangoapps.edxmako instead of edxmako * Import from common.djangoapps.entitlements instead of entitlements * Import from common.djangoapps.pipline_mako instead of pipeline_mako * Import from common.djangoapps.static_replace instead of static_replace * Import from common.djangoapps.student instead of student * Import from common.djangoapps.terrain instead of terrain * Import from common.djangoapps.third_party_auth instead of third_party_auth * Import from common.djangoapps.track instead of track * Import from common.djangoapps.util instead of util * Import from common.djangoapps.xblock_django instead of xblock_django * Add empty common/djangoapps/__init__.py to fix pytest collection * Fix pylint formatting violations * Exclude import_shims/ directory tree from linting
102 lines
3.2 KiB
Python
102 lines
3.2 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
|
|
|
|
|
|
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 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
|