core/controllers/subscriptions.py - develop - githubmirror/oppia

core/controllers/subscriptions.py
104 строки3 KB
Gabriel Fuentes
Black formatter staging (#23456)
05 окт 2025, 06:15
05 окт 2025, 06:1562ec95a
# Copyright 2014 The Oppia Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS-IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Controllers related to user subscriptions."""

from __future__ import annotations

from core import feconf
from core.controllers import acl_decorators, base
from core.domain import subscription_services, user_services

from typing import Dict, TypedDict


class SubscribeHandlerNormalizedPayloadDict(TypedDict):
    """Dict representation of SubscribeHandler's
    normalized_payload dictionary.
    """

    creator_username: str


class SubscribeHandler(
    base.BaseHandler[SubscribeHandlerNormalizedPayloadDict, Dict[str, str]]
):
    """Handles operations relating to new subscriptions."""

    POST_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON
    URL_PATH_ARGS_SCHEMAS: Dict[str, str] = {}
    HANDLER_ARGS_SCHEMAS = {
        'POST': {
            'creator_username': {
                'schema': {
                    'type': 'basestring',
                    'validators': [{'id': 'is_valid_username_string'}],
                }
            }
        }
    }

    @acl_decorators.can_subscribe_to_users
    def post(self) -> None:
        """Subscribes the current user to another user."""
        assert self.user_id is not None
        assert self.normalized_payload is not None
        creator_username = self.normalized_payload['creator_username']
        creator_id = user_services.get_user_id_from_username(
            creator_username, strict=True
        )
        subscription_services.subscribe_to_creator(self.user_id, creator_id)
        self.render_json(self.values)


class UnsubscribeHandlerNormalizedPayloadDict(TypedDict):
    """Dict representation of UnsubscribeHandler's
    normalized_payload dictionary.
    """

    creator_username: str


class UnsubscribeHandler(
    base.BaseHandler[UnsubscribeHandlerNormalizedPayloadDict, Dict[str, str]]
):
    """Handles operations related to unsubscriptions."""

    POST_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON
    URL_PATH_ARGS_SCHEMAS: Dict[str, str] = {}
    HANDLER_ARGS_SCHEMAS = {
        'POST': {
            'creator_username': {
                'schema': {
                    'type': 'basestring',
                    'validators': [{'id': 'is_valid_username_string'}],
                }
            }
        }
    }

    @acl_decorators.can_subscribe_to_users
    def post(self) -> None:
        """Unsubscribes the current user from another user."""
        assert self.user_id is not None
        assert self.normalized_payload is not None
        creator_username = self.normalized_payload['creator_username']
        creator_id = user_services.get_user_id_from_username(creator_username)
        if creator_id is None:
            raise Exception(
                'No creator user_id found for the given creator username: %s'
                % creator_username
            )
        subscription_services.unsubscribe_from_creator(self.user_id, creator_id)
        self.render_json(self.values)