Merge pull request #932 from mollie/fix/plugin-check-cleanup

Fix/plugin check cleanup
mollie · Aug 22, 2024 · c0b2d82 · c0b2d82
2 parents 4aeb49f + 240aaed
commit c0b2d82
Show file tree

Hide file tree

Showing 56 changed files with 629 additions and 513 deletions.
diff --git a/.distignore b/.distignore
@@ -4,6 +4,7 @@
 tests/
 resources/
 vendor/**/test*
+vendor/mollie/mollie-api-php/examples/
 languages/*.po
 bin/
 *.lock

diff --git a/composer.lock b/composer.lock
diff --git a/inc/settings/mollie_advanced_settings.php b/inc/settings/mollie_advanced_settings.php
@@ -71,6 +71,7 @@
             'lt_LT' => __('Lithuanian', 'mollie-payments-for-woocommerce'),
         ],
         'desc' => sprintf(
+        /* translators: Placeholder 1: link tag Placeholder 2: closing tag */
             __('Sending a language (or locale) is required. The option \'Automatically send WordPress language\' will try to get the customer\'s language in WordPress (and respects multilanguage plugins) and convert it to a format Mollie understands. If this fails, or if the language is not supported, it will fall back to American English. You can also select one of the locales currently supported by Mollie, that will then be used for all customers.', 'mollie-payments-for-woocommerce'),
             '<a href="https://www.mollie.com/nl/docs/reference/payments/create" target="_blank">',
             '</a>'
@@ -80,8 +81,8 @@
     [
         'id' => $pluginName . '_customer_details',
         'title' => __('Store customer details at Mollie', 'mollie-payments-for-woocommerce'),
-        /* translators: Placeholder 1: enabled or disabled */
         'desc' => sprintf(
+        /* translators: Placeholder 1: enabled or disabled Placeholder 2: translated string */
             __(
                 'Should Mollie store customers name and email address for Single Click Payments? Default <code>%1$s</code>. Required if WooCommerce Subscriptions is being used! Read more about <a href=\'https://help.mollie.com/hc/en-us/articles/115000671249-What-are-single-click-payments-and-how-does-it-work-\'>%2$s</a> and how it improves your conversion.',
                 'mollie-payments-for-woocommerce'
@@ -110,8 +111,8 @@
             ),
         ],
         'default' => PaymentService::PAYMENT_METHOD_TYPE_ORDER,
-        /* translators: Placeholder 1: opening link tag, placeholder 2: closing link tag */
         'desc' => sprintf(
+        /* translators: Placeholder 1: opening link tag, placeholder 2: closing link tag */
             __(
                 'Click %1$shere%2$s to read more about the differences between the Payments and Orders API',
                 'mollie-payments-for-woocommerce'
@@ -160,8 +161,8 @@ class="mollie-settings-advanced-payment-desc-label button button-secondary butto
                 array_keys($api_payment_description_labels),
                 $api_payment_description_labels
             )),
-            /* translators: Placeholder 1: Opening paragraph tag, placeholder 2: Closing paragraph tag */
             sprintf(
+            /* translators: Placeholder 1: Opening paragraph tag, placeholder 2: Closing paragraph tag */
                 __(
                     'Select among the available variables the description to be used for this transaction.%1$s(Note: this only works when the method is set to Payments API)%2$s',
                     'mollie-payments-for-woocommerce'
@@ -180,11 +181,9 @@ class="mollie-settings-advanced-payment-desc-label button button-secondary butto
         'type' => 'text',
         'custom_attributes' => ['maxlength' => '30'],
         'default' => __('Gateway Fee', 'mollie-payments-for-woocommerce'),
-        'desc' => sprintf(
-            __(
-                'This is the label will appear in frontend when the surcharge applies',
-                'mollie-payments-for-woocommerce'
-            )
+        'desc' => __(
+            'This is the label will appear in frontend when the surcharge applies',
+            'mollie-payments-for-woocommerce'
         ),
     ],
     [

diff --git a/inc/settings/mollie_applepay_settings.php b/inc/settings/mollie_applepay_settings.php
@@ -27,8 +27,8 @@
     [
         'id' => 'title',
         'title' => __('Title', 'mollie-payments-for-woocommerce'),
-        /* translators: Placeholder 1: Gateway title */
         'desc' => sprintf(
+            /* translators: Placeholder 1: Gateway title */
             __(
                 'This controls the title which the user sees during checkout. Default <code>%s</code>',
                 'mollie-payments-for-woocommerce'
@@ -44,11 +44,9 @@
     [
         'id' => 'display_logo',
         'title' => __('Display logo', 'mollie-payments-for-woocommerce'),
-        'desc' => sprintf(
-            __(
-                'Display logo',
-                'mollie-payments-for-woocommerce'
-            )
+        'desc' => __(
+            'Display logo',
+            'mollie-payments-for-woocommerce'
         ),
         'desc_tip' => true,
         'type' => 'checkbox',
@@ -59,8 +57,8 @@
     [
         'id' => 'description',
         'title' => __('Description', 'mollie-payments-for-woocommerce'),
-        /* translators: Placeholder 1: Gateway description */
         'desc' => sprintf(
+            /* translators: Placeholder 1: Gateway description */
             __(
                 'Payment method description that the customer will see on your checkout. Default <code>%s</code>',
                 'mollie-payments-for-woocommerce'
@@ -88,8 +86,8 @@
     [
         'id' => 'mollie_apple_pay_button_enabled_cart',
         'title' => __('Enable Apple Pay Button on Cart page', 'mollie-payments-for-woocommerce'),
-        /* translators: Placeholder 1: enabled or disabled */
         'desc' => sprintf(
+        /* translators: Placeholder 1: enabled or disabled */
             __(
                 'Enable the Apple Pay direct buy button on the Cart page',
                 'mollie-payments-for-woocommerce'
@@ -104,8 +102,8 @@
     [
         'id' => 'mollie_apple_pay_button_enabled_product',
         'title' => __('Enable Apple Pay Button on Product page', 'mollie-payments-for-woocommerce'),
-        /* translators: Placeholder 1: enabled or disabled */
         'desc' => sprintf(
+        /* translators: Placeholder 1: enabled or disabled */
             __(
                 'Enable the Apple Pay direct buy button on the Product page',
                 'mollie-payments-for-woocommerce'

diff --git a/pluginEnvironmentChecker/Constraints/AbstractVersionConstraint.php b/pluginEnvironmentChecker/Constraints/AbstractVersionConstraint.php
@@ -36,7 +36,7 @@ abstract class AbstractVersionConstraint implements ConstraintInterface
 	public function __construct($requiredVersion, $requiredPluginName = null)
 	{
 		$this->requiredVersion = $requiredVersion;
-		$this->requiredPluginName = $requiredPluginName;
+		$this->requiredPluginName = esc_html($requiredPluginName);
 		$this->error = '';
 		$this->message = '';
 	}
@@ -60,11 +60,13 @@ protected function checkVersion($actualVersion)
 		if ($result) {
 			return $result;
 		}
-		throw new ConstraintFailedException(
+        // phpcs:disable WordPress.Security.EscapeOutput.ExceptionNotEscaped
+        throw new ConstraintFailedException(
 			$this,
 			$actualVersion,
 			[$this->error],
-			$this->message
+			esc_html($this->message)
 		);
-	}
+        // phpcs:enable WordPress.Security.EscapeOutput.ExceptionNotEscaped
+    }
 }
diff --git a/pluginEnvironmentChecker/Constraints/ExtensionConstraint.php b/pluginEnvironmentChecker/Constraints/ExtensionConstraint.php
@@ -15,7 +15,7 @@ class ExtensionConstraint extends AbstractVersionConstraint
 	public function __construct($requiredVersion)
 	{
 		parent::__construct($requiredVersion);
-		$this->error = 'Required Extension not loaded';
+		$this->error = esc_html('Required Extension not loaded');
 	}
 
 	/**
@@ -25,18 +25,21 @@ public function check()
 	{
 		$this->message = $this->requiredVersion
 			. ' extension is required. Enable it in your server or ask your webhoster to enable it for you.';
+        $this->message = esc_html($this->message);
 		if (function_exists('extension_loaded')
 			&& !extension_loaded(
 				$this->requiredVersion
 			)
 		) {
-			throw new ConstraintFailedException(
+            // phpcs:disable WordPress.Security.EscapeOutput.ExceptionNotEscaped
+            throw new ConstraintFailedException(
 				$this,
 				$this->requiredVersion,
 				[$this->error],
 				$this->message
 			);
-		}
+            // phpcs:enable WordPress.Security.EscapeOutput.ExceptionNotEscaped
+        }
 		return true;
 	}
 }
diff --git a/pluginEnvironmentChecker/Constraints/PluginConstraint.php b/pluginEnvironmentChecker/Constraints/PluginConstraint.php
@@ -18,7 +18,7 @@ class PluginConstraint extends AbstractVersionConstraint
 	public function __construct($requiredVersion, $requiredPluginName, $pluginDisplayName)
 	{
 		parent::__construct($requiredVersion, $requiredPluginName);
-		$this->error = 'Plugin incompatibility';
+		$this->error = esc_html('Plugin incompatibility');
 		$this->requiredPluginName = $requiredPluginName;
 		$this->pluginDisplayName = $pluginDisplayName;
 	}
@@ -33,23 +33,26 @@ public function check()
 		if (!$isPluginActive) {
 			$this->message
 				= "The {$this->pluginDisplayName} plugin must be active. Please install & activate {$this->pluginDisplayName}";
-
+            // phpcs:disable WordPress.Security.EscapeOutput.ExceptionNotEscaped
 			throw new ConstraintFailedException(
 				$this,
-				$this->requiredPluginName,
+                esc_html($this->requiredPluginName),
 				[$this->error],
-				$this->message
+				esc_html($this->message)
 			);
-		}
+            // phpcs:enable WordPress.Security.EscapeOutput.ExceptionNotEscaped
+        }
 
 		$pathToPluginFile = $this->absolutePathToPlugin();
 		if (!$pathToPluginFile) {
-			throw new ConstraintFailedException(
+            // phpcs:disable WordPress.Security.EscapeOutput.ExceptionNotEscaped
+            throw new ConstraintFailedException(
 				$this,
-				$this->requiredPluginName,
+                esc_html($this->requiredPluginName),
 				[$this->error],
-				"Cannot find absolute path to {$this->pluginDisplayName} plugin"
+				esc_html("Cannot find absolute path to {$this->pluginDisplayName} plugin")
 			);
+            // phpcs:enable WordPress.Security.EscapeOutput.ExceptionNotEscaped
 		}
 		if (!function_exists('get_plugin_data')) {
 			require_once ABSPATH . 'wp-admin/includes/plugin.php';
@@ -59,7 +62,7 @@ public function check()
 		$this->message = "The {$this->pluginDisplayName} plugin has to be version "
 			. $this->requiredVersion
 			. " or higher. Please update your {$this->pluginDisplayName} version.";
-
+        $this->message = esc_html($this->message);
 		return $this->checkVersion(
 			$currentVersion
 		);

diff --git a/pluginEnvironmentChecker/Constraints/WordPressConstraint.php b/pluginEnvironmentChecker/Constraints/WordPressConstraint.php
@@ -12,7 +12,7 @@ class WordPressConstraint extends AbstractVersionConstraint
 	public function __construct($requiredVersion)
 	{
 		parent::__construct($requiredVersion);
-		$this->error = 'Wordpress version incompatibility';
+		$this->error = esc_html('Wordpress version incompatibility');
 	}
 
     /**
@@ -24,6 +24,7 @@ public function check()
 	    $this->message = 'WordPress version has to be '
 		    . $this->requiredVersion
 		    . ' or higher. Please update your WordPress version';
+        $this->message = esc_html($this->message);
 
 	    return $this->checkVersion(
 		    $WPCurrentVersion

diff --git a/pluginEnvironmentChecker/EnvironmentChecker.php b/pluginEnvironmentChecker/EnvironmentChecker.php
@@ -42,13 +42,15 @@ public function check()
 
 		$errCount = count($this->errors);
 		if ($errCount) {
-			throw new ConstraintFailedException(
+            // phpcs:disable WordPress.Security.EscapeOutput.ExceptionNotEscaped
+            throw new ConstraintFailedException(
 				$this,
 				'General Checker',
 				$this->errors,
-				$this->__('Validation failed with %1$d errors', [$errCount])
+				$this->esc_html__('Validation failed with %1$d errors', [$errCount])
 			);
-		}
+            // phpcs:enable WordPress.Security.EscapeOutput.ExceptionNotEscaped
+        }
 	}
 
 	/**
@@ -60,6 +62,6 @@ public function check()
 	 */
 	protected function __($string, $params = [])
 	{
-		return vsprintf($string, $params);
+		return esc_html(vsprintf($string, $params));
 	}
 }
diff --git a/src/Activation/ActivationModule.php b/src/Activation/ActivationModule.php
@@ -83,25 +83,6 @@ public function initDb()
     public function handleTranslations(): void
     {
         add_action('core_upgrade_preamble', 'mollieDeleteWPTranslationFiles');
-        add_filter(
-            'site_transient_update_plugins',
-            static function ($value) {
-                if (isset($value->translations)) {
-                    $i = 0;
-                    foreach ($value->translations as $translation) {
-                        if (
-                            $translation["slug"]
-                            === "mollie-payments-for-woocommerce"
-                        ) {
-                            unset($value->translations[$i]);
-                        }
-                        $i++;
-                    }
-                }
-
-                return $value;
-            }
-        );
     }
 
     /**
@@ -136,8 +117,8 @@ public function mollieWcNoticeApiKeyMissing()
         }
 
         $notice = new AdminNotice();
-        /* translators: Placeholder 1: Opening strong tag. Placeholder 2: Closing strong tag. Placeholder 3: Opening link tag to settings. Placeholder 4: Closing link tag.*/
         $message = sprintf(
+        /* translators: Placeholder 1: Opening strong tag. Placeholder 2: Closing strong tag. Placeholder 3: Opening link tag to settings. Placeholder 4: Closing link tag.*/
             esc_html__(
                 '%1$sMollie Payments for WooCommerce: API keys missing%2$s Please%3$s set your API keys here%4$s.',
                 'mollie-payments-for-woocommerce'
@@ -180,6 +161,7 @@ public function pluginInit()
             false,
             dirname(plugin_basename($this->baseFile)) . '/languages/'
         );
+
         $this->markUpdatedOrNew();
         $this->initDb();
     }

diff --git a/src/Activation/ConstraintsChecker.php b/src/Activation/ConstraintsChecker.php
@@ -103,11 +103,21 @@ public function maybeShowWarning($constraint, $warning)
 
     protected function showNotice(array $errors)
     {
-        $message = sprintf(__('%1$sMollie Payments for WooCommerce is inactive:%2$s', 'mollie-payments-for-woocommerce'), '<p><strong>', '</strong></p>');
+        $message = sprintf(
+        /* translators: Placeholder 1: opening tags Placeholder 2: closing tags */
+            __('%1$sMollie Payments for WooCommerce is inactive:%2$s', 'mollie-payments-for-woocommerce'),
+            '<p><strong>',
+            '</strong></p>'
+        );
         foreach ($errors as $error) {
             $message .= sprintf('<p>%s</p>', $error);
         }
-        $message .= sprintf(__('%1$sCorrect the above errors to use Mollie Payments for Woocommerce%2$s', 'mollie-payments-for-woocommerce'), '<p>', '</p>');
+        $message .= sprintf(
+        /* translators: Placeholder 1: opening tags Placeholder 2: closing tags */
+            __('%1$sCorrect the above errors to use Mollie Payments for Woocommerce%2$s', 'mollie-payments-for-woocommerce'),
+            '<p>',
+            '</p>'
+        );
         $errorLevel = 'notice-error';
         $this->notice->addNotice($errorLevel, $message);
     }

diff --git a/src/Assets/AssetsModule.php b/src/Assets/AssetsModule.php
@@ -247,7 +247,7 @@ protected function registerFrontendScripts(string $pluginUrl, string $pluginPath
             (string) filemtime($this->getPluginPath($pluginPath, '/public/js/applepayDirectCart.min.js')),
             true
         );
-        wp_register_script('mollie', 'https://js.mollie.com/v1/mollie.js', [], date("d"), true);
+        wp_register_script('mollie', 'https://js.mollie.com/v1/mollie.js', [], gmdate("d"), true);
         wp_register_script(
             'mollie-components',
             $this->getPluginUrl($pluginUrl, '/public/js/mollie-components.min.js'),

diff --git a/src/Buttons/ApplePayButton/AppleAjaxRequests.php b/src/Buttons/ApplePayButton/AppleAjaxRequests.php
@@ -116,7 +116,7 @@ public function validateMerchant()
         //we cannot access the endpoint in testmode, we override it to be testMode = false
         $apiKey = $this->settingsHelper->getApiKey(false);
         $validationUrl = $applePayRequestDataObject->validationUrl();
-        $completeDomain = parse_url(get_site_url(), PHP_URL_HOST);
+        $completeDomain = wp_parse_url(get_site_url(), PHP_URL_HOST);
         $removeHttp = ["https://", "http://"];
         $regex = '/.+\.\w+\/?((\w*\/*)*)/i';
         $domain = str_replace($removeHttp, "", $completeDomain);
@@ -695,8 +695,8 @@ function ($result, $order_id) {
                         )
                     );
                 } else {
-                    /* translators: Placeholder 1: Payment method title */
                     $message = sprintf(
+                    /* translators: Placeholder 1: Payment method title */
                         __(
                             'Could not create %s payment.',
                             'mollie-payments-for-woocommerce'

diff --git a/src/Buttons/ApplePayButton/ApplePayDirectHandler.php b/src/Buttons/ApplePayButton/ApplePayDirectHandler.php
@@ -37,8 +37,8 @@ public function __construct(AdminNotice $notice, AppleAjaxRequests $ajaxRequests
     public function bootstrap($buttonEnabledProduct, $buttonEnabledCart)
     {
         if (!$this->isApplePayCompatible()) {
-            /* translators: Placeholder 1: Opening strong tag. Placeholder 2: Closing strong tag. Placeholder 3: Opening link tag to documentation. Placeholder 4: Closing link tag.*/
             $message = sprintf(
+            /* translators: Placeholder 1: Opening strong tag. Placeholder 2: Closing strong tag. Placeholder 3: Opening link tag to documentation. Placeholder 4: Closing link tag.*/
                 esc_html__(
                     '%1$sServer not compliant with Apple requirements%2$s Check %3$sApple Server requirements page%4$s to fix it in order to make the Apple Pay button work',
                     'mollie-payments-for-woocommerce'
@@ -53,8 +53,8 @@ public function bootstrap($buttonEnabledProduct, $buttonEnabledCart)
         }
 
         if (!$this->merchantValidated()) {
-            /* translators: Placeholder 1: Opening link tag to documentation. Placeholder 2: Closing link tag.*/
             $message = sprintf(
+            /* translators: Placeholder 1: Opening link tag to documentation. Placeholder 2: Closing link tag.*/
                 esc_html__(
                     'Apple Pay Validation Error: Please review the %1$sApple Server requirements%2$s. If everything appears correct, click the Apple Pay button to retry validation.',
                     'mollie-payments-for-woocommerce'