316 lines
9.6 KiB
PHP
316 lines
9.6 KiB
PHP
<?php
|
|
|
|
if ( ! defined( 'ABSPATH' ) ) {
|
|
exit; // Exit if accessed directly
|
|
}
|
|
|
|
/**
|
|
* Generates requests to send to PayPal
|
|
*/
|
|
class WC_Gateway_Paypal_Request {
|
|
|
|
/**
|
|
* Stores line items to send to PayPal
|
|
* @var array
|
|
*/
|
|
protected $line_items = array();
|
|
|
|
/**
|
|
* Pointer to gateway making the request
|
|
* @var WC_Gateway_Paypal
|
|
*/
|
|
protected $gateway;
|
|
|
|
/**
|
|
* Endpoint for requests from PayPal
|
|
* @var string
|
|
*/
|
|
protected $notify_url;
|
|
|
|
/**
|
|
* Constructor
|
|
* @param WC_Gateway_Paypal $gateway
|
|
*/
|
|
public function __construct( $gateway ) {
|
|
$this->gateway = $gateway;
|
|
$this->notify_url = WC()->api_request_url( 'WC_Gateway_Paypal' );
|
|
}
|
|
|
|
/**
|
|
* Get the PayPal request URL for an order
|
|
* @param WC_Order $order
|
|
* @param boolean $sandbox
|
|
* @return string
|
|
*/
|
|
public function get_request_url( $order, $sandbox = false ) {
|
|
$paypal_args = http_build_query( $this->get_paypal_args( $order ), '', '&' );
|
|
|
|
if ( $sandbox ) {
|
|
return 'https://www.sandbox.paypal.com/cgi-bin/webscr?test_ipn=1&' . $paypal_args;
|
|
} else {
|
|
return 'https://www.paypal.com/cgi-bin/webscr?' . $paypal_args;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get PayPal Args for passing to PP
|
|
*
|
|
* @param WC_Order $order
|
|
* @return array
|
|
*/
|
|
protected function get_paypal_args( $order ) {
|
|
$this->gateway->log( 'Generating payment form for order ' . $order->get_order_number() . '. Notify URL: ' . $this->notify_url );
|
|
|
|
return apply_filters( 'woocommerce_paypal_args', array_merge(
|
|
array(
|
|
'cmd' => '_cart',
|
|
'business' => $this->gateway->get_option( '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->gateway->get_return_url( $order ) ) ),
|
|
'cancel_return' => esc_url( $order->get_cancel_order_url() ),
|
|
'page_style' => $this->gateway->get_option( 'page_style' ),
|
|
'paymentaction' => $this->gateway->get_option( 'paymentaction' ),
|
|
'bn' => 'WooThemes_Cart',
|
|
'invoice' => $this->gateway->get_option( 'invoice_prefix' ) . $order->get_order_number(),
|
|
'custom' => serialize( array( $order->id, $order->order_key ) ),
|
|
'notify_url' => $this->notify_url,
|
|
'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
|
|
),
|
|
$this->get_phone_number_args( $order ),
|
|
$this->get_shipping_args( $order ),
|
|
$this->get_line_item_args( $order )
|
|
), $order );
|
|
}
|
|
|
|
/**
|
|
* Get phone number args for paypal request
|
|
* @param WC_Order $order
|
|
* @return array
|
|
*/
|
|
protected function get_phone_number_args( $order ) {
|
|
if ( in_array( $order->billing_country, array( 'US','CA' ) ) ) {
|
|
$phone_number = str_replace( array( '(', '-', ' ', ')', '.' ), '', $order->billing_phone );
|
|
$phone_args = array(
|
|
'night_phone_a' => substr( $phone_number, 0, 3 ),
|
|
'night_phone_b' => substr( $phone_number, 3, 3 ),
|
|
'night_phone_c' => substr( $phone_number, 6, 4 ),
|
|
'day_phone_a' => substr( $phone_number, 0, 3 ),
|
|
'day_phone_b' => substr( $phone_number, 3, 3 ),
|
|
'day_phone_c' => substr( $phone_number, 6, 4 )
|
|
);
|
|
} else {
|
|
$phone_args = array(
|
|
'night_phone_b' => $order->billing_phone,
|
|
'day_phone_b' => $order->billing_phone
|
|
);
|
|
}
|
|
return $phone_args;
|
|
}
|
|
|
|
/**
|
|
* Get shipping args for paypal request
|
|
* @param WC_Order $order
|
|
* @return array
|
|
*/
|
|
protected function get_shipping_args( $order ) {
|
|
$shipping_args = array();
|
|
|
|
if ( 'yes' == $this->gateway->get_option( 'send_shipping' ) ) {
|
|
$shipping_args['address_override'] = $this->gateway->get_option( 'address_override' ) === 'yes' ? 1 : 0;
|
|
$shipping_args['no_shipping'] = 0;
|
|
|
|
// If we are sending shipping, send shipping address instead of billing
|
|
$shipping_args['first_name'] = $order->shipping_first_name;
|
|
$shipping_args['last_name'] = $order->shipping_last_name;
|
|
$shipping_args['company'] = $order->shipping_company;
|
|
$shipping_args['address1'] = $order->shipping_address_1;
|
|
$shipping_args['address2'] = $order->shipping_address_2;
|
|
$shipping_args['city'] = $order->shipping_city;
|
|
$shipping_args['state'] = $this->get_paypal_state( $order->shipping_country, $order->shipping_state );
|
|
$shipping_args['country'] = $order->shipping_country;
|
|
$shipping_args['zip'] = $order->shipping_postcode;
|
|
} else {
|
|
$shipping_args['no_shipping'] = 1;
|
|
}
|
|
|
|
return $shipping_args;
|
|
}
|
|
|
|
/**
|
|
* Get line item args for paypal request
|
|
* @param WC_Order $order
|
|
* @return array
|
|
*/
|
|
protected function get_line_item_args( $order ) {
|
|
/**
|
|
* Try passing a line item per product if supported
|
|
*/
|
|
if ( ( ! wc_tax_enabled() || ! wc_prices_include_tax() ) && $this->prepare_line_items( $order ) ) {
|
|
|
|
$line_item_args = $this->get_line_items();
|
|
$line_item_args['tax_cart'] = $order->get_total_tax();
|
|
|
|
if ( $order->get_total_discount() > 0 ) {
|
|
$line_item_args['discount_amount_cart'] = round( $order->get_total_discount(), 2 );
|
|
}
|
|
|
|
/**
|
|
* Send order as a single item
|
|
*
|
|
* For shipping, we longer use shipping_1 because paypal ignores it if *any* shipping rules are within paypal, and paypal ignores anything over 5 digits (999.99 is the max)
|
|
*/
|
|
} else {
|
|
|
|
$this->delete_line_items();
|
|
|
|
$this->add_line_item( $this->get_order_item_names( $order ), 1, number_format( $order->get_total() - round( $order->get_total_shipping() + $order->get_shipping_tax(), 2 ), 2, '.', '' ), $order->get_order_number() );
|
|
$this->add_line_item( sprintf( __( 'Shipping via %s', 'woocommerce' ), ucwords( $order->get_shipping_method() ) ), 1, number_format( $order->get_total_shipping() + $order->get_shipping_tax(), 2, '.', '' ) );
|
|
|
|
$line_item_args = $this->get_line_items();
|
|
}
|
|
|
|
return $line_item_args;
|
|
}
|
|
|
|
/**
|
|
* Get order item names as a string
|
|
* @param WC_Order $order
|
|
* @return string
|
|
*/
|
|
protected function get_order_item_names( $order ) {
|
|
$item_names = array();
|
|
|
|
foreach ( $order->get_items() as $item ) {
|
|
$item_names[] = $item['name'] . ' x ' . $item['qty'];
|
|
}
|
|
|
|
return implode( ', ', $item_names );
|
|
}
|
|
|
|
/**
|
|
* Get order item names as a string
|
|
* @param WC_Order $order
|
|
* @param array $item
|
|
* @return string
|
|
*/
|
|
protected function get_order_item_name( $order, $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 . ' )';
|
|
}
|
|
|
|
return $item_name;
|
|
}
|
|
|
|
/**
|
|
* Return all line items
|
|
*/
|
|
protected function get_line_items() {
|
|
return $this->line_items;
|
|
}
|
|
|
|
/**
|
|
* Remove all line items
|
|
*/
|
|
protected function delete_line_items() {
|
|
$this->line_items = array();
|
|
}
|
|
|
|
/**
|
|
* Get line items to send to paypal
|
|
*
|
|
* @param WC_Order $order
|
|
* @return bool
|
|
*/
|
|
protected function prepare_line_items( $order ) {
|
|
$this->delete_line_items();
|
|
$calculated_total = 0;
|
|
|
|
// Products
|
|
foreach ( $order->get_items( array( 'line_item', 'fee' ) ) as $item ) {
|
|
if ( 'fee' === $item['type'] ) {
|
|
$line_item = $this->add_line_item( $item['name'], 1, $item['line_total'] );
|
|
$calculated_total += $item['line_total'];
|
|
} else {
|
|
$product = $order->get_product_from_item( $item );
|
|
$line_item = $this->add_line_item( $this->get_order_item_name( $order, $item ), $item['qty'], $order->get_item_subtotal( $item, false ), $product->get_sku() );
|
|
$calculated_total += $order->get_item_subtotal( $item, false ) * $item['qty'];
|
|
}
|
|
|
|
if ( ! $line_item ) {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
// Shipping Cost item - paypal only allows shipping per item, we want to send shipping for the order
|
|
if ( $order->get_total_shipping() > 0 && ! $this->add_line_item( sprintf( __( 'Shipping via %s', 'woocommerce' ), $order->get_shipping_method() ), 1, round( $order->get_total_shipping(), 2 ) ) ) {
|
|
return false;
|
|
}
|
|
|
|
// Check for mismatched totals
|
|
if ( ( $calculated_total + $order->get_total_tax() + round( $order->get_total_shipping(), 2 ) - round( $order->get_total_discount(), 2 ) ) != $order->get_total() ) {
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Add PayPal Line Item
|
|
* @param string $item_name
|
|
* @param integer $quantity
|
|
* @param integer $amount
|
|
* @param string $item_number
|
|
* @return bool successfully added or not
|
|
*/
|
|
protected function add_line_item( $item_name, $quantity = 1, $amount = 0, $item_number = '' ) {
|
|
$index = ( sizeof( $this->line_items ) / 4 ) + 1;
|
|
|
|
if ( ! $item_name || $amount < 0 || $index > 9 ) {
|
|
return false;
|
|
}
|
|
|
|
$this->line_items[ 'item_name_' . $index ] = html_entity_decode( wc_trim_string( $item_name, 127 ), ENT_NOQUOTES, 'UTF-8' );
|
|
$this->line_items[ 'quantity_' . $index ] = $quantity;
|
|
$this->line_items[ 'amount_' . $index ] = $amount;
|
|
$this->line_items[ 'item_number_' . $index ] = $item_number;
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Get the state to send to paypal
|
|
* @param string $cc
|
|
* @param string $state
|
|
* @return string
|
|
*/
|
|
protected 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;
|
|
}
|
|
}
|