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

matomo / app / core / Console.php

matomo / app / core Last commit date

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

Console.php

258 lines

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