File Source for tangra_module_installer.class.php

<?php
// *** Tangra (Application Framework and Tools for PHP)
// $Id$
//
/**
* Contains class Tangra_Module_Installer
*
* @package tangra_lib
* @subpackage modules_manager
*/
/**
*
*/
require_once(TANGRA_MAIN_DIR.'filesystem_toolbox/filesystem_functions.inc.php');
/**
*
*/
require_once(TANGRA_MAIN_DIR.'filesystem_toolbox/tangra_file.class.php');
/**
*
*/
require_once(TANGRA_MAIN_DIR.'core/tangra_simple_tple.class.php');
/**
*
*/
require_once(TANGRA_MAIN_DIR.'modules_manager/can_upgrade_loader.class.php');
/**
*
*/
require_once(TANGRA_MAIN_DIR.'misc/misc.inc.php');
/**
*
*/
require_once('exceptions/te_tmm_target_dir_not_exists.class.php');
/**
*
*/
require_once('exceptions/te_tmm_target_dir_not_writable.class.php');
/**
*
*/
require_once('exceptions/te_tmm_item_already_exist.class.php');
/**
* Type File
*
*/
define('TMM_INSTALL_ITEM_TYPE_FILE', 0);
/**
* Type directory
*
*/
define('TMM_INSTALL_ITEM_TYPE_DIR', 1);
/**
* Type symlink
*
*/
define('TMM_INSTALL_ITEM_TYPE_SYMLINK', 2);
/**
* Prefix for section start in config file
*
*/
define('TMM_CONFFILE_SECTION_START_PREFIX', "\n//+++ section ");
/**
* Suffix for section start in config file
*
*/
define('TMM_CONFFILE_SECTION_START_SUFFIX', " START\n\n");
/**
* Prefix for section end in config file
*
*/
define('TMM_CONFFILE_SECTION_END_PREFIX', "\n//--- section ");
/**
* Suffix for section end in config file
*
*/
define('TMM_CONFFILE_SECTION_END_SUFFIX', " END\n\n");
/**
* Tangra_Module_Installer is the base class used by all module installers
*
* @package tangra_lib
* @subpackage modules_manager
*/
abstract class Tangra_Module_Installer extends Tangra_Class {
/**
* Name of the module
*
* @var string
* @internal
*/
private $module_name;
/**
* Module source dir
*
* @var string
* @internal
*/
private $module_dir;
/**
* Root directory of the site where module will be installed
*
* @var string
* @internal
*/
private $target_dir;
/**
* List of installed files and directories
*
* @var array
* @internal
*/
protected $files = array();
/**
* Flag for overwrite all
*
* @var boolean
* @internal
*/
private $overwrite_all;
/**
* Flag for overwrite
*
* @var boolean
* @internal
*/
private $overwrite;
/**
* Usergroup to which intalled files will be chown-ed
*
* @var string
* @internal
*/
private $file_group = '';
/**
* Filepermissions that will be used to chmod installed files to
*
* @var integer
* @internal
*/
private $file_permissions = '';
/**
* Permissions that will be used to chmod dirs to
*
* @var integer
*/
private $dir_permissions = '';
/**
* Contains array with version => upgrade method pairs
*
* Each instance of module installer must provide values (in __constructor) here if it is capable of upgrade
*
* @var array
*/
private $upgrade_matrix = array();
/**
* Constructor
*
* Parameter $params is a structured array that must have at least key 'target-path'. Other parameters have to be fed as key-value pairs.
*
* Example $params['smarty-dir'] = '/some/path';
*
* @param array $params
*/
function __construct($params) {
$this->check_params($params);
$this->set_target_dir($params['target-path']);
if ($this->is_parameter_present($params, 'overwrite')) {
$this->set_overwrite($params['overwrite']);
}
if ($this->is_parameter_present($params, 'overwrite-all')) {
$this->set_overwrite_all($params['overwrite-all']);
}
if ($this->is_parameter_present($params, 'file-permissions')) {
$this->set_file_permissions($params['file-permissions']);
}
if ($this->is_parameter_present($params, 'dir-permissions')) {
$this->set_dir_permissions($params['dir-permissions']);
}
if ($this->is_parameter_present($params, 'file-group')) {
$this->set_file_group($params['file-group']);
}
}
/**
* Activities that have to be performed before actual installation have to be placed here.
*
*/
abstract function pre_install();
/**
* Actual installation. This method have to be overwrited by inherited clases.
*
*/
public function install() {
$this->create_module_conf_dir();
}
/**
* Activities that have to be performed after actual installation have to be placed here.
*
* If you overwrite this method don't forget to call parent::post_install()
*/
public function post_install() {
$this->copy_module_ctrl();
$this->write_files_list();
// $this->change_file_properties();
}
/**
* Creates modules conf dir (hidden/conf/modules)
*
*/
abstract protected function create_module_conf_dir();
/**
* Checks if all required parameters are present
*
* @param array $params
* @throws TE_TMM_Exception
*/
protected function check_params($params) {
if (array_key_exists('target-dir', $params)) {
if (!$params['target-dir']) {
throw new TE_TMM_Exception('$params[target_dir] is empty.');
}
}
}
/**
* Sets module name
*
* @param string $name
* @throws TE_TMM_Exception
*/
final protected function set_module_name($name) {
if (ereg("^[a-z]{1}[a-z0-9_]{1,254}$", $name)) {
$this->module_name = $name;
} else {
throw TE_TMM_Exception('Invalid module name: '.$name);
}
}
/**
* Returns module name
*
* @return string
*/
final public function get_module_name() {
return $this->module_name;
}
/**
* Sets module source dir
*
* @param string $module_dir
*/
final protected function set_module_dir($module_dir) {
$this->module_dir = $module_dir;
}
/**
* Returns module source dir
*
* @return unknown
*/
final public function get_module_dir() {
return $this->module_dir;
}
/**
* Sets root directory of the site where module will be installed
*
* @param string $target_dir
* @throws TE_TMM_Target_Dir_Not_Writable, TE_TMM_Target_Dir_Not_Exists, TE_TMM_Target_Dir_Not_Exists
*/
final protected function set_target_dir($target_dir) {
if (file_exists($target_dir)) {
if (is_dir($target_dir)) {
if (is_writable($target_dir)) {
$this->target_dir = tangra_normalize_path($target_dir);
} else {
throw new TE_TMM_Target_Dir_Not_Writable('Dir:'.$target_dir.' is not writable');
}
} else {
throw new TE_TMM_Target_Dir_Not_Exists('Dir: '.$target_dir.'. Such item exist and it is not a directory.');
}
} else {
throw new TE_TMM_Target_Dir_Not_Exists('Target dir '.$target_dir.' does not exist.');
}
}
/**
* Gets root directory of the site where module will be installed
*
* @return unknown
*/
final public function get_target_dir() {
return $this->target_dir;
}
/**
* Sets overwrite flag
*
* @param boolean $owr
*/
final public function set_overwrite($owr) {
$this->overwrite = $owr ? true : false;
}
/**
* Returns overwrite flag
*
* @return boolean
*/
final public function get_overwrite() {
$ret = $this->overwrite || $this->overwrite_all;
return $ret;
}
/**
* Sets overwrite all flag
*
* @param boolean $owr
*/
final public function set_overwrite_all($owr) {
$this->overwrite_all = $owr ? true : false;
}
/**
* Returns overwrite all flag
*
* @return boolean
*/
final public function get_overwrite_all() {
return $this->overwrite_all;
}
/**
* Sets permission that will be used to chmod installed files to
*
* Please note that you have to pass parameter $file_permissions without leading zero (for octal value).
*
* @param integer $file_permissions
*/
final public function set_file_permissions($file_permissions) {
$this->file_permissions = $file_permissions;
}
/**
* Returns permission that will be used to chmod installed files to
*
* @return integer
*/
final public function get_file_permissions() {
return $this->file_permissions;
}
/**
* Sets permission that will be used to chmod installed dirs to
*
* Please note that you have to pass parameter $dir_permissions without leading zero (for octal value).
*
* @param integer $dir_permissions
*/
final public function set_dir_permissions($dir_permissions) {
$this->dir_permissions = $dir_permissions;
}
/**
* Returns permission that will be used to chmod installed dirs to
*
* @return integer
*/
final public function get_dir_permissions() {
return $this->dir_permissions;
}
/**
* Sets usergroup to which intalled files will be chown-ed
*
* @param string $file_group
*/
final public function set_file_group($file_group) {
$this->file_group = $file_group;
}
/**
* Returns usergroup to which intalled files will be chown-ed
*
* @return unknown
*/
final public function get_file_group() {
return $this->file_group;
}
/**
* 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);
}
/**
* Recursive copy of given directory
*
* @param string $source_dir Source dir
* @param string $destination_dir destination dir
* @param boolean $is_root If false tries to create $destionation_dir if not already exist. If true will copy just the content of $source_dir.
* @throws TE_TMM_Exception
*/
protected function copy_static_content_bulk($source_dir, $destination_dir, $is_root = true) {
$destination_dir = tangra_normalize_path($this->get_target_dir().$destination_dir);
$source_dir = $this->get_module_dir().'static/'.$source_dir;
$this->_copy_static_content_bulk($source_dir, $destination_dir, $is_root);
}
/**
* Recursive copy of given directory (actual copy)
*
* @param string $source_dir Source dir
* @param string $destination_dir destination dir
* @param boolean $is_root If false tries to create $destionation_dir if not already exist. If true will copy just the content of $source_dir.
* @throws TE_TMM_Item_Already_Exist
*/
private function _copy_static_content_bulk($source_dir, $destination_dir, $is_root = true) {
if (!$is_root) {
if (!file_exists($destination_dir)) {
$this->create_dir_full_path($destination_dir);
}
}
if ($dir = opendir($source_dir)) {
while (($item = readdir($dir)) !== false) {
if ($item != '.' && $item != '..') {
if (file_exists("$destination_dir$item") && !is_dir("$destination_dir$item")) {
if (!$this->get_overwrite()) {
throw new TE_TMM_Item_Already_Exist("File/directory "."$destination_dir$item already exists. Consider using option 'overwrite'.");
}
}
if (is_file("$source_dir/$item")) {
if (copy("$source_dir/$item","$destination_dir$item")) {
$this->add_to_files_list_file("$destination_dir$item");
} else {
throw new TE_TMM_Item_Already_Exist("Can't copy $source_dir/$item to $destination_dir$item");
}
} else {
if ($item != '.svn') {
$tmp_arr = $this->_copy_static_content_bulk("$source_dir/$item", tangra_normalize_path($destination_dir).$item.'/', false);
} else {
continue;
}
}
}
}
closedir($dir);
}
}
/**
* Sets installed files list.
*
* @param array $files
* @throws Tangra_Exception
*/
public function set_files($files) {
if (is_array($files)) {
$this->files = $files;
} else {
throw new Tangra_Exception('$files is not an array.');
}
}
/**
* Returns installed files list
*
* @return unknown
*/
public function get_files() {
return $ret;
}
/**
* Writes installed files list to files.list
*
*/
protected function write_files_list() {
$filename = $this->get_target_dir().'hidden/conf/modules/'.$this->get_module_name().'/files.list';
$file = new Tangra_File($filename, "w");
foreach($this->files as $item) {
if ($item['type'] == TMM_INSTALL_ITEM_TYPE_FILE) {
$str = $item['item'].' '.$item['checksum']."\n";
} else {
$str = $item['item']."\n";
}
$file->write($str);
}
$file_list_itself = '%HIDDEN%conf/modules/'.$this->get_module_name().'/files.list';
$file->write($file_list_itself."\n");
$file->close();
$this->set_item_permissions($filename);
}
/**
* Sets file/dirs permissions and group (if values available)
*
* @param string $item Path to file / dir
*/
protected function set_item_permissions($item) {
$file_perm = $this->get_file_permissions();
$dir_perm = $this->get_dir_permissions();
$file_group = $this->get_file_group();
if ($file_group || $file_perm || $dir_perm) {
if (is_dir($item) && $dir_perm) {
$rez = @chmod($item, octdec('0'.$dir_perm));
}
if (is_file($item) && $file_perm) {
$rez = @chmod($item, octdec('0'.$file_perm));
}
if ($file_group) {
$rez = @chgrp($item, $file_group);
}
}
}
/**
* Copies file.
*
* @param string $source_file Path to source file relative to module source dir
* @param string $target_file Path to target file relative to site target path
* @param boolean $special_file Flags file that will not be overwrited if just 'overwrite' flag is set. Such files are for example configuration files that you don't want to get overwrited when preinstalling module. If you want to overwrite special files use 'overwrite-all' flag.
* @throws TE_TMM_Exception,TE_TMM_Item_Already_Exist
*/
protected function copy_static_file($source_file, $target_file, $special_file = false) {
$ret = false;
if (file_exists($this->get_module_dir().'static/'.$source_file)) {
if (is_file($this->get_module_dir().'static/'.$source_file)) {
if (file_exists($this->get_target_dir().$target_file)) {
if (!$special_file) {
if ($this->get_overwrite()) {
$ret = $this->_copy_static_file($source_file, $target_file);
} else {
throw new TE_TMM_Item_Already_Exist("Target file ".$this->get_target_dir().$target_file." exists. Consider using overwrite option.");
}
} else {
if ($this->get_overwrite_all()) {
$ret = $this->_copy_static_file($source_file, $target_file);
} else {
$this->add_to_files_list_file($this->get_target_dir().$target_file);
}
}
} else {
$ret = $this->_copy_static_file($source_file, $target_file);
}
} else {
throw new TE_TMM_Exception("Source is not a file: ".$this->get_module_dir().'static/'.$source_file);
}
} else {
throw new TE_TMM_Exception("Can't find source file: ".$this->get_module_dir().'static/'.$source_file);
}
return $ret;
}
/**
* Actual copy of file
*
* @param string $source_file
* @param string $target_file
* @return boolean
* @internal
* @throws TE_TMM_Exception
*/
private function _copy_static_file($source_file, $target_file) {
$ret = copy($this->get_module_dir().'static/'.$source_file, $this->get_target_dir().$target_file);
if ($ret) {
$this->add_to_files_list_file($this->get_target_dir().$target_file);
} else {
throw new TE_TMM_Exception("Can't copy $source_file to ".$this->get_target_dir().$target_file);
}
return $ret;
}
/**
* Creates module's config dir, i.e. where module.ctrl file will be installed
*
* @param string $modules_conf_dir
*/
protected function create_module_dir($modules_conf_dir) {
$dir = tangra_normalize_path($modules_conf_dir).$this->get_module_name().'/';
$this->create_dir($dir);
}
/**
* Creates directory and adds it to files list.
*
* If directory already exists is just added to files list.
*
* @param string $dir Directory to be created. Relative to target_path
* @throws TE_TMM_Exception
*/
protected function create_dir($dir) {
$dir = $this->get_target_dir().$dir;
if (mkdir_ine($dir)) {
$this->add_to_files_list_dir($dir);
} else {
throw new TE_TMM_Exception('Can not create dir: '.$dir);
}
}
/**
* Creates directory and adds it to files list.
*
* If directory already exists is just added to files list.
*
* @param string $dir Directory to be created specified with full path
*/
protected function create_dir_full_path($dir) {
if (mkdir_ine($dir)) {
$this->add_to_files_list_dir($dir);
} else {
throw new TE_TMM_Exception('Can not create dir: '.$dir);
}
}
/**
* Compiles template file and writes the rezult in destination file. Adds full destination path to files list.
*
* @param Tangra_Simple_Tple $tple Template engine object with preassigned values that will be substituted
* @param string $file Temlate file
* @param string $destination_file Destination file
* @param boolean $special_file Flags file that will not be overwrited if just 'overwrite' flag is set. Such files are for example configuration files that you don't want to get overwrited when preinstalling module. If you want to overwrite special files use 'overwrite-all' flag.
* @throws TE_TMM_Item_Already_Exist
*/
protected function compile_tpl_file(Tangra_Simple_Tple $tple, $file, $destination_file, $special_file = false) {
$ret = false;
if (file_exists($this->get_target_dir().$destination_file)) {
if (!$special_file) {
if ($this->get_overwrite()) {
$ret = $this->_compile_tpl_file($tple, $file, $destination_file);
} else {
throw new TE_TMM_Item_Already_Exist("Target file ".$this->get_target_dir().$destination_file." exists. Consider using overwrite parameter.");
}
} else {
if ($this->get_overwrite_all()) {
$ret = $this->_compile_tpl_file($tple, $file, $destination_file);
} else {
$ret = $this->add_to_files_list_file($this->get_target_dir().$destination_file);
}
}
} else {
$ret = $this->_compile_tpl_file($tple, $file, $destination_file);
}
return $ret;
}
/**
* Actual compilation of template file
*
* @see compile_tpl_file()
*
* @param Tangra_Simple_Tple $tple
* @param string $file
* @param string $destination_file
* @internal
* @throws TE_TMM_Exception
*/
private function _compile_tpl_file(Tangra_Simple_Tple $tple, $file, $destination_file) {
$ret = false;
$content = $tple->fetch($file);
if (file_put_contents($this->get_target_dir().$destination_file, $content)) {
$this->add_to_files_list_file($this->get_target_dir().$destination_file);
$ret = true;
} else {
throw new TE_TMM_Exception('Failed to create compiled file: '.$this->get_target_dir().$destination_file);
}
return $ret;
}
/**
* Creates symlink and adds it to files list
*
* @param string $source_file Source file that symlink will point to
* @param string $link_name Link name
* @param string $alternative_source_for_copy If symlinks are not available (like in Windows), just copy this file instead of creating symlink
* @throws TE_TMM_Exception,TE_TMM_Item_Already_Exist
*/
protected function create_sym_link($source_file, $link_name, $alternative_source_for_copy = '') {
if (function_exists('symlink') && !is_windows()) {
if (file_exists($this->get_target_dir().$link_name)) {
if ($this->get_overwrite()) {
if (!is_dir($this->get_target_dir().$link_name)) {
unlink($this->get_target_dir().$link_name);
$ret = $this->_create_sym_link($source_file, $link_name);
} else {
throw new TE_TMM_Exception('Unable to create symlink because dir with same name exists: '.$this->get_target_dir().$link_name);
}
} else {
throw new TE_TMM_Item_Already_Exist("File/directory ".$this->get_target_dir().$link_name." already exists. Consider using option 'overwrite'.");
}
} else {
$ret = $this->_create_sym_link($source_file, $link_name);
}
} else {
if ($alternative_source_for_copy) {
$ret = $this->copy_static_file($alternative_source_for_copy, $link_name);
} else {
$ret = copy($this->get_target_dir().$source_file, $this->get_target_dir().$link_name);
$this->add_to_files_list_file($this->get_target_dir().$source_file);
}
}
if (!$ret) {
throw new TE_TMM_Exception('Failed to create file: '.$this->get_target_dir().$link_name);
}
}
/**
* Enter description here...
*
* @param string $source_file
* @param string $link_name
* @return boolean
* @throws TE_TMM_Exception
*/
private function _create_sym_link($source_file, $link_name) {
$ret = @symlink($this->get_target_dir().$source_file, $this->get_target_dir().$link_name);
$this->add_to_files_list_symlink($this->get_target_dir().$link_name);
if (!$ret) {
throw new TE_TMM_Exception('Failed to create symlink: '.$this->get_target_dir().$link_name);
}
return $ret;
}
/**
* Copies module.ctrl file to modules conf dir
*
* @internal
* @throws TE_TMM_Exception
*/
private function copy_module_ctrl() {
if (file_exists($this->get_module_dir().'module.ctrl.xml')) {
$ret = copy($this->get_module_dir().'module.ctrl.xml', $this->get_target_dir().'hidden/conf/modules/'.$this->get_module_name().'/module.ctrl.xml');
if (!$ret) {
throw new TE_TMM_Exception('Failed to copy file: '.$this->get_target_dir().'hidden/conf/modules/'.$this->get_module_name().'/module.ctrl');
}
$this->add_to_files_list_file($this->get_target_dir().'hidden/conf/modules/'.$this->get_module_name().'/module.ctrl.xml');
} else {
$ret = copy($this->get_module_dir().'module.ctrl', $this->get_target_dir().'hidden/conf/modules/'.$this->get_module_name().'/module.ctrl');
if (!$ret) {
throw new TE_TMM_Exception('Failed to copy file: '.$this->get_target_dir().'hidden/conf/modules/'.$this->get_module_name().'/module.ctrl');
}
$this->add_to_files_list_file($this->get_target_dir().'hidden/conf/modules/'.$this->get_module_name().'/module.ctrl');
}
}
/**
* Adds new section to conf file
*
* @param string $file Path to config file relative to site target dir
* @param string $section_content Content of the section
* @param boolean $strict If true will throw exception if section already exists.
* @throws TE_TMM_Exception
*/
protected function add_section_to_conf_file($file, $section_content, $strict = false) {
$full_path = $this->get_target_dir().$file;
if (file_exists($full_path)) {
$arr = file($full_path);
$boundaries = $this->find_start_and_end_of_conf_section($arr);
if (!$boundaries) {
$this->_add_section_to_conf_file($full_path, $section_content);
} else {
if ($this->get_overwrite_all()) {
$this->remove_section_from_conf_file($file);
$this->_add_section_to_conf_file($full_path, $section_content);
} else {
if ($strict) {
throw new TE_TMM_Exception('Configuration section for module "'.$this->get_module_name().'" already exist starting at: '.$boundaries['start']);
}
}
}
} else {
throw new TE_TMM_Exception('Configuration file does not exists: '.$this->get_target_dir().$file);
}
}
/**
* Actual adding of section to conf file
*
* @param string $full_path Full path to conf file
* @param string $section_content Content of the section
* @internal
*/
private function _add_section_to_conf_file($full_path, $section_content) {
$start_tag = TMM_CONFFILE_SECTION_START_PREFIX.$this->get_module_name().TMM_CONFFILE_SECTION_START_SUFFIX;
$end_tag = TMM_CONFFILE_SECTION_END_PREFIX.$this->get_module_name().TMM_CONFFILE_SECTION_END_SUFFIX;
file_put_contents($full_path, $start_tag, FILE_APPEND);
file_put_contents($full_path, $section_content, FILE_APPEND);
file_put_contents($full_path, $end_tag, FILE_APPEND);
}
/**
* Removes module section from conf file
*
* @param string $file Path to conh file relative to site target dir
* @param boolean $strict If true will throw exception if section does not exists.
* @throws TE_TMM_Exception
*/
protected function remove_section_from_conf_file($file, $strict = true) {
$full_path = $this->get_target_dir().$file;
if (file_exists($this->get_target_dir().$file)) {
$arr = file($this->get_target_dir().$file);
$boundaries = $this->find_start_and_end_of_conf_section($arr);
if ($boundaries) {
for ($i = $boundaries['start']; $i <= $boundaries['end']; $i++) {
unset($arr[$i]);
}
$file_content = implode('', $arr);
file_put_contents($full_path, $file_content);
} else {
throw new TE_TMM_Exception('Configuration section for module "'.$this->get_module_name().'" does not exist.');
}
} else {
throw new TE_TMM_Exception('Configuration file does not exists: '.$this->get_target_dir().$file);
}
}
/**
* Find start and end indexes of module's section
*
* @param array $arr
* @return array Structured array 'start' => start index, 'end' => end index
* @internal
*/
private function find_start_and_end_of_conf_section($arr) {
$ret = false;
$start_tag = TMM_CONFFILE_SECTION_START_PREFIX.$this->get_module_name().TMM_CONFFILE_SECTION_START_SUFFIX;
$end_tag = TMM_CONFFILE_SECTION_END_PREFIX.$this->get_module_name().TMM_CONFFILE_SECTION_END_SUFFIX;
$start_found = false;
$end_found = false;
for ($i = 0; $i < count($arr); $i++) {
if (strpos($arr[$i], trim($start_tag)) !== false) {
$start_found = $i;
break;
}
}
if ($start_found !== false) {
for ($i = $start_found; $i < count($arr); $i++) {
if (strpos($arr[$i], trim($end_tag)) !== false) {
$end_found = $i;
break;
}
}
}
if ($start_found !== false && $end_found !== false) {
$ret['start'] = $start_found;
$ret['end'] = $end_found;
}
return $ret;
}
//
// /**
// * Changes file permisssions and groups
// *
// * @see set_file_permissions(), set_file_group()
// * @internal
// *
// */
// private function change_file_properties() {
// $file_perm = $this->get_file_permissions();
// $dir_perm = $this->get_dir_permissions();
// $file_group = $this->get_file_group();
//
// if ($file_group || $file_perm || $dir_perm) {
// foreach($this->files as $item) {
// if (is_file($item['item']) || is_link($item['item'])) {
// if ($file_perm) {
// $rez = @chmod($item['item'], octdec('0'.$file_perm));
// }
// }
//
// if (is_dir($item['item'])) {
// if ($dir_perm) {
// $rez = @chmod($item['item'], octdec('0'.$dir_perm));
// }
// }
//
// if ($file_group) {
// $rez = @chgrp($item['item'], $file_group);
// }
// }
// }
// }
/**
* Deinstallation of the module
*
* Incomplete method. TCC has functionality to remove modules.
*
*/
public function uninstall($params) {
//TODO
}
/**
* Adds file to files list
*
* @param string $item Full path to the file
*/
protected function add_to_files_list_file($item) {
$this->set_item_permissions($item);
$item_abs = $this->abstract_path($item);
array_push($this->files, array('item' => $item_abs,
'type' => TMM_INSTALL_ITEM_TYPE_FILE,
'checksum' => md5_file($item)));
}
/**
* Adds dir to files list
*
* @param string $item Full path to the dir
*/
protected function add_to_files_list_dir($item) {
$this->set_item_permissions($item);
$item = $this->abstract_path($item);
array_push($this->files, array('item' => tangra_normalize_path($item),
'type' => TMM_INSTALL_ITEM_TYPE_DIR));
}
/**
* Adds symlink to files list
*
* @param string $item Full path to the symlink
*/
protected function add_to_files_list_symlink($item) {
$item = $this->abstract_path($item);
array_push($this->files, array('item' => $item,
'type' => TMM_INSTALL_ITEM_TYPE_SYMLINK));
}
/**
* Converts full path to abstract path, this way files.list is portable between depoyments
*
* This method accepts $item like /var/www/sites/test/hidden/inc/classes/some_class.class.php and converts it to %HIDDEN%inc/classes/some_class.class.php
*
* @param string $item Full path of a item
* @return string abstracted path
*/
private function abstract_path($item) {
$target_dir = $this->get_target_dir();
$item = str_replace($target_dir.'hidden/', '%HIDDEN%', $item);
$item = str_replace($target_dir.'htdocs/', '%HTDOCS%', $item);
$item = str_replace($target_dir.'ext_inc/', '%EXT_INC%', $item);
$item = str_replace($target_dir.'scratch/', '%SCRATCH%', $item);
return $item;
}
/**
* Compiles bulk of files contained in $source_dir into $destination_dir
*
* @param Tangra_Simple_Tple $tple Tangra_Simple_Tple instance. You have to set all exports before calling this method
* @param string $source_dir Relative to $tple->get_tpl_path(). Example: 'htdocs'
* @param string $destination_dir Relative to $this->get_target_dir(). Example: 'htdocs/admin'
* @param boolean $is_root If false tries to create $destionation_dir if not already exist. If true will copy just the content of $source_dir.
*/
protected function compile_bulk(Tangra_Simple_Tple $tple, $source_dir, $destination_dir, $is_root = true) {
$destination_dir = tangra_normalize_path($this->get_target_dir().$destination_dir);
$source_dir = $tple->get_tpl_path().$source_dir;
$this->_compile_bulk($tple, $source_dir, $destination_dir, $is_root);
}
/**
* Actual compilation of bulk files. See compile_bulk();
*
* This method is not ment to be called directly by the user. Use compile_bulk() instead.
*
* @param Tangra_Simple_Tple $tple Tangra_Simple_Tple instance. You have to set all exports before calling this method
* @param string $source_dir Relative to $tple->get_tpl_path(). Example: 'htdocs'
* @param string $destination_dir Relative to $this->get_target_dir(). Example: 'htdocs/admin'
* @param boolean $is_root If false tries to create $destionation_dir if not already exist. If true will copy just the content of $source_dir.
* @throws TE_TMM_Item_Already_Exist,TE_TMM_Exception
*/
private function _compile_bulk(Tangra_Simple_Tple $tple, $source_dir, $destination_dir, $is_root = true) {
if (!$is_root) {
if (mkdir_ine($destination_dir)) {
$this->add_to_files_list_dir($destination_dir);
} else {
throw new TE_TMM_Exception("Can't create dir $destination_dir/$item");
}
}
if ($dir = opendir($source_dir)) {
while (($item = readdir($dir)) !== false) {
if ($item != '.' && $item != '..') {
if (file_exists("$destination_dir$item") && !is_dir("$destination_dir$item")) {
if (!$this->get_overwrite()) {
throw new TE_TMM_Item_Already_Exist("File "."$destination_dir$item already exists. Consider using option 'overwrite'.");
}
}
if (is_file("$source_dir/$item")) {
if ($this->compile_tpl_file($tple, str_replace($tple->get_tpl_path(), '', "$source_dir/$item"), str_replace($this->get_target_dir(), '', "$destination_dir$item"), false)) {
$this->add_to_files_list_file("$destination_dir$item");
} else {
throw new TE_TMM_Exception("Can't compile $source_dir/$item to $destination_dir$item");
}
} else {
if ($item != '.svn') {
$tmp_arr = $this->_compile_bulk($tple, "$source_dir/$item", tangra_normalize_path($destination_dir).$item.'/', false);
} else {
continue;
}
}
}
}
closedir($dir);
}
}
/**
* This function is called to check if installer can upgrade from given version.
*
* @param string $from_version
* @return boolean
*/
public function can_upgrade($from_version) {
$ret = $this->get_upgrade_method($from_version) ? $from_version : false;
return $ret;
}
/**
* Activities that have to be performed before actual upgrade have to be placed here.
*
* If you overwrite this method don't forget to call parent::pre_upgrade()
*
* @param string $from_version
*/
public function pre_upgrade($from_version) {
$this->backup_files_list($from_version);
}
/**
* Makes a copy of current files.list in order to be used later when generating new one (after upgrade)
*
* @param string $from_version
*/
protected function backup_files_list($from_version) {
$module_conf_dir = $this->get_target_dir().'hidden/conf/modules/'.$this->get_module_name().'/';
$files_list_path = $module_conf_dir.'files.list';
$files_list_old = $module_conf_dir.'files.list.'.$from_version;
$rez = @copy($files_list_path, $files_list_old);
if (!$rez) {
throw new TE_TMM_Exception('Cannot copy '.$files_list_path.' to '.$files_list_old);
}
}
/**
* Performs upgrade of module
*
* @param string $from_version
*/
public function upgrade($from_version) {
$method_name = $this->get_upgrade_method($from_version);
if ($method_name) {
$this->$method_name($from_version);
}
}
/**
* Activities that have to be performed after actual upgrade have to be placed here.
*
* If you overwrite this method don't forget to call parent::post_upgrade()
*
* @param string $from_version
*/
public function post_upgrade($from_version) {
}
/**
* Adds new class method that will handle upgrade from particular version
*
* @param string $version
* @param string $method_name
*/
protected function set_upgrade_method($version, $method_name) {
if (is_callable(array($this, $method_name))) {
$this->upgrade_matrix[$version] = $method_name;
} else {
throw new TE_TMM_Exception("Method $method_name does not exist");
}
}
/**
* Returns name of the method that will perform upgrade from version $from_version
*
* Name of the metod is lookup in $this->upgrade_matrix
*
* @param string $from_version
*/
protected function get_upgrade_method($from_version) {
$ret = false;
if (array_key_exists($from_version, $this->upgrade_matrix)) {
$ret = $this->upgrade_matrix[$from_version];
}
return $ret;
}
public function init_can_upgrade() {
$can_upgrade_loader = new Can_Upgrade_Loader($this->get_module_dir().'can_upgrade');
$arr = $can_upgrade_loader->get_can_upgrade();
foreach($arr as $version => $method) {
$this->set_upgrade_method($version, $method);
}
}
public function set_error_reporting_php4_lib() {
global $ERROR_REPORTING_PHP4_LIBS;
error_reporting($ERROR_REPORTING_PHP4_LIBS);
}
public function set_error_reporting_normal() {
global $ERROR_REPORTING;
error_reporting($ERROR_REPORTING);
}
}

Source for file tangra_module_installer.class.php