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

matomo / app / core / Console.php

matomo / app / core Last commit date

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

Console.php

256 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	* @return int
75	*/
76	public function originDoRun(InputInterface $input, OutputInterface $output)
77	{
78	return parent::doRun($input, $output);
79	}
80	private function doRunImpl(InputInterface $input, OutputInterface $output)
81	{
82	if ($input->hasParameterOption('--xhprof')) {
83	\Piwik\Profiler::setupProfilerXHProf(\true, \true);
84	}
85	$this->initMatomoHost($input);
86	$this->initEnvironment($output);
87	$this->initLoggerOutput($output);
88	try {
89	self::initPlugins();
90	} catch (ConfigNotFoundException $e) {
91	// Piwik not installed yet, no config file?
92	\Piwik\Log::warning($e->getMessage());
93	}
94	$this->initAuth();
95	$commands = $this->getAvailableCommands();
96	foreach ($commands as $command) {
97	$this->addCommandIfExists($command);
98	}
99	$exitCode = null;
100	/**
101	* @ignore
102	*/
103	\Piwik\Piwik::postEvent('Console.doRun', [&$exitCode, $input, $output]);
104	if ($exitCode === null) {
105	$self = $this;
106	/*
107	* Ensure to run console command with super user permission. Otherwise any permission check would fail,
108	* as we do not have any user session or authentication in place.
109	*/
110	$exitCode = \Piwik\Access::doAsSuperUser(function () use($input, $output, $self) {
111	return call_user_func(array($self, 'originDoRun'), $input, $output);
112	});
113	}
114	$importantLogDetector = StaticContainer::get(FailureLogMessageDetector::class);
115	if (!$input->hasParameterOption('--ignore-warn') && $exitCode === 0 && $importantLogDetector->hasEncounteredImportantLog()) {
116	$output->writeln("Error: error or warning logs detected, exit 1");
117	$exitCode = 1;
118	}
119	return $exitCode;
120	}
121	private function addCommandIfExists($command)
122	{
123	if (!class_exists($command)) {
124	\Piwik\Log::warning(sprintf('Cannot add command %s, class does not exist', $command));
125	} elseif (!is_subclass_of($command, 'Piwik\\Plugin\\ConsoleCommand')) {
126	\Piwik\Log::warning(sprintf('Cannot add command %s, class does not extend Piwik\\Plugin\\ConsoleCommand', $command));
127	} else {
128	/** @var Command $commandInstance */
129	$commandInstance = new $command();
130	// do not add the command if it already exists; this way we can add the command ourselves in tests
131	if (!$this->has($commandInstance->getName())) {
132	$this->add($commandInstance);
133	}
134	}
135	}
136	/**
137	* Returns a list of available command classnames.
138	*
139	* @return string[]
140	*/
141	private function getAvailableCommands()
142	{
143	$commands = $this->getDefaultPiwikCommands();
144	$detected = PluginManager::getInstance()->findMultipleComponents('Commands', 'Piwik\\Plugin\\ConsoleCommand');
145	$commands = array_merge($commands, $detected);
146	/**
147	* Triggered to filter / restrict console commands. Plugins that want to restrict commands
148	* should subscribe to this event and remove commands from the existing list.
149	*
150	* Example
151	*
152	* public function filterConsoleCommands(&$commands)
153	* {
154	* $key = array_search('Piwik\Plugins\MyPlugin\Commands\MyCommand', $commands);
155	* if (false !== $key) {
156	* unset($commands[$key]);
157	* }
158	* }
159	*
160	* @param array &$commands An array containing a list of command class names.
161	*/
162	\Piwik\Piwik::postEvent('Console.filterCommands', array(&$commands));
163	$commands = array_values(array_unique($commands));
164	return $commands;
165	}
166	private function setServerArgsIfPhpCgi()
167	{
168	if (\Piwik\Common::isPhpCgiType()) {
169	$_SERVER['argv'] = array();
170	foreach ($_GET as $name => $value) {
171	$argument = $name;
172	if (!empty($value)) {
173	$argument .= '=' . $value;
174	}
175	$_SERVER['argv'][] = $argument;
176	}
177	if (!defined('STDIN')) {
178	define('STDIN', fopen('php://stdin', 'r'));
179	}
180	}
181	}
182	public static function isSupported()
183	{
184	return \Piwik\Common::isPhpCliMode() && !\Piwik\Common::isPhpCgiType();
185	}
186	protected function initMatomoHost(InputInterface $input)
187	{
188	$matomoHostname = $input->getParameterOption('--matomo-domain');
189	if (empty($matomoHostname)) {
190	$matomoHostname = $input->getParameterOption('--url');
191	}
192	$matomoHostname = \Piwik\UrlHelper::getHostFromUrl($matomoHostname);
193	\Piwik\Url::setHost($matomoHostname);
194	}
195	protected function initEnvironment(OutputInterface $output)
196	{
197	try {
198	if ($this->environment === null) {
199	$this->environment = new Environment('cli');
200	$this->environment->init();
201	}
202	$config = \Piwik\Config::getInstance();
203	return $config;
204	} catch (\Exception $e) {
205	$output->writeln($e->getMessage() . "\n");
206	}
207	}
208	/**
209	* Register the console output into the logger.
210	*
211	* Ideally, this should be done automatically with events:
212	* @see https://symfony.com/fr/doc/current/components/console/events.html
213	* @see Symfony\Bridge\Monolog\Handler\ConsoleHandler::onCommand()
214	* But it would require to install Symfony's Event Dispatcher.
215	*/
216	private function initLoggerOutput(OutputInterface $output)
217	{
218	/** @var ConsoleHandler $consoleLogHandler */
219	$consoleLogHandler = StaticContainer::get('Matomo\\Dependencies\\Symfony\\Bridge\\Monolog\\Handler\\ConsoleHandler');
220	$consoleLogHandler->setOutput($output);
221	}
222	public static function initPlugins()
223	{
224	\Piwik\Plugin\Manager::getInstance()->loadActivatedPlugins();
225	\Piwik\Plugin\Manager::getInstance()->loadPluginTranslations();
226	}
227	private function getDefaultPiwikCommands()
228	{
229	$commands = array('Piwik\\CliMulti\\RequestCommand');
230	$commandsFromPluginsMarkedInConfig = $this->getCommandsFromPluginsMarkedInConfig();
231	$commands = array_merge($commands, $commandsFromPluginsMarkedInConfig);
232	return $commands;
233	}
234	private function getCommandsFromPluginsMarkedInConfig()
235	{
236	$plugins = \Piwik\Config::getInstance()->General['always_load_commands_from_plugin'];
237	$plugins = explode(',', $plugins);
238	$commands = array();
239	foreach ($plugins as $plugin) {
240	$instance = new \Piwik\Plugin($plugin);
241	$commands = array_merge($commands, $instance->findMultipleComponents('Commands', 'Piwik\\Plugin\\ConsoleCommand'));
242	}
243	return $commands;
244	}
245	private function initAuth()
246	{
247	\Piwik\Piwik::postEvent('Request.initAuthenticationObject');
248	try {
249	StaticContainer::get('Piwik\\Auth');
250	} catch (Exception $e) {
251	$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";
252	StaticContainer::get(LoggerInterface::class)->warning($message);
253	}
254	}
255	}
256