ILIAS  Release_4_4_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Data Fields
ilSetup Class Reference

Setup class. More...

+ Inheritance diagram for ilSetup:
+ Collaboration diagram for ilSetup:

Public Member Functions

 ilSetup ($a_auth, $a_auth_type)
 constructor
 setClient ($a_cl)
 Set Client.
 getClient ()
 Get Client.
 init ()
 init setup load settings from ilias.ini if exists and sets some constants
 saveNewClient ()
 saves client.ini & updates client list in ilias.ini
 updateNewClient ($a_old_client_id)
 update client.ini & move data dirs does not work correctly at this time - DISABLED
 createDatabase ($a_collation="")
 create client database
 installDatabase ()
 set the database data
 getline ($fp, $delim)
 readDump ($db, $file)
 execute a query
 checkIniFileExists ()
 check if inifile exists
 checkWritable ()
 check for writable directory
 checkCreatable ($a_dir=".")
 check for permission to create new folders in specified directory
 checkCookiesEnabled ()
 check cookies enabled
 checkPHPVersion ()
 check for PHP version
 checkMySQL ()
 Check MySQL.
 checkAuth ()
 check authentication status
 checkDom ()
 Check MySQL.
 checkXsl ()
 Check MySQL.
 checkGd ()
 Check MySQL.
 checkMemoryLimit ()
 Check Memory Limit.
 queryPreliminaries ()
 preliminaries
 checkPreliminaries ()
 check all prliminaries
 getPassword ()
 get setup master password
 setPassword ($a_password)
 set setup master password
 loginAsClient ($a_auth_data)
 process client login
 loginAsAdmin ($a_password)
 process setup admin login
 newClient ($a_client_id=0)
 creates a client object in $this->client
 getStatus ($client=0)
 coumpute client status
 checkFinish (&$client)
 check if client setup was finished
 checkAccess (&$client)
 check client access status
 checkClientIni (&$client)
 check client ini status
 checkClientDatabase (&$client)
 check client db status
 checkClientSessionSettings (&$client, $a_as_bool=false)
 check client session config status
 checkClientProxySettings (&$client)
 check client session config status
 checkClientLanguages (&$client)
 check client installed languages status
 checkClientContact (&$client)
 check client contact data status
 checkClientNIC (&$client)
 check client nic status
 isInstalled ()
 check if client's db is installed
 isAuthenticated ()
 check if current user is authenticated
 isAdmin ()
 check if current user is admin
 saveMasterSetup ($a_formdata)
 saves intial settings
 updateMasterSettings ($a_formdata)
 updates settings
 checkToolsSetup ($a_formdata)
 check pathes to 3rd party software
 checkDataDirSetup ($a_formdata)
 check datadir path
 checkPasswordSetup ($a_formdata)
 check setup password
 checkLogSetup ($a_formdata)
 check log path
 getError ()
 get Error message
 _ilSetup ()
 destructor
 testConvert ($a_convert_path)
 Check convert program.
 testGhostscript ($a_ghostscript_path)
 Check ghostscript program.
 testJava ($a_java_path)
 Check JVM.
 testLatex ($a_latex_url)
 Check latex cgi script.
 testZip ($a_zip_path)
 Check zip program.
 testUnzip ($a_unzip_path)
 Check unzip program.
 testHtmldoc ($a_htmldoc_path)
 Check htmldoc program.
 unzip ($a_file, $overwrite=false)
 unzip file
 setSessionSettings ($session_settings)
 saves session settings to db
 getSessionSettings ()
 reads session settings from db
 cloneFromSource ($source_id)
 Clone source client into current client.
 printProxyStatus ($client)
 Print proxy settings.
 saveProxySettings ($proxy_settings)
- Public Member Functions inherited from PEAR
 PEAR ($error_class=null)
 Constructor.
 _PEAR ()
 Destructor (the emulated type of...).
& getStaticProperty ($class, $var)
 If you have a class that's mostly/entirely static, and you need static properties, you can use this method to simulate them.
 registerShutdownFunc ($func, $args=array())
 Use this function to register a shutdown method for static classes.
 isError ($data, $code=null)
 Tell whether a value is a PEAR error.
 setErrorHandling ($mode=null, $options=null)
 Sets how errors generated by this object should be handled.
 expectError ($code= '*')
 This method is used to tell which errors you expect to get.
 popExpect ()
 This method pops one element off the expected error codes stack.
 _checkDelExpect ($error_code)
 This method checks unsets an error code if available.
 delExpect ($error_code)
 This method deletes all occurences of the specified element from the expected error codes stack.
& raiseError ($message=null, $code=null, $mode=null, $options=null, $userinfo=null, $error_class=null, $skipmsg=false)
 This method is a wrapper that returns an instance of the configured error class with this object's default error handling applied.
& throwError ($message=null, $code=null, $userinfo=null)
 Simpler form of raiseError with fewer options.
 staticPushErrorHandling ($mode, $options=null)
 staticPopErrorHandling ()
 pushErrorHandling ($mode, $options=null)
 Push a new error handler on top of the error handler options stack.
 popErrorHandling ()
 Pop the last error handler used.
 loadExtension ($ext)
 OS independant PHP extension load.

Data Fields

 $ini
 $ini_file_path
 $error = ""
 $ini_ilias_exists = false
 $ini_client_exists = false
 $setup_defaults
 $ilias_nic_server = "http://www.ilias.de/ilias-nic/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
- Data Fields inherited from PEAR
 $_debug = false
 $_default_error_mode = null
 $_default_error_options = null
 $_default_error_handler = ''
 $_error_class = 'PEAR_Error'
 $_expected_errors = array()

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:
class.ilSetup.php 52581 2014-08-25 10:01:55Z akill

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

Member Function Documentation

ilSetup::_ilSetup ( )

destructor

Returns
boolean

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

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

check client access status

Parameters
objectclient
Returns
boolean

Definition at line 886 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:

ilSetup::checkAuth ( )

check authentication status

Returns
boolean

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

References $_SESSION.

Referenced by ilSetup().

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

+ Here is the caller graph for this function:

ilSetup::checkClientContact ( &  $client)

check client contact data status

Parameters
objectclient
Returns
boolean

Definition at line 1101 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:

ilSetup::checkClientDatabase ( &  $client)

check client db status

Parameters
objectclient
Returns
boolean

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

References $client.

Referenced by getStatus().

{
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");
//$this->lng->setDbHandler($client->db);
include_once "./Services/Database/classes/class.ilDBUpdate.php";
$ilDB = $client->db;
$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
$cset = $ilDB->query("SELECT count(*) as cnt FROM ctrl_calls");
$crec = $ilDB->fetchAssoc($cset);
if ($crec["cnt"] == 0)
{
$arr["status"] = false;
$arr["comment"] = $this->lng->txt("db_control_structure_missing");
$arr["update"] = true;
return $arr;
}
//$arr["comment"] = "version ".$dbupdate->getCurrentVersion();
return $arr;
}

+ Here is the caller graph for this function:

ilSetup::checkClientIni ( &  $client)

check client ini status

Parameters
objectclient
Returns
boolean

Definition at line 907 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:

ilSetup::checkClientLanguages ( &  $client)

check client installed languages status

Parameters
objectclient
Returns
boolean

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

Referenced by getStatus().

{
$installed_langs = $this->lng->getInstalledLanguages();
$count = count($installed_langs);
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");
}
return $arr;
}

+ Here is the caller graph for this function:

ilSetup::checkClientNIC ( &  $client)

check client nic status

Parameters
objectclient
Returns
boolean

Definition at line 1132 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:

ilSetup::checkClientProxySettings ( &  $client)

check client session config status

Parameters
objectclient

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

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

Referenced by getStatus().

{
global $ilDB;
$db = $ilDB;
$fields = array('proxy_status','proxy_host','proxy_port');
$query = "SELECT keyword, value FROM settings WHERE ".$db->in('keyword', $fields, false, 'text');
$res = $db->query($query);
$proxy_settings = array();
$already_saved = false;
while($row = $db->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 caller graph for this function:

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

check client session config status

Parameters
objectclient
Returns
boolean

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

References $db, $query, $res, $row, DB_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(DB_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:

ilSetup::checkCookiesEnabled ( )

check cookies enabled

Returns
array

Definition at line 451 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:

ilSetup::checkCreatable (   $a_dir = ".")

check for permission to create new folders in specified directory

Parameters
stringdirectory
Returns
array

Definition at line 425 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:

ilSetup::checkDataDirSetup (   $a_formdata)

check datadir path

Parameters
arrayform data
Returns
boolean

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

References ilFile\deleteTrailingSlash(), ILIAS_ABSOLUTE_PATH, 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 (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 (!is_writable($datadir_path))
{
$this->error = "cannot_create_datadir_no_write_access";
return false;
}
}
return true;
}

+ Here is the call graph for this function:

ilSetup::checkDom ( )

Check MySQL.

Returns
boolean

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

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:

ilSetup::checkFinish ( &  $client)

check if client setup was finished

Parameters
objectclient
Returns
boolean

Definition at line 865 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:

ilSetup::checkGd ( )

Check MySQL.

Returns
boolean

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

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:

ilSetup::checkIniFileExists ( )

check if inifile exists

Returns
boolean

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

{
$a = @file_exists($this->INI_FILE);
return $a;
}
ilSetup::checkLogSetup (   $a_formdata)

check log path

Parameters
arrayform data
Returns
boolean

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

References ilFile\deleteTrailingSlash(), 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 (!@touch($log_path))
{
$this->error = "could_not_create_logfile";
return false;
}
}
return true;
}

+ Here is the call graph for this function:

ilSetup::checkMemoryLimit ( )

Check Memory Limit.

Returns
boolean

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

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:

ilSetup::checkMySQL ( )

Check MySQL.

Returns
boolean

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

{
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;
}
ilSetup::checkPasswordSetup (   $a_formdata)

check setup password

Parameters
arrayform data
Returns
boolean

Definition at line 1538 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;
}
ilSetup::checkPHPVersion ( )

check for PHP version

Returns
array

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

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:

ilSetup::checkPreliminaries ( )

check all prliminaries

Returns
boolean

Definition at line 651 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:

ilSetup::checkToolsSetup (   $a_formdata)

check pathes to 3rd party software

Parameters
arrayform data
Returns
boolean

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

References ilUtil\stripSlashes(), testConvert(), testGhostscript(), testHtmldoc(), 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;
}
}
// htmldoc path
if (!isset($a_formdata["chk_htmldoc_path"]))
{
// convert backslashes to forwardslashes
$htmldoc_path = preg_replace("/\\\\/","/",ilUtil::stripSlashes($a_formdata["htmldoc_path"]));
if (empty($htmldoc_path))
{
$this->error = "no_path_htmldoc";
return false;
}
if (!$this->testHtmldoc($htmldoc_path))
{
$this->error = "check_failed_htmldoc";
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 (!$this->testHtmldoc($mkisofs_path))
{
$this->error = "check_failed_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:

ilSetup::checkWritable ( )

check for writable directory

Parameters
stringdirectory
Returns
array

Definition at line 396 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:

ilSetup::checkXsl ( )

Check MySQL.

Returns
boolean

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

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:

ilSetup::cloneFromSource (   $source_id)

Clone source client into current client.

Parameters
arrayform data
Returns
boolean

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

References $client, $error, 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]);
}
return true;
}

+ Here is the call graph for this function:

ilSetup::createDatabase (   $a_collation = "")

create client database

Returns
boolean

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

References $db, and MDB2\isError().

{
if ($this->client->checkDatabaseExists())
{
$this->error = $this->lng->txt("database_exists");
return false;
}
$this->client->getDB()->connectHost(true);
//create database
$db = $this->client->getDB();
if (MDB2::isError($db))
{
$this->error = "connection_failed";
return false;
}
$r = $db->createDatabase($this->client->getdbName(),
"utf8", $a_collation);
if (MDB2::isError($r))
{
$this->error = "create_database_failed";
return false;
}
//database is created, now disconnect and reconnect
$db->disconnect();
$this->client->db_exists = true;
return true;
}

+ Here is the call graph for this function:

ilSetup::getClient ( )

Get Client.

Returns
object client

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

References $client.

{
return $this->client;
}
ilSetup::getError ( )

get Error message

Returns
string error message

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

References $error.

{
if (empty($this->error))
{
return false;
}
$error = $this->error;
$this->error = "";
return $error;
}
ilSetup::getline (   $fp,
  $delim 
)

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

References $result.

Referenced by readDump().

{
$result = "";
while( !feof( $fp ) )
{
$tmp = fgetc( $fp );
if( $tmp == $delim )
return $result;
$result .= $tmp;
}
return $result;
}

+ Here is the caller graph for this function:

ilSetup::getPassword ( )

get setup master password

Returns
string

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

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

reads session settings from db

Returns
array session_settings

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

References $db, $query, $res, $row, DB_FETCHMODE_ASSOC, ilSessionControl\DEFAULT_ALLOW_CLIENT_MAINTENANCE, ilSessionControl\DEFAULT_MAX_COUNT, ilSessionControl\DEFAULT_MAX_IDLE, ilSessionControl\DEFAULT_MAX_IDLE_AFTER_FIRST_REQUEST, ilSessionControl\DEFAULT_MIN_IDLE, 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(DB_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:

ilSetup::getStatus (   $client = 0)

coumpute client status

Parameters
stringclient id
Returns
array status information

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

References $client, 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:

ilSetup::ilSetup (   $a_auth,
  $a_auth_type 
)

constructor

Parameters
booleanuser is authenticated? (true) or not (false)
stringuser is admin or common user

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

References $lng, $log, checkAuth(), ilFile\deleteTrailingSlash(), ILIAS_ABSOLUTE_PATH, init(), PEAR\PEAR(), PEAR_ERROR_CALLBACK, and PEAR\setErrorHandling().

{
global $log, $lng;
$this->PEAR();
$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"));
}
// Error Handling
$this->error_obj = new ilErrorHandling();
$this->setErrorHandling(PEAR_ERROR_CALLBACK,array($this->error_obj,'errorHandler'));
// 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:

ilSetup::init ( )

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

Returns
boolean

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

Referenced by ilSetup().

{
// 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:

ilSetup::installDatabase ( )

set the database data

Returns
boolean

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

References readDump().

{
/* if (!$this->client->checkDatabaseHost())
{
$this->error = "no_connection_to_host";
return false;
}*/
if (!$this->client->connect())
{
return false;
}
//take sql dump an put it in
if ($this->readDump($this->client->db, $this->SQL_FILE))
{
$this->client->db_installed = true;
return true;
}
else
{
return false;
}
}

+ Here is the call graph for this function:

ilSetup::isAdmin ( )

check if current user is admin

Returns
boolean

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

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

check if current user is authenticated

Returns
boolean

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

References $auth.

{
return $this->auth;
}
ilSetup::isInstalled ( )

check if client's db is installed

Returns
boolean

Definition at line 1171 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:

ilSetup::loginAsAdmin (   $a_password)

process setup admin login

Parameters
stringpassword
Returns
boolean

Definition at line 766 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;
}
ilSetup::loginAsClient (   $a_auth_data)

process client login

Parameters
array
Returns
boolean

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

References $_SESSION, 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"]))
{
$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"];
$q = "SELECT usr_data.usr_id 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')." ".
"AND usr_data.passwd=".$this->client->db->quote(md5($a_auth_data["password"]),'text');
$r = $this->client->db->query($q);
if (!$r->numRows())
{
$this->error = "login_invalid";
return false;
}
// 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;
}

+ Here is the call graph for this function:

ilSetup::newClient (   $a_client_id = 0)

creates a client object in $this->client

Parameters
stringclient id
Returns
boolean

Definition at line 786 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:

ilSetup::printProxyStatus (   $client)

Print proxy settings.

private

Verifies the proxy server connection

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

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

{
require_once './Services/Http/exceptions/class.ilProxyException.php';
$settings = $client->getAllSettings();
if((bool)$settings['proxy_status'] == true)
{
try
{
require_once 'Services/PEAR/lib/Net/Socket.php';
$socket = new Net_Socket();
$socket->setErrorHandling(PEAR_ERROR_RETURN);
$response = $socket->connect($settings['proxy_host'], $settings['proxy_port']);
if(!is_bool($response))
{
global $lng;
throw new ilProxyException(strlen($response) ? $response : $lng->txt('proxy_not_connectable'));
}
ilUtil::sendSuccess($this->lng->txt('proxy_connectable'));
}
catch(ilProxyException $e)
{
ilUtil::sendFailure($this->lng->txt('proxy_pear_net_socket_error').': '.$e->getMessage());
}
}
}

+ Here is the call graph for this function:

ilSetup::queryPreliminaries ( )

preliminaries

check if different things are ok for setting up ilias private

Returns
array

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

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

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();
return $a;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilSetup::readDump (   $db,
  $file 
)

execute a query

Parameters
string
string
Returns
boolean ture if query was processed successfully

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

References $db, $file, $reader, and getline().

Referenced by installDatabase().

{
// mysql (old procedure)
if ($db->getDBType() == "mysql")
{
$fp = fopen($file, 'r');
while(!feof($fp))
{
//$line = trim(fgets($fp, 200000));
$line = trim($this->getline($fp, "\n"));
if ($line != "" && substr($line,0,1)!="#"
&& substr($line,0,1)!="-")
{
//take line per line, until last char is ";"
if (substr($line,-1)==";")
{
//query is complete
$q .= " ".substr($line,0,-1);
$r = $db->query($q);
if ($db->getErrorNo() > 0)
{
echo "<br />ERROR: ".$db->getError().
"<br />SQL: $q";
return false;
}
unset($q);
unset($line);
} //if
else
{
$q .= " ".$line;
} //else
} //if
} //for
fclose($fp);
}
#echo 'Start Memory: '.memory_get_usage().' peak: '.memory_get_peak_usage();
if (in_array($db->getDBType(), array("oracle", "postgres", "innodb")))
{
if(@is_dir('./setup/sql/ilDBTemplate'))
{
include_once './Services/Database/classes/class.ilArrayTableDataParser.php';
include_once './Services/Xml/exceptions/class.ilSaxParserException.php';
$reader = new tmpDirectoyIterator('./setup/sql/ilDBTemplate');
foreach($reader as $file)
{
eval(file_get_contents('./setup/sql/ilDBTemplate/'.$file));
try
{
$parser = new ilArrayTableDataParser('./setup/sql/ilDBTemplate/'.$file.'_inserts');
#$parser = new ilSimpleXMLTableDataParser('./setup/sql/ilDBTemplate/'.$file.'.xml');
$parser->startParsing();
#echo 'Table: '.$file.', memory: '.memory_get_peak_usage().' peak: '.memory_get_peak_usage().'<br />';flush();
}
catch(ilSaxParserException $e)
{
die($e);
}
}
}
else
{
include_once("./setup/sql/ilDBTemplate.php");
setupILIASDatabase();
}
}
#echo 'Start Memory: '.memory_get_usage().' peak: '.memory_get_peak_usage();
return true;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilSetup::saveMasterSetup (   $a_formdata)

saves intial settings

Parameters
arrayform data
Returns
boolean

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

References $_SESSION, ilFile\deleteTrailingSlash(), ILIAS_ABSOLUTE_PATH, 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);
$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", "htmldoc", preg_replace("/\\\\/","/",ilUtil::stripSlashes($a_formdata["htmldoc_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("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);
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:

ilSetup::saveNewClient ( )

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

Returns
boolean

Definition at line 167 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:

ilSetup::saveProxySettings (   $proxy_settings)

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

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

{
$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])
)
);
}
}
}
}
ilSetup::setClient (   $a_cl)

Set Client.

Parameters
objectclient

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

{
$this->client = $a_cl;
}
ilSetup::setPassword (   $a_password)

set setup master password

Parameters
stringpassword
Returns
boolean

Definition at line 681 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;
}
ilSetup::setSessionSettings (   $session_settings)

saves session settings to db

Parameters
array$session_settings

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

References $db, $query, $res, $row, DB_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(DB_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:

ilSetup::testConvert (   $a_convert_path)

Check convert program.

Parameters
stringconvert path
Returns
boolean true -> OK | false -> not OK

Definition at line 1621 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 "";
/*
// generate gif with convert
if (file_exists(ILIAS_ABSOLUTE_PATH."/images/test.gif"))
{
unlink(ILIAS_ABSOLUTE_PATH."/images/test.png");
}
system($a_convert_path." ".ILIAS_ABSOLUTE_PATH."/setup/test/test.jpg GIF:".ILIAS_ABSOLUTE_PATH."/setup/test/test.png");
// check wether convert generated file
if (file_exists(ILIAS_ABSOLUTE_PATH."/setup/test/test.png"))
{
unlink(ILIAS_ABSOLUTE_PATH."/setup/test/test.png");
return true;
}
else
{
return false;
}
*/
}

+ Here is the caller graph for this function:

ilSetup::testGhostscript (   $a_ghostscript_path)

Check ghostscript program.

Parameters
stringghostscript path
Returns
boolean true -> OK | false -> not OK

Definition at line 1662 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:

ilSetup::testHtmldoc (   $a_htmldoc_path)

Check htmldoc program.

Parameters
stringhtmldoc_path
Returns
boolean true -> OK | false -> not OK

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

References ILIAS_ABSOLUTE_PATH.

Referenced by checkToolsSetup().

{
// java is optional, so empty path is ok
if (trim($a_htmldoc_path) == "")
{
return "";
}
if (!is_file($a_htmldoc_path))
{
return "check_failed_htmldoc";
}
return "";
$curDir = getcwd();
chdir(ILIAS_ABSOLUTE_PATH);
$html = "<html><head><title></title></head><body><p>test</p></body></html>";
$html_file = "htmldoc_test_file.html";
$fp = fopen( $html_file ,"wb");
fwrite($fp, $html);
fclose($fp);
$htmldoc = $a_htmldoc_path." ";
$htmldoc .= "--no-toc ";
$htmldoc .= "--no-jpeg ";
$htmldoc .= "--webpage ";
$htmldoc .= "--outfile htmldoc_test_file.pdf ";
$htmldoc .= "--bodyfont Arial ";
$htmldoc .= "--charset iso-8859-15 ";
$htmldoc .= "--color ";
$htmldoc .= "--size A4 "; // --landscape
$htmldoc .= "--format pdf ";
$htmldoc .= "--footer ... ";
$htmldoc .= "--header ... ";
$htmldoc .= "--left 60 ";
// $htmldoc .= "--right 200 ";
$htmldoc .= $html_file;
exec($htmldoc);
unlink(ILIAS_ABSOLUTE_PATH."/".$html_file);
chdir($curDir);
if (file_exists(ILIAS_ABSOLUTE_PATH."/htmldoc_test_file.pdf"))
{
unlink(ILIAS_ABSOLUTE_PATH."/htmldoc_test_file.pdf");
return true;
}
else
{
return false;
}
}

+ Here is the caller graph for this function:

ilSetup::testJava (   $a_java_path)

Check JVM.

Parameters
stringjava path
Returns
boolean true -> OK | false -> not OK

Definition at line 1683 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:

ilSetup::testLatex (   $a_latex_url)

Check latex cgi script.

Parameters
stringlatex cgi url
Returns
boolean true -> OK | false -> not OK

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

References $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:

ilSetup::testUnzip (   $a_unzip_path)

Check unzip program.

Parameters
stringunzip_path
Returns
boolean true -> OK | false -> not OK

Definition at line 1793 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:

ilSetup::testZip (   $a_zip_path)

Check zip program.

Parameters
stringzip path
Returns
boolean true -> OK | false -> not OK

Definition at line 1740 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:

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

unzip file

Parameters
string$a_filefull path/filename
boolean$overwritepass true to overwrite existing files

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

References $file, 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:

ilSetup::updateMasterSettings (   $a_formdata)

updates settings

Parameters
arrayform data
Returns
boolean

Definition at line 1266 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"]));
$htmldoc_path = preg_replace("/\\\\/","/",ilUtil::stripSlashes($a_formdata["htmldoc_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"]));
$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", "htmldoc", $htmldoc_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);
$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);
$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("server","timezone",preg_replace("/\\\\/","/",ilUtil::stripSlashes($a_formdata["time_zone"])));
if (!$this->ini->write())
{
$this->error = get_class($this).": ".$this->ini->getError();
return false;
}
return true;
}

+ Here is the call graph for this function:

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 190 of file class.ilSetup.php.

References ilUtil\delDir(), ILIAS_ABSOLUTE_PATH, ILIAS_WEB_DIR, PEAR\raiseError(), and saveNewClient().

{
return true;
//var_dump("<pre>",$this->client,"</pre>");exit;
if ($a_old_client_id != $this->client->getId())
{
// check for existing client dir
if (file_exists(ILIAS_ABSOLUTE_PATH."/".ILIAS_WEB_DIR."/".$this->client->getId()))
{
$this->raiseError($this->lng->txt("client_id_already_exists"),$this->error_obj->MESSAGE);
}
if (!$this->saveNewClient())
{
$this->raiseError($this->lng->txt("save_error"),$this->error_obj->MESSAGE);
}
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

ilSetup::$access_mode

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

ilSetup::$auth

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

Referenced by isAuthenticated().

ilSetup::$db

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

Referenced by checkClientProxySettings(), checkClientSessionSettings(), createDatabase(), getSessionSettings(), readDump(), saveProxySettings(), and setSessionSettings().

ilSetup::$default_client

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

ilSetup::$dsn = ""

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

ilSetup::$error = ""

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

Referenced by cloneFromSource(), and getError().

ilSetup::$ilias_nic_server = "http://www.ilias.de/ilias-nic/index.php"

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

ilSetup::$ini

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

ilSetup::$ini_client_exists = false

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

ilSetup::$ini_file_path

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

ilSetup::$ini_ilias_exists = false

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

Referenced by isInstalled().

ilSetup::$preliminaries = true

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

ilSetup::$preliminaries_result = array()

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

ilSetup::$safe_mode

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

ilSetup::$safe_mode_exec_dir

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

ilSetup::$setup_defaults

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

ilSetup::$setup_password

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

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: