class.ilLDAPAttributeMapping.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilLDAPAttributeMapping
{
    private static array $instances = [];
    private int $server_id;
    private ilDBInterface $db;

    private array $mapping_rules = [];
    private array $rules_for_update = [];

    private function __construct(int $a_server_id)
    {
        global $DIC;

        $this->db = $DIC->database();

        $this->server_id = $a_server_id;
        $this->read();
    }

    public static function _getInstanceByServerId(int $a_server_id): ilLDAPAttributeMapping
    {
        if (array_key_exists($a_server_id, self::$instances) && is_object(self::$instances[$a_server_id])) {
            return self::$instances[$a_server_id];
        }

        return self::$instances[$a_server_id] = new ilLDAPAttributeMapping($a_server_id);
    }

    public static function _delete(int $a_server_id): void
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $query = "DELETE FROM ldap_attribute_mapping " .
            "WHERE server_id =" . $ilDB->quote($a_server_id, 'integer');
        $ilDB->manipulate($query);
    }

    public static function _lookupGlobalRole(int $a_server_id): int
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $query = "SELECT value FROM ldap_attribute_mapping " .
            "WHERE server_id =" . $ilDB->quote($a_server_id, 'integer') . " " .
            "AND keyword = " . $ilDB->quote('global_role', 'text');

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

        return 0;
    }

    public static function hasRulesForUpdate(int $a_server_id): bool
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $query = 'SELECT perform_update FROM ldap_attribute_mapping ' .
            'WHERE server_id = ' . $ilDB->quote($a_server_id, 'integer') . ' ' .
            'AND perform_update = 1';
        $res = $ilDB->query($query);
        return $res->numRows() > 0;
    }

    public function setRule(string $a_field_name, string $a_ldap_attribute, bool $a_perform_update): void
    {
        $this->mapping_rules[$a_field_name]['value'] = $a_ldap_attribute;
        $this->mapping_rules[$a_field_name]['performUpdate'] = $a_perform_update;
    }

    public function getRulesForUpdate(): array
    {
        return $this->rules_for_update;
    }

    public function getFieldsForUpdate(): array
    {
        return self::getMappedFields($this->rules_for_update);
    }

    public function getFields(): array
    {
        return self::getMappedFields($this->mapping_rules);
    }

    private static function getMappedFields(array $rules): array
    {
        $fields = [];
        foreach ($rules as $rule) {
            if (!$rule['value']) {
                continue;
            }
            if (strpos($rule['value'], ',') === false) {
                $fields[] = strtolower($rule['value']);
                continue;
            }
            $tmp_fields = explode(',', $rule['value']);
            foreach ($tmp_fields as $tmp_field) {
                $fields[] = strtolower(trim($tmp_field));
            }
        }
        return $fields;
    }

    public function getRules(bool $onlyApplicable = false): array
    {
        if (!$onlyApplicable) {
            return $this->mapping_rules;
        }
        return array_filter($this->mapping_rules, static function (array $rule): bool {
            return $rule['value'] !== '';
        });
    }

    public function clearRules(): void
    {
        $this->mapping_rules = array();
    }

    public function save(): void
    {
        $this->delete();

        foreach ($this->mapping_rules as $keyword => $options) {
            $query = "INSERT INTO ldap_attribute_mapping (server_id,keyword,value,perform_update) " .
                "VALUES( " .
                $this->db->quote($this->server_id, 'integer') . ", " .
                $this->db->quote($keyword, 'text') . ", " .
                $this->db->quote($options['value'], 'text') . ", " .
                $this->db->quote($options['performUpdate'], 'integer') .
                ')';
            $this->db->manipulate($query);
        }
    }

    public function delete(): void
    {
        self::_delete($this->server_id);
    }

    public function enabledUpdate(string $a_field_name): bool
    {
        if (array_key_exists($a_field_name, $this->mapping_rules)) {
            return (bool) $this->mapping_rules[$a_field_name]['performUpdate'];
        }

        return false;
    }

    public function getValue(string $a_field_name): string
    {
        if (array_key_exists($a_field_name, $this->mapping_rules)) {
            return $this->mapping_rules[$a_field_name]['value'];
        }

        return '';
    }

    private function read(): void
    {
        $query = "SELECT * FROM ldap_attribute_mapping " .
            "WHERE server_id =" . $this->db->quote($this->server_id, 'integer');

        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            if (!is_null($row->value)) {
                $this->mapping_rules[$row->keyword]['value'] = $row->value;
                $this->mapping_rules[$row->keyword]['performUpdate'] = (bool) $row->perform_update;

                if ($row->perform_update) {
                    $this->rules_for_update[$row->keyword]['value'] = $row->value;
                }
            }
        }
    }
}