Database Update class. More...

Inheritance diagram for ilDBUpdate:

Collaboration diagram for ilDBUpdate:

Public Member Functions
	__construct ($a_db_handler=0, $client_ini=null)
	ilDBUpdate constructor. More...

	getFileForStep ($a_version)
	Get db update file name for db step. More...

	initStep ($i)

	readDBUpdateFile ()

	readLastUpdateFile ()

	getCurrentVersion ()

	setCurrentVersion ($a_version)

	setRunningStatus ($a_nr)
	Set running status for a step. More...

	getRunningStatus ()
	Get running status. More...

	clearRunningStatus ()
	Clear running status. More...

	readFileVersion ()

	getFileVersion ()
	Get Version of file. More...

	execQuery ($db, $str)
	execute a query More...

	checkQuery ($q)
	check query More...

	applyUpdate ($a_break=0)
	Apply update. More...

	loadXMLInfo ()

	applyUpdateNr (&$nr, $hotfix=false, $custom_update=false)
	apply an update More...

	getDBVersionStatus ()

	getTables ()

	getTableStatus ($table)

	getHotfixCurrentVersion ()
	Get current hotfix version. More...

	setHotfixCurrentVersion ($a_version)
	Set current hotfix version. More...

	getHotfixFileVersion ()
	Get current hotfix version. More...

	readHotfixFileVersion ($a_file_content)
	Set current hotfix version. More...

	readHotfixInfo ($a_force=false)
	Get status of hotfix file. More...

	hotfixAvailable ()
	Get status of hotfix file. More...

	applyHotfix ()
	Apply hotfix. More...

	getCustomUpdatesCurrentVersion ()

	setCustomUpdatesCurrentVersion ($a_version)

	getCustomUpdatesFileVersion ()

	readCustomUpdatesFileVersion ($a_file_content)

	readCustomUpdatesInfo ($a_force=false)

	customUpdatesAvailable ()

	applyCustomUpdates ()

	getUpdateSteps ($a_break=0)
	Get update steps as string (for presentation) More...

	getHotfixSteps ()
	Get hotfix steps. More...

	getUpdateStepNr ($nr, $hotfix=false, $custom_update=false)
	Get single update step for presentation. More...

Data Fields
	$DB_UPDATE_FILE
	db update file More...

	$currentVersion

	$fileVersion

	$updateMsg

Protected Attributes
	$client_ini

	$custom_updates_current_version

	$custom_updates_file_version

	$custom_updates_info_read

Private Member Functions
	initGlobalsRequiredForUpdateSteps (&$ilCtrlStructureReader, &$ilMySQLAbstraction, &$ilDB)

Detailed Description

Database Update class.

Author: Peter Gabriel pgabr.nosp@m.iel@.nosp@m.datab.nosp@m.ay.d.nosp@m.e; Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

Definition at line 12 of file class.ilDBUpdate.php.

Constructor & Destructor Documentation

◆ __construct()

ilDBUpdate::__construct	(	$a_db_handler = `0`,
		$client_ini = `null`
	)

ilDBUpdate constructor.

Parameters

ilDBInterface	$a_db_handler
bool	$tmp_flag

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

    {
        // workaround to allow setup migration
        $this->client_ini = $client_ini;
        if ($a_db_handler) {
            $this->db = &$a_db_handler;
            $this->PATH = "./";
        } else {
            global $DIC;
            if ($DIC->offsetExists('mySetup')) {
                $mySetup = $DIC['mySetup'];
            }
            $this->db = $mySetup->db;
            $this->PATH = "./";
        }
 
        $this->getCurrentVersion();
 
        // get update file for current version
        $updatefile = $this->getFileForStep($this->currentVersion + 1);
 
        $this->current_file = $updatefile;
        $this->DB_UPDATE_FILE = $this->PATH . "setup/sql/" . $updatefile;
 
        //
        // NOTE: IF YOU SET THIS TO THE NEWEST FILE, CHANGE ALSO getFileForStep()
        //
        $this->LAST_UPDATE_FILE = $this->PATH . "setup/sql/dbupdate_05.php";
 
        $this->readDBUpdateFile();
        $this->readLastUpdateFile();
        $this->readFileVersion();
    }

References $client_ini, $DIC, getCurrentVersion(), getFileForStep(), PATH, readDBUpdateFile(), readFileVersion(), and readLastUpdateFile().

Here is the call graph for this function:

Member Function Documentation

◆ applyCustomUpdates()

ilDBUpdate::applyCustomUpdates ( )

Definition at line 806 of file class.ilDBUpdate.php.

    {
        $ilCtrlStructureReader = null;
        $ilMySQLAbstraction = null;
        $ilDB = null;
        $this->initGlobalsRequiredForUpdateSteps($ilCtrlStructureReader, $ilMySQLAbstraction, $ilDB);
 
        $ilMySQLAbstraction = new ilMySQLAbstraction();
        $GLOBALS['DIC']['ilMySQLAbstraction'] = $ilMySQLAbstraction;
 
        $this->readCustomUpdatesInfo(true);
 
        $f = $this->getCustomUpdatesFileVersion();
        $c = $this->getCustomUpdatesCurrentVersion();
 
        if ($c < $f) {
            $msg = array();
            for ($i = ($c + 1); $i <= $f; $i++) {
                $this->filecontent = $this->custom_updates_content;
 
                if ($this->applyUpdateNr($i, false, true) == false) {
                    $msg[] = array("msg" => "update_error: " . $this->error,
                                   "nr" => $i,);
                    $this->updateMsg = $msg;
 
                    return false;
                } else {
                    $msg[] = array("msg" => "custom_update_applied",
                                   "nr" => $i,);
                }
            }
 
            $this->updateMsg = $msg;
        } else {
            $this->updateMsg = "no_changes";
        }
 
        return $this->loadXMLInfo();
    }

References $c, Vendor\Package\$f, $GLOBALS, $i, $ilDB, applyUpdateNr(), error(), getCustomUpdatesCurrentVersion(), getCustomUpdatesFileVersion(), initGlobalsRequiredForUpdateSteps(), loadXMLInfo(), and readCustomUpdatesInfo().

Here is the call graph for this function:

◆ applyHotfix()

ilDBUpdate::applyHotfix ( )

Apply hotfix.

Definition at line 691 of file class.ilDBUpdate.php.

    {
        $ilCtrlStructureReader = null;
        $ilMySQLAbstraction = null;
        $ilDB = null;
        $this->initGlobalsRequiredForUpdateSteps($ilCtrlStructureReader, $ilMySQLAbstraction, $ilDB);
 
        $ilMySQLAbstraction = new ilMySQLAbstraction();
        $GLOBALS['DIC']['ilMySQLAbstraction'] = $ilMySQLAbstraction;
 
        $this->readHotfixInfo(true);
 
        $f = $this->getHotfixFileVersion();
        $c = $this->getHotfixCurrentVersion();
 
        if ($c < $f) {
            $msg = array();
            for ($i = ($c + 1); $i <= $f; $i++) {
                //                              $this->initStep($i);    // nothings happens here
 
                $this->filecontent = $this->hotfix_content;
 
                if ($this->applyUpdateNr($i, true) == false) {
                    $msg[] = array("msg" => "update_error: " . $this->error,
                                   "nr" => $i,);
                    $this->updateMsg = $msg;
 
                    return false;
                } else {
                    $msg[] = array("msg" => "hotfix_applied",
                                   "nr" => $i,);
                }
            }
 
            $this->updateMsg = $msg;
        } else {
            $this->updateMsg = "no_changes";
        }
 
        return $this->loadXMLInfo();
    }

References $c, Vendor\Package\$f, $GLOBALS, $i, $ilDB, applyUpdateNr(), error(), getHotfixCurrentVersion(), getHotfixFileVersion(), initGlobalsRequiredForUpdateSteps(), loadXMLInfo(), and readHotfixInfo().

Here is the call graph for this function:

◆ applyUpdate()

ilDBUpdate::applyUpdate ( $a_break = 0 )

Apply update.

Definition at line 344 of file class.ilDBUpdate.php.

    {
        $ilCtrlStructureReader = null;
        $ilMySQLAbstraction = null;
        $ilDB = null;
        $this->initGlobalsRequiredForUpdateSteps($ilCtrlStructureReader, $ilMySQLAbstraction, $ilDB);
 
        $f = $this->fileVersion;
        $c = $this->currentVersion;
 
        if ($a_break > $this->currentVersion
            && $a_break < $this->fileVersion
        ) {
            $f = $a_break;
        }
 
        if ($c < $f) {
            $msg = array();
            for ($i = ($c + 1); $i <= $f; $i++) {
                // check wether next update file must be loaded
                if ($this->current_file != $this->getFileForStep($i)) {
                    $this->DB_UPDATE_FILE = $this->PATH . "setup/sql/" . $this->getFileForStep($i);
                    $this->readDBUpdateFile();
                }
 
                $this->initStep($i);
 
                if ($this->applyUpdateNr($i) == false) {
                    $msg[] = array("msg" => "update_error: " . $this->error,
                                   "nr" => $i,);
                    $this->updateMsg = $msg;
 
                    return false;
                } else {
                    $msg[] = array("msg" => "update_applied",
                                   "nr" => $i,);
                }
            }
 
            $this->updateMsg = $msg;
        } else {
            $this->updateMsg = "no_changes";
        }
 
        if ($f < $this->fileVersion) {
            return true;
        } else {
            return $this->loadXMLInfo();
        }
    }

References $c, $currentVersion, Vendor\Package\$f, $fileVersion, $i, $ilDB, applyUpdateNr(), error(), getFileForStep(), initGlobalsRequiredForUpdateSteps(), initStep(), loadXMLInfo(), PATH, and readDBUpdateFile().

Referenced by ilDatabaseUpdatedObjective\achieve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ applyUpdateNr()

ilDBUpdate::applyUpdateNr	(	&	$nr,
			$hotfix = `false`,
			$custom_update = `false`
	)

apply an update

Parameters

int	nr number what patch to apply (Reference: Patch for https://mantis.ilias.de/view.php?id=28550)

Returns: bool @access private

Definition at line 447 of file class.ilDBUpdate.php.

    {
        $ilCtrlStructureReader = null;
        $ilMySQLAbstraction = null;
        $ilDB = null;
        $this->initGlobalsRequiredForUpdateSteps($ilCtrlStructureReader, $ilMySQLAbstraction, $ilDB);
 
        //search for desired $nr
        reset($this->filecontent);
 
        if (!$hotfix && !$custom_update) {
            $this->setRunningStatus($nr);
        }
 
        //init
        $i = 0;
 
        //go through filecontent
        while (!preg_match("/^<\#" . $nr . ">/", $this->filecontent[$i]) && $i < count($this->filecontent)) {
            $i++;
        }
 
        //update not found
        if ($i == count($this->filecontent)) {
            $this->error = "update_not_found";
 
            return false;
        }
 
        $i++;
 
        //update found, now extract this update to a new array
        $update = array();
        while ($i < count($this->filecontent) && !preg_match("/^<#" . ($nr + 1) . ">/", $this->filecontent[$i])) {
            $update[] = trim($this->filecontent[$i]);
            $i++;
        }
 
        //now you have the update, now process it
        $sql = array();
        $php = array();
        $mode = "sql";
 
        foreach ($update as $row) {
            if (preg_match("/<\?php/", $row)) {
                if (count($sql) > 0) {
                    if ($this->execQuery($this->db, implode("\n", $sql)) == false) {
                        $this->error = $this->error;
 
                        return false;
                    }
                    $sql = array();
                }
                $mode = "php";
            } elseif (preg_match("/\?>/", $row)) {
                if (count($php) > 0) {
                    $code = implode("\n", $php);
                    if (eval($code) === false) {
                        $this->error = "Parse error: " . $code;
 
                        return false;
                    }
                    $php = array();
                }
                $mode = "sql";
            } else {
                if ($mode == "sql") {
                    $sql[] = $row;
                }
 
                if ($mode == "php") {
                    $php[] = $row;
                }
            } //else
        } //foreach
 
        if ($mode == "sql" && count($sql) > 0) {
            if ($this->execQuery($this->db, implode("\n", $sql)) == false) {
                $this->error = "dump_error: " . $this->error;
 
                return false;
            }
        }
 
        //increase db_Version number
        if (!$hotfix && !$custom_update) {
            $this->setCurrentVersion($nr);
        } elseif ($hotfix) {
            $this->setHotfixCurrentVersion($nr);
        } elseif ($custom_update) {
            $this->setCustomUpdatesCurrentVersion($nr);
        }
 
        if (!$hotfix && !$custom_update) {
            $this->clearRunningStatus();
        }
 
        //$this->currentVersion = $ilias->getSetting("db_version");
 
        return true;
    }

References $i, $ilDB, clearRunningStatus(), error(), execQuery(), initGlobalsRequiredForUpdateSteps(), setCurrentVersion(), setCustomUpdatesCurrentVersion(), setHotfixCurrentVersion(), and setRunningStatus().

Referenced by applyCustomUpdates(), applyHotfix(), and applyUpdate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkQuery()

ilDBUpdate::checkQuery ( $q )

check query

Reimplemented in ilPluginDBUpdate.

Definition at line 298 of file class.ilDBUpdate.php.

    {
        return true;
    }

Referenced by execQuery().

Here is the caller graph for this function:

◆ clearRunningStatus()

ilDBUpdate::clearRunningStatus ( )

Clear running status.

Definition at line 209 of file class.ilDBUpdate.php.

    {
        $set = new ilSetting("common", true);
        $set->set("db_update_running", 0);
        $this->db_update_running = 0;
    }

Referenced by applyUpdateNr().

Here is the caller graph for this function:

◆ customUpdatesAvailable()

ilDBUpdate::customUpdatesAvailable ( )

Definition at line 792 of file class.ilDBUpdate.php.

    {
        // trunk does not support custom updates
        //              return false;
 
        $this->readCustomUpdatesInfo();
        if ($this->custom_updates_file_version > $this->custom_updates_current_version) {
            return true;
        }
 
        return false;
    }

References readCustomUpdatesInfo().

Here is the call graph for this function:

◆ execQuery()

ilDBUpdate::execQuery	(	$db,
		$str
	)

execute a query

Parameters

object	DB
string	query

Returns: boolean

Definition at line 252 of file class.ilDBUpdate.php.

    {
        $sql = explode("\n", trim($str));
        for ($i = 0; $i < count($sql); $i++) {
            $sql[$i] = trim($sql[$i]);
            if ($sql[$i] != "" && substr($sql[$i], 0, 1) != "#") {
                //take line per line, until last char is ";"
                if (substr($sql[$i], -1) == ";") {
                    //query is complete
                    $q .= " " . substr($sql[$i], 0, -1);
                    $check = $this->checkQuery($q);
                    if ($check === true) {
                        try {
                            $r = $db->query($q);
                        } catch (ilDatabaseException $e) {
                            var_dump($e); // FSX
                            exit;
                            $this->error = $e->getMessage();
 
                            return false;
                        }
                    } else {
                        $this->error = $check;
 
                        return false;
                    }
                    unset($q);
                } //if
                else {
                    $q .= " " . $sql[$i];
                } //else
            } //if
        } //for
        if (isset($q) && $q != "") {
            echo "incomplete_statement: " . $q . "<br>";
 
            return false;
        }
 
        return true;
    }

References Vendor\Package\$e, $i, checkQuery(), error(), and exit.

Referenced by applyUpdateNr().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCurrentVersion()

ilDBUpdate::getCurrentVersion ( )

Returns: int

Reimplemented in ilPluginDBUpdate.

Definition at line 155 of file class.ilDBUpdate.php.

    {
        $set = new ilSetting("common", true);
        $this->currentVersion = (integer) $set->get("db_version");
 
        return $this->currentVersion;
    }

References $currentVersion.

Referenced by __construct().

Here is the caller graph for this function:

◆ getCustomUpdatesCurrentVersion()

ilDBUpdate::getCustomUpdatesCurrentVersion ( )

Definition at line 734 of file class.ilDBUpdate.php.

    {
        $this->readCustomUpdatesInfo();
 
        return $this->custom_updates_current_version;
    }

References $custom_updates_current_version, and readCustomUpdatesInfo().

Referenced by applyCustomUpdates().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCustomUpdatesFileVersion()

ilDBUpdate::getCustomUpdatesFileVersion ( )

Definition at line 752 of file class.ilDBUpdate.php.

    {
        $this->readCustomUpdatesInfo();
 
        return $this->custom_updates_file_version;
    }

References $custom_updates_file_version, and readCustomUpdatesInfo().

Referenced by applyCustomUpdates().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDBVersionStatus()

ilDBUpdate::getDBVersionStatus ( )

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

    {
        if ($this->fileVersion > $this->currentVersion) {
            return false;
        } else {
            return true;
        }
    }

◆ getFileForStep()

ilDBUpdate::getFileForStep ( $a_version )

Get db update file name for db step.

Parameters

int $a_version

Returns: string

Reimplemented in ilPluginDBUpdate.

Definition at line 93 of file class.ilDBUpdate.php.

    {
        //
        // NOTE: IF YOU ADD A NEW FILE HERE, CHANGE ALSO THE CONSTRUCTOR
        //
        switch (true) {
            case ((int) $a_version > 5431): // last number in previous file
                return "dbupdate_05.php";
            case ((int) $a_version > 4182): // last number in previous file
                return "dbupdate_04.php";
            case ((int) $a_version > 2948): // last number in previous file
                return "dbupdate_03.php";
            case ((int) $a_version > 864): // last number in previous file
                return "dbupdate_02.php";
            default:
                return "dbupdate.php";
        }
    }

Referenced by __construct(), applyUpdate(), and getUpdateSteps().

Here is the caller graph for this function:

◆ getFileVersion()

ilDBUpdate::getFileVersion ( )

Get Version of file.

Definition at line 238 of file class.ilDBUpdate.php.

    {
        return $this->fileVersion;
    }

References $fileVersion.

◆ getHotfixCurrentVersion()

ilDBUpdate::getHotfixCurrentVersion ( )

Get current hotfix version.

Definition at line 596 of file class.ilDBUpdate.php.

    {
        $this->readHotfixInfo();
 
        return $this->hotfix_current_version ?? null;
    }

References readHotfixInfo().

Referenced by applyHotfix(), and getHotfixSteps().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHotfixFileVersion()

ilDBUpdate::getHotfixFileVersion ( )

Get current hotfix version.

Definition at line 623 of file class.ilDBUpdate.php.

    {
        $this->readHotfixInfo();
 
        return $this->hotfix_file_version ?? null;
    }

References readHotfixInfo().

Referenced by applyHotfix(), and getHotfixSteps().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHotfixSteps()

ilDBUpdate::getHotfixSteps ( )

Get hotfix steps.

Returns: string steps from the update file

Definition at line 892 of file class.ilDBUpdate.php.

    {
        $this->readHotfixInfo(true);
 
        $str = "";
 
        $f = $this->getHotfixFileVersion();
        $c = $this->getHotfixCurrentVersion();
 
        if ($c < $f) {
            $msg = array();
            for ($i = ($c + 1); $i <= $f; $i++) {
                $this->filecontent = $this->hotfix_content;
 
                $str .= $this->getUpdateStepNr($i, true);
            }
        }
 
        return $str;
    }

References $c, Vendor\Package\$f, $i, getHotfixCurrentVersion(), getHotfixFileVersion(), getUpdateStepNr(), and readHotfixInfo().

Here is the call graph for this function:

◆ getRunningStatus()

ilDBUpdate::getRunningStatus ( )

Get running status.

Returns: int current runnning db step

Definition at line 197 of file class.ilDBUpdate.php.

    {
        $set = new ilSetting("common", true);
        $this->db_update_running = (integer) $set->get("db_update_running");
 
        return $this->db_update_running;
    }

◆ getTables()

ilDBUpdate::getTables ( )

Definition at line 560 of file class.ilDBUpdate.php.

    {
        $a = array();
 
        $query = "SHOW TABLES";
        $res = $this->db->query($query);
        while ($row = $res->fetchRow()) {
            $status = $this->getTableStatus($row[0]);
            $a[] = array("name" => $status["Table"],
                         "table" => $row[0],
                         "status" => $status["Msg_text"],);
        }
 
        return $a;
    }

References Vendor\Package\$a, $query, $res, and getTableStatus().

Here is the call graph for this function:

◆ getTableStatus()

ilDBUpdate::getTableStatus ( $table )

Definition at line 577 of file class.ilDBUpdate.php.

    {
        $a = array();
 
        $query = "ANALYZE TABLE " . $table;
        $res = $this->db->query($query);
        $row = $res->fetchRow(ilDBConstants::FETCHMODE_ASSOC);
 
        return $row;
    }

References Vendor\Package\$a, $query, $res, and ilDBConstants\FETCHMODE_ASSOC.

Referenced by getTables().

Here is the caller graph for this function:

◆ getUpdateStepNr()

ilDBUpdate::getUpdateStepNr	(	$nr,
		$hotfix = `false`,
		$custom_update = `false`
	)

Get single update step for presentation.

Definition at line 917 of file class.ilDBUpdate.php.

    {
        $str = "";
 
        //search for desired $nr
        reset($this->filecontent);
 
        //init
        $i = 0;
 
        //go through filecontent
        while (!preg_match("/^<#" . $nr . ">/", $this->filecontent[$i]) && $i < count($this->filecontent)) {
            $i++;
        }
 
        //update not found
        if ($i == count($this->filecontent)) {
            return false;
        }
 
        $i++;
 
        //update found, now extract this update to a new array
        $update = array();
        while ($i < count($this->filecontent) && !preg_match("/^<#" . ($nr + 1) . ">/", $this->filecontent[$i])) {
            $str .= $this->filecontent[$i];
            $i++;
        }
 
        return "<pre><b><#" . $nr . "></b>\n" . htmlentities($str) . "</pre>";
    }

References $i.

Referenced by getHotfixSteps(), and getUpdateSteps().

Here is the caller graph for this function:

◆ getUpdateSteps()

ilDBUpdate::getUpdateSteps ( $a_break = 0 )

Get update steps as string (for presentation)

Returns: string steps from the update file

Definition at line 852 of file class.ilDBUpdate.php.

    {
        $ilCtrlStructureReader = null;
        $ilMySQLAbstraction = null;
        $ilDB = null;
        $this->initGlobalsRequiredForUpdateSteps($ilCtrlStructureReader, $ilMySQLAbstraction, $ilDB);
 
        $str = "";
 
        $f = $this->fileVersion;
        $c = $this->currentVersion;
 
        if ($a_break > $this->currentVersion
            && $a_break < $this->fileVersion
        ) {
            $f = $a_break;
        }
 
        if ($c < $f) {
            $msg = array();
            for ($i = ($c + 1); $i <= $f; $i++) {
                // check wether next update file must be loaded
                if ($this->current_file != $this->getFileForStep($i)) {
                    $this->DB_UPDATE_FILE = $this->PATH . "setup/sql/" . $this->getFileForStep($i);
                    $this->readDBUpdateFile();
                }
 
                $str .= $this->getUpdateStepNr($i);
            }
        }
 
        return $str;
    }

References $c, $currentVersion, Vendor\Package\$f, $fileVersion, $i, $ilDB, getFileForStep(), getUpdateStepNr(), initGlobalsRequiredForUpdateSteps(), PATH, and readDBUpdateFile().

Here is the call graph for this function:

◆ hotfixAvailable()

ilDBUpdate::hotfixAvailable ( )

Get status of hotfix file.

Definition at line 677 of file class.ilDBUpdate.php.

    {
        $this->readHotfixInfo();
        if (isset($this->hotfix_file_version) && $this->hotfix_file_version > $this->hotfix_current_version) {
            return true;
        }
 
        return false;
    }

References readHotfixInfo().

Here is the call graph for this function:

◆ initGlobalsRequiredForUpdateSteps()

ilDBUpdate::initGlobalsRequiredForUpdateSteps	(	&	$ilCtrlStructureReader,
		&	$ilMySQLAbstraction,
		&	$ilDB
	)

private

Parameters

$ilCtrlStructureReader
$ilMySQLAbstraction
$ilDB

Definition at line 309 of file class.ilDBUpdate.php.

    {
        global $DIC;
 
        // TODO: There is currently a huge mixup of globals, $DIC and dependencies, esprecially in setup and during DB-Updates. This leads to many problems. The following core tries to provide the needed dependencies for the dbupdate-script. The code hopefully will change in the future.
 
        if (isset($GLOBALS['ilCtrlStructureReader'])) {
            $ilCtrlStructureReader = $GLOBALS['ilCtrlStructureReader'];
        } elseif ($DIC->offsetExists('ilCtrlStructureReader')) {
            $ilCtrlStructureReader = $DIC['ilCtrlStructureReader'];
        } else {
            $ilCtrlStructureReader = new ilCtrlStructureReader();
            $DIC->offsetSet('ilCtrlStructureReader', $ilCtrlStructureReader);
        }
 
        $GLOBALS['ilCtrlStructureReader'] = $ilCtrlStructureReader;
 
        if ($DIC->offsetExists('ilMySQLAbstraction')) {
            $ilMySQLAbstraction = $DIC['ilMySQLAbstraction'];
        } else {
            $ilMySQLAbstraction = new ilMySQLAbstraction();
            $DIC->offsetSet('ilMySQLAbstraction', $ilMySQLAbstraction);
        }
 
        $GLOBALS['ilMySQLAbstraction'] = $ilMySQLAbstraction;
        if ($this->client_ini) {
            $ilCtrlStructureReader->setIniFile($this->client_ini);
        }
        $ilDB = $DIC->database();
    }

References $DIC, $GLOBALS, and $ilDB.

Referenced by applyCustomUpdates(), applyHotfix(), applyUpdate(), applyUpdateNr(), getUpdateSteps(), and loadXMLInfo().

Here is the caller graph for this function:

◆ initStep()

ilDBUpdate::initStep ( $i )

Parameters

int $i

Definition at line 116 of file class.ilDBUpdate.php.

    {
        //
    }

Referenced by applyUpdate().

Here is the caller graph for this function:

◆ loadXMLInfo()

ilDBUpdate::loadXMLInfo ( )

Reimplemented in ilPluginDBUpdate.

Definition at line 396 of file class.ilDBUpdate.php.

    {
        $ilCtrlStructureReader = null;
        $ilMySQLAbstraction = null;
        $ilDB = null;
        $this->initGlobalsRequiredForUpdateSteps($ilCtrlStructureReader, $ilMySQLAbstraction, $ilDB);
 
        // read module and service information into db
        $modules = ilModule::getAvailableCoreModules();
        $services = ilService::getAvailableCoreServices();
 
        $ilCtrlStructureReader->readStructure();
 
        $mr = new ilModuleReader("", "", "");
        $mr->clearTables();
        foreach ($modules as $module) {
            $mr = new ilModuleReader(
                ILIAS_ABSOLUTE_PATH . "/Modules/" . $module["subdir"] . "/module.xml",
                $module["subdir"],
                "Modules"
            );
            $mr->getModules();
            unset($mr);
        }
 
        $sr = new ilServiceReader("", "", "");
        $sr->clearTables();
        foreach ($services as $service) {
            $sr = new ilServiceReader(
                ILIAS_ABSOLUTE_PATH . "/Services/" . $service["subdir"] . "/service.xml",
                $service["subdir"],
                "Services"
            );
            $sr->getServices();
            unset($sr);
        }
 
 
 
        return true;
    }

References $ilDB, $service, ilModule\getAvailableCoreModules(), ilService\getAvailableCoreServices(), and initGlobalsRequiredForUpdateSteps().

Referenced by applyCustomUpdates(), applyHotfix(), and applyUpdate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readCustomUpdatesFileVersion()

ilDBUpdate::readCustomUpdatesFileVersion ( $a_file_content )

Definition at line 760 of file class.ilDBUpdate.php.

    {
        //go through filecontent and search for last occurence of <#x>
        reset($a_file_content);
        $regs = array();
        foreach ($a_file_content as $row) {
            if (preg_match("/^<#([0-9]+)>/", $row, $regs)) {
                $version = $regs[1];
            }
        }
 
        return (integer) $version;
    }

Referenced by readCustomUpdatesInfo().

Here is the caller graph for this function:

◆ readCustomUpdatesInfo()

ilDBUpdate::readCustomUpdatesInfo ( $a_force = false )

Definition at line 775 of file class.ilDBUpdate.php.

    {
        if ($this->custom_updates_info_read && !$a_force) {
            return;
        }
 
        $this->custom_updates_setting = new ilSetting();
        $custom_updates_file = $this->PATH . "setup/sql/dbupdate_custom.php";
        if (is_file($custom_updates_file)) {
            $this->custom_updates_content = @file($custom_updates_file);
            $this->custom_updates_current_version = (int) $this->custom_updates_setting->get('db_version_custom', 0);
            $this->custom_updates_file_version = $this->readCustomUpdatesFileVersion($this->custom_updates_content);
        }
        $this->custom_updates_info_read = true;
    }

References PATH, and readCustomUpdatesFileVersion().

Referenced by applyCustomUpdates(), ilDatabaseMetricsCollectedObjective\collectFrom(), customUpdatesAvailable(), getCustomUpdatesCurrentVersion(), getCustomUpdatesFileVersion(), and setCustomUpdatesCurrentVersion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readDBUpdateFile()

ilDBUpdate::readDBUpdateFile ( )

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

    {
        if (!file_exists($this->DB_UPDATE_FILE)) {
            $this->error = "no_db_update_file";
            $this->filecontent = array();
 
            return false;
        }
 
        $this->filecontent = @file($this->DB_UPDATE_FILE);
 
        return true;
    }

References error().

Referenced by ilPluginDBUpdate\__construct(), __construct(), applyUpdate(), and getUpdateSteps().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readFileVersion()

ilDBUpdate::readFileVersion ( )

Definition at line 217 of file class.ilDBUpdate.php.

    {
        //go through filecontent and search for last occurence of <#x>
        reset($this->lastfilecontent);
        $regs = array();
        $version = 0;
        foreach ($this->lastfilecontent as $row) {
            if (preg_match('/^<\#([0-9]+)>/', $row, $regs)) {
                $version = $regs[1];
            }
        }
 
        $this->fileVersion = (integer) $version;
 
        return $this->fileVersion;
    }

References $fileVersion.

Referenced by ilPluginDBUpdate\__construct(), and __construct().

Here is the caller graph for this function:

◆ readHotfixFileVersion()

ilDBUpdate::readHotfixFileVersion ( $a_file_content )

Set current hotfix version.

Definition at line 634 of file class.ilDBUpdate.php.

    {
        //go through filecontent and search for last occurence of <#x>
        reset($a_file_content);
        $regs = array();
        foreach ($a_file_content as $row) {
            if (preg_match("/^<#([0-9]+)>/", $row, $regs)) {
                $version = $regs[1];
            }
        }
 
        return (integer) $version;
    }

Referenced by readHotfixInfo().

Here is the caller graph for this function:

◆ readHotfixInfo()

ilDBUpdate::readHotfixInfo ( $a_force = false )

Get status of hotfix file.

Definition at line 652 of file class.ilDBUpdate.php.

    {
        if (isset($this->hotfix_info_read) && $this->hotfix_info_read && !$a_force) {
            return;
        }
        $this->hotfix_setting = new ilSetting("common", true);
        $ilias_version = ILIAS_VERSION_NUMERIC;
        $version_array = explode(".", $ilias_version);
        $this->hotfix_version[0] = $version_array[0];
        $this->hotfix_version[1] = $version_array[1];
        $hotfix_file = $this->PATH . "setup/sql/" . $this->hotfix_version[0] . "_hotfixes.php";
        if (is_file($hotfix_file)) {
            $this->hotfix_content = @file($hotfix_file);
            $this->hotfix_current_version = (int) $this->hotfix_setting->get(
                "db_hotfixes_" . $this->hotfix_version[0]
            );
            $this->hotfix_file_version = $this->readHotfixFileVersion($this->hotfix_content);
        }
        $this->hotfix_info_read = true;
    }

References ILIAS_VERSION_NUMERIC, PATH, and readHotfixFileVersion().

Referenced by applyHotfix(), getHotfixCurrentVersion(), getHotfixFileVersion(), getHotfixSteps(), hotfixAvailable(), and setHotfixCurrentVersion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readLastUpdateFile()

ilDBUpdate::readLastUpdateFile ( )

Definition at line 137 of file class.ilDBUpdate.php.

    {
        if (!file_exists($this->LAST_UPDATE_FILE)) {
            $this->error = "no_last_update_file";
            $this->lastfilecontent = array();
 
            return false;
        }
 
        $this->lastfilecontent = @file($this->LAST_UPDATE_FILE);
 
        return true;
    }

References error().

Referenced by ilPluginDBUpdate\__construct(), and __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCurrentVersion()

ilDBUpdate::setCurrentVersion ( $a_version )

Parameters

int $a_version

Returns: bool

Reimplemented in ilPluginDBUpdate.

Definition at line 169 of file class.ilDBUpdate.php.

    {
        $set = new ilSetting("common", true);
        $set->set("db_version", $a_version);
        $this->currentVersion = $a_version;
 
        return true;
    }

Referenced by applyUpdateNr().

Here is the caller graph for this function:

◆ setCustomUpdatesCurrentVersion()

ilDBUpdate::setCustomUpdatesCurrentVersion ( $a_version )

Definition at line 742 of file class.ilDBUpdate.php.

    {
        $this->readCustomUpdatesInfo();
        $this->custom_updates_setting->set('db_version_custom', $a_version);
        $this->custom_updates_current_version = $a_version;
 
        return true;
    }

References readCustomUpdatesInfo().

Referenced by applyUpdateNr().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setHotfixCurrentVersion()

ilDBUpdate::setHotfixCurrentVersion ( $a_version )

Set current hotfix version.

Definition at line 607 of file class.ilDBUpdate.php.

    {
        $this->readHotfixInfo();
        $this->hotfix_setting->set(
            "db_hotfixes_" . $this->hotfix_version[0],
            $a_version
        );
        $this->hotfix_current_version = $a_version;
 
        return true;
    }

References readHotfixInfo().

Referenced by applyUpdateNr().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setRunningStatus()

ilDBUpdate::setRunningStatus ( $a_nr )

Set running status for a step.

Parameters

int	step number

Definition at line 184 of file class.ilDBUpdate.php.

    {
        $set = new ilSetting("common", true);
        $set->set("db_update_running", $a_nr);
        $this->db_update_running = $a_nr;
    }

Referenced by applyUpdateNr().

Here is the caller graph for this function:

Field Documentation

◆ $client_ini

ilDBUpdate::$client_ini

protected

Definition at line 38 of file class.ilDBUpdate.php.

Referenced by __construct().

◆ $currentVersion

ilDBUpdate::$currentVersion

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

Referenced by applyUpdate(), ilPluginDBUpdate\getCurrentVersion(), getCurrentVersion(), and getUpdateSteps().

◆ $custom_updates_current_version

ilDBUpdate::$custom_updates_current_version

protected

Definition at line 40 of file class.ilDBUpdate.php.

Referenced by getCustomUpdatesCurrentVersion().

◆ $custom_updates_file_version

ilDBUpdate::$custom_updates_file_version

protected

Definition at line 41 of file class.ilDBUpdate.php.

Referenced by getCustomUpdatesFileVersion().

◆ $custom_updates_info_read

ilDBUpdate::$custom_updates_info_read

protected

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

◆ $DB_UPDATE_FILE

ilDBUpdate::$DB_UPDATE_FILE

db update file

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

◆ $fileVersion

ilDBUpdate::$fileVersion

Definition at line 30 of file class.ilDBUpdate.php.

Referenced by applyUpdate(), getFileVersion(), getUpdateSteps(), and readFileVersion().

◆ $updateMsg

ilDBUpdate::$updateMsg

Definition at line 34 of file class.ilDBUpdate.php.

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

Services/Database/classes/class.ilDBUpdate.php

Public Member Functions

Data Fields

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ applyCustomUpdates()

◆ applyHotfix()

◆ applyUpdate()

◆ applyUpdateNr()

◆ checkQuery()

◆ clearRunningStatus()

◆ customUpdatesAvailable()

◆ execQuery()

◆ getCurrentVersion()

◆ getCustomUpdatesCurrentVersion()

◆ getCustomUpdatesFileVersion()

◆ getDBVersionStatus()

◆ getFileForStep()

◆ getFileVersion()

◆ getHotfixCurrentVersion()

◆ getHotfixFileVersion()

◆ getHotfixSteps()

◆ getRunningStatus()

◆ getTables()

◆ getTableStatus()

◆ getUpdateStepNr()

◆ getUpdateSteps()

◆ hotfixAvailable()

◆ initGlobalsRequiredForUpdateSteps()

◆ initStep()

◆ loadXMLInfo()

◆ readCustomUpdatesFileVersion()

◆ readCustomUpdatesInfo()

◆ readDBUpdateFile()

◆ readFileVersion()

◆ readHotfixFileVersion()

◆ readHotfixInfo()

◆ readLastUpdateFile()

◆ setCurrentVersion()

◆ setCustomUpdatesCurrentVersion()

◆ setHotfixCurrentVersion()

◆ setRunningStatus()

Field Documentation

◆ $client_ini

◆ $currentVersion

◆ $custom_updates_current_version

◆ $custom_updates_file_version

◆ $custom_updates_info_read

◆ $DB_UPDATE_FILE

◆ $fileVersion

◆ $updateMsg