mirror of
https://github.com/kamilwylegala/cakephp2-php8.git
synced 2024-11-15 03:18:26 +00:00
4c9a9ebb31
git-svn-id: https://svn.cakephp.org/repo/branches/1.2.x.x@5099 3807eeeb-6ff5-0310-8944-8be069107fe0
500 lines
No EOL
12 KiB
PHP
500 lines
No EOL
12 KiB
PHP
<?php
|
|
/* SVN FILE: $Id$ */
|
|
/**
|
|
* Base class for Shells
|
|
*
|
|
* 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.console.libs
|
|
* @since CakePHP(tm) v 1.2.0.5012
|
|
* @version $Revision$
|
|
* @modifiedby $LastChangedBy$
|
|
* @lastmodified $Date$
|
|
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
|
|
*/
|
|
require_once CAKE . 'console' . DS . 'error.php';
|
|
/**
|
|
* Base class for command-line utilities for automating programmer chores.
|
|
*
|
|
* @package cake
|
|
* @subpackage cake.cake.console.libs
|
|
*/
|
|
class Shell extends Object {
|
|
|
|
/**
|
|
* ShellDispatcher object
|
|
*
|
|
* @var object An instance of the ShellDispatcher 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();
|
|
/**
|
|
* The file name of the shell that was invoked.
|
|
*
|
|
* @var string
|
|
*/
|
|
var $shell = null;
|
|
/**
|
|
* The class name of the shell that was invoked.
|
|
*
|
|
* @var string
|
|
*/
|
|
var $className = null;
|
|
/**
|
|
* The command called if public methods are available.
|
|
*
|
|
* @var string
|
|
*/
|
|
var $command = null;
|
|
/**
|
|
* The name of the shell in camelized.
|
|
*
|
|
* @var string
|
|
*/
|
|
var $name = null;
|
|
/**
|
|
* Contains tasks to load and instantiate
|
|
*
|
|
* @var array
|
|
*/
|
|
var $tasks = array();
|
|
/**
|
|
* Contains the loaded tasks
|
|
*
|
|
* @var array
|
|
*/
|
|
var $taskNames = array();
|
|
/**
|
|
* Contains models to load and instantiate
|
|
*
|
|
* @var array
|
|
*/
|
|
var $uses = array();
|
|
/**
|
|
* Constructs this Shell instance.
|
|
*
|
|
*/
|
|
function __construct(&$dispatch) {
|
|
$this->Dispatch = & $dispatch;
|
|
$vars = array('params', 'args', 'shell', 'shellName'=> 'name', 'shellClass'=> 'className', 'shellCommand'=> 'command');
|
|
foreach($vars as $key => $var) {
|
|
if(is_string($key)){
|
|
$this->{$var} = & $this->Dispatch->{$key};
|
|
} else {
|
|
$this->{$var} = & $this->Dispatch->{$var};
|
|
}
|
|
}
|
|
$name = get_class($this);
|
|
if(strpos($name, 'Task') === false && strpos($name, 'task') == false) {
|
|
$this->_loadTasks();
|
|
}
|
|
}
|
|
/**
|
|
* Initializes the Shell
|
|
* can be overriden in subclasses
|
|
*
|
|
* @return void
|
|
*/
|
|
function initialize() {
|
|
$this->_loadModels();
|
|
$this->_welcome();
|
|
}
|
|
/**
|
|
* Displays a header for the shell
|
|
*
|
|
* @return void
|
|
*/
|
|
function _welcome() {
|
|
$this->out('App : '. APP_DIR);
|
|
$this->out('Path: '. ROOT . DS . APP_DIR);
|
|
$this->hr();
|
|
}
|
|
/**
|
|
* 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');
|
|
$this->out('Run \'bake\' to create the database configuration');
|
|
return false;
|
|
}
|
|
/**
|
|
* if var $uses = true
|
|
* Loads AppModel file and constructs AppModel class
|
|
* makes $this->AppModel available to subclasses
|
|
* if var $uses is an array of models
|
|
*
|
|
* @return bool
|
|
*/
|
|
function _loadModels() {
|
|
|
|
if($this->uses === null || $this->uses === false) {
|
|
return;
|
|
}
|
|
|
|
uses ('model'.DS.'connection_manager',
|
|
'model'.DS.'datasources'.DS.'dbo_source', 'model'.DS.'model'
|
|
);
|
|
|
|
if($this->uses === true && loadModel()) {
|
|
$this->AppModel = & new AppModel(false, false, false);
|
|
return true;
|
|
}
|
|
|
|
if ($this->uses !== true && !empty($this->uses)) {
|
|
$uses = is_array($this->uses) ? $this->uses : array($this->uses);
|
|
$this->modelClass = $uses[0];
|
|
|
|
foreach($uses as $modelClass) {
|
|
$modelKey = Inflector::underscore($modelClass);
|
|
|
|
if(!class_exists($modelClass)){
|
|
loadModel($modelClass);
|
|
}
|
|
if(class_exists($modelClass)) {
|
|
$model =& new $modelClass();
|
|
$this->modelNames[] = $modelClass;
|
|
$this->{$modelClass} =& $model;
|
|
ClassRegistry::addObject($modelKey, $model);
|
|
} else {
|
|
return $this->cakeError('missingModel', array(array('className' => $modelClass)));
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
/**
|
|
* Loads tasks defined in var $tasks
|
|
*
|
|
* @return bool
|
|
*/
|
|
function _loadTasks() {
|
|
if($this->tasks === null || $this->tasks === false) {
|
|
return;
|
|
}
|
|
|
|
if ($this->tasks !== true && !empty($this->tasks)) {
|
|
|
|
$tasks = $this->tasks;
|
|
if(!is_array($tasks)) {
|
|
$tasks = array($tasks);
|
|
}
|
|
|
|
$this->taskClass = $tasks[0];
|
|
|
|
foreach($tasks as $taskName) {
|
|
$taskKey = Inflector::underscore($taskName);
|
|
$loaded = false;
|
|
foreach($this->Dispatch->shellPaths as $path) {
|
|
$taskPath = $path . 'tasks' . DS . Inflector::underscore($taskName).'.php';
|
|
if (file_exists($taskPath)) {
|
|
$loaded = true;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if ($loaded) {
|
|
$taskClass = Inflector::camelize($taskName.'Task');
|
|
if(!class_exists($taskClass)) {
|
|
require_once $taskPath;
|
|
}
|
|
|
|
if(class_exists($taskClass) && !isset($this->{$taskName})) {
|
|
$task =& new $taskClass($this->Dispatch);
|
|
$this->taskNames[] = $taskName;
|
|
$this->{$taskName} =& $task;
|
|
ClassRegistry::addObject($taskKey, $task);
|
|
}
|
|
|
|
if(!isset($this->{$taskName})) {
|
|
$this->err("Task '".$taskName."' could not be loaded");
|
|
exit();
|
|
}
|
|
} else {
|
|
$this->err("Task '".$taskName."' could not be found");
|
|
exit();
|
|
}
|
|
}
|
|
}
|
|
|
|
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) {
|
|
$in = $this->Dispatch->getInput($prompt, $options, $default);
|
|
if($options && is_string($options)) {
|
|
if(strpos($options, ',')) {
|
|
$options = explode(',', $options);
|
|
} else if(strpos($options, '/')) {
|
|
$options = explode('/', $options);
|
|
} else {
|
|
$options = array($options);
|
|
}
|
|
}
|
|
if(is_array($options)) {
|
|
while($in == '' || ($in && (!in_array(low($in), $options) && !in_array(up($in), $options)) && !in_array($in, $options))) {
|
|
$in = $this->Dispatch->getInput($prompt, $options, $default);
|
|
}
|
|
}
|
|
if($in) {
|
|
return $in;
|
|
}
|
|
}
|
|
/**
|
|
* 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 error($title, $msg) {
|
|
$out .= "$title\n";
|
|
$out .= "$msg\n";
|
|
$out .= "\n";
|
|
$this->err($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->error('Wrong number of parameters: '.count($this->args), 'Please type \'cake '.$this->shell.' help\' for help on usage of the '.$this->name.' '.$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);
|
|
$this->out("\n".__(sprintf("Creating file %s", $path), true));
|
|
if (is_file($path) && $this->interactive === true) {
|
|
$key = $this->in(__("File exists, overwrite?", true). " {$path}", array('y', 'n', 'q'), 'n');
|
|
if (low($key) == 'q') {
|
|
$this->out(__("Quitting.", true) ."\n");
|
|
exit;
|
|
} else if (low($key) == 'a') {
|
|
$this->dont_ask = true;
|
|
} else if (low($key) != 'y') {
|
|
$this->out(__("Skip", true) ." {$path}\n");
|
|
return false;
|
|
}
|
|
}
|
|
if(!class_exists('File')) {
|
|
uses('file');
|
|
}
|
|
if ($File = new File($path, true)) {
|
|
$File->write($contents);
|
|
$this->out(__("Wrote", true) ." {$path}");
|
|
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() {
|
|
if($this->command != null) {
|
|
$this->err("Unknown {$this->name} command '$this->command'.\nFor usage, try 'cake {$this->shell} help'.\n\n");
|
|
} else{
|
|
$this->Dispatch->help();
|
|
}
|
|
}
|
|
/**
|
|
* Action to create a Unit Test.
|
|
*
|
|
* @return Success
|
|
*/
|
|
function _checkUnitTest() {
|
|
if (is_dir(VENDORS.'simpletest') || is_dir(ROOT.DS.APP_DIR.DS.'vendors'.DS.'simpletest')) {
|
|
return true;
|
|
}
|
|
$unitTest = $this->in('Cake test suite not installed. Do you want to bake unit test files anyway?', array('y','n'), 'y');
|
|
$result = low($unitTest) == 'y' || low($unitTest) == 'yes';
|
|
|
|
if ($result) {
|
|
$this->out("\nYou can download the Cake test suite from http://cakeforge.org/projects/testsuite/", true);
|
|
}
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* creates the proper pluralize controller for the url
|
|
*
|
|
* @param string $name
|
|
* @return string $name
|
|
*/
|
|
function _controllerPath($name) {
|
|
return low(Inflector::underscore($name));
|
|
}
|
|
/**
|
|
* creates the proper pluralize controller class name.
|
|
*
|
|
* @param string $name
|
|
* @return string $name
|
|
*/
|
|
function _controllerName($name) {
|
|
return Inflector::pluralize(Inflector::camelize($name));
|
|
}
|
|
/**
|
|
* creates the proper singular model name.
|
|
*
|
|
* @param string $name
|
|
* @return string $name
|
|
*/
|
|
function _modelName($name) {
|
|
return Inflector::camelize(Inflector::singularize($name));
|
|
}
|
|
/**
|
|
* creates the proper singular model key for associations.
|
|
*
|
|
* @param string $name
|
|
* @return string $name
|
|
*/
|
|
function _modelKey($name) {
|
|
return Inflector::underscore(Inflector::singularize($name)).'_id';
|
|
}
|
|
/**
|
|
* creates the proper model name from a foreign key.
|
|
*
|
|
* @param string $key
|
|
* @return string $name
|
|
*/
|
|
function _modelNameFromKey($key) {
|
|
$name = str_replace('_id', '',$key);
|
|
return $this->_modelName($name);
|
|
}
|
|
/**
|
|
* creates the singular name for use in views.
|
|
*
|
|
* @param string $name
|
|
* @return string $name
|
|
*/
|
|
function _singularName($name) {
|
|
return Inflector::variable(Inflector::singularize($name));
|
|
}
|
|
/**
|
|
* creates the plural name for views.
|
|
*
|
|
* @param string $name
|
|
* @return string $name
|
|
*/
|
|
function _pluralName($name) {
|
|
return Inflector::variable(Inflector::pluralize($name));
|
|
}
|
|
/**
|
|
* creates the singular human name used in views
|
|
*
|
|
* @param string $name
|
|
* @return string $name
|
|
*/
|
|
function _singularHumanName($name) {
|
|
return Inflector::humanize(Inflector::underscore(Inflector::singularize($name)));
|
|
}
|
|
/**
|
|
* creates the plural humna name used in views
|
|
*
|
|
* @param string $name
|
|
* @return string $name
|
|
*/
|
|
function _pluralHumanName($name) {
|
|
return Inflector::humanize(Inflector::underscore(Inflector::pluralize($name)));
|
|
}
|
|
}
|
|
?>
|