cakephp2-php8/cake/console/libs/cake_script.php
2007-05-07 15:30:06 +00:00

345 lines
No EOL
8 KiB
PHP

<?php
/* SVN FILE: $Id$ */
/**
* Short description for file.
*
* Long description for file
*
* PHP versions 4 and 5
*
* CakePHP(tm) : Rapid Development Framework <http://www.cakephp.org/>
* Copyright 2005-2007, Cake Software Foundation, Inc.
* 1785 E. Sahara Avenue, Suite 490-204
* Las Vegas, Nevada 89104
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @filesource
* @copyright Copyright 2005-2007, Cake Software Foundation, Inc.
* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP(tm) Project
* @package cake
* @subpackage cake.cake.scripts
* @since CakePHP(tm) v 1.2.0.4604
* @version $Revision$
* @modifiedby $LastChangedBy$
* @lastmodified $Date$
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
*/
/**
* Base class for command-line utilities for automating programmer chores.
*
* @package cake
* @subpackage cake.cake.scripts
*/
class CakeScript extends Object {
/**
* ConsoleDispatcher object
*
* @var object An instance of the ConsoleDispatcher object that loaded this script
*/
var $Dispatch = null;
/**
* If true, the script will ask for permission to perform actions.
*
* @var boolean
*/
var $interactive = true;
/**
* Holds the DATABASE_CONFIG object for the app. Null if database.php could not be found,
* or the app does not exist.
*
* @var object
*/
var $dbConfig = null;
/**
* Contains command switches parsed from the command line.
*
* @var array
*/
var $params = array();
/**
* Contains arguments parsed from the command line.
*
* @var array
*/
var $args = array();
/**
* Constructs this CakeScript instance.
*
*/
function __construct(&$dispatch) {
$this->Dispatch = & $dispatch;
$this->params = & $this->Dispatch->params;
$this->args = & $this->Dispatch->args;
$this->name = & $this->Dispatch->scriptName;
$this->command = & $this->Dispatch->scriptCommand;
}
/**
* Initializes the CakeScript
* can be overriden in subclasses
*
* @return null
*/
function initialize() {
if($this->_loadDbConfig()) {
$this->_loadModel();
}
}
/**
* Loads database file and constructs DATABASE_CONFIG class
* makes $this->dbConfig available to subclasses
*
* @return bool
*/
function _loadDbConfig() {
if(config('database')) {
if (class_exists('DATABASE_CONFIG')) {
$this->dbConfig = new DATABASE_CONFIG();
return true;
}
}
$this->err('Database config could not be loaded');
return false;
}
/**
* Loads AppModel file and constructs AppModel class
* makes $this->AppModel available to subclasses
*
* @return bool
*/
function _loadModel() {
uses ('model'.DS.'connection_manager',
'model'.DS.'datasources'.DS.'dbo_source', 'model'.DS.'model'
);
if(loadModel()) {
$this->AppModel = & new AppModel();
return true;
}
$this->err('AppModel could not be loaded');
return false;
}
/**
* Prompts the user for input, and returns it.
*
* @param string $prompt Prompt text.
* @param mixed $options Array or string of options.
* @param string $default Default input value.
* @return Either the default value, or the user-provided input.
*/
function in($prompt, $options = null, $default = null) {
return $this->Dispatch->getInput($prompt, $options, $default);
}
/**
* Outputs to the stdout filehandle.
*
* @param string $string String to output.
* @param boolean $newline If true, the outputs gets an added newline.
*/
function out($string, $newline = true) {
return $this->Dispatch->stdout($string, $newline);
}
/**
* Outputs to the stderr filehandle.
*
* @param string $string Error text to output.
*/
function err($string) {
return $this->Dispatch->stderr($string."\n");
}
/**
* Outputs a series of minus characters to the standard output, acts as a visual separator.
*
*/
function hr($newline = false) {
if ($newline) {
$this->out("\n");
}
$this->out('---------------------------------------------------------------');
if ($newline) {
$this->out("\n");
}
}
/**
* Displays a formatted error message
*
* @param unknown_type $title
* @param unknown_type $msg
*/
function displayError($title, $msg) {
$out = "\n";
$out .= "Error: $title\n";
$out .= "$msg\n";
$out .= "\n";
$this->out($out);
exit();
}
/**
* Will check the number args matches otherwise throw an error
*
* @param unknown_type $expectedNum
* @param unknown_type $command
*/
function _checkArgs($expectedNum, $command = null) {
if(!$command) {
$command = $this->command;
}
if (count($this->args) < $expectedNum) {
$this->displayError('Wrong number of parameters: '.count($this->args), 'Please type \'cake '.$this->Dispatch->script.' help\' for help on usage of the '.$command.' command.');
}
}
/**
* Creates a file at given path.
*
* @param string $path Where to put the file.
* @param string $contents Content to put in the file.
* @return Success
*/
function createFile ($path, $contents) {
$path = str_replace(DS . DS, DS, $path);
echo "\nCreating file $path\n";
if (is_file($path) && $this->interactive === true) {
$this->out(__("File exists, overwrite?", true). " {$path} (y/n/q):");
$key = trim(fgets($this->stdin));
if ($key == 'q') {
$this->out(__("Quitting.", true) ."\n");
exit;
} elseif ($key == 'a') {
$this->dont_ask = true;
} elseif ($key == 'y') {
} else {
$this->out(__("Skip", true) ." {$path}\n");
return false;
}
}
uses('file');
if ($File = new File($path, true)) {
$File->write($contents);
$this->out(__("Wrote", true) ."{$path}\n");
return true;
} else {
$this->err(__("Error! Could not write to", true)." {$path}.\n");
return false;
}
}
/**
* Outputs usage text on the standard output. Implement it in subclasses.
*
*/
function help() {
// empty
}
/**
* Returns true if given path is a directory.
*
* @param string $path
* @return True if given path is a directory.
*/
function isDir($path) {
if(is_dir($path)) {
return true;
} else {
return false;
}
}
/**
* Recursive directory copy.
*
* @param string $fromDir
* @param string $toDir
* @param octal $chmod
* @param boolean $verbose
* @return Success.
*/
function copyDir($fromDir, $toDir, $chmod = 0755, $verbose = false) {
$errors = array();
$messages = array();
if (!is_dir($toDir)) {
uses('folder');
$folder = new Folder();
$folder->mkdirr($toDir, 0755);
}
if (!is_writable($toDir)) {
$errors[] = 'target '.$toDir.' is not writable';
}
if (!is_dir($fromDir)) {
$errors[] = 'source '.$fromDir.' is not a directory';
}
if (!empty($errors)) {
if ($verbose) {
foreach($errors as $err) {
$this->stdout('Error: '.$err);
}
}
return false;
}
$exceptions = array('.','..','.svn');
$handle = opendir($fromDir);
while (false !== ($item = readdir($handle))) {
if (!in_array($item,$exceptions)) {
$from = str_replace('//','/',$fromDir.'/'.$item);
$to = str_replace('//','/',$toDir.'/'.$item);
if (is_file($from)) {
if (@copy($from, $to)) {
chmod($to, $chmod);
touch($to, filemtime($from));
$messages[] = 'File copied from '.$from.' to '.$to;
} else {
$errors[] = 'cannot copy file from '.$from.' to '.$to;
}
}
if (is_dir($from)) {
if (@mkdir($to)) {
chmod($to, $chmod);
$messages[] = 'Directory created: '.$to;
} else {
$errors[] = 'cannot create directory '.$to;
}
$this->copyDir($from,$to,$chmod,$verbose);
}
}
}
closedir($handle);
if ($verbose) {
foreach($errors as $err) {
$this->stdout('Error: '.$err);
}
foreach($messages as $msg) {
$this->stdout($msg);
}
}
return true;
}
function __addAdminRoute($name){
$file = file_get_contents(CONFIGS.'core.php');
if (preg_match('%([/\\t\\x20]*define\\(\'CAKE_ADMIN\',[\\t\\x20\'a-z]*\\);)%', $file, $match)) {
$result = str_replace($match[0], 'define(\'CAKE_ADMIN\', \''.$name.'\');', $file);
if(file_put_contents(CONFIGS.'core.php', $result)){
return true;
} else {
return false;
}
} else {
return false;
}
}
}
?>