+
-
- {{ translate('Marketplace_TrialRequested') }}
-
@@ -170,6 +171,10 @@ export default defineComponent({
type: String,
required: true,
},
+ numUsers: {
+ type: Number,
+ required: true,
+ },
},
data(): PluginListState {
return {
diff --git a/app/vendor/composer/installed.php b/app/vendor/composer/installed.php
index f745e003c..dcc48948f 100644
--- a/app/vendor/composer/installed.php
+++ b/app/vendor/composer/installed.php
@@ -1,9 +1,9 @@
array(
'name' => 'matomo/matomo',
- 'pretty_version' => '5.1.0',
- 'version' => '5.1.0.0',
- 'reference' => 'd24cf65196940628cd95025d8c41a7f029c1eabd',
+ 'pretty_version' => '5.1.1',
+ 'version' => '5.1.1.0',
+ 'reference' => '11af37b46f21609a1c472e193ba4971a8e6cd14a',
'type' => 'project',
'install_path' => __DIR__ . '/../../',
'aliases' => array(),
@@ -103,9 +103,9 @@
'dev_requirement' => false,
),
'matomo/matomo' => array(
- 'pretty_version' => '5.1.0',
- 'version' => '5.1.0.0',
- 'reference' => 'd24cf65196940628cd95025d8c41a7f029c1eabd',
+ 'pretty_version' => '5.1.1',
+ 'version' => '5.1.1.0',
+ 'reference' => '11af37b46f21609a1c472e193ba4971a8e6cd14a',
'type' => 'project',
'install_path' => __DIR__ . '/../../',
'aliases' => array(),
diff --git a/app/vendor/prefixed/vendor/autoload.php b/app/vendor/prefixed/vendor/autoload.php
index fc402bc6f..c6be777f1 100644
--- a/app/vendor/prefixed/vendor/autoload.php
+++ b/app/vendor/prefixed/vendor/autoload.php
@@ -22,4 +22,4 @@
require_once __DIR__ . '/composer/autoload_real.php';
-return ComposerAutoloaderInit47b38957cb7abb837da5063f6a09e77a::getLoader();
+return ComposerAutoloaderInit69e2472aa6abd29b7e5b42ed20b91f70::getLoader();
diff --git a/app/vendor/prefixed/vendor/composer/autoload_real.php b/app/vendor/prefixed/vendor/composer/autoload_real.php
index f6ff0215e..24ce5ce29 100644
--- a/app/vendor/prefixed/vendor/composer/autoload_real.php
+++ b/app/vendor/prefixed/vendor/composer/autoload_real.php
@@ -2,7 +2,7 @@
// autoload_real.php @generated by Composer
-class ComposerAutoloaderInit47b38957cb7abb837da5063f6a09e77a
+class ComposerAutoloaderInit69e2472aa6abd29b7e5b42ed20b91f70
{
private static $loader;
@@ -22,16 +22,16 @@ public static function getLoader()
return self::$loader;
}
- spl_autoload_register(array('ComposerAutoloaderInit47b38957cb7abb837da5063f6a09e77a', 'loadClassLoader'), true, true);
+ spl_autoload_register(array('ComposerAutoloaderInit69e2472aa6abd29b7e5b42ed20b91f70', 'loadClassLoader'), true, true);
self::$loader = $loader = new \Composer\Autoload\ClassLoader(\dirname(__DIR__));
- spl_autoload_unregister(array('ComposerAutoloaderInit47b38957cb7abb837da5063f6a09e77a', 'loadClassLoader'));
+ spl_autoload_unregister(array('ComposerAutoloaderInit69e2472aa6abd29b7e5b42ed20b91f70', 'loadClassLoader'));
require __DIR__ . '/autoload_static.php';
- call_user_func(\Composer\Autoload\ComposerStaticInit47b38957cb7abb837da5063f6a09e77a::getInitializer($loader));
+ call_user_func(\Composer\Autoload\ComposerStaticInit69e2472aa6abd29b7e5b42ed20b91f70::getInitializer($loader));
$loader->register(true);
- $filesToLoad = \Composer\Autoload\ComposerStaticInit47b38957cb7abb837da5063f6a09e77a::$files;
+ $filesToLoad = \Composer\Autoload\ComposerStaticInit69e2472aa6abd29b7e5b42ed20b91f70::$files;
$requireFile = \Closure::bind(static function ($fileIdentifier, $file) {
if (empty($GLOBALS['__composer_autoload_files'][$fileIdentifier])) {
$GLOBALS['__composer_autoload_files'][$fileIdentifier] = true;
diff --git a/app/vendor/prefixed/vendor/composer/autoload_static.php b/app/vendor/prefixed/vendor/composer/autoload_static.php
index 44b580655..dd7a474a4 100644
--- a/app/vendor/prefixed/vendor/composer/autoload_static.php
+++ b/app/vendor/prefixed/vendor/composer/autoload_static.php
@@ -4,7 +4,7 @@
namespace Composer\Autoload;
-class ComposerStaticInit47b38957cb7abb837da5063f6a09e77a
+class ComposerStaticInit69e2472aa6abd29b7e5b42ed20b91f70
{
public static $files = array (
'57561443c5204a2081a57dea43ad4761' => __DIR__ . '/../..' . '/twig/twig/src/Resources/core.php',
@@ -951,7 +951,7 @@ class ComposerStaticInit47b38957cb7abb837da5063f6a09e77a
public static function getInitializer(ClassLoader $loader)
{
return \Closure::bind(function () use ($loader) {
- $loader->classMap = ComposerStaticInit47b38957cb7abb837da5063f6a09e77a::$classMap;
+ $loader->classMap = ComposerStaticInit69e2472aa6abd29b7e5b42ed20b91f70::$classMap;
}, null, ClassLoader::class);
}
diff --git a/assets/css/admin-style.css b/assets/css/admin-style.css
index 512f04d6d..9bff75670 100644
--- a/assets/css/admin-style.css
+++ b/assets/css/admin-style.css
@@ -1,9 +1,14 @@
-.matomo-tracking-form th {
- width: 30%;
+.matomo-tracking-form tr {
+ padding: 6px 0;
}
.matomo-tracking-form th {
width: 30%;
+ vertical-align: top;
+}
+
+.matomo-tracking-form th label {
+ vertical-align: baseline;
}
.matomo-systemreport-comment {
@@ -92,14 +97,67 @@ ol.matomo-list {
border: 0;
}
-#matomo_default_tracking_code {
- margin-top: 100px;
-}
-
#matomo_default_tracking_code textarea {
width: 100%;
- height: 140px;
+ height: 280px;
}
#matomo_default_tracking_code textarea.no_script {
height: 50px;
}
+
+table.matomo-tracking-form textarea {
+ display: inline-block;
+ width: 95%;
+}
+
+table.matomo-tracking-form th {
+ max-width: 30%;
+}
+
+/* toggle styles */
+.matomo-toggle {
+ position: relative;
+ display: inline-block;
+ width: 2.375em;
+ height: 1.345em;
+}
+.matomo-toggle input {
+ height: 0;
+ width: 0;
+ opacity: 0;
+}
+.matomo-toggle .slider {
+ position: absolute;
+ cursor: pointer;
+ top: 0;
+ left: 0;
+ right: 0;
+ bottom: 0;
+ background-color: #ccc;
+ -webkit-transition: .4s;
+ transition: .4s;
+ border-radius: 1.345em;
+}
+.matomo-toggle .slider:before {
+ position: absolute;
+ content: "";
+ height: 1.03em;
+ width: 1.03em;
+ left: .15835em;
+ bottom: .15835em;
+ background-color: white;
+ -webkit-transition: .4s;
+ transition: .4s;
+ border-radius: 50%;
+}
+.matomo-toggle input:checked + .slider {
+ background-color: #2271b1;
+}
+.matomo-toggle input:focus + .slider {
+ box-shadow: 0 0 1px #2271b1;
+}
+.matomo-toggle input:checked + .slider:before {
+ -webkit-transform: translateX(1.03em);
+ -ms-transform: translateX(1.03em);
+ transform: translateX(1.03em);
+}
diff --git a/assets/js/asset_manager_core_js.js b/assets/js/asset_manager_core_js.js
index 17426f630..09ca39c5c 100644
--- a/assets/js/asset_manager_core_js.js
+++ b/assets/js/asset_manager_core_js.js
@@ -1,4 +1,4 @@
-/* Matomo Javascript - cb=9eaa1e9b4cd3c91d97655fe7d9a09e09*/
+/* Matomo Javascript - cb=4767562f3e40726a4d4a7d951799bb82*/
/*!
* Matomo - free/libre analytics platform
diff --git a/assets/js/marketplace_setup_wizard.js b/assets/js/marketplace_setup_wizard.js
index 90791c2b1..5a26dba8a 100644
--- a/assets/js/marketplace_setup_wizard.js
+++ b/assets/js/marketplace_setup_wizard.js
@@ -12,8 +12,8 @@ window.jQuery(document).ready(function ($) {
var interval = setInterval(function () {
$.post(mtmMarketplaceWizardAjax.ajax_url, {
- _ajax_nonce: mtmMarketplaceWizardAjax.nonce,
- action: 'mtm_is_marketplace_active',
+ _ajax_nonce: mtmMarketplaceWizardAjax.is_active_nonce,
+ action: 'matomo_is_marketplace_active',
}, function (data) {
if (data.active) {
$('.wizard-waiting-for').hide();
@@ -33,8 +33,8 @@ window.jQuery(document).ready(function ($) {
$('.wizard-waiting-for').show();
$.post(mtmMarketplaceWizardAjax.ajax_url, {
- _ajax_nonce: mtmMarketplaceWizardAjax.nonce,
- action: 'mtm_activate_marketplace',
+ _ajax_nonce: mtmMarketplaceWizardAjax.activate_nonce,
+ action: 'matomo_activate_marketplace',
}, pollForPluginActivation);
}
diff --git a/assets/js/settings.js b/assets/js/settings.js
new file mode 100644
index 000000000..cf42c62a0
--- /dev/null
+++ b/assets/js/settings.js
@@ -0,0 +1,84 @@
+/**
+ * Matomo - free/libre analytics platform
+ *
+ * @link https://matomo.org
+ * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ * @package matomo
+ */
+
+window.jQuery(document).ready(function ($) {
+ // generated tracking code update
+ if (typeof mtmTrackingSettingsAjax !== 'undefined' && mtmTrackingSettingsAjax.ajax_url) {
+ var DEFAULT_DEBOUNCE_DELAY = 300;
+
+ function debounce(fn, delayInMs) {
+ var timeout;
+
+ delayInMs = delayInMs || DEFAULT_DEBOUNCE_DELAY;
+
+ return function wrapper() {
+ var args = Array.from(arguments);
+ if (timeout) {
+ clearTimeout(timeout);
+ }
+
+ timeout = setTimeout(() => {
+ fn.apply(this, args);
+ }, delayInMs);
+ };
+ }
+
+ function updateGeneratedTrackingCode() {
+ var settings = $('form#tracking-settings').serializeArray().reduce(function (accumulator, current) {
+ if (/^_/.test(current.name)) {
+ return accumulator;
+ }
+ accumulator[current.name.replace(/^matomo\[(.*?)\]$/, '$1')] = current.value;
+ return accumulator;
+ }, {});
+
+ $.post(
+ mtmTrackingSettingsAjax.ajax_url,
+ Object.assign(settings, {
+ _ajax_nonce: mtmTrackingSettingsAjax.nonce,
+ action: 'matomo_generate_tracking_code',
+ }),
+ function (data) {
+ if (data) {
+ $('#generated_tracking_code').text(data.script);
+ $('#generated_noscript_code').text(data.noscript);
+ }
+ },
+ );
+ }
+
+ updateGeneratedTrackingCode = debounce(updateGeneratedTrackingCode, 300);
+
+ $('#auto-tracking-settings').on('change', ':not(#generatedTrackingCode)', updateGeneratedTrackingCode);
+ updateGeneratedTrackingCode();
+ }
+
+ // warn if user has unsaved changes
+ var initialFormContents = $('#tracking-settings').serialize();
+ function beforePageUnload(e) {
+ var currentFormContents = $('#tracking-settings').serialize();
+ if (initialFormContents !== currentFormContents) {
+ e.preventDefault();
+ }
+ }
+
+ window.addEventListener('beforeunload', beforePageUnload);
+ $('form#tracking-settings').on('submit', function () {
+ window.removeEventListener('beforeunload', beforePageUnload);
+ });
+
+ // auto-expand section if hash points to section
+ function onHashChange() {
+ var target = $(window.location.hash);
+ if (target.length) {
+ target.closest('.collapsible-settings').addClass('expanded');
+ }
+ }
+ window.addEventListener('hashchange', onHashChange);
+ onHashChange();
+});
diff --git a/classes/WpMatomo.php b/classes/WpMatomo.php
index 210afe8dd..3031f8c35 100644
--- a/classes/WpMatomo.php
+++ b/classes/WpMatomo.php
@@ -64,6 +64,7 @@ public function __construct() {
}
add_action( 'init', [ $this, 'init_plugin' ] );
+ add_action( 'activated_plugin', [ $this, 'on_plugin_activated' ] );
$capabilities = new Capabilities( self::$settings );
$capabilities->register_hooks();
@@ -118,6 +119,10 @@ public function __construct() {
$plugin_admin_overrides = new PluginAdminOverrides( self::$settings );
$plugin_admin_overrides->register_hooks();
+
+ // TODO: need better way of doing ajax?
+ MarketplaceSetupWizard::register_ajax();
+ WpMatomo\Admin\TrackingSettings::register_ajax();
}
$tracking_code = new TrackingCode( self::$settings );
@@ -136,9 +141,6 @@ public function __construct() {
'add_settings_link',
]
);
-
- // TODO: need better way of doing ajax?
- MarketplaceSetupWizard::register_ajax();
}
private function check_compatibility() {
@@ -277,4 +279,11 @@ public static function is_async_archiving_manually_disabled() {
private static function is_async_archiving_disabled_by_setting() {
return self::$settings->is_async_archiving_disabled_by_option();
}
+
+ public function on_plugin_activated( $plugin ) {
+ if ( is_admin() && plugin_basename( MATOMO_ANALYTICS_FILE ) === $plugin ) {
+ wp_safe_redirect( home_url( '/wp-admin/admin.php?page=matomo-get-started' ) );
+ exit;
+ }
+ }
}
diff --git a/classes/WpMatomo/Admin/Admin.php b/classes/WpMatomo/Admin/Admin.php
index 3fa3f91fd..f3d6b8c96 100644
--- a/classes/WpMatomo/Admin/Admin.php
+++ b/classes/WpMatomo/Admin/Admin.php
@@ -33,7 +33,7 @@ public static function is_matomo_admin() {
}
public function load_scripts() {
- wp_enqueue_style( 'matomo_admin_css', plugins_url( 'assets/css/admin-style.css', MATOMO_ANALYTICS_FILE ), false, '1.0.0' );
+ wp_enqueue_style( 'matomo_admin_css', plugins_url( 'assets/css/admin-style.css', MATOMO_ANALYTICS_FILE ), false, '1.0.2' );
wp_enqueue_script( 'matomo_iframe_resizer', plugins_url( 'assets/js/iframeResizer.min.js', MATOMO_ANALYTICS_FILE ), [], '1.0', [ 'defer', false ] );
wp_enqueue_script(
diff --git a/classes/WpMatomo/Admin/MarketplaceSetupWizard.php b/classes/WpMatomo/Admin/MarketplaceSetupWizard.php
index cb1133009..a66cc20ac 100644
--- a/classes/WpMatomo/Admin/MarketplaceSetupWizard.php
+++ b/classes/WpMatomo/Admin/MarketplaceSetupWizard.php
@@ -10,7 +10,9 @@
namespace WpMatomo\Admin;
class MarketplaceSetupWizard {
- const MARKETPLACE_PLUGIN_FILE = 'matomo-marketplace-for-wordpress/matomo-marketplace-for-wordpress.php';
+ const MARKETPLACE_PLUGIN_FILE = 'matomo-marketplace-for-wordpress/matomo-marketplace-for-wordpress.php';
+ const AJAX_IS_ACTIVE_NONCE_NAME = 'matomo-marketplace-setup-wizard-is-active';
+ const AJAX_ACTIVATE_NONCE_NAME = 'matomo-marketplace-setup-wizard-activate';
public function __construct() {
$this->add_hooks();
@@ -49,22 +51,35 @@ private function enqueue_scripts() {
'matomo-marketplace-setup-wizard',
'mtmMarketplaceWizardAjax',
[
- 'ajax_url' => admin_url( 'admin-ajax.php' ),
- 'nonce' => wp_create_nonce( 'matomo-marketplace-setup-wizard' ),
+ 'ajax_url' => admin_url( 'admin-ajax.php' ),
+ 'is_active_nonce' => wp_create_nonce( self::AJAX_IS_ACTIVE_NONCE_NAME ),
+ 'activate_nonce' => wp_create_nonce( self::AJAX_ACTIVATE_NONCE_NAME ),
]
);
}
public static function register_ajax() {
- add_action( 'wp_ajax_mtm_is_marketplace_active', [ self::class, 'is_marketplace_active' ] );
- add_action( 'wp_ajax_mtm_activate_marketplace', [ self::class, 'activate_marketplace_plugin' ] );
+ add_action( 'wp_ajax_matomo_is_marketplace_active', [ self::class, 'is_marketplace_active' ] );
+ add_action( 'wp_ajax_matomo_activate_marketplace', [ self::class, 'activate_marketplace_plugin' ] );
}
public static function is_marketplace_active() {
+ check_ajax_referer( self::AJAX_IS_ACTIVE_NONCE_NAME );
+
+ if ( ! current_user_can( 'activate_plugins' ) ) {
+ wp_send_json_error( [ 'message' => 'forbidden' ], 403 );
+ }
+
wp_send_json( [ 'active' => is_plugin_active( self::MARKETPLACE_PLUGIN_FILE ) ] );
}
public static function activate_marketplace_plugin() {
+ check_ajax_referer( self::AJAX_ACTIVATE_NONCE_NAME );
+
+ if ( ! current_user_can( 'activate_plugins' ) ) {
+ wp_send_json_error( [ 'message' => 'forbidden' ], 403 );
+ }
+
activate_plugin( self::MARKETPLACE_PLUGIN_FILE );
wp_send_json( [] );
}
diff --git a/classes/WpMatomo/Admin/Menu.php b/classes/WpMatomo/Admin/Menu.php
index a85564004..b7a188a09 100644
--- a/classes/WpMatomo/Admin/Menu.php
+++ b/classes/WpMatomo/Admin/Menu.php
@@ -213,8 +213,8 @@ public function add_menu() {
}
add_submenu_page(
self::$parent_slug,
- __( 'About', 'matomo' ),
- __( 'About', 'matomo' ),
+ __( 'Help', 'matomo' ),
+ __( 'Help', 'matomo' ),
Capabilities::KEY_VIEW,
self::SLUG_ABOUT,
[
diff --git a/classes/WpMatomo/Admin/TrackingSettings.php b/classes/WpMatomo/Admin/TrackingSettings.php
index 260cc1feb..23dddbbca 100644
--- a/classes/WpMatomo/Admin/TrackingSettings.php
+++ b/classes/WpMatomo/Admin/TrackingSettings.php
@@ -14,22 +14,26 @@
use WpMatomo\Settings;
use WpMatomo\Site;
use WpMatomo\Site\Sync\SyncConfig as SiteConfigSync;
+use WpMatomo\TrackingCode\GeneratorOptions;
use WpMatomo\TrackingCode\TrackingCodeGenerator;
if ( ! defined( 'ABSPATH' ) ) {
exit; // if accessed directly
}
/**
- * @todo set up the nonce verification
+ * TODO: maybe we can move the form data collection to a single class
+ * Note: nonce verification exists, but phpcs can't tell since it's in a method
+ * that calls other methods that then access post data.
* phpcs:disable WordPress.Security.NonceVerification.Missing
*/
class TrackingSettings implements AdminSettingsInterface {
- const FORM_NAME = 'matomo';
- const NONCE_NAME = 'matomo_settings';
- const TRACK_MODE_DEFAULT = 'default';
- const TRACK_MODE_DISABLED = 'disabled';
- const TRACK_MODE_MANUALLY = 'manually';
- const TRACK_MODE_TAGMANAGER = 'tagmanager';
+ const FORM_NAME = 'matomo';
+ const NONCE_NAME = 'matomo_settings';
+ const TRACK_MODE_DEFAULT = 'default';
+ const TRACK_MODE_DISABLED = 'disabled';
+ const TRACK_MODE_MANUALLY = 'manually';
+ const TRACK_MODE_TAGMANAGER = 'tagmanager';
+ const NONCE_NAME_GENERATE_TRACKING_CODE_AJAX = 'matomo-tracking-settings-code';
/**
* @var Settings
@@ -41,6 +45,7 @@ class TrackingSettings implements AdminSettingsInterface {
*/
public function __construct( $settings ) {
$this->settings = $settings;
+ $this->add_hooks();
}
public function get_title() {
@@ -265,15 +270,58 @@ public function show_settings() {
$containers = $this->get_active_containers();
$track_modes = [
- self::TRACK_MODE_DISABLED => esc_html__( 'Disabled', 'matomo' ),
- self::TRACK_MODE_DEFAULT => esc_html__( 'Default tracking', 'matomo' ),
- self::TRACK_MODE_MANUALLY => esc_html__( 'Enter manually', 'matomo' ),
+ self::TRACK_MODE_DEFAULT => [
+ 'name' => esc_html__( 'Auto (recommended)', 'matomo' ),
+ 'disabled' => false,
+ ],
+ self::TRACK_MODE_MANUALLY => [
+ 'name' => esc_html__( 'Manual', 'matomo' ),
+ 'disabled' => false,
+ ],
+ self::TRACK_MODE_TAGMANAGER => [
+ 'name' => esc_html__( 'Tag Manager', 'matomo' ),
+ 'disabled' => false,
+ ],
+ self::TRACK_MODE_DISABLED => [
+ 'name' => esc_html__( 'Disabled', 'matomo' ),
+ 'disabled' => false,
+ ],
];
- if ( ! empty( $containers ) ) {
- $track_modes[ self::TRACK_MODE_TAGMANAGER ] = esc_html__( 'Tag Manager', 'matomo' );
+ $matomo_track_mode_descriptions = [
+ self::TRACK_MODE_DISABLED => esc_html__( 'Matomo will not add the tracking code itself. Use this mode if you want to add the tracking code by hand to your template files or you want to use another plugin to add the tracking code.', 'matomo' ),
+ self::TRACK_MODE_DEFAULT => esc_html__( 'Matomo will automatically generate and embed the tracking code based on the Auto Tracking settings below.', 'matomo' ) . ' ' . esc_html__( 'This is the recommended mode for most users.', 'matomo' ),
+ self::TRACK_MODE_MANUALLY => sprintf(
+ esc_html__( '%1$sDefine your own tracking JavaScript by hand below%2$s, and Matomo will embed it into your website.', 'matomo' ) . ( $settings->is_network_enabled() ? ' ' . esc_html__( 'Make sure to use the placeholder {ID} to add the Matomo site ID.', 'matomo' ) : '' ),
+ '',
+ ''
+ ),
+ self::TRACK_MODE_TAGMANAGER => esc_html__( 'If you\'ve created containers in the Tag Manager, you can use this tracking mode to embed one or more of them into your website automatically.', 'matomo' ),
+ ];
+
+ if ( empty( $containers ) ) {
+ $track_modes[ self::TRACK_MODE_TAGMANAGER ]['disabled'] = true;
+ $track_modes[ self::TRACK_MODE_TAGMANAGER ]['tooltip'] = esc_html__( 'No containers were found. Create one to be able to use the Tag Manager tracking mode.', 'matomo' );
+ $matomo_track_mode_descriptions[ self::TRACK_MODE_TAGMANAGER ] .= ' ' . esc_html__( 'This mode is not selectable since no containers have been created in the Tag Manager.', 'matomo' );
+ } else {
+ $container_select = ' %s '
+ . ''
+ . $desc,
+ ( $tooltip ? ' title="' . esc_attr( $tooltip ) . '"' : '' ),
+ $radio_id,
+ esc_attr( TrackingSettings::FORM_NAME ) . '[' . esc_attr( $id ) . ']',
+ esc_attr( $key ),
+ // phpcs:ignore WordPress.PHP.StrictComparisons.LooseComparison
+ ( $key == $default ? 'checked="checked"' : '' ),
+ ( $disabled ? 'disabled="disabled"' : '' ),
+ esc_attr( $on_change ),
+ $radio_id,
+ esc_html( $label )
+ );
+ }
+ }
+ $script_change = '';
+ if ( $on_change ) {
+ // we make sure it will select the right settings by default
+ $script_change .= '';
+ }
+ printf(
+ '',
+ esc_html( $name ),
+ $script_change,
+ esc_attr( $id ),
+ implode( is_array( $description ) ? '' : '
', $button_list ), + is_array( $description ) ? '' : $this->get_description( $id, $description, $hide_description ) + ); + } + /** * Show an info box * diff --git a/classes/WpMatomo/Admin/views/get_started.php b/classes/WpMatomo/Admin/views/get_started.php index 82e27f1e8..17e11c713 100644 --- a/classes/WpMatomo/Admin/views/get_started.php +++ b/classes/WpMatomo/Admin/views/get_started.php @@ -41,46 +41,65 @@ } ?> +
+ +
diff --git a/classes/WpMatomo/Admin/views/info.php b/classes/WpMatomo/Admin/views/info.php
index 47246a456..73343e4ee 100644
--- a/classes/WpMatomo/Admin/views/info.php
+++ b/classes/WpMatomo/Admin/views/info.php
@@ -21,12 +21,21 @@
+
+
+ {{ translate('Marketplace_AddToCart') }}
+ 
+ `${variation.name} - ${variation.prettyPrice} / ${variation.period}`,
+ );
+ },
+ pluginShopRecommendedVariation(): IPluginShopVariation | null {
+ const recommendedVariations = this.pluginShopVariations.filter((v) => v.recommended);
+ const defaultVariation = this.pluginShopVariations.length
+ ? this.pluginShopVariations[0]
+ : null;
+ return recommendedVariations.length ? recommendedVariations[0] : defaultVariation;
+ },
+ selectedPluginShopVariationUrl(): string {
+ return this.currentPluginShopVariationUrl
+ ? this.currentPluginShopVariationUrl
+ : this.pluginShopRecommendedVariation?.addToCartUrl || '';
+ },
+ selectedShopVariationUrl(): string {
+ return this.selectedPluginShopVariationUrl || '';
+ },
},
methods: {
+ changeSelectedPluginShopVariationUrl(event: ChangeEvent) {
+ if (event) {
+ this.currentPluginShopVariationUrl = event.target.value;
+ }
+ },
applyExternalTarget() {
setTimeout(() => {
const root = this.$refs.root as HTMLElement;
diff --git a/app/plugins/Marketplace/vue/src/PluginList/CTAContainer.vue b/app/plugins/Marketplace/vue/src/PluginList/CTAContainer.vue
index 8f5d85107..7b0bc93f8 100644
--- a/app/plugins/Marketplace/vue/src/PluginList/CTAContainer.vue
+++ b/app/plugins/Marketplace/vue/src/PluginList/CTAContainer.vue
@@ -83,14 +83,17 @@
- {{ translate('Marketplace_StartFreeTrial') }}
+ >{{ translate('Marketplace_StartFreeTrial') }}
+
+
-
+
+
{{ translate('Marketplace_TryFreeTrialTitle') }}
+
+ `${variation.name} - ${variation.prettyPrice} / ${variation.period}`,
+ );
+ },
+ pluginShopRecommendedVariation(): IPluginShopVariation | null {
+ const recommendedVariations = this.pluginShopVariations.filter((v) => v.recommended);
+ const defaultVariation = this.pluginShopVariations.length
+ ? this.pluginShopVariations[0]
+ : null;
+ return recommendedVariations.length ? recommendedVariations[0] : defaultVariation;
+ },
+ selectedPluginShopVariationUrl(): string {
+ return this.currentPluginShopVariationUrl
+ ? this.currentPluginShopVariationUrl
+ : this.pluginShopRecommendedVariation?.addToCartUrl || '';
+ },
+ selectedShopVariationUrl(): string {
+ return this.selectedPluginShopVariationUrl || '';
+ },
},
methods: {
+ changeSelectedPluginShopVariationUrl(event: ChangeEvent) {
+ if (event) {
+ this.currentPluginShopVariationUrl = event.target.value;
+ }
+ },
applyExternalTarget() {
setTimeout(() => {
const root = this.$refs.root as HTMLElement;
diff --git a/app/plugins/Marketplace/vue/src/PluginList/CTAContainer.vue b/app/plugins/Marketplace/vue/src/PluginList/CTAContainer.vue
index 8f5d85107..7b0bc93f8 100644
--- a/app/plugins/Marketplace/vue/src/PluginList/CTAContainer.vue
+++ b/app/plugins/Marketplace/vue/src/PluginList/CTAContainer.vue
@@ -83,14 +83,17 @@
'
+ . '';
+
+ $selected_container_ids = $settings->get_global_option( 'tagmanger_container_ids' );
+ foreach ( $containers as $container_id => $container_name ) {
+ $container_select .= ' ' . esc_html( $container_name ) . ' (ID: ' . esc_html( $container_id ) . ')
'; + } + + $container_select .= 'Edit containers '; + $container_select .= '
';
+
+ $matomo_track_mode_descriptions[ self::TRACK_MODE_TAGMANAGER ] .= $container_select;
}
+ $matomo_track_mode_descriptions[ self::TRACK_MODE_TAGMANAGER ] .= '' . esc_html__( 'Read our documentation on the Matomo Tag Manager to learn more.', 'matomo' ) . '';
+
+ // /var/www/html/test/wp-content/uploads/wp-statistics/GeoLite2-City.mmdb
$site = new Site();
$idsite = $site->get_current_matomo_site_id();
@@ -281,9 +329,11 @@ public function show_settings() {
$cookie_consent_modes = $this->get_cookie_consent_modes();
- $tracking_code_generator = new TrackingCodeGenerator( $this->settings );
+ $tracking_code_generator = new TrackingCodeGenerator( $this->settings, new GeneratorOptions( $this->settings ) );
$matomo_default_tracking_code = $tracking_code_generator->prepare_tracking_code( $idsite );
+ $matomo_exclusion_settings_url = home_url( '/wp-admin/admin.php?page=matomo-settings&tab=exlusions' );
+
include dirname( __FILE__ ) . '/views/tracking.php';
}
@@ -332,4 +382,73 @@ public function get_active_containers() {
return $by_id;
}
+
+ private function add_hooks() {
+ add_action(
+ 'admin_enqueue_scripts',
+ function ( $page ) {
+ if ( 'matomo-analytics_page_matomo-settings' !== $page ) {
+ return;
+ }
+
+ wp_enqueue_script(
+ 'matomo-tracking-settings',
+ plugins_url( '/assets/js/settings.js', MATOMO_ANALYTICS_FILE ),
+ [ 'jquery' ],
+ '1.0.1',
+ true
+ );
+
+ wp_localize_script(
+ 'matomo-tracking-settings',
+ 'mtmTrackingSettingsAjax',
+ [
+ 'ajax_url' => admin_url( 'admin-ajax.php' ),
+ 'nonce' => wp_create_nonce( self::NONCE_NAME_GENERATE_TRACKING_CODE_AJAX ),
+ ]
+ );
+ }
+ );
+ }
+
+ public static function register_ajax() {
+ add_action( 'wp_ajax_matomo_generate_tracking_code', [ self::class, 'generate_tracking_code' ] );
+ }
+
+ public static function generate_tracking_code() {
+ check_ajax_referer( self::NONCE_NAME_GENERATE_TRACKING_CODE_AJAX );
+
+ $blog_id = get_current_blog_id();
+ $idsite = Site::get_matomo_site_id( $blog_id );
+
+ // phpcs complains if reading from $_POST is not done this way
+ $overrides = [
+ 'track_datacfasync' => isset( $_POST['track_datacfasync'] ) ? ( boolval( wp_unslash( $_POST['track_datacfasync'] ) ) ) : false,
+ 'track_content' => isset( $_POST['track_content'] ) ? ( sanitize_text_field( wp_unslash( $_POST['track_content'] ) ) ) : '',
+ 'track_heartbeat' => isset( $_POST['track_heartbeat'] ) ? ( intval( wp_unslash( $_POST['track_heartbeat'] ) ) ) : 0,
+ 'limit_cookies' => isset( $_POST['limit_cookies'] ) ? ( boolval( wp_unslash( $_POST['limit_cookies'] ) ) ) : false,
+ 'limit_cookies_visitor' => isset( $_POST['limit_cookies_visitor'] ) ? ( intval( wp_unslash( $_POST['limit_cookies_visitor'] ) ) ) : 0,
+ 'limit_cookies_session' => isset( $_POST['limit_cookies_session'] ) ? ( intval( wp_unslash( $_POST['limit_cookies_session'] ) ) ) : 0,
+ 'limit_cookies_referral' => isset( $_POST['limit_cookies_referral'] ) ? ( intval( wp_unslash( $_POST['limit_cookies_referral'] ) ) ) : 0,
+ 'cookie_consent' => isset( $_POST['cookie_consent'] ) ? ( sanitize_text_field( wp_unslash( $_POST['cookie_consent'] ) ) ) : '',
+ 'force_post' => isset( $_POST['force_post'] ) ? ( wp_unslash( boolval( $_POST['force_post'] ) ) ) : false,
+ 'track_across_alias' => isset( $_POST['track_across_alias'] ) ? ( boolval( wp_unslash( $_POST['track_across_alias'] ) ) ) : false,
+ 'track_across' => isset( $_POST['track_across'] ) ? ( boolval( wp_unslash( $_POST['track_across'] ) ) ) : false,
+ 'track_crossdomain_linking' => isset( $_POST['track_crossdomain_linking'] ) ? ( boolval( wp_unslash( $_POST['track_crossdomain_linking'] ) ) ) : false,
+ 'track_jserrors' => isset( $_POST['track_jserrors'] ) ? ( boolval( wp_unslash( $_POST['track_jserrors'] ) ) ) : false,
+ 'disable_cookies' => isset( $_POST['disable_cookies'] ) ? ( boolval( wp_unslash( $_POST['disable_cookies'] ) ) ) : false,
+ 'set_link_classes' => isset( $_POST['set_link_classes'] ) ? ( sanitize_text_field( wp_unslash( $_POST['set_link_classes'] ) ) ) : '',
+ 'set_download_classes' => isset( $_POST['set_download_classes'] ) ? ( sanitize_text_field( wp_unslash( $_POST['set_download_classes'] ) ) ) : '',
+ 'add_download_extensions' => isset( $_POST['add_download_extensions'] ) ? ( sanitize_text_field( wp_unslash( $_POST['add_download_extensions'] ) ) ) : '',
+ 'track_api_endpoint' => isset( $_POST['track_api_endpoint'] ) ? ( sanitize_text_field( wp_unslash( $_POST['track_api_endpoint'] ) ) ) : '',
+ 'force_protocol' => isset( $_POST['force_protocol'] ) ? ( boolval( wp_unslash( $_POST['force_protocol'] ) ) ) : false,
+ 'track_js_endpoint' => isset( $_POST['track_js_endpoint'] ) ? ( sanitize_text_field( wp_unslash( $_POST['track_js_endpoint'] ) ) ) : '',
+ 'set_download_extensions' => isset( $_POST['set_download_extensions'] ) ? ( sanitize_text_field( wp_unslash( $_POST['set_download_extensions'] ) ) ) : '',
+ ];
+
+ $generator = new TrackingCodeGenerator( \WpMatomo::$settings, new GeneratorOptions( \WpMatomo::$settings, $overrides ) );
+ $tracking_code = $generator->prepare_tracking_code( $idsite );
+
+ wp_send_json( $tracking_code );
+ }
}
diff --git a/classes/WpMatomo/Admin/TrackingSettings/Forms.php b/classes/WpMatomo/Admin/TrackingSettings/Forms.php
index 50c71c210..8a0a9886c 100644
--- a/classes/WpMatomo/Admin/TrackingSettings/Forms.php
+++ b/classes/WpMatomo/Admin/TrackingSettings/Forms.php
@@ -22,8 +22,8 @@
if ( ! defined( 'ABSPATH' ) ) {
exit; // if accessed directly
}
+
/**
- * we deal with HTML
* phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped
*/
class Forms {
@@ -41,14 +41,12 @@ public function __construct( $settings ) {
*
* @param string $id option id
* @param string $description option description
- * @param boolean $hide_description set to false to show description initially (default: true)
+ * @param boolean $hide_description set to false to show description initially (default: false)
*
* @return string full description HTML
*/
- public function get_description( $id, $description, $hide_description = true ) {
- $title = esc_html__( 'Click to read help', 'matomo' );
-
- return sprintf( ' ', $title, esc_attr( $id ), $description );
+ public function get_description( $id, $description, $hide_description = false ) {
+ return sprintf( '', esc_attr( $id ), $description );
}
/**
@@ -62,8 +60,23 @@ public function get_description( $id, $description, $hide_description = true ) {
* @param boolean $hide_description $hideDescription set to false to show description initially (default: true)
* @param string $on_change javascript for onchange event (default: empty)
*/
- public function show_checkbox( $id, $name, $description, $is_hidden = false, $group_name = '', $hide_description = true, $on_change = '' ) {
- printf( '', esc_html( $name ), esc_attr( $id ), $on_change, $this->get_description( $id, $description, $hide_description ) );
+ public function show_checkbox( $id, $name, $description, $is_hidden = false, $group_name = '', $hide_description = false, $on_change = '' ) {
+ printf(
+ '',
+ esc_html( $name ),
+ esc_attr( $id ),
+ $on_change,
+ $this->get_description( $id, $description, $hide_description )
+ );
}
/**
@@ -75,14 +88,14 @@ public function show_checkbox( $id, $name, $description, $is_hidden = false, $gr
* @param string $description option description
* @param boolean $is_hidden set to true to initially hide the option (default: false)
* @param string $group_name define a class name to access a group of option rows by javascript (default: empty)
- * @param boolean $hide_description $hideDescription set to false to show description initially (default: true)
+ * @param boolean $hide_description $hideDescription set to false to show description initially (default: false)
* @param string $on_change javascript for onchange event (default: empty)
* @param boolean $is_readonly set textarea to read only (default: false)
* @param boolean $global set to false if the textarea shows a site-specific option (default: true)
*/
- public function show_textarea( $id, $name, $rows, $description, $is_hidden, $group_name, $hide_description = true, $on_change = '', $is_readonly = false, $global = true ) {
+ public function show_textarea( $id, $name, $rows, $description, $is_hidden, $group_name, $hide_description = false, $on_change = '', $is_readonly = false, $global = true, $exclude_name = false ) {
printf(
- '',
+ '',
esc_html( $name ),
esc_attr( $id ),
$on_change,
@@ -118,10 +131,10 @@ public function show_headline( $text, $group_name = '' ) {
* @param boolean $is_hidden set to true to initially hide the option (default: false)
* @param string $group_name define a class name to access a group of option rows by javascript (default: empty)
* @param string $row_name define a class name to access the specific option row by javascript (default: empty)
- * @param boolean $hide_description $hideDescription set to false to show description initially (default: true)
+ * @param boolean $hide_description $hideDescription set to false to show description initially (default: false)
* @param boolean $wide Create a wide box (default: false)
*/
- public function show_input( $id, $name, $description, $is_hidden = false, $group_name = '', $row_name = false, $hide_description = true, $wide = false ) {
+ public function show_input( $id, $name, $description, $is_hidden = false, $group_name = '', $row_name = false, $hide_description = false, $wide = false ) {
printf( ''; + } + + $container_select .= 'Edit containers '; + $container_select .= '
' . sprintf( esc_html__( 'For Matomo to track you will need to %1$sadd a Matomo Tag to the container%2$s. It otherwise won\'t track automatically.', 'matomo' ), '', '' ) . '
'; + $container_select .= '' . $description[ $key ] . '
'; + } + + $button_list[] = sprintf( + '', $button_list ), + is_array( $description ) ? '' : $this->get_description( $id, $description, $hide_description ) + ); + } + /** * Show an info box * diff --git a/classes/WpMatomo/Admin/views/get_started.php b/classes/WpMatomo/Admin/views/get_started.php index 82e27f1e8..17e11c713 100644 --- a/classes/WpMatomo/Admin/views/get_started.php +++ b/classes/WpMatomo/Admin/views/get_started.php @@ -41,46 +41,65 @@ } ?> +
+ +
+ ++ +
+ +
+ +1.
+ ++ +
+ ++ [matomo_opt_out]' ); ?> + ', '' ); ?> +
+ ++ +
++ ', '', '', '' ); ?> +
+ is_tracking_enabled() ) { ?> -1. 2.
-1.
+2.
+ +:
- -2.
- - [matomo_opt_out]', '', '' ); ?> +3.
- - ', '', '', '' ); ?> + -3.
-
+
+
+
+
+
+
+ + + +
+ + + +
- Matomo will always cost you nothing to use, but that doesn't mean it costs us nothing to make.
- Matomo needs your continued support to grow and thrive.
',
- '',
+ esc_html__( 'Matomo will always cost you nothing to use, but if you\'d like to support Matomo in a more meaningful way, take a look at our %1$spremium plugins%2$s.', 'matomo' ),
'',
''
);
?>
- Every penny will help.
-
diff --git a/classes/WpMatomo/Admin/views/info_help.php b/classes/WpMatomo/Admin/views/info_help.php
index 737a2793a..85d9d6040 100644
--- a/classes/WpMatomo/Admin/views/info_help.php
+++ b/classes/WpMatomo/Admin/views/info_help.php
@@ -13,11 +13,11 @@
exit; // if accessed directly
}
?>
-
+
- ',
+ '',
+ '',
+ ''
+);
diff --git a/classes/WpMatomo/Admin/views/info_shared.php b/classes/WpMatomo/Admin/views/info_shared.php
index 82a7cea5f..174736fae 100644
--- a/classes/WpMatomo/Admin/views/info_shared.php
+++ b/classes/WpMatomo/Admin/views/info_shared.php
@@ -11,23 +11,14 @@
exit; // if accessed directly
}
?>
-
++ + +
', - '', - '', - '' - ); + require_once 'info_matomo_desc.php'; ?>
-
diff --git a/classes/WpMatomo/Admin/views/tracking.php b/classes/WpMatomo/Admin/views/tracking.php
index 389cddb6d..fb31773e5 100644
--- a/classes/WpMatomo/Admin/views/tracking.php
+++ b/classes/WpMatomo/Admin/views/tracking.php
@@ -27,6 +27,8 @@
/** @var array $matomo_currencies */
/** @var string[] $settings_errors */
/** @var array $cookie_consent_modes */
+/** @var string $matomo_exclusion_settings_url */
+/** @var array $matomo_track_mode_descriptions $matomo_form */
$matomo_form = new \WpMatomo\Admin\TrackingSettings\Forms( $settings );
$matomo_paths = new Paths();
@@ -41,224 +43,766 @@
}
?>
-
diff --git a/classes/WpMatomo/AjaxTracker.php b/classes/WpMatomo/AjaxTracker.php index 632bd69d9..8d3d62c08 100644 --- a/classes/WpMatomo/AjaxTracker.php +++ b/classes/WpMatomo/AjaxTracker.php @@ -9,6 +9,9 @@ namespace WpMatomo; +use WpMatomo\TrackingCode\GeneratorOptions; +use WpMatomo\TrackingCode\TrackingCodeGenerator; + if ( ! defined( 'ABSPATH' ) ) { exit; // if accessed directly } @@ -46,7 +49,8 @@ public function __construct( Settings $settings ) { $this->pageUrl = ! empty( $_SERVER['HTTP_REFERER'] ) ? $_SERVER['HTTP_REFERER'] : false; if ( ! $settings->get_global_option( 'disable_cookies' ) ) { - $cookie_domain = $settings->get_tracking_cookie_domain(); + $tracking_code_generator = new TrackingCodeGenerator( $settings, new GeneratorOptions( $settings ) ); + $cookie_domain = $tracking_code_generator->get_tracking_cookie_domain(); $this->enableCookies( $cookie_domain ); } else { $this->disableCookieSupport(); diff --git a/classes/WpMatomo/ScheduledTasks.php b/classes/WpMatomo/ScheduledTasks.php index 560a6bfec..deecb06ae 100644 --- a/classes/WpMatomo/ScheduledTasks.php +++ b/classes/WpMatomo/ScheduledTasks.php @@ -227,7 +227,7 @@ public function perform_update() { return true; } - public function update_geo_ip2_db() { + public function update_geo_ip2_db( $db_url_override = null, $asn_url_override = null ) { if ( is_multisite() && ! is_main_site() ) { return; // only run this task once per entire WP install } @@ -247,6 +247,13 @@ public function update_geo_ip2_db() { $asn_url = 'https://download.maxmind.com/app/geoip_download?edition_id=GeoLite2-ASN&suffix=tar.gz&license_key=' . $maxmind_license; } + if ( ! empty( $db_url_override ) ) { + $db_url = $db_url_override; + } + if ( ! empty( $asn_url_override ) ) { + $asn_url = $asn_url_override; + } + Option::set( GeoIP2AutoUpdater::LOC_URL_OPTION_NAME, $db_url ); if ( Manager::getInstance()->isPluginActivated( 'Provider' ) ) { diff --git a/classes/WpMatomo/Settings.php b/classes/WpMatomo/Settings.php index 9ef1c53ee..74e7a468d 100644 --- a/classes/WpMatomo/Settings.php +++ b/classes/WpMatomo/Settings.php @@ -54,9 +54,11 @@ class Settings { /** * Register default configuration set * + * (public for tests) + * * @var array */ - private $default_global_settings = [ + public $default_global_settings = [ // Plugin settings 'last_settings_update' => 0, self::OPTION_LAST_TRACKING_SETTINGS_CHANGE => 0, @@ -403,18 +405,6 @@ public function is_cross_domain_linking_enabled() { return $this->get_global_option( 'track_crossdomain_linking' ); } - public function get_tracking_cookie_domain() { - if ( $this->get_global_option( 'track_across' ) - || $this->get_global_option( 'track_crossdomain_linking' ) ) { - $host = wp_parse_url( home_url(), PHP_URL_HOST ); - if ( ! empty( $host ) ) { - return '*.' . $host; - } - } - - return ''; - } - public function should_delete_all_data_on_uninstall() { if ( defined( 'MATOMO_REMOVE_ALL_DATA' ) ) { return (bool) MATOMO_REMOVE_ALL_DATA; diff --git a/classes/WpMatomo/TrackingCode.php b/classes/WpMatomo/TrackingCode.php index b9ff895f4..4607762fb 100644 --- a/classes/WpMatomo/TrackingCode.php +++ b/classes/WpMatomo/TrackingCode.php @@ -13,6 +13,7 @@ exit; // if accessed directly } +use WpMatomo\TrackingCode\GeneratorOptions; use WpMatomo\TrackingCode\TrackingCodeGenerator; use WpMatomo\Settings; @@ -39,7 +40,7 @@ class TrackingCode { public function __construct( $settings ) { $this->settings = $settings; $this->logger = new Logger(); - $this->generator = new TrackingCodeGenerator( $this->settings ); + $this->generator = new TrackingCodeGenerator( $this->settings, new GeneratorOptions( $this->settings ) ); $this->generator->register_hooks(); } diff --git a/classes/WpMatomo/TrackingCode/GeneratorOptions.php b/classes/WpMatomo/TrackingCode/GeneratorOptions.php new file mode 100644 index 000000000..3af639b0d --- /dev/null +++ b/classes/WpMatomo/TrackingCode/GeneratorOptions.php @@ -0,0 +1,122 @@ +settings = $settings; + $this->options_override = $options_override; + } + + public function get_track_datacfasync() { + return $this->get_option( 'track_datacfasync' ); + } + + public function get_track_content() { + return $this->get_option( 'track_content' ); + } + + public function get_track_heartbeat() { + return $this->get_option( 'track_heartbeat' ); + } + + public function get_limit_cookies() { + return $this->get_option( 'limit_cookies' ); + } + + public function get_limit_cookies_visitor() { + return $this->get_option( 'limit_cookies_visitor' ); + } + + public function get_limit_cookies_session() { + return $this->get_option( 'limit_cookies_session' ); + } + + public function get_limit_cookies_referral() { + return $this->get_option( 'limit_cookies_referral' ); + } + + public function get_cookie_consent() { + return $this->get_option( 'cookie_consent' ); + } + + public function get_force_post() { + return $this->get_option( 'force_post' ); + } + + public function get_track_across_alias() { + return $this->get_option( 'track_across_alias' ); + } + + public function get_track_across() { + return $this->get_option( 'track_across' ); + } + + public function get_track_crossdomain_linking() { + return $this->get_option( 'track_crossdomain_linking' ); + } + + public function get_track_jserrors() { + return $this->get_option( 'track_jserrors' ); + } + + public function get_disable_cookies() { + return $this->get_option( 'disable_cookies' ); + } + + public function get_set_link_classes() { + return $this->get_option( 'set_link_classes' ); + } + + public function get_set_download_classes() { + return $this->get_option( 'set_download_classes' ); + } + + public function get_add_download_extensions() { + return $this->get_option( 'add_download_extensions' ); + } + + public function get_track_api_endpoint() { + return $this->get_option( 'track_api_endpoint' ); + } + + public function get_force_protocol() { + return $this->get_option( 'force_protocol' ); + } + + public function get_track_js_endpoint() { + return $this->get_option( 'track_js_endpoint' ); + } + + public function get_set_download_extensions() { + return $this->get_option( 'set_download_extensions' ); + } + + private function get_option( $option_name ) { + if ( isset( $this->options_override[ $option_name ] ) ) { + return $this->options_override[ $option_name ]; + } + + return $this->settings->get_global_option( $option_name ); + } +} diff --git a/classes/WpMatomo/TrackingCode/TrackingCodeGenerator.php b/classes/WpMatomo/TrackingCode/TrackingCodeGenerator.php index 56d6a214f..422d589f9 100644 --- a/classes/WpMatomo/TrackingCode/TrackingCodeGenerator.php +++ b/classes/WpMatomo/TrackingCode/TrackingCodeGenerator.php @@ -33,15 +33,18 @@ class TrackingCodeGenerator { private $settings; /** - * @var Logger + * @var GeneratorOptions */ - private $logger; + private $options; /** - * @param Settings $settings + * @var Logger */ - public function __construct( $settings ) { + private $logger; + + public function __construct( Settings $settings, GeneratorOptions $options ) { $this->settings = $settings; + $this->options = $options; $this->logger = new Logger(); } @@ -186,13 +189,13 @@ private function prepare_tagmanger_code( $settings, $logger ) { public function get_tracker_endpoint() { $paths = new Paths(); - if ( $this->settings->get_global_option( 'track_api_endpoint' ) === 'restapi' ) { + if ( $this->options->get_track_api_endpoint() === 'restapi' ) { $tracker_endpoint = $paths->get_tracker_api_rest_api_endpoint(); } else { $tracker_endpoint = $paths->get_tracker_api_url_in_matomo_dir(); } - if ( $this->settings->get_global_option( 'force_protocol' ) === 'https' ) { + if ( $this->options->get_force_protocol() === 'https' ) { $tracker_endpoint = preg_replace( '(^http://)', 'https://', $tracker_endpoint ); } else { $tracker_endpoint = preg_replace( '(^https?://)', '//', $tracker_endpoint ); @@ -203,15 +206,15 @@ public function get_tracker_endpoint() { public function get_js_endpoint() { $paths = new Paths(); - if ( $this->settings->get_global_option( 'track_js_endpoint' ) === 'restapi' ) { + if ( $this->options->get_track_js_endpoint() === 'restapi' ) { $js_endpoint = $paths->get_js_tracker_rest_api_endpoint(); - } elseif ( $this->settings->get_global_option( 'track_js_endpoint' ) === 'plugin' ) { + } elseif ( $this->options->get_track_js_endpoint() === 'plugin' ) { $js_endpoint = plugins_url( 'app/matomo.js', MATOMO_ANALYTICS_FILE ); } else { $js_endpoint = $paths->get_js_tracker_url_in_matomo_dir(); } - if ( $this->settings->get_global_option( 'force_protocol' ) === 'https' ) { + if ( $this->options->get_force_protocol() === 'https' ) { $js_endpoint = preg_replace( '(^http://)', 'https://', $js_endpoint ); } else { $js_endpoint = preg_replace( '(^https?://)', '//', $js_endpoint ); @@ -235,34 +238,34 @@ public function prepare_tracking_code( $idsite ) { $options = []; - if ( $this->settings->get_global_option( 'set_download_extensions' ) ) { - $options[] = "_paq.push(['setDownloadExtensions', " . wp_json_encode( $this->settings->get_global_option( 'set_download_extensions' ) ) . ']);'; + if ( $this->options->get_set_download_extensions() ) { + $options[] = "_paq.push(['setDownloadExtensions', " . wp_json_encode( $this->options->get_set_download_extensions() ) . ']);'; } - if ( $this->settings->get_global_option( 'add_download_extensions' ) ) { - $options[] = "_paq.push(['addDownloadExtensions', " . wp_json_encode( $this->settings->get_global_option( 'add_download_extensions' ) ) . ']);'; + if ( $this->options->get_add_download_extensions() ) { + $options[] = "_paq.push(['addDownloadExtensions', " . wp_json_encode( $this->options->get_add_download_extensions() ) . ']);'; } - if ( $this->settings->get_global_option( 'set_download_classes' ) ) { - $options[] = "_paq.push(['setDownloadClasses', " . wp_json_encode( $this->settings->get_global_option( 'set_download_classes' ) ) . ']);'; + if ( $this->options->get_set_download_classes() ) { + $options[] = "_paq.push(['setDownloadClasses', " . wp_json_encode( $this->options->get_set_download_classes() ) . ']);'; } - if ( $this->settings->get_global_option( 'set_link_classes' ) ) { - $options[] = "_paq.push(['setLinkClasses', " . wp_json_encode( $this->settings->get_global_option( 'set_link_classes' ) ) . ']);'; + if ( $this->options->get_set_link_classes() ) { + $options[] = "_paq.push(['setLinkClasses', " . wp_json_encode( $this->options->get_set_link_classes() ) . ']);'; } - if ( $this->settings->get_global_option( 'disable_cookies' ) ) { + if ( $this->options->get_disable_cookies() ) { $options[] = self::get_disable_cookies_partial(); } - if ( $this->settings->get_global_option( 'track_crossdomain_linking' ) ) { + if ( $this->options->get_track_crossdomain_linking() ) { $options[] = "_paq.push(['enableCrossDomainLinking']);"; } - if ( $this->settings->get_global_option( 'track_jserrors' ) ) { + if ( $this->options->get_track_jserrors() ) { $options[] = "_paq.push(['enableJSErrorTracking']);"; } - $cookie_domain = $this->settings->get_tracking_cookie_domain(); + $cookie_domain = $this->get_tracking_cookie_domain(); if ( ! empty( $cookie_domain ) ) { $options[] = '_paq.push(["setCookieDomain", ' . wp_json_encode( $cookie_domain ) . ']);'; } - $track_across_alias = $this->settings->get_global_option( 'track_across_alias' ); + $track_across_alias = $this->options->get_track_across_alias(); if ( $track_across_alias ) { // todo detect more hosts such as when using WPML etc @@ -278,34 +281,34 @@ function ( $host ) { $options[] = '_paq.push(["setDomains", ' . wp_json_encode( $hosts ) . ']);'; } } - if ( $this->settings->get_global_option( 'force_post' ) ) { + if ( $this->options->get_force_post() ) { $options[] = "_paq.push(['setRequestMethod', 'POST']);"; } $cookie_consent = new CookieConsent(); - $cookie_consent_option = $cookie_consent->get_tracking_consent_option( $this->settings->get_global_option( 'cookie_consent' ) ); + $cookie_consent_option = $cookie_consent->get_tracking_consent_option( $this->options->get_cookie_consent() ); // for unit test cases if ( ! empty( $cookie_consent_option ) ) { $options[] = $cookie_consent_option; } - if ( $this->settings->get_global_option( 'limit_cookies' ) ) { - $options[] = "_paq.push(['setVisitorCookieTimeout', " . wp_json_encode( $this->settings->get_global_option( 'limit_cookies_visitor' ) ) . ']);'; - $options[] = "_paq.push(['setSessionCookieTimeout', " . wp_json_encode( $this->settings->get_global_option( 'limit_cookies_session' ) ) . ']);'; - $options[] = "_paq.push(['setReferralCookieTimeout', " . wp_json_encode( $this->settings->get_global_option( 'limit_cookies_referral' ) ) . ']);'; + if ( $this->options->get_limit_cookies() ) { + $options[] = "_paq.push(['setVisitorCookieTimeout', " . wp_json_encode( $this->options->get_limit_cookies_visitor() ) . ']);'; + $options[] = "_paq.push(['setSessionCookieTimeout', " . wp_json_encode( $this->options->get_limit_cookies_session() ) . ']);'; + $options[] = "_paq.push(['setReferralCookieTimeout', " . wp_json_encode( $this->options->get_limit_cookies_referral() ) . ']);'; } - if ( $this->settings->get_global_option( 'track_content' ) === 'all' ) { + if ( $this->options->get_track_content() === 'all' ) { $options[] = "_paq.push(['trackAllContentImpressions']);"; - } elseif ( $this->settings->get_global_option( 'track_content' ) === 'visible' ) { + } elseif ( $this->options->get_track_content() === 'visible' ) { $options[] = "_paq.push(['trackVisibleContentImpressions']);"; } - if ( (int) $this->settings->get_global_option( 'track_heartbeat' ) > 0 ) { - $options[] = "_paq.push(['enableHeartBeatTimer', " . intval( $this->settings->get_global_option( 'track_heartbeat' ) ) . ']);'; + if ( (int) $this->options->get_track_heartbeat() > 0 ) { + $options[] = "_paq.push(['enableHeartBeatTimer', " . intval( $this->options->get_track_heartbeat() ) . ']);'; } $data_cf_async = ''; $data_of_async_option = []; - if ( $this->settings->get_global_option( 'track_datacfasync' ) ) { + if ( $this->options->get_track_datacfasync() ) { $data_cf_async = 'data-cfasync="false"'; $data_of_async_option['data-cfasync'] = 'false'; } @@ -348,6 +351,18 @@ function ( $host ) { ]; } + public function get_tracking_cookie_domain() { + if ( $this->options->get_track_across() + || $this->options->get_track_crossdomain_linking() ) { + $host = wp_parse_url( home_url(), PHP_URL_HOST ); + if ( ! empty( $host ) ) { + return '*.' . $host; + } + } + + return ''; + } + private function apply_404_changes( $tracking_code ) { $this->logger->log( 'Apply 404 tracking changes. Blog ID: ' . get_current_blog_id() ); diff --git a/matomo.php b/matomo.php index a77720d5a..41e005fab 100644 --- a/matomo.php +++ b/matomo.php @@ -4,10 +4,10 @@ * Description: Privacy friendly, GDPR compliant and self-hosted. Matomo is the #1 Google Analytics alternative that gives you control of your data. Free and secure. * Author: Matomo * Author URI: https://matomo.org - * Version: 5.1.2 + * Version: 5.1.3 * Domain Path: /languages * WC requires at least: 2.4.0 - * WC tested up to: 9.1.2 + * WC tested up to: 9.2.3 * * Matomo - free/libre analytics platform * diff --git a/package.json b/package.json index 0888098a0..13a4fafd2 100644 --- a/package.json +++ b/package.json @@ -20,7 +20,8 @@ "phpcs": "./vendor/bin/phpcs", "matomo:console": "docker compose --env-file .env.default --env-file .env run --rm console", "wp:cli": "docker compose --env-file .env.default --env-file .env run --rm wp", - "phpunit": "docker compose --env-file .env.default --env-file .env run --rm phpunit" + "phpunit": "docker compose --env-file .env.default --env-file .env run --rm phpunit", + "mariadb": "docker compose --env-file .env.default --env-file .env run mariadb mariadb -h mariadb -u root -p" }, "dependencies": { "chart.js": "^3.4.1" diff --git a/readme.txt b/readme.txt index 81b4335ea..5b5cb847b 100644 --- a/readme.txt +++ b/readme.txt @@ -2,8 +2,8 @@ Contributors: matomoteam Tags: matomo,analytics,statistics,stats,ecommerce Requires at least: 4.8 -Tested up to: 6.5.5 -Stable tag: 5.1.2 +Tested up to: 6.6.1 +Stable tag: 5.1.3 Requires PHP: 7.2.5 License: GPLv3 or later License URI: https://www.gnu.org/licenses/gpl-3.0.html diff --git a/scripts/update-core.sh b/scripts/update-core.sh index 5163ef1db..771944614 100755 --- a/scripts/update-core.sh +++ b/scripts/update-core.sh @@ -22,6 +22,13 @@ function die() { which git &> /dev/null || die "git is required for this script" which composer &> /dev/null || die "composer is required for this script" +cd .. && npm run matomo:console &> /dev/null || die "local mwp environment must be running" +cd scripts + +if [ -z "$MATOMO_SCOPER_PATH" ]; then + die "Error: MATOMO_SCOPER_PATH not defined." +fi + trap catch_error ERR SCRIPTPATH="$( cd "$(dirname "$0")" ; pwd -P )" @@ -69,14 +76,9 @@ cp -R matomo/* $MATOMO_ROOT cp -R matomo/.* $MATOMO_ROOT rm -r matomo/ -if [ ! -z "$MATOMO_SCOPER_PATH" ]; then - echo "Running matomo-scoper..." +echo "Running matomo-scoper..." - php "$MATOMO_SCOPER_PATH/bin/matomo-scoper" scope -y --rename-references --ignore-platform-check "$MATOMO_ROOT" -else - echo "Error: MATOMO_SCOPER_PATH not defined." - exit 1; -fi +php "$MATOMO_SCOPER_PATH/bin/matomo-scoper" scope -y --rename-references --ignore-platform-check "$MATOMO_ROOT" find $MATOMO_ROOT/misc/* -exec rm -rf {} + rm -r $MATOMO_ROOT/js/piwik.js @@ -211,6 +213,7 @@ sed -i -e 's/!\/node_modules\/@materializecss\/materialize/!\/node_modules\/@mat RED='\033[0;31m' NO_COLOR='\033[0m' -npm run compose -- run console wordpress:generate-lang-files || echo -e "${RED}Failed to generate lang files! Make sure to run 'npm run compose -- run console wordpress:generate-lang-files' after fixing the issue!${NO_COLOR}" +npm run matomo:console wordpress:generate-lang-files || echo -e "${RED}Failed to generate lang files! Make sure to run 'npm run compose -- run console wordpress:generate-lang-files' after fixing the issue!${NO_COLOR}" +npm run matomo:console wordpress:generate-core-assets || echo -e "${RED}Failed to regenerate core assets.${NO_COLOR}" echo -e "Done!... " diff --git a/tests/e2e/baseline/desktop_firefox/matomo-admin.diagnostic.device-detection.png b/tests/e2e/baseline/desktop_firefox/matomo-admin.diagnostic.device-detection.png index 0a9db9dc2..bf893b24d 100644 --- a/tests/e2e/baseline/desktop_firefox/matomo-admin.diagnostic.device-detection.png +++ b/tests/e2e/baseline/desktop_firefox/matomo-admin.diagnostic.device-detection.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:79ddb61b5e171c08ab34017ade9c0cd18c1d97eca2fa40850f52001126b9c36b -size 102425 +oid sha256:99dadc993283398a88f849d30f5a01f8935441000f924a3518b675f9bcd74e60 +size 102192 diff --git a/tests/e2e/baseline/desktop_firefox/mwp-admin.about.png b/tests/e2e/baseline/desktop_firefox/mwp-admin.about.png index 35dc27fdd..b576ceb5a 100644 --- a/tests/e2e/baseline/desktop_firefox/mwp-admin.about.png +++ b/tests/e2e/baseline/desktop_firefox/mwp-admin.about.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:c20370beaa50e1ca31569d0feb246d1e00fb8b75a5a8cc4e0352843b1347f56a -size 229388 +oid sha256:4dfa2e436ee8e554d1fec91e197374a36903311da86204f93930755f87f9805f +size 223241 diff --git a/tests/e2e/baseline/desktop_firefox/mwp-admin.about.trunk.png b/tests/e2e/baseline/desktop_firefox/mwp-admin.about.trunk.png index cdabcdb6a..0655df12e 100644 --- a/tests/e2e/baseline/desktop_firefox/mwp-admin.about.trunk.png +++ b/tests/e2e/baseline/desktop_firefox/mwp-admin.about.trunk.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:693fa63e4d7e2785898c84f6c3c3428e4199696088937eb95a1d48990fdd88ca -size 245142 +oid sha256:5272b1979dc014ac815cfef51457d30ae7a6dcd84e0fda81f9b0372b299abe1f +size 236255 diff --git a/tests/e2e/baseline/desktop_firefox/mwp-admin.diagnostics.system-report.7.2.trunk.png b/tests/e2e/baseline/desktop_firefox/mwp-admin.diagnostics.system-report.7.2.trunk.png index e5359f13d..5f9877144 100644 --- a/tests/e2e/baseline/desktop_firefox/mwp-admin.diagnostics.system-report.7.2.trunk.png +++ b/tests/e2e/baseline/desktop_firefox/mwp-admin.diagnostics.system-report.7.2.trunk.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:7d96b8aa880e9b240dbeb3639cf3e6ca7b93af9a30cdb160e049a4f5de476009 -size 960141 +oid sha256:e658430f9f0abca4db7097743ac61d55b2544d7c409c88b5ee0f2e3b3784c9c7 +size 959434 diff --git a/tests/e2e/baseline/desktop_firefox/mwp-admin.diagnostics.system-report.8.1.png b/tests/e2e/baseline/desktop_firefox/mwp-admin.diagnostics.system-report.8.1.png index 0198c2553..94306943b 100644 --- a/tests/e2e/baseline/desktop_firefox/mwp-admin.diagnostics.system-report.8.1.png +++ b/tests/e2e/baseline/desktop_firefox/mwp-admin.diagnostics.system-report.8.1.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:71af148623610452c6ddfe37df62b9a31ac1ad792fa5e5a274d4b5662a5ed91e -size 901643 +oid sha256:9affc2cacc09a18bdc7e809ece1bc30f89e8d1dfa3d88532265a5218cf3a4920 +size 899476 diff --git a/tests/e2e/baseline/desktop_firefox/mwp-admin.diagnostics.system-report.8.1.trunk.png b/tests/e2e/baseline/desktop_firefox/mwp-admin.diagnostics.system-report.8.1.trunk.png index b1a99c4db..f58b4c58d 100644 --- a/tests/e2e/baseline/desktop_firefox/mwp-admin.diagnostics.system-report.8.1.trunk.png +++ b/tests/e2e/baseline/desktop_firefox/mwp-admin.diagnostics.system-report.8.1.trunk.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:85ac4417da7721d6c024b8241f9578f8bf5446ca7fafe64c74f18d6f3c877420 -size 960924 +oid sha256:0ad05ec91e82f800a021453a87899d4cc323d1eee26d34aaa011638b9d26a004 +size 960486 diff --git a/tests/e2e/baseline/desktop_firefox/mwp-admin.diagnostics.troubleshooting.png b/tests/e2e/baseline/desktop_firefox/mwp-admin.diagnostics.troubleshooting.png index 685c5dab9..e6e8f35c6 100644 --- a/tests/e2e/baseline/desktop_firefox/mwp-admin.diagnostics.troubleshooting.png +++ b/tests/e2e/baseline/desktop_firefox/mwp-admin.diagnostics.troubleshooting.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:31b0dc103d517265116c93b6b4259a703257c23284b9c4b7cd010f04b284c4c1 -size 209416 +oid sha256:e6154364b63ec459d5b64f87fbe9c8ece0252745e79bd857171426e4bd1be71e +size 211333 diff --git a/tests/e2e/baseline/desktop_firefox/mwp-admin.diagnostics.troubleshooting.trunk.png b/tests/e2e/baseline/desktop_firefox/mwp-admin.diagnostics.troubleshooting.trunk.png index 63f0c024e..2d21b8923 100644 --- a/tests/e2e/baseline/desktop_firefox/mwp-admin.diagnostics.troubleshooting.trunk.png +++ b/tests/e2e/baseline/desktop_firefox/mwp-admin.diagnostics.troubleshooting.trunk.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:53082fa7d17c18dfd8a89e04d064e7b1807c5efc980327e148aa3519316e6482 -size 219888 +oid sha256:aea6dda5463094769672f54bccd893764f3ab4bd8db8e02ca848e268fa333191 +size 221471 diff --git a/tests/e2e/baseline/desktop_firefox/mwp-admin.get-started.png b/tests/e2e/baseline/desktop_firefox/mwp-admin.get-started.png index ea6f45047..87b616fc8 100644 --- a/tests/e2e/baseline/desktop_firefox/mwp-admin.get-started.png +++ b/tests/e2e/baseline/desktop_firefox/mwp-admin.get-started.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:0b70345fb324195f8febadb11a62677d73f4066bba8f73663c643777d22e549b -size 171124 +oid sha256:ff6147278afe756b8cd90580dd6eca7dda3eccb922f460da44ac785d90136b47 +size 124715 diff --git a/tests/e2e/baseline/desktop_firefox/mwp-admin.get-started.trunk.png b/tests/e2e/baseline/desktop_firefox/mwp-admin.get-started.trunk.png index f739a4aad..04e95e865 100644 --- a/tests/e2e/baseline/desktop_firefox/mwp-admin.get-started.trunk.png +++ b/tests/e2e/baseline/desktop_firefox/mwp-admin.get-started.trunk.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:e3d8166b9a9d9435ca9c67113192051dc1a8288773153921290de5b64282ebb1 -size 181879 +oid sha256:c6a503460591d69761addfeb2cd48080902964e108a5e1b2ed7f2d4d0e6dc0f9 +size 135225 diff --git a/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.advanced.png b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.advanced.png index bde3685ca..2bb233e80 100644 --- a/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.advanced.png +++ b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.advanced.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:9d386d9561e4f326358e205f67b3640814e9049a03b966af1099fdb946442d36 -size 149186 +oid sha256:0f7a82373a4d792f7fb3e072cd3ad6ba2151f5d14b799ae1c761ff53c2385a42 +size 148357 diff --git a/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.advanced.trunk.png b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.advanced.trunk.png index cd09e6c6b..ca4ba4727 100644 --- a/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.advanced.trunk.png +++ b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.advanced.trunk.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:1e4d3d1b2dae3f64d29e5687563085b106bb674c914022bea196182f721a2064 -size 154974 +oid sha256:31fa3aedd6131a093eeef68f01696ce3b04295ea1f11dff5237dd4827d0f9151 +size 154642 diff --git a/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.exclusions.png b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.exclusions.png index aad62d322..c8b4ca5d2 100644 --- a/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.exclusions.png +++ b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.exclusions.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:f8efeee50b1ac465f110a700caa9d92a6823494d8f7f544e68d1eea525505af3 -size 177751 +oid sha256:508bf5a92f0fcdcb2ba8e7a2d946c102ed3a92e1eeaa1d363d7c8d1e589324e2 +size 176896 diff --git a/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.exclusions.trunk.png b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.exclusions.trunk.png index 6824a1c4d..35660e69c 100644 --- a/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.exclusions.trunk.png +++ b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.exclusions.trunk.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:4621e518e02212e0030eedd689c97b01fdc98aaa157ee2fb912ea351b6eebb9d -size 189334 +oid sha256:17531689c8f8f46f6da81345e1ba4f53d43cf957bf810362e5820408f39f80d0 +size 185924 diff --git a/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.geolocation.png b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.geolocation.png index 11101ee73..b1d4b632e 100644 --- a/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.geolocation.png +++ b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.geolocation.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:876f58db4b9cca0927cd4b030f374140e04587fd55c1ab03351f5194a100067f -size 110062 +oid sha256:7c532291d4255d0de9c26c79c771e69f492827a467a1a6c6d770a9bd1cf8f89c +size 110079 diff --git a/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.geolocation.trunk.png b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.geolocation.trunk.png index 71a7af984..f029e04f9 100644 --- a/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.geolocation.trunk.png +++ b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.geolocation.trunk.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:e5289c7ff4b75af17ea254a9527cc582b3f92c223f429951764520a6373c96ba -size 117425 +oid sha256:83b2ef3a09060a71d145bfeea052e937bcd479fb2db538917f201845889b0b60 +size 117252 diff --git a/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.7.2.png b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.7.2.png index 759c1f86a..736b8f040 100644 --- a/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.7.2.png +++ b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.7.2.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:7975e136c37a5c100cc3ae3d4ecf195b5393533309785ad66ce376277c56409a -size 316103 +oid sha256:7e070fcf24a0061517a3b9d1c7a23faf4f4c0f3075e0e634d2f3b3990c09a666 +size 255243 diff --git a/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.7.2.trunk.png b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.7.2.trunk.png index 5903de7ae..4733863e3 100644 --- a/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.7.2.trunk.png +++ b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.7.2.trunk.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:923f47b703fc1189bcace5c9bc91034aadef8db2f08b9b3c5f3370b2c64f9658 -size 323720 +oid sha256:7bada1f8782d3bd639e49ada564712418d99f172bac9ca05690a70d08aff4c2f +size 267418 diff --git a/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.8.1.png b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.8.1.png index 05ef605fd..736b8f040 100644 --- a/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.8.1.png +++ b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.8.1.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:19db332c5569ee2a8e12b314592fde6d897a7d9737641565de22db0e2568eb43 -size 316791 +oid sha256:7e070fcf24a0061517a3b9d1c7a23faf4f4c0f3075e0e634d2f3b3990c09a666 +size 255243 diff --git a/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.8.1.trunk.png b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.8.1.trunk.png index 9de7c23bf..4733863e3 100644 --- a/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.8.1.trunk.png +++ b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.8.1.trunk.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:374a00619316646fab1eeb3513afeff4633e5b680247bc17164939ea9bbd08f7 -size 325162 +oid sha256:7bada1f8782d3bd639e49ada564712418d99f172bac9ca05690a70d08aff4c2f +size 267418 diff --git a/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.all-expanded.7.2.png b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.all-expanded.7.2.png new file mode 100644 index 000000000..352065433 --- /dev/null +++ b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.all-expanded.7.2.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ae4ae30b8e2ac1eeb507daab5da0c986f910f5e8700a4c1570dc6de26d7af081 +size 1075219 diff --git a/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.all-expanded.7.2.trunk.png b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.all-expanded.7.2.trunk.png new file mode 100644 index 000000000..a6ca05710 --- /dev/null +++ b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.all-expanded.7.2.trunk.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0e4c692dd91439773b628dff628723d09d6996ed4dbd4cb1729a7c30cf095c3a +size 1138909 diff --git a/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.all-expanded.8.1.png b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.all-expanded.8.1.png new file mode 100644 index 000000000..048fe4d23 --- /dev/null +++ b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.all-expanded.8.1.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d8cc3470854e47ff23f7f49283eb3e67efc5b3cb168d5a7002c27520898d5587 +size 1076889 diff --git a/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.all-expanded.8.1.trunk.png b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.all-expanded.8.1.trunk.png new file mode 100644 index 000000000..8313ad6a8 --- /dev/null +++ b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.all-expanded.8.1.trunk.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:49366db652d5656a4d8664d194b77a8345afb3c5036f1cd6e491cd2fa47a8569 +size 1140541 diff --git a/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.auto-changed.7.2.png b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.auto-changed.7.2.png new file mode 100644 index 000000000..e32f5baa6 --- /dev/null +++ b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.auto-changed.7.2.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b5dc702bcad3a523b80428b4afd2ea201c01741425722ef0adbc4931d7c3fa7b +size 1020157 diff --git a/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.auto-changed.7.2.trunk.png b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.auto-changed.7.2.trunk.png new file mode 100644 index 000000000..4a522a6db --- /dev/null +++ b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.auto-changed.7.2.trunk.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8a31393099112bb318579cf04141a01800dbe391e3b6c7ce39419111c9766fcc +size 1083044 diff --git a/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.auto-changed.8.1.png b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.auto-changed.8.1.png new file mode 100644 index 000000000..b124a34ec --- /dev/null +++ b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.auto-changed.8.1.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:45e2c01e53ca4e573bba0fb4ebf7ec28d93c38be8130974f1ac67a49d3e235a1 +size 1021819 diff --git a/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.auto-changed.8.1.trunk.png b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.auto-changed.8.1.trunk.png new file mode 100644 index 000000000..1ad5b2c35 --- /dev/null +++ b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.auto-changed.8.1.trunk.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3d6d6868093e990ad0f220d861af71f061e356ab98dca244cc0a63bc89ef99ae +size 1084465 diff --git a/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.saved.7.2.png b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.saved.7.2.png new file mode 100644 index 000000000..742297929 --- /dev/null +++ b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.saved.7.2.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3c4c6bc5967b7bb906c70698ed44da045dd02d964f56bc46a4976813512fa828 +size 1134402 diff --git a/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.saved.7.2.trunk.png b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.saved.7.2.trunk.png new file mode 100644 index 000000000..0f8f302f4 --- /dev/null +++ b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.saved.7.2.trunk.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ef5f1df9c5d55698306b922f0c6cd319271d99069fab1ccb75b7e8f14e31ce3b +size 1202637 diff --git a/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.saved.8.1.png b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.saved.8.1.png new file mode 100644 index 000000000..55ea94cbd --- /dev/null +++ b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.saved.8.1.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7623d1b5f15e09e586e23a5d185068bfe736a98e8df8e4e87147ea461d745ab3 +size 1136019 diff --git a/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.saved.8.1.trunk.png b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.saved.8.1.trunk.png new file mode 100644 index 000000000..c58e1d608 --- /dev/null +++ b/tests/e2e/baseline/desktop_firefox/mwp-admin.settings.tracking.saved.8.1.trunk.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:50c81977e14f5511ded4e8ccd9a6f0abb91ef6e6738f5569285675de85df1022 +size 1204119 diff --git a/tests/e2e/baseline/desktop_firefox/mwp-admin.summary.thismonth.png b/tests/e2e/baseline/desktop_firefox/mwp-admin.summary.thismonth.png index ff8ab95e4..222ee1bb8 100644 --- a/tests/e2e/baseline/desktop_firefox/mwp-admin.summary.thismonth.png +++ b/tests/e2e/baseline/desktop_firefox/mwp-admin.summary.thismonth.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:87bb075e74a6998a0086831970e39a87333c80f6f884d4d3ea9f7f318d09e8df -size 257409 +oid sha256:371b82bc65988f806f757e9b188a770074bc3ed18d980d6be577765b8f1daf2c +size 251541 diff --git a/tests/e2e/baseline/desktop_firefox/mwp-admin.summary.thismonth.trunk.png b/tests/e2e/baseline/desktop_firefox/mwp-admin.summary.thismonth.trunk.png index f6c9aa051..d560af10e 100644 --- a/tests/e2e/baseline/desktop_firefox/mwp-admin.summary.thismonth.trunk.png +++ b/tests/e2e/baseline/desktop_firefox/mwp-admin.summary.thismonth.trunk.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:58246c5111bca9e0a9a9f50812b3a891edd06b517ba87e2da70b7bbfcdab7f06 -size 271383 +oid sha256:5bda253e84578d945ae140046043e0a305dafcf83fef7b06dbd65429f124f9a9 +size 265505 diff --git a/tests/e2e/mwp-admin.settings.e2e.ts b/tests/e2e/mwp-admin.settings.e2e.ts index 8b4585413..38a92ffa8 100644 --- a/tests/e2e/mwp-admin.settings.e2e.ts +++ b/tests/e2e/mwp-admin.settings.e2e.ts @@ -24,12 +24,51 @@ describe('MWP Admin > Settings', () => { throw new Error('Unexpected: PHP_VERSION environment variable cannot be found.'); } + await MwpSettingsPage.removeTagManagerContainerIds(); await MwpSettingsPage.prepareWpAdminForScreenshot(); await expect( await browser.checkFullPageScreen(`mwp-admin.settings.tracking.${process.env.PHP_VERSION}${trunkSuffix}`) ).toEqual(0); }); + it('should expand all tracking settings sections correctly', async () => { + await MwpSettingsPage.undoChangesToWpAdminForScreenshot(); + + await MwpSettingsPage.expandAllTrackingSettingsSections(); + + await MwpSettingsPage.removeTagManagerContainerIds(); + await MwpSettingsPage.prepareWpAdminForScreenshot(); + await expect( + await browser.checkFullPageScreen(`mwp-admin.settings.tracking.all-expanded.${process.env.PHP_VERSION}${trunkSuffix}`) + ).toEqual(0); + }); + + it('should update the generated tracking code when an Auto Tracking mode setting changes', async () => { + await MwpSettingsPage.undoChangesToWpAdminForScreenshot(); + + await MwpSettingsPage.selectTrackMode('default'); + await MwpSettingsPage.changeSomeAutoTrackingSettings(); + + await MwpSettingsPage.removeTagManagerContainerIds(); + await MwpSettingsPage.prepareWpAdminForScreenshot(); + await expect( + await browser.checkFullPageScreen(`mwp-admin.settings.tracking.auto-changed.${process.env.PHP_VERSION}${trunkSuffix}`) + ).toEqual(0); + }); + + it('should correctly save tracking settings when the submit button is clicked', async () => { + await MwpSettingsPage.undoChangesToWpAdminForScreenshot(); + + await MwpSettingsPage.saveSettings(); + await MwpSettingsPage.expandAllTrackingSettingsSections(); + + await MwpSettingsPage.removeTagManagerContainerIds(); + await MwpSettingsPage.prepareWpAdminForScreenshot(); + await expect( + await browser.checkFullPageScreen(`mwp-admin.settings.tracking.saved.${process.env.PHP_VERSION}${trunkSuffix}`) + ).toEqual(0); + }); + it('should load the access tab correctly', async () => { await MwpSettingsPage.open(); await MwpSettingsPage.openAccessTab(); diff --git a/tests/e2e/pageobjects/mwp-admin/settings.page.ts b/tests/e2e/pageobjects/mwp-admin/settings.page.ts index 1339c1d21..72a2f4817 100644 --- a/tests/e2e/pageobjects/mwp-admin/settings.page.ts +++ b/tests/e2e/pageobjects/mwp-admin/settings.page.ts @@ -15,25 +15,19 @@ class MwpSettingsPage extends MwpPage { } async enableTagManagerTracking() { - await browser.execute(() => { - window.jQuery('#track_mode').val('tagmanager').change(); - }); + await this.selectTrackMode('tagmanager'); await browser.execute(() => { - window.jQuery('tr.matomo-track-option-tagmanager input[type="checkbox"]').first().prop('checked', true); + window.jQuery('.tagmanager-container-select input[type="checkbox"]').first().prop('checked', true); }); - await browser.execute(() => { - window.jQuery('.matomo-tracking-form .submit > input')[0].click(); - }); + await this.saveSettings(); await browser.pause(1000); } async disableTagManagerTracking() { - await browser.execute(() => { - window.jQuery('#track_mode').val('default').change(); - }); + await this.selectTrackMode('default'); await browser.execute(() => { window.jQuery('.matomo-tracking-form .submit > input').click(); @@ -80,6 +74,53 @@ class MwpSettingsPage extends MwpPage { }); await browser.pause(3000); } + + async expandAllTrackingSettingsSections() { + await browser.execute(() => { + window.jQuery('.collapsible-settings:not(.expanded) > h2').each(function () { + window.jQuery(this).click(); + }); + + window.jQuery('#showGeneratedTrackingCode > a')[0].click(); + }); + await browser.pause(200); + } + + async selectTrackMode(trackMode: string) { + await browser.$(`input[name="matomo[track_mode]"][value="${trackMode}"]`).click(); + } + + async changeSomeAutoTrackingSettings() { + await browser.execute(() => { + window.jQuery('input[name="matomo[disable_cookies]"]').prev('.matomo-toggle').find('input').click(); + window.jQuery('input[name="matomo[track_crossdomain_linking]"]').prev('.matomo-toggle').find('input').click(); + window.jQuery('input[name="matomo[set_download_classes]"]').val('a|b|c'); + }); + await browser.pause(500); + } + + async saveSettings() { + await browser.$('p.submit > input').click(); + await browser.waitUntil(() => { + return browser.execute(() => { + return window.jQuery('.updated.notice p:contains(Settings have been updated successfully)').length > 0; + }); + }); + } + + async removeTagManagerContainerIds() { + await browser.execute(() => { + window.jQuery('.tagmanager-container-select').html( + window.jQuery('.tagmanager-container-select').html().replace(/\(ID: [a-zA-Z0-9]+\)/g, '(ID: REMOVED)') + ); + + window.jQuery('textarea').each(function () { + window.jQuery(this).html( + window.jQuery(this).html().replace(/container_[a-zA-Z0-9]+\.js/g, 'container_REMOVED.js') + ); + }); + }); + } } export default new MwpSettingsPage(); diff --git a/tests/e2e/pageobjects/page.ts b/tests/e2e/pageobjects/page.ts index 57b150235..e222efdbb 100644 --- a/tests/e2e/pageobjects/page.ts +++ b/tests/e2e/pageobjects/page.ts @@ -138,4 +138,12 @@ export default class Page { window.jQuery('#footer-upgrade').hide(); }); } + + async undoChangesToWpAdminForScreenshot() { + await browser.execute(() => { + window.jQuery('.notice-ocean-extra-plugin').show(); + window.jQuery('#wpadminbar,#adminmenumain').show(); + window.jQuery('#footer-upgrade').show(); + }); + } } diff --git a/tests/phpunit/framework/fixture/test-matomo-fixture.php b/tests/phpunit/framework/fixture/test-matomo-fixture.php new file mode 100644 index 000000000..84e8d3f6d --- /dev/null +++ b/tests/phpunit/framework/fixture/test-matomo-fixture.php @@ -0,0 +1,152 @@ +getName(); + + if ( ! defined( 'PIWIK_TEST_MODE' ) ) { + define( 'PIWIK_TEST_MODE', true ); + } + + $annotations = PHPUnit\Util\Test::parseTestMethodAnnotations( $test_class_name, $test_method_name ); + if ( ! empty( $annotations['method']['provideContainerConfig'][0] ) ) { + $container_config = $annotations['method']['provideContainerConfig'][0]; + + $method = new ReflectionMethod( $test_case, $container_config ); + $definitions = $method->invoke( $test_case ); + + Bootstrap::set_extra_di_definitions( $definitions ); + } else { + Bootstrap::set_extra_di_definitions( [] ); + } + + $uninstall = new Uninstaller(); + $uninstall->uninstall( true ); + + if ( is_multisite() ) { + $this->delete_extraneous_blogs(); + } + + clearstatcache(); + + Bootstrap::set_not_bootstrapped(); + + $settings = new Settings(); + $installer = new Installer( $settings ); + $installer->install(); + + // we need to init roles again... seems like WP isn't doing this by themselves... + // otherwise if one test adds eg Capability WRITE_MATOMO to a role "editor", in other tests this + // capability will still be present + global $wp_roles; + $wp_roles->init_roles(); + + $roles = new Roles( $settings ); + $roles->add_roles(); + + add_action( + 'set_current_user', + function () { + // auth might still be pointing to a different user... + Bootstrap::set_not_bootstrapped(); + } + ); + + add_action( + 'matomo_uninstall', + function () { + Option::clearCache(); + Cache::flushAll(); + \Piwik\Singleton::clearAll(); + API::unsetAllInstances(); + ArchiveTableCreator::clear(); + Site::clearCache(); + Archive::clearStaticCache(); + // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase + FrontController::$requestId = null; + Date::$now = null; + \Piwik\Tracker\Cache::deleteTrackerCache(); + \Piwik\NumberFormatter::getInstance()->clearCache(); + \Piwik\Plugins\ScheduledReports\API::$cache = array(); + Manager::getInstance()->deleteAll(); + \WpMatomo\Updater::unlock(); + PluginsArchiver::$archivers = array(); + $_GET = array(); + $_REQUEST = array(); + \Piwik\Container\StaticContainer::get( \Piwik\Translation\Translator::class )->reset(); + \Piwik\Log::unsetInstance(); + } + ); + + if ( ! empty( $GLOBALS['wpdb'] ) ) { + $GLOBALS['wpdb']->suppress_errors( false ); + } + } + + public function tear_down() { + Bootstrap::set_extra_di_definitions( [] ); + + if ( ! empty( $GLOBALS['wpdb'] ) ) { + $GLOBALS['wpdb']->suppress_errors( true ); + } + + $uninstall = new Uninstaller(); + $uninstall->uninstall( true ); + + unset( $_GET['trigger'] ); + Metadata::clear_cache(); + + if ( is_multisite() ) { + $this->delete_extraneous_blogs(); + } + } + + private function delete_extraneous_blogs() { + global $wpdb; + + switch_to_blog( 1 ); + + $blogs = $wpdb->get_results( 'SELECT blog_id, deleted FROM ' . $wpdb->blogs . ' ORDER BY blog_id', ARRAY_A ); + foreach ( $blogs as $blog ) { + if ( 1 === (int) $blog['deleted'] || 1 === (int) $blog['blog_id'] ) { + continue; + } + + wpmu_delete_blog( $blog['blog_id'] ); + } + } +} diff --git a/tests/phpunit/framework/fixture/test-wordpress-fixture.php b/tests/phpunit/framework/fixture/test-wordpress-fixture.php new file mode 100644 index 000000000..b82466038 --- /dev/null +++ b/tests/phpunit/framework/fixture/test-wordpress-fixture.php @@ -0,0 +1,55 @@ +reset_roles(); + + add_filter( + 'plugins_url', + function ( $url ) { + // workaround for https://github.com/wp-cli/wp-cli/issues/1037 + // WP is installed in tmp dir, but our plugin must be symlinked in actual dir, then plugin_basename + // fails to remove the actual plugin path + // replaces eg http://example.org/wp-content/plugins/Users/foobar/www/wordpress-tests/src/wp-content/plugins/matomo/app/matomo.js + // with http://example.org/wp-content/plugins/matomo/app/matomo.js + return str_replace( rtrim( dirname( plugin_dir_path( MATOMO_ANALYTICS_FILE ) ), '/' ), '', $url ); + } + ); + if ( ! empty( $GLOBALS['wpdb'] ) ) { + $GLOBALS['wpdb']->suppress_errors( true ); + } + } + + public function tear_down() { + // empty + } + + /** + * Reset roles so they won't be stored across tests... + */ + public function reset_roles() { + foreach ( array( 'editor', 'author', 'contributor' ) as $role ) { + get_role( $role )->remove_cap( Capabilities::KEY_SUPERUSER ); + get_role( $role )->remove_cap( Capabilities::KEY_WRITE ); + get_role( $role )->remove_cap( Capabilities::KEY_ADMIN ); + get_role( $role )->remove_cap( Capabilities::KEY_VIEW ); + } + } + + public function switch_to_admin_page() { + set_current_screen( 'edit-post' ); + } +} diff --git a/tests/phpunit/framework/test-ajax-case.php b/tests/phpunit/framework/test-ajax-case.php new file mode 100644 index 000000000..90272dbaa --- /dev/null +++ b/tests/phpunit/framework/test-ajax-case.php @@ -0,0 +1,44 @@ +wordpress_fixture = new MatomoUnit_WordPress_Fixture(); + $this->wordpress_fixture->set_up(); + } + + public function tearDown(): void { + $this->wordpress_fixture->tear_down(); + parent::tearDown(); + } + + /** + * Calls an WP AJAX method and returns the response as decoded JSON. + * + * @param string $ajax_method + * @param array $get_params + * @param array $post_params + * @return mixed + */ + protected function call_ajax( $ajax_method, $get_params = [], $post_params = [] ) { + $_GET = $get_params; + $_POST = $post_params; + + try { + $this->_handleAjax( $ajax_method ); + $this->fail( 'expected WPAjaxDieContinueException to be thrown in test' ); + } catch ( WPAjaxDieContinueException $e ) { + // empty + } + + $response = json_decode( $this->_last_response, true ); + return $response; + } +} diff --git a/tests/phpunit/framework/test-case.php b/tests/phpunit/framework/test-case.php index da8d210b6..c371d25ff 100644 --- a/tests/phpunit/framework/test-case.php +++ b/tests/phpunit/framework/test-case.php @@ -7,33 +7,21 @@ class MatomoUnit_TestCase extends WP_UnitTestCase { + /** + * @var MatomoUnit_WordPress_Fixture + */ + protected $wordpress_fixture; + public function setUp(): void { parent::setUp(); - if ( ! function_exists( 'wp_delete_site' ) ) { - function wp_delete_site( $site_id ) { - wpmu_delete_blog( $site_id, true ); - } - } - - set_current_screen( 'front' ); - - $this->reset_roles(); + $this->wordpress_fixture = new MatomoUnit_WordPress_Fixture(); + $this->wordpress_fixture->set_up(); + } - add_filter( - 'plugins_url', - function ( $url ) { - // workaround for https://github.com/wp-cli/wp-cli/issues/1037 - // WP is installed in tmp dir, but our plugin must be symlinked in actual dir, then plugin_basename - // fails to remove the actual plugin path - // replaces eg http://example.org/wp-content/plugins/Users/foobar/www/wordpress-tests/src/wp-content/plugins/matomo/app/matomo.js - // with http://example.org/wp-content/plugins/matomo/app/matomo.js - return str_replace( rtrim( dirname( plugin_dir_path( MATOMO_ANALYTICS_FILE ) ), '/' ), '', $url ); - } - ); - if ( ! empty( $GLOBALS['wpdb'] ) ) { - $GLOBALS['wpdb']->suppress_errors( true ); - } + public function tearDown(): void { + $this->wordpress_fixture->tear_down(); + parent::tearDown(); } protected function assume_admin_page() { @@ -60,17 +48,6 @@ protected function create_set_super_admin() { return $id; } - /** - * Reset roles so they won't be stored across tests... - */ - protected function reset_roles() { - foreach ( array( 'editor', 'author', 'contributor' ) as $role ) { - get_role( $role )->remove_cap( Capabilities::KEY_SUPERUSER ); - get_role( $role )->remove_cap( Capabilities::KEY_WRITE ); - get_role( $role )->remove_cap( Capabilities::KEY_ADMIN ); - get_role( $role )->remove_cap( Capabilities::KEY_VIEW ); - } - } /** * @return string diff --git a/tests/phpunit/framework/test-matomo-ajax-case.php b/tests/phpunit/framework/test-matomo-ajax-case.php new file mode 100644 index 000000000..89e3c923a --- /dev/null +++ b/tests/phpunit/framework/test-matomo-ajax-case.php @@ -0,0 +1,24 @@ +matomo_fixture = new MatomoUnit_Matomo_Fixture(); + $this->matomo_fixture->set_up( $this ); + } + + public function tearDown(): void { + $this->matomo_fixture->tear_down(); + parent::tearDown(); + } + +} diff --git a/tests/phpunit/framework/test-matomo-test-case.php b/tests/phpunit/framework/test-matomo-test-case.php index 05d89347c..fd1cc64cb 100644 --- a/tests/phpunit/framework/test-matomo-test-case.php +++ b/tests/phpunit/framework/test-matomo-test-case.php @@ -35,6 +35,11 @@ */ class MatomoAnalytics_TestCase extends MatomoUnit_TestCase { + /** + * @var MatomoUnit_Matomo_Fixture + */ + protected $matomo_fixture; + /** * Disable creation of temporary tables. This may be needed when you're writing a test that is * tracking/archiving data. Problem is with temp tables many queries fail like this @@ -77,103 +82,12 @@ public function _drop_temporary_tables( $query ) { public function setUp(): void { parent::setUp(); - - if ( ! defined( 'PIWIK_TEST_MODE' ) ) { - define( 'PIWIK_TEST_MODE', true ); - } - - $annotations = PHPUnit\Util\Test::parseTestMethodAnnotations( static::class, $this->getName() ); - if ( ! empty( $annotations['method']['provideContainerConfig'][0] ) ) { - $container_config = $annotations['method']['provideContainerConfig'][0]; - - $method = new ReflectionMethod( $this, $container_config ); - $definitions = $method->invoke( $this ); - - Bootstrap::set_extra_di_definitions( $definitions ); - } else { - Bootstrap::set_extra_di_definitions( [] ); - } - - $uninstall = new Uninstaller(); - $uninstall->uninstall( true ); - - if ( is_multisite() ) { - $this->delete_extraneous_blogs(); - } - - clearstatcache(); - - Bootstrap::set_not_bootstrapped(); - - $settings = new Settings(); - $installer = new Installer( $settings ); - $installer->install(); - - // we need to init roles again... seems like WP isn't doing this by themselves... - // otherwise if one test adds eg Capability WRITE_MATOMO to a role "editor", in other tests this - // capability will still be present - global $wp_roles; - $wp_roles->init_roles(); - - $roles = new Roles( $settings ); - $roles->add_roles(); - - add_action( - 'set_current_user', - function () { - // auth might still be pointing to a different user... - Bootstrap::set_not_bootstrapped(); - } - ); - - add_action( - 'matomo_uninstall', - function () { - Option::clearCache(); - Cache::flushAll(); - \Piwik\Singleton::clearAll(); - API::unsetAllInstances(); - ArchiveTableCreator::clear(); - Site::clearCache(); - Archive::clearStaticCache(); - // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase - FrontController::$requestId = null; - Date::$now = null; - \Piwik\Tracker\Cache::deleteTrackerCache(); - \Piwik\NumberFormatter::getInstance()->clearCache(); - \Piwik\Plugins\ScheduledReports\API::$cache = array(); - Manager::getInstance()->deleteAll(); - \WpMatomo\Updater::unlock(); - PluginsArchiver::$archivers = array(); - $_GET = array(); - $_REQUEST = array(); - \Piwik\Container\StaticContainer::get( \Piwik\Translation\Translator::class )->reset(); - \Piwik\Log::unsetInstance(); - } - ); - - if ( ! empty( $GLOBALS['wpdb'] ) ) { - $GLOBALS['wpdb']->suppress_errors( false ); - } + $this->matomo_fixture = new MatomoUnit_Matomo_Fixture(); + $this->matomo_fixture->set_up( $this ); } public function tearDown(): void { - Bootstrap::set_extra_di_definitions( [] ); - - if ( ! empty( $GLOBALS['wpdb'] ) ) { - $GLOBALS['wpdb']->suppress_errors( true ); - } - - $uninstall = new Uninstaller(); - $uninstall->uninstall( true ); - - unset( $_GET['trigger'] ); - Metadata::clear_cache(); - - if ( is_multisite() ) { - $this->delete_extraneous_blogs(); - } - + $this->matomo_fixture->tear_down(); parent::tearDown(); } @@ -255,19 +169,4 @@ protected function create_set_super_admin() { return $id; } - - private function delete_extraneous_blogs() { - global $wpdb; - - switch_to_blog( 1 ); - - $blogs = $wpdb->get_results( 'SELECT blog_id, deleted FROM ' . $wpdb->blogs . ' ORDER BY blog_id', ARRAY_A ); - foreach ( $blogs as $blog ) { - if ( 1 === (int) $blog['deleted'] || 1 === (int) $blog['blog_id'] ) { - continue; - } - - wpmu_delete_blog( $blog['blog_id'] ); - } - } } diff --git a/tests/phpunit/wpmatomo/admin/test-getstarted.php b/tests/phpunit/wpmatomo/admin/test-getstarted.php index 90e19af62..7e907d113 100644 --- a/tests/phpunit/wpmatomo/admin/test-getstarted.php +++ b/tests/phpunit/wpmatomo/admin/test-getstarted.php @@ -42,7 +42,6 @@ public function test_show_renders_ui() { $this->get_started->show(); $output = ob_get_clean(); $this->assertNotEmpty( $output ); - $this->assertStringContainsString( 'About', $output ); } public function test_show_does_change_value_if_nonce() { diff --git a/tests/phpunit/wpmatomo/admin/test-install.php b/tests/phpunit/wpmatomo/admin/test-install.php index d1e404a1d..a6bc02bd5 100644 --- a/tests/phpunit/wpmatomo/admin/test-install.php +++ b/tests/phpunit/wpmatomo/admin/test-install.php @@ -25,7 +25,7 @@ public function setUp(): void { } public function tearDown(): void { - $this->reset_roles(); + $this->wordpress_fixture->reset_roles(); parent::tearDown(); } diff --git a/tests/phpunit/wpmatomo/admin/test-marketplace-setup-wizard-ajax.php b/tests/phpunit/wpmatomo/admin/test-marketplace-setup-wizard-ajax.php new file mode 100644 index 000000000..ffaa3b72a --- /dev/null +++ b/tests/phpunit/wpmatomo/admin/test-marketplace-setup-wizard-ajax.php @@ -0,0 +1,148 @@ +wordpress_fixture->switch_to_admin_page(); + + // create dummy marketplace plugin + $marketplace_plugin_dir = $this->get_marketplace_plugin_dir(); + if ( is_dir( $marketplace_plugin_dir ) + && count( scandir( $marketplace_plugin_dir ) ) > 1 + ) { + $this->markTestSkipped( 'cannot run this test while the real matomo-marketplace-for-wordpress plugin is installed' ); + } + + $dummy_plugin_content = <<- ', '' ); ?> + ', '' ); ?>
- '; ?> - - '; ?> + '; ?> +tracking code', 'matomo' ); ?>
+ '; ?>deactivate_marketplace(); + } + + public function tearDown(): void { + $this->deactivate_marketplace(); + $marketplace_plugin_dir = $this->get_marketplace_plugin_dir(); + unlink( $marketplace_plugin_dir . '/matomo-marketplace-for-wordpress.php' ); + rmdir( $marketplace_plugin_dir ); + } + + public function test_is_marketplace_active_fails_if_incorrect_nonce_given() { + wp_create_nonce( MarketplaceSetupWizard::AJAX_IS_ACTIVE_NONCE_NAME ); + + try { + $this->call_ajax( 'matomo_is_marketplace_active', [], [ '_ajax_nonce' => 'garbagevalue' ] ); + $this->fail( 'ajax method did not fail as expected' ); + } catch ( WPAjaxDieStopException $e ) { + $this->assertEquals( '-1', $e->getMessage() ); // see check_ajax_referer() + } + } + + public function test_is_marketplace_active_fails_if_user_cannot_activate_plugins() { + $userid = self::factory()->user->create( [ 'role' => 'editor' ] ); + wp_set_current_user( $userid ); + + $nonce = wp_create_nonce( MarketplaceSetupWizard::AJAX_IS_ACTIVE_NONCE_NAME ); + + $response = $this->call_ajax( 'matomo_is_marketplace_active', [], [ '_ajax_nonce' => $nonce ] ); + $this->assertEquals( + [ + 'success' => false, + 'data' => [ + 'message' => 'forbidden', + ], + ], + $response + ); + } + + public function test_is_marketplace_active_returns_true_if_plugin_is_active() { + $user_id = $this->factory->user->create( [ 'role' => 'administrator' ] ); + wp_set_current_user( $user_id ); + + $nonce_value = wp_create_nonce( MarketplaceSetupWizard::AJAX_IS_ACTIVE_NONCE_NAME ); + $result = activate_plugin( 'matomo-marketplace-for-wordpress/matomo-marketplace-for-wordpress.php' ); + $this->assertNull( $result ); + + $response = $this->call_ajax( 'matomo_is_marketplace_active', [], [ '_ajax_nonce' => $nonce_value ] ); + $this->assertEquals( [ 'active' => true ], $response ); + } + + public function test_is_marketplace_active_returns_false_if_plugin_is_not_active() { + $user_id = $this->factory->user->create( [ 'role' => 'administrator' ] ); + wp_set_current_user( $user_id ); + + $nonce_value = wp_create_nonce( MarketplaceSetupWizard::AJAX_IS_ACTIVE_NONCE_NAME ); + + $response = $this->call_ajax( 'matomo_is_marketplace_active', [], [ '_ajax_nonce' => $nonce_value ] ); + $this->assertEquals( [ 'active' => false ], $response ); + } + + public function test_activate_marketplace_plugin_fails_if_incorrect_nonce_given() { + $this->assertFalse( is_plugin_active( 'matomo-marketplace-for-wordpress/matomo-marketplace-for-wordpress.php' ) ); + + wp_create_nonce( MarketplaceSetupWizard::AJAX_ACTIVATE_NONCE_NAME ); + + try { + $this->call_ajax( 'matomo_activate_marketplace', [], [ '_ajax_nonce' => 'garbagevalue' ] ); + $this->fail( 'ajax method did not fail as expected' ); + } catch ( WPAjaxDieStopException $e ) { + $this->assertEquals( '-1', $e->getMessage() ); // see check_ajax_referer() + } + } + + public function test_activate_marketplace_plugin_fails_if_user_cannot_activate_plugins() { + $this->assertFalse( is_plugin_active( 'matomo-marketplace-for-wordpress/matomo-marketplace-for-wordpress.php' ) ); + + $userid = self::factory()->user->create( [ 'role' => 'editor' ] ); + wp_set_current_user( $userid ); + + $nonce = wp_create_nonce( MarketplaceSetupWizard::AJAX_ACTIVATE_NONCE_NAME ); + + $response = $this->call_ajax( 'matomo_activate_marketplace', [], [ '_ajax_nonce' => $nonce ] ); + $this->assertEquals( + [ + 'success' => false, + 'data' => [ + 'message' => 'forbidden', + ], + ], + $response + ); + } + + public function test_activate_marketplace_plugin_correctly_activates_the_plugin() { + $this->assertFalse( is_plugin_active( 'matomo-marketplace-for-wordpress/matomo-marketplace-for-wordpress.php' ) ); + + $userid = self::factory()->user->create( [ 'role' => 'administrator' ] ); + wp_set_current_user( $userid ); + + $nonce = wp_create_nonce( MarketplaceSetupWizard::AJAX_ACTIVATE_NONCE_NAME ); + + $response = $this->call_ajax( 'matomo_activate_marketplace', [], [ '_ajax_nonce' => $nonce ] ); + $this->assertEquals( [], $response ); + + $this->assertTrue( is_plugin_active( 'matomo-marketplace-for-wordpress/matomo-marketplace-for-wordpress.php' ) ); + } + + private function get_marketplace_plugin_dir() { + return ABSPATH . '/wp-content/plugins/matomo-marketplace-for-wordpress'; + } + + private function deactivate_marketplace() { + deactivate_plugins( 'matomo-marketplace-for-wordpress/matomo-marketplace-for-wordpress.php' ); + } +} diff --git a/tests/phpunit/wpmatomo/admin/test-trackingsettings-ajax.php b/tests/phpunit/wpmatomo/admin/test-trackingsettings-ajax.php new file mode 100644 index 000000000..cb40f3d5b --- /dev/null +++ b/tests/phpunit/wpmatomo/admin/test-trackingsettings-ajax.php @@ -0,0 +1,112 @@ +wordpress_fixture->switch_to_admin_page(); + } + + public function test_generate_tracking_code_fails_if_an_incorrect_nonce_is_given() { + wp_create_nonce( TrackingSettings::NONCE_NAME_GENERATE_TRACKING_CODE_AJAX ); + + try { + $this->call_ajax( 'matomo_generate_tracking_code', [], [ '_ajax_nonce' => 'garbagevalue' ] ); + $this->fail( 'ajax method did not fail as expected' ); + } catch ( WPAjaxDieStopException $e ) { + $this->assertEquals( '-1', $e->getMessage() ); // see check_ajax_referer() + } + } + + public function test_generate_tracking_code_returns_generated_code_using_settings() { + $nonce = wp_create_nonce( TrackingSettings::NONCE_NAME_GENERATE_TRACKING_CODE_AJAX ); + + $response = $this->call_ajax( 'matomo_generate_tracking_code', [], [ '_ajax_nonce' => $nonce ] ); + + $site = new Site(); + $idsite = $site->get_current_matomo_site_id(); + + $space = ''; + if ( version_compare( getenv( 'WORDPRESS_VERSION' ), '5.2', '<=' ) ) { + $space = ' '; + } + + $expected_js_code = <<
+JS; + + $this->assertEquals( + [ + 'script' => $expected_js_code, + 'noscript' => $expected_noscript_code, + ], + $response + ); + } + + public function test_generate_tracking_code_returns_generated_code_with_overrides_from_request() { + $nonce = wp_create_nonce( TrackingSettings::NONCE_NAME_GENERATE_TRACKING_CODE_AJAX ); + + $response = $this->call_ajax( + 'matomo_generate_tracking_code', + [], + [ + '_ajax_nonce' => $nonce, + 'track_mode' => TrackingSettings::TRACK_MODE_DEFAULT, + 'force_post' => true, + 'track_heartbeat' => 72, + ] + ); + + $site = new Site(); + $idsite = $site->get_current_matomo_site_id(); + + $space = ''; + if ( version_compare( getenv( 'WORDPRESS_VERSION' ), '5.2', '<=' ) ) { + $space = ' '; + } + + $expected_js_code = <<
+JS; + + $this->assertEquals( + [ + 'script' => $expected_js_code, + 'noscript' => $expected_noscript_code, + ], + $response + ); + } +} diff --git a/tests/phpunit/wpmatomo/test-access.php b/tests/phpunit/wpmatomo/test-access.php index e7bde6fb7..56e9546aa 100644 --- a/tests/phpunit/wpmatomo/test-access.php +++ b/tests/phpunit/wpmatomo/test-access.php @@ -32,7 +32,7 @@ public function setUp(): void { public function tearDown(): void { $this->capabilities->remove_hooks(); - $this->reset_roles(); + $this->wordpress_fixture->reset_roles(); parent::tearDown(); } diff --git a/tests/phpunit/wpmatomo/test-annotations.php b/tests/phpunit/wpmatomo/test-annotations.php index 0b8573a51..d0d9fcbd6 100644 --- a/tests/phpunit/wpmatomo/test-annotations.php +++ b/tests/phpunit/wpmatomo/test-annotations.php @@ -74,14 +74,14 @@ public function test_add_annotation_when_post_type_allowed() { ) ); - $post_id = self::factory()->post->create_and_get( array( 'post_title' => 'hello-world' ) ); - wp_publish_post( $post_id ); + $post = self::factory()->post->create_and_get( array( 'post_title' => 'hello-world' ) ); + wp_publish_post( $post ); $this->assertSame( array( array( 'date' => gmdate( 'Y-m-d' ), - 'note' => 'Published: hello-world - URL: http://example.org/?p=5', + 'note' => 'Published: hello-world - URL: http://example.org/?p=' . $post->ID, 'starred' => 0, 'user' => 'super user was set', 'idNote' => 0, diff --git a/tests/phpunit/wpmatomo/test-release.php b/tests/phpunit/wpmatomo/test-release.php index ca62a209e..786baa2c6 100644 --- a/tests/phpunit/wpmatomo/test-release.php +++ b/tests/phpunit/wpmatomo/test-release.php @@ -240,6 +240,57 @@ public function test_built_release_has_all_needed_matomo_contents_and_is_not_too } } + public function test_matomo_at_latest_stable_release() { + $response = wp_remote_request( 'https://api.matomo.org/1.0/getLatestVersion' ); + if ( is_wp_error( $response ) ) { + throw new \Exception( 'getLatestVersion request failed: ' . $response->get_error_message() ); + } + + $this->assertEquals( $response['body'], \Piwik\Version::VERSION ); + } + + public function test_wordpress_tested_up_to_is_latest() { + $response = wp_remote_request( 'https://api.wordpress.org/core/version-check/1.7/' ); + if ( is_wp_error( $response ) ) { + throw new \Exception( 'check for WordPress version failed: ' . $response->get_error_message() ); + } + + $body = json_decode( $response['body'], true ); + $latest_version = $body['offers'][0]['version']; + + $readme_txt = file_get_contents( __DIR__ . '/../../../readme.txt' ); + + preg_match( '/Tested up to: (\d+.\d+.\d+)/', $readme_txt, $matches ); + if ( empty( $matches[1] ) ) { + throw new \Exception( 'could not find tested up to version in readme.txt' ); + } + + $tested_up_to_version = $matches[1]; + + $this->assertEquals( $latest_version, $tested_up_to_version ); + } + + public function test_woocommerce_tested_up_to_is_latest() { + $response = wp_remote_request( 'https://api.wordpress.org/plugins/info/1.0/woocommerce.json' ); + if ( is_wp_error( $response ) ) { + throw new \Exception( 'check for woocommerce version failed: ' . $response->get_error_message() ); + } + + $body = json_decode( $response['body'], true ); + $latest_version = $body['version']; + + $matomo_php = file_get_contents( __DIR__ . '/../../../matomo.php' ); + + preg_match( '/WC tested up to: (\d+.\d+.\d+)/', $matomo_php, $matches ); + if ( empty( $matches[1] ) ) { + throw new \Exception( 'could not find WC tested up to version in matomo.php' ); + } + + $tested_up_to_version = $matches[1]; + + $this->assertEquals( $latest_version, $tested_up_to_version ); + } + private function get_zip_file_contents( $path_to_zip ) { // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.system_calls_shell_exec $output = shell_exec( 'unzip -l ' . $path_to_zip ); diff --git a/tests/phpunit/wpmatomo/test-scheduled-tasks.php b/tests/phpunit/wpmatomo/test-scheduled-tasks.php index b84f2ab83..c3019e0d5 100644 --- a/tests/phpunit/wpmatomo/test-scheduled-tasks.php +++ b/tests/phpunit/wpmatomo/test-scheduled-tasks.php @@ -181,6 +181,7 @@ public function test_geoip_update_does_not_reschedule_if_already_scheduled_withi */ public function test_geoip_only_runs_on_multisite_if_site_is_not_main_site() { if ( ! is_multisite() ) { + $this->markTestSkipped( 'only runs if multisite' ); return; } diff --git a/tests/phpunit/wpmatomo/test-settings.php b/tests/phpunit/wpmatomo/test-settings.php index 47c829a81..9c2c3dfc3 100644 --- a/tests/phpunit/wpmatomo/test-settings.php +++ b/tests/phpunit/wpmatomo/test-settings.php @@ -256,15 +256,6 @@ public function test_get_js_tracking_code_returns_js_tracking_code() { $this->assertSame( $test_value, $this->settings->get_js_tracking_code() ); } - public function test_get_tracking_cookie_domain_no_cookie_domain() { - $this->assertSame( '', $this->settings->get_tracking_cookie_domain() ); - } - - public function test_get_tracking_cookie_domain_returns_cookie_domain() { - $this->settings->set_global_option( 'track_across', true ); - $this->assertSame( '*.example.org', $this->settings->get_tracking_cookie_domain() ); - } - public function test_get_noscript_tracking_code_returns_noscript_tracking_code() { $this->assertSame( '', $this->settings->get_noscript_tracking_code() ); diff --git a/tests/phpunit/wpmatomo/test-trackingcode.php b/tests/phpunit/wpmatomo/test-trackingcode.php index 490bde147..35911df1a 100644 --- a/tests/phpunit/wpmatomo/test-trackingcode.php +++ b/tests/phpunit/wpmatomo/test-trackingcode.php @@ -196,6 +196,8 @@ public function test_add_feed_campaign() { } public function test_add_feed_tracking() { + global $post; + $this->settings->apply_tracking_related_changes( array( 'track_mode' => WpMatomo\Admin\TrackingSettings::TRACK_MODE_DEFAULT, @@ -208,7 +210,7 @@ public function test_add_feed_tracking() { $url = apply_filters( 'the_excerpt_rss', 'foobarbaz
' ); - $this->assertStringStartsWith( 'foobarbaz
ID . '&action_name=hello-world&urlref=http%3A%2F%2Fexample.org', $url ); $this->assertStringEndsWith( '" style="border:0;width:0;height:0" width="0" height="0" alt="" />', $url ); } diff --git a/tests/phpunit/wpmatomo/trackingcode/test-generatoroptions.php b/tests/phpunit/wpmatomo/trackingcode/test-generatoroptions.php new file mode 100644 index 000000000..aa1a57ca8 --- /dev/null +++ b/tests/phpunit/wpmatomo/trackingcode/test-generatoroptions.php @@ -0,0 +1,230 @@ +assertEquals( $settings->default_global_settings['track_api_endpoint'], $options->get_track_api_endpoint() ); + $this->assertEquals( $settings->default_global_settings['force_protocol'], $options->get_force_protocol() ); + $this->assertEquals( $settings->default_global_settings['track_js_endpoint'], $options->get_track_js_endpoint() ); + $this->assertEquals( $settings->default_global_settings['set_download_extensions'], $options->get_set_download_extensions() ); + $this->assertEquals( $settings->default_global_settings['add_download_extensions'], $options->get_add_download_extensions() ); + $this->assertEquals( $settings->default_global_settings['set_download_classes'], $options->get_set_download_classes() ); + $this->assertEquals( $settings->default_global_settings['set_link_classes'], $options->get_set_link_classes() ); + $this->assertEquals( $settings->default_global_settings['disable_cookies'], $options->get_disable_cookies() ); + $this->assertEquals( $settings->default_global_settings['track_crossdomain_linking'], $options->get_track_crossdomain_linking() ); + $this->assertEquals( $settings->default_global_settings['track_jserrors'], $options->get_track_jserrors() ); + $this->assertEquals( $settings->default_global_settings['track_across'], $options->get_track_across() ); + $this->assertEquals( $settings->default_global_settings['track_across_alias'], $options->get_track_across_alias() ); + $this->assertEquals( $settings->default_global_settings['force_post'], $options->get_force_post() ); + $this->assertEquals( $settings->default_global_settings['cookie_consent'], $options->get_cookie_consent() ); + $this->assertEquals( $settings->default_global_settings['limit_cookies'], $options->get_limit_cookies() ); + $this->assertEquals( $settings->default_global_settings['limit_cookies_visitor'], $options->get_limit_cookies_visitor() ); + $this->assertEquals( $settings->default_global_settings['limit_cookies_referral'], $options->get_limit_cookies_referral() ); + $this->assertEquals( $settings->default_global_settings['limit_cookies_session'], $options->get_limit_cookies_session() ); + $this->assertEquals( $settings->default_global_settings['track_datacfasync'], $options->get_track_datacfasync() ); + $this->assertEquals( $settings->default_global_settings['track_heartbeat'], $options->get_track_heartbeat() ); + $this->assertEquals( $settings->default_global_settings['track_content'], $options->get_track_content() ); + } + + public function test_construct_with_settings_missing_values() { + $settings = new \WpMatomo\Settings(); + $settings->set_global_option( 'track_api_endpoint', 'test value 1' ); + $settings->set_global_option( 'force_protocol', 'test value 2' ); + $settings->set_global_option( 'track_js_endpoint', 'test value 3' ); + $settings->set_global_option( 'set_download_extensions', 'test value 4' ); + $settings->set_global_option( 'add_download_extensions', 'test value 5' ); + $settings->set_global_option( 'set_download_classes', 'test value 6' ); + $settings->set_global_option( 'set_link_classes', 'test value 7' ); + $settings->set_global_option( 'track_crossdomain_linking', 'test value 9' ); + $settings->set_global_option( 'track_jserrors', 'test value 10' ); + $settings->set_global_option( 'track_across', 'test value 11' ); + $settings->set_global_option( 'force_post', 'test value 13' ); + $settings->set_global_option( 'cookie_consent', 'test value 14' ); + $settings->set_global_option( 'limit_cookies', 'test value 15' ); + $settings->set_global_option( 'limit_cookies_visitor', 16 ); + $settings->set_global_option( 'limit_cookies_referral', 17 ); + $settings->set_global_option( 'limit_cookies_session', 18 ); + $settings->set_global_option( 'track_heartbeat', 20 ); + $settings->set_global_option( 'track_content', 'test value 21' ); + + $options = new GeneratorOptions( $settings ); + + $this->assertEquals( 'test value 1', $options->get_track_api_endpoint() ); + $this->assertEquals( 'test value 2', $options->get_force_protocol() ); + $this->assertEquals( 'test value 3', $options->get_track_js_endpoint() ); + $this->assertEquals( 'test value 4', $options->get_set_download_extensions() ); + $this->assertEquals( 'test value 5', $options->get_add_download_extensions() ); + $this->assertEquals( 'test value 6', $options->get_set_download_classes() ); + $this->assertEquals( 'test value 7', $options->get_set_link_classes() ); + $this->assertEquals( null, $options->get_disable_cookies() ); + $this->assertEquals( 'test value 9', $options->get_track_crossdomain_linking() ); + $this->assertEquals( 'test value 10', $options->get_track_jserrors() ); + $this->assertEquals( 'test value 11', $options->get_track_across() ); + $this->assertEquals( null, $options->get_track_across_alias() ); + $this->assertEquals( 'test value 13', $options->get_force_post() ); + $this->assertEquals( 'test value 14', $options->get_cookie_consent() ); + $this->assertEquals( 'test value 15', $options->get_limit_cookies() ); + $this->assertEquals( 16, $options->get_limit_cookies_visitor() ); + $this->assertEquals( 17, $options->get_limit_cookies_referral() ); + $this->assertEquals( 18, $options->get_limit_cookies_session() ); + $this->assertEquals( null, $options->get_track_datacfasync() ); + $this->assertEquals( 20, $options->get_track_heartbeat() ); + $this->assertEquals( 'test value 21', $options->get_track_content() ); + } + + public function test_construct_with_settings() { + $settings = new \WpMatomo\Settings(); + $settings->set_global_option( 'track_api_endpoint', 'test value 1' ); + $settings->set_global_option( 'force_protocol', 'test value 2' ); + $settings->set_global_option( 'track_js_endpoint', 'test value 3' ); + $settings->set_global_option( 'set_download_extensions', 'test value 4' ); + $settings->set_global_option( 'add_download_extensions', 'test value 5' ); + $settings->set_global_option( 'set_download_classes', 'test value 6' ); + $settings->set_global_option( 'set_link_classes', 'test value 7' ); + $settings->set_global_option( 'disable_cookies', 'test value 8' ); + $settings->set_global_option( 'track_crossdomain_linking', 'test value 9' ); + $settings->set_global_option( 'track_jserrors', 'test value 10' ); + $settings->set_global_option( 'track_across', 'test value 11' ); + $settings->set_global_option( 'track_across_alias', 'test value 12' ); + $settings->set_global_option( 'force_post', 'test value 13' ); + $settings->set_global_option( 'cookie_consent', 'test value 14' ); + $settings->set_global_option( 'limit_cookies', 'test value 15' ); + $settings->set_global_option( 'limit_cookies_visitor', 16 ); + $settings->set_global_option( 'limit_cookies_referral', 17 ); + $settings->set_global_option( 'limit_cookies_session', 18 ); + $settings->set_global_option( 'track_datacfasync', 'test value 19' ); + $settings->set_global_option( 'track_heartbeat', 20 ); + $settings->set_global_option( 'track_content', 'test value 21' ); + + $options = new GeneratorOptions( $settings ); + + $this->assertEquals( 'test value 1', $options->get_track_api_endpoint() ); + $this->assertEquals( 'test value 2', $options->get_force_protocol() ); + $this->assertEquals( 'test value 3', $options->get_track_js_endpoint() ); + $this->assertEquals( 'test value 4', $options->get_set_download_extensions() ); + $this->assertEquals( 'test value 5', $options->get_add_download_extensions() ); + $this->assertEquals( 'test value 6', $options->get_set_download_classes() ); + $this->assertEquals( 'test value 7', $options->get_set_link_classes() ); + $this->assertEquals( 'test value 8', $options->get_disable_cookies() ); + $this->assertEquals( 'test value 9', $options->get_track_crossdomain_linking() ); + $this->assertEquals( 'test value 10', $options->get_track_jserrors() ); + $this->assertEquals( 'test value 11', $options->get_track_across() ); + $this->assertEquals( 'test value 12', $options->get_track_across_alias() ); + $this->assertEquals( 'test value 13', $options->get_force_post() ); + $this->assertEquals( 'test value 14', $options->get_cookie_consent() ); + $this->assertEquals( 'test value 15', $options->get_limit_cookies() ); + $this->assertEquals( 16, $options->get_limit_cookies_visitor() ); + $this->assertEquals( 17, $options->get_limit_cookies_referral() ); + $this->assertEquals( 18, $options->get_limit_cookies_session() ); + $this->assertEquals( 'test value 19', $options->get_track_datacfasync() ); + $this->assertEquals( 20, $options->get_track_heartbeat() ); + $this->assertEquals( 'test value 21', $options->get_track_content() ); + } + + public function test_construct_with_request_missing_values() { + $settings = new \WpMatomo\Settings(); + $request = [ + 'track_api_endpoint' => 'test value 1', + 'force_protocol' => 'test value 2', + 'track_js_endpoint' => 'test value 3', + 'set_download_extensions' => 'test value 4', + 'add_download_extensions' => 'test value 5', + 'set_download_classes' => 'test value 6', + 'set_link_classes' => 'test value 7', + 'track_crossdomain_linking' => 'test value 9', + 'track_jserrors' => 'test value 10', + 'track_across' => 'test value 11', + 'track_across_alias' => 'test value 12', + 'force_post' => 'test value 13', + 'cookie_consent' => 'test value 14', + 'limit_cookies' => 'test value 15', + 'limit_cookies_referral' => 'test value 17', + 'limit_cookies_session' => 'test value 18', + 'track_heartbeat' => 'test value 19', + 'track_content' => 'test value 21', + ]; + + $options = new GeneratorOptions( $settings, $request ); + + $this->assertEquals( 'test value 1', $options->get_track_api_endpoint() ); + $this->assertEquals( 'test value 2', $options->get_force_protocol() ); + $this->assertEquals( 'test value 3', $options->get_track_js_endpoint() ); + $this->assertEquals( 'test value 4', $options->get_set_download_extensions() ); + $this->assertEquals( 'test value 5', $options->get_add_download_extensions() ); + $this->assertEquals( 'test value 6', $options->get_set_download_classes() ); + $this->assertEquals( 'test value 7', $options->get_set_link_classes() ); + $this->assertEquals( null, $options->get_disable_cookies() ); + $this->assertEquals( 'test value 9', $options->get_track_crossdomain_linking() ); + $this->assertEquals( 'test value 10', $options->get_track_jserrors() ); + $this->assertEquals( 'test value 11', $options->get_track_across() ); + $this->assertEquals( 'test value 12', $options->get_track_across_alias() ); + $this->assertEquals( 'test value 13', $options->get_force_post() ); + $this->assertEquals( 'test value 14', $options->get_cookie_consent() ); + $this->assertEquals( 'test value 15', $options->get_limit_cookies() ); + $this->assertEquals( 34186669, $options->get_limit_cookies_visitor() ); + $this->assertEquals( 'test value 17', $options->get_limit_cookies_referral() ); + $this->assertEquals( 'test value 18', $options->get_limit_cookies_session() ); + $this->assertEquals( 'test value 19', $options->get_track_heartbeat() ); + $this->assertEquals( null, $options->get_track_datacfasync() ); + $this->assertEquals( 'test value 21', $options->get_track_content() ); + } + + public function test_construct_with_full_request() { + $settings = new \WpMatomo\Settings(); + $request = [ + 'track_api_endpoint' => 'test value 1', + 'force_protocol' => 'test value 2', + 'track_js_endpoint' => 'test value 3', + 'set_download_extensions' => 'test value 4', + 'add_download_extensions' => 'test value 5', + 'set_download_classes' => 'test value 6', + 'set_link_classes' => 'test value 7', + 'disable_cookies' => 'test value 8', + 'track_crossdomain_linking' => 'test value 9', + 'track_jserrors' => 'test value 10', + 'track_across' => 'test value 11', + 'track_across_alias' => 'test value 12', + 'force_post' => 'test value 13', + 'cookie_consent' => 'test value 14', + 'limit_cookies' => 'test value 15', + 'limit_cookies_visitor' => 'test value 16', + 'limit_cookies_referral' => 'test value 17', + 'limit_cookies_session' => 'test value 18', + 'track_heartbeat' => 'test value 19', + 'track_datacfasync' => 'test value 20', + 'track_content' => 'test value 21', + ]; + + $options = new GeneratorOptions( $settings, $request ); + + $this->assertEquals( 'test value 1', $options->get_track_api_endpoint() ); + $this->assertEquals( 'test value 2', $options->get_force_protocol() ); + $this->assertEquals( 'test value 3', $options->get_track_js_endpoint() ); + $this->assertEquals( 'test value 4', $options->get_set_download_extensions() ); + $this->assertEquals( 'test value 5', $options->get_add_download_extensions() ); + $this->assertEquals( 'test value 6', $options->get_set_download_classes() ); + $this->assertEquals( 'test value 7', $options->get_set_link_classes() ); + $this->assertEquals( 'test value 8', $options->get_disable_cookies() ); + $this->assertEquals( 'test value 9', $options->get_track_crossdomain_linking() ); + $this->assertEquals( 'test value 10', $options->get_track_jserrors() ); + $this->assertEquals( 'test value 11', $options->get_track_across() ); + $this->assertEquals( 'test value 12', $options->get_track_across_alias() ); + $this->assertEquals( 'test value 13', $options->get_force_post() ); + $this->assertEquals( 'test value 14', $options->get_cookie_consent() ); + $this->assertEquals( 'test value 15', $options->get_limit_cookies() ); + $this->assertEquals( 'test value 16', $options->get_limit_cookies_visitor() ); + $this->assertEquals( 'test value 17', $options->get_limit_cookies_referral() ); + $this->assertEquals( 'test value 18', $options->get_limit_cookies_session() ); + $this->assertEquals( 'test value 19', $options->get_track_heartbeat() ); + $this->assertEquals( 'test value 20', $options->get_track_datacfasync() ); + $this->assertEquals( 'test value 21', $options->get_track_content() ); + } +} diff --git a/tests/phpunit/wpmatomo/trackingcode/test-trackingcodegenerator.php b/tests/phpunit/wpmatomo/trackingcode/test-trackingcodegenerator.php index 580bb4d85..505ca90e8 100644 --- a/tests/phpunit/wpmatomo/trackingcode/test-trackingcodegenerator.php +++ b/tests/phpunit/wpmatomo/trackingcode/test-trackingcodegenerator.php @@ -3,12 +3,10 @@ * @package matomo */ -use WpMatomo\Access; use WpMatomo\Admin\TrackingSettings; use WpMatomo\Admin\CookieConsent; -use WpMatomo\Capabilities; -use WpMatomo\Roles; use WpMatomo\Settings; +use WpMatomo\TrackingCode\GeneratorOptions; use WpMatomo\TrackingCode\TrackingCodeGenerator; class TrackingCodeGeneratorTest extends MatomoUnit_TestCase { @@ -31,7 +29,7 @@ public function setUp(): void { } private function make_tracking_code() { - $this->tracking_code = new TrackingCodeGenerator( $this->settings ); + $this->tracking_code = new TrackingCodeGenerator( $this->settings, new GeneratorOptions( $this->settings ) ); } private function get_tracking_code() { @@ -280,4 +278,44 @@ public function test_cookie_consent_tracking() { ); $this->assertStringContainsString( "_paq.push(['requireConsent']);", $this->get_tracking_code() ); } + + public function test_get_tracking_cookie_domain_no_cookie_domain() { + $this->make_tracking_code(); + $this->assertSame( '', $this->tracking_code->get_tracking_cookie_domain() ); + } + + public function test_get_tracking_cookie_domain_returns_cookie_domain() { + $this->make_tracking_code(); + $this->settings->set_global_option( 'track_across', true ); + $this->assertSame( '*.example.org', $this->tracking_code->get_tracking_cookie_domain() ); + } + + public function test_prepare_tracking_code_when_using_options_from_request() { + $cdata_start = "/* */\n"; + if ( getenv( 'WORDPRESS_VERSION' ) && ( getenv( 'WORDPRESS_VERSION' ) !== 'latest' && version_compare( getenv( 'WORDPRESS_VERSION' ), '6.4', '<' ) ) ) { + $cdata_start = ''; + $cdata_end = ''; + } + + $request = [ + 'track_mode' => TrackingSettings::TRACK_MODE_DEFAULT, + 'force_post' => true, + 'track_heartbeat' => 72, + ]; + + $settings = new Settings(); + $generator = new TrackingCodeGenerator( $settings, new GeneratorOptions( $settings, $request ) ); + + $this->assertSame( + [ + 'script' => '\n", + 'noscript' => '
', + ], + $generator->prepare_tracking_code( 1 ) + ); + } } diff --git a/tests/phpunit/wpmatomo/wpstatistics/test-import.php b/tests/phpunit/wpmatomo/wpstatistics/test-import.php index fd8802120..32d0827bb 100644 --- a/tests/phpunit/wpmatomo/wpstatistics/test-import.php +++ b/tests/phpunit/wpmatomo/wpstatistics/test-import.php @@ -38,7 +38,13 @@ public function manually_load_plugin() { $file = $this->plugin_file(); if ( file_exists( $file ) ) { require_once $file; - $GLOBALS['WP_Statistics']->includes(); + + $wp_statistics = $GLOBALS['WP_Statistics']; + if ( method_exists( $wp_statistics, 'plugin_setup' ) ) { + $wp_statistics->plugin_setup(); + } else { + $wp_statistics->includes(); + } } } @@ -83,11 +89,23 @@ public function setUp(): void { * Download the geoip database for the GeoIP2 client * * @return void - * @throws Exception In case there is an error while downloading the geoip database. + * @throws \Exception In case there is an error while downloading the geoip database. */ private function download_geoip() { + // wpstatistics fails to download geoip during tests, so we do it ourselves and link it into the wpstatistics directory + $wp_statistics_geoip_url = 'https://cdn.jsdelivr.net/npm/geolite2-city/GeoLite2-City.mmdb.gz'; + $schedule_task = new ScheduledTasks( new Settings() ); - $schedule_task->update_geo_ip2_db(); + $schedule_task->update_geo_ip2_db( $wp_statistics_geoip_url ); + + $expected_path = ABSPATH . '/wp-content/uploads/matomo/GeoIP2-City.mmdb'; + if ( ! is_file( $expected_path ) ) { + throw new \Exception( 'failed to download geoip database. contents of upload directory: ' . var_export( scandir( dirname( $expected_path ) ), true ) ); + } + + $wpstats_database_path = ABSPATH . '/wp-content/uploads/wp-statistics/GeoLite2-City.mmdb'; + mkdir( dirname( $wpstats_database_path ), 0777, true ); + symlink( $expected_path, $wpstats_database_path ); } public function test_countries_found() { @@ -197,10 +215,8 @@ public function test_pages_found() { return; } - $possible_values = [ 156, 81, 77, 90, 91 ]; - $report = $this->fetch_report( 'Actions', 'getPageUrls' ); - $this->assertContains( $report['reportData']->getRowsCount(), $possible_values ); + $this->assertGreaterThan( 75, $report['reportData']->getRowsCount() ); } protected function fetch_report( $report_name, $method ) {
- ',
+ '',
+ '',
+ ''
+);
diff --git a/classes/WpMatomo/Admin/views/info_shared.php b/classes/WpMatomo/Admin/views/info_shared.php
index 82a7cea5f..174736fae 100644
--- a/classes/WpMatomo/Admin/views/info_shared.php
+++ b/classes/WpMatomo/Admin/views/info_shared.php
@@ -11,23 +11,14 @@
exit; // if accessed directly
}
?>
-
',
+ ],
+ $generator->prepare_tracking_code( 1 )
+ );
+ }
}
diff --git a/tests/phpunit/wpmatomo/wpstatistics/test-import.php b/tests/phpunit/wpmatomo/wpstatistics/test-import.php
index fd8802120..32d0827bb 100644
--- a/tests/phpunit/wpmatomo/wpstatistics/test-import.php
+++ b/tests/phpunit/wpmatomo/wpstatistics/test-import.php
@@ -38,7 +38,13 @@ public function manually_load_plugin() {
$file = $this->plugin_file();
if ( file_exists( $file ) ) {
require_once $file;
- $GLOBALS['WP_Statistics']->includes();
+
+ $wp_statistics = $GLOBALS['WP_Statistics'];
+ if ( method_exists( $wp_statistics, 'plugin_setup' ) ) {
+ $wp_statistics->plugin_setup();
+ } else {
+ $wp_statistics->includes();
+ }
}
}
@@ -83,11 +89,23 @@ public function setUp(): void {
* Download the geoip database for the GeoIP2 client
*
* @return void
- * @throws Exception In case there is an error while downloading the geoip database.
+ * @throws \Exception In case there is an error while downloading the geoip database.
*/
private function download_geoip() {
+ // wpstatistics fails to download geoip during tests, so we do it ourselves and link it into the wpstatistics directory
+ $wp_statistics_geoip_url = 'https://cdn.jsdelivr.net/npm/geolite2-city/GeoLite2-City.mmdb.gz';
+
$schedule_task = new ScheduledTasks( new Settings() );
- $schedule_task->update_geo_ip2_db();
+ $schedule_task->update_geo_ip2_db( $wp_statistics_geoip_url );
+
+ $expected_path = ABSPATH . '/wp-content/uploads/matomo/GeoIP2-City.mmdb';
+ if ( ! is_file( $expected_path ) ) {
+ throw new \Exception( 'failed to download geoip database. contents of upload directory: ' . var_export( scandir( dirname( $expected_path ) ), true ) );
+ }
+
+ $wpstats_database_path = ABSPATH . '/wp-content/uploads/wp-statistics/GeoLite2-City.mmdb';
+ mkdir( dirname( $wpstats_database_path ), 0777, true );
+ symlink( $expected_path, $wpstats_database_path );
}
public function test_countries_found() {
@@ -197,10 +215,8 @@ public function test_pages_found() {
return;
}
- $possible_values = [ 156, 81, 77, 90, 91 ];
-
$report = $this->fetch_report( 'Actions', 'getPageUrls' );
- $this->assertContains( $report['reportData']->getRowsCount(), $possible_values );
+ $this->assertGreaterThan( 75, $report['reportData']->getRowsCount() );
}
protected function fetch_report( $report_name, $method ) {