class-wc-gateway-stcpay.php

<?php
/**
 * WooCommerce Stcpay Payment Gateway.
 *
 * @class       WC_Gateway_Stcpay
 * @extends     WC_Payment_Gateway
**/
class WC_Gateway_Stcpay extends WC_Payment_Gateway {
	protected $api_handler;

	/**
	 * Constructor
	 */
	public function __construct() {
		// Setup general properties.
		$this->setup_properties();

		// Load the form fields.
		$this->init_form_fields();
		$this->init_settings();

		// Get settings.
		$this->title         = $this->get_option( 'title' );
		$this->description   = $this->get_option( 'description' );

		// Display a message if staging environment is used.
		if ( 'staging' == $this->get_option( 'environment' ) ) {
			$this->description .= '<p style="color:red; font-size: 18px; margin: 20px 0 10px;">';
			$this->description .= __( 'TEST MODE', 'woocommerce-gateway-stcpay' );
			$this->description .= '</p>';
			$this->description .= '<p style="padding: 10px; border: 1px solid red; font-size: 12px; line-height: 18px;">';
			$this->description .= __( 'Use 966539342897 as mobile number.', 'woocommerce-gateway-stcpay' );
			$this->description .= '<br/>' . __( 'No OTP will be sent through SMS, use any value for OTP.', 'woocommerce-gateway-stcpay' );
			#$this->description .= '<br/>' . __( 'Use 4444 as OTP to test wrong otp output.', 'woocommerce-gateway-stcpay' );
			$this->description .= '</p>';
			$this->description  = trim( $this->description );
		}

		$this->api_handler = new WC_Stcpay_Api_Handler();

		add_action( 'woocommerce_update_options_payment_gateways_'. $this->id, array( $this, 'process_admin_options' ) );
		add_action( 'wp_footer', array( $this, 'render_otp_form' ) );
		add_action( 'wp_enqueue_scripts', array( $this, 'payment_scripts' ) );
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_scripts' ) );

		if ( ! $this->is_available() ) {
			$this->enabled = 'no';
		}
	}

	/**
	 * Setup general properties for the gateway.
	 */
	protected function setup_properties() {
		$this->id                 = 'stcpay';
		$this->has_fields         = true;
		$this->order_button_text  = __( 'Pay with Stcpay', 'woocommerce-gateway-stcpay' );
		$this->method_title       = __( 'Stcpay', 'woocommerce-gateway-stcpay');
		$this->method_description = __( 'Stcpay payment gateway for WooCommerce.', 'woocommerce-gateway-stcpay' );
		$this->supports           = array( 'products' );
		$this->icon               = WC_STCPAY_URL . '/assets/images/stcpay-logo.png';
	}

	/**
	 * Check if the payment gateway is available to be used.
	 *
	 */
	public function is_available() {
		$client = new WC_Stcpay_Client();
		if ( ! $client->is_available() ) {
			return false;
		}

		return parent::is_available();
	}

	/**
	 * Return whether or not this gateway still requires setup to function.
	 *
	 * @return bool
	 */
	public function needs_setup() {
		$client = new WC_Stcpay_Client();
		return ! $client->is_available();
	}

	/**
	 * Process payment
	 *
	 * @param  $order_id Order id.
	 * @return bool|array
	 */
	public function process_payment( $order_id ) {
		if ( get_post_meta( $order_id, 'stcpay_otp_verified', 1 ) ) {
			return $this->complete_payment( $order_id );
		} elseif ( WC()->checkout->get_value( 'stcpay_otp_value' ) ) {
			return $this->confirm_payment( $order_id );
		} else {
			return $this->request_payment( $order_id );
		}
	}

	/**
	 * Complete order payment.
	 *
	 * @param  int $order_id Order id
	 * @return bool|array
	 */
	public function complete_payment( $order_id ) {
		if ( ! get_post_meta( $order_id, 'stcpay_otp_verified', 1 ) ) {
			wc_add_notice( __( 'Verify OTP first to complete payment.', 'woocommerce-gateway-stcpay' ), 'error' );
			return false;
		}

		$order  = wc_get_order( $order_id );
		$client = new WC_Stcpay_Client();

		$payment = $client->get_payment( $order->get_order_key() );
		wc_stcpay()->log( print_r( $payment, true ) );

		if ( is_wp_error( $payment ) ) {
			wc_stcpay()->log(
				sprintf(
					/* translators: %s: Error message. */
					__( 'Stcpay API Error: %s', 'woocommerce-gateway-stcpay' ),
					$payment->get_error_message()
				)
			);

			$error = $payment->get_error_message();

			if ( ! in_array( $payment->get_error_code(), array( 'api_error', 'customer_error', 'internal_error', 'stcpay_error' ) ) ) {
				$error = __( 'Could not process your request. Please try later, or use other payment gateway.', 'woocommerce-gateway-stcpay' );
			}

			return array(
				'result'        => 'failure',
				'messages'      => '<div class="woocommerce-error">' . $error . '</div>',
				'redirect'      => $this->get_return_url( $order ),
			);
		}

		if ( 'Pending' === $payment['PaymentStatusDesc'] ) {
			$this->api_handler->stcpay_status_pending( $order, $payment );
		} elseif ( 'Paid' === $payment['PaymentStatusDesc'] ) {
			$this->api_handler->stcpay_status_paid( $order, $payment );
		} elseif ( 'Cancelled' === $payment['PaymentStatusDesc'] ) {
			$this->api_handler->stcpay_status_cancelled( $order, $payment );
		} elseif ( 'Expired' === $payment['PaymentStatusDesc'] ) {
			$this->api_handler->stcpay_status_failed( $order, $payment );
		} else {
			return array(
				'result'        => 'failure',
				'messages'      => '<div class="woocommerce-error">' . __( 'Unknown status received from stcpay' ) . '</div>',
				'redirect'      => $this->get_return_url( $order ),
			);
		}

		return array(
			'result'        => 'success',
			'messages'      => '<div class="woocommerce-info">' . __( 'Payment Completed.', 'woocommerce-gateway-stcpay' ) . '</div>',
			'redirect'      => $order->get_checkout_order_received_url(),
		);
	}

	private function clear_stcpay_otp_session() {
		WC()->session->__unset( 'stcpay_otp_expires' );
		WC()->session->__unset( 'stcpay_otp_reference' );
		WC()->session->__unset( 'stcpay_payment_reference' );
	}

	public function confirm_payment( $order_id ) {
		$order  = wc_get_order( $order_id );
		$client = new WC_Stcpay_Client();

		wc_stcpay()->log( 'Stcpay confirming payment with OTP - '. WC()->checkout->get_value( 'stcpay_otp_value' ) );

		$error = '';
		if ( ! WC()->session->get( 'stcpay_otp_expires' ) || WC()->session->get( 'stcpay_otp_expires' ) < time() ) {
			$error = __( 'Internal Error: OTP expired.' );
		} elseif ( ! WC()->session->get( 'stcpay_otp_reference' ) ) {
			$error = __( 'Internal Error: Missing otp reference.' );
		} elseif ( ! WC()->session->get( 'stcpay_payment_reference' ) ) {
			$error = __( 'Internal Error: Missing payment reference.' );
		}

		if ( ! empty( $error ) ) {
			$this->clear_stcpay_otp_session();

			return array(
				'result'        => 'success',
				'messages'      => '<div class="woocommerce-error">' . __( 'OTP expired, Request again.', 'woocommerce-gateway-stcpay' ) . '</div>',
				'stcpay_action' => 'request_payment',
				'redirect'      => $this->get_return_url( $order ),
			);
		}

		$confirm_payment = $client->confirm_payment(
			WC()->checkout->get_value( 'stcpay_otp_value' ),
			WC()->session->get( 'stcpay_otp_reference' ),
			WC()->session->get( 'stcpay_payment_reference' )
		);

		if ( is_wp_error( $confirm_payment ) ) {
			wc_stcpay()->log(
				sprintf(
					/* translators: %s: Error message. */
					__( 'Stcpay API Error: %s', 'woocommerce-gateway-stcpay' ),
					$confirm_payment->get_error_message()
				)
			);

			$error = $confirm_payment->get_error_message();

			if ( ! in_array( $confirm_payment->get_error_code(), array( 'api_error', 'customer_error', 'internal_error', 'stcpay_error' ) ) ) {
				$error = __( 'Could not process your request. Please try later, or use other payment gateway.', 'woocommerce-gateway-stcpay' );
			}

			return array(
				'result'        => 'success',
				'messages'      => '<div class="woocommerce-error">' . $error . '</div>',
				'stcpay_action' => 'confirm_payment',
				'redirect'      => $this->get_return_url( $order ),
			);
		}

		// Remove cart.
		WC()->cart->empty_cart();

		$order->add_order_note( __( 'Stcpay OTP Verified', 'woocommerce-gateway-stcpay' ) );

		update_post_meta( $order->get_id(), 'stcpay_otp_verified', time() );


		if ( 'Pending' === $confirm_payment['PaymentStatusDesc'] ) {
			$this->api_handler->stcpay_status_pending( $order, $confirm_payment );
		} elseif ( 'Paid' === $confirm_payment['PaymentStatusDesc'] ) {
			$this->api_handler->stcpay_status_paid( $order, $confirm_payment );
		} elseif ( 'Cancelled' === $confirm_payment['PaymentStatusDesc'] ) {
			$this->api_handler->stcpay_status_cancelled( $order, $confirm_payment );
		} elseif ( 'Expired' === $payment['PaymentStatusDesc'] ) {
			$this->api_handler->stcpay_status_failed( $order, $confirm_payment );
		} else {
			return array(
				'result'        => 'failure',
				'messages'      => '<div class="woocommerce-error">' . __( 'Unknown status received from stcpay' ) . '</div>',
				'redirect'      => $this->get_return_url( $order ),
			);
		}

		return array(
			'result'        => 'success',
			'messages'      => '<div class="woocommerce-info">' . __( 'OTP Confirmed. Redirecting...', 'woocommerce-gateway-stcpay' ) . '</div>',
			'stcpay_action' => 'payment_confirmed',
			'redirect'      => $this->get_return_url( $order ),
		);
	}

	public function request_payment( $order_id ) {
		if ( empty( $_POST['stcpay_mobile_no'] ) ) {
			wc_add_notice( __( 'Please enter your stcpay wallet mobile number', 'woocommerce-gateway-stcpay' ), 'error' );
			return false;
		}

		$order  = wc_get_order( $order_id );
		$client = new WC_Stcpay_Client();

		wc_stcpay()->log(
			sprintf(
				/* translators: %d: Order id, numeric. */
				__( 'Stcpay requesting payment for order # %d', 'woocommerce-gateway-stcpay' ),
				$order_id
			)
		);

		$mobile_no = wp_unslash( $_POST['stcpay_mobile_no'] );

		// store mobile number in user meta & session.
		WC()->session->set( 'stcpay_mobile_no', $mobile_no );
		if ( is_user_logged_in() ) {
			update_user_meta( get_current_user_id(), 'stcpay_mobile_no', $mobile_no );
		}

		$request_payment = $client->request_payment( $order, WC()->checkout->get_value( 'stcpay_mobile_no' ) );

		if ( is_wp_error( $request_payment ) ) {
			wc_stcpay()->log(
				sprintf(
					/* translators: %s: Error message. */
					__( 'Stcpay API Error: %s' ),
					$request_payment->get_error_message()
				)
			);

			if ( $request_payment->get_error_data() ) {
				wc_stcpay()->log( print_r( $request_payment->get_error_data(), true ) );
			}

			if ( ! in_array( $request_payment->get_error_code(), array( 'api_error', 'customer_error', 'internal_error', 'stcpay_error' ) ) ) {
				wc_add_notice( __( 'Could not process your request. Please try later, or use other payment gateway.', 'woocommerce-gateway-stcpay' ), 'error' );
			} else {
				wc_add_notice( $request_payment->get_error_message(), 'error' );
			}

			return false;
		}

		$order->add_order_note(
			sprintf(
				/* translators: %1$s: Payment reference. %2$s: OTP reference */
				__( 'Stcpay OTP Requested <br/>Payment Reference: %1$s <br/>OTP Reference: %2$s', 'woocommerce-gateway-stcpay' ),
				wc_clean( $request_payment['STCPayPmtReference'] ),
				wc_clean( $request_payment['OtpReference'] )
			)
		);

		WC()->session->set( 'stcpay_otp_expires', time() + $request_payment['ExpiryDuration'] );
		WC()->session->set( 'stcpay_otp_reference', $request_payment['OtpReference'] );
		WC()->session->set( 'stcpay_payment_reference', $request_payment['STCPayPmtReference'] );

		return array(
			'result'        => 'success',
			'messages'      => '<div class="woocommerce-info">' . __( 'Enter OTP to confirm order', 'woocommerce-gateway-stcpay' ) . '</div>',
			'stcpay_action' => 'confirm_payment',
			'otpExpires' 	=> time() + $request_payment['ExpiryDuration'],
			'redirect'      => $this->get_return_url( $order ),
		);
	}

	public function validate_fields() {
		if ( empty( $_POST['stcpay_mobile_no'] ) ) {
			wc_add_notice( __( 'Please enter your stcpay wallet mobile number', 'woocommerce-gateway-stcpay' ), 'error' );
		}
	}

	public function payment_fields() {
		$description = $this->get_description();
		if ( $description ) {
			echo wpautop( wptexturize( $description ) );
		}

		$mobile_no = '';
		if ( is_user_logged_in() ) {
			$mobile_no = get_user_meta( get_current_user_id(), 'stcpay_mobile_no', true );
		}
		if ( ! $mobile_no ) {
			$mobile_no = WC()->session->get( 'stcpay_mobile_no' );
		}

		?>
		<fieldset id="wc-stcpay-form" class="wc-payment-form">
			<p class="form-row field-stcpay-mobile-no">
				<label for="stcpay-mobile-no"><?php _e( 'Stcpay Wallet Mobile Number', 'woocommerce-gateway-stcpay' ); ?>&nbsp;<span class="required">*</span></label>
				<input id="stcpay-mobile-no" value="<?php echo esc_attr( $mobile_no ); ?>" class="input-text" autocorrect="no" autocapitalize="no" spellcheck="no" type="text" name="stcpay_mobile_no" required />
				<span class="field-notice"></span>
			</p>
			<input type="hidden" id="stcpay-otp-value" name="stcpay_otp_value" value="" />
			<input type="hidden" id="stcpay-action" name="stcpay_action" value="request_payment" />
			<div class="clear"></div>
		</fieldset>
		<?php
	}

	/**
	 * Intialize form fields
	 *
	 */
	public function init_form_fields() {
		$this->form_fields = include WC_STCPAY_DIR . 'includes/settings-stcpay.php';
	}

	/**
	 * Payment_scripts function.
	 *
	 * Outputs styles/scripts used for stcpay payment
	 *
	 */
	public function payment_scripts() {
		if ( ! is_cart() && ! is_checkout() && ! isset( $_GET['pay_for_order'] ) ) {
			return;
		}

		// If Stcpay is not available, bail.
		if ( ! $this->is_available() ) {
			return;
		}

		wp_register_script(
			'stcpay-checkout',
			WC_STCPAY_URL . 'assets/js/checkout.js',
			array( 'jquery' ),
			WC_STCPAY_VERSION,
			true
		);
		wp_register_style(
			'stcpay-frontend',
			WC_STCPAY_URL . '/assets/css/frontend.css',
			array(),
			WC_STCPAY_VERSION
		);

		wp_localize_script(
			'stcpay-checkout',
			'stcpay',
			array(
				'ajaxUrl'          => admin_url( 'admin-ajax.php' ),
				'orderKey'         => isset( $_GET['key'] ) ? wp_unslash( $_GET['key'] ) : '',
				'textOtpExpired'   => __( 'OTP Expired, Please request a new OTP', 'woocommerce-gateway-stcpay' ),
				'textOtpExpiresIn' => sprintf(
					/* translators: %s: Numeric seconds. */
					__( 'OTP expires in %s seconds', 'woocommerce-gateway-stcpay' ),
					'{expires}'
				),
				'textEnterWalletNumber' => __( 'Enter Wallet Mobile No', 'woocommerce-gateway-stcpay' )
			)
		);

		wp_enqueue_script( 'stcpay-checkout' );
		wp_enqueue_style( 'stcpay-frontend' );
	}

	/**
	 * Load admin scripts.
	 *
	 */
	public function admin_scripts() {
		$screen    = get_current_screen();
		$screen_id = $screen ? $screen->id : '';

		if ( 'woocommerce_page_wc-settings' !== $screen_id ) {
			return;
		}

		wp_enqueue_script(
			'woocommerce_stcpay_admin',
			WC_STCPAY_URL . '/assets/js/settings.js',
			array( 'jquery' ),
			WC_STCPAY_VERSION,
			true
		);
	}

	public function render_otp_form() {
		if ( ! is_cart() && ! is_checkout() && ! isset( $_GET['pay_for_order'] ) ) {
			return;
		}

		$available_gateways = WC()->payment_gateways()->get_available_payment_gateways();
		if ( ! isset( $available_gateways['stcpay'] ) ) {
			return;
		}

		?>
		<div id="stcpay-otp-modal" class="stcpay-modal">
			<div class="modal-wrap">
				<div class="modal-inner">
					<p class="logo-wrap"><img src="<?php echo  WC_STCPAY_URL . '/assets/images/stcpay-logo.png'; ?>" /></p>
					<div class="modal-notice"></div>

					<div class="otp-confirmation-form">
						<div class="form-heading"><?php esc_html_e( 'Please enter the OTP you have received from STC Pay', 'woocommerce-gateway-stcpay' ); ?></div>
						<input id="stcpay-modal-otp-value" type="text" />
						<div class="form-notice"></div>
						<div class="form-actions">
							<button class="confirm-otp-btn" type="button" data-text="<?php esc_attr_e( 'Verify OTP', 'woocommerce-gateway-stcpay' ); ?>" data-loading="<?php esc_attr_e( 'Verifying', 'woocommerce-gateway-stcpay' ); ?>"><?php esc_html_e( 'Verify OTP', 'woocommerce-gateway-stcpay' ); ?></button>
							<button class="modal-close-btn" type="button"><?php esc_html_e( 'Cancel', 'woocommerce-gateway-stcpay' ); ?></button>
						</div>
					</div>

					<div class="otp-request-form" style="display:none;">
						<div class="form-heading"><?php _e( 'Request new OTP.', 'woocommerce-gateway-stcpay' ); ?></div>
						<div class="form-notice"></div>
						<div class="form-actions">
							<button class="request-otp-btn" type="button" title="<?php esc_attr_e( 'Request OTP to confirm payments', 'woocommerce-gateway-stcpay' ); ?>" data-text="<?php esc_attr_e( 'Request OTP', 'woocommerce-gateway-stcpay' ); ?>" data-loading="<?php esc_attr_e( 'Requesting', 'woocommerce-gateway-stcpay' ); ?>"><?php esc_html_e( 'Request OTP', 'woocommerce-gateway-stcpay' ); ?></button>
							<button class="modal-close-btn" type="button" title="<?php esc_attr_e( 'Cancel', 'woocommerce-gateway-stcpay' ); ?>"><?php esc_html_e( 'Cancel', 'woocommerce-gateway-stcpay' ); ?></button>
						</div>
					</div>
				</div>
			</div>
		</div>
		<?php
	}
}