commands.php | searchcode

/app/vendors/fbollon/commands.php

http://fredistrano.googlecode.com/
PHP | 545 lines | 396 code | 79 blank | 70 comment | 100 complexity | b2837d3bc66d39a664416095f549abc7 MD5 | raw file
Possible License(s): LGPL-2.1

<?php 
/* SVN FILE: $Id: commands.php 374 2009-10-12 21:49:11Z fbollon $ */
/**
 * Wrap all used shell commands in a static PHP function
 * 
 * PHP 5
 *
 * Licensed under The MIT License
 * Redistributions of files must retain the above copyright notice.
 *
 * @filesource
 * @link			http://code.google.com/p/fredistrano
 * @package			app
 * @subpackage		app.vendors.fbollon
 * @version			$Revision: 374 $
 * @modifiedby		$Author: fbollon $
 * @lastmodified	$Date: 2009-10-12 23:49:11 +0200 (Mon, 12 Oct 2009) $
 * @license			http://www.opensource.org/licenses/mit-license.php The MIT License
 */
/**
 * Wrap all used shell commands in a static PHP function
 *
 * @package		app
 * @subpackage	app.vendors.fbollon
 */
class Utils {
	
	public static function computeDirMode( $fileMode, $options = array() ) {
		$fileMode = str_split($fileMode);
		$dirMode = '';
	
		for ($i=0; $i < 3; $i++) { 
			if ($fileMode[$i] > 7) {
				$fileMode[$i] = 7;
			} elseif (!in_array($fileMode[$i], array(0,7))) {
				$fileMode[$i]++;
			} 
			$dirMode .= $fileMode[$i];
		}
		return $dirMode; 
	}// computeDirMode
	
	public static function getSvnRevisionFromOutput($output, $options = array() ) {
		preg_match('/ ([0-9]+)\.$/', $output, $matches);
		if (isset($matches[1])) {
			return $matches[1];
		} else {
			return false;
		}
	}// getRevisionFromOutput
	
	/**
	 * Convert if necessary a path to a cygwin/linux format 
	 * @param string $path 		Path to be converted
	 * @return string 			Converted path
	 */ 
	public static function formatPath($path) {
		$pathForRsync = $path;
		if ( F_OS == 'WIN') {
			$pattern = '/^([A-Za-z]):/';
			preg_match($pattern, $path, $matches, PREG_OFFSET_CAPTURE);
			if (!empty ($matches[1][0])) {
				$windowsLetter = strtolower($matches[1][0]);
				$pathForRsync = strtr( Configure::read('Cygwin.rootDir') . $windowsLetter . substr($path, 2), "\\", "/");
			}	
		}
		return $pathForRsync;
	}// formatPath
	
}// FileSystemCommand

class Action {
	
	public function initAction($name=null, $comment=null, $type=null, $options = array() ) {
		if ( isset($options['stepLog']) && get_class($options['stepLog']) == 'StepLog' ) {
			$actionLog =  $options['stepLog']->addNewAction($name, $comment , $type);
		} else if ( isset($options['actionLog']) && get_class($options['actionLog']) == 'ActionLog' ) {
			$actionLog =  $options['actionLog'];
		} else {
			$actionLog =  new ActionLog($name, $comment , $type);
		}
		return $actionLog;
	}// initAction
	
}// Action

class PhpAction extends Action {
	
	// Create files list and directories list for chmod step
	public function createFilesListToChmod($output=null, $projectTmpDir=null, $target=null, $options = array()) {
		$actionLog = self::initAction('createFilesListToChmod', 'files_to_chmod.txt and dir_to_chmod.txt', 'PhpAction', $options);
		
		if (empty($output) || empty($projectTmpDir) || empty($target)) {
			$actionLog->error( sprintf(__('Missing working data', true)) );
		}
		
		$list = array_reverse(explode("\n", $output));
		$size = count($list);
		if ($size > 0) {
			$files_to_chmod = $projectTmpDir."files_to_chmod.txt";
			$dir_to_chmod = $projectTmpDir."dir_to_chmod.txt";
			$handle_f = fopen($files_to_chmod, "w");
			$handle_d = fopen($dir_to_chmod, "w");

			for ($i = 4; $i < $size ; $i++) {
				if (empty($list[$i]) || strpos($list[$i],'deleting ') !== false) {
					break;
				}
		
				if (is_file($target . $list[$i])) {
					$tmp_str = $list[$i];
					fwrite($handle_f, $target.str_replace(".".Configure::read('FileSystem.renameExt').".", ".", $list[$i]) . "\n");
				} else if (is_dir($target . $list[$i])){
					fwrite($handle_d, $target.$list[$i] . "\n");
				}
			}
			fclose($handle_f);
			fclose($handle_d);
		}
		// End action
		$actionLog->end();
		
		return $actionLog;
	}// createFilesListToChmod
	
	public static function loadConfig(& $config, $projectName = null, $options = array()) {
		$actionLog = self::initAction('loadConfig', null, 'PhpAction', $options);
		
		if (empty($projectName)) {
			$actionLog->error(__('Invalid project',true));
		}
		
		// Check new path
		$path = F_DEPLOYTMPDIR.$projectName.DS.'tmpDir'.DS.'.fredistrano'.DS.'deploy.php';
		if ( !file_exists( $path ) ) {
			$path = F_DEPLOYTMPDIR.$projectName.DS.'tmpDir'.DS.'deploy.php';
			if (!file_exists( $path )) {
				$actionLog->error( sprintf(__('Unable to find deploy.php', true)) );
			}
		} 
		include_once($path);
		$config = new DEPLOY_CONFIG();
		
		// End action
		$actionLog->end();
		
		return $actionLog;
	}// loadConfig
	
}// PhpAction

class ShellAction extends Action {

	public static function changePermissions( $path=null, $mode=array(), $options = array() ) {
		$actionLog = self::initAction('resetPermission', null, 'ShellAction', $options);	
		if (!is_array($mode)) {
			$mode = array(
				'file' 	=> $mode,
				'dir' 	=> Utils::computeDirMode($mode)
			);
		}
		
		// Check
		if ( is_null($path) || empty($mode) ) {
			$actionLog->error(sprintf(__('Forbidden NULL value for input parameter [%s;%s]',true),$path,$mode));	
		}
		if (!file_exists($path)) {
			$actionLog->error(sprintf(__('Path [%s] not found',true),$path));	
		}
		$path = Utils::formatPath($path);

		if (isset($mode['file'])) {
			// Change file mode
			$desc = sprintf(__('Reseting permissions files on %s',true),$path);
			$actionLog->description = $desc;
			$command = "find ".$path." -type f -exec chmod ".$mode['file']." {} \;";
			ShellAction::executeCommand( $command,
				array(
			        'directory'	=> $path,
					'actionLog' => $actionLog
				)
			);
		}

		if (isset($mode['dir'])) {
			// Change directory mode
			$desc = sprintf(__('Resetting directories permissions on %s',true),$path);
			$actionLog->description = $desc;
			$command = "find ".$path." -type d -exec chmod ".$mode['dir']." {} \;";
			ShellAction::executeCommand( $command,
				array(
					'directory'	=> $path,
					'actionLog' => $actionLog
				)
			);
		}
		
		// Terminate action
		$actionLog->end();
		
		return $actionLog;
	}// changePermissions
	
	public static function createDirectory( $path=null, $mode=null, $options = array() ) {
		$comment = sprintf(__('Creating %s with mode %s',true),$path,$mode);
		$actionLog = self::initAction('createDirectory', $comment, 'ShellAction', $options);
		
		// Check
		if ( is_null($path) || is_null($mode) ) {
			$actionLog->error(sprintf(__('Forbidden NULL value for input parameter [%s;%s]',true),$path,$mode));	
		} else if (is_dir($path)) {
			$actionLog->error(sprintf(__('Directory %s already exists',true),$path));
		}
		
		// Execute
		// $path = Utils::formatPath($path);
		if (!@mkdir($path, octdec( $mode ), TRUE)) {
			$actionLog->error( sprintf(__('Unable to create directory %s', true), $path) );
		}
		
		// Terminate action
		$actionLog->end();
		
		return $actionLog;
	}// createDirectory

	public static function executeCommand( $command = null, $options = array() ){
		$defaultOptions = array(
			'comment' 		=> null,
			'directory'		=> null,
			'commandForLog'	=> null
		);
		$options = array_merge($defaultOptions, $options);

		// Log management
		$actionLog = self::initAction('executeCommand', $options['comment'], 'ShellAction', $options);
		if ( !isset($options['actionLog']) || get_class($options['actionLog']) != 'ActionLog' ) {
			// Terminate log if passed in params
			$terminate = false;
		} else {
			$terminate = true;
		}
		
		// Check
		if ( is_null($command) ) {
			$actionLog->error(sprintf(__('Forbidden NULL value for input parameter [%s]',true),$command));	
		} 

		// Prepare command
		if ( F_OS == 'WIN' ) {
			if (!is_null($options['directory'])) {
				$cd = 'cd '.Utils::formatPath( $options['directory'] ).'; ';
			} else {
				$cd = '';
			}
			$prefix = "bash.exe --login -c \"".$cd;
			$suffix = "\"";
		} else {
			if (!is_null($options['directory'])) {
				chdir($options['directory']);
			}
			$prefix = "";
			$suffix = "";
		}
		
		// Execute command 
		$output = utf8_encode(shell_exec($prefix.$command.$suffix));
		
		if (!is_null($options['commandForLog'])) {
			$commandForLog = $options['commandForLog'];
		}else{
			$commandForLog = $prefix.$command.$suffix;
		}
		$actionLog->saveCommand($commandForLog, $output);
		 
		// End action
		if ($terminate) {
			$actionLog->end($output);
		}
		
		return $actionLog;
	}// executeCommand
	
	public static function remove( $path, $recursive = false , $options = array() ) {
		$comment = sprintf(__('Deleting content under %s (recursivity=%d)',true), $path, $recursive);
		$actionLog = self::initAction('remove', $comment, 'ShellAction', $options);
		
		// Check
		if (!is_dir($path)) {
			$actionLog->error( sprintf(__('Nothing to delete since no temporary files have been found', true)) );
		} 

		// Execute command 
		$path = Utils::formatPath($path);
		$recStr = $recursive?'r':'';
		$command = "rm -f".$recStr." ".$path;
		ShellAction::executeCommand( $command, array('actionLog' => $actionLog) );

		// End action
		$actionLog->end();
		
		return $actionLog;
	}// remove
	
	public static function runScript( $type, $projectTmpDir, $scriptPath, $options ) {
		$comment = sprintf(__('Executing script %s',true), $scriptPath);
		$actionLog = self::initAction('runScript', $comment, 'ShellAction', $options);
		
		if (!isset($scriptPath) || !$scriptPath) {
			$actionLog->error( sprintf(__('Script not found', true)) );
		}
		
		// Run script
		if ($options['run'.ucfirst($type).'Script']) {
			if (!file_exists($scriptPath) && file_exists($projectTmpDir.'tmpDir'.DS.'.fredistrano'.DS.$scriptPath)) {
				$scriptPath = $projectTmpDir.'tmpDir'.DS.'.fredistrano'.DS.$scriptPath;
			} else if (!file_exists($scriptPath)){
				$actionLog->error( __('Script not found', true) );
			}
			
			$formatedScriptPath = Utils::formatPath($scriptPath);
			if (!is_executable($scriptPath)) {
				$log = ShellAction::executeCommand( "chmod u+x $formatedScriptPath", 
					array(
						'comment'	=> __('Execution privileges to script',true),
						'actionLog' => $actionLog
					)
				);	
			}
			
			ShellAction::executeCommand( $formatedScriptPath,
				array(
					'comment'	=> sprintf(__('%s script',true), $type),
					'actionLog' => $actionLog
				)
			);
		}
		// End action
		$actionLog->end();
		
		return $actionLog;
	}// runScript
	
	public static function synchronizeContent( $source = null, $target = null, $options = array ()) {
		$comment = sprintf(__('Synchronizing %s with %s',true),$source,$target);
		$actionLog = self::initAction('synchronizeContent', $comment, 'ShellAction', $options);

		// Setting up Rsync options
		if ($options['simulation'] === true) {
			// Simulation mode
			$option = 'rtvn';
		} else {
			// Live mode
			$option = 'rtv';
		}
		
		$optionalOptions = Configure::read('Rsync.optionalOptions');
		if (!empty($optionalOptions)) {
			$option .= $optionalOptions;
		}
		
		// Execute command		
		$excludeFileName = Utils::formatPath( $options['exclude'] );
		$source = Utils::formatPath( $source );
		$target = Utils::formatPath( $target );
	
		$command = "rsync -$option --delete --exclude-from=$excludeFileName $source $target 2>&1";	
		ShellAction::executeCommand( $command, array('actionLog' => $actionLog));
		
		// End action
		$actionLog->end();
		
		return $actionLog;
	}// synchronizeContent
	
}//

class SvnAction extends Action {
	
	public static function checkout( $svnUrl = null, $path = null, $targetDir = null, $options = array() ) {
		$actionLog = self::initAction('checkout',$svnUrl,'SvnAction',$options);
		$configDirectory = '';
		// Check
		if ( is_null($svnUrl) || is_null($path) || is_null($targetDir)) {
			$actionLog->error(sprintf(__('Forbidden NULL value for input parameter [%s;%s;%s]',true),$svnUrl,$path,$targetDir));	
		} else if (!is_dir($path)) {
			$actionLog->error(sprintf(__('Directory %s not found',true),$path));
		} else if (is_dir($path.DS.$targetDir))  {
			$actionLog->error(sprintf(__('Delete target %s directory first',true), $path.DS.$targetDir));			
		}
			
		// Define step options
		$default_options = array(
			'revision' 			=> null,
			'user_svn' 			=> null,
			'password_svn' 		=> null,
			'configDirectory'	=> null,
			'parseResponse' 	=> false
		);
		$options = array_merge($default_options, $options);
		
		// Execute command 
		$path = Utils::formatPath($path);
		$revision = !is_null($options['revision'])?' -r' . $options['revision']:'';
		$authentication = '';
		if (!is_null($options['user_svn'])) {
			$authentication .= '--username '.$options['user_svn'];
			if (!empty($options['password_svn'])) {
				$authentication .= ' --password '.$options['password_svn'];
			}
		}
		if (!is_null($options['configDirectory'])) {
			$configDirectory = '--config-dir '.Utils::formatPath( $options['configDirectory'] );
		}
		$command = "svn checkout --non-interactive $configDirectory $revision $authentication $svnUrl $targetDir 2>&1";	
		$commandForLog = "svn checkout --non-interactive $configDirectory $revision XXXX $svnUrl $targetDir 2>&1";		
		ShellAction::executeCommand( $command,
			array(
		        'directory'		=> $path,
				'actionLog' 	=> $actionLog,
				'commandForLog'	=> $commandForLog
			)
		);
		// Parse output
		if ( !(strpos( $actionLog->getResult() , 'PROPFIND request failed on' ) === false) && $options['parseResponse'] ) {
			$actionLog->error(__('An error has been detected in the SVN output',true));			
		}
		
		// End action
		$actionLog->end();
		
		return $actionLog;
	}// checkout
	
	public static function export( $svnUrl = null, $path = null, $targetDir = null, $options = array() ) {
		$actionLog = self::initAction('export',$svnUrl,'SvnAction',$options);
		$configDirectory = '';
		
		if ( is_null($svnUrl) || is_null($path) || is_null($targetDir)) {
			$actionLog->error(sprintf(__('Forbidden NULL value for input parameter [%s;%s;%s]',true),$svnUrl,$path,$targetDir));	
		} else if (!is_dir($path)) {
			$actionLog->error(sprintf(__('Directory %s not found',true),$path));
		} else if (is_dir($path.DS.$targetDir))  {
			$actionLog->error(sprintf(__('Delete target %s directory first',true), $path.DS.$targetDir));			
		}
		
		// Define step options
		$default_options = array(
			'revision' 			=> null,
			'user_svn' 			=> null,
			'password_svn' 		=> null,
			'configDirectory'	=> null,
			'parseResponse' 	=> false
		);
		$options = array_merge($default_options, $options);
		
		// Execute command 
		$path = Utils::formatPath($path);
		$revision = !is_null($options['revision'])?' -r' . $options['revision']:'';
		$authentication = '';
		if (!is_null($options['user_svn'])) {
			$authentication .= '--username '.$options['user_svn'];
			if (!empty($options['password_svn'])) {
				$authentication .= ' --password '.$options['password_svn'];
			}
		}
		if (!is_null($options['configDirectory'])) {
			$configDirectory = '--config-dir '.Utils::formatPath( $options['configDirectory'] );
		}
		$command = "svn export --non-interactive $configDirectory $revision $authentication $svnUrl $targetDir 2>&1";
		$commandForLog = "svn export --non-interactive $configDirectory $revision XXXX $svnUrl $targetDir 2>&1";		
		ShellAction::executeCommand( $command,
			array(
		        'directory'	=> $path,
				'actionLog' => $actionLog,
				'commandForLog'	=> $commandForLog
			)
		);
		// Parse output
		if ( !(strpos( $actionLog->getResult() , 'PROPFIND request failed on' ) === false) && $options['parseResponse'] ) {
			$actionLog->error(__('An error has been detected in the SVN output',true));
		}
		
		// End action
		$actionLog->end();
		
		return $actionLog;
	}// export
	
	public static function update( $projectDir, $options = array() ) {
		$actionLog = self::initAction('update',$projectDir,'SvnAction',$options);
		$configDirectory = '';
		if ( is_null($projectDir) ) {
			$actionLog->error(sprintf(__('Forbidden NULL value for input parameter [%s]',true),$projectDir));	
		} else if (!is_dir($projectDir) ) {
			$actionLog->error(sprintf(__('Directory %s not found',true), $projectDir));
		} else if ( !is_dir($projectDir.DS.'.svn') ) {
			$actionLog->error(sprintf(__('Specified directory %s is not a working copy',true), $projectDir.DS.'.svn'));
		} else if ( !is_writeable($projectDir) ) {
			$actionLog->error(sprintf(__('Specified directory %s is not writeable',true), $projectDir));
		}
 			
		// Define step options
		$default_options = array(
			'revision' 			=> null,
			'configDirectory'	=> null,
			'parseResponse' 	=> false
		);
		$options = array_merge($default_options, $options);
		
		// Execute command 
		$projectDir = Utils::formatPath($projectDir);
		$revision = ($options['revision']!=null)?' -r' . $options['revision']:'';
		$authentication = '';
		if (!is_null($options['user_svn'])) {
			$authentication .= '--username '.$options['user_svn'];
			if (!empty($options['password_svn'])) {
				$authentication .= ' --password '.$options['password_svn'];
			}
		}
		if (!is_null($options['configDirectory'])) {
			$configDirectory = '--config-dir '.Utils::formatPath( $options['configDirectory'] );
		}
		$command = "svn update --non-interactive $configDirectory $revision $authentication 2>&1";
		$commandForLog = "svn update --non-interactive $configDirectory $revision XXXX 2>&1";		
		ShellAction::executeCommand( $command, array(
				'directory'	=> $projectDir,
				'actionLog' => $actionLog,
				'commandForLog'	=> $commandForLog
			) 
		);
		
		// Parse response
		if ( !(strpos( $actionLog->getResult() , 'PROPFIND request failed on' ) === false) && $options['parseResponse'] ) {
			$actionLog->error(__('An error has been detected in the SVN output',true));
		}
		
		// End action
		$actionLog->end();
		return $actionLog;
	}// update
	
}// SvnAction

?>