:
%s', 'woocommerce' ), wc_get_log_file_path( 'paypal' ) )
)
);
}
/**
* Limit the length of item names
* @param string $item_name
* @return string
*/
public function paypal_item_name( $item_name ) {
if ( strlen( $item_name ) > 127 ) {
$item_name = substr( $item_name, 0, 124 ) . '...';
}
return html_entity_decode( $item_name, ENT_NOQUOTES, 'UTF-8' );
}
/**
* Get PayPal Args for passing to PP
*
* @access public
* @param mixed $order
* @return array
*/
function get_paypal_args( $order ) {
$order_id = $order->id;
if ( 'yes' == $this->debug ) {
$this->log->add( 'paypal', 'Generating payment form for order ' . $order->get_order_number() . '. Notify URL: ' . $this->notify_url );
}
if ( in_array( $order->billing_country, array( 'US','CA' ) ) ) {
$order->billing_phone = str_replace( array( '(', '-', ' ', ')', '.' ), '', $order->billing_phone );
$phone_args = array(
'night_phone_a' => substr( $order->billing_phone, 0, 3 ),
'night_phone_b' => substr( $order->billing_phone, 3, 3 ),
'night_phone_c' => substr( $order->billing_phone, 6, 4 ),
'day_phone_a' => substr( $order->billing_phone, 0, 3 ),
'day_phone_b' => substr( $order->billing_phone, 3, 3 ),
'day_phone_c' => substr( $order->billing_phone, 6, 4 )
);
} else {
$phone_args = array(
'night_phone_b' => $order->billing_phone,
'day_phone_b' => $order->billing_phone
);
}
// PayPal Args
$paypal_args = array_merge(
array(
'cmd' => '_cart',
'business' => $this->email,
'no_note' => 1,
'currency_code' => get_woocommerce_currency(),
'charset' => 'UTF-8',
'rm' => is_ssl() ? 2 : 1,
'upload' => 1,
'return' => esc_url( add_query_arg( 'utm_nooverride', '1', $this->get_return_url( $order ) ) ),
'cancel_return' => esc_url( $order->get_cancel_order_url() ),
'page_style' => $this->page_style,
'paymentaction' => $this->paymentaction,
'bn' => 'WooThemes_Cart',
// Order key + ID
'invoice' => $this->invoice_prefix . ltrim( $order->get_order_number(), '#' ),
'custom' => serialize( array( $order_id, $order->order_key ) ),
// IPN
'notify_url' => $this->notify_url,
// Billing Address info
'first_name' => $order->billing_first_name,
'last_name' => $order->billing_last_name,
'company' => $order->billing_company,
'address1' => $order->billing_address_1,
'address2' => $order->billing_address_2,
'city' => $order->billing_city,
'state' => $this->get_paypal_state( $order->billing_country, $order->billing_state ),
'zip' => $order->billing_postcode,
'country' => $order->billing_country,
'email' => $order->billing_email
),
$phone_args
);
// Shipping
if ( 'yes' == $this->send_shipping ) {
$paypal_args['address_override'] = ( $this->address_override == 'yes' ) ? 1 : 0;
$paypal_args['no_shipping'] = 0;
// If we are sending shipping, send shipping address instead of billing
$paypal_args['first_name'] = $order->shipping_first_name;
$paypal_args['last_name'] = $order->shipping_last_name;
$paypal_args['company'] = $order->shipping_company;
$paypal_args['address1'] = $order->shipping_address_1;
$paypal_args['address2'] = $order->shipping_address_2;
$paypal_args['city'] = $order->shipping_city;
$paypal_args['state'] = $this->get_paypal_state( $order->shipping_country, $order->shipping_state );
$paypal_args['country'] = $order->shipping_country;
$paypal_args['zip'] = $order->shipping_postcode;
} else {
$paypal_args['no_shipping'] = 1;
}
// If prices include tax or have order discounts, send the whole order as a single item
if ( get_option( 'woocommerce_prices_include_tax' ) == 'yes' || $order->get_order_discount() > 0 || ( sizeof( $order->get_items() ) + sizeof( $order->get_fees() ) ) >= 9 ) {
// Discount
$paypal_args['discount_amount_cart'] = $order->get_order_discount();
// Don't pass items - paypal borks tax due to prices including tax. PayPal has no option for tax inclusive pricing sadly. Pass 1 item for the order items overall
$item_names = array();
if ( sizeof( $order->get_items() ) > 0 ) {
foreach ( $order->get_items() as $item ) {
if ( $item['qty'] ) {
$item_names[] = $item['name'] . ' x ' . $item['qty'];
}
}
}
$paypal_args['item_name_1'] = $this->paypal_item_name( sprintf( __( 'Order %s' , 'woocommerce'), $order->get_order_number() ) . " - " . implode( ', ', $item_names ) );
$paypal_args['quantity_1'] = 1;
$paypal_args['amount_1'] = number_format( $order->get_total() - round( $order->get_total_shipping() + $order->get_shipping_tax(), 2 ) + $order->get_order_discount(), 2, '.', '' );
// Shipping Cost
// No longer using shipping_1 because
// a) paypal ignore it if *any* shipping rules are within paypal
// b) paypal ignore anything over 5 digits, so 999.99 is the max
if ( ( $order->get_total_shipping() + $order->get_shipping_tax() ) > 0 ) {
$paypal_args['item_name_2'] = $this->paypal_item_name( __( 'Shipping via', 'woocommerce' ) . ' ' . ucwords( $order->get_shipping_method() ) );
$paypal_args['quantity_2'] = '1';
$paypal_args['amount_2'] = number_format( $order->get_total_shipping() + $order->get_shipping_tax(), 2, '.', '' );
}
} else {
// Tax
$paypal_args['tax_cart'] = $order->get_total_tax();
// Cart Contents
$item_loop = 0;
if ( sizeof( $order->get_items() ) > 0 ) {
foreach ( $order->get_items() as $item ) {
if ( $item['qty'] ) {
$item_loop++;
$product = $order->get_product_from_item( $item );
$item_name = $item['name'];
$item_meta = new WC_Order_Item_Meta( $item['item_meta'] );
if ( $meta = $item_meta->display( true, true ) ) {
$item_name .= ' ( ' . $meta . ' )';
}
$paypal_args[ 'item_name_' . $item_loop ] = $this->paypal_item_name( $item_name );
$paypal_args[ 'quantity_' . $item_loop ] = $item['qty'];
$paypal_args[ 'amount_' . $item_loop ] = $order->get_item_subtotal( $item, false );
if ( $product->get_sku() ) {
$paypal_args[ 'item_number_' . $item_loop ] = $product->get_sku();
}
}
}
}
// Discount
if ( $order->get_cart_discount() > 0 ) {
$paypal_args['discount_amount_cart'] = round( $order->get_cart_discount(), 2 );
}
// Fees
if ( sizeof( $order->get_fees() ) > 0 ) {
foreach ( $order->get_fees() as $item ) {
$item_loop++;
$paypal_args[ 'item_name_' . $item_loop ] = $this->paypal_item_name( $item['name'] );
$paypal_args[ 'quantity_' . $item_loop ] = 1;
$paypal_args[ 'amount_' . $item_loop ] = $item['line_total'];
}
}
// Shipping Cost item - paypal only allows shipping per item, we want to send shipping for the order
if ( $order->get_total_shipping() > 0 ) {
$item_loop++;
$paypal_args[ 'item_name_' . $item_loop ] = $this->paypal_item_name( sprintf( __( 'Shipping via %s', 'woocommerce' ), $order->get_shipping_method() ) );
$paypal_args[ 'quantity_' . $item_loop ] = '1';
$paypal_args[ 'amount_' . $item_loop ] = number_format( $order->get_total_shipping(), 2, '.', '' );
}
}
$paypal_args = apply_filters( 'woocommerce_paypal_args', $paypal_args );
return $paypal_args;
}
/**
* Generate the paypal button link
*
* @access public
* @param mixed $order_id
* @return string
*/
function generate_paypal_form( $order_id ) {
$order = new WC_Order( $order_id );
if ( 'yes' == $this->testmode ) {
$paypal_adr = $this->testurl . '?test_ipn=1&';
} else {
$paypal_adr = $this->liveurl . '?';
}
$paypal_args = $this->get_paypal_args( $order );
$paypal_args_array = array();
foreach ( $paypal_args as $key => $value ) {
$paypal_args_array[] = '';
}
wc_enqueue_js( '
$.blockUI({
message: "' . esc_js( __( 'Thank you for your order. We are now redirecting you to PayPal to make payment.', 'woocommerce' ) ) . '",
baseZ: 99999,
overlayCSS:
{
background: "#fff",
opacity: 0.6
},
css: {
padding: "20px",
zindex: "9999999",
textAlign: "center",
color: "#555",
border: "3px solid #aaa",
backgroundColor:"#fff",
cursor: "wait",
lineHeight: "24px",
}
});
jQuery("#submit_paypal_payment_form").click();
' );
return '';
}
/**
* Process the payment and return the result
*
* @access public
* @param int $order_id
* @return array
*/
function process_payment( $order_id ) {
$order = new WC_Order( $order_id );
if ( ! $this->form_submission_method ) {
$paypal_args = $this->get_paypal_args( $order );
$paypal_args = http_build_query( $paypal_args, '', '&' );
if ( 'yes' == $this->testmode ) {
$paypal_adr = $this->testurl . '?test_ipn=1&';
} else {
$paypal_adr = $this->liveurl . '?';
}
return array(
'result' => 'success',
'redirect' => $paypal_adr . $paypal_args
);
} else {
return array(
'result' => 'success',
'redirect' => $order->get_checkout_payment_url( true )
);
}
}
/**
* Output for the order received page.
*
* @access public
* @return void
*/
function receipt_page( $order ) {
echo '' . __( 'Thank you - your order is now pending payment. You should be automatically redirected to PayPal to make payment.', 'woocommerce' ) . '
'; echo $this->generate_paypal_form( $order ); } /** * Check PayPal IPN validity **/ function check_ipn_request_is_valid( $ipn_response ) { // Get url if ( 'yes' == $this->testmode ) { $paypal_adr = $this->testurl; } else { $paypal_adr = $this->liveurl; } if ( 'yes' == $this->debug ) { $this->log->add( 'paypal', 'Checking IPN response is valid via ' . $paypal_adr . '...' ); } // Get received values from post data $validate_ipn = array( 'cmd' => '_notify-validate' ); $validate_ipn += stripslashes_deep( $ipn_response ); // Send back post vars to paypal $params = array( 'body' => $validate_ipn, 'sslverify' => false, 'timeout' => 60, 'httpversion' => '1.1', 'compress' => false, 'decompress' => false, 'user-agent' => 'WooCommerce/' . WC()->version ); if ( 'yes' == $this->debug ) { $this->log->add( 'paypal', 'IPN Request: ' . print_r( $params, true ) ); } // Post back to get a response $response = wp_remote_post( $paypal_adr, $params ); if ( 'yes' == $this->debug ) { $this->log->add( 'paypal', 'IPN Response: ' . print_r( $response, true ) ); } // check to see if the request was valid if ( ! is_wp_error( $response ) && $response['response']['code'] >= 200 && $response['response']['code'] < 300 && ( strcmp( $response['body'], "VERIFIED" ) == 0 ) ) { if ( 'yes' == $this->debug ) { $this->log->add( 'paypal', 'Received valid response from PayPal' ); } return true; } if ( 'yes' == $this->debug ) { $this->log->add( 'paypal', 'Received invalid response from PayPal' ); if ( is_wp_error( $response ) ) { $this->log->add( 'paypal', 'Error response: ' . $response->get_error_message() ); } } return false; } /** * Check for PayPal IPN Response * * @access public * @return void */ function check_ipn_response() { @ob_clean(); $ipn_response = ! empty( $_POST ) ? $_POST : false; if ( $ipn_response && $this->check_ipn_request_is_valid( $ipn_response ) ) { header( 'HTTP/1.1 200 OK' ); do_action( "valid-paypal-standard-ipn-request", $ipn_response ); } else { wp_die( "PayPal IPN Request Failure", "PayPal IPN", array( 'response' => 200 ) ); } } /** * Successful Payment! * * @access public * @param array $posted * @return void */ function successful_request( $posted ) { $posted = stripslashes_deep( $posted ); // Custom holds post ID if ( ! empty( $posted['invoice'] ) && ! empty( $posted['custom'] ) ) { $order = $this->get_paypal_order( $posted['custom'], $posted['invoice'] ); if ( 'yes' == $this->debug ) { $this->log->add( 'paypal', 'Found order #' . $order->id ); } // Lowercase returned variables $posted['payment_status'] = strtolower( $posted['payment_status'] ); $posted['txn_type'] = strtolower( $posted['txn_type'] ); // Sandbox fix if ( 1 == $posted['test_ipn'] && 'pending' == $posted['payment_status'] ) { $posted['payment_status'] = 'completed'; } if ( 'yes' == $this->debug ) { $this->log->add( 'paypal', 'Payment status: ' . $posted['payment_status'] ); } // We are here so lets check status and do actions switch ( $posted['payment_status'] ) { case 'completed' : case 'pending' : // Check order not already completed if ( $order->has_status( 'completed' ) ) { if ( 'yes' == $this->debug ) { $this->log->add( 'paypal', 'Aborting, Order #' . $order->id . ' is already complete.' ); } exit; } // Check valid txn_type $accepted_types = array( 'cart', 'instant', 'express_checkout', 'web_accept', 'masspay', 'send_money' ); if ( ! in_array( $posted['txn_type'], $accepted_types ) ) { if ( 'yes' == $this->debug ) { $this->log->add( 'paypal', 'Aborting, Invalid type:' . $posted['txn_type'] ); } exit; } // Validate currency if ( $order->get_order_currency() != $posted['mc_currency'] ) { if ( 'yes' == $this->debug ) { $this->log->add( 'paypal', 'Payment error: Currencies do not match (sent "' . $order->get_order_currency() . '" | returned "' . $posted['mc_currency'] . '")' ); } // Put this order on-hold for manual checking $order->update_status( 'on-hold', sprintf( __( 'Validation error: PayPal currencies do not match (code %s).', 'woocommerce' ), $posted['mc_currency'] ) ); exit; } // Validate amount if ( $order->get_total() != $posted['mc_gross'] ) { if ( 'yes' == $this->debug ) { $this->log->add( 'paypal', 'Payment error: Amounts do not match (gross ' . $posted['mc_gross'] . ')' ); } // Put this order on-hold for manual checking $order->update_status( 'on-hold', sprintf( __( 'Validation error: PayPal amounts do not match (gross %s).', 'woocommerce' ), $posted['mc_gross'] ) ); exit; } // Validate Email Address if ( strcasecmp( trim( $posted['receiver_email'] ), trim( $this->receiver_email ) ) != 0 ) { if ( 'yes' == $this->debug ) { $this->log->add( 'paypal', "IPN Response is for another one: {$posted['receiver_email']} our email is {$this->receiver_email}" ); } // Put this order on-hold for manual checking $order->update_status( 'on-hold', sprintf( __( 'Validation error: PayPal IPN response from a different email address (%s).', 'woocommerce' ), $posted['receiver_email'] ) ); exit; } // Store PP Details if ( ! empty( $posted['payer_email'] ) ) { update_post_meta( $order->id, 'Payer PayPal address', wc_clean( $posted['payer_email'] ) ); } if ( ! empty( $posted['first_name'] ) ) { update_post_meta( $order->id, 'Payer first name', wc_clean( $posted['first_name'] ) ); } if ( ! empty( $posted['last_name'] ) ) { update_post_meta( $order->id, 'Payer last name', wc_clean( $posted['last_name'] ) ); } if ( ! empty( $posted['payment_type'] ) ) { update_post_meta( $order->id, 'Payment type', wc_clean( $posted['payment_type'] ) ); } if ( $posted['payment_status'] == 'completed' ) { $order->add_order_note( __( 'IPN payment completed', 'woocommerce' ) ); $txn_id = ( ! empty( $posted['txn_id'] ) ) ? wc_clean( $posted['txn_id'] ) : ''; $order->payment_complete( $txn_id ); } else { $order->update_status( 'on-hold', sprintf( __( 'Payment pending: %s', 'woocommerce' ), $posted['pending_reason'] ) ); } if ( 'yes' == $this->debug ) { $this->log->add( 'paypal', 'Payment complete.' ); } break; case 'denied' : case 'expired' : case 'failed' : case 'voided' : // Order failed $order->update_status( 'failed', sprintf( __( 'Payment %s via IPN.', 'woocommerce' ), strtolower( $posted['payment_status'] ) ) ); break; case 'refunded' : // Only handle full refunds, not partial if ( $order->get_total() == ( $posted['mc_gross'] * -1 ) ) { // Mark order as refunded $order->update_status( 'refunded', sprintf( __( 'Payment %s via IPN.', 'woocommerce' ), strtolower( $posted['payment_status'] ) ) ); $this->send_ipn_email_notification( sprintf( __( 'Payment for order %s refunded/reversed', 'woocommerce' ), $order->get_order_number() ), sprintf( __( 'Order %s has been marked as refunded - PayPal reason code: %s', 'woocommerce' ), $order->get_order_number(), $posted['reason_code'] ) ); } break; case 'reversed' : // Mark order as refunded $order->update_status( 'on-hold', sprintf( __( 'Payment %s via IPN.', 'woocommerce' ), strtolower( $posted['payment_status'] ) ) ); $this->send_ipn_email_notification( sprintf( __( 'Payment for order %s reversed', 'woocommerce' ), $order->get_order_number() ), sprintf(__( 'Order %s has been marked on-hold due to a reversal - PayPal reason code: %s', 'woocommerce' ), $order->get_order_number(), $posted['reason_code'] ) ); break; case 'canceled_reversal' : $this->send_ipn_email_notification( sprintf( __( 'Reversal cancelled for order %s', 'woocommerce' ), $order->get_order_number() ), sprintf( __( 'Order %s has had a reversal cancelled. Please check the status of payment and update the order status accordingly.', 'woocommerce' ), $order->get_order_number() ) ); break; default : // No action break; } exit; } } /** * Send a notification to the user handling orders. * @param string $subject * @param string $message */ public function send_ipn_email_notification( $subject, $message ) { $new_order_settings = get_option( 'woocommerce_new_order_settings', array() ); $mailer = WC()->mailer(); $message = $mailer->wrap_message( $subject, $message ); $mailer->send( ! empty( $new_order_settings['recipient'] ) ? $new_order_settings['recipient'] : get_option( 'admin_email' ), $subject, $message ); } /** * Return handler * * Alternative to IPN */ public function pdt_return_handler() { $posted = stripslashes_deep( $_REQUEST ); if ( ! empty( $this->identity_token ) && ! empty( $posted['cm'] ) ) { $order = $this->get_paypal_order( $posted['cm'] ); if ( ! $order->has_status( 'pending' ) ) { return false; } $posted['st'] = strtolower( $posted['st'] ); switch ( $posted['st'] ) { case 'completed' : // Validate transaction if ( 'yes' == $this->testmode ) { $paypal_adr = $this->testurl; } else { $paypal_adr = $this->liveurl; } $pdt = array( 'body' => array( 'cmd' => '_notify-synch', 'tx' => $posted['tx'], 'at' => $this->identity_token ), 'sslverify' => false, 'timeout' => 60, 'httpversion' => '1.1', 'user-agent' => 'WooCommerce/' . WC_VERSION ); // Post back to get a response $response = wp_remote_post( $paypal_adr, $pdt ); if ( is_wp_error( $response ) ) { return false; } if ( ! strpos( $response['body'], "SUCCESS" ) === 0 ) { return false; } // Validate Amount if ( $order->get_total() != $posted['amt'] ) { if ( 'yes' == $this->debug ) { $this->log->add( 'paypal', 'Payment error: Amounts do not match (amt ' . $posted['amt'] . ')' ); } // Put this order on-hold for manual checking $order->update_status( 'on-hold', sprintf( __( 'Validation error: PayPal amounts do not match (amt %s).', 'woocommerce' ), $posted['amt'] ) ); return true; } else { // Store PP Details $order->add_order_note( __( 'PDT payment completed', 'woocommerce' ) ); $txn_id = ( ! empty( $posted['tx'] ) ) ? wc_clean( $posted['tx'] ) : ''; $order->payment_complete( $txn_id ); return true; } break; } } return false; } /** * get_paypal_order function. * * @param string $custom * @param string $invoice * @return WC_Order object */ private function get_paypal_order( $custom, $invoice = '' ) { $custom = maybe_unserialize( $custom ); // Backwards comp for IPN requests if ( is_numeric( $custom ) ) { $order_id = (int) $custom; $order_key = $invoice; } elseif( is_string( $custom ) ) { $order_id = (int) str_replace( $this->invoice_prefix, '', $custom ); $order_key = $custom; } else { list( $order_id, $order_key ) = $custom; } $order = new WC_Order( $order_id ); if ( ! isset( $order->id ) ) { // We have an invalid $order_id, probably because invoice_prefix has changed $order_id = wc_get_order_id_by_order_key( $order_key ); $order = new WC_Order( $order_id ); } // Validate key if ( $order->order_key !== $order_key ) { if ( 'yes' == $this->debug ) { $this->log->add( 'paypal', 'Error: Order Key does not match invoice.' ); } exit; } return $order; } /** * Get the state to send to paypal * @param string $cc * @param string $state * @return string */ public function get_paypal_state( $cc, $state ) { if ( 'US' === $cc ) { return $state; } $states = WC()->countries->get_states( $cc ); if ( isset( $states[ $state ] ) ) { return $states[ $state ]; } return $state; } }