class.ilECSParticipantSetting.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
class ilECSParticipantSetting
{
    public const AUTH_VERSION_4 = 1;
    public const AUTH_VERSION_5 = 2;
 
    public const PERSON_EPPN = 1;
    public const PERSON_LUID = 2;
    public const PERSON_LOGIN = 3;
    public const PERSON_UID = 4;
 
    public const LOGIN_PLACEHOLDER = '[LOGIN]';
    public const EXTERNAL_ACCOUNT_PLACEHOLDER = '[EXTERNAL_ACCOUNT]';
 
    public const INCOMING_AUTH_TYPE_INACTIVE = 0;
    public const INCOMING_AUTH_TYPE_LOGIN_PAGE = 1;
    public const INCOMING_AUTH_TYPE_SHIBBOLETH = 2;
 
    public const OUTGOING_AUTH_MODE_DEFAULT = 'default';
 
    public const VALIDATION_OK = 0;
    public const ERR_MISSING_USERNAME_PLACEHOLDER = 1;
 
 
    protected static array $instances = [];
 
 
    // :TODO: what types are needed?
    public const IMPORT_UNCHANGED = 0;
    public const IMPORT_RCRS = 1;
    public const IMPORT_CRS = 2;
    public const IMPORT_CMS = 3;
 
    private int $server_id;
    private int $mid;
    private bool $export = false;
    private bool $import = false;
    private int $import_type = 1;
    private string $title = '';
    private string $cname = '';
    private bool $token = true;
    private bool $dtoken = true;
 
    private int $auth_version = self::AUTH_VERSION_4;
    private int $person_type = self::PERSON_UID;
 
 
    private array $export_types = array();
    private array $import_types = array();
    private array $username_placeholders = [];
    private bool $incoming_local_accounts = true;
    private int $incoming_auth_type = self::INCOMING_AUTH_TYPE_INACTIVE;
    private array $outgoing_auth_modes = [];
 
    private bool $exists = false;
 
    private ilDBInterface $db;
 
    public function __construct(int $a_server_id, int $mid)
    {
        global $DIC;
 
        $this->db = $DIC->database();
 
        $this->server_id = $a_server_id;
        $this->mid = $mid;
        $this->read();
    }
 
    public static function getInstance(int $a_server_id, int $mid): ilECSParticipantSetting
    {
        if (!isset(self::$instances[$a_server_id . '_' . $mid])) {
            return self::$instances[$a_server_id . '_' . $mid] = new self($a_server_id, $mid);
        }
        return self::$instances[$a_server_id . '_' . $mid];
    }
 
 
    public function getServerId(): int
    {
        return $this->server_id;
    }
 
    public function setMid(int $a_mid): void
    {
        $this->mid = $a_mid;
    }
 
    public function getMid(): int
    {
        return $this->mid;
    }
 
    public function enableExport(bool $a_status): void
    {
        $this->export = $a_status;
    }
 
    public function isExportEnabled(): bool
    {
        return $this->export;
    }
 
    public function enableImport(bool $a_status): void
    {
        $this->import = $a_status;
    }
 
    public function isImportEnabled(): bool
    {
        return $this->import;
    }
 
    public function setImportType(int $a_type): void
    {
        if ($a_type !== self::IMPORT_UNCHANGED) {
            $this->import_type = $a_type;
        }
    }
 
    public function getImportType(): int
    {
        return $this->import_type;
    }
 
    public function setTitle(string $a_title): void
    {
        $this->title = $a_title;
    }
 
    public function getTitle(): string
    {
        return $this->title;
    }
 
    public function getCommunityName(): string
    {
        return $this->cname;
    }
 
    public function setCommunityName(string $a_name): void
    {
        $this->cname = $a_name;
    }
 
    public function isTokenEnabled(): bool
    {
        return $this->token;
    }
 
    public function enableToken(bool $a_stat): void
    {
        $this->token = $a_stat;
    }
 
    public function setExportTypes(array $a_types): void
    {
        $this->export_types = $a_types;
    }
 
    public function getExportTypes(): array
    {
        return $this->export_types;
    }
 
    public function getOutgoingUsernamePlaceholders(): array
    {
        return $this->username_placeholders;
    }
 
    public function setOutgoingUsernamePlaceholders(array $a_username_placeholders): void
    {
        $this->username_placeholders = $a_username_placeholders;
    }
 
    public function getOutgoingUsernamePlaceholderByAuthMode(string $auth_mode): string
    {
        return $this->getOutgoingUsernamePlaceholders()[$auth_mode] ?? '';
    }
 
    public function areIncomingLocalAccountsSupported(): bool
    {
        return $this->incoming_local_accounts;
    }
 
    public function enableIncomingLocalAccounts(bool $a_status): void
    {
        $this->incoming_local_accounts = $a_status;
    }
 
    public function setIncomingAuthType(int $incoming_auth_type): void
    {
        $this->incoming_auth_type = $incoming_auth_type;
    }
 
    public function getIncomingAuthType(): int
    {
        return $this->incoming_auth_type;
    }
 
    public function setOutgoingAuthModes(array $auth_modes): void
    {
        $this->outgoing_auth_modes = $auth_modes;
    }
 
    public function getOutgoingAuthModes(): array
    {
        return $this->outgoing_auth_modes;
    }
 
    public function getOutgoingExternalAuthModes(): array
    {
        return array_filter(
            $this->getOutgoingAuthModes(),
            static function (string $auth_mode): bool {
                return $auth_mode !== self::OUTGOING_AUTH_MODE_DEFAULT;
            }
        );
    }
 
    public function isOutgoingAuthModeEnabled(string $auth_mode): bool
    {
        return (bool) ($this->getOutgoingAuthModes()[$auth_mode] ?? false);
    }
 
 
    public function setImportTypes(array $a_types): void
    {
        $this->import_types = $a_types;
    }
 
    public function getImportTypes(): array
    {
        return $this->import_types;
    }
 
    private function exists(): bool
    {
        return $this->exists;
    }
 
    public function validate(): int
    {
        foreach ($this->getOutgoingAuthModes() as $auth_mode) {
            if ($auth_mode === self::OUTGOING_AUTH_MODE_DEFAULT) {
                continue;
            }
            $placeholder = $this->getOutgoingUsernamePlaceholderByAuthMode($auth_mode);
            if (
                !stristr($placeholder, self::LOGIN_PLACEHOLDER) &&
                !stristr($placeholder, self::EXTERNAL_ACCOUNT_PLACEHOLDER)
            ) {
                return self::ERR_MISSING_USERNAME_PLACEHOLDER;
            }
        }
        return self::VALIDATION_OK;
    }
 
    public function update(): bool
    {
        if (!$this->exists()) {
            return $this->create();
        }
        $query = 'UPDATE ecs_part_settings ' .
            'SET ' .
            'sid = ' . $this->db->quote($this->getServerId(), 'integer') . ', ' .
            'mid = ' . $this->db->quote($this->getMid(), 'integer') . ', ' .
            'export = ' . $this->db->quote((int) $this->isExportEnabled(), 'integer') . ', ' .
            'import = ' . $this->db->quote((int) $this->isImportEnabled(), 'integer') . ', ' .
            'import_type = ' . $this->db->quote($this->getImportType(), 'integer') . ', ' .
            'title = ' . $this->db->quote($this->getTitle(), 'text') . ', ' .
            'cname = ' . $this->db->quote($this->getCommunityName(), 'text') . ', ' .
            'token = ' . $this->db->quote($this->isTokenEnabled(), 'integer') . ', ' .
            'export_types = ' . $this->db->quote(serialize($this->getExportTypes()), 'text') . ', ' .
            'import_types = ' . $this->db->quote(serialize($this->getImportTypes()), ilDBConstants::T_TEXT) . ', ' .
            'username_placeholders = ' . $this->db->quote(serialize($this->getOutgoingUsernamePlaceholders()), ilDBConstants::T_TEXT) . ', ' .
            'incoming_local_accounts = ' . $this->db->quote($this->areIncomingLocalAccountsSupported(), ilDBConstants::T_INTEGER) . ', ' .
            'incoming_auth_type = ' . $this->db->quote($this->getIncomingAuthType(), ilDBConstants::T_INTEGER) . ', ' .
            'outgoing_auth_modes = ' . $this->db->quote(serialize($this->getOutgoingAuthModes()), ilDBConstants::T_TEXT) . ' ' .
            'WHERE sid = ' . $this->db->quote($this->getServerId(), 'integer') . ' ' .
            'AND mid  = ' . $this->db->quote($this->getMid(), 'integer');
        $this->db->manipulate($query);
        return true;
    }
 
    private function create(): bool
    {
        $query = 'INSERT INTO ecs_part_settings ' .
            '(sid,mid,export,import,import_type,title,cname,token,export_types, import_types, username_placeholders, incoming_auth_type, incoming_local_accounts, outgoing_auth_modes) ' .
            'VALUES( ' .
            $this->db->quote($this->getServerId(), 'integer') . ', ' .
            $this->db->quote($this->getMid(), 'integer') . ', ' .
            $this->db->quote((int) $this->isExportEnabled(), 'integer') . ', ' .
            $this->db->quote((int) $this->isImportEnabled(), 'integer') . ', ' .
            $this->db->quote($this->getImportType(), 'integer') . ', ' .
            $this->db->quote($this->getTitle(), 'text') . ', ' .
            $this->db->quote($this->getCommunityName(), 'text') . ', ' .
            $this->db->quote($this->isTokenEnabled(), 'integer') . ', ' .
            $this->db->quote(serialize($this->getExportTypes()), 'text') . ', ' .
            $this->db->quote(serialize($this->getImportTypes()), 'text') . ', ' .
            $this->db->quote(serialize($this->getOutgoingUsernamePlaceholders()), ilDBConstants::T_TEXT) . ', ' .
            $this->db->quote($this->areIncomingLocalAccountsSupported(), ilDBConstants::T_INTEGER) . ', ' .
            $this->db->quote($this->getIncomingAuthType(), ilDBConstants::T_INTEGER) . ', ' .
            $this->db->quote(serialize($this->getOutgoingAuthModes()), ilDBConstants::T_TEXT) . ' ' .
            ')';
        $this->db->manipulate($query);
        return true;
    }
 
    public function delete(): bool
    {
        $query = 'DELETE FROM ecs_part_settings ' .
            'WHERE sid = ' . $this->db->quote($this->getServerId(), 'integer') . ' ' .
            'AND mid = ' . $this->db->quote($this->getMid(), 'integer');
        $this->db->manipulate($query);
        return true;
    }
 
    private function read(): void
    {
        $query = 'SELECT * FROM ecs_part_settings ' .
            'WHERE sid = ' . $this->db->quote($this->getServerId(), 'integer') . ' ' .
            'AND mid = ' . $this->db->quote($this->getMid(), 'integer');
 
        $res = $this->db->query($query);
 
        $this->exists = ($res->numRows() ? true : false);
 
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->enableExport((bool) $row->export);
            $this->enableImport((bool) $row->import);
            $this->setImportType((int) $row->import_type);
            $this->setTitle($row->title);
            $this->setCommunityName($row->cname);
            $this->enableToken((bool) $row->token);
            $this->setExportTypes((array) unserialize($row->export_types, ['allowed_classes' => true]));
            $this->setImportTypes((array) unserialize($row->import_types, ['allowed_classes' => true]));
            $this->setOutgoingUsernamePlaceholders((array) unserialize((string) $row->username_placeholders, ['allowed_classes' => true]));
            $this->setIncomingAuthType((int) $row->incoming_auth_type);
            $this->enableIncomingLocalAccounts((bool) $row->incoming_local_accounts);
            $this->setOutgoingAuthModes((array) unserialize((string) $row->outgoing_auth_modes, ['allowed_classes' => true]));
        }
    }
}