store backup of config.ini.php file contents in DB in case the local file gets deleted for some reason

app/bootstrap.php

@@ -194,7 +194,6 @@ function matomo_log_message_no_display($message)
 	}
 }
 
-
 if ( matomo_is_app_request() ) {
 	// pretend we are in the admin... potentially avoiding caching etc
 	$GLOBALS['hook_suffix'] = '';
@@ -222,45 +221,15 @@ function matomo_log_message_no_display($message)
 	}
 }
 
-$GLOBALS['MATOMO_MODIFY_CONFIG_SETTINGS'] = function ($settings) {
-	$plugins = $settings['Plugins'];
-	if (is_array($settings['Plugins'])) {
-		$pluginsToRemove = array('Marketplace', 'MultiSites', 'TwoFactorAuth', 'Widgetize', 'Feedback', 'ExamplePlugin', 'ExampleAPI', 'MobileAppMeasurable', 'CustomPiwikJs');
-		foreach ($pluginsToRemove as $pluginToRemove) {
-			// Marketplace => this is instead done in wordpress
-			// MultiSites => doesn't really make sense since we have only one website per installation
-			// TwoFactorAuth => not needed as login is being handled by WordPress
-			// widgetize for now we don't want to allow widgetizing as it is based on the token_auth authentication
-			// Monolog => we use our own logger
-			// ProfessionalServices => we advertise in the WP plugin itself instead
-			// feedback => we want to hide things like Need help in the admin etc
-			// MobileAppMeasurable => for WP mobile apps are not a thing
-			// custom variables we don't want to enable as we will deprecate them in Matomo 4 anyway => used to be disabled but we need to make sure the columns get installed otherwise matomo has issues... need to wait to matomo 4 to remove it
-			$pos = array_search($pluginToRemove, $plugins['Plugins']);
-			if ($pos !== false) {
-				array_splice($plugins['Plugins'], $pos, 1);
-			}
-		}
-		if (matomo_has_tag_manager()) {
-			$plugins['Plugins'][] = 'TagManager';
-		}
-		$mustEnable = ['BulkTracking', 'CustomJsTracker'];
-		foreach ($mustEnable as $enable) {
-			if (!in_array($enable, $plugins['Plugins'])) {
-				$plugins['Plugins'][] = $enable;
-			}
-		}
-	}
-	if (!empty($GLOBALS['MATOMO_PLUGINS_ENABLED'])) {
-		foreach ($GLOBALS['MATOMO_PLUGINS_ENABLED'] as $plugin) {
-			if (!in_array($plugin, $plugins['Plugins'])) {
-				$plugins['Plugins'][] = $plugin;
-			}
-		}
-	}
-	if (!empty($GLOBALS['MATOMO_MARKETPLACE_PLUGINS'])) {
-		matomo_filter_incompatible_plugins($plugins['Plugins']);
-	}
-	$settings['Plugins'] = $plugins;
-	return $settings;
-};
+// use a WordPress specific Matomo Environment subclass so the WordPress GlobalSettingsProvider is
+// used. core Matomo entry points are patched to instantiate WordPressEnvironment (see
+// patches/prefixed/wordpress-environment.diff).
+//
+// at this point the composer autoloader is not included yet, so make sure the classes these
+// entry points reference are loaded before they run.
+if (!defined('PIWIK_INCLUDE_PATH')) {
+	define('PIWIK_INCLUDE_PATH', PIWIK_DOCUMENT_ROOT);
+}
+require_once PIWIK_DOCUMENT_ROOT . '/vendor/autoload.php';
+require_once __DIR__ . '/../plugins/WordPress/Overrides/GlobalSettingsProvider.php';
+require_once __DIR__ . '/../plugins/WordPress/WordPressEnvironment.php';

app/core/CliMulti/RequestCommand.php

@@ -92,7 +92,7 @@ private function recreateContainerWithWebEnvironment()
     {
         StaticContainer::clearContainer();
         Log::unsetInstance();
-        $this->environment = new Environment(null);
+        $this->environment = new \Piwik\Plugins\WordPress\WordPressEnvironment(null);
         $this->environment->init();
     }
     private function resetDatabase()

app/core/Console.php

@@ -196,7 +196,7 @@ protected function initEnvironment(OutputInterface $output)
     {
         try {
             if ($this->environment === null) {
-                $this->environment = new Environment('cli');
+                $this->environment = new \Piwik\Plugins\WordPress\WordPressEnvironment('cli');
                 $this->environment->init();
             }
             $config = \Piwik\Config::getInstance();

app/core/dispatch.php

@@ -19,7 +19,7 @@
         \define('PIWIK_ENABLE_DISPATCH', \true);
     }
     if (\PIWIK_ENABLE_DISPATCH) {
-        $environment = new \Piwik\Application\Environment(null);
+        $environment = new \Piwik\Plugins\WordPress\WordPressEnvironment(null);
         $environment->init();
         $controller = FrontController::getInstance();
         try {

app/js/tracker.php

@@ -67,7 +67,7 @@ class Validator {
     public function validate() {}
 }
 $validator = new Validator();
-$environment = new \Piwik\Application\Environment(null, array(
+$environment = new \Piwik\Plugins\WordPress\WordPressEnvironment(null, array(
     'Piwik\Application\Kernel\EnvironmentValidator' => $validator
 ));
 $environment->init();

app/piwik.php

@@ -46,7 +46,7 @@
     require_once \PIWIK_INCLUDE_PATH . '/core/Cookie.php';
     require_once \PIWIK_INCLUDE_PATH . '/core/API/CORSHandler.php';
     SettingsServer::setIsTrackerApiRequest();
-    $environment = new \Piwik\Application\Environment('tracker');
+    $environment = new \Piwik\Plugins\WordPress\WordPressEnvironment('tracker');
     try {
         $environment->init();
     } catch (\Piwik\Exception\NotYetInstalledException $e) {

classes/WpMatomo/API.php

@@ -55,6 +55,7 @@ public function register_routes() {
 		$this->register_route( 'CoreAdminHome', 'invalidateArchivedReports' );
 		$this->register_route( 'CoreAdminHome', 'runScheduledTasks' );
 		$this->register_route( 'CoreAdminHome', 'runCronArchiving' );
+		$this->register_route( 'CorePluginsAdmin', 'setSystemSettings' );
 		$this->register_route( 'Dashboard', 'getDashboards' );
 		$this->register_route( 'ImageGraph', 'get' );
 		$this->register_route( 'VisitsSummary', 'getVisits' );
@@ -155,9 +156,6 @@ public function to_snake_case( $method ) {
 		return implode( '_', $snake_case );
 	}
 
-	/**
-	 * @api
-	 */
 	public function register_route( $api_module, $api_method ) {
 		$methods                 = [
 			'get'        => 'GET',
@@ -170,6 +168,7 @@ public function register_route( $api_module, $api_method ) {
 			'run'        => 'POST',
 			'send'       => 'POST',
 			'publish'    => 'POST',
+			'set'        => 'POST',
 			'delete'     => 'DELETE',
 			'remove'     => 'DELETE',
 		];

classes/WpMatomo/Admin/PluginSuggestions/PluginSuggestions.php

@@ -40,6 +40,10 @@ public function register_hooks() {
 
 		add_action( 'admin_enqueue_scripts', [ $this, 'load_scripts' ] );
 
+		add_action( 'init', [ $this, 'register_suggestion_hooks' ] );
+	}
+
+	public function register_suggestion_hooks() {
 		foreach ( $this->get_suggestions() as $suggestion ) {
 			$suggestion->register_hooks();
 		}

classes/WpMatomo/Admin/SystemReport.php

@@ -75,8 +75,10 @@ class SystemReport implements MatomoPageContent {
 	const TROUBLESHOOT_UPDATE_GEOIP_DB    = 'matomo_troubleshooting_action_update_geoipdb';
 	const TROUBLESHOOT_CLEAR_LOGS         = 'matomo_troubleshooting_action_clear_logs';
 	const TROUBLESHOOT_RUN_UPDATER        = 'matomo_troubleshooting_action_run_updater';
-	const REGENERATE_TRACKING_CODE        = 'matomo_troubleshooting_action_regen_tracking_code';
-	const RUN_SCHEDULED_TASK              = 'matomo_troubleshooting_action_run_task';
+
+	const TROUBLESHOOT_DISMISS_SALT_REGENERATED = 'matomo_troubleshooting_action_dismiss_salt_regenerated';
+	const REGENERATE_TRACKING_CODE              = 'matomo_troubleshooting_action_regen_tracking_code';
+	const RUN_SCHEDULED_TASK                    = 'matomo_troubleshooting_action_run_task';
 
 	private $not_compatible_plugins = [
 		'minify-html-markup',
@@ -196,6 +198,10 @@ private function execute_troubleshoot_if_needed() {
 				$this->logger->clear_logged_exceptions();
 			}
 
+			if ( ! empty( $_POST[ self::TROUBLESHOOT_DISMISS_SALT_REGENERATED ] ) ) {
+				$this->settings->set_time_salt_was_regenerated( 0 );
+			}
+
 			if ( ! $this->settings->is_network_enabled() || ! is_network_admin() ) {
 				if ( ! empty( $_POST[ self::TROUBLESHOOT_SYNC_USERS ] ) ) {
 					$sync = new UserSync();
@@ -366,6 +372,7 @@ public function show() {
 		$matomo_has_exception_logs        = [];
 		$matomo_has_warning_and_no_errors = false;
 		$matomo_scheduled_tasks           = [];
+		$matomo_salt_was_regenerated      = $this->settings->get_time_salt_was_regenerated() > 0;
 
 		if ( empty( $matomo_active_tab ) ) { // system report
 			// phpcs:ignore WordPress.PHP.DevelopmentFunctions.prevent_path_disclosure_error_reporting
@@ -585,6 +592,19 @@ private function get_matomo_info() {
 		$path_config_file = $paths->get_config_ini_path();
 		$rows             = $this->check_file_exists_and_writable( $rows, $path_config_file, 'Config', true );
 
+		$salt_regenerated_time = $this->settings->get_time_salt_was_regenerated();
+		if ( $salt_regenerated_time > 0 ) {
+			$rows[] = [
+				'name'       => esc_html__( 'Matomo salt was regenerated during a config file recovery', 'matomo' ),
+				'value'      => $this->convert_time_to_date( $salt_regenerated_time, true, true ),
+				'is_warning' => true,
+				'comment'    => esc_html__(
+					'The Matomo config file (config.ini.php) went missing or was corrupted, and was automatically recovered from the backup kept in the WordPress database. The original "salt" setting could not be recovered, however, so a new one was generated. This has the following consequences for your install: visitors who opted out of tracking through the Matomo opt-out feature are being tracked again, because their opt-out cookie is no longer recognized — consider informing your users to renew their opt-out, since being able to refuse tracking may be legally required depending on your jurisdiction (eg. GDPR/ePrivacy). Additionally, visits that were ongoing at the time of the recovery may appear split in two in your reports.',
+					'matomo'
+				),
+			];
+		}
+
 		$path_tracker_file = $paths->get_matomo_js_upload_path();
 		$rows              = $this->check_file_exists_and_writable( $rows, $path_tracker_file, 'JS Tracker', false );
 

classes/WpMatomo/Admin/views/systemreport.php

@@ -212,6 +212,14 @@ class='button-primary'
 				<br/><br/>
 			<?php } ?>
 
+			<?php if ( ! empty( $matomo_salt_was_regenerated ) ) { ?>
+				<input name="<?php echo esc_attr( SystemReport::TROUBLESHOOT_DISMISS_SALT_REGENERATED ); ?>" type="submit"
+					   class='button-primary'
+					   title="<?php esc_attr_e( 'Removes the system report warning about the Matomo salt having been regenerated during a config file recovery.', 'matomo' ); ?>"
+					   value="<?php esc_html_e( 'Dismiss salt regeneration warning', 'matomo' ); ?>">
+				<br/><br/>
+			<?php } ?>
+
 			<input name="<?php echo esc_attr( SystemReport::TROUBLESHOOT_UPDATE_GEOIP_DB ); ?>" type="submit"
 				   class='button-primary'
 				   title="<?php esc_attr_e( 'Updates the geolocation database which is used to detect the location (city/region/country) of visitors. This task is performed automatically. If the geolocation DB is not loaded or updated, you may need to trigger it manually to find the error which is causing it.', 'matomo' ); ?>"

classes/WpMatomo/Bootstrap.php

@@ -9,7 +9,7 @@
 
 namespace WpMatomo;
 
-use Piwik\Application\Environment;
+use Piwik\Plugins\WordPress\WordPressEnvironment;
 use Piwik\Cache;
 use Piwik\Container\StaticContainer;
 use Piwik\FrontController;
@@ -104,7 +104,7 @@ public static function bootstrap_environment() {
 
 		include_once 'Db/WordPress.php';
 
-		$environment = new Environment( null, self::$extra_di_definitions );
+		$environment = new WordPressEnvironment( null, self::$extra_di_definitions );
 		$environment->init();
 
 		self::$environment_bootstrapped = true;

classes/WpMatomo/Installer.php

@@ -20,6 +20,7 @@
 use Piwik\Plugin\API as PluginApi;
 use Piwik\Plugin\Manager;
 use Piwik\Plugins\SitesManager\Model;
+use Piwik\Plugins\WordPress\Overrides\GlobalSettingsProvider;
 use Piwik\SettingsPiwik;
 use Piwik\Singleton;
 use WpMatomo\Site\Sync;
@@ -114,7 +115,10 @@ public function install() {
 
 			Bootstrap::bootstrap_environment();
 
-			if ( ! SettingsPiwik::isMatomoInstalled() || ! $this->looks_like_it_is_installed() ) {
+			if (
+				! SettingsPiwik::isMatomoInstalled()
+				|| ! $this->looks_like_it_is_installed()
+			) {
 				throw new NotYetInstalledException( 'Not yet installed' );
 			}
 
@@ -148,7 +152,7 @@ public function install() {
 			if ( ! $this->is_environment_set_up() ) {
 				try {
 					$this->logger->log( 'Matomo will now init the environment' );
-					$environment = new \Piwik\Application\Environment( null, Bootstrap::get_extra_di_definitions() );
+					$environment = new \Piwik\Plugins\WordPress\WordPressEnvironment( null, Bootstrap::get_extra_di_definitions() );
 					$environment->init();
 				} catch ( Exception $e ) {
 					$this->logger->log( 'Ignoring error environment init' );
@@ -299,18 +303,25 @@ private function create_db() {
 		return $db_infos;
 	}
 
-	private function create_config( $db_info ) {
-		$this->logger->log( 'Matomo is now creating the config' );
+	public static function get_trusted_host_from_wp_url() {
 		$home_url = home_url();
-		$domain   = wp_parse_url( $home_url, PHP_URL_HOST );
-		if ( $domain ) {
-			$port = wp_parse_url( $home_url, PHP_URL_PORT );
-			if ( $port ) {
-				$domain .= ':' . $port;
-			}
-		} else {
-			$domain = $home_url;
+
+		$domain = wp_parse_url( $home_url, PHP_URL_HOST );
+		if ( ! $domain ) {
+			return $home_url;
 		}
+
+		$port = wp_parse_url( $home_url, PHP_URL_PORT );
+		if ( $port ) {
+			$domain .= ':' . $port;
+		}
+
+		return $domain;
+	}
+
+	private function create_config( $db_info ) {
+		$this->logger->log( 'Matomo is now creating the config' );
+		$domain  = self::get_trusted_host_from_wp_url();
 		$general = [
 			'trusted_hosts' => [ $domain ],
 			'salt'          => Common::generateUniqId(),
@@ -333,6 +344,14 @@ private function create_config( $db_info ) {
 		$config->database = array_merge( $db_default, $db_info );
 		// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
 		$config->General = array_merge( $general_default, $general );
+
+		// add the end-of-file marker used to detect interrupted writes to config.ini.php; it must
+		// exist in every config file (see GlobalSettingsProvider). skip it when the config backup
+		// feature is disabled, so the file is not modified for admins managing it themselves.
+		if ( ! Settings::is_config_backup_disabled() ) {
+			GlobalSettingsProvider::addEndOfFileMarkerSectionTo( $config );
+		}
+
 		$config->forceSave();
 
 		$mode = 0664;

classes/WpMatomo/ScheduledTasks.php

@@ -19,6 +19,7 @@
 use Piwik\Plugins\GeoIp2\LocationProvider\GeoIp2;
 use Piwik\Plugins\GeoIp2\LocationProvider\GeoIp2\Php;
 use Piwik\Plugins\UserCountry\LocationProvider;
+use Piwik\Plugins\WordPress\Overrides\GlobalSettingsProvider;
 use WpMatomo\Admin\Admin;
 use WpMatomo\Site\Sync as SiteSync;
 use WpMatomo\User\Sync as UserSync;
@@ -33,6 +34,7 @@ class ScheduledTasks extends Feature {
 	const EVENT_ARCHIVE            = 'matomo_scheduled_archive';
 	const EVENT_GEOIP              = 'matomo_scheduled_geoipdb';
 	const EVENT_UPDATE             = 'matomo_update_core';
+	const EVENT_CONFIG_MARKER      = 'matomo_scheduled_config_marker';
 
 	const KEY_BEFORE_CRON = 'before-cron-';
 	const KEY_AFTER_CRON  = 'after-cron-';
@@ -145,21 +147,26 @@ public function set_last_time_after_cron( $event_name, $time ) {
 
 	public function get_all_events() {
 		$events = [
-			self::EVENT_SYNC    => [
+			self::EVENT_SYNC          => [
 				'name'     => 'Sync users & sites',
 				'interval' => 'daily',
 				'method'   => 'sync',
 			],
-			self::EVENT_ARCHIVE => [
+			self::EVENT_ARCHIVE       => [
 				'name'     => 'Archive',
 				'interval' => 'hourly',
 				'method'   => 'archive',
 			],
-			self::EVENT_GEOIP   => [
+			self::EVENT_GEOIP         => [
 				'name'     => 'Update GeoIP DB',
 				'interval' => 'matomo_monthly',
 				'method'   => 'update_geo_ip2_db',
 			],
+			self::EVENT_CONFIG_MARKER => [
+				'name'     => 'Add config end of file marker',
+				'interval' => 'daily',
+				'method'   => 'add_config_end_of_file_marker',
+			],
 		];
 		if ( $this->settings->should_disable_addhandler() ) {
 			$events[ self::EVENT_DISABLE_ADDHANDLER ] = [
@@ -211,6 +218,26 @@ public function disable_add_handler( $force_undo = false ) {
 		}
 	}
 
+	/**
+	 * Adds the eof file marker used by the config backup system (see GlobalSettingsProvider).
+	 */
+	public function add_config_end_of_file_marker() {
+		if ( Settings::is_config_backup_disabled() ) {
+			return; // the marker only exists for the config backup feature
+		}
+
+		$this->remove_task_errors( [ 'config_backup' ] );
+
+		try {
+			Bootstrap::do_bootstrap();
+
+			$updater = new Updater( $this->settings );
+			$updater->add_config_end_of_file_marker_if_needed();
+		} catch ( Exception $e ) {
+			$this->on_task_fail( 'config_backup', $e, 'An error occurred when adding the end-of-file marker to config.ini.php.' );
+		}
+	}
+
 	private function check_try_update() {
 		try {
 			$installer = new Installer( $this->settings );