class.ilECSCourseMappingRule.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilECSCourseMappingRule
{
    public const SUBDIR_ATTRIBUTE_NAME = 1;
    public const SUBDIR_VALUE = 2;

    private ilLogger $logger;
    private ilTree $tree;
    private ilLanguage $lng;
    private ilDBInterface $db;

    private int $rid;
    private int $sid;
    private int $mid;
    private string $attribute;
    private int $ref_id;
    private bool $is_filter = false;
    private string $filter = "";
    private array $filter_elements = [];
    private bool $create_subdir = true;
    private string $directory = '';

    public function __construct(int $a_rid = 0)
    {
        global $DIC;

        $this->logger = $DIC->logger()->wsrv();
        $this->tree = $DIC->repositoryTree();
        $this->lng = $DIC->language();
        $this->db = $DIC->database();

        $this->rid = $a_rid;
        $this->read();
    }

    public static function lookupLastExistingAttribute(int $a_sid, int $a_mid, int $a_ref_id): string
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $query = 'SELECT attribute FROM ecs_cmap_rule ' .
                'WHERE sid = ' . $ilDB->quote($a_sid, 'integer') . ' ' .
                'AND mid = ' . $ilDB->quote($a_mid, 'integer') . ' ' .
                'AND ref_id = ' . $ilDB->quote($a_ref_id, 'integer') . ' ' .
                'ORDER BY rid ';
        $res = $ilDB->query($query);

        $attributes = '';
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $attributes = $row->attribute;
        }
        return $attributes;
    }

    public static function getRuleRefIds(int $a_sid, int $a_mid): array
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $query = 'SELECT DISTINCT(ref_id) ref_id, rid FROM ecs_cmap_rule ' .
                'WHERE sid = ' . $ilDB->quote($a_sid, 'integer') . ' ' .
                'AND mid = ' . $ilDB->quote($a_mid, 'integer') . ' ' .
                'GROUP BY ref_id' . ' ' .
                'ORDER BY rid';

        $res = $ilDB->query($query);
        $ref_ids = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $ref_ids[] = (int) $row->ref_id;
        }
        // check if ref_ids are in tree
        $checked_ref_ids = [];
        foreach ($ref_ids as $ref_id) {
            if (
                $DIC->repositoryTree()->isInTree($ref_id)) {
                $checked_ref_ids[] = $ref_id;
            }
        }
        return $checked_ref_ids;
    }

    public static function getRulesOfRefId(int $a_sid, int $a_mid, int $a_ref_id): array
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $query = 'SELECT rid FROM ecs_cmap_rule ' .
                'WHERE sid = ' . $ilDB->quote($a_sid, 'integer') . ' ' .
                'AND mid = ' . $ilDB->quote($a_mid, 'integer') . ' ' .
                'AND ref_id = ' . $ilDB->quote($a_ref_id, 'integer');
        $res = $ilDB->query($query);
        $rids = [];
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $rids = $row->rid;
        }
        return $rids;
    }

    public static function hasRules(int $a_sid, int $a_mid, int $a_ref_id): bool
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $query = 'SELECT ref_id FROM ecs_cmap_rule ' .
                'WHERE sid = ' . $ilDB->quote($a_sid, 'integer') . ' ' .
                'AND mid = ' . $ilDB->quote($a_mid, 'integer') . ' ' .
                'AND ref_id = ' . $ilDB->quote($a_ref_id, 'integer');
        $res = $ilDB->query($query);
        return $res->numRows() ? true : false;
    }

    public static function isMatching($course, int $a_sid, int $a_mid, int $a_ref_id): string
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $query = 'SELECT rid FROM ecs_cmap_rule ' .
                'WHERE sid = ' . $ilDB->quote($a_sid, 'integer') . ' ' .
                'AND mid = ' . $ilDB->quote($a_mid, 'integer') . ' ' .
                'AND ref_id = ' . $ilDB->quote($a_ref_id, 'integer') . ' ' .
                'ORDER BY rid';
        $res = $ilDB->query($query);

        $does_match = false;
        $sortable_index = '';
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $rule = new ilECSCourseMappingRule((int) $row->rid);
            $matches = $rule->matches($course);
            if ($matches === -1) {
                return '0';
            }
            $does_match = true;
            $sortable_index .= str_pad((string) $matches, 4, '0', STR_PAD_LEFT);
        }
        if ($does_match) {
            return $sortable_index;
        }
        return "0";
    }

    public static function doMappings($course, int $a_sid, int $a_mid, int $a_ref_id): array
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $query = 'SELECT rid FROM ecs_cmap_rule ' .
                'WHERE sid = ' . $ilDB->quote($a_sid, 'integer') . ' ' .
                'AND mid = ' . $ilDB->quote($a_mid, 'integer') . ' ' .
                'AND ref_id = ' . $ilDB->quote($a_ref_id, 'integer') . ' ' .
                'ORDER BY rid';
        $res = $ilDB->query($query);

        $level = 1;
        $last_level_category = [];
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $rule = new ilECSCourseMappingRule((int) $row->rid);
            if ($level === 1) {
                $last_level_category[] = $rule->getRefId();
            }

            $found_new_level = false;
            $new_level_cats = [];
            foreach ($last_level_category as $cat_ref_id) {
                $refs = $rule->doMapping($course, (int) $cat_ref_id);
                foreach ($refs as $new_ref_id) {
                    $found_new_level = true;
                    $new_level_cats[] = $new_ref_id;
                }
            }
            if ($found_new_level) {
                $last_level_category = $new_level_cats;
            }
            $level++;
        }

        return $last_level_category;
    }

    public function doMapping($course, int $parent_ref): array
    {
        if (!$this->isSubdirCreationEnabled()) {
            return [];
        }
        $values = ilECSMappingUtils::getCourseValueByMappingAttribute($course, $this->getAttribute());

        $children = $this->tree->getChildsByType($parent_ref, 'cat');
        $category_references = [];
        foreach ($values as $value) {
            $found = false;
            foreach ($children as $child) {
                // category already created
                if (strcmp($child['title'], $value) === 0) {
                    $found = true;
                    $category_references[] = (int) $child['child'];
                    break;
                }
            }
            if (!$found) {
                $category_references[] = $this->createCategory($value, $parent_ref);
            }
        }
        return $category_references;
    }

    protected function createCategory($a_title, $a_parent_ref): int
    {
        // Create category
        $cat = new ilObjCategory();
        $cat->setOwner(SYSTEM_USER_ID);
        $cat->setTitle($a_title);
        $cat->create();
        $cat->createReference();
        $cat->putInTree($a_parent_ref);
        $cat->setPermissions($a_parent_ref);
        $cat->deleteTranslation($this->lng->getDefaultLanguage());
        $cat->addTranslation(
            $a_title,
            $cat->getLongDescription(),
            $this->lng->getDefaultLanguage(),
            $this->lng->getDefaultLanguage()
        );
        return $cat->getRefId();
    }


    private function matches($course): int
    {
        if ($this->isFilterEnabled()) {
            $values = ilECSMappingUtils::getCourseValueByMappingAttribute($course, $this->getAttribute());
            $index = 0;
            foreach ($values as $value) {
                $index++;
                foreach ($this->getFilterElements() as $filter_element) {
                    $this->logger->debug('Comparing ' . $value . ' with ' . $filter_element);
                    if (strcmp(trim($value), trim($filter_element)) === 0) {
                        $this->logger->debug($value . ' matches ' . $filter_element);
                        $this->logger->debug('Found index: ' . $index);
                        return $index;
                    }
                }
            }
            return -1;
        }
        return 0;
    }


    public static function getInstanceByAttribute($a_sid, $a_mid, $a_ref_id, $a_att): \ilECSCourseMappingRule
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $query = 'SELECT rid FROM ecs_cmap_rule ' .
                'WHERE sid = ' . $ilDB->quote($a_sid, 'integer') . ' ' .
                'AND mid = ' . $ilDB->quote($a_mid, 'integer') . ' ' .
                'AND ref_id = ' . $ilDB->quote($a_ref_id, 'integer') . ' ' .
                'AND attribute = ' . $ilDB->quote($a_att, 'text');

        $res = $ilDB->query($query);
        if ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return new ilECSCourseMappingRule((int) $row->rid);
        }
        return new ilECSCourseMappingRule();
    }

    public function setRuleId(int $a_rule_id): void
    {
        $this->rid = $a_rule_id;
    }

    public function getRuleId(): int
    {
        return $this->rid;
    }

    public function setServerId(int $a_server_id): void
    {
        $this->sid = $a_server_id;
    }

    public function getServerId(): int
    {
        return $this->sid;
    }

    public function setMid(int $a_mid): void
    {
        $this->mid = $a_mid;
    }

    public function getMid(): int
    {
        return $this->mid;
    }

    public function setAttribute(string $a_att): void
    {
        $this->attribute = $a_att;
    }

    public function getAttribute(): string
    {
        return $this->attribute;
    }

    public function setRefId(int $a_ref_id): void
    {
        $this->ref_id = $a_ref_id;
    }

    public function getRefId(): int
    {
        return $this->ref_id;
    }

    public function enableFilter(bool $a_status): void
    {
        $this->is_filter = $a_status;
    }

    public function isFilterEnabled(): bool
    {
        return $this->is_filter;
    }

    public function setFilter(string $a_filter): void
    {
        $this->filter = $a_filter;
    }

    public function getFilter(): string
    {
        return $this->filter;
    }

    public function getFilterElements(): array
    {
        return $this->filter_elements;
    }

    public function enableSubdirCreation(bool $a_stat): void
    {
        $this->create_subdir = $a_stat;
    }

    public function isSubdirCreationEnabled(): bool
    {
        return $this->create_subdir;
    }

    public function getSubDirectoryType(): int
    {
        return self::SUBDIR_VALUE;
    }

    public function setDirectory(string $a_dir): void
    {
        $this->directory = $a_dir;
    }

    public function getDirectory(): string
    {
        return $this->directory;
    }

    public function delete(): bool
    {
        $query = 'DELETE from ecs_cmap_rule ' .
            'WHERE rid = ' . $this->db->quote($this->getRuleId(), 'integer');
        $this->db->manipulate($query);
        return true;
    }

    public function save(): int
    {
        $this->setRuleId($this->db->nextId('ecs_cmap_rule'));
        $query = 'INSERT INTO ecs_cmap_rule ' .
                '(rid,sid,mid,attribute,ref_id,is_filter,filter,create_subdir,subdir_type,directory) ' .
                'VALUES (' .
                $this->db->quote($this->getRuleId(), 'integer') . ', ' .
                $this->db->quote($this->getServerId(), 'integer') . ', ' .
                $this->db->quote($this->getMid(), 'integer') . ', ' .
                $this->db->quote($this->getAttribute(), 'text') . ', ' .
                $this->db->quote($this->getRefId(), 'integer') . ', ' .
                $this->db->quote($this->isFilterEnabled(), 'integer') . ', ' .
                $this->db->quote($this->getFilter(), 'text') . ', ' .
                $this->db->quote($this->isSubdirCreationEnabled(), 'integer') . ', ' .
                $this->db->quote($this->getSubDirectoryType(), 'integer') . ', ' .
                $this->db->quote($this->getDirectory(), 'text') . ' ' .
                ')';
        $this->db->manipulate($query);
        return $this->getRuleId();
    }

    public function update(): void
    {
        $query = 'UPDATE ecs_cmap_rule ' . ' ' .
                'SET ' .
                'attribute = ' . $this->db->quote($this->getAttribute(), 'text') . ', ' .
                'ref_id = ' . $this->db->quote($this->getRefId(), 'integer') . ', ' .
                'is_filter = ' . $this->db->quote($this->isFilterEnabled(), 'integer') . ', ' .
                'filter = ' . $this->db->quote($this->getFilter(), 'text') . ', ' .
                'create_subdir = ' . $this->db->quote($this->isSubdirCreationEnabled(), 'integer') . ', ' .
                'subdir_type = ' . $this->db->quote($this->getSubDirectoryType(), 'integer') . ', ' .
                'directory = ' . $this->db->quote($this->getDirectory(), 'text') . ' ' .
                'WHERE rid = ' . $this->db->quote($this->getRuleId(), 'integer');
        $this->db->manipulate($query);
    }

    protected function read(): void
    {
        if (!$this->getRuleId()) {
            return;
        }
        $query = 'SELECT * from ecs_cmap_rule ' . ' ' .
            'WHERE rid = ' . $this->db->quote($this->getRuleId(), 'integer');
        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->setServerId((int) $row->sid);
            $this->setMid((int) $row->mid);
            $this->setRefId((int) $row->ref_id);
            $this->setAttribute($row->attribute);
            $this->enableFilter((bool) $row->is_filter);
            $this->setFilter($row->filter);
            $this->enableSubdirCreation((bool) $row->create_subdir);
            //TODO create database update step to remove unneed variable
            $this->setDirectory($row->directory);
        }

        $this->parseFilter();
    }

    protected function parseFilter(): void
    {
        $filter = $this->getFilter();
        //$this->logger->debug('Original filter: ' . $filter);

        $escaped_filter = str_replace('\,', '#:#', $filter);
        //$this->logger->debug('Escaped filter: ' . $escaped_filter);

        $filter_elements = explode(',', $escaped_filter);
        foreach ((array) $filter_elements as $filter_element) {
            $replaced = str_replace('#:#', ',', $filter_element);
            if (trim($replaced) !== '') {
                $this->filter_elements[] = $replaced;
            }
        }
        //$this->logger->dump($this->filter_elements);
    }
}