Merge pull request #202 from mollie/9.2.6

QualityWorks · web-flow · commit 02e3923d2725 · 2020-02-26T12:36:36.000+01:00
9.2.6
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,13 @@
 
 # Changelog #
 
+#### Changes in release 9.2.6
+  + Redirected to success page after 'Open' payment status
+  + Made mollie_order_id primary in mollie_payments table 
+  + Added date_modified field in mollie_payments table 
+  + Call cleanup function on more occasions
+  + Added settings update to make sure module keeps working when an update introduces new settings
+
 #### Changes in release 9.2.5
   + Bugfix URL creation
   + Added option to force currency for payment
diff --git a/admin/controller/payment/mollie/base.php b/admin/controller/payment/mollie/base.php
@@ -272,9 +272,22 @@ public function cleanUp() {
 		$catalogControllerDir = DIR_CATALOG . 'controller/';
 		$catalogModelDir      = DIR_CATALOG . 'model/';
 
+		$files = array();
+
 		foreach (DEPRECATED_METHODS as $method) {
-			if (file_exists($adminControllerDir . 'extension/payment/mollie_' . $method . '.php')) {
-				unlink($adminControllerDir . 'extension/payment/mollie_' . $method . '.php');
+			$files = array(
+				$adminControllerDir . 'extension/payment/mollie_' . $method . '.php',
+				$catalogControllerDir . 'extension/payment/mollie_' . $method . '.php',
+				$catalogModelDir . 'extension/payment/mollie_' . $method . '.php',
+				$adminControllerDir . 'payment/mollie_' . $method . '.php',
+				$catalogControllerDir . 'payment/mollie_' . $method . '.php',
+				$catalogModelDir . 'payment/mollie_' . $method . '.php'
+			);
+
+			foreach ($files as $file) {
+				if (file_exists($file)) {
+					unlink($file);
+				}
 			}
 
 			$languageFiles = glob($adminLanguageDir . '*/extension/payment/mollie_' . $method . '.php');
@@ -284,67 +297,51 @@ public function cleanUp() {
 				}
 			}
 
-			if (file_exists($catalogControllerDir . 'extension/payment/mollie_' . $method . '.php')) {
-				unlink($catalogControllerDir . 'extension/payment/mollie_' . $method . '.php');
-			}
-
-			if (file_exists($catalogModelDir . 'extension/payment/mollie_' . $method . '.php')) {
-				unlink($catalogModelDir . 'extension/payment/mollie_' . $method . '.php');
-			}
-
-			if (file_exists($adminControllerDir . 'payment/mollie_' . $method . '.php')) {
-				unlink($adminControllerDir . 'payment/mollie_' . $method . '.php');
-			}
-
 			$languageFiles = glob($adminLanguageDir . '*/payment/mollie_' . $method . '.php');
 			foreach ($languageFiles as $file) {
 				if (file_exists($file)) {
 					unlink($file);
 				}
 			}
-
-			if (file_exists($catalogControllerDir . 'payment/mollie_' . $method . '.php')) {
-				unlink($catalogControllerDir . 'payment/mollie_' . $method . '.php');
-			}
-
-			if (file_exists($catalogModelDir . 'payment/mollie_' . $method . '.php')) {
-				unlink($catalogModelDir . 'payment/mollie_' . $method . '.php');
-			}
 		}
 
 		if (MollieHelper::isOpenCart3x()) {
-			if(file_exists($adminThemeDir . 'extension/payment/mollie(max_1.5.6.4).tpl')) {
-				unlink($adminThemeDir . 'extension/payment/mollie(max_1.5.6.4).tpl');
-				unlink($adminThemeDir . 'payment/mollie(max_1.5.6.4).tpl');
-				unlink($catalogThemeDir . 'extension/payment/mollie_return.tpl');
-				unlink($catalogThemeDir . 'payment/mollie_return.tpl');
-				unlink($catalogThemeDir . 'extension/payment/mollie_checkout_form.tpl');
-				unlink($catalogThemeDir . 'payment/mollie_checkout_form.tpl');
-			}
-			//Remove twig file from old version
-			if(file_exists($adminThemeDir . 'extension/payment/mollie.twig')) {
-				unlink($adminThemeDir . 'extension/payment/mollie.twig');
-			}
-			if(file_exists($adminThemeDir . 'payment/mollie.twig')) {
-				unlink($adminThemeDir . 'payment/mollie.twig');
-			}
+			$files = array(
+				$adminThemeDir . 'extension/payment/mollie(max_1.5.6.4).tpl',
+				$adminThemeDir . 'payment/mollie(max_1.5.6.4).tpl',
+				$catalogThemeDir . 'extension/payment/mollie_return.tpl',
+				$catalogThemeDir . 'payment/mollie_return.tpl',
+				$catalogThemeDir . 'extension/payment/mollie_checkout_form.tpl',
+				$catalogThemeDir . 'payment/mollie_checkout_form.tpl',
+				$adminThemeDir . 'extension/payment/mollie.twig', //Remove twig file from old version
+				$adminThemeDir . 'payment/mollie.twig' //Remove twig file from old version
+			);
+			
 		} elseif (MollieHelper::isOpenCart2x()) {
-			if(file_exists($adminThemeDir . 'extension/payment/mollie(max_1.5.6.4).tpl')) {
-				unlink($adminThemeDir . 'extension/payment/mollie(max_1.5.6.4).tpl');
-				unlink($adminThemeDir . 'payment/mollie(max_1.5.6.4).tpl');
-				unlink($catalogThemeDir . 'extension/payment/mollie_return.twig');
-				unlink($catalogThemeDir . 'payment/mollie_return.twig');
-				unlink($catalogThemeDir . 'extension/payment/mollie_checkout_form.twig');
-				unlink($catalogThemeDir . 'payment/mollie_checkout_form.twig');
-			}
+			$files = array(
+				$adminThemeDir . 'extension/payment/mollie(max_1.5.6.4).tpl',
+				$adminThemeDir . 'payment/mollie(max_1.5.6.4).tpl',
+				$catalogThemeDir . 'extension/payment/mollie_return.twig',
+				$catalogThemeDir . 'payment/mollie_return.twig',
+				$catalogThemeDir . 'extension/payment/mollie_checkout_form.twig',
+				$catalogThemeDir . 'payment/mollie_checkout_form.twig'
+			);
+			
 		} else {
-			if(file_exists($adminThemeDir . 'extension/payment/mollie.tpl')) {
-				unlink($adminThemeDir . 'extension/payment/mollie.tpl');
-				unlink($adminThemeDir . 'payment/mollie.tpl');
-				unlink($catalogThemeDir . 'extension/payment/mollie_return.twig');
-				unlink($catalogThemeDir . 'payment/mollie_return.twig');
-				unlink($catalogThemeDir . 'extension/payment/mollie_checkout_form.twig');
-				unlink($catalogThemeDir . 'payment/mollie_checkout_form.twig');
+			$files = array(
+				$adminThemeDir . 'extension/payment/mollie.tpl',
+				$adminThemeDir . 'payment/mollie.tpl',
+				$catalogThemeDir . 'extension/payment/mollie_return.twig',
+				$catalogThemeDir . 'payment/mollie_return.twig',
+				$catalogThemeDir . 'extension/payment/mollie_checkout_form.twig',
+				$catalogThemeDir . 'payment/mollie_checkout_form.twig'
+			);
+			
+		}
+
+		foreach ($files as $file) {
+			if (file_exists($file)) {
+				unlink($file);
 			}
 		}
 
@@ -374,6 +371,24 @@ public function delTree($dir) {
 	    return rmdir($dir);
 	}
 
+	/**
+	 * Insert variables that are added in later versions.
+	*/
+	public function updateSettings() {
+		$code = MollieHelper::getModuleCode();
+        $stores = Util::info()->stores();
+        $vars = array(
+        	'default_currency' => 'DEF' // variable => default value
+        );
+        foreach($stores as $store) {
+        	foreach($vars as $var=>$val) {
+        		if (null == Util::config($store['store_id'])->get($code . '_' . $var, true)) {
+					Util::config($store['store_id'])->setValue($code, $code . '_' . $var, $val);
+				}
+        	}
+        }
+	}
+
 	/**
 	 * Trigger installation of all Mollie modules.
 	 */
@@ -431,41 +446,21 @@ public function clearData() {
 	public function index () {
 		// Double-check if clean-up has been done - For upgrades
 		if (empty($this->config->get('mollie_payment_version')) || $this->config->get('mollie_payment_version') < MOLLIE_VERSION) {
-			$this->cleanUp();
 			Util::config(0)->set('mollie_payment', 'mollie_payment_version', MOLLIE_VERSION);
 		}
 
-		$adminThemeDir = DIR_APPLICATION . 'view/template/';
-		if (MollieHelper::isOpenCart3x() || MollieHelper::isOpenCart2x()) {
-			if(file_exists($adminThemeDir . 'extension/payment/mollie(max_1.5.6.4).tpl') || file_exists($adminThemeDir . 'extension/payment/mollie.twig') || file_exists($adminThemeDir . 'payment/mollie.twig')) {
-				$this->cleanUp();
-			}
-		} else {
-			if(file_exists($adminThemeDir . 'extension/payment/mollie.tpl')) {
-				$this->cleanUp();
-			}
-		}
-
-		$adminControllerDir   = DIR_APPLICATION . 'controller/';
-		foreach (DEPRECATED_METHODS as $method) {
-			if (file_exists($adminControllerDir . 'extension/payment/mollie_' . $method . '.php') || file_exists($adminControllerDir . 'payment/mollie_' . $method . '.php')) {
-				$this->cleanUp();
-			}
-		}
-
-		$catalogControllerDir   = DIR_CATALOG . 'controller/';
-		
-		// Remove un-used files from version 8.x
-		if (file_exists($adminControllerDir . 'extension/payment/mollie') || file_exists($catalogControllerDir . 'extension/payment/mollie') || file_exists($catalogControllerDir . 'extension/payment/mollie-api-client')) {
-			$this->cleanUp();
-		}
+		// Run cleanup
+		$this->cleanUp();
 
 		//Also delete data related to deprecated modules from settings
 		$this->clearData();
 
 		// Run database patch
 		$this->patch();
 
+		// Update settings with newly added variables
+		$this->updateSettings();
+
 		//Load language data
 		$data = array("version" => MOLLIE_RELEASE);
 		Util::load()->language("payment/mollie", $data);
@@ -633,7 +628,7 @@ public function index () {
 			$code . "_ideal_shipping_status_id"   				=> 3,
 			$code . "_create_shipment_status_id"  				=> 3,
 			$code . "_ideal_refund_status_id"  					=> 11,
-			$code . "_create_shipment"  		  				=> 1,
+			$code . "_create_shipment"  		  				=> 3,
 			$code . "_refresh_token"  		  					=> '',
 			$code . "_payment_screen_language"  		  		=> 'en-gb',
 			$code . "_default_currency"  		  				=> 'DEF',
diff --git a/admin/patch/mollie/0_createMolliePaymentsTable.php b/admin/patch/mollie/0_createMolliePaymentsTable.php
@@ -3,13 +3,13 @@
 
 return function () {
     Util::patch()->table("mollie_payments")
-        ->addField("order_id", "INT(11) NOT NULL", "primary")
+        ->addField("order_id", "INT(11) NOT NULL")
         ->addField("method", "VARCHAR(32) NOT NULL")
-        ->addField("mollie_order_id", "VARCHAR(32) NOT NULL")
+        ->addField("mollie_order_id", "VARCHAR(32) NOT NULL", "primary")
         ->addField("transaction_id", "VARCHAR(32)")
         ->addField("bank_account", "VARCHAR(15)")
         ->addField("bank_status", "VARCHAR(20)")
         ->addField("refund_id", "VARCHAR(32)")
-		->addUnique("mollie_order_id")
+        ->addUnique("mollie_order_id")
         ->create();
 };
diff --git a/admin/patch/mollie/5_updatePrimaryKey.php b/admin/patch/mollie/5_updatePrimaryKey.php
@@ -0,0 +1,8 @@
+<?php
+
+return function () {
+    $query = $this->db->query("SHOW INDEX FROM `" .DB_PREFIX. "mollie_payments` where Key_name = 'PRIMARY'");
+	if($query->num_rows > 0 && $query->row['Column_name'] != 'mollie_order_id') {
+		$this->db->query("ALTER TABLE `" .DB_PREFIX. "mollie_payments` DROP PRIMARY KEY, ADD PRIMARY KEY (mollie_order_id)");
+	}
+};
diff --git a/admin/patch/mollie/6_addDateModifiedField.php b/admin/patch/mollie/6_addDateModifiedField.php
@@ -0,0 +1,8 @@
+<?php
+use comercia\Util;
+
+return function () {
+    Util::patch()->table("mollie_payments")
+        ->addField("date_modified", "DATETIME NOT NULL")
+        ->update();
+};
diff --git a/catalog/controller/payment/mollie/base.php b/catalog/controller/payment/mollie/base.php
@@ -1191,7 +1191,7 @@ public function callback()
         } else if(!empty($orderDetails->_embedded->payments)) {
 
             $payment = $orderDetails->_embedded->payments[0];
-            if (($payment->status == 'paid') && !in_array($paid_status_id, $orderStatuses)) {
+            if (($payment->status == 'paid' || $payment->status == 'open') && !in_array($paid_status_id, $orderStatuses)) {
                 $this->addOrderHistory($order, $paid_status_id, $this->language->get("response_success"), true);
                 $order['order_status_id'] = $paid_status_id;
             }
diff --git a/catalog/controller/payment/mollie/helper.php b/catalog/controller/payment/mollie/helper.php
@@ -5,7 +5,7 @@
 
 class MollieHelper
 {
-	const PLUGIN_VERSION = "9.2.5";
+	const PLUGIN_VERSION = "9.2.6";
 	const OUTH_URL = 'https://api.mollie.com/oauth2';
 
 	// All available modules. These should correspond to the Mollie_API_Object_Method constants.
diff --git a/catalog/model/payment/mollie/base.php b/catalog/model/payment/mollie/base.php
@@ -205,7 +205,7 @@ public function setPayment($order_id, $mollie_order_id, $method)
 	{
 		$bank_account = isset($this->session->data['mollie_issuer']) ? $this->session->data['mollie_issuer'] : NULL;
 		if (!empty($order_id) && !empty($mollie_order_id) && !empty($method)) {
-			$this->db->query("INSERT INTO `" . DB_PREFIX . "mollie_payments` SET `order_id` = '" . (int)$order_id . "', `mollie_order_id` = '" . $this->db->escape($mollie_order_id) . "', `method` = '" . $this->db->escape($method) . "', `bank_account` = '" . $this->db->escape($bank_account) . "' ON DUPLICATE KEY UPDATE `order_id` = '" . (int)$order_id . "'");
+			$this->db->query("INSERT INTO `" . DB_PREFIX . "mollie_payments` SET `order_id` = '" . (int)$order_id . "', `mollie_order_id` = '" . $this->db->escape($mollie_order_id) . "', `method` = '" . $this->db->escape($method) . "', `bank_account` = '" . $this->db->escape($bank_account) . "', `date_modified` = NOW() ON DUPLICATE KEY UPDATE `order_id` = '" . (int)$order_id . "'");
 
 			if ($this->db->countAffected() > 0) {
 				return TRUE;
@@ -227,7 +227,7 @@ public function setPayment($order_id, $mollie_order_id, $method)
 	public function updatePayment($order_id, $mollie_order_id, $data, $consumer = NULL)
 	{
 		if (!empty($order_id) && !empty($mollie_order_id)) {
-			$this->db->query("UPDATE `" . DB_PREFIX . "mollie_payments` SET `transaction_id` = '" . $this->db->escape($data['payment_id']) . "', `bank_status` = '" . $this->db->escape($data['status']) . "' WHERE `order_id` = '" . (int)$order_id . "' AND `mollie_order_id` = '" . $this->db->escape($mollie_order_id) . "'");
+			$this->db->query("UPDATE `" . DB_PREFIX . "mollie_payments` SET `transaction_id` = '" . $this->db->escape($data['payment_id']) . "', `bank_status` = '" . $this->db->escape($data['status']) . "', `date_modified` = NOW() WHERE `order_id` = '" . (int)$order_id . "' AND `mollie_order_id` = '" . $this->db->escape($mollie_order_id) . "'");
 
 			return $this->db->countAffected() > 0;
 		}
diff --git a/system/comercia/config.php b/system/comercia/config.php
@@ -6,11 +6,13 @@ class Config
     var $model;
     var $store_id;
     var $data = [];
+    var $db;
 
     function __construct($store_id = 0)
     {
         $this->model = Util::load()->model("setting/setting");
         $this->store_id = $store_id;
+        $this->db = Util::registry()->get("db");
         $data = Util::db()->query("SELECT * FROM " . DB_PREFIX . "setting WHERE store_id = " . $store_id . "");
         foreach ($data as $value) {
             if (!$value['serialized']) {
@@ -58,6 +60,16 @@ function set($code, $key, $value = false)
             $this->data[$key] = $val;
         }
     }
+
+    function setValue($code, $key, $value = '')
+    {
+        if (!is_array($value)) {
+            $this->db->query("INSERT INTO " . DB_PREFIX . "setting SET store_id = '" . (int)$this->store_id . "', `code` = '" . $this->db->escape($code) . "', `key` = '" . $this->db->escape($key) . "', `value` = '" . $this->db->escape($value) . "'");
+        } else {
+            $this->db->query("INSERT INTO " . DB_PREFIX . "setting SET store_id = '" . (int)$this->store_id . "', `code` = '" . $this->db->escape($code) . "', `key` = '" . $this->db->escape($key) . "', `value` = '" . $this->db->escape(json_encode($value, true)) . "', serialized = '1'");
+        }
+        $this->data[$key] = $value;
+    }
 }
 
 ?>
diff --git a/tests/unittests/catalog/model/ModelPaymentMollieIdealTest.php b/tests/unittests/catalog/model/ModelPaymentMollieIdealTest.php
@@ -64,7 +64,7 @@ public function testSetPaymentNothingAffected()
 		$this->model->db->expects($this->once())
 			->method("query")
 
-			->with("INSERT INTO `prefix_mollie_payments` SET `order_id` = '1337', `mollie_order_id` = '1bba1d8fdbd8103b46151634bdbe0a60', `method` = 'idl', `bank_account` = '' ON DUPLICATE KEY UPDATE `order_id` = '1337'");
+			->with("INSERT INTO `prefix_mollie_payments` SET `order_id` = '1337', `mollie_order_id` = '1bba1d8fdbd8103b46151634bdbe0a60', `method` = 'idl', `bank_account` = '', `date_modified` = NOW() ON DUPLICATE KEY UPDATE `order_id` = '1337'");
 
 		$this->model->db->expects($this->once())
 			->method("countAffected")
@@ -77,7 +77,7 @@ public function testSetPaymentPaymentSet()
 	{
 		$this->model->db->expects($this->once())
 			->method("query")
-			->with("INSERT INTO `prefix_mollie_payments` SET `order_id` = '1337', `mollie_order_id` = '1bba1d8fdbd8103b46151634bdbe0a60', `method` = 'idl', `bank_account` = '' ON DUPLICATE KEY UPDATE `order_id` = '1337'");
+			->with("INSERT INTO `prefix_mollie_payments` SET `order_id` = '1337', `mollie_order_id` = '1bba1d8fdbd8103b46151634bdbe0a60', `method` = 'idl', `bank_account` = '', `date_modified` = NOW() ON DUPLICATE KEY UPDATE `order_id` = '1337'");
 
 		$this->model->db->expects($this->once())
 			->method("countAffected")

Original file line number	Diff line number	Diff line change
`@@ -1191,7 +1191,7 @@ public function callback()`
`1191`	`1191`	`} else if(!empty($orderDetails->_embedded->payments)) {`
`1192`	`1192`
`1193`	`1193`	`$payment = $orderDetails->_embedded->payments[0];`
`1194`		`- if (($payment->status == 'paid') && !in_array($paid_status_id, $orderStatuses)) {`
	`1194`	`+ if (($payment->status == 'paid' \|\| $payment->status == 'open') && !in_array($paid_status_id, $orderStatuses)) {`
`1195`	`1195`	`$this->addOrderHistory($order, $paid_status_id, $this->language->get("response_success"), true);`
`1196`	`1196`	`$order['order_status_id'] = $paid_status_id;`
`1197`	`1197`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`
`6`	`6`	`class MollieHelper`
`7`	`7`	`{`
`8`		`- const PLUGIN_VERSION = "9.2.5";`
	`8`	`+ const PLUGIN_VERSION = "9.2.6";`
`9`	`9`	`const OUTH_URL = 'https://api.mollie.com/oauth2';`
`10`	`10`
`11`	`11`	`// All available modules. These should correspond to the Mollie_API_Object_Method constants.`
Original file line number	Diff line number	Diff line change
`@@ -205,7 +205,7 @@ public function setPayment($order_id, $mollie_order_id, $method)`
`205`	`205`	`{`
`206`	`206`	`$bank_account = isset($this->session->data['mollie_issuer']) ? $this->session->data['mollie_issuer'] : NULL;`
`207`	`207`	`if (!empty($order_id) && !empty($mollie_order_id) && !empty($method)) {`
`208`		- $this->db->query("INSERT INTO `" . DB_PREFIX . "mollie_payments` SET `order_id` = '" . (int)$order_id . "', `mollie_order_id` = '" . $this->db->escape($mollie_order_id) . "', `method` = '" . $this->db->escape($method) . "', `bank_account` = '" . $this->db->escape($bank_account) . "' ON DUPLICATE KEY UPDATE `order_id` = '" . (int)$order_id . "'");
	`208`	+ $this->db->query("INSERT INTO `" . DB_PREFIX . "mollie_payments` SET `order_id` = '" . (int)$order_id . "', `mollie_order_id` = '" . $this->db->escape($mollie_order_id) . "', `method` = '" . $this->db->escape($method) . "', `bank_account` = '" . $this->db->escape($bank_account) . "', `date_modified` = NOW() ON DUPLICATE KEY UPDATE `order_id` = '" . (int)$order_id . "'");
`209`	`209`
`210`	`210`	`if ($this->db->countAffected() > 0) {`
`211`	`211`	`return TRUE;`
`@@ -227,7 +227,7 @@ public function setPayment($order_id, $mollie_order_id, $method)`
`227`	`227`	`public function updatePayment($order_id, $mollie_order_id, $data, $consumer = NULL)`
`228`	`228`	`{`
`229`	`229`	`if (!empty($order_id) && !empty($mollie_order_id)) {`
`230`		- $this->db->query("UPDATE `" . DB_PREFIX . "mollie_payments` SET `transaction_id` = '" . $this->db->escape($data['payment_id']) . "', `bank_status` = '" . $this->db->escape($data['status']) . "' WHERE `order_id` = '" . (int)$order_id . "' AND `mollie_order_id` = '" . $this->db->escape($mollie_order_id) . "'");
	`230`	+ $this->db->query("UPDATE `" . DB_PREFIX . "mollie_payments` SET `transaction_id` = '" . $this->db->escape($data['payment_id']) . "', `bank_status` = '" . $this->db->escape($data['status']) . "', `date_modified` = NOW() WHERE `order_id` = '" . (int)$order_id . "' AND `mollie_order_id` = '" . $this->db->escape($mollie_order_id) . "'");
`231`	`231`
`232`	`232`	`return $this->db->countAffected() > 0;`
`233`	`233`	`}`