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/wizard/steps/configuration.php

721 lines
25 KiB
PHP

<?php
/**
* Configuration Step Controller.
*
* 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.
*
* @copyright 2008-2009, KnowledgeTree Inc.
* @license GNU General Public License version 3
* @author KnowledgeTree Team
* @package Installer
* @version Version 0.1
*/
class configuration extends Step
{
private $fpath = false;
private $allConfs;
/**
* Database host
*
* @author KnowledgeTree Team
* @access private
* @var string
*/
private $host;
/**
* Database port
*
* @author KnowledgeTree Team
* @access private
* @var string
*/
private $port;
/**
* Relative path to knowledge tree directory
*
* @author KnowledgeTree Team
* @access private
* @var string
*/
private $root_url;
/**
* Absolute path to knowledge tree directory
*
* @author KnowledgeTree Team
* @access private
* @var string
*/
private $file_system_root;
/**
* Whether or not ssl is enabled
*
* @author KnowledgeTree Team
* @access private
* @var string
*/
private $ssl_enabled;
/**
* Whether or not the step is complete
*
* @author KnowledgeTree Team
* @access private
* @var string
*/
private $done;
/**
* Flag to display confirmation page first
*
* @author KnowledgeTree Team
* @access public
* @var array
*/
public $displayFirst = true;
/**
* Flag to store class information in session
*
* @author KnowledgeTree Team
* @access public
* @var array
*/
protected $storeInSession = true;
/**
* Flag if step needs to be installed
*
* @author KnowledgeTree Team
* @access public
* @var array
*/
protected $runInstall = true;
/**
* Flag if step needs to run silently
*
* @author KnowledgeTree Team
* @access public
* @var array
*/
protected $silent = false;
/**
* Flag if step needs to run silently
*
* @author KnowledgeTree Team
* @access public
* @var array
*/
protected $error = array();
/**
* List of paths
*
* @author KnowledgeTree Team
* @access public
* @var array
*/
protected $paths = array();
/**
* Reference to utility object
*
* @author KnowledgeTree Team
* @access protected
* @var object
*/
public $util;
protected $confpaths = array();
/**
* Control function for position within the step
*
* @author KnowledgeTree Team
* @access public
* @return string The position in the step
*/
public function doStep() {
$this->temp_variables = array("step_name"=>"configuration", "silent"=>$this->silent);
$this->done = true;
if(!$this->inStep("configuration")) {
$res = $this->setDetails();
$this->doRun($res);
return 'landing';
}
$this->loadTemplateDefaults();
if($this->next()) {
if($this->doRun()) {
return 'confirm';
}
return 'error';
} else if($this->previous()) {
return 'previous';
} else if($this->confirm()) {
$res = $this->setDetails();
if($this->doRun($res)) {
return 'next';
}
return 'error';
} else if($this->edit()) {
$res = $this->setDetails();
if($this->doRun($res)) {
return 'landing';
} else {
return 'error';
}
}
$this->doRun();
return 'landing';
}
/**
* Set the variables from those stored in the session.
* Used for stepping back to the step from a future step.
*
* @author KnowledgeTree Team
* @access private
* @param none
* @return void
*/
private function setDetails() {
$conf = $this->getDataFromSession("configuration");
if($conf) {
$this->temp_variables['server'] = $conf['server'];
$this->temp_variables['paths'] = $conf['paths'];
return true;
} else {
return false;
}
}
/**
* Default Template settings
*
* @author KnowledgeTree Team
* @access public
* @param none
* @return void
*/
public function loadTemplateDefaults() {
$this->temp_variables['paths_perms'] = 'tick';
}
/**
* Execute the step
*
* @author KnowledgeTree Team
* @access public
* @return boolean True to continue | False if errors occurred
*/
public function doRun($edit = false)
{
$server = $this->getServerInfo();
if(!$edit || $this->util->isMigration())
$this->temp_variables['server'] = $server;
$paths = $this->getPathInfo($server['file_system_root']['value']);
if(!$edit || $this->util->isMigration())
$this->temp_variables['paths'] = $paths;
// Rewrite file system root
if(!$this->fpath) {
$froot = $this->temp_variables['server']['file_system_root']['value'];
$this->temp_variables['server']['file_system_root']['value'] = 'default';
}
return $this->done;
}
/**
* Get the database configuration settings
*
* @author KnowledgeTree Team
* @access public
* @param array $server
* @param array $dbconf
* @return array
*/
public function registerDBConfig($server, $dbconf) { // Adjust server variables
$server['dbName'] = array('where'=>'file', 'name'=>ucwords($dbconf['dname']), 'section'=>'db', 'value'=>$dbconf['dname'], 'setting'=>'dbName');
$server['dbUser'] = array('where'=>'file', 'name'=>ucwords($dbconf['dmsname']), 'section'=>'db', 'value'=>$dbconf['dmsname'], 'setting'=>'dbUser');
$server['dbPass'] = array('where'=>'file', 'name'=>ucwords($dbconf['dmspassword']), 'section'=>'db', 'value'=>$dbconf['dmspassword'], 'setting'=>'dbPass');
$server['dbPort'] = array('where'=>'file', 'name'=>ucwords($dbconf['dport']), 'section'=>'db', 'value'=>$dbconf['dport'], 'setting'=>'dbPort');
$server['dbAdminUser'] = array('where'=>'file', 'name'=>ucwords($dbconf['dmsname']), 'section'=>'db', 'value'=>$dbconf['dmsname'], 'setting'=>'dbAdminUser');
$server['dbAdminPass'] = array('where'=>'file', 'name'=>ucwords($dbconf['dmspassword']), 'section'=>'db', 'value'=>$dbconf['dmspassword'], 'setting'=>'dbAdminPass');
return $server;
}
private function registerDirs() { // Adjust directories variables
$directories['varDirectory'] = array('section'=>'urls', 'value'=>addslashes($this->allConfs['varDirectory']['path']), 'setting'=>'varDirectory');
$directories['logDirectory'] = array('section'=>'urls', 'value'=>addslashes($this->allConfs['logDirectory']['path']), 'setting'=>'logDirectory');
$directories['documentRoot'] = array('section'=>'urls', 'value'=>addslashes($this->allConfs['documentRoot']['path']), 'setting'=>'documentRoot');
$directories['uiDirectory'] = array('section'=>'urls', 'value'=>'${fileSystemRoot}/presentation/lookAndFeel/knowledgeTree', 'setting'=>'uiDirectory');
$directories['tmpDirectory'] = array('section'=>'urls', 'value'=>addslashes($this->allConfs['tmpDirectory']['path']), 'setting'=>'tmpDirectory');
$directories['cacheDirectory'] = array('section'=>'cache', 'value'=>addslashes($this->allConfs['cacheDirectory']['path']), 'setting'=>'cacheDirectory');
return $directories;
}
/**
* Perform the installation associated with the step.
* Variables required by the installation are stored within the session.
*
* @author KnowledgeTree Team
* @access public
*/
public function installStep()
{
$this->file_system_root = realpath(SYSTEM_DIR);
$conf = $this->getDataFromSession("configuration"); // get data from the server
$dbconf = $this->getDataFromSession("database");
$this->util->dbUtilities->load($dbconf['dhost'], $dbconf['dport'], $dbconf['dmsname'], $dbconf['dmspassword'], $dbconf['dname']);
$server = $conf['server'];
$paths = $conf['paths'];
if ($this->util->isMigration()) { // Check if its an upgrade
$this->readInstallation();
$this->confpaths['configIni'] = $paths['configFile']['path'];
} else {
$this->readConfigPath(); // initialise writing to config.ini
}
$this->getFromConfigPath(); // Sets config Paths
if(file_exists($this->confpaths['configIni'])) {
$this->util->iniUtilities->load($this->confpaths['configIni']);
}
if(!$this->util->iniUtilities=== false){ // write out the config.ini file
$this->writeUrlSection();
$this->writeDBSection($server);
$this->writeDBPathSection($paths);
$this->util->iniUtilities->write();
}
$this->util->dbUtilities->close(); // close the database connection
$this->writeCachePath($this->getCachePath(), $paths['cacheDirectory']['path']); // Write cache path file
$this->writeConfigPath($this->getContentPath(), $this->confpaths['configIni']); // Write config file
}
private function writeUrlSection() {
$directories = $this->registerDirs();
foreach($directories as $item) { // write server settings to config_settings table and config.ini
$this->util->iniUtilities->updateItem($item['section'], $item['setting'], $item['value']);
}
}
private function writeDBPathSection($paths) {
$table = 'config_settings';
if(is_array($paths)) { // write the paths to the config_settings table
foreach ($paths as $item){
if(empty($item['setting'])){
continue;
}
$value = mysql_real_escape_string($item['path']);
$setting = mysql_real_escape_string($item['setting']);
$sql = "UPDATE {$table} SET value = '{$value}' WHERE item = '{$setting}'";
$this->util->dbUtilities->query($sql);
}
}
}
private function writeDBSection($server) {
$dbconf = $this->getDataFromSession("database"); // retrieve database information from session
$this->util->dbUtilities->load($dbconf['dhost'], $dbconf['dport'], $dbconf['duname'], $dbconf['dpassword'], $dbconf['dname']); // initialise the db connection
$server = $this->registerDBConfig($server, $dbconf); // add db config to server variables
$table = 'config_settings';
foreach($server as $item) { // write server settings to config_settings table and config.ini
switch($item['where']) {
case 'file':
$value = $item['value'];
if($value == 'yes') {
$value = 'true';
}
if($value == 'no'){
$value = 'false';
}
$this->util->iniUtilities->updateItem($item['section'], $item['setting'], $value);
break;
case 'db':
$value = mysql_real_escape_string($item['value']);
$setting = mysql_real_escape_string($item['setting']);
$sql = "UPDATE {$table} SET value = '{$value}' WHERE item = '{$setting}'";
$this->util->dbUtilities->query($sql);
break;
}
}
}
/**
* Get the server settings information
*
* @author KnowledgeTree Team
* @access private
* @return array Server settings
*/
private function getServerInfo()
{
$script = $_SERVER['SCRIPT_NAME'];
$file_system_root = realpath(SYSTEM_DIR);
$this->file_system_root = $file_system_root;
$host = $_SERVER['SERVER_NAME'];
$port = $_SERVER['SERVER_PORT'];
$ssl_enabled = isset($_SERVER['HTTPS']) ? (strtolower($_SERVER['HTTPS']) === 'on' ? 'yes' : 'no') : 'no';
$pos = strpos($script, '/setup/wizard/');
$root_url = substr($script, 0, $pos);
$root_url = (isset($_POST['root_url'])) ? $_POST['root_url'] : $root_url;
$file_system_root = (isset($_POST['file_system_root'])) ? $_POST['file_system_root'] : $file_system_root;
$host = (isset($_POST['host'])) ? $_POST['host'] : $host;
$port = (isset($_POST['port'])) ? $_POST['port'] : $port;
$ssl_enabled = (isset($_POST['ssl_enabled'])) ? $_POST['ssl_enabled'] : $ssl_enabled;
$server = array();
$server['root_url'] = array('name' => 'Root Url', 'setting' => 'rootUrl', 'where' => 'db', 'value' => $root_url);
$server['file_system_root'] = array('name' => 'File System Root', 'section' => 'KnowledgeTree', 'setting' => 'fileSystemRoot', 'where' => 'file', 'value' => $file_system_root);
$server['host'] = array('name' => 'Host', 'setting' => 'server_name', 'where' => 'db', 'value' => $host);
$server['port'] = array('name' => 'Port', 'setting' => 'server_port', 'where' => 'db', 'value' => $port);
$server['ssl_enabled'] = array('name' => 'SSL Enabled', 'section' => 'KnowledgeTree', 'setting' => 'sslEnabled', 'where' => 'file', 'value' => $ssl_enabled);
if(empty($server['host']['value']))
$this->error[] = 'Enter the server\'s host name';
if(empty($server['port']['value']))
$this->error[] = 'Enter the server\'s port';
if(empty($server['file_system_root']['value']))
$this->error[] = 'Enter the file system root';
return $server;
}
/**
* Get the path information for directories. Check permissions and existence of each.
* Expands any ${fileSystemRoot} and ${varDirectory} variables contained in the path.
*
* @author KnowledgeTree Team
* @access private
* @param string $fileSystemRoot The file system root of the installation
* @return array The path information
*/
private function getPathInfo($fileSystemRoot)
{
if(isset($this->temp_variables['paths'])) {
if ($this->util->isMigration()) { // Check if its an upgrade
$this->readConfigPath(); // Read contents of config-path file as only var Documents are used of old stack
$this->readInstallation(); // Read values from config.ini of other installation and overwrite config-path's
$dirs = $this->getFromConfigPath(); // Store contents
} else {
$dirs = $this->temp_variables['paths']; // Pull from temp
}
} else {
if ($this->util->isMigration()) { // Check if its an upgrade
$this->readConfigPath(); // Read contents of config-path file as only var Documents are used of old stack
$this->readInstallation(); // Read values from config.ini of other installation
} else {
$this->readConfigPath(); // Read contents of config-path file
}
$dirs = $this->getFromConfigPath(); // Store contents
}
$varDirectory = $fileSystemRoot . DS . 'var';
foreach ($dirs as $key => $dir){
$path = (isset($_POST[$dir['setting']])) ? $_POST[$dir['setting']] : $dir['path'];
while(preg_match('/\$\{([^}]+)\}/', $path, $matches)){
$path = str_replace($matches[0], $$matches[1], $path);
}
if(WINDOWS_OS)
$path = preg_replace('/\//', '\\',$path);
$dirs[$key]['path'] = $path;
$path = $class = strtolower(substr($path,0,1)).substr($path,1); // Damn you windows
if(isset($dir['file'])) {
$class = $this->util->checkPermission($path, false, true);
} else {
$class = $this->util->checkPermission($path, $dir['create']);
}
if(isset($class['msg'])) {
if($class['class'] != 'tick') {
$this->temp_variables['paths_perms'] = $class['class'];
$this->done = false;
$this->error[] = $class['msg'];
}
}
$dirs[$key] = array_merge($dirs[$key], $class);
}
return $dirs;
}
/**
* Store contents of edited settings
*
* @author KnowledgeTree Team
* @access private
* @param none
* @return array The path information
*/
private function getFromConfigPath() {
$configs = array();
if(isset($this->confpaths['configIni'])) { // Simple check to see if any paths were written
$configPath = $this->confpaths['configIni']; // Get absolute path
} else {
$configPath = $this->readConfigPathIni(); //'${fileSystemRoot}/config/config.ini';
}
$configs['configFile'] = array('name' => 'Configuration File', 'setting' => 'configFile', 'path' => $configPath, 'create' => false, 'file'=>true);
if(isset($this->confpaths['Documents'])) {
$docsPath = $this->confpaths['Documents'];
} else {
$docsPath = '${varDirectory}/Documents';
}
$configs['documentRoot'] = array('name' => 'Document Directory', 'setting' => 'documentRoot', 'path' => $docsPath, 'create' => true);
if(isset($this->confpaths['log'])) {
$logPath = $this->confpaths['log'];
} else {
$logPath = '${varDirectory}/log';
}
$configs['logDirectory'] = array('name' => 'Log Directory', 'setting' => 'logDirectory', 'path' => $logPath, 'create' => true);
if(isset($this->confpaths['tmp'])) {
$tmpPath = $this->confpaths['tmp'];
} else {
$tmpPath = '${varDirectory}/tmp';
}
$configs['tmpDirectory'] = array('name' => 'Temporary Directory', 'setting' => 'tmpDirectory', 'path' => $tmpPath, 'create' => true);
if(isset($this->confpaths['cache'])) {
$cachePath = $this->confpaths['cache'];
} else {
$cachePath = '${varDirectory}/cache';
}
$configs['cacheDirectory'] = array('name' => 'Cache Directory', 'setting' => 'cacheDirectory', 'path' => $cachePath, 'create' => true);
if(isset($this->confpaths['uploads'])) {
$uploadsPath = $this->confpaths['uploads'];
} else {
$uploadsPath = '${varDirectory}/uploads';
}
$configs['uploadDirectory'] = array('name' => 'Uploads Directory', 'setting' => 'uploadDirectory', 'path' => $uploadsPath, 'create' => true);
if(isset($this->confpaths['var'])) {
$varPath = $this->confpaths['var'];
} else {
$varPath = '${fileSystemRoot}/var';
}
$configs['varDirectory'] = array('name' => 'Var Directory', 'setting' => 'varDirectory', 'path' => $varPath, 'create' => false);
$this->allConfs = $configs;
return $configs;
}
/**
* Migration Path finder
*
* @author KnowledgeTree Team
* @access private
* @param none
* @return boolean
*/
private function readInstallation() {
$inst = $this->getDataFromPackage('migrate', 'installation');
if(isset($inst['urlPaths'])) {
foreach ($inst['urlPaths'] as $name=>$path) {
$k = $path['path'];
if($path['name'] == 'Var Directory') {
$this->confpaths['var'] = $k;
} elseif($path['name'] == 'Log Directory') {
$this->confpaths['log'] = $k;
} elseif($path['name'] == 'Document Root') {
$this->confpaths['Documents'] = $k;
} elseif($path['name'] == 'UI Directory') {
} elseif($path['name'] == 'Temporary Directory') {
$this->confpaths['tmp'] = $k;
} elseif($path['name'] == 'Cache Directory') {
$this->confpaths['cache'] = $k;
} elseif ($path['name'] == 'Upload Directory') {
$this->confpaths['uploads'] = $k;
}
}
}
return true;
}
public function readConfigPathIni() {
if(isset($this->temp_variables['paths']['configFile']['path'])) {
if($this->temp_variables['paths']['configFile']['path'] != '')
return $this->temp_variables['paths']['configFile']['path'];
}
$configPath = $this->getContentPath();
if(!$configPath) {
return false;
}
$data = $this->util->getFileByLine($configPath);
$firstline = true;
foreach ($data as $k) {
if(preg_match('/config.ini/', $k)) { // Find config.ini
if($k == "config/config.ini") { // Source install and source upgrades
$configIniPath = realpath(SYSTEM_DIR.$k);
if($configIniPath)
return $configIniPath;
}
return $k;
}
}
return false;
}
public function readCachePath() {
$cachePath = $this->getCachePath();
if(!$cachePath) {
return false;
}
$data = $this->util->getFileByLine($cachePath);
$firstline = true;
foreach ($data as $k) {
if(preg_match('/cache/', $k)) { // Find config.ini
if($k == "var/cache") { // Source install and source upgrades
$configIniPath = realpath(SYSTEM_DIR.$k);
if($configIniPath)
return $configIniPath;
}
return $k;
}
}
return false;
}
/**
* Read contents of config path file
*
* @author KnowledgeTree Team
* @access private
* @param none
* @return boolean
*/
private function readConfigPath() {
$configPath = $this->getContentPath();
if(!$configPath) return false;
$data = $this->util->getFileByLine($configPath);
$firstline = true;
foreach ($data as $k) {
if($firstline) { // First line holds the var directory
$firstline = false;
if(!preg_match('/config.ini/', $k)) { // Make sure it is not the old config.ini
$this->confpaths['var'] = $k; // Store var directory
}
}
if(preg_match('/config.ini/', $k)) { // Find config.ini
$this->confpaths['configIni'] = $k;
} elseif (preg_match('/Documents/', $k)) { // Find documents directory
$this->confpaths['Documents'] = $k;
} elseif (preg_match('/cache/', $k)) {
$this->confpaths['cache'] = $k;
} elseif (preg_match('/indexes/', $k)) {
$this->confpaths['indexes'] = $k;
} elseif (preg_match('/log/', $k)) {
$this->confpaths['log'] = $k;
} elseif (preg_match('/proxies/', $k)) {
$this->confpaths['proxies'] = $k;
} elseif (preg_match('/uploads/', $k)) {
$this->confpaths['uploads'] = $k;
} elseif (preg_match('/tmp/', $k)) {
$this->confpaths['tmp'] = $k;
}
}
// Source Installs
if($this->confpaths['configIni'] == 'config/config.ini') {
$this->confpaths['configIni'] = $this->file_system_root .DS. $this->confpaths['configIni'];
}
return true;
}
/**
* Write location of config path file
*
* @author KnowledgeTree Team
* @access private
* @param none
* @return boolean
*/
private function writeConfigPath($configPath, $configContent) {
if($configContent == 'config/config.ini') {
$configContent = $this->file_system_root . DS . 'config/config.ini';
}
$fp = fopen($configPath, 'w+');
if($configContent != '' && $fp) {
if(fwrite($fp, $configContent))
return true;
}
return false;
}
private function writeCachePath($cachePath, $cacheContent) {
if($cacheContent == 'var/cache') {
$cacheContent = $this->file_system_root . DS . 'var/cache';
}
$fp = fopen($cachePath, 'w+');
if($cacheContent != '' && $fp) {
if(fwrite($fp, $cacheContent))
return true;
}
return false;
}
/**
* Attempt to locate config-path file in system
*
* @author KnowledgeTree Team
* @access private
* @param none
* @return mixed
*/
public function getContentPath() {
$configPath = realpath('../../../config/config-path');
if($configPath == '')
$configPath = realpath('../../config/config-path');
if(!$configPath) return false;
return $configPath;
}
public function getCachePath() {
$cachePath = realpath('../../../config/cache-path');
if($cachePath == '')
$cachePath = realpath('../../config/cache-path');
if(!$cachePath) return false;
return $cachePath;
}
}
?>