1: <?php
  2: /**
  3:  * Base class for Shells
  4:  *
  5:  * PHP 5
  6:  *
  7:  * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
  8:  * Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
  9:  *
 10:  * Licensed under The MIT License
 11:  * Redistributions of files must retain the above copyright notice.
 12:  *
 13:  * @copyright     Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
 14:  * @link          http://cakephp.org CakePHP(tm) Project
 15:  * @since         CakePHP(tm) v 1.2.0.5012
 16:  * @license       MIT License (http://www.opensource.org/licenses/mit-license.php)
 17:  */
 18: 
 19: App::uses('TaskCollection', 'Console');
 20: App::uses('ConsoleOutput', 'Console');
 21: App::uses('ConsoleInput', 'Console');
 22: App::uses('ConsoleInputSubcommand', 'Console');
 23: App::uses('ConsoleOptionParser', 'Console');
 24: App::uses('File', 'Utility');
 25: 
 26: /**
 27:  * Base class for command-line utilities for automating programmer chores.
 28:  *
 29:  * @package       Cake.Console
 30:  */
 31: class Shell extends Object {
 32: 
 33: /**
 34:  * Output constants for making verbose and quiet shells.
 35:  */
 36:     const VERBOSE = 2;
 37:     const NORMAL = 1;
 38:     const QUIET = 0;
 39: 
 40: /**
 41:  * An instance of ConsoleOptionParser that has been configured for this class.
 42:  *
 43:  * @var ConsoleOptionParser
 44:  */
 45:     public $OptionParser;
 46: 
 47: /**
 48:  * If true, the script will ask for permission to perform actions.
 49:  *
 50:  * @var boolean
 51:  */
 52:     public $interactive = true;
 53: 
 54: /**
 55:  * Contains command switches parsed from the command line.
 56:  *
 57:  * @var array
 58:  */
 59:     public $params = array();
 60: 
 61: /**
 62:  * The command (method/task) that is being run.
 63:  *
 64:  * @var string
 65:  */
 66:     public $command;
 67: 
 68: /**
 69:  * Contains arguments parsed from the command line.
 70:  *
 71:  * @var array
 72:  */
 73:     public $args = array();
 74: 
 75: /**
 76:  * The name of the shell in camelized.
 77:  *
 78:  * @var string
 79:  */
 80:     public $name = null;
 81: 
 82: /**
 83:  * The name of the plugin the shell belongs to.
 84:  * Is automatically set by ShellDispatcher when a shell is constructed.
 85:  *
 86:  * @var string
 87:  */
 88:     public $plugin = null;
 89: 
 90: /**
 91:  * Contains tasks to load and instantiate
 92:  *
 93:  * @var array
 94:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::$tasks
 95:  */
 96:     public $tasks = array();
 97: 
 98: /**
 99:  * Contains the loaded tasks
100:  *
101:  * @var array
102:  */
103:     public $taskNames = array();
104: 
105: /**
106:  * Contains models to load and instantiate
107:  *
108:  * @var array
109:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::$uses
110:  */
111:     public $uses = array();
112: 
113: /**
114:  * Task Collection for the command, used to create Tasks.
115:  *
116:  * @var TaskCollection
117:  */
118:     public $Tasks;
119: 
120: /**
121:  * Normalized map of tasks.
122:  *
123:  * @var string
124:  */
125:     protected $_taskMap = array();
126: 
127: /**
128:  * stdout object.
129:  *
130:  * @var ConsoleOutput
131:  */
132:     public $stdout;
133: 
134: /**
135:  * stderr object.
136:  *
137:  * @var ConsoleOutput
138:  */
139:     public $stderr;
140: 
141: /**
142:  * stdin object
143:  *
144:  * @var ConsoleInput
145:  */
146:     public $stdin;
147: 
148: /**
149:  *  Constructs this Shell instance.
150:  *
151:  * @param ConsoleOutput $stdout A ConsoleOutput object for stdout.
152:  * @param ConsoleOutput $stderr A ConsoleOutput object for stderr.
153:  * @param ConsoleInput $stdin A ConsoleInput object for stdin.
154:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell
155:  */
156:     public function __construct($stdout = null, $stderr = null, $stdin = null) {
157:         if ($this->name == null) {
158:             $this->name = Inflector::camelize(str_replace(array('Shell', 'Task'), '', get_class($this)));
159:         }
160:         $this->Tasks = new TaskCollection($this);
161: 
162:         $this->stdout = $stdout;
163:         $this->stderr = $stderr;
164:         $this->stdin = $stdin;
165:         if ($this->stdout == null) {
166:             $this->stdout = new ConsoleOutput('php://stdout');
167:         }
168:         if ($this->stderr == null) {
169:             $this->stderr = new ConsoleOutput('php://stderr');
170:         }
171:         if ($this->stdin == null) {
172:             $this->stdin = new ConsoleInput('php://stdin');
173:         }
174:         $this->_useLogger();
175:         $parent = get_parent_class($this);
176:         if ($this->tasks !== null && $this->tasks !== false) {
177:             $this->_mergeVars(array('tasks'), $parent, true);
178:         }
179:         if ($this->uses !== null && $this->uses !== false) {
180:             $this->_mergeVars(array('uses'), $parent, false);
181:         }
182:     }
183: 
184: /**
185:  * Initializes the Shell
186:  * acts as constructor for subclasses
187:  * allows configuration of tasks prior to shell execution
188:  *
189:  * @return void
190:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::initialize
191:  */
192:     public function initialize() {
193:         $this->_loadModels();
194:     }
195: 
196: /**
197:  * Starts up the Shell and displays the welcome message.
198:  * Allows for checking and configuring prior to command or main execution
199:  *
200:  * Override this method if you want to remove the welcome information,
201:  * or otherwise modify the pre-command flow.
202:  *
203:  * @return void
204:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::startup
205:  */
206:     public function startup() {
207:         $this->_welcome();
208:     }
209: 
210: /**
211:  * Displays a header for the shell
212:  *
213:  * @return void
214:  */
215:     protected function _welcome() {
216:         $this->out();
217:         $this->out(__d('cake_console', '<info>Welcome to CakePHP %s Console</info>', 'v' . Configure::version()));
218:         $this->hr();
219:         $this->out(__d('cake_console', 'App : %s', APP_DIR));
220:         $this->out(__d('cake_console', 'Path: %s', APP));
221:         $this->hr();
222:     }
223: 
224: /**
225:  * If $uses = true
226:  * Loads AppModel file and constructs AppModel class
227:  * makes $this->AppModel available to subclasses
228:  * If public $uses is an array of models will load those models
229:  *
230:  * @return boolean
231:  */
232:     protected function _loadModels() {
233:         if ($this->uses === null || $this->uses === false) {
234:             return;
235:         }
236:         App::uses('ClassRegistry', 'Utility');
237: 
238:         if ($this->uses !== true && !empty($this->uses)) {
239:             $uses = is_array($this->uses) ? $this->uses : array($this->uses);
240: 
241:             $modelClassName = $uses[0];
242:             if (strpos($uses[0], '.') !== false) {
243:                 list($plugin, $modelClassName) = explode('.', $uses[0]);
244:             }
245:             $this->modelClass = $modelClassName;
246: 
247:             foreach ($uses as $modelClass) {
248:                 list($plugin, $modelClass) = pluginSplit($modelClass, true);
249:                 $this->{$modelClass} = ClassRegistry::init($plugin . $modelClass);
250:             }
251:             return true;
252:         }
253:         return false;
254:     }
255: 
256: /**
257:  * Loads tasks defined in public $tasks
258:  *
259:  * @return boolean
260:  */
261:     public function loadTasks() {
262:         if ($this->tasks === true || empty($this->tasks) || empty($this->Tasks)) {
263:             return true;
264:         }
265:         $this->_taskMap = TaskCollection::normalizeObjectArray((array)$this->tasks);
266:         foreach ($this->_taskMap as $task => $properties) {
267:             $this->taskNames[] = $task;
268:         }
269:         return true;
270:     }
271: 
272: /**
273:  * Check to see if this shell has a task with the provided name.
274:  *
275:  * @param string $task The task name to check.
276:  * @return boolean Success
277:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::hasTask
278:  */
279:     public function hasTask($task) {
280:         return isset($this->_taskMap[Inflector::camelize($task)]);
281:     }
282: 
283: /**
284:  * Check to see if this shell has a callable method by the given name.
285:  *
286:  * @param string $name The method name to check.
287:  * @return boolean
288:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::hasMethod
289:  */
290:     public function hasMethod($name) {
291:         try {
292:             $method = new ReflectionMethod($this, $name);
293:             if (!$method->isPublic() || substr($name, 0, 1) === '_') {
294:                 return false;
295:             }
296:             if ($method->getDeclaringClass()->name == 'Shell') {
297:                 return false;
298:             }
299:             return true;
300:         } catch (ReflectionException $e) {
301:             return false;
302:         }
303:     }
304: 
305: /**
306:  * Dispatch a command to another Shell. Similar to Object::requestAction()
307:  * but intended for running shells from other shells.
308:  *
309:  * ### Usage:
310:  *
311:  * With a string command:
312:  *
313:  *  `return $this->dispatchShell('schema create DbAcl');`
314:  *
315:  * Avoid using this form if you have string arguments, with spaces in them.
316:  * The dispatched will be invoked incorrectly. Only use this form for simple
317:  * command dispatching.
318:  *
319:  * With an array command:
320:  *
321:  * `return $this->dispatchShell('schema', 'create', 'i18n', '--dry');`
322:  *
323:  * @return mixed The return of the other shell.
324:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::dispatchShell
325:  */
326:     public function dispatchShell() {
327:         $args = func_get_args();
328:         if (is_string($args[0]) && count($args) == 1) {
329:             $args = explode(' ', $args[0]);
330:         }
331: 
332:         $Dispatcher = new ShellDispatcher($args, false);
333:         return $Dispatcher->dispatch();
334:     }
335: 
336: /**
337:  * Runs the Shell with the provided argv.
338:  *
339:  * Delegates calls to Tasks and resolves methods inside the class. Commands are looked
340:  * up with the following order:
341:  *
342:  * - Method on the shell.
343:  * - Matching task name.
344:  * - `main()` method.
345:  *
346:  * If a shell implements a `main()` method, all missing method calls will be sent to
347:  * `main()` with the original method name in the argv.
348:  *
349:  * @param string $command The command name to run on this shell. If this argument is empty,
350:  *   and the shell has a `main()` method, that will be called instead.
351:  * @param array $argv Array of arguments to run the shell with. This array should be missing the shell name.
352:  * @return void
353:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::runCommand
354:  */
355:     public function runCommand($command, $argv) {
356:         $isTask = $this->hasTask($command);
357:         $isMethod = $this->hasMethod($command);
358:         $isMain = $this->hasMethod('main');
359: 
360:         if ($isTask || $isMethod && $command !== 'execute') {
361:             array_shift($argv);
362:         }
363: 
364:         $this->OptionParser = $this->getOptionParser();
365:         try {
366:             list($this->params, $this->args) = $this->OptionParser->parse($argv, $command);
367:         } catch (ConsoleException $e) {
368:             $this->out($this->OptionParser->help($command));
369:             return false;
370:         }
371: 
372:         if (!empty($this->params['quiet'])) {
373:             $this->_useLogger(false);
374:         }
375:         if (!empty($this->params['plugin'])) {
376:             CakePlugin::load($this->params['plugin']);
377:         }
378:         $this->command = $command;
379:         if (!empty($this->params['help'])) {
380:             return $this->_displayHelp($command);
381:         }
382: 
383:         if (($isTask || $isMethod || $isMain) && $command !== 'execute') {
384:             $this->startup();
385:         }
386: 
387:         if ($isTask) {
388:             $command = Inflector::camelize($command);
389:             return $this->{$command}->runCommand('execute', $argv);
390:         }
391:         if ($isMethod) {
392:             return $this->{$command}();
393:         }
394:         if ($isMain) {
395:             return $this->main();
396:         }
397:         $this->out($this->OptionParser->help($command));
398:         return false;
399:     }
400: 
401: /**
402:  * Display the help in the correct format
403:  *
404:  * @param string $command
405:  * @return void
406:  */
407:     protected function _displayHelp($command) {
408:         $format = 'text';
409:         if (!empty($this->args[0]) && $this->args[0] == 'xml') {
410:             $format = 'xml';
411:             $this->stdout->outputAs(ConsoleOutput::RAW);
412:         } else {
413:             $this->_welcome();
414:         }
415:         return $this->out($this->OptionParser->help($command, $format));
416:     }
417: 
418: /**
419:  * Gets the option parser instance and configures it.
420:  * By overriding this method you can configure the ConsoleOptionParser before returning it.
421:  *
422:  * @return ConsoleOptionParser
423:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::getOptionParser
424:  */
425:     public function getOptionParser() {
426:         $name = ($this->plugin ? $this->plugin . '.' : '') . $this->name;
427:         $parser = new ConsoleOptionParser($name);
428:         return $parser;
429:     }
430: 
431: /**
432:  * Overload get for lazy building of tasks
433:  *
434:  * @param string $name
435:  * @return Shell Object of Task
436:  */
437:     public function __get($name) {
438:         if (empty($this->{$name}) && in_array($name, $this->taskNames)) {
439:             $properties = $this->_taskMap[$name];
440:             $this->{$name} = $this->Tasks->load($properties['class'], $properties['settings']);
441:             $this->{$name}->args =& $this->args;
442:             $this->{$name}->params =& $this->params;
443:             $this->{$name}->initialize();
444:             $this->{$name}->loadTasks();
445:         }
446:         return $this->{$name};
447:     }
448: 
449: /**
450:  * Prompts the user for input, and returns it.
451:  *
452:  * @param string $prompt Prompt text.
453:  * @param string|array $options Array or string of options.
454:  * @param string $default Default input value.
455:  * @return mixed Either the default value, or the user-provided input.
456:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::in
457:  */
458:     public function in($prompt, $options = null, $default = null) {
459:         if (!$this->interactive) {
460:             return $default;
461:         }
462:         $originalOptions = $options;
463:         $in = $this->_getInput($prompt, $originalOptions, $default);
464: 
465:         if ($options && is_string($options)) {
466:             if (strpos($options, ',')) {
467:                 $options = explode(',', $options);
468:             } elseif (strpos($options, '/')) {
469:                 $options = explode('/', $options);
470:             } else {
471:                 $options = array($options);
472:             }
473:         }
474:         if (is_array($options)) {
475:             $options = array_merge(
476:                 array_map('strtolower', $options),
477:                 array_map('strtoupper', $options),
478:                 $options
479:             );
480:             while ($in === '' || !in_array($in, $options)) {
481:                 $in = $this->_getInput($prompt, $originalOptions, $default);
482:             }
483:         }
484:         return $in;
485:     }
486: 
487: /**
488:  * Prompts the user for input, and returns it.
489:  *
490:  * @param string $prompt Prompt text.
491:  * @param string|array $options Array or string of options.
492:  * @param string $default Default input value.
493:  * @return Either the default value, or the user-provided input.
494:  */
495:     protected function _getInput($prompt, $options, $default) {
496:         if (!is_array($options)) {
497:             $printOptions = '';
498:         } else {
499:             $printOptions = '(' . implode('/', $options) . ')';
500:         }
501: 
502:         if ($default === null) {
503:             $this->stdout->write('<question>' . $prompt . '</question>' . " $printOptions \n" . '> ', 0);
504:         } else {
505:             $this->stdout->write('<question>' . $prompt . '</question>' . " $printOptions \n" . "[$default] > ", 0);
506:         }
507:         $result = $this->stdin->read();
508: 
509:         if ($result === false) {
510:             $this->_stop(1);
511:         }
512:         $result = trim($result);
513: 
514:         if ($default !== null && ($result === '' || $result === null)) {
515:             return $default;
516:         }
517:         return $result;
518:     }
519: 
520: /**
521:  * Wrap a block of text.
522:  * Allows you to set the width, and indenting on a block of text.
523:  *
524:  * ### Options
525:  *
526:  * - `width` The width to wrap to.  Defaults to 72
527:  * - `wordWrap` Only wrap on words breaks (spaces) Defaults to true.
528:  * - `indent` Indent the text with the string provided. Defaults to null.
529:  *
530:  * @param string $text Text the text to format.
531:  * @param string|integer|array $options Array of options to use, or an integer to wrap the text to.
532:  * @return string Wrapped / indented text
533:  * @see String::wrap()
534:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::wrapText
535:  */
536:     public function wrapText($text, $options = array()) {
537:         return String::wrap($text, $options);
538:     }
539: 
540: /**
541:  * Outputs a single or multiple messages to stdout. If no parameters
542:  * are passed outputs just a newline.
543:  *
544:  * ### Output levels
545:  *
546:  * There are 3 built-in output level.  Shell::QUIET, Shell::NORMAL, Shell::VERBOSE.
547:  * The verbose and quiet output levels, map to the `verbose` and `quiet` output switches
548:  * present in  most shells.  Using Shell::QUIET for a message means it will always display.
549:  * While using Shell::VERBOSE means it will only display when verbose output is toggled.
550:  *
551:  * @param string|array $message A string or a an array of strings to output
552:  * @param integer $newlines Number of newlines to append
553:  * @param integer $level The message's output level, see above.
554:  * @return integer|boolean Returns the number of bytes returned from writing to stdout.
555:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::out
556:  */
557:     public function out($message = null, $newlines = 1, $level = Shell::NORMAL) {
558:         $currentLevel = Shell::NORMAL;
559:         if (!empty($this->params['verbose'])) {
560:             $currentLevel = Shell::VERBOSE;
561:         }
562:         if (!empty($this->params['quiet'])) {
563:             $currentLevel = Shell::QUIET;
564:         }
565:         if ($level <= $currentLevel) {
566:             return $this->stdout->write($message, $newlines);
567:         }
568:         return true;
569:     }
570: 
571: /**
572:  * Outputs a single or multiple error messages to stderr. If no parameters
573:  * are passed outputs just a newline.
574:  *
575:  * @param string|array $message A string or a an array of strings to output
576:  * @param integer $newlines Number of newlines to append
577:  * @return void
578:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::err
579:  */
580:     public function err($message = null, $newlines = 1) {
581:         $this->stderr->write($message, $newlines);
582:     }
583: 
584: /**
585:  * Returns a single or multiple linefeeds sequences.
586:  *
587:  * @param integer $multiplier Number of times the linefeed sequence should be repeated
588:  * @return string
589:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::nl
590:  */
591:     public function nl($multiplier = 1) {
592:         return str_repeat(ConsoleOutput::LF, $multiplier);
593:     }
594: 
595: /**
596:  * Outputs a series of minus characters to the standard output, acts as a visual separator.
597:  *
598:  * @param integer $newlines Number of newlines to pre- and append
599:  * @param integer $width Width of the line, defaults to 63
600:  * @return void
601:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::hr
602:  */
603:     public function hr($newlines = 0, $width = 63) {
604:         $this->out(null, $newlines);
605:         $this->out(str_repeat('-', $width));
606:         $this->out(null, $newlines);
607:     }
608: 
609: /**
610:  * Displays a formatted error message
611:  * and exits the application with status code 1
612:  *
613:  * @param string $title Title of the error
614:  * @param string $message An optional error message
615:  * @return void
616:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::error
617:  */
618:     public function error($title, $message = null) {
619:         $this->err(__d('cake_console', '<error>Error:</error> %s', $title));
620: 
621:         if (!empty($message)) {
622:             $this->err($message);
623:         }
624:         $this->_stop(1);
625:     }
626: 
627: /**
628:  * Clear the console
629:  *
630:  * @return void
631:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::clear
632:  */
633:     public function clear() {
634:         if (empty($this->params['noclear'])) {
635:             if (DS === '/') {
636:                 passthru('clear');
637:             } else {
638:                 passthru('cls');
639:             }
640:         }
641:     }
642: 
643: /**
644:  * Creates a file at given path
645:  *
646:  * @param string $path Where to put the file.
647:  * @param string $contents Content to put in the file.
648:  * @return boolean Success
649:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::createFile
650:  */
651:     public function createFile($path, $contents) {
652:         $path = str_replace(DS . DS, DS, $path);
653: 
654:         $this->out();
655: 
656:         if (is_file($path) && $this->interactive === true) {
657:             $this->out(__d('cake_console', '<warning>File `%s` exists</warning>', $path));
658:             $key = $this->in(__d('cake_console', 'Do you want to overwrite?'), array('y', 'n', 'q'), 'n');
659: 
660:             if (strtolower($key) == 'q') {
661:                 $this->out(__d('cake_console', '<error>Quitting</error>.'), 2);
662:                 $this->_stop();
663:             } elseif (strtolower($key) != 'y') {
664:                 $this->out(__d('cake_console', 'Skip `%s`', $path), 2);
665:                 return false;
666:             }
667:         } else {
668:             $this->out(__d('cake_console', 'Creating file %s', $path));
669:         }
670: 
671:         $File = new File($path, true);
672:         if ($File->exists() && $File->writable()) {
673:             $data = $File->prepare($contents);
674:             $File->write($data);
675:             $this->out(__d('cake_console', '<success>Wrote</success> `%s`', $path));
676:             return true;
677:         } else {
678:             $this->err(__d('cake_console', '<error>Could not write to `%s`</error>.', $path), 2);
679:             return false;
680:         }
681:     }
682: 
683: /**
684:  * Action to create a Unit Test
685:  *
686:  * @return boolean Success
687:  */
688:     protected function _checkUnitTest() {
689:         if (class_exists('PHPUnit_Framework_TestCase')) {
690:             return true;
691:             //@codingStandardsIgnoreStart
692:         } elseif (@include 'PHPUnit' . DS . 'Autoload.php') {
693:             //@codingStandardsIgnoreEnd
694:             return true;
695:         } elseif (App::import('Vendor', 'phpunit', array('file' => 'PHPUnit' . DS . 'Autoload.php'))) {
696:             return true;
697:         }
698: 
699:         $prompt = __d('cake_console', 'PHPUnit is not installed. Do you want to bake unit test files anyway?');
700:         $unitTest = $this->in($prompt, array('y', 'n'), 'y');
701:         $result = strtolower($unitTest) == 'y' || strtolower($unitTest) == 'yes';
702: 
703:         if ($result) {
704:             $this->out();
705:             $this->out(__d('cake_console', 'You can download PHPUnit from %s', 'http://phpunit.de'));
706:         }
707:         return $result;
708:     }
709: 
710: /**
711:  * Makes absolute file path easier to read
712:  *
713:  * @param string $file Absolute file path
714:  * @return string short path
715:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::shortPath
716:  */
717:     public function shortPath($file) {
718:         $shortPath = str_replace(ROOT, null, $file);
719:         $shortPath = str_replace('..' . DS, '', $shortPath);
720:         return str_replace(DS . DS, DS, $shortPath);
721:     }
722: 
723: /**
724:  * Creates the proper controller path for the specified controller class name
725:  *
726:  * @param string $name Controller class name
727:  * @return string Path to controller
728:  */
729:     protected function _controllerPath($name) {
730:         return Inflector::underscore($name);
731:     }
732: 
733: /**
734:  * Creates the proper controller plural name for the specified controller class name
735:  *
736:  * @param string $name Controller class name
737:  * @return string Controller plural name
738:  */
739:     protected function _controllerName($name) {
740:         return Inflector::pluralize(Inflector::camelize($name));
741:     }
742: 
743: /**
744:  * Creates the proper model camelized name (singularized) for the specified name
745:  *
746:  * @param string $name Name
747:  * @return string Camelized and singularized model name
748:  */
749:     protected function _modelName($name) {
750:         return Inflector::camelize(Inflector::singularize($name));
751:     }
752: 
753: /**
754:  * Creates the proper underscored model key for associations
755:  *
756:  * @param string $name Model class name
757:  * @return string Singular model key
758:  */
759:     protected function _modelKey($name) {
760:         return Inflector::underscore($name) . '_id';
761:     }
762: 
763: /**
764:  * Creates the proper model name from a foreign key
765:  *
766:  * @param string $key Foreign key
767:  * @return string Model name
768:  */
769:     protected function _modelNameFromKey($key) {
770:         return Inflector::camelize(str_replace('_id', '', $key));
771:     }
772: 
773: /**
774:  * creates the singular name for use in views.
775:  *
776:  * @param string $name
777:  * @return string $name
778:  */
779:     protected function _singularName($name) {
780:         return Inflector::variable(Inflector::singularize($name));
781:     }
782: 
783: /**
784:  * Creates the plural name for views
785:  *
786:  * @param string $name Name to use
787:  * @return string Plural name for views
788:  */
789:     protected function _pluralName($name) {
790:         return Inflector::variable(Inflector::pluralize($name));
791:     }
792: 
793: /**
794:  * Creates the singular human name used in views
795:  *
796:  * @param string $name Controller name
797:  * @return string Singular human name
798:  */
799:     protected function _singularHumanName($name) {
800:         return Inflector::humanize(Inflector::underscore(Inflector::singularize($name)));
801:     }
802: 
803: /**
804:  * Creates the plural human name used in views
805:  *
806:  * @param string $name Controller name
807:  * @return string Plural human name
808:  */
809:     protected function _pluralHumanName($name) {
810:         return Inflector::humanize(Inflector::underscore($name));
811:     }
812: 
813: /**
814:  * Find the correct path for a plugin. Scans $pluginPaths for the plugin you want.
815:  *
816:  * @param string $pluginName Name of the plugin you want ie. DebugKit
817:  * @return string $path path to the correct plugin.
818:  */
819:     protected function _pluginPath($pluginName) {
820:         if (CakePlugin::loaded($pluginName)) {
821:             return CakePlugin::path($pluginName);
822:         }
823:         return current(App::path('plugins')) . $pluginName . DS;
824:     }
825: 
826: /**
827:  * Used to enable or disable logging stream output to stdout and stderr
828:  * If you don't wish to see in your stdout or stderr everything that is logged
829:  * through CakeLog, call this function with first param as false
830:  *
831:  * @param boolean $enable wheter to enable CakeLog output or not
832:  * @return void
833:  **/
834:     protected function _useLogger($enable = true) {
835:         if (!$enable) {
836:             CakeLog::drop('stdout');
837:             CakeLog::drop('stderr');
838:             return;
839:         }
840:         CakeLog::config('stdout', array(
841:             'engine' => 'ConsoleLog',
842:             'types' => array('notice', 'info'),
843:             'stream' => $this->stdout,
844:         ));
845:         CakeLog::config('stderr', array(
846:             'engine' => 'ConsoleLog',
847:             'types' => array('emergency', 'alert', 'critical', 'error', 'warning', 'debug'),
848:             'stream' => $this->stderr,
849:         ));
850:     }
851: }
852: