openedx-forum 0.1.6__py2.py3-none-any.whl

forum/__init__.py

@@ -0,0 +1,5 @@
+"""
+Openedx forum app.
+"""
+
+__version__ = "0.1.6"

forum/admin.py

@@ -0,0 +1,154 @@
+"""Admin module for forum."""
+
+from django.contrib import admin
+from forum.models import (
+    ForumUser,
+    CourseStat,
+    CommentThread,
+    Comment,
+    EditHistory,
+    AbuseFlagger,
+    HistoricalAbuseFlagger,
+    ReadState,
+    LastReadTime,
+    UserVote,
+    Subscription,
+    MongoContent,
+)
+
+
+@admin.register(ForumUser)
+class ForumUserAdmin(admin.ModelAdmin):  # type: ignore
+    """Admin interface for ForumUser model."""
+
+    list_display = ("user", "default_sort_key")
+    search_fields = ("user__username", "user__email")
+
+
+@admin.register(CourseStat)
+class CourseStatAdmin(admin.ModelAdmin):  # type: ignore
+    """Admin interface for CourseStat model."""
+
+    list_display = (
+        "user",
+        "course_id",
+        "active_flags",
+        "inactive_flags",
+        "threads",
+        "responses",
+        "replies",
+        "last_activity_at",
+    )
+    search_fields = ("user__username", "course_id")
+    list_filter = ("course_id",)
+
+
+@admin.register(CommentThread)
+class CommentThreadAdmin(admin.ModelAdmin):  # type: ignore
+    """Admin interface for CommentThread model."""
+
+    list_display = (
+        "title",
+        "author",
+        "course_id",
+        "thread_type",
+        "context",
+        "closed",
+        "pinned",
+        "created_at",
+        "updated_at",
+    )
+    search_fields = ("title", "body", "author__username", "course_id")
+    list_filter = ("thread_type", "context", "closed", "pinned")
+
+
+@admin.register(Comment)
+class CommentAdmin(admin.ModelAdmin):  # type: ignore
+    """Admin interface for Comment model."""
+
+    list_display = (
+        "comment_thread",
+        "author",
+        "body",
+        "created_at",
+        "updated_at",
+        "endorsed",
+        "anonymous",
+    )
+    search_fields = ("body", "author__username", "comment_thread__title")
+    list_filter = ("endorsed", "anonymous")
+
+
+@admin.register(EditHistory)
+class EditHistoryAdmin(admin.ModelAdmin):  # type: ignore
+    """Admin interface for EditHistory model."""
+
+    list_display = ("editor", "content_object_id", "created_at", "reason_code")
+    search_fields = ("editor__username", "original_body")
+    list_filter = ("reason_code",)
+
+
+@admin.register(AbuseFlagger)
+class AbuseFlaggerAdmin(admin.ModelAdmin):  # type: ignore
+    """Admin interface for AbuseFlagger model."""
+
+    list_display = ("user", "content_object_id", "flagged_at")
+    search_fields = ("user__username",)
+    list_filter = ("content_type",)
+
+
+@admin.register(HistoricalAbuseFlagger)
+class HistoricalAbuseFlaggerAdmin(admin.ModelAdmin):  # type: ignore
+    """Admin interface for HistoricalAbuseFlagger model."""
+
+    list_display = ("user", "content_object_id", "flagged_at")
+    search_fields = ("user__username",)
+    list_filter = ("content_type",)
+
+
+@admin.register(ReadState)
+class ReadStateAdmin(admin.ModelAdmin):  # type: ignore
+    """Admin interface for ReadState model."""
+
+    list_display = ("user", "course_id")
+    search_fields = ("user__username", "course_id")
+
+
+@admin.register(LastReadTime)
+class LastReadTimeAdmin(admin.ModelAdmin):  # type: ignore
+    """Admin interface for LastReadTime model."""
+
+    list_display = ("read_state", "comment_thread", "timestamp")
+    search_fields = ("read_state__user__username", "comment_thread__title")
+
+
+@admin.register(UserVote)
+class UserVoteAdmin(admin.ModelAdmin):  # type: ignore
+    """Admin interface for UserVote model."""
+
+    list_display = ("user", "content_object_id", "vote")
+    search_fields = ("user__username",)
+    list_filter = ("vote",)
+
+
+@admin.register(Subscription)
+class SubscriptionAdmin(admin.ModelAdmin):  # type: ignore
+    """Admin interface for Subscription model."""
+
+    list_display = (
+        "subscriber",
+        "source_object_id",
+        "source_content_type",
+        "created_at",
+        "updated_at",
+    )
+    search_fields = ("subscriber__username",)
+    list_filter = ("source_content_type",)
+
+
+@admin.register(MongoContent)
+class MongoContentAdmin(admin.ModelAdmin):  # type: ignore
+    """Admin interface for MongoContent model."""
+
+    list_display = ("mongo_id", "content_object_id", "content_type")
+    search_fields = ("mongo_id",)

forum/api/__init__.py

@@ -0,0 +1,88 @@
+"""
+Native Python APIs.
+"""
+
+from .commentables import get_commentables_stats
+from .comments import (
+    create_child_comment,
+    create_parent_comment,
+    delete_comment,
+    get_course_id_by_comment,
+    get_parent_comment,
+    update_comment,
+)
+from .flags import (
+    update_comment_flag,
+    update_thread_flag,
+)
+from .pins import pin_thread, unpin_thread
+from .search import search_threads
+from .subscriptions import (
+    create_subscription,
+    delete_subscription,
+    get_thread_subscriptions,
+    get_user_subscriptions,
+)
+from .threads import (
+    create_thread,
+    delete_thread,
+    get_course_id_by_thread,
+    get_thread,
+    get_user_threads,
+    update_thread,
+)
+from .users import (
+    create_user,
+    get_user,
+    get_user_active_threads,
+    get_user_course_stats,
+    mark_thread_as_read,
+    retire_user,
+    update_user,
+    update_username,
+    update_users_in_course,
+)
+from .votes import (
+    delete_comment_vote,
+    delete_thread_vote,
+    update_comment_votes,
+    update_thread_votes,
+)
+
+__all__ = [
+    "create_child_comment",
+    "create_parent_comment",
+    "create_subscription",
+    "create_thread",
+    "create_user",
+    "delete_comment",
+    "delete_comment_vote",
+    "delete_subscription",
+    "delete_thread",
+    "delete_thread_vote",
+    "get_commentables_stats",
+    "get_course_id_by_comment",
+    "get_course_id_by_thread",
+    "get_parent_comment",
+    "get_thread",
+    "get_thread_subscriptions",
+    "get_user",
+    "get_user_active_threads",
+    "get_user_course_stats",
+    "get_user_subscriptions",
+    "get_user_threads",
+    "mark_thread_as_read",
+    "pin_thread",
+    "retire_user",
+    "search_threads",
+    "unpin_thread",
+    "update_comment",
+    "update_comment_flag",
+    "update_comment_votes",
+    "update_thread",
+    "update_thread_flag",
+    "update_thread_votes",
+    "update_user",
+    "update_username",
+    "update_users_in_course",
+]

forum/api/commentables.py

@@ -0,0 +1,22 @@
+"""
+Native Python Commenttables APIs.
+"""
+
+from forum.backend import get_backend
+
+
+def get_commentables_stats(course_id: str) -> dict[str, int]:
+    """
+    Get the threads count based on thread_type and group them by commentable_id.
+
+    Parameters:
+        course_id: The ID of the course.
+    Body:
+        Empty.
+    Response:
+        The threads count for the given course_id based on thread_type.
+        e.g.
+        reponse = {'course': {'discussion': 1, 'question': 1}}
+    """
+    backend = get_backend(course_id)()
+    return backend.get_commentables_counts_based_on_type(course_id)

forum/api/comments.py

@@ -0,0 +1,321 @@
+"""
+Native Python Comments APIs.
+"""
+
+import logging
+from typing import Any, Optional
+
+from django.core.exceptions import ObjectDoesNotExist
+from rest_framework.serializers import ValidationError
+
+from forum.backend import get_backend
+from forum.serializers.comment import CommentSerializer
+from forum.utils import ForumV2RequestError
+
+log = logging.getLogger(__name__)
+
+
+def prepare_comment_api_response(
+    comment: dict[str, Any],
+    backend: Any,
+    exclude_fields: Optional[list[str]] = None,
+) -> dict[str, Any]:
+    """
+    Return serialized validated data.
+
+    Parameters:
+        comment: The comment details that needs to be serialized.
+        exclude_fields: Any fields that need to be excluded from response.
+
+    Response:
+        serialized validated data of the comment.
+    """
+    comment_data = {
+        **comment,
+        "id": str(comment.get("_id")),
+        "user_id": comment.get("author_id"),
+        "thread_id": str(comment.get("comment_thread_id")),
+        "username": comment.get("author_username"),
+        "parent_id": str(comment.get("parent_id")),
+        "type": str(comment.get("_type", "")).lower(),
+    }
+    if not exclude_fields:
+        exclude_fields = []
+    exclude_fields.append("children")
+    serializer = CommentSerializer(
+        data=comment_data,
+        exclude_fields=exclude_fields,
+        backend=backend,
+    )
+    if not serializer.is_valid(raise_exception=True):
+        raise ValidationError(serializer.errors)
+
+    return serializer.data
+
+
+def get_parent_comment(
+    comment_id: str, course_id: Optional[str] = None
+) -> dict[str, Any]:
+    """
+    Get a parent comment.
+
+    Parameters:
+        comment_id: The ID of the comment.
+    Body:
+        Empty.
+    Response:
+        The details of the comment for the given comment_id.
+    """
+    backend = get_backend(course_id)()
+    try:
+        comment = backend.validate_object("Comment", comment_id)
+    except ObjectDoesNotExist as exc:
+        log.error("Forumv2RequestError for get parent comment request.")
+        raise ForumV2RequestError(
+            f"Comment does not exists with Id: {comment_id}"
+        ) from exc
+    return prepare_comment_api_response(
+        comment,
+        backend,
+        exclude_fields=["sk"],
+    )
+
+
+def create_child_comment(
+    parent_comment_id: str,
+    body: str,
+    user_id: str,
+    course_id: str,
+    anonymous: bool,
+    anonymous_to_peers: bool,
+) -> dict[str, Any]:
+    """
+    Create a new child comment.
+
+    Parameters:
+        comment_id: The ID of the parent comment for creating it's child comment.
+        body: The content of the comment.
+        course_id: The Id of the respective course.
+        user_id: The requesting user id.
+        anonymous: anonymous flag(True or False).
+        anonymous_to_peers: anonymous to peers flag(True or False).
+    Response:
+        The details of the comment that is created.
+    """
+    backend = get_backend(course_id)()
+    try:
+        parent_comment = backend.validate_object("Comment", parent_comment_id)
+    except ObjectDoesNotExist as exc:
+        log.error("Forumv2RequestError for create child comment request.")
+        raise ForumV2RequestError(
+            f"Comment does not exists with Id: {parent_comment_id}"
+        ) from exc
+
+    comment_id = backend.create_comment(
+        {
+            "body": body,
+            "author_id": user_id,
+            "course_id": course_id,
+            "anonymous": anonymous,
+            "anonymous_to_peers": anonymous_to_peers,
+            "depth": 1,
+            "comment_thread_id": backend.get_thread_id_by_comment_id(parent_comment_id),
+            "parent_id": parent_comment_id,
+        }
+    )
+    comment = backend.get_comment(comment_id)
+    if not comment:
+        log.error("Forumv2RequestError for create child comment request.")
+        raise ForumV2RequestError("comment is not created")
+
+    user = backend.get_user(user_id)
+    thread = backend.get_thread(parent_comment["comment_thread_id"])
+    if user and thread and comment:
+        backend.mark_as_read(user_id, parent_comment["comment_thread_id"])
+    try:
+        comment_data = prepare_comment_api_response(
+            comment,
+            backend,
+            exclude_fields=["endorsement", "sk"],
+        )
+        return comment_data
+    except ValidationError as error:
+        raise error
+
+
+def update_comment(
+    comment_id: str,
+    body: Optional[str] = None,
+    course_id: Optional[str] = None,
+    user_id: Optional[str] = None,
+    anonymous: Optional[bool] = None,
+    anonymous_to_peers: Optional[bool] = None,
+    endorsed: Optional[bool] = None,
+    closed: Optional[bool] = None,
+    editing_user_id: Optional[str] = None,
+    edit_reason_code: Optional[str] = None,
+    endorsement_user_id: Optional[str] = None,
+    course_key: Optional[str] = None,
+) -> dict[str, Any]:
+    """
+    Update an existing child/parent comment.
+
+    Parameters:
+        comment_id: The ID of the comment to be edited.
+        body (Optional[str]): The content of the comment.
+        course_id (Optional[str]): The Id of the respective course.
+        user_id (Optional[str]): The requesting user id.
+        anonymous (Optional[bool]): anonymous flag(True or False).
+        anonymous_to_peers (Optional[bool]): anonymous to peers flag(True or False).
+        endorsed (Optional[bool]): Flag indicating if the comment is endorsed by any user.
+        closed (Optional[bool]): Flag indicating if the comment thread is closed.
+        editing_user_id (Optional[str]): The ID of the user editing the comment.
+        edit_reason_code (Optional[str]): The reason for editing the comment, typically represented by a code.
+        endorsement_user_id (Optional[str]): The ID of the user endorsing the comment.
+    Response:
+        The details of the comment that is updated.
+    """
+    backend = get_backend(course_key)()
+    try:
+        backend.validate_object("Comment", comment_id)
+    except ObjectDoesNotExist as exc:
+        log.error("Forumv2RequestError for update comment request.")
+        raise ForumV2RequestError(
+            f"Comment does not exists with Id: {comment_id}"
+        ) from exc
+
+    updated_comment = backend.update_comment_and_get_updated_comment(
+        comment_id,
+        body,
+        course_id,
+        user_id,
+        anonymous,
+        anonymous_to_peers,
+        endorsed,
+        closed,
+        editing_user_id,
+        edit_reason_code,
+        endorsement_user_id,
+    )
+    if not updated_comment:
+        log.error("Forumv2RequestError for create child comment request.")
+        raise ForumV2RequestError("comment is not updated")
+    try:
+        return prepare_comment_api_response(
+            updated_comment,
+            backend,
+            exclude_fields=(
+                ["endorsement", "sk"] if updated_comment.get("parent_id") else ["sk"]
+            ),
+        )
+    except ValidationError as error:
+        raise error
+
+
+def delete_comment(comment_id: str, course_id: Optional[str] = None) -> dict[str, Any]:
+    """
+    Delete a comment.
+
+    Parameters:
+        comment_id: The ID of the comment to be deleted.
+    Body:
+        Empty.
+    Response:
+        The details of the comment that is deleted.
+    """
+    backend = get_backend(course_id)()
+    try:
+        comment = backend.validate_object("Comment", comment_id)
+    except ObjectDoesNotExist as exc:
+        log.error("Forumv2RequestError for delete comment request.")
+        raise ForumV2RequestError(
+            f"Comment does not exists with Id: {comment_id}"
+        ) from exc
+    data = prepare_comment_api_response(
+        comment,
+        backend,
+        exclude_fields=["endorsement", "sk"],
+    )
+    backend.delete_comment(comment_id)
+    author_id = comment["author_id"]
+    comment_course_id = comment["course_id"]
+    parent_comment_id = data["parent_id"]
+    if parent_comment_id:
+        backend.update_stats_for_course(author_id, comment_course_id, replies=-1)
+    else:
+        backend.update_stats_for_course(author_id, comment_course_id, responses=-1)
+    return data
+
+
+def create_parent_comment(
+    thread_id: str,
+    body: str,
+    user_id: str,
+    course_id: str,
+    anonymous: bool,
+    anonymous_to_peers: bool,
+) -> dict[str, Any]:
+    """
+    Create a new parent comment.
+
+    Parameters:
+        thread_id: The ID of the thread for creating a comment on it.
+        body: The content of the comment.
+        course_id: The Id of the respective course.
+        user_id: The requesting user id.
+        anonymous: anonymous flag(True or False).
+        anonymous_to_peers: anonymous to peers flag(True or False).
+    Response:
+        The details of the comment that is created.
+    """
+    backend = get_backend(course_id)()
+    try:
+        backend.validate_object("CommentThread", thread_id)
+    except ObjectDoesNotExist as exc:
+        log.error("Forumv2RequestError for create parent comment request.")
+        raise ForumV2RequestError(
+            f"Thread does not exists with Id: {thread_id}"
+        ) from exc
+
+    comment_id = backend.create_comment(
+        {
+            "body": body,
+            "author_id": user_id,
+            "course_id": course_id,
+            "anonymous": anonymous,
+            "anonymous_to_peers": anonymous_to_peers,
+            "depth": 0,
+            "comment_thread_id": thread_id,
+        }
+    )
+    if not comment_id:
+        log.error("Forumv2RequestError for create parent comment request.")
+        raise ForumV2RequestError("comment is not created")
+    comment = backend.get_comment(comment_id) or {}
+    user = backend.get_user(user_id)
+    if user and comment:
+        backend.mark_as_read(user_id, thread_id)
+    try:
+        return prepare_comment_api_response(
+            comment,
+            backend,
+            exclude_fields=["endorsement", "sk"],
+        )
+    except ValidationError as error:
+        raise error
+
+
+def get_course_id_by_comment(comment_id: str) -> str | None:
+    """
+    Return course_id for the matching comment.
+    It searches for comment_id both in mongodb and mysql.
+    """
+    #  pylint: disable=C0415
+    from forum.backends.mongodb.api import MongoBackend
+    from forum.backends.mysql.api import MySQLBackend
+
+    return (
+        MongoBackend.get_course_id_by_comment_id(comment_id)
+        or MySQLBackend.get_course_id_by_comment_id(comment_id)
+        or None
+    )