File Source for tangra_module_uninstaller.class.php

<?php
// *** Tangra framework for php
// $Id$
//
/**
* Contains class Tangra_Module_Uninstaller
*
* @package tangra_lib
* @subpackage modules_manager
*/
/**
*
*/
require_once(TANGRA_MAIN_DIR.'filesystem_toolbox/filesystem_functions.inc.php');
/**
* Tangra_Module_Uninstaller is the base class used by all module installers
*
* @package tangra_lib
* @subpackage modules_manager
*/
class Tangra_Module_Uninstaller extends Tangra_Class {
private $module_conf_path;
private $dbc;
private $site_root_dir = '';
/**
* Constructor
*
* Parameter $params is a structured array that must have at least key 'module-conf-path'. Other parameters have to be fed as key-value pairs.
*
* Example $params[''module-conf-path'] = '/some/path';
*
* @param array $params
*/
function __construct($params) {
$this->check_params($params);
$this->set_module_conf_path($params['module-conf-path']);
$hidden_start = strpos($params['module-conf-path'], 'hidden/conf');
if ($hidden_start !== false) {
$this->site_root_dir = substr($params['module-conf-path'], 0, $hidden_start);
}
if ($this->is_parameter_present($params, 'dbc')) {
$this->set_dbc($params['dbc']);
}
}
/**
* Performs uninstall of the module
*
* @return array
*/
public function uninstall() {
$ret = array('ok' => true, 'removed_files' => array(), 'removed_db_objects' => array());
if ($this->get_dbc()) {
$ret['removed_db_objects'] = $this->remove_db_objects();
}
$ret['removed_files'] = $this->remove_files();
return $ret;
}
/**
* Checks if parameter is present
*
* @param array $params
* @param string $parameter Parameter to be checked
* @return boolean
*/
protected function is_parameter_present($params, $parameter) {
return array_key_exists($parameter, $params);
}
/**
* Sets module conf path
*
* @param string $module_conf_path
*/
protected function set_module_conf_path($module_conf_path) {
if (file_exists($module_conf_path) && is_dir($module_conf_path)) {
$this->module_conf_path = $module_conf_path;
} else {
throw new TE_TMM_Exception('Path does not exist or it is not a directory: '.$module_conf_path);
}
}
/**
* Gets module conf path
*
* @return string
*/
public function get_module_conf_path() {
return $this->module_conf_path;
}
/**
* Sets DBC
*
* @param DB_Connection $dbc
*/
public function set_dbc( DB_Connection $dbc) {
$this->dbc = $dbc;
}
/**
* Gets DBC
*
* @return DB_Connection
*/
public function get_dbc() {
return $this->dbc;
}
/**
* Gets site root dir
*
* @return string
*/
public function get_site_root_dir() {
return $this->site_root_dir;
}
/**
* Checks if all required parameters are present
*
* @param array $params
* @throws TE_TMM_Exception
*/
protected function check_params($params) {
if (array_key_exists('module-conf-path', $params)) {
if (!$params['module-conf-path']) {
throw new TE_TMM_Exception('$params[module-conf-path] is empty.');
}
} else {
throw new TE_TMM_Exception('$params[module-conf-path] is not passed.');
}
}
/**
* Loads files list
*
* @return array
* @internal
*/
private function load_files_list() {
$files = array();
$module_files_list = tangra_normalize_path($this->get_module_conf_path()).'files.list';
if (file_exists($module_files_list)) {
$files = file($module_files_list);
}
return $files;
}
/**
* Prepares list of files to be removed expanding paths to full paths
*
* Can handle with files.list with releative paths
*
* @param array $files_list
* @return array
* @internal
*/
private function prepare_remove_list($files_list) {
$ret = array();
$site_dirs = $this->load_site_dirs();
foreach($files_list as $item) {
$item = trim($item);
if (strpos($item, '%') !== false) {
$item = str_replace('%HIDDEN%', $site_dirs['hidden'], $item);
$item = str_replace('%HTDOCS%', $site_dirs['htdocs'], $item);
$item = str_replace('%EXT_INC%', $site_dirs['ext_inc'], $item);
$item = str_replace('%SCRATCH%', $site_dirs['scratch'], $item);
$space_pos = strpos($item, ' ');
if ($space_pos !== false) {
$item = substr($item, 0, $space_pos);
}
$ret[] = $item;
} else {
// processing old style files.list (i.e. with full paths or relative without root dir)
$space_pos = strpos($item, ' ');
if ($space_pos !== false) {
if (substr($item, 0, 1) == '/') {
$ret[] = substr($item, 0, $space_pos);
} else {
$ret[] = $this->get_site_root_dir().substr($item, 0, $space_pos);
}
} else {
if (substr($item, 0, 1) == '/') {
$ret[] = $item;
} else {
$ret[] = $this->get_site_root_dir().$item;
}
}
}
}
return $ret;
}
/**
* Removes module's files
*
* @return array
*/
protected function remove_files() {
$ret['ok'] = array();
$ret['err'] = array();
$ret['freed'] = 0;
$files_list = $this->prepare_remove_list($this->load_files_list());
if ($files_list) {
$files_list = array_reverse($files_list);
$used_space = 0;
foreach($files_list as $item) {
$rez = false;
if (file_exists($item)) {
if (is_dir($item)) {
if (is_dir_empty($item)) {
$rez = @rmdir($item);
}
} else {
if (is_file($item) || is_link($item)) {
$used_space += filesize($item);
$rez = @unlink($item);
} else {
$rez = false;
}
}
} else {
$rez = true;
}
if ($rez) {
$ret['ok'][] = $item;
} else {
$ret['err'][] = $item;
}
$ret['freed'] = $used_space;
}
}
return $ret;
}
/**
* Removes DB objects - tables and/or columns
*
* @return array
*/
protected function remove_db_objects() {
$dbc = $this->get_dbc();
$module_conf_path = $this->get_module_conf_path();
$ret['ok'] = array();
$ret['err'] = array();
$file = $module_conf_path.'uninstall_db_items.txt';
if (file_exists($file)) {
$arr = file($file);
foreach($arr as $row) {
$pair = explode('==', $row);
if (count($pair) == 2 && trim($pair[1])) {
try {
switch($pair[0]) {
case 'drop_table':
$sql = 'drop table '.addslashes($pair[1]);
break;
case 'drop_column':
$sql = $this->generate_drop_columns_sql($pair[1]);
break;
case 'sql':
$sql = $pair[1];
break;
default:
$sql = '';
break;
}
if ($sql) {
$dbc->execute($sql);
$ret['ok'][] = $row;
}
} catch (Exception $e) {
if ($e instanceof TE_DBC_SQL_Failed) {
$ret['err'][] = $row;
} else {
throw $e;
}
}
}
}
}
return $ret;
}
/**
* Generates SQL for drop column
*
* @param string $str
* @return string SQL Drop column statement
* @internal
*/
private function generate_drop_columns_sql($str) {
$ret = '';
$tmp = explode(':', $str);
if (count($tmp) == 2) {
$table = $tmp[0];
if (trim($tmp[1])) {
$column = trim($tmp[1]);
$ret = "ALTER TABLE $table DROP COLUMN '$column'";
}
}
return $ret;
}
/**
* Loads hidden, htdocs, scratch and ext_inc paths and returns them as array
*
* @param string $root_dir Path to site's root dir
* @return array
*/
private function load_site_dirs() {
$module_conf_path = $this->get_module_conf_path();
$root_dir = substr($module_conf_path, 0, strpos($module_conf_path, 'hidden/conf/modules/'));
$root_dir = substr($module_conf_path, 0, strpos($module_conf_path, 'hidden/conf/modules/')); // just in case path is not normalized
$ms_conf = $root_dir.'hidden/conf/machine_specific.conf';
$ms_conf = $root_dir.'hidden/conf/machine_specific.conf';
$conf_loader = new Config_Loader_File($ms_conf);
$hidden_dir = $conf_loader->get_conf_value('HIDDEN', false);
if (!$hidden_dir) {
$hidden_dir = $root_dir.'hidden/';
}
$htdocs_dir = $conf_loader->get_conf_value('DOCUMENT_ROOT', false);
if (!$htdocs_dir) {
$htdocs_dir = $root_dir.'htdocs/';
}
$scratch_dir = $conf_loader->get_conf_value('SCRATCH', false);
if (!$scratch_dir) {
$scratch_dir = $root_dir.'scratch/';
}
$ext_inc_dir = $conf_loader->get_conf_value('EXT_INC', false);
if (!$ext_inc_dir) {
$ext_inc_dir = $root_dir.'ext_inc/';
}
return array('hidden' => $hidden_dir, 'htdocs' => $htdocs_dir, 'scratch' => $scratch_dir, 'ext_inc' => $ext_inc_dir);
}
}

Source for file tangra_module_uninstaller.class.php