ilSetup Class Reference

Setup class. More...

Collaboration diagram for ilSetup:

Public Member Functions
	__construct ($a_auth, $a_auth_type)
	constructor More...
	setClient ($a_cl)
	getClient ()
	init ()
	init setup load settings from ilias.ini if exists and sets some constants More...
	saveNewClient ()
	saves client.ini & updates client list in ilias.ini More...
	updateNewClient ($a_old_client_id)
	update client.ini & move data dirs does not work correctly at this time - DISABLED More...
	createDatabase ($a_collation="")
	create client database More...
	installDatabase ()
	set the database data More...
	checkIniFileExists ()
	check if inifile exists More...
	checkWritable ()
	check for writable directory More...
	checkCreatable ($a_dir=".")
	check for permission to create new folders in specified directory More...
	checkCookiesEnabled ()
	check cookies enabled More...
	checkPHPVersion ()
	check for PHP version More...
	checkMySQL ()
	Check MySQL. More...
	checkAuth ()
	check authentication status More...
	checkDom ()
	Check MySQL. More...
	checkXsl ()
	Check MySQL. More...
	checkGd ()
	Check MySQL. More...
	checkMemoryLimit ()
	Check Memory Limit. More...
	queryPreliminaries ()
	preliminaries More...
	checkPreliminaries ()
	check all prliminaries More...
	getPassword ()
	get setup master password More...
	setPassword ($a_password)
	set setup master password More...
	loginAsClient ($a_auth_data)
	process client login More...
	loginAsAdmin ($a_password)
	process setup admin login More...
	newClient ($a_client_id=0)
	creates a client object in $this->client More...
	getStatus ($client=0)
	coumpute client status More...
	checkFinish (&$client)
	check if client setup was finished More...
	checkAccess (&$client)
	check client access status More...
	checkClientIni (&$client)
	check client ini status More...
	checkClientDatabase (ilClient $client)
	checkClientSessionSettings (&$client, $a_as_bool=false)
	check client session config status More...
	checkClientProxySettings (ilClient $client)
	checkClientLanguages (ilClient $client)
	checkClientContact (&$client)
	check client contact data status More...
	checkClientNIC (&$client)
	check client nic status More...
	isInstalled ()
	check if client's db is installed More...
	isAuthenticated ()
	check if current user is authenticated More...
	isAdmin ()
	check if current user is admin More...
	saveMasterSetup ($a_formdata)
	saves intial settings More...
	updateMasterSettings ($a_formdata)
	updates settings More...
	checkToolsSetup ($a_formdata)
	check pathes to 3rd party software More...
	checkDataDirSetup ($a_formdata)
	check datadir path More...
	checkPasswordSetup ($a_formdata)
	check setup password More...
	checkLogSetup ($a_formdata)
	check log path More...
	checkErrorLogSetup ($error_log_path)
	check error log path More...
	getError ()
	get Error message More...
	_ilSetup ()
	destructor More...
	testConvert ($a_convert_path)
	Check convert program. More...
	testGhostscript ($a_ghostscript_path)
	Check ghostscript program. More...
	testJava ($a_java_path)
	Check JVM. More...
	testLatex ($a_latex_url)
	Check latex cgi script. More...
	testZip ($a_zip_path)
	Check zip program. More...
	testUnzip ($a_unzip_path)
	Check unzip program. More...
	unzip ($a_file, $overwrite=false)
	unzip file More...
	setSessionSettings ($session_settings)
	saves session settings to db More...
	getSessionSettings ()
	reads session settings from db More...
	cloneFromSource ($source_id)
	Clone source client into current client. More...
	printProxyStatus ($client)
	Print proxy settings. More...
	saveProxySettings ($proxy_settings)
	hasOpCacheEnabled ()
	isValidClientId ($a_client_id)
	Is valid client id. More...

Data Fields
	$ini
	$ini_file_path
	$error = ""
	$ini_ilias_exists = false
	$ini_client_exists = false
	$setup_defaults
	$ilias_nic_server = "https://nic.ilias.de/index.php"
	$preliminaries_result = array()
	$preliminaries = true
	$SQL_FILE = "./setup/sql/ilias3.sql"
	$dsn = ""
	$db
	$setup_password
	$default_client
	$safe_mode
	$safe_mode_exec_dir
	$auth
	$access_mode
	$client

Protected Member Functions
	checkOpcacheSettings ()
	isDirectoryInOther ($directory, $other_directory)
	Checks if directory is subdirectory of other directory. More...

Detailed Description

Setup class.

class to setup ILIAS first and maintain the ini-settings and the database

Author

Peter Gabriel pgabr.nosp@m.iel@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Sascha Hofmann shofm.nosp@m.ann@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Version

$Id$

Definition at line 15 of file class.ilSetup.php.

Constructor & Destructor Documentation

__construct()

ilSetup::__construct	(		$a_auth,
			$a_auth_type
	)

constructor

Parameters

boolean	user is authenticated? (true) or not (false)
string	user is admin or common user

Definition at line 67 of file class.ilSetup.php.

References $lng, checkAuth(), ilFile\deleteTrailingSlash(), and init().

        {
                global $lng;

                $this->lng = $lng;

                $this->db_connections = new ilDBConnections();

                define("ILIAS_MODULE","setup");

                $this->auth = ($this->checkAuth()) ? true : false;
                $this->access_mode = $a_auth_type;

                // safe mode status & exec_dir
                if ($this->safe_mode = ini_get("safe_mode"))
                {
                        $this->safe_mode_exec_dir = ilFile::deleteTrailingSlash(ini_get("safe_mode_exec_dir"));
                }

                // set path to ilias.ini
                $this->ini_file_path = ILIAS_ABSOLUTE_PATH."/ilias.ini.php";
                $this->setup_defaults = ILIAS_ABSOLUTE_PATH."/setup/ilias.master.ini.php";

                // init setup.ini
                $this->ini_ilias_exists = $this->init();

                /*
                if ($this->ini_ilias_exists)
                {
                        if ($this->ini->readVariable("log","path") != "")
                        {
                                $log->path = $this->ini->readVariable("log","path");
                        }

                        if ($this->ini->readVariable("log","file") != "")
                        {
                                $log->filename = $this->ini->readVariable("log","file");
                        }

                        if ($this->ini->readVariable("log","enabled") != "")
                        {
                                $log->enabled = $this->ini->readVariable("log","enabled");
                        }
                }
                */
        }

Here is the call graph for this function:

Member Function Documentation

_ilSetup()

ilSetup::_ilSetup

(

)

destructor

Returns

boolean

Definition at line 1562 of file class.ilSetup.php.

        {
                //if ($this->ini->readVariable("db","type") != "")
                //{
                //      $this->db->disconnect();
                //}
                return true;
        }

checkAccess()

ilSetup::checkAccess

(

&

$client

)

check client access status

Parameters

object

client

Returns

boolean

Definition at line 814 of file class.ilSetup.php.

References $client.

Referenced by getStatus().

        {
                if ($client->ini->readVariable("client","access") == "1")
                {
                        $arr["status"] = true;
                        $arr["comment"] = $this->lng->txt("online");
                }
                else
                {
                        $arr["status"] = false;
                        $arr["comment"] = $this->lng->txt("disabled");
                }

                return $arr;
        }

Here is the caller graph for this function:

checkAuth()

ilSetup::checkAuth

(

)

check authentication status

Returns

boolean

Definition at line 378 of file class.ilSetup.php.

References $_SESSION.

Referenced by __construct().

        {
                if ($_SESSION["auth"] === true && $_SESSION["auth_path"] == ILIAS_HTTP_PATH)
                {
                        return true;
                }

                return false;
        }

Here is the caller graph for this function:

checkClientContact()

ilSetup::checkClientContact

(

&

$client

)

check client contact data status

Parameters

object

client

Returns

boolean

Definition at line 1022 of file class.ilSetup.php.

References $client, and ilUtil\is_email().

Referenced by getStatus().

        {
                $arr["status"] = true;
                //$arr["comment"] = $this->lng->txt("filled_out");

                $settings = $client->getAllSettings();
                $client_name = $client->getName();

                // check required fields
                if (empty($settings["admin_firstname"]) or empty($settings["admin_lastname"]) or
                        empty($settings["admin_email"]) or empty($client_name))
                {
                        $arr["status"] = false;
                        $arr["comment"] = $this->lng->txt("missing_data");
                }

                // admin email
                if (!ilUtil::is_email($settings["admin_email"]) and $arr["status"] != false)
                {
                        $arr["status"] = false;
                        $arr["comment"] = $this->lng->txt("email_not_valid");
                }

                return $arr;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

checkClientDatabase()

ilSetup::checkClientDatabase

(

ilClient

$client

)

Parameters

\ilClient

$client

Returns

array

Definition at line 854 of file class.ilSetup.php.

References $ilDB, array, ilClient\getSetting(), ilClient\provideGlobalDB(), and ilClient\revokeGlobalDB().

Referenced by getStatus().

                                                              {
                $arr = array();
                $client->provideGlobalDB();
                if (!$arr["status"] = $client->db_exists) {
                        $arr["comment"] = $this->lng->txt("no_database");

                        return $arr;
                }

                if (!$arr["status"] = $client->db_installed) {
                        $arr["comment"] = $this->lng->txt("db_not_installed");

                        return $arr;
                }
                // TODO: move this to client class!!
                $client->setup_ok = (bool)$client->getSetting("setup_ok");

                include_once "./Services/Database/classes/class.ilDBUpdate.php";
                $this->lng->setDbHandler($client->db);
                $dbupdate = new ilDBUpdate($client->db);

                if (!$arr["status"] = $dbupdate->getDBVersionStatus()) {
                        $arr["comment"] = $this->lng->txt("db_needs_update");
                        $arr["update"] = true;

                        return $arr;
                } else {
                        if ($dbupdate->hotfixAvailable()) {
                                $arr["status"] = false;
                                $arr["comment"] = $this->lng->txt("hotfix_available");
                                $arr["update"] = true;

                                return $arr;
                        } else {
                                if ($dbupdate->customUpdatesAvailable()) {
                                        $arr["status"] = false;
                                        $arr["comment"] = $this->lng->txt("custom_updates_available");
                                        $arr["update"] = true;

                                        return $arr;
                                }
                        }
                }

                // check control information
                global $ilDB;
                $cset = $ilDB->query("SELECT count(*) as cnt FROM ctrl_calls");
                $crec = $ilDB->fetchAssoc($cset);
                $client->revokeGlobalDB();
                if ($crec["cnt"] == 0) {
                        $arr["status"] = false;
                        $arr["comment"] = $this->lng->txt("db_control_structure_missing");
                        $arr["update"] = true;

                        return $arr;
                }

                return $arr;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

checkClientIni()

ilSetup::checkClientIni

(

&

$client

)

check client ini status

Parameters

object

client

Returns

boolean

Definition at line 835 of file class.ilSetup.php.

References $client.

Referenced by getStatus().

        {
                if (!$arr["status"] = $client->init())
                {
                        $arr["comment"] = $client->getError();
                }
                else
                {
                        //$arr["comment"] = "dir: /".ILIAS_WEB_DIR."/".$client->getId();                        
                }

                return $arr;
        }

Here is the caller graph for this function:

checkClientLanguages()

ilSetup::checkClientLanguages

(

ilClient

$client

)

Parameters

\ilClient

$client

Returns

array

Definition at line 1000 of file class.ilSetup.php.

References array, ilClient\provideGlobalDB(), and ilClient\revokeGlobalDB().

Referenced by getStatus().

                                                               {
                $client->provideGlobalDB();
                $installed_langs = $this->lng->getInstalledLanguages();

                $count = count($installed_langs);
                $arr = array();
                if ($count < 1) {
                        $arr["status"] = false;
                        $arr["comment"] = $this->lng->txt("lang_none_installed");
                } else {
                        $arr["status"] = true;
                        //$arr["comment"] = $count." ".$this->lng->txt("languages_installed");
                }
                $client->revokeGlobalDB();
                return $arr;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

checkClientNIC()

ilSetup::checkClientNIC

(

&

$client

)

check client nic status

Parameters

object

client

Returns

boolean

Definition at line 1053 of file class.ilSetup.php.

References $client.

Referenced by getStatus().

        {
                $settings = $client->getAllSettings();

                if (!isset($settings["nic_enabled"]))
                {
                        $arr["status"] = false;
                        $arr["comment"] = $this->lng->txt("nic_not_disabled");
                        return $arr;
                }

                $arr["status"] = true;

                if ($settings["nic_enabled"] == "-1")
                {
                        $arr["comment"] = $this->lng->txt("nic_reg_failed");
                        return $arr;
                }

                if (!$settings["nic_enabled"])
                {
                        $arr["comment"] = $this->lng->txt("nic_reg_disabled");
                }
                else
                {
                        $arr["comment"] = $this->lng->txt("nic_reg_enabled");
                        if ($settings["inst_id"] <= 0)
                        {
                                $arr["status"] = false;
                        }
                }

                return $arr;
        }

Here is the caller graph for this function:

checkClientProxySettings()

ilSetup::checkClientProxySettings

(

ilClient

$client

)

Parameters

\ilClient

$client

Returns

array

Definition at line 960 of file class.ilSetup.php.

References $ilDB, $query, $res, $row, array, and ilClient\provideGlobalDB().

Referenced by getStatus().

                                                                   {
                $client->provideGlobalDB();
                global $ilDB;
                $arr = array();
                $fields = array( 'proxy_status', 'proxy_host', 'proxy_port' );

                $query = "SELECT keyword, value FROM settings WHERE " . $ilDB->in('keyword', $fields, false, 'text');
                $res = $ilDB->query($query);

                $proxy_settings = array();
                $already_saved = false;
                while ($row = $ilDB->fetchAssoc($res)) {
                        $already_saved = true;
                        $proxy_settings[$row['keyword']] = $row['value'];
                }

                if (!$already_saved) {
                        $arr["status"] = false;
                        $arr["comment"] = $this->lng->txt("proxy");
                        $arr["text"] = $this->lng->txt("proxy");
                } else {
                        if ((bool)$proxy_settings["proxy_status"] == false) {
                                $arr["status"] = true;
                                $arr["comment"] = $this->lng->txt("proxy_disabled");
                                $arr["text"] = $this->lng->txt("proxy_disabled");
                        } else {
                                $arr["status"] = true;
                                $arr["comment"] = $this->lng->txt("proxy_activated_configurated");
                                $arr["text"] = $this->lng->txt("proxy_activated_configurated");
                        }
                }

                return $arr;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

checkClientSessionSettings()

ilSetup::checkClientSessionSettings	(	&	$client,
			$a_as_bool = false
	)

check client session config status

Parameters

object

client

Returns

boolean

Definition at line 919 of file class.ilSetup.php.

References $ilDB, $query, $res, $row, array, ilDBConstants\FETCHMODE_ASSOC, and ilSessionControl\getSettingFields().

        {
                require_once('Services/Authentication/classes/class.ilSessionControl.php');

                global $ilDB;
                $db = $ilDB;

                $fields = ilSessionControl::getSettingFields();

                $query = "SELECT keyword, value FROM settings WHERE ".$db->in('keyword', $fields, false, 'text');
                $res = $db->query($query);

                $rows = array();
                while($row = $res->fetchRow(ilDBConstants::FETCHMODE_ASSOC))
                {
                        if( $row['value'] != '' )
                                        $rows[] = $row;
                        else    break;
                }

                if (count($rows) != count($fields))
                {
                        if($a_as_bool) return false;
                        $arr["status"] = false;
                        $arr["comment"] = $this->lng->txt("session_management_not_configured");
                }
                else
                {
                        if($a_as_bool) return true;
                        $arr["status"] = true;
                        $arr["comment"] = $this->lng->txt("session_management_configured");
                }

                return $arr;
        }

Here is the call graph for this function:

checkCookiesEnabled()

ilSetup::checkCookiesEnabled

(

)

check cookies enabled

Returns

array

Definition at line 315 of file class.ilSetup.php.

References $sess.

Referenced by queryPreliminaries().

        {
                global $sess;

                if ($sess->usesCookies)
                {
                        $arr["status"] = true;
                        $arr["comment"] = "";
                }
                else
                {
                        $arr["status"] = false;
                        $arr["comment"] = $this->lng->txt("pre_cookies_disabled");
                }

                return $arr;
        }

Here is the caller graph for this function:

checkCreatable()

ilSetup::checkCreatable

(

$a_dir = "."

)

check for permission to create new folders in specified directory

Parameters

string

directory

Returns

array

Definition at line 289 of file class.ilSetup.php.

Referenced by queryPreliminaries().

        {
                clearstatcache();
                if (@mkdir($a_dir."/crst879dldsk9d", 0774))
                {
                        $arr["status"] = true;
                        $arr["comment"] = "";

                        @rmdir($a_dir."/crst879dldsk9d");
                }
                else
                {
                        $arr["status"] = false;
                        //$cdir = getcwd();
                        //chdir("..");
                        $arr["comment"] = getcwd().": ".$this->lng->txt("pre_folder_create_error");
                        //chdir($cdir);
                }

                return $arr;
        }

Here is the caller graph for this function:

checkDataDirSetup()

ilSetup::checkDataDirSetup

(

$a_formdata

)

check datadir path

Parameters

array

form data

Returns

boolean

Definition at line 1397 of file class.ilSetup.php.

References ilFile\deleteTrailingSlash(), isDirectoryInOther(), and ilUtil\stripSlashes().

        {
                // remove trailing slash & convert backslashes to forwardslashes
                $datadir_path = preg_replace("/\\\\/","/",ilFile::deleteTrailingSlash(ilUtil::stripSlashes($a_formdata["datadir_path"])));

                if (empty($datadir_path))
                {
                        $this->error = "no_path_datadir";
                        return false;
                }

                $webspace_dir = ILIAS_ABSOLUTE_PATH . "/data";

                // datadir may not point to webspace dir or to any place under webspace_dir
                if (strpos($datadir_path,$webspace_dir) !== false)
                {
                        $this->error = "datadir_webspacedir_match";
                        return false;
                }

                // create dir
                if ($a_formdata["chk_datadir_path"] == 1)
                {
                        $dir_to_create = substr(strrchr($datadir_path, "/"), 1);
                        $dir_to_check = substr($datadir_path,0,- strlen($dir_to_create)-1);

                        if ($this->isDirectoryInOther($dir_to_create, ILIAS_ABSOLUTE_PATH)) {
                                $this->error = "cannot_create_datadir_inside_webdir";
                                return false;
                        }

                        if (is_writable($datadir_path))
                        {
                                $this->error = "dir_exists_create";
                                return false;
                        }

                        if (!is_writable($dir_to_check))
                        {
                                $this->error = "cannot_create_datadir_no_write_access";
                                return false;
                        }
                }
                else    // check set target dir
                {
                        if ($this->isDirectoryInOther($datadir_path, ILIAS_ABSOLUTE_PATH)) {
                                $this->error = "cannot_create_datadir_inside_webdir";
                                return false;
                        }

                        if (!is_writable($datadir_path))
                        {
                                $this->error = "cannot_create_datadir_no_write_access";
                                return false;
                        }
                }

                return true;
        }

Here is the call graph for this function:

checkDom()

ilSetup::checkDom

(

)

Check MySQL.

Returns

boolean

Definition at line 393 of file class.ilSetup.php.

References $ilDB.

Referenced by queryPreliminaries().

        {
                global $ilDB;

                if (class_exists("DOMDocument"))
                {
                        $arr["status"] = true;
                }
                else
                {
                        $arr["status"] = false;
                        $arr["comment"] = $this->lng->txt("pre_dom_missing");
                }

                return $arr;
        }

Here is the caller graph for this function:

checkErrorLogSetup()

ilSetup::checkErrorLogSetup

(

$error_log_path

)

check error log path

Parameters

string

$error_log_path

path to save error log files

Returns

boolean

Definition at line 1526 of file class.ilSetup.php.

References ilFile\deleteTrailingSlash(), ilUtil\makeDirParents(), and ilUtil\stripSlashes().

                                                            {
                // remove trailing slash & convert backslashes to forwardslashes
                $clean_error_log_path = preg_replace("/\\\\/","/",ilFile::deleteTrailingSlash(ilUtil::stripSlashes($error_log_path)));

                if (!empty($clean_error_log_path)) {
                        if (!ilUtil::makeDirParents($clean_error_log_path)) {
                                $this->error = "could_not_create_error_directory";
                                return false;
                        }
                }

                return true;
        }

Here is the call graph for this function:

checkFinish()

ilSetup::checkFinish

(

&

$client

)

check if client setup was finished

Parameters

object

client

Returns

boolean

Definition at line 793 of file class.ilSetup.php.

References $client.

Referenced by getStatus().

        {
                if ($client->getSetting("setup_ok"))
                {
                        $arr["status"] = true;
                        //$arr["comment"] = $this->lng->txt("setup_finished");
                }
                else
                {
                        $arr["status"] = false;
                        $arr["comment"] = $this->lng->txt("setup_not_finished");
                }

                return $arr;
        }

Here is the caller graph for this function:

checkGd()

ilSetup::checkGd

(

)

Check MySQL.

Returns

boolean

Definition at line 436 of file class.ilSetup.php.

References $ilDB.

Referenced by queryPreliminaries().

        {
                global $ilDB;

                if (function_exists("imagefill") && function_exists("imagecolorallocate"))
                {
                        $arr["status"] = true;
                }
                else
                {
                        $arr["status"] = false;
                        $arr["comment"] = sprintf($this->lng->txt("pre_gd_missing"),
                                "http://php.net/manual/en/book.image.php");
                }

                return $arr;
        }

Here is the caller graph for this function:

checkIniFileExists()

ilSetup::checkIniFileExists

(

)

check if inifile exists

Returns

boolean

Definition at line 249 of file class.ilSetup.php.

        {
                $a = @file_exists($this->INI_FILE);
                return $a;
        }

checkLogSetup()

ilSetup::checkLogSetup

(

$a_formdata

)

check log path

Parameters

array

form data

Returns

boolean

Definition at line 1484 of file class.ilSetup.php.

References ilFile\deleteTrailingSlash(), isDirectoryInOther(), and ilUtil\stripSlashes().

        {
                // log path
                if (!$a_formdata["chk_log_status"])
                {
                        // remove trailing slash & convert backslashes to forwardslashes
                        $log_path = preg_replace("/\\\\/","/",ilFile::deleteTrailingSlash(ilUtil::stripSlashes($a_formdata["log_path"])));

                        if (empty($log_path))
                        {
                                $this->error = "no_path_log";
                                return false;
                        }
                        
                        if(is_dir($log_path))
                        {
                                $this->error = 'could_not_create_logfile';
                                return false;
                        }

                        if ($this->isDirectoryInOther($log_path, ILIAS_ABSOLUTE_PATH)) {
                                $this->error = "cannot_create_logdir_inside_webdir";
                                return false;
                        }

                        if (!@touch($log_path))
                        {
                                $this->error = "could_not_create_logfile";
                                return false;
                        }
                }

                return true;
        }

Here is the call graph for this function:

checkMemoryLimit()

ilSetup::checkMemoryLimit

(

)

Check Memory Limit.

Returns

boolean

Definition at line 458 of file class.ilSetup.php.

References $ilDB.

Referenced by queryPreliminaries().

        {
                global $ilDB;

                $limit = ini_get("memory_limit");

                $limit_ok = true;
                if (is_int(strpos($limit, "M")))
                {
                        $limit_n = (int) $limit;
                        if ($limit_n < 40)
                        {
                                $limit_ok = false;
                        }
                }

                if ($limit_ok)
                {
                        $arr["status"] = true;
                        $arr["comment"] = $limit.". ".$this->lng->txt("pre_memory_limit_recommend");
                }
                else
                {
                        $arr["status"] = false;
                        $arr["comment"] = $limit.". ".$this->lng->txt("pre_memory_limit_too_low");
                }

                return $arr;
        }

Here is the caller graph for this function:

checkMySQL()

ilSetup::checkMySQL

(

)

Check MySQL.

Returns

boolean

Definition at line 356 of file class.ilSetup.php.

References $ilDB.

        {
                global $ilDB;

                if (function_exists("mysql_query"))
                {
                        $arr["status"] = true;
                        $arr["comment"] = $this->lng->txt("pre_mysql_4_1_or_higher");
                }
                else
                {
                        $arr["status"] = false;
                        $arr["comment"] = $this->lng->txt("pre_mysql_missing");
                }

                return $arr;
        }

checkOpcacheSettings()

ilSetup::checkOpcacheSettings ( )

protected

Returns

array

Definition at line 492 of file class.ilSetup.php.

References array.

Referenced by queryPreliminaries().

                                                  {
                $arr = array();
                // correct-with-php5-removal FSX start
                if (version_compare(PHP_VERSION, '7.0.0', '>=')) {
                        $arr["status"] = true;

                        return $arr;
                }
                // correct-with-php5-removal FSX end

                $load_comments = ini_get("opcache.load_comments");
                if ($load_comments == 1) {
                        $arr["status"] = true;
                } else {
                        $arr["status"] = false;
                        $arr["comment"] = $this->lng->txt("pre_opcache_comments");
                }

                return $arr;
        }

Here is the caller graph for this function:

checkPasswordSetup()

ilSetup::checkPasswordSetup

(

$a_formdata

)

check setup password

Parameters

array

form data

Returns

boolean

Definition at line 1462 of file class.ilSetup.php.

        {
                if (!$a_formdata["setup_pass"])
                {
                        $this->error = "no_setup_pass_given";
                        return false;
                }

                if ($a_formdata["setup_pass"] != $a_formdata["setup_pass2"])
                {
                        $this->error = "pass_does_not_match";
                        return false;
                }

                return true;
        }

checkPHPVersion()

ilSetup::checkPHPVersion

(

)

check for PHP version

Returns

array

Definition at line 337 of file class.ilSetup.php.

References $version.

Referenced by queryPreliminaries().

        {
                $version =  PHP_VERSION;

                $arr["status"] = true;
                $arr["comment"] = "PHP ".$version;
                if (version_compare($version, '5.3.0', '<'))
                {
                        $arr["status"] = false;
                        $arr["comment"] = "PHP ".$version.". ".$this->lng->txt("pre_php_version_too_low");
                }

                return $arr;
        }

Here is the caller graph for this function:

checkPreliminaries()

ilSetup::checkPreliminaries

(

)

check all prliminaries

Returns

boolean

Definition at line 544 of file class.ilSetup.php.

References queryPreliminaries().

        {
                $this->preliminaries_result = $this->queryPreliminaries();

                foreach ($this->preliminaries_result as $val)
                {
                        if ($val["status"] === false)
                        {
                                $this->preliminaries = false;
                                return false;
                        }
                }

                return true;
        }

Here is the call graph for this function:

checkToolsSetup()

ilSetup::checkToolsSetup

(

$a_formdata

)

check pathes to 3rd party software

Parameters

array

form data

Returns

boolean

Definition at line 1257 of file class.ilSetup.php.

References ilUtil\stripSlashes(), testConvert(), testGhostscript(), testJava(), testLatex(), testUnzip(), and testZip().

        {
                // convert path
                if (!isset($a_formdata["chk_convert_path"]))
                {
                        // convert backslashes to forwardslashes
                        $convert_path = preg_replace("/\\\\/","/",ilUtil::stripSlashes($a_formdata["convert_path"]));

                        if (($err = $this->testConvert($convert_path)) != "")
                        {
                                $this->error = $err;
                                return false;
                        }
                }

                // zip path
                if (!isset($a_formdata["chk_zip_path"]))
                {
                        // convert backslashes to forwardslashes
                        $zip_path = preg_replace("/\\\\/","/",ilUtil::stripSlashes($a_formdata["zip_path"]));

                        if (empty($zip_path))
                        {
                                $this->error = "no_path_zip";
                                return false;
                        }

                        if (!$this->testZip($zip_path))
                        {
                                $this->error = "check_failed_zip";
                                return false;
                        }
                }

                // unzip path
                if (!isset($a_formdata["chk_unzip_path"]))
                {
                        // convert backslashes to forwardslashes
                        $unzip_path = preg_replace("/\\\\/","/",ilUtil::stripSlashes($a_formdata["unzip_path"]));

                        if (empty($unzip_path))
                        {
                                $this->error = "no_path_unzip";
                                return false;
                        }

                        if (!$this->testUnzip($unzip_path))
                        {
                                $this->error = "check_failed_unzip";
                                return false;
                        }
                }

                // ghostscript path
                if (!isset($a_formdata["chk_ghostscript_path"]))
                {
                        // convert backslashes to forwardslashes
                        $ghostscript_path = preg_replace("/\\\\/","/",ilUtil::stripSlashes($a_formdata["ghostscript_path"]));

                        if (($err = $this->testGhostscript($ghostscript_path)) != "")
                        {
                                $this->error = $err;
                                return false;
                        }
                }

                // java path
                if (!isset($a_formdata["chk_java_path"]))
                {
                        // convert backslashes to forwardslashes
                        $java_path = preg_replace("/\\\\/","/",ilUtil::stripSlashes($a_formdata["java_path"]));

                        if (empty($java_path))
                        {
                                $this->error = "no_path_java";
                                return false;
                        }

                        if (!$this->testJava($java_path))
                        {
                                $this->error = "check_failed_java";
                                return false;
                        }
                }

                /*if (!isset($a_formdata["chk_mkisofs_path"]))
                {
                        // convert backslashes to forwardslashes
                        $mkisofs_path = preg_replace("/\\\\/","/",ilUtil::stripSlashes($a_formdata["mkisofs_path"]));

                        if (empty($mkisofs_path))
                        {
                                $this->error = "no_path_mkisofs";
                                return false;
                        }
                }*/

                if (!isset($a_formdata["chk_ffmpeg_path"]))
                {
                        // convert backslashes to forwardslashes
                        $ffmpeg_path = preg_replace("/\\\\/","/",ilUtil::stripSlashes($a_formdata["ffmpeg_path"]));

                        if (empty($ffmpeg_path))
                        {
                                $this->error = "no_path_ffmpeg";
                                return false;
                        }

                        if (!$this->testFFMpeg($ffmpeg_path))
                        {
                                $this->error = "check_failed_ffmpeg";
                                return false;
                        }
                }

                // latex  url
                if (!isset($a_formdata["chk_latex_url"]))
                {
                        $latex_url = ilUtil::stripSlashes($a_formdata["latex_url"]);
                        if (empty($latex_url))
                        {
                                $this->error = "no_latex_url";
                                return false;
                        }

                        if (!$this->testLatex($latex_url))
                        {
                                $this->error = "check_failed_latex";
                                return false;
                        }
                }

                return true;
        }

Here is the call graph for this function:

checkWritable()

ilSetup::checkWritable

(

)

check for writable directory

Parameters

string

directory

Returns

array

Definition at line 260 of file class.ilSetup.php.

Referenced by queryPreliminaries().

        {
                clearstatcache();
                if (is_writable("."))
                {
                        $arr["status"] = true;
                        //$cdir = getcwd();
                        //chdir("..");
                        $arr["comment"] = getcwd();
                        //chdir($cdir);
                }
                else
                {
                        $arr["status"] = false;
                        $arr["comment"] = $this->lng->txt("pre_folder_write_error");
                        //$cdir = getcwd();
                        //chdir("..");
                        $arr["comment"] = getcwd().": ".$arr["comment"];
                        //chdir($cdir);
                }

                return $arr;
        }

Here is the caller graph for this function:

checkXsl()

ilSetup::checkXsl

(

)

Check MySQL.

Returns

boolean

Definition at line 414 of file class.ilSetup.php.

References $ilDB.

Referenced by queryPreliminaries().

        {
                global $ilDB;

                if (class_exists("XSLTProcessor"))
                {
                        $arr["status"] = true;
                }
                else
                {
                        $arr["status"] = false;
                        $arr["comment"] = sprintf($this->lng->txt("pre_xsl_missing"),
                                "http://php.net/manual/en/book.xsl.php");
                }

                return $arr;
        }

Here is the caller graph for this function:

cloneFromSource()

ilSetup::cloneFromSource

(

$source_id

)

Clone source client into current client.

Parameters

array

form data

Returns

boolean

Definition at line 1958 of file class.ilSetup.php.

References $client, $insert, $target, ilUtil\delDir(), ilUtil\makeDir(), and ilUtil\rCopy().

        {
                // Getting source and targets
                $source = new ilClient($source_id, $this->db_connections);
                $source->init();
                $target = $this->client;

                // ************************************************
                // **  COPY FILES

                // Cleaning up datadir
                if (! ilUtil::delDir($target->getDataDir())) {
                        $this->error = "Could not delete data dir $target->getDataDir()";
                        //return false;
                }

                // Create empty datadir
                if (!ilUtil::makeDir($target->getDataDir()))
                {
                        $this->error = "could_not_create_base_data_dir :".$target->getDataDir();
                        return false;
                }

                // Copying datadir
                if (! ilUtil::rCopy($source->getDataDir(),$target->getDataDir())) {
                        $this->error = "clone_datadircopyfail";
                        $target->ini->write();
                        return false;
                }

                // Cleaning up Webspacedir
                if (! ilUtil::delDir($target->getWebspaceDir())) {
                        $this->error = "Could not delete webspace dir $target->getWebspaceDir()";
                        //return false;
                }

                // Create empty Webspacedir
                if (!ilUtil::makeDir($target->getWebspaceDir()))
                {
                        $this->error = "could_not_create_base_webspace_dir :".$target->getWebspaceDir();
                        return false;
                }

                // Copying Webspacedir
                if (! ilUtil::rCopy($source->getWebspaceDir(),$target->getWebspaceDir())) {
                        $this->error = "clone_websipacedircopyfail";
                        $target->ini->write();
                        return false;
                }

                // Restore ini file
                $target->ini->write();

                // ************************************************
                // **  COPY DATABASE

                $source->connect();
                if (!$source->db)
        {
            $this->error = "Source database connection failed.";
            return false;
        }

                $target->connect();
                if (!$target->db)
        {
            $this->error = "Target database connection failed.";
            return false;
        }

                $source->connect();
                $srcTables = $source->db->query("SHOW TABLES");
                $target->connect();

                // drop all tables of the target db
                $tarTables = $target->db->query("SHOW TABLES");
                foreach($tarTables->fetchAll() as $cTable)
                {
                        $target->db->query("DROP TABLE IF EXISTS " . $cTable[0]);
                }

                foreach($srcTables->fetchAll() as $cTable){
                        $drop   = $target->db->query("DROP TABLE IF EXISTS " . $cTable[0]);
                        $create = $target->db->query("CREATE TABLE " . $cTable[0] . " LIKE " . $source->getDbName() . "." . $cTable[0]);
            if(!$create) {
                $error = true;
            }
            $insert = $target->db->query("INSERT INTO " . $cTable[0] . " SELECT * FROM ".$source->getDbName().".".$cTable[0]);
        }

                $target->db->query("UPDATE settings SET VALUE = ".$target->db->quote(0, "integer")." WHERE keyword = ".$target->db->quote("inst_id", "text"));
                $target->db->query("UPDATE settings SET VALUE = ".$target->db->quote(0, "integer")." WHERE keyword = ".$target->db->quote("nic_enabled", "text"));
                return true;
        }

Here is the call graph for this function:

createDatabase()

ilSetup::createDatabase

(

$a_collation = ""

)

create client database

Returns

boolean

Definition at line 212 of file class.ilSetup.php.

        {
                if ($this->client->getDBSetup()->isDatabaseInstalled()) {
                        $this->error = $this->lng->txt("database_exists");

                        return false;
                }

                $db_setup = $this->client->getDBSetup();
                return $db_setup->createDatabase($a_collation);
        }

getClient()

ilSetup::getClient

(

)

Returns

ilClient

Definition at line 132 of file class.ilSetup.php.

References $client.

                                    {
                return $this->client;
        }

getError()

ilSetup::getError

(

)

get Error message

Returns

string error message

Definition at line 1544 of file class.ilSetup.php.

References $error.

        {
                if (empty($this->error))
                {
                        return false;
                }

                $error = $this->error;
                $this->error = "";

                return $error;
        }

getPassword()

ilSetup::getPassword

(

)

get setup master password

Returns

string

Definition at line 564 of file class.ilSetup.php.

        {
                return $this->ini->readVariable("setup","pass");
        }

getSessionSettings()

ilSetup::getSessionSettings

(

)

reads session settings from db

Returns

array session_settings

Definition at line 1893 of file class.ilSetup.php.

References $query, $res, $row, array, ilSessionControl\DEFAULT_ALLOW_CLIENT_MAINTENANCE, ilSessionControl\DEFAULT_MAX_COUNT, ilSessionControl\DEFAULT_MAX_IDLE, ilSessionControl\DEFAULT_MAX_IDLE_AFTER_FIRST_REQUEST, ilSessionControl\DEFAULT_MIN_IDLE, ilDBConstants\FETCHMODE_ASSOC, and ilSessionControl\getSettingFields().

        {
                require_once('Services/Authentication/classes/class.ilSessionControl.php');

                $db = $this->client->getDB();

                $setting_fields = ilSessionControl::getSettingFields();

                $query = "SELECT * FROM settings WHERE module = %s " .
                                "AND ".$db->in('keyword', $setting_fields, false, 'text');

                $res = $db->queryF($query, array('text'), array('common'));

                $session_settings = array();
                while($row = $res->fetchRow(ilDBConstants::FETCHMODE_ASSOC))
                {
                        $session_settings[$row['keyword']] = $row['value'];
                }

                foreach( $setting_fields as $field )
                {
                        if( !isset($session_settings[$field]) )
                        {
                                $value = 1;

                                switch($field)
                                {
                                        case 'session_max_count':

                                                $value = ilSessionControl::DEFAULT_MAX_COUNT;
                                                break;

                                        case 'session_min_idle':

                                                $value = ilSessionControl::DEFAULT_MIN_IDLE;
                                                break;

                                        case 'session_max_idle':

                                                $value = ilSessionControl::DEFAULT_MAX_IDLE;
                                                break;

                                        case 'session_max_idle_after_first_request':

                                                $value = ilSessionControl::DEFAULT_MAX_IDLE_AFTER_FIRST_REQUEST;
                                                break;

                                        case 'session_allow_client_maintenance':

                                                $value = ilSessionControl::DEFAULT_ALLOW_CLIENT_MAINTENANCE;
                                                break;
                                }

                                $session_settings[$field] = $value;
                        }
                }

                return $session_settings;
        }

Here is the call graph for this function:

getStatus()

ilSetup::getStatus

(

$client = 0

)

coumpute client status

Parameters

string

client id

Returns

array status information

Definition at line 741 of file class.ilSetup.php.

References $client, array, checkAccess(), checkClientContact(), checkClientDatabase(), checkClientIni(), checkClientLanguages(), checkClientNIC(), checkClientProxySettings(), and checkFinish().

        {
                if (!is_object($client))
                {
                        if ($this->ini_client_exists)
                        {
                                $client =& $this->client;
                        }
                        else
                        {
                                $client = new ilClient(0, $this->db_connections);
                        }
                }

                $status = array();
                $status["ini"] = $this->checkClientIni($client);                // check this one
                $status["db"] = $this->checkClientDatabase($client);
                if ($status["db"]["status"] === false and $status["db"]["update"] !== true)
                {
                        //$status["sess"]["status"] = false;
                        //$status["sess"]["comment"] = $status["db"]["comment"];
                        $status["lang"]["status"] = false;
                        $status["lang"]["comment"] = $status["db"]["comment"];
                        $status["contact"]["status"] = false;
                        $status["contact"]["comment"] = $status["db"]["comment"];

                        $status["proxy"]["status"] = false;
                        $status["proxy"]["comment"] = $status["db"]["comment"];

                        $status["nic"]["status"] = false;
                        $status["nic"]["comment"] = $status["db"]["comment"];
                }
                else
                {
                        //$status["sess"] = $this->checkClientSessionSettings($client);
                        $status["lang"] = $this->checkClientLanguages($client);
                        $status["contact"] = $this->checkClientContact($client);
                        $status["proxy"] = $this->checkClientProxySettings($client);
                        $status["nic"] = $this->checkClientNIC($client);
                        $status["finish"] = $this->checkFinish($client);
                        $status["access"] = $this->checkAccess($client);
                }

                //return value
                return $status;
        }

Here is the call graph for this function:

hasOpCacheEnabled()

ilSetup::hasOpCacheEnabled

(

)

Returns

bool

Definition at line 2138 of file class.ilSetup.php.

Referenced by queryPreliminaries().

                                            {
                $ini_get = ini_get('opcache.enable');

                return ($ini_get === 1 OR $ini_get === '1' OR strtolower($ini_get) === 'on');
        }

Here is the caller graph for this function:

init()

ilSetup::init

(

)

init setup load settings from ilias.ini if exists and sets some constants

Returns

boolean

Definition at line 141 of file class.ilSetup.php.

Referenced by __construct().

        {
                // load data from setup.ini file
                $this->ini = new ilIniFile($this->ini_file_path);

                if (!$this->ini->read())
                {
                        $this->ini->GROUPS = parse_ini_file($this->setup_defaults,true);
                        $this->error = get_class($this).": ".$this->ini->getError();
                        return false;
                }

                $this->setup_password = $this->ini->readVariable("setup","pass");
                $this->default_client = $this->ini->readVariable("clients","default");

                define("ILIAS_DATA_DIR",$this->ini->readVariable("clients","datadir"));
                define("ILIAS_WEB_DIR",$this->ini->readVariable("clients","path"));

                return true;
        }

Here is the caller graph for this function:

installDatabase()

ilSetup::installDatabase

(

)

set the database data

Returns

boolean

Deprecated:

Definition at line 229 of file class.ilSetup.php.

        {
                if (!$this->client->getDBSetup()->isDatabaseConnectable()) {
                        return false;
                }

                if ($this->client->getDBSetup()->installDatabase()) {
                        $this->client->db_installed = true;

                        return true;
                }

                return false;
        }

isAdmin()

ilSetup::isAdmin

(

)

check if current user is admin

Returns

boolean

Definition at line 1110 of file class.ilSetup.php.

        {
                return ($this->access_mode == "admin") ? true : false;
        }

isAuthenticated()

ilSetup::isAuthenticated

(

)

check if current user is authenticated

Returns

boolean

Definition at line 1101 of file class.ilSetup.php.

References $auth.

        {
                return $this->auth;
        }

isDirectoryInOther()

ilSetup::isDirectoryInOther (   $directory,   $other_directory  )

protected

Checks if directory is subdirectory of other directory.

Parameters

string	$directory
string	$other_directory

Returns

bool

Definition at line 2166 of file class.ilSetup.php.

Referenced by checkDataDirSetup(), and checkLogSetup().

                                                                            {
                $other_directory = $other_directory."/";

                return !(strpos($directory, $other_directory) !== 0);
        }

Here is the caller graph for this function:

isInstalled()

ilSetup::isInstalled

(

)

check if client's db is installed

Returns

boolean

Definition at line 1092 of file class.ilSetup.php.

References $ini_ilias_exists.

Referenced by newClient().

        {
                return $this->ini_ilias_exists;
        }

Here is the caller graph for this function:

isValidClientId()

ilSetup::isValidClientId

(

$a_client_id

)

Is valid client id.

Parameters

Definition at line 2150 of file class.ilSetup.php.

        {
                if (!preg_match("/^[A-Za-z0-9]+$/", $a_client_id))
                {
                        return false;
                }
                return true;
        }

loginAsAdmin()

ilSetup::loginAsAdmin

(

$a_password

)

process setup admin login

Parameters

string

password

Returns

boolean

Definition at line 694 of file class.ilSetup.php.

References $_SESSION.

        {
                $a_password = md5($a_password);

                if ($this->ini->readVariable("setup","pass") == $a_password)
                {
                        $_SESSION["auth"] = true;
                        $_SESSION["auth_path"] = ILIAS_HTTP_PATH;
                        $_SESSION["access_mode"] = "admin";
                        return true;
                }

                return false;
        }

loginAsClient()

ilSetup::loginAsClient

(

$a_auth_data

)

process client login

Parameters

array

Returns

boolean

Definition at line 592 of file class.ilSetup.php.

References $_SESSION, $data, $ilDB, $r, ilUserPasswordManager\getInstance(), IL_PASSWD_CRYPTED, and newClient().

        {
                global $ilDB;

                if (empty($a_auth_data["client_id"]))
                {
                        $this->error = "no_client_id";
                        return false;
                }

                if (empty($a_auth_data["username"]))
                {
                        $this->error = "no_username";
                        return false;
                }

                if (empty($a_auth_data["password"]))
                {
                        $this->error = "no_password";
                        return false;
                }

                if (!$this->newClient($a_auth_data["client_id"])) //TT: comment out to get around null db
                {
                        $this->error = "unknown_client_id";
                        unset($this->client);
                        return false;
                }

                if (!$this->client->db_exists)
                {
                        $this->error = "no_db_connect_consult_admin";
                        unset($this->client);
                        return false;
                }

                $s1 = $this->client->db->query("SELECT value from settings WHERE keyword = ".
                        $this->client->db->quote('system_role_id','text'));
                $r1 = $this->client->db->fetchAssoc($s1);
                $system_role_id = $r1["value"];

                $add_usrfields = '';
                if($this->client->db->tableColumnExists('usr_data', 'passwd_enc_type'))
                {
                        $add_usrfields .= ' , usr_data.passwd_enc_type, usr_data.passwd_salt ';
                }
                $q = "SELECT usr_data.usr_id, usr_data.passwd $add_usrfields " .
                        "FROM usr_data " .
                        "LEFT JOIN rbac_ua ON rbac_ua.usr_id=usr_data.usr_id " .
                        "WHERE rbac_ua.rol_id = " . $this->client->db->quote((int)$system_role_id, 'integer') . " " .
                        "AND usr_data.login=" . $this->client->db->quote($a_auth_data["username"], 'text');
                $r = $this->client->db->query($q);
                if(!$this->client->db->numRows($r))
                {
                        $this->error = 'login_invalid';
                        return false;
                }

                $data = $this->client->db->fetchAssoc($r);

                global $ilClientIniFile;

                $ilClientIniFile = $this->client->ini;

                require_once 'Services/User/classes/class.ilUserPasswordManager.php';
                $crypt_type = ilUserPasswordManager::getInstance()->getEncoderName();
                if(strlen($add_usrfields) && ilUserPasswordManager::getInstance()->isEncodingTypeSupported($crypt_type))
                {
                        require_once 'setup/classes/class.ilObjSetupUser.php';
                        $user = new ilObjSetupUser();
                        $user->setPasswd($data['passwd'], IL_PASSWD_CRYPTED);
                        $user->setPasswordEncodingType($data['passwd_enc_type']);
                        $user->setPasswordSalt($data['passwd_salt']);

                        $password_valid = ilUserPasswordManager::getInstance()->verifyPassword($user, $a_auth_data['password']);
                }
                else
                {
                        $password_valid =  $data['passwd'] == md5($a_auth_data['password']);
                }

                if($password_valid)
                {
                        // all checks passed -> user valid
                        $_SESSION['auth']        = true;
                        $_SESSION['auth_path']   = ILIAS_HTTP_PATH;
                        $_SESSION['access_mode'] = 'client';
                        $_SESSION['ClientId']    = $this->client->getId();
                        return true;
                }
                else
                {
                        $this->error = 'login_invalid';
                        return false;
                }
        }

Here is the call graph for this function:

newClient()

ilSetup::newClient

(

$a_client_id = 0

)

creates a client object in $this->client

Parameters

string

client id

Returns

boolean

Definition at line 714 of file class.ilSetup.php.

References $_SESSION, and isInstalled().

Referenced by loginAsClient().

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

                $this->client = new ilClient($a_client_id, $this->db_connections);

                if (!$this->client->init())
                {
//echo "<br>noclientinit";
                        $this->error = get_class($this).": ".$this->client->getError();
                        $_SESSION["ClientId"] = "";
                        return false;
                }

                $_SESSION["ClientId"] = $a_client_id;

                return true;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

printProxyStatus()

ilSetup::printProxyStatus

(

$client

)

Print proxy settings.

private

Definition at line 2059 of file class.ilSetup.php.

References $client, ilUtil\sendFailure(), and ilUtil\sendSuccess().

        {
                require_once './Services/Http/exceptions/class.ilProxyException.php';
                $settings = $client->getAllSettings();

                if((bool)$settings['proxy_status'] == true)
                {
                        try
                        {
                                $err_str = false;
                                $wait_timeout = 100;

                                $fp = @fsockopen($settings['proxy_host'], $settings['proxy_port'],$err_code,$err_str,$wait_timeout);

                                if($err_str)
                                {
                                        throw new ilProxyException($err_str);
                                }

                                fclose($fp);

                                ilUtil::sendSuccess($this->lng->txt('proxy_connectable'));

                        }
                        catch(Exception $e)
                        {
                                ilUtil::sendFailure($this->lng->txt('proxy_not_connectable') . ": " . $e->getMessage());
                        }
                }

        }

Here is the call graph for this function:

queryPreliminaries()

ilSetup::queryPreliminaries

(

)

preliminaries

check if different things are ok for setting up ilias private

Returns

array

Definition at line 520 of file class.ilSetup.php.

References array, checkCookiesEnabled(), checkCreatable(), checkDom(), checkGd(), checkMemoryLimit(), checkOpcacheSettings(), checkPHPVersion(), checkWritable(), checkXsl(), and hasOpCacheEnabled().

Referenced by checkPreliminaries().

        {
                $a = array();
                $a["php"] = $this->checkPHPVersion();
//              $a["mysql"] = $this->checkMySQL();
                $a["root"] = $this->checkWritable();
                $a["folder_create"] = $this->checkCreatable();
                $a["cookies_enabled"] = $this->checkCookiesEnabled();
                $a["dom"] = $this->checkDom();
                $a["xsl"] = $this->checkXsl();
                $a["gd"] = $this->checkGd();
                $a["memory"] = $this->checkMemoryLimit();

                if ($this->hasOpCacheEnabled()) {
                        $a["load_comments"] = $this->checkOpcacheSettings();
                }

                return $a;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

saveMasterSetup()

ilSetup::saveMasterSetup

(

$a_formdata

)

saves intial settings

Parameters

array

form data

Returns

boolean

Definition at line 1120 of file class.ilSetup.php.

References $_SESSION, ilFile\deleteTrailingSlash(), ilUtil\makeDir(), and ilUtil\stripSlashes().

        {
                $datadir_path = preg_replace("/\\\\/","/",ilFile::deleteTrailingSlash(ilUtil::stripSlashes($a_formdata["datadir_path"])));

                if ($a_formdata["chk_datadir_path"] == 1)       // mode create dir
                {
                        if (!ilUtil::makeDir($datadir_path))
                        {
                                $this->error = "create_datadir_failed";
                                return false;
                        }
                }

                // create webspace dir if it does not exist
                if (!@file_exists(ILIAS_ABSOLUTE_PATH."/".$this->ini->readVariable("clients","path")) and !@is_dir(ILIAS_ABSOLUTE_PATH."/".$this->ini->readVariable("clients","path")))
                {
                        if (!ilUtil::makeDir(ILIAS_ABSOLUTE_PATH."/".$this->ini->readVariable("clients","path")))
                        {
                                $this->error = "create_webdir_failed";
                                return false;
                        }
                }

                $form_log_path = preg_replace("/\\\\/","/",ilFile::deleteTrailingSlash(ilUtil::stripSlashes($a_formdata["log_path"])));
                $log_path = substr($form_log_path,0,strrpos($form_log_path,"/"));
                $log_file = substr($form_log_path,strlen($log_path)+1);
                $error_log_path = preg_replace("/\\\\/","/",ilFile::deleteTrailingSlash(ilUtil::stripSlashes($a_formdata["error_log_path"])));

                $this->ini->setVariable("server","http_path",ILIAS_HTTP_PATH);
                $this->ini->setVariable("server","absolute_path",ILIAS_ABSOLUTE_PATH);
                $this->ini->setVariable("server","timezone",preg_replace("/\\\\/","/",ilUtil::stripSlashes($a_formdata["time_zone"])));
                $this->ini->setVariable("clients", "datadir", $datadir_path);
                $this->ini->setVariable("tools", "convert", preg_replace("/\\\\/","/",ilUtil::stripSlashes($a_formdata["convert_path"])));
                $this->ini->setVariable("tools", "zip", preg_replace("/\\\\/","/",ilUtil::stripSlashes($a_formdata["zip_path"])));
                $this->ini->setVariable("tools", "unzip", preg_replace("/\\\\/","/",ilUtil::stripSlashes($a_formdata["unzip_path"])));
                $this->ini->setVariable("tools", "ghostscript", preg_replace("/\\\\/","/",ilUtil::stripSlashes($a_formdata["ghostscript_path"])));
                $this->ini->setVariable("tools", "java", preg_replace("/\\\\/","/",ilUtil::stripSlashes($a_formdata["java_path"])));
                //$this->ini->setVariable("tools", "mkisofs", preg_replace("/\\\\/","/",ilUtil::stripSlashes($a_formdata["mkisofs_path"])));
                $this->ini->setVariable("tools", "ffmpeg", preg_replace("/\\\\/","/",ilUtil::stripSlashes($a_formdata["ffmpeg_path"])));
                $this->ini->setVariable("tools", "latex", ilUtil::stripSlashes($a_formdata["latex_url"]));
                $this->ini->setVariable("tools", "vscantype", preg_replace("/\\\\/","/",ilUtil::stripSlashes($a_formdata["vscanner_type"])));
                $this->ini->setVariable("tools", "scancommand", preg_replace("/\\\\/","/",ilUtil::stripSlashes($a_formdata["scan_command"])));
                $this->ini->setVariable("tools", "cleancommand", preg_replace("/\\\\/","/",ilUtil::stripSlashes($a_formdata["clean_command"])));
                $this->ini->setVariable("tools", "enable_system_styles_management", preg_replace("/\\\\/","/",ilUtil::stripSlashes($a_formdata["enable_system_styles_management"])));
                $this->ini->setVariable("tools", "lessc", preg_replace("/\\\\/","/",ilUtil::stripSlashes($a_formdata["lessc_path"])));

                $this->ini->setVariable("setup", "pass", md5($a_formdata["setup_pass"]));
                $this->ini->setVariable("log", "path", $log_path);
                $this->ini->setVariable("log", "file", $log_file);
                $this->ini->setVariable("log", "enabled", ($a_formdata["chk_log_status"]) ? "0" : 1);
                $this->ini->setVariable("log", "error_path", $error_log_path);

                $this->ini->setVariable("https","auto_https_detect_enabled", ($a_formdata["auto_https_detect_enabled"]) ? 1 : 0);
                $this->ini->setVariable("https","auto_https_detect_header_name", $a_formdata["auto_https_detect_header_name"]);
                $this->ini->setVariable("https","auto_https_detect_header_value", $a_formdata["auto_https_detect_header_value"]);

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

                // everything is fine. so we authenticate the user and set access mode to 'admin'
                $_SESSION["auth"] = true;
                $_SESSION["auth_path"] = ILIAS_HTTP_PATH;
                $_SESSION["access_mode"] = "admin";

                return true;
        }

Here is the call graph for this function:

saveNewClient()

ilSetup::saveNewClient

(

)

saves client.ini & updates client list in ilias.ini

Returns

boolean

Definition at line 166 of file class.ilSetup.php.

References $_SESSION.

Referenced by updateNewClient().

        {
                // save client id to session
                $_SESSION["ClientId"] = $this->client->getId();

                // create client
                if (!$this->client->create())
                {
                        $this->error = $this->client->getError();
                        return false;
                }

                //everything okay
                $this->ini_client_exists = true;

                return true;
        }

Here is the caller graph for this function:

saveProxySettings()

ilSetup::saveProxySettings

(

$proxy_settings

)

Definition at line 2091 of file class.ilSetup.php.

References $query, $res, $row, and array.

        {
                $db = $this->client->getDB();
                $proxy_fields = array('proxy_status','proxy_host','proxy_port');

                foreach($proxy_fields as $field)
                {
                        if( isset($proxy_settings[$field]) )
                        {
                                $query = "SELECT keyword FROM settings WHERE module = %s AND keyword = %s";
                                $res = $db->queryF($query,
                                        array('text', 'text'), array('common', $field));

                                $row = array();
                                while($row = $db->fetchAssoc($res)) break;

                                if( count($row) > 0 )
                                {
                                        $db->update(
                                                'settings',
                                                array(
                                                        'value' => array('text', $proxy_settings[$field])
                                                ),
                                                array(
                                                        'module' => array('text', 'common'),
                                                        'keyword' => array('text', $field)
                                                )
                                        );
                                }
                                else
                                {
                                        $db->insert(
                                                'settings',
                                                array(
                                                        'module' => array('text', 'common'),
                                                        'keyword' => array('text', $field),
                                                        'value' => array('text', $proxy_settings[$field])
                                                )
                                        );
                                }
                        }
                }
        }

setClient()

ilSetup::setClient

(

$a_cl

)

Parameters

$a_cl

Definition at line 124 of file class.ilSetup.php.

                                         {
                $this->client = $a_cl;
        }

setPassword()

ilSetup::setPassword

(

$a_password

)

set setup master password

Parameters

string

password

Returns

boolean

Definition at line 574 of file class.ilSetup.php.

        {
                $this->ini->setVariable("setup","pass",md5($a_password));

                if ($this->ini->write() == false)
                {
                        $this->error = $this->ini->getError();
                        return false;
                }

                return true;
        }

setSessionSettings()

ilSetup::setSessionSettings

(

$session_settings

)

saves session settings to db

Parameters

array

$session_settings

Definition at line 1833 of file class.ilSetup.php.

References $query, $res, $row, array, ilDBConstants\FETCHMODE_ASSOC, ilSessionControl\getSettingFields(), and ilUtil\sendInfo().

        {
                require_once('Services/Authentication/classes/class.ilSessionControl.php');

                $db = $this->client->getDB();

                $setting_fields = ilSessionControl::getSettingFields();

                $i = 0;
                foreach($setting_fields as $field)
                {
                        if( isset($session_settings[$field]) )
                        {
                                $query = "SELECT keyword FROM settings WHERE module = %s AND keyword = %s";
                                $res = $db->queryF($query,
                                                array('text', 'text'), array('common', $field));

                                $row = array();
                                while($row = $res->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) break;

                                if( count($row) > 0 )
                                {
                                        $db->update(
                                                'settings',
                                                array(
                                                        'value' => array('text', $session_settings[$field])
                                                ),
                                                array(
                                                        'module' => array('text', 'common'),
                                                        'keyword' => array('text', $field)
                                                )
                                        );
                                }
                                else
                                {
                                        $db->insert(
                                                'settings',
                                                array(
                                                        'module' => array('text', 'common'),
                                                        'keyword' => array('text', $field),
                                                        'value' => array('text', $session_settings[$field])
                                                )
                                        );
                                }

                                $i++;
                        }
                }

                if($i < 4) $message = $this->lng->txt("session_settings_not_saved");
                else $message = $this->lng->txt("settings_saved");

                ilUtil::sendInfo($message);
        }

Here is the call graph for this function:

testConvert()

ilSetup::testConvert

(

$a_convert_path

)

Check convert program.

Parameters

string

convert path

Returns

boolean true -> OK | false -> not OK

Definition at line 1577 of file class.ilSetup.php.

Referenced by checkToolsSetup().

        {
                if (trim($a_convert_path) == "")
                {
                        return "no_path_convert";
                }
                if (!is_file($a_convert_path))
                {
                        return "check_failed_convert";
                }

                return "";

        }

Here is the caller graph for this function:

testGhostscript()

ilSetup::testGhostscript

(

$a_ghostscript_path

)

Check ghostscript program.

Parameters

string

ghostscript path

Returns

boolean true -> OK | false -> not OK

Definition at line 1598 of file class.ilSetup.php.

Referenced by checkToolsSetup().

        {
                // ghostscript is optional, so empty path is ok
                if (trim($a_ghostscript_path) == "")
                {
                        return "";
                }
                if (!is_file($a_ghostscript_path))
                {
                        return "check_failed_ghostscript";
                }

                return "";
        }

Here is the caller graph for this function:

testJava()

ilSetup::testJava

(

$a_java_path

)

Check JVM.

Parameters

string

java path

Returns

boolean true -> OK | false -> not OK

Definition at line 1619 of file class.ilSetup.php.

Referenced by checkToolsSetup().

        {
                // java is optional, so empty path is ok
                if (trim($a_java_path) == "")
                {
                        return "";
                }

                if (!is_file($a_java_path))
                {
                        return "check_failed_java";
                }

                return "";
/*
                exec($a_java_path, $out, $back);

                unset($out);

                return ($back != 1) ? false : true;
*/
        }

Here is the caller graph for this function:

testLatex()

ilSetup::testLatex

(

$a_latex_url

)

Check latex cgi script.

Parameters

string

latex cgi url

Returns

boolean true -> OK | false -> not OK

Definition at line 1648 of file class.ilSetup.php.

References $http, $result, and ilUtil\stripSlashes().

Referenced by checkToolsSetup().

        {
                // latex is optional, so empty path is ok
                if (trim($a_latex_url) == "")
                {
                        return "";
                }

                // open the URL
                include_once "./setup/classes/class.ilHttpRequest.php";
                $http = new ilHttpRequest(ilUtil::stripSlashes($a_latex_url) . "?x_0");
                $result = @$http->downloadToString();
                if ((strpos((substr($result, 0, 5)), "PNG") !== FALSE) || (strpos((substr($result, 0, 5)), "GIF") !== FALSE))
                {
                        return "";
                }
                else
                {
                        return "check_failed_latex";;
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

testUnzip()

ilSetup::testUnzip

(

$a_unzip_path

)

Check unzip program.

Parameters

string

unzip_path

Returns

boolean true -> OK | false -> not OK

Definition at line 1729 of file class.ilSetup.php.

Referenced by checkToolsSetup().

        {
                if (trim($a_unzip_path) == "")
                {
                        return "no_path_unzip";
                }
                if (!is_file($a_unzip_path))
                {
                        return "check_failed_unzip";
                }

                return "";
/*
                $curDir = getcwd();

                chdir(ILIAS_ABSOLUTE_PATH);

                if (file_exists(ILIAS_ABSOLUTE_PATH."/unzip_test_file.zip"))
                {
                        $unzipCmd = $a_unzip_path." unzip_test_file.zip";
                        exec($unzipCmd);
                }

                chdir($curDir);

                // check wether unzip extracted the test file or not
                if (file_exists(ILIAS_ABSOLUTE_PATH."/unzip_test_file.txt"))
                {
                        unlink(ILIAS_ABSOLUTE_PATH."/unzip_test_file.txt");

                        return true;
                }
                else
                {
                        return false;
                }
*/
        }

Here is the caller graph for this function:

testZip()

ilSetup::testZip

(

$a_zip_path

)

Check zip program.

Parameters

string

zip path

Returns

boolean true -> OK | false -> not OK

Definition at line 1676 of file class.ilSetup.php.

Referenced by checkToolsSetup().

        {
                if (trim($a_zip_path) == "")
                {
                        return "no_path_zip";
                }
                if (!is_file($a_zip_path))
                {
                        return "check_failed_zip";
                }

                return "";
/*
                // create test file and run zip
                $fp = fopen(ILIAS_ABSOLUTE_PATH."/test.dat", "w");

                fwrite($fp, "test");
                fclose($fp);

                if (file_exists(ILIAS_ABSOLUTE_PATH."/test.dat"))
                {
                        $curDir = getcwd();
                        chdir(ILIAS_ABSOLUTE_PATH);

                        $zipCmd = $a_zip_path." -m zip_test_file.zip test.dat";

                        exec($zipCmd);

                        chdir($curDir);

                }

                // check wether zip generated test file or not
                if (file_exists(ILIAS_ABSOLUTE_PATH."/zip_test_file.zip"))
                {
                        unlink(ILIAS_ABSOLUTE_PATH."/zip_test_file.zip");
                        return true;
                }
                else
                {
                        unlink(ILIAS_ABSOLUTE_PATH."/test.dat");
                        return false;
                }
*/
        }

Here is the caller graph for this function:

unzip()

ilSetup::unzip	(		$a_file,
			$overwrite = false
	)

unzip file

Parameters

string	$a_file	full path/filename
boolean	$overwrite	pass true to overwrite existing files

Definition at line 1774 of file class.ilSetup.php.

References $file, array, ilUtil\createDirectory(), and ilUtil\escapeShellArg().

        {
                //global $ilias;

                $pathinfo = pathinfo($a_file);
                $dir = $pathinfo["dirname"];
                $file = $pathinfo["basename"];

                // unzip
                $cdir = getcwd();
                chdir($dir);
                $unzip = $this->ini->readVariable("tools","unzip");
                $unzipcmd = $unzip." -Z -1 ".ilUtil::escapeShellArg($file);
                exec($unzipcmd, $arr);
                $zdirs = array();

                foreach($arr as $line)
                {
                        if(is_int(strpos($line, "/")))
                        {
                                $zdir = substr($line, 0, strrpos($line, "/"));
                                $nr = substr_count($zdir, "/");
                                //echo $zdir." ".$nr."<br>";
                                while ($zdir != "")
                                {
                                        $nr = substr_count($zdir, "/");
                                        $zdirs[$zdir] = $nr;                            // collect directories
                                        //echo $dir." ".$nr."<br>";
                                        $zdir = substr($zdir, 0, strrpos($zdir, "/"));
                                }
                        }
                }

                asort($zdirs);

                foreach($zdirs as $zdir => $nr)                         // create directories
                {
                        ilUtil::createDirectory($zdir);
                }

                // real unzip
                if ($overvwrite)
                {
                        $unzipcmd = $unzip." ".ilUtil::escapeShellArg($file);
                }
                else
                {
                        $unzipcmd = $unzip." -o ".ilUtil::escapeShellArg($file);
                }
                exec($unzipcmd);

                chdir($cdir);
        }

Here is the call graph for this function:

updateMasterSettings()

ilSetup::updateMasterSettings

(

$a_formdata

)

updates settings

Parameters

array

form data

Returns

boolean

Definition at line 1195 of file class.ilSetup.php.

References ilFile\deleteTrailingSlash(), and ilUtil\stripSlashes().

        {
                $convert_path = preg_replace("/\\\\/","/",ilUtil::stripSlashes($a_formdata["convert_path"]));
                $zip_path = preg_replace("/\\\\/","/",ilUtil::stripSlashes($a_formdata["zip_path"]));
                $unzip_path = preg_replace("/\\\\/","/",ilUtil::stripSlashes($a_formdata["unzip_path"]));
                $ghostscript_path = preg_replace("/\\\\/","/",ilUtil::stripSlashes($a_formdata["ghostscript_path"]));
                $java_path = preg_replace("/\\\\/","/",ilUtil::stripSlashes($a_formdata["java_path"]));
                //$mkisofs_path = preg_replace("/\\\\/","/",ilUtil::stripSlashes($a_formdata["mkisofs_path"]));
                $ffmpeg_path = preg_replace("/\\\\/","/",ilUtil::stripSlashes($a_formdata["ffmpeg_path"]));
                $latex_url = ilUtil::stripSlashes($a_formdata["latex_url"]);
                $fop_path = preg_replace("/\\\\/","/",ilUtil::stripSlashes($a_formdata["fop_path"]));
                $scan_type = preg_replace("/\\\\/","/",ilUtil::stripSlashes($a_formdata["vscanner_type"]));
                $scan_command = preg_replace("/\\\\/","/",ilUtil::stripSlashes($a_formdata["scan_command"]));
                $clean_command = preg_replace("/\\\\/","/",ilUtil::stripSlashes($a_formdata["clean_command"]));
                $enable_system_styles_management = preg_replace("/\\\\/","/",ilUtil::stripSlashes($a_formdata["enable_system_styles_management"]));
                $lessc_path = preg_replace("/\\\\/","/",ilUtil::stripSlashes($a_formdata["lessc_path"]));

                $this->ini->setVariable("tools", "convert", $convert_path);
                $this->ini->setVariable("tools", "zip", $zip_path);
                $this->ini->setVariable("tools", "unzip", $unzip_path);
                $this->ini->setVariable("tools", "ghostscript", $ghostscript_path);
                $this->ini->setVariable("tools", "java", $java_path);
                //$this->ini->setVariable("tools", "mkisofs", $mkisofs_path);
                $this->ini->setVariable("tools", "ffmpeg", $ffmpeg_path);
                $this->ini->setVariable("tools", "latex", $latex_url);
                $this->ini->setVariable("tools", "fop", $fop_path);
                $this->ini->setVariable("tools", "vscantype", $scan_type);
                $this->ini->setVariable("tools", "scancommand", $scan_command);
                $this->ini->setVariable("tools", "cleancommand", $clean_command);
                $this->ini->setVariable("tools", "lessc", $lessc_path);
                $this->ini->setVariable("tools", "enable_system_styles_management", $enable_system_styles_management);

                $form_log_path = preg_replace("/\\\\/","/",ilFile::deleteTrailingSlash(ilUtil::stripSlashes($a_formdata["log_path"])));
                $log_path = substr($form_log_path,0,strrpos($form_log_path,"/"));
                $log_file = substr($form_log_path,strlen($log_path)+1);

                $error_log_path = preg_replace("/\\\\/","/",ilFile::deleteTrailingSlash(ilUtil::stripSlashes($a_formdata["error_log_path"])));

                $this->ini->setVariable("log", "path", $log_path);
                $this->ini->setVariable("log", "file", $log_file);
                $this->ini->setVariable("log", "enabled", ($a_formdata["chk_log_status"]) ? "0" : 1);
                $this->ini->setVariable("log", "error_path", $error_log_path);
                $this->ini->setVariable("server","timezone",preg_replace("/\\\\/","/",ilUtil::stripSlashes($a_formdata["time_zone"])));

                $this->ini->setVariable("https","auto_https_detect_enabled",($a_formdata["auto_https_detect_enabled"]) ? 1 : 0);
                $this->ini->setVariable("https","auto_https_detect_header_name", $a_formdata["auto_https_detect_header_name"]);
                $this->ini->setVariable("https","auto_https_detect_header_value", $a_formdata["auto_https_detect_header_value"]);

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

                return true;
        }

Here is the call graph for this function:

updateNewClient()

ilSetup::updateNewClient

(

$a_old_client_id

)

update client.ini & move data dirs does not work correctly at this time - DISABLED

Returns

boolean

Definition at line 189 of file class.ilSetup.php.

References ilUtil\delDir(), and saveNewClient().

        {
                return true;
                //var_dump("<pre>",$this->client,"</pre>");exit;
                //Error Handling disabled!! caused by missing PEAR
                if ($a_old_client_id != $this->client->getId())
                {
                        $this->saveNewClient();

                        ilUtil::delDir(ILIAS_ABSOLUTE_PATH."/".ILIAS_WEB_DIR."/".$a_old_client_id);
                        ilUtil::delDir(ILIAS_DATA_DIR."/".$a_old_client_id);
                }

                //everything okay
                $this->ini_client_exists = true;

                return true;
        }

Here is the call graph for this function:

Field Documentation

$access_mode

ilSetup::$access_mode

Definition at line 58 of file class.ilSetup.php.

$auth

ilSetup::$auth

Definition at line 57 of file class.ilSetup.php.

Referenced by isAuthenticated().

$client

ilSetup::$client

Definition at line 118 of file class.ilSetup.php.

Referenced by checkAccess(), checkClientContact(), checkClientIni(), checkClientNIC(), checkFinish(), cloneFromSource(), getClient(), getStatus(), and printProxyStatus().

$db

ilSetup::$db

Definition at line 49 of file class.ilSetup.php.

$default_client

ilSetup::$default_client

Definition at line 52 of file class.ilSetup.php.

$dsn

ilSetup::$dsn = ""

Definition at line 42 of file class.ilSetup.php.

$error

ilSetup::$error = ""

Definition at line 19 of file class.ilSetup.php.

Referenced by getError().

$ilias_nic_server

ilSetup::$ilias_nic_server = "https://nic.ilias.de/index.php"

Definition at line 25 of file class.ilSetup.php.

$ini

ilSetup::$ini

Definition at line 17 of file class.ilSetup.php.

$ini_client_exists

ilSetup::$ini_client_exists = false

Definition at line 22 of file class.ilSetup.php.

$ini_file_path

ilSetup::$ini_file_path

Definition at line 18 of file class.ilSetup.php.

$ini_ilias_exists

ilSetup::$ini_ilias_exists = false

Definition at line 21 of file class.ilSetup.php.

Referenced by isInstalled().

$preliminaries

ilSetup::$preliminaries = true

Definition at line 28 of file class.ilSetup.php.

$preliminaries_result

ilSetup::$preliminaries_result = array()

Definition at line 27 of file class.ilSetup.php.

$safe_mode

ilSetup::$safe_mode

Definition at line 54 of file class.ilSetup.php.

$safe_mode_exec_dir

ilSetup::$safe_mode_exec_dir

Definition at line 55 of file class.ilSetup.php.

$setup_defaults

ilSetup::$setup_defaults

Definition at line 24 of file class.ilSetup.php.

$setup_password

ilSetup::$setup_password

Definition at line 51 of file class.ilSetup.php.

$SQL_FILE

ilSetup::$SQL_FILE = "./setup/sql/ilias3.sql"

Definition at line 35 of file class.ilSetup.php.

---

The documentation for this class was generated from the following file:

• setup/classes/class.ilSetup.php