Initial commit

lib/Cake/Console/Command/Task/CommandTask.php

@@ -0,0 +1,183 @@
+<?php
+/**
+ * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
+ * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
+ *
+ * Licensed under The MIT License
+ * For full copyright and license information, please see the LICENSE.txt
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
+ * @link          http://cakephp.org CakePHP(tm) Project
+ * @since         CakePHP(tm) v 2.5
+ * @license       http://www.opensource.org/licenses/mit-license.php MIT License
+ */
+
+App::uses('AppShell', 'Console/Command');
+
+/**
+ * Base class for Shell Command reflection.
+ *
+ * @package       Cake.Console.Command.Task
+ */
+class CommandTask extends AppShell {
+
+/**
+ * Gets the shell command listing.
+ *
+ * @return array
+ */
+	public function getShellList() {
+		$skipFiles = array('AppShell');
+
+		$plugins = CakePlugin::loaded();
+		$shellList = array_fill_keys($plugins, null) + array('CORE' => null, 'app' => null);
+
+		$corePath = App::core('Console/Command');
+		$shells = App::objects('file', $corePath[0]);
+		$shells = array_diff($shells, $skipFiles);
+		$this->_appendShells('CORE', $shells, $shellList);
+
+		$appShells = App::objects('Console/Command', null, false);
+		$appShells = array_diff($appShells, $shells, $skipFiles);
+		$this->_appendShells('app', $appShells, $shellList);
+
+		foreach ($plugins as $plugin) {
+			$pluginShells = App::objects($plugin . '.Console/Command');
+			$this->_appendShells($plugin, $pluginShells, $shellList);
+		}
+
+		return array_filter($shellList);
+	}
+
+/**
+ * Scan the provided paths for shells, and append them into $shellList
+ *
+ * @param string $type The type of object.
+ * @param array $shells The shell name.
+ * @param array &$shellList List of shells.
+ * @return void
+ */
+	protected function _appendShells($type, $shells, &$shellList) {
+		foreach ($shells as $shell) {
+			$shellList[$type][] = Inflector::underscore(str_replace('Shell', '', $shell));
+		}
+	}
+
+/**
+ * Return a list of all commands
+ *
+ * @return array
+ */
+	public function commands() {
+		$shellList = $this->getShellList();
+
+		$options = array();
+		foreach ($shellList as $type => $commands) {
+			$prefix = '';
+			if (!in_array(strtolower($type), array('app', 'core'))) {
+				$prefix = $type . '.';
+			}
+
+			foreach ($commands as $shell) {
+				$options[] = $prefix . $shell;
+			}
+		}
+
+		return $options;
+	}
+
+/**
+ * Return a list of subcommands for a given command
+ *
+ * @param string $commandName The command you want subcommands from.
+ * @return array
+ */
+	public function subCommands($commandName) {
+		$Shell = $this->getShell($commandName);
+
+		if (!$Shell) {
+			return array();
+		}
+
+		$taskMap = TaskCollection::normalizeObjectArray((array)$Shell->tasks);
+		$return = array_keys($taskMap);
+		$return = array_map('Inflector::underscore', $return);
+
+		$ShellReflection = new ReflectionClass('AppShell');
+		$shellMethods = $ShellReflection->getMethods(ReflectionMethod::IS_PUBLIC);
+		$shellMethodNames = array('main', 'help');
+		foreach ($shellMethods as $method) {
+			$shellMethodNames[] = $method->getName();
+		}
+
+		$Reflection = new ReflectionClass($Shell);
+		$methods = $Reflection->getMethods(ReflectionMethod::IS_PUBLIC);
+		$methodNames = array();
+		foreach ($methods as $method) {
+			$methodNames[] = $method->getName();
+		}
+
+		$return += array_diff($methodNames, $shellMethodNames);
+		sort($return);
+
+		return $return;
+	}
+
+/**
+ * Get Shell instance for the given command
+ *
+ * @param mixed $commandName The command you want.
+ * @return mixed
+ */
+	public function getShell($commandName) {
+		list($pluginDot, $name) = pluginSplit($commandName, true);
+
+		if (in_array(strtolower($pluginDot), array('app.', 'core.'))) {
+			$commandName = $name;
+			$pluginDot = '';
+		}
+
+		if (!in_array($commandName, $this->commands())) {
+			return false;
+		}
+
+		$name = Inflector::camelize($name);
+		$pluginDot = Inflector::camelize($pluginDot);
+		$class = $name . 'Shell';
+		App::uses($class, $pluginDot . 'Console/Command');
+
+		$Shell = new $class();
+		$Shell->plugin = trim($pluginDot, '.');
+		$Shell->initialize();
+
+		return $Shell;
+	}
+
+/**
+ * Get Shell instance for the given command
+ *
+ * @param mixed $commandName The command to get options for.
+ * @return array
+ */
+	public function options($commandName) {
+		$Shell = $this->getShell($commandName);
+		if (!$Shell) {
+			$parser = new ConsoleOptionParser();
+		} else {
+			$parser = $Shell->getOptionParser();
+		}
+
+		$options = array();
+		$array = $parser->options();
+		foreach ($array as $name => $obj) {
+			$options[] = "--$name";
+			$short = $obj->short();
+			if ($short) {
+				$options[] = "-$short";
+			}
+		}
+		return $options;
+	}
+
+}