class-omise-payment-creditcard.php

<?php
defined( 'ABSPATH' ) or die( 'No direct script access allowed.' );

	class Omise_Payment_Creditcard extends Omise_Payment {
		const PAYMENT_ACTION_AUTHORIZE         = 'manual_capture';
		const PAYMENT_ACTION_AUTHORIZE_CAPTURE = 'auto_capture';

		public function __construct() {
			parent::__construct();

			$this->id                 = 'omise';
			$this->has_fields         = true;
			$this->method_title       = __( 'Omise Credit / Debit Card', 'omise' );
			$this->method_description = wp_kses(
				__( 'Accept payment through <strong>Credit / Debit Card</strong> via Omise payment gateway.', 'omise' ),
				array(
					'strong' => array()
				)
			);
			$this->supports           = array( 'products', 'refunds' );

			$this->init_form_fields();
			$this->init_settings();

			$this->title                = $this->get_option( 'title' );
			$this->description          = $this->get_option( 'description' );
			$this->payment_action       = $this->get_option( 'payment_action' );
			$this->restricted_countries = array( 'TH', 'JP', 'SG' );

			add_action( 'woocommerce_api_' . $this->id . '_callback', array( $this, 'callback' ) );
			add_action( 'woocommerce_update_options_payment_gateways_' . $this->id, array( $this, 'process_admin_options' ) );
			add_action( 'wp_enqueue_scripts', array( $this, 'omise_scripts' ) );
			add_action( 'woocommerce_order_action_' . $this->id . '_charge_capture', array( $this, 'process_capture' ) );
			add_action( 'woocommerce_order_action_' . $this->id . '_sync_payment', array( $this, 'sync_payment' ) );

			/** @deprecated 3.0 */
			add_action( 'woocommerce_api_wc_gateway_' . $this->id, array( $this, 'callback' ) );
		}

		/**
		 * @see WC_Settings_API::init_form_fields()
		 * @see woocommerce/includes/abstracts/abstract-wc-settings-api.php
		 */
		function init_form_fields() {
			$this->form_fields = array_merge(
				array(
					'enabled' => array(
						'title'   => __( 'Enable/Disable', 'omise' ),
						'type'    => 'checkbox',
						'label'   => __( 'Enable Omise Credit / Debit Card Payment', 'omise' ),
						'default' => 'no'
					),

					'title' => array(
						'title'       => __( 'Title', 'omise' ),
						'type'        => 'text',
						'description' => __( 'This controls the title which the user sees during checkout.', 'omise' ),
						'default'     => __( 'Credit / Debit Card', 'omise' )
					),

					'description' => array(
						'title'       => __( 'Description', 'omise' ),
						'type'        => 'textarea',
						'description' => __( 'This controls the description which the user sees during checkout.', 'omise' )
					),
				),
				array(
					'advanced' => array(
						'title'       => __( 'Advance Settings', 'omise' ),
						'type'        => 'title'
					),
					'payment_action' => array(
						'title'       => __( 'Payment action', 'omise' ),
						'type'        => 'select',
						'description' => __( 'Capture automatically during the checkout process or manually after order has been placed', 'omise' ),
						'default'     => self::PAYMENT_ACTION_AUTHORIZE_CAPTURE,
						'class'       => 'wc-enhanced-select',
						'options'     => array(
							self::PAYMENT_ACTION_AUTHORIZE_CAPTURE => __( 'Auto Capture', 'omise' ),
							self::PAYMENT_ACTION_AUTHORIZE         => __( 'Manual Capture', 'omise' )
						),
						'desc_tip'    => true
					),
					'accept_visa' => array(
						'title'       => __( 'Supported card icons', 'omise' ),
						'type'        => 'checkbox',
						'label'       => Omise_Card_Image::get_visa_image(),
						'css'         => Omise_Card_Image::get_css(),
						'default'     => Omise_Card_Image::get_visa_default_display()
					),
					'accept_mastercard' => array(
						'type'        => 'checkbox',
						'label'       => Omise_Card_Image::get_mastercard_image(),
						'css'         => Omise_Card_Image::get_css(),
						'default'     => Omise_Card_Image::get_mastercard_default_display()
					),
					'accept_jcb' => array(
						'type'        => 'checkbox',
						'label'       => Omise_Card_Image::get_jcb_image(),
						'css'         => Omise_Card_Image::get_css(),
						'default'     => Omise_Card_Image::get_jcb_default_display()
					),
					'accept_diners' => array(
						'type'        => 'checkbox',
						'label'       => Omise_Card_Image::get_diners_image(),
						'css'         => Omise_Card_Image::get_css(),
						'default'     => Omise_Card_Image::get_diners_default_display()
					),
					'accept_amex' => array(
						'type'        => 'checkbox',
						'label'       => Omise_Card_Image::get_amex_image(),
						'css'         => Omise_Card_Image::get_css(),
						'default'     => Omise_Card_Image::get_amex_default_display(),
						'description' => wp_kses(
							__( 'This only controls the icons displayed on the checkout page.<br />It is not related to card processing on Omise payment gateway.', 'omise' ),
							array( 'br' => array() )
						)
					)
				)
			);
		}

		/**
		 * @see WC_Payment_Gateway::payment_fields()
		 * @see woocommerce/includes/abstracts/abstract-wc-payment-gateway.php
		 */
		public function payment_fields() {
			parent::payment_fields();

			if ( is_user_logged_in() ) {
				$viewData['user_logged_in'] = true;

				$current_user      = wp_get_current_user();
				$omise_customer_id = $this->is_test() ? $current_user->test_omise_customer_id : $current_user->live_omise_customer_id;
				if ( ! empty( $omise_customer_id ) ) {
					try {
						$customer                  = OmiseCustomer::retrieve( $omise_customer_id );
						$viewData['existingCards'] = $customer->cards( array( 'order' => 'reverse_chronological' ) );
					} catch (Exception $e) {
						// nothing
					}
				}
			} else {
				$viewData['user_logged_in'] = false;
			}

			Omise_Util::render_view( 'templates/payment/form.php', $viewData );
		}

		/**
		 * @inheritdoc
		 */
		public function charge( $order_id, $order ) {
			$token   = isset( $_POST['omise_token'] ) ? wc_clean( $_POST['omise_token'] ) : '';
			$card_id = isset( $_POST['card_id'] ) ? wc_clean( $_POST['card_id'] ) : '';

			if ( empty( $token ) && empty( $card_id ) ) {
				throw new Exception( __( 'Please select an existing card or enter new card information.', 'omise' ) );
			}

			$user              = $order->get_user();
			$omise_customer_id = $this->is_test() ? $user->test_omise_customer_id : $user->live_omise_customer_id;

			// Saving card.
			if ( isset( $_POST['omise_save_customer_card'] ) && empty( $card_id ) ) {
				if ( empty( $token ) ) {
					throw new Exception( __( 'Unable to process the card. Please make sure that the information is correct, or contact our support team if you have any questions.', 'omise' ) );
				}

				if ( ! empty( $omise_customer_id ) ) {
					try {
						// attach a new card to customer
						$customer = OmiseCustomer::retrieve( $omise_customer_id );
						$customer->update( array(
							'card' => $token
						) );

						$cards = $customer->cards( array(
							'limit' => 1,
							'order' => 'reverse_chronological'
						) );

						$card_id = $cards['data'][0]['id'];
					} catch (Exception $e) {
						throw new Exception( $e->getMessage() );
					}
				} else {
					$description   = "WooCommerce customer " . $user->ID;
					$customer_data = array(
						"description" => $description,
						"card"        => $token
					);

					$omise_customer = OmiseCustomer::create( $customer_data );

					if ( $omise_customer['object'] == "error" ) {
						throw new Exception( $omise_customer['message'] );
					}

					$omise_customer_id = $omise_customer['id'];
					if ( $this->is_test() ) {
						update_user_meta( $user->ID, 'test_omise_customer_id', $omise_customer_id );
					} else {
						update_user_meta( $user->ID, 'live_omise_customer_id', $omise_customer_id );
					}

					if ( 0 == sizeof( $omise_customer['cards']['data'] ) ) {
						throw new Exception(
							sprintf(
								wp_kses(
									__( 'Please note that you\'ve done nothing wrong - this is likely an issue with our store.<br/><br/>Feel free to try submitting your order again, or report this problem to our support team (Your temporary order id is \'%s\')', 'omise' ),
									array(
										'br' => array()
									)
								),
								$order_id
							)
						);
					}

					$cards   = $omise_customer->cards( array( 'order' => 'reverse_chronological' ) );
					$card_id = $cards['data'][0]['id']; //use the latest card
				}
			}

			$success    = false;
			$return_uri = add_query_arg(
				array(
					'wc-api'   => 'omise_callback',
					'order_id' => $order_id
				),
				home_url()
			);
			$data    = array(
				'amount'      => Omise_Money::to_subunit( $order->get_total(), $order->get_order_currency() ),
				'currency'    => $order->get_order_currency(),
				'description' => apply_filters( 'omise_charge_params_description', 'WooCommerce Order id ' . $order_id, $order ),
				'return_uri'  => $return_uri
			);

			if ( ! empty( $omise_customer_id ) && ! empty( $card_id ) ) {
				$data['customer'] = $omise_customer_id;
				$data['card']     = $card_id;
			} else {
				$data['card'] = $token;
			}

			// Set capture status (otherwise, use API's default behaviour)
			if ( self::PAYMENT_ACTION_AUTHORIZE_CAPTURE === $this->payment_action ) {
				$data['capture'] = true;
			} else if ( self::PAYMENT_ACTION_AUTHORIZE === $this->payment_action ) {
				$data['capture'] = false;
			}
			$metadata = apply_filters( 'omise_charge_params_metadata', array(), $order );

			$data['metadata'] = array_merge( $metadata, array(
				/** override order_id as a reference for webhook handlers **/
				/** backward compatible with WooCommerce v2.x series **/
				'order_id' => version_compare( WC()->version, '3.0.0', '>=' ) ? $order->get_id() : $order->id
			) );

			return OmiseCharge::create( $data );
		}

		/**
		 * @inheritdoc
		 */
		public function result( $order_id, $order, $charge ) {
			if ( Omise_Charge::is_failed( $charge ) ) {
				return $this->payment_failed( Omise_Charge::get_error_message( $charge ) );
			}

			// If 3-D Secure feature is enabled, redirecting user out to a 3rd-party credit card authorization page.
			if ( self::STATUS_PENDING === $charge['status'] && ! $charge['authorized'] && ! $charge['paid'] && ! empty( $charge['authorize_uri'] ) ) {
				$order->add_order_note(
					sprintf(
						__( 'Omise: Processing a 3-D Secure payment, redirecting buyer to %s', 'omise' ),
						esc_url( $charge['authorize_uri'] )
					)
				);

				return array(
					'result'   => 'success',
					'redirect' => $charge['authorize_uri'],
				);
			}

			switch ( $this->payment_action ) {
				case self::PAYMENT_ACTION_AUTHORIZE:
					$success = Omise_Charge::is_authorized( $charge );
					if ( $success ) {
						$order->add_order_note(
							sprintf(
								wp_kses(
									__( 'Omise: Payment processing.<br/>An amount of %1$s %2$s has been authorized', 'omise' ),
									array( 'br' => array() )
								),
								$order->get_total(),
								$order->get_order_currency()
							)
						);
					}

					break;

				case self::PAYMENT_ACTION_AUTHORIZE_CAPTURE:
					$success = Omise_Charge::is_paid( $charge );
					if ( $success ) {
						$order->payment_complete();
						$order->add_order_note(
							sprintf(
								wp_kses(
									__( 'Omise: Payment successful.<br/>An amount of %1$s %2$s has been paid', 'omise' ),
									array( 'br' => array() )
								),
								$order->get_total(),
								$order->get_order_currency()
							)
						);
					}

					break;

				default:
					// Default behaviour is, check if it paid first.
					$success = Omise_Charge::is_paid( $charge );

					// Then, check is authorized after if the first condition is false.
					if ( ! $success )
						$success = Omise_Charge::is_authorized( $charge );

					break;
			}

			if ( ! $success ) {
				return $this->payment_failed( __( 'Note that your payment may have already been processed. Please contact our support team if you have any questions.', 'omise' ) );
			}

			// Remove cart
			WC()->cart->empty_cart();
			return array (
				'result'   => 'success',
				'redirect' => $this->get_return_url( $order )
			);
		}

		/**
		 * Capture an authorized charge.
		 *
		 * @param  WC_Order $order WooCommerce's order object
		 *
		 * @return void
		 *
		 * @see    WC_Meta_Box_Order_Actions::save( $post_id, $post )
		 * @see    woocommerce/includes/admin/meta-boxes/class-wc-meta-box-order-actions.php
		 */
		public function process_capture( $order ) {
			$this->load_order( $order );

			try {
				$charge = OmiseCharge::retrieve( $this->get_charge_id_from_order() );
				$charge->capture();

				if ( ! OmisePluginHelperCharge::isPaid( $charge ) ) {
					throw new Exception( $charge['failure_message'] );
				}

				$this->order()->add_order_note(
					sprintf(
						wp_kses(
							__( 'Omise: Payment successful (manual capture).<br/>An amount of %1$s %2$s has been paid', 'omise' ),
							array( 'br' => array() )
						),
						$this->order()->get_total(),
						$this->order()->get_order_currency()
					)
				);
				$this->order()->payment_complete();
			} catch ( Exception $e ) {
				$this->order()->add_order_note(
					sprintf(
						wp_kses(
							__( 'Omise: Payment failed (manual capture).<br/>%s', 'omise' ),
							array( 'br' => array() )
						),
						$e->getMessage()
					)
				);
			}
		}

		public function callback() {
			if ( ! isset( $_GET['order_id'] ) || ! $order = $this->load_order( $_GET['order_id'] ) ) {
				wc_add_notice(
					wp_kses(
						__( 'We cannot validate your payment result:<br/>Note that your payment might already has been processed. Please contact our support team if you have any questions.', 'omise' ),
						array( 'br' => array() )
					),
					'error'
				);

				header( 'Location: ' . WC()->cart->get_checkout_url() );
				die();
			}

			$order->add_order_note( __( 'Omise: Validating the payment result..', 'omise' ) );

			try {
				$charge = OmiseCharge::retrieve( $this->get_charge_id_from_order() );

				switch ( $this->payment_action ) {
					case self::PAYMENT_ACTION_AUTHORIZE:
						$success = Omise_Charge::is_authorized( $charge );
						if ( $success ) {
							$order->add_order_note(
								sprintf(
									wp_kses(
										__( 'Omise: Payment processing.<br/>An amount %1$s %2$s has been authorized', 'omise' ),
										array( 'br' => array() )
									),
									$order->get_total(),
									$order->get_order_currency()
								)
							);
						}

						break;

					case self::PAYMENT_ACTION_AUTHORIZE_CAPTURE:
						$success = Omise_Charge::is_paid( $charge );
						if ( $success ) {
							$order->add_order_note(
								sprintf(
									wp_kses(
										__( 'Omise: Payment successful.<br/>An amount %1$s %2$s has been paid', 'omise' ),
										array( 'br' => array() )
									),
									$order->get_total(),
									$order->get_order_currency()
								)
							);
							$order->payment_complete();
						}

						break;

					default:
						// Default behaviour is, check if it paid first.
						$success = Omise_Charge::is_paid( $charge );

						// Then, check is authorized after if the first condition is false.
						if ( ! $success )
							$success = Omise_Charge::is_authorized( $charge );

						break;
				}

				if ( ! $success ) {
					throw new Exception( Omise_Charge::get_error_message( $charge ) );
				}

				// Remove cart
				WC()->cart->empty_cart();
				header( 'Location: ' . $this->get_return_url( $order ) );
				die();
			} catch ( Exception $e ) {
				wc_add_notice(
					sprintf(
						wp_kses(
							__( 'Seems we cannot process your payment properly:<br/>%s', 'omise' ),
							array( 'br' => array() )
						),
						$e->getMessage()
					),
					'error'
				);

				$order->add_order_note(
					sprintf(
						wp_kses(
							__( 'Omise: Payment failed.<br/>%s', 'omise' ),
							array( 'br' => array() )
						),
						$e->getMessage()
					)
				);

				header( 'Location: ' . WC()->cart->get_checkout_url() );
				die();
			}

			wp_die( 'Access denied', 'Access Denied', array( 'response' => 401 ) );
			die();
		}

		/**
		 * Get icons of all supported card types
		 *
		 * @see WC_Payment_Gateway::get_icon()
		 */
		public function get_icon() {
			$icon = '';

			// TODO: Refactor 'Omise_Card_Image' class that we don't need to pass
			//       these options to check outside this class.
			$card_icons['accept_amex']       = $this->get_option( 'accept_amex' );
			$card_icons['accept_diners']     = $this->get_option( 'accept_diners' );
			$card_icons['accept_jcb']        = $this->get_option( 'accept_jcb' );
			$card_icons['accept_mastercard'] = $this->get_option( 'accept_mastercard' );
			$card_icons['accept_visa']       = $this->get_option( 'accept_visa' );

			if ( Omise_Card_Image::is_visa_enabled( $card_icons ) ) {
				$icon .= Omise_Card_Image::get_visa_image();
			}

			if ( Omise_Card_Image::is_mastercard_enabled( $card_icons ) ) {
				$icon .= Omise_Card_Image::get_mastercard_image();
			}

			if ( Omise_Card_Image::is_jcb_enabled( $card_icons ) ) {
				$icon .= Omise_Card_Image::get_jcb_image();
			}

			if ( Omise_Card_Image::is_diners_enabled( $card_icons ) ) {
				$icon .= Omise_Card_Image::get_diners_image();
			}

			if ( Omise_Card_Image::is_amex_enabled( $card_icons ) ) {
				$icon .= Omise_Card_Image::get_amex_image();
			}

			return empty( $icon ) ? '' : apply_filters( 'woocommerce_gateway_icon', $icon, $this->id );
		}

		/**
		 * Register all required javascripts
		 */
		public function omise_scripts() {
			if ( is_checkout() && $this->is_available() ) {
				wp_enqueue_script( 'omise-js', 'https://cdn.omise.co/omise.js', array( 'jquery' ), OMISE_WOOCOMMERCE_PLUGIN_VERSION, true );
				wp_enqueue_script( 'omise-payment-form-handler', plugins_url( '../../assets/javascripts/omise-payment-form-handler.js', __FILE__ ), array( 'omise-js' ), OMISE_WOOCOMMERCE_PLUGIN_VERSION, true );

				$omise_params = array(
					'key'                            => $this->public_key(),
					'required_card_name'             => __( 'Cardholder\'s name is a required field', 'omise' ),
					'required_card_number'           => __( 'Card number is a required field', 'omise' ),
					'required_card_expiration_month' => __( 'Card expiry month is a required field', 'omise' ),
					'required_card_expiration_year'  => __( 'Card expiry year is a required field', 'omise' ),
					'required_card_security_code'    => __( 'Card security code is a required field', 'omise' ),
					'invalid_card'                   => __( 'Invalid card.', 'omise' ),
					'no_card_selected'               => __( 'Please select a card or enter a new one.', 'omise' ),
					'cannot_create_token'            => __( 'Unable to proceed to the payment.', 'omise' ),
					'cannot_connect_api'             => __( 'Currently, the payment provider server is undergoing maintenance.', 'omise' ),
					'retry_checkout'                 => __( 'Please place your order again in a couple of seconds.', 'omise' ),
					'cannot_load_omisejs'            => __( 'Cannot connect to the payment provider.', 'omise' ),
					'check_internet_connection'      => __( 'Please make sure that your internet connection is stable.', 'omise' ),
				);

				wp_localize_script( 'omise-payment-form-handler', 'omise_params', $omise_params );
			}
		}
	}