/usr/share/php/PHP/Depend/TextUI/Command.php is in pdepend 1.1.4-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 | <?php
/**
* This file is part of PHP_Depend.
*
* PHP Version 5
*
* Copyright (c) 2008-2012, Manuel Pichler <mapi@pdepend.org>.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* * Neither the name of Manuel Pichler nor the names of his
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* @category QualityAssurance
* @package PHP_Depend
* @subpackage TextUI
* @author Manuel Pichler <mapi@pdepend.org>
* @copyright 2008-2012 Manuel Pichler. All rights reserved.
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @version SVN: $Id$
* @link http://pdepend.org/
*/
/**
* Handles the command line stuff and starts the text ui runner.
*
* @category QualityAssurance
* @package PHP_Depend
* @subpackage TextUI
* @author Manuel Pichler <mapi@pdepend.org>
* @copyright 2008-2012 Manuel Pichler. All rights reserved.
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @version Release: 1.1.4
* @link http://pdepend.org/
*/
class PHP_Depend_TextUI_Command
{
/**
* Marks a cli error exit.
*/
const CLI_ERROR = 1742;
/**
* Marks an input error exit.
*/
const INPUT_ERROR = 1743;
/**
* Collected log options.
*
* @var array(string=>string)
*/
private $logOptions = null;
/**
* Collected analyzer options.
*
* @var array(string=>string)
*/
private $analyzerOptions = null;
/**
* The recieved cli options
*
* @var array(string=>mixed)
*/
private $options = array();
/**
* The used text ui runner.
*
* @var PHP_Depend_TextUI_Runner
*/
private $runner = null;
/**
* Performs the main cli process and returns the exit code.
*
* @return integer
*/
public function run()
{
// Create a new text ui runner
$this->runner = new PHP_Depend_TextUI_Runner();
$this->runner->addProcessListener(new PHP_Depend_TextUI_ResultPrinter());
try {
if ($this->handleArguments() === false) {
$this->printHelp();
return self::CLI_ERROR;
}
} catch (Exception $e) {
echo $e->getMessage(), PHP_EOL, PHP_EOL;
$this->printHelp();
return self::CLI_ERROR;
}
if (isset($this->options['--help'])) {
$this->printHelp();
return PHP_Depend_TextUI_Runner::SUCCESS_EXIT;
}
if (isset($this->options['--usage'])) {
$this->printUsage();
return PHP_Depend_TextUI_Runner::SUCCESS_EXIT;
}
if (isset($this->options['--version'])) {
$this->printVersion();
return PHP_Depend_TextUI_Runner::SUCCESS_EXIT;
}
// Get a copy of all options
$options = $this->options;
// Get an array with all available log options
$logOptions = $this->collectLogOptions();
// Get an array with all available analyzer options
$analyzerOptions = $this->collectAnalyzerOptions();
foreach ($options as $option => $value) {
if (isset($logOptions[$option])) {
// Reduce recieved option list
unset($options[$option]);
// Register logger
$this->runner->addLogger(substr($option, 2), $value);
} else if (isset($analyzerOptions[$option])) {
// Reduce recieved option list
unset($options[$option]);
if (isset($analyzerOptions[$option]['value']) && is_bool($value)) {
echo 'Option ', $option, ' requires a value.', PHP_EOL;
return self::INPUT_ERROR;
} else if ($analyzerOptions[$option]['value'] === 'file'
&& file_exists($value) === false
) {
echo 'Specified file ', $option, '=', $value,
' not exists.', PHP_EOL;
return self::INPUT_ERROR;
} else if ($analyzerOptions[$option]['value'] === '*') {
$value = array_map('trim', explode(',', $value));
}
$this->runner->addOption(substr($option, 2), $value);
}
}
if (isset($options['--without-annotations'])) {
// Disable annotation parsing
$this->runner->setWithoutAnnotations();
// Remove option
unset($options['--without-annotations']);
}
if (isset($options['--optimization'])) {
// This option is deprecated.
echo 'Option --optimization is ambiguous.', PHP_EOL;
// Remove option
unset($options['--optimization']);
}
if (isset($options['--notify-me'])) {
$this->runner->addProcessListener(
new PHP_Depend_DbusUI_ResultPrinter()
);
unset($options['--notify-me']);
}
if (count($options) > 0) {
$this->printHelp();
echo "Unknown option '", key($options), "' given.", PHP_EOL;
return self::CLI_ERROR;
}
try {
// Output current pdepend version and author
$this->printVersion();
$this->printWorkarounds();
$startTime = time();
$result = $this->runner->run();
if ($this->runner->hasParseErrors() === true) {
$errors = $this->runner->getParseErrors();
printf(
'%sThe following error%s occured:%s',
PHP_EOL,
count($errors) > 1 ? 's' : '',
PHP_EOL
);
foreach ($errors as $error) {
echo $error, PHP_EOL;
}
echo PHP_EOL;
}
echo PHP_EOL, 'Time: ', date('i:s', time() - $startTime);
if (function_exists('memory_get_peak_usage')) {
$memory = (memory_get_peak_usage(true) / (1024 * 1024));
printf('; Memory: %4.2fMb', $memory);
}
echo PHP_EOL;
return $result;
} catch (RuntimeException $e) {
echo PHP_EOL, PHP_EOL,
'Critical error: ', PHP_EOL,
'=============== ', PHP_EOL,
$e->getMessage(), PHP_EOL;
return $e->getCode();
}
}
/**
* Parses the cli arguments.
*
* @return boolean
*/
protected function handleArguments()
{
if (!isset($_SERVER['argv'])) {
if (false === (boolean) ini_get('register_argc_argv')) {
// @codeCoverageIgnoreStart
echo 'Please enable register_argc_argv in your php.ini.';
} else {
// @codeCoverageIgnoreEnd
echo 'Unknown error, no $argv array available.';
}
echo PHP_EOL, PHP_EOL;
return false;
}
$argv = $_SERVER['argv'];
// Remove the pdepend command line file
array_shift($argv);
if (count($argv) === 0) {
return false;
}
// Last argument must be a list of source directories
if (strpos(end($argv), '--') !== 0) {
$this->runner->setSourceArguments(explode(',', array_pop($argv)));
}
for ($i = 0, $c = count($argv); $i < $c; ++$i) {
// Is it an ini_set option?
if ($argv[$i] === '-d' && isset($argv[$i + 1])) {
if (strpos($argv[++$i], '=') === false) {
ini_set($argv[$i], 'on');
} else {
list($key, $value) = explode('=', $argv[$i]);
ini_set($key, $value);
}
} else if (strpos($argv[$i], '=') === false) {
$this->options[$argv[$i]] = true;
} else {
list($key, $value) = explode('=', $argv[$i]);
$this->options[$key] = $value;
}
}
// Check for suffix option
if (isset($this->options['--suffix'])) {
// Get file extensions
$extensions = explode(',', $this->options['--suffix']);
// Set allowed file extensions
$this->runner->setFileExtensions($extensions);
unset($this->options['--suffix']);
}
// Check for ignore option
if (isset($this->options['--ignore'])) {
// Get exclude directories
$directories = explode(',', $this->options['--ignore']);
// Set exclude directories
$this->runner->setExcludeDirectories($directories);
unset($this->options['--ignore']);
}
// Check for exclude package option
if (isset($this->options['--exclude'])) {
// Get exclude directories
$packages = explode(',', $this->options['--exclude']);
// Set exclude packages
$this->runner->setExcludePackages($packages);
unset($this->options['--exclude']);
}
// Check for the bad documentation option
if (isset($this->options['--bad-documentation'])) {
echo "Option --bad-documentation is ambiguous.", PHP_EOL;
unset($this->options['--bad-documentation']);
}
$configurationFactory = new PHP_Depend_Util_Configuration_Factory();
// Check for configuration option
if (isset($this->options['--configuration'])) {
// Get config file
$configFile = $this->options['--configuration'];
unset($this->options['--configuration']);
$configuration = $configurationFactory->create($configFile);
} else {
$configuration = $configurationFactory->createDefault();
}
// Store in config registry
PHP_Depend_Util_ConfigurationInstance::set($configuration);
$this->runner->setConfiguration($configuration);
if (isset($this->options['--debug'])) {
unset($this->options['--debug']);
PHP_Depend_Util_Log::setSeverity(PHP_Depend_Util_Log::DEBUG);
}
return true;
}
/**
* Outputs the current PHP_Depend version.
*
* @return void
*/
protected function printVersion()
{
echo 'PHP_Depend 1.1.4 by Manuel Pichler', PHP_EOL, PHP_EOL;
}
/**
* If the current PHP installation requires some workarounds or limitations,
* this method will output a message on STDOUT.
*
* @return void
*/
protected function printWorkarounds()
{
$workarounds = new PHP_Depend_Util_Workarounds();
if ($workarounds->isNotRequired()) {
return;
}
echo 'Your PHP version requires some workaround:', PHP_EOL;
foreach ($workarounds->getRequiredWorkarounds() as $workaround) {
echo '- ', $workaround, PHP_EOL;
}
echo PHP_EOL;
}
/**
* Outputs the base usage of PHP_Depend.
*
* @return void
*/
protected function printUsage()
{
$this->printVersion();
echo 'Usage: pdepend [options] [logger] <dir[,dir[,...]]>', PHP_EOL, PHP_EOL;
}
/**
* Outputs the main help of PHP_Depend.
*
* @return void
*/
protected function printHelp()
{
$this->printUsage();
$length = $this->printLogOptions();
$length = $this->printAnalyzerOptions($length);
$this->printOption(
'--configuration=<file>',
'Optional PHP_Depend configuration file.',
$length
);
echo PHP_EOL;
$this->printOption(
'--suffix=<ext[,...]>',
'List of valid PHP file extensions.',
$length
);
$this->printOption(
'--ignore=<dir[,...]>',
'List of exclude directories.',
$length
);
$this->printOption(
'--exclude=<pkg[,...]>',
'List of exclude packages.',
$length
);
echo PHP_EOL;
$this->printOption(
'--without-annotations',
'Do not parse doc comment annotations.',
$length
);
echo PHP_EOL;
$this->printOption('--debug', 'Prints debugging information.', $length);
$this->printOption('--help', 'Print this help text.', $length);
$this->printOption('--version', 'Print the current version.', $length);
$this->printDbusOption($length);
$this->printOption('-d key[=value]', 'Sets a php.ini value.', $length);
echo PHP_EOL;
}
/**
* Prints all available log options and returns the length of the longest
* option.
*
* @return integer
*/
protected function printLogOptions()
{
$maxLength = 0;
$options = array();
foreach ($this->collectLogOptions() as $option => $path) {
// Build log option identifier
$identifier = "{$option}=<file>";
// Store in options array
$options[$identifier] = (string) simplexml_load_file($path)->message;
$length = strlen($identifier);
if ($length > $maxLength) {
$maxLength = $length;
}
}
ksort($options);
$last = null;
foreach ($options as $option => $message) {
$current = substr($option, 0, strrpos($option, '-'));
if ($last !== null && $last !== $current) {
echo PHP_EOL;
}
$last = $current;
$this->printOption($option, $message, $maxLength);
}
echo PHP_EOL;
return $maxLength;
}
/**
* Collects all logger options and the configuration name.
*
* @return array(string=>string)
*/
protected function collectLogOptions()
{
if ($this->logOptions !== null) {
return $this->logOptions;
}
$this->logOptions = array();
// Get all include paths
$paths = explode(PATH_SEPARATOR, get_include_path());
$paths[] = dirname(__FILE__) . '/../../../';
foreach ($paths as $path) {
$path .= '/PHP/Depend/Log';
if (is_dir($path) === false) {
continue;
}
$dirs = new DirectoryIterator($path);
foreach ($dirs as $dir) {
if (!$dir->isDir() || substr($dir->getFilename(), 0, 1) === '.') {
continue;
}
$files = new DirectoryIterator($dir->getPathname());
foreach ($files as $file) {
if (!$file->isFile()) {
continue;
}
if (substr($file->getFilename(), -4, 4) !== '.xml') {
continue;
}
$option = '--' . strtolower($dir->getFilename())
. '-' . strtolower(substr($file->getFilename(), 0, -4));
$this->logOptions[$option] = $file->getPathname();
}
}
}
return $this->logOptions;
}
/**
* Prints the analyzer options.
*
* @param integer $length Length of the longest option.
*
* @return integer
*/
protected function printAnalyzerOptions($length)
{
$options = $this->collectAnalyzerOptions();
if (count($options) === 0) {
return $length;
}
ksort($options);
foreach ($options as $option => $info) {
if (isset($info['value'])) {
if ($info['value'] === '*') {
$option .= '=<*[,...]>';
} else if ($info['value'] === 'file') {
$option .= '=<file>';
} else {
$option .= '=<value>';
}
}
$this->printOption($option, $info['message'], $length);
}
echo PHP_EOL;
return $length;
}
/**
* Collects cli options for installed analyzers.
*
* @return array(string=>array)
*/
protected function collectAnalyzerOptions()
{
if ($this->analyzerOptions !== null) {
return $this->analyzerOptions;
}
$this->analyzerOptions = array();
// Get all include paths
$paths = explode(PATH_SEPARATOR, get_include_path());
$paths[] = dirname(__FILE__) . '/../../../';
foreach ($paths as $path) {
$path .= '/PHP/Depend/Metrics';
if (is_dir($path) === false) {
continue;
}
foreach (new DirectoryIterator($path) as $dir) {
// Create analyzer xml config filename
$file = $dir->getPathname() . '/Analyzer.xml';
if (is_file($file) === false) {
continue;
}
// Create a simple xml instance
$sxml = simplexml_load_file($file);
// Check for options
if (!isset($sxml->options->option)) {
continue;
}
foreach ($sxml->options->option as $option) {
$identifier = '--' . (string) $option['name'];
$message = (string) $option->message;
$value = null;
if (isset($option['value'])) {
$value = (string) $option['value'];
}
$this->analyzerOptions[$identifier] = array(
'message' => $message,
'value' => $value
);
}
}
}
return $this->analyzerOptions;
}
/**
* Prints a single option.
*
* @param string $option The option identifier.
* @param string $message The option help message.
* @param integer $length The length of the longest option.
*
* @return void
*/
private function printOption($option, $message, $length)
{
// Ignore the phpunit xml option
if (0 === strpos($option, '--phpunit-xml=')) {
return;
}
// Calculate the max message length
$mlength = 77 - $length;
$option = str_pad($option, $length, ' ', STR_PAD_RIGHT);
echo ' ', $option, ' ';
$lines = explode(PHP_EOL, wordwrap($message, $mlength, PHP_EOL));
echo array_shift($lines);
while (($line = array_shift($lines)) !== null) {
echo PHP_EOL, str_repeat(' ', $length + 3), $line;
}
echo PHP_EOL;
}
/**
* Optionally outputs the dbus option when the required extension
* is loaded.
*
* @param integer $length Padding length for the option.
*
* @return void
*/
private function printDbusOption($length)
{
if (extension_loaded("dbus") === false) {
return;
}
$option = '--notify-me';
$message = 'Show a notification after analysis.';
$this->printOption($option, $message, $length);
}
/**
* Main method that starts the command line runner.
*
* @return integer The exit code.
*/
public static function main()
{
$command = new PHP_Depend_TextUI_Command();
return $command->run();
}
}
|