1: <?php
  2: /**
  3:  * ShellDispatcher file
  4:  *
  5:  * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
  6:  * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
  7:  *
  8:  * Licensed under The MIT License
  9:  * For full copyright and license information, please see the LICENSE.txt
 10:  * Redistributions of files must retain the above copyright notice.
 11:  *
 12:  * @copyright     Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
 13:  * @link          http://cakephp.org CakePHP(tm) Project
 14:  * @since         CakePHP(tm) v 2.0
 15:  * @license       http://www.opensource.org/licenses/mit-license.php MIT License
 16:  */
 17: 
 18: /**
 19:  * Shell dispatcher handles dispatching cli commands.
 20:  *
 21:  * @package       Cake.Console
 22:  */
 23: class ShellDispatcher {
 24: 
 25: /**
 26:  * Contains command switches parsed from the command line.
 27:  *
 28:  * @var array
 29:  */
 30:     public $params = array();
 31: 
 32: /**
 33:  * Contains arguments parsed from the command line.
 34:  *
 35:  * @var array
 36:  */
 37:     public $args = array();
 38: 
 39: /**
 40:  * Constructor
 41:  *
 42:  * The execution of the script is stopped after dispatching the request with
 43:  * a status code of either 0 or 1 according to the result of the dispatch.
 44:  *
 45:  * @param array $args the argv from PHP
 46:  * @param bool $bootstrap Should the environment be bootstrapped.
 47:  */
 48:     public function __construct($args = array(), $bootstrap = true) {
 49:         set_time_limit(0);
 50:         $this->parseParams($args);
 51: 
 52:         if ($bootstrap) {
 53:             $this->_initConstants();
 54:             $this->_initEnvironment();
 55:         }
 56:     }
 57: 
 58: /**
 59:  * Run the dispatcher
 60:  *
 61:  * @param array $argv The argv from PHP
 62:  * @return void
 63:  */
 64:     public static function run($argv) {
 65:         $dispatcher = new ShellDispatcher($argv);
 66:         return $dispatcher->_stop($dispatcher->dispatch() === false ? 1 : 0);
 67:     }
 68: 
 69: /**
 70:  * Defines core configuration.
 71:  *
 72:  * @return void
 73:  */
 74:     protected function _initConstants() {
 75:         if (function_exists('ini_set')) {
 76:             ini_set('html_errors', false);
 77:             ini_set('implicit_flush', true);
 78:             ini_set('max_execution_time', 0);
 79:         }
 80: 
 81:         if (!defined('CAKE_CORE_INCLUDE_PATH')) {
 82:             define('CAKE_CORE_INCLUDE_PATH', dirname(dirname(dirname(__FILE__))));
 83:             define('CAKEPHP_SHELL', true);
 84:             if (!defined('DS')) {
 85:                 define('DS', DIRECTORY_SEPARATOR);
 86:             }
 87:             if (!defined('CORE_PATH')) {
 88:                 define('CORE_PATH', CAKE_CORE_INCLUDE_PATH . DS);
 89:             }
 90:         }
 91:     }
 92: 
 93: /**
 94:  * Defines current working environment.
 95:  *
 96:  * @return void
 97:  * @throws CakeException
 98:  */
 99:     protected function _initEnvironment() {
100:         if (!$this->_bootstrap()) {
101:             $message = "Unable to load CakePHP core.\nMake sure " . DS . 'lib' . DS . 'Cake exists in ' . CAKE_CORE_INCLUDE_PATH;
102:             throw new CakeException($message);
103:         }
104: 
105:         if (!isset($this->args[0]) || !isset($this->params['working'])) {
106:             $message = "This file has been loaded incorrectly and cannot continue.\n" .
107:                 "Please make sure that " . DS . 'lib' . DS . 'Cake' . DS . "Console is in your system path,\n" .
108:                 "and check the cookbook for the correct usage of this command.\n" .
109:                 "(http://book.cakephp.org/)";
110:             throw new CakeException($message);
111:         }
112: 
113:         $this->shiftArgs();
114:     }
115: 
116: /**
117:  * Initializes the environment and loads the CakePHP core.
118:  *
119:  * @return bool Success.
120:  */
121:     protected function _bootstrap() {
122:         if (!defined('ROOT')) {
123:             define('ROOT', $this->params['root']);
124:         }
125:         if (!defined('APP_DIR')) {
126:             define('APP_DIR', $this->params['app']);
127:         }
128:         if (!defined('APP')) {
129:             define('APP', $this->params['working'] . DS);
130:         }
131:         if (!defined('WWW_ROOT')) {
132:             define('WWW_ROOT', APP . $this->params['webroot'] . DS);
133:         }
134:         if (!defined('TMP') && !is_dir(APP . 'tmp')) {
135:             define('TMP', CAKE_CORE_INCLUDE_PATH . DS . 'Cake' . DS . 'Console' . DS . 'Templates' . DS . 'skel' . DS . 'tmp' . DS);
136:         }
137:         $boot = file_exists(ROOT . DS . APP_DIR . DS . 'Config' . DS . 'bootstrap.php');
138:         require CORE_PATH . 'Cake' . DS . 'bootstrap.php';
139: 
140:         if (!file_exists(APP . 'Config' . DS . 'core.php')) {
141:             include_once CAKE_CORE_INCLUDE_PATH . DS . 'Cake' . DS . 'Console' . DS . 'Templates' . DS . 'skel' . DS . 'Config' . DS . 'core.php';
142:             App::build();
143:         }
144: 
145:         $this->setErrorHandlers();
146: 
147:         if (!defined('FULL_BASE_URL')) {
148:             $url = Configure::read('App.fullBaseUrl');
149:             define('FULL_BASE_URL', $url ? $url : 'http://localhost');
150:             Configure::write('App.fullBaseUrl', FULL_BASE_URL);
151:         }
152: 
153:         return true;
154:     }
155: 
156: /**
157:  * Set the error/exception handlers for the console
158:  * based on the `Error.consoleHandler`, and `Exception.consoleHandler` values
159:  * if they are set. If they are not set, the default ConsoleErrorHandler will be
160:  * used.
161:  *
162:  * @return void
163:  */
164:     public function setErrorHandlers() {
165:         App::uses('ConsoleErrorHandler', 'Console');
166:         $error = Configure::read('Error');
167:         $exception = Configure::read('Exception');
168: 
169:         $errorHandler = new ConsoleErrorHandler();
170:         if (empty($error['consoleHandler'])) {
171:             $error['consoleHandler'] = array($errorHandler, 'handleError');
172:             Configure::write('Error', $error);
173:         }
174:         if (empty($exception['consoleHandler'])) {
175:             $exception['consoleHandler'] = array($errorHandler, 'handleException');
176:             Configure::write('Exception', $exception);
177:         }
178:         set_exception_handler($exception['consoleHandler']);
179:         set_error_handler($error['consoleHandler'], Configure::read('Error.level'));
180:     }
181: 
182: /**
183:  * Dispatches a CLI request
184:  *
185:  * @return bool
186:  * @throws MissingShellMethodException
187:  */
188:     public function dispatch() {
189:         $shell = $this->shiftArgs();
190: 
191:         if (!$shell) {
192:             $this->help();
193:             return false;
194:         }
195:         if (in_array($shell, array('help', '--help', '-h'))) {
196:             $this->help();
197:             return true;
198:         }
199: 
200:         $Shell = $this->_getShell($shell);
201: 
202:         $command = null;
203:         if (isset($this->args[0])) {
204:             $command = $this->args[0];
205:         }
206: 
207:         if ($Shell instanceof Shell) {
208:             $Shell->initialize();
209:             return $Shell->runCommand($command, $this->args);
210:         }
211:         $methods = array_diff(get_class_methods($Shell), get_class_methods('Shell'));
212:         $added = in_array($command, $methods);
213:         $private = $command[0] === '_' && method_exists($Shell, $command);
214: 
215:         if (!$private) {
216:             if ($added) {
217:                 $this->shiftArgs();
218:                 $Shell->startup();
219:                 return $Shell->{$command}();
220:             }
221:             if (method_exists($Shell, 'main')) {
222:                 $Shell->startup();
223:                 return $Shell->main();
224:             }
225:         }
226: 
227:         throw new MissingShellMethodException(array('shell' => $shell, 'method' => $command));
228:     }
229: 
230: /**
231:  * Get shell to use, either plugin shell or application shell
232:  *
233:  * All paths in the loaded shell paths are searched.
234:  *
235:  * @param string $shell Optionally the name of a plugin
236:  * @return mixed An object
237:  * @throws MissingShellException when errors are encountered.
238:  */
239:     protected function _getShell($shell) {
240:         list($plugin, $shell) = pluginSplit($shell, true);
241: 
242:         $plugin = Inflector::camelize($plugin);
243:         $class = Inflector::camelize($shell) . 'Shell';
244: 
245:         App::uses('Shell', 'Console');
246:         App::uses('AppShell', 'Console/Command');
247:         App::uses($class, $plugin . 'Console/Command');
248: 
249:         if (!class_exists($class)) {
250:             throw new MissingShellException(array(
251:                 'class' => $class
252:             ));
253:         }
254:         $Shell = new $class();
255:         $Shell->plugin = trim($plugin, '.');
256:         return $Shell;
257:     }
258: 
259: /**
260:  * Parses command line options and extracts the directory paths from $params
261:  *
262:  * @param array $args Parameters to parse
263:  * @return void
264:  */
265:     public function parseParams($args) {
266:         $this->_parsePaths($args);
267: 
268:         $defaults = array(
269:             'app' => 'app',
270:             'root' => dirname(dirname(dirname(dirname(__FILE__)))),
271:             'working' => null,
272:             'webroot' => 'webroot'
273:         );
274:         $params = array_merge($defaults, array_intersect_key($this->params, $defaults));
275:         $isWin = false;
276:         foreach ($defaults as $default => $value) {
277:             if (strpos($params[$default], '\\') !== false) {
278:                 $isWin = true;
279:                 break;
280:             }
281:         }
282:         $params = str_replace('\\', '/', $params);
283: 
284:         if (isset($params['working'])) {
285:             $params['working'] = trim($params['working']);
286:         }
287: 
288:         if (!empty($params['working']) && (!isset($this->args[0]) || isset($this->args[0]) && $this->args[0][0] !== '.')) {
289:             if ($params['working'][0] === '.') {
290:                 $params['working'] = realpath($params['working']);
291:             }
292:             if (empty($this->params['app']) && $params['working'] != $params['root']) {
293:                 $params['root'] = dirname($params['working']);
294:                 $params['app'] = basename($params['working']);
295:             } else {
296:                 $params['root'] = $params['working'];
297:             }
298:         }
299: 
300:         if ($params['app'][0] === '/' || preg_match('/([a-z])(:)/i', $params['app'], $matches)) {
301:             $params['root'] = dirname($params['app']);
302:         } elseif (strpos($params['app'], '/')) {
303:             $params['root'] .= '/' . dirname($params['app']);
304:         }
305: 
306:         $params['app'] = basename($params['app']);
307:         $params['working'] = rtrim($params['root'], '/');
308:         if (!$isWin || !preg_match('/^[A-Z]:$/i', $params['app'])) {
309:             $params['working'] .= '/' . $params['app'];
310:         }
311: 
312:         if (!empty($matches[0]) || !empty($isWin)) {
313:             $params = str_replace('/', '\\', $params);
314:         }
315: 
316:         $this->params = $params + $this->params;
317:     }
318: 
319: /**
320:  * Parses out the paths from from the argv
321:  *
322:  * @param array $args The argv to parse.
323:  * @return void
324:  */
325:     protected function _parsePaths($args) {
326:         $parsed = array();
327:         $keys = array('-working', '--working', '-app', '--app', '-root', '--root');
328:         $args = (array)$args;
329:         foreach ($keys as $key) {
330:             while (($index = array_search($key, $args)) !== false) {
331:                 $keyname = str_replace('-', '', $key);
332:                 $valueIndex = $index + 1;
333:                 $parsed[$keyname] = $args[$valueIndex];
334:                 array_splice($args, $index, 2);
335:             }
336:         }
337:         $this->args = $args;
338:         $this->params = $parsed;
339:     }
340: 
341: /**
342:  * Removes first argument and shifts other arguments up
343:  *
344:  * @return mixed Null if there are no arguments otherwise the shifted argument
345:  */
346:     public function shiftArgs() {
347:         return array_shift($this->args);
348:     }
349: 
350: /**
351:  * Shows console help. Performs an internal dispatch to the CommandList Shell
352:  *
353:  * @return void
354:  */
355:     public function help() {
356:         $this->args = array_merge(array('command_list'), $this->args);
357:         $this->dispatch();
358:     }
359: 
360: /**
361:  * Stop execution of the current script
362:  *
363:  * @param int|string $status see http://php.net/exit for values
364:  * @return void
365:  */
366:     protected function _stop($status = 0) {
367:         exit($status);
368:     }
369: 
370: }
371: