This repository has been archived on 2024-11-28. You can view files and clone it, but cannot push or open issues or pull requests.
Incam_SGD/setup/upgrade/lib/UpgradeItems.inc.php

511 lines
16 KiB
PHP

<?php
/**
* $Id$
*
* KnowledgeTree Community Edition
* Document Management Made Simple
* Copyright (C) 2008, 2009 KnowledgeTree Inc.
*
*
* This program is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License version 3 as published by the
* Free Software Foundation.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
* details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* You can contact KnowledgeTree Inc., PO Box 7775 #87847, San Francisco,
* California 94120-7775, or email info@knowledgetree.com.
*
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU General Public License version 3.
*
* In accordance with Section 7(b) of the GNU General Public License version 3,
* these Appropriate Legal Notices must retain the display of the "Powered by
* KnowledgeTree" logo and retain the original copyright notice. If the display of the
* logo is not reasonably feasible for technical reasons, the Appropriate Legal Notices
* must display the words "Powered by KnowledgeTree" and retain the original
* copyright notice.
* Contributor( s): ______________________________________
*
*/
// {{{ Format of the descriptor
/**
* Format of the descriptor
*
* type*version*phase*simple description for uniqueness
*
* type is: sql, function, subupgrade, upgrade
* version is: 1.2.4, 2.0.0rc5
* phase is: 0, 1, 0pre. Phase is _only_ evaluated by describeUpgrades.
* description is: anything, unique in terms of version and type.
*/
// }}}
require_once('sqlfile.inc.php');
require_once('datetime.inc.php');
require_once("../wizard/iniUtilities.php");
require_once("../wizard/dbUtilities.php");
// {{{ Upgrade_Already_Applied
class Upgrade_Already_Applied {
function Upgrade_Already_Applied($oUpgradeItem) {
$this->oUpgradeItem = $oUpgradeItem;
}
}
// }}}
class UpgradeItem {
public $type = "";
public $name;
public $version;
public $description;
public $phase;
public $priority = 0;
public $parent;
public $date;
public $result;
protected $error;
function UpgradeItem($name, $version, $description = null, $phase = 0, $priority = 0) {
$this->name = $name;
$this->version = $version;
if (is_null($description)) {
$description = $this->type . " upgrade to version " . $version . " phase " . $phase;
}
$this->description = $description;
$this->phase = $phase;
$this->priority = $priority;
$this->dbUtilities = new dbUtilities();
$this->iniUtilities = new iniUtilities();
}
function setParent($parent) {
$this->parent = $parent;
}
function setDate($date) {
$this->date = $date;
}
function getDescriptor() {
return join("*", array($this->type, $this->version, $this->phase, $this->name));
}
function getDescription() {
return $this->description;
}
function getVersion() {
return $this->version;
}
function getPhase() {
return $this->phase;
}
function getPriority() {
return $this->priority;
}
function getType() {
return $this->type;
}
public function getErrors()
{
if(isset($this->error[0])){
return $this->error[0];
}
return $this->error;
}
/**
* Runs a DB query and returns a result based on arguments which specify what to look for
*
* @param string $query The query to run
* @param boolean $checkResult Whether to check that a result was found (not needed for update/delete, only select): This result may be empty
* @param boolean $resultCheck Whether to check for returned results from the query
* @return unknown
*/
function runDBQuery($query, $checkResult = false, $resultCheck = false) {
if(!isset($this->iniUtilities) || !is_object($this->iniUtilities)) {
$this->dbUtilities = new dbUtilities();
$this->iniUtilities = new iniUtilities();
}
$wizConfigHandler = new configuration();
$configPath = $wizConfigHandler->readConfigPathIni();
$this->iniUtilities->load($configPath);
$dconf = $this->iniUtilities->getSection('db');
$this->dbUtilities->load($dconf['dbHost'], '', $dconf['dbAdminUser'], $dconf['dbAdminPass'], $dconf['dbName']);
$result = $this->dbUtilities->query($query);
if($checkResult) {
$assArr = $this->dbUtilities->fetchAssoc($result);
if($resultCheck) {
return !is_null($assArr);
} else {
return is_null($assArr);
}
}
return !is_null($result);
}
function _upgradeTableInstalled() {
$query = "SELECT COUNT(id) FROM upgrades";
$res = $this->runDBQuery($query, true, true);
if($res) {
return true;
}
return false;
}
function isAlreadyApplied() {
if (!$this->_upgradeTableInstalled()) {
return false;
}
$query = "SELECT id FROM upgrades WHERE descriptor = '".$this->getDescriptor()."' AND result = 1";
$res = $this->runDBQuery($query, true, false);
if(!$res) {
return true;
}
return false;
}
function performUpgrade($force = false) {
$res = $this->isAlreadyApplied();
if ($res === true) {
if ($force !== true) {
// PHP5: Exception
return new Upgrade_Already_Applied($this);
}
}
$res = $this->_performUpgrade();
if (!$res) {
$this->_recordUpgrade(false);
$this->error[] = $this->dbUtilities->getErrors();
return false;
}
$res = $this->_recordUpgrade(true);
if (!$res) {
$this->error[] = 'An Error Has Occured';
return false;
}
return true;
}
function _performUpgrade() {
$this->error[] = 'Unimplemented';
return false;
}
function _recordUpgrade($result) {
if (is_null($this->date)) {
$this->date = getCurrentDateTime();
}
if ($this->parent) {
$parentid = $this->parent->getDescriptor();
} else {
$parentid = null;
}
$sql = "INSERT INTO upgrades (`id`, `descriptor`, `description`, `date_performed`, `result`, `parent`) VALUES (NULL, '". $this->getDescriptor()."', '".$this->description."', '".$this->date."', '".$result."', '".$parentid."')";
$this->dbUtilities->query($sql);
return true;
}
function getAllUpgrades() {
return array();
}
} // end class UpgradeItem
class SQLUpgradeItem extends UpgradeItem {
function SQLUpgradeItem($path, $version = null, $description = null, $phase = null, $priority = null) {
$this->type = "sql";
$this->priority = 0;
$details = $this->_getDetailsFromFileName($path);
if (is_null($version)) {
$version = $details[1];
}
if (is_null($description)) {
$description = $details[2];
}
if (is_null($phase)) {
$phase = $details[3];
}
if (is_null($priority)) {
$priority = isset($details[4]) ? $details[4] : 0;
}
$this->UpgradeItem($path, $version, $description, $phase, $priority);
}
/**
* Describe the SQL scripts that will be used to upgrade KnowledgeTree
*
* Return an array of arrays with two components: a string identifier
* that uniquely describes the step to be taken and a string which is an
* HTML-formatted description of the step to be taken. These will be
* returned in any order - describeUpgrade performs the ordering.
*
* @param string Original version (e.g., "1.2.4")
* @param string Current version (e.g., "2.0.2")
*
* @return array Array of SQLUpgradeItem describing steps to be taken
*
* STATIC
*/
public static function getUpgrades($origVersion, $currVersion) {
$dbType = 'mysql';
$sqlupgradedir = KT_DIR . 'sql/' . $dbType . '/upgrade/';
$ret = array();
if (!is_dir($sqlupgradedir)) {
return false;
}
if (!($dh = opendir($sqlupgradedir))) {
return false;
}
while (($file = readdir($dh)) !== false) {
// Each entry can be a file or a directory
//
// A file is legacy before the upgrade system was created, but
// will be supported anyway.
//
// A directory is the end-result version: so, 2.0.5 contains
// every script that differentiates it from a previous version,
// say, 2.0.5rc1 or 2.0.4.
//
if (in_array($file, array('.', '..', 'CVS'))) {
continue;
}
$fullpath = $sqlupgradedir . $file;
if (is_file($fullpath)) {
// Legacy file support, will be in form of
// 1.2.4-to-2.0.0.sql.
$details = SQLUpgradeItem::_getDetailsFromFileName($file);
if ($details) {
if (!gte_version($details[0], $origVersion)) {
continue;
}
if (!lte_version($details[1], $currVersion)) {
continue;
}
$ret[] = new SQLUpgradeItem($file);
}
}
if (is_dir($fullpath)) {
$subdir = $file;
if (!($subdh = opendir($fullpath))) {
continue;
}
while (($file = readdir($subdh)) !== false) {
$relpath = $subdir . '/' . $file;
$details = SQLUpgradeItem::_getDetailsFromFileName($relpath);
if ($details) {
if (!gte_version($details[0], $origVersion)) {
continue;
}
if (!lte_version($details[1], $currVersion)) {
continue;
}
$ret[] = new SQLUpgradeItem($relpath);
}
}
}
}
closedir($dh);
return $ret;
}
public static function _getDetailsFromFileName($path) {
// Old format (pre 2.0.6)
$matches = false;
$matched = preg_match('#^([\d.]*)-to-([\d.]*).sql$#', $path, $matches);
if ($matched != 0) {
$fromVersion = $matches[1];
$toVersion = $matches[2];
$description = "Database upgrade from version $fromVersion to $toVersion";
$phase = 0;
return array($fromVersion, $toVersion, $description, $phase);
}
$matched = preg_match('#^([\d\.-]*)/(?:(\d*)-)?(.*)\.sql$#', $path, $matches);
//$matched = preg_match('#^([\d.]*)/(?:(\d*)-)?(.*):(?:(\d*))\.sql$#', $path, $matches);
if ($matched != 0) {
$fromVersion = $matches[1];
$toVersion = $matches[1];
$in = array('_');
$out = array(' ');
$phase = (int)$matches[2];
//$priority = (int)$matches[4];
$priority = 0;
$priorities = false;
$iPriority = preg_match('#^(.*)-(\d*)$#', $matches[3], $priorities);
if($iPriority != 0){
$priority = $priorities[2];
$matches[3] = $priorities[1];
}
$description = "Database upgrade to version $toVersion: " . ucfirst(str_replace($in, $out, $matches[3]));
return array($fromVersion, $toVersion, $description, $phase, $priority);
}
// XXX: handle new format
return null;
}
function _performUpgrade() {
$dbType = 'mysql';
$sqlupgradedir = KT_DIR . 'sql/' . $dbType . '/upgrade/';
$queries = SQLFile::sqlFromFile($sqlupgradedir . $this->name);
return $this->dbUtilities->runQueries($queries);
}
} // end class SQLUpgradeItem
class KTRebuildPermissionObserver {
function start() {
$this->lastBeat = time();
}
function receiveMessage() {
$now = time();
if ($this->lastBeat + 15 < $now) {
print "<!-- -->";
ob_flush();
flush();
}
}
function end() {
}
}
class RecordUpgradeItem extends UpgradeItem {
function RecordUpgradeItem ($version, $oldversion = null) {
$this->type = "upgrade";
if (is_null($oldversion)) {
$this->description = "Upgrade to version $version";
} else {
$this->description = "Upgrade from version $oldversion to $version";
}
$this->phase = 99;
$this->version = $version;
$this->name = 'upgrade' . $version;
}
function _performUpgrade() {
// What did this do?
/*
$this->_deleteSmartyFiles();
$this->_deleteProxyFiles();
require_once(KT_LIB_DIR . '/cache/cache.inc.php');
$oCache =& KTCache::getSingleton();
$oCache->deleteAllCaches();
// TODO : clear cache folder
require_once(KT_LIB_DIR . '/permissions/permissionutil.inc.php');
TODO : What does this do
$po =& new KTRebuildPermissionObserver($this);
$po->start();
$oChannel =& KTPermissionChannel::getSingleton();
$oChannel->addObserver($po);
*/
set_time_limit(0);
ignore_user_abort(true);
// What did this do?
/*
KTPermissionUtil::rebuildPermissionLookups(true);
$po->end();
*/
$versionFile=KT_DIR . '/docs/VERSION-NAME.txt';
$fp = fopen($versionFile,'rt');
$systemVersion = fread($fp, filesize($versionFile));
fclose($fp);
$query = "UPDATE system_settings SET value = '$systemVersion' WHERE name = 'knowledgetreeVersion'";
$this->runDBQuery($query);
$query = "UPDATE system_settings SET value = '{$this->version}' WHERE name = 'databaseVersion'";
$result = $this->runDBQuery($query);
return $result;
}
function _deleteSmartyFiles() {
$oConfig =& KTConfig::getSingleton();
$dir = sprintf('%s/%s', $oConfig->get('urls/varDirectory'), 'tmp');
$dh = @opendir($dir);
if (empty($dh)) {
return;
}
$aFiles = array();
while (false !== ($sFilename = readdir($dh))) {
if (substr($sFilename, -10) == "smarty.inc") {
$aFiles[] = sprintf('%s/%s', $dir, $sFilename);
}
if (substr($sFilename, -10) == "smarty.php") {
$aFiles[] = sprintf('%s/%s', $dir, $sFilename);
}
}
foreach ($aFiles as $sFile) {
@unlink($sFile);
}
}
function _deleteProxyFiles() {
$oKTConfig =& KTConfig::getSingleton();
// from ktentityutil::_proxyCreate
$sDirectory = $oKTConfig->get('cache/proxyCacheDirectory');
if (!file_exists($sDirectory)) {
return;
}
$sRunningUser = KTUtil::running_user();
if ($sRunningUser) {
$sDirectory = sprintf("%s/%s", $sDirectory, $sRunningUser);
}
if (!file_exists($sDirectory)) {
return ;
}
$dh = @opendir($sDirectory);
if (empty($dh)) {
return;
}
$aFiles = array();
while (false !== ($sFilename = readdir($dh))) {
if (substr($sFilename, -8) == ".inc.php") {
$aFiles[] = sprintf('%s/%s', $sDirectory, $sFilename);
}
}
foreach ($aFiles as $sFile) {
@unlink($sFile);
}
}
} // end class RecordUpgradeItem
?>