class.ilECSSetting.php

Go to the documentation of this file.

<?php
/*
    +-----------------------------------------------------------------------------+
    | ILIAS open source                                                           |
    +-----------------------------------------------------------------------------+
    | Copyright (c) 1998-2006 ILIAS open source, University of Cologne            |
    |                                                                             |
    | This program is free software; you can redistribute it and/or               |
    | modify it under the terms of the GNU General Public License                 |
    | as published by the Free Software Foundation; either version 2              |
    | of the License, or (at your option) any later version.                      |
    |                                                                             |
    | This program is distributed in the hope that it will be useful,             |
    | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
    | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
    | GNU General Public License for more details.                                |
    |                                                                             |
    | You should have received a copy of the GNU General Public License           |
    | along with this program; if not, write to the Free Software                 |
    | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
    +-----------------------------------------------------------------------------+
*/

class ilECSSetting
{
    const DEFAULT_AUTH_MODE = 'ldap';
    
    const ERROR_EXTRACT_SERIAL = 'ecs_error_extract_serial';
    const ERROR_REQUIRED = 'fill_out_all_required_fields';
    const ERROR_INVALID_IMPORT_ID = 'ecs_check_import_id';
    const ERROR_CERT_EXPIRED = 'ecs_certificate_expired';

    const AUTH_CERTIFICATE = 1;
    const AUTH_APACHE = 2;
    
    const DEFAULT_DURATION = 6;
    
    
    const PROTOCOL_HTTP = 0;
    const PROTOCOL_HTTPS = 1;
    
    protected static $instances = null;
    protected static $configured;


    private $server_id = 0;
    private $active = false;
    private $title = '';
    private $auth_type = self::AUTH_CERTIFICATE;
    private $server;
    private $protocol;
    private $port;
    private $client_cert_path;
    private $ca_cert_path;
    private $key_path;
    private $key_password;
    private $polling;
    private $import_id;
    private $cert_serial;
    private $global_role;
    private $duration;

    private $auth_user = '';
    private $auth_pass = '';
    
    private $user_recipients = array();
    private $econtent_recipients = array();
    private $approval_recipients = array();
    
    private function __construct($a_server_id = 0)
    {
        $this->server_id = $a_server_id;
        $this->read();
    }
    
    public static function _getInstance()
    {
        $GLOBALS['DIC']->logger()->wsrv()->warning('Using deprecated call');
        $GLOBALS['DIC']->logger()->wsrv()->logStack(ilLogLevel::WARNING);
        return self::getInstanceByServerId(null);
    }

    public static function getInstanceByServerId($a_server_id)
    {
        if (self::$instances[$a_server_id]) {
            return self::$instances[$a_server_id];
        }
        return self::$instances[$a_server_id] = new ilECSSetting($a_server_id);
    }
    
    public static function lookupAuthMode()
    {
        return self::DEFAULT_AUTH_MODE;
    }

    public static function ecsConfigured()
    {
        if (self::$configured === null) {
            global $DIC;
            $ilDB = $DIC->database();

            $query = "SELECT count(*) count FROM ecs_server";
            $ret = $ilDB->query($query);
            $c = $ret->fetchObject()->count;

            self::$configured = $c > 0;
        }
        return self::$configured;
    }

    public function setTitle($a_title)
    {
        $this->title = $a_title;
    }

    public function getTitle()
    {
        return $this->title;
    }

    public function setAuthType($a_auth_type)
    {
        $this->auth_type = $a_auth_type;
    }

    public function getAuthType()
    {
        return $this->auth_type;
    }

    public function setAuthUser($a_user)
    {
        $this->auth_user = $a_user;
    }

    public function getAuthUser()
    {
        return $this->auth_user;
    }

    public function setAuthPass($a_pass)
    {
        $this->auth_pass = $a_pass;
    }

    public function getAuthPass()
    {
        return $this->auth_pass;
    }

    public function getServerId()
    {
        return (int) $this->server_id;
    }
    
    public function setEnabledStatus($a_status)
    {
        $this->active = $a_status;
    }
    
    public function isEnabled()
    {
        return $this->active;
    }
    
    public function setServer($a_server)
    {
        $this->server = $a_server;
    }
    
    public function getServer()
    {
        return $this->server;
    }
    
    public function getServerURI()
    {
        switch ($this->getProtocol()) {
            case self::PROTOCOL_HTTP:
                $uri = 'http://';
                break;
                
            case self::PROTOCOL_HTTPS:
                $uri = 'https://';
                break;
        }

        if (stristr($this->getServer(), '/')) {
            $counter = 0;
            foreach ((array) explode('/', $this->getServer()) as $key => $part) {
                $uri .= $part;
                if (!$counter) {
                    $uri .= ':' . $this->getPort();
                }
                $uri .= '/';
                ++$counter;
            }
            $uri = substr($uri, 0, -1);
        } else {
            $uri .= $this->getServer();
            $uri .= (':' . $this->getPort());
        }

        return $uri;
    }
    
    public function setProtocol($a_prot)
    {
        $this->protocol = $a_prot;
    }

    public function getProtocol()
    {
        return $this->protocol;
    }
    
    public function setPort($a_port)
    {
        $this->port = $a_port;
    }
    
    public function getPort()
    {
        return $this->port;
    }
    
    public function setPollingTime($a_time)
    {
        $this->polling = $a_time;
    }
    
    public function getPollingTime()
    {
        return $this->polling;
    }
    
    public function getPollingTimeSeconds()
    {
        return (int) ($this->polling % 60);
    }
    
    public function getPollingTimeMinutes()
    {
        return (int) ($this->polling / 60);
    }
    
    public function setPollingTimeMS($a_min, $a_sec)
    {
        $this->setPollingTime(60 * $a_min + $a_sec);
    }
    
    public function setClientCertPath($a_path)
    {
        $this->client_cert_path = $a_path;
    }

    public function getClientCertPath()
    {
        return $this->client_cert_path;
    }
    
    public function setCACertPath($a_ca)
    {
        $this->ca_cert_path = $a_ca;
    }
    
    public function getCACertPath()
    {
        return $this->ca_cert_path;
    }
    
    public function getKeyPath()
    {
        return $this->key_path;
    }
    
    public function setKeyPath($a_path)
    {
        $this->key_path = $a_path;
    }
    
    public function getKeyPassword()
    {
        return $this->key_password;
    }
    
    public function setKeyPassword($a_pass)
    {
        $this->key_password = $a_pass;
    }
    
    public function setImportId($a_id)
    {
        $this->import_id = $a_id;
    }
    
    public function getImportId()
    {
        return $this->import_id;
    }
    
    public function setCertSerialNumber($a_cert_serial)
    {
        $this->cert_serial_number = $a_cert_serial;
    }
    
    public function getCertSerialNumber()
    {
        return $this->cert_serial_number;
    }
    
    public function getGlobalRole()
    {
        return $this->global_role;
    }
    
    public function setGlobalRole($a_role_id)
    {
        $this->global_role = $a_role_id;
    }
    
    public function setDuration($a_duration)
    {
        $this->duration = $a_duration;
    }
    
    public function getDuration()
    {
        return $this->duration ? $this->duration : self::DEFAULT_DURATION;
    }
    
    public function getUserRecipients()
    {
        return explode(',', (string) $this->user_recipients);
    }
    
    public function getUserRecipientsAsString()
    {
        return $this->user_recipients ? $this->user_recipients : '';
    }
    
    public function setUserRecipients($a_logins)
    {
        $this->user_recipients = $a_logins;
    }
    
    public function getEContentRecipients()
    {
        return explode(',', $this->econtent_recipients);
    }
    
    public function getEContentRecipientsAsString()
    {
        return $this->econtent_recipients ? $this->econtent_recipients : '';
    }
    
    public function setEContentRecipients($a_logins)
    {
        $this->econtent_recipients = $a_logins;
    }
    
    public function getApprovalRecipients()
    {
        return explode(',', $this->approval_recipients);
    }
    
    public function getApprovalRecipientsAsString()
    {
        return $this->approval_recipients ? $this->approval_recipients : '';
    }
    
    public function setApprovalRecipients($a_rcp)
    {
        $this->approval_recipients = $a_rcp;
    }
    
    public function validate()
    {
        if (!$this->isEnabled()) {
            return '';
        }

        // Cert based authentication
        if ($this->getAuthType() == self::AUTH_CERTIFICATE) {
            if (!$this->getClientCertPath() or !$this->getCACertPath() or !$this->getKeyPath() or !$this->getKeyPassword()) {
                return self::ERROR_REQUIRED;
            }
            // Check import id
            if (!$this->fetchSerialID()) {
                return self::ERROR_EXTRACT_SERIAL;
            }
            if (!$this->fetchCertificateExpiration()) {
                return self::ERROR_CERT_EXPIRED;
            }
        }
        // Apache auth
        if ($this->getAuthType() == self::AUTH_APACHE) {
            if (!$this->getAuthUser() or !$this->getAuthPass()) {
                return self::ERROR_REQUIRED;
            }
        }

        // required fields
        if (!$this->getServer() or !$this->getPort() or !$this->getImportId()
            or !$this->getGlobalRole() or !$this->getDuration()) {
            return self::ERROR_REQUIRED;
        }
        
        if (!$this->checkImportId()) {
            return self::ERROR_INVALID_IMPORT_ID;
        }
        return '';
    }
    
    public function checkImportId()
    {
        global $DIC;

        $ilObjDataCache = $DIC['ilObjDataCache'];
        $tree = $DIC['tree'];
        
        if (!$this->getImportId()) {
            return false;
        }
        if ($ilObjDataCache->lookupType($ilObjDataCache->lookupObjId($this->getImportId())) != 'cat') {
            return false;
        }
        if ($tree->isDeleted($this->getImportId())) {
            return false;
        }
        return true;
    }
    
    public function save()
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $this->server_id = $ilDB->nextId('ecs_server');
        $ilDB->manipulate(
            $q = 'INSERT INTO ecs_server (server_id,active,title,protocol,server,port,auth_type,client_cert_path,ca_cert_path,' .
            'key_path,key_password,cert_serial,polling_time,import_id,global_role,econtent_rcp,user_rcp,approval_rcp,duration,auth_user,auth_pass) ' .
            'VALUES (' .
            $ilDB->quote($this->getServerId(), 'integer') . ', ' .
            $ilDB->quote((int) $this->isEnabled(), 'integer') . ', ' .
            $ilDB->quote($this->getTitle(), 'text') . ', ' .
            $ilDB->quote((int) $this->getProtocol(), 'integer') . ', ' .
            $ilDB->quote($this->getServer(), 'text') . ', ' .
            $ilDB->quote($this->getPort(), 'integer') . ', ' .
            $ilDB->quote($this->getAuthType(), 'integer') . ', ' .
            $ilDB->quote($this->getClientCertPath(), 'text') . ', ' .
            $ilDB->quote($this->getCACertPath(), 'text') . ', ' .
            $ilDB->quote($this->getKeyPath(), 'text') . ', ' .
            $ilDB->quote($this->getKeyPassword(), 'text') . ', ' .
            $ilDB->quote($this->getCertSerialNumber(), 'text') . ', ' .
            $ilDB->quote($this->getPollingTime(), 'integer') . ', ' .
            $ilDB->quote($this->getImportId(), 'integer') . ', ' .
            $ilDB->quote($this->getGlobalRole(), 'integer') . ', ' .
            $ilDB->quote($this->getEContentRecipientsAsString(), 'text') . ', ' .
            $ilDB->quote($this->getUserRecipientsAsString(), 'text') . ', ' .
            $ilDB->quote($this->getApprovalRecipientsAsString(), 'text') . ', ' .
            $ilDB->quote($this->getDuration(), 'integer') . ', ' .
            $ilDB->quote($this->getAuthUser(), 'text') . ', ' .
            $ilDB->quote($this->getAuthPass(), 'text') . ' ' .
            ')'
        );
    }

    public function update()
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $ilDB->manipulate(
            'UPDATE ecs_server SET ' .
            'server_id = ' . $ilDB->quote($this->getServerId(), 'integer') . ', ' .
            'active = ' . $ilDB->quote((int) $this->isEnabled(), 'integer') . ', ' .
            'title = ' . $ilDB->quote($this->getTitle(), 'text') . ', ' .
            'protocol = ' . $ilDB->quote((int) $this->getProtocol(), 'integer') . ', ' .
            'server = ' . $ilDB->quote($this->getServer(), 'text') . ', ' .
            'port = ' . $ilDB->quote($this->getPort(), 'integer') . ', ' .
            'auth_type = ' . $ilDB->quote($this->getAuthType(), 'integer') . ', ' .
            'client_cert_path = ' . $ilDB->quote($this->getClientCertPath(), 'text') . ', ' .
            'ca_cert_path = ' . $ilDB->quote($this->getCACertPath(), 'text') . ', ' .
            'key_path = ' . $ilDB->quote($this->getKeyPath(), 'text') . ', ' .
            'key_password = ' . $ilDB->quote($this->getKeyPassword(), 'text') . ', ' .
            'cert_serial = ' . $ilDB->quote($this->getCertSerialNumber(), 'text') . ', ' .
            'polling_time = ' . $ilDB->quote($this->getPollingTime(), 'integer') . ', ' .
            'import_id = ' . $ilDB->quote($this->getImportId(), 'integer') . ', ' .
            'global_role = ' . $ilDB->quote($this->getGlobalRole(), 'integer') . ', ' .
            'econtent_rcp = ' . $ilDB->quote($this->getEContentRecipientsAsString(), 'text') . ', ' .
            'user_rcp = ' . $ilDB->quote($this->getUserRecipientsAsString(), 'text') . ', ' .
            'approval_rcp = ' . $ilDB->quote($this->getApprovalRecipientsAsString(), 'text') . ', ' .
            'duration = ' . $ilDB->quote($this->getDuration(), 'integer') . ', ' .
            'auth_user = ' . $ilDB->quote($this->getAuthUser(), 'text') . ', ' .
            'auth_pass = ' . $ilDB->quote($this->getAuthPass(), 'text') . ', ' .
            'auth_type = ' . $ilDB->quote($this->getAuthType(), 'integer') . ' ' .
            'WHERE server_id = ' . $ilDB->quote($this->getServerId(), 'integer')
        );
    }

    public function delete()
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        // --- cascading delete

        include_once 'Services/WebServices/ECS/classes/Tree/class.ilECSCmsData.php';
        ilECSCmsData::deleteByServerId($this->getServerId());
        
        include_once 'Services/WebServices/ECS/classes/class.ilECSCommunityCache.php';
        ilECSCommunityCache::deleteByServerId($this->getServerId());
        
        include_once 'Services/WebServices/ECS/classes/class.ilECSDataMappingSetting.php';
        ilECSDataMappingSetting::deleteByServerId($this->getServerId());
        
        include_once 'Services/WebServices/ECS/classes/class.ilECSEventQueueReader.php';
        ilECSEventQueueReader::deleteByServerId($this->getServerId());
        
        include_once 'Services/WebServices/ECS/classes/Mapping/class.ilECSNodeMappingAssignment.php';
        ilECSNodeMappingAssignment::deleteByServerId($this->getServerId());
        
        include_once 'Services/WebServices/ECS/classes/class.ilECSParticipantSetting.php';
        ilECSParticipantSetting::deleteByServerId($this->getServerId());
        
        include_once 'Services/WebServices/ECS/classes/class.ilECSExport.php';
        ilECSExport::deleteByServerId($this->getServerId());
                
        // resetting server id to flag items in imported list
        include_once 'Services/WebServices/ECS/classes/class.ilECSImport.php';
        ilECSImport::resetServerId($this->getServerId());
                        
        $ilDB->manipulate(
            'DELETE FROM ecs_server ' .
            'WHERE server_id = ' . $ilDB->quote($this->getServerId(), 'integer')
        );
        
        $this->server_id = null;
        return true;
    }


    public function fetchCertificateExpiration()
    {
        if ($this->getAuthType() != self::AUTH_CERTIFICATE) {
            return null;
        }

        if (function_exists('openssl_x509_parse') and $cert = openssl_x509_parse('file://' . $this->getClientCertPath())) {
            if (isset($cert['validTo_time_t']) and $cert['validTo_time_t']) {
                $dt = new ilDateTime($cert['validTo_time_t'], IL_CAL_UNIX);
                
                $GLOBALS['DIC']->logger()->wsrv()->debug('Certificate expires at: ' . ilDatePresentation::formatDate($dt));
                return $dt;
            }
        }
        return null;
    }
    
    private function fetchSerialID()
    {
        if (function_exists('openssl_x509_parse') and $cert = openssl_x509_parse('file://' . $this->getClientCertPath())) {
            if (isset($cert['serialNumber']) and $cert['serialNumber']) {
                $this->setCertSerialNumber($cert['serialNumber']);
                $GLOBALS['DIC']->logger()->wsrv()->debug('Searial number is: ' . $cert['serialNumber']);
                return true;
            }
        }
        
        if (!file_exists($this->getClientCertPath()) or !is_readable($this->getClientCertPath())) {
            return false;
        }
        $lines = file($this->getClientCertPath());
        $found = false;
        foreach ($lines as $line) {
            if (strpos($line, 'Serial Number:') !== false) {
                $found = true;
                $serial_line = explode(':', $line);
                $serial = (int) trim($serial_line[1]);
                break;
            }
        }
        if ($found) {
            $this->setCertSerialNumber($serial);
            return true;
        } else {
            return false;
        }
    }
    
    private function read()
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        if (!$this->getServerId()) {
            return false;
        }

        $query = 'SELECT * FROM ecs_server ' .
            'WHERE server_id = ' . $ilDB->quote($this->getServerId(), 'integer');
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
            $this->setServer($row['server']);
            $this->setTitle($row['title']);
            $this->setProtocol($row['protocol']);
            $this->setPort($row['port']);
            $this->setClientCertPath($row['client_cert_path']);
            $this->setCACertPath($row['ca_cert_path']);
            $this->setKeyPath($row['key_path']);
            $this->setKeyPassword($row['key_password']);
            $this->setPollingTime($row['polling_time']);
            $this->setImportId($row['import_id']);
            $this->setEnabledStatus((int) $row['active']);
            $this->setCertSerialNumber($row['cert_serial']);
            $this->setGlobalRole($row['global_role']);
            $this->econtent_recipients = $row['econtent_rcp'];
            $this->approval_recipients = $row['approval_rcp'];
            $this->user_recipients = $row['user_rcp'];
            $this->setDuration($row['duration']);
            $this->setAuthUser($row['auth_user']);
            $this->setAuthPass($row['auth_pass']);
            $this->setAuthType($row['auth_type']);
        }
    }

    public function __clone()
    {
        $this->server_id = 0;
        $this->setTitle($this->getTitle() . ' (Copy)');
        $this->setEnabledStatus(false);
        $this->setServer('');
        $this->setProtocol(self::PROTOCOL_HTTPS);
        $this->setPort(0);
        $this->setClientCertPath('');
        $this->setKeyPath('');
        $this->setKeyPassword('');
        $this->setCACertPath('');
        $this->setCertSerialNumber('');
        $this->setAuthType(self::AUTH_CERTIFICATE);
        $this->setAuthUser('');
        $this->setAuthPass('');
    }
}