class.ilClient.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilClient
{
        var $id;                                        // client_id (md5 hash)
        var $dir;                                       // directory name in ilias/clients/
        var $name;                                      // installation name
        var $db_exists = false;         // db exists?
        var $db_installed = false;      // db installed?

        var $client_defaults;           // default settings
        var $status;                            // contains status infos about setup process (todo: move function to this class)
        var $setup_ok = false;          // if client setup was finished at least once, this is set to true
        var $nic_status;                        // contains received data of ILIAS-NIC server when registering
        public $error = '';
        public $db;
        public $ini;


        public function __construct($a_client_id, $a_db_connections)
        {
                if ($a_client_id)
                {
                        $this->id = $a_client_id;
                        $this->ini_file_path = ILIAS_ABSOLUTE_PATH."/".ILIAS_WEB_DIR."/".$this->getId()."/client.ini.php";
                }

                $this->db_connections = $a_db_connections;

                // set path default.ini
                $this->client_defaults = ILIAS_ABSOLUTE_PATH."/setup/client.master.ini.php";
        }


        public function getDBSetup() {
                require_once('./setup/classes/class.ilDbSetup.php');

                return ilDbSetup::getInstanceForClient($this);
        }

        function init()
        {
                $this->ini = new ilIniFile($this->ini_file_path);

                // load defaults only if no client.ini was found
                if (!@file_exists($this->ini_file_path)) {
                        //echo "<br>A-".$this->ini_file_path."-";
                        $this->ini->GROUPS = parse_ini_file($this->client_defaults, true);

                        return false;
                }

                // read client.ini
                if (!$this->ini->read()) {
                        $this->error = get_class($this) . ": " . $this->ini->getError();

                        return false;
                }

                // only for ilias main
                define("CLIENT_WEB_DIR", ILIAS_ABSOLUTE_PATH . "/" . ILIAS_WEB_DIR . "/" . $this->getId());
                define("CLIENT_DATA_DIR", ILIAS_DATA_DIR . "/" . $this->getId());
                define("DEVMODE", $this->ini->readVariable('system', 'DEVMODE'));
                define("ROOT_FOLDER_ID", $this->ini->readVariable('system', 'ROOT_FOLDER_ID'));
                define("SYSTEM_FOLDER_ID", $this->ini->readVariable('system', 'SYSTEM_FOLDER_ID'));
                define("ROLE_FOLDER_ID", $this->ini->readVariable('system', 'ROLE_FOLDER_ID'));
                define("ANONYMOUS_USER_ID", 13);
                define("ANONYMOUS_ROLE_ID", 14);
                define("SYSTEM_USER_ID", 6);
                define("SYSTEM_ROLE_ID", 2);

                $this->db_exists = $this->getDBSetup()->isConnectable();
                                $this->getDBSetup()->provideGlobalDB();
                if ($this->db_exists) {
                        $this->db_installed = $this->getDBSetup()->isDatabaseInstalled();
                }

                return true;
        }


        public function provideGlobalDB() {
                $this->getDBSetup()->provideGlobalDB();
        }


        public function revokeGlobalDB() {
                $this->getDBSetup()->provideGlobalDB();
        }

        function getId()
        {
                return $this->id;
        }

        function setId($a_client_id)
        {
                $this->id = $a_client_id;
                $this->webspace_dir = ILIAS_ABSOLUTE_PATH."/".ILIAS_WEB_DIR."/".$this->id;
        }

        function getName()
        {
                return $this->ini->readVariable("client","name");
        }

        function setName($a_str)
        {
                $this->ini->setVariable("client","name",$a_str);
        }

        function getDescription()
        {
                return $this->ini->readVariable("client","description");
        }

        function setDescription($a_str)
        {
                $this->ini->setVariable("client","description",$a_str);
        }

/*      function getMySQLVersion()
        {
                return mysql_get_server_info();
        }*/

        function getDB()
        {
                return $this->db;
        }

        function connect()
        {
                // check parameters
                // To support oracle tnsnames.ora dbname is not required
                if (!$this->getdbHost() || !$this->getdbUser()) {
                        $this->error = "empty_fields";

                        return false;
                }

                include_once("./Services/Database/classes/class.ilDBWrapperFactory.php");
                $this->db = ilDBWrapperFactory::getWrapper($this->getdbType(),
                        $this->ini->readVariable("db","inactive_mysqli"));
                $this->db->setDBUser($this->getdbUser());
                $this->db->setDBPort($this->getdbPort());
                $this->db->setDBPassword($this->getdbPass());
                $this->db->setDBHost($this->getdbHost());
                $this->db->setDBName($this->getdbName());
                $con = $this->db->connect(true);

                if (!$con)
                {
                        $this->error = "Database connection failed.";
                        return false;
                }
                $GLOBALS["ilDB"] = $this->db;
                $GLOBALS["DIC"]["ilDB"] = function($c) {
                        return $GLOBALS["ilDB"];
                };

                $this->db_exists = true;
                return true;
        }

        function isInstalledDB(&$a_db)
        {
                if(method_exists($a_db,'loadModule'))
                {
                        $a_db->loadModule('Manager');
                }
                if(!$tables = $a_db->listTables())
                {
                        return false;
                }

                // check existence of some basic tables from ilias3 to determine if ilias3 is already installed in given database
                if (in_array("object_data",$tables) and in_array("object_reference",$tables) and in_array("usr_data",$tables) and in_array("rbac_ua",$tables))
                {
                        $this->db_installed = true;
                        return true;
                }
                $this->db_installed = false;
                return false;
        }

        function setDSN()
        {
                switch($this->getDbType())
                {
                        case "oracle":
                                //$this->dsn_host = "oci8://".$this->getdbUser().":".$this->getdbPass()."@".$this->getdbHost();
                                $this->dsn_host = array(
                                                'phptype' => 'oci8',
                                                'hostspec' => $this->getdbHost(),
                                                'username' => $this->getdbUser(),
                                                                                                'port' => $this->getdbPort(),
                                                'password' => $this->getdbPass(),
                                                );
                                //$this->dsn = "oci8://".$this->getdbUser().":".$this->getdbPass()."@".$this->getdbHost()."/?service=".$this->getdbName();
                                $this->dsn = $this->dsn = array(
                                        'phptype' => 'oci8',
                                        'hostspec' => $this->getdbHost(),
                                        'username' => $this->getdbUser(),
                                        'port' => $this->getdbPort(),
                                        'password' => $this->getdbPass(),
                                        'service' => $this->getdbName()
                                        );
                                break;

                        case "postgres":
                                $db_port_str = "";
                                if (trim($this->getdbPort()) != "")
                                {
                                        $db_port_str = ":".$this->getdbPort();
                                }
                                $this->dsn_host = "pgsql://".$this->getdbUser().":".$this->getdbPass()."@".$this->getdbHost().$db_port_str;
                                $this->dsn = "pgsql://".$this->getdbUser().":".$this->getdbPass()."@".$this->getdbHost().$db_port_str."/".$this->getdbName();
                                break;

                        case "mysql":
                        case "innodb":
                        default:
                                $db_port_str = "";
                                if (trim($this->getdbPort()) != "")
                                {
                                        $db_port_str = ":".$this->getdbPort();
                                }
                                $this->dsn_host = "mysql://".$this->getdbUser().":".$this->getdbPass()."@".$this->getdbHost().$db_port_str;
                                $this->dsn = "mysql://".$this->getdbUser().":".$this->getdbPass()."@".$this->getdbHost().$db_port_str."/".$this->getdbName();
                                break;
                }
        }

        function setDbHost($a_str)
        {
                $this->ini->setVariable("db","host",$a_str);
        }

        function getDbHost()
        {
                return $this->ini->readVariable("db","host");
        }

        function setDbName($a_str)
        {
                $this->ini->setVariable("db","name",$a_str);
        }

        function getDbName()
        {
                return $this->ini->readVariable("db","name");
        }

        function setDbUser($a_str)
        {
                $this->ini->setVariable("db","user",$a_str);
        }

        function getDbUser()
        {
                return $this->ini->readVariable("db","user");
        }

        function getDbPort()
        {
                return $this->ini->readVariable("db","port");
        }

        function setDbPort($a_str)
        {
                $this->ini->setVariable("db","port",$a_str);
        }

        function setDbPass($a_str)
        {
                $this->ini->setVariable("db","pass",$a_str);
        }

        function getDbPass()
        {
                return $this->ini->readVariable("db","pass");
        }

        function setDbSlaveActive($a_act)
        {
                $this->ini->setVariable("db","slave_active", (int) $a_act);
        }

        function getDbSlaveActive()
        {
                return (int) $this->ini->readVariable("db","slave_active");
        }

        function setDbSlaveHost($a_str)
        {
                $this->ini->setVariable("db","slave_host",$a_str);
        }

        function getDbSlaveHost()
        {
                return $this->ini->readVariable("db","slave_host");
        }

        function setDbSlaveName($a_str)
        {
                $this->ini->setVariable("db","slave_name",$a_str);
        }

        function getDbSlaveName()
        {
                return $this->ini->readVariable("db","slave_name");
        }

        function setDbSlaveUser($a_str)
        {
                $this->ini->setVariable("db","slave_user",$a_str);
        }

        function getDbSlaveUser()
        {
                return $this->ini->readVariable("db","slave_user");
        }

        function getDbSlavePort()
        {
                return $this->ini->readVariable("db","slave_port");
        }

        function setDbSlavePort($a_str)
        {
                $this->ini->setVariable("db","slave_port",$a_str);
        }

        function setDbSlavePass($a_str)
        {
                $this->ini->setVariable("db","slave_pass",$a_str);
        }

        function getDbSlavePass()
        {
                return $this->ini->readVariable("db","slave_pass");
        }

        function setDbType($a_str)
        {
                $this->ini->setVariable("db","type",$a_str);
        }

        function getDbType()
        {
                $val =  $this->ini->readVariable("db","type");
                if ($val == "")
                {
                        return "mysql";
                }
                else
                {
                        return $val;
                }
        }

        function getDataDir()
        {
                return ILIAS_DATA_DIR."/".$this->getId();
        }

        function getWebspaceDir()
        {
                return ILIAS_ABSOLUTE_PATH."/".ILIAS_WEB_DIR."/".$this->getId();
        }


        function checkDatabaseExists($a_keep_connection = false)
        {
                return $this->getDBSetup()->isConnectable();
                
                //try to connect to database
                $db = $this->db_connections->connectDB($this->dsn);
                if (MDB2::isError($db))
                {
                        return false;
                }

                if (!$this->isInstalledDB($db))
                {
                        return false;
                }

                // #10633
                if($a_keep_connection)
                {
                        $GLOBALS["ilDB"] = $this->db;
                        $GLOBALS["DIC"]["ilDB"] = function($c) {
                                return $GLOBALS["ilDB"];
                        };
                }

                return true;
        }

        function reconnect()
        {
                $this->connect();
        }


        public function getSetting($a_keyword) {
                global $ilDB;
                if (!$this->getDBSetup()->isDatabaseInstalled() || !$ilDB) {
                        return false;
                }
                include_once './Services/Administration/classes/class.ilSetting.php';
                $set = new ilSetting("common", true);

                return $set->get($a_keyword);
        }

        function getAllSettings()
        {
                include_once './Services/Administration/classes/class.ilSetting.php';
                $set = new ilSetting("common", true);
                return $set->getAll();
        }

        function setSetting($a_key, $a_val)
        {
                include_once './Services/Administration/classes/class.ilSetting.php';
                $set = new ilSetting("common", true);
                $set->set($a_key, $a_val);
        }

        function getURLStringForNIC($a_nic_url)
        {
                $settings = $this->getAllSettings();

                $inst_id = (empty($settings["inst_id"])) ? "0" : $settings["inst_id"];

                // send host information to ilias-nic
                //#18132: removed ipadr, server_port, server_software, institution, contact_title, contact_position,
                // contact_institution, contact_street, contact_pcode, contact_city, contact_country, contact_phone
                $url =  $a_nic_url.
                                "?cmd=getid".
                                "&inst_id=".rawurlencode($inst_id).
                                "&hostname=".rawurlencode($_SERVER["SERVER_NAME"]).
                                "&inst_name=".rawurlencode($this->ini->readVariable("client","name")).
                                "&inst_info=".rawurlencode($this->ini->readVariable("client","description")).
                                "&http_path=".rawurlencode(ILIAS_HTTP_PATH).
                                "&contact_firstname=".rawurlencode($settings["admin_firstname"]).
                                "&contact_lastname=".rawurlencode($settings["admin_lastname"]).
                                "&contact_email=".rawurlencode($settings["admin_email"]).
                                "&nic_key=".rawurlencode($this->getNICkey());

                return $url;
        }

        function updateNIC($a_nic_url)
        {
                $max_redirects = 5;
                $socket_timeout = 5;

                require_once(__DIR__."/../../Services/WebServices/Curl/classes/class.ilCurlConnection.php");
                if (!ilCurlConnection::_isCurlExtensionLoaded()) {
                        $this->setError("CURL-extension not loaded.");
                        return false;
                }

                $url = $this->getURLStringForNIC($a_nic_url);
                $req = new ilCurlConnection($url);
                $req->init();

                $settings = $this->getAllSettings();
                if((bool)$settings['proxy_status'] && strlen($settings['proxy_host']) && strlen($settings['proxy_port']))
                {
                        $req->setOpt(CURLOPT_HTTPPROXYTUNNEL, true);
                        $req->setOpt(CURLOPT_PROXY, $settings["proxy_host"]);
                        $req->setOpt(CURLOPT_PROXYPORT, $settings["proxy_port"]);
                }

                $req->setOpt(CURLOPT_HEADER, 1);
                $req->setOpt(CURLOPT_RETURNTRANSFER, 1);
                $req->setOpt(CURLOPT_CONNECTTIMEOUT, $socket_timeout);
                $req->setOpt(CURLOPT_MAXREDIRS, $max_redirects);
                $response = $req->exec();
                
                $req->parseResponse($response);
                $response_body = $req->getResponseBody();

                $info = $req->getInfo();
                if ($info["http_code"] != "200") {
                        $this->setError("Could not connect to NIC-Server at '".$url."'");
                        return false;
                }

                $this->nic_status = explode("\n", $response_body);
                
                ilLoggerFactory::getLogger('setup')->dump($nic_status);

                return true;
        }

        function setNICkey()
        {
                mt_srand((double)microtime()*1000000);
                $nic_key =      md5(str_replace(".","",$_SERVER["SERVER_ADDR"]) +
                                        mt_rand(100000,999999));

                $this->setSetting("nic_key",$nic_key);

                $this->nic_key = $nic_key;

                return true;
        }

        function getNICkey()
        {
                $this->nic_key = $this->getSetting("nic_key");

                if (empty($this->nic_key))
                {
                        $this->setNICkey();
                }

                return $this->nic_key;
        }

        function getDefaultLanguage()
        {
                return $this->getSetting("language");
        }

        function setDefaultLanguage($a_lang_key)
        {
                $this->setSetting("language",$a_lang_key);
                $this->ini->setVariable("language","default",$a_lang_key);
                $this->ini->write();

                return true;
        }


        function getError() {
                $error = $this->error;
                $this->error = "";

                return $error;
        }


        public function setError($error_message) {
                $this->error = $error_message;
        }

        function delete ($a_ini = true, $a_db = false, $a_files = false)
        {
                if ($a_ini === true and file_exists(ILIAS_ABSOLUTE_PATH."/".ILIAS_WEB_DIR."/".$this->getId()."/client.ini.php"))
                {
                        unlink(CLIENT_WEB_DIR."/client.ini.php");
                        $msg[] = "ini_deleted";
                }

                if ($a_db === true and $this->db_exists)
                {
                        $this->db->query("DROP DATABASE ".$this->getDbName());
                        $msg[] = "db_deleted";
                }

                if ($a_files === true and file_exists(CLIENT_WEB_DIR) and is_dir(CLIENT_WEB_DIR))
                {
                        // rmdir();
                        ilUtil::delDir(CLIENT_WEB_DIR);
                        ilUtil::delDir(CLIENT_DATA_DIR);
                        $msg[] = "files_deleted";
                }

                return $msg;
        }

        function create()
        {
                //var_dump($this->getDataDir());exit;
                // create base data dir
                if (!ilUtil::makeDir($this->getDataDir()))
                {
                        $this->error = "could_not_create_base_data_dir :".$this->getDataDir();
                        return false;
                }

                // create sub dirs in base data dir
                if (!ilUtil::makeDir($this->getDataDir()."/mail"))
                {
                        $this->error = "could_not_create_mail_data_dir :".$this->getDataDir()."/mail";
                        return false;
                }

                if (!ilUtil::makeDir($this->getDataDir()."/lm_data"))
                {
                        $this->error = "could_not_create_lm_data_dir :".$this->getDataDir()."/lm_data";
                        return false;
                }

                if (!ilUtil::makeDir($this->getDataDir()."/forum"))
                {
                        $this->error = "could_not_create_forum_data_dir :".$this->getDataDir()."/forum";
                        return false;
                }

                if (!ilUtil::makeDir($this->getDataDir()."/files"))
                {
                        $this->error = "could_not_create_files_data_dir :".$this->getDataDir()."/files";
                        return false;
                }

                // create base webspace dir
                if (!ilUtil::makeDir($this->getWebspaceDir()))
                {
                        $this->error = "could_not_create_base_webspace_dir :".$this->getWebspaceDir();
                        return false;
                }

                // create sub dirs in base webspace dir
                if (!ilUtil::makeDir($this->getWebspaceDir()."/lm_data"))
                {
                        $this->error = "could_not_create_lm_webspace_dir :".$this->getWebspaceDir()."/lm_data";
                        return false;
                }

                if (!ilUtil::makeDir($this->getWebspaceDir()."/usr_images"))
                {
                        $this->error = "could_not_create_usr_images_webspace_dir :".$this->getWebspaceDir()."/usr_images";
                        return false;
                }

                if (!ilUtil::makeDir($this->getWebspaceDir()."/mobs"))
                {
                        $this->error = "could_not_create_mobs_webspace_dir :".$this->getWebspaceDir()."/mobs";
                        return false;
                }

                if (!ilUtil::makeDir($this->getWebspaceDir()."/css"))
                {
                        $this->error = "could_not_create_css_webspace_dir :".$this->getWebspaceDir()."/css";
                        return false;
                }

                // write client ini
                if (!$this->ini->write())
                {
                        $this->error = get_class($this).": ".$this->ini->getError();
                        return false;
                }

                return true;
        }

        function writeIni()
        {
                $this->ini->write();
        }

} // END class.ilClient
?>