class.ilObjStudyProgramme.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Filesystem\Filesystem;

class ilObjStudyProgramme extends ilContainer
{
    public const CP_TYPE = 'cont';

    protected static ?ilObjStudyProgrammeCache $study_programme_cache = null;

    protected $parent;

    protected ?array $children = null;

    protected ?array $lp_children = null;

    protected ilStudyProgrammeTypeDBRepository $type_repository;
    protected ilPRGAssignmentDBRepository $assignment_repository;
    protected ilStudyProgrammeAutoCategoryDBRepository $auto_categories_repository;
    protected ilStudyProgrammeAutoMembershipsDBRepository $auto_memberships_repository;
    protected ilStudyProgrammeMembershipSourceReaderFactory $membersourcereader_factory;
    protected ilStudyProgrammeEvents $events;
    protected ilStudyProgrammeSettingsDBRepository $settings_repository;

    // GLOBALS from ILIAS

    protected ?array $members_cache = null;

    protected ?array $reference_children = null;

    protected Filesystem $webdir;
    protected ilObjUser $ilUser;
    protected ?ilObjectFactoryWrapper $object_factory = null;
    protected ilObjectCustomIconFactory $custom_icon_factory;
    protected ilLogger $logger;

    public function __construct(int $id = 0, bool $call_by_reference = true)
    {
        $dic = ilStudyProgrammeDIC::dic();
        $this->type = "prg";

        $this->type_repository = $dic['model.Type.ilStudyProgrammeTypeRepository'];
        $this->auto_categories_repository = $dic['model.AutoCategories.ilStudyProgrammeAutoCategoriesRepository'];
        $this->auto_memberships_repository = $dic['model.AutoMemberships.ilStudyProgrammeAutoMembershipsRepository'];
        $this->membersourcereader_factory = $dic['model.AutoMemberships.ilStudyProgrammeMembershipSourceReaderFactory'];

        $this->settings_repository = $dic['model.Settings.ilStudyProgrammeSettingsRepository'];
        $this->assignment_repository = $dic['repo.assignment'];
        $this->events = $dic['ilStudyProgrammeEvents'];

        parent::__construct($id, $call_by_reference);

        $this->clearParentCache();
        $this->clearChildrenCache();
        $this->clearLPChildrenCache();

        global $DIC;
        $tree = $DIC['tree'];
        $ilUser = $DIC['ilUser'];
        $this->webdir = $DIC->filesystem()->web();
        $this->tree = $tree;
        $this->ilUser = $ilUser;
        $this->db = $DIC['ilDB'];
        $this->lng = $DIC['lng'];
        $this->logger = ilLoggerFactory::getLogger($this->type);

        $this->object_factory = ilObjectFactoryWrapper::singleton();

        $this->custom_icon_factory = $DIC['object.customicons.factory'];

        self::initStudyProgrammeCache();
    }

    public static function initStudyProgrammeCache(): void
    {
        if (self::$study_programme_cache === null) {
            self::$study_programme_cache = ilObjStudyProgrammeCache::singleton();
        }
    }

    protected function clearParentCache(): void
    {
        // This is not initialized, but we need null if there is no parent.
        $this->parent = false;
    }

    protected function clearChildrenCache(): void
    {
        $this->children = null;
    }

    protected function clearLPChildrenCache(): void
    {
        $this->lp_children = null;
    }

    public static function getRefIdFor(int $obj_id): int
    {
        $refs = ilObject::_getAllReferences($obj_id);
        if (count($refs) < 1) {
            throw new ilException("Could not find ref_id for programme with obj_id $obj_id");
        }
        return (int) array_shift($refs);
    }

    protected function getPrgInstanceByObjId(int $obj_id): ilObjStudyProgramme
    {
        return self::getInstanceByRefId(self::getRefIdFor($obj_id));
    }

    public static function getInstanceByObjId(int $obj_id): ilObjStudyProgramme
    {
        return self::getInstanceByRefId(self::getRefIdFor($obj_id));
    }

    public static function getInstanceByRefId($ref_id): ilObjStudyProgramme
    {
        if (self::$study_programme_cache === null) {
            self::initStudyProgrammeCache();
        }
        return self::$study_programme_cache->getInstanceByRefId((int) $ref_id);
    }

    protected function getAssignmentRepository(): PRGAssignmentRepository
    {
        return $this->assignment_repository;
    }
    protected function getSettingsRepository(): ilStudyProgrammeSettingsRepository
    {
        return $this->settings_repository;
    }
    protected function getTree(): ilTree
    {
        return $this->tree;
    }
    protected function getLogger(): ilLogger
    {
        return $this->logger;
    }

    public static function createInstance(): ilObjStudyProgramme
    {
        $obj = new ilObjStudyProgramme();
        $obj->create();
        $obj->createReference();
        self::$study_programme_cache->addInstance($obj);
        return $obj;
    }

    // CRUD

    public function getSettings(): ilStudyProgrammeSettings
    {
        return $this->getSettingsRepository()->get($this->getId());
    }

    public function updateSettings(ilStudyProgrammeSettings $settings): bool
    {
        if ($settings->getObjId() !== $this->getId()) {
            throw new Exception("The given settings-object does not belong to this programme", 1);
        }
        $this->getSettingsRepository()->update($settings);

        return true;
    }

    protected function deleteSettings(): void
    {
        $this->getSettingsRepository()->delete($this->getSettings());
    }

    protected function deleteAssignmentsAndProgresses(): void
    {
        $this->assignment_repository->deleteAllAssignmentsForProgrammeId($this->getId());
    }

    public function create(): int
    {
        $id = (int) parent::create();
        $this->getSettingsRepository()->createFor($id);
        return $id;
    }

    public function update(): bool
    {
        parent::update();

        $type_settings = $this->getSettings()->getTypeSettings();
        // Update selection for advanced metadata of the type
        if ($type_settings->getTypeId()) {
            ilAdvancedMDRecord::saveObjRecSelection(
                $this->getId(),
                'prg_type',
                $this->type_repository->getAssignedAMDRecordIdsByType($type_settings->getTypeId())
            );
        } else {
            // If no type is assigned, delete relations by passing an empty array
            ilAdvancedMDRecord::saveObjRecSelection($this->getId(), 'prg_type', array());
        }
        return true;
    }

    public function delete(): bool
    {
        // always call parent delete function first!!
        if (!parent::delete()) {
            return false;
        }

        $this->deleteSettings();
        $this->deleteAssignmentsAndProgresses();
        try {
            $this->auto_categories_repository->deleteFor($this->getId());
        } catch (ilStudyProgrammeTreeException $e) {
            // This would be the case when SP is in trash (#17797)
        }

        $this->deleteAllAutomaticContentCategories();
        $this->deleteAllAutomaticMembershipSources();

        $this->events->raise('delete', ['object' => $this, 'obj_id' => $this->getId()]);
        return true;
    }

    public function hasAdvancedMetadata(): bool
    {
        $sub_type_id = $this->getSettings()->getTypeSettings()->getTypeId();
        $type = null;
        if ($sub_type_id) {
            $type = $this->type_repository->getType($sub_type_id);
        }

        return !is_null($type) && count($this->type_repository->getAssignedAMDRecordIdsByType($type->getId(), true)) > 0;
    }

    public function cloneObject(int $target_ref_id, int $copy_id = 0, bool $omit_tree = false): ?ilObject
    {
        $new_obj = parent::cloneObject($target_ref_id, $copy_id, $omit_tree);
        $settings = $this->getSettings()->withObjId($new_obj->getId());
        $settings = $settings->withAssessmentSettings(
            $settings->getAssessmentSettings()->withStatus(ilStudyProgrammeSettings::STATUS_DRAFT)
        );
        $new_obj->updateSettings($settings);
        return $new_obj;
    }

    // GETTERS AND SETTERS

    public function getLastChange(): DateTime
    {
        return $this->getSettings()->getLastChange();
    }

    public function getPoints(): int
    {
        return $this->getSettings()->getAssessmentSettings()->getPoints();
    }

    public function setPoints(int $points): ilObjStudyProgramme
    {
        $settings = $this->getSettings();
        $this->updateSettings(
            $settings->withAssessmentSettings($settings->getAssessmentSettings()->withPoints($points))
        );
        $this->updateLastChange();
        return $this;
    }

    public function getLPMode(): int
    {
        return $this->getSettings()->getLPMode();
    }

    public function adjustLPMode(): void
    {
        // Clear caches here, there have been some changes, because this method
        // would not have been called otherwise, and the changer just does not
        // know if we have filled the caches already...
        $this->clearLPChildrenCache();
        $this->clearChildrenCache();

        if ($this->tree->isInTree($this->getRefId())) {
            if ($this->getAmountOfLPChildren() > 0) {
                $this->settings_repository->update(
                    $this->getSettings()->setLPMode(ilStudyProgrammeSettings::MODE_LP_COMPLETED)
                );
            } elseif ($this->getAmountOfChildren(true) > 0) {
                $this->settings_repository->update(
                    $this->getSettings()->setLPMode(ilStudyProgrammeSettings::MODE_POINTS)
                );
            } else {
                $this->settings_repository->update(
                    $this->getSettings()->setLPMode(ilStudyProgrammeSettings::MODE_UNDEFINED)
                );
            }
        }
    }

    public function getStatus(): int
    {
        return $this->getSettings()->getAssessmentSettings()->getStatus();
    }

    public function setStatus(int $a_status): ilObjStudyProgramme
    {
        $settings = $this->getSettings();
        $this->updateSettings(
            $settings->withAssessmentSettings($settings->getAssessmentSettings()->withStatus($a_status))
        );
        $this->updateLastChange();
        return $this;
    }

    public function isActive(): bool
    {
        return $this->getStatus() === ilStudyProgrammeSettings::STATUS_ACTIVE;
    }

    public function getSubType(): ?ilStudyProgrammeType
    {
        $type_settings = $this->getSettings()->getTypeSettings();
        if (!in_array($type_settings->getTypeId(), array("-", "0"))) {
            $subtype_id = $type_settings->getTypeId();
            return $this->type_repository->getType($subtype_id);
        }

        return null;
    }

    public function isCertificateActive(): bool
    {
        $global_settings = new ilSetting('certificate');
        $global_active = (bool) $global_settings->get('active', '0');
        if (!$global_active) {
            return false;
        }
        $certificate_template_repository = new ilCertificateTemplateDatabaseRepository($this->db);
        $certificate_template = $certificate_template_repository->fetchCurrentlyUsedCertificate($this->getId());
        return $certificate_template->isCurrentlyActive();
    }


    // TREE NAVIGATION

    public static function getAllChildren(int $a_ref_id, bool $include_references = false): array
    {
        $ret = array();
        $root = self::getInstanceByRefId($a_ref_id);
        $root_id = $root->getId();
        $root->applyToSubTreeNodes(function (ilObjStudyProgramme $prg) use (&$ret, $root_id) {
            // exclude root node of subtree.
            if ($prg->getId() === $root_id) {
                return;
            }
            $ret[] = $prg;
        }, $include_references);
        return $ret;
    }

    public function getAllPrgChildren(): array
    {
        $ret = [];
        $this->applyToSubTreeNodes(
            function (ilObjStudyProgramme $prg) use (&$ret) {
                if ($prg->getId() === $this->getId()) {
                    return;
                }
                $ret[] = $prg;
            }
        );
        return $ret;
    }

    public function getChildren(bool $include_references = false): array
    {
        $this->throwIfNotInTree();

        if ($this->children === null) {
            $ref_ids = $this->tree->getChildsByType($this->getRefId(), "prg");

            // apply container sorting to tree
            $sorting = ilContainerSorting::_getInstance($this->getId());
            $ref_ids = $sorting->sortItems(array('prg' => $ref_ids));
            $ref_ids = $ref_ids['prg'];

            $this->children = array_map(static function ($node_data) {
                return ilObjStudyProgramme::getInstanceByRefId($node_data["child"]);
            }, $ref_ids);
        }

        if ($include_references && $this->reference_children === null) {
            $this->reference_children = [];
            $ref_child_ref_ids = $this->tree->getChildsByType($this->getRefId(), "prgr");
            foreach (
                array_unique(
                    array_map(
                        static function ($data) {
                            return (int) $data['child'];
                        },
                        array_filter($ref_child_ref_ids, static function ($data) {
                            return $data["deleted"] === null;
                        })
                    )
                ) as $prg_ref_id
            ) {
                $this->reference_children[] =
                    (new ilObjStudyProgrammeReference($prg_ref_id))->getReferencedObject();
            }
        }
        return $include_references ?
            array_merge($this->children, $this->reference_children) :
            $this->children;
    }

    public function getParent(): ?ilObjStudyProgramme
    {
        if ($this->parent === false) {
            $this->throwIfNotInTree();
            $parent_data = $this->tree->getParentNodeData($this->getRefId());
            if ($parent_data["type"] !== "prg") {
                $this->parent = null;
            } else {
                $this->parent = self::getInstanceByRefId($parent_data["ref_id"]);
            }
        }
        return $this->parent;
    }

    protected function getReferencesTo(ilObjStudyProgramme $prg): array
    {
        $tree = $this->tree;
        return array_filter(
            array_map(
                static function ($id) {
                    $refs = ilObject::_getAllReferences((int) $id);
                    return new ilObjStudyProgrammeReference(
                        array_shift($refs)
                    );
                },
                ilContainerReference::_lookupSourceIds($prg->getId())
            ),
            static function ($prg_ref) use ($tree) {
                return !$tree->isDeleted($prg_ref->getRefId());
            }
        );
    }

    public function getReferencesToSelf(): array
    {
        return $this->getReferencesTo($this);
    }

    public function getParents(bool $include_references = false): array
    {
        $current = $this;
        $parents = [];
        $queque = [$current];
        while ($element = array_shift($queque)) {
            $parent = $element->getParent();
            if ($parent === null || $include_references) {
                foreach ($this->getReferencesTo($element) as $reference) {
                    if ($this->tree->isDeleted($reference->getRefId())) {
                        continue;
                    }
                    $r_parent = $reference->getParent();
                    if (is_null($r_parent)) {
                        continue;
                    }
                    $queque[] = $r_parent;
                    $parents[] = $r_parent;
                }
                continue;
            }
            $queque[] = $parent;
            $parents[] = $parent;
        }
        return array_reverse($parents);
    }

    public function hasChildren(bool $include_references = false): bool
    {
        return $this->getAmountOfChildren($include_references) > 0;
    }

    public function getAmountOfChildren($include_references = false): int
    {
        return count($this->getChildren($include_references));
    }

    public function getDepth(): int
    {
        $cur = $this;
        $count = 0;
        while ($cur = $cur->getParent()) {
            $count++;
        }
        return $count;
    }

    public function getRoot(): ilObjStudyProgramme
    {
        $parents = $this->getParents();
        if (count($parents) < 1) {
            return $this;
        }
        return $parents[0];
    }

    public function getLPChildren(): array
    {
        $this->throwIfNotInTree();

        if ($this->lp_children === null) {
            $this->lp_children = array();

            $ref_ids = $this->tree->getChildsByType($this->getRefId(), "crsr");

            // apply container sorting to tree
            $sorting = ilContainerSorting::_getInstance($this->getId());
            $ref_ids = $sorting->sortItems(array('crs_ref' => $ref_ids));
            $ref_ids = $ref_ids['crs_ref'];

            $lp_children = array_map(function ($node_data) {
                $lp_obj = $this->object_factory->getInstanceByRefId((int) $node_data["child"]);

                // filter out all StudyProgramme instances
                return ($lp_obj instanceof $this) ? null : $lp_obj;
            }, $ref_ids);

            $this->lp_children = array_filter($lp_children);
        }
        return $this->lp_children;
    }

    public function getLPChildrenIds(): array
    {
        return array_map(static function ($child) {
            return $child->getId();
        }, $this->getLPChildren());
    }

    public function getAmountOfLPChildren(): int
    {
        return count($this->getLPChildren());
    }

    public function hasLPChildren(): bool
    {
        return ($this->getAmountOfLPChildren() > 0);
    }

    protected function throwIfNotInTree(): void
    {
        if (!$this->tree->isInTree($this->getRefId())) {
            throw new ilStudyProgrammeTreeException("This program is not in tree.");
        }
    }

    // QUERIES ON SUBTREE

    public function applyToSubTreeNodes(Closure $fun, bool $include_references = false): void
    {
        $this->throwIfNotInTree();

        if ($fun($this) !== false) {
            foreach ($this->getChildren($include_references) as $child) {
                $child->applyToSubTreeNodes($fun, $include_references);
            }
        }
    }

    public function getCompletedCourses(ilPRGAssignment $assignment): array
    {
        $completed_crss = [];
        $f = function ($prg) use (&$completed_crss, $assignment) {
            if ($prg->isActive() &&
                $assignment->getProgressForNode($prg->getId())->isRelevant()
            ) {
                foreach ($prg->getLPChildren() as $child) {
                    $crs_id = (int) ilContainerReference::_lookupTargetId((int) $child->getId());
                    $crs_ref_id = (int) ilContainerReference::_lookupTargetRefId((int) $child->getId());
                    $crsr_ref_id = (int) $child->getRefId();

                    if (ilObject::_exists($crsr_ref_id, true) &&
                        is_null(ilObject::_lookupDeletedDate($crsr_ref_id)) &&
                        ilObject::_exists($crs_id, false) &&
                        is_null(ilObject::_lookupDeletedDate($crs_ref_id)) &&
                        ilLPStatus::_hasUserCompleted($crs_id, $assignment->getUserId())
                    ) {
                        $completed_crss[] = [
                            'crs_id' => $crs_id,
                            'prg_ref_id' => $prg->getRefId(),
                            'prg_obj_id' => $prg->getId(),
                            'crsr_ref_id' => $crsr_ref_id,
                            'crsr_id' => $child->getId(),
                            'crs_ref_id' => $crs_ref_id,
                            'title' => ilContainerReference::_lookupTitle((int) $child->getId()),
                        ];
                    }
                }
                return true;
            }
            return false;
        };
        $this->applyToSubTreeNodes($f, true);
        return $completed_crss;
    }

    // TREE MANIPULATION

    public function addNode(ilObjStudyProgramme $a_prg): ilObjStudyProgramme
    {
        $this->throwIfNotInTree();

        if ($this->getLPMode() === ilStudyProgrammeSettings::MODE_LP_COMPLETED) {
            throw new ilStudyProgrammeTreeException("Program already contains leafs.");
        }

        if ($this->tree->isInTree($a_prg->getRefId())) {
            throw new ilStudyProgrammeTreeException("Other program already is in tree.");
        }

        if ($a_prg->getRefId() === null) {
            $a_prg->createReference();
        }
        $a_prg->putInTree($this->getRefId());
        return $this;
    }

    public function nodeInserted($prg): void
    {
        if (! $prg instanceof ilObjStudyProgrammeReference &&
           ! $prg instanceof ilObjStudyProgramme
        ) {
            throw new ilStudyProgrammeTreeException("Wrong type of node: " . get_class($prg));
        }
        if ($this->getLPMode() === ilStudyProgrammeSettings::MODE_LP_COMPLETED) {
            throw new ilStudyProgrammeTreeException("Program already contains leafs.");
        }

        if ($this->getSettings()->getLPMode() !== ilStudyProgrammeSettings::MODE_POINTS) {
            $this->settings_repository->update(
                $this->getSettings()->setLPMode(ilStudyProgrammeSettings::MODE_POINTS)
            );
        }

        $this->clearChildrenCache();
        $this->addMissingProgresses();
    }

    public function putInTree(int $parent_ref_id): void
    {
        parent::putInTree($parent_ref_id);

        if (ilObject::_lookupType($parent_ref_id, true) === "prg") {
            $par = self::getInstanceByRefId($parent_ref_id);
            $par->nodeInserted($this);
        }
    }

    public function removeNode(ilObjStudyProgramme $a_prg): ilObjStudyProgramme
    {
        if ($a_prg->getParent()->getId() !== $this->getId()) {
            throw new ilStudyProgrammeTreeException("This is no parent of the given programm.");
        }

        if (!$a_prg->canBeRemoved()) {
            throw new ilStudyProgrammeTreeException("The node has relevant assignments.");
        }

        // *sigh*...
        $node_data = $this->tree->getNodeData($a_prg->getRefId());
        $this->tree->deleteTree($node_data);
        $a_prg->clearParentCache();
        $this->clearChildrenCache();

        return $this;
    }

    public function canBeRemoved(): bool
    {
        return ! $this->hasRelevantProgresses();
    }

    public function moveTo(ilObjStudyProgramme $new_parent): ilObjStudyProgramme
    {
        global $DIC;
        $rbacadmin = $DIC['rbacadmin'];

        if ($parent = $this->getParent()) {
            // TODO: check if there some leafs in the new parent

            $this->tree->moveTree($this->getRefId(), $new_parent->getRefId());
            // necessary to clean up permissions
            $rbacadmin->adjustMovedObjectPermissions($this->getRefId(), $parent->getRefId());

            // TODO: lp-progress needs to be updated

            // clear caches on different nodes
            $this->clearParentCache();

            $parent->clearChildrenCache();
            $parent->clearLPChildrenCache();

            $new_parent->clearChildrenCache();
            $new_parent->clearLPChildrenCache();
        }

        return $this;
    }

    // USER ASSIGNMENTS

    public function assignUser(int $usr_id, int $acting_usr_id = null, $raise_event = true): ilPRGAssignment
    {
        $this->members_cache = null;

        if ($this->getStatus() !== ilStudyProgrammeSettings::STATUS_ACTIVE) {
            throw new ilException(
                "ilObjStudyProgramme::assignUser: Can't assign user to program '"
                . $this->getId() . "', since it's not in active status."
            );
        }

        if (is_null($acting_usr_id)) {
            $acting_usr_id = $this->getLoggedInUserId();
        }

        $ass = $this->assignment_repository->createFor($this->getId(), $usr_id, $acting_usr_id);
        $ass = $ass
            ->initAssignmentDates();

        $ass = $ass->resetProgresses(
            $this->getSettingsRepository(),
            $acting_usr_id
        );

        $this->assignment_repository->store($ass);

        if ($raise_event) {
            $this->events->userAssigned($ass);
        }
        return $ass;
    }

    public function removeAssignment(ilPRGAssignment $assignment): ilObjStudyProgramme
    {
        $this->members_cache = null;
        if ($assignment->getRootId() !== $this->getId()) {
            throw new ilException(
                "ilObjStudyProgramme::removeAssignment: Assignment '"
                . $assignment->getId() . "' does not belong to study "
                . "program '" . $this->getId() . "'."
            );
        }

        $this->assignment_repository->delete($assignment);

        $affected_node_ids = array_map(fn($pgs) => $pgs->getNodeId(), $assignment->getProgresses());
        foreach ($affected_node_ids as $node_obj_id) {
            $this->refreshLPStatus($assignment->getUserId(), $node_obj_id);
        }

        $this->events->userDeassigned($assignment);
        return $this;
    }

    public function getSpecificAssignment(int $assignment_id): ilPRGAssignment
    {
        return $this->assignment_repository->get($assignment_id);
    }

    public function storeExpiryInfoSentFor(ilPRGAssignment $ass): void
    {
        $this->assignment_repository->storeExpiryInfoSentFor($ass);
    }

    public function resetExpiryInfoSentFor(ilPRGAssignment $ass): void
    {
        $this->assignment_repository->resetExpiryInfoSentFor($ass);
    }

    public function storeRiskyToFailSentFor(ilPRGAssignment $ass): void
    {
        $this->assignment_repository->storeRiskyToFailSentFor($ass);
    }

    public function resetRiskyToFailSentFor(ilPRGAssignment $ass): void
    {
        $this->assignment_repository->resetRiskyToFailSentFor($ass);
    }

    public function hasAssignmentOf(int $user_id): bool
    {
        return $this->getAmountOfAssignmentsOf($user_id) > 0;
    }

    public function getAmountOfAssignmentsOf(int $user_id): int
    {
        return count($this->getAssignmentsOf($user_id));
    }

    public function getAssignmentsOf(int $user_id): array
    {
        $assignments = $this->assignment_repository->getAllForNodeIsContained(
            $this->getId(),
            [$user_id]
        );

        usort($assignments, function ($a_one, $a_other) {
            return strcmp(
                $a_one->getLastChange()->format('Y-m-d'),
                $a_other->getLastChange()->format('Y-m-d')
            );
        });
        return $assignments;
    }

    public function getAssignments(): array
    {
        return $this->assignment_repository->getAllForNodeIsContained($this->getId());
    }

    public function getMembers(): array
    {
        $usr_ids = [];
        foreach ($this->getAssignments() as $assignment) {
            $usr_ids[] = $assignment->getUserId();
        }
        return array_unique($usr_ids);
    }

    public function getLocalMembers(): array
    {
        if (!$this->members_cache) {
            $this->members_cache = array_map(
                static function ($assignment) {
                    return $assignment->getUserId();
                },
                $this->assignment_repository->getByPrgId($this->getId())
            );
        }
        return $this->members_cache;
    }

    public function hasAssignments(): bool
    {
        $filter = new ilPRGAssignmentFilter($this->lng);
        $count = $this->assignment_repository->countAllForNodeIsContained(
            $this->getId(),
            null,
            $filter
        );
        return $count > 0;

    }

    public function getAssignmentsOfSingleProgramForUser(int $usr_id): array
    {
        return $this->assignment_repository->getAllForSpecificNode($this->getId(), [$usr_id]);
    }

    public function hasAssignmentsOfSingleProgramForUser(int $usr_id): bool
    {
        return count($this->getAssignmentsOfSingleProgramForUser($usr_id)) > 0;
    }

    public function getCertificateRelevantAssignmentIds(int ...$usr_ids): array
    {
        return $this->assignment_repository->getCertificateRelevantAssignmentIds(
            $this->getId(),
            ...$usr_ids
        );
    }


    // USER PROGRESS

    public function addMissingProgresses(): void
    {
        $assignments = $this->getAssignments();
        foreach ($assignments as $ass) {
            $this->assignment_repository->store($ass);
        }
    }

    public function hasRelevantProgresses(): bool
    {
        $filter = new ilPRGAssignmentFilter($this->lng);
        $filter = $filter->withValues([
            'prg_status_hide_irrelevant' => true
        ]);
        $count = $this->assignment_repository->countAllForNodeIsContained(
            $this->getId(),
            null,
            $filter
        );
        return $count > 0;
    }

    public function getIdsOfUsersWithRelevantProgress(): array
    {
        return array_map(
            fn($ass) => $ass->getUserId(),
            $this->getAssignments()
        );
    }


    // AUTOMATIC CONTENT CATEGORIES

    public function getAutomaticContentCategories(): array
    {
        return $this->auto_categories_repository->getFor($this->getId());
    }

    public function hasAutomaticContentCategories(): bool
    {
        return count($this->getAutomaticContentCategories()) > 0;
    }


    public function storeAutomaticContentCategory(int $category_ref_id): void
    {
        $ac = $this->auto_categories_repository->create(
            $this->getId(),
            $category_ref_id
        );
        $this->auto_categories_repository->update($ac);
    }

    public function deleteAutomaticContentCategories(array $category_ids = []): void
    {
        $this->auto_categories_repository->delete($this->getId(), $category_ids);
    }

    public function deleteAllAutomaticContentCategories(): void
    {
        $this->auto_categories_repository->deleteFor($this->getId());
    }

    public static function addCrsToProgrammes(int $crs_ref_id, int $cat_ref_id): void
    {
        foreach (self::getProgrammesMonitoringCategory($cat_ref_id) as $prg) {
            $course_ref = new ilObjCourseReference();
            $course_ref->setTitleType(ilContainerReference::TITLE_TYPE_REUSE);
            $course_ref->setTargetRefId($crs_ref_id);
            $course_ref->create();
            $course_ref->createReference();
            $course_ref->putInTree($prg->getRefId());
            $course_ref->setPermissions($crs_ref_id);
            $course_ref->setTargetId(ilObject::_lookupObjectId($crs_ref_id));
            $course_ref->update();
            $lp = new ilLPObjSettings($course_ref->getId());
            $lp->insert();
            $lp->setMode($lp::LP_MODE_COURSE_REFERENCE);
            $lp->update(false);
        }
    }

    public static function removeCrsFromProgrammes(int $crs_ref_id, int $cat_ref_id): void
    {
        foreach (self::getProgrammesMonitoringCategory($cat_ref_id) as $prg) {
            foreach ($prg->getLPChildren() as $child) {
                if ((int) $child->getTargetRefId() === $crs_ref_id) {
                    $child->delete();
                }
            }
        }
    }

    protected static function getProgrammesMonitoringCategory(int $cat_ref_id): array
    {
        $db = ilStudyProgrammeDIC::dic()['model.AutoCategories.ilStudyProgrammeAutoCategoriesRepository'];
        $programmes =
            array_filter(
                array_map(
                    static function (array $rec) {
                        $values = array_values($rec);
                        $prg_obj_id = (int) array_shift($values);

                        $references = ilObject::_getAllReferences($prg_obj_id);
                        $prg_ref_id = (int) array_shift($references);

                        $prg = self::getInstanceByRefId($prg_ref_id);
                        if ($prg->isAutoContentApplicable()) {
                            return $prg;
                        }
                    },
                    $db::getProgrammesFor($cat_ref_id)
                )
            );
        return $programmes;
    }

    public function isAutoContentApplicable(): bool
    {
        $valid_status = in_array(
            $this->getSettings()->getAssessmentSettings()->getStatus(),
            [
                ilStudyProgrammeSettings::STATUS_DRAFT,
                ilStudyProgrammeSettings::STATUS_ACTIVE
            ],
            true
        );

        $crslnk_allowed = (
            $this->hasLPChildren()
            || $this->getAmountOfChildren(true) === 0
        );

        return $valid_status && $crslnk_allowed;
    }


    // AUTOMATIC MEMBERSHIPS

    public function getAutomaticMembershipSources(): array
    {
        return $this->auto_memberships_repository->getFor($this->getId());
    }

    public function storeAutomaticMembershipSource(string $type, int $src_id, bool $search_recursive): void
    {
        $ams = $this->auto_memberships_repository->create(
            $this->getId(),
            $type,
            $src_id,
            false,
            null,
            null,
            $search_recursive
        );
        $this->auto_memberships_repository->update($ams);
    }

    public function deleteAutomaticMembershipSource(string $type, int $src_id): void
    {
        $this->auto_memberships_repository->delete($this->getId(), $type, $src_id);
    }

    public function deleteAllAutomaticMembershipSources(): void
    {
        $this->auto_memberships_repository->deleteFor($this->getId());
    }

    public function disableAutomaticMembershipSource(string $type, int $src_id, bool $search_recursive): void
    {
        $ams = $this->auto_memberships_repository->create(
            $this->getId(),
            $type,
            $src_id,
            false,
            null,
            null,
            $search_recursive
        );
        $this->auto_memberships_repository->update($ams);
    }

    public function enableAutomaticMembershipSource(string $type, int $src_id, bool $search_recursive, $assign_now = false): void
    {
        if ($assign_now) {
            $assigned_by = ilStudyProgrammeAutoMembershipSource::SOURCE_MAPPING[$type];
            $member_ids = $this->getMembersOfMembershipSource($type, $src_id);
            foreach ($member_ids as $usr_id) {
                if (!$this->getAssignmentsOfSingleProgramForUser($usr_id)) {
                    $this->assignUser($usr_id, $assigned_by);
                }
            }
        }
        $ams = $this->auto_memberships_repository->create(
            $this->getId(),
            $type,
            $src_id,
            true,
            null,
            null,
            $search_recursive
        );
        $this->auto_memberships_repository->update($ams);
    }

    protected function getMembersOfMembershipSource(ilStudyProgrammeAutoMembershipSource $ams, ?int $exclude_id): array
    {
        $source_reader = $this->membersourcereader_factory->getReaderFor($ams, $exclude_id);
        return $source_reader->getMemberIds();
    }

    protected static function getProgrammesMonitoringMemberSource(string $src_type, int $src_id): array
    {
        $db = ilStudyProgrammeDIC::dic()['model.AutoMemberships.ilStudyProgrammeAutoMembershipsRepository'];
        $programmes = array_map(
            static function ($rec) {
                $values = array_values($rec);
                $prg_obj_id = (int) array_shift($values);

                $references = ilObject::_getAllReferences($prg_obj_id);
                $prg_ref_id = (int) array_shift($references);

                $prg = self::getInstanceByRefId($prg_ref_id);
                return $prg;
            },
            $db::getProgrammesFor($src_type, $src_id)
        );
        return $programmes;
    }

    public static function addMemberToProgrammes(string $src_type, int $src_id, int $usr_id): void
    {
        foreach (self::getProgrammesMonitoringMemberSource($src_type, $src_id) as $prg) {
            if ($prg->isActive() &&
                !$prg->hasAssignmentsOfSingleProgramForUser($usr_id)) {
                $assigned_by = ilStudyProgrammeAutoMembershipSource::SOURCE_MAPPING[$src_type];
                $prg->assignUser($usr_id, $assigned_by);
            }
        }
    }

    public static function removeMemberFromProgrammes(string $src_type, int $src_id, int $usr_id): void
    {
        $now = new DateTimeImmutable();
        $assignment_repository = ilStudyProgrammeDIC::dic()['repo.assignment'];
        foreach (self::getProgrammesMonitoringMemberSource($src_type, $src_id) as $prg) {
            $assignments = $prg->getAssignmentsOfSingleProgramForUser($usr_id);
            $next_membership_source = $prg->getApplicableMembershipSourceForUser($usr_id, $src_id);

            foreach ($assignments as $assignment) {
                if (!$assignment->getProgressTree()->isInProgress()) {
                    continue;
                }

                if (
                    $next_membership_source !== null
                    && $next_membership_source?->isEnabled()
                    && $next_membership_source->getSourceId() !== $src_id
                ) {
                    $new_src_type = $next_membership_source->getSourceType();
                    $assigned_by = ilStudyProgrammeAutoMembershipSource::SOURCE_MAPPING[$new_src_type];
                    $assignment = $assignment->withLastChange($assigned_by, $now);
                    $assignment_repository->store($assignment);
                    break;
                } else {
                    $assignment_repository->delete($assignment);
                }
            }
        }
    }

    public function getApplicableMembershipSourceForUser(
        int $usr_id,
        ?int $exclude_id
    ): ?ilStudyProgrammeAutoMembershipSource {
        foreach ($this->getAutomaticMembershipSources() as $ams) {
            if ($ams->isEnabled()) {
                $source_members = $this->getMembersOfMembershipSource($ams, $exclude_id);
                if (in_array($usr_id, $source_members)) {
                    return $ams;
                }
            }
        }
        return null;
    }

    // HELPERS

    protected function updateLastChange(): void
    {
        $this->getSettings()->updateLastChange();
        if ($parent = $this->getParent()) {
            $parent->updateLastChange();
        }
        $this->update();
    }

    public static function setProgressesCompletedFor(int $obj_id, int $user_id): void
    {
        // We only use courses via crs_refs
        $type = ilObject::_lookupType($obj_id);
        if ($type === "crsr") {
            foreach (ilObject::_getAllReferences($obj_id) as $ref_id) {
                self::setProgressesCompletedIfParentIsProgrammeInLPCompletedMode($ref_id, $obj_id, $user_id);
            }
        }
    }

    public static function setProgressesCompletedIfParentIsProgrammeInLPCompletedMode(
        int $ref_id,
        int $obj_id,
        int $user_id
    ): void {
        global $DIC; // TODO: replace this by a settable static for testing purpose?
        $tree = $DIC['tree'];
        $node_data = $tree->getParentNodeData($ref_id);
        if (count($node_data) === 0 || !array_key_exists('type', $node_data) || $node_data["type"] !== "prg") {
            return;
        }
        self::initStudyProgrammeCache();
        $prg = self::getInstanceByRefId($node_data["child"]);
        if ($prg->getLPMode() !== ilStudyProgrammeSettings::MODE_LP_COMPLETED) {
            return;
        }
        $prg->succeed($user_id, $obj_id);
    }

    public function succeed(int $usr_id, int $triggering_obj_id, ilPRGAssignment $ass = null): void
    {
        $progress_node_id = $this->getId();
        if (is_null($ass)) {
            $user_assignments = $this->assignment_repository
                ->getAllForNodeIsContained($progress_node_id, [$usr_id]);
        } else {
            $user_assignments = [$ass];
        }

        foreach ($user_assignments as $ass) {
            $ass = $ass->succeed(
                $this->getSettingsRepository(),
                $progress_node_id,
                $triggering_obj_id
            );
            $this->assignment_repository->store($ass);
        }
    }

    public function updateCustomIcon(): void
    {
        $customIcon = $this->custom_icon_factory->getByObjId($this->getId(), $this->getType());
        $subtype = $this->getSubType();

        if ($subtype && $subtype->getIconIdentifier()) {
            $src = $this->type_repository->getIconPathFS($subtype);

            //This is a horrible hack to allow Flysystem/LocalFilesystem to read the file.
            $tmp = 'ico_' . $this->getId();
            copy($src, \ilFileUtils::getDataDir() . '/temp/' . $tmp);

            $customIcon->saveFromTempFileName($tmp);
        } else {
            $customIcon->remove();
        }
    }

    // HOOKS

    public static function getCreatableSubObjects(array $subobjects, $ref_id): array
    {
        if ($ref_id === null) {
            return $subobjects;
        }

        if (ilObject::_lookupType($ref_id, true) !== "prg") {
            throw new ilException("Ref-Id '$ref_id' does not belong to a study programme object.");
        }

        $parent = self::getInstanceByRefId($ref_id);

        $mode = $parent->getLPMode();

        switch ($mode) {
            case ilStudyProgrammeSettings::MODE_UNDEFINED:
                $possible_subobjects = $subobjects;
                break;
            case ilStudyProgrammeSettings::MODE_POINTS:
                $possible_subobjects = [
                    "prg" => $subobjects["prg"],
                    "prgr" => $subobjects["prgr"]
                ];
                break;
            case ilStudyProgrammeSettings::MODE_LP_COMPLETED:
                $possible_subobjects = ['crsr' => $subobjects['crsr']];
                break;
            default:
                throw new ilException("Undefined mode for study programme: '$mode'");
        }

        if ($parent->hasAutomaticContentCategories()) {
            $possible_subobjects = array_filter(
                $possible_subobjects,
                static function ($subtype) {
                    return $subtype === 'crsr';
                },
                ARRAY_FILTER_USE_KEY
            );
        }
        return $possible_subobjects;
    }


    protected function getLoggedInUserId(): int
    {
        return $this->ilUser->getId();
    }

    protected function getNow(): DateTimeImmutable
    {
        return new DateTimeImmutable();
    }

    protected function refreshLPStatus(int $usr_id, int $node_obj_id = null): void
    {
        if (is_null($node_obj_id)) {
            $node_obj_id = $this->getId();
        }
        ilLPStatusWrapper::_updateStatus($node_obj_id, $usr_id);
    }

    public function markAccredited(
        int $assignment_id,
        int $acting_usr_id,
        ilPRGMessageCollection $err_collection
    ): void {
        $progress_node_id = $this->getId();
        $assignment = $this->assignment_repository->get($assignment_id)
            ->markAccredited(
                $this->getSettingsRepository(),
                $this->events,
                $progress_node_id,
                $acting_usr_id,
                $err_collection
            );

        $this->assignment_repository->store($assignment);
    }

    public function unmarkAccredited(
        int $assignment_id,
        int $acting_usr_id,
        ilPRGMessageCollection $err_collection
    ): void {
        $progress_node_id = $this->getId();
        $assignment = $this->assignment_repository->get($assignment_id)
            ->unmarkAccredited(
                $this->getSettingsRepository(),
                $progress_node_id,
                $acting_usr_id,
                $err_collection
            );

        $this->assignment_repository->store($assignment);
        $this->refreshLPStatus($assignment->getUserId());
    }

    public function markNotRelevant(
        int $assignment_id,
        int $acting_usr_id,
        ilPRGMessageCollection $err_collection
    ): void {
        $progress_node_id = $this->getId();
        $assignment = $this->assignment_repository->get($assignment_id)
            ->markNotRelevant(
                $this->getSettingsRepository(),
                $progress_node_id,
                $acting_usr_id,
                $err_collection
            );

        $this->assignment_repository->store($assignment);
        $this->refreshLPStatus($assignment->getUserId());
    }

    public function markRelevant(
        int $assignment_id,
        int $acting_usr_id,
        ilPRGMessageCollection $err_collection
    ): void {
        $progress_node_id = $this->getId();
        $assignment = $this->assignment_repository->get($assignment_id)
            ->markRelevant(
                $this->getSettingsRepository(),
                $progress_node_id,
                $acting_usr_id,
                $err_collection
            );

        $this->assignment_repository->store($assignment);
        $this->refreshLPStatus($assignment->getUserId());
    }

    public function changeProgressDeadline(
        int $assignment_id,
        int $acting_usr_id,
        ilPRGMessageCollection $err_collection,
        ?DateTimeImmutable $deadline
    ): void {
        $progress_node_id = $this->getId();
        $assignment = $this->assignment_repository->get($assignment_id)
            ->changeProgressDeadline(
                $this->getSettingsRepository(),
                $progress_node_id,
                $acting_usr_id,
                $err_collection,
                $deadline
            );

        $this->assignment_repository->store($assignment);
        $this->refreshLPStatus($assignment->getUserId());
    }

    public function changeProgressValidityDate(
        int $assignment_id,
        int $acting_usr_id,
        ilPRGMessageCollection $err_collection,
        ?DateTimeImmutable $validity
    ): void {
        $progress_node_id = $this->getId();
        $assignment = $this->assignment_repository->get($assignment_id)
            ->changeProgressValidityDate(
                $this->getSettingsRepository(),
                $progress_node_id,
                $acting_usr_id,
                $err_collection,
                $validity
            );

        $this->assignment_repository->store($assignment);
        $this->refreshLPStatus($assignment->getUserId());
    }

    public function changeAmountOfPoints(
        int $assignment_id,
        int $acting_usr_id,
        ilPRGMessageCollection $err_collection,
        int $points
    ): void {
        $progress_node_id = $this->getId();
        $assignment = $this->assignment_repository->get($assignment_id)
            ->changeAmountOfPoints(
                $this->getSettingsRepository(),
                $progress_node_id,
                $acting_usr_id,
                $err_collection,
                $points
            );

        $this->assignment_repository->store($assignment);
        $this->refreshLPStatus($assignment->getUserId());
    }

    public function updatePlanFromRepository(
        int $assignment_id,
        int $acting_usr_id,
        ilPRGMessageCollection $err_collection = null
    ): void {
        $assignment = $this->assignment_repository->get($assignment_id)
            ->updatePlanFromRepository(
                $this->getSettingsRepository(),
                $acting_usr_id,
                $err_collection
            );

        $this->assignment_repository->store($assignment);
        $this->refreshLPStatus($assignment->getUserId());
    }

    public function acknowledgeCourses(
        int $assignment_id,
        array $nodes,
        ilPRGMessageCollection $err_collection = null
    ): void {
        $acting_usr_id = $this->getLoggedInUserId();
        $assignment = $this->assignment_repository->get($assignment_id);
        foreach ($nodes as $nodeinfo) {
            [$node_obj_id, $course_obj_id] = $nodeinfo;

            $assignment = $assignment->succeed(
                $this->settings_repository,
                $node_obj_id,
                $course_obj_id
            );

            $msg = sprintf(
                '%s, progress-id (%s/%s)',
                $assignment->getUserInformation()->getFullname(),
                $assignment->getId(),
                (string) $node_obj_id
            );
            $err_collection->add(true, 'acknowledged_course', $msg);
        }
        $this->assignment_repository->store($assignment);
        $this->refreshLPStatus($assignment->getUserId());
    }

    public function canBeCompleted(ilPRGProgress $progress): bool
    {
        if ($this->getStatus() === ilStudyProgrammeSettings::STATUS_DRAFT) {
            return false;
        }
        if ($this->getLPMode() == ilStudyProgrammeSettings::MODE_LP_COMPLETED) {
            return true;
        }
        $possible_points = $progress->getPossiblePointsOfRelevantChildren();
        return $possible_points >= $progress->getAmountOfPoints();
    }

    public function statusToRepr(int $status): string
    {
        $lng = $this->lng;
        $lng->loadLanguageModule("prg");
        if ($status === ilPRGProgress::STATUS_IN_PROGRESS) {
            return $lng->txt("prg_status_in_progress");
        }
        if ($status === ilPRGProgress::STATUS_COMPLETED) {
            return $lng->txt("prg_status_completed");
        }
        if ($status === ilPRGProgress::STATUS_ACCREDITED) {
            return $lng->txt("prg_status_accredited");
        }
        if ($status === ilPRGProgress::STATUS_NOT_RELEVANT) {
            return $lng->txt("prg_status_not_relevant");
        }
        if ($status === ilPRGProgress::STATUS_FAILED) {
            return $lng->txt("prg_status_failed");
        }
        throw new ilException("Unknown status: '$status'");
    }

    public function hasContentPage(): bool
    {
        return \ilContainerPage::_exists(self::CP_TYPE, $this->getId());
    }
    public function createContentPage(): void
    {
        if ($this->hasContentPage()) {
            throw new \LogicException('will not create content page - it already exists.');
        }
        $new_page_object = new \ilContainerPage();
        $new_page_object->setId($this->getId());
        $new_page_object->setParentId($this->getId());
        $new_page_object->createFromXML();
    }
}