PradoCommandLineInterpreter

Complexity

Total Complexity

11

Size/Duplication

Total Lines	70
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	addActionClass()	0	3	1
A	printHelp()	0	9	2
A	printGreeting()	0	3	1
B	run()	0	19	5
A	getInstance()	0	6	2

<?php

/**
 * Prado command line developer tools.
 *
 * @author Wei Zhuo <weizhuo[at]gmail[dot]com>
 * @link https://github.com/pradosoft/prado
 * @copyright Copyright &copy; 2005-2016 The PRADO Group
 * @license https://github.com/pradosoft/prado/blob/master/LICENSE
 */

if(!isset($_SERVER['argv']) || php_sapi_name() !== 'cli')
	die('Must be run from the command line');

// Locate composer's autoloader
if(file_exists($autoloader = realpath(__DIR__ . '/../vendor/autoload.php')))
{
	// if we are running inside a prado repo checkout, get out of bin/
	include($autoloader);
} elseif(file_exists($autoloader = realpath(__DIR__ . '/../../../autoload.php'))) {
	// if we are running from inside an application's vendor/ directory, get out of pradosoft/prado/bin/
	include($autoloader);
}

use Prado\TApplication;
use Prado\Prado;

//stub application class
class PradoShellApplication extends TApplication
{
	public function run()
	{
		$this->initApplication();
	}
}

restore_exception_handler();


//register action classes
PradoCommandLineInterpreter::getInstance()->addActionClass('PradoCommandLineCreateProject');
PradoCommandLineInterpreter::getInstance()->addActionClass('PradoCommandLineCreateTests');
PradoCommandLineInterpreter::getInstance()->addActionClass('PradoCommandLinePhpShell');
PradoCommandLineInterpreter::getInstance()->addActionClass('PradoCommandLineActiveRecordGen');
PradoCommandLineInterpreter::getInstance()->addActionClass('PradoCommandLineActiveRecordGenAll');

//run it;
PradoCommandLineInterpreter::getInstance()->run($_SERVER['argv']);

/**************** END CONFIGURATION **********************/

/**
 * PradoCommandLineInterpreter Class
 *
 * Command line interface, configures the action classes and dispatches the command actions.
 *
 * @author Wei Zhuo <weizhuo[at]gmail[dot]com>
 * @since 3.0.5
 */
class PradoCommandLineInterpreter
{
	/**
	 * @var array command action classes
	 */
	protected $_actions = [];

	/**
	 * @param string action class name

The type action was not found. Maybe you did not declare it correctly or list all dependencies?

	 */
	public function addActionClass($class)
	{
		$this->_actions[$class] = new $class;
	}

	/**
	 * @return PradoCommandLineInterpreter static instance
	 */
	public static function getInstance()
	{
		static $instance;
		if($instance === null)
			$instance = new self;
		return $instance;
	}

	public static function printGreeting()
	{
		echo "Command line tools for Prado " . Prado::getVersion() . ".\n";
	}

	/**
	 * Dispatch the command line actions.

The type command was not found. Maybe you did not declare it correctly or list all dependencies?

	 * @param array command line arguments
	 */
	public function run($args)
	{
		if(count($args) > 1)
			array_shift($args);
		$valid = false;
		foreach($this->_actions as $class => $action)
		{
			if($action->isValidAction($args))
			{
				$valid |= $action->performAction($args);
				break;
			}
			else
			{
				$valid = false;
			}
		}
		if(!$valid)

The expression $valid of type integer|false is loosely compared to false; this is ambiguous if the integer can be 0. You might want to explicitly use === false instead.

			$this->printHelp();
	}

	/**
	 * Print command line help, default action.
	 */
	public function printHelp()
	{
		PradoCommandLineInterpreter::printGreeting();

		echo "usage: php prado-cli.php action <parameter> [optional]\n";
		echo "example: php prado-cli.php -c mysite\n\n";
		echo "actions:\n";
		foreach($this->_actions as $action)
			echo $action->renderHelp();
	}
}

/**
 * Base class for command line actions.
 *
 * @author Wei Zhuo <weizhuo[at]gmail[dot]com>
 * @since 3.0.5
 */
abstract class PradoCommandLineAction
{
	/**
	 * Execute the action.
	 * @param array command line parameters
	 * @return boolean true if action was handled
	 */
	abstract public function performAction($args);

	protected function createDirectory($dir, $mask)
	{
		if(!is_dir($dir))
		{
			mkdir($dir);
			echo "creating $dir\n";
		}
		if(is_dir($dir))
			chmod($dir, $mask);
	}

	protected function createFile($filename, $content)
	{
		if(!is_file($filename))
		{
			file_put_contents($filename, $content);
			echo "creating $filename\n";
		}
	}

	public function isValidAction($args)
	{
		return 0 == strcasecmp($args[0], $this->action) &&
			count($args) - 1 >= count($this->parameters);
	}

	public function renderHelp()
	{
		$params = [];
		foreach($this->parameters as $v)
			$params[] = '<' . $v . '>';
		$parameters = implode($params, ' ');

The call to implode() has too many arguments starting with ' '.

		$options = [];
		foreach($this->optional as $v)
			$options[] = '[' . $v . ']';
		$optional = (strlen($parameters) ? ' ' : '') . implode($options, ' ');
		$description = '';
		foreach(explode("\n", wordwrap($this->description, 65)) as $line)
			$description .= '    ' . $line . "\n";
		return <<<EOD
  {$this->action} {$parameters}{$optional}
{$description}

EOD;
	}

	protected function initializePradoApplication($directory)
	{
		$_SERVER['SCRIPT_FILENAME'] = $directory . '/index.php';
		$app_dir = realpath($directory . '/protected/');
		if($app_dir !== false && is_dir($app_dir))
		{
			if(Prado::getApplication() === null)
			{
				$app = new PradoShellApplication($app_dir);
				$app->run();
				$dir = substr(str_replace(realpath('./'), '', $app_dir), 1);
				PradoCommandLineInterpreter::printGreeting();
				echo '** Loaded PRADO appplication in directory "' . $dir . "\".\n";
			}

			return Prado::getApplication();
		}
		else
		{
			PradoCommandLineInterpreter::printGreeting();
			echo '+' . str_repeat('-', 77) . "+\n";
			echo '** Unable to load PRADO application in directory "' . $directory . "\".\n";
			echo '+' . str_repeat('-', 77) . "+\n";
		}
		return false;
	}

}

/**
 * Create a Prado project skeleton, including directories and files.
 *
 * @author Wei Zhuo <weizhuo[at]gmail[dot]com>
 * @since 3.0.5
 */
class PradoCommandLineCreateProject extends PradoCommandLineAction
{
	protected $action = '-c';
	protected $parameters = ['directory'];
	protected $optional = [];
	protected $description = 'Creates a Prado project skeleton for the given <directory>.';

	public function performAction($args)
	{
		PradoCommandLineInterpreter::printGreeting();
		$this->createNewPradoProject($args[1]);
		return true;
	}

	/**
	 * Functions to create new prado project.
	 */
	protected function createNewPradoProject($dir)
	{
		if(strlen(trim($dir)) == 0)
			return;

		$rootPath = realpath(dirname(trim($dir)));

		if(basename($dir) !== '.')
			$basePath = $rootPath . DIRECTORY_SEPARATOR . basename($dir);
		else
			$basePath = $rootPath;
		$appName = basename($basePath);
		$assetPath = $basePath . DIRECTORY_SEPARATOR . 'assets';
		$protectedPath = $basePath . DIRECTORY_SEPARATOR . 'protected';
		$runtimePath = $basePath . DIRECTORY_SEPARATOR . 'protected' . DIRECTORY_SEPARATOR . 'runtime';
		$pagesPath = $protectedPath . DIRECTORY_SEPARATOR . 'pages';

		$indexFile = $basePath . DIRECTORY_SEPARATOR . 'index.php';
		$htaccessFile = $protectedPath . DIRECTORY_SEPARATOR . '.htaccess';
		$configFile = $protectedPath . DIRECTORY_SEPARATOR . 'application.xml';
		$defaultPageFile = $pagesPath . DIRECTORY_SEPARATOR . 'Home.page';

		$this->createDirectory($basePath, 0755);
		$this->createDirectory($assetPath, 0777);
		$this->createDirectory($protectedPath, 0755);
		$this->createDirectory($runtimePath, 0777);
		$this->createDirectory($pagesPath, 0755);

		$this->createFile($indexFile, $this->renderIndexFile());
		$this->createFile($configFile, $this->renderConfigFile($appName));
		$this->createFile($htaccessFile, $this->renderHtaccessFile());
		$this->createFile($defaultPageFile, $this->renderDefaultPage());
	}

	protected function renderIndexFile()
	{
		$framework = realpath(dirname(dirname(__FILE__))) . DIRECTORY_SEPARATOR . 'framework' . DIRECTORY_SEPARATOR . 'prado.php';
return '<?php

$frameworkPath=\'' . $framework . '\';

// The following directory checks may be removed if performance is required
$basePath=dirname(__FILE__);
$assetsPath=$basePath.\'/assets\';
$runtimePath=$basePath.\'/protected/runtime\';

if(!is_file($frameworkPath))
	die("Unable to find prado framework path $frameworkPath.");
if(!is_writable($assetsPath))
	die("Please make sure that the directory $assetsPath is writable by Web server process.");
if(!is_writable($runtimePath))
	die("Please make sure that the directory $runtimePath is writable by Web server process.");


require_once($frameworkPath);

$application=new TApplication;
$application->run();
';
	}

	protected function renderConfigFile($appName)
	{
		return <<<EOD
<?xml version="1.0" encoding="utf-8"?>

<application id="$appName" mode="Debug">
  <!-- alias definitions and namespace usings
  <paths>
    <alias id="myalias" path="./lib" />
    <using namespace="Application.common.*" />
  </paths>
  -->

  <!-- configurations for modules -->
  <modules>
    <!-- Remove this comment mark to enable caching
    <module id="cache" class="System.Caching.TDbCache" />
    -->

    <!-- Remove this comment mark to enable PATH url format
    <module id="request" class="THttpRequest" UrlFormat="Path" />
    -->

    <!-- Remove this comment mark to enable logging
    <module id="log" class="System.Util.TLogRouter">
      <route class="TBrowserLogRoute" Categories="System" />
    </module>
    -->
  </modules>

  <!-- configuration for available services -->
  <services>
    <service id="page" class="TPageService" DefaultPage="Home" />
  </services>

  <!-- application parameters
  <parameters>
    <parameter id="param1" value="value1" />
    <parameter id="param2" value="value2" />
  </parameters>
  -->
</application>
EOD;
	}

	protected function renderHtaccessFile()
	{
		return 'deny from all';
	}


	protected function renderDefaultPage()
	{
return <<<EOD
<html>
<head>
  <title>Welcome to PRADO</title>
</head>
<body>
<h1>Welcome to PRADO!</h1>
</body>
</html>
EOD;
	}
}

/**
 * Creates test fixtures for a Prado application.
 *
 * @author Wei Zhuo <weizhuo[at]gmail[dot]com>
 * @since 3.0.5
 */
class PradoCommandLineCreateTests extends PradoCommandLineAction
{
	protected $action = '-t';
	protected $parameters = ['directory'];
	protected $optional = [];
	protected $description = 'Create test fixtures in the given <directory>.';

	public function performAction($args)
	{
		PradoCommandLineInterpreter::printGreeting();
		$this->createTestFixtures($args[1]);
		return true;
	}

	protected function createTestFixtures($dir)
	{
		if(strlen(trim($dir)) == 0)
			return;

		$rootPath = realpath(dirname(trim($dir)));
		$basePath = $rootPath . '/' . basename($dir);

		$tests = $basePath . '/tests';
		$unit_tests = $tests . '/unit';
		$functional_tests = $tests . '/functional';

		$this->createDirectory($tests, 0755);
		$this->createDirectory($unit_tests, 0755);
		$this->createDirectory($functional_tests, 0755);

		$unit_test_index = $tests . '/unit.php';
		$functional_test_index = $tests . '/functional.php';

		$this->createFile($unit_test_index, $this->renderUnitTestFixture());
		$this->createFile($functional_test_index, $this->renderFunctionalTestFixture());
	}

	protected function renderUnitTestFixture()
	{
		$tester = realpath(dirname(dirname(__FILE__))) . '/tests/test_tools/unit_tests.php';
return '<?php

include_once \'' . $tester . '\';

$app_directory = "../protected";
$test_cases = dirname(__FILE__)."/unit";

$tester = new PradoUnitTester($test_cases, $app_directory);
$tester->run(new HtmlReporter());
';
	}

	protected function renderFunctionalTestFixture()
	{
		$tester = realpath(dirname(dirname(__FILE__))) . '/tests/test_tools/functional_tests.php';
return '<?php

include_once \'' . $tester . '\';

$test_cases = dirname(__FILE__)."/functional";

$tester=new PradoFunctionalTester($test_cases);
$tester->run(new SimpleReporter());
';
	}

}

/**
 * Creates and run a Prado application in a PHP Shell.
 *
 * @author Wei Zhuo <weizhuo[at]gmail[dot]com>
 * @since 3.0.5
 */
class PradoCommandLinePhpShell extends PradoCommandLineAction
{
	protected $action = 'shell';
	protected $parameters = [];
	protected $optional = ['directory'];
	protected $description = 'Runs a PHP interactive interpreter. Initializes the Prado application in the given [directory].';

	public function performAction($args)
	{
		if(count($args) > 1)
			$this->initializePradoApplication($args[1]);

		\Psy\debug([], Prado::getApplication());
		return true;
	}
}

/**
 * Create active record skeleton
 *
 * @author Wei Zhuo <weizhuo[at]gmail[dot]com>
 * @since 3.1
 */
class PradoCommandLineActiveRecordGen extends PradoCommandLineAction
{
	protected $action = 'generate';
	protected $parameters = ['table', 'output'];
	protected $optional = ['directory', 'soap'];
	protected $description = 'Generate Active Record skeleton for <table> to <output> file using application.xml in [directory]. May also generate [soap] properties.';
	private $_soap = false;

	public function performAction($args)
	{
		$app_dir = count($args) > 3 ? $this->getAppDir($args[3]) : $this->getAppDir();
		$this->_soap = count($args) > 4;
		if($app_dir !== false)
		{
			$config = $this->getActiveRecordConfig($app_dir);
			$output = $this->getOutputFile($app_dir, $args[2]);
			if(is_file($output))

It seems like $output can also be of type false; however, parameter $filename of is_file() does only seem to accept string, maybe add an additional type check?

				echo "** File $output already exists, skiping. \n";
			elseif($config !== false && $output !== false)
				$this->generateActiveRecord($config, $args[1], $output);
		}
		return true;
	}

	protected function getAppDir($dir = ".")
	{
		if(is_dir($dir))
			return realpath($dir);
		if(false !== ($app_dir = realpath($dir . '/protected/')) && is_dir($app_dir))
			return $app_dir;
		echo '** Unable to find directory "' . $dir . "\".\n";
		return false;
	}

	protected function getXmlFile($app_dir)
	{
		if(false !== ($xml = realpath($app_dir . '/application.xml')) && is_file($xml))
			return $xml;
		if(false !== ($xml = realpath($app_dir . '/protected/application.xml')) && is_file($xml))
			return $xml;
		echo '** Unable to find application.xml in ' . $app_dir . "\n";
		return false;
	}

	protected function getActiveRecordConfig($app_dir)
	{
		if(false === ($xml = $this->getXmlFile($app_dir)))
			return false;
		if(false !== ($app = $this->initializePradoApplication($app_dir)))
		{
			Prado::using('System.Data.ActiveRecord.TActiveRecordConfig');
			foreach($app->getModules() as $module)
				if($module instanceof TActiveRecordConfig)

The type TActiveRecordConfig was not found. Maybe you did not declare it correctly or list all dependencies?

					return $module;
			echo '** Unable to find TActiveRecordConfig module in ' . $xml . "\n";
		}
		return false;
	}

	protected function getOutputFile($app_dir, $namespace)
	{
		if(is_file($namespace) && strpos($namespace, $app_dir) === 0)
				return $namespace;
		$file = Prado::getPathOfNamespace($namespace, ".php");
		if($file !== null && false !== ($path = realpath(dirname($file))) && is_dir($path))
		{
			if(strpos($path, $app_dir) === 0)
				return $file;
		}
		echo '** Output file ' . $file . ' must be within directory ' . $app_dir . "\n";
		return false;
	}

	protected function generateActiveRecord($config, $tablename, $output)
	{
		$manager = TActiveRecordManager::getInstance();

The type TActiveRecordManager was not found. Maybe you did not declare it correctly or list all dependencies?

		if($manager->getDbConnection()) {
			$gateway = $manager->getRecordGateway();
			$tableInfo = $gateway->getTableInfo($manager->getDbConnection(), $tablename);
			if(count($tableInfo->getColumns()) === 0)
			{
				echo '** Unable to find table or view "' . $tablename . '" in "' . $manager->getDbConnection()->getConnectionString() . "\".\n";
				return false;
			}
			else
			{
				$properties = [];
				foreach($tableInfo->getColumns() as $field => $column)
					$properties[] = $this->generateProperty($field, $column);
			}

			$classname = basename($output, '.php');
			$class = $this->generateClass($properties, $tablename, $classname);
			echo "  Writing class $classname to file $output\n";
			file_put_contents($output, $class);
		} else {
			echo '** Unable to connect to database with ConnectionID=\'' . $config->getConnectionID() . "'. Please check your settings in application.xml and ensure your database connection is set up first.\n";
		}
	}

	protected function generateProperty($field, $column)
	{
		$prop = '';
		$name = '$' . $field;
		$type = $column->getPHPType();
		if($this->_soap)
		{
			$prop .= <<<EOD

	/**
	 * @var $type $name
	 * @soapproperty
	 */

EOD;
		}
		$prop .= "\tpublic $name;";
		return $prop;
	}

	protected function generateClass($properties, $tablename, $class)
	{
		$props = implode("\n", $properties);
		$date = date('Y-m-d h:i:s');
return <<<EOD
<?php
/**
 * Auto generated by prado-cli.php on $date.
 */
class $class extends TActiveRecord
{
	const TABLE='$tablename';

$props

	public static function finder(\$className=__CLASS__)
	{
		return parent::finder(\$className);
	}
}

EOD;
	}
}

/**
 * Create active record skeleton for all tables in DB and its relations
 *
 * @author Matthias Endres <me[at]me23[dot]de>
 * @author Daniel Sampedro Bello <darthdaniel85[at]gmail[dot]com>
 * @since 3.2
 */
class PradoCommandLineActiveRecordGenAll extends PradoCommandLineAction
{
	protected $action = 'generateAll';
	protected $parameters = ['output'];
	protected $optional = ['directory', 'soap', 'overwrite', 'prefix', 'postfix'];
	protected $description = "Generate Active Record skeleton for all Tables to <output> file using application.xml in [directory]. May also generate [soap] properties.\nGenerated Classes are named like the Table with optional [Prefix] and/or [Postfix]. [Overwrite] is used to overwrite existing Files.";
	private $_soap = false;
	private $_prefix = '';
	private $_postfix = '';
	private $_overwrite = false;

	public function performAction($args) {
		$app_dir = count($args) > 2 ? $this->getAppDir($args[2]) : $this->getAppDir();
		$this->_soap = count($args) > 3 ? ($args[3] == "soap" || $args[3] == "true" ? true : false) : false;
		$this->_overwrite = count($args) > 4 ? ($args[4] == "overwrite" || $args[4] == "true" ? true : false) : false;
		$this->_prefix = count($args) > 5 ? $args[5] : '';
		$this->_postfix = count($args) > 6 ? $args[6] : '';

		if ($app_dir !== false) {
			$config = $this->getActiveRecordConfig($app_dir);

			$manager = TActiveRecordManager::getInstance();
			$con = $manager->getDbConnection();
			$con->Active = true;

			switch($con->getDriverName())
			   {
				case 'mysqli':
				case 'mysql':
					$command = $con->createCommand("SHOW TABLES");
					break;
				case 'sqlite': //sqlite 3
				case 'sqlite2': //sqlite 2
					$command = $con->createCommand("SELECT DISTINCT tbl_name FROM sqlite_master WHERE tbl_name<>'sqlite_sequence'");
					break;
				case 'pgsql':
				case 'mssql': // Mssql driver on windows hosts
				case 'sqlsrv': // sqlsrv driver on windows hosts
				case 'dblib': // dblib drivers on linux (and maybe others os) hosts
				case 'oci':
//				case 'ibm':
				default:
					echo "\n    Sorry, generateAll is not implemented for " . $con->getDriverName() . "\n";
					
			   }

			$dataReader = $command->query();

The variable $command does not seem to be defined for all execution paths leading up to this point.

			$dataReader->bindColumn(1, $table);

The variable $table does not exist. Did you maybe mean $tables?

			$tables = [];
			while ($dataReader->read() !== false) {
				$tables[] = $table;
			}
			$con->Active = false;
			foreach ($tables as $key => $table) {
				$output = $args[1] . "." . $this->_prefix . ucfirst($table) . $this->_postfix;
				if ($config !== false && $output !== false) {
					$this->generate("generate " . $table . " " . $output . " " . $this->_soap . " " . $this->_overwrite);
				}
			}
		}
		return true;
	}

	public function generate($l)
	{
		$input = explode(" ", trim($l));
		if(count($input) > 2)
		{
			$app_dir = '.';
			if(Prado::getApplication() !== null)
				$app_dir = dirname(Prado::getApplication()->getBasePath());
			$args = [$input[0],$input[1], $input[2],$app_dir];
			if(count($input) > 3)
				$args = [$input[0],$input[1], $input[2],$app_dir,'soap'];
			$cmd = new PradoCommandLineActiveRecordGen;
			$cmd->performAction($args);
		}
		else
		{
			echo "\n    Usage: generate table_name Application.pages.RecordClassName\n";
		}
	}

	protected function getAppDir($dir = ".") {
		if (is_dir($dir))
			return realpath($dir);
		if (false !== ($app_dir = realpath($dir . '/protected/')) && is_dir($app_dir))
			return $app_dir;
		echo '** Unable to find directory "' . $dir . "\".\n";
		return false;
	}

	protected function getXmlFile($app_dir) {
		if (false !== ($xml = realpath($app_dir . '/application.xml')) && is_file($xml))
			return $xml;
		if (false !== ($xml = realpath($app_dir . '/protected/application.xml')) && is_file($xml))
			return $xml;
		echo '** Unable to find application.xml in ' . $app_dir . "\n";
		return false;
	}

	protected function getActiveRecordConfig($app_dir) {
		if (false === ($xml = $this->getXmlFile($app_dir)))
			return false;
		if (false !== ($app = $this->initializePradoApplication($app_dir))) {
			Prado::using('System.Data.ActiveRecord.TActiveRecordConfig');
			foreach ($app->getModules() as $module)
				if ($module instanceof TActiveRecordConfig)
					return $module;
			echo '** Unable to find TActiveRecordConfig module in ' . $xml . "\n";
		}
		return false;
	}

	protected function getOutputFile($app_dir, $namespace) {
		if (is_file($namespace) && strpos($namespace, $app_dir) === 0)
			return $namespace;
		$file = Prado::getPathOfNamespace($namespace, "");
		if ($file !== null && false !== ($path = realpath(dirname($file))) && is_dir($path)) {
			if (strpos($path, $app_dir) === 0)
				return $file;
		}
		echo '** Output file ' . $file . ' must be within directory ' . $app_dir . "\n";
		return false;
	}

}