ts-website/src/private/php/Assigner.php

<?php

namespace Wruczek\TSWebsite;

use Wruczek\TSWebsite\Utils\TeamSpeakUtils;

class Assigner {

    public static function getAssignerConfig() {
        return Config::get("assignerconfig");
    }

    public static function getAssignerArray() {
        $assignerConfig = self::getAssignerConfig();

        if (empty($assignerConfig)) {
            return []; // not configured, do not get more data and just return an empty array
        }

        $userGroups = Auth::getUserServerGroupIds();
        $serverGroups = CacheManager::i()->getServerGroupList();

        foreach ($assignerConfig as $index => $category) {
            $assignedCount = 0;
            $groups = [];

            foreach ($category["groups"] as $sgid) {
                $serverGroup = @$serverGroups[$sgid];

                if ($serverGroup === null) {
                    continue;
                }

                $assigned = in_array($sgid, $userGroups);
                $groups[$sgid] = $serverGroup + ["assigned" => $assigned];

                if ($assigned) {
                    $assignedCount++;
                }
            }

            $assignerConfig[$index]["assignedCount"] = $assignedCount;
            $assignerConfig[$index]["groups"] = $groups;
        }

        return $assignerConfig;
    }

    public static function isAssignable($sgid) {
        foreach (self::getAssignerConfig() as $category) {
            if (in_array($sgid, $category["groups"], true)) {
                return true;
            }
        }

        return false;
    }

    /**
     * Attempts to change user groups with the provided $newGroups
     * @param array $newGroups array of new SGIDs that the user should
     *              have. any assigner groups not present in this array will
     *              be removed from the user
     * @return int status code that shows result of the group change.
     *             0 - groups have been successfully changed
     *             1 - no change between current groups and submitted groups
     *             2 - group assigner is not configured, stopping
     *             3 - reached category group limit
     * @throws UserNotAuthenticatedException
     * @throws \TeamSpeak3_Exception
     */
    public static function changeGroups($newGroups) {
        $assignerConfig = self::getAssignerConfig();

        if (empty($assignerConfig)) {
            return 2; // if the assigner is not configured, stop there
        }

        $userGroups = Auth::getUserServerGroupIds();
        $groupsToAdd = [];
        $groupsToRemove = [];

        foreach ($assignerConfig as $config) {
            $groupsToAssign = 0;

            foreach ($config["groups"] as $group) {
                // true if the $group is currently assigned to the user
                $isAssigned = in_array($group, $userGroups);
                // true if the user wants to be added to $group
                $wantToAssign = in_array($group, $newGroups);

                // if the group is already assigned, or is to be assigned,
                // check for the max group limit in this category:
                // - add 1 to the "groupsToAssign", and
                // - check if its bigger than the max limit
                if ($wantToAssign && (++$groupsToAssign > $config["max"])) {
                    return 3;
                }

                // ADD GROUP if the group is not assigned, but the user wants to be added
                if (!$isAssigned && $wantToAssign) {
                    // ok, seems like we can add this group!
                    $groupsToAdd[] = $group;
                }

                // REMOVE GROUP if the group is currently assigned, but the user does not want to have it
                if ($isAssigned && !$wantToAssign) {
                    $groupsToRemove[] = $group;
                }
            }
        }

        // empty arrays - nothing to change
        if (!$groupsToAdd && !$groupsToRemove) {
            return 1;
        }

        // finally, add or remove the groups
        $tsServer = TeamSpeakUtils::i()->getTSNodeServer();

        foreach ($groupsToAdd as $sgid) {
            try {
                $tsServer->serverGroupClientAdd($sgid, Auth::getCldbid());
            } catch (\TeamSpeak3_Exception $e) {} // TODO log it to the admin panel?
        }

        foreach ($groupsToRemove as $sgid) {
            try {
                $tsServer->serverGroupClientDel($sgid, Auth::getCldbid());
            } catch (\TeamSpeak3_Exception $e) {} // TODO log it to the admin panel?
        }

        return 0;
    }

    public static function getRequiredSgids() {
        return Config::get("assigner_required_sgids");
    }

    public static function canUseAssigner() {
        // if there are no required sgids, the user can use assigner and
        // we can skip the other, more expensive checks that will require
        // fetching user groups from TS3
        if (empty(self::getRequiredSgids())) {
            return true;
        }

        $userGroups = Auth::getUserServerGroupIds();
        return self::canUseAssignerSgArray($userGroups);
    }

    public static function canUseAssignerSgArray(array $serverGroups) {
        // user needs to be in at least one of those groups to be able
        // to use group assigner
        $requiredSgid = self::getRequiredSgids();

        foreach ($requiredSgid as $sgid) {
            if (in_array($sgid, $serverGroups, false)) {
                return true;
            }
        }

        return false;
    }

}