osu-web / app / Http / Controllers / Chat / ChatController.php

<?php

// Copyright (c) ppy Pty Ltd <[e-mail]>. Licensed under the GNU Affero General Public License v3.0.
// See the LICENCE file in the repository root for full licence text.

namespace App\Http\Controllers\Chat;

use App\Libraries\Chat;
use App\Libraries\UserChannelList;
use App\Models\Chat\Message;
use App\Models\User;
use App\Models\UserAccountHistory;
use App\Transformers\Chat\ChannelTransformer;
use App\Transformers\Chat\MessageTransformer;
use App\Transformers\Chat\UserSilenceTransformer;
use Ds\Set;

/**
 * @group Chat
 */
class ChatController extends Controller
{
    public function __construct()
    {
        $this->middleware('require-scopes:chat.read', ['only' => ['ack']]);
        $this->middleware('require-scopes:chat.write', ['only' => ['newConversation']]);

        // TODO: remove as it's already defined in parent controller?
        $this->middleware('auth');

        parent::__construct();
    }

    /**
     * Chat Keepalive
     *
     * Request periodically to reset chat activity timeout. Also returns an updated list of recent silences.
     *
     * See [Public channels and activity timeout](#public-channels-and-activity-timeout)
     *
     * ---
     *
     * ### Response Format
     *
     * Field            | Type
     * ---------------- | -----------------
     * silences         | [UserSilence](#usersilence)[]
     *
     * @queryParam history_since integer [UserSilence](#usersilence)s after the specified id to return.
     * This field is preferred and takes precedence over `since`.
     * @queryParam since integer [UserSilence](#usersilence)s after the specified [ChatMessage.message_id](#chatmessage) to return. No-example
     */
    public function ack()
    {
        Chat::ack(auth()->user());

        $params = get_params(request()->all(), null, [
            'history_since:int',
            'since:int',
        ], ['null_missing' => true]);

        return [
            'silences' => json_collection($this->getSilences($params['history_since'], $params['since'] ?? 0), new UserSilenceTransformer()),
        ];
    }

    /**
     * Create New PM
     *
     * This endpoint allows you to create a new PM channel.
     *
     * ---
     *
     * ### Response Format
     *
     * Field            | Type
     * ---------------- | -----------------
     * channel          | The new [ChatChannel](#chatchannel)
     * message          | the sent [ChatMessage](#chatmessage)
     * new_channel_id   | Deprecated; `channel_id` of newly created [ChatChannel](#chatchannel)
     *
     * <aside class="notice">
     *   This endpoint will only allow the creation of PMs initially, group chat support will come later.
     * </aside>
     *
     * @bodyParam target_id integer required `user_id` of user to start PM with
     * @bodyParam message string required message to send
     * @bodyParam is_action boolean required whether the message is an action
     * @bodyParam uuid string client-side message identifier which will be sent back in response and websocket json. Example: some-uuid-string
     *
     * @response {
     *   "channel": {
     *     "channel_id": 1234,
     *     "description": "",
     *     "icon": "https://a.ppy.sh/102?1500537068"
     *     "message_length_limit": 450,
     *     "moderated": false,
     *     "name": "peppy",
     *     "type": "PM",
     *     "uuid": null,
     *     "last_message_id": 9150005005,
     *     "users": [
     *       101,
     *       102
     *     ]
     *   },
     *   "message": {
     *     "channel_id": 1234,
     *     "content": "i can haz featured artist plz?",
     *     "is_action": false,
     *     "message_id": 9150005005,
     *     "sender_id": 102,
     *     "timestamp": "2024-12-23T01:23:45+00:00",
     *     "type": "plain",
     *     "uuid": "some-uuid-string",
     *     "sender": {
     *       "avatar_url": "https://a.ppy.sh/102?1500537068",
     *       "country_code": "AU",
     *       "default_group": "default",
     *       "id": 102,
     *       "is_active": true,
     *       "is_bot": false,
     *       "is_deleted": false,
     *       "is_online": true,
     *       "is_supporter": true
     *       "last_visit": "2024-12-23T01:23:45+00:00",
     *       "pm_friends_only": false,
     *       "profile_colour": "#333333",
     *       "username": "nekodex",
     *     }
     *   },
     *   "new_channel_id": 1234,
     * }
     */
    public function newConversation()
    {
        $params = get_params(request()->all(), null, [
            'is_action:bool',
            'message',
            'target_id:int',
            'uuid',
        ], ['null_missing' => true]);

        $target = User::lookup($params['target_id'], 'id');
        if ($target === null) {
            abort(422, 'target user not found');
        }

        $sender = auth()->user();

        /** @var Message $message */
        $message = Chat::sendPrivateMessage(
            $sender,
            $target,
            $params['message'],
            $params['is_action'],
            $params['uuid']
        );

        $channelJson = json_item($message->channel, ChannelTransformer::forUser($sender), ChannelTransformer::CONVERSATION_INCLUDES);

        return [
            'channel' => $channelJson,
            'message' => json_item(
                $message,
                new MessageTransformer(),
                ['sender']
            ),
            'new_channel_id' => $message->channel_id, // TODO: remove, there's channel already.
        ];
    }

    // TODO: move the listing to channels.index
    /**
     * @deprecated
     * @group Undocumented
     */
    public function presence()
    {
        return (new UserChannelList(auth()->user()))->get();
    }

    /**
     * Get Updates
     *
     * Returns the list of channels the current User is in along with an updated list of [UserSilence](#usersilence)s.
     *
     * ---
     *
     * ### Response Format
     *
     * Field            | Type
     * ---------------- | -----------------
     * messages         | This field is not used and will be removed.
     * presence         | [ChatChannel](#chatchannel)[]?
     * silences         | [UserSilence](#usersilence)[]?
     *
     * @queryParam history_since integer [UserSilence](#usersilence)s after the specified id to return.
     * This field is preferred and takes precedence over `since`.
     * @queryParam includes string[] List of fields from `presence`, `silences` to include in the response. Returns all if not specified. No-example
     * @queryParam since integer [UserSilence](#usersilence)s after the specified [ChatMessage.message_id](#chatmessage) to return. No-example
     *
     * @response {
     *   "presence": [
     *     {
     *       "channel_id": 5,
     *       "current_user_attributes": {
     *         "can_message": true,
     *         "can_message_error": null,
     *         "last_read_id": 9150005005
     *       },
     *       "name": "#osu",
     *       "description": "The official osu! channel (english only).",
     *       "type": "public",
     *       "last_read_id": 9150005005,
     *       "last_message_id": 9150005005
     *     },
     *     {
     *       "channel_id": 12345,
     *       "current_user_attributes": {
     *         "can_message": true,
     *         "can_message_error": null,
     *         "last_read_id": 9150001235
     *       },
     *       "type": "PM",
     *       "name": "peppy",
     *       "icon": "https://a.ppy.sh/2?1519081077.png",
     *       "users": [
     *         2,
     *         102
     *       ],
     *       "last_read_id": 9150001235,
     *       "last_message_id": 9150001234
     *     }
     *   ],
     *   "silences": [
     *      {
     *        "id": 1,
     *        "user_id": 2
     *      }
     *   ]
     * }
     */
    public function updates()
    {
        static $availableIncludes;
        $availableIncludes ??= new Set(['messages', 'presence', 'silences']);

        $params = get_params(request()->all(), null, [
            'history_since:int',
            'includes:array',
            'since:int',
        ], ['null_missing' => true]);

        if ($params['since'] === null) {
            abort(422);
        }

        $includes = $params['includes'] !== null
            ? $availableIncludes->intersect(new Set($params['includes']))
            : $availableIncludes;

        $response = [];

        if ($includes->contains('presence')) {
            $userChannelList = new UserChannelList(auth()->user());
            $response['presence'] = $userChannelList->get();
        }

        if ($includes->contains('silences')) {
            $silences = $this->getSilences($params['history_since'], $params['since']);
            $response['silences'] = json_collection($silences, new UserSilenceTransformer());
        }

        // FIXME: empty array for compatibility with old lazer versions
        if ($includes->contains('messages')) {
            $response['messages'] = [];
        }

        return $response;
    }

    private function getSilences(?int $lastHistoryId, ?int $since)
    {
        $silenceQuery = UserAccountHistory::bans()->recentForChat()->limit(100);

        if ($lastHistoryId === null) {
            $previousMessage = Message::where('message_id', '<=', $since)->last();

            if ($previousMessage === null) {
                $silenceQuery->none();
            } else {
                $silenceQuery->where('timestamp', '>', $previousMessage->timestamp);
            }
        } else {
            $silenceQuery->where('ban_id', '>', $lastHistoryId)->reorderBy('ban_id', 'DESC');
        }

        return $silenceQuery->get();
    }
}