wp-pay-gateways / buckaroo

src/Client.php

<?php

namespace Pronamic\WordPress\Pay\Gateways\Buckaroo;

/**
 * Title: Buckaroo client
 * Description:
 * Copyright: 2005-2019 Pronamic
 * Company: Pronamic
 *
 * @author Remco Tolsma
 * @version 2.0.0
 * @since 1.0.0
 */
class Client {
	/**
	 * Gateway URL
	 *
	 * @var string
	 */
	const GATEWAY_URL = 'https://checkout.buckaroo.nl/html/';

	/**
	 * Gateway test URL
	 *
	 * @var string
	 */
	const GATEWAY_TEST_URL = 'https://testcheckout.buckaroo.nl/html/';

	/**
	 * Gateway Name-Value-Pair URL
	 *
	 * @var string
	 */
	const GATEWAY_NVP_URL = 'https://checkout.buckaroo.nl/nvp/';

	/**
	 * Gateway Name-Value-Pair test URL
	 *
	 * @var string
	 */
	const GATEWAY_NVP_TEST_URL = 'https://testcheckout.buckaroo.nl/nvp/';

	/**
	 * Indicator for the iDEAL payment method
	 *
	 * @var string
	 */
	const PAYMENT_METHOD_IDEAL = 'ideal';

	/**
	 * The payment server URL
	 *
	 * @var string
	 */
	private $payment_server_url;

	/**
	 * The amount
	 *
	 * @var int
	 */
	private $amount;

	/**
	 * The website key
	 *
	 * @var string
	 */
	private $website_key;

	/**
	 * The secret key
	 *
	 * @var string
	 */
	private $secret_key;

	/**
	 * The payment method
	 *
	 * @var string
	 */
	private $payment_method;

	/**
	 * The iDEAL issuer
	 *
	 * @since 1.2.4
	 * @var string
	 */
	private $ideal_issuer;

	/**
	 * The country code (culture)
	 *
	 * @var string
	 */
	private $culture;

	/**
	 * The currency
	 *
	 * @var string
	 */
	private $currency;

	/**
	 * The invoice number
	 *
	 * @var string
	 */
	private $invoice_number;

	/**
	 * The description
	 *
	 * @var string
	 */
	private $description;

	/**
	 * The return url
	 *
	 * @var string
	 */
	private $return_url;

	/**
	 * The return reject url
	 *
	 * @var string
	 */
	private $return_reject_url;

	/**
	 * The return error url
	 *
	 * @var string
	 */
	private $return_error_url;

	/**
	 * The return cancel url
	 *
	 * @var string
	 */
	private $return_cancel_url;

	/**
	 * Push URL
	 *
	 * @var string
	 */
	private $push_url;

	/**
	 * Requested services
	 *
	 * @var array
	 */
	private $requested_services;

	/**
	 * Excluded services
	 *
	 * @var array
	 */
	private $excluded_services;

	/**
	 * Pronamic payment ID
	 *
	 * @var array
	 */
	private $payment_id;

	/**
	 * Constructs and initialize a iDEAL kassa object
	 */
	public function __construct() {
		$this->set_payment_server_url( self::GATEWAY_URL );

		$this->requested_services = array();
	}

	/**
	 * Get the payment server URL
	 *
	 * @return string the payment server URL
	 */
	public function get_payment_server_url() {
		return $this->payment_server_url;
	}

	/**
	 * Set the payment server URL
	 *
	 * @param string $url an URL
	 */
	public function set_payment_server_url( $url ) {
		$this->payment_server_url = $url;
	}

	public function get_website_key() {
		return $this->website_key;
	}

	public function set_website_key( $website_key ) {
		$this->website_key = $website_key;
	}

	public function get_secret_key() {
		return $this->secret_key;
	}

	public function set_secret_key( $secret_key ) {
		$this->secret_key = $secret_key;
	}

	public function get_payment_method() {
		return $this->payment_method;
	}

	public function set_payment_method( $payment_method ) {
		$this->payment_method = $payment_method;
	}

	/**
	 * Get iDEAL issuer.
	 *
	 * @since 1.2.4
	 * @return string
	 */
	public function get_ideal_issuer() {
		return $this->ideal_issuer;
	}

	/**
	 * Set iDEAL issuer.
	 *
	 * @since 1.2.4
	 *
	 * @param string $issuer
	 */
	public function set_ideal_issuer( $issuer ) {
		$this->ideal_issuer = $issuer;
	}

	public function get_requested_services() {
		return $this->requested_services;
	}

	public function add_requested_service( $service ) {
		$this->requested_services[] = $service;
	}

	public function get_excluded_services() {
		return $this->excluded_services;
	}

	public function set_excluded_services( $service ) {
		$this->excluded_services = $service;
	}

	public function get_culture() {
		return $this->culture;
	}

	public function set_culture( $culture ) {
		$this->culture = $culture;
	}

	public function get_currency() {
		return $this->currency;
	}

	public function set_currency( $currency ) {
		$this->currency = $currency;
	}

	public function get_invoice_number() {
		return $this->invoice_number;
	}

	public function set_invoice_number( $invoice_number ) {
		$this->invoice_number = $invoice_number;
	}

	public function get_description() {
		return $this->description;
	}

	public function set_description( $description ) {
		$this->description = $description;
	}

	/**
	 * Get amount.
	 *
	 * @return int
	 */
	public function get_amount() {
		return $this->amount;
	}

	/**
	 * Set amount.
	 *
	 * @param int $amount Amount.
	 */
	public function set_amount( $amount ) {
		$this->amount = $amount;
	}

	/**
	 * Get return URL
	 *
	 * @return string
	 */
	public function get_return_url() {
		return $this->return_url;
	}

	/**
	 * Set return URL
	 *
	 * @param string $url Return URL.
	 */
	public function set_return_url( $url ) {
		$this->return_url = $url;
	}

	/**
	 * Get return reject URL
	 *
	 * @return string
	 */
	public function get_return_reject_url() {
		return $this->return_reject_url;
	}

	/**
	 * Set return reject URL
	 *
	 * @param string $url Return reject URL.
	 */
	public function set_return_reject_url( $url ) {
		$this->return_reject_url = $url;
	}

	/**
	 * Get return error URL
	 *
	 * @return string
	 */
	public function get_return_error_url() {
		return $this->return_error_url;
	}

	/**
	 * Set return error URL
	 *
	 * @param string $url Return error URL.
	 */
	public function set_return_error_url( $url ) {
		$this->return_error_url = $url;
	}

	/**
	 * Get return cancel URL
	 *
	 * @return string
	 */
	public function get_return_cancel_url() {
		return $this->return_cancel_url;
	}

	/**
	 * Set return cancel URL
	 *
	 * @param string $url Return cancel URL.
	 */
	public function set_return_cancel_url( $url ) {
		$this->return_cancel_url = $url;
	}

	/**
	 * Get push URL
	 *
	 * @return string
	 */
	public function get_push_url() {
		return $this->push_url;
	}

	/**
	 * Set push URL
	 *
	 * @param string $url Push URL.
	 */
	public function set_push_url( $url ) {
		$this->push_url = $url;
	}

	/**
	 * Get Pronamic payment ID
	 *
	 * @return string
	 */
	public function get_payment_id() {
		return $this->payment_id;

The expression return $this->payment_id returns the type array which is incompatible with the documented return type string.

	}

	/**
	 * Set Pronamic payment ID
	 *
	 * @param string $payment_id Payment ID.
	 */
	public function set_payment_id( $payment_id ) {
		$this->payment_id = $payment_id;

It seems like $payment_id of type string is incompatible with the declared type array of property $payment_id.

	}

	/**
	 * Get issuers
	 *
	 * @since 1.2.4
	 * @link http://support.buckaroo.nl/index.php/Service_iDEAL#iDEAL_banken_lijst_opvragen
	 * @return array
	 */
	public function get_issuers() {
		$issuers = array();

		$url = add_query_arg( 'op', 'TransactionRequestSpecification', self::GATEWAY_NVP_TEST_URL );

		$data = array(
			'brq_websitekey'        => $this->get_website_key(),
			'brq_services'          => 'ideal',
			'brq_latestversiononly' => 'True',
		);

		$signature = Security::create_signature( $data, $this->get_secret_key() );

		$data[ Parameters::SIGNATURE ] = $signature;

		$result = wp_remote_post(
			$url,
			array(
				'body' => http_build_query( $data ),
			)
		);

		$body = wp_remote_retrieve_body( $result );

It seems like $result can also be of type WP_Error; however, parameter $response of wp_remote_retrieve_body() does only seem to accept array, maybe add an additional type check?

		wp_parse_str( $body, $data );

		$data = Util::transform_flat_response( $data );

		$error_msg = __( 'Unable to retrieve issuers from Buckaroo.', 'pronamic_ideal' );

		if ( 200 !== wp_remote_retrieve_response_code( $result ) ) {

It seems like $result can also be of type WP_Error; however, parameter $response of wp_remote_retrieve_response_code() does only seem to accept array, maybe add an additional type check?

			throw new \Pronamic\WordPress\Pay\GatewayException( 'buckaroo', $error_msg, $data );

The type Pronamic\WordPress\Pay\GatewayException was not found. Maybe you did not declare it correctly or list all dependencies?

		}

		if ( isset( $data['BRQ_APIRESULT'] ) && 'Fail' === $data['BRQ_APIRESULT'] ) {
			if ( isset( $data['BRQ_APIERRORMESSAGE'] ) ) {
				$error_msg = sprintf( '%s %s', $error_msg, $data['BRQ_APIERRORMESSAGE'] );
			}

			throw new \Pronamic\WordPress\Pay\GatewayException( 'buckaroo', $error_msg, $data );
		}

		if ( ! isset( $data['BRQ_SERVICES'] ) ) {
			return $issuers;
		}

		foreach ( $data['BRQ_SERVICES'] as $service ) {
			if ( ! isset( $service['NAME'], $service['VERSION'], $service['ACTIONDESCRIPTION'] ) ) {
				return $issuers;
			}

			if ( PaymentMethods::IDEAL !== $service['NAME'] ) {
				continue;
			}

			foreach ( $service['ACTIONDESCRIPTION'] as $action ) {
				if ( ! isset( $action['NAME'], $action['REQUESTPARAMETERS'] ) ) {
					return $issuers;
				}

				if ( 'Pay' !== $action['NAME'] ) {
					continue;
				}

				foreach ( $action['REQUESTPARAMETERS'] as $parameter ) {

					if ( ! isset( $parameter['NAME'], $parameter['LISTITEMDESCRIPTION'] ) ) {
						return $issuers;
					}

					if ( 'issuer' !== $parameter['NAME'] ) {
						continue;
					}

					foreach ( $parameter['LISTITEMDESCRIPTION'] as $issuer ) {
						$issuers[ $issuer['VALUE'] ] = $issuer['DESCRIPTION'];
					}

					break;
				}
			}
		}

		return $issuers;
	}

	/**
	 * Get HTML fields
	 *
	 * @since 1.1.1
	 * @return string
	 */
	public function get_fields() {
		$data = array(
			Parameters::ADD_PRONAMIC_PAYMENT_ID => $this->get_payment_id(),
			Parameters::WEBSITE_KEY             => $this->get_website_key(),
			Parameters::INVOICE_NUMBER          => $this->get_invoice_number(),
			Parameters::AMOUNT                  => number_format( $this->get_amount(), 2, '.', '' ),
			Parameters::CURRENCY                => $this->get_currency(),
			Parameters::CULTURE                 => $this->get_culture(),
			Parameters::DESCRIPTION             => $this->get_description(),
			Parameters::PAYMENT_METHOD          => $this->get_payment_method(),
			Parameters::RETURN_URL              => $this->get_return_url(),
			Parameters::RETURN_REJECT_URL       => $this->get_return_reject_url(),
			Parameters::RETURN_ERROR_URL        => $this->get_return_error_url(),
			Parameters::RETURN_CANCEL_URL       => $this->get_return_cancel_url(),
			Parameters::PUSH_URL                => $this->get_push_url(),
			Parameters::PUSH_FAILURE_URL        => $this->get_push_url(),
			Parameters::REQUESTED_SERVICES      => implode( ',', $this->get_requested_services() ),
			Parameters::EXCLUDED_SERVICES       => $this->get_excluded_services(),
			Parameters::IDEAL_ISSUER            => $this->get_ideal_issuer(),
		);

		$signature = Security::create_signature( $data, $this->get_secret_key() );

		$data[ Parameters::SIGNATURE ] = $signature;

		return $data;

The expression return $data returns the type array<string,array|string> which is incompatible with the documented return type string.

	}

	/**
	 * Verify request Buckaroo
	 */
	public function verify_request( $data ) {
		$result = false;

		$signature = Security::get_signature( $data );

Are you sure the assignment to $signature is correct as Pronamic\WordPress\Pay\Gateways\Buckaroo\Security::get_signature($data) targeting Pronamic\WordPress\Pay\Gateways\Buckaroo\Security::get_signature() seems to always return null.

		$signature_check = Security::create_signature( $data, $this->get_secret_key() );

		if ( 0 === strcasecmp( $signature, $signature_check ) ) {
			$data = array_change_key_case( $data, CASE_LOWER );

			$result = filter_var_array(
				$data,
				array(
					Parameters::ADD_PRONAMIC_PAYMENT_ID    => FILTER_SANITIZE_STRING,
					Parameters::PAYMENT                    => FILTER_SANITIZE_STRING,
					Parameters::PAYMENT_METHOD             => FILTER_SANITIZE_STRING,
					Parameters::STATUS_CODE                => FILTER_VALIDATE_INT,
					Parameters::STATUS_CODE_DETAIL         => FILTER_SANITIZE_STRING,
					Parameters::STATUS_MESSAGE             => FILTER_SANITIZE_STRING,
					Parameters::INVOICE_NUMBER             => FILTER_SANITIZE_STRING,
					Parameters::AMOUNT                     => FILTER_VALIDATE_FLOAT,
					Parameters::CURRENCY                   => FILTER_SANITIZE_STRING,
					Parameters::TIMESTAMP                  => FILTER_SANITIZE_STRING,
					Parameters::SERVICE_IDEAL_CONSUMER_ISSUER => FILTER_SANITIZE_STRING,
					Parameters::SERVICE_IDEAL_CONSUMER_NAME => FILTER_SANITIZE_STRING,
					Parameters::SERVICE_IDEAL_CONSUMER_IBAN => FILTER_SANITIZE_STRING,
					Parameters::SERVICE_IDEAL_CONSUMER_BIC => FILTER_SANITIZE_STRING,
					Parameters::TRANSACTIONS               => FILTER_SANITIZE_STRING,
				)
			);
		}

		return $result;
	}
}