| 1 |
<?php |
| 2 |
/* |
| 3 |
Delegate class for talking to Vipps MobilePay, encapsulating all the low-level behaviour and mapping error codes to exceptions |
| 4 |
|
| 5 |
This file is part of the plugin Pay with Vipps and MobilePay for WooCommerce |
| 6 |
Copyright (c) 2019 WP-Hosting AS |
| 7 |
|
| 8 |
MIT License |
| 9 |
|
| 10 |
Copyright (c) 2019 WP-Hosting AS |
| 11 |
|
| 12 |
Permission is hereby granted, free of charge, to any person obtaining a copy |
| 13 |
of this software and associated documentation files (the "Software"), to deal |
| 14 |
in the Software without restriction, including without limitation the rights |
| 15 |
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 16 |
copies of the Software, and to permit persons to whom the Software is |
| 17 |
furnished to do so, subject to the following conditions: |
| 18 |
|
| 19 |
The above copyright notice and this permission notice shall be included in all |
| 20 |
copies or substantial portions of the Software. |
| 21 |
|
| 22 |
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 23 |
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 24 |
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 25 |
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 26 |
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 27 |
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 28 |
SOFTWARE. |
| 29 |
|
| 30 |
*/ |
| 31 |
if ( ! defined('ABSPATH') ) { |
| 32 |
exit; // Exit if accessed directly |
| 33 |
} |
| 34 |
require_once(dirname(__FILE__) . "/VippsApi.class.php"); |
| 35 |
|
| 36 |
class WC_Gateway_Vipps extends WC_Payment_Gateway { |
| 37 |
public $form_fields = null; |
| 38 |
public $dev_form_fields = null; |
| 39 |
public $id = 'vipps'; |
| 40 |
public $icon = ''; |
| 41 |
public $has_fields = true; |
| 42 |
public $method_title = 'Vipps MobilePay'; |
| 43 |
public $title = 'Vipps MobilePay'; |
| 44 |
public $method_description = ""; |
| 45 |
public $apiurl = null; |
| 46 |
public $testapiurl = null; |
| 47 |
public $api = null; |
| 48 |
public $supports = null; |
| 49 |
public $express_checkout_supported_product_types; |
| 50 |
|
| 51 |
public $captured_statuses; |
| 52 |
|
| 53 |
private static $instance = null; // This class uses the singleton pattern to make actions easier to handle |
| 54 |
|
| 55 |
protected $keyset = null; // This will contain all api keys etc for the gateway, keyed on the merchant serial number. |
| 56 |
|
| 57 |
// Just to avoid calculating these alot |
| 58 |
private $page_templates = null; |
| 59 |
private $page_list = null; |
| 60 |
|
| 61 |
|
| 62 |
|
| 63 |
// This returns the singleton instance of this class |
| 64 |
public static function instance() { |
| 65 |
if (null === self::$instance) { |
| 66 |
self::$instance = new self(); |
| 67 |
} |
| 68 |
return self::$instance; |
| 69 |
} |
| 70 |
|
| 71 |
public function add_image_upload_setting_widget () { |
| 72 |
add_action('admin_enqueue_scripts', function ($suff) { |
| 73 |
if ($suff == 'woocommerce_page_wc-settings' && (($_REQUEST['section'] ?? false) == 'vipps')) { |
| 74 |
if (!did_action('wp_enqueue_media')) { |
| 75 |
wp_enqueue_media(); |
| 76 |
} |
| 77 |
} |
| 78 |
}); |
| 79 |
} |
| 80 |
|
| 81 |
|
| 82 |
// Generates html for the woo_vipps_image settings widget type |
| 83 |
public function generate_woo_vipps_image_html ($key, $field) { |
| 84 |
$field_key = $this->get_field_key( $key ); |
| 85 |
$defaults = array( |
| 86 |
'title' => '', |
| 87 |
'disabled' => false, |
| 88 |
'class' => '', |
| 89 |
'css' => '', |
| 90 |
'placeholder' => '', |
| 91 |
'type' => 'woo_vipps_image', |
| 92 |
'desc_tip' => false, |
| 93 |
'description' => '', |
| 94 |
'custom_attributes' => array(), |
| 95 |
); |
| 96 |
$data = wp_parse_args( $field, $defaults ); |
| 97 |
|
| 98 |
$imgid = intval($this->get_option($key)); |
| 99 |
$image = $imgid ? wp_get_attachment_image_src($imgid) : ""; |
| 100 |
|
| 101 |
ob_start(); |
| 102 |
?> |
| 103 |
<tr valign="top"> |
| 104 |
<th scope="row" class="titledesc"> |
| 105 |
<label for="<?php echo esc_attr( $field_key ); ?>"><?php echo wp_kses_post( $data['title'] ); ?> <?php echo $this->get_tooltip_html( $data ); // WPCS: XSS ok. ?></label> |
| 106 |
</th> |
| 107 |
<td class="forminp"> |
| 108 |
<fieldset> |
| 109 |
<legend class="screen-reader-text"><span><?php echo wp_kses_post( $data['title'] ); ?></span></legend> |
| 110 |
<?php if ($image): ?> |
| 111 |
<a href="#" class="woo-vipps-image-upload"><img style="max-width: 360px; max-height: 360px" src="<?php echo $image[0]; ?>" /><span style="display:none" class='uploadtext'><?php _e('Upload image', 'woo-vipps'); ?></span></a> |
| 112 |
<a href="#" class="woo-vipps-image-remove"><?php _e('Remove image', 'woo-vipps');?></a> |
| 113 |
<?php else: ?> |
| 114 |
<a href="#" class="woo-vipps-image-upload"><img style="display:none; max-width:360px; max-height: 360px"/><span class='uploadtext'><?php _e('Upload image', 'woo-vipps'); ?></span></a> |
| 115 |
<a href="#" class="woo-vipps-image-remove" style="display:none;"><?php _e('Remove image', 'woo-vipps');?></a> |
| 116 |
<?php endif; ?> |
| 117 |
<input type="hidden" class="woo-vipps-image-input <?php echo esc_attr( $data['class'] ); ?>" name="<?php echo esc_attr( $field_key ); ?>" id="<?php echo esc_attr( $field_key ); ?>" value="<?php echo esc_attr($imgid); ?>" <?php echo $this->get_custom_attribute_html( $data ); // WPCS: XSS ok. ?> /> |
| 118 |
<?php echo $this->get_description_html( $data ); // WPCS: XSS ok. ?> |
| 119 |
</fieldset> |
| 120 |
</td> |
| 121 |
</tr> |
| 122 |
<?php |
| 123 |
|
| 124 |
return ob_get_clean(); |
| 125 |
} |
| 126 |
|
| 127 |
// Attempts to detect the current country based on the store's currency NT-2024-10-15 |
| 128 |
private function detect_country_from_currency() { |
| 129 |
$currency = get_woocommerce_currency(); |
| 130 |
switch ($currency) { |
| 131 |
case 'DKK': |
| 132 |
return 'DK'; |
| 133 |
case 'NOK': |
| 134 |
return 'NO'; |
| 135 |
case 'SEK': |
| 136 |
return 'SE'; |
| 137 |
case 'EUR': |
| 138 |
return 'FI'; |
| 139 |
default: |
| 140 |
return null; |
| 141 |
} |
| 142 |
} |
| 143 |
// Migrates the keysets to include the country setting if it's missing |
| 144 |
// This is an initial migration step to ensure the country setting is explicitly set. |
| 145 |
// We do this because we no longer want to automatically guess payment method name. NT-2024-10-15 |
| 146 |
private function migrate_keyset_with_country_detection() { |
| 147 |
$settings = get_option('woocommerce_vipps_settings', array()); |
| 148 |
if ($settings['country'] ?? false) return; // Already set, do nothing IOK 2024-10-17 |
| 149 |
|
| 150 |
// Now we are only wanting to do this with people who have already configured the plugin. These will have at least this value set: |
| 151 |
if ($settings['payment_method_name'] ?? false) { |
| 152 |
// This assumes that EUR == FI which will be correct for all users reaching this branch IOK 2024-10-17 |
| 153 |
$detected_country = $this->detect_country_from_currency(); |
| 154 |
// If we can't detect the country, there's nothing to migrate. "this cannot happen" etc. |
| 155 |
if (!$detected_country) return; |
| 156 |
|
| 157 |
$settings['country'] = $detected_country; |
| 158 |
update_option('woocommerce_vipps_settings', $settings); |
| 159 |
delete_transient('_vipps_keyset'); |
| 160 |
return; |
| 161 |
} |
| 162 |
} |
| 163 |
|
| 164 |
public function __construct() { |
| 165 |
$this->testapiurl = 'https://apitest.vipps.no'; |
| 166 |
$this->apiurl = 'https://api.vipps.no'; |
| 167 |
|
| 168 |
$this->method_description = __('Offer Vipps or MobilePay as a payment method', 'woo-vipps'); |
| 169 |
$this->method_title = __('Vipps MobilePay','woo-vipps'); |
| 170 |
$this->title = __('Vipps MobilePay','woo-vipps'); |
| 171 |
|
| 172 |
$this->icon = plugins_url('img/vmp-logo.png',__FILE__); |
| 173 |
$this->migrate_keyset_with_country_detection(); |
| 174 |
$this->init_form_fields(); |
| 175 |
$this->init_settings(); |
| 176 |
|
| 177 |
|
| 178 |
$this->api = new VippsApi($this); |
| 179 |
|
| 180 |
$this->supports = array('products','refunds'); |
| 181 |
|
| 182 |
// we need to disallow certain types of refunds; mostly manual refunds done before capture. IOK 2026-02-24 |
| 183 |
add_action( 'woocommerce_create_refund', array($this, 'woocommerce_create_refund'), 10, 2); |
| 184 |
|
| 185 |
// We can't guarantee any particular product type being supported, so we must enumerate those we are certain about |
| 186 |
// IOK 2020-04-21 Add support for WooCommerce Product Bundles |
| 187 |
$supported_types= array('simple','variable','variation','bundle', 'yith_bundle', 'gift-card'); |
| 188 |
$this->express_checkout_supported_product_types = apply_filters('woo_vipps_express_checkout_supported_product_types', $supported_types); |
| 189 |
|
| 190 |
add_action('woocommerce_update_options_payment_gateways_' . $this->id, array( $this, 'process_admin_options') ); |
| 191 |
add_action('admin_init', array($this, 'add_image_upload_setting_widget')); |
| 192 |
|
| 193 |
// Capturing, refunding and cancelling the order when transitioning states: |
| 194 |
// This are the statuses for which the Vipps MobilePay plugin should try to ensure capture has been made. |
| 195 |
// Normally, this is 'processing' and 'completed', but plugins may define other statuses. IOK 2018-10-05 |
| 196 |
// It is also possible to remove 'processing' from this list. If you do, you may use it as the end-state of the |
| 197 |
// Vipps MobilePay transaction (see below in after_vipps_order_status) IOK 2018-12-05 |
| 198 |
$resultstatus = $this->get_option('result_status'); |
| 199 |
$captured_statuses = apply_filters('woo_vipps_captured_statuses', array('processing', 'completed')); |
| 200 |
$captured_statuses = array_diff($captured_statuses, array($resultstatus)); |
| 201 |
|
| 202 |
$this->captured_statuses = $captured_statuses; |
| 203 |
|
| 204 |
$non_completed_captured_statuses = array_diff($captured_statuses, array('completed')); |
| 205 |
|
| 206 |
// This ensures that funds are captured when transitioning from 'on hold' to a status where the money |
| 207 |
// should be captured, and refunded when moved from this status to cancelled or refunded |
| 208 |
foreach($captured_statuses as $capstatus) { |
| 209 |
add_action('woocommerce_order_status_' . $capstatus, array($this, 'maybe_capture_payment')); |
| 210 |
} |
| 211 |
// We will refund money on cancelled orders, but only if they are *relatively new*. This is to |
| 212 |
// avoid accidents and issues where old orders are *somehow* cancelled even though they are complete. IOK 2024-08-12 |
| 213 |
add_action('woocommerce_order_status_cancelled', array($this, 'maybe_cancel_order')); |
| 214 |
// Add a full refund if neccessary *before* woocommerce does, on priority 10 IOK 2026-01-28 |
| 215 |
add_action('woocommerce_order_status_refunded', array($this, 'maybe_refund_order'), 9, 1); |
| 216 |
|
| 217 |
// Possibly delete orders that never went anywhere |
| 218 |
add_action('woocommerce_order_status_pending_to_cancelled', array($this, 'maybe_delete_order'), 99999, 1); |
| 219 |
|
| 220 |
// Disable emails for cancelled express orders that never went anywhere IOK 2026-09-09 |
| 221 |
add_filter('woocommerce_email_enabled_cancelled_order', function ( $enabled, $order, $email ) { |
| 222 |
if ( ! $order instanceof WC_Order ) { |
| 223 |
return $enabled; |
| 224 |
} |
| 225 |
$pm = $order->get_payment_method(); |
| 226 |
if (! Vipps::is_vipps_order($pm)){ |
| 227 |
return $enabled; |
| 228 |
} |
| 229 |
$is_vipps_express = (bool) $order->get_meta( '_vipps_express_checkout' ); |
| 230 |
$has_billing_email = (bool) $order->get_billing_email(); |
| 231 |
if ( $is_vipps_express) { |
| 232 |
return false; |
| 233 |
} |
| 234 |
return $enabled; |
| 235 |
}, 10, 3); |
| 236 |
|
| 237 |
// Handle orders when authorized |
| 238 |
add_action('woocommerce_payment_complete', array($this, 'order_payment_complete'), 10, 1); |
| 239 |
|
| 240 |
// when an order is complete, we need to check if there is reserved amount that is not captured |
| 241 |
// if so, we need to cancel this amount PMB 2024-11-21 |
| 242 |
// nb: note very late priority - we must have captured before, please |
| 243 |
// Also for orders that have been partially or completely refunded, or need to be set to cancelled IOK 2026-01-26 |
| 244 |
add_action('woocommerce_order_status_completed', array($this, 'maybe_cancel_reserved_amount'), 99); |
| 245 |
add_action('woocommerce_order_status_refunded', array($this, 'maybe_cancel_reserved_amount'), 99, 1); |
| 246 |
add_action('woocommerce_order_status_cancelled', array($this, 'maybe_cancel_reserved_amount'), 99, 1); |
| 247 |
|
| 248 |
// New handling for callbacks in the action scheduler. LP 2026-03-27 |
| 249 |
add_action('woo_vipps_action_process_callback', [$this, 'action_process_callback'], 10, 4); |
| 250 |
|
| 251 |
// Endpoint for setting shipping data for express checkout orders. LP 2026-03-30 |
| 252 |
add_action('rest_api_init', function() { |
| 253 |
register_rest_route(Vipps::get_rest_namespace('v1'), '/order-set-shipping', [ |
| 254 |
'methods' => 'POST', |
| 255 |
'callback' => [$this, 'rest_order_set_shipping'], |
| 256 |
'permission_callback' => function($request) { |
| 257 |
// Note: permission callbacks run twice, on purpose. LP 2026-04-01 |
| 258 |
// https://github.com/WP-API/WP-API/issues/2400 |
| 259 |
$input_token = $request->get_header('X-WooVipps-Token'); |
| 260 |
|
| 261 |
$order_id = $request->get_param('order_id'); |
| 262 |
|
| 263 |
$order = wc_get_order($order_id); |
| 264 |
if (!is_a($order, 'WC_Order')) { |
| 265 |
return new WP_Error('order_not_found', __('Order not found', 'woo-vipps'), ['status' => 404, 'order_id' => $order_id]); |
| 266 |
} |
| 267 |
|
| 268 |
// a small bit of security |
| 269 |
$auth_token = $order->get_meta('_vipps_authtoken'); |
| 270 |
if (!$input_token || !$auth_token || !hash_equals($input_token, $auth_token)) { |
| 271 |
/* translators: endpoint path, order id */ |
| 272 |
$this->log(sprintf(__('Wrong authtoken for rest endpoint %1$s for order %2$s', 'woo-vipps'), '/order-set-shipping', $order_id), 'warning'); |
| 273 |
return false; |
| 274 |
} |
| 275 |
return true; |
| 276 |
|
| 277 |
}, |
| 278 |
'args' => [ |
| 279 |
'order_id' => [ |
| 280 |
'required' => true, |
| 281 |
'validate_callback' => fn($param, $request, $key) => is_numeric($param), |
| 282 |
'sanitize_callback' => fn($param, $request, $key) => intval($param), |
| 283 |
], |
| 284 |
/* Data from Vipps callback or api poll. LP 2026-03-30 */ |
| 285 |
'vipps_order_data' => [ |
| 286 |
'required' => true, |
| 287 |
'validate_callback' => fn($param, $request, $key) => is_array($param), |
| 288 |
'sanitize_callback' => fn($param, $request, $key) => map_deep($param, 'sanitize_text_field'), |
| 289 |
], |
| 290 |
], |
| 291 |
]); |
| 292 |
}); |
| 293 |
} |
| 294 |
|
| 295 |
// this function is called after an order is changed to complete/refunded/cancelled. It checks if there is reserved money that is not captured |
| 296 |
// if there still is money reserved, then this amount is cancelled PMB 2024-11-21 |
| 297 |
// Ensure we've updated the vipps status before calling this. IOK 2026-01-28 |
| 298 |
public function maybe_cancel_reserved_amount ($orderid) { |
| 299 |
$order = wc_get_order($orderid); |
| 300 |
if (!$order) return; |
| 301 |
if (! Vipps::is_vipps_order($order)) return false; |
| 302 |
|
| 303 |
// Check that the normal maybe_capture_order hook has actually ran *and* done something, |
| 304 |
// it's only after this we know we have captured 'everything' so if there is anything left, |
| 305 |
// it should be cancelled. IOK 2025-05-04 |
| 306 |
// Also set in maybe_cancel and maybe_refund now - in all "final status" hooks. IOK 2026-01-28 |
| 307 |
if (! $order->get_meta('_vipps_capture_complete')) { |
| 308 |
return false; |
| 309 |
} |
| 310 |
|
| 311 |
$order_status = $order->get_status(); |
| 312 |
|
| 313 |
if ('completed' == $order_status) { |
| 314 |
// For safety, on completed orders also only want to do this for orders that have had *something* captured. IOK 2025-02-04 |
| 315 |
$captured = intval($order->get_meta('_vipps_captured')); |
| 316 |
if ($captured < 1) { |
| 317 |
return false; |
| 318 |
} |
| 319 |
} |
| 320 |
if ('cancelled' != $order_status) { |
| 321 |
// If not in the 'cancelled' state, allow merchants that do not reserve large amounts to opt out for safety IOK 2025-02-04 |
| 322 |
if (apply_filters('woo_vipps_never_cancel_uncaptured_money', false, $order)) { |
| 323 |
return false; |
| 324 |
} |
| 325 |
} |
| 326 |
|
| 327 |
$ok = true; |
| 328 |
|
| 329 |
$remaining = intval($order->get_meta('_vipps_capture_remaining')); |
| 330 |
|
| 331 |
if ($remaining > 0) { |
| 332 |
$this->log(sprintf(__("maybe_cancel_reserved_amount we have remaining reserved after capture of total %1\$s ",'woo-vipps'), $remaining),'debug'); |
| 333 |
} else { |
| 334 |
// IOK 2026-06-15 Nothing left to cancel, just return |
| 335 |
return false; |
| 336 |
} |
| 337 |
|
| 338 |
$currency = $order->get_currency(); |
| 339 |
try { |
| 340 |
$ok = $this->cancel_payment($order); |
| 341 |
if ($ok && $remaining && 'completed' == $order_status) { |
| 342 |
$amount = number_format($remaining/100, 2) . " " . $currency; |
| 343 |
$note = sprintf(__('Order %1$s: %2$s is cancelled to free up the reservation in the customers bank account.', 'woo-vipps'), $orderid, $amount); |
| 344 |
$order->add_order_note($note); |
| 345 |
} |
| 346 |
} catch (Exception $e) { |
| 347 |
$ok = false; |
| 348 |
// if this happens, we just log it - we may not have an active admin |
| 349 |
$msg = sprintf(__('Was not able to cancel remaining amount for the order %1$s: %2$s','woo-vipps'), $orderid, $e->getMessage()); |
| 350 |
$order->add_order_note($msg); |
| 351 |
$this->log($msg,'error'); |
| 352 |
} |
| 353 |
|
| 354 |
// We need to update the order details after the fact. We can't fix errors here though. IOK 2024-11-22 |
| 355 |
try { |
| 356 |
$this->update_vipps_payment_details($order); |
| 357 |
} catch (Exception $e) { |
| 358 |
// noop |
| 359 |
} |
| 360 |
|
| 361 |
// we just return true from this function for now PMB 2024-11-21 |
| 362 |
// return false if we couldn't cancel reserved. IOK 2024-11-22 |
| 363 |
return $ok; |
| 364 |
} |
| 365 |
|
| 366 |
|
| 367 |
public function get_icon () { |
| 368 |
$src = $this->icon; |
| 369 |
if ($this->get_payment_method_name() == "Vipps") { |
| 370 |
$src = plugins_url('img/vipps-mark.svg',__FILE__); |
| 371 |
} else { |
| 372 |
$src = plugins_url('img/mobilepay-mark.png',__FILE__); |
| 373 |
} |
| 374 |
return '<img src="' . esc_attr($src) . '" alt="' . $this->get_payment_method_name() . '">'; |
| 375 |
} |
| 376 |
|
| 377 |
|
| 378 |
// True iff this gateway is currently in test mode. IOK 2019-08-30 |
| 379 |
public function is_test_mode() { |
| 380 |
if (VIPPS_TEST_MODE) return true; |
| 381 |
if ($this->get_option('developermode') == 'yes' && $this->get_option('testmode') == 'yes') return true; |
| 382 |
return false; |
| 383 |
} |
| 384 |
// These abstraction gets the correct client id and so forth based on whether or not test mode is on |
| 385 |
// "test mode" is now per MSN, so we accept that as an argument IOK 2023-12-19 |
| 386 |
public function apiurl ($msn="") { |
| 387 |
$msn = $msn ?? $this->get_merchant_serial(); |
| 388 |
$keyset = $this->get_keyset(); |
| 389 |
$entry = $keyset ? ($keyset[$msn] ?? null) : null; |
| 390 |
if (!$entry) { |
| 391 |
$testmode = $this->is_test_mode(); |
| 392 |
} else { |
| 393 |
$testmode = $entry['testmode']; |
| 394 |
} |
| 395 |
if ($testmode) return $this->testapiurl; |
| 396 |
return $this->apiurl; |
| 397 |
} |
| 398 |
|
| 399 |
// This returns the *current* merchant serial number. There may be more than one, for instance if the test mode is on. |
| 400 |
// IOK 2023-12-19 |
| 401 |
public function get_merchant_serial() { |
| 402 |
$merch = $this->get_option('merchantSerialNumber'); |
| 403 |
$testmerch = @$this->get_option('merchantSerialNumber_test'); |
| 404 |
if (!empty($testmerch) && $this->is_test_mode()) return $testmerch; |
| 405 |
return $merch; |
| 406 |
} |
| 407 |
|
| 408 |
// Returns a table of all the keydata of this instance, keyed on MSN. IOK 2023-12-19 |
| 409 |
public function get_keyset() { |
| 410 |
if ($this->keyset) return $this->keyset; |
| 411 |
$stored = get_transient('_vipps_keyset'); |
| 412 |
if ($stored) { |
| 413 |
return $stored; |
| 414 |
} |
| 415 |
|
| 416 |
$keyset = []; |
| 417 |
$main = $this->get_option('merchantSerialNumber'); |
| 418 |
if ($main) { |
| 419 |
$data = ['client_id'=>$clientid=$this->get_option('clientId'), |
| 420 |
'client_secret' => $this->get_option('secret'), |
| 421 |
'sub_key'=>$this->get_option('Ocp_Apim_Key_eCommerce'), |
| 422 |
'country' => $this->get_option('country'), |
| 423 |
'gw' => 'vipps' |
| 424 |
]; |
| 425 |
if (! in_array(false, array_map('boolval', array_values($data)))) { |
| 426 |
$data['testmode'] = 0; // Must add after |
| 427 |
$keyset[$main] = $data; |
| 428 |
} |
| 429 |
} |
| 430 |
|
| 431 |
$test = @$this->get_option('merchantSerialNumber_test'); |
| 432 |
$testmode = @$this->get_option('testmode'); |
| 433 |
if ($testmode === 'yes' && $test) { |
| 434 |
$data = [ |
| 435 |
'client_id'=>$clientid=$this->get_option('clientId_test'), |
| 436 |
'client_secret' => $this->get_option('secret_test'), |
| 437 |
'sub_key'=>$this->get_option('Ocp_Apim_Key_eCommerce_test'), |
| 438 |
'country' => $this->get_option('country'), |
| 439 |
'gw' => 'vipps' |
| 440 |
]; |
| 441 |
|
| 442 |
if (! in_array(false, array_map('boolval', array_values($data)))) { |
| 443 |
$data['testmode'] = 1; |
| 444 |
$keyset[$test] = $data; |
| 445 |
} |
| 446 |
} |
| 447 |
|
| 448 |
$this->keyset = $keyset; |
| 449 |
set_transient('_vipps_keyset', $keyset, DAY_IN_SECONDS); |
| 450 |
return $keyset; |
| 451 |
} |
| 452 |
|
| 453 |
// Get and show any keysets from the Vipps Recurring plugin too IOK 2024-11-29 |
| 454 |
private function get_recurring_keysets () { |
| 455 |
$res = []; |
| 456 |
$settings = get_option( 'woocommerce_vipps_recurring_settings' ); |
| 457 |
if (empty($settings)) return $res; |
| 458 |
|
| 459 |
$country = $this->get_option('country'); |
| 460 |
|
| 461 |
$client_id = $settings["client_id"] ?? ""; |
| 462 |
$client_secret = $settings["secret_key"] ?? ""; |
| 463 |
$subscription_key = $settings["subscription_key"] ?? ""; |
| 464 |
$merchant_serial_number = $settings["merchant_serial_number"] ?? ""; |
| 465 |
if ($merchant_serial_number && $client_id && $client_secret && $subscription_key ) { |
| 466 |
$res[$merchant_serial_number] = ['client_id' => $client_id, 'client_secret' => $client_secret, 'sub_key' => $subscription_key, 'country' => $country, 'testmode' => 0, 'gw'=>'vipps_recurring']; |
| 467 |
} |
| 468 |
|
| 469 |
$client_id = $settings["test_client_id"] ?? ""; |
| 470 |
$client_secret = $settings["test_secret_key"] ?? ""; |
| 471 |
$subscription_key = $settings["test_subscription_key"] ?? ""; |
| 472 |
$merchant_serial_number = $settings["test_merchant_serial_number"] ?? ""; |
| 473 |
if ($merchant_serial_number && $client_id && $client_secret && $subscription_key ) { |
| 474 |
$res[$merchant_serial_number] = ['client_id' => $client_id, 'client_secret' => $client_secret, 'sub_key' => $subscription_key, 'country' => $country, 'testmode' => 1, 'gw'=>'vipps_recurring']; |
| 475 |
} |
| 476 |
return $res; |
| 477 |
} |
| 478 |
|
| 479 |
// Return all webhooks for our MSNs |
| 480 |
public function get_webhooks_from_vipps () { |
| 481 |
$keys = $this->get_keyset(); |
| 482 |
$hooks = []; |
| 483 |
foreach($keys as $msn=>$data) { |
| 484 |
try { |
| 485 |
$hooks[$msn] = $this->api->get_webhooks($msn); |
| 486 |
} catch (Exception $e) { |
| 487 |
$this->log(sprintf(__('Could not get webhooks for Merchant Serial Number %1$s: %2$s', 'woo-vipps'), $msn, $e->getMessage()), 'error'); |
| 488 |
$hooks[$msn]=[]; |
| 489 |
} |
| 490 |
} |
| 491 |
return $hooks; |
| 492 |
} |
| 493 |
|
| 494 |
|
| 495 |
// The rest of the settings gets the correct client id, secret, sub key and order prefix based on the MSN. |
| 496 |
public function get_clientid($msn="") { |
| 497 |
if (!$msn) $msn = $this->get_merchant_serial(); |
| 498 |
$keyset = $this->get_keyset(); |
| 499 |
if (!isset($keyset[$msn])) return false; |
| 500 |
return $keyset[$msn]['client_id']; |
| 501 |
} |
| 502 |
public function get_secret($msn="") { |
| 503 |
if (!$msn) $msn = $this->get_merchant_serial(); |
| 504 |
$keyset = $this->get_keyset(); |
| 505 |
if (!isset($keyset[$msn])) return false; |
| 506 |
return $keyset[$msn]['client_secret']; |
| 507 |
} |
| 508 |
public function get_key($msn="") { |
| 509 |
if (!$msn) $msn = $this->get_merchant_serial(); |
| 510 |
$keyset = $this->get_keyset(); |
| 511 |
if (!isset($keyset[$msn])) return false; |
| 512 |
return $keyset[$msn]['sub_key']; |
| 513 |
} |
| 514 |
public function get_country($msn="") { |
| 515 |
if (!$msn) $msn = $this->get_merchant_serial(); |
| 516 |
$keyset = $this->get_keyset(); |
| 517 |
if (!isset($keyset[$msn])) return false; |
| 518 |
return $keyset[$msn]['country']; |
| 519 |
} |
| 520 |
|
| 521 |
public function get_orderprefix() { |
| 522 |
$prefix = $this->get_option('orderprefix'); |
| 523 |
return $prefix; |
| 524 |
} |
| 525 |
|
| 526 |
// We did shenanigans here earlier, we don't have to do that anymore. IOK 2022-12-09 |
| 527 |
public function get_return_url($order=null) { |
| 528 |
$url = parent::get_return_url($order); |
| 529 |
return $url; |
| 530 |
} |
| 531 |
|
| 532 |
|
| 533 |
// Delete express checkout orders with no customer information - these were abandonend before the app started. |
| 534 |
// IOK 2019-08-26 |
| 535 |
public function maybe_delete_order ($orderid) { |
| 536 |
$order = wc_get_order($orderid); |
| 537 |
if (!$order) return; |
| 538 |
if (! Vipps::is_vipps_order($order)) return false; |
| 539 |
$express = $order->get_meta('_vipps_express_checkout'); |
| 540 |
if (!$express) return false; |
| 541 |
$email = $order->get_billing_email(); |
| 542 |
if ($email) return false; |
| 543 |
|
| 544 |
// Only delete if we have to |
| 545 |
if ($this->get_option('deletefailedexpressorders') != 'yes') return false; |
| 546 |
// Mark this order that an order that wasn't completed with any user info - it can be deleted. IOK 2019-11-13 |
| 547 |
$order->update_meta_data('_vipps_delendum',1); |
| 548 |
$order->save(); |
| 549 |
return true; |
| 550 |
} |
| 551 |
|
| 552 |
|
| 553 |
// Return the status to use after return from Vipps MobilePay for orders that are not both "virtual" and "downloadable". |
| 554 |
// These orders are *not* complete, and payment is *not* captured, which is why the default status is 'on-hold'. |
| 555 |
// If you use custom order statuses, or if you don't capture on 'processing' - see filter 'woo_vipps_captured_statuses' - |
| 556 |
// you can instead use 'processing' here - which is much nicer. |
| 557 |
// If you do so, remember to capture *before* shipping is done on the order - if you send the package and then do 'complete', |
| 558 |
// the capture may fail. IOK 2018-12-05 |
| 559 |
// |
| 560 |
// IOK As of 2023-12-22, the default is now 'processing', since this is more in line with what other gateways are using, |
| 561 |
// what other integrations and plugins expect, the most popular choice by users; and because of the fact that "on-hold" is |
| 562 |
// normally used to indicate "a problem with the order". Not being able to capture a reserved order has to my knowledge at this |
| 563 |
// point only happened once, in 2018, with a completely different api and backend. |
| 564 |
public function after_vipps_order_status($order=null) { |
| 565 |
// Revert to on-hold if the user tries to set a payment status that is a 'captured' status IOK 2024-01-25 |
| 566 |
$defaultstatus = 'on-hold'; |
| 567 |
|
| 568 |
$chosen = $this->get_option('result_status'); |
| 569 |
$newstatus = apply_filters('woo_vipps_after_vipps_order_status', $chosen, $order); |
| 570 |
|
| 571 |
if (in_array($newstatus, $this->captured_statuses)){ |
| 572 |
$this->log(sprintf(__("Cannot use %1\$s as status for non-autocapturable orders: payment is captured on this status. See the woo_vipps_captured_statuses-filter.",'woo-vipps'), $newstatus),'debug'); |
| 573 |
return $defaultstatus; |
| 574 |
} |
| 575 |
return $newstatus; |
| 576 |
} |
| 577 |
|
| 578 |
// Create callback urls' using WC's callback API in a way that works with Vipps MobilePay callbacks and both pretty and not so pretty urls. |
| 579 |
private function make_callback_urls($forwhat,$token='', $reference=0) { |
| 580 |
// Passing the token as GET arguments, as the Authorize header is stripped. IOK 2018-06-13 |
| 581 |
// This applies to Ecom, Checkout and Express Checkout callbacks. For epayment, we instead need to use |
| 582 |
// the webhook api, which is altogether different. IOK 2023-12-19 |
| 583 |
$url = home_url("/", 'https'); |
| 584 |
$queryargs = []; |
| 585 |
if ($token) $queryargs['tk']=$token; |
| 586 |
if ($reference) $queryargs['id']=$reference; |
| 587 |
|
| 588 |
// HTTPS required. IOK 2018-05-18 |
| 589 |
// If the user for some reason hasn't enabled pretty links, fall back to ancient version. IOK 2018-04-24 |
| 590 |
if ( !get_option('permalink_structure')) { |
| 591 |
$queryargs['wc-api'] = $forwhat; |
| 592 |
} else { |
| 593 |
$url = trailingslashit(home_url("wc-api/$forwhat", 'https')); |
| 594 |
} |
| 595 |
// And we need to add an empty "callback" query arg as the very last arg to receive the actual callback. |
| 596 |
// We can't use add_query_arg for that, as an empty argument will remove the equals-sign. |
| 597 |
$callbackurl = add_query_arg($queryargs, $url) . "&callback="; |
| 598 |
return $callbackurl; |
| 599 |
} |
| 600 |
|
| 601 |
// Webhook callbacks do not pass GET arguments at all, but do provide an X-Vipps-Authorization header for verification. IOK 2023-12-19 |
| 602 |
public function webhook_callback_url () { |
| 603 |
$url = home_url("/", 'https'); |
| 604 |
$queryargs = ['callback'=>'webhook']; |
| 605 |
$forwhat = 'wc_gateway_vipps'; // Same callback as for epayment, checkout, express checkout |
| 606 |
// HTTPS required. IOK 2018-05-18 |
| 607 |
// If the user for some reason hasn't enabled pretty links, fall back to ancient version. IOK 2018-04-24 |
| 608 |
if ( !get_option('permalink_structure')) { |
| 609 |
$queryargs['wc-api'] = $forwhat; |
| 610 |
} else { |
| 611 |
$url = trailingslashit(home_url("wc-api/$forwhat", 'https')); |
| 612 |
} |
| 613 |
$callbackurl = add_query_arg($queryargs, $url); |
| 614 |
return $callbackurl; |
| 615 |
} |
| 616 |
|
| 617 |
|
| 618 |
// The main payment callback |
| 619 |
public function payment_callback_url ($token='', $reference=0) { |
| 620 |
return $this->make_callback_urls('wc_gateway_vipps',$token, $reference); |
| 621 |
} |
| 622 |
public function shipping_details_callback_url($token='',$reference=0) { |
| 623 |
return $this->make_callback_urls('vipps_shipping_details',$token,$reference); |
| 624 |
} |
| 625 |
|
| 626 |
// Allow user to select the template to be used for the special Vipps MobilePay pages. IOK 2020-02-17 |
| 627 |
public function get_theme_page_templates() { |
| 628 |
if (!$this->page_templates) { |
| 629 |
$choices = array('' => __('Use default template', 'woo-vipps')); |
| 630 |
foreach(wp_get_theme()->get_page_templates() as $filename=>$name) { |
| 631 |
$choices[$filename]=$name; |
| 632 |
} |
| 633 |
$this->page_templates = $choices; |
| 634 |
} |
| 635 |
return $this->page_templates; |
| 636 |
} |
| 637 |
|
| 638 |
// Check to see if the product in question can be bought with express checkout IOK 2018-12-04 |
| 639 |
public function product_supports_express_checkout($product) { |
| 640 |
// IOK 2023-12-12 Can only support express checkout for Vipps - not MobilePay (yet!) |
| 641 |
// IOK 2025-09-01 Now supports mobilepay |
| 642 |
return apply_filters('woo_vipps_product_supports_express_checkout', $this->product_supports_checkout($product), $product); |
| 643 |
} |
| 644 |
|
| 645 |
// Checkout and Express Checkout are very similarily restricted because they both replace the standard |
| 646 |
// Woo Checkout page, but express checkout is even more restricted, so we need to separate out the commonalities. IOK 2024-01-11 |
| 647 |
public function product_supports_checkout($product) { |
| 648 |
$type = $product->get_type(); |
| 649 |
$ok = in_array($type, $this->express_checkout_supported_product_types); |
| 650 |
$ok = apply_filters('woo_vipps_product_supports_checkout',$ok,$product); |
| 651 |
return $ok; |
| 652 |
} |
| 653 |
|
| 654 |
// Almost the same as express checkout - unfortunately not *entirely* the same. IOK 2024-01-11 |
| 655 |
public function cart_supports_checkout($cart=null) { |
| 656 |
if (!$cart) $cart = WC()->cart; |
| 657 |
if (!$cart) return false; |
| 658 |
# Not supported by Vipps MobilePay |
| 659 |
if ($cart->cart_contents_total <= 0) return false; |
| 660 |
|
| 661 |
$supports = true; |
| 662 |
foreach($cart->get_cart() as $key=>$val) { |
| 663 |
$prod = $val['data']; |
| 664 |
if (!is_a($prod, 'WC_Product')) continue; |
| 665 |
$product_supported = $this->product_supports_checkout($prod); |
| 666 |
if (!$product_supported) { |
| 667 |
$supports = false; |
| 668 |
break; |
| 669 |
} |
| 670 |
} |
| 671 |
$supports = apply_filters('woo_vipps_cart_supports_checkout', $supports, $cart); |
| 672 |
return $supports; |
| 673 |
} |
| 674 |
|
| 675 |
// Check to see if the cart passed (or the global one) can be bought with express checkout IOK 2018-12-04 |
| 676 |
public function cart_supports_express_checkout($cart=null) { |
| 677 |
if (!$cart) $cart = WC()->cart; |
| 678 |
$supports = true; |
| 679 |
if (!$cart) return $supports; |
| 680 |
# Not supported by Vipps MobilePay |
| 681 |
if ($cart->cart_contents_total <= 0) return false; |
| 682 |
|
| 683 |
foreach($cart->get_cart() as $key=>$val) { |
| 684 |
$prod = $val['data']; |
| 685 |
if (!is_a($prod, 'WC_Product')) continue; |
| 686 |
$product_supported = $this->product_supports_express_checkout($prod); |
| 687 |
if (!$product_supported) { |
| 688 |
$supports = false; |
| 689 |
break; |
| 690 |
} |
| 691 |
} |
| 692 |
$supports = apply_filters('woo_vipps_cart_supports_express_checkout', $supports, $cart); |
| 693 |
return $supports; |
| 694 |
} |
| 695 |
|
| 696 |
// True if "Express checkout" should be displayed IOK 2018-06-18 |
| 697 |
public function show_express_checkout() { |
| 698 |
if (!$this->express_checkout_available()) return false; |
| 699 |
$show = 'yes' == $this->enabled && $this->cart_supports_express_checkout(); |
| 700 |
|
| 701 |
if (is_checkout()) { |
| 702 |
$show = $show && $this->get_option('express_show_in_checkout') == 'yes'; |
| 703 |
} else { // for cart, and all other contexts, since this is how the method functioned before we checked checkout explicitly. LP 2026-07-02 |
| 704 |
$show = $show && $this->get_option('cartexpress') == 'yes'; |
| 705 |
} |
| 706 |
// Earlier, we disabled this if Checkout was active; but we will now respect the setting in all |
| 707 |
// cases. Also, there is a filter. IOK 2026-02-19 |
| 708 |
// Now there is also a separate setting for just checkout, 'express_show_in_checkout'. See above branch. LP 2026-07-01 |
| 709 |
|
| 710 |
return apply_filters('woo_vipps_show_express_checkout', $show); |
| 711 |
} |
| 712 |
|
| 713 |
public function show_login_with_vipps() { |
| 714 |
return false; |
| 715 |
} |
| 716 |
|
| 717 |
// Called when orders reach the 'refunded' status. We'll add a complete refund and note that any rest is to be cancelled. |
| 718 |
public function maybe_refund_order($order_id) { |
| 719 |
$order = wc_get_order($order_id); |
| 720 |
if (! Vipps::is_vipps_order($order)) return false; |
| 721 |
try { |
| 722 |
$order = $this->update_vipps_payment_details($order); |
| 723 |
} catch (Exception $e) { |
| 724 |
//Do nothing with this for now |
| 725 |
$this->log(__("Error getting payment details before doing refund: ", 'woo-vipps') . $e->getMessage(), 'warning'); |
| 726 |
} |
| 727 |
$payment = $this->check_payment_status($order); |
| 728 |
if ($payment == 'initiated' || $payment == 'cancelled') { |
| 729 |
return true; // Can't refund these |
| 730 |
} |
| 731 |
|
| 732 |
// This will create + process a refund for the captured amount (if any). IOK 2026-01-26 |
| 733 |
// We always run this since woo will create a manual refund on this status change: we want the refund to be through our gw instead. LP 2026-06-10 |
| 734 |
$this->wc_order_fully_refunded ($order_id); |
| 735 |
|
| 736 |
// In any case, note that this order is ready for cancellation - we don't actually do this here anymore |
| 737 |
$order->update_meta_data('_vipps_capture_complete',true); |
| 738 |
$order->save(); |
| 739 |
} |
| 740 |
|
| 741 |
// Called when orders reach the 'cancelled'-status. When this happens, orders will be *refunded* |
| 742 |
// when they have been captured, but for added safety, this is only done when the orders are relatively new. |
| 743 |
public function maybe_cancel_order($order_id) { |
| 744 |
$order = wc_get_order($order_id); |
| 745 |
if (! Vipps::is_vipps_order($order)) return false; |
| 746 |
|
| 747 |
try { |
| 748 |
$order = $this->update_vipps_payment_details($order); |
| 749 |
} catch (Exception $e) { |
| 750 |
//Do nothing with this for now |
| 751 |
$this->log(__("Error getting payment details before doing cancel: ", 'woo-vipps') . $e->getMessage(), 'warning'); |
| 752 |
} |
| 753 |
|
| 754 |
$payment = $this->check_payment_status($order); |
| 755 |
if ($payment == 'initiated' || $payment == 'cancelled') { |
| 756 |
return true; // Can't cancel these |
| 757 |
} |
| 758 |
|
| 759 |
$days_threshold = apply_filters('woo_vipps_cancel_refund_days_threshold', 30); |
| 760 |
$order_date = $order->get_date_created(); |
| 761 |
$days_since_order = (time() - $order_date->getTimestamp()) / (60 * 60 * 24); |
| 762 |
|
| 763 |
$captured = intval($order->get_meta('_vipps_captured')); |
| 764 |
$vippsstatus = $order->get_meta('_vipps_status'); |
| 765 |
|
| 766 |
// If we have captured some funds, we must first create a refund for the amount we've captured. |
| 767 |
// However, we will only do this if the order is relatively fresh, to avoid accidentally refunding |
| 768 |
// old orders. |
| 769 |
if ($captured > 0 || $vippsstatus == 'SALE') { |
| 770 |
// If this is true then the order is *too old to refund* which would happen on maybe_cancel_payment. |
| 771 |
// add a note instead. |
| 772 |
if ($days_since_order > $days_threshold) { |
| 773 |
$note = sprintf(__('Order with captured funds older than %d days cancelled - because the order is this old, it will not be automatically refunded at Vipps. Manual refund may be required.', 'woo-vipps'), $days_threshold); |
| 774 |
$order->add_order_note($note); |
| 775 |
// Add an admin notice in case this is interactive |
| 776 |
$msg = sprintf(__("Could not cancel %1\$s payment", 'woo-vipps'), $this->get_payment_method_name()); |
| 777 |
$this->adminerr(__('Order', 'woo-vipps') . " " . $order->get_id() . ": " . $note); |
| 778 |
$order->save(); |
| 779 |
Vipps::instance()->store_admin_notices(); |
| 780 |
return false; |
| 781 |
} |
| 782 |
// This will create + process a refund for the captured amount. IOK 2026-01-26 |
| 783 |
$this->wc_order_fully_refunded ($order_id); |
| 784 |
} |
| 785 |
// In any case, note that this order is ready for cancellation - we don't actually do this here anymore |
| 786 |
$order->update_meta_data('_vipps_capture_complete',true); |
| 787 |
$order->save(); |
| 788 |
} |
| 789 |
|
| 790 |
// IOK 2024-09-01 In general, we can refund most Vipps Mobilepay orders through the api, |
| 791 |
// however, this is not the case for the Bank Transfer method available through Checkout. |
| 792 |
public function can_refund_order( $order ) { |
| 793 |
$method = $order->get_meta('_vipps_api'); |
| 794 |
switch ($method) { |
| 795 |
case 'banktransfer': |
| 796 |
return false; |
| 797 |
break; |
| 798 |
case 'epayment': |
| 799 |
return true; |
| 800 |
break; |
| 801 |
// Default is true; but the above are exhaustive IOK 2026-08-18 |
| 802 |
default: |
| 803 |
return true; |
| 804 |
break; |
| 805 |
} |
| 806 |
} |
| 807 |
|
| 808 |
// This is ran in woocommerce_order_status_refunded *before* woos own wc_order_fully_refunded (priority 9) |
| 809 |
// so that we can create a through-the-gateway refund for this if neccessary. That way, *our* logic for refunds occur |
| 810 |
// instead of the normal woo logic. IOK 2026-04-16 |
| 811 |
public function wc_order_fully_refunded ($orderid) { |
| 812 |
$order = wc_get_order($orderid); |
| 813 |
if (! Vipps::is_vipps_order($order)) return false; |
| 814 |
|
| 815 |
// First check to see if we actually need to refund anything now IOK 2026-02-16 |
| 816 |
$max_refund = wc_format_decimal( $order->get_total() - $order->get_total_refunded() ); |
| 817 |
if ( ! $max_refund ) { |
| 818 |
return; |
| 819 |
} |
| 820 |
|
| 821 |
// IOK 2019-10-03 it is now possible to do capture via other tools than Woo, so we must now first check to see if |
| 822 |
// the order is capturable by getting full payment details. |
| 823 |
try { |
| 824 |
$order = $this->update_vipps_payment_details($order); |
| 825 |
} catch (Exception $e) { |
| 826 |
//Do nothing with this for now |
| 827 |
$this->log(__("Error getting payment details before doing refund: ", 'woo-vipps') . $e->getMessage(), 'warning'); |
| 828 |
} |
| 829 |
|
| 830 |
$data = []; |
| 831 |
$data['amount'] = $max_refund; |
| 832 |
$data['reason'] = __( 'Order fully refunded.', 'woocommerce' ); |
| 833 |
$data['order_id'] = $orderid; |
| 834 |
$data['refund_payment'] = true; // This should call our "process_refund" instead of adding a manual refund |
| 835 |
|
| 836 |
// IOK 2026-04-17 Should be all remaining un-refunded line items |
| 837 |
$line_items = apply_filters('woo_vipps_order_fully_refunded_line_items', $this->get_remaining_refundable_line_items($order), $order); |
| 838 |
$data['line_items'] = $line_items; |
| 839 |
|
| 840 |
wc_switch_to_site_locale(); |
| 841 |
$the_refund = wc_create_refund($data); |
| 842 |
wc_restore_locale(); |
| 843 |
if (is_wp_error($the_refund)) { |
| 844 |
$msg = $the_refund->get_error_message(); |
| 845 |
$order->add_order_note(sprintf(__("Error when refunding payment through %1\$s:", 'woo-vipps'), $this->get_payment_method_name()) . ' ' . $msg); |
| 846 |
$order->save(); |
| 847 |
$this->adminerr($msg); |
| 848 |
} |
| 849 |
return true; |
| 850 |
} |
| 851 |
|
| 852 |
|
| 853 |
// IOK 2026-04-16 Build wc_create_refund() line_items for all remaining refundable order items - used to provide line-item info for the refund to be processed when |
| 854 |
// "fully refunded" is done. |
| 855 |
// [ $item_id => ['qty' => 1, 'refund_total' => '100.00', 'refund_tax' => [ 1 => '25.00' ], * ], ... ] |
| 856 |
// Includes line items, fees and shipping. For fees/shipping, qty is set to 0. |
| 857 |
private function get_remaining_refundable_line_items( WC_Order $order ) { |
| 858 |
$items = $order->get_items( array( 'line_item', 'fee', 'shipping' )); |
| 859 |
|
| 860 |
$new_refund_line_items = []; |
| 861 |
foreach($items as $item_id => $item) { |
| 862 |
$new_refund_line = []; |
| 863 |
|
| 864 |
// Calculate remaining tax for this line item; by tax id. The shape is [ [total] => [tax_id => value_for_this_tax_id] ]. |
| 865 |
// We want the tax id and the value. |
| 866 |
$tax_data = wc_tax_enabled() ? $item->get_taxes() : false; |
| 867 |
$remaining_tax = []; |
| 868 |
if ($tax_data) { |
| 869 |
foreach($tax_data['total'] as $tax_id => $value) { |
| 870 |
if ('' === $value) continue; // don't add empty string as tax value, fatal crash. LP 2026-06-08 |
| 871 |
$remaining_tax[$tax_id] = $value; |
| 872 |
} |
| 873 |
} |
| 874 |
// We can then subtract the tax already refunded for each of these items. |
| 875 |
foreach($remaining_tax as $tax_id => $current) { |
| 876 |
$refunded = $order->get_tax_refunded_for_item($item_id, $tax_id, $item->get_type()); |
| 877 |
$remaining = wc_format_decimal($current-$refunded); |
| 878 |
if ($remaining > 0) { |
| 879 |
$remaining_tax[$tax_id] = wc_format_decimal($current-$refunded); |
| 880 |
} else { |
| 881 |
unset($remaining_tax[$tax_id]); |
| 882 |
} |
| 883 |
} |
| 884 |
|
| 885 |
// Then the quantity |
| 886 |
$qty = (int) $item->get_quantity(); |
| 887 |
$refunded_quantity = abs((int) $order->get_qty_refunded_for_item($item_id, $item->get_type())); // Documented to be positive since 3.0, seems to be actually negative. |
| 888 |
$remaining_quantity = $qty-$refunded_quantity; |
| 889 |
|
| 890 |
$total = $item->get_total(); |
| 891 |
$refunded_total = $order->get_total_refunded_for_item($item_id, $item->get_type()); // A positive value |
| 892 |
$remaining_total = wc_format_decimal($total-$refunded_total); |
| 893 |
|
| 894 |
|
| 895 |
if ($remaining_quantity>0 || !empty($remaining_tax) || $remaining_total > 0) { |
| 896 |
$new_refund_line['qty'] = max(0,$remaining_quantity); |
| 897 |
$new_refund_line['refund_tax'] = $remaining_tax; |
| 898 |
$new_refund_line['refund_total'] = $remaining_total; |
| 899 |
$new_refund_line_items[$item_id] = $new_refund_line; |
| 900 |
} |
| 901 |
|
| 902 |
} |
| 903 |
|
| 904 |
return $new_refund_line_items; |
| 905 |
|
| 906 |
} |
| 907 |
|
| 908 |
|
| 909 |
// This is for orders that are 'reserved' at Vipps but could actually be captured at once because |
| 910 |
// they don't require payment. So we try to capture. IOK 2020-09-22 |
| 911 |
// do NOT call this unless the order is 'reserved' at Vipps! |
| 912 |
protected function maybe_complete_payment($order) { |
| 913 |
if (! Vipps::is_vipps_order($order)) return false; |
| 914 |
if ($order->needs_processing()) return false; // No auto-capture for orders needing processing |
| 915 |
// IOK 2018-10-03 when implementing partial capture, this must be modified. |
| 916 |
$captured = intval($order->get_meta('_vipps_captured')); |
| 917 |
$vippsstatus = $order->get_meta('_vipps_status'); |
| 918 |
if ($captured || $vippsstatus == 'SALE') { |
| 919 |
return true; |
| 920 |
} |
| 921 |
$ok = 0; |
| 922 |
try { |
| 923 |
$ok = $this->capture_payment($order); |
| 924 |
$order->add_order_note(sprintf(__('Payment automatically captured at %1$s for order not needing processing','woo_vipps'), $this->get_payment_method_name())); |
| 925 |
} catch (Exception $e) { |
| 926 |
$order->add_order_note(sprintf(__('Order does not need processing, but payment could not be captured at %1$s:','woo_vipps'), $this->get_payment_method_name()) . ' ' . $e->getMessage()); |
| 927 |
} |
| 928 |
if (!$ok) return false; |
| 929 |
$order->save(); |
| 930 |
return true; |
| 931 |
} |
| 932 |
|
| 933 |
// This filter runs on *all* refunds, including manual refunds. Its main job here is to |
| 934 |
// disallow creating manual refunds on orders that have not been captured yet, since this makes the capture/cancel logic |
| 935 |
// very confusing |
| 936 |
public function woocommerce_create_refund ($refund, $args) { |
| 937 |
$order_id = intval($args['order_id'] ?? 0); |
| 938 |
$order = $order_id ? wc_get_order( $order_id ) : null; |
| 939 |
if ( ! $order ) return; |
| 940 |
if (! Vipps::is_vipps_order($order)) return; |
| 941 |
// This is for manual refunds only IOK 2026-02-24 |
| 942 |
if (!($args['refund_payment'] ?? false)) { |
| 943 |
try { |
| 944 |
$order = $this->update_vipps_payment_details($order); |
| 945 |
} catch (Exception $e) { |
| 946 |
//Do nothing with this for now |
| 947 |
$this->log(__("Error getting payment details before doing refund: ", 'woo-vipps') . $e->getMessage(), 'warning'); |
| 948 |
} |
| 949 |
// This would be *per order line* in the fulfilment branch. IOK 2026-02-24 FIXME |
| 950 |
$captured = intval($order->get_meta('_vipps_captured')); |
| 951 |
if (!$captured) { |
| 952 |
$msg = sprintf(__("Order %2\$d: It is not possible to create a manual refund for a %1\$s order before it has been captured - doing so makes it impossible to track how much to capture and how much to release. If you create the refund through %1\$s, a note will be made internally so that the amount to be refunded will *not* be captured - please do this instead if possible. Otherwise, capture the order then refund either manually or through %1\$s", 'woo-vipps'), $this->get_payment_method_name(), $order_id); |
| 953 |
throw new Exception($msg); |
| 954 |
} |
| 955 |
} |
| 956 |
} |
| 957 |
|
| 958 |
// This is the Woocommerce refund api called by the "Refund" actions. IOK 2018-05-11 |
| 959 |
public function process_refund($orderid,$amount=null,$reason='') { |
| 960 |
$order = wc_get_order($orderid); |
| 961 |
|
| 962 |
$currency = $order->get_currency(); |
| 963 |
|
| 964 |
try { |
| 965 |
$order = $this->update_vipps_payment_details($order); |
| 966 |
} catch (Exception $e) { |
| 967 |
//Do nothing with this for now |
| 968 |
$this->log(__("Error getting payment details before doing refund: ", 'woo-vipps') . $e->getMessage(), 'warning'); |
| 969 |
} |
| 970 |
|
| 971 |
$captured = intval($order->get_meta('_vipps_captured')); |
| 972 |
$to_refund = intval($order->get_meta('_vipps_refund_remaining')); |
| 973 |
|
| 974 |
// No funds captured, by epayment can do cancel of partial capture, so let's note that we are not to capture this. |
| 975 |
if (!$captured) { |
| 976 |
if ('epayment' != $order->get_meta('_vipps_api')) { |
| 977 |
return new WP_Error('Vipps', sprintf(__("Cannot refund through %1\$s - the payment has not been captured yet.", 'woo-vipps'), $this->get_payment_method_name())); |
| 978 |
} |
| 979 |
if ($amount > $order->get_total()) { |
| 980 |
return new WP_Error('Vipps', sprintf(__("Cannot refund through %1\$s - the refund amount is too large.", 'woo-vipps'), $this->get_payment_method_name())); |
| 981 |
} |
| 982 |
$msg = sprintf(__('The money for order %1$d has not been captured, only reserved. %2$s %3$s of the reserved funds will be released when the order is set to complete.', 'woo-vipps'), $orderid, $amount, $currency); |
| 983 |
$this->log($msg, 'info'); |
| 984 |
$uncapturable = round($amount * 100) + intval($order->get_meta('_vipps_noncapturable')); |
| 985 |
|
| 986 |
$order->update_meta_data('_vipps_noncapturable', $uncapturable); |
| 987 |
$order->add_order_note($msg); |
| 988 |
$order->save(); |
| 989 |
return true; |
| 990 |
} |
| 991 |
|
| 992 |
if ($amount*100 > $to_refund) { |
| 993 |
return new WP_Error('Vipps', sprintf(__("Cannot refund through %1\$s - the refund amount is too large.", 'woo-vipps'), $this->get_payment_method_name())); |
| 994 |
} |
| 995 |
$ok = 0; |
| 996 |
|
| 997 |
// Specialcase zero, because Vipps treats this as the entire amount IOK 2021-09-14 |
| 998 |
if (is_numeric($amount) && $amount == 0) { |
| 999 |
$order->add_order_note($amount . ' ' . $currency . ' ' . sprintf(__(" refunded through %1\$s:",'woo-vipps'), Vipps::CompanyName()) . ' ' . $reason); |
| 1000 |
return true; |
| 1001 |
} |
| 1002 |
|
| 1003 |
try { |
| 1004 |
$ok = $this->refund_payment($order,$amount); |
| 1005 |
} catch (TemporaryVippsApiException $e) { |
| 1006 |
$this->log(sprintf(__('Could not refund %1$s payment for order id:', 'woo-vipps'), $this->get_payment_method_name()) . ' ' . $orderid . "\n" .$e->getMessage(),'error'); |
| 1007 |
return new WP_Error('Vipps',sprintf(__('%1$s is temporarily unavailable.','woo-vipps'), Vipps::CompanyName()) . ' ' . $e->getMessage()); |
| 1008 |
} catch (Exception $e) { |
| 1009 |
$msg = sprintf(__('Could not refund %1$s payment','woo-vipps'), Vipps::CompanyName()) . ' ' . $e->getMessage(); |
| 1010 |
$order->add_order_note($msg); |
| 1011 |
$this->log($msg,'error'); |
| 1012 |
return new WP_Error('Vipps',$msg); |
| 1013 |
} |
| 1014 |
|
| 1015 |
if ($ok) { |
| 1016 |
$order->add_order_note($amount . ' ' . $currency . ' ' . sprintf(__(" refunded through %1\$s:",'woo-vipps'), Vipps::CompanyName()) . ' ' . $reason); |
| 1017 |
} |
| 1018 |
return $ok; |
| 1019 |
} |
| 1020 |
|
| 1021 |
// Detect default payment method based on country code NT-2024-10-15 |
| 1022 |
public function detect_default_payment_method_from_country($country_code) { |
| 1023 |
// Default to MobilePay |
| 1024 |
$payment_method_name = 'MobilePay'; |
| 1025 |
// Default to Vipps if country is Norway or Sweden |
| 1026 |
if($country_code == 'NO' || $country_code == 'SE') { |
| 1027 |
$payment_method_name = 'Vipps'; |
| 1028 |
} |
| 1029 |
return $payment_method_name; |
| 1030 |
} |
| 1031 |
|
| 1032 |
// Returns true iff this is a store where Vipps will allow external payment methods. |
| 1033 |
// Currently this is only Finland, and only Klarna is supported. We need to call this like so because |
| 1034 |
// most of woocommerce will not be initialized when we need this info. IOK 2024-05-28 |
| 1035 |
public function allow_external_payments_in_checkout() { |
| 1036 |
$store_location= wc_get_base_location(); |
| 1037 |
$store_country = $store_location['country'] ?? ''; |
| 1038 |
$finland = (get_woocommerce_currency() == "EUR" && $store_country == "FI"); |
| 1039 |
$norway = (get_woocommerce_currency() == "NOK" && $store_country == "NO"); |
| 1040 |
$sweden = (get_woocommerce_currency() == "SEK" && $store_country == "SE"); |
| 1041 |
return apply_filters('woo_vipps_allow_external_payment_methods', ($finland || $norway || $sweden)); |
| 1042 |
} |
| 1043 |
|
| 1044 |
public function init_form_fields() { |
| 1045 |
global $Vipps; |
| 1046 |
|
| 1047 |
// Used for defaults in the admin interface; however this functions is called a loot more often than that. |
| 1048 |
$page_templates = $this->get_theme_page_templates(); |
| 1049 |
|
| 1050 |
$orderprefix = $Vipps->generate_order_prefix(); |
| 1051 |
|
| 1052 |
// Default handling based on other parameters and earlier values. |
| 1053 |
$expresscreateuserdefault = "no"; |
| 1054 |
$vippscreateuserdefault = "no"; |
| 1055 |
|
| 1056 |
// Express checkout uses verified email addresses,so we'll create users if the Login plugin is installed and WooCommerce is set to allow user registration. |
| 1057 |
if (class_exists('VippsWooLogin')) { |
| 1058 |
$woodefault = 'yes' === get_option('woocommerce_enable_signup_and_login_from_checkout'); |
| 1059 |
if ($woodefault) { |
| 1060 |
$expresscreateuserdefault = "yes"; |
| 1061 |
// $vippscreateuserdefault = "yes"; // However, for Checkout the email address is freetext so we'll treat the default a bit different. |
| 1062 |
} |
| 1063 |
} |
| 1064 |
|
| 1065 |
// We will only show the Checkout options if the user has activated the feature (thus creating the pages involved etc). IOK 2021-10-01 |
| 1066 |
$vipps_checkout_activated = get_option('woo_vipps_checkout_activated', false); |
| 1067 |
|
| 1068 |
// This is used for new options,to set reasonable defaults based on older settings. We can't use WC_Settings->get_option for this unfortunately. |
| 1069 |
$current = get_option('woocommerce_vipps_settings'); |
| 1070 |
// New defaults based on old defaults |
| 1071 |
$default_static_shipping_for_checkout = 'no'; |
| 1072 |
$default_ask_address_for_express = 'no'; |
| 1073 |
$default_status_on_fail = 'failed'; |
| 1074 |
$default_express_show_in_checkout = 'yes'; |
| 1075 |
if ($current) { |
| 1076 |
$default_static_shipping_for_checkout = (isset($current['enablestaticshipping'])) ? $current['enablestaticshipping'] : 'no'; |
| 1077 |
$default_ask_address_for_express = (isset($current['useExplicitCheckoutFlow']) && $current['useExplicitCheckoutFlow'] == "yes") ? "yes" : "no"; |
| 1078 |
// The old default used the same value as for Express Checkout. IOK 2023-07-27 |
| 1079 |
$vippscreateuserdefault = isset($current['expresscreateuser']) ? $current['expresscreateuser'] : $vippscreateuserdefault; |
| 1080 |
|
| 1081 |
// For existing installs: set failed payments order status to cancelled to keep same default behaviour. |
| 1082 |
// New installs will be set to failed instead of cancelled. LP 2026-03-26 |
| 1083 |
$default_status_on_fail = 'cancelled'; |
| 1084 |
|
| 1085 |
// New setting 'express_show_in_checkout', previously 'cartexpress' affected both cart and checkout. |
| 1086 |
// Therefore, set new one equal to 'cartexpress' IF it isn't set yet, so that the functionality stays the same for users. LP 2026-07-02 |
| 1087 |
$default_express_show_in_checkout = 'yes'; |
| 1088 |
if (!isset($current['express_show_in_checkout']) && isset($current['cartexpress'])) { |
| 1089 |
$default_express_show_in_checkout = $current['cartexpress']; |
| 1090 |
} |
| 1091 |
} |
| 1092 |
|
| 1093 |
// Get the already-set country code. For existing sites, this will guess the country based on the currency; for new sites, use |
| 1094 |
// the woo base country. IOK 2024-10-17 (previously used the currency here too). |
| 1095 |
$countries = new WC_Countries(); // Can't use WC()->countries here - too early IOK 2024-10-17 |
| 1096 |
$country_code = $current['country'] ?? $countries->get_base_country(); |
| 1097 |
|
| 1098 |
// Same issue as above: We need the default payment method name before it is set to be able to provide defaults IOK 2023-12-01 |
| 1099 |
$payment_method_name = $current['payment_method_name'] ?? $this->detect_default_payment_method_from_country($country_code); |
| 1100 |
|
| 1101 |
$checkoutfields = array( |
| 1102 |
'checkout_options' => array( |
| 1103 |
'title' => "Checkout", // Vipps::CheckoutName(), // Don't translate this, but save some space IOK 2024-12-06 |
| 1104 |
'type' => 'title', |
| 1105 |
'class' => 'tab', |
| 1106 |
'description' => sprintf(__("%1\$s is a new service from %2\$s which replaces the usual WooCommerce checkout page entirely, replacing it with a simplified checkout screen providing payment both with %2\$s and credit card. Additionally, your customers will get the option of providing their address information using their %2\$s app directly.", 'woo-vipps'), Vipps::CheckoutName(), Vipps::CompanyName()), |
| 1107 |
), |
| 1108 |
|
| 1109 |
|
| 1110 |
'vipps_checkout_enabled' => array( |
| 1111 |
'title' => sprintf(__('Activate Alternative %1$s', 'woo-vipps'), Vipps::CheckoutName()), |
| 1112 |
'label' => sprintf(__('Enable Alternative %1$s screen, replacing the standard checkout page', 'woo-vipps'), Vipps::CheckoutName()), |
| 1113 |
'type' => 'checkbox', |
| 1114 |
'description' => sprintf(__('If activated, this will <strong>replace</strong> the standard Woo checkout screen with %1$s, providing easy checkout using %1$s or credit card, with no need to type in addresses.', 'woo-vipps'), Vipps::CheckoutName()), |
| 1115 |
'default' => 'no', |
| 1116 |
), |
| 1117 |
|
| 1118 |
'checkoutcreateuser' => array ( |
| 1119 |
'title' => sprintf(__('Create new customers on %1$s', 'woo-vipps'), Vipps::CheckoutName()), |
| 1120 |
'label' => sprintf(__('Create new customers on %1$s', 'woo-vipps'), Vipps::CheckoutName()), |
| 1121 |
'type' => 'checkbox', |
| 1122 |
'description' => sprintf(__('Enable this to create and login customers when using %1$s. Otherwise these will all be guest checkouts. If using, you may want to install Login with Vipps too.', 'woo-vipps'), Vipps::CheckoutName()), |
| 1123 |
'default' => $vippscreateuserdefault, |
| 1124 |
), |
| 1125 |
|
| 1126 |
'enablestaticshipping_checkout' => array( |
| 1127 |
'title' => sprintf(__('Enable static shipping for %1$s', 'woo-vipps'), Vipps::CheckoutName()), |
| 1128 |
'label' => __('Enable static shipping', 'woo-vipps'), |
| 1129 |
'type' => 'checkbox', |
| 1130 |
'description' => sprintf(__('If your shipping options do not depend on the customers address, you can enable \'Static shipping\', which will precompute the shipping options when using %1$s so that this will be much faster. If you do this and the customer isn\'t logged in, the base location of the store will be used to compute the shipping options for the order. You should only use this if your shipping is actually \'static\', that is, does not vary based on the customers address. So fixed price/free shipping will work. If the customer is logged in, their address as registered in the store will be used, so if your customers are always logged in, you may be able to use this too.', 'woo-vipps'), Vipps::CheckoutName()), |
| 1131 |
'default' => $default_static_shipping_for_checkout |
| 1132 |
), |
| 1133 |
|
| 1134 |
|
| 1135 |
'requireUserInfo_checkout' => array( |
| 1136 |
'title' => __('Ask the user to consent to share user information', 'woo-vipps'), |
| 1137 |
'label' => __('Ask the user to consent to share user information', 'woo-vipps'), |
| 1138 |
'type' => 'checkbox', |
| 1139 |
'description' => sprintf(__('If using %1$s, ask for the users consent to share user information with the store. This will allow better integration between Login With %1$s but will add another step to first-time buyers.', 'woo-vipps'), Vipps::CompanyName()), |
| 1140 |
'default' => 'no' |
| 1141 |
), |
| 1142 |
|
| 1143 |
'noAddressFields' => array( |
| 1144 |
'title' => __('Drop the address fields on the Checkout screen', 'woo-vipps'), |
| 1145 |
'label' => __('Don\'t require the address fields', 'woo-vipps'), |
| 1146 |
'type' => 'checkbox', |
| 1147 |
'description' => __('If your products <i>don\'t require shipping</i>, either because they are digital downloads, immaterial products or delivering the products directly on purchase, you can check this box. The user will then not be required to provide an address, which should speed things up a bit. If your products require shipping, this will have no effect. NB: If you have plugins that require shipping information, then this is not going to work very well.','woo-vipps'), |
| 1148 |
'default' => 'no' |
| 1149 |
), |
| 1150 |
|
| 1151 |
'noContactFields' => array( |
| 1152 |
'title' => __('Drop the contact fields on the Checkout screen', 'woo-vipps'), |
| 1153 |
'label' => __('Don\'t require the contact fields', 'woo-vipps'), |
| 1154 |
'type' => 'checkbox', |
| 1155 |
'description' => __('If your products <i>don\'t require shipping</i> as above, and you also don\'t care about the customers name or contact information, you can drop this too! The customer fields will then be filled with a placeholder. NB: If you have plugins that require contact information, then this is not going to work very well. Also, for this to work you have to check the \'no addresses\' box as well.','woo-vipps'), |
| 1156 |
'default' => 'no' |
| 1157 |
), |
| 1158 |
|
| 1159 |
|
| 1160 |
); |
| 1161 |
|
| 1162 |
$vipps_checkout_shipping_fields = array( |
| 1163 |
|
| 1164 |
'checkout_shipping' => array( |
| 1165 |
'title' => sprintf(__('%1$s Shipping Methods', 'woo-vipps'), Vipps::CheckoutName()), |
| 1166 |
'type' => 'title', |
| 1167 |
'description' => sprintf(__("When using %1\$s, you have the option to use %1\$s specific shipping methods with extended features for certain carriers. These will add an apropriate logo as well as extended delivery options for certain methods. For some of these, you need to add integration data from the carriers below. You can then add these shipping methods to your shipping zones the normal way, but they will only appear in the %1\$s screen.", 'woo-vipps'), Vipps::CheckoutName()) |
| 1168 |
), |
| 1169 |
|
| 1170 |
'vcs_posten' => array( |
| 1171 |
'title' => __('Posten Norge', 'woo-vipps'), |
| 1172 |
'class' => 'vcs_posten vcs_main', |
| 1173 |
'custom_attributes' => array('data-vcs-show'=>'.vcs_depend.vcs_posten'), |
| 1174 |
'label' => sprintf(__('Support Posten Norge as a shipping method in %1$s', 'woo-vipps'), Vipps::CheckoutName()), |
| 1175 |
'type' => 'checkbox', |
| 1176 |
'description' => sprintf(__('Activate this for Posten Norge as a %1$s Shipping method.', 'woo-vipps'), Vipps::CheckoutName()), |
| 1177 |
'default' => 'yes' |
| 1178 |
), |
| 1179 |
|
| 1180 |
'vcs_posti' => array( |
| 1181 |
'title' => __('Posti', 'woo-vipps'), |
| 1182 |
'class' => 'vcs_posti vcs_main', |
| 1183 |
'custom_attributes' => array('data-vcs-show'=>'.vcs_depend.vcs_posti'), |
| 1184 |
'label' => sprintf(__('Support Posti as a shipping method in %1$s', 'woo-vipps'), Vipps::CheckoutName()), |
| 1185 |
'type' => 'checkbox', |
| 1186 |
'description' => sprintf(__('Activate this for Posti as a %1$s Shipping method.', 'woo-vipps'), Vipps::CheckoutName()), |
| 1187 |
'default' => 'yes' |
| 1188 |
), |
| 1189 |
|
| 1190 |
'vcs_postnord' => array( |
| 1191 |
'title' => __('PostNord', 'woo-vipps'), |
| 1192 |
'class' => 'vcs_postnord vcs_main', |
| 1193 |
'custom_attributes' => array('data-vcs-show'=>'.vcs_depend.vcs_postnord'), |
| 1194 |
'label' => sprintf(__('Support PostenNord as a shipping method in %1$s', 'woo-vipps'), Vipps::CheckoutName()), |
| 1195 |
'type' => 'checkbox', |
| 1196 |
'description' => sprintf(__('Activate this for PostNord as a %1$s Shipping method.', 'woo-vipps'), Vipps::CheckoutName()), |
| 1197 |
'default' => 'yes' |
| 1198 |
), |
| 1199 |
|
| 1200 |
'vcs_porterbuddy' => array( |
| 1201 |
'title' => __('Porterbuddy', 'woo-vipps'), |
| 1202 |
'class' => 'vcs_porterbuddy vcs_main', |
| 1203 |
'custom_attributes' => array('data-vcs-show'=>'.vcs_depend.vcs_porterbuddy'), |
| 1204 |
'label' => sprintf(__('Support Porterbuddy as a shipping method in %1$s', 'woo-vipps'), Vipps::CheckoutName()), |
| 1205 |
'type' => 'checkbox', |
| 1206 |
'description' => sprintf(__('Activate this for Porterbuddy as a %1$s Shipping method. Your store address will be used as the pick-up point and your admin email will be used for booking information from Porterbuddy.' ,'woo-vipps'), Vipps::CheckoutName()), |
| 1207 |
'default' => 'no' |
| 1208 |
), |
| 1209 |
|
| 1210 |
'vcs_porterbuddy_publicToken' => array( |
| 1211 |
'title' => __('Porterbuddy public token', 'woo-vipps'), |
| 1212 |
'class' => 'vippspw vcs_porterbuddy vcs_depend', |
| 1213 |
'type' => 'password', |
| 1214 |
'description' => __('The public key provided to you by Porterbuddy','woo-vipps'), |
| 1215 |
'default' => '', |
| 1216 |
), |
| 1217 |
'vcs_porterbuddy_apiKey' => array( |
| 1218 |
'title' => __('Porterbuddy API key', 'woo-vipps'), |
| 1219 |
'class' => 'vippspw vcs_porterbuddy vcs_depend', |
| 1220 |
'type' => 'password', |
| 1221 |
'description' => __('The API key provided to you by Porterbuddy','woo-vipps'), |
| 1222 |
'default' => '', |
| 1223 |
), |
| 1224 |
'vcs_porterbuddy_phoneNumber' => array( |
| 1225 |
'title' => __('Porterbuddy Phone Number', 'woo-vipps'), |
| 1226 |
'class' => 'vcs_porterbuddy vcs_depend', |
| 1227 |
'type' => 'text', |
| 1228 |
'description' => __('Your phone number where Porterbuddy may send you important messages. Format must be MSISDN (including country code). Example: "4791234567"','woo-vipps'), |
| 1229 |
'default' => '', |
| 1230 |
), |
| 1231 |
|
| 1232 |
// Vipps checkout *shipping options* - extra shipping options that only work with Checkout |
| 1233 |
'vcs_helthjem' => array( |
| 1234 |
'title' => __('Helthjem', 'woo-vipps'), |
| 1235 |
'label' => sprintf(__('Support Helthjem as a shipping method in %1$s', 'woo-vipps'), Vipps::CheckoutName()), |
| 1236 |
'type' => 'checkbox', |
| 1237 |
'class' => 'vcs_helthjem vcs_main', |
| 1238 |
'custom_attributes' => array('data-vcs-show'=>'.vcs_depend.vcs_helthjem'), |
| 1239 |
'description' => sprintf(__('Activate this for Helthjem as a %1$s Shipping method.' ,'woo-vipps'), Vipps::CheckoutName()), |
| 1240 |
'default' => 'no' |
| 1241 |
), |
| 1242 |
|
| 1243 |
'vcs_helthjem_shopId' => array( |
| 1244 |
'title' => __('Helthjem Shop Id', 'woo-vipps'), |
| 1245 |
'class' => 'vcs_helthjem vcs_depend', |
| 1246 |
'type' => 'number', |
| 1247 |
'custom_attributes' => array('pattern'=>'[0-9]'), |
| 1248 |
'description' => __('The ShopId provided to you by Helthjem','woo-vipps'), |
| 1249 |
'default' => '', |
| 1250 |
), |
| 1251 |
|
| 1252 |
'vcs_helthjem_username' => array( |
| 1253 |
'title' => __('Helthjem Username', 'woo-vipps'), |
| 1254 |
'class' => 'vcs_helthjem vcs_depend', |
| 1255 |
'type' => 'text', |
| 1256 |
'description' => __('The Username provided to you by Helthjem','woo-vipps'), |
| 1257 |
'default' => '', |
| 1258 |
), |
| 1259 |
'vcs_helthjem_password' => array( |
| 1260 |
'title' => __('Helthjem Password', 'woo-vipps'), |
| 1261 |
'class' => 'vippspw vcs_helthjem vcs_depend', |
| 1262 |
'type' => 'password', |
| 1263 |
'description' => __('Password provided to you by Helthjem','woo-vipps'), |
| 1264 |
'default' => '', |
| 1265 |
), |
| 1266 |
|
| 1267 |
); |
| 1268 |
|
| 1269 |
/* Support for *certain* external payment methods in Checkout. IOK 2024-05-27 */ |
| 1270 |
$externals = []; |
| 1271 |
$external_payment_fields = []; |
| 1272 |
$allow_external_payments = $this->allow_external_payments_in_checkout(); |
| 1273 |
if ($allow_external_payments) { |
| 1274 |
if (in_array('KCO_Gateway', Vipps::$installed_gateways) || in_array('WC_Gateway_Klarna_Payments', Vipps::$installed_gateways)) { |
| 1275 |
$externals['checkout_external_payments_klarna'] = array( |
| 1276 |
'title' => __('Klarna', 'woo-vipps'), |
| 1277 |
'label' => __('Klarna', 'woo-vipps'), |
| 1278 |
'type' => 'checkbox', |
| 1279 |
'class' => 'external_payments klarna', |
| 1280 |
'description' => sprintf(__("Allow Klarna as an external payment method in %1\$s",'woo-vipps'), Vipps::CheckoutName()), |
| 1281 |
'default' => 'no', |
| 1282 |
); |
| 1283 |
} |
| 1284 |
if (!empty($externals)) { |
| 1285 |
$external_payment_fields = [ |
| 1286 |
'checkout_external_payment_title' => array( |
| 1287 |
'title' => sprintf(__('External Payment Methods', 'woo-vipps'), Vipps::CheckoutName()), |
| 1288 |
'type' => 'title', |
| 1289 |
'description' => sprintf(__("Allow certain external payment methods in %1\$s, returning control to WooCommerce for the order", 'woo-vipps'), Vipps::CheckoutName()) |
| 1290 |
), |
| 1291 |
]; |
| 1292 |
foreach($externals as $k => $def) $external_payment_fields[$k] = $def; |
| 1293 |
} |
| 1294 |
} |
| 1295 |
|
| 1296 |
$vipps_checkout_widgets_fields = [ |
| 1297 |
'checkout_widgets' => [ |
| 1298 |
'title' => sprintf(__('%1$s widgets', 'woo-vipps'), Vipps::CheckoutName()), |
| 1299 |
'type' => 'title', |
| 1300 |
'description' => sprintf(__('Widgets are elements shown above the %1$s frame with extra functionality.', 'woo-vipps'), Vipps::CheckoutName()), |
| 1301 |
], |
| 1302 |
'checkout_widget_ordernotes' => [ |
| 1303 |
'title' => __('Order notes', 'woo-vipps'), |
| 1304 |
'label' => __('Enable the order notes widget', 'woo-vipps'), |
| 1305 |
'type' => 'checkbox', |
| 1306 |
'description' => __('A widget to add customer notes with their order.', 'woo-vipps'), |
| 1307 |
'default' => 'yes' |
| 1308 |
], |
| 1309 |
]; |
| 1310 |
/* This seems to have broken some sites with OOM during plugin activation. 2025-05-27 */ |
| 1311 |
// if (wc_coupons_enabled()) { |
| 1312 |
$vipps_checkout_widgets_fields['checkout_widget_coupon'] = [ |
| 1313 |
'title' => __('Coupon code', 'woo-vipps'), |
| 1314 |
'label' => __('Enable the coupon code widget', 'woo-vipps'), |
| 1315 |
'type' => 'checkbox', |
| 1316 |
'description' => __('A widget to activate coupon codes.', 'woo-vipps'), |
| 1317 |
'default' => 'yes' |
| 1318 |
]; |
| 1319 |
// } |
| 1320 |
|
| 1321 |
$mainfields = array( |
| 1322 |
'main_options' => array( |
| 1323 |
'title' => __('Main options', 'woo-vipps'), |
| 1324 |
'type' => 'title', |
| 1325 |
'class' => 'tab', |
| 1326 |
), |
| 1327 |
'enabled' => array( |
| 1328 |
'title' => __('Enable/Disable', 'woocommerce'), |
| 1329 |
'label' => sprintf(__('Enable %1$s', 'woo-vipps'), Vipps::CompanyName()), |
| 1330 |
'type' => 'checkbox', |
| 1331 |
'description' => '', |
| 1332 |
'default' => 'no', |
| 1333 |
), |
| 1334 |
'country' => array( |
| 1335 |
'title' => __('Country', 'woo-vipps'), |
| 1336 |
'label' => __('Country', 'woo-vipps'), |
| 1337 |
'type' => 'select', |
| 1338 |
'options' => array( |
| 1339 |
'NO' => __('Norway', 'woo-vipps'), |
| 1340 |
'SE' => __('Sweden', 'woo-vipps'), |
| 1341 |
'FI' => __('Finland', 'woo-vipps'), |
| 1342 |
'DK' => __('Denmark', 'woo-vipps'), |
| 1343 |
), |
| 1344 |
'description' => __('Select the country for this merchant serial number. This will determine the appropriate payment method (Vipps or MobilePay).', 'woo-vipps'), |
| 1345 |
'default' => $country_code, |
| 1346 |
), |
| 1347 |
|
| 1348 |
'payment_method_name' => array( |
| 1349 |
'title' => __('Payment method', 'woo-vipps'), |
| 1350 |
'label' => __('Choose which payment method should be displayed to users at checkout', 'woo-vipps'), |
| 1351 |
'type' => 'select', |
| 1352 |
'options' => array( |
| 1353 |
'Vipps' => __('Vipps','woo-vipps'), |
| 1354 |
'MobilePay' => __('MobilePay', 'woo-vipps'), |
| 1355 |
), |
| 1356 |
'description' => __('Choose which payment method should be displayed to users at checkout', 'woo-vipps'), |
| 1357 |
'default' => $payment_method_name, |
| 1358 |
), |
| 1359 |
|
| 1360 |
'orderprefix' => array( |
| 1361 |
'title' => __('Order-id Prefix', 'woo-vipps'), |
| 1362 |
'label' => __('Order-id Prefix', 'woo-vipps'), |
| 1363 |
'type' => 'string', |
| 1364 |
'description' => __('An alphanumeric textstring to use as a prefix on orders from your shop, to avoid duplicate order-ids','woo-vipps'), |
| 1365 |
'default' => $orderprefix |
| 1366 |
), |
| 1367 |
'merchantSerialNumber' => array( |
| 1368 |
'title' => __('Merchant Serial Number', 'woo-vipps'), |
| 1369 |
'label' => __('Merchant Serial Number', 'woo-vipps'), |
| 1370 |
'type' => 'number', |
| 1371 |
'description' => __('Your "Merchant Serial Number" from the Developer tab on https://portal.vippsmobilepay.com','woo-vipps'), |
| 1372 |
'default' => '', |
| 1373 |
), |
| 1374 |
'clientId' => array( |
| 1375 |
'title' => __('Client Id', 'woo-vipps'), |
| 1376 |
'class' => 'vippspw', |
| 1377 |
'label' => __('Client Id', 'woo-vipps'), |
| 1378 |
'type' => 'password', |
| 1379 |
'description' => __('Find your account under the "Developer" tab on https://portal.vippsmobilepay.com/ and choose "Show keys". Copy the value of "client_id"','woo-vipps'), |
| 1380 |
'default' => '', |
| 1381 |
), |
| 1382 |
'secret' => array( |
| 1383 |
'title' => __('Client Secret', 'woo-vipps'), |
| 1384 |
'label' => __('Client Secret', 'woo-vipps'), |
| 1385 |
'class' => 'vippspw', |
| 1386 |
'type' => 'password', |
| 1387 |
'description' => __('Find your account under the "Developer" tab on https://portal.vippsmobilepay.com/ and choose "show keys". Copy the value of "client_secret"','woo-vipps'), |
| 1388 |
'default' => '', |
| 1389 |
), |
| 1390 |
'Ocp_Apim_Key_eCommerce' => array( |
| 1391 |
'title' => __('Subscription Key', 'woo-vipps'), |
| 1392 |
'label' => __('Subscription Key', 'woo-vipps'), |
| 1393 |
'class' => 'vippspw', |
| 1394 |
'type' => 'password', |
| 1395 |
'description' => __('Find your account under the "Developer" tab on https://portal.vippsmobilepay.com/ and choose "show keys". Copy the value of "Vipps-Subscription-Key"','woo-vipps'), |
| 1396 |
'default' => '', |
| 1397 |
), |
| 1398 |
|
| 1399 |
'result_status' => array( |
| 1400 |
'title' => sprintf(__('Order status on return from %1$s', 'woo-vipps'), Vipps::CompanyName()), |
| 1401 |
'label' => __('Choose default order status for reserved (not captured) orders', 'woo-vipps'), |
| 1402 |
'type' => 'select', |
| 1403 |
'options' => array( |
| 1404 |
'processing' => __('Processing', 'woo-vipps'), |
| 1405 |
'on-hold' => __('On hold','woo-vipps'), |
| 1406 |
), |
| 1407 |
'description' => __('By default, orders that are <b>reserved</b> but not <b>yet captured</b> will now have the order status \'Processing\'. You can capture the sum manually, or by changing the status to \'Complete\'. You should ensure that your workflow is such that the order is not shipped until after this capture.<br><br> The status \'On hold\' can be chosen instead for stores using a workflow where orders are shipped when the status is \'Processing\'. In this case, \'On hold\' will mean "order is reserved but not yet captured". This is a slightly safer solution, and ensures that the order status will reflect the payment status. <br><br>However, in many stores \'On hold\' has the additional meaning "there is a problem with the order"; and an email is often sent to the customer about this problem. The default is \'Processing\' because of this, and because many plugins and integrations expect orders to be \'Processing\' when the customer has completed payment.', 'woo-vipps'), |
| 1408 |
'default' => 'processing', |
| 1409 |
), |
| 1410 |
|
| 1411 |
'status_on_fail' => array( |
| 1412 |
'title' => sprintf(__('Order status on failed payment (for restartable orders)', 'woo-vipps'), Vipps::CompanyName()), |
| 1413 |
'label' => __('Choose default order status for failed payments', 'woo-vipps'), |
| 1414 |
'type' => 'select', |
| 1415 |
'options' => array( |
| 1416 |
/* translators: woocommerce status name */ |
| 1417 |
'failed' => __('Failed', 'woo-vipps'), |
| 1418 |
/* translators: woocommerce status name */ |
| 1419 |
'cancelled' => __('Cancelled','woo-vipps'), |
| 1420 |
), |
| 1421 |
/* translators: company name. cancelled and failed are woocommerce status names! */ |
| 1422 |
'description' => sprintf(__('By default, orders where payment is started but not completed at %1$s will be set to failed if they can be restarted. This setting changes this behaviour, but does <strong>not</strong> affect orders that cannot be restarted as these will always be set to cancelled.<br><br>Cancelled orders will keep the customer\'s shopping cart intact.<br>Failed orders can be restarted, possibly with another payment method.', 'woo-vipps'), Vipps::CompanyName()), |
| 1423 |
'default' => $default_status_on_fail, |
| 1424 |
), |
| 1425 |
|
| 1426 |
/* |
| 1427 |
'title' => array( |
| 1428 |
'title' => __('Title', 'woocommerce'), |
| 1429 |
'type' => 'text', |
| 1430 |
'description' => __('This controls the title which the user sees during checkout.', 'woocommerce'), |
| 1431 |
'default' => sprintf(__('%1$s','woo-vipps'), $payment_method_name), |
| 1432 |
), |
| 1433 |
*/ |
| 1434 |
|
| 1435 |
'description' => array( |
| 1436 |
'title' => __('Description', 'woocommerce'), |
| 1437 |
'type' => 'textarea', |
| 1438 |
'description' => __('This controls the description which the user sees during checkout.', 'woocommerce'), |
| 1439 |
'default' => __("Pay safely and easily. No fees, no matter the amount.", 'woo-vipps'), |
| 1440 |
), |
| 1441 |
|
| 1442 |
'vippsdefault' => array( |
| 1443 |
'title' => sprintf(__('Use %1$s as default payment method on checkout page', 'woo-vipps'), $payment_method_name), |
| 1444 |
'label' => sprintf(__('%1$s is default payment method', 'woo-vipps'), $payment_method_name), |
| 1445 |
'type' => 'checkbox', |
| 1446 |
'description' => sprintf(__('Enable this to use %1$s as the default payment method on the checkout page, regardless of order.', 'woo-vipps'), $payment_method_name), |
| 1447 |
'default' => 'yes', |
| 1448 |
), |
| 1449 |
|
| 1450 |
'checkout_phone_transformation' => array( |
| 1451 |
'title' => sprintf(__('Phone number transformation for %1$s and Express Checkout', 'woo-vipps'), 'Checkout'), |
| 1452 |
'label' => sprintf(__('Choose a transformation to apply to phone numbers for %1$s and Express Checkout', 'woo-vipps'), 'Checkout'), |
| 1453 |
'type' => 'select', |
| 1454 |
'options' => array( |
| 1455 |
'none' => __('None', 'woo-vipps'), |
| 1456 |
'ensure_plus' => __('Prepend \'+\'','woo-vipps'), |
| 1457 |
'strip_country_code' => __('Strip country code','woo-vipps'), |
| 1458 |
), |
| 1459 |
'description' => __('Phone numbers from Express or Checkout are in the format 47xxxxxx without plus-sign in front. If you prefer, or if it is neccessary for your integrations, you can transform these numbers either by adding the plus sign or by stripping the country-code (45, 46, 47, 358).<br>NB: stripping country codes is at the moment only supported for Norwegian, Danish, Finnish and Swedish numbers.<br>Remember to explicitly test your use case before committing to any transformation on your live store.', 'woo-vipps'), |
| 1460 |
'default' => 'none', |
| 1461 |
), |
| 1462 |
); |
| 1463 |
|
| 1464 |
$expressfields = array( |
| 1465 |
'express_options' => array( |
| 1466 |
'title' => sprintf(__('Express Checkout', 'woo-vipps')), |
| 1467 |
'type' => 'title', |
| 1468 |
'class' => 'tab', |
| 1469 |
'description' => sprintf(__("%1\$s allows you to buy products by a single click from the cart, checkout, or directly from product or catalog pages. Product will get a 'buy now' button which will start the purchase process immediately.", 'woo-vipps'), Vipps::ExpressCheckoutName()) |
| 1470 |
), |
| 1471 |
|
| 1472 |
'cartexpress' => array( |
| 1473 |
'title' => __('Enable Express Checkout in cart', 'woo-vipps'), |
| 1474 |
'label' => __('Enable Express Checkout in cart', 'woo-vipps'), |
| 1475 |
'type' => 'checkbox', |
| 1476 |
'description' => sprintf(__('Enable this to allow customers to shop using %1$s directly from the cart with no login or address input needed', 'woo-vipps'), Vipps::ExpressCheckoutName()) . '.<br>' . |
| 1477 |
sprintf(__('Please note that for Express Checkout, shipping must be calculated in a callback from the %1$s app, without any knowledge of the customer. This means that Express Checkout may not be compatible with all Shipping plugins or setup. You should test that your setup works if you intend to provide this feature.', 'woo-vipps'), Vipps::CompanyName()), |
| 1478 |
'default' => 'yes', |
| 1479 |
), |
| 1480 |
|
| 1481 |
'express_show_in_checkout' => array( |
| 1482 |
'title' => __('Enable Express Checkout in checkout', 'woo-vipps'), |
| 1483 |
'label' => __('Enable Express Checkout in checkout', 'woo-vipps'), |
| 1484 |
'type' => 'checkbox', |
| 1485 |
'description' => sprintf(__('Enable this to allow customers to shop using %1$s directly from the checkout page with no login or address input needed', 'woo-vipps'), Vipps::ExpressCheckoutName()) . '.<br>' . |
| 1486 |
sprintf(__('Please note that for Express Checkout, shipping must be calculated in a callback from the %1$s app, without any knowledge of the customer. This means that Express Checkout may not be compatible with all Shipping plugins or setup. You should test that your setup works if you intend to provide this feature.', 'woo-vipps'), Vipps::CompanyName()), |
| 1487 |
'default' => $default_express_show_in_checkout, |
| 1488 |
), |
| 1489 |
|
| 1490 |
'singleproductexpress' => array( |
| 1491 |
'title' => __('Enable Express Checkout for single products', 'woo-vipps'), |
| 1492 |
'label' => __('Enable Express Checkout for single products', 'woo-vipps'), |
| 1493 |
'type' => 'select', |
| 1494 |
'options' => array( |
| 1495 |
'none' => __('No products','woo-vipps'), |
| 1496 |
'some' => __('Some products', 'woo-vipps'), |
| 1497 |
'all' => __('All products','woo-vipps') |
| 1498 |
), |
| 1499 |
'description' => sprintf(__('Enable this to allow customers to buy a product using %1$s directly from the product page. If you choose \'some\', you must enable this on the relevant products', 'woo-vipps'), Vipps::ExpressCheckoutName()), |
| 1500 |
'default' => 'none', |
| 1501 |
), |
| 1502 |
'singleproductexpressarchives' => array( |
| 1503 |
'title' => __('Add \'Buy now\' button on catalog pages too', 'woo-vipps'), |
| 1504 |
'label' => __('Add the button for all relevant products on catalog pages', 'woo-vipps'), |
| 1505 |
'type' => 'checkbox', |
| 1506 |
'description' => sprintf(__('If %1$s is enabled for a product, add the \'Buy now\' button to catalog pages too', 'woo-vipps'), Vipps::ExpressCheckoutName()), |
| 1507 |
'default' => 'no', |
| 1508 |
), |
| 1509 |
'expresscheckout_termscheckbox' => array( |
| 1510 |
'title' => sprintf(__('Add terms and conditions checkbox on %1$s', 'woo-vipps'), Vipps::ExpressCheckoutName()), |
| 1511 |
'label' => sprintf(__('Always ask for confirmation on %1$s', 'woo-vipps'), Vipps::ExpressCheckoutName()), |
| 1512 |
'type' => 'checkbox', |
| 1513 |
'description' => sprintf(__('When using %1$s, ask the user to confirm that they have read and accepted the stores terms and conditons before proceeding', 'woo-vipps'), Vipps::ExpressCheckoutName()), |
| 1514 |
'default' => 'no', |
| 1515 |
), |
| 1516 |
|
| 1517 |
'expresscheckout_always_address' => array( |
| 1518 |
'title' => __('Always ask for address, even if products don\'t need shipping', 'woo-vipps'), |
| 1519 |
'label' => __('Always ask the user for their address, even if you don\'t need it for shipping', 'woo-vipps'), |
| 1520 |
'type' => 'checkbox', |
| 1521 |
'description' => __('If the order contains only "virtual" products that do not need shipping, we do not normally ask the user for their address - but check this box to do so anyway.', 'woo-vipps'), |
| 1522 |
'default' => $default_ask_address_for_express, |
| 1523 |
), |
| 1524 |
|
| 1525 |
'enablestaticshipping' => array( |
| 1526 |
'title' => __('Enable static shipping for Express Checkout', 'woo-vipps'), |
| 1527 |
'label' => __('Enable static shipping', 'woo-vipps'), |
| 1528 |
'type' => 'checkbox', |
| 1529 |
'description' => __('If your shipping options do not depend on the customers address, you can enable \'Static shipping\', which will precompute the shipping options when using Express Checkout so that this will be much faster. If you do this and the customer isn\'t logged in, the base location of the store will be used to compute the shipping options for the order. You should only use this if your shipping is actually \'static\', that is, does not vary based on the customers address. So fixed price/free shipping will work. If the customer is logged in, their address as registered in the store will be used, so if your customers are always logged in, you may be able to use this too.', 'woo-vipps'), |
| 1530 |
'default' => 'no', |
| 1531 |
), |
| 1532 |
|
| 1533 |
|
| 1534 |
'expresscreateuser' => array ( |
| 1535 |
'title' => __('Create new customers on Express Checkout', 'woo-vipps'), |
| 1536 |
'label' => __('Create new customers on Express Checkout', 'woo-vipps'), |
| 1537 |
'type' => 'checkbox', |
| 1538 |
'description' => sprintf(__('Enable this to create and login new customers when using express checkout. Otherwise these will all be guest checkouts. If you have "Login with Vipps" installed, this will be the default (unless you have turned off user creation in WooCommerce itself)', 'woo-vipps'), Vipps::CompanyName()), |
| 1539 |
'default' => $expresscreateuserdefault, |
| 1540 |
), |
| 1541 |
'singleproductbuynowcompatmode' => array( |
| 1542 |
'title' => __('"Buy now" compatibility mode', 'woo-vipps'), |
| 1543 |
'label' => __('Activate compatibility mode for all "Buy now" buttons', 'woo-vipps'), |
| 1544 |
'type' => 'checkbox', |
| 1545 |
'description' => __('Choosing this will use a different method of handling the "Buy now" button on a single product, which will work for more product types and more plugins - while being <i>slightly</i> less smooth. Use this if your product needs more configuration than simple or standard variable products', 'woo-vipps'), |
| 1546 |
'default' => 'no', |
| 1547 |
), |
| 1548 |
|
| 1549 |
|
| 1550 |
'deletefailedexpressorders' => array( |
| 1551 |
'title' => __('Delete failed Express Checkout Orders', 'woo-vipps'), |
| 1552 |
'label' => __('Delete failed Express Checkout Orders', 'woo-vipps'), |
| 1553 |
'type' => 'checkbox', |
| 1554 |
'description' => __('As Express Checkout orders are anonymous, failed orders will end up as "cancelled" orders with no information in them. Enable this to delete these automatically when cancelled - but test to make sure no other plugin needs them for anything.', 'woo-vipps'), |
| 1555 |
'default' => 'no', |
| 1556 |
) |
| 1557 |
); |
| 1558 |
// New shipping in express checkout is available, but merchant has overridden the old shipping callback. Ask what to do! IOK 2020-02-12 |
| 1559 |
if (has_action('woo_vipps_shipping_methods')) { |
| 1560 |
$shippingoptions = array( |
| 1561 |
'newshippingcallback' => array( |
| 1562 |
'title' => __('Use old-style shipping callback for express checkout', 'woo-vipps'), |
| 1563 |
'label' => __('Use your current shipping filters', 'woo-vipps'), |
| 1564 |
'type' => 'select', |
| 1565 |
'options' => array( |
| 1566 |
'none' => __('Select one','woo-vipps'), |
| 1567 |
'old' => __('Keep using old shipping callback with my custom filter', 'woo-vipps'), |
| 1568 |
'new' => __('Use new shipping callback','woo-vipps') |
| 1569 |
), |
| 1570 |
'description' => sprintf(__('Since version 1.4 this plugin uses a new method of providing shipping methods to %1$s when using Express Checkout. The new method supports metadata in the shipping options, which is neccessary for integration with Bring, Postnord etc. However, the new method is not compatible with the old <code>\'woo_vipps_shipping_methods\'</code> filter, which your site has overridden in a theme or plugin. If you want to, you can continue using this filter and the old method. If you want to disable your filters and use the new method, you can choose this here. ', 'woo-vipps'), Vipps::CompanyName()), |
| 1571 |
'default' => 'none', |
| 1572 |
) |
| 1573 |
); |
| 1574 |
$expressfields = array_merge(array_slice($expressfields ,0,1), $shippingoptions, array_slice($expressfields,1)); |
| 1575 |
} |
| 1576 |
|
| 1577 |
$advancedfields = array( |
| 1578 |
'advanced_options' => array( |
| 1579 |
'title' => __('Advanced', 'woo-vipps'), |
| 1580 |
'type' => 'title', |
| 1581 |
'class' => 'tab', |
| 1582 |
'description' => __("If you have issues with your theme, you might find a setting here that will help. Normally you do not need to change these.", 'woo-vipps') |
| 1583 |
), |
| 1584 |
|
| 1585 |
'vippsorderattribution' => array( |
| 1586 |
'title' => __( 'Support WooCommerces Order Attribution API for Checkout and Express Checkout', 'woo-vipps' ), |
| 1587 |
'label' => __( 'Add support for Order Attribution', 'woo-vipps' ), |
| 1588 |
'type' => 'checkbox', |
| 1589 |
'default'=> 'no', |
| 1590 |
'description' => __('Turn this on to add support for Woos Order Attribution API for Checkout and Express Checkout. Some stores have reported problems when using this API together with Vipps, so be sure to test this if you turn it on.', 'woo-vipps'), |
| 1591 |
), |
| 1592 |
|
| 1593 |
'vippsspecialpagetemplate' => array( |
| 1594 |
'title' => sprintf(__('Legacy: Override page template used for the special %1$s page', 'woo-vipps'), Vipps::CompanyName()), |
| 1595 |
'label' => sprintf(__('Use specific template for %1$s', 'woo-vipps'), Vipps::CompanyName()), |
| 1596 |
'type' => 'select', |
| 1597 |
'options' => $page_templates, |
| 1598 |
'description' => sprintf(__('Use this template from your theme or child-theme for the special %1$s page.<br>Legacy: This is not necessary anymore - you should instead choose a template by editing the page like any other page.','woo-vipps'), Vipps::CompanyName()), |
| 1599 |
'default' => ''), |
| 1600 |
|
| 1601 |
// Deprecated, not shown anymore: TODO: remove this option in future. LP 2026-09-01 |
| 1602 |
'vippsspecialpageid' => array( |
| 1603 |
'title' => sprintf(__('Use a real page ID for the special %1$s pages - neccessary for some themes', 'woo-vipps'), Vipps::CompanyName()), |
| 1604 |
'label' => __('Use a real page ID', 'woo-vipps'), |
| 1605 |
'type' => 'select', |
| 1606 |
'options' => [], |
| 1607 |
'description' => sprintf(__('Some very few themes do not work with the simulated pages used by this plugin, and needs a real page ID for this. Choose a blank page for this; the content will be replaced, but the template and other metadata will be present. You only need to use this if the plugin seems to break on the special %1$s pages.', 'woo-vipps'), Vipps::CompanyName()), |
| 1608 |
'default' => '' |
| 1609 |
), |
| 1610 |
|
| 1611 |
'sendreceipts' => array( |
| 1612 |
'title' => __("Send receipts and order confirmation info to the customers' app on completed purchases.", 'woo-vipps'), |
| 1613 |
'label' => sprintf(__("Send receipts to the customers %1\$s app", 'woo-vipps'), Vipps::CompanyName()), |
| 1614 |
'type' => 'checkbox', |
| 1615 |
'description' => sprintf(__("If this is checked, a receipt will be sent to %1\$s which will be viewable in the users' app, specifying the order items, shipping et cetera", 'woo-vipps'), Vipps::CompanyName()), |
| 1616 |
'default' => 'yes' |
| 1617 |
), |
| 1618 |
|
| 1619 |
'receiptimage' => array ( |
| 1620 |
'title' => sprintf(__('Use this image for the order confirmation link uploaded to the customers\' %1$s app', 'woo-vipps'), Vipps::CompanyName()), |
| 1621 |
'label' => sprintf(__('Profile image used in the %1$s App', 'woo-vipps'), Vipps::CompanyName()), |
| 1622 |
'type' => 'woo_vipps_image', |
| 1623 |
'description' => sprintf(__('If set, this image will be uploaded to %1$s and used to profile your store in the %1$s app for links to the order confirmation etc', 'woo-vipps'), Vipps::CompanyName()), |
| 1624 |
'default' => 0, |
| 1625 |
), |
| 1626 |
|
| 1627 |
'delete_settings_on_deactivation' => array ( |
| 1628 |
'title' => __('Delete plugin settings on deactivation', 'woo-vipps'), |
| 1629 |
'label' => __('Delete plugin settings on deactivation', 'woo-vipps'), |
| 1630 |
'type' => 'checkbox', |
| 1631 |
'description' => __('If set, all plugin settings will be deleted upon plugin deactivation. Warning: there is no recovery after deletion.', 'woo-vipps'), |
| 1632 |
'default' => 'no', |
| 1633 |
), |
| 1634 |
|
| 1635 |
'developermode' => array ( // DEVELOPERS! DEVELOPERS! DEVELOPERS! DEVE |
| 1636 |
'title' => __('Enable developer mode', 'woo-vipps'), |
| 1637 |
'label' => __('Enable developer mode', 'woo-vipps'), |
| 1638 |
'type' => 'checkbox', |
| 1639 |
'description' => __('Enable this to enter developer mode. This gives you access to the test-api and sometimes other tools not yet ready for general consumption', 'woo-vipps'), |
| 1640 |
'default' => VIPPS_TEST_MODE ? 'yes' : 'no', |
| 1641 |
) |
| 1642 |
|
| 1643 |
|
| 1644 |
); |
| 1645 |
|
| 1646 |
$developerfields = array( |
| 1647 |
'developertitle' => array( |
| 1648 |
'title' => __('Developer mode', 'woo-vipps'), |
| 1649 |
'type' => 'title', |
| 1650 |
'class' => 'tab', |
| 1651 |
'description' => __('These are settings for developers that contain extra features that are normally not useful for regular users, or are not yet ready for primetime', 'woo-vipps'), |
| 1652 |
), |
| 1653 |
|
| 1654 |
'testmode' => array( |
| 1655 |
'title' => __('Test mode', 'woo-vipps'), |
| 1656 |
'label' => __('Enable test mode', 'woo-vipps'), |
| 1657 |
'type' => 'checkbox', |
| 1658 |
'description' => sprintf(__('If you enable this, transactions will be made towards the %1$s Test API instead of the live one. No real transactions will be performed. You will need to fill out your test |
| 1659 |
accounts keys below, and you will need to install a special test-mode app from Testflight on a device (which cannot run the regular %1$s app). Contact %1$s\'s technical support if you need this. If you turn this mode off, normal operation will resume. If you have the VIPPS_TEST_MODE defined in your wp-config file, this will override this value. ', 'woo-vipps'), Vipps::CompanyName()), |
| 1660 |
'default' => VIPPS_TEST_MODE ? 'yes' : 'no', |
| 1661 |
), |
| 1662 |
'merchantSerialNumber_test' => array( |
| 1663 |
'title' => __('Merchant Serial Number', 'woo-vipps'), |
| 1664 |
'class' => 'vippspw', |
| 1665 |
'label' => __('Merchant Serial Number', 'woo-vipps'), |
| 1666 |
'type' => 'number', |
| 1667 |
'description' => __('Your test account "Merchant Serial Number" from the Developer tab on https://portal.vippsmobilepay.com','woo-vipps'), |
| 1668 |
'default' => '', |
| 1669 |
), |
| 1670 |
'clientId_test' => array( |
| 1671 |
'title' => __('Client Id', 'woo-vipps'), |
| 1672 |
'label' => __('Client Id', 'woo-vipps'), |
| 1673 |
'type' => 'password', |
| 1674 |
'class' => 'vippspw', |
| 1675 |
'description' => __('Find your test account under the "Developer" tab on https://portal.vippsmobilepay.com/ and choose "Show keys". Copy the value of "client_id"','woo-vipps'), |
| 1676 |
'default' => '', |
| 1677 |
), |
| 1678 |
'secret_test' => array( |
| 1679 |
'title' => __('Client Secret', 'woo-vipps'), |
| 1680 |
'label' => __('Client Secret', 'woo-vipps'), |
| 1681 |
'type' => 'password', |
| 1682 |
'class' => 'vippspw', |
| 1683 |
'description' => __('Find your test account under the "Developer" tab on https://portal.vippsmobilepay.com/ and choose "show keys". Copy the value of "client_secret"','woo-vipps'), |
| 1684 |
'default' => '', |
| 1685 |
), |
| 1686 |
'Ocp_Apim_Key_eCommerce_test' => array( |
| 1687 |
'title' => __('Subscription Key', 'woo-vipps'), |
| 1688 |
'label' => __('Subscription Key', 'woo-vipps'), |
| 1689 |
'type' => 'password', |
| 1690 |
'class' => 'vippspw', |
| 1691 |
'description' => __('Find your test account under the "Developer" tab on https://portal.vippsmobilepay.com/ and choose "show keys". Copy the value of "Vipps-Subscription-Key"','woo-vipps'), |
| 1692 |
'default' => '', |
| 1693 |
), |
| 1694 |
); |
| 1695 |
|
| 1696 |
// Add all the standard fields |
| 1697 |
foreach($mainfields as $key=>$field) { |
| 1698 |
$this->form_fields[$key] = $field; |
| 1699 |
} |
| 1700 |
foreach($expressfields as $key=>$field) { |
| 1701 |
$this->form_fields[$key] = $field; |
| 1702 |
} |
| 1703 |
foreach($checkoutfields as $key=>$field) { |
| 1704 |
$this->form_fields[$key] = $field; |
| 1705 |
} |
| 1706 |
|
| 1707 |
|
| 1708 |
foreach($external_payment_fields as $key=>$field) { |
| 1709 |
$this->form_fields[$key] = $field; |
| 1710 |
} |
| 1711 |
|
| 1712 |
foreach($vipps_checkout_widgets_fields as $key=>$field) { |
| 1713 |
$this->form_fields[$key] = $field; |
| 1714 |
} |
| 1715 |
|
| 1716 |
foreach($vipps_checkout_shipping_fields as $key=>$field) { |
| 1717 |
$this->form_fields[$key] = $field; |
| 1718 |
} |
| 1719 |
foreach($advancedfields as $key=>$field) { |
| 1720 |
$this->form_fields[$key] = $field; |
| 1721 |
} |
| 1722 |
|
| 1723 |
// The react UI decides whether or not to show the developer fields, however we always have to send this data to the client |
| 1724 |
// because otherwise the react UI will not be able to show the correct translations, since they would be missing. |
| 1725 |
foreach($developerfields as $key=>$field) { |
| 1726 |
$this->form_fields[$key] = $field; |
| 1727 |
} |
| 1728 |
// Developer mode settings: Only shown when active. IOK 2019-08-30 |
| 1729 |
if ($this->get_option('developermode') == 'yes' || VIPPS_TEST_MODE) { |
| 1730 |
if (VIPPS_TEST_MODE) { |
| 1731 |
$this->form_fields['developermode']['description'] .= '<br><b>' . __('VIPPS_TEST_MODE is set to true in your configuration - dev mode is forced', 'woo-vipps') . "</b>"; |
| 1732 |
$this->form_fields['testmode']['description'] .= '<br><b>' . __('VIPPS_TEST_MODE is set to true in your configuration - test mode is forced', 'woo-vipps') . "</b>"; |
| 1733 |
} |
| 1734 |
} |
| 1735 |
|
| 1736 |
|
| 1737 |
} |
| 1738 |
|
| 1739 |
|
| 1740 |
// IOK 2018-04-18 utilities for the 'admin notices' interface. |
| 1741 |
private function adminwarn($what) { |
| 1742 |
add_action('vipps_admin_notices',function() use ($what) { |
| 1743 |
echo "<div class='notice notice-warning is-dismissible'><p>$what</p></div>"; |
| 1744 |
}); |
| 1745 |
} |
| 1746 |
private function adminerr($what) { |
| 1747 |
add_action('vipps_admin_notices',function() use ($what) { |
| 1748 |
echo "<div class='notice notice-error is-dismissible'><p>$what</p></div>"; |
| 1749 |
}); |
| 1750 |
} |
| 1751 |
private function adminnotify($what) { |
| 1752 |
add_action('vipps_admin_notices',function() use ($what) { |
| 1753 |
echo "<div class='notice notice-info is-dismissible'><p>$what</p></div>"; |
| 1754 |
}); |
| 1755 |
} |
| 1756 |
|
| 1757 |
// Only be available if current currency is NOK IOK 2018-09-19 |
| 1758 |
// Only be available if current currency is supported NT 2023-12-04 |
| 1759 |
public function is_available() { |
| 1760 |
// This is split into two functions to avoid triggering infinite recursion in filters that override this value below. IOK 2021-10-30 |
| 1761 |
$ok = $this->standard_is_available(); |
| 1762 |
$ok = apply_filters('woo_vipps_is_available', $ok, $this); |
| 1763 |
return $ok; |
| 1764 |
} |
| 1765 |
|
| 1766 |
// True if the alternative Checkout screen is both available and activated. Returns the page id of the checkout |
| 1767 |
// page for convenience. IOK 2021-10-01 |
| 1768 |
public function vipps_checkout_available () { |
| 1769 |
|
| 1770 |
if ($this->get_option('vipps_checkout_enabled') != 'yes') return false; |
| 1771 |
if (!$this->standard_is_available()) return false; |
| 1772 |
|
| 1773 |
$checkoutid = wc_get_page_id('vipps_checkout'); |
| 1774 |
if (!$checkoutid) return false; |
| 1775 |
|
| 1776 |
// Page doesn't exist anymore |
| 1777 |
if (! get_post_status($checkoutid)) { |
| 1778 |
delete_option('woocommerce_vipps_checkout_page_id'); |
| 1779 |
return false; |
| 1780 |
} |
| 1781 |
|
| 1782 |
// Restrictions on cart are similar to express checkout, but not exactly the same. IOK 2024-01-11 |
| 1783 |
if (!$this->cart_supports_checkout()) return false; |
| 1784 |
|
| 1785 |
// Filter to false if you want to use the standard checkout for whatever reason |
| 1786 |
return apply_filters('woo_vipps_checkout_available', $checkoutid, $this); |
| 1787 |
} |
| 1788 |
|
| 1789 |
// Get supported currencies for payment method NT 2023-12-04 |
| 1790 |
public function get_supported_currencies($payment_method) { |
| 1791 |
switch ($payment_method) { |
| 1792 |
case 'Vipps': return array('NOK', 'SEK'); |
| 1793 |
case 'MobilePay': return array('DKK', 'EUR'); |
| 1794 |
default: return array(); |
| 1795 |
} |
| 1796 |
} |
| 1797 |
|
| 1798 |
// Check if payment method supports currency. NT 2023-12-04 |
| 1799 |
public function payment_method_supports_currency($payment_method, $currency) { |
| 1800 |
$ok = in_array($currency, $this->get_supported_currencies($payment_method)); |
| 1801 |
return $ok; |
| 1802 |
} |
| 1803 |
|
| 1804 |
// Basic unfiltered version of "can I use vipps" ? IOK 2021-10-01 |
| 1805 |
protected function standard_is_available () { |
| 1806 |
if (!$this->can_be_activated()) return false; |
| 1807 |
if (!parent::is_available()) return false; |
| 1808 |
if (!$this->payment_method_supports_currency($this->get_payment_method_name(), get_woocommerce_currency())) return false; |
| 1809 |
return true; |
| 1810 |
} |
| 1811 |
|
| 1812 |
// True if the express checkout feature should be available |
| 1813 |
public function express_checkout_available() { |
| 1814 |
if (! $this->is_available()) return false; |
| 1815 |
$ok = true; |
| 1816 |
$ok = apply_filters('woo_vipps_express_checkout_available', $ok, $this); |
| 1817 |
return $ok; |
| 1818 |
} |
| 1819 |
|
| 1820 |
// IOK 2018-04-20 Initiate payment at Vipps and redirect to the Vipps payment terminal. |
| 1821 |
public function process_payment ($order_id) { |
| 1822 |
global $woocommerce, $Vipps; |
| 1823 |
if (!$order_id) return []; |
| 1824 |
|
| 1825 |
do_action('woo_vipps_before_process_payment',$order_id); |
| 1826 |
|
| 1827 |
// Get current merchant serial |
| 1828 |
$msn = $this->get_merchant_serial(); |
| 1829 |
|
| 1830 |
// Do a quick check for correct setup first - this is the most critical point IOK 2018-05-11 |
| 1831 |
try { |
| 1832 |
$at = $this->api->get_access_token($msn); |
| 1833 |
} catch (Exception $e) { |
| 1834 |
$this->log(sprintf(__('Could not get access token when initiating %1$s payment for order id:','woo-vipps'), $this->get_payment_method_name()) . $order_id .":\n" . $e->getMessage(), 'error'); |
| 1835 |
wc_add_notice(sprintf(__('Unfortunately, the %1$s payment method is currently unavailable. Please choose another method.','woo-vipps'), $this->get_payment_method_name()),'error'); |
| 1836 |
return []; |
| 1837 |
} |
| 1838 |
|
| 1839 |
// From the request, get either [billing_phone] => or [vipps phone] |
| 1840 |
$phone = ''; |
| 1841 |
if (isset($_POST['vippsphone'])) { |
| 1842 |
$phone = trim(sanitize_text_field($_POST['vippsphone'])); |
| 1843 |
} |
| 1844 |
if (!$phone && isset($_POST['billing_phone'])) { |
| 1845 |
$phone = trim(sanitize_text_field($_POST['billing_phone'])); |
| 1846 |
} |
| 1847 |
|
| 1848 |
// This is for express checkout if we know the customers' phone. |
| 1849 |
// thanks to sOndre @ github for reporting , https://github.com/vippsas/vipps-woocommerce/issues/22 |
| 1850 |
if (!$phone && WC()->customer) { |
| 1851 |
$phone = WC()->customer->get_billing_phone(); |
| 1852 |
} |
| 1853 |
|
| 1854 |
// No longer the case for V2 of the API |
| 1855 |
if (false && !$phone) { |
| 1856 |
wc_add_notice(sprintf(__('You need to enter your phone number to pay with %1$s','woo-vipps'), $this->get_payment_method_name()) ,'error'); |
| 1857 |
return []; |
| 1858 |
} |
| 1859 |
|
| 1860 |
$order = wc_get_order($order_id); |
| 1861 |
$content = null; |
| 1862 |
|
| 1863 |
// Should be impossible, but there we go IOK 2022-04-21 |
| 1864 |
if (! $order->has_status(['pending', 'failed'])) { |
| 1865 |
$this->log(sprintf(__("Trying to start order %1\$s with status %2\$s - only 'pending' and 'failed' are allowed, so this will fail", 'woo-vipps'), $order_id, $order->get_status())); |
| 1866 |
wc_add_notice(sprintf(__('This order cannot be paid with %1$s - please try another payment method or try again later', 'woo-vipps'), $this->get_payment_method_name()), 'error'); |
| 1867 |
return []; |
| 1868 |
} |
| 1869 |
|
| 1870 |
// If the Vipps order already has an init-timestamp, we should *not* call init_payment again, |
| 1871 |
// in the *normal* case, this is a user who have lost their vipps session, so it suffices to |
| 1872 |
// just return the stored vipps session URL (eg. the user used the Back button.) If abandoned, the |
| 1873 |
// order will eventually be cancelled. Changes in the cart will result in a new order anyway. |
| 1874 |
// Note: we now also support restarting the payment with a new retry session if there is no stored vipps session. LP 2026-03-12 |
| 1875 |
if ($order->get_meta('_vipps_init_timestamp')) { |
| 1876 |
$oldurl = $order->get_meta('_vipps_orderurl'); |
| 1877 |
|
| 1878 |
// Poll status at VMP here to verify session is still open. LP 2026-02-27 |
| 1879 |
$vipps_status = 'unknown'; |
| 1880 |
$vipps_session_open = false; |
| 1881 |
try { |
| 1882 |
$vipps_status = $this->get_payment_details($order)['status'] ?? 'unknown'; |
| 1883 |
if ('unknown' !== $vipps_status) { |
| 1884 |
$vipps_status = $this->interpret_vipps_order_status($vipps_status); |
| 1885 |
$vipps_session_open = 'initiated' === $vipps_status; |
| 1886 |
} |
| 1887 |
} catch (Exception $e) { |
| 1888 |
/* translators: company name, order id */ |
| 1889 |
$this->log(sprintf(__('Retry-branch: error getting payment details from %1$s for order id %2$s:','woo-vipps'), $this->get_payment_method_name(), $order->get_id()) . "\n" . $e->getMessage(), 'error'); |
| 1890 |
} |
| 1891 |
|
| 1892 |
// Do we have an active session we can redirect to? LP 2026-02-27 |
| 1893 |
if ($vipps_session_open && $oldurl) { |
| 1894 |
$order->add_order_note(sprintf(__('%1$s payment restarted','woo-vipps'), $this->get_payment_method_name())); |
| 1895 |
return array('result'=>'success','redirect'=>$oldurl); |
| 1896 |
} |
| 1897 |
|
| 1898 |
// If not, then we need to create a new retry session with incrementing index. LP 2026-03-12 |
| 1899 |
$retry_count = intval($order->get_meta('_vipps_retry_count')) + 1; |
| 1900 |
$enable_payment_retry = 'unknown' !== $vipps_status; // dont retry unknown statuses. LP 2026-03-18 |
| 1901 |
if (apply_filters('woo_vipps_enable_payment_retry', $enable_payment_retry, $order, $vipps_status, $retry_count)) { |
| 1902 |
/* translators: number of attempts, order id. */ |
| 1903 |
$this->log(sprintf(__('Order %2$d session could not be restored, creating a new retry session (retry #%1$d).', 'woo-vipps'), $retry_count, $order_id), 'info'); |
| 1904 |
$order->update_meta_data('_vipps_retry_count', $retry_count); |
| 1905 |
$order->save_meta_data(); |
| 1906 |
} else { |
| 1907 |
// If restarting is disabled, then we have to cancel the order. LP 2026-03-12 |
| 1908 |
/* translators: order id. */ |
| 1909 |
$this->log(sprintf(__('Order %1$d session could not be restored, and payment retry is disabled. Cancelling the order!', 'woo-vipps'), $order_id), 'info'); |
| 1910 |
$order->update_status('cancelled', sprintf(__('Cannot restart order at %1$s', 'woo-vipps'), Vipps::CompanyName())); |
| 1911 |
return []; |
| 1912 |
} |
| 1913 |
} |
| 1914 |
|
| 1915 |
// This is needed to ensure that the callbacks from Vipps have access to the customers' session which is important for some plugins. IOK 2019-11-22 |
| 1916 |
$this->save_session_in_order($order); |
| 1917 |
|
| 1918 |
// Vipps-terminal-page return url to poll/await return |
| 1919 |
$returnurl= $Vipps->payment_return_url(); |
| 1920 |
// If we are using express checkout, use this to handle the address stuff |
| 1921 |
// IOK 2018-11-19 also when *not* using express checkout. This allows us to pass the order-id in the return URL and use this as a password in case the sesson has been lost. |
| 1922 |
$authtoken = $this->generate_authtoken(); |
| 1923 |
|
| 1924 |
// IOK 2019-11-19 We have to do this because even though we actually store the order ID in the session, we can a) be redirected to another browser than the one with |
| 1925 |
// the session, and b) some plugins wipe the session for guest purchases. |
| 1926 |
// So we might need to restore (enough of the) session to get to the than you page, even if the session is gone |
| 1927 |
// or in another castle. |
| 1928 |
// IOK 2023-01-23 store the limited session in the order instead and separeted it from the authtoken |
| 1929 |
$limited_session = $this->generate_authtoken(); |
| 1930 |
$returnurl = add_query_arg('ls',$limited_session,$returnurl); |
| 1931 |
$returnurl = add_query_arg('id', $order_id, $returnurl); |
| 1932 |
|
| 1933 |
try { |
| 1934 |
// If the order was 'failed', it isnt any more! yet! |
| 1935 |
if ($order->get_status() == 'failed') { |
| 1936 |
$order->set_status('pending', __('Setting order status to pending to start payment', 'woo-vipps')); |
| 1937 |
} |
| 1938 |
// The requestid is actually for replaying the request, but I get 402 if I retry with the same Orderid. |
| 1939 |
// Still, if we want to handle transient error conditions, then that needs to be extended here (timeouts, etc) |
| 1940 |
// Update: replaced requestid with new idempotency key, moved this into epayment_initiate_payment. LP 2026-03-13 |
| 1941 |
$content = $this->api->epayment_initiate_payment($phone,$order,$returnurl,$authtoken); |
| 1942 |
} catch (TemporaryVippsApiException $e) { |
| 1943 |
$this->log(sprintf(__('Could not initiate %1$s payment','woo-vipps'), $this->get_payment_method_name()) . ' ' . $e->getMessage(), 'error'); |
| 1944 |
wc_add_notice(sprintf(__('Unfortunately, the %1$s payment method is temporarily unavailable. Please wait or choose another method.','woo-vipps'), $this->get_payment_method_name()),'error'); |
| 1945 |
return []; |
| 1946 |
} catch (Exception $e) { |
| 1947 |
|
| 1948 |
// Special case the "duplicate order id" thing to ensure it doesn't happen again, and if it does, at least |
| 1949 |
// log some more info IOK 2022-11-02 |
| 1950 |
if (preg_match("/Duplicate Order Id/i", $e->getMessage())) { |
| 1951 |
do_action('woo_vipps_duplicate_order_id', $order); |
| 1952 |
$this->log(sprintf(__("Duplicate Order ID! Please report this to [email protected] together with as much info about the order as possible. Express: %1\$s Status: %2\$s User agent: %3\$s", 'woo-vipps'), $order->get_meta('_vipps_express_checkout'), $order->get_status(), $order->get_customer_user_agent()), 'error'); |
| 1953 |
$order->update_status('cancelled', __('Cannot restart order with same order ID: Must cancel', 'woo-vipps')); |
| 1954 |
} |
| 1955 |
|
| 1956 |
$this->log(sprintf(__('Could not initiate %1$s payment','woo-vipps'), $this->get_payment_method_name()) . ' ' . $e->getMessage(), 'error'); |
| 1957 |
wc_add_notice(sprintf(__('Unfortunately, the %1$s payment method is currently unavailable. Please choose another method.','woo-vipps'), $this->get_payment_method_name()),'error'); |
| 1958 |
return []; |
| 1959 |
} |
| 1960 |
|
| 1961 |
$url = $content['url']; |
| 1962 |
$vippstamp = time(); |
| 1963 |
|
| 1964 |
// Ensure we only check the status by ajax of our own orders. IOK 2018-05-03 |
| 1965 |
$sessionorders= WC()->session->get('_vipps_session_orders'); |
| 1966 |
$sessionorders[$order_id] = 1; |
| 1967 |
WC()->session->set('_vipps_session_orders',$sessionorders); |
| 1968 |
WC()->session->set('_vipps_pending_order',$order_id); // Send information to the 'please confirm' screen IOK 2018-04-24 |
| 1969 |
|
| 1970 |
$order = wc_get_order($order_id); |
| 1971 |
if ($authtoken) { |
| 1972 |
$order->update_meta_data('_vipps_authtoken',wp_hash_password($authtoken)); |
| 1973 |
} |
| 1974 |
if ($limited_session) { |
| 1975 |
$order->update_meta_data('_vipps_limited_session',wp_hash_password($limited_session)); |
| 1976 |
} |
| 1977 |
// Store the "session URL" for restarts of the order in the same session context. IOK 2022-11-02 |
| 1978 |
$order->update_meta_data('_vipps_init_timestamp',$vippstamp); |
| 1979 |
$order->update_meta_data('_vipps_orderurl', $url); |
| 1980 |
|
| 1981 |
$order->update_meta_data('_vipps_status','INITIATE'); // INITIATE right now |
| 1982 |
|
| 1983 |
$name = $this->get_payment_method_name(); |
| 1984 |
$order->add_order_note(sprintf(__('%1$s payment initiated','woo-vipps'), $name)); |
| 1985 |
$order->add_order_note(sprintf(__('Awaiting %1$s payment confirmation','woo-vipps'),$name)); |
| 1986 |
|
| 1987 |
$order->save(); |
| 1988 |
// Create a signal file that we can check without calling wordpress to see if our result is in IOK 2018-05-04 |
| 1989 |
try { |
| 1990 |
$Vipps->createCallbackSignal($order); |
| 1991 |
} catch (Exception $e) { |
| 1992 |
// Could not create a signal file, but that's ok. |
| 1993 |
} |
| 1994 |
do_action('woo_vipps_before_redirect_to_vipps',$order_id); |
| 1995 |
|
| 1996 |
// This will send us to a receipt page where we will do the actual work. IOK 2018-04-20 |
| 1997 |
return array('result'=>'success','redirect'=>$url); |
| 1998 |
} |
| 1999 |
|
| 2000 |
|
| 2001 |
// This tries to capture a Vipps payment, and resets the status to 'on-hold' if it fails. IOK 2018-05-07 |
| 2002 |
public function maybe_capture_payment($orderid) { |
| 2003 |
$order = wc_get_order($orderid); |
| 2004 |
if (! Vipps::is_vipps_order($order)) return false; |
| 2005 |
$ok = 0; |
| 2006 |
|
| 2007 |
# Shortcut orders that have been directly captured |
| 2008 |
$vippsstatus = $order->get_meta('_vipps_status'); |
| 2009 |
if ($vippsstatus == 'SALE') { |
| 2010 |
return true; |
| 2011 |
} |
| 2012 |
|
| 2013 |
$remaining = intval($order->get_meta('_vipps_capture_remaining')); |
| 2014 |
|
| 2015 |
// Somehow the order status in payment_complete has been set to the 'after order status' or 'complete' by a filter. If so, do not capture. |
| 2016 |
// Capture will be done *before* payment_complete if appropriate IOK 2020-09-22 |
| 2017 |
if (did_action('woocommerce_pre_payment_complete')) { |
| 2018 |
if (!$order->needs_processing()) return; // This is fine, we've captured. |
| 2019 |
if ($remaining>0) { |
| 2020 |
// Not everything has been captured, but we have reached a capturable status. Complain, do not capture. IOK 2020-09-22 |
| 2021 |
$this->log(sprintf(__("Filters are setting the payment_complete order status to '%1\$s' - will not capture", 'woo-vipps'), $order->get_status()),'debug'); |
| 2022 |
$order->add_order_note(sprintf(__('Payment complete set status to "%1$s" - will not capture payments automatically','woo-vipps'), $order->get_status())); |
| 2023 |
return false; |
| 2024 |
} |
| 2025 |
} |
| 2026 |
|
| 2027 |
// IOK 2019-10-03 it is now possible to do capture via other tools than Woo, so we must now first check to see if |
| 2028 |
// the order is capturable by getting full payment details. |
| 2029 |
try { |
| 2030 |
$order = $this->update_vipps_payment_details($order); |
| 2031 |
} catch (Exception $e) { |
| 2032 |
//Do nothing with this for now |
| 2033 |
$this->log(__("Error getting payment details before doing capture: ", 'woo-vipps') . $e->getMessage(), 'warning'); |
| 2034 |
} |
| 2035 |
|
| 2036 |
try { |
| 2037 |
$ok = $this->capture_payment($order); |
| 2038 |
} catch (Exception $e) { |
| 2039 |
// This is handled in sub-methods so we shouldn't actually hit this IOK 2018-05-07 |
| 2040 |
} |
| 2041 |
if ($ok) { |
| 2042 |
// Signal other hooked actions that this one actually did something. IOK 2025-02-04 |
| 2043 |
$order->update_meta_data('_vipps_capture_complete',true); |
| 2044 |
$order->save(); |
| 2045 |
} else { |
| 2046 |
$order->update_meta_data('_vipps_capture_complete',false); |
| 2047 |
$msg = sprintf(__("Could not capture %1\$s payment for this order!", 'woo-vipps'), $this->get_payment_method_name()); |
| 2048 |
$order->add_order_note($msg); |
| 2049 |
$order->save(); |
| 2050 |
if (apply_filters('woo_vipps_on_hold_on_failed_capture', true, $order)) { |
| 2051 |
$msg = sprintf(__("Could not capture %1\$s payment - status set to", 'woo-vipps'), $this->get_payment_method_name()) . ' ' . __('on-hold','woocommerce'); |
| 2052 |
$order->set_status('on-hold',$msg); |
| 2053 |
$order->save(); |
| 2054 |
global $Vipps; |
| 2055 |
$this->adminerr($msg); |
| 2056 |
$Vipps->store_admin_notices(); |
| 2057 |
return false; |
| 2058 |
} |
| 2059 |
} |
| 2060 |
} |
| 2061 |
|
| 2062 |
|
| 2063 |
// Capture (possibly partially) the order. Only full capture really supported by plugin at this point. IOK 2018-05-07 |
| 2064 |
// Except that we *do* note that money "refunded" through vipps before capture should be "uncapturable". IOK 2024-11-25 |
| 2065 |
public function capture_payment($order) { |
| 2066 |
$pm = $order->get_payment_method(); |
| 2067 |
if (! Vipps::is_vipps_order($pm)) { |
| 2068 |
$this->log(sprintf(__('Trying to capture payment on order not made by %1$s:','woo-vipps'), $this->get_payment_method_name()). ' ' . $order->get_id(), 'error'); |
| 2069 |
$this->adminerr(sprintf(__('Cannot capture payment on orders not made by %1$s','woo-vipps'), $this->get_payment_method_name())); |
| 2070 |
return false; |
| 2071 |
} |
| 2072 |
|
| 2073 |
// Partial capture can happen if the order is edited IOK 2017-12-19 |
| 2074 |
$captured = intval($order->get_meta('_vipps_captured')); |
| 2075 |
$vippsstatus = $order->get_meta('_vipps_status'); |
| 2076 |
$noncapturable = intval($order->get_meta('_vipps_noncapturable')); // This money has been marked as not-to-be-captured. It will be cancelled on complete. |
| 2077 |
|
| 2078 |
// Ensure 'SALE' direct captured orders work |
| 2079 |
if (!$captured && $vippsstatus == 'SALE') { |
| 2080 |
$order = $this->update_vipps_payment_details($order); |
| 2081 |
$captured = intval($order->get_meta('_vipps_captured')); |
| 2082 |
} |
| 2083 |
|
| 2084 |
$total = round(wc_format_decimal($order->get_total(),'')*100); |
| 2085 |
$amount = $total-$captured-$noncapturable; // IOK subtract any amount not to be captured here |
| 2086 |
|
| 2087 |
if ($amount<=0) { |
| 2088 |
$order->add_order_note(__('Payment already captured','woo-vipps')); |
| 2089 |
return true; |
| 2090 |
} |
| 2091 |
|
| 2092 |
// If we already have captured everything, then we are ok! IOK 2017-05-07 |
| 2093 |
if ($captured) { |
| 2094 |
$remaining = intval($order->get_meta('_vipps_capture_remaining')); |
| 2095 |
if (!$remaining) { |
| 2096 |
$order->add_order_note(__('Payment already captured','woo-vipps')); |
| 2097 |
return true; |
| 2098 |
} |
| 2099 |
} |
| 2100 |
|
| 2101 |
// Each time we succeed, we'll increase the 'capture' transaction id so we don't just capture the same amount again and again. IOK 2018-05-07 |
| 2102 |
// (but on failre, we don't increase it - and also, we don't really support partial capture yet.) IOK 2018-05-07 |
| 2103 |
$requestidnr = intval($order->get_meta('_vipps_capture_transid')); |
| 2104 |
// IOK 2023-03-13 keep track of failed captures; because some stores automate capturing without paying attention to the result. |
| 2105 |
// some reservations are for only 7 days (or 30 days or 180 days) so some orders will be uncapturable. This will be reset by the |
| 2106 |
// 'Show full transaction details' metabox. |
| 2107 |
$failures = intval($order->get_meta('_vipps_capture_failures')); |
| 2108 |
$failurelimit = 10; |
| 2109 |
try { |
| 2110 |
|
| 2111 |
// Assume we cannot capture if we have gotten errors 10 times from the API |
| 2112 |
if ($failures >= $failurelimit) { |
| 2113 |
throw new Exception(sprintf(__("More than %1\$d API exceptions trying to capture order - this order cannot be captured.", 'woo-vipps'), $failures)); |
| 2114 |
} |
| 2115 |
|
| 2116 |
$requestid = $requestidnr . ":" . $order->get_order_key(); |
| 2117 |
$api = $order->get_meta('_vipps_api'); |
| 2118 |
|
| 2119 |
|
| 2120 |
if ($api == 'banktransfer') { |
| 2121 |
// This is an error - we should not ever get to the 'capture' branch if we are a banktransfer payment. |
| 2122 |
// IOK 2024-01-09 |
| 2123 |
$content = []; |
| 2124 |
} else { |
| 2125 |
// Now the only other api is 'epayment' IOK 2026-08-18 |
| 2126 |
$content = $this->api->epayment_capture_payment($order,$amount,$requestid); |
| 2127 |
} |
| 2128 |
} catch (TemporaryVippsApiException $e) { |
| 2129 |
$this->log(sprintf(__('Could not capture %1$s payment for order id:', 'woo-vipps'), $this->get_payment_method_name()) . ' ' . $order->get_id() . "\n" .$e->getMessage(),'error'); |
| 2130 |
$this->adminerr(sprintf(__('%1$s is temporarily unavailable.','woo-vipps'), $this->get_payment_method_name()) . "\n" . $e->getMessage()); |
| 2131 |
return false; |
| 2132 |
} catch (Exception $e) { |
| 2133 |
// Keep track of API failures up to a point. IOK 2024-03-13 |
| 2134 |
if ($failures < $failurelimit) { |
| 2135 |
$order->update_meta_data('_vipps_capture_failures', $failures + 1); |
| 2136 |
$order->save(); |
| 2137 |
} |
| 2138 |
|
| 2139 |
$msg = sprintf(__('Could not capture %1$s payment for order_id:','woo-vipps'), $this->get_payment_method_name()) . ' ' . $order->get_id() . "\n" . $e->getMessage(); |
| 2140 |
$this->log($msg,'error'); |
| 2141 |
$this->adminerr($msg); |
| 2142 |
return false; |
| 2143 |
} |
| 2144 |
|
| 2145 |
$currency = $order->get_currency(); |
| 2146 |
|
| 2147 |
// Previously, we got this from the transactionInfo field of the Vipps data - this is no longer provided. IOK 2025-08-12 |
| 2148 |
// We simply have to keep track: There is no way of knowing what the correct values are here yet, as we only get these values async, after |
| 2149 |
// the fact. |
| 2150 |
$captured = $amount + intval($order->get_meta('_vipps_captured')); |
| 2151 |
$remaining = intval($order->get_meta('_vipps_amount')) - $captured - intval($order->get_meta('_vipps_cancelled')); |
| 2152 |
$refundable = $captured - intval($order->get_meta('_vipps_refunded')); |
| 2153 |
|
| 2154 |
$order->update_meta_data('_vipps_captured', $captured); |
| 2155 |
$order->update_meta_data('_vipps_capture_remaining', $remaining); |
| 2156 |
$order->update_meta_data('_vipps_refund_remaining', $refundable); |
| 2157 |
$order->update_meta_data('_vipps_capture_timestamp', time()); |
| 2158 |
$order->add_order_note(sprintf(__('%1$s Payment captured:','woo-vipps'), $this->get_payment_method_name()) . ' ' . sprintf("%0.2f",$captured/100) . ' ' . $currency); |
| 2159 |
|
| 2160 |
|
| 2161 |
// Since we succeeded, the next time we'll start a new transaction. |
| 2162 |
$order->update_meta_data('_vipps_capture_transid', $requestidnr+1); |
| 2163 |
$order->save(); |
| 2164 |
|
| 2165 |
return true; |
| 2166 |
} |
| 2167 |
|
| 2168 |
|
| 2169 |
// Cancel (only completely) a reserved but not yet captured order IOK 2018-05-07 |
| 2170 |
public function cancel_payment($order) { |
| 2171 |
$pm = $order->get_payment_method(); |
| 2172 |
if (! Vipps::is_vipps_order($pm)) { |
| 2173 |
$this->log(sprintf(__('Trying to cancel payment on order not made by %1$s:','woo-vipps'), $this->get_payment_method_name()). ' ' .$order->get_id(), 'error'); |
| 2174 |
$this->adminerr(sprintf(__('Cannot cancel payment on orders not made by %1$s','woo-vipps'), $this->get_payment_method_name())); |
| 2175 |
return false; |
| 2176 |
} |
| 2177 |
// We'll use the same transaction id for all cancel jobs, as we can only do it completely. IOK 2018-05-07 |
| 2178 |
// For epayment, partial cancellations will be possible. IOK 2022-11-12 |
| 2179 |
// IOK 2026-08-18 actually, epayment does *not* support partial cancellation - all remaining funds are cancelled. |
| 2180 |
$api = $order->get_meta('_vipps_api'); |
| 2181 |
try { |
| 2182 |
$requestid = ""; |
| 2183 |
if ($api == 'banktransfer') { |
| 2184 |
// If we are here, and the order is somehow not captured, just do nothing. IOK 2024-01-09 |
| 2185 |
$content = []; |
| 2186 |
} else { |
| 2187 |
// api is here 'epayment'. IOK 2026-07-18 |
| 2188 |
$requestid = 1; |
| 2189 |
// This will cancel any remaining, not-captured amount IOK 2026-01-28 |
| 2190 |
$content = $this->api->epayment_cancel_payment($order,$requestid); |
| 2191 |
} |
| 2192 |
} catch (TemporaryVippsApiException $e) { |
| 2193 |
$this->log(sprintf(__('Could not cancel %1$s payment for order_id:', 'woo-vipps'), $this->get_payment_method_name()) . ' ' . $order->get_id() . "\n" .$e->getMessage(),'error'); |
| 2194 |
$this->adminerr(sprintf(__('%1$s is temporarily unavailable.','woo-vipps'), $this->get_payment_method_name()) . ' ' . $e->getMessage()); |
| 2195 |
return false; |
| 2196 |
} catch (Exception $e) { |
| 2197 |
$msg = sprintf(__('Could not cancel %1$s payment for order id:','woo-vipps'), $this->get_payment_method_name()) . $order->get_id() . "\n" . $e->getMessage(); |
| 2198 |
$this->log($msg,'error'); |
| 2199 |
$this->adminerr($msg); |
| 2200 |
return false; |
| 2201 |
} |
| 2202 |
|
| 2203 |
// the epay v2 API would return transactionInfo and Summary with the result, the new epayment api returns nothing. |
| 2204 |
// Removed epay branch 2025-08-12 IOK |
| 2205 |
$total = intval($order->get_meta('_vipps_amount')); |
| 2206 |
$captured = intval($order->get_meta('_vipps_captured')); |
| 2207 |
$cancelled = $total; |
| 2208 |
$remaining = $total - $captured - $cancelled; |
| 2209 |
|
| 2210 |
// We need to assume it worked. Also, we can't do partial cancels yet, so just cancel everything. |
| 2211 |
$order->update_meta_data('_vipps_cancel_timestamp',time()); |
| 2212 |
$order->update_meta_data('_vipps_cancelled', $cancelled); |
| 2213 |
$order->update_meta_data('_vipps_cancel_remaining', $remaining); |
| 2214 |
|
| 2215 |
|
| 2216 |
// Set status from Vipps, ignore errors, use statusdata if we have it. |
| 2217 |
try { |
| 2218 |
$status = $this->get_vipps_order_status($order); |
| 2219 |
if ($status) $order->update_meta_data('_vipps_status',$status); |
| 2220 |
$order->add_order_note(sprintf(__('%1$s Payment cancelled:','woo-vipps'), $this->get_payment_method_name())); |
| 2221 |
$order->save(); |
| 2222 |
} catch (Exception $e) { |
| 2223 |
} |
| 2224 |
return true; |
| 2225 |
} |
| 2226 |
|
| 2227 |
// Refund (possibly partially) the captured order. IOK 2018-05-07 |
| 2228 |
// The caller must handle the errors. |
| 2229 |
public function refund_payment($order,$amount=0,$cents=false) { |
| 2230 |
$pm = $order->get_payment_method(); |
| 2231 |
if (! Vipps::is_vipps_order($pm)) { |
| 2232 |
$msg = sprintf(__('Trying to refund payment on order not made by %1$s:','woo-vipps'), $this->get_payment_method_name()) . ' ' . $order->get_id(); |
| 2233 |
$this->log($msg,'error'); |
| 2234 |
throw new VippsAPIException($msg); |
| 2235 |
} |
| 2236 |
|
| 2237 |
|
| 2238 |
// If we haven't captured anything, we can't refund IOK 2017-05-07 |
| 2239 |
$captured = intval($order->get_meta('_vipps_captured')); |
| 2240 |
if (!$captured) { |
| 2241 |
$msg = sprintf(__('Trying to refund payment on %1$s payment not captured:','woo-vipps'), $this->get_payment_method_name()). ' ' .$order->get_id(); |
| 2242 |
$this->log($msg,'error'); |
| 2243 |
throw new VippsAPIException($msg); |
| 2244 |
} |
| 2245 |
|
| 2246 |
// Each time we succeed, we'll increase the 'refund' transaction id so we don't just refund the same amount again and again. IOK 2018-05-07 |
| 2247 |
// (but on failre, we don't increase it.) IOK 2018-05-07 |
| 2248 |
$requestidnr = intval($order->get_meta('_vipps_refund_transid')); |
| 2249 |
$requestid = $requestidnr . ":" . $order->get_order_key(); |
| 2250 |
|
| 2251 |
$api = $order->get_meta('_vipps_api'); |
| 2252 |
if ($api == 'banktransfer') { |
| 2253 |
$msg = sprintf(__("Cannot refund bank transfer order %1\$d", 'woo-vipps'), $order->get_id()); |
| 2254 |
$this->log($msg, 'error'); |
| 2255 |
throw new Exception($msg); |
| 2256 |
} else { |
| 2257 |
// api is now 'epayment' IOK 2026-08-18 |
| 2258 |
$content = $this->api->epayment_refund_payment($order,$requestid,$amount,$cents); |
| 2259 |
} |
| 2260 |
|
| 2261 |
$currency = $order->get_currency(); |
| 2262 |
|
| 2263 |
// Previously, we got updated transaction info in a transactionInfo field. this is no longer provided, |
| 2264 |
// so we have to do dead reckoning. IOK 2025-08-12 |
| 2265 |
// We simply have to keep track: There is no way of knowing what the correct values are here yet, as we only get these values async, after |
| 2266 |
// the fact. |
| 2267 |
$captured = intval($order->get_meta('_vipps_captured')); |
| 2268 |
|
| 2269 |
if (!$amount) { |
| 2270 |
$amount = wc_format_decimal($order->get_total(),''); |
| 2271 |
$cents = false; |
| 2272 |
} |
| 2273 |
if ($amount && !$cents) { |
| 2274 |
$amount = round($amount * 100); |
| 2275 |
} |
| 2276 |
|
| 2277 |
$refunded_now = $amount; |
| 2278 |
$refunded = intval($order->get_meta('_vipps_refunded')) + $amount; |
| 2279 |
$remaining = $captured - $refunded; |
| 2280 |
|
| 2281 |
$order->update_meta_data('_vipps_refunded', $refunded); |
| 2282 |
$order->update_meta_data('_vipps_refund_remaining', $remaining); |
| 2283 |
$order->update_meta_data('_vipps_refund_timestamp', time()); |
| 2284 |
$order->add_order_note(sprintf(__('%1$s Payment Refunded:','woo-vipps'), $this->get_payment_method_name()) . ' ' . sprintf("%0.2f",$refunded/100) . ' ' . $currency ); |
| 2285 |
|
| 2286 |
// Since we succeeded, the next time we'll start a new transaction. |
| 2287 |
$order->update_meta_data('_vipps_refund_transid', $requestidnr+1); |
| 2288 |
$order->save(); |
| 2289 |
return true; |
| 2290 |
} |
| 2291 |
|
| 2292 |
// Generate a one-time password for certain callbacks, with some backwards compatibility for PHP 5.6 |
| 2293 |
public function generate_authtoken($length=32) { |
| 2294 |
$token=""; |
| 2295 |
if (function_exists('random_bytes')) { |
| 2296 |
$token = bin2hex(random_bytes($length)); |
| 2297 |
} elseif (function_exists('openssl_random_pseudo_bytes')) { |
| 2298 |
$token = bin2hex(openssl_random_pseudo_bytes($length)); |
| 2299 |
} elseif (function_exists('mcrypt_create_iv')) { |
| 2300 |
// These aren't "secure" but they are probably ok for this purpose. IOK 2018-05-18 |
| 2301 |
$indirect = 'mcrypt_create_iv'; // grep-based 7.2 compatibility checkers need to be worked around IOK 2018-10-24 |
| 2302 |
$token = bin2hex($indirect($length)); |
| 2303 |
} else { |
| 2304 |
// Final fallback |
| 2305 |
$token = bin2hex(md5(microtime() . ":" . mt_rand())); |
| 2306 |
} |
| 2307 |
|
| 2308 |
return $token; |
| 2309 |
} |
| 2310 |
|
| 2311 |
// Collapse several statuses to a known list IOK 2019-01-23 |
| 2312 |
// Statuses still in use are annotated. IOK 2025-08-12 |
| 2313 |
public function interpret_vipps_order_status($status) { |
| 2314 |
switch ($status) { |
| 2315 |
case 'INITIATE': // legacy, used by us to indicate a fresh order |
| 2316 |
case 'REGISTER': |
| 2317 |
case 'REGISTERED': |
| 2318 |
case 'CREATED': // Checkout, Epayment |
| 2319 |
return 'initiated'; |
| 2320 |
break; |
| 2321 |
case 'RESERVE': |
| 2322 |
case 'RESERVED': |
| 2323 |
case 'AUTHORISED': |
| 2324 |
case 'AUTHORIZED': // Checkout, Epayment |
| 2325 |
case 'CAPTURED': // Epayment |
| 2326 |
case 'REFUNDED': // epayment - this is probably authorized, because it will have had that state *before* it was refuned. IOK 2025-08-12 |
| 2327 |
return 'authorized'; |
| 2328 |
break; |
| 2329 |
case 'SALE': |
| 2330 |
return 'complete'; |
| 2331 |
break; |
| 2332 |
case 'CANCEL': |
| 2333 |
case 'CANCELLED': // Epayment |
| 2334 |
case 'VOID': |
| 2335 |
case 'AUTOREVERSAL': |
| 2336 |
case 'AUTOCANCEL': |
| 2337 |
case 'AUTO_CANCEL': |
| 2338 |
case 'RESERVE_FAILED': |
| 2339 |
case 'FAILED': |
| 2340 |
case 'REJECTED': |
| 2341 |
case 'TERMINATED': // Checkout, Epayment |
| 2342 |
case 'ABORTED': // Epayment |
| 2343 |
case 'EXPIRED': // Epayment |
| 2344 |
return 'cancelled'; |
| 2345 |
break; |
| 2346 |
} |
| 2347 |
// Default should never happen, but just to ensure we are in our enumeration |
| 2348 |
return "initiated"; |
| 2349 |
} |
| 2350 |
|
| 2351 |
// This does not normally call Vipps, so if you need to refresh status, please use poll_and_check_order_status first. IOK 2019-01-23 |
| 2352 |
public function check_payment_status($order) { |
| 2353 |
if (!$order) return 'cancelled'; |
| 2354 |
$status = $this->interpret_vipps_order_status($order->get_meta('_vipps_status')); |
| 2355 |
// This can happen if the vipps status is set from the back end for instance. IOK 2020-08-14 |
| 2356 |
if ($order->get_status() == 'pending' && $status != 'initiated') { |
| 2357 |
$this->poll_and_check_order_status($order); |
| 2358 |
$order = wc_get_order($order->get_id()); // refresh to get the new status IOK 2021-01-20 |
| 2359 |
$status = $this->interpret_vipps_order_status($order->get_meta('_vipps_status')); |
| 2360 |
} |
| 2361 |
return $status; |
| 2362 |
} |
| 2363 |
|
| 2364 |
// Called by poll_and_check_order_status and handle_callback to handle the situation where |
| 2365 |
// the payment method has been set to something else *after* Vipps has gotten the order. |
| 2366 |
// This happens very rarely for people who use Vipps as an external payment method in Klarna, so |
| 2367 |
// we only do it for orders that match this. IOK 2023-02-03 |
| 2368 |
public function reset_erroneous_payment_method($order) { |
| 2369 |
// This is only called by methods that are Vipps-specific, but still lets be careful not to touch other orders |
| 2370 |
|
| 2371 |
// New 2026-01-05: we now check all other payment methods that aren't vipps, and reset it back to vipps. |
| 2372 |
// The issue was using Klarna Payments and pressing 'back' in the browser, then completing the payment in vipps checkout |
| 2373 |
// the order still had the payment method klarna_payments, since we previously only checked 'kco' = klarna/kustom checkout. LP 2026-01-05 |
| 2374 |
if (! Vipps::is_vipps_order($order) && $order->get_meta("_vipps_orderid")) { |
| 2375 |
$order->set_payment_method('vipps'); |
| 2376 |
$express = $order->get_meta('_vipps_express_checkout'); |
| 2377 |
$checkout = $order->get_meta('_vipps_checkout'); |
| 2378 |
$order->set_payment_method_title('Vipps'); |
| 2379 |
if ($express) $order->set_payment_method_title('Vipps Express Checkout'); |
| 2380 |
if ($checkout) $order->set_payment_method_title('Vipps Checkout'); |
| 2381 |
// paypal gw resets payment gateway on order save because it has this meta, so delete it before save. LP 2026-06-23 |
| 2382 |
$order->delete_meta_data('_ppcp_paypal_order_id'); |
| 2383 |
$order->save(); |
| 2384 |
|
| 2385 |
$msg = sprintf(__("Payment method reset to %1\$s - it had been set to another payment method while completing the order for %2\$d", 'woo-vipps'), $this->get_payment_method_name(), $order->get_id()); |
| 2386 |
$this->log($msg, 'debug'); |
| 2387 |
$order->add_order_note($msg); |
| 2388 |
} |
| 2389 |
} |
| 2390 |
|
| 2391 |
// Check status of order at Vipps, in case the callback has been delayed or failed. |
| 2392 |
// Should only be called if in status 'pending'; it will modify the order when status changes. |
| 2393 |
public function poll_and_check_order_status($order, $allow_retry = true) { |
| 2394 |
global $Vipps; |
| 2395 |
$orderid = $order->get_id(); |
| 2396 |
|
| 2397 |
clean_post_cache($order->get_id()); |
| 2398 |
$order = wc_get_order($orderid); // Ensure a fresh copy is read. |
| 2399 |
|
| 2400 |
$oldstatus = $order->get_status(); |
| 2401 |
$newstatus = $oldstatus; |
| 2402 |
|
| 2403 |
// Only do work when the orders woo status is pending |
| 2404 |
if ($oldstatus != 'pending') return $oldstatus; |
| 2405 |
|
| 2406 |
$oldvippsstatus = $this->interpret_vipps_order_status($order->get_meta('_vipps_status')); |
| 2407 |
$vippsstatus = ""; |
| 2408 |
|
| 2409 |
/* Now read the payment details and update the order with the relevant values, finding the new Vipps status IOK 2021-01-20 */ |
| 2410 |
$paymentdetails = array(); |
| 2411 |
try { |
| 2412 |
$paymentdetails = $this->get_payment_details($order); |
| 2413 |
$newvippsstatus = $paymentdetails['status']; |
| 2414 |
$vippsstatus = $this->interpret_vipps_order_status($newvippsstatus); |
| 2415 |
|
| 2416 |
$ready = false; // True if money is authorized or complete |
| 2417 |
if (in_array($vippsstatus, ['authorized', 'complete'])) { |
| 2418 |
$ready = true; |
| 2419 |
} |
| 2420 |
|
| 2421 |
// No change == nothing to do. Ensure we don't modify the order at this point. IOK 2025-10-24 |
| 2422 |
if ($vippsstatus == $oldvippsstatus) { |
| 2423 |
return $oldstatus; |
| 2424 |
} |
| 2425 |
// Something changed, so we are now going to sideeffect the order. IOK 2025-10-15 |
| 2426 |
$this->log(sprintf(__("%1\$s poll: Handling order: ", 'woo-vipps'), Vipps::CompanyName()) . " " . $orderid, 'debug'); |
| 2427 |
|
| 2428 |
// Failsafe for rare bug when using Klarna Checkout with Vipps as an external payment method |
| 2429 |
// IOK 2024-01-09 ensure this is called only when order is complete/authorized |
| 2430 |
if ($ready) { |
| 2431 |
$this->reset_erroneous_payment_method($order); |
| 2432 |
} |
| 2433 |
|
| 2434 |
$order->update_meta_data('_vipps_status',$newvippsstatus); |
| 2435 |
|
| 2436 |
// Extract order metadata from either Checkout or Epayment - set below IOK 2025-08-13 |
| 2437 |
if (!empty($paymentdetails)) { |
| 2438 |
// checkout has a string, epayment has an array with upper case "type" and apparently, cardBin IOK 2025-08-12 |
| 2439 |
$paymentMethod = $paymentdetails['paymentMethod'] ?? "epayment"; |
| 2440 |
// After normalization, all APIs will have data here. |
| 2441 |
$details = $paymentdetails['paymentDetails']; |
| 2442 |
if (isset($details['paymentMethod'])) { |
| 2443 |
$paymentMethod = $details['paymentMethod']; |
| 2444 |
} |
| 2445 |
if (!is_string($paymentMethod)) { |
| 2446 |
// should be WALLET |
| 2447 |
$paymentMethod = $paymentMethod['type'] ?? "epayment"; |
| 2448 |
} |
| 2449 |
$transaction = array(); |
| 2450 |
$transaction['timeStamp'] = date('Y-m-d H:i:s', time()); |
| 2451 |
$transaction['amount'] = $details['amount']['value']; |
| 2452 |
$transaction['currency'] = $details['amount']['currency']; |
| 2453 |
$transaction['status'] = $details['state']; |
| 2454 |
$transaction['paymentmethod'] = $paymentMethod; |
| 2455 |
$this->order_set_transaction_metadata($order, $transaction); |
| 2456 |
} |
| 2457 |
|
| 2458 |
} catch (Exception $e) { |
| 2459 |
$this->log(sprintf(__("Error getting payment details from %1\$s for order_id:",'woo-vipps'), $this->get_payment_method_name()) . $orderid . "\n" . $e->getMessage(), 'error'); |
| 2460 |
clean_post_cache($order->get_id()); |
| 2461 |
return $oldstatus; |
| 2462 |
} |
| 2463 |
$order->save(); |
| 2464 |
|
| 2465 |
// We have a completed order, but the callback haven't given us the payment details yet - so handle it. |
| 2466 |
if (($vippsstatus == 'authorized' || $vippsstatus=='complete') && $order->get_meta('_vipps_express_checkout')) { |
| 2467 |
|
| 2468 |
do_action('woo_vipps_express_checkout_get_order_status', $paymentdetails); |
| 2469 |
$address_set = $order->get_meta('_vipps_shipping_set'); |
| 2470 |
|
| 2471 |
if ($address_set) { |
| 2472 |
// Callback has handled the situation, do nothing |
| 2473 |
} elseif ($paymentdetails['shippingDetails'] ?? "") { |
| 2474 |
// We need to set shipping details here |
| 2475 |
$billing = isset($paymentdetails['billingDetails']) ? $paymentdetails['billingDetails'] : false; |
| 2476 |
$this->set_order_shipping_details($order,$paymentdetails['shippingDetails'], $paymentdetails['userDetails'], $billing, $paymentdetails); |
| 2477 |
} else { |
| 2478 |
// IN THIS CASE we actually need to cancel the order as we have no way of determining whose order this is. |
| 2479 |
// But first check to see if it has customer info! |
| 2480 |
// Cancel any orders where the Checkout session is dead and there is no address info available |
| 2481 |
if (!$order->has_shipping_address() && !$order->has_billing_address()) { |
| 2482 |
$this->log(sprintf(__("No shipping details from %1\$s for express checkout for order id:",'woo-vipps'), $this->get_payment_method_name()) . ' ' . $orderid, 'error'); |
| 2483 |
$sessiontimeout = time() - (60*90); |
| 2484 |
$then = intval($order->get_meta('_vipps_init_timestamp')); |
| 2485 |
if ($then < $sessiontimeout) { |
| 2486 |
$this->log(sprintf(__("Order %2\$d has no address info and any %1\$s session is dead - have to cancel.", 'woo-vipps'), Vipps::CheckoutName(), $order->get_id())); |
| 2487 |
$order->update_status('cancelled', sprintf(__('Could not get address info for order from %1$s', 'woo-vipps'), Vipps::CompanyName())); |
| 2488 |
$order->save(); |
| 2489 |
} else { |
| 2490 |
// NOOP - the vipps checkout session can still be active, so we need to let it be |
| 2491 |
$this->log(sprintf(__("No address information for order %2\$d, but there still might be an active %1\$s session for it, so do not cancel it.", 'woo-vipps'), Vipps::CheckoutName(), $order->get_id())); |
| 2492 |
} |
| 2493 |
} |
| 2494 |
clean_post_cache($order->get_id()); |
| 2495 |
return $oldstatus; |
| 2496 |
} |
| 2497 |
} |
| 2498 |
|
| 2499 |
# Since the order is pending, and the vipps status has changed, switch to the correct vipps status in woo too IOK 2025-10-24 |
| 2500 |
switch ($vippsstatus) { |
| 2501 |
case 'authorized': |
| 2502 |
$this->payment_complete($order); |
| 2503 |
break; |
| 2504 |
case 'complete': |
| 2505 |
$msg = sprintf(__('Payment captured directly at %1$s', 'woo-vipps'), $this->get_payment_method_name()); |
| 2506 |
$msg = $msg . __(" - order does not need processing", 'woo-vipps'); |
| 2507 |
$order->add_order_note($msg); |
| 2508 |
$order = $this->update_vipps_payment_details($order, $paymentdetails); |
| 2509 |
$order->payment_complete(); |
| 2510 |
break; |
| 2511 |
case 'cancelled': |
| 2512 |
$order_is_retryable = $allow_retry && Vipps::order_is_vipps_retryable($order->get_id()); |
| 2513 |
$status_on_fail = $this->get_option('status_on_fail'); |
| 2514 |
$cancel_on_fail = apply_filters('woo_vipps_cancel_failed_orders', false, $order, $vippsstatus); |
| 2515 |
if ($cancel_on_fail || !$order_is_retryable) { |
| 2516 |
$status_on_fail = 'cancelled'; |
| 2517 |
} |
| 2518 |
if (!in_array($status_on_fail, ['cancelled', 'failed'])) { |
| 2519 |
/* translators: order status name. Cancelled is woocommerce status name */ |
| 2520 |
$this->log(__('Unsupported status for payment failure of \'%1$s\', falling back to cancelled.', 'woo-vipps'), 'warning'); |
| 2521 |
$status_on_fail = 'cancelled'; |
| 2522 |
} |
| 2523 |
|
| 2524 |
/* translators: company name */ |
| 2525 |
$order->update_status($status_on_fail, sprintf(__('Order failed or rejected at %1$s.', 'woo-vipps'), Vipps::CompanyName())); |
| 2526 |
break; |
| 2527 |
} |
| 2528 |
|
| 2529 |
$order->save(); |
| 2530 |
clean_post_cache($order->get_id()); |
| 2531 |
$newstatus = $order->get_status(); |
| 2532 |
return $newstatus; |
| 2533 |
} |
| 2534 |
|
| 2535 |
// IOK 2020-01-20 Previously was just a debugging tool, then was used to update postmeta values. Now is used as the main source of info |
| 2536 |
// about the order from Vipps; the previous side-effecting is now done by update_vipps_payment_details. |
| 2537 |
// IOK 2021-11-24 Because of this, we need to handle 402 and 404 errors differently here now - these *are* results, meaning there is |
| 2538 |
// no payment details because the order doesn't exist. |
| 2539 |
// IOK 2022-01-19 And now, with the epayment API in use by checkout, we also need to use the poll api because the epayment API does not return user- and shipping data. We do get an order status though. |
| 2540 |
// IOK 2025-08-12 And now, with epayment used for Express Checkout also, there *is* user- and shipping-data when using Express Checkout, so we can simplify. We still need to transform the data |
| 2541 |
// so old hooks and filters can get the input they expect. |
| 2542 |
public function get_payment_details($order) { |
| 2543 |
$result = array(); |
| 2544 |
$checkout_session = $order->get_meta('_vipps_checkout_session'); |
| 2545 |
$express = $order->get_meta('_vipps_express_checkout'); |
| 2546 |
|
| 2547 |
// IOK 2025-08-12: Three cases; either this is Checkout, in which case we need to get user/shipping-data from the checkout session, |
| 2548 |
// or it is Express Checkout or normal payment, in which cases we just retrieve the payment from the epayment API - possibly containing user data |
| 2549 |
if ($checkout_session) { |
| 2550 |
try { |
| 2551 |
$result = $this->api->checkout_get_session_info($order); |
| 2552 |
|
| 2553 |
if ($result == 'EXPIRED') { |
| 2554 |
$result = array('status'=>'CANCEL', 'state'=>'CANCEL'); |
| 2555 |
return $result; |
| 2556 |
} |
| 2557 |
|
| 2558 |
// For checkout, we are really handling *session states* which we map to *order states*, but sometimes |
| 2559 |
// these indicate a failed order. |
| 2560 |
// 'state' can be missing for Checkout, first case is if this is because the session is invalid. |
| 2561 |
// The sesssion states are # "SessionCreated" "PaymentInitiated" "SessionExpired" "PaymentSuccessful" "PaymentTerminated" |
| 2562 |
if (isset($result['sessionState']) && ($result['sessionState'] == 'SessionTerminated' || $result['sessionState'] == 'SessionExpired')) { |
| 2563 |
$result['state'] = 'CANCEL'; |
| 2564 |
$result['status'] = 'CANCEL'; |
| 2565 |
$order->add_order_note(sprintf(__('%1$s Order with no order status, so session was never completed; setting status to cancelled', 'woo-vipps'), Vipps::CheckoutName())); |
| 2566 |
return $result; |
| 2567 |
} |
| 2568 |
|
| 2569 |
// IOK 2023-12-14 at some point, apparently SessionStarted became SessionCreated |
| 2570 |
if (isset($result['sessionState']) && ($result['sessionState'] == 'SessionStarted' || $result['sessionState'] == 'SessionCreated')) { |
| 2571 |
// We have no order info, only the session data (this is a checkout order). Therefore, assume it has been started at least. |
| 2572 |
$result['status'] = "INITIATE"; |
| 2573 |
$result['state'] = "INITIATE"; |
| 2574 |
$created = $order->get_date_created(); |
| 2575 |
$timestamp = 0; |
| 2576 |
$now = time(); |
| 2577 |
try { |
| 2578 |
$timestamp = $created->getTimestamp(); |
| 2579 |
} catch (Exception $e) { |
| 2580 |
// PHP 8 gives ValueError for certain older versions of WooCommerce here. |
| 2581 |
$timestamp = intval($created->format('U')); |
| 2582 |
} |
| 2583 |
$passed = $now - $timestamp; |
| 2584 |
$minutes = ($passed / 60); |
| 2585 |
|
| 2586 |
// Give up after 120 minutes. Actually, 60 minutes is probably enough: We expire live sessions after 50 mins. |
| 2587 |
if ($minutes > 120) { |
| 2588 |
$this->log(sprintf(__('Checkout order older than 120 minutes with no order status - cancelled as abandoned: %1$s', 'woo-vipps'), $order->get_id()), 'debug'); |
| 2589 |
$order->add_order_note(sprintf(__('%1$s Order with no order status, so session was never completed; setting status to cancelled', 'woo-vipps'), Vipps::CheckoutName())); |
| 2590 |
$result['status'] = 'CANCEL'; |
| 2591 |
$result['state'] = 'CANCEL'; |
| 2592 |
} |
| 2593 |
return $result; |
| 2594 |
} |
| 2595 |
|
| 2596 |
|
| 2597 |
} catch (VippsAPIException $e) { |
| 2598 |
$resp = intval($e->responsecode); |
| 2599 |
if ($resp == 402 || $resp == 404) { |
| 2600 |
$result = array('status'=>'CANCEL', 'state'=>'CANCEL'); |
| 2601 |
return $result; |
| 2602 |
} else { |
| 2603 |
throw $e; |
| 2604 |
} |
| 2605 |
} |
| 2606 |
} else { |
| 2607 |
try { |
| 2608 |
$result = $this->api->epayment_get_payment($order); |
| 2609 |
} catch (VippsAPIException $e) { |
| 2610 |
$resp = intval($e->responsecode); |
| 2611 |
if ($resp == 402 || $resp == 404) { |
| 2612 |
$result = array('status'=>'CANCEL', 'state'=>'CANCEL'); |
| 2613 |
return $result; |
| 2614 |
} else { |
| 2615 |
$this->log(sprintf(__("Could not get order status from %1\$s using epayment api: ", 'woo-vipps'), Vipps::CompanyName()) . $e->getMessage(), "error"); |
| 2616 |
throw $e; |
| 2617 |
} |
| 2618 |
} |
| 2619 |
} |
| 2620 |
|
| 2621 |
if (!$result || $result == "ERROR") { |
| 2622 |
$this->log(sprintf(__("Could not get payment results for order %1\$s", 'woo-vipps'), $order->get_id())); |
| 2623 |
wp_die(sprintf(__("Could not get payment results for order %1\$s - you may have the wrong MSN for the order. Please check logs for more information", 'woo-vipps'), $order->get_id())); |
| 2624 |
} |
| 2625 |
|
| 2626 |
// We now have a result which maybe will contain user and shipping data, which we will need to normalize because it is slightly different in the different |
| 2627 |
// APIs, and we have provided filters/hooks that receive this information. IOK 2025-08-12 |
| 2628 |
// If we now have epayment data, we want to translate this to the ecom 'view' for now. Later, we will do the opposite. |
| 2629 |
// We now only need to map Checkout and epayment to the same format, but we will try to keep the normalized result compatible with |
| 2630 |
// ecom, in case consumers have created filters/hooks. IOK 2025-08-12 |
| 2631 |
|
| 2632 |
// if Checkout, the result will have a sessionState, reference etc, userInfo, shippingDetails, billingDetails and the payment details in a paymentDetails member. |
| 2633 |
// if not, the result will *be* a paymentDetails field, but with user*Details* and shippingDetails added. No billingDetails. |
| 2634 |
// The end result should have state/status (not neccessarily present with Checkout), userDetails, paymentDetails, shippingDetails and billingDetails, and a transactionSummary. |
| 2635 |
// Because that's what the code depending on this has been expecting. IOK 2025-08-12 |
| 2636 |
if (!$checkout_session) { |
| 2637 |
// This should be an ecom result, so move all data (for simplicitys sake) into paymentDetails |
| 2638 |
$result['paymentDetails'] = $result; |
| 2639 |
} |
| 2640 |
// Ensure we get payment details with state + aggregate, which we do not if the payment method is bank transfer for checkout. IOK 2024-01-09 |
| 2641 |
// Also add keys and transform for backwards compatibility. |
| 2642 |
$result = $this->normalizePaymentDetails($result); |
| 2643 |
$newstatus = $this->interpret_vipps_order_status($result['status']); |
| 2644 |
$ready = false; |
| 2645 |
if (in_array($newstatus, ['authorized', 'complete'])) { |
| 2646 |
$ready = true; |
| 2647 |
} |
| 2648 |
|
| 2649 |
if ($ready && ($express || $checkout_session)) { |
| 2650 |
// For Checkout version 3 there are no more userDetails, so we will add it, including defaults for anonymous purchases IOK 2023-01-10 |
| 2651 |
// This will also normalize userDetails, adding 'sub' where possible and fields for backwards compatibility. 2025-08-12 |
| 2652 |
$result = $this->ensure_userDetails($result, $order); |
| 2653 |
|
| 2654 |
// After, we need to normalize shipping details or even add them if e.g. using Checkout without address or contact info IOK 2025-08-13 |
| 2655 |
// Epayment Express Checkout is of course also significantly different from both the old Express and from Checkout in the formatting here. IOK 2025-08-12 |
| 2656 |
$result = $this->normalizeShippingDetails($result, $order); |
| 2657 |
} |
| 2658 |
|
| 2659 |
return $result; |
| 2660 |
} |
| 2661 |
|
| 2662 |
// IOK 2025-08-12 Normalize the shippingDetails field for backwards compatibility, since this is different from old express, new express and checkout. |
| 2663 |
function normalizeShippingDetails($result, $order) { |
| 2664 |
|
| 2665 |
// We may actually get no shipping details eg. for Checkout when not asking for addresses etc. |
| 2666 |
if (!isset($result['shippingDetails'])) { |
| 2667 |
$result['shippingDetails'] = ['address' => [] ]; |
| 2668 |
} |
| 2669 |
$details = $result['shippingDetails']; |
| 2670 |
|
| 2671 |
$user = $result['userDetails']; // Normalized earlier |
| 2672 |
$address = $details['address'] ?? []; |
| 2673 |
|
| 2674 |
// No address, but we have a list of addresses in the userDetails field. This is ecom with the address scope added. |
| 2675 |
// We will use the first one. |
| 2676 |
if (empty($address) && isset($result['userDetails']) && isset($result['userDetails']['addresses']) && !empty($result['userDetails']['addresses'])) { |
| 2677 |
$address = $result['userDetails']['addresses'][0]; |
| 2678 |
} |
| 2679 |
|
| 2680 |
// Checkout has address info inside shippingDetails, whereas Express Checkout now has it in an address field IOK 2025-08-12 |
| 2681 |
if (empty($address)) { |
| 2682 |
$address['firstName'] = $details['firstName'] ?? ""; |
| 2683 |
$address['lastName'] = $details['lastName'] ?? ""; |
| 2684 |
$address['email'] = $details['email'] ?? ""; |
| 2685 |
$address['mobileNumber'] = $details['phoneNumber'] ?? ""; |
| 2686 |
$address['addressLine1'] = $details['streetAddress'] ?? ""; |
| 2687 |
$address['addressLine2'] = ""; |
| 2688 |
$address['city'] = $details['city'] ?? ""; |
| 2689 |
$address['postCode'] = $details['postalCode'] ?? ""; |
| 2690 |
$address['country'] = $details['country'] ?? ""; |
| 2691 |
} |
| 2692 |
|
| 2693 |
// Need at least a country for VAT so add our own. |
| 2694 |
if (!$address['country']) { |
| 2695 |
$countries=new WC_Countries(); |
| 2696 |
$address['country'] = $countries->get_base_country(); |
| 2697 |
} |
| 2698 |
|
| 2699 |
// Normalize from user details when neccessary (mostly for new express) |
| 2700 |
$address['firstName'] = ($address['firstName'] ?? "") ?: $user['firstName']; |
| 2701 |
$address['lastName'] = ($address['lastName'] ?? "") ?: $user['lastName']; |
| 2702 |
$address['email'] = ($address['email'] ?? "") ?: $user['email']; |
| 2703 |
$address['mobileNumber'] = ($address['mobileNumber'] ?? "") ?: $user['mobileNumber']; |
| 2704 |
|
| 2705 |
// phoneNumber is checkout, mobileNumber is epayment |
| 2706 |
$address['phoneNumber'] = $address['mobileNumber']; |
| 2707 |
// addressline1 and 2 are epayment, streetAddress is checkout |
| 2708 |
$address['streetAddress'] = $address['addressLine1']; |
| 2709 |
// postCode is epayment, postalCode is checkout |
| 2710 |
$address['postalCode'] = $address['postCode']; |
| 2711 |
|
| 2712 |
|
| 2713 |
// Ensure we have 'address' as in Express/epayment |
| 2714 |
$details['address'] = $address; |
| 2715 |
|
| 2716 |
// Name change from Checkout/Express to new Express from MethodId to OptionId IOK 2025-08-12 |
| 2717 |
$details['shippingMethodId'] = $details['shippingMethodId'] ?? ($details['shippingOptionId'] ?? ""); |
| 2718 |
$details['shippingOptionId'] = $details['shippingMethodId']; |
| 2719 |
|
| 2720 |
$result['shippingDetails'] = $details; |
| 2721 |
return $result; |
| 2722 |
} |
| 2723 |
|
| 2724 |
|
| 2725 |
// IOK 2024-01-09 If using Checkout with the BankTransfer method, which is eg. used in Finland, |
| 2726 |
// we are (currently) not receiving any 'state' or 'aggregate', so add this iff the payment is successful. |
| 2727 |
// The reason for this is that this payment type does not actually use the epayment API at all (!) |
| 2728 |
// Also moved some other compatibility code here - |
| 2729 |
// --- reference used to be orderId |
| 2730 |
// --- state used to be status |
| 2731 |
// --- there used to be a transactionSummary field |
| 2732 |
// --- at one point there was a 'transactionAggregate' instead of an 'aggregate' |
| 2733 |
private function normalizePaymentDetails($result) { |
| 2734 |
// the 'reference' used to be an 'orderId', keep for compatibility. |
| 2735 |
$result['orderId'] = $result['reference']; |
| 2736 |
if (isset($result['sessionState']) && $result['sessionState'] == 'PaymentSuccessful' && $result['paymentMethod'] == 'BankTransfer') { |
| 2737 |
$details = $result['paymentDetails']; |
| 2738 |
$details['state'] = 'SALE'; // Payment is actually complete at this point |
| 2739 |
$aggregate=[]; |
| 2740 |
$aggregate['capturedAmount'] = $details['amount']; |
| 2741 |
$aggregate['authorizedAmount'] = $details['amount']; |
| 2742 |
$aggregate['refundedAmount'] = ['value'=>0, 'currency'=>$details['amount']['currency']]; |
| 2743 |
$aggregate['cancelledAmount'] = ['value'=>0, 'currency'=>$details['amount']['currency']]; |
| 2744 |
$details['aggregate'] = $aggregate; |
| 2745 |
$result['paymentDetails'] = $details; |
| 2746 |
} |
| 2747 |
|
| 2748 |
// Sometimes we get the state at top level, sometimes in paymentDetails. |
| 2749 |
$state = $result['state'] ?? false; |
| 2750 |
|
| 2751 |
// Now, if we don't have payment details, we should have a dead session or something like it. If we do, we can cretae |
| 2752 |
// a normalized result. IOK 2023-12-13 |
| 2753 |
if (isset($result['paymentDetails'])) { |
| 2754 |
$details = $result['paymentDetails']; |
| 2755 |
$state = $state ?: $details['state']; |
| 2756 |
$result['state'] = $state; |
| 2757 |
$details['state'] = $state; |
| 2758 |
|
| 2759 |
# IOK 2022-01-19 for this, the docs and experience does not agree, so check both |
| 2760 |
$aggregate = (isset($details['transactionAggregate'])) ? $details['transactionAggregate'] : $details['aggregate']; |
| 2761 |
|
| 2762 |
// if 'AUTHORISED' and directCapture is set and true, set to SALE which will set the order to complete |
| 2763 |
// IOK 2025-08-12: This is never true anymore - directCapture is never set and the SALE state does not seem to exist. |
| 2764 |
// this was an extra feature for merchants with special products however, so keep the logic just in case. |
| 2765 |
if (($result['state'] == 'AUTHORISED' || $result['state'] == "AUTHORIZED") && isset($result['directCapture']) && $result['directCapture']) { |
| 2766 |
$result['state'] = "SALE"; |
| 2767 |
} |
| 2768 |
|
| 2769 |
# the transactionSummary used to contain the information now present in 'aggregate', so map it back for compatibility. |
| 2770 |
$transactionSummary = array(); |
| 2771 |
// Always NOK at this point, but we also don't care because the order has the currency |
| 2772 |
// IOK 2024-03-22 Now supports other currencies, but we still don't care. |
| 2773 |
$transactionSummary['capturedAmount'] = isset($aggregate['capturedAmount']) ? $aggregate['capturedAmount']['value'] : 0; |
| 2774 |
$transactionSummary['refundedAmount'] = isset($aggregate['refundedAmount']) ? $aggregate['refundedAmount']['value'] : 0; |
| 2775 |
$transactionSummary['cancelledAmount'] =isset($aggregate['cancelledAmount']) ? $aggregate['cancelledAmount']['value'] : 0; |
| 2776 |
$transactionSummary['authorizedAmount'] =isset($aggregate['authorizedAmount']) ? $aggregate['authorizedAmount']['value'] : 0; |
| 2777 |
$transactionSummary['remainingAmountToCapture'] = $transactionSummary['authorizedAmount'] - $transactionSummary['cancelledAmount'] - $transactionSummary['capturedAmount']; |
| 2778 |
$transactionSummary['remainingAmountToRefund'] = $transactionSummary['capturedAmount'] - $transactionSummary['refundedAmount']; |
| 2779 |
// now also reducing remainingAmmountToCancel with cancelledAmount PMB 2024-11-21 |
| 2780 |
$transactionSummary['remainingAmountToCancel'] = $transactionSummary['authorizedAmount'] - $transactionSummary['capturedAmount'] - $transactionSummary['cancelledAmount']; |
| 2781 |
|
| 2782 |
$result['transactionSummary'] = $transactionSummary; |
| 2783 |
} |
| 2784 |
// After this, the result will contain a 'state' which used to be a 'status' - map back for compatibility. |
| 2785 |
// The reason for the method is that in ecom v2 we needed to calculate this from the transaction history. IOK 2025-08-12 |
| 2786 |
$result['status'] = $this->get_payment_status_from_payment_details($result); |
| 2787 |
|
| 2788 |
// No longer used; was used in later versions of ecom to deduce order status. Added for typewise compatibility. |
| 2789 |
$result['transactionLogHistory'] = array(); |
| 2790 |
// The corresponding epayment log. Filled on-demand by debugging code. |
| 2791 |
$result['epaymentLog'] = null; |
| 2792 |
|
| 2793 |
return $result; |
| 2794 |
} |
| 2795 |
|
| 2796 |
// Checkout v3 does *not* provide userDetails. Checkout v2 and epayment *does*. But Checkout additionally allows |
| 2797 |
// for anonymous purchases, in which case there is *no* user details. In this case we provide an anonymous user so we can actually create an order. |
| 2798 |
// To handle this, we provide this utility that ensures we have userDetails no matter the input. For this we use the anonymous filters and "billingDetails" if present |
| 2799 |
// if not, we use shippingDetails. IOK 2023-01-10 |
| 2800 |
// Also, epayment uses mobileNumber and checkout uses phoneNumber, so normalize. |
| 2801 |
public function ensure_userDetails($vippsdata, $order) { |
| 2802 |
$userDetails = []; |
| 2803 |
|
| 2804 |
// If we have userDetails, use it (ecom API with user data requested - Express Checkout |
| 2805 |
if (isset($vippsdata['userDetails'])) { |
| 2806 |
$userDetails = $vippsdata['userDetails']; |
| 2807 |
// This is the verified user information from the app - this is always the customer for Express Checkout, but not for Checkout IOK 2025-08-12 |
| 2808 |
// Also, it may not always be available - it depends on consent and whether scope was added (probably) in epayment_initate_payment. IOK 2026-08-18 |
| 2809 |
$sub = ""; |
| 2810 |
if (isset($vippsdata['profile']) && isset($vippsdata['profile']['sub'])) { |
| 2811 |
$sub = $vippsdata['profile']['sub']; |
| 2812 |
} |
| 2813 |
$userDetails['sub'] = $sub; |
| 2814 |
|
| 2815 |
} else if (isset($vippsdata['billingDetails'])) { |
| 2816 |
// Otherwise this is now Checkout, and we want to get it from billingDetails preferrably |
| 2817 |
$addr = $vippsdata['billingDetails']; |
| 2818 |
$phone = $addr['phoneNumber']; |
| 2819 |
$userDetails = array( |
| 2820 |
'firstName' => $addr['firstName'], |
| 2821 |
'lastName' => $addr['lastName'], |
| 2822 |
'email' => $addr['email'], |
| 2823 |
'phoneNumber' => $phone, |
| 2824 |
// This is the verified user information from the app - this is always the customer for Express Checkout, but not for Checkout IOK 2025-08-12 |
| 2825 |
'sub' => "" |
| 2826 |
); |
| 2827 |
|
| 2828 |
// Or use shippingDetails - this is still Checkout |
| 2829 |
} else if (isset($vippsdata['shippingDetails'])) { |
| 2830 |
$addr = $vippsdata['shippingDetails']; |
| 2831 |
$phone = $addr['phoneNumber']; |
| 2832 |
$userDetails = array( |
| 2833 |
'firstName' => $addr['firstName'], |
| 2834 |
'lastName' => $addr['lastName'], |
| 2835 |
'email' => $addr['email'], |
| 2836 |
'phoneNumber' => $phone, |
| 2837 |
// This is the verified user information from the app - this is always the customer for Express Checkout, but not for Checkout IOK 2025-08-12 |
| 2838 |
'sub' => "" |
| 2839 |
); |
| 2840 |
|
| 2841 |
// And it is possible to not require user details in Checkout at all (or if not using express) |
| 2842 |
} else { |
| 2843 |
$userDetails = array( |
| 2844 |
|
| 2845 |
'firstName' => apply_filters('woo_vipps_anon_customer_first_name', __('Anonymous customer', 'woo-vipps'), $order), |
| 2846 |
'lastName' => apply_filters('woo_vipps_anon_customer_last_name', "", $order), |
| 2847 |
'email' => apply_filters('woo_vipps_anon_customer_email', '', $order), |
| 2848 |
'phoneNumber' => apply_filters('woo_vipps_anon_customer_phone_number', '', $order), |
| 2849 |
'sub' => "" |
| 2850 |
); |
| 2851 |
} |
| 2852 |
|
| 2853 |
//Normalize the result |
| 2854 |
$phone = $userDetails['phoneNumber'] ?? ($userDetails['mobileNumber'] ?? ""); |
| 2855 |
$userDetails['phoneNumber'] = $phone; |
| 2856 |
$userDetails['mobileNumber'] = $phone; |
| 2857 |
|
| 2858 |
|
| 2859 |
// No longer used, but try to provide it for backwards compatibility |
| 2860 |
$userDetails['userId'] = $userDetails['phoneNumber']; |
| 2861 |
// This is possible to get iff we have the 'sub', unfortunately it is not passed directly in several of the apis. IOK 2025-08-12 |
| 2862 |
$userDetails['email_verified'] = ($userDetails['email_verified'] ?? false); |
| 2863 |
|
| 2864 |
$vippsdata['userDetails'] = $userDetails; |
| 2865 |
|
| 2866 |
return $vippsdata; |
| 2867 |
} |
| 2868 |
|
| 2869 |
// Update the order with Vipps payment details, either passed or called using the API. |
| 2870 |
public function update_vipps_payment_details ($order, $details = null) { |
| 2871 |
if (!$details) { |
| 2872 |
try { |
| 2873 |
$details = $this->get_payment_details($order); |
| 2874 |
} catch (Exception $e) { |
| 2875 |
// We'll try but if we fail, that's too bad. IOK 2026-03-18. No recovery is really possible here. |
| 2876 |
$this->log(sprintf(__("Could not get payment results for order %1\$s", 'woo-vipps'), $order->get_id())); |
| 2877 |
$this->log($e->getMessage()); |
| 2878 |
} |
| 2879 |
} |
| 2880 |
|
| 2881 |
if ($details) { |
| 2882 |
if (isset($details['transactionSummary'])) { |
| 2883 |
$transactionSummary= $details['transactionSummary']; |
| 2884 |
$order->update_meta_data('_vipps_status',$details['status']); |
| 2885 |
$order->update_meta_data('_vipps_captured',$transactionSummary['capturedAmount']); |
| 2886 |
$order->update_meta_data('_vipps_refunded',$transactionSummary['refundedAmount']); |
| 2887 |
$order->update_meta_data('_vipps_capture_remaining',$transactionSummary['remainingAmountToCapture']); |
| 2888 |
$order->update_meta_data('_vipps_refund_remaining',$transactionSummary['remainingAmountToRefund']); |
| 2889 |
if (isset($details['transactionSummary']['cancelledAmount'])) { |
| 2890 |
$order->update_meta_data('_vipps_cancelled',$transactionSummary['cancelledAmount']); |
| 2891 |
$order->update_meta_data('_vipps_cancel_remaining',$transactionSummary['remainingAmountToCancel']); |
| 2892 |
} |
| 2893 |
} |
| 2894 |
// This is the epayment API - IOK 2022-01-20 |
| 2895 |
if (isset($details['paymentDetails'])) { |
| 2896 |
$d = $details['paymentDetails']; |
| 2897 |
if (isset($d['amount'])) { |
| 2898 |
$order->update_meta_data('_vipps_amount', $d['amount']['value']); |
| 2899 |
} |
| 2900 |
$aggregate = (isset($d['transactionAggregate'])) ? $d['transactionAggregate'] : $d['aggregate']; |
| 2901 |
if ($aggregate) { |
| 2902 |
// capturedAmount, refundedAmount, authorizedAmount, cancelledAmount |
| 2903 |
if (isset($aggregate['authorizedAmount'])) { |
| 2904 |
$order->update_meta_data('_vipps_amount', $aggregate['authorizedAmount']['value']); |
| 2905 |
} |
| 2906 |
} |
| 2907 |
} |
| 2908 |
// Modify payment method name if neccessary |
| 2909 |
if (isset($details['paymentMethod']) && $details['paymentMethod'] == 'Card') { |
| 2910 |
if ($order->get_meta('_vipps_checkout')) { |
| 2911 |
$order->set_payment_method_title(sprintf(__('Credit Card / %1$s', 'woo-vipps'), Vipps::CheckoutName())); |
| 2912 |
} |
| 2913 |
} |
| 2914 |
if (isset($details['paymentMethod']) && $details['paymentMethod'] == 'BankTransfer') { |
| 2915 |
if ($order->get_meta('_vipps_checkout')) { |
| 2916 |
$order->set_payment_method_title(sprintf(__('Bank Transfer/ %1$s', 'woo-vipps'), Vipps::CheckoutName())); |
| 2917 |
$order->update_meta_data('_vipps_api', 'banktransfer'); |
| 2918 |
} |
| 2919 |
} |
| 2920 |
$order->save(); |
| 2921 |
} |
| 2922 |
return $order; |
| 2923 |
} |
| 2924 |
|
| 2925 |
// IOK 2021-01-20 from March 2021 the order_status interface is removed; so we now need to interpret the payment history to find |
| 2926 |
// out the order status. |
| 2927 |
// IOK 2022-01-19 With the epayment API on the other hand, the payment status is back as 'state'. |
| 2928 |
// IOK 2025-08-12 Except for certain payment methods in Checkout. So. |
| 2929 |
// IOK 2025-08-12 Removing the ecom support now, so all code will use 'state', as normalized by normalizePaymentDetails |
| 2930 |
public function get_payment_status_from_payment_details($details) { |
| 2931 |
$status = $details['state']; |
| 2932 |
return $status; |
| 2933 |
} |
| 2934 |
|
| 2935 |
// Get the order status as defined by Vipps; if you have the payment details already, pass them. Will modify the order. IOK 2021-01-20 |
| 2936 |
public function get_vipps_order_status($order, $statusdata=null) { |
| 2937 |
$vippsorderid = $order->get_meta('_vipps_orderid'); |
| 2938 |
if (!$vippsorderid) { |
| 2939 |
$msg = sprintf(__('Could not get %1$s order status - it has no %1$s Order Id. Must cancel.','woo-vipps'), $this->get_payment_method_name()); |
| 2940 |
$this->log($msg,'error'); |
| 2941 |
return 'CANCEL'; |
| 2942 |
} |
| 2943 |
if (!$statusdata) { |
| 2944 |
try { |
| 2945 |
$statusdata = $this->get_payment_details($order); |
| 2946 |
} catch (TemporaryVippsApiException $e) { |
| 2947 |
$this->log(sprintf(__('Could not get %1$s order status for order id:', 'woo-vipps'), Vipps::CompanyName()) . ' ' . $order->get_id() . "\n" .$e->getMessage(),'error'); |
| 2948 |
return null; |
| 2949 |
} catch (VippsAPIException $e) { |
| 2950 |
$msg = sprintf(__('Could not get %1$s order status','woo-vipps'), $this->get_payment_method_name()) . ' ' . $e->getMessage(); |
| 2951 |
$this->log($msg,'error'); |
| 2952 |
if (intval($e->responsecode) == 402 || intval($e->responsecode) == 404) { |
| 2953 |
$this->log(sprintf(__('Order does not exist at %1$s - cancelling','woo-vipps'), $this->get_payment_method_name()) . ' ' . $order->get_id(), 'warning'); |
| 2954 |
return 'CANCEL'; |
| 2955 |
} |
| 2956 |
} catch (Exception $e) { |
| 2957 |
$msg = sprintf(__('Could not get %1$s order status for order id:','woo-vipps'), $this->get_payment_method_name()) . ' ' . $order->get_id() . "\n" . $e->getMessage(); |
| 2958 |
$this->log($msg,'error'); |
| 2959 |
return null; |
| 2960 |
} |
| 2961 |
} |
| 2962 |
if (!$statusdata) return null; |
| 2963 |
|
| 2964 |
$vippsstatus = isset($statusdata['status']) ? $statusdata['status'] : ""; |
| 2965 |
|
| 2966 |
if (!$vippsstatus) { |
| 2967 |
$this->log("Unknown Vipps Status: " . print_r($statusdata, true), 'debug'); |
| 2968 |
} |
| 2969 |
return $vippsstatus; |
| 2970 |
} |
| 2971 |
|
| 2972 |
// The various Vipps APIs return address info with various keys and formats, so we need to translate all of them |
| 2973 |
// to a canonical format. |
| 2974 |
public function canonicalize_vipps_address($address, $user) { |
| 2975 |
// eCom has user info only in the user struct |
| 2976 |
$firstname = $user['firstName']; |
| 2977 |
$lastname = $user['lastName']; |
| 2978 |
$email = $user['email']; |
| 2979 |
|
| 2980 |
// Get the passed phone number from checkout or express, which could be in any number of slots IOK 2025- |
| 2981 |
$phone = isset($user['mobileNumber']) ? $user['mobileNumber'] : ""; |
| 2982 |
if (isset($user['phoneNumber'])) $phone = $user['phoneNumber']; |
| 2983 |
if (!$phone && ($address['phoneNumber'] ?? "")) $phone = $address['phoneNumber']; |
| 2984 |
if (!$phone && ($address['mobileNumber'] ?? "")) $phone = $address['mobileNumber']; |
| 2985 |
|
| 2986 |
// Phone number transformations - the format Vipps Mobilepay uses is often not what merchants expect or need |
| 2987 |
// NOTE: as of writing this, the checkout+expresscheckout expected format is '{countrycode}{phonenr}', so we assume this. LP 2025-12-29 |
| 2988 |
$phone_transformation = $this->get_option('checkout_phone_transformation'); |
| 2989 |
switch($phone_transformation) { |
| 2990 |
case 'ensure_plus': |
| 2991 |
$phone = "+$phone"; |
| 2992 |
break; |
| 2993 |
case 'strip_country_code': |
| 2994 |
// We only support norway,denmark,swedish,finnish country codes as of now. LP 2025-12-29 |
| 2995 |
// We can't do these replaces in sequence, because e.g. +47 46 12 34 56 would become 0 12 34 56 instead of the correct 46 12 34 56. LP 2026-02-19 |
| 2996 |
if (preg_match('!^(45|47)!', $phone)) { // NO, DK |
| 2997 |
$phone = preg_replace('!^(45|47)!', '', $phone); |
| 2998 |
} else if (preg_match('!^(46|358)!', $phone)) { // SE, FI: leading zero for area codes is not used with country code, so add it back here. LP 2026-02-09 |
| 2999 |
$phone = preg_replace('!^(46|358)!', '0', $phone); |
| 3000 |
} |
| 3001 |
break; |
| 3002 |
} |
| 3003 |
$phone = apply_filters('woo_vipps_canonicalize_checkout_phone', $phone, $address, $user); |
| 3004 |
|
| 3005 |
if (!isset($address['firstName']) or !$address['firstName']) { |
| 3006 |
$address['firstName'] = $firstname; |
| 3007 |
} |
| 3008 |
if (!isset($address['lastName']) or !$address['lastName']) { |
| 3009 |
$address['lastName'] = $lastname; |
| 3010 |
} |
| 3011 |
// checkout uses phonenumber |
| 3012 |
if (!isset($address['phoneNumber']) or !$address['phoneNumber']) { |
| 3013 |
$address['phoneNumber'] = $phone; |
| 3014 |
} |
| 3015 |
// epayment uses mobileNumber |
| 3016 |
if (!isset($address['mobileNumber']) or !$address['mobileNumber']) { |
| 3017 |
$address['mobileNumber'] = $phone; |
| 3018 |
} |
| 3019 |
if (!isset($address['email']) or !$address['email']) { |
| 3020 |
$address['email'] = $email; |
| 3021 |
} |
| 3022 |
|
| 3023 |
// epayment |
| 3024 |
$addressline1 = isset($address['addressLine1']) ? $address['addressLine1'] : ""; |
| 3025 |
$addressline2 = isset($address['addressLine2']) ? $address['addressLine2'] : ""; |
| 3026 |
// checkout |
| 3027 |
if (isset($address['streetAddress'])) { |
| 3028 |
$addressline1 = $address['streetAddress']; |
| 3029 |
} |
| 3030 |
if (isset($address['street_address'])) { // From the userinfo api |
| 3031 |
$addressline1 = $address['street_address']; |
| 3032 |
} |
| 3033 |
if ($addressline1 == $addressline2) $addressline2 = ''; |
| 3034 |
$address['addressLine1'] = $addressline1; // epayment |
| 3035 |
$address['addressline2'] = $addressline2; |
| 3036 |
$address['streetAddress'] = $addressline1; // Checkout |
| 3037 |
|
| 3038 |
$city = ""; |
| 3039 |
if (isset($address['city'])) { // checkout and epayment |
| 3040 |
$city = $address['city']; |
| 3041 |
} elseif (isset($address['region'])) { // ecom |
| 3042 |
$city = $address['region']; |
| 3043 |
} |
| 3044 |
$address['city'] = $city; |
| 3045 |
$address['region'] = $city; |
| 3046 |
|
| 3047 |
$postcode= ""; |
| 3048 |
if (isset($address['postCode'])) { |
| 3049 |
$postcode= $address['postCode']; // epayment |
| 3050 |
} elseif (isset($address['postalCode'])){ |
| 3051 |
$postcode= $address['postalCode']; // checkout |
| 3052 |
} elseif (isset($address['postal_code'])) { |
| 3053 |
$postcode= $address['postal_code']; // userinfo |
| 3054 |
} |
| 3055 |
$address['postCode'] = $postcode; // epayment |
| 3056 |
$address['zipCode'] = $postcode; // ecom |
| 3057 |
$address['postalCode'] = $postcode; // checkout |
| 3058 |
|
| 3059 |
// Allow users to modify the address to e.g. handle phone numbers differently IOK 2025-01-20 |
| 3060 |
// note: added separate filter for phone number 'woo_vipps_canonicalize_checkout_phone' because of the different uses, keys etc. LP 2025-12-29 |
| 3061 |
return apply_filters('woo_vipps_canonicalize_checkout_address', $address, $user); |
| 3062 |
} |
| 3063 |
|
| 3064 |
public function set_order_shipping_details($order,$shipping, $user, $billing=false, $alldata=null, $assigncustomer=true) { |
| 3065 |
global $Vipps; |
| 3066 |
$done = $order->get_meta('_vipps_shipping_set'); |
| 3067 |
if ($done) return true; |
| 3068 |
$order->update_meta_data('_vipps_shipping_set', true); |
| 3069 |
$order->save(); // Limit the window for double shipping as much as possible. |
| 3070 |
|
| 3071 |
// This is for handling a custom consent checkbox for mailing lists etc. IOK 2023-02-09 |
| 3072 |
if ($alldata && isset($alldata['customConsentProvided'])) { |
| 3073 |
$order->update_meta_data('_vipps_custom_consent_provided', intval($alldata['customConsentProvided'])); |
| 3074 |
} |
| 3075 |
|
| 3076 |
|
| 3077 |
// We get different values from the normal callback and the Checkout callback, so be prepared for several results. IOK 2021-09-02 |
| 3078 |
// IOK VERIFY this should be normalized now or soon at any rate |
| 3079 |
$address = isset($shipping['address']) ? $shipping['address'] : $shipping;; |
| 3080 |
|
| 3081 |
// Sometimes we get an empty shipping address! In this case, fill the details with the billing address. |
| 3082 |
// This only happens with ecommerce though, so we need to check before canonicalizing. IOK 2022-03-21 |
| 3083 |
// billing is only present in Checkout, which uses phoneNumber, streetAddress, postalCode etc. |
| 3084 |
$shipping_empty = true; |
| 3085 |
if ($billing && array_key_exists('streetAddress', $address)) { |
| 3086 |
$keys = ['firstName', 'lastName', 'email', 'phoneNumber', 'streetAddress', 'postalCode', 'city', 'country']; |
| 3087 |
foreach ($keys as $key) { |
| 3088 |
if (isset($address[$key]) && $address[$key]) { |
| 3089 |
$shipping_empty = false; break; |
| 3090 |
} |
| 3091 |
} |
| 3092 |
if ($shipping_empty) { |
| 3093 |
foreach ($keys as $key) $address[$key] = $billing[$key]; |
| 3094 |
} |
| 3095 |
} |
| 3096 |
|
| 3097 |
if (!$billing) $billing = $address; |
| 3098 |
$address = $this->canonicalize_vipps_address($address, $user); |
| 3099 |
$billing = $this->canonicalize_vipps_address($billing, $user); |
| 3100 |
|
| 3101 |
# Billing. |
| 3102 |
$order->set_billing_email($billing['email']); |
| 3103 |
$order->set_billing_phone($billing['mobileNumber']); |
| 3104 |
$order->set_billing_first_name($billing['firstName']); |
| 3105 |
$order->set_billing_last_name($billing['lastName']); |
| 3106 |
$order->set_billing_address_1($billing['addressLine1']); |
| 3107 |
if ($billing['addressLine2'] ?? false) $order->set_billing_address_2($billing['addressLine2']); |
| 3108 |
$order->set_billing_city($billing['city'] ?? ""); |
| 3109 |
$order->set_billing_postcode($billing['postCode'] ?? ""); |
| 3110 |
$order->set_billing_country($billing['country'] ?? ""); |
| 3111 |
|
| 3112 |
# Shipping. |
| 3113 |
$order->set_shipping_first_name($address['firstName']); |
| 3114 |
$order->set_shipping_last_name($address['lastName']); |
| 3115 |
if (version_compare(WC_VERSION, '5.6.0', '>=')) { |
| 3116 |
$order->set_shipping_phone($address['mobileNumber']); |
| 3117 |
} |
| 3118 |
$order->set_shipping_address_1($address['addressLine1']); |
| 3119 |
if ($address['addressLine2'] ?? "") $order->set_shipping_address_2($address['addressLine2']); |
| 3120 |
$order->set_shipping_city($address['city']); |
| 3121 |
$order->set_shipping_postcode($address['postCode']); |
| 3122 |
$order->set_shipping_country($address['country']); |
| 3123 |
|
| 3124 |
$order->save(); |
| 3125 |
|
| 3126 |
// This is *essential* to get VAT calculated correctly. That calculation uses the customer, which uses the session, which we will have restored at this point.IOK 2019-10-25 |
| 3127 |
if (WC()->customer) { |
| 3128 |
WC()->customer->set_billing_email($billing['email']); |
| 3129 |
WC()->customer->set_email($billing['email']); |
| 3130 |
|
| 3131 |
$country = $billing['country'] ?? ($address['country'] ?? ""); |
| 3132 |
WC()->customer->set_billing_location($country,'',$billing['postalCode'],$billing['region']); |
| 3133 |
WC()->customer->set_shipping_location($address['country'],'',$address['postalCode'],$address['region']); |
| 3134 |
} |
| 3135 |
|
| 3136 |
// We may need the order total early on, so start with that |
| 3137 |
$ordertotal = $order->get_total() ?: 0; |
| 3138 |
|
| 3139 |
$vipps_reserved = $alldata['paymentDetails']['amount']['value'] ?? null; |
| 3140 |
// i dont expect order total to ever be greater than vipps reserved total here, so i dont use abs(). LP 2026-01-28 |
| 3141 |
$diff_reserved_ordertotal = is_numeric($vipps_reserved) ? ($vipps_reserved / 100 - $ordertotal) : 0; |
| 3142 |
|
| 3143 |
// Now do shipping, if it exists IOK 2021-09-02 |
| 3144 |
$method = isset($shipping['shippingMethodId']) ? $shipping['shippingMethodId'] : false; |
| 3145 |
|
| 3146 |
// We will add a shipping rate either if there has been passed a shipping method; or if this |
| 3147 |
// is an order that needs shipping and the amount reserved at vipps is greater than the order total |
| 3148 |
// (with a bit of tolerance for rounding errors). If we *don't* have a shipping method but we know |
| 3149 |
// we need a shipping rate; this is an error condition that the merchant needs to resolve. We'll add a fake |
| 3150 |
// 'Unknown' rate to ensure we capture the right amount and add this fact to the order log. Code by LP, comment by IOK 2026-01-28 |
| 3151 |
$needs_shipping = $method || $order->get_meta('_vipps_needs_shipping'); |
| 3152 |
$tol = 0.01; |
| 3153 |
$has_shipping = $method || $diff_reserved_ordertotal > $tol; |
| 3154 |
|
| 3155 |
if ($needs_shipping && $has_shipping) { |
| 3156 |
$shipping_rate=null; |
| 3157 |
$option_table = []; |
| 3158 |
|
| 3159 |
// Try to find the shipping rate. LP 2026-01-28 |
| 3160 |
if ($method) { |
| 3161 |
if (substr($method,0,1) != '$') { |
| 3162 |
// This is the old way of adding shipping. We should probably deprecate this sometime soon. IOK 2026-01-28 |
| 3163 |
$shipping_rate = $this->get_legacy_express_checkout_shipping_rate($shipping); |
| 3164 |
} else { |
| 3165 |
// Strip suffixes if we have several Express rates mapping to the same Woo rate (eg. for Posten). IOK 2025-05-04 |
| 3166 |
$matches = []; |
| 3167 |
preg_match("!^(?P<key>[^:]+):?(?P<option_index>.+)?$!", $method, $matches); |
| 3168 |
$key = $matches['key'] ?? ""; |
| 3169 |
$option_index = intval(trim($matches['option_index'] ?? "")); // 0 is never an index |
| 3170 |
$shipping_table = $order->get_meta('_vipps_express_checkout_shipping_method_table'); |
| 3171 |
$is_base64 = $shipping_table ? ( $shipping_table['_is_base64'] ?? false) : false; |
| 3172 |
|
| 3173 |
if (is_array($shipping_table) && isset($shipping_table[$key])) { |
| 3174 |
$decoded = $is_base64 ? @base64_decode($shipping_table[$key]) : $shipping_table[$key]; |
| 3175 |
|
| 3176 |
// Ensure no shop manager has injected an evil object (that they would have had to add as a plugin) here. IOK 2026-09-18 |
| 3177 |
$allowed_classes = apply_filters('woo_vipps_express_checkout_allowed_shipping_classes', [WC_Shipping_Rate::class, \stdClass::class]); |
| 3178 |
$shipping_rate = $decoded ? @unserialize($decoded, ['allowed_classes' => $allowed_classes]) : null; |
| 3179 |
$shipping_rate = is_a($shipping_rate,'WC_Shipping_Rate') ? $shipping_rate : null; |
| 3180 |
|
| 3181 |
if (!$shipping_rate) { |
| 3182 |
$this->log(sprintf(__("%1\$s: Could not deserialize the chosen shipping method %2\$s for order %3\$d", 'woo-vipps'), Vipps::ExpressCheckoutName(), $method, $order->get_id()), 'error'); |
| 3183 |
$this->log(sprintf(__("Serialized data was %1\$s", 'woo-vipps'), $decoded), 'error'); |
| 3184 |
} else { |
| 3185 |
// Special-case the Woo pickup location methods. IOK 2026-01-28 |
| 3186 |
if ($option_index) { |
| 3187 |
$meta = $shipping_rate->get_meta_data(); |
| 3188 |
$option_table = $meta['_vipps_pickupPoints'] ?? []; |
| 3189 |
// force string table IOK 2025-08-15 |
| 3190 |
$point = $option_table["i".$option_index] ?? ""; |
| 3191 |
if ($point) { |
| 3192 |
$shipping['pickupPoint'] = $point; |
| 3193 |
} |
| 3194 |
$shipping_rate->add_meta_data('_vipps_pickupPoints', null); |
| 3195 |
} |
| 3196 |
// Empty this when done, but not if there was an error - let the merchant be able to debug. IOK 2020-02-14 |
| 3197 |
$order->update_meta_data('_vipps_express_checkout_shipping_method_table', null); |
| 3198 |
} |
| 3199 |
} |
| 3200 |
} |
| 3201 |
|
| 3202 |
// Possible extra metadata from Checkout IOK 2023-01-17 |
| 3203 |
// Store in the order, but also in the shipping rate so it will be visible in the order screen |
| 3204 |
// along with the shipping ragte |
| 3205 |
if (isset($shipping['pickupPoint'])) { |
| 3206 |
$order->update_meta_data('vipps_checkout_pickupPoint', $shipping['pickupPoint']); |
| 3207 |
if ($shipping_rate) { |
| 3208 |
$pp = $shipping['pickupPoint']; |
| 3209 |
$addr = []; |
| 3210 |
foreach(['address', 'postalCode', 'city', 'country'] as $key) { |
| 3211 |
$v = trim($pp[$key]); |
| 3212 |
if (!empty($v)) $addr[] = trim($pp[$key]); |
| 3213 |
} |
| 3214 |
|
| 3215 |
$shipping_rate->add_meta_data('pickup_location', $pp['name']); |
| 3216 |
$shipping_rate->add_meta_data('pickup_address', join(", ", $addr)); |
| 3217 |
$shipping_rate->add_meta_data('pickup_details', ""); // Not supported by the API unfortunately. IOK 2025-06-07 |
| 3218 |
} |
| 3219 |
} |
| 3220 |
if (isset($shipping['timeslot'])) { |
| 3221 |
$order->update_meta_data('vipps_checkout_timeslot', $shipping['timeslot']); |
| 3222 |
if ($shipping_rate) { |
| 3223 |
$pp = $shipping['timeslot']; |
| 3224 |
$slot = ""; |
| 3225 |
$slot .= sprintf(__("Date: %s", 'woo-vipps'), ($pp['date'] ?? "")); |
| 3226 |
$slot .= " " . sprintf(__("Start: %s", 'woo-vipps'), ($pp['start'] ?? "")); |
| 3227 |
$slot .= " " . sprintf(__("End: %s", 'woo-vipps'), ($pp['end'] ?? "")); |
| 3228 |
$shipping_rate->add_meta_data('vipps_delivery_timeslot', $slot); |
| 3229 |
$shipping_rate->add_meta_data('vipps_delivery_timeslot_id', $pp['id']); |
| 3230 |
} |
| 3231 |
} |
| 3232 |
} |
| 3233 |
|
| 3234 |
// We know we need a shipping rate, and what its price has to be, so ensure we have one by making one up if missing. LP 2026-01-28 |
| 3235 |
if (!$shipping_rate) { |
| 3236 |
$shipping_rate = new WC_Shipping_Rate( |
| 3237 |
'UNKNOWN', |
| 3238 |
sprintf(__('Unknown shipping: please check the shipping details at %1$s', 'woo-vipps'), Vipps::CompanyName()), |
| 3239 |
$diff_reserved_ordertotal, |
| 3240 |
[], |
| 3241 |
'UNKNOWN', |
| 3242 |
0, |
| 3243 |
); |
| 3244 |
$shipping_rate = apply_filters('woo_vipps_unknown_shipping_rate_dummy', $shipping_rate, $order); |
| 3245 |
|
| 3246 |
// Add an error log for the merchants to quote to us. |
| 3247 |
$msg = sprintf(__("%1\$s Could not retrieve any shipping rate for this order, with method %2\$s",'woo-vipps'), $this->get_payment_method_name(), $method) . " " . $order->get_id(); |
| 3248 |
$order->add_order_note($msg); |
| 3249 |
$this->log($msg, 'warning'); |
| 3250 |
} |
| 3251 |
|
| 3252 |
$shipping_rate = apply_filters('woo_vipps_express_checkout_final_shipping_rate', $shipping_rate, $order, $shipping); |
| 3253 |
|
| 3254 |
$total_shipping = 0; |
| 3255 |
$total_shipping_tax = 0; |
| 3256 |
$it = null; |
| 3257 |
|
| 3258 |
// Recover the Shipping Method class |
| 3259 |
$methods_classes = WC()->shipping->get_shipping_method_class_names(); |
| 3260 |
$methodclass = $methods_classes[$shipping_rate->get_method_id()] ?? null; |
| 3261 |
$shipping_method = $methodclass ? new $methodclass($shipping_rate->get_instance_id()) : null; |
| 3262 |
$is_vipps_checkout_shipping = $shipping_method && is_a($shipping_method, 'VippsCheckout_Shipping_Method'); |
| 3263 |
|
| 3264 |
// Some Checkout-specific shipping methods calculate the cost in the Vipps window. |
| 3265 |
if ($is_vipps_checkout_shipping && $shipping_method->dynamic_cost) { |
| 3266 |
$vippsamount = intval($order->get_meta('_vipps_amount')); |
| 3267 |
$shipping_tax_rate = floatval($order->get_meta('_vipps_shipping_tax_rates')); |
| 3268 |
$compareamount = $ordertotal * 100; |
| 3269 |
$amountdiff = $vippsamount-$compareamount; // this is the *actual* shipping cost at this point |
| 3270 |
$diffnotax = ($amountdiff / (100 + $shipping_tax_rate)); // Adjusted to correct values actually |
| 3271 |
$difftax = WC_Tax::round($amountdiff/100 - $diffnotax); |
| 3272 |
$actual = $amountdiff/100 - $difftax; |
| 3273 |
|
| 3274 |
$shipping_rate->set_cost($actual); |
| 3275 |
$shipping_rate->set_taxes( [ 1 => $difftax] ); |
| 3276 |
} |
| 3277 |
|
| 3278 |
$it = new WC_Order_Item_Shipping(); |
| 3279 |
$it->set_shipping_rate($shipping_rate); |
| 3280 |
$it->set_order_id( $order->get_id() ); |
| 3281 |
// This should actually have been done by the "set_shipping_rate" call above, but as of 3.9.2 at least, this does not work. |
| 3282 |
// Therefore, do it manually/forcefully IOK 2020-02-17 |
| 3283 |
foreach($shipping_rate->get_meta_data() as $key => $value) { |
| 3284 |
$it->add_meta_data($key,$value,true); |
| 3285 |
} |
| 3286 |
$it->save(); |
| 3287 |
|
| 3288 |
$order->add_item($it); |
| 3289 |
|
| 3290 |
$total_shipping = $it->get_total() ?: 0; |
| 3291 |
$total_shipping_tax = $it->get_total_tax() ?: 0; |
| 3292 |
|
| 3293 |
// Try to avoid calculate_totals, because this will recalculate shipping _without checking if the rate |
| 3294 |
// in question actually should use tax_. Therefore we will just add the pre-calculated values, so that the |
| 3295 |
// value reserved at Vipps and the order total is the same. IOK 2022-10-03 |
| 3296 |
$order->set_shipping_total($total_shipping); |
| 3297 |
$order->set_shipping_tax($total_shipping_tax); |
| 3298 |
|
| 3299 |
$order->set_total($ordertotal + $total_shipping + $total_shipping_tax); |
| 3300 |
$order->update_taxes(); // Necessary for the admin view only; does not recalculate order. |
| 3301 |
|
| 3302 |
// Add an early hook for Checkout orders with special shipping methods |
| 3303 |
$metadata = $shipping_rate->get_meta_data(); |
| 3304 |
if (isset($metadata['type'])) { |
| 3305 |
do_action('woo_vipps_checkout_special_shipping_method', $order, $shipping_rate, $metadata['type']); |
| 3306 |
} |
| 3307 |
|
| 3308 |
$order->save(); |
| 3309 |
// NB: WE DO NOT CALL CALCULATE TOTALS! |
| 3310 |
// THIS WILL CALCULATE SHIPPING FOR TAX IF THERE IS A TAX RATE FOR THE GIVEN AREA WITH THE 'shipping' PROPERTY CHECKED - EVEN IF THE SHIPPING RATE IT SELF IS NOT THUS CONFIGURED. |
| 3311 |
// Same thing happens when using the "recalculate" button in the backend |
| 3312 |
// This will *only* affect users that choose "No tax" for the shipping rates themselves, which is mostly just wrong, but we want to ensure consistency here since this is hard |
| 3313 |
// to debug. |
| 3314 |
// $order->calculate_totals(true); |
| 3315 |
} |
| 3316 |
|
| 3317 |
|
| 3318 |
// If we have the 'expresscreateuser' thing set to true, we will create or assign the order here, as it is the first-ish place where we can. |
| 3319 |
// If possible and safe, user will be logged in before being sent to the thankyou screen. IOK 2020-10-09 |
| 3320 |
// Same thing for Checkout, mutatis mutandis. The function below returns false if no customer exists or gets created. |
| 3321 |
$customer = false; |
| 3322 |
if ($assigncustomer) { |
| 3323 |
$customer = Vipps::instance()->express_checkout_get_vipps_customer($order); |
| 3324 |
} |
| 3325 |
if ($customer) { |
| 3326 |
// This would have been used to ensure that we 'enroll' the users the same way as in the Login plugin. Unfortunately, the userId from express checkout isn't |
| 3327 |
// the same as the 'sub' we get in Login so that must be a future feature. IOK 2020-10-09 |
| 3328 |
// IOK 2025-08-13 we do get the 'sub' now, at least for express checkout. For Checkout, we would have to compare the email of the user with the verified email |
| 3329 |
// after calling get_userinfo, so we'll leave that be. |
| 3330 |
// We *maybe* get the sub - it depends on consent, and *maybe* that a scope has been added in epayment_initate_payment. IOK 2026-08-18 |
| 3331 |
if (class_exists('VippsWooLogin') && $customer && !is_wp_error($customer) && !get_user_meta($customer->get_id(), '_vipps_phone',true)) { |
| 3332 |
update_user_meta($customer->get_id(), '_vipps_phone', $billing['phoneNumber']); |
| 3333 |
if (isset($user['sub'])) { |
| 3334 |
$userid = $customer->get_id(); |
| 3335 |
update_user_meta($userid, '_vipps_id', $user['sub']); |
| 3336 |
update_user_meta($userid, '_vipps_just_connected', 1); |
| 3337 |
} |
| 3338 |
} |
| 3339 |
|
| 3340 |
// Ensure we get any changes made to the order, as it will be re-saved later |
| 3341 |
$order = wc_get_order($order->get_id()); |
| 3342 |
} |
| 3343 |
|
| 3344 |
do_action('woo_vipps_set_order_shipping_details', $order, $shipping, $user); |
| 3345 |
$order->save(); // I'm not sure why this is neccessary - but be sure. |
| 3346 |
|
| 3347 |
} |
| 3348 |
|
| 3349 |
// Previously, shipping rates were added by creating them here with metadata packed into the shippingMethodId. This is from 1.4.0 only |
| 3350 |
// used when the woo_vipps_shipping_methods filter has been overriden by the merchant. IOK 2020-02-14 |
| 3351 |
private function get_legacy_express_checkout_shipping_rate($shipping) { |
| 3352 |
$method = $shipping['shippingMethodId']; |
| 3353 |
list ($rate,$tax) = explode(";",$method); |
| 3354 |
// The method ID is encoded in the rate ID but we apparently must still send it to the WC_Shipping_Rate constructor. IOK 2018-06-01 |
| 3355 |
// Unfortunately, Vipps won't accept long enought 'shipingMethodId' for us to actually stash all the information we need. IOK 2018-06-01 |
| 3356 |
list ($method,$product) = explode(":",$rate); |
| 3357 |
$tax = wc_format_decimal($tax,''); |
| 3358 |
$label = $shipping['shippingMethod']; |
| 3359 |
$cost = wc_format_decimal($shipping['shippingCost'],''); // This is inclusive of tax |
| 3360 |
$costExTax= wc_format_decimal($cost-$tax,''); |
| 3361 |
$shipping_rate = new WC_Shipping_Rate($rate,$label,$costExTax,array(array('total'=>$tax)), $method, $product); |
| 3362 |
$shipping_rate = apply_filters('woo_vipps_express_checkout_shipping_rate',$shipping_rate,$costExTax,$tax,$method,$product); |
| 3363 |
return $shipping_rate; |
| 3364 |
} |
| 3365 |
|
| 3366 |
// Used by both poll_and_check_order_status and handle_callback - sets the neccessary order metadata after a successful (or not vipps transaction). IOK 2025-08-13 |
| 3367 |
public function order_set_transaction_metadata($order, $transaction) { |
| 3368 |
// Set Vipps metadata as early as possible |
| 3369 |
$vippsstamp = strtotime($transaction['timeStamp']); |
| 3370 |
$vippsamount = $transaction['amount'] ?? ''; |
| 3371 |
$vippscurrency= $transaction['currency'] ?? ''; |
| 3372 |
$vippsstatus = $transaction['status']; |
| 3373 |
|
| 3374 |
$order->update_meta_data('_vipps_callback_timestamp',$vippsstamp); |
| 3375 |
$order->update_meta_data('_vipps_amount',$vippsamount); |
| 3376 |
$order->update_meta_data('_vipps_currency',$vippscurrency); |
| 3377 |
$order->update_meta_data('_vipps_status',$vippsstatus); |
| 3378 |
|
| 3379 |
// Checkout only, modify payment method name if neccessary |
| 3380 |
if ($transaction['paymentmethod'] == 'Card') { |
| 3381 |
if ($order->get_meta('_vipps_checkout')) { |
| 3382 |
$order->set_payment_method_title(sprintf(__('Credit Card / %1$s', 'woo-vipps'), Vipps::CheckoutName())); |
| 3383 |
} |
| 3384 |
} |
| 3385 |
// Checkout only, banktransfers are handled specially so note that |
| 3386 |
if ($transaction['paymentmethod'] == 'BankTransfer') { |
| 3387 |
$order->set_payment_method_title(sprintf(__('Bank Transfer/ %1$s', 'woo-vipps'), Vipps::CheckoutName())); |
| 3388 |
$order->update_meta_data('_vipps_api', 'banktransfer'); |
| 3389 |
} |
| 3390 |
} |
| 3391 |
|
| 3392 |
// Handle the callback from Vipps ePayment |
| 3393 |
public function handle_callback($result, $order, $ischeckout=false, $iswebhook=false) { |
| 3394 |
global $Vipps; |
| 3395 |
|
| 3396 |
$vippsorderid = $result['orderId']; |
| 3397 |
$merchant= $result['merchantSerialNumber']; |
| 3398 |
|
| 3399 |
$keyset = $this->get_keyset(); |
| 3400 |
$me = array_keys($keyset); |
| 3401 |
|
| 3402 |
// Validate the callback first |
| 3403 |
if (!in_array($merchant, $me)) { |
| 3404 |
$this->log(sprintf(__("%1\$s callback with wrong merchantSerialNumber - might be forged",'woo-vipps'), $this->get_payment_method_name()) . " " . $order->get_id(), 'warning'); |
| 3405 |
return false; |
| 3406 |
} |
| 3407 |
if (!$order) { |
| 3408 |
$this->log(sprintf(__("%1\$s callback for unknown order",'woo-vipps'), $this->get_payment_method_name()) . " " . $order->get_id(), 'warning'); |
| 3409 |
return false; |
| 3410 |
} |
| 3411 |
$order_id = $order->get_id(); |
| 3412 |
if ($vippsorderid != $order->get_meta('_vipps_orderid')) { |
| 3413 |
$this->log(sprintf(__('Wrong %1$s Orderid - possibly an attempt to fake a callback ', 'woo-vipps'), Vipps::CompanyName()), 'warning'); |
| 3414 |
clean_post_cache($order_id); |
| 3415 |
exit(); |
| 3416 |
} |
| 3417 |
|
| 3418 |
// Note any errors in the callback early |
| 3419 |
$errorInfo = $result['errorInfo'] ?? ''; |
| 3420 |
if ($errorInfo) { |
| 3421 |
/* translators: payment method name, order id */ |
| 3422 |
$this->log(sprintf(__('Message in callback from %1$s for order %2$s: ','woo-vipps'), $this->get_payment_method_name(), $order_id), $errorInfo['errorMessage'], 'error'); |
| 3423 |
/* translators: payment method name, message */ |
| 3424 |
$order->add_order_note(sprintf(__('Message from %1$s: %2$s','woo-vipps'), $this->get_payment_method_name(), $errorInfo['errorMessage'])); |
| 3425 |
} |
| 3426 |
|
| 3427 |
// Create a signal file (if possible) so the confirm screen knows to check status IOK 2018-05-04 |
| 3428 |
try { |
| 3429 |
$Vipps->createCallbackSignal($order,'ok'); |
| 3430 |
} catch (Exception $e) { |
| 3431 |
// Could not create a signal file, but that's ok. |
| 3432 |
} |
| 3433 |
|
| 3434 |
// New callback handling: schedule an Action Scheduler job to process it. The purpose of processing callback |
| 3435 |
// is to set finalize the order (set order status, set shipping for express) in the case when customer does |
| 3436 |
// not return to the store, because then poll does not run. LP 2026-03-27 |
| 3437 |
|
| 3438 |
// Below is separate from '_vipps_callback_timestamp' which is when callback is sent, |
| 3439 |
// but also that meta won't be stored until callback is actually processed. LP 2026-03-30 |
| 3440 |
$order->update_meta_data('_vipps_callback_received_at', time()); |
| 3441 |
// Store the callback data in the order. We'll do a cleanup of this when the scheduled job runs. IOK 2026-04-21 |
| 3442 |
$order->update_meta_data('_vipps_callback_data', $result); |
| 3443 |
$order->save_meta_data(); |
| 3444 |
|
| 3445 |
// Run callback actions for callback received as soon as it is actually received. |
| 3446 |
$transaction = []; // No longer provided. IOK 2026-05-06 |
| 3447 |
do_action('woo_vipps_callback_received', $order, $result, $transaction); |
| 3448 |
|
| 3449 |
$action_args = [ |
| 3450 |
'order_id' => $order->get_id(), |
| 3451 |
'is_checkout' => $ischeckout, |
| 3452 |
'is_webhook' => $iswebhook, |
| 3453 |
]; |
| 3454 |
// We'll check the status of this order in a minute. At that time, the customer should have been able to return to the store |
| 3455 |
// and have the order finalized the 'normal' way, but if they don't, we'll handle it async. 2026-04-21 |
| 3456 |
$scheduled_at = time() + 60; |
| 3457 |
$action_id = as_schedule_single_action($scheduled_at, 'woo_vipps_action_process_callback', $action_args, 'woo-vipps', false); |
| 3458 |
if ($action_id) { |
| 3459 |
/* translators: order id, scheduled time */ |
| 3460 |
$this->log(sprintf(__('Callback action scheduled at %2$s for order %1$s', 'woo-vipps'), $order->get_id(), $scheduled_at), 'info'); |
| 3461 |
} else { |
| 3462 |
// The action scheduler error is not returned, only sent to error_log (https://github.com/woocommerce/action-scheduler/blob/25c982c3d0f8134389d5b5884082403c4806322f/classes/ActionScheduler_ActionFactory.php#L268). LP 2026-04-23 |
| 3463 |
/* translators: order id */ |
| 3464 |
$this->log(sprintf(__('Failed to schedule callback process action for order %1$s, check the php error log', 'woo-vipps'), $order->get_id()), 'error'); |
| 3465 |
/* We will not delete the callback data here, to facilitate debugging. But return false to indicate that callback handling will fail. */ |
| 3466 |
/* NB: The order will still be processed with the periodic job, at a later stage. IOK 2026-05-06 */ |
| 3467 |
return false; |
| 3468 |
} |
| 3469 |
|
| 3470 |
// Signal that we in fact handled the order. |
| 3471 |
return true; |
| 3472 |
} |
| 3473 |
|
| 3474 |
/** Runs in action scheduler: sync woo status from Vipps callback data. Handle shipping etc. for Express. LP 2026-03-31 */ |
| 3475 |
public function action_process_callback($order_id, $is_checkout, $is_webhook) { |
| 3476 |
$order = wc_get_order($order_id); |
| 3477 |
if (!is_a($order, 'WC_Order')) { |
| 3478 |
/* translators: order id */ |
| 3479 |
$this->log(sprintf(__('Callback process action failed, could not find order %1$s','woo-vipps'), $order_id), 'error'); |
| 3480 |
return false; |
| 3481 |
} |
| 3482 |
|
| 3483 |
$oldstatus = $order->get_status(); |
| 3484 |
if ($oldstatus != 'pending') { |
| 3485 |
// Actually, we are ok with this order, abort the callback handler. IOK 2018-05-30 |
| 3486 |
$order->delete_meta_data('_vipps_callback_data'); |
| 3487 |
clean_post_cache($order->get_id()); |
| 3488 |
return false; |
| 3489 |
} |
| 3490 |
$data = $order->get_meta('_vipps_callback_data'); |
| 3491 |
|
| 3492 |
/* translators: order id */ |
| 3493 |
$this->log(sprintf(__('Callback process action running for order %1$s.', 'woo-vipps'), $order_id)); |
| 3494 |
|
| 3495 |
// The payment details field is passed in Checkout, not in Express, but none of them are complete, so we fill out the values |
| 3496 |
// depending on which one we are IOK 2025-08-13 |
| 3497 |
$details = []; |
| 3498 |
// Checkout has this as a field, containing *some* of the neccessary data |
| 3499 |
if (isset($data['paymentDetails'])) { |
| 3500 |
// Checkout. The sesssion states are # "SessionCreated" "PaymentInitiated" "SessionExpired" "PaymentSuccessful" "PaymentTerminated" |
| 3501 |
// -- we should only get callbacks for successful sessions actually. |
| 3502 |
|
| 3503 |
$details = $data['paymentDetails']; |
| 3504 |
$data['state'] = $data['sessionState'] == 'PaymentSuccessful' ? 'AUTHORIZED' : ($data['sessionState'] == 'PaymentTerminated' ? 'TERMINATED' : 'CREATED'); |
| 3505 |
$details['state'] = $data['state']; |
| 3506 |
$details['paymentMethod'] = $data['paymentMethod']; |
| 3507 |
} else { |
| 3508 |
// This should be an epayment webhook callback; which we need to add a lot of data for to get a valid "paymentDetails". |
| 3509 |
$details = []; |
| 3510 |
$data['state'] = $data['name']; // The name of the callback - which should be AUTHORIZED, TERMINATED etc |
| 3511 |
$details['state'] = $data['name']; |
| 3512 |
$details['amount'] = $data['amount']; // currency, value |
| 3513 |
$details['paymentMethod'] = 'epayment'; |
| 3514 |
} |
| 3515 |
|
| 3516 |
// For both callbacks, set 'aggregate' |
| 3517 |
$currency = $details['amount']['currency']; |
| 3518 |
$nothing = [ 'currency' => $currency, 'value' => 0]; |
| 3519 |
$aggregate = ['authorizedAmount' => $nothing, 'cancelledAmount' => $nothing, 'capturedAmount' => $nothing, 'refundedAmount' => $nothing]; |
| 3520 |
if ($details['state'] == 'AUTHORIZED') { |
| 3521 |
$aggregate['authorizedAmount'] = $details['amount']; |
| 3522 |
} |
| 3523 |
$details['aggregate'] = $aggregate; |
| 3524 |
$data['paymentDetails'] = $details; |
| 3525 |
|
| 3526 |
// Do the actual work with a function shared with the periodic job. |
| 3527 |
$this->set_order_status_by_payment_details($order,$data); |
| 3528 |
|
| 3529 |
/* translators: payment method name */ |
| 3530 |
$order->add_order_note(sprintf(__('%1$s callback processed','woo-vipps'), $this->get_payment_method_name())); |
| 3531 |
|
| 3532 |
// We're done, so delete the callback data. IOK 2026-04-22 |
| 3533 |
$order->delete_meta_data('_vipps_callback_data'); |
| 3534 |
} |
| 3535 |
|
| 3536 |
|
| 3537 |
// Called either by periodic job or by action_process_callback with the callback data *or* with payment details fetched with poll. |
| 3538 |
// sets order status if neccessary, and will finalize the order for Express via HTTP call if necessary. IOK 2026-05-06 |
| 3539 |
public function set_order_status_by_payment_details($order, $data, $allow_retry=true) { |
| 3540 |
$data = $this->normalizePaymentDetails($data); |
| 3541 |
$details = $data['paymentDetails']; |
| 3542 |
$order_id = $order->get_id(); |
| 3543 |
|
| 3544 |
$vippsstatus = $data['status']; // Will exist now, because of the normalization IOK 2025-08-13 |
| 3545 |
$newstatus = $this->interpret_vipps_order_status($vippsstatus); |
| 3546 |
|
| 3547 |
// Extract order metadata from either Checkout or Epayment - set below IOK 2025-08-13 |
| 3548 |
$transaction = array(); |
| 3549 |
$stamp = ($data['timestamp'] ?? false) ? strtotime($data['timestamp']) : time(); |
| 3550 |
$transaction['timeStamp'] = date('Y-m-d H:i:s', $stamp); |
| 3551 |
$transaction['amount'] = $details['amount']['value']; |
| 3552 |
$transaction['currency'] = $details['amount']['currency']; |
| 3553 |
$transaction['status'] = ($data['state'] ?? $details['state']); |
| 3554 |
$transaction['paymentmethod'] = $details['paymentMethod'] ?? ""; |
| 3555 |
$this->order_set_transaction_metadata($order, $transaction); |
| 3556 |
|
| 3557 |
// Dont do anything if order is not finalized. LP 2026-08-31 |
| 3558 |
if (!in_array($newstatus, ['authorized', 'complete', 'cancelled'])) { |
| 3559 |
return; |
| 3560 |
} |
| 3561 |
|
| 3562 |
// This order is ready to set order shipping details etc for IOK 2025-09-19 |
| 3563 |
$ready = in_array($newstatus, ['authorized', 'complete']); |
| 3564 |
|
| 3565 |
if ($ready) { |
| 3566 |
// Failsafe for rare bug when using Klarna Checkout with Vipps as an external payment method |
| 3567 |
// IOK 2024-01-09 ensure this is called only when order is complete/authorized |
| 3568 |
$this->reset_erroneous_payment_method($order); |
| 3569 |
} |
| 3570 |
|
| 3571 |
$is_express_or_checkout = $order->get_meta('_vipps_express_checkout'); |
| 3572 |
|
| 3573 |
// Handle session and shipping through http, because we dont want to mess with session here in wp cron (action scheduler). LP 2026-03-30 |
| 3574 |
// NB: This is and must be a *synchronous call*. When done, the order will have shipping, addresses etc. IOK 2026-05-06. |
| 3575 |
$shipping_set = $order->get_meta('_vipps_shipping_set'); |
| 3576 |
if ($ready && $is_express_or_checkout && !$shipping_set) { |
| 3577 |
$token = $order->get_meta('_vipps_authtoken'); |
| 3578 |
$args = [ |
| 3579 |
'body' => [ |
| 3580 |
'order_id' => $order_id, |
| 3581 |
'vipps_order_data' => $data, |
| 3582 |
], |
| 3583 |
'headers' => [ |
| 3584 |
'X-WooVipps-Token' => $token, |
| 3585 |
], |
| 3586 |
]; |
| 3587 |
$url = Vipps::get_rest_url('v1', '/order-set-shipping'); |
| 3588 |
$response = wp_remote_post($url, $args); |
| 3589 |
if (is_wp_error($response)) { |
| 3590 |
/* translators: order id, error message */ |
| 3591 |
$error_msg = $response->get_error_message(); |
| 3592 |
$this->log(sprintf(__('Process callback action failed to finalize shipping through http rest endpoint for order %1$s: %2$s', 'woo-vipps'), $order->get_id(), $error_msg), 'error'); |
| 3593 |
} else if (200 != ($response['response']['code'] ?? -1)) { |
| 3594 |
/* translators: order id */ |
| 3595 |
$response_msg = print_r($response['body'] ?? ['Missing response body'], true); |
| 3596 |
$this->log(sprintf(__('Process callback action failed to finalize shipping through http rest endpoint for order %1$s: %2$s', 'woo-vipps'), $order->get_id(), $response_msg), 'error'); |
| 3597 |
} |
| 3598 |
} |
| 3599 |
|
| 3600 |
// This must happen *after* finalization for Express, as above. IOK 2026-05-06 |
| 3601 |
// the only status we now care about is AUTHORIZED. Previously we had AUTHORISED and RESERVED and RESERVE as well. And SALE. |
| 3602 |
if ($vippsstatus == 'AUTHORIZED') { |
| 3603 |
$this->payment_complete($order); |
| 3604 |
} else if ($vippsstatus == 'SALE') { |
| 3605 |
// Direct capture needs special handling because most of the meta values we use are missing IOK 2019-02-26 |
| 3606 |
// Actually not supported anymore, but keep logic. IOK 2025-08-13 |
| 3607 |
// Still supported for finnish direct bank transfer. IOK 2026-04-22 |
| 3608 |
$order->add_order_note(sprintf(__('Payment captured directly at %1$s', 'woo-vipps'), $this->get_payment_method_name())); |
| 3609 |
$order->payment_complete(); |
| 3610 |
$this->update_vipps_payment_details($order); |
| 3611 |
} else { |
| 3612 |
// Not ok status; set to failed/cancelled |
| 3613 |
$order_is_retryable = $allow_retry && Vipps::order_is_vipps_retryable($order->get_id()); |
| 3614 |
$status_on_fail = $this->get_option('status_on_fail'); |
| 3615 |
$cancel_on_fail = apply_filters('woo_vipps_cancel_failed_orders', false, $order, $vippsstatus); |
| 3616 |
if ($cancel_on_fail || !$order_is_retryable) { |
| 3617 |
$status_on_fail = 'cancelled'; |
| 3618 |
} |
| 3619 |
if (!in_array($status_on_fail, ['cancelled', 'failed'])) { |
| 3620 |
/* translators: %1 = order status parameter. 'cancelled' is woocommerce order status name */ |
| 3621 |
$this->log(__('Unsupported status for payment failure of \'%1$s\', falling back to cancelled.', 'woo-vipps'), 'warning'); |
| 3622 |
$status_on_fail = 'cancelled'; |
| 3623 |
} |
| 3624 |
|
| 3625 |
/* translators: company name */ |
| 3626 |
$order->update_status($status_on_fail, sprintf(__('Callback: Payment cancelled at %1$s.', 'woo-vipps'), Vipps::CompanyName())); |
| 3627 |
} |
| 3628 |
|
| 3629 |
$order->save(); |
| 3630 |
clean_post_cache($order_id); |
| 3631 |
} |
| 3632 |
|
| 3633 |
/* finalize shipping for express/checkout order. LP 2026-03-30 */ |
| 3634 |
public function rest_order_set_shipping($request) { |
| 3635 |
$order_id = $request->get_param('order_id'); |
| 3636 |
$data = $request->get_param('vipps_order_data'); |
| 3637 |
|
| 3638 |
$order = wc_get_order($order_id); |
| 3639 |
if (!is_a($order, 'WC_Order')) { |
| 3640 |
return new WP_Error('order_not_found', __('Order not found', 'woo-vipps'), ['status' => 404]); |
| 3641 |
} |
| 3642 |
|
| 3643 |
$is_express_or_checkout = $order->get_meta('_vipps_express_checkout'); |
| 3644 |
$shipping_set = $order->get_meta('_vipps_shipping_set'); |
| 3645 |
if (!$is_express_or_checkout || $shipping_set) { |
| 3646 |
return new WP_Error('order_is_finalized', __('Order does not need to set shipping', 'woo-vipps'), ['status' => 409]); |
| 3647 |
} |
| 3648 |
|
| 3649 |
// Ensure we use the same session as for the original order from here on. IOK 2019-10-21 |
| 3650 |
// IOK 2023-07-18 but because of the race condition issue, we cannot guarantee that any changes |
| 3651 |
// made to the session here will be saved. Sorry. |
| 3652 |
// UPDATE: Should be no more race condition since we moved callback into the action scheduler, and this shipping finalization into this rest endpoint. LP 2026-03-30 |
| 3653 |
Vipps::instance()->callback_restore_session($order_id); |
| 3654 |
|
| 3655 |
// For Checkout version 3 there are no more userDetails, so we will add it, including defaults for anonymous purchases IOK 2023-01-10 |
| 3656 |
// This will also normalize userDetails, adding 'sub' where possible and fields for backwards compatibility. 2025-08-12 |
| 3657 |
$data = $this->ensure_userDetails($data, $order); |
| 3658 |
|
| 3659 |
// Some Express Checkout orders aren't really express checkout orders, but normal orders to which we have |
| 3660 |
// added scope name, email, phoneNumber. The reason is that we don't care about the address. But then |
| 3661 |
// we also get no user data in the callback, so we must replace the callback with a user info call. IOK 2023-03-10 |
| 3662 |
// IOK 2025-09-29: This is probably *no longer true* - we now almost certainly *always* get a userDetails field if |
| 3663 |
// we have added a scope of any kind. This is therefore probably dead code. |
| 3664 |
// This being dead code, we'll not try to handle errors gracefully here. IOK 2026-03-18 |
| 3665 |
if (!isset($data['userDetails'])) { |
| 3666 |
// This also calls ensure_userDetails and normalizeShippingDetails - but NB: it could fail, so call only when neccessary. |
| 3667 |
try { |
| 3668 |
$details = $this->get_payment_details($order); |
| 3669 |
$data = $details; |
| 3670 |
} catch (Exception $e) { |
| 3671 |
$this->log(sprintf(__("Could not get payment results for order %1\$s", 'woo-vipps'), $order->get_id())); |
| 3672 |
$this->log($e->getMessage()); |
| 3673 |
} |
| 3674 |
} |
| 3675 |
|
| 3676 |
// Epayment Express Checkout is of course also significantly different from both the old Express and from Checkout in the formatting here. IOK 2025-08-12 |
| 3677 |
$data = $this->normalizeShippingDetails($data, $order); |
| 3678 |
|
| 3679 |
// We should now always have shipping details. |
| 3680 |
if (isset($data['shippingDetails'])) { |
| 3681 |
$billing = isset($data['billingDetails']) ? $data['billingDetails'] : false; |
| 3682 |
$this->set_order_shipping_details($order,$data['shippingDetails'], $data['userDetails'], $billing, $data); |
| 3683 |
} |
| 3684 |
} |
| 3685 |
|
| 3686 |
// Do the 'payment_complete' logic for non-SALE orders IOK 2020-09-22 |
| 3687 |
public function payment_complete($order,$transactionid='') { |
| 3688 |
// Orders not needing processing can be autocaptured, so try to do so now. |
| 3689 |
$autocapture = $this->maybe_complete_payment($order); |
| 3690 |
if (!$autocapture) { |
| 3691 |
add_filter('woocommerce_payment_complete_order_status', |
| 3692 |
function ($status, $orderid, $order) { |
| 3693 |
return $this->after_vipps_order_status($order); |
| 3694 |
}, 99, 3); |
| 3695 |
$order->add_order_note(sprintf(__('Payment authorized at %1$s', 'woo-vipps'), $this->get_payment_method_name())); |
| 3696 |
} |
| 3697 |
$order->payment_complete(); |
| 3698 |
} |
| 3699 |
|
| 3700 |
// Hook run by Woo after order is complete (authorized or sale). We'll add receipt info etc here. |
| 3701 |
public function order_payment_complete ($orderid) { |
| 3702 |
$order = wc_get_order($orderid); |
| 3703 |
if (!is_a($order, 'WC_Order')) return false; |
| 3704 |
if (! Vipps::is_vipps_order($order)) return false; |
| 3705 |
|
| 3706 |
$do_order_management = apply_filters('woo_vipps_order_management_on_payment_complete', true, $orderid); |
| 3707 |
if (!$do_order_management) return; |
| 3708 |
|
| 3709 |
// We do the actual order management call in a separate request which we call non-blocking to avoid it locking |
| 3710 |
// up the users' session on return from the store. This won't work if your Wordpress doesn't support non-blocking calls, |
| 3711 |
// so in this case, allow the user to set a longer timeout (5 seconds should be plenty.) IOK 2022-07-01 |
| 3712 |
// Yes, it will block until timeout even if non-blocking is set. IOK 2022-07-01 |
| 3713 |
$timeout = apply_filters('woo_vipps_asynch_timeout', 0.5); |
| 3714 |
$data = [ 'action'=> 'woo_vipps_order_management','orderid'=>$orderid, 'orderkey' => $order->get_order_key() ]; |
| 3715 |
$args = array( "method" => "POST", "body"=>$data, "timeout"=>$timeout, "blocking" => false); |
| 3716 |
$url = admin_url('admin-post.php'); |
| 3717 |
$asynch = wp_remote_request($url,$args); |
| 3718 |
if (is_wp_error($asynch)) { |
| 3719 |
$this->log(__("Error calling the Order Management API: %1\$s ", 'woo-vipps'), $asynch->get_error_message()); |
| 3720 |
} |
| 3721 |
} |
| 3722 |
|
| 3723 |
// The below actions *may* be long-running, and we can't be sure |
| 3724 |
// they will happen at callback-time. Some user may be affected, even if using wp-cron. |
| 3725 |
// We therefore set them up to be run at shutdown, as soon as payment complete is done |
| 3726 |
public function payment_complete_at_shutdown ($orderid, $orderkey) { |
| 3727 |
// Ensure consistent environment here |
| 3728 |
global $Vipps; |
| 3729 |
if (!$Vipps) $Vipps = Vipps::instance(); |
| 3730 |
$order = wc_get_order($orderid); |
| 3731 |
if (!is_a($order, 'WC_Order')) { |
| 3732 |
return false; |
| 3733 |
} |
| 3734 |
if (! Vipps::is_vipps_order($order)) return false; |
| 3735 |
if ($order->get_order_key() != wc_clean($orderkey)) { |
| 3736 |
return false; |
| 3737 |
} |
| 3738 |
try { |
| 3739 |
|
| 3740 |
$sendreceipt = apply_filters('woo_vipps_send_receipt', ($this->get_option('sendreceipts') == 'yes'), $order); |
| 3741 |
if ($sendreceipt) { |
| 3742 |
$this->api->add_receipt($order); |
| 3743 |
$this->order_add_vipps_categories($order); |
| 3744 |
} |
| 3745 |
do_action('woo_vipps_payment_complete_at_shutdown', $order, $this); |
| 3746 |
} catch (Exception $e) { |
| 3747 |
// This is/should be non-critical so just log it. |
| 3748 |
$this->log(sprintf(__("Could not do all payment-complete actions on %1\$s order %2\$d: %3\$s ", 'woo-vipps'), Vipps::CompanyName(), $orderid, $e->getMessage()), "error"); |
| 3749 |
} |
| 3750 |
} |
| 3751 |
|
| 3752 |
// This is run on payment complete. Per default will it only add a link to the order confirmation page, but |
| 3753 |
// the hook added should be used if selling tickets, bookings etc to add these to the Vipps app receipt; with images if desired (eg. QR images). |
| 3754 |
public function order_add_vipps_categories ($order) { |
| 3755 |
if (!is_a($order, 'WC_Order')) return; |
| 3756 |
|
| 3757 |
$none = ['link'=>null, 'image'=>null, 'imagesize'=>null]; |
| 3758 |
$orderconfirmation = ['link' => $this->get_return_url($order), 'image' => null, 'imagesize'=>null]; |
| 3759 |
|
| 3760 |
$receipt_image = $this->get_option('receiptimage'); |
| 3761 |
if ($receipt_image) { |
| 3762 |
$orderconfirmation['image'] = intval($receipt_image); |
| 3763 |
$orderconfirmation['imagesize'] = 'full'; |
| 3764 |
} |
| 3765 |
|
| 3766 |
// Do these in this order, in case we get terminated at some point during processing |
| 3767 |
$default = ['TICKET'=>$none,'ORDER_CONFIRMATION' => $orderconfirmation, 'RECEIPT' => $none,"BOOKING" => $none, "DELIVERY" => $none, "GENERAL" => $none]; |
| 3768 |
$categories = apply_filters('woo_vipps_add_order_categories', $default, $order, $this); |
| 3769 |
|
| 3770 |
foreach ($categories as $category=>$data) { |
| 3771 |
if ($data['link']) { |
| 3772 |
$this->order_add_vipps_category($category, $order, $data['link'], $data['image'], $data['imagesize']); |
| 3773 |
} |
| 3774 |
// Let people handle this in other ways if not using filter above IOK 2022-07-01 |
| 3775 |
do_action('woo_vipps_add_order_category', $category, $order, $this); |
| 3776 |
|
| 3777 |
} |
| 3778 |
} |
| 3779 |
|
| 3780 |
// Use the Order Management API to add a link with a category name and an optional image, which is viewable in the order. |
| 3781 |
public function order_add_vipps_category($categoryname, $order, $link, $image=null, $imagesize='medium') { |
| 3782 |
$imageid = $image ? $this->add_vipps_image($image, $imagesize) : null; |
| 3783 |
return $this->api->add_category($order, $link, $imageid, $categoryname); |
| 3784 |
} |
| 3785 |
|
| 3786 |
// Use the Order Management API to upload an image that can be attached to the order. |
| 3787 |
public function add_vipps_image ($imagespec, $size = 'medium') { |
| 3788 |
// Imagespec is an attachmend id (of an image) or a filename (to an image), and a size if using an attachment id. |
| 3789 |
$filename = null; |
| 3790 |
$imageid = 0; |
| 3791 |
$imagefile = ""; |
| 3792 |
$mime = ""; |
| 3793 |
$accepted_types = ["image/jpeg", "image/png", "image/jpg"]; // Only accepted types at Vipps |
| 3794 |
$vippsid = null; |
| 3795 |
$uploads = wp_get_upload_dir(); |
| 3796 |
|
| 3797 |
if (is_numeric($imagespec)) { |
| 3798 |
// Don't send same image twice if we have an id |
| 3799 |
$stored = get_post_meta($imagespec, '_vipps_imageid', true); |
| 3800 |
if ($stored && !$this->is_test_mode()) { |
| 3801 |
return $stored; |
| 3802 |
} |
| 3803 |
$imageid = intval($imagespec); |
| 3804 |
$imagefile = get_attached_file($imageid); |
| 3805 |
$mime = get_post_mime_type($imageid); |
| 3806 |
} |
| 3807 |
|
| 3808 |
if (!is_file($imagefile) || !in_array($mime, $accepted_types)) { |
| 3809 |
$this->log(sprintf(__('%1$s is not an image that can be uploaded to %2$s', 'woo-vipps'), $imagefile, Vipps::CompanyName()), 'error'); |
| 3810 |
$this->log(sprintf(__('File type was %1$s; supported types are %2$s', 'woo-vipps'), $mime, join(", ", $accepted_types)), 'error'); |
| 3811 |
return null; |
| 3812 |
} |
| 3813 |
|
| 3814 |
if ($imageid) { |
| 3815 |
$intermediate = image_get_intermediate_size($imageid, $size); |
| 3816 |
if ($intermediate && isset($intermediate['path'])) { |
| 3817 |
$imagefile = join(DIRECTORY_SEPARATOR, [$uploads['basedir'] , $intermediate['path']]); |
| 3818 |
} |
| 3819 |
} |
| 3820 |
|
| 3821 |
if ($imagefile) { |
| 3822 |
// Check image dimensions before uploading |
| 3823 |
$dimensions = getimagesize($imagefile); |
| 3824 |
if ($dimensions && $dimensions[1] < 167) { // [1] is height |
| 3825 |
$this->log(sprintf(__('Image %1$s is too small - height %2$dpx (minimum 167px required)', 'woo-vipps'), |
| 3826 |
$imagefile, $dimensions[1]), 'error'); |
| 3827 |
return null; |
| 3828 |
} |
| 3829 |
|
| 3830 |
$vippsid = $this->api->add_image($imagefile); |
| 3831 |
if ($vippsid) { |
| 3832 |
update_post_meta($imageid, '_vipps_imageid', $vippsid); |
| 3833 |
} |
| 3834 |
} |
| 3835 |
return $vippsid; |
| 3836 |
} |
| 3837 |
|
| 3838 |
// For the express checkout mechanism, create a partial order without shipping details by simulating checkout->create_order(); |
| 3839 |
// IOK 2018-05-25 |
| 3840 |
public function create_partial_order($ischeckout=false) { |
| 3841 |
// This is neccessary for some plugins, like Yith Dynamic Pricing, that adds filters to get_price depending on whether or not ischeckout is true. |
| 3842 |
// so basically, since we are impersonating WC_Checkout here, we should define this constant too. IOK 2020-07-03 |
| 3843 |
wc_maybe_define_constant('WOOCOMMERCE_CHECKOUT', true ); |
| 3844 |
|
| 3845 |
// In *some* cases you may need to actually load classes and reload the cart, because some plugins do not load when DOING_AJAX. |
| 3846 |
do_action('woo_vipps_express_checkout_before_calculate_totals'); |
| 3847 |
WC()->cart->calculate_fees(); |
| 3848 |
WC()->cart->calculate_totals(); |
| 3849 |
do_action('woo_vipps_before_create_express_checkout_order', WC()->cart); |
| 3850 |
|
| 3851 |
// We store this in the order so we don't have to access the cart when initiating payment. This allows us to restart orders etc. |
| 3852 |
$needs_shipping = WC()->cart->needs_shipping(); |
| 3853 |
|
| 3854 |
$contents = WC()->cart->get_cart_contents(); |
| 3855 |
$contents = apply_filters('woo_vipps_create_express_checkout_cart_contents',$contents); |
| 3856 |
try { |
| 3857 |
$cart_hash = WC()->cart->get_cart_hash(); |
| 3858 |
$order = new WC_Order(); |
| 3859 |
$order->set_status('pending'); |
| 3860 |
$order->set_payment_method($this); |
| 3861 |
if ($ischeckout) { |
| 3862 |
$order->update_meta_data('_vipps_api', 'epayment'); |
| 3863 |
$order->set_payment_method_title('Vipps Checkout'); |
| 3864 |
} else { |
| 3865 |
$order->set_payment_method_title('Vipps Express Checkout'); |
| 3866 |
} |
| 3867 |
// We use 'checkout' as the created_via key as per requests, but allow merchants to use their own. IOK 2022-09-15 |
| 3868 |
$created_via = apply_filters('woo_vipps_express_checkout_created_via', 'checkout', $order, $ischeckout); |
| 3869 |
$order->set_created_via($created_via); |
| 3870 |
$order->set_cart_hash($cart_hash); |
| 3871 |
|
| 3872 |
$dummy = sprintf(__('Vipps Express Checkout', 'woo-vipps')); // this is so gettext will find this string. |
| 3873 |
$dummy = sprintf(__('Vipps Checkout', 'woo-vipps')); // this is so gettext will find this string. |
| 3874 |
|
| 3875 |
$order->update_meta_data('_vipps_express_checkout',1); |
| 3876 |
|
| 3877 |
# To help with address fields, scope etc in inititate payment |
| 3878 |
$order->update_meta_data('_vipps_needs_shipping', $needs_shipping); |
| 3879 |
|
| 3880 |
$order->set_customer_id( apply_filters('woocommerce_checkout_customer_id', get_current_user_id() ) ); |
| 3881 |
$order->set_currency( get_woocommerce_currency() ); |
| 3882 |
$order->set_prices_include_tax('yes' === get_option('woocommerce_prices_include_tax') ); |
| 3883 |
$order->set_customer_ip_address( WC_Geolocation::get_ip_address() ); |
| 3884 |
$order->set_customer_user_agent( wc_get_user_agent() ); |
| 3885 |
$order->set_discount_total( WC()->cart->get_discount_total()); |
| 3886 |
$order->set_discount_tax( WC()->cart->get_discount_tax() ); |
| 3887 |
$order->set_cart_tax( WC()->cart->get_cart_contents_tax() + WC()->cart->get_fee_tax() ); |
| 3888 |
|
| 3889 |
// Use these methods directly - they should be safe. |
| 3890 |
WC()->checkout->create_order_line_items( $order, WC()->cart); |
| 3891 |
WC()->checkout->create_order_fee_lines( $order, WC()->cart); |
| 3892 |
WC()->checkout->create_order_tax_lines( $order, WC()->cart); |
| 3893 |
WC()->checkout->create_order_coupon_lines( $order, WC()->cart); |
| 3894 |
do_action('woo_vipps_before_calculate_totals_partial_order', $order); |
| 3895 |
$order->calculate_totals(true); |
| 3896 |
|
| 3897 |
// Added to support third-party plugins that wants to do stuff with the order before it is saved. IOK 2020-07-03 |
| 3898 |
do_action('woocommerce_checkout_create_order', $order, array()); |
| 3899 |
|
| 3900 |
$orderid = $order->save(); |
| 3901 |
|
| 3902 |
do_action('woo_vipps_express_checkout_order_created', $orderid); |
| 3903 |
|
| 3904 |
// Normally done by the WC_Checkout::create_order method, so call it here too. IOK 2018-11-19 |
| 3905 |
do_action('woocommerce_checkout_update_order_meta', $orderid, array()); |
| 3906 |
|
| 3907 |
// It isn't possible to remove the javascript or 'after order notice' actions, because these are added as closures |
| 3908 |
// before anything else is run. But we can disable the hook that saves data. IOK 2024-01-18 |
| 3909 |
if (WC_Gateway_Vipps::instance()->get_option('vippsorderattribution') != 'yes') { |
| 3910 |
remove_all_filters( 'woocommerce_order_save_attribution_data'); |
| 3911 |
} |
| 3912 |
|
| 3913 |
// And another one. IOK 2021-11-24 |
| 3914 |
do_action('woocommerce_checkout_order_created', $order ); |
| 3915 |
} catch ( Exception $e ) { |
| 3916 |
if ( $order && $order instanceof WC_Order ) { |
| 3917 |
$order->get_data_store()->release_held_coupons( $order ); |
| 3918 |
do_action('woocommerce_checkout_order_exception', $order ); |
| 3919 |
} |
| 3920 |
// Any errors gets passed upstream IOK 2021-11-24 |
| 3921 |
throw $e; |
| 3922 |
} |
| 3923 |
return $orderid; |
| 3924 |
} |
| 3925 |
|
| 3926 |
// The order attribution subsystem of Woo requires extra work for our partial orders. IOK 2024-01-09 |
| 3927 |
// The attribution data is added to the order forms with prefixes (after 'order note') and we need to strip the prefix. |
| 3928 |
public function get_order_attribution_data($input_data) { |
| 3929 |
$prefix = (string) apply_filters( 'wc_order_attribution_tracking_field_prefix', 'wc_order_attribution_'); |
| 3930 |
$prefix = trim( $prefix, '_' ) . "_"; |
| 3931 |
$len = strlen($prefix); |
| 3932 |
$params = []; |
| 3933 |
foreach($input_data as $key=>$val) { |
| 3934 |
$found = strpos($key, $prefix); |
| 3935 |
if ($found === 0) { |
| 3936 |
$paramkey = substr($key, $len); |
| 3937 |
$params[$paramkey] = $val; |
| 3938 |
} |
| 3939 |
} |
| 3940 |
return $params; |
| 3941 |
} |
| 3942 |
|
| 3943 |
public function save_session_in_order($order) { |
| 3944 |
// The callbacks from Vipps carry no session cookie, so we must store this in the order and use a special session handler when in a callback. |
| 3945 |
// The Vipps class will restore the session from this on callbacks. |
| 3946 |
// IOK 2019-10-21 |
| 3947 |
$sessioncookie = array(); |
| 3948 |
$sessionhandler = WC()->session; |
| 3949 |
if ($sessionhandler && is_a($sessionhandler, 'WC_Session_Handler')) { |
| 3950 |
// If customer is actually logged in, take note IOK 2019-10-25 |
| 3951 |
WC()->session->set('express_customer_id',get_current_user_id()); |
| 3952 |
WC()->session->save_data(); |
| 3953 |
$sessioncookie=$sessionhandler->get_session_cookie(); |
| 3954 |
} else { |
| 3955 |
// This actually can't happen. IOK 2020-04-08. Branch added for debugging only. |
| 3956 |
} |
| 3957 |
|
| 3958 |
if (!empty($sessioncookie)) { |
| 3959 |
// Customer id, session expiration, session-epiring and cookie-hash is the contents. IOK 2019-10-21 |
| 3960 |
$order->update_meta_data('_vipps_sessiondata',json_encode($sessioncookie)); |
| 3961 |
$order->save(); |
| 3962 |
} |
| 3963 |
|
| 3964 |
} |
| 3965 |
|
| 3966 |
// Using this internally to allow the 'enable' button or not. Checks SSL in addition to currency, |
| 3967 |
// is valid_for_use can in principle run on a http version of the page; we only need to have https accessible for callbacks, |
| 3968 |
// but if so, admin should definitely be HTTPS so we just check that. IOK 2018-06-06 |
| 3969 |
public function can_be_activated () { |
| 3970 |
if (!is_ssl() && !preg_match("!^https!i",home_url())) return false; |
| 3971 |
return true; |
| 3972 |
} |
| 3973 |
|
| 3974 |
// Used by the ajax thing that 'sets activated' - checks that it can be activated and that all keys are present. IOK 2018-06-06 |
| 3975 |
function needs_setup() { |
| 3976 |
if (!$this->can_be_activated()) return true; |
| 3977 |
$required = array('merchantSerialNumber','clientId', 'secret', 'Ocp_Apim_Key_eCommerce'); |
| 3978 |
foreach ($required as $key) { |
| 3979 |
if (!$this->get_option($key)) return true; |
| 3980 |
} |
| 3981 |
return false; |
| 3982 |
} |
| 3983 |
|
| 3984 |
// Not present in WooCommerce until 3.4.0. Should be deleted when required versions are incremented. IOK 2018-10-26 |
| 3985 |
public function update_option( $key, $value = '') { |
| 3986 |
if ( empty( $this->settings ) ) { |
| 3987 |
$this->init_settings(); |
| 3988 |
} |
| 3989 |
$this->settings[ $key ] = $value; |
| 3990 |
return update_option( $this->get_option_key(), apply_filters('woocommerce_settings_api_sanitized_fields_' . $this->id, $this->settings ), 'yes'); |
| 3991 |
} |
| 3992 |
|
| 3993 |
|
| 3994 |
public function admin_options() { |
| 3995 |
$currency = get_woocommerce_currency(); |
| 3996 |
$payment_method = $this->get_payment_method_name(); |
| 3997 |
|
| 3998 |
if (!$this->can_be_activated()) { |
| 3999 |
$this->update_option('enabled', 'no'); |
| 4000 |
} |
| 4001 |
|
| 4002 |
if ($payment_method != "Vipps"): ?> |
| 4003 |
<style> |
| 4004 |
#woocommerce_vipps_express_options, #woocommerce_vipps_express_options-table { |
| 4005 |
display: none; |
| 4006 |
} |
| 4007 |
</style> |
| 4008 |
<?php endif; ?> |
| 4009 |
|
| 4010 |
<h2 id='vipps-settings-page'><?php echo __(Vipps::CompanyName(),'woo-vipps'); ?> <img style="float:right;max-height:40px;margin-top:-15px" alt="<?php _e($this->title,'woo-vipps'); ?>" src="<?php echo $this->icon; ?>"></h2> |
| 4011 |
<?php $this->display_errors(); ?> |
| 4012 |
|
| 4013 |
<?php |
| 4014 |
|
| 4015 |
|
| 4016 |
if (!$this->payment_method_supports_currency($payment_method, $currency)): |
| 4017 |
?> |
| 4018 |
<div class="inline error"> |
| 4019 |
<p><strong><?php echo sprintf(__('%1$s does not support your currency.', 'woo-vipps'), $payment_method); ?></strong> |
| 4020 |
<br> |
| 4021 |
<?php echo sprintf(__('%1$s supported currencies: %2$s', 'woo-vipps'), $payment_method, implode(", ", $this->get_supported_currencies($payment_method))); ?> |
| 4022 |
</p> |
| 4023 |
</div> |
| 4024 |
<?php endif; ?> |
| 4025 |
|
| 4026 |
<?php if (!is_ssl() && !preg_match("!^https!i",home_url())): ?> |
| 4027 |
<div class="inline error"> |
| 4028 |
<p><strong><?php _e('Gateway disabled', 'woocommerce'); ?></strong>: |
| 4029 |
<?php echo sprintf(__('%1$s requires that your site uses HTTPS.', 'woo-vipps'), $payment_method); ?> |
| 4030 |
</p> |
| 4031 |
</div> |
| 4032 |
<?php endif; ?> |
| 4033 |
|
| 4034 |
<?php // We will only show the Checkout options if the user has activated the feature (thus creating the pages involved etc). IOK 2021-10-01 |
| 4035 |
$vipps_checkout_activated = get_option('woo_vipps_checkout_activated', false); |
| 4036 |
?> |
| 4037 |
|
| 4038 |
<?php /* We will *not* allow vipps checkout to be activated at this point, since the product is no longer sold. IOK 2026-04-30 */ ?> |
| 4039 |
<?php if (!$vipps_checkout_activated): ?> |
| 4040 |
|
| 4041 |
<?php endif; ?> |
| 4042 |
<table class="form-table"> |
| 4043 |
<?php $this->generate_settings_html(); ?> |
| 4044 |
</table> <?php |
| 4045 |
} |
| 4046 |
|
| 4047 |
// Validate/mangle input fields |
| 4048 |
function validate_text_field ($key, $value) { |
| 4049 |
if ($key != 'orderprefix') return parent::validate_text_field($key,$value); |
| 4050 |
$value = preg_replace('![^a-zA-Z0-9]!','',$value); |
| 4051 |
return $value; |
| 4052 |
} |
| 4053 |
function validate_checkbox_field($key,$value) { |
| 4054 |
if ($key == 'testmode' && VIPPS_TEST_MODE) { |
| 4055 |
return "yes"; |
| 4056 |
} else if ($key == 'developermode' && VIPPS_TEST_MODE) { |
| 4057 |
return "yes"; |
| 4058 |
} else if ($key == 'enabled') { |
| 4059 |
if ($value && $this->can_be_activated()) return 'yes'; |
| 4060 |
return "no"; |
| 4061 |
} |
| 4062 |
return parent::validate_checkbox_field($key,$value); |
| 4063 |
} |
| 4064 |
|
| 4065 |
function process_admin_options () { |
| 4066 |
// Handle options updates |
| 4067 |
$saved = parent::process_admin_options(); |
| 4068 |
// We may have changed the number of form fields at this point if dev mode was changed |
| 4069 |
// from off to on,so re-initialize the form fields here. IOK 2019-09-03 |
| 4070 |
$this->init_form_fields(); |
| 4071 |
|
| 4072 |
// Reinitialize keysets in case user added/changed these |
| 4073 |
$this->keyset = null; |
| 4074 |
delete_transient('_vipps_keyset'); |
| 4075 |
$keyset = $this->get_keyset(); |
| 4076 |
|
| 4077 |
// IOK FIXME check if we are called using ajax for this; and if so add the notifications to a list of notifications |
| 4078 |
// instead of doing the adminerr/adminnotify thing. IOK 2024-01-03 |
| 4079 |
|
| 4080 |
list($ok,$msg) = $this->check_connection(); |
| 4081 |
if ($ok) { |
| 4082 |
$this->adminnotify(sprintf(__("Connection to %1\$s is OK", 'woo-vipps'), Vipps::CompanyName())); |
| 4083 |
} else { |
| 4084 |
$this->adminerr(sprintf(__("Could not connect to %1\$s", 'woo-vipps'), Vipps::CompanyName()) . ": $msg"); |
| 4085 |
} |
| 4086 |
|
| 4087 |
if ($ok) { |
| 4088 |
$this->check_webhooks(); |
| 4089 |
// Try to ensure we have webhooks defined for the epayment-api IOK 2023-12-19 |
| 4090 |
$hooks = $this->initialize_webhooks(); |
| 4091 |
} |
| 4092 |
|
| 4093 |
// If enabling this, ensure the page in question exists |
| 4094 |
if ($this->get_option('vipps_checkout_enabled') == 'yes') { |
| 4095 |
update_option('woo_vipps_checkout_activated', true, true); // This must be true here, but still, make sure |
| 4096 |
Vipps::instance()->maybe_create_vipps_pages(); |
| 4097 |
} |
| 4098 |
|
| 4099 |
// Ensure special page has the necessary shortcode. LP 2026-09-01 |
| 4100 |
$special_page = get_post(Vipps::get_special_page_id()); |
| 4101 |
if ($special_page && !has_shortcode($special_page->post_content, 'vipps_special_page')) { |
| 4102 |
$new_content = $special_page->post_content . "\n\n<!-- wp:shortcode -->[vipps_special_page]<!-- /wp:shortcode -->"; |
| 4103 |
wp_update_post([ |
| 4104 |
'ID' => Vipps::get_special_page_id(), |
| 4105 |
'post_content' => $new_content, |
| 4106 |
]); |
| 4107 |
} else if (!Vipps::get_special_page_id()) { |
| 4108 |
// We shouldn't really get here, the page should be ensured to exist in init. LP 2026-09-03 |
| 4109 |
/* translators: %s is current method name */ |
| 4110 |
$this->log(sprintf(__('Missing special page in %s, attempting to fix', 'woo-vipps'), 'process_admin_options'), 'warning'); |
| 4111 |
Vipps::instance()->ensure_special_page_exists(); |
| 4112 |
} |
| 4113 |
|
| 4114 |
return $saved; |
| 4115 |
} |
| 4116 |
|
| 4117 |
// Check our stored webhooks for consistency, which means the callback URLs should point to *this* site. If they don't, |
| 4118 |
// delete all the ones pointing wrong. If this returns false, you should reinitialize the webhooks. IOK 2023-12-20 |
| 4119 |
public function check_webhooks () { |
| 4120 |
$local_hooks = get_option('_woo_vipps_webhooks'); |
| 4121 |
if (!$local_hooks) return false; |
| 4122 |
|
| 4123 |
$callback = $this->webhook_callback_url(); |
| 4124 |
$callback_compare = strtok($callback, '?'); |
| 4125 |
$problems = false; |
| 4126 |
|
| 4127 |
// We are going to re-initialize our webhooks after this, but just to ensure we're not keeping any 'stale' hooks, |
| 4128 |
// we'll update the local hooks too. IOK 2025-02-13 |
| 4129 |
$change = false; |
| 4130 |
$msns = array_keys($local_hooks); |
| 4131 |
foreach($msns as $msn) { |
| 4132 |
$hooks = $local_hooks[$msn]; |
| 4133 |
$ids = array_keys($hooks); |
| 4134 |
foreach ($ids as $id) { |
| 4135 |
$hook = $hooks[$id]; |
| 4136 |
$noargs = strtok($hook['url'], '?'); |
| 4137 |
if ($noargs == $callback_compare) continue; // This hook is good, probably, unless somebody has deleted it |
| 4138 |
try { |
| 4139 |
$this->log(sprintf(__("For msn %s we have a webhook %s %s which is pointed the wrong way (%s) for this website", 'woo-vipps'), $msn, $hook['id'], $hook['url'], $callback_compare)); |
| 4140 |
$this->api->delete_webhook($msn, $hook['id']); // This isn't - it's pointed the wrong way, which means we have changed name of the site or something |
| 4141 |
} catch (Exception $e) { |
| 4142 |
$this->log(sprintf(__("Could not delete webhook for this site with url '%2\$s' : %1\$s", 'woo-vipps'), $e->getMessage(), $noargs), 'error'); |
| 4143 |
} |
| 4144 |
unset($hooks[$id]); |
| 4145 |
$change = true; |
| 4146 |
$problems = true; |
| 4147 |
} |
| 4148 |
|
| 4149 |
if ($change) { |
| 4150 |
if (empty($hooks)) { |
| 4151 |
unset($local_hooks[$msn]); |
| 4152 |
} else { |
| 4153 |
$local_hooks[$msn] = $hooks; |
| 4154 |
} |
| 4155 |
} |
| 4156 |
} |
| 4157 |
|
| 4158 |
if ($change) { |
| 4159 |
update_option('_woo_vipps_webhooks', $local_hooks, true); |
| 4160 |
} |
| 4161 |
|
| 4162 |
if ($problems) return false; |
| 4163 |
return true; |
| 4164 |
} |
| 4165 |
|
| 4166 |
// Returns the local webhooks for the given msn. If the url has changed, it will return nothing. IOK 2023-12-19 |
| 4167 |
public function get_local_webhook($msn) { |
| 4168 |
$local_hooks = get_option('_woo_vipps_webhooks'); |
| 4169 |
$hooks = $local_hooks[$msn] ?? []; |
| 4170 |
$callback = $this->webhook_callback_url(); |
| 4171 |
$callback_compare = strtok($callback, '?'); |
| 4172 |
|
| 4173 |
foreach ($hooks as $id=>$hook) { |
| 4174 |
$noargs = strtok($hook['url'], '?'); |
| 4175 |
if ($noargs == $callback_compare) { |
| 4176 |
return $hook; |
| 4177 |
} else { |
| 4178 |
// May want to log this somehow |
| 4179 |
} |
| 4180 |
} |
| 4181 |
return null; |
| 4182 |
} |
| 4183 |
|
| 4184 |
|
| 4185 |
// This is to be used in deactivate/uninstall - it deletes all webhooks for all MSNs for this instance |
| 4186 |
// Unfortunatetly, we can't delete other msn's webhooks or webhooks pointing to other URLs. IOK 2023-12-20 |
| 4187 |
public function delete_all_webhooks() { |
| 4188 |
delete_option('_woo_vipps_webhooks'); |
| 4189 |
$callback = $this->webhook_callback_url(); |
| 4190 |
$comparandum = strtok($callback, '?'); |
| 4191 |
$all_hooks = $this->get_webhooks_from_vipps(); |
| 4192 |
foreach($all_hooks as $msn => $data) { |
| 4193 |
$hooks = $data['webhooks'] ?? []; |
| 4194 |
foreach ($hooks as $hook) { |
| 4195 |
$id = $hook['id']; |
| 4196 |
$url = $hook['url']; |
| 4197 |
$noargs = strtok($url, '?'); |
| 4198 |
if ($noargs != $comparandum) continue; // Some other shops hook, we will ignore it |
| 4199 |
$ok = $this->api->delete_webhook($msn,$id); |
| 4200 |
} |
| 4201 |
} |
| 4202 |
} |
| 4203 |
|
| 4204 |
// This will initalize the webhooks for this instance, for all MSNs that are configured. |
| 4205 |
// Hooks that point to us that we *do not* know the secret for, have to be deleted. |
| 4206 |
public function initialize_webhooks() { |
| 4207 |
// IOK 2023-12-20 for the epayment api, we need to re-initialize webhooks at this point. |
| 4208 |
try { |
| 4209 |
return $this->initialize_webhooks_internal(); |
| 4210 |
} catch (Exception $e) { |
| 4211 |
$this->log(sprintf(__("Could not initialize webhooks for this site: %1\$s", 'woo-vipps'), $e->getMessage()), 'error'); |
| 4212 |
return []; |
| 4213 |
} |
| 4214 |
} |
| 4215 |
|
| 4216 |
private function initialize_webhooks_internal () { |
| 4217 |
$local_hooks = get_option('_woo_vipps_webhooks'); |
| 4218 |
$all_hooks = $this->get_webhooks_from_vipps(); |
| 4219 |
$ourselves = $this->webhook_callback_url(); |
| 4220 |
$keysets = $this->get_keyset(); |
| 4221 |
|
| 4222 |
// Ignore any extra arguments |
| 4223 |
$comparandum = strtok($ourselves, '?'); |
| 4224 |
|
| 4225 |
$change = false; |
| 4226 |
|
| 4227 |
// We may need to delete webhooks that have been orphaned. There should be exactly one |
| 4228 |
// for this sites' callback, and we need to know its secret. All others should be deleted. |
| 4229 |
$delenda = []; |
| 4230 |
|
| 4231 |
|
| 4232 |
foreach($all_hooks as $msn => $data) { |
| 4233 |
$hooks = $data['webhooks'] ?? []; |
| 4234 |
$gotit = false; |
| 4235 |
$locals = $local_hooks[$msn] ?? []; |
| 4236 |
|
| 4237 |
foreach ($hooks as $hook) { |
| 4238 |
$id = $hook['id']; |
| 4239 |
$url = $hook['url']; |
| 4240 |
$noargs = strtok($url, '?'); |
| 4241 |
if ($noargs != $comparandum) { |
| 4242 |
continue; // Some other shops hook, we will ignore it |
| 4243 |
} |
| 4244 |
$local = $locals[$id] ?? false; |
| 4245 |
|
| 4246 |
// If we haven't gotten our hook yet, but we have a local hook now that we know a secret for, note it and continue |
| 4247 |
if (!$gotit && $local && isset($local['secret'])) { |
| 4248 |
$gotit = $local; |
| 4249 |
continue; |
| 4250 |
} |
| 4251 |
// Now we have a hook for our own msn and url, but either we don't know the secret or it is a duplicate. It should be deleted. |
| 4252 |
$delenda[] = $id; |
| 4253 |
} |
| 4254 |
|
| 4255 |
// Delete all the webhooks for this msn that we don't want |
| 4256 |
foreach ($delenda as $wrong) { |
| 4257 |
$change = true; |
| 4258 |
$this->api->delete_webhook($msn,$wrong); |
| 4259 |
} |
| 4260 |
|
| 4261 |
if ($gotit) { |
| 4262 |
// Now if we got a hook, then we should *just* remember that for this msn. |
| 4263 |
$local_hooks[$msn] = array($gotit['id'] => $gotit); |
| 4264 |
} else { |
| 4265 |
// If not, we don't have a hook for this msn and site, so we need to (try to) create one |
| 4266 |
// but only if the MSN is registered for the payment gateway "vipps" ! IOK 2024-12-03 |
| 4267 |
$keys = $keysets[$msn] ?? []; |
| 4268 |
$gateway = $keys['gw'] ?? 'vipps'; |
| 4269 |
|
| 4270 |
if ($gateway == 'vipps') { |
| 4271 |
$change = true; |
| 4272 |
$result = $this->api->register_webhook($msn, $ourselves); |
| 4273 |
if ($result) { |
| 4274 |
$local_hooks[$msn] = [$result['id'] => ['id'=>$result['id'], 'url' => $ourselves, 'secret' => $result['secret']]]; |
| 4275 |
} |
| 4276 |
} |
| 4277 |
} |
| 4278 |
} |
| 4279 |
update_option('_woo_vipps_webhooks', $local_hooks, true); |
| 4280 |
|
| 4281 |
|
| 4282 |
if ($change) $all_hooks = $this->get_webhooks_from_vipps(); |
| 4283 |
|
| 4284 |
return $all_hooks; |
| 4285 |
} |
| 4286 |
|
| 4287 |
|
| 4288 |
// Checks connection of the 'main' MSN IOK 2023-12-19 |
| 4289 |
public function check_connection ($msn = null) { |
| 4290 |
if (!$msn) { |
| 4291 |
$msn = $this->get_merchant_serial(); |
| 4292 |
} |
| 4293 |
$at = $this->get_key($msn); |
| 4294 |
$s = $this->get_secret($msn); |
| 4295 |
$c = $this->get_clientid($msn); |
| 4296 |
if ($at && $s && $c) { |
| 4297 |
|
| 4298 |
|
| 4299 |
|
| 4300 |
try { |
| 4301 |
// First, test the client id / client secret which will give us an access token |
| 4302 |
$token = $this->api->get_access_token($msn,'force'); |
| 4303 |
if ($token) { |
| 4304 |
// Then, call the webhooks api to check if the msn/sub key is ok |
| 4305 |
try { |
| 4306 |
$this->api->get_webhooks_raw($msn); |
| 4307 |
update_option('woo-vipps-configured', 1, true); |
| 4308 |
return array(true,''); |
| 4309 |
} catch (Exception $e) { |
| 4310 |
$msg = $e->getMessage(); |
| 4311 |
if ($msg == "403 Forbidden") { |
| 4312 |
$msg= __("MSN or subscription key (or both) seem to be wrong: ", 'woo-vipps') . $msg; |
| 4313 |
} |
| 4314 |
update_option('woo-vipps-configured', 0, true); |
| 4315 |
return array(false, $msg); |
| 4316 |
} |
| 4317 |
} |
| 4318 |
|
| 4319 |
} catch (Exception $e) { |
| 4320 |
$msg = __("Your client key or secret is wrong.", 'woo-vipps'); |
| 4321 |
update_option('woo-vipps-configured', 0, true); |
| 4322 |
return array(false, $msg); |
| 4323 |
} |
| 4324 |
} |
| 4325 |
return array(false, ''); // No configuration |
| 4326 |
} |
| 4327 |
|
| 4328 |
public function log ($what,$type='info') { |
| 4329 |
$logger = function_exists('wc_get_logger') ? wc_get_logger() : false; |
| 4330 |
if ($logger) { |
| 4331 |
$context = array('source'=>'woo-vipps'); |
| 4332 |
$logger->log($type,$what,$context); |
| 4333 |
} else { |
| 4334 |
error_log("woo-vipps ($type): $what"); |
| 4335 |
} |
| 4336 |
} |
| 4337 |
|
| 4338 |
// Ensure chosen name gets used in the checkout page IOK 2018-09-12 |
| 4339 |
public function get_title() { |
| 4340 |
return apply_filters('woo_vipps_payment_method_title', $this->get_payment_method_name()); |
| 4341 |
} |
| 4342 |
|
| 4343 |
public function get_payment_method_name() { |
| 4344 |
return $this->get_option('payment_method_name'); |
| 4345 |
} |
| 4346 |
|
| 4347 |
public function payment_fields() { |
| 4348 |
// Use Billing Phone if it is required, otherwise ask for a phone IOK 2018-04-24 |
| 4349 |
// For v2 of the api, just let Vipps ask for then umber |
| 4350 |
// IOK 2019-09-12 removed dead code only used for v1 of api |
| 4351 |
// This just prints a description of the payment method. |
| 4352 |
print $this->get_option('description'); |
| 4353 |
return; |
| 4354 |
} |
| 4355 |
public function validate_fields() { |
| 4356 |
return true; |
| 4357 |
} |
| 4358 |
|
| 4359 |
|
| 4360 |
} |
| 4361 |
|
| 4362 |
|
