EEG_Paypal_Express - Code Metrics - Inspection of "Daily Inspection: change filter logic; [touch:7553..." - eventespresso/event-espresso-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — FEAT-7553-PayPal-Express-PM (35980c)

unknown

created 2016-09-06 21:37 UTC

EEG_Paypal_Express B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	442
Duplicated Lines	9.5 %

Coupling/Cohesion

Components	1
Dependencies	9

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	42
loc	442
rs	7.0642
wmc	54
lcom	1
cbo	9

7 Methods

Rating	Name	Duplication	Size	Complexity
A	set_settings()	0	9	2
F	set_redirection_info()	19	145	15
C	handle_payment_update()	23	77	16
B	_ppExpress_request()	0	27	1
C	_ppExpress_check_response()	0	27	12
A	_log_clean_request()	0	7	1
C	_get_errors()	0	28	7

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like EEG_Paypal_Express often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use EEG_Paypal_Express, and based on these observations, apply Extract Interface, too.

<?php if ( ! defined( 'EVENT_ESPRESSO_VERSION' )) { exit('NO direct script access allowed'); }

/**
 * ----------------------------------------------
 *
 * Class  EEG_Paypal_Express
 *
 * @package			Event Espresso
 * @subpackage		eea-paypal-express
 * @author			Event Espresso
 * @version		 	$VID:$
 *
 * ----------------------------------------------
 */
class EEG_Paypal_Express extends EE_Offsite_Gateway {

	/**
	 * Merchant API Username.
	 *  @var string
	 */
	protected $_api_username = null;

	/**
	 * Merchant API Password.
	 *  @var string
	 */
	protected $_api_password = null;

	/**
	 * API Signature.
	 *  @var string
	 */
	protected $_api_signature = null;

	/**
	 * Business/personal logo.
	 *  @var string
	 */
	protected $_image_url = null;

	/**
	 * All the currencies supported by this gateway.
	 *  @var array
	 */
	protected $_currencies_supported = array(
		'USD',
		'AUD',
		'BRL',
		'CAD',
		'CZK',
		'DKK',
		'EUR',
		'HKD',
		'HUF',
		'ILS',
		'JPY',
		'MYR',
		'MXN',
		'NOK',
		'NZD',
		'PHP',
		'PLN',
		'GBP',
		'RUB',
		'SGD',
		'SEK',
		'CHF',
		'TWD',
		'THB',
		'TRY'
	);


	/**
	 * Sets the gateway URL variable based on whether debug mode is enabled or not.
	 *
	 *  @param type $settings_array
	 */
	public function set_settings( $settings_array ) {
		parent::set_settings($settings_array);
		// Redirect URL.
		if ( $this->_debug_mode ) {
			$this->_base_gateway_url = 'https://api-3t.sandbox.paypal.com/nvp';
class MyClass { }

$x = new MyClass();
$x->foo = true;
		} else {
			$this->_base_gateway_url = 'https://api-3t.paypal.com/nvp';
		}
	}


	/**
	 *
	 *  @param EEI_Payment $payment
	 *  @param type $billing_info
	 *  @param type $return_url
	 *  @param type $cancel_url
	 */
	public function set_redirection_info( $payment, $billing_info = array(), $return_url = NULL, $notify_url = NULL, $cancel_url = NULL ) {
		if ( ! $payment instanceof EEI_Payment ) {
			$payment->set_gateway_response( __( 'Error. No associated payment was found.', 'event_espresso' ) );
			$payment->set_status( $this->_pay_model->failed_status() );
			return $payment;
		}
		$transaction = $payment->transaction();
		if ( ! $transaction instanceof EEI_Transaction ) {
			$payment->set_gateway_response( __( 'Could not process this payment because it has no associated transaction.', 'event_espresso' ) );
			$payment->set_status( $this->_pay_model->failed_status() );
			return $payment;
		}
		$order_description = substr( sprintf( __('Event Registrations from %s', 'event_espresso'), get_bloginfo('name') ), 0, 127 );
		$primary_registration = $transaction->primary_registration();
		$primary_attendee = $primary_registration instanceof EE_Registration ? $primary_registration->attendee() : false;
		$locale = explode('-', get_bloginfo('language'));

		// Gather request parameters.
		$token_request_dtls = array(
			'METHOD' => 'SetExpressCheckout',
			'PAYMENTREQUEST_0_AMT' => $payment->amount(),
			'PAYMENTREQUEST_0_CURRENCYCODE' => $payment->currency_code(),
			'PAYMENTREQUEST_0_DESC' => $order_description,
			'RETURNURL' => $return_url,
			'CANCELURL' => $cancel_url,
			'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
			'SOLUTIONTYPE' => 'Sole',	// Buyer does not need to create a PayPal account to check out. This is referred to as PayPal Account Optional. 
			'BUTTONSOURCE' => 'EventEspresso_SP',//EE will blow up if you change this
			'LOCALECODE' => $locale[1]	// Locale of the pages displayed by PayPal during Express Checkout.
		);

		// Show itemized list.
		if ( EEH_Money::compare_floats( $payment->amount(), $transaction->total(), '==' ) ) {
			$item_num = 0;
			$itemized_sum = 0;
			$total_line_items = $transaction->total_line_item();
			// Go through each item in the list.
			foreach ( $total_line_items->get_items() as $line_item ) {
				if ( $line_item instanceof EE_Line_Item ) {
					// PayPal doesn't like line items with 0.00 amount, so we may skip those.
					if ( EEH_Money::compare_floats( $line_item->total(), '0.00', '==' ) ) {
						continue;
					}

					$unit_price = $line_item->unit_price();
					$line_item_quantity = $line_item->quantity();
					// This is a discount.
					if ( $line_item->is_percent() ) {
						$unit_price = $line_item->total();
						$line_item_quantity = 1;
					}
					// Item Name.
					$token_request_dtls['L_PAYMENTREQUEST_0_NAME'.$item_num] = substr($line_item->name(), 0, 127);
					// Item description.
					$token_request_dtls['L_PAYMENTREQUEST_0_DESC'.$item_num] = substr($line_item->desc(), 0, 127);
					// Cost of individual item.
					$token_request_dtls['L_PAYMENTREQUEST_0_AMT'.$item_num] = $this->format_currency( $unit_price );
					// Item Number.
					$token_request_dtls['L_PAYMENTREQUEST_0_NUMBER'.$item_num] = $item_num + 1;
					// Item quantity.
					$token_request_dtls['L_PAYMENTREQUEST_0_QTY'.$item_num] = $line_item_quantity;
					// Digital item is sold.
					$token_request_dtls['L_PAYMENTREQUEST_0_ITEMCATEGORY'.$item_num] = 'Digital';
					$itemized_sum += $line_item->total();
					++$item_num;
				}
			}
			// Item's sales S/H and tax amount.
			$token_request_dtls['PAYMENTREQUEST_0_ITEMAMT'] = $total_line_items->get_items_total();
			$token_request_dtls['PAYMENTREQUEST_0_TAXAMT'] = $total_line_items->get_total_tax();
			$token_request_dtls['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
			$token_request_dtls['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';

			$itemized_sum_diff_from_txn_total = round( $transaction->total() - $itemized_sum - $total_line_items->get_total_tax(), 2 );
			// If we were not able to recognize some item like promotion, surcharge or cancellation, 
			// add the difference as an extra line item.
			if ( $itemized_sum_diff_from_txn_total != 0 ) {
				// Item Name.
				$token_request_dtls['L_PAYMENTREQUEST_0_NAME'.$item_num] = substr( __( 'Other (promotion/surcharge/cancellation)', 'event_espresso' ), 0, 127 );
				// Item description.
				$token_request_dtls['L_PAYMENTREQUEST_0_DESC'.$item_num] = substr( $line_item->desc(), 0, 127 );
foreach ($a as $b) {
}

// $b is defined here only if $a has elements, for example if $a is array()
// then $b would not be defined here. To avoid that, we recommend to set a
// default value for $b.


// Better
$b = 0; // or whatever default makes sense in your context
foreach ($a as $b) {
}

// $b is now guaranteed to be defined here.
				// Cost of individual item.
				$token_request_dtls['L_PAYMENTREQUEST_0_AMT'.$item_num] = $this->format_currency( $itemized_sum_diff_from_txn_total );
				// Item Number.
				$token_request_dtls['L_PAYMENTREQUEST_0_NUMBER'.$item_num] = $item_num + 1;
				// Item quantity.
				$token_request_dtls['L_PAYMENTREQUEST_0_QTY'.$item_num] = 1;
				++$item_num;
			}
		} else {
			// Just one Item.
			// Item Name.
			$token_request_dtls['L_PAYMENTREQUEST_0_NAME0'] = substr( sprintf( __('Payment for %1$s', 'event_espresso'), $primary_registration->reg_code() ), 0, 127 );
			// Item description.
			$token_request_dtls['L_PAYMENTREQUEST_0_DESC0'] = substr( sprintf( __('Payment of %1$s for %2$s', 'event_espresso'), $payment->amount(), $primary_registration->reg_code() ), 0, 127 );
			// Cost of individual item.
			$token_request_dtls['L_PAYMENTREQUEST_0_AMT0'] = $this->format_currency( $payment->amount() );
			// Item Number.
			$token_request_dtls['L_PAYMENTREQUEST_0_NUMBER0'] = 1;
			// Item quantity.
			$token_request_dtls['L_PAYMENTREQUEST_0_QTY0'] = 1;
			// Digital item is sold.
			$token_request_dtls['L_PAYMENTREQUEST_0_ITEMCATEGORY0'] = 'Digital';
			// Item's sales S/H and tax amount.
			$token_request_dtls['PAYMENTREQUEST_0_ITEMAMT'] = $this->format_currency( $payment->amount() );
			$token_request_dtls['PAYMENTREQUEST_0_TAXAMT'] = '0';
			$token_request_dtls['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
			$token_request_dtls['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
		}
		// Automatically filling out shipping and contact information.
		if ( $primary_attendee instanceof EEI_Attendee ) {
			$token_request_dtls['NOSHIPPING'] = '2';	//  If you do not pass the shipping address, PayPal obtains it from the buyer's account profile.
			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET'] = $primary_attendee->address();
			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET2'] = $primary_attendee->address2();
			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOCITY'] = $primary_attendee->city();
			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTATE'] = $primary_attendee->state_abbrev();
			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOCOUNTRYCODE'] = $primary_attendee->country_ID();
			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOZIP'] = $primary_attendee->zip();
			$token_request_dtls['PAYMENTREQUEST_0_EMAIL'] = $primary_attendee->email();
			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOPHONENUM'] = $primary_attendee->phone();
		}
		// Used a business/personal logo on the PayPal page.
		if ( ! empty($this->_image_url) ) {
			$token_request_dtls['LOGOIMG'] = $this->_image_url;
		}
		// Request PayPal token.
		$token_request_response = $this->_ppExpress_request( $token_request_dtls, 'Payment Token', $payment );
		$token_rstatus = $this->_ppExpress_check_response( $token_request_response );
		$response_args = ( isset($token_rstatus['args']) ) ? $token_rstatus['args'] : array();
		if ( $token_rstatus['status'] ) {
			// We got the Token so we may continue with the payment and redirect the client.
			$payment->set_details( $response_args );
			$payment->set_redirect_url( 'https://www.sandbox.paypal.com/cgi-bin/webscr?useraction=commit&cmd=_express-checkout&token=' . $response_args['TOKEN'] );
		} else {
			if ( isset($response_args['L_ERRORCODE']) ) {
				$payment->set_gateway_response( $response_args['L_ERRORCODE'] . '; ' . $response_args['L_SHORTMESSAGE'] );
			} else {
				$payment->set_gateway_response( __( 'Error occurred while trying to setup the Express Checkout.', 'event_espresso' ) );
			}
			$payment->set_details( $response_args );
			$payment->set_status( $this->_pay_model->failed_status() );
		}

		return $payment;
	}


	/**
	 *
	 *  @param array $update_info {
	 *	  @type string $gateway_txn_id
	 *	  @type string status an EEMI_Payment status
	 *  }
	 *  @param type $transaction
	 *  @return EEI_Payment
	 */
	public function handle_payment_update( $update_info, $transaction ) {
		$payment = ( $transaction instanceof EEI_Transaction ) ? $transaction->last_payment() : null;

		if ( $payment instanceof EEI_Payment ) {
			$this->log( array( 'Return from Authorization' => $update_info ), $payment );

			$payment_details = $payment->details();
			$transaction = $payment->transaction();
			if ( ! $transaction instanceof EEI_Transaction ) {
				$payment->set_gateway_response( __( 'Could not process this payment because it has no associated transaction.', 'event_espresso' ) );
				$payment->set_status( $this->_pay_model->failed_status() );
				return $payment;
			}
			$primary_registrant = $transaction->primary_registration();

			// Check if we still have the token.
			if ( ! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN']) ) {
				$payment->set_status( $this->_pay_model->failed_status() );
				return $payment;
			}

			$cdetails_request_dtls = array(
				'METHOD' => 'GetExpressCheckoutDetails',
				'TOKEN' => $payment_details['TOKEN']
			);
			// Request Customer Details.
			$cdetails_request_response = $this->_ppExpress_request( $cdetails_request_dtls, 'Customer Details', $payment );
			$cdetails_rstatus = $this->_ppExpress_check_response( $cdetails_request_response );
			$cdata_response_args = ( isset($cdetails_rstatus['args']) ) ? $cdetails_rstatus['args'] : array();
			if ( $cdetails_rstatus['status'] ) {
				// We got the PayerID so now we can Complete the transaction.
				$docheckout_request_dtls = array(
					'METHOD' => 'DoExpressCheckoutPayment',
					'PAYERID' => $cdata_response_args['PAYERID'],
					'TOKEN' => $payment_details['TOKEN'],
					'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
					'PAYMENTREQUEST_0_AMT' => $payment->amount(),
					'PAYMENTREQUEST_0_CURRENCYCODE' => $payment->currency_code()
				);
				// Payment Checkout/Capture.
				$docheckout_request_response = $this->_ppExpress_request( $docheckout_request_dtls, 'Do Payment', $payment );
				$docheckout_rstatus = $this->_ppExpress_check_response( $docheckout_request_response );
				$docheckout_response_args = ( isset($docheckout_rstatus['args']) ) ? $docheckout_rstatus['args'] : array();
				if ( $docheckout_rstatus['status'] ) {
					// All is well, payment approved.
					$primary_registration_code = $primary_registrant instanceof EE_Registration ? $primary_registrant->reg_code() : '';
					$payment->set_extra_accntng( $primary_registration_code );
					$payment->set_amount( isset($docheckout_response_args['PAYMENTINFO_0_AMT']) ? floatval( $docheckout_response_args['PAYMENTINFO_0_AMT'] ) : 0 );
					$payment->set_txn_id_chq_nmbr( isset( $docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID'] ) ? $docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID'] : null );
					$payment->set_details( $cdata_response_args );
					$payment->set_gateway_response( isset( $docheckout_response_args['PAYMENTINFO_0_ACK'] ) ? $docheckout_response_args['PAYMENTINFO_0_ACK'] : '' );
					$payment->set_status( $this->_pay_model->approved_status() );
				} else {
					if ( isset($docheckout_response_args['L_ERRORCODE']) ) {
						$payment->set_gateway_response( $docheckout_response_args['L_ERRORCODE'] . '; ' . $docheckout_response_args['L_SHORTMESSAGE'] );
					} else {
						$payment->set_gateway_response( __( 'Error occurred while trying to Capture the funds.', 'event_espresso' ) );
					}
					$payment->set_details( $docheckout_response_args );
					$payment->set_status( $this->_pay_model->declined_status() );
				}
			} else {
				if ( isset($cdata_response_args['L_ERRORCODE']) ) {
					$payment->set_gateway_response( $cdata_response_args['L_ERRORCODE'] . '; ' . $cdata_response_args['L_SHORTMESSAGE'] );
				} else {
					$payment->set_gateway_response( __( 'Error occurred while trying to get payment Details from PayPal.', 'event_espresso' ) );
				}
				$payment->set_details( $cdata_response_args );
				$payment->set_status( $this->_pay_model->failed_status() );
			}
		} else {
			$payment->set_gateway_response( __( 'Error occurred while trying to process the payment.', 'event_espresso' ) );
			$payment->set_status( $this->_pay_model->failed_status() );
		}

		return $payment;
	}


	/**
	 *  Make the Express checkout request.
	 *
	 *	@param array        $request_params
	 *	@param string       $request_text
	 *  @param EEI_Payment  $payment
	 *	@return mixed
	 */
	public function _ppExpress_request( $request_params, $request_text, $payment ) {
		$request_dtls = array(
			'VERSION' => '204.0',
			'USER' => urlencode( $this->_api_username ),
			'PWD' => urlencode( $this->_api_password ),
			'SIGNATURE' => urlencode( $this->_api_signature )
		);
		$dtls = array_merge( $request_dtls, $request_params );

		$this->_log_clean_request( $dtls, $payment, $request_text . ' Request' );
		// Request Customer Details.
		$request_response = wp_remote_post(
			$this->_base_gateway_url,
			array(
				'method' => 'POST',
				'timeout' => 45,
				'httpversion' => '1.1',
				'cookies' => array(),
				'headers' => array(),
				'body' => http_build_query( $dtls )
			)
		);
		// Log the response.
		$this->log( array( $request_text . ' Response' => $request_response), $payment );

		return $request_response;
	}


	/**
	 *  Check the response status.
	 *
	 *	@param mixed        $request_response
	 *	@return array
	 */
	public function _ppExpress_check_response( $request_response ) {
		if ( ! is_wp_error( $request_response ) && $request_response['body'] && ! empty($request_response['body'] ) ) {
			$response_args = array();
			parse_str( urldecode($request_response['body']), $response_args );
			if ( isset($response_args['ACK']) 
				&& $response_args['ACK'] === 'Success' 
				&& ( isset($response_args['PAYERID']) 
					|| isset($response_args['PAYMENTINFO_0_TRANSACTIONID']) 
					|| ( isset($response_args['PAYMENTSTATUS']) && $response_args['PAYMENTSTATUS'] === 'Completed' ) 
					|| isset($response_args['TOKEN']) 
				) 
			) {
				// Response status OK, return response parameters for further processing.
				return array('status' => true, 'args' => $response_args);
			} else {
				if ( isset($response_args['ACK']) ) {
					$errors = $this->_get_errors($response_args);
					return array( 'status' => false, 'args' => $errors );
				} else {
					return array( 'status' => false, 'args' => $request_response );
				}
			}
		} else {
			// If we got here then there was an error in this request.
			return array( 'status' => false, 'args' => $request_response );
		}
	}


	/**
	 *  Log a "Cleared" request.
	 *
	 *	@param array        $response
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
	 *	@param EEI_Payment  $payment
	 *	@param string  		$info
	 *	@return void
	 */
	private function _log_clean_request( $request_prms, $payment, $info ) {
		$cleaned_request_data = $request_prms;
		unset($cleaned_request_data['PWD']);
		unset($cleaned_request_data['USER']);
		unset($cleaned_request_data['SIGNATURE']);
		$this->log( array($info => $cleaned_request_data), $payment );
	}


	/**
	 *  Get error from the response data.
	 *
	 *  @param array	$data_array
	 *  @return array
	 */
	private function _get_errors( $data_array ) {
		$errors = array();
		$n = 0;
		while ( isset($data_array['L_ERRORCODE' . $n . '']) ) {
			$l_error_code = isset($data_array['L_ERRORCODE' . $n . '']) ? $data_array['L_ERRORCODE' . $n . ''] : '';
			$l_severity_code = isset($data_array['L_SEVERITYCODE' . $n . '']) ? $data_array['L_SEVERITYCODE' . $n . ''] : '';
			$l_short_message = isset($data_array['L_SHORTMESSAGE' . $n . '']) ? $data_array['L_SHORTMESSAGE' . $n . ''] : '';
			$l_long_message = isset($data_array['L_LONGMESSAGE' . $n . '']) ? $data_array['L_LONGMESSAGE' . $n . ''] : '';

			if ( $n == 0 ) {
				$errors = array(
					'L_ERRORCODE' => $l_error_code,
					'L_SHORTMESSAGE' => $l_short_message,
					'L_LONGMESSAGE' => $l_long_message,
					'L_SEVERITYCODE' => $l_severity_code
				);
			} else {
				$errors['L_ERRORCODE'] .= ', ' . $l_error_code;
				$errors['L_SHORTMESSAGE'] .= ', ' . $l_short_message;
				$errors['L_LONGMESSAGE'] .= ', ' . $l_long_message;
				$errors['L_SEVERITYCODE'] .= ', ' . $l_severity_code;
			}

			$n++;
		}

		return $errors;
	}

}
// End of file EEG_Paypal_Express.gateway.php

1		<?php if ( ! defined( 'EVENT_ESPRESSO_VERSION' )) { exit('NO direct script access allowed'); }
2
3		/**
4		* ----------------------------------------------
5		*
6		* Class EEG_Paypal_Express
7		*
8		* @package Event Espresso
9		* @subpackage eea-paypal-express
10		* @author Event Espresso
11		* @version $VID:$
12		*
13		* ----------------------------------------------
14		*/
15		class EEG_Paypal_Express extends EE_Offsite_Gateway {
16
17		/**
18		* Merchant API Username.
19		* @var string
20		*/
21		protected $_api_username = null;
22
23		/**
24		* Merchant API Password.
25		* @var string
26		*/
27		protected $_api_password = null;
28
29		/**
30		* API Signature.
31		* @var string
32		*/
33		protected $_api_signature = null;
34
35		/**
36		* Business/personal logo.
37		* @var string
38		*/
39		protected $_image_url = null;
40
41		/**
42		* All the currencies supported by this gateway.
43		* @var array
44		*/
45		protected $_currencies_supported = array(
46		'USD',
47		'AUD',
48		'BRL',
49		'CAD',
50		'CZK',
51		'DKK',
52		'EUR',
53		'HKD',
54		'HUF',
55		'ILS',
56		'JPY',
57		'MYR',
58		'MXN',
59		'NOK',
60		'NZD',
61		'PHP',
62		'PLN',
63		'GBP',
64		'RUB',
65		'SGD',
66		'SEK',
67		'CHF',
68		'TWD',
69		'THB',
70		'TRY'
71		);
72
73
74		/**
75		* Sets the gateway URL variable based on whether debug mode is enabled or not.
76		*
77		* @param type $settings_array
78		*/
79		public function set_settings( $settings_array ) {
80		parent::set_settings($settings_array);
81		// Redirect URL.
82		if ( $this->_debug_mode ) {
83		$this->_base_gateway_url = 'https://api-3t.sandbox.paypal.com/nvp';
		0 ignored issues – show Bug introduced 2016-09-06 22:30 UTC by Report Bug Copy Issue Report The property `_base_gateway_url` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
84		} else {
85		$this->_base_gateway_url = 'https://api-3t.paypal.com/nvp';
86		}
87		}
88
89
90		/**
91		*
92		* @param EEI_Payment $payment
93		* @param type $billing_info
94		* @param type $return_url
95		* @param type $cancel_url
96		*/
97		public function set_redirection_info( $payment, $billing_info = array(), $return_url = NULL, $notify_url = NULL, $cancel_url = NULL ) {
98	View Code Duplication	if ( ! $payment instanceof EEI_Payment ) {
99		$payment->set_gateway_response( __( 'Error. No associated payment was found.', 'event_espresso' ) );
100		$payment->set_status( $this->_pay_model->failed_status() );
101		return $payment;
102		}
103		$transaction = $payment->transaction();
104	View Code Duplication	if ( ! $transaction instanceof EEI_Transaction ) {
105		$payment->set_gateway_response( __( 'Could not process this payment because it has no associated transaction.', 'event_espresso' ) );
106		$payment->set_status( $this->_pay_model->failed_status() );
107		return $payment;
108		}
109		$order_description = substr( sprintf( __('Event Registrations from %s', 'event_espresso'), get_bloginfo('name') ), 0, 127 );
110		$primary_registration = $transaction->primary_registration();
111		$primary_attendee = $primary_registration instanceof EE_Registration ? $primary_registration->attendee() : false;
112		$locale = explode('-', get_bloginfo('language'));
113
114		// Gather request parameters.
115		$token_request_dtls = array(
116		'METHOD' => 'SetExpressCheckout',
117		'PAYMENTREQUEST_0_AMT' => $payment->amount(),
118		'PAYMENTREQUEST_0_CURRENCYCODE' => $payment->currency_code(),
119		'PAYMENTREQUEST_0_DESC' => $order_description,
120		'RETURNURL' => $return_url,
121		'CANCELURL' => $cancel_url,
122		'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
123		'SOLUTIONTYPE' => 'Sole', // Buyer does not need to create a PayPal account to check out. This is referred to as PayPal Account Optional.
124		'BUTTONSOURCE' => 'EventEspresso_SP',//EE will blow up if you change this
125		'LOCALECODE' => $locale[1] // Locale of the pages displayed by PayPal during Express Checkout.
126		);
127
128		// Show itemized list.
129		if ( EEH_Money::compare_floats( $payment->amount(), $transaction->total(), '==' ) ) {
130		$item_num = 0;
131		$itemized_sum = 0;
132		$total_line_items = $transaction->total_line_item();
133		// Go through each item in the list.
134		foreach ( $total_line_items->get_items() as $line_item ) {
135		if ( $line_item instanceof EE_Line_Item ) {
136		// PayPal doesn't like line items with 0.00 amount, so we may skip those.
137		if ( EEH_Money::compare_floats( $line_item->total(), '0.00', '==' ) ) {
138		continue;
139		}
140
141		$unit_price = $line_item->unit_price();
142		$line_item_quantity = $line_item->quantity();
143		// This is a discount.
144		if ( $line_item->is_percent() ) {
145		$unit_price = $line_item->total();
146		$line_item_quantity = 1;
147		}
148		// Item Name.
149		$token_request_dtls['L_PAYMENTREQUEST_0_NAME'.$item_num] = substr($line_item->name(), 0, 127);
150		// Item description.
151		$token_request_dtls['L_PAYMENTREQUEST_0_DESC'.$item_num] = substr($line_item->desc(), 0, 127);
152		// Cost of individual item.
153		$token_request_dtls['L_PAYMENTREQUEST_0_AMT'.$item_num] = $this->format_currency( $unit_price );
154		// Item Number.
155		$token_request_dtls['L_PAYMENTREQUEST_0_NUMBER'.$item_num] = $item_num + 1;
156		// Item quantity.
157		$token_request_dtls['L_PAYMENTREQUEST_0_QTY'.$item_num] = $line_item_quantity;
158		// Digital item is sold.
159		$token_request_dtls['L_PAYMENTREQUEST_0_ITEMCATEGORY'.$item_num] = 'Digital';
160		$itemized_sum += $line_item->total();
161		++$item_num;
162		}
163		}
164		// Item's sales S/H and tax amount.
165		$token_request_dtls['PAYMENTREQUEST_0_ITEMAMT'] = $total_line_items->get_items_total();
166		$token_request_dtls['PAYMENTREQUEST_0_TAXAMT'] = $total_line_items->get_total_tax();
167		$token_request_dtls['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
168		$token_request_dtls['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
169
170		$itemized_sum_diff_from_txn_total = round( $transaction->total() - $itemized_sum - $total_line_items->get_total_tax(), 2 );
171		// If we were not able to recognize some item like promotion, surcharge or cancellation,
172		// add the difference as an extra line item.
173		if ( $itemized_sum_diff_from_txn_total != 0 ) {
174		// Item Name.
175		$token_request_dtls['L_PAYMENTREQUEST_0_NAME'.$item_num] = substr( __( 'Other (promotion/surcharge/cancellation)', 'event_espresso' ), 0, 127 );
176		// Item description.
177		$token_request_dtls['L_PAYMENTREQUEST_0_DESC'.$item_num] = substr( $line_item->desc(), 0, 127 );
		0 ignored issues – show Bug introduced 2016-09-06 22:30 UTC by Report Bug Copy Issue Report The variable `$line_item` seems to be defined by a `foreach` iteration on line `134`. Are you sure the iterator is never empty, otherwise this variable is not defined? It seems like you are relying on a variable being defined by an iteration: foreach ($a as $b) { } // $b is defined here only if $a has elements, for example if $a is array() // then $b would not be defined here. To avoid that, we recommend to set a // default value for $b. // Better $b = 0; // or whatever default makes sense in your context foreach ($a as $b) { } // $b is now guaranteed to be defined here. Loading history...
178		// Cost of individual item.
179		$token_request_dtls['L_PAYMENTREQUEST_0_AMT'.$item_num] = $this->format_currency( $itemized_sum_diff_from_txn_total );
180		// Item Number.
181		$token_request_dtls['L_PAYMENTREQUEST_0_NUMBER'.$item_num] = $item_num + 1;
182		// Item quantity.
183		$token_request_dtls['L_PAYMENTREQUEST_0_QTY'.$item_num] = 1;
184		++$item_num;
185		}
186		} else {
187		// Just one Item.
188		// Item Name.
189		$token_request_dtls['L_PAYMENTREQUEST_0_NAME0'] = substr( sprintf( __('Payment for %1$s', 'event_espresso'), $primary_registration->reg_code() ), 0, 127 );
190		// Item description.
191		$token_request_dtls['L_PAYMENTREQUEST_0_DESC0'] = substr( sprintf( __('Payment of %1$s for %2$s', 'event_espresso'), $payment->amount(), $primary_registration->reg_code() ), 0, 127 );
192		// Cost of individual item.
193		$token_request_dtls['L_PAYMENTREQUEST_0_AMT0'] = $this->format_currency( $payment->amount() );
194		// Item Number.
195		$token_request_dtls['L_PAYMENTREQUEST_0_NUMBER0'] = 1;
196		// Item quantity.
197		$token_request_dtls['L_PAYMENTREQUEST_0_QTY0'] = 1;
198		// Digital item is sold.
199		$token_request_dtls['L_PAYMENTREQUEST_0_ITEMCATEGORY0'] = 'Digital';
200		// Item's sales S/H and tax amount.
201		$token_request_dtls['PAYMENTREQUEST_0_ITEMAMT'] = $this->format_currency( $payment->amount() );
202		$token_request_dtls['PAYMENTREQUEST_0_TAXAMT'] = '0';
203		$token_request_dtls['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
204		$token_request_dtls['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
205		}
206		// Automatically filling out shipping and contact information.
207		if ( $primary_attendee instanceof EEI_Attendee ) {
208		$token_request_dtls['NOSHIPPING'] = '2'; // If you do not pass the shipping address, PayPal obtains it from the buyer's account profile.
209		$token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET'] = $primary_attendee->address();
210		$token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET2'] = $primary_attendee->address2();
211		$token_request_dtls['PAYMENTREQUEST_0_SHIPTOCITY'] = $primary_attendee->city();
212		$token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTATE'] = $primary_attendee->state_abbrev();
213		$token_request_dtls['PAYMENTREQUEST_0_SHIPTOCOUNTRYCODE'] = $primary_attendee->country_ID();
214		$token_request_dtls['PAYMENTREQUEST_0_SHIPTOZIP'] = $primary_attendee->zip();
215		$token_request_dtls['PAYMENTREQUEST_0_EMAIL'] = $primary_attendee->email();
216		$token_request_dtls['PAYMENTREQUEST_0_SHIPTOPHONENUM'] = $primary_attendee->phone();
217		}
218		// Used a business/personal logo on the PayPal page.
219		if ( ! empty($this->_image_url) ) {
220		$token_request_dtls['LOGOIMG'] = $this->_image_url;
221		}
222		// Request PayPal token.
223		$token_request_response = $this->_ppExpress_request( $token_request_dtls, 'Payment Token', $payment );
224		$token_rstatus = $this->_ppExpress_check_response( $token_request_response );
225		$response_args = ( isset($token_rstatus['args']) ) ? $token_rstatus['args'] : array();
226		if ( $token_rstatus['status'] ) {
227		// We got the Token so we may continue with the payment and redirect the client.
228		$payment->set_details( $response_args );
229		$payment->set_redirect_url( 'https://www.sandbox.paypal.com/cgi-bin/webscr?useraction=commit&cmd=_express-checkout&token=' . $response_args['TOKEN'] );
230	View Code Duplication	} else {
231		if ( isset($response_args['L_ERRORCODE']) ) {
232		$payment->set_gateway_response( $response_args['L_ERRORCODE'] . '; ' . $response_args['L_SHORTMESSAGE'] );
233		} else {
234		$payment->set_gateway_response( __( 'Error occurred while trying to setup the Express Checkout.', 'event_espresso' ) );
235		}
236		$payment->set_details( $response_args );
237		$payment->set_status( $this->_pay_model->failed_status() );
238		}
239
240		return $payment;
241		}
242
243
244		/**
245		*
246		* @param array $update_info {
247		* @type string $gateway_txn_id
248		* @type string status an EEMI_Payment status
249		* }
250		* @param type $transaction
251		* @return EEI_Payment
252		*/
253		public function handle_payment_update( $update_info, $transaction ) {
254		$payment = ( $transaction instanceof EEI_Transaction ) ? $transaction->last_payment() : null;
255
256		if ( $payment instanceof EEI_Payment ) {
257		$this->log( array( 'Return from Authorization' => $update_info ), $payment );
258
259		$payment_details = $payment->details();
260		$transaction = $payment->transaction();
261	View Code Duplication	if ( ! $transaction instanceof EEI_Transaction ) {
262		$payment->set_gateway_response( __( 'Could not process this payment because it has no associated transaction.', 'event_espresso' ) );
263		$payment->set_status( $this->_pay_model->failed_status() );
264		return $payment;
265		}
266		$primary_registrant = $transaction->primary_registration();
267
268		// Check if we still have the token.
269		if ( ! isset($payment_details['TOKEN']) \|\| empty($payment_details['TOKEN']) ) {
270		$payment->set_status( $this->_pay_model->failed_status() );
271		return $payment;
272		}
273
274		$cdetails_request_dtls = array(
275		'METHOD' => 'GetExpressCheckoutDetails',
276		'TOKEN' => $payment_details['TOKEN']
277		);
278		// Request Customer Details.
279		$cdetails_request_response = $this->_ppExpress_request( $cdetails_request_dtls, 'Customer Details', $payment );
280		$cdetails_rstatus = $this->_ppExpress_check_response( $cdetails_request_response );
281		$cdata_response_args = ( isset($cdetails_rstatus['args']) ) ? $cdetails_rstatus['args'] : array();
282		if ( $cdetails_rstatus['status'] ) {
283		// We got the PayerID so now we can Complete the transaction.
284		$docheckout_request_dtls = array(
285		'METHOD' => 'DoExpressCheckoutPayment',
286		'PAYERID' => $cdata_response_args['PAYERID'],
287		'TOKEN' => $payment_details['TOKEN'],
288		'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
289		'PAYMENTREQUEST_0_AMT' => $payment->amount(),
290		'PAYMENTREQUEST_0_CURRENCYCODE' => $payment->currency_code()
291		);
292		// Payment Checkout/Capture.
293		$docheckout_request_response = $this->_ppExpress_request( $docheckout_request_dtls, 'Do Payment', $payment );
294		$docheckout_rstatus = $this->_ppExpress_check_response( $docheckout_request_response );
295		$docheckout_response_args = ( isset($docheckout_rstatus['args']) ) ? $docheckout_rstatus['args'] : array();
296		if ( $docheckout_rstatus['status'] ) {
297		// All is well, payment approved.
298		$primary_registration_code = $primary_registrant instanceof EE_Registration ? $primary_registrant->reg_code() : '';
299		$payment->set_extra_accntng( $primary_registration_code );
300		$payment->set_amount( isset($docheckout_response_args['PAYMENTINFO_0_AMT']) ? floatval( $docheckout_response_args['PAYMENTINFO_0_AMT'] ) : 0 );
301		$payment->set_txn_id_chq_nmbr( isset( $docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID'] ) ? $docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID'] : null );
302		$payment->set_details( $cdata_response_args );
303		$payment->set_gateway_response( isset( $docheckout_response_args['PAYMENTINFO_0_ACK'] ) ? $docheckout_response_args['PAYMENTINFO_0_ACK'] : '' );
304		$payment->set_status( $this->_pay_model->approved_status() );
305	View Code Duplication	} else {
306		if ( isset($docheckout_response_args['L_ERRORCODE']) ) {
307		$payment->set_gateway_response( $docheckout_response_args['L_ERRORCODE'] . '; ' . $docheckout_response_args['L_SHORTMESSAGE'] );
308		} else {
309		$payment->set_gateway_response( __( 'Error occurred while trying to Capture the funds.', 'event_espresso' ) );
310		}
311		$payment->set_details( $docheckout_response_args );
312		$payment->set_status( $this->_pay_model->declined_status() );
313		}
314	View Code Duplication	} else {
315		if ( isset($cdata_response_args['L_ERRORCODE']) ) {
316		$payment->set_gateway_response( $cdata_response_args['L_ERRORCODE'] . '; ' . $cdata_response_args['L_SHORTMESSAGE'] );
317		} else {
318		$payment->set_gateway_response( __( 'Error occurred while trying to get payment Details from PayPal.', 'event_espresso' ) );
319		}
320		$payment->set_details( $cdata_response_args );
321		$payment->set_status( $this->_pay_model->failed_status() );
322		}
323		} else {
324		$payment->set_gateway_response( __( 'Error occurred while trying to process the payment.', 'event_espresso' ) );
325		$payment->set_status( $this->_pay_model->failed_status() );
326		}
327
328		return $payment;
329		}
330
331
332		/**
333		* Make the Express checkout request.
334		*
335		* @param array $request_params
336		* @param string $request_text
337		* @param EEI_Payment $payment
338		* @return mixed
339		*/
340		public function _ppExpress_request( $request_params, $request_text, $payment ) {
341		$request_dtls = array(
342		'VERSION' => '204.0',
343		'USER' => urlencode( $this->_api_username ),
344		'PWD' => urlencode( $this->_api_password ),
345		'SIGNATURE' => urlencode( $this->_api_signature )
346		);
347		$dtls = array_merge( $request_dtls, $request_params );
348
349		$this->_log_clean_request( $dtls, $payment, $request_text . ' Request' );
350		// Request Customer Details.
351		$request_response = wp_remote_post(
352		$this->_base_gateway_url,
353		array(
354		'method' => 'POST',
355		'timeout' => 45,
356		'httpversion' => '1.1',
357		'cookies' => array(),
358		'headers' => array(),
359		'body' => http_build_query( $dtls )
360		)
361		);
362		// Log the response.
363		$this->log( array( $request_text . ' Response' => $request_response), $payment );
364
365		return $request_response;
366		}
367
368
369		/**
370		* Check the response status.
371		*
372		* @param mixed $request_response
373		* @return array
374		*/
375		public function _ppExpress_check_response( $request_response ) {
376		if ( ! is_wp_error( $request_response ) && $request_response['body'] && ! empty($request_response['body'] ) ) {
377		$response_args = array();
378		parse_str( urldecode($request_response['body']), $response_args );
379		if ( isset($response_args['ACK'])
380		&& $response_args['ACK'] === 'Success'
381		&& ( isset($response_args['PAYERID'])
382		\|\| isset($response_args['PAYMENTINFO_0_TRANSACTIONID'])
383		\|\| ( isset($response_args['PAYMENTSTATUS']) && $response_args['PAYMENTSTATUS'] === 'Completed' )
384		\|\| isset($response_args['TOKEN'])
385		)
386		) {
387		// Response status OK, return response parameters for further processing.
388		return array('status' => true, 'args' => $response_args);
389		} else {
390		if ( isset($response_args['ACK']) ) {
391		$errors = $this->_get_errors($response_args);
392		return array( 'status' => false, 'args' => $errors );
393		} else {
394		return array( 'status' => false, 'args' => $request_response );
395		}
396		}
397		} else {
398		// If we got here then there was an error in this request.
399		return array( 'status' => false, 'args' => $request_response );
400		}
401		}
402
403
404		/**
405		* Log a "Cleared" request.
406		*
407		* @param array $response
		0 ignored issues – show Bug introduced 2016-09-06 22:30 UTC by Report Bug Copy Issue Report There is no parameter named `$response`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
408		* @param EEI_Payment $payment
409		* @param string $info
410		* @return void
411		*/
412		private function _log_clean_request( $request_prms, $payment, $info ) {
413		$cleaned_request_data = $request_prms;
414		unset($cleaned_request_data['PWD']);
415		unset($cleaned_request_data['USER']);
416		unset($cleaned_request_data['SIGNATURE']);
417		$this->log( array($info => $cleaned_request_data), $payment );
418		}
419
420
421		/**
422		* Get error from the response data.
423		*
424		* @param array $data_array
425		* @return array
426		*/
427		private function _get_errors( $data_array ) {
428		$errors = array();
429		$n = 0;
430		while ( isset($data_array['L_ERRORCODE' . $n . '']) ) {
431		$l_error_code = isset($data_array['L_ERRORCODE' . $n . '']) ? $data_array['L_ERRORCODE' . $n . ''] : '';
432		$l_severity_code = isset($data_array['L_SEVERITYCODE' . $n . '']) ? $data_array['L_SEVERITYCODE' . $n . ''] : '';
433		$l_short_message = isset($data_array['L_SHORTMESSAGE' . $n . '']) ? $data_array['L_SHORTMESSAGE' . $n . ''] : '';
434		$l_long_message = isset($data_array['L_LONGMESSAGE' . $n . '']) ? $data_array['L_LONGMESSAGE' . $n . ''] : '';
435
436		if ( $n == 0 ) {
437		$errors = array(
438		'L_ERRORCODE' => $l_error_code,
439		'L_SHORTMESSAGE' => $l_short_message,
440		'L_LONGMESSAGE' => $l_long_message,
441		'L_SEVERITYCODE' => $l_severity_code
442		);
443		} else {
444		$errors['L_ERRORCODE'] .= ', ' . $l_error_code;
445		$errors['L_SHORTMESSAGE'] .= ', ' . $l_short_message;
446		$errors['L_LONGMESSAGE'] .= ', ' . $l_long_message;
447		$errors['L_SEVERITYCODE'] .= ', ' . $l_severity_code;
448		}
449
450		$n++;
451		}
452
453		return $errors;
454		}
455
456		}
457		// End of file EEG_Paypal_Express.gateway.php

eventespresso / event-espresso-core