Move comment_client into django_comment_common
This commit is contained in:
Nimisha Asthagiri
@@ -0,0 +1 @@
|
||||
See ``lms/djangoapps/discussion/README.rst``
|
||||
@@ -0,0 +1,5 @@
|
||||
from .comment_client import *
|
||||
from .utils import (
|
||||
CommentClientError, CommentClientRequestError,
|
||||
CommentClient500Error, CommentClientMaintenanceError
|
||||
)
|
||||
@@ -0,0 +1,110 @@
|
||||
from django_comment_common.comment_client import models, settings
|
||||
|
||||
from .thread import Thread, _url_for_flag_abuse_thread, _url_for_unflag_abuse_thread
|
||||
from .utils import CommentClientRequestError, perform_request
|
||||
|
||||
|
||||
class Comment(models.Model):
|
||||
|
||||
accessible_fields = [
|
||||
'id', 'body', 'anonymous', 'anonymous_to_peers', 'course_id',
|
||||
'endorsed', 'parent_id', 'thread_id', 'username', 'votes', 'user_id',
|
||||
'closed', 'created_at', 'updated_at', 'depth', 'at_position_list',
|
||||
'type', 'commentable_id', 'abuse_flaggers', 'endorsement',
|
||||
'child_count',
|
||||
]
|
||||
|
||||
updatable_fields = [
|
||||
'body', 'anonymous', 'anonymous_to_peers', 'course_id', 'closed',
|
||||
'user_id', 'endorsed', 'endorsement_user_id',
|
||||
]
|
||||
|
||||
initializable_fields = updatable_fields
|
||||
|
||||
metrics_tag_fields = ['course_id', 'endorsed', 'closed']
|
||||
|
||||
base_url = "{prefix}/comments".format(prefix=settings.PREFIX)
|
||||
type = 'comment'
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
super(Comment, self).__init__(*args, **kwargs)
|
||||
self._cached_thread = None
|
||||
|
||||
@property
|
||||
def thread(self):
|
||||
if not self._cached_thread:
|
||||
self._cached_thread = Thread(id=self.thread_id, type='thread')
|
||||
return self._cached_thread
|
||||
|
||||
@property
|
||||
def context(self):
|
||||
"""Return the context of the thread which this comment belongs to."""
|
||||
return self.thread.context
|
||||
|
||||
@classmethod
|
||||
def url_for_comments(cls, params={}):
|
||||
if params.get('parent_id'):
|
||||
return _url_for_comment(params['parent_id'])
|
||||
else:
|
||||
return _url_for_thread_comments(params['thread_id'])
|
||||
|
||||
@classmethod
|
||||
def url(cls, action, params={}):
|
||||
if action in ['post']:
|
||||
return cls.url_for_comments(params)
|
||||
else:
|
||||
return super(Comment, cls).url(action, params)
|
||||
|
||||
def flagAbuse(self, user, voteable):
|
||||
if voteable.type == 'thread':
|
||||
url = _url_for_flag_abuse_thread(voteable.id)
|
||||
elif voteable.type == 'comment':
|
||||
url = _url_for_flag_abuse_comment(voteable.id)
|
||||
else:
|
||||
raise CommentClientRequestError("Can only flag/unflag threads or comments")
|
||||
params = {'user_id': user.id}
|
||||
response = perform_request(
|
||||
'put',
|
||||
url,
|
||||
params,
|
||||
metric_tags=self._metric_tags,
|
||||
metric_action='comment.abuse.flagged'
|
||||
)
|
||||
voteable._update_from_response(response)
|
||||
|
||||
def unFlagAbuse(self, user, voteable, removeAll):
|
||||
if voteable.type == 'thread':
|
||||
url = _url_for_unflag_abuse_thread(voteable.id)
|
||||
elif voteable.type == 'comment':
|
||||
url = _url_for_unflag_abuse_comment(voteable.id)
|
||||
else:
|
||||
raise CommentClientRequestError("Can flag/unflag for threads or comments")
|
||||
params = {'user_id': user.id}
|
||||
|
||||
if removeAll:
|
||||
params['all'] = True
|
||||
|
||||
response = perform_request(
|
||||
'put',
|
||||
url,
|
||||
params,
|
||||
metric_tags=self._metric_tags,
|
||||
metric_action='comment.abuse.unflagged'
|
||||
)
|
||||
voteable._update_from_response(response)
|
||||
|
||||
|
||||
def _url_for_thread_comments(thread_id):
|
||||
return "{prefix}/threads/{thread_id}/comments".format(prefix=settings.PREFIX, thread_id=thread_id)
|
||||
|
||||
|
||||
def _url_for_comment(comment_id):
|
||||
return "{prefix}/comments/{comment_id}".format(prefix=settings.PREFIX, comment_id=comment_id)
|
||||
|
||||
|
||||
def _url_for_flag_abuse_comment(comment_id):
|
||||
return "{prefix}/comments/{comment_id}/abuse_flag".format(prefix=settings.PREFIX, comment_id=comment_id)
|
||||
|
||||
|
||||
def _url_for_unflag_abuse_comment(comment_id):
|
||||
return "{prefix}/comments/{comment_id}/abuse_unflag".format(prefix=settings.PREFIX, comment_id=comment_id)
|
||||
@@ -0,0 +1,6 @@
|
||||
"""Import other classes here so they can be imported from here."""
|
||||
# pylint: disable=unused-import
|
||||
from .comment import Comment
|
||||
from .commentable import Commentable
|
||||
from .thread import Thread
|
||||
from .user import User
|
||||
@@ -0,0 +1,18 @@
|
||||
"""Provides base Commentable model class"""
|
||||
from django_comment_common.comment_client import models, settings
|
||||
|
||||
|
||||
class Commentable(models.Model):
|
||||
|
||||
accessible_fields = ['id', 'commentable_id']
|
||||
|
||||
base_url = "{prefix}/commentables".format(prefix=settings.PREFIX)
|
||||
type = 'commentable'
|
||||
|
||||
def retrieve(self, *args, **kwargs):
|
||||
"""
|
||||
Override default behavior because commentables don't actually exist in the comment service.
|
||||
"""
|
||||
self.attributes["commentable_id"] = self.attributes["id"]
|
||||
self.retrieved = True
|
||||
return self
|
||||
182
common/djangoapps/django_comment_common/comment_client/models.py
Normal file
182
common/djangoapps/django_comment_common/comment_client/models.py
Normal file
@@ -0,0 +1,182 @@
|
||||
import logging
|
||||
|
||||
from .utils import CommentClientRequestError, extract, perform_request
|
||||
|
||||
log = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class Model(object):
|
||||
|
||||
accessible_fields = ['id']
|
||||
updatable_fields = ['id']
|
||||
initializable_fields = ['id']
|
||||
base_url = None
|
||||
default_retrieve_params = {}
|
||||
metric_tag_fields = []
|
||||
|
||||
DEFAULT_ACTIONS_WITH_ID = ['get', 'put', 'delete']
|
||||
DEFAULT_ACTIONS_WITHOUT_ID = ['get_all', 'post']
|
||||
DEFAULT_ACTIONS = DEFAULT_ACTIONS_WITH_ID + DEFAULT_ACTIONS_WITHOUT_ID
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
self.attributes = extract(kwargs, self.accessible_fields)
|
||||
self.retrieved = False
|
||||
|
||||
def __getattr__(self, name):
|
||||
if name == 'id':
|
||||
return self.attributes.get('id', None)
|
||||
try:
|
||||
return self.attributes[name]
|
||||
except KeyError:
|
||||
if self.retrieved or self.id is None:
|
||||
raise AttributeError(u"Field {0} does not exist".format(name))
|
||||
self.retrieve()
|
||||
return self.__getattr__(name)
|
||||
|
||||
def __setattr__(self, name, value):
|
||||
if name == 'attributes' or name not in self.accessible_fields + self.updatable_fields:
|
||||
super(Model, self).__setattr__(name, value)
|
||||
else:
|
||||
self.attributes[name] = value
|
||||
|
||||
def __getitem__(self, key):
|
||||
if key not in self.accessible_fields:
|
||||
raise KeyError(u"Field {0} does not exist".format(key))
|
||||
return self.attributes.get(key)
|
||||
|
||||
def __setitem__(self, key, value):
|
||||
if key not in self.accessible_fields + self.updatable_fields:
|
||||
raise KeyError(u"Field {0} does not exist".format(key))
|
||||
self.attributes.__setitem__(key, value)
|
||||
|
||||
def items(self, *args, **kwargs):
|
||||
return self.attributes.items(*args, **kwargs)
|
||||
|
||||
def get(self, *args, **kwargs):
|
||||
return self.attributes.get(*args, **kwargs)
|
||||
|
||||
def to_dict(self):
|
||||
self.retrieve()
|
||||
return self.attributes
|
||||
|
||||
def retrieve(self, *args, **kwargs):
|
||||
if not self.retrieved:
|
||||
self._retrieve(*args, **kwargs)
|
||||
self.retrieved = True
|
||||
return self
|
||||
|
||||
def _retrieve(self, *args, **kwargs):
|
||||
url = self.url(action='get', params=self.attributes)
|
||||
response = perform_request(
|
||||
'get',
|
||||
url,
|
||||
self.default_retrieve_params,
|
||||
metric_tags=self._metric_tags,
|
||||
metric_action='model.retrieve'
|
||||
)
|
||||
self._update_from_response(response)
|
||||
|
||||
@property
|
||||
def _metric_tags(self):
|
||||
"""
|
||||
Returns a list of tags to be used when recording metrics about this model.
|
||||
|
||||
Each field named in ``self.metric_tag_fields`` is used as a tag value,
|
||||
under the key ``<class>.<metric_field>``. The tag model_class is used to
|
||||
record the class name of the model.
|
||||
"""
|
||||
tags = [
|
||||
u'{}.{}:{}'.format(self.__class__.__name__, attr, self[attr])
|
||||
for attr in self.metric_tag_fields
|
||||
if attr in self.attributes
|
||||
]
|
||||
tags.append(u'model_class:{}'.format(self.__class__.__name__))
|
||||
return tags
|
||||
|
||||
@classmethod
|
||||
def find(cls, id):
|
||||
return cls(id=id)
|
||||
|
||||
def _update_from_response(self, response_data):
|
||||
for k, v in response_data.items():
|
||||
if k in self.accessible_fields:
|
||||
self.__setattr__(k, v)
|
||||
else:
|
||||
log.warning(
|
||||
u"Unexpected field {field_name} in model {model_name}".format(
|
||||
field_name=k,
|
||||
model_name=self.__class__.__name__
|
||||
)
|
||||
)
|
||||
|
||||
def updatable_attributes(self):
|
||||
return extract(self.attributes, self.updatable_fields)
|
||||
|
||||
def initializable_attributes(self):
|
||||
return extract(self.attributes, self.initializable_fields)
|
||||
|
||||
@classmethod
|
||||
def before_save(cls, instance):
|
||||
pass
|
||||
|
||||
@classmethod
|
||||
def after_save(cls, instance):
|
||||
pass
|
||||
|
||||
def save(self, params=None):
|
||||
"""
|
||||
Invokes Forum's POST/PUT service to create/update thread
|
||||
"""
|
||||
self.before_save(self)
|
||||
if self.id: # if we have id already, treat this as an update
|
||||
request_params = self.updatable_attributes()
|
||||
if params:
|
||||
request_params.update(params)
|
||||
url = self.url(action='put', params=self.attributes)
|
||||
response = perform_request(
|
||||
'put',
|
||||
url,
|
||||
request_params,
|
||||
metric_tags=self._metric_tags,
|
||||
metric_action='model.update'
|
||||
)
|
||||
else: # otherwise, treat this as an insert
|
||||
url = self.url(action='post', params=self.attributes)
|
||||
response = perform_request(
|
||||
'post',
|
||||
url,
|
||||
self.initializable_attributes(),
|
||||
metric_tags=self._metric_tags,
|
||||
metric_action='model.insert'
|
||||
)
|
||||
self.retrieved = True
|
||||
self._update_from_response(response)
|
||||
self.after_save(self)
|
||||
|
||||
def delete(self):
|
||||
url = self.url(action='delete', params=self.attributes)
|
||||
response = perform_request('delete', url, metric_tags=self._metric_tags, metric_action='model.delete')
|
||||
self.retrieved = True
|
||||
self._update_from_response(response)
|
||||
|
||||
@classmethod
|
||||
def url_with_id(cls, params={}):
|
||||
return cls.base_url + '/' + str(params['id'])
|
||||
|
||||
@classmethod
|
||||
def url_without_id(cls, params={}):
|
||||
return cls.base_url
|
||||
|
||||
@classmethod
|
||||
def url(cls, action, params={}):
|
||||
if cls.base_url is None:
|
||||
raise CommentClientRequestError("Must provide base_url when using default url function")
|
||||
if action not in cls.DEFAULT_ACTIONS:
|
||||
raise ValueError(u"Invalid action {0}. The supported action must be in {1}".format(action, str(cls.DEFAULT_ACTIONS)))
|
||||
elif action in cls.DEFAULT_ACTIONS_WITH_ID:
|
||||
try:
|
||||
return cls.url_with_id(params)
|
||||
except KeyError:
|
||||
raise CommentClientRequestError(u"Cannot perform action {0} without id".format(action))
|
||||
else: # action must be in DEFAULT_ACTIONS_WITHOUT_ID now
|
||||
return cls.url_without_id()
|
||||
@@ -0,0 +1 @@
|
||||
requests
|
||||
@@ -0,0 +1,8 @@
|
||||
from django.conf import settings
|
||||
|
||||
if hasattr(settings, "COMMENTS_SERVICE_URL"):
|
||||
SERVICE_HOST = settings.COMMENTS_SERVICE_URL
|
||||
else:
|
||||
SERVICE_HOST = 'http://localhost:4567'
|
||||
|
||||
PREFIX = SERVICE_HOST + '/api/v1'
|
||||
235
common/djangoapps/django_comment_common/comment_client/thread.py
Normal file
235
common/djangoapps/django_comment_common/comment_client/thread.py
Normal file
@@ -0,0 +1,235 @@
|
||||
import logging
|
||||
|
||||
import settings
|
||||
|
||||
import models
|
||||
from eventtracking import tracker
|
||||
|
||||
import utils
|
||||
|
||||
log = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class Thread(models.Model):
|
||||
|
||||
# accessible_fields can be set and retrieved on the model
|
||||
accessible_fields = [
|
||||
'id', 'title', 'body', 'anonymous', 'anonymous_to_peers', 'course_id',
|
||||
'closed', 'tags', 'votes', 'commentable_id', 'username', 'user_id',
|
||||
'created_at', 'updated_at', 'comments_count', 'unread_comments_count',
|
||||
'at_position_list', 'children', 'type', 'highlighted_title',
|
||||
'highlighted_body', 'endorsed', 'read', 'group_id', 'group_name', 'pinned',
|
||||
'abuse_flaggers', 'resp_skip', 'resp_limit', 'resp_total', 'thread_type',
|
||||
'endorsed_responses', 'non_endorsed_responses', 'non_endorsed_resp_total',
|
||||
'context', 'last_activity_at',
|
||||
]
|
||||
|
||||
# updateable_fields are sent in PUT requests
|
||||
updatable_fields = [
|
||||
'title', 'body', 'anonymous', 'anonymous_to_peers', 'course_id', 'read',
|
||||
'closed', 'user_id', 'commentable_id', 'group_id', 'group_name', 'pinned', 'thread_type'
|
||||
]
|
||||
|
||||
# metric_tag_fields are used by Datadog to record metrics about the model
|
||||
metric_tag_fields = [
|
||||
'course_id', 'group_id', 'pinned', 'closed', 'anonymous', 'anonymous_to_peers',
|
||||
'endorsed', 'read'
|
||||
]
|
||||
|
||||
# initializable_fields are sent in POST requests
|
||||
initializable_fields = updatable_fields + ['thread_type', 'context']
|
||||
|
||||
base_url = "{prefix}/threads".format(prefix=settings.PREFIX)
|
||||
default_retrieve_params = {'recursive': False}
|
||||
type = 'thread'
|
||||
|
||||
@classmethod
|
||||
def search(cls, query_params):
|
||||
|
||||
# NOTE: Params 'recursive' and 'with_responses' are currently not used by
|
||||
# either the 'search' or 'get_all' actions below. Both already use
|
||||
# with_responses=False internally in the comment service, so no additional
|
||||
# optimization is required.
|
||||
params = {
|
||||
'page': 1,
|
||||
'per_page': 20,
|
||||
'course_id': query_params['course_id'],
|
||||
}
|
||||
params.update(
|
||||
utils.strip_blank(utils.strip_none(query_params))
|
||||
)
|
||||
|
||||
if query_params.get('text'):
|
||||
url = cls.url(action='search')
|
||||
else:
|
||||
url = cls.url(action='get_all', params=utils.extract(params, 'commentable_id'))
|
||||
if params.get('commentable_id'):
|
||||
del params['commentable_id']
|
||||
response = utils.perform_request(
|
||||
'get',
|
||||
url,
|
||||
params,
|
||||
metric_tags=[u'course_id:{}'.format(query_params['course_id'])],
|
||||
metric_action='thread.search',
|
||||
paged_results=True
|
||||
)
|
||||
if query_params.get('text'):
|
||||
search_query = query_params['text']
|
||||
course_id = query_params['course_id']
|
||||
group_id = query_params['group_id'] if 'group_id' in query_params else None
|
||||
requested_page = params['page']
|
||||
total_results = response.get('total_results')
|
||||
corrected_text = response.get('corrected_text')
|
||||
# Record search result metric to allow search quality analysis.
|
||||
# course_id is already included in the context for the event tracker
|
||||
tracker.emit(
|
||||
'edx.forum.searched',
|
||||
{
|
||||
'query': search_query,
|
||||
'corrected_text': corrected_text,
|
||||
'group_id': group_id,
|
||||
'page': requested_page,
|
||||
'total_results': total_results,
|
||||
}
|
||||
)
|
||||
log.info(
|
||||
u'forum_text_search query="{search_query}" corrected_text="{corrected_text}" course_id={course_id} group_id={group_id} page={requested_page} total_results={total_results}'.format(
|
||||
search_query=search_query,
|
||||
corrected_text=corrected_text,
|
||||
course_id=course_id,
|
||||
group_id=group_id,
|
||||
requested_page=requested_page,
|
||||
total_results=total_results
|
||||
)
|
||||
)
|
||||
|
||||
return utils.CommentClientPaginatedResult(
|
||||
collection=response.get('collection', []),
|
||||
page=response.get('page', 1),
|
||||
num_pages=response.get('num_pages', 1),
|
||||
thread_count=response.get('thread_count', 0),
|
||||
corrected_text=response.get('corrected_text', None)
|
||||
)
|
||||
|
||||
@classmethod
|
||||
def url_for_threads(cls, params={}):
|
||||
if params.get('commentable_id'):
|
||||
return u"{prefix}/{commentable_id}/threads".format(prefix=settings.PREFIX, commentable_id=params['commentable_id'])
|
||||
else:
|
||||
return u"{prefix}/threads".format(prefix=settings.PREFIX)
|
||||
|
||||
@classmethod
|
||||
def url_for_search_threads(cls, params={}):
|
||||
return "{prefix}/search/threads".format(prefix=settings.PREFIX)
|
||||
|
||||
@classmethod
|
||||
def url(cls, action, params={}):
|
||||
|
||||
if action in ['get_all', 'post']:
|
||||
return cls.url_for_threads(params)
|
||||
elif action == 'search':
|
||||
return cls.url_for_search_threads(params)
|
||||
else:
|
||||
return super(Thread, cls).url(action, params)
|
||||
|
||||
# TODO: This is currently overriding Model._retrieve only to add parameters
|
||||
# for the request. Model._retrieve should be modified to handle this such
|
||||
# that subclasses don't need to override for this.
|
||||
def _retrieve(self, *args, **kwargs):
|
||||
url = self.url(action='get', params=self.attributes)
|
||||
request_params = {
|
||||
'recursive': kwargs.get('recursive'),
|
||||
'with_responses': kwargs.get('with_responses', False),
|
||||
'user_id': kwargs.get('user_id'),
|
||||
'mark_as_read': kwargs.get('mark_as_read', True),
|
||||
'resp_skip': kwargs.get('response_skip'),
|
||||
'resp_limit': kwargs.get('response_limit'),
|
||||
}
|
||||
request_params = utils.strip_none(request_params)
|
||||
|
||||
response = utils.perform_request(
|
||||
'get',
|
||||
url,
|
||||
request_params,
|
||||
metric_action='model.retrieve',
|
||||
metric_tags=self._metric_tags
|
||||
)
|
||||
self._update_from_response(response)
|
||||
|
||||
def flagAbuse(self, user, voteable):
|
||||
if voteable.type == 'thread':
|
||||
url = _url_for_flag_abuse_thread(voteable.id)
|
||||
elif voteable.type == 'comment':
|
||||
url = _url_for_flag_comment(voteable.id)
|
||||
else:
|
||||
raise utils.CommentClientRequestError("Can only flag/unflag threads or comments")
|
||||
params = {'user_id': user.id}
|
||||
response = utils.perform_request(
|
||||
'put',
|
||||
url,
|
||||
params,
|
||||
metric_action='thread.abuse.flagged',
|
||||
metric_tags=self._metric_tags
|
||||
)
|
||||
voteable._update_from_response(response)
|
||||
|
||||
def unFlagAbuse(self, user, voteable, removeAll):
|
||||
if voteable.type == 'thread':
|
||||
url = _url_for_unflag_abuse_thread(voteable.id)
|
||||
elif voteable.type == 'comment':
|
||||
url = _url_for_unflag_comment(voteable.id)
|
||||
else:
|
||||
raise utils.CommentClientRequestError("Can only flag/unflag for threads or comments")
|
||||
params = {'user_id': user.id}
|
||||
#if you're an admin, when you unflag, remove ALL flags
|
||||
if removeAll:
|
||||
params['all'] = True
|
||||
|
||||
response = utils.perform_request(
|
||||
'put',
|
||||
url,
|
||||
params,
|
||||
metric_tags=self._metric_tags,
|
||||
metric_action='thread.abuse.unflagged'
|
||||
)
|
||||
voteable._update_from_response(response)
|
||||
|
||||
def pin(self, user, thread_id):
|
||||
url = _url_for_pin_thread(thread_id)
|
||||
params = {'user_id': user.id}
|
||||
response = utils.perform_request(
|
||||
'put',
|
||||
url,
|
||||
params,
|
||||
metric_tags=self._metric_tags,
|
||||
metric_action='thread.pin'
|
||||
)
|
||||
self._update_from_response(response)
|
||||
|
||||
def un_pin(self, user, thread_id):
|
||||
url = _url_for_un_pin_thread(thread_id)
|
||||
params = {'user_id': user.id}
|
||||
response = utils.perform_request(
|
||||
'put',
|
||||
url,
|
||||
params,
|
||||
metric_tags=self._metric_tags,
|
||||
metric_action='thread.unpin'
|
||||
)
|
||||
self._update_from_response(response)
|
||||
|
||||
|
||||
def _url_for_flag_abuse_thread(thread_id):
|
||||
return "{prefix}/threads/{thread_id}/abuse_flag".format(prefix=settings.PREFIX, thread_id=thread_id)
|
||||
|
||||
|
||||
def _url_for_unflag_abuse_thread(thread_id):
|
||||
return "{prefix}/threads/{thread_id}/abuse_unflag".format(prefix=settings.PREFIX, thread_id=thread_id)
|
||||
|
||||
|
||||
def _url_for_pin_thread(thread_id):
|
||||
return "{prefix}/threads/{thread_id}/pin".format(prefix=settings.PREFIX, thread_id=thread_id)
|
||||
|
||||
|
||||
def _url_for_un_pin_thread(thread_id):
|
||||
return "{prefix}/threads/{thread_id}/unpin".format(prefix=settings.PREFIX, thread_id=thread_id)
|
||||
233
common/djangoapps/django_comment_common/comment_client/user.py
Normal file
233
common/djangoapps/django_comment_common/comment_client/user.py
Normal file
@@ -0,0 +1,233 @@
|
||||
""" User model wrapper for comment service"""
|
||||
from six import text_type
|
||||
|
||||
import settings
|
||||
import models
|
||||
import utils
|
||||
|
||||
|
||||
class User(models.Model):
|
||||
|
||||
accessible_fields = [
|
||||
'username', 'follower_ids', 'upvoted_ids', 'downvoted_ids',
|
||||
'id', 'external_id', 'subscribed_user_ids', 'children', 'course_id',
|
||||
'group_id', 'subscribed_thread_ids', 'subscribed_commentable_ids',
|
||||
'subscribed_course_ids', 'threads_count', 'comments_count',
|
||||
'default_sort_key'
|
||||
]
|
||||
|
||||
updatable_fields = ['username', 'external_id', 'default_sort_key']
|
||||
initializable_fields = updatable_fields
|
||||
|
||||
metric_tag_fields = ['course_id']
|
||||
|
||||
base_url = "{prefix}/users".format(prefix=settings.PREFIX)
|
||||
default_retrieve_params = {'complete': True}
|
||||
type = 'user'
|
||||
|
||||
@classmethod
|
||||
def from_django_user(cls, user):
|
||||
return cls(id=str(user.id),
|
||||
external_id=str(user.id),
|
||||
username=user.username)
|
||||
|
||||
def read(self, source):
|
||||
"""
|
||||
Calls cs_comments_service to mark thread as read for the user
|
||||
"""
|
||||
params = {'source_type': source.type, 'source_id': source.id}
|
||||
utils.perform_request(
|
||||
'post',
|
||||
_url_for_read(self.id),
|
||||
params,
|
||||
metric_action='user.read',
|
||||
metric_tags=self._metric_tags + ['target.type:{}'.format(source.type)],
|
||||
)
|
||||
|
||||
def follow(self, source):
|
||||
params = {'source_type': source.type, 'source_id': source.id}
|
||||
response = utils.perform_request(
|
||||
'post',
|
||||
_url_for_subscription(self.id),
|
||||
params,
|
||||
metric_action='user.follow',
|
||||
metric_tags=self._metric_tags + ['target.type:{}'.format(source.type)],
|
||||
)
|
||||
|
||||
def unfollow(self, source):
|
||||
params = {'source_type': source.type, 'source_id': source.id}
|
||||
response = utils.perform_request(
|
||||
'delete',
|
||||
_url_for_subscription(self.id),
|
||||
params,
|
||||
metric_action='user.unfollow',
|
||||
metric_tags=self._metric_tags + ['target.type:{}'.format(source.type)],
|
||||
)
|
||||
|
||||
def vote(self, voteable, value):
|
||||
if voteable.type == 'thread':
|
||||
url = _url_for_vote_thread(voteable.id)
|
||||
elif voteable.type == 'comment':
|
||||
url = _url_for_vote_comment(voteable.id)
|
||||
else:
|
||||
raise utils.CommentClientRequestError("Can only vote / unvote for threads or comments")
|
||||
params = {'user_id': self.id, 'value': value}
|
||||
response = utils.perform_request(
|
||||
'put',
|
||||
url,
|
||||
params,
|
||||
metric_action='user.vote',
|
||||
metric_tags=self._metric_tags + ['target.type:{}'.format(voteable.type)],
|
||||
)
|
||||
voteable._update_from_response(response)
|
||||
|
||||
def unvote(self, voteable):
|
||||
if voteable.type == 'thread':
|
||||
url = _url_for_vote_thread(voteable.id)
|
||||
elif voteable.type == 'comment':
|
||||
url = _url_for_vote_comment(voteable.id)
|
||||
else:
|
||||
raise utils.CommentClientRequestError("Can only vote / unvote for threads or comments")
|
||||
params = {'user_id': self.id}
|
||||
response = utils.perform_request(
|
||||
'delete',
|
||||
url,
|
||||
params,
|
||||
metric_action='user.unvote',
|
||||
metric_tags=self._metric_tags + ['target.type:{}'.format(voteable.type)],
|
||||
)
|
||||
voteable._update_from_response(response)
|
||||
|
||||
def active_threads(self, query_params={}):
|
||||
if not self.course_id:
|
||||
raise utils.CommentClientRequestError("Must provide course_id when retrieving active threads for the user")
|
||||
url = _url_for_user_active_threads(self.id)
|
||||
params = {'course_id': text_type(self.course_id)}
|
||||
params.update(query_params)
|
||||
response = utils.perform_request(
|
||||
'get',
|
||||
url,
|
||||
params,
|
||||
metric_action='user.active_threads',
|
||||
metric_tags=self._metric_tags,
|
||||
paged_results=True,
|
||||
)
|
||||
return response.get('collection', []), response.get('page', 1), response.get('num_pages', 1)
|
||||
|
||||
def subscribed_threads(self, query_params={}):
|
||||
if not self.course_id:
|
||||
raise utils.CommentClientRequestError("Must provide course_id when retrieving subscribed threads for the user")
|
||||
url = _url_for_user_subscribed_threads(self.id)
|
||||
params = {'course_id': text_type(self.course_id)}
|
||||
params.update(query_params)
|
||||
response = utils.perform_request(
|
||||
'get',
|
||||
url,
|
||||
params,
|
||||
metric_action='user.subscribed_threads',
|
||||
metric_tags=self._metric_tags,
|
||||
paged_results=True
|
||||
)
|
||||
return utils.CommentClientPaginatedResult(
|
||||
collection=response.get('collection', []),
|
||||
page=response.get('page', 1),
|
||||
num_pages=response.get('num_pages', 1),
|
||||
thread_count=response.get('thread_count', 0)
|
||||
)
|
||||
|
||||
def _retrieve(self, *args, **kwargs):
|
||||
url = self.url(action='get', params=self.attributes)
|
||||
retrieve_params = self.default_retrieve_params.copy()
|
||||
retrieve_params.update(kwargs)
|
||||
if self.attributes.get('course_id'):
|
||||
retrieve_params['course_id'] = text_type(self.course_id)
|
||||
if self.attributes.get('group_id'):
|
||||
retrieve_params['group_id'] = self.group_id
|
||||
try:
|
||||
response = utils.perform_request(
|
||||
'get',
|
||||
url,
|
||||
retrieve_params,
|
||||
metric_action='model.retrieve',
|
||||
metric_tags=self._metric_tags,
|
||||
)
|
||||
except utils.CommentClientRequestError as e:
|
||||
if e.status_code == 404:
|
||||
# attempt to gracefully recover from a previous failure
|
||||
# to sync this user to the comments service.
|
||||
self.save()
|
||||
response = utils.perform_request(
|
||||
'get',
|
||||
url,
|
||||
retrieve_params,
|
||||
metric_action='model.retrieve',
|
||||
metric_tags=self._metric_tags,
|
||||
)
|
||||
else:
|
||||
raise
|
||||
self._update_from_response(response)
|
||||
|
||||
def retire(self, retired_username):
|
||||
url = _url_for_retire(self.id)
|
||||
params = {'retired_username': retired_username}
|
||||
|
||||
utils.perform_request(
|
||||
'post',
|
||||
url,
|
||||
params,
|
||||
raw=True,
|
||||
metric_action='user.retire',
|
||||
metric_tags=self._metric_tags
|
||||
)
|
||||
|
||||
def replace_username(self, new_username):
|
||||
url = _url_for_username_replacement(self.id)
|
||||
params = {"new_username": new_username}
|
||||
|
||||
utils.perform_request(
|
||||
'post',
|
||||
url,
|
||||
params,
|
||||
raw=True,
|
||||
)
|
||||
|
||||
|
||||
def _url_for_vote_comment(comment_id):
|
||||
return "{prefix}/comments/{comment_id}/votes".format(prefix=settings.PREFIX, comment_id=comment_id)
|
||||
|
||||
|
||||
def _url_for_vote_thread(thread_id):
|
||||
return "{prefix}/threads/{thread_id}/votes".format(prefix=settings.PREFIX, thread_id=thread_id)
|
||||
|
||||
|
||||
def _url_for_subscription(user_id):
|
||||
return "{prefix}/users/{user_id}/subscriptions".format(prefix=settings.PREFIX, user_id=user_id)
|
||||
|
||||
|
||||
def _url_for_user_active_threads(user_id):
|
||||
return "{prefix}/users/{user_id}/active_threads".format(prefix=settings.PREFIX, user_id=user_id)
|
||||
|
||||
|
||||
def _url_for_user_subscribed_threads(user_id):
|
||||
return "{prefix}/users/{user_id}/subscribed_threads".format(prefix=settings.PREFIX, user_id=user_id)
|
||||
|
||||
|
||||
def _url_for_read(user_id):
|
||||
"""
|
||||
Returns cs_comments_service url endpoint to mark thread as read for given user_id
|
||||
"""
|
||||
return "{prefix}/users/{user_id}/read".format(prefix=settings.PREFIX, user_id=user_id)
|
||||
|
||||
|
||||
def _url_for_retire(user_id):
|
||||
"""
|
||||
Returns cs_comments_service url endpoint to retire a user (remove all post content, etc.)
|
||||
"""
|
||||
return "{prefix}/users/{user_id}/retire".format(prefix=settings.PREFIX, user_id=user_id)
|
||||
|
||||
|
||||
def _url_for_username_replacement(user_id):
|
||||
"""
|
||||
Returns cs_comments_servuce url endpoint to replace the username of a user
|
||||
"""
|
||||
return "{prefix}/users/{user_id}/replace_username".format(prefix=settings.PREFIX, user_id=user_id)
|
||||
155
common/djangoapps/django_comment_common/comment_client/utils.py
Normal file
155
common/djangoapps/django_comment_common/comment_client/utils.py
Normal file
@@ -0,0 +1,155 @@
|
||||
"""" Common utilities for comment client wrapper """
|
||||
import logging
|
||||
from contextlib import contextmanager
|
||||
from time import time
|
||||
from uuid import uuid4
|
||||
|
||||
import requests
|
||||
from django.utils.translation import get_language
|
||||
|
||||
from .settings import SERVICE_HOST as COMMENTS_SERVICE
|
||||
|
||||
log = logging.getLogger(__name__)
|
||||
|
||||
|
||||
def strip_none(dic):
|
||||
return dict([(k, v) for k, v in dic.iteritems() if v is not None])
|
||||
|
||||
|
||||
def strip_blank(dic):
|
||||
def _is_blank(v):
|
||||
return isinstance(v, str) and len(v.strip()) == 0
|
||||
return dict([(k, v) for k, v in dic.iteritems() if not _is_blank(v)])
|
||||
|
||||
|
||||
def extract(dic, keys):
|
||||
if isinstance(keys, str):
|
||||
return strip_none({keys: dic.get(keys)})
|
||||
else:
|
||||
return strip_none({k: dic.get(k) for k in keys})
|
||||
|
||||
|
||||
def perform_request(method, url, data_or_params=None, raw=False,
|
||||
metric_action=None, metric_tags=None, paged_results=False):
|
||||
# To avoid dependency conflict
|
||||
from django_comment_common.models import ForumsConfig
|
||||
config = ForumsConfig.current()
|
||||
|
||||
if not config.enabled:
|
||||
raise CommentClientMaintenanceError('service disabled')
|
||||
|
||||
if metric_tags is None:
|
||||
metric_tags = []
|
||||
|
||||
metric_tags.append(u'method:{}'.format(method))
|
||||
if metric_action:
|
||||
metric_tags.append(u'action:{}'.format(metric_action))
|
||||
|
||||
if data_or_params is None:
|
||||
data_or_params = {}
|
||||
headers = {
|
||||
'X-Edx-Api-Key': config.api_key,
|
||||
'Accept-Language': get_language(),
|
||||
}
|
||||
request_id = uuid4()
|
||||
request_id_dict = {'request_id': request_id}
|
||||
|
||||
if method in ['post', 'put', 'patch']:
|
||||
data = data_or_params
|
||||
params = request_id_dict
|
||||
else:
|
||||
data = None
|
||||
params = data_or_params.copy()
|
||||
params.update(request_id_dict)
|
||||
response = requests.request(
|
||||
method,
|
||||
url,
|
||||
data=data,
|
||||
params=params,
|
||||
headers=headers,
|
||||
timeout=config.connection_timeout
|
||||
)
|
||||
|
||||
metric_tags.append(u'status_code:{}'.format(response.status_code))
|
||||
if response.status_code > 200:
|
||||
metric_tags.append(u'result:failure')
|
||||
else:
|
||||
metric_tags.append(u'result:success')
|
||||
|
||||
if 200 < response.status_code < 500:
|
||||
raise CommentClientRequestError(response.text, response.status_code)
|
||||
# Heroku returns a 503 when an application is in maintenance mode
|
||||
elif response.status_code == 503:
|
||||
raise CommentClientMaintenanceError(response.text)
|
||||
elif response.status_code == 500:
|
||||
raise CommentClient500Error(response.text)
|
||||
else:
|
||||
if raw:
|
||||
return response.text
|
||||
else:
|
||||
try:
|
||||
data = response.json()
|
||||
except ValueError:
|
||||
raise CommentClientError(
|
||||
u"Invalid JSON response for request {request_id}; first 100 characters: '{content}'".format(
|
||||
request_id=request_id,
|
||||
content=response.text[:100]
|
||||
)
|
||||
)
|
||||
return data
|
||||
|
||||
|
||||
class CommentClientError(Exception):
|
||||
pass
|
||||
|
||||
|
||||
class CommentClientRequestError(CommentClientError):
|
||||
def __init__(self, msg, status_codes=400):
|
||||
super(CommentClientRequestError, self).__init__(msg)
|
||||
self.status_code = status_codes
|
||||
|
||||
|
||||
class CommentClient500Error(CommentClientError):
|
||||
pass
|
||||
|
||||
|
||||
class CommentClientMaintenanceError(CommentClientError):
|
||||
pass
|
||||
|
||||
|
||||
class CommentClientPaginatedResult(object):
|
||||
""" class for paginated results returned from comment services"""
|
||||
|
||||
def __init__(self, collection, page, num_pages, thread_count=0, corrected_text=None):
|
||||
self.collection = collection
|
||||
self.page = page
|
||||
self.num_pages = num_pages
|
||||
self.thread_count = thread_count
|
||||
self.corrected_text = corrected_text
|
||||
|
||||
|
||||
def check_forum_heartbeat():
|
||||
"""
|
||||
Check the forum connection via its built-in heartbeat service and create an answer which can be used in the LMS
|
||||
heartbeat django application.
|
||||
This function can be connected to the LMS heartbeat checker through the HEARTBEAT_CHECKS variable.
|
||||
"""
|
||||
# To avoid dependency conflict
|
||||
from django_comment_common.models import ForumsConfig
|
||||
config = ForumsConfig.current()
|
||||
|
||||
if not config.enabled:
|
||||
# If this check is enabled but forums disabled, don't connect, just report no error
|
||||
return 'forum', True, 'OK'
|
||||
|
||||
try:
|
||||
res = requests.get(
|
||||
'%s/heartbeat' % COMMENTS_SERVICE,
|
||||
timeout=config.connection_timeout
|
||||
).json()
|
||||
if res['OK']:
|
||||
return 'forum', True, 'OK'
|
||||
else:
|
||||
return 'forum', False, res.get('check', 'Forum heartbeat failed')
|
||||
except Exception as fail:
|
||||
return 'forum', False, unicode(fail)
|
||||
@@ -50,8 +50,8 @@ from six import text_type
|
||||
from slumber.exceptions import HttpClientError, HttpServerError
|
||||
from user_util import user_util
|
||||
|
||||
import django_comment_common.comment_client as cc
|
||||
from edx_django_utils.cache import RequestCache
|
||||
import lms.lib.comment_client as cc
|
||||
from student.signals import UNENROLL_DONE, ENROLL_STATUS_CHANGE, ENROLLMENT_TRACK_UPDATED
|
||||
from lms.djangoapps.certificates.models import GeneratedCertificate
|
||||
from course_modes.models import CourseMode, get_cosmetic_verified_display_price
|
||||
|
||||
Reference in New Issue
Block a user