appwrite/src/Appwrite/Realtime/Parser.php

<?php

namespace Appwrite\Realtime;

use Appwrite\Auth\Auth;
use Appwrite\Database\Document;

class Parser
{
    /**
     * @var Document $user
     */
    static $user;

    /**
     * Sets the current user for the role and channel parsing.
     * 
     * @param Document $user
     */
    static function setUser(Document $user)
    {
        self::$user = $user;
    }

    /**
     * Returns array of roles that the set User has permissions to.
     * 
     * @return array
     */
    static function getRoles()
    {
        if (!isset(self::$user)) {
            return [];
        }

        $roles = ['role:' . ((self::$user->isEmpty()) ? Auth::USER_ROLE_GUEST : Auth::USER_ROLE_MEMBER)];
        if (!(self::$user->isEmpty())) {
            $roles[] = 'user:' . self::$user->getId();
        }
        foreach (self::$user->getAttribute('memberships', []) as $node) {
            if (isset($node['teamId']) && isset($node['roles'])) {
                $roles[] = 'team:' . $node['teamId'];

                foreach ($node['roles'] as $nodeRole) { // Set all team roles
                    $roles[] = 'team:' . $node['teamId'] . '/' . $nodeRole;
                }
            }
        }
        return $roles;
    }

    /**
     * Converts the channels from the Query Params into an array. 
     * Also renames the account channel to account.USER_ID and removes all illegal account channel variations.
     * 
     * @param array $channels
     */
    static function parseChannels(array $channels)
    {
        $channels = array_flip($channels);

        foreach ($channels as $key => $value) {
            switch (true) {
                case strpos($key, 'account.') === 0:
                    unset($channels[$key]);
                    break;
                
                case $key === 'account':
                    if (!empty(self::$user->getId())) {
                        $channels['account.' . self::$user->getId()] = $value;
                    }
                    unset($channels['account']);
                    break;
            }
        }

        if (\array_key_exists('account', $channels)) {
            if (self::$user->getId()) {
                $channels['account.' . self::$user->getId()] = $channels['account'];
            }
            unset($channels['account']);
        }

        return $channels;
    }

    /**
     * Identifies the receivers of all subscriptions, based on the permissions and event.
     * 
     * Example of performance with an event with user:XXX permissions and with X users spread across 10 different channels:
     *  - 0.014 ms (±6.88%) | 10 Connections / 100 Subscriptions 
     *  - 0.070 ms (±3.71%) | 100 Connections / 1,000 Subscriptions 
     *  - 0.846 ms (±2.74%) | 1,000 Connections / 10,000 Subscriptions
     *  - 10.866 ms (±1.01%) | 10,000 Connections / 100,000 Subscriptions
     *  - 110.201 ms (±2.32%) | 100,000 Connections / 1,000,000 Subscriptions
     *  - 1,121.328 ms (±0.84%) | 1,000,000 Connections / 10,000,000 Subscriptions 
     * 
     * @param array $event
     * @param array $connections
     * @param array $subscriptions
     */
    static function identifyReceivers(array &$event, array &$subscriptions)
    {
        $receivers = [];
        if (isset($subscriptions[$event['project']])) {
            foreach ($subscriptions[$event['project']] as $role => $subscription) {
                foreach ($event['data']['channels'] as $channel) {
                    if (
                        \array_key_exists($channel, $subscriptions[$event['project']][$role])
                        && (\in_array($role, $event['permissions']) || \in_array('*', $event['permissions']))
                    ) {
                        foreach (array_keys($subscriptions[$event['project']][$role][$channel]) as $ids) {
                            $receivers[$ids] = 0;
                        }
                        break;
                    }
                }
            }
        }

        return array_keys($receivers);
    }

    /**
     * Adds Subscription. 
     * 
     * @param string $projectId
     * @param mixed $connection
     * @param array $subscriptions
     * @param array $roles
     * @param array $channels
     */
    static function subscribe($projectId, $connection, $roles, &$subscriptions, &$connections, &$channels)
    {
        /**
         * Build Subscriptions Tree
         * 
         * [PROJECT_ID] -> 
         *      [ROLE_X] -> 
         *          [CHANNEL_NAME_X] -> [CONNECTION_ID]
         *          [CHANNEL_NAME_Y] -> [CONNECTION_ID]
         *          [CHANNEL_NAME_Z] -> [CONNECTION_ID]
         *      [ROLE_Y] -> 
         *          [CHANNEL_NAME_X] -> [CONNECTION_ID]
         *          [CHANNEL_NAME_Y] -> [CONNECTION_ID]
         *          [CHANNEL_NAME_Z] -> [CONNECTION_ID]
         */

        if (!isset($subscriptions[$projectId])) { // Init Project
            $subscriptions[$projectId] = [];
        }

        foreach ($roles as $role) {
            if (!isset($subscriptions[$projectId][$role])) { // Add user first connection
                $subscriptions[$projectId][$role] = [];
            }

            foreach ($channels as $channel => $list) {
                $subscriptions[$projectId][$role][$channel][$connection] = true;
            }
        }

        $connections[$connection] = [
            'projectId' => $projectId,
            'roles' => $roles,
            'channels' => $channels
        ];
    }

    /**
     * Remove Subscription. 
     * 
     * @param mixed $connection
     * @param array $subscriptions
     * @param array $connections
     */
    static function unsubscribe($connection, &$subscriptions, &$connections)
    {
        $projectId = $connections[$connection]['projectId'] ?? '';
        $roles = $connections[$connection]['roles'] ?? [];

        foreach ($roles as $role) {
            foreach ($subscriptions[$projectId][$role] as $channel => $list) {
                unset($subscriptions[$projectId][$role][$channel][$connection]); // Remove connection

                if (empty($subscriptions[$projectId][$role][$channel])) {
                    unset($subscriptions[$projectId][$role][$channel]);  // Remove channel when no connections
                }
            }

            if (empty($subscriptions[$projectId][$role])) {
                unset($subscriptions[$projectId][$role]); // Remove role when no channels
            }
        }

        if (empty($subscriptions[$projectId])) { // Remove project when no roles
            unset($subscriptions[$projectId]);
        }

        unset($connections[$connection]);
    }
}