Console.php — Matomo Analytics – Powerful, Privacy-First Insights for WordPress 5.0.3

matomo / app / core / Console.php

matomo / app / core Last commit date

API 2 years ago Access 2 years ago Application 2 years ago Archive 2 years ago ArchiveProcessor 2 years ago Archiver 2 years ago AssetManager 2 years ago Auth 2 years ago Category 2 years ago Changes 2 years ago CliMulti 2 years ago Columns 2 years ago Concurrency 2 years ago Config 2 years ago Container 2 years ago CronArchive 2 years ago DataAccess 2 years ago DataFiles 2 years ago DataTable 2 years ago Db 2 years ago DeviceDetector 2 years ago Email 2 years ago Exception 2 years ago Http 2 years ago Intl 2 years ago Log 2 years ago Mail 2 years ago Measurable 2 years ago Menu 2 years ago Metrics 2 years ago Notification 2 years ago Period 2 years ago Plugin 2 years ago ProfessionalServices 2 years ago Report 2 years ago ReportRenderer 2 years ago Scheduler 2 years ago Segment 2 years ago Session 2 years ago Settings 2 years ago Tracker 2 years ago Translation 2 years ago Twig 2 years ago UpdateCheck 2 years ago Updater 2 years ago Updates 2 years ago Validators 2 years ago View 2 years ago ViewDataTable 2 years ago Visualization 2 years ago Widget 2 years ago .htaccess 2 years ago Access.php 2 years ago Archive.php 2 years ago ArchiveProcessor.php 2 years ago AssetManager.php 2 years ago Auth.php 2 years ago AuthResult.php 2 years ago BaseFactory.php 2 years ago Cache.php 2 years ago CacheId.php 2 years ago CliMulti.php 2 years ago Common.php 2 years ago Config.php 2 years ago Console.php 2 years ago Context.php 2 years ago Cookie.php 2 years ago CronArchive.php 2 years ago DI.php 2 years ago DataArray.php 2 years ago DataTable.php 2 years ago Date.php 2 years ago Db.php 2 years ago DbHelper.php 2 years ago Development.php 2 years ago ErrorHandler.php 2 years ago EventDispatcher.php 2 years ago ExceptionHandler.php 2 years ago FileIntegrity.php 2 years ago Filechecks.php 2 years ago Filesystem.php 2 years ago FrontController.php 2 years ago Http.php 2 years ago IP.php 2 years ago Log.php 2 years ago LogDeleter.php 2 years ago Mail.php 2 years ago Metrics.php 2 years ago NoAccessException.php 2 years ago Nonce.php 2 years ago Notification.php 2 years ago NumberFormatter.php 2 years ago Option.php 2 years ago Period.php 2 years ago Piwik.php 2 years ago Plugin.php 2 years ago Profiler.php 2 years ago ProxyHeaders.php 2 years ago ProxyHttp.php 2 years ago QuickForm2.php 2 years ago RankingQuery.php 2 years ago ReportRenderer.php 2 years ago Request.php 2 years ago Segment.php 2 years ago Sequence.php 2 years ago Session.php 2 years ago SettingsPiwik.php 2 years ago SettingsServer.php 2 years ago Singleton.php 2 years ago Site.php 2 years ago SiteContentDetector.php 2 years ago SupportedBrowser.php 2 years ago TCPDF.php 2 years ago Theme.php 2 years ago Timer.php 2 years ago Tracker.php 2 years ago Twig.php 2 years ago Unzip.php 2 years ago UpdateCheck.php 2 years ago Updater.php 2 years ago UpdaterErrorException.php 2 years ago Updates.php 2 years ago Url.php 2 years ago UrlHelper.php 2 years ago Version.php 2 years ago View.php 2 years ago bootstrap.php 2 years ago dispatch.php 2 years ago testMinimumPhpVersion.php 2 years ago

Console.php

255 lines

1	<?php
2
3	/**
4	* Matomo - free/libre analytics platform
5	*
6	* @link https://matomo.org
7	* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
8	*
9	*/
10	namespace Piwik;
11
12	use Exception;
13	use Matomo\Dependencies\Monolog\Handler\FingersCrossedHandler;
14	use Piwik\Application\Environment;
15	use Piwik\Config\ConfigNotFoundException;
16	use Piwik\Container\StaticContainer;
17	use Piwik\Plugin\Manager as PluginManager;
18	use Piwik\Plugins\Monolog\Handler\FailureLogMessageDetector;
19	use Piwik\Log\LoggerInterface;
20	use Matomo\Dependencies\Symfony\Bridge\Monolog\Handler\ConsoleHandler;
21	use Matomo\Dependencies\Symfony\Component\Console\Application;
22	use Matomo\Dependencies\Symfony\Component\Console\Command\Command;
23	use Matomo\Dependencies\Symfony\Component\Console\Input\InputInterface;
24	use Matomo\Dependencies\Symfony\Component\Console\Input\InputOption;
25	use Matomo\Dependencies\Symfony\Component\Console\Output\OutputInterface;
26	class Console extends Application
27	{
28	/**
29	* @var Environment
30	*/
31	private $environment;
32	public function __construct(Environment $environment = null)
33	{
34	$this->setServerArgsIfPhpCgi();
35	parent::__construct('Matomo', \Piwik\Version::VERSION);
36	$this->environment = $environment;
37	$option = new InputOption('matomo-domain', null, InputOption::VALUE_OPTIONAL, 'Matomo URL (protocol and domain) eg. "http://matomo.example.org"');
38	$this->getDefinition()->addOption($option);
39	$option = new InputOption('xhprof', null, InputOption::VALUE_NONE, 'Enable profiling with XHProf');
40	$this->getDefinition()->addOption($option);
41	$option = new InputOption('ignore-warn', null, InputOption::VALUE_NONE, 'Return 0 exit code even if there are warning logs or error logs detected in the command output.');
42	$this->getDefinition()->addOption($option);
43	}
44	public function renderThrowable(\Throwable $e, OutputInterface $output) : void
45	{
46	$logHandlers = StaticContainer::get('log.handlers');
47	$hasFingersCrossed = false;
48	foreach ($logHandlers as $handler) {
49	if ($handler instanceof FingersCrossedHandler) {
50	$hasFingersCrossed = true;
51	break;
52	}
53	}
54	if ($hasFingersCrossed && !$output->isVerbose()) {
55	$output->setVerbosity(OutputInterface::VERBOSITY_VERBOSE);
56	}
57	parent::renderThrowable($e, $output);
58	}
59	public function doRun(InputInterface $input, OutputInterface $output)
60	{
61	try {
62	return $this->doRunImpl($input, $output);
63	} catch (\Exception $ex) {
64	try {
65	\Piwik\FrontController::generateSafeModeOutputFromException($ex);
66	} catch (\Exception $ex) {
67	// ignore, we re-throw the original exception, not a wrapped one
68	}
69	throw $ex;
70	}
71	}
72	/**
73	* Makes parent doRun method available
74	*
75	* @param InputInterface $input
76	* @param OutputInterface $output
77	* @return int
78	*/
79	public function originDoRun(InputInterface $input, OutputInterface $output)
80	{
81	return parent::doRun($input, $output);
82	}
83	private function doRunImpl(InputInterface $input, OutputInterface $output)
84	{
85	if ($input->hasParameterOption('--xhprof')) {
86	\Piwik\Profiler::setupProfilerXHProf(true, true);
87	}
88	$this->initMatomoHost($input);
89	$this->initEnvironment($output);
90	$this->initLoggerOutput($output);
91	try {
92	self::initPlugins();
93	} catch (ConfigNotFoundException $e) {
94	// Piwik not installed yet, no config file?
95	\Piwik\Log::warning($e->getMessage());
96	}
97	$this->initAuth();
98	$commands = $this->getAvailableCommands();
99	foreach ($commands as $command) {
100	$this->addCommandIfExists($command);
101	}
102	$exitCode = null;
103	/**
104	* @ignore
105	*/
106	\Piwik\Piwik::postEvent('Console.doRun', [&$exitCode, $input, $output]);
107	if ($exitCode === null) {
108	$self = $this;
109	$exitCode = \Piwik\Access::doAsSuperUser(function () use($input, $output, $self) {
110	return call_user_func(array($self, 'originDoRun'), $input, $output);
111	});
112	}
113	$importantLogDetector = StaticContainer::get(FailureLogMessageDetector::class);
114	if (!$input->hasParameterOption('--ignore-warn') && $exitCode === 0 && $importantLogDetector->hasEncounteredImportantLog()) {
115	$output->writeln("Error: error or warning logs detected, exit 1");
116	$exitCode = 1;
117	}
118	return $exitCode;
119	}
120	private function addCommandIfExists($command)
121	{
122	if (!class_exists($command)) {
123	\Piwik\Log::warning(sprintf('Cannot add command %s, class does not exist', $command));
124	} elseif (!is_subclass_of($command, 'Piwik\\Plugin\\ConsoleCommand')) {
125	\Piwik\Log::warning(sprintf('Cannot add command %s, class does not extend Piwik\\Plugin\\ConsoleCommand', $command));
126	} else {
127	/** @var Command $commandInstance */
128	$commandInstance = new $command();
129	// do not add the command if it already exists; this way we can add the command ourselves in tests
130	if (!$this->has($commandInstance->getName())) {
131	$this->add($commandInstance);
132	}
133	}
134	}
135	/**
136	* Returns a list of available command classnames.
137	*
138	* @return string[]
139	*/
140	private function getAvailableCommands()
141	{
142	$commands = $this->getDefaultPiwikCommands();
143	$detected = PluginManager::getInstance()->findMultipleComponents('Commands', 'Piwik\\Plugin\\ConsoleCommand');
144	$commands = array_merge($commands, $detected);
145	/**
146	* Triggered to filter / restrict console commands. Plugins that want to restrict commands
147	* should subscribe to this event and remove commands from the existing list.
148	*
149	* Example
150	*
151	* public function filterConsoleCommands(&$commands)
152	* {
153	* $key = array_search('Piwik\Plugins\MyPlugin\Commands\MyCommand', $commands);
154	* if (false !== $key) {
155	* unset($commands[$key]);
156	* }
157	* }
158	*
159	* @param array &$commands An array containing a list of command class names.
160	*/
161	\Piwik\Piwik::postEvent('Console.filterCommands', array(&$commands));
162	$commands = array_values(array_unique($commands));
163	return $commands;
164	}
165	private function setServerArgsIfPhpCgi()
166	{
167	if (\Piwik\Common::isPhpCgiType()) {
168	$_SERVER['argv'] = array();
169	foreach ($_GET as $name => $value) {
170	$argument = $name;
171	if (!empty($value)) {
172	$argument .= '=' . $value;
173	}
174	$_SERVER['argv'][] = $argument;
175	}
176	if (!defined('STDIN')) {
177	define('STDIN', fopen('php://stdin', 'r'));
178	}
179	}
180	}
181	public static function isSupported()
182	{
183	return \Piwik\Common::isPhpCliMode() && !\Piwik\Common::isPhpCgiType();
184	}
185	protected function initMatomoHost(InputInterface $input)
186	{
187	$matomoHostname = $input->getParameterOption('--matomo-domain');
188	if (empty($matomoHostname)) {
189	$matomoHostname = $input->getParameterOption('--url');
190	}
191	$matomoHostname = \Piwik\UrlHelper::getHostFromUrl($matomoHostname);
192	\Piwik\Url::setHost($matomoHostname);
193	}
194	protected function initEnvironment(OutputInterface $output)
195	{
196	try {
197	if ($this->environment === null) {
198	$this->environment = new Environment('cli');
199	$this->environment->init();
200	}
201	$config = \Piwik\Config::getInstance();
202	return $config;
203	} catch (\Exception $e) {
204	$output->writeln($e->getMessage() . "\n");
205	}
206	}
207	/**
208	* Register the console output into the logger.
209	*
210	* Ideally, this should be done automatically with events:
211	* @see http://symfony.com/fr/doc/current/components/console/events.html
212	* @see Symfony\Bridge\Monolog\Handler\ConsoleHandler::onCommand()
213	* But it would require to install Symfony's Event Dispatcher.
214	*/
215	private function initLoggerOutput(OutputInterface $output)
216	{
217	/** @var ConsoleHandler $consoleLogHandler */
218	$consoleLogHandler = StaticContainer::get('Matomo\\Dependencies\\Symfony\\Bridge\\Monolog\\Handler\\ConsoleHandler');
219	$consoleLogHandler->setOutput($output);
220	}
221	public static function initPlugins()
222	{
223	\Piwik\Plugin\Manager::getInstance()->loadActivatedPlugins();
224	\Piwik\Plugin\Manager::getInstance()->loadPluginTranslations();
225	}
226	private function getDefaultPiwikCommands()
227	{
228	$commands = array('Piwik\\CliMulti\\RequestCommand');
229	$commandsFromPluginsMarkedInConfig = $this->getCommandsFromPluginsMarkedInConfig();
230	$commands = array_merge($commands, $commandsFromPluginsMarkedInConfig);
231	return $commands;
232	}
233	private function getCommandsFromPluginsMarkedInConfig()
234	{
235	$plugins = \Piwik\Config::getInstance()->General['always_load_commands_from_plugin'];
236	$plugins = explode(',', $plugins);
237	$commands = array();
238	foreach ($plugins as $plugin) {
239	$instance = new \Piwik\Plugin($plugin);
240	$commands = array_merge($commands, $instance->findMultipleComponents('Commands', 'Piwik\\Plugin\\ConsoleCommand'));
241	}
242	return $commands;
243	}
244	private function initAuth()
245	{
246	\Piwik\Piwik::postEvent('Request.initAuthenticationObject');
247	try {
248	StaticContainer::get('Piwik\\Auth');
249	} catch (Exception $e) {
250	$message = "Authentication object cannot be found in the container. Maybe the Login plugin is not activated?\n You can activate the plugin by adding:\n Plugins[] = Login\n under the [Plugins] section in your config/config.ini.php";
251	StaticContainer::get(LoggerInterface::class)->warning($message);
252	}
253	}
254	}
255