class.ilObjOrgUnitTree.php

Go to the documentation of this file.

<?php

class ilObjOrgUnitTree
{
    protected static ?string $temporary_table_name_getOrgUnitOfUser = null;
    protected static ?string $temporary_table_name = null;
    protected static ?ilObjOrgUnitTree $instance = null;
    private array $roles;
    private array $role_to_orgu;
    private $staff;
    private array $tree_childs = [];
    private array $parent = [];
    private ilDBInterface $db;
    private ilObjUser $ilUser;
    private \ilTree $tree;

    private function __construct()
    {
        global $DIC;
        $this->db = $DIC->database();
        $this->tree = $DIC->repositoryTree();
        $this->roles = array();
        $this->staff = array();
        $this->ilUser = $DIC->user();
    }

    public static function _getInstance(): \ilObjOrgUnitTree
    {
        if (static::$instance === null) {
            static::$instance = new self();
        }

        return static::$instance;
    }

    public function getEmployees(int $ref_id, bool $recursive = false): array
    {
        $arr_usr_ids = [];

        switch ($recursive) {
            case false:
                $arr_usr_ids = $this->getAssignements(
                    $ref_id,
                    ilOrgUnitPosition::getCorePosition(ilOrgUnitPosition::CORE_POSITION_EMPLOYEE)
                );
                break;
            case true:
                $assignment_query = ilOrgUnitUserAssignmentQueries::getInstance();
                $arr_usr_ids = $assignment_query->getUserIdsOfOrgUnitsInPosition(
                    $this->getAllChildren($ref_id),
                    ilOrgUnitPosition::CORE_POSITION_EMPLOYEE
                );
                break;
        }

        return $arr_usr_ids;
    }

    public function getAssignements(int $ref_id, ilOrgUnitPosition $ilOrgUnitPosition): array
    {
        return ilOrgUnitUserAssignment::where(array(
            'orgu_id' => $ref_id,
            'position_id' => $ilOrgUnitPosition->getId(),
        ))->getArray('id', 'user_id');
    }

    public function getSuperiors(int $ref_id, bool $recursive = false): array
    {
        if ($recursive === false) {
            return $this->getAssignements(
                $ref_id,
                ilOrgUnitPosition::getCorePosition(ilOrgUnitPosition::CORE_POSITION_SUPERIOR)
            );
        }

        $arr_usr_ids = [];
        foreach ($this->getAllChildren($ref_id) as $ref_id_child) {
            $arr_usr_ids += $this->getAssignements(
                $ref_id_child,
                ilOrgUnitPosition::getCorePosition(ilOrgUnitPosition::CORE_POSITION_SUPERIOR)
            );
        }
        return $arr_usr_ids;
    }

    private function loadArrayOfStaff(string $title, array $ref_ids): array
    {
        $this->loadRoles($title);
        $all_refs = $ref_ids;
        //take away ref_ids that are already loaded.
        foreach ($ref_ids as $id => $ref_id) {
            if (isset($this->staff[$title][$ref_id])) {
                unset($ref_ids[$id]);
            } else {
                $this->staff[$title][$ref_id] = array();
                $ref_ids[$id] = $this->roles[$title][$ref_id];
            }
        }

        //if there are still refs that need to be loaded, then do so.
        if (count($ref_ids)) {
            $q = "SELECT usr_id, rol_id FROM rbac_ua WHERE " . $this->db->in("rol_id", $ref_ids, false, "integer");
            $set = $this->db->query($q);
            while ($res = $this->db->fetchAssoc($set)) {
                $orgu_ref = $this->role_to_orgu[$title][$res["rol_id"]];
                $this->staff[$title][$orgu_ref][] = $res["usr_id"];
            }
        }

        //collect * users.
        $all_users = [];
        foreach ($all_refs as $ref) {
            $all_users = array_merge($all_users, $this->staff[$title][$ref]);
        }
        return $all_users;
    }

    public function getAllChildren(int $ref_id): array
    {
        $open = array($ref_id);
        $closed = array();
        while (count($open)) {
            $ref = array_pop($open);
            $closed[] = $ref;
            foreach ($this->getChildren($ref) as $child) {
                if (in_array($child, $open, true) === false && in_array($child, $closed, true) === false) {
                    $open[] = $child;
                }
            }
        }

        return $closed;
    }

    public function getOrgusWhereUserHasPermissionForOperation($operation): array
    {

        /*$q = "SELECT object_data.obj_id, object_reference.ref_id, object_data.title, object_data.type, rbac_pa.ops_id, rbac_operations.ops_id as op_id FROM object_data
        INNER JOIN rbac_operations ON rbac_operations.operation = ".$this->db->quote($operation, "text")."
        INNER JOIN rbac_ua ON rbac_ua.usr_id = ".$this->db->quote($ilUser->getId(), "integer")."
        INNER JOIN rbac_pa ON rbac_pa.rol_id = rbac_ua.rol_id AND rbac_pa.ops_id LIKE CONCAT('%', rbac_operations.ops_id, '%')
        INNER JOIN rbac_fa ON rbac_fa.rol_id = rbac_ua.rol_id
        INNER JOIN tree ON tree.child = rbac_fa.parent
        INNER JOIN object_reference ON object_reference.ref_id = tree.parent
        WHERE object_data.obj_id = object_reference.obj_id AND object_data.type = 'orgu'";*/

        $q = "SELECT object_data.obj_id, object_reference.ref_id, object_data.title, object_data.type, rbac_pa.ops_id, rbac_operations.ops_id as op_id FROM object_data
                INNER JOIN rbac_operations ON rbac_operations.operation = " . $this->db->quote($operation, "text") . "
                INNER JOIN rbac_ua ON rbac_ua.usr_id = " . $this->db->quote($this->ilUser->getId(), "integer") . "
                INNER JOIN rbac_pa ON rbac_pa.rol_id = rbac_ua.rol_id AND rbac_pa.ops_id LIKE CONCAT('%', rbac_operations.ops_id, '%')
                INNER JOIN object_reference ON object_reference.ref_id = rbac_pa.ref_id
                WHERE object_data.obj_id = object_reference.obj_id AND object_data.type = 'orgu'";

        $set = $this->db->query($q);
        $orgus = [];
        while ($res = $this->db->fetchAssoc($set)) {
            //this is needed as the table rbac_operations is not in the first normal form, thus this needs some additional checkings.
            $perm_check = unserialize($res['ops_id'], ['allowed_classes' => true]);
            if (in_array($res["op_id"], $perm_check, true) === false) {
                continue;
            }

            $orgus[] = $res["ref_id"];
        }

        return $orgus;
    }

    public function getOrgusWhereUserHasPermissionForOperationId(string $operation_id): array
    {
        $q = "SELECT object_data.obj_id, object_data.title, object_data.type, rbac_pa.ops_id FROM object_data
                INNER JOIN rbac_ua ON rbac_ua.usr_id = " . $this->db->quote($this->ilUser->getId(), "integer") . "
                INNER JOIN rbac_pa ON rbac_pa.rol_id = rbac_ua.rol_id AND rbac_pa.ops_id LIKE CONCAT('%', " . $this->db->quote(
            $operation_id,
            "integer"
        ) . ", '%')
                INNER JOIN rbac_fa ON rbac_fa.rol_id = rbac_ua.rol_id
                INNER JOIN tree ON tree.child = rbac_fa.parent
                INNER JOIN object_reference ON object_reference.ref_id = tree.parent
                WHERE object_data.obj_id = object_reference.obj_id AND object_data.type = 'orgu'";

        $set = $this->db->query($q);
        $orgus = array();
        while ($res = $this->db->fetchAssoc($set)) {
            //this is needed as the table rbac_operations is not in the first normal form, thus this needs some additional checkings.
            $perm_check = unserialize($res['ops_id'], ['allowed_classes' => true]);
            if (in_array($res["ops_id"], $perm_check, true) === false) {
                continue;
            }

            $orgus[] = $res["obj_id"];
        }

        return $orgus;
    }

    private function getChildren(int $ref_id): array
    {
        $this->loadChildren($ref_id);
        return $this->tree_childs[$ref_id];
    }

    private function loadChildren(int $ref_id): void
    {
        if (!array_key_exists($ref_id, $this->tree_childs)) {
            $children = [];
            foreach ($this->tree->getChilds($ref_id) as $child) {
                if ($child["type"] == "orgu") {
                    $children[] = $child["child"];
                }
            }
            $this->tree_childs[$ref_id] = $children;
        }
    }

    public function getAllOrgunitsOnLevelX(int $level): array
    {
        $levels = array(0 => array(ilObjOrgUnit::getRootOrgRefId()));
        $current_level = 0;
        while ($current_level < $level) {
            $new_level = array();
            foreach ($levels[$current_level] as $orgu_ref) {
                $new_level = array_merge($this->getChildren($orgu_ref), $new_level);
            }
            $new_level = array_unique($new_level);
            $levels[$current_level + 1] = $new_level;
            $current_level++;
        }

        return $levels[$level];
    }

    public function getEmployeesUnderUser(int $user_id, bool $recursive = true): array
    {
        $assignment_query = ilOrgUnitUserAssignmentQueries::getInstance();
        $orgu_ref_ids = $assignment_query->getOrgUnitIdsOfUsersPosition(
            ilOrgUnitPosition::CORE_POSITION_SUPERIOR,
            $user_id
        );

        switch ($recursive) {
            case true:
                $orgu_ref_id_with_children = [];
                foreach ($orgu_ref_ids as $orgu_ref_id) {
                    $orgu_ref_id_with_children = array_merge($orgu_ref_ids, $this->getAllChildren($orgu_ref_id));
                }
                return $assignment_query->getUserIdsOfOrgUnitsInPosition(
                    $orgu_ref_id_with_children,
                    ilOrgUnitPosition::CORE_POSITION_EMPLOYEE
                );
            default:
                return $assignment_query->getUserIdsOfOrgUnitsInPosition(
                    $orgu_ref_ids,
                    ilOrgUnitPosition::CORE_POSITION_EMPLOYEE
                );
        }
    }

    public function getSuperiorsOfUser(int $user_id, bool $recursive = true): array
    {
        //querry for all orgu where user_id is superior.
        $q = "SELECT orgu.obj_id, refr.ref_id FROM object_data orgu
                INNER JOIN object_reference refr ON refr.obj_id = orgu.obj_id
                                INNER JOIN object_data roles ON roles.title LIKE CONCAT('il_orgu_employee_',refr.ref_id) OR roles.title LIKE CONCAT('il_orgu_superior_',refr.ref_id)
                                INNER JOIN rbac_ua rbac ON rbac.usr_id = " . $this->db->quote($user_id, "integer") . " AND roles.obj_id = rbac.rol_id
                                WHERE orgu.type = 'orgu'";
        $set = $this->db->query($q);
        $orgu_ref_ids = array();
        while ($res = $this->db->fetchAssoc($set)) {
            $orgu_ref_ids[] = $res['ref_id'];
        }
        $superiors = array();
        foreach ($orgu_ref_ids as $orgu_ref_id) {
            $superiors = array_merge($superiors, $this->getSuperiors($orgu_ref_id, $recursive));
        }

        return $superiors;
    }

    public function getLevelXOfUser(int $user_id, int $level): array
    {
        $q = "SELECT object_reference.ref_id FROM rbac_ua
                                JOIN rbac_fa ON rbac_fa.rol_id = rbac_ua.rol_id
                                JOIN object_reference ON rbac_fa.parent = object_reference.ref_id
                                JOIN object_data ON object_data.obj_id = object_reference.obj_id
                        WHERE rbac_ua.usr_id = " . $this->db->quote($user_id, 'integer') . " AND object_data.type = 'orgu';";

        $set = $this->db->query($q);
        $orgu_ref_ids = array();
        while ($res = $this->db->fetchAssoc($set)) {
            $orgu_ref_ids[] = $res['ref_id'];
        }
        $orgus_on_level_x = array();
        foreach ($orgu_ref_ids as $orgu_ref_id) {
            try {
                $orgus_on_level_x[] = $this->getLevelXOfTreenode($orgu_ref_id, $level);
            } catch (Exception $e) {
                // this means the user is assigned to a orgu above the given level. just dont add it to the list.
            }
        }

        return array_unique($orgus_on_level_x);
    }

    public function getOrgUnitOfUser(int $user_id): array
    {
        $orgu_ref_ids = [];
        $orgu_query = ilOrgUnitUserAssignmentQueries::getInstance();

        $orgus = $orgu_query->getAssignmentsOfUserId($user_id);
        foreach ($orgus as $orgu) {
            $orgu_ref_ids[] = $orgu->getOrguId();
        }
        return $orgu_ref_ids;
    }

    public function buildTempTableWithUsrAssignements(string $temporary_table_name = 'orgu_usr_assignements'): bool
    {
        if (self::$temporary_table_name == $temporary_table_name) {
            return true;
        }
        if (self::$temporary_table_name === null) {
            $this->dropTempTable($temporary_table_name);
            self::$temporary_table_name = $temporary_table_name;
        } elseif ($temporary_table_name != self::$temporary_table_name) {
            throw new ilException('there is already a temporary table for org-unit assignement: ' . self::$temporary_table_name);
        }

        $q = "CREATE TEMPORARY TABLE IF NOT EXISTS " . $temporary_table_name . " AS (
                                SELECT DISTINCT object_reference.ref_id AS ref_id, il_orgu_ua.user_id AS user_id, orgu_path_storage.path AS path
                                        FROM il_orgu_ua
                    JOIN object_reference ON object_reference.ref_id = il_orgu_ua.orgu_id
                                        JOIN object_data ON object_data.obj_id = object_reference.obj_id
                                        JOIN orgu_path_storage ON orgu_path_storage.ref_id = object_reference.ref_id
                                WHERE object_data.type = 'orgu' AND object_reference.deleted IS NULL
                        );";
        $this->db->manipulate($q);

        return true;
    }

    public function dropTempTable(string $temporary_table_name): bool
    {
        if (self::$temporary_table_name === null
            || $temporary_table_name !== self::$temporary_table_name
        ) {
            return false;
        }
        $q = "DROP TABLE IF EXISTS " . $temporary_table_name;
        $this->db->manipulate($q);

        self::$temporary_table_name = null;

        return true;
    }

    public function getTitles(array $org_refs): array
    {
        $names = array();
        foreach ($org_refs as $org_unit) {
            $names[$org_unit] = ilObject::_lookupTitle(ilObject::_lookupObjId($org_unit));
        }

        return $names;
    }

    public function getEmployeeRoles(): array
    {
        $this->loadRoles("employee");
        return $this->roles["employee"];
    }

    public function getSuperiorRoles(): array
    {
        $this->loadRoles("superior");

        return $this->roles["superior"];
    }

    private function loadRoles(string $role)
    {
        if ($this->roles[$role] == null) {
            $this->loadRolesQuery($role);
        }
    }

    public function flushCache(): void
    {
        $this->roles = null;
    }

    private function loadRolesQuery(string $role): void
    {
        $this->roles[$role] = array();
        $q = "SELECT obj_id, title FROM object_data WHERE type = 'role' AND title LIKE 'il_orgu_" . $role . "%'";
        $set = $this->db->query($q);
        while ($res = $this->db->fetchAssoc($set)) {
            $orgu_ref = $this->getRefIdFromRoleTitle($res["title"]);
            $this->roles[$role][$orgu_ref] = $res["obj_id"];
            $this->role_to_orgu[$role][$res["obj_id"]] = $orgu_ref;
        }
    }

    private function getRefIdFromRoleTitle(string $role_title): int
    {
        $array = explode("_", $role_title);

        return $array[count($array) - 1];
    }

    public function getLevelXOfTreenode(int $orgu_ref, int $level)
    {
        $line = array($orgu_ref);
        $current_ref = $orgu_ref;
        while ($current_ref != ilObjOrgUnit::getRootOrgRefId()) {
            $current_ref = $this->getParent($current_ref);
            if ($current_ref) {
                $line[] = $current_ref;
            } else {
                break;
            }
            if (count($line) > 100) {
                throw new Exception("There's either a non valid call of the getLevelXOfTreenode in ilObjOrgUnitTree or your nesting of orgunits is higher than 100 units, which isn't encouraged");
            }
        }
        $line = array_reverse($line);
        if (count($line) > $level) {
            return $line[$level];
        } else {
            throw new Exception("you want to fetch level " . $level . " but the line to the length of the line is only " . count($line)
                . ". The line of the given org unit is: " . print_r($line, true));
        }
    }

    public function getParent(int $orgu_ref): int
    {
        if (array_key_exists($orgu_ref, $this->parent) === false) {
            $this->parent[$orgu_ref] = $this->tree->getParentId($orgu_ref);
        }

        return $this->parent[$orgu_ref];
    }
}