WPSC_Payment_Gateway_Paypal_Express_Checkout::process_refund() - Code Metrics - Inspection of "Refunds API + Express Checkout" - wp-e-commerce/WP-e-Commerce - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#2185)

by Justin
created 2016-11-29 22:31 UTC
process_refund() B

↳ Parent: WPSC_Payment_Gateway_Paypal_Express_Checkout
Complexity

Conditions	6
Paths	5
Size

Total Lines	41
Code Lines	22
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	6
eloc	22
nc	5
nop	3
dl	0
loc	41
rs	8.439
c	0
b	0
f	0
<?php
/**
 * The PayPal Express Checkout Gateway class
 *
 */

class WPSC_Payment_Gateway_Paypal_Express_Checkout extends WPSC_Payment_Gateway {
	public $sandbox_url = 'https://www.sandbox.paypal.com/webscr';
	public $live_url    = 'https://www.paypal.com/cgi-bin/webscr';
	private $paypal_data;
	protected $gateway;

	/**
	 * Constructor of PayPal Express Checkout Gateway.
	 * The $child parameter should be set to true, if the constructor
	 * is called from a child class.
	 *
	 * @param array $options
	 * @param bool $child
	 *
	 * @since 3.9
	 */
	public function __construct( $options, $child = false ) {
		parent::__construct();

		require_once( 'php-merchant/gateways/paypal-express-checkout.php' );
		$this->gateway = new PHP_Merchant_Paypal_Express_Checkout( $options );

		if ( ! $child ) {
			$this->title = __( 'PayPal Express Checkout 3.0', 'wp-e-commerce' );
			$this->supports = array( 'refunds', 'partial-refunds' );
			$this->gateway->set_options( array(
				'api_username'     => $this->setting->get( 'api_username' ),
				'api_password'     => $this->setting->get( 'api_password' ),
				'api_signature'    => $this->setting->get( 'api_signature' ),
				'cancel_url'       => $this->get_shopping_cart_payment_url(),
				'currency'         => $this->get_currency_code(),
				'test'             => (bool) $this->setting->get( 'sandbox_mode' ),
				'address_override' => 1,
				'solution_type'    => 'mark',
				'cart_logo'        => $this->setting->get( 'cart_logo' ),
				'cart_border'      => $this->setting->get( 'cart_border' ),
				'incontext'        => (bool) $this->setting->get( 'incontext' ),
			) );

			// Express Checkout Button
			if ( (bool) $this->setting->get( 'shortcut' ) && ! (bool) $this->setting->get( 'incontext' ) ) {
				add_action( 'wpsc_cart_item_table_form_actions_left', array( $this, 'add_ecs_button' ), 2, 2 );
			}
			// Incontext Checkout Scripts
			if ( (bool) $this->setting->get( 'incontext' ) && ! (bool) $this->setting->get( 'shortcut' ) ) {
				add_action( 'wp_enqueue_scripts', array( $this, 'incontext_load_scripts' ) );
			}
		}
	}

	public function incontext_load_scripts() {
		wp_register_script( 'ec-incontext', WPSC_URL . '/wpsc-components/merchant-core-v3/gateways/ec-incontext.js', '', null, true );
		wp_localize_script( 'ec-incontext', 'wpec_ppic', array(
			'mid' => esc_attr( $this->setting->get( 'api_merchantid' ) ),
			'env' => (bool) $this->setting->get( 'sandbox_mode' ) === true ? 'sandbox' : 'production',
			)
		);
		wp_enqueue_script( 'ec-incontext' );
		wp_enqueue_script( 'ppincontext', 'https://www.paypalobjects.com/api/checkout.js', array(), null, true );
	}

	/**
	 * Insert the ExpessCheckout Shortcut Button
	 *
	 * @return void
	 */
	public function add_ecs_button( $cart_table, $context ) {

		if ( ! wpsc_uses_shipping() && wpsc_is_gateway_active( 'paypal-digital-goods' ) || ! wpsc_is_gateway_active( 'paypal-express-checkout' ) ) {
			return;
		}

		if ( 'bottom' == $context ) {
			return;
		}

		if ( _wpsc_get_current_controller_name() === 'cart' ) {
			$url = $this->get_shortcut_url();
			echo '<a class="express-checkout-button" href="'. esc_url( $url ) .'"><img src="https://www.paypalobjects.com/webstatic/en_US/i/buttons/checkout-logo-large.png" alt="' . __( 'Check out with PayPal', 'wp-e-commerce' ) . '" /></a>';
		}
	}

	/**
	 * Return the ExpressCheckout Shortcut redirection URL
	 *
	 * @return void
	 */
	public function get_shortcut_url() {
		$location = add_query_arg( array(
			'payment_gateway'          => 'paypal-express-checkout',
			'payment_gateway_callback' => 'shortcut_process',
		), home_url( 'index.php' ) );

		return apply_filters( 'wpsc_paypal_express_checkout_shortcut_url', $location );
	}

	/**
	 * ExpressCheckout Shortcut Callback
	 *
	 * @return int
	 */
	public function callback_shortcut_process() {
		if ( ! isset( $_GET['payment_gateway'] ) ) {
			return;
		}
		$payment_gateway = $_GET['payment_gateway'];

		global $wpsc_cart;
		//	Create a new PurchaseLog Object
		$purchase_log = new WPSC_Purchase_Log();

		// Create a Sessionid
		$sessionid = ( mt_rand( 100, 999 ) . time() );
		wpsc_update_customer_meta( 'checkout_session_id', $sessionid );
		$purchase_log->set( array(
			'user_ID'        => get_current_user_id(),
			'date'           => time(),
			'plugin_version' => WPSC_VERSION,
			'statusno'       => '0',
			'sessionid'      => $sessionid,
		) );

		if ( wpsc_is_tax_included() ) {
			$tax            = $wpsc_cart->calculate_total_tax();
			$tax_percentage = $wpsc_cart->tax_percentage;
		} else {
			$tax            = 0;
			$tax_percentage = 0;
		}
		$purchase_log->set( array(
			'wpec_taxes_total' => $tax,
			'wpec_taxes_rate'  => $tax_percentage,
		) );

		// Save the purchase_log object to generate it's id
		$purchase_log->save();
		$purchase_log_id = $purchase_log->get( 'id' );

		$wpsc_cart->log_id = $purchase_log_id;
		wpsc_update_customer_meta( 'current_purchase_log_id', $purchase_log_id );

		$purchase_log->set( array(
			'gateway'       => $payment_gateway,
			'base_shipping' => $wpsc_cart->calculate_base_shipping(),
			'totalprice'    => $wpsc_cart->calculate_total_price(),
		) );

		$purchase_log->save();

		$wpsc_cart->empty_db( $purchase_log_id );
		$wpsc_cart->save_to_db( $purchase_log_id );
		$wpsc_cart->submit_stock_claims( $purchase_log_id );

		// Save an empty Form
		$form   = WPSC_Checkout_Form::get();
		$fields = $form->get_fields();
		WPSC_Checkout_Form_Data::save_form( $purchase_log, $fields );

		// Return Customer to Review Order Page if there is Shipping
		add_filter( 'wpsc_paypal_express_checkout_transact_url', array( &$this, 'review_order_url' ) );
		add_filter( 'wpsc_paypal_express_checkout_return_url', array( &$this, 'review_order_callback' ) );

		// Set a Temporary Option for EC Shortcut
		wpsc_update_customer_meta( 'esc-' . $sessionid, true );

		// Apply Checkout Actions
		do_action( 'wpsc_submit_checkout', array(
			'purchase_log_id' => $purchase_log_id,
			'our_user_id'     => get_current_user_id(),
		) );
		do_action( 'wpsc_submit_checkout_gateway', $payment_gateway, $purchase_log );

		return $sessionid;
	}

	/**
	 * Return Customer to Review Order Page if there are Shipping Costs.
	 *
	 * @param string $url
	 * @return string
	 */
	public function review_order_url( $url ) {
		if ( wpsc_uses_shipping() ) {
		   $url = wpsc_get_checkout_url( 'review-order' );
		}

		return $url;
	}

	/**
	 * Sets the Review Callback for Review Order page.
	 *
	 * @param string $url
	 * @return string
	 */
	public function review_order_callback( $url ) {
		$args = array(
			'payment_gateway_callback' => 'review_transaction',
			'payment_gateway'          => 'paypal-express-checkout',
		);
		$url = add_query_arg( $args, $url );

		return esc_url( $url );
	}

	/**
	 * Run the gateway hooks
	 *
	 * @access public
	 * @since 4.0
	 *
	 * @return void
	 */
	public function init() {
		add_filter(
			'wpsc_payment_method_form_fields',
			array( 'WPSC_Payment_Gateway_Paypal_Express_Checkout', 'filter_unselect_default' ), 100 , 1
		);
	}

	/**
	 * No payment gateway is selected by default
	 *
	 * @access public
	 * @param array $fields
	 * @return array
	 *
	 * @since 3.9
	 */
	public static function filter_unselect_default( $fields ) {
		foreach ( $fields as $i => $field ) {
			$fields[ $i ][ 'checked' ] = false;
		}

		return $fields;
	}

	/**
	 * Returns the HTML of the logo of the payment gateway.
	 *
	 * @access public
	 * @return string
	 *
	 * @since 3.9
	 */
	public function get_mark_html() {
		$html = '<img src="https://www.paypalobjects.com/webstatic/mktg/logo/pp_cc_mark_37x23.jpg" border="0" alt="PayPal Logo">';

		return apply_filters( 'wpsc_paypal-ec_mark_html', $html );
	}

	/**
	 * Returns the PayPal redirect URL
	 *
	 * @param array $data Arguments to encode with the URL
	 * @return string
	 *
	 * @since 3.9
	 */
	public function get_redirect_url( $data = array() ) {

		// Select either the Sandbox or the Live URL
		if ( $this->setting->get( 'sandbox_mode' ) ) {
			$url = $this->sandbox_url;
		} else {
			$url = $this->live_url;
		}

		// Common Vars
		$common = array(
			'cmd'        => '_express-checkout',
			'useraction' => 'commit',
		);

		if ( wp_is_mobile() ) {
			$common['cmd'] = '_express-checkout-mobile';
		}

		// Merge the two arrays
		$data = array_merge( $data, $common );

		// Build the URL
		$url = add_query_arg( $data, $url );

		return $url;
	}

	/**
	 * Returns the URL of the Return Page after the PayPal Checkout
	 *
	 * @return string
	 */
	protected function get_return_url() {
		$transact_url = get_option( 'transact_url' );
		$transact_url = apply_filters( 'wpsc_paypal_express_checkout_transact_url', $transact_url );

		$location = add_query_arg( array(
			'sessionid'                => $this->purchase_log->get( 'sessionid' ),
			'payment_gateway'          => 'paypal-express-checkout',
			'payment_gateway_callback' => 'confirm_transaction',
		),
		$transact_url
	);
		return apply_filters( 'wpsc_paypal_express_checkout_return_url', $location, $this );
	}

	/**
	 * Returns the URL of the IPN Page
	 *
	 * @return string
	 */
	protected function get_notify_url() {
		$location = add_query_arg( array(
			'payment_gateway'          => 'paypal-express-checkout',
			'payment_gateway_callback' => 'ipn',
		), home_url( 'index.php' ) );

		return apply_filters( 'wpsc_paypal_express_checkout_notify_url', $location );
	}

	/**
	 * Creates a new Purchase Log entry and set it to the current object
	 *
	 * @return null
	 */
	protected function set_purchase_log_for_callbacks( $sessionid = false ) {
		// Define the sessionid if it's not passed
		if ( $sessionid === false ) {
			$sessionid = $_REQUEST['sessionid'];
		}

		// Create a new Purchase Log entry
		$purchase_log = new WPSC_Purchase_Log( $sessionid, 'sessionid' );

		if ( ! $purchase_log->exists() ) {
			return null;
		}

		// Set the Purchase Log for the gateway object
		$this->set_purchase_log( $purchase_log );
	}

	/**
	 * IPN Callback function
	 *
	 * @return void
	 */
	public function callback_ipn() {
		$ipn = new PHP_Merchant_Paypal_IPN( false, (bool) $this->setting->get( 'sandbox_mode', false ) );

		if ( $ipn->is_verified() ) {
			$sessionid = $ipn->get( 'invoice' );
			$this->set_purchase_log_for_callbacks( $sessionid );

			if ( $ipn->is_payment_denied() ) {
				$this->purchase_log->set( 'processed', WPSC_Purchase_Log::PAYMENT_DECLINED );
			} elseif ( $ipn->is_payment_refunded() ) {
				$this->purchase_log->set( 'processed', WPSC_Purchase_Log::REFUNDED );
			} elseif ( $ipn->is_payment_completed() ) {
				$this->purchase_log->set( 'processed', WPSC_Purchase_Log::ACCEPTED_PAYMENT );
			} elseif ( $ipn->is_payment_pending() ) {
				if ( $ipn->is_payment_refund_pending() ) {
					$this->purchase_log->set( 'processed', WPSC_Purchase_Log::REFUND_PENDING );
				} else {
					$this->purchase_log->set( 'processed', WPSC_Purchase_Log::ORDER_RECEIVED );
				}
			}

			$this->purchase_log->save();
			transaction_results( $sessionid, false );
		}

		exit;
	}

	/**
	 * Pull and Record PayPal Details
	 *
	 * @return void
	 */
	public function pull_paypal_details() {
		$this->set_purchase_log_for_callbacks();

		// Pull the User Details from PayPal
		$this->paypal_data = $paypal = $this->gateway->get_details_for( $_GET['token'] );
		$payer = $paypal->get( 'payer' );
		$address = $paypal->get( 'shipping_address' );

		// PurchaseLog Update
		if ( isset( $address['country_code'] ) ) {
			$this->purchase_log->set( 'billing_country', $address['country_code'] );
			$this->purchase_log->set( 'shipping_country', $address['country_code'] );
		}
		if ( isset( $address['state'] ) ) {
			$this->purchase_log->set( 'billing_region', $address['state'] );
			$this->purchase_log->set( 'shipping_region', $address['state'] );
		}

		// Save Checkout Form Fields
		$form   = WPSC_Checkout_Form::get();
		$fields = $form->get_fields();
		$_POST['wpsc_checkout_details'] = array();
		foreach( $fields as $field ) {
			$this->set_post_var( $field, $payer, $address );
		}

		// Save details to the Forms Table
		WPSC_Checkout_Form_Data::save_form( $this->purchase_log, $fields );
	}

	/**
	 * To insert Data to the Form Table, we need to pass it
	 * to the global $_POST variable first
	 *
	 * @param object $payer
	 * @param object $field
	 * @param array $address
	 *
	 * @return void
	 */
	private function set_post_var( $field, $payer, $address ) {
		switch( $field->unique_name ) {
			// Shipping Details
		case 'shippingfirstname':
			$_POST['wpsc_checkout_details'][$field->id] = $this->validate_var( $address['name'] );
			break;
		case 'shippinglastname':
			$_POST['wpsc_checkout_details'][$field->id] = '';
			break;
		case 'shippingaddress':
				$_POST['wpsc_checkout_details'][$field->id] = $this->validate_var( $address['street'] );
			break;
		case 'shippingcity':
				$_POST['wpsc_checkout_details'][$field->id] = $this->validate_var( $address['city'] );
			break;
		case 'shippingstate':
				$_POST['wpsc_checkout_details'][$field->id] = $this->validate_var( $address['state'] );
			break;
		case 'shippingcountry':
				$_POST['wpsc_checkout_details'][$field->id] = $this->validate_var( $address['country_code'] );
			break;
		case 'shippingpostcode':
				$_POST['wpsc_checkout_details'][$field->id] = $this->validate_var( $address['zip'] );
			break;
			// Billing Details
		case 'billingfirstname':
				$_POST['wpsc_checkout_details'][$field->id] = $this->validate_var( $payer->first_name );
			break;
		case 'billinglastname':
				$_POST['wpsc_checkout_details'][$field->id] = $this->validate_var( $payer->last_name );
			break;
		case 'billingaddress':
		case 'billingcity':
		case 'billingstate':
		case 'billingpostcode':
		case 'billingphone':
			$_POST['wpsc_checkout_details'][$field->id] = '';
			break;
		case 'billingcountry':
				$_POST['wpsc_checkout_details'][$field->id] = $this->validate_var( $payer->country );
			break;
		case 'billingemail':
				$_POST['wpsc_checkout_details'][$field->id] = $this->validate_var( $payer->email );
			break;
		}
	}

	/**
	 * Verify that the variable isset and return it, otherwise return an empty
	 * string
	 *
	 * @param string $var
	 *
	 * @return string
	 */
	private function validate_var( $var ) {
		if ( isset( $var ) ) {
			return $var;
		}
		return '';
	}

	/**
	 * Review Transaction Callback
	 *
	 * @return void
	 */
	public function callback_review_transaction() {
		// Pull Customer Details from PayPal
		$this->pull_paypal_details();

		// If no Shipping is required, confirm the Transaction
		if ( !wpsc_uses_shipping() ) {
			$this->callback_confirm_transaction();
		}

		// Display Customer Details
		add_filter( 'wpsc_review_order_buyers_details', array( &$this, 'review_order_buyer_details' ) );
		add_filter( 'wpsc_review_order_shipping_details', array( &$this, 'review_order_shipping_details' ) );
	}

	/**
	 * Display Customer Details from PayPal
	 *
	 * @param string $output
	 * @return string
	 */
	public function review_order_buyer_details( $output ) {
		$payer = $this->paypal_data->get( 'payer' );
		$output .= '<ul>';
		$output .= '<li><strong>' . __( 'Email:', 'wp-e-commerce' ) . ' </strong>' . $payer->email . '</li>';
		$output .= '<li><strong>' . __( 'First Name:', 'wp-e-commerce' ) . ' </strong>' . $payer->first_name . '</li>';
		$output .= '<li><strong>' . __( 'Last Name:', 'wp-e-commerce' ) . ' </strong>' . $payer->last_name . '</li>';
		$output .= '</ul>';
		return $output;
	}

	/**
	 * Display Shipping Details from PayPal
	 *
	 * @param string $output
	 * @return string
	 */
	public function review_order_shipping_details( $output ) {
		$address = $this->paypal_data->get( 'shipping_address' );
		$output .= '<ul>';
		$output .= '<li>' . $address[ 'name' ] . '</li>';
		$output .= '<li>' . $address[ 'street' ] . '</li>';
		$output .= '<li>' . $address[ 'city' ] . '</li>';
		$output .= '<li>' . $address[ 'state' ] . '</li>';
		$output .= '<li>' . $address[ 'zip' ] . '</li>';
		$output .= '<li>' . $address[ 'country_code' ] . '</li>';
		$output .= '</ul>';
		return $output;
	}

	/**
	 * Confirm Transaction Callback
	 *
	 * @return bool
	 *
	 * @since 3.9
	 */
	public function callback_confirm_transaction() {
		if ( ! isset( $_REQUEST['sessionid'] ) || ! isset( $_REQUEST['token'] ) || ! isset( $_REQUEST['PayerID'] ) ) {
			return false;
		}

		// Set the Purchase Log
		$this->set_purchase_log_for_callbacks();

		// Display the Confirmation Page
		$this->do_transaction();

		// Remove Shortcut option if it exists
		$sessionid = $_REQUEST['sessionid'];
		wpsc_delete_customer_meta( 'esc-' . $sessionid );
	}

	/**
	 * Process the transaction through the PayPal APIs
	 *
	 * @since 3.9
	 */
	public function do_transaction() {
		$args = array_map( 'urldecode', $_GET );
		extract( $args, EXTR_SKIP );


		if ( ! isset( $sessionid ) || ! isset( $token ) || ! isset( $PayerID ) ) {
			return;
		}

		$this->set_purchase_log_for_callbacks();

		$total = $this->convert( $this->purchase_log->get( 'totalprice' ) );
		$options = array(
			'token'         => $token,
			'payer_id'      => $PayerID,
			'message_id'    => $this->purchase_log->get( 'id' ),
			'invoice'		=> $this->purchase_log->get( 'sessionid' ),
		);
		$options += $this->checkout_data->get_gateway_data();
		$options += $this->purchase_log->get_gateway_data( parent::get_currency_code(), $this->get_currency_code() );
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}

		if ( $this->setting->get( 'ipn', false ) ) {
			$options['notify_url'] = $this->get_notify_url();
		}

		// GetExpressCheckoutDetails
		$details = $this->gateway->get_details_for( $token );
		$this->log_payer_details( $details );

		$response = $this->gateway->purchase( $options );
		$this->log_protection_status( $response );
		$location = remove_query_arg( 'payment_gateway_callback' );

		if ( $response->has_errors() ) {
			$errors = $response->get_params();

			if ( isset( $errors['L_ERRORCODE0'] ) && '10486' == $errors['L_ERRORCODE0'] ) {
				wp_redirect( $this->get_redirect_url( array( 'token' => $token ) ) );
				exit;
			}

			wpsc_update_customer_meta( 'paypal_express_checkout_errors', $response->get_errors() );
			$location = add_query_arg( array( 'payment_gateway_callback' => 'display_paypal_error' ) );

		} elseif ( $response->is_payment_completed() || $response->is_payment_pending() ) {
			$location = remove_query_arg( 'payment_gateway' );

			if ( $response->is_payment_completed() ) {
				$this->purchase_log->set( 'processed', WPSC_Purchase_Log::ACCEPTED_PAYMENT );
			} else {
				$this->purchase_log->set( 'processed', WPSC_Purchase_Log::ORDER_RECEIVED );
			}

			$this->purchase_log->set( 'transactid', $response->get( 'transaction_id' ) )
				->set( 'date', time() )
				->save();
		} else {
			$location = add_query_arg( array( 'payment_gateway_callback' => 'display_generic_error' ) );
		}

		wp_redirect( esc_url_raw( $location ) );
		exit;
	}

	public function callback_display_paypal_error() {
		add_filter( 'wpsc_get_transaction_html_output', array( $this, 'filter_paypal_error_page' ) );
	}

	public function callback_display_generic_error() {
		add_filter( 'wpsc_get_transaction_html_output', array( $this, 'filter_generic_error_page' ) );
	}

	/**
	 * Records the Payer ID, Payer Status and Shipping Status to the Purchase
	 * Log on GetExpressCheckout Call
	 *
	 * @return void
	 */
	public function log_payer_details( $details ) {
		if ( isset( $details->get( 'payer' )->id ) && !empty( $details->get( 'payer' )->id ) ) {
			$payer_id = $details->get( 'payer' )->id;
		} else {
			$payer_id = 'not set';
		}
		if ( isset( $details->get( 'payer' )->status ) && !empty( $details->get( 'payer' )->status ) ) {
			$payer_status = $details->get( 'payer' )->status;
		} else {
			$payer_status = 'not set';
		}
		if ( isset( $details->get( 'payer' )->shipping_status ) && !empty( $details->get( 'payer' )->shipping_status ) ) {
			$payer_shipping_status = $details->get( 'payer' )->shipping_status;
		} else {
			$payer_shipping_status = 'not set';
		}
		$paypal_log = array(
			'payer_id'        => $payer_id,
			'payer_status'    => $payer_status,
			'shipping_status' => $payer_shipping_status,
			'protection'      => null,
		);

		wpsc_update_purchase_meta( $this->purchase_log->get( 'id' ), 'paypal_ec_details' , $paypal_log );
	}

	/**
	 * Records the Protection Eligibility status to the Purchase Log on
	 * DoExpressCheckout Call
	 *
	 * @return void
	 */
	public function log_protection_status( $response ) {
		$params = $response->get_params();

		if ( isset( $params['PAYMENTINFO_0_PROTECTIONELIGIBILITY'] ) ) {
			$elg                      = $params['PAYMENTINFO_0_PROTECTIONELIGIBILITY'];
		} else {
			$elg = false;
		}
		$paypal_log               = wpsc_get_purchase_meta( $this->purchase_log->get( 'id' ), 'paypal_ec_details', true );
		$paypal_log['protection'] = $elg;
		wpsc_update_purchase_meta( $this->purchase_log->get( 'id' ), 'paypal_ec_details' , $paypal_log );
	}

	public function callback_process_confirmed_payment() {
		$args = array_map( 'urldecode', $_GET );
		extract( $args, EXTR_SKIP );


		if ( ! isset( $sessionid ) || ! isset( $token ) || ! isset( $PayerID ) ) {
			return;
		}

		$this->set_purchase_log_for_callbacks();

		$total = $this->convert( $this->purchase_log->get( 'totalprice' ) );
		$options = array(
			'token'         => $token,
			'payer_id'      => $PayerID,
			'message_id'    => $this->purchase_log->get( 'id' ),
			'invoice'       => $this->purchase_log->get( 'sessionid' ),
		);
		$options += $this->checkout_data->get_gateway_data();
		$options += $this->purchase_log->get_gateway_data( parent::get_currency_code(), $this->get_currency_code() );
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}

		if ( $this->setting->get( 'ipn', false ) ) {
			$options['notify_url'] = $this->get_notify_url();
		}

		// GetExpressCheckoutDetails
		$details = $this->gateway->get_details_for( $token );
		$this->log_payer_details( $details );

		$response = $this->gateway->purchase( $options );
		$this->log_protection_status( $response );
		$location = remove_query_arg( 'payment_gateway_callback' );

		if ( $response->has_errors() ) {
			wpsc_update_customer_meta( 'paypal_express_checkout_errors', $response->get_errors() );
			$location = add_query_arg( array( 'payment_gateway_callback' => 'display_paypal_error' ) );
		} elseif ( $response->is_payment_completed() || $response->is_payment_pending() ) {
			$location = remove_query_arg( 'payment_gateway' );

			if ( $response->is_payment_completed() ) {
				$this->purchase_log->set( 'processed', WPSC_Purchase_Log::ACCEPTED_PAYMENT );
			} else {
				$this->purchase_log->set( 'processed', WPSC_Purchase_Log::ORDER_RECEIVED );
			}

			$this->purchase_log->set( 'transactid', $response->get( 'transaction_id' ) )
				->set( 'date', time() )
				->save();
		} else {
			$location = add_query_arg( array( 'payment_gateway_callback' => 'display_generic_error' ) );
		}

		wp_redirect( esc_url_raw( $location ) );
		exit;
	}

	/**
	 * Error Page Template
	 *
	 * @since 3.9
	 */
	public function filter_paypal_error_page() {
		$errors = wpsc_get_customer_meta( 'paypal_express_checkout_errors' );
		ob_start();
?>
	<p>
	<?php _e( 'Sorry, your transaction could not be processed by PayPal. Please contact the site administrator. The following errors are returned:' , 'wp-e-commerce' ); ?>
		</p>
			<ul>
			<?php foreach ( $errors as $error ): ?>
			<li><?php echo esc_html( $error['details'] ) ?> (<?php echo esc_html( $error['code'] ); ?>)</li>
			<?php endforeach; ?>
		</ul>
			<p><a href="<?php echo esc_url( $this->get_shopping_cart_payment_url() ); ?>"><?php ( 'Click here to go back to the checkout page.') ?></a></p>
<?php
		$output = apply_filters( 'wpsc_paypal_express_checkout_gateway_error_message', ob_get_clean(), $errors );
		return $output;
	}

	/**
	 * Generic Error Page Template
	 *
	 * @since 3.9
	 */
	public function filter_generic_error_page() {
		ob_start();
?>
<p><?php _e( 'Sorry, but your transaction could not be processed by PayPal for some reason. Please contact the site administrator.' , 'wp-e-commerce' ); ?></p>
<p><a href="<?php echo esc_attr( $this->get_shopping_cart_payment_url() ); ?>"><?php _e( 'Click here to go back to the checkout page.', 'wp-e-commerce' ) ?></a></p>
<?php
		$output = apply_filters( 'wpsc_paypal_express_checkout_generic_error_message', ob_get_clean() );
		return $output;
	}

	/**
	 * Settings Form Template
	 *
	 * @since 3.9
	 */
	public function setup_form() {
		$paypal_currency = $this->get_currency_code();
?>

<!-- Account Credentials -->
<tr>
	<td colspan="2">
		<h4><?php _e( 'Account Credentials', 'wp-e-commerce' ); ?></h4>
	</td>
</tr>
<tr>
	<td>
		<label for="wpsc-paypal-express-api-username"><?php _e( 'API Username', 'wp-e-commerce' ); ?></label>
	</td>
	<td>
		<input type="text" name="<?php echo esc_attr( $this->setting->get_field_name( 'api_username' ) ); ?>" value="<?php echo esc_attr( $this->setting->get( 'api_username' ) ); ?>" id="wpsc-paypal-express-api-username" />
	</td>
</tr>
<tr>
	<td>
		<label for="wpsc-paypal-express-api-password"><?php _e( 'API Password', 'wp-e-commerce' ); ?></label>
	</td>
	<td>
		<input type="text" name="<?php echo esc_attr( $this->setting->get_field_name( 'api_password' ) ); ?>" value="<?php echo esc_attr( $this->setting->get( 'api_password' ) ); ?>" id="wpsc-paypal-express-api-password" />
	</td>
</tr>
<tr>
	<td>
		<label for="wpsc-paypal-express-api-signature"><?php _e( 'API Signature', 'wp-e-commerce' ); ?></label>
	</td>
	<td>
		<input type="text" name="<?php echo esc_attr( $this->setting->get_field_name( 'api_signature' ) ); ?>" value="<?php echo esc_attr( $this->setting->get( 'api_signature' ) ); ?>" id="wpsc-paypal-express-api-signature" />
	</td>
</tr>
<tr>
	<td>
		<label for="wpsc-paypal-express-api-username"><?php _e( 'Merchant ID', 'wp-e-commerce' ); ?></label>
	</td>
	<td>
		<input type="text" name="<?php echo esc_attr( $this->setting->get_field_name( 'api_merchantid' ) ); ?>" value="<?php echo esc_attr( $this->setting->get( 'api_merchantid' ) ); ?>" id="wpsc-paypal-express-api-username" />
	</td>
</tr>
<tr>
	<td>
		<label><?php _e( 'Sandbox Mode', 'wp-e-commerce' ); ?></label>
	</td>
	<td>
		<label><input <?php checked( $this->setting->get( 'sandbox_mode' ) ); ?> type="radio" name="<?php echo esc_attr( $this->setting->get_field_name( 'sandbox_mode' ) ); ?>" value="1" /> <?php _e( 'Yes', 'wp-e-commerce' ); ?></label>&nbsp;&nbsp;&nbsp;
		<label><input <?php checked( (bool) $this->setting->get( 'sandbox_mode' ), false ); ?> type="radio" name="<?php echo esc_attr( $this->setting->get_field_name( 'sandbox_mode' ) ); ?>" value="0" /> <?php _e( 'No', 'wp-e-commerce' ); ?></label>
	</td>
</tr>
<tr>
	<td>
		<label><?php _e( 'IPN', 'wp-e-commerce' ); ?></label>
	</td>
	<td>
		<label><input <?php checked( $this->setting->get( 'ipn' ) ); ?> type="radio" name="<?php echo esc_attr( $this->setting->get_field_name( 'ipn' ) ); ?>" value="1" /> <?php _e( 'Yes', 'wp-e-commerce' ); ?></label>&nbsp;&nbsp;&nbsp;
		<label><input <?php checked( (bool) $this->setting->get( 'ipn' ), false ); ?> type="radio" name="<?php echo esc_attr( $this->setting->get_field_name( 'ipn' ) ); ?>" value="0" /> <?php _e( 'No', 'wp-e-commerce' ); ?></label>
	</td>
</tr>

<!-- Cart Customization -->
<tr>
	<td colspan="2">
		<label><h4><?php _e( 'Cart Customization', 'wp-e-commerce'); ?></h4></label>
	</td>
</tr>
<tr>
	<td>
		<label for="wpsc-paypal-express-cart-logo"><?php _e( 'Merchant Logo', 'wp-e-commerce' ); ?></label>
	</td>
	<td>
		<input type="text" name="<?php echo esc_attr( $this->setting->get_field_name( 'cart_logo' ) ); ?>" value="<?php echo esc_attr( $this->setting->get( 'cart_logo' ) ); ?>" id="wpsc-paypal-express-cart-logo" /><br><span class="small description"><?php _e( 'The image must be stored in a HTTPS Server. Limit the image to 190 pixels wide by 60 pixels high.', 'wp-e-commerce' ); ?></span>
	</td>
</tr>
<tr>
	<td>
		<label for="wpsc-paypal-express-cart-border"><?php _e( 'Cart Border Color', 'wp-e-commerce' ); ?></label>
	</td>
	<td>
		<input type="text" name="<?php echo esc_attr( $this->setting->get_field_name( 'cart_border' ) ); ?>" value="<?php echo esc_attr( $this->setting->get( 'cart_border' ) ); ?>" id="wpsc-paypal-express-cart-border" />
	</td>
</tr>
<tr>
	<td>
		<label for="wpsc-paypal-express-cart-border"><?php _e( 'Enable In-Context Checkout', 'wp-e-commerce' ); ?></label>
	</td>
	<td>
		<label><input <?php checked( $this->setting->get( 'incontext' ) ); ?> type="radio" name="<?php echo esc_attr( $this->setting->get_field_name( 'incontext' ) ); ?>" value="1" /> <?php _e( 'Yes', 'wp-e-commerce' ); ?></label>&nbsp;&nbsp;&nbsp;
		<label><input <?php checked( (bool) $this->setting->get( 'incontext' ), false ); ?> type="radio" name="<?php echo esc_attr( $this->setting->get_field_name( 'incontext' ) ); ?>" value="0" /> <?php _e( 'No', 'wp-e-commerce' ); ?></label>
	</td>
</tr>

<!-- Currency Conversion -->
<?php if ( ! $this->is_currency_supported() ) : ?>
<tr>
	<td colspan="2">
		<h4><?php _e( 'Currency Conversion', 'wp-e-commerce' ); ?></h4>
	</td>
</tr>
<tr>
	<td colspan="2">
		<p><?php _e( "Your base currency is currently not accepted by PayPal. As a result, before a payment request is sent to PayPal, WP eCommerce has to convert the amounts into one of PayPal's supported currencies. Please select your preferred currency below.", 'wp-e-commerce' ); ?></p>
	</td>
</tr>
<tr>
	<td>
		<label for "wpsc-paypal-express-currency"><?php _e( 'PayPal Currency', 'wp-e-commerce' ); ?></label>
	</td>
	<td>
		<select name="<?php echo esc_attr( $this->setting->get_field_name( 'currency' ) ); ?>" id="wpsc-paypal-express-currency">
			<?php foreach ( $this->gateway->get_supported_currencies() as $currency ) : ?>
			<option <?php selected( $currency, $paypal_currency ); ?> value="<?php echo esc_attr( $currency ); ?>"><?php echo esc_html( $currency ); ?></option>
			<?php endforeach ?>
		</select>
	</td>
</tr>
<?php endif ?>

<!-- Checkout Shortcut -->
<tr>
	<td colspan="2">
		<h4><?php _e( 'Express Checkout Shortcut', 'wp-e-commerce' ); ?></h4>
	</td>
</tr>
<tr>
	<td>
		<label><?php _e( 'Enable Shortcut', 'wp-e-commerce' ); ?></label>
	</td>
	<td>
		<label><input <?php checked( $this->setting->get( 'shortcut' ) ); ?> type="radio" name="<?php echo esc_attr( $this->setting->get_field_name( 'shortcut' ) ); ?>" value="1" /> <?php _e( 'Yes', 'wp-e-commerce' ); ?></label>&nbsp;&nbsp;&nbsp;
		<label><input <?php checked( (bool) $this->setting->get( 'shortcut' ), false ); ?> type="radio" name="<?php echo esc_attr( $this->setting->get_field_name( 'shortcut' ) ); ?>" value="0" /> <?php _e( 'No', 'wp-e-commerce' ); ?></label>
	</td>
</tr>

<!-- Error Logging -->
<tr>
	<td colspan="2">
		<h4><?php _e( 'Error Logging', 'wp-e-commerce' ); ?></h4>
	</td>
</tr>
<tr>
	<td>
		<label><?php _e( 'Enable Debugging', 'wp-e-commerce' ); ?></label>
	</td>
	<td>
		<label><input <?php checked( $this->setting->get( 'debugging' ) ); ?> type="radio" name="<?php echo esc_attr( $this->setting->get_field_name( 'debugging' ) ); ?>" value="1" /> <?php _e( 'Yes', 'wp-e-commerce' ); ?></label>&nbsp;&nbsp;&nbsp;
		<label><input <?php checked( (bool) $this->setting->get( 'debugging' ), false ); ?> type="radio" name="<?php echo esc_attr( $this->setting->get_field_name( 'debugging' ) ); ?>" value="0" /> <?php _e( 'No', 'wp-e-commerce' ); ?></label>
	</td>
</tr>
<?php
	}

	/**
	 * Check if the selected currency is supported by the gateway
	 *
	 * @return bool
	 *
	 * @since 3.9
	 */
	protected function is_currency_supported() {
		return in_array( parent::get_currency_code(), $this->gateway->get_supported_currencies() );
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
	}

	/**
	 * Return the Currency ISO code
	 *
	 * @return string
	 *
	 * @since 3.9
	 */
	public function get_currency_code() {
		$code = parent::get_currency_code();

		if ( ! in_array( $code, $this->gateway->get_supported_currencies() ) ) {
			$code = $this->setting->get( 'currency', 'USD' );
		}

		return $code;
	}

	/**
	 * Convert an amount (integer) to the supported currency
	 * @param integer $amt
	 *
	 * @return integer
	 *
	 * @since 3.9
	 */
	protected function convert( $amt ) {
		if ( $this->is_currency_supported() ) {
			return $amt;
		}

		return wpsc_convert_currency( $amt, parent::get_currency_code(), $this->get_currency_code() );
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
	}

	/**
	 * Process the SetExpressCheckout API Call
	 *
	 * @return void
	 *
	 * @since 3.9
	 */
	public function process() {
		$total = $this->convert( $this->purchase_log->get( 'totalprice' ) );
		$options = array(
			'return_url'       => $this->get_return_url(),
			'message_id'       => $this->purchase_log->get( 'id' ),
			'invoice'          => $this->purchase_log->get( 'sessionid' ),
			'address_override' => 1,
		);

		$options += $this->checkout_data->get_gateway_data();
		$options += $this->purchase_log->get_gateway_data( parent::get_currency_code(), $this->get_currency_code() );
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}

		if ( $this->setting->get( 'ipn', false ) ) {
			$options['notify_url'] = $this->get_notify_url();
		}

		// SetExpressCheckout
		$response = $this->gateway->setup_purchase( $options );

		if ( $response->is_successful() ) {
			$params = $response->get_params();
			if ( $params['ACK'] == 'SuccessWithWarning' ) {
				$this->log_error( $response );
				wpsc_update_customer_meta( 'paypal_express_checkout_errors', $response->get_errors() );
			}
			// Successful redirect
			$url = $this->get_redirect_url( array( 'token' => $response->get( 'token' ) ) );
		} else {

			// SetExpressCheckout Failure
			$this->log_error( $response );
			wpsc_update_customer_meta( 'paypal_express_checkout_errors', $response->get_errors() );

			$url = add_query_arg( array(
				'payment_gateway'          => 'paypal-express-checkout',
				'payment_gateway_callback' => 'display_paypal_error',
			), $this->get_return_url() );
		}

		wp_redirect( $url );
		exit;
	}

	/**
	 * Log an error message
	 *
	 * @param PHP_Merchant_Paypal_Express_Checkout_Response $response
	 * @return void
	 *
	 * @since 3.9
	 */
	public function log_error( $response ) {
		if ( $this->setting->get( 'debugging' ) ) {

			add_filter( 'wpsc_logging_post_type_args', 'WPSC_Logging::force_ui' );
			add_filter( 'wpsc_logging_taxonomy_args ', 'WPSC_Logging::force_ui' );

			$log_data = array(
				'post_title'    => 'PayPal ExpressCheckout Operation Failure',
				'post_content'  =>  'There was an error processing the payment. Find details in the log entry meta fields.',

				'log_type'      => 'error'
			);

			$log_meta = array(
				'correlation_id'   => $response->get( 'correlation_id' ),
				'time' => $response->get( 'datetime' ),
				'errors' => $response->get_errors(),
			);

			$log_entry = WPSC_Logging::insert_log( $log_data, $log_meta );
		}
	}

	public function process_refund( $order_id, $amount = 0.00, $reason = '' ) {

		if ( 0.00 == $amount ) {
			return new WP_Error( 'paypal_refund_error', __( 'Refund Error: You need to specify a refund amount.', 'wp-e-commerce' ) );
		}

		$log        = new WPSC_Purchase_Log( $order_id );
		$refundType = 'Full';

		// If refund is full amount is not needed
		// add refund params
		$options = array(
			'transaction_id' => $log->get( 'transactid' ),
			'invoice'        => $log->get( 'sessionid' ),
			'refund_type'    => $refundType,
			'note'           => $reason,
		);

		// do API call
		$response = $this->gateway->credit( $options );

		// look at ACK to see if success or failure
		if ( $response->has_errors() ) {
			// WE could use $response->get_errors() and return the errors in an alert message ?
			return false;
		}

		if ( $response->is_successful() ) {
			$params = $response->get_params();
			if ( 'Success' == $params['ACK'] || 'SuccessWithWarning' == $params['ACK'] ) {
				$this->log_error( $response );
				// Set a log meta entry
				$log->set( 'total_order_refunded' , $amount )->save();
				wpsc_purchlogs_update_notes( absint( $order_id ), sprintf( __( 'Refunded %s - Refund ID: %s', 'woocommerce' ), $params['GROSSREFUNDAMT'], $params['REFUNDTRANSACTIONID'] ) );

				return true;
			}
		} else {
			return false;
		}
	}
}

wp-e-commerce / WP-e-Commerce

Pull Request — master (#2185)

process_refund() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
