/usr/share/php/TheSeer/phpDox/CLI.php is in phpdox 0.7.0-2.
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 | <?php
/**
* Copyright (c) 2010-2014 Arne Blankerts <arne@blankerts.de>
* 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 Arne Blankerts nor the names of 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 HOLDER ORCONTRIBUTORS
* 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.
*
* Exit codes:
* 0 - No error
* 1 - Execution Error
* 3 - Parameter Error
*
* @package phpDox
* @author Arne Blankerts <arne@blankerts.de>
* @copyright Arne Blankerts <arne@blankerts.de>, All rights reserved.
* @license BSD License
*
*/
namespace TheSeer\phpDox {
use TheSeer\fDOM\fDOMDocument;
use TheSeer\fDOM\fDOMException;
class CLI {
/**
* Factory instance
*
* @var Factory
*/
protected $factory;
public function __construct(Factory $factory) {
$this->factory = $factory;
}
/**
* Main executor for CLI process.
*/
public function run(CLIOptions $options) {
$errorHandler = $this->factory->getInstanceFor('ErrorHandler');
$errorHandler->register();
try {
$this->preBootstrap();
if ($options->showHelp() === TRUE) {
$this->showVersion();
echo $options->getHelpScreen();
exit(0);
}
if ($options->showVersion() === TRUE) {
$this->showVersion();
exit(0);
}
if ($options->generateSkel() === TRUE) {
$this->showSkeletonConfig($options->generateStrippedSkel());
exit(0);
}
$cfgLoader = $this->factory->getInstanceFor('ConfigLoader');
$cfgFile = $options->configFile();
if ($cfgFile != '') {
$config = $cfgLoader->load($cfgFile);
} else {
$config = $cfgLoader->autodetect();
}
/** @var $config GlobalConfig */
if ($config->isSilentMode()) {
$this->factory->setLoggerType('silent');
} else {
$this->showVersion();
$this->factory->setLoggerType('shell');
}
$logger = $this->factory->getInstanceFor('Logger');
$logger->log("Using config file '". $config->getConfigFile()->getPathname() . "'");
/** @var Application $app */
$app = $this->factory->getInstanceFor('Application');
$defBootstrapFiles = new FileInfoCollection();
$defBootstrapFiles->add(new FileInfo(__DIR__ . '/../bootstrap/backends.php'));
$defBootstrapFiles->add(new FileInfo(__DIR__ . '/../bootstrap/enrichers.php'));
$defBootstrapFiles->add(new FileInfo(__DIR__ . '/../bootstrap/engines.php'));
$bootstrap = $app->runBootstrap($defBootstrapFiles);
$bootstrap->load($config->getCustomBootstrapFiles(), false);
if ($options->listEngines()) {
$this->showVersion();
$this->showList('engines', $bootstrap->getEngines());
}
if ($options->listEnrichers()) {
$this->showVersion();
$this->showList('enrichers', $bootstrap->getEnrichers());
}
if ($options->listBackends()) {
$this->showVersion();
$this->showList('backends', $bootstrap->getBackends());
}
if ($options->listBackends() || $options->listEngines() || $options->listEnrichers()) {
exit(0);
}
foreach($config->getAvailableProjects() as $project) {
$logger->log("Starting to process project '$project'");
$pcfg = $config->getProjectConfig($project);
$index = new FileInfo($pcfg->getWorkDirectory() . '/index.xml');
if ($index->exists() && ($index->getMTime() < $config->getConfigFile()->getMTime())) {
$logger->log("Configuration change detected - cleaning cache");
$cleaner = new DirectoryCleaner();
$cleaner->process(new FileInfo($pcfg->getWorkDirectory()));
}
if (!$options->generatorOnly()) {
$app->runCollector( $pcfg->getCollectorConfig() );
}
if (!$options->collectorOnly()) {
$app->runGenerator( $pcfg->getGeneratorConfig() );
}
$logger->log("Processing project '$project' completed.");
}
$logger->buildSummary();
} catch (CLIEnvironmentException $e) {
$this->showVersion();
fwrite(STDERR, 'Sorry, but your PHP environment is currently not able to run phpDox due to');
fwrite(STDERR, "\nthe following issue(s):\n\n" . $e->getMessage() . "\n\n");
fwrite(STDERR, "Please adjust your PHP configuration and try again.\n\n");
exit(3);
} catch (CLIOptionsException $e) {
$this->showVersion();
fwrite(STDERR, $e->getMessage()."\n\n");
fwrite(STDERR, $options->getHelpScreen());
exit(3);
} catch (ConfigLoaderException $e) {
$this->showVersion();
fwrite(STDERR, "\nAn error occured while trying to load the configuration file:\n\t" . $e->getMessage()."\n\nUsing --skel might get you started.\n\n");
exit(3);
} catch (ConfigException $e) {
fwrite(STDERR, "\nYour configuration seems to be corrupted:\n\n\t" . $e->getMessage()."\n\nPlease verify your configuration xml file.\n\n");
exit(3);
} catch (ApplicationException $e) {
fwrite(STDERR, "\nAn application error occured while processing:\n\n\t" . $e->getMessage()."\n\nPlease verify your configuration.\n\n");
exit(1);
} catch (\Exception $e) {
if ($e instanceof fDOMException) {
$e->toggleFullMessage(TRUE);
}
$this->showVersion();
$errorHandler->handleException($e);
}
}
/**
* Helper to output version information.
*/
protected function showVersion() {
static $shown = FALSE;
if ($shown) {
return;
}
$shown = TRUE;
echo Version::getInfoString() . "\n\n";
}
protected function showSkeletonConfig($strip) {
$config = file_get_contents(__DIR__ . '/config/skeleton.xml');
if ($strip) {
$dom = new fDOMDocument();
$dom->loadXML($config);
foreach($dom->query('//comment()') as $c) {
$c->parentNode->removeChild($c);
}
$dom->preserveWhiteSpace = FALSE;
$dom->formatOutput = TRUE;
$dom->loadXML($dom->saveXML());
$config = $dom->saveXML();
}
echo $config;
}
protected function showList($title, Array $list) {
echo "\nThe following $title are registered:\n\n";
foreach($list as $name => $desc) {
printf(" %s \t %s\n", $name, $desc);
}
echo "\n\n";
}
private function preBootstrap() {
$required = array('tokenizer', 'iconv', 'fileinfo', 'libxml', 'dom', 'xsl','mbstring');
$missing = array();
foreach($required as $test) {
if (!extension_loaded($test)) {
$missing[] = sprintf('ext/%s not installed/enabled', $test);
}
}
if (count($missing)) {
throw new CLIEnvironmentException(
join("\n", $missing),
CLIEnvironmentException::ExtensionMissing
);
}
if (extension_loaded('xdebug')) {
ini_set('xdebug.scream', 0);
ini_set('xdebug.max_nesting_level', 8192);
ini_set('xdebug.show_exception_trace', 0);
xdebug_disable();
}
try {
date_default_timezone_set(date_default_timezone_get());
} catch (\ErrorException $e) {
date_default_timezone_set('UTC');
throw new CLIEnvironmentException(
"No default date.timezone configured in php.ini.",
CLIEnvironmentException::DateTimeZoneMissing,
$e
);
}
}
}
class CLIEnvironmentException extends \Exception {
const ExtensionMissing = 1;
const DateTimeZoneMissing = 2;
}
}
|