' . sprintf( __( 'Simplify Commerce Error: Simplify commerce requires PHP 5.3 and above. You are using version %s.', 'woocommerce' ), phpversion() ) . '
' . __( 'Simplify Commerce Error: Please enter your public and private keys', 'woocommerce' ) . '
';
-
- } elseif ( 'standard' == $this->mode && ! wc_checkout_is_https() ) {
-
- // Show message when using standard mode and no SSL on the checkout page
- echo '
' . sprintf( __( 'Simplify Commerce is enabled, but the force SSL option is disabled; your checkout may not be secure! Please enable SSL and ensure your server has a valid SSL certificate - Simplify Commerce will only work in sandbox mode.', 'woocommerce' ), admin_url( 'admin.php?page=wc-settings&tab=checkout' ) ) . '
';
-
- }
- }
-
- /**
- * Check if this gateway is enabled.
- *
- * @return bool
- */
- public function is_available() {
- if ( 'yes' !== $this->enabled ) {
- return false;
- }
-
- if ( 'standard' === $this->mode && 'yes' !== $this->sandbox && ! wc_checkout_is_https() ) {
- return false;
- }
-
- if ( ! $this->public_key || ! $this->private_key ) {
- return false;
- }
-
- return true;
- }
-
- /**
- * Initialise Gateway Settings Form Fields.
- */
- public function init_form_fields() {
- $this->form_fields = array(
- 'enabled' => array(
- 'title' => __( 'Enable/Disable', 'woocommerce' ),
- 'label' => __( 'Enable Simplify Commerce', 'woocommerce' ),
- 'type' => 'checkbox',
- 'description' => '',
- 'default' => 'no',
- ),
- 'title' => array(
- 'title' => __( 'Title', 'woocommerce' ),
- 'type' => 'text',
- 'description' => __( 'This controls the title which the user sees during checkout.', 'woocommerce' ),
- 'default' => __( 'Credit card', 'woocommerce' ),
- 'desc_tip' => true,
- ),
- 'description' => array(
- 'title' => __( 'Description', 'woocommerce' ),
- 'type' => 'text',
- 'description' => __( 'This controls the description which the user sees during checkout.', 'woocommerce' ),
- 'default' => 'Pay with your credit card via Simplify Commerce by MasterCard.',
- 'desc_tip' => true,
- ),
- 'mode' => array(
- 'title' => __( 'Payment mode', 'woocommerce' ),
- 'label' => __( 'Enable Hosted Payments', 'woocommerce' ),
- 'type' => 'select',
- 'description' => sprintf( __( 'Standard will display the credit card fields on your store (SSL required). %1$s Hosted Payments will display a Simplify Commerce modal dialog on your store (if SSL) or will redirect the customer to Simplify Commerce hosted page (if not SSL). %1$s Note: Hosted Payments need a new API Key pair with the hosted payments flag selected. %2$sFor more details check the Simplify Commerce docs%3$s.', 'woocommerce' ), ' ', '', '' ),
- 'default' => 'standard',
- 'options' => array(
- 'standard' => __( 'Standard', 'woocommerce' ),
- 'hosted' => __( 'Hosted Payments', 'woocommerce' ),
- ),
- ),
- 'modal_color' => array(
- 'title' => __( 'Modal color', 'woocommerce' ),
- 'type' => 'color',
- 'description' => __( 'Set the color of the buttons and titles on the modal dialog.', 'woocommerce' ),
- 'default' => '#a46497',
- 'desc_tip' => true,
- ),
- 'sandbox' => array(
- 'title' => __( 'Sandbox', 'woocommerce' ),
- 'label' => __( 'Enable sandbox mode', 'woocommerce' ),
- 'type' => 'checkbox',
- 'description' => __( 'Place the payment gateway in sandbox mode using sandbox API keys (real payments will not be taken).', 'woocommerce' ),
- 'default' => 'yes',
- ),
- 'sandbox_public_key' => array(
- 'title' => __( 'Sandbox public key', 'woocommerce' ),
- 'type' => 'text',
- 'description' => __( 'Get your API keys from your Simplify account: Settings > API Keys.', 'woocommerce' ),
- 'default' => '',
- 'desc_tip' => true,
- ),
- 'sandbox_private_key' => array(
- 'title' => __( 'Sandbox private key', 'woocommerce' ),
- 'type' => 'text',
- 'description' => __( 'Get your API keys from your Simplify account: Settings > API Keys.', 'woocommerce' ),
- 'default' => '',
- 'desc_tip' => true,
- ),
- 'public_key' => array(
- 'title' => __( 'Public key', 'woocommerce' ),
- 'type' => 'text',
- 'description' => __( 'Get your API keys from your Simplify account: Settings > API Keys.', 'woocommerce' ),
- 'default' => '',
- 'desc_tip' => true,
- ),
- 'private_key' => array(
- 'title' => __( 'Private key', 'woocommerce' ),
- 'type' => 'text',
- 'description' => __( 'Get your API keys from your Simplify account: Settings > API Keys.', 'woocommerce' ),
- 'default' => '',
- 'desc_tip' => true,
- ),
- );
- }
-
- /**
- * Payment form on checkout page.
- */
- public function payment_fields() {
- $description = $this->get_description();
-
- if ( 'yes' == $this->sandbox ) {
- $description .= ' ' . sprintf( __( 'TEST MODE ENABLED. Use a test card: %s', 'woocommerce' ), 'https://www.simplify.com/commerce/docs/tutorial/index#testing' );
- }
-
- if ( $description ) {
- echo wpautop( wptexturize( trim( $description ) ) );
- }
-
- if ( 'standard' == $this->mode ) {
- parent::payment_fields();
- }
- }
-
- /**
- * Outputs scripts used for simplify payment.
- */
- public function payment_scripts() {
- $load_scripts = false;
-
- if ( is_checkout() ) {
- $load_scripts = true;
- }
- if ( $this->is_available() ) {
- $load_scripts = true;
- }
-
- if ( false === $load_scripts ) {
- return;
- }
-
- wp_enqueue_script( 'simplify-commerce', 'https://www.simplify.com/commerce/v1/simplify.js', array( 'jquery' ), WC_VERSION, true );
- wp_enqueue_script( 'wc-simplify-commerce', WC()->plugin_url() . '/includes/gateways/simplify-commerce/assets/js/simplify-commerce.js', array( 'simplify-commerce', 'wc-credit-card-form' ), WC_VERSION, true );
- wp_localize_script(
- 'wc-simplify-commerce', 'Simplify_commerce_params', array(
- 'key' => $this->public_key,
- 'card.number' => __( 'Card number', 'woocommerce' ),
- 'card.expMonth' => __( 'Expiry month', 'woocommerce' ),
- 'card.expYear' => __( 'Expiry year', 'woocommerce' ),
- 'is_invalid' => __( 'is invalid', 'woocommerce' ),
- 'mode' => $this->mode,
- 'is_ssl' => is_ssl(),
- )
- );
- }
-
- public function add_payment_method() {
- if ( empty( $_POST['simplify_token'] ) ) {
- wc_add_notice( __( 'There was a problem adding this card.', 'woocommerce' ), 'error' );
- return;
- }
-
- $cart_token = wc_clean( $_POST['simplify_token'] );
- $customer_token = $this->get_users_token();
- $current_user = wp_get_current_user();
- $customer_info = array(
- 'email' => $current_user->user_email,
- 'name' => $current_user->display_name,
- );
-
- $token = $this->save_token( $customer_token, $cart_token, $customer_info );
- if ( is_null( $token ) ) {
- wc_add_notice( __( 'There was a problem adding this card.', 'woocommerce' ), 'error' );
- return;
- }
-
- return array(
- 'result' => 'success',
- 'redirect' => wc_get_endpoint_url( 'payment-methods' ),
- );
- }
-
- /**
- * Actually saves a customer token to the database.
- *
- * @param WC_Payment_Token $customer_token Payment Token
- * @param string $cart_token CC Token
- * @param array $customer_info 'email', 'name'
- *
- * @return null|WC_Payment_Token|WC_Payment_Token_CC
- */
- public function save_token( $customer_token, $cart_token, $customer_info ) {
- if ( ! is_null( $customer_token ) ) {
- $customer = Simplify_Customer::findCustomer( $customer_token->get_token() );
- $updates = array( 'token' => $cart_token );
- $customer->setAll( $updates );
- $customer->updateCustomer();
- $customer = Simplify_Customer::findCustomer( $customer_token->get_token() ); // get updated customer with new set card
- $token = $customer_token;
- } else {
- $customer = Simplify_Customer::createCustomer(
- array(
- 'token' => $cart_token,
- 'email' => $customer_info['email'],
- 'name' => $customer_info['name'],
- )
- );
- $token = new WC_Payment_Token_CC();
- $token->set_token( $customer->id );
- }
-
- // If we were able to create an save our card, save the data on our side too
- if ( is_object( $customer ) && '' != $customer->id ) {
- $customer_properties = $customer->getProperties();
- $card = $customer_properties['card'];
- $token->set_gateway_id( $this->id );
- $token->set_card_type( strtolower( $card->type ) );
- $token->set_last4( $card->last4 );
- $expiry_month = ( 1 === strlen( $card->expMonth ) ? '0' . $card->expMonth : $card->expMonth );
- $token->set_expiry_month( $expiry_month );
- $token->set_expiry_year( '20' . $card->expYear );
- if ( is_user_logged_in() ) {
- $token->set_user_id( get_current_user_id() );
- }
- $token->save();
- return $token;
- }
-
- return null;
- }
-
- /**
- * Process customer: updating or creating a new customer/saved CC
- *
- * @param WC_Order $order Order object
- * @param WC_Payment_Token $customer_token Payment Token
- * @param string $cart_token CC Token
- */
- protected function process_customer( $order, $customer_token = null, $cart_token = '' ) {
- // Are we saving a new payment method?
- if ( is_user_logged_in() && isset( $_POST['wc-simplify_commerce-new-payment-method'] ) && true === (bool) $_POST['wc-simplify_commerce-new-payment-method'] ) {
- $customer_info = array(
- 'email' => $order->get_billing_email(),
- 'name' => trim( $order->get_formatted_billing_full_name() ),
- );
- $token = $this->save_token( $customer_token, $cart_token, $customer_info );
- if ( ! is_null( $token ) ) {
- $order->add_payment_token( $token );
- }
- }
- }
-
- /**
- * Process standard payments.
- *
- * @param WC_Order $order
- * @param string $cart_token
- * @param string $customer_token
- *
- * @return array
- * @uses Simplify_ApiException
- * @uses Simplify_BadRequestException
- */
- protected function process_standard_payments( $order, $cart_token = '', $customer_token = '' ) {
- try {
-
- if ( empty( $cart_token ) && empty( $customer_token ) ) {
- $error_msg = __( 'Please make sure your card details have been entered correctly and that your browser supports JavaScript.', 'woocommerce' );
-
- if ( 'yes' == $this->sandbox ) {
- $error_msg .= ' ' . __( 'Developers: Please make sure that you are including jQuery and there are no JavaScript errors on the page.', 'woocommerce' );
- }
-
- throw new Simplify_ApiException( $error_msg );
- }
-
- // We need to figure out if we want to charge the card token (new unsaved token, no customer, etc)
- // or the customer token (just saved method, previously saved method)
- $pass_tokens = array();
-
- if ( ! empty( $cart_token ) ) {
- $pass_tokens['token'] = $cart_token;
- }
-
- if ( ! empty( $customer_token ) ) {
- $pass_tokens['customer'] = $customer_token;
- // Use the customer token only, since we already saved the (one time use) card token to the customer
- if ( isset( $_POST['wc-simplify_commerce-new-payment-method'] ) && true === (bool) $_POST['wc-simplify_commerce-new-payment-method'] ) {
- unset( $pass_tokens['token'] );
- }
- }
-
- // Did we create an account and save a payment method? We might need to use the customer token instead of the card token
- if ( isset( $_POST['createaccount'] ) && true === (bool) $_POST['createaccount'] && empty( $customer_token ) ) {
- $user_token = $this->get_users_token();
- if ( ! is_null( $user_token ) ) {
- $pass_tokens['customer'] = $user_token->get_token();
- unset( $pass_tokens['token'] );
- }
- }
-
- $payment_response = $this->do_payment( $order, $order->get_total(), $pass_tokens );
-
- if ( is_wp_error( $payment_response ) ) {
- throw new Simplify_ApiException( $payment_response->get_error_message() );
- } else {
- // Remove cart
- WC()->cart->empty_cart();
-
- // Return thank you page redirect
- return array(
- 'result' => 'success',
- 'redirect' => $this->get_return_url( $order ),
- );
- }
- } catch ( Simplify_ApiException $e ) {
- if ( $e instanceof Simplify_BadRequestException && $e->hasFieldErrors() && $e->getFieldErrors() ) {
- foreach ( $e->getFieldErrors() as $error ) {
- wc_add_notice( $error->getFieldName() . ': "' . $error->getMessage() . '" (' . $error->getErrorCode() . ')', 'error' );
- }
- } else {
- wc_add_notice( $e->getMessage(), 'error' );
- }
-
- return array(
- 'result' => 'fail',
- 'redirect' => '',
- );
- }
- }
-
- /**
- * do payment function.
- *
- * @param WC_order $order
- * @param int $amount (default: 0)
- * @param array $token
- *
- * @return bool|WP_Error
- * @uses Simplify_BadRequestException
- */
- public function do_payment( $order, $amount = 0, $token = array() ) {
- if ( $amount * 100 < 50 ) {
- return new WP_Error( 'simplify_error', __( 'Sorry, the minimum allowed order total is 0.50 to use this payment method.', 'woocommerce' ) );
- }
-
- try {
- // Charge the customer
- $data = array(
- 'amount' => $amount * 100, // In cents.
- 'description' => sprintf( __( '%1$s - Order #%2$s', 'woocommerce' ), esc_html( get_bloginfo( 'name', 'display' ) ), $order->get_order_number() ),
- 'currency' => strtoupper( get_woocommerce_currency() ),
- 'reference' => $order->get_id(),
- );
-
- $data = array_merge( $data, $token );
- $payment = Simplify_Payment::createPayment( $data );
-
- } catch ( Exception $e ) {
-
- $error_message = $e->getMessage();
-
- if ( $e instanceof Simplify_BadRequestException && $e->hasFieldErrors() && $e->getFieldErrors() ) {
- $error_message = '';
- foreach ( $e->getFieldErrors() as $error ) {
- $error_message .= ' ' . $error->getFieldName() . ': "' . $error->getMessage() . '" (' . $error->getErrorCode() . ')';
- }
- }
-
- $order->add_order_note( sprintf( __( 'Simplify payment error: %s.', 'woocommerce' ), $error_message ) );
-
- return new WP_Error( 'simplify_payment_declined', $e->getMessage(), array( 'status' => $e->getCode() ) );
- }
-
- if ( 'APPROVED' == $payment->paymentStatus ) {
- // Payment complete
- $order->payment_complete( $payment->id );
-
- // Add order note
- $order->add_order_note( sprintf( __( 'Simplify payment approved (ID: %1$s, Auth Code: %2$s)', 'woocommerce' ), $payment->id, $payment->authCode ) );
-
- return true;
- } else {
- $order->add_order_note( __( 'Simplify payment declined', 'woocommerce' ) );
-
- return new WP_Error( 'simplify_payment_declined', __( 'Payment was declined - please try another card.', 'woocommerce' ) );
- }
- }
-
- /**
- * Process standard payments.
- *
- * @param WC_Order $order
- * @return array
- */
- protected function process_hosted_payments( $order ) {
- return array(
- 'result' => 'success',
- 'redirect' => $order->get_checkout_payment_url( true ),
- );
- }
-
- protected function get_users_token() {
- $customer_token = null;
- if ( is_user_logged_in() ) {
- $tokens = WC_Payment_Tokens::get_customer_tokens( get_current_user_id() );
- foreach ( $tokens as $token ) {
- if ( $token->get_gateway_id() === $this->id ) {
- $customer_token = $token;
- break;
- }
- }
- }
- return $customer_token;
- }
-
- /**
- * Process the payment.
- *
- * @param int $order_id
- *
- * @return array|void
- */
- public function process_payment( $order_id ) {
- $order = wc_get_order( $order_id );
-
- // Payment/CC form is hosted on Simplify
- if ( 'hosted' === $this->mode ) {
- return $this->process_hosted_payments( $order );
- }
-
- // New CC info was entered
- if ( isset( $_POST['simplify_token'] ) ) {
- $cart_token = wc_clean( $_POST['simplify_token'] );
- $customer_token = $this->get_users_token();
- $customer_token_value = ( ! is_null( $customer_token ) ? $customer_token->get_token() : '' );
- $this->process_customer( $order, $customer_token, $cart_token );
- return $this->process_standard_payments( $order, $cart_token, $customer_token_value );
- }
-
- // Possibly Create (or update) customer/save payment token, use an existing token, and then process the payment
- if ( isset( $_POST['wc-simplify_commerce-payment-token'] ) && 'new' !== $_POST['wc-simplify_commerce-payment-token'] ) {
- $token_id = wc_clean( $_POST['wc-simplify_commerce-payment-token'] );
- $token = WC_Payment_Tokens::get( $token_id );
- if ( $token->get_user_id() !== get_current_user_id() ) {
- wc_add_notice( __( 'Please make sure your card details have been entered correctly and that your browser supports JavaScript.', 'woocommerce' ), 'error' );
- return;
- }
- $this->process_customer( $order, $token );
- return $this->process_standard_payments( $order, '', $token->get_token() );
- }
- }
-
- /**
- * Hosted payment args.
- *
- * @param WC_Order $order
- *
- * @return array
- */
- protected function get_hosted_payments_args( $order ) {
- $args = apply_filters(
- 'woocommerce_simplify_commerce_hosted_args', array(
- 'sc-key' => $this->public_key,
- 'amount' => $order->get_total() * 100,
- 'reference' => $order->get_id(),
- 'name' => esc_html( get_bloginfo( 'name', 'display' ) ),
- 'description' => sprintf( __( 'Order #%s', 'woocommerce' ), $order->get_order_number() ),
- 'receipt' => 'false',
- 'color' => $this->modal_color,
- 'redirect-url' => WC()->api_request_url( 'WC_Gateway_Simplify_Commerce' ),
- 'address' => $order->get_billing_address_1() . ' ' . $order->get_billing_address_2(),
- 'address-city' => $order->get_billing_city(),
- 'address-state' => $order->get_billing_state(),
- 'address-zip' => $order->get_billing_postcode(),
- 'address-country' => $order->get_billing_country(),
- 'operation' => 'create.token',
- ), $order->get_id()
- );
-
- return $args;
- }
-
- /**
- * Receipt page.
- *
- * @param int $order_id
- */
- public function receipt_page( $order_id ) {
- $order = wc_get_order( $order_id );
-
- echo '
' . __( 'Thank you for your order, please click the button below to pay with credit card using Simplify Commerce by MasterCard.', 'woocommerce' ) . '
';
-
- $args = $this->get_hosted_payments_args( $order );
- $button_args = array();
- foreach ( $args as $key => $value ) {
- $button_args[] = 'data-' . esc_attr( $key ) . '="' . esc_attr( $value ) . '"';
- }
-
- echo '
- ' . __( 'Cancel order & restore cart', 'woocommerce' ) . '
- ';
- }
-
- /**
- * Return handler for Hosted Payments.
- */
- public function return_handler() {
- @ob_clean();
- header( 'HTTP/1.1 200 OK' );
-
- if ( isset( $_REQUEST['reference'] ) && isset( $_REQUEST['paymentId'] ) && isset( $_REQUEST['signature'] ) ) {
- $signature = strtoupper( md5( $_REQUEST['amount'] . $_REQUEST['reference'] . $_REQUEST['paymentId'] . $_REQUEST['paymentDate'] . $_REQUEST['paymentStatus'] . $this->private_key ) );
- $order_id = absint( $_REQUEST['reference'] );
- $order = wc_get_order( $order_id );
-
- if ( hash_equals( $signature, $_REQUEST['signature'] ) ) {
- $order_complete = $this->process_order_status( $order, $_REQUEST['paymentId'], $_REQUEST['paymentStatus'], $_REQUEST['paymentDate'] );
-
- if ( ! $order_complete ) {
- $order->update_status( 'failed', __( 'Payment was declined by Simplify Commerce.', 'woocommerce' ) );
- }
-
- wp_redirect( $this->get_return_url( $order ) );
- exit();
- }
- }
-
- wp_redirect( wc_get_page_permalink( 'cart' ) );
- exit();
- }
-
- /**
- * Process the order status.
- *
- * @param WC_Order $order
- * @param string $payment_id
- * @param string $status
- * @param string $auth_code
- *
- * @return bool
- */
- public function process_order_status( $order, $payment_id, $status, $auth_code ) {
- if ( 'APPROVED' == $status ) {
- // Payment complete
- $order->payment_complete( $payment_id );
-
- // Add order note
- $order->add_order_note( sprintf( __( 'Simplify payment approved (ID: %1$s, Auth Code: %2$s)', 'woocommerce' ), $payment_id, $auth_code ) );
-
- // Remove cart
- WC()->cart->empty_cart();
-
- return true;
- }
-
- return false;
- }
-
- /**
- * Process refunds.
- * WooCommerce 2.2 or later.
- *
- * @param int $order_id
- * @param float $amount
- * @param string $reason
- * @uses Simplify_ApiException
- * @uses Simplify_BadRequestException
- * @return bool|WP_Error
- */
- public function process_refund( $order_id, $amount = null, $reason = '' ) {
- try {
- $payment_id = get_post_meta( $order_id, '_transaction_id', true );
-
- $refund = Simplify_Refund::createRefund(
- array(
- 'amount' => $amount * 100, // In cents.
- 'payment' => $payment_id,
- 'reason' => $reason,
- 'reference' => $order_id,
- )
- );
-
- if ( 'APPROVED' == $refund->paymentStatus ) {
- return true;
- } else {
- throw new Simplify_ApiException( __( 'Refund was declined.', 'woocommerce' ) );
- }
- } catch ( Simplify_ApiException $e ) {
- if ( $e instanceof Simplify_BadRequestException && $e->hasFieldErrors() && $e->getFieldErrors() ) {
- foreach ( $e->getFieldErrors() as $error ) {
- return new WP_Error( 'simplify_refund_error', $error->getFieldName() . ': "' . $error->getMessage() . '" (' . $error->getErrorCode() . ')' );
- }
- } else {
- return new WP_Error( 'simplify_refund_error', $e->getMessage() );
- }
- }
-
- return false;
- }
-
- /**
- * Get gateway icon.
- *
- * @access public
- * @return string
- */
- public function get_icon() {
- $icon = '';
- $icon .= '';
- $icon .= '';
- $icon .= '';
- $icon .= '';
-
- return apply_filters( 'woocommerce_gateway_icon', $icon, $this->id );
- }
-}
diff --git a/includes/gateways/simplify-commerce/includes/Simplify.php b/includes/gateways/simplify-commerce/includes/Simplify.php
deleted file mode 100644
index d0c4859f5c4d1..0000000000000
--- a/includes/gateways/simplify-commerce/includes/Simplify.php
+++ /dev/null
@@ -1,88 +0,0 @@
-setAll($hash);
- }
-
- /**
- * Creates an OAuth access token
- * @param $code - the authorisation code returned from the GET on /oauth/authorize
- * @param $redirect_uri = this must be the redirect_uri set in the apps configuration
- * @param $authentication - Authentication information to access the API. If not value is passed the global key Simplify::$publicKey and Simplify::$privateKey are used
- * @return Simplify_AccessToken
- */
- public static function create($code, $redirect_uri, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 3);
-
- $props = 'code='.$code.'&redirect_uri='.$redirect_uri.'&grant_type=authorization_code';
- $resp = Simplify_AccessToken::sendRequest($props, "token", $authentication);
-
- return new Simplify_AccessToken($resp);
- }
-
- /**
- * Refreshes the current token. The access_token and refresh_token values will be updated.
- * @param $authentication - Authentication information to access the API. If not value is passed the global key Simplify::$publicKey and Simplify::$privateKey are used
- * @return Simplify_AccessToken
- * @throws InvalidArgumentException
- */
- public function refresh($authentication = null) {
- $args = func_get_args();
-
- $refresh_token = $this->refresh_token;
- if (empty($refresh_token)){
- throw new InvalidArgumentException('Cannot refresh access token; refresh token is invalid');
- }
-
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 1);
-
- $props = 'refresh_token='.$refresh_token.'&grant_type=refresh_token';
- $resp = Simplify_AccessToken::sendRequest($props, "token", $authentication);
-
- $this->setAll($resp);
-
- return $this;
- }
-
- /**
- *
Revokes a token from further use.
- * @param $authentication - Authentication information to access the API. If not value is passed the global key Simplify::$publicKey and Simplify::$privateKey are used
- * @return Simplify_AccessToken
- * @throws InvalidArgumentException
- */
- public function revoke($authentication = null) {
- $args = func_get_args();
-
- $access_token = $this->access_token;
- if (empty($access_token)){
- throw new InvalidArgumentException('Cannot revoke access token; access token is invalid');
- }
-
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $props = 'token='.$access_token.'';
-
- Simplify_AccessToken::sendRequest($props, "revoke", $authentication);
-
- $this->access_token = null;
- $this->refresh_token = null;
- $this->redirect_uri = null;
-
- return $this;
- }
-
- private static function sendRequest($props, $context, $authentication){
-
- $url = Simplify_Constants::OAUTH_BASE_URL.'/'.$context;
- $http = new Simplify_HTTP();
- $resp = $http->oauthRequest($url, $props, $authentication);
-
- return $resp;
- }
-
- /**
- * @ignore
- */
- static public function getClazz() {
- return "AccessToken";
- }
-
-}
diff --git a/includes/gateways/simplify-commerce/includes/Simplify/Authentication.php b/includes/gateways/simplify-commerce/includes/Simplify/Authentication.php
deleted file mode 100644
index c787b6c1d5ff9..0000000000000
--- a/includes/gateways/simplify-commerce/includes/Simplify/Authentication.php
+++ /dev/null
@@ -1,74 +0,0 @@
-accessToken = $accessToken;
- }
-
- function __construct2($publicKey, $privateKey) {
- $this->publicKey = $publicKey;
- $this->privateKey = $privateKey;
- }
-
- function __construct3($publicKey, $privateKey, $accessToken) {
- $this->publicKey = $publicKey;
- $this->privateKey = $privateKey;
- $this->accessToken = $accessToken;
- }
-}
diff --git a/includes/gateways/simplify-commerce/includes/Simplify/Authorization.php b/includes/gateways/simplify-commerce/includes/Simplify/Authorization.php
deleted file mode 100644
index 69704b558f729..0000000000000
--- a/includes/gateways/simplify-commerce/includes/Simplify/Authorization.php
+++ /dev/null
@@ -1,142 +0,0 @@
-
- *
amount
Amount of the payment (in the smallest unit of your currency). Example: 100 = $1.00USD required
- *
card.addressCity
City of the cardholder. [max length: 50, min length: 2]
- *
card.addressCountry
Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder. [max length: 2, min length: 2]
- *
card.addressLine1
Address of the cardholder. [max length: 255]
- *
card.addressLine2
Address of the cardholder if needed. [max length: 255]
- *
card.addressState
State of residence of the cardholder. For the US, this is a 2-digit USPS code. [max length: 255, min length: 2]
- *
card.addressZip
Postal code of the cardholder. The postal code size is between 5 and 9 characters in length and only contains numbers or letters. [max length: 9, min length: 3]
- *
card.cvc
CVC security code of the card. This is the code on the back of the card. Example: 123
- *
card.expMonth
Expiration month of the card. Format is MM. Example: January = 01 [min value: 1, max value: 12] required
- *
card.expYear
Expiration year of the card. Format is YY. Example: 2013 = 13 [min value: 0, max value: 99] required
- *
card.name
Name as it appears on the card. [max length: 50, min length: 2]
- *
card.number
Card number as it appears on the card. [max length: 19, min length: 13] required
- *
currency
Currency code (ISO-4217) for the transaction. Must match the currency associated with your account. [default: USD] required
- *
customer
ID of customer. If specified, card on file of customer will be used.
- *
description
Free form text field to be used as a description of the payment. This field is echoed back with the payment on any find or list operations. [max length: 1024]
- *
reference
Custom reference field to be used with outside systems.
- *
replayId
An identifier that can be sent to uniquely identify a payment request to facilitate retries due to I/O related issues. This identifier must be unique for your account (sandbox or live) across all of your payments. If supplied, we will check for a payment on your account that matches this identifier, and if one is found we will attempt to return an identical response of the original request. [max length: 50, min length: 1]
- *
statementDescription.name
Merchant name required
- *
statementDescription.phoneNumber
Merchant contact phone number.
- *
token
If specified, card associated with card token will be used. [max length: 255]
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return Authorization a Authorization object.
- */
- static public function createAuthorization($hash, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $instance = new Simplify_Authorization();
- $instance->setAll($hash);
-
- $object = Simplify_PaymentsApi::createObject($instance, $authentication);
- return $object;
- }
-
-
- /**
- * Deletes an Simplify_Authorization object.
- *
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- *
- * @return true
- */
- public function deleteAuthorization($authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 1);
-
- $obj = Simplify_PaymentsApi::deleteObject($this, $authentication);
- $this->properties = null;
- return true;
- }
-
-
- /**
- * Retrieve Simplify_Authorization objects.
- * @param array criteria a map of parameters; valid keys are:
- *
filter
Filters to apply to the list.
- *
max
Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20]
- *
offset
Used in pagination of the list. This is the start offset of the page. [min value: 0, default: 0]
- *
sorting
Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either asc for ascending or desc for descending). Sortable properties are: dateCreated amount id description paymentDate.
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return ResourceList a ResourceList object that holds the list of Authorization objects and the total
- * number of Authorization objects available for the given criteria.
- * @see ResourceList
- */
- static public function listAuthorization($criteria = null, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $val = new Simplify_Authorization();
- $list = Simplify_PaymentsApi::listObject($val, $criteria, $authentication);
-
- return $list;
- }
-
-
- /**
- * Retrieve a Simplify_Authorization object from the API
- *
- * @param string id the id of the Authorization object to retrieve
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return Authorization a Authorization object
- */
- static public function findAuthorization($id, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $val = new Simplify_Authorization();
- $val->id = $id;
-
- $obj = Simplify_PaymentsApi::findObject($val, $authentication);
-
- return $obj;
- }
-
- /**
- * @ignore
- */
- public function getClazz() {
- return "Authorization";
- }
-}
diff --git a/includes/gateways/simplify-commerce/includes/Simplify/CardToken.php b/includes/gateways/simplify-commerce/includes/Simplify/CardToken.php
deleted file mode 100644
index 0cd0f0cf44aee..0000000000000
--- a/includes/gateways/simplify-commerce/includes/Simplify/CardToken.php
+++ /dev/null
@@ -1,94 +0,0 @@
-
- *
callback
The URL callback for the cardtoken
- *
card.addressCity
City of the cardholder. [max length: 50, min length: 2]
- *
card.addressCountry
Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder. [max length: 2, min length: 2]
- *
card.addressLine1
Address of the cardholder. [max length: 255]
- *
card.addressLine2
Address of the cardholder if needed. [max length: 255]
- *
card.addressState
State of residence of the cardholder. For the US, this is a 2-digit USPS code. [max length: 255, min length: 2]
- *
card.addressZip
Postal code of the cardholder. The postal code size is between 5 and 9 in length and only contain numbers or letters. [max length: 9, min length: 3]
- *
card.cvc
CVC security code of the card. This is the code on the back of the card. Example: 123
- *
card.expMonth
Expiration month of the card. Format is MM. Example: January = 01 [min value: 1, max value: 12] required
- *
card.expYear
Expiration year of the card. Format is YY. Example: 2013 = 13 [min value: 0, max value: 99] required
- *
card.name
Name as appears on the card. [max length: 50, min length: 2]
- *
card.number
Card number as it appears on the card. [max length: 19, min length: 13] required
- *
key
Key used to create the card token.
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return CardToken a CardToken object.
- */
- static public function createCardToken($hash, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $instance = new Simplify_CardToken();
- $instance->setAll($hash);
-
- $object = Simplify_PaymentsApi::createObject($instance, $authentication);
- return $object;
- }
-
-
-
- /**
- * Retrieve a Simplify_CardToken object from the API
- *
- * @param string id the id of the CardToken object to retrieve
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return CardToken a CardToken object
- */
- static public function findCardToken($id, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $val = new Simplify_CardToken();
- $val->id = $id;
-
- $obj = Simplify_PaymentsApi::findObject($val, $authentication);
-
- return $obj;
- }
-
- /**
- * @ignore
- */
- public function getClazz() {
- return "CardToken";
- }
-}
diff --git a/includes/gateways/simplify-commerce/includes/Simplify/Chargeback.php b/includes/gateways/simplify-commerce/includes/Simplify/Chargeback.php
deleted file mode 100644
index 78fca9c80afa5..0000000000000
--- a/includes/gateways/simplify-commerce/includes/Simplify/Chargeback.php
+++ /dev/null
@@ -1,86 +0,0 @@
-
- *
filter
Filters to apply to the list.
- *
max
Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20]
- *
offset
Used in paging of the list. This is the start offset of the page. [min value: 0, default: 0]
- *
sorting
Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either asc for ascending or desc for descending). Sortable properties are: id amount description dateCreated.
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return ResourceList a ResourceList object that holds the list of Chargeback objects and the total
- * number of Chargeback objects available for the given criteria.
- * @see ResourceList
- */
- static public function listChargeback($criteria = null, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $val = new Simplify_Chargeback();
- $list = Simplify_PaymentsApi::listObject($val, $criteria, $authentication);
-
- return $list;
- }
-
-
- /**
- * Retrieve a Simplify_Chargeback object from the API
- *
- * @param string id the id of the Chargeback object to retrieve
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return Chargeback a Chargeback object
- */
- static public function findChargeback($id, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $val = new Simplify_Chargeback();
- $val->id = $id;
-
- $obj = Simplify_PaymentsApi::findObject($val, $authentication);
-
- return $obj;
- }
-
- /**
- * @ignore
- */
- public function getClazz() {
- return "Chargeback";
- }
-}
diff --git a/includes/gateways/simplify-commerce/includes/Simplify/Constants.php b/includes/gateways/simplify-commerce/includes/Simplify/Constants.php
deleted file mode 100644
index c2174da898458..0000000000000
--- a/includes/gateways/simplify-commerce/includes/Simplify/Constants.php
+++ /dev/null
@@ -1,58 +0,0 @@
-
- *
amountOff
Amount off of the price of the product in the smallest units of the currency of the merchant. While this field is optional, you must provide either amountOff or percentOff for a coupon. Example: 100 = $1.00USD [min value: 1]
- *
couponCode
Code that identifies the coupon to be used. [min length: 2] required
- *
description
A brief section that describes the coupon.
- *
durationInMonths
DEPRECATED - Duration in months that the coupon will be applied after it has first been selected. [min value: 1, max value: 9999]
- *
endDate
Last date of the coupon in UTC millis that the coupon can be applied to a subscription. This ends at 23:59:59 of the merchant timezone.
- *
maxRedemptions
Maximum number of redemptions allowed for the coupon. A redemption is defined as when the coupon is applied to the subscription for the first time. [min value: 1]
- *
numTimesApplied
The number of times a coupon will be applied on a customer's subscription. [min value: 1, max value: 9999]
- *
percentOff
Percentage off of the price of the product. While this field is optional, you must provide either amountOff or percentOff for a coupon. The percent off is a whole number. [min value: 1, max value: 100]
- *
startDate
First date of the coupon in UTC millis that the coupon can be applied to a subscription. This starts at midnight of the merchant timezone. required
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return Coupon a Coupon object.
- */
- static public function createCoupon($hash, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $instance = new Simplify_Coupon();
- $instance->setAll($hash);
-
- $object = Simplify_PaymentsApi::createObject($instance, $authentication);
- return $object;
- }
-
-
- /**
- * Deletes an Simplify_Coupon object.
- *
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- *
- * @return true
- */
- public function deleteCoupon($authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 1);
-
- $obj = Simplify_PaymentsApi::deleteObject($this, $authentication);
- $this->properties = null;
- return true;
- }
-
-
- /**
- * Retrieve Simplify_Coupon objects.
- * @param array criteria a map of parameters; valid keys are:
- *
filter
Filters to apply to the list.
- *
max
Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20]
- *
offset
Used in paging of the list. This is the start offset of the page. [min value: 0, default: 0]
- *
sorting
Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either asc for ascending or desc for descending). Sortable properties are: dateCreated maxRedemptions timesRedeemed id startDate endDate percentOff couponCode durationInMonths numTimesApplied amountOff.
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return ResourceList a ResourceList object that holds the list of Coupon objects and the total
- * number of Coupon objects available for the given criteria.
- * @see ResourceList
- */
- static public function listCoupon($criteria = null, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $val = new Simplify_Coupon();
- $list = Simplify_PaymentsApi::listObject($val, $criteria, $authentication);
-
- return $list;
- }
-
-
- /**
- * Retrieve a Simplify_Coupon object from the API
- *
- * @param string id the id of the Coupon object to retrieve
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return Coupon a Coupon object
- */
- static public function findCoupon($id, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $val = new Simplify_Coupon();
- $val->id = $id;
-
- $obj = Simplify_PaymentsApi::findObject($val, $authentication);
-
- return $obj;
- }
-
-
- /**
- * Updates an Simplify_Coupon object.
- *
- * The properties that can be updated:
- *
- *
endDate
The ending date in UTC millis for the coupon. This must be after the starting date of the coupon.
- *
maxRedemptions
Maximum number of redemptions allowed for the coupon. A redemption is defined as when the coupon is applied to the subscription for the first time. [min value: 1]
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return Coupon a Coupon object.
- */
- public function updateCoupon($authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 1);
-
- $object = Simplify_PaymentsApi::updateObject($this, $authentication);
- return $object;
- }
-
- /**
- * @ignore
- */
- public function getClazz() {
- return "Coupon";
- }
-}
diff --git a/includes/gateways/simplify-commerce/includes/Simplify/Customer.php b/includes/gateways/simplify-commerce/includes/Simplify/Customer.php
deleted file mode 100644
index 6bbcf524290e2..0000000000000
--- a/includes/gateways/simplify-commerce/includes/Simplify/Customer.php
+++ /dev/null
@@ -1,184 +0,0 @@
-
- *
card.addressCity
City of the cardholder. required
- *
card.addressCountry
Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder. required
- *
card.addressLine1
Address of the cardholder required
- *
card.addressLine2
Address of the cardholder if needed. required
- *
card.addressState
State of residence of the cardholder. For the US, this is a 2-digit USPS code. required
- *
card.addressZip
Postal code of the cardholder. The postal code size is between 5 and 9 in length and only contain numbers or letters. required
- *
card.cvc
CVC security code of the card. This is the code on the back of the card. Example: 123 required
- *
card.expMonth
Expiration month of the card. Format is MM. Example: January = 01 required
- *
card.expYear
Expiration year of the card. Format is YY. Example: 2013 = 13 required
- *
card.id
ID of card. Unused during customer create.
- *
card.name
Name as appears on the card. required
- *
card.number
Card number as it appears on the card. [max length: 19, min length: 13]
- *
email
Email address of the customer required
- *
name
Customer name [min length: 2] required
- *
reference
Reference field for external applications use.
- *
subscriptions.amount
Amount of payment in the smallest unit of your currency. Example: 100 = $1.00USD
- *
subscriptions.billingCycle
How the plan is billed to the customer. Values must be AUTO (indefinitely until the customer cancels) or FIXED (a fixed number of billing cycles). [default: AUTO]
- *
subscriptions.billingCycleLimit
The number of fixed billing cycles for a plan. Only used if the billingCycle parameter is set to FIXED. Example: 4
- *
subscriptions.coupon
Coupon associated with the subscription for the customer.
- *
subscriptions.currency
Currency code (ISO-4217). Must match the currency associated with your account. [default: USD]
- *
subscriptions.customer
The customer ID to create the subscription for. Do not supply this when creating a customer.
- *
subscriptions.frequency
Frequency of payment for the plan. Used in conjunction with frequencyPeriod. Valid values are "DAILY", "WEEKLY", "MONTHLY" and "YEARLY".
- *
subscriptions.frequencyPeriod
Period of frequency of payment for the plan. Example: if the frequency is weekly, and periodFrequency is 2, then the subscription is billed bi-weekly.
- *
subscriptions.name
Name describing subscription
- *
subscriptions.plan
The plan ID that the subscription should be created from.
- *
subscriptions.quantity
Quantity of the plan for the subscription. [min value: 1]
- *
subscriptions.renewalReminderLeadDays
If set, how many days before the next billing cycle that a renewal reminder is sent to the customer. If null, then no emails are sent. Minimum value is 7 if set.
- *
token
If specified, card associated with card token will be used
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return Customer a Customer object.
- */
- static public function createCustomer($hash, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $instance = new Simplify_Customer();
- $instance->setAll($hash);
-
- $object = Simplify_PaymentsApi::createObject($instance, $authentication);
- return $object;
- }
-
-
- /**
- * Deletes an Simplify_Customer object.
- *
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- *
- * @return true
- */
- public function deleteCustomer($authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 1);
-
- $obj = Simplify_PaymentsApi::deleteObject($this, $authentication);
- $this->properties = null;
- return true;
- }
-
-
- /**
- * Retrieve Simplify_Customer objects.
- * @param array criteria a map of parameters; valid keys are:
- *
filter
Filters to apply to the list.
- *
max
Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20]
- *
offset
Used in paging of the list. This is the start offset of the page. [min value: 0, default: 0]
- *
sorting
Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either asc for ascending or desc for descending). Sortable properties are: dateCreated id name email reference.
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return ResourceList a ResourceList object that holds the list of Customer objects and the total
- * number of Customer objects available for the given criteria.
- * @see ResourceList
- */
- static public function listCustomer($criteria = null, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $val = new Simplify_Customer();
- $list = Simplify_PaymentsApi::listObject($val, $criteria, $authentication);
-
- return $list;
- }
-
-
- /**
- * Retrieve a Simplify_Customer object from the API
- *
- * @param string id the id of the Customer object to retrieve
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return Customer a Customer object
- */
- static public function findCustomer($id, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $val = new Simplify_Customer();
- $val->id = $id;
-
- $obj = Simplify_PaymentsApi::findObject($val, $authentication);
-
- return $obj;
- }
-
-
- /**
- * Updates an Simplify_Customer object.
- *
- * The properties that can be updated:
- *
- *
card.addressCity
City of the cardholder. required
- *
card.addressCountry
Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder. required
- *
card.addressLine1
Address of the cardholder. required
- *
card.addressLine2
Address of the cardholder if needed. required
- *
card.addressState
State of residence of the cardholder. For the US, this is a 2-digit USPS code. required
- *
card.addressZip
Postal code of the cardholder. The postal code size is between 5 and 9 in length and only contain numbers or letters. required
- *
card.cvc
CVC security code of the card. This is the code on the back of the card. Example: 123 required
- *
card.expMonth
Expiration month of the card. Format is MM. Example: January = 01 required
- *
card.expYear
Expiration year of the card. Format is YY. Example: 2013 = 13 required
- *
card.id
ID of card. If present, card details for the customer will not be updated. If not present, the customer will be updated with the supplied card details.
- *
card.name
Name as appears on the card. required
- *
card.number
Card number as it appears on the card. [max length: 19, min length: 13]
- *
email
Email address of the customer required
- *
name
Customer name [min length: 2] required
- *
reference
Reference field for external applications use.
- *
token
If specified, card associated with card token will be added to the customer
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return Customer a Customer object.
- */
- public function updateCustomer($authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 1);
-
- $object = Simplify_PaymentsApi::updateObject($this, $authentication);
- return $object;
- }
-
- /**
- * @ignore
- */
- public function getClazz() {
- return "Customer";
- }
-}
diff --git a/includes/gateways/simplify-commerce/includes/Simplify/Deposit.php b/includes/gateways/simplify-commerce/includes/Simplify/Deposit.php
deleted file mode 100644
index 7c6d66add3fbc..0000000000000
--- a/includes/gateways/simplify-commerce/includes/Simplify/Deposit.php
+++ /dev/null
@@ -1,86 +0,0 @@
-
- *
filter
Filters to apply to the list.
- *
max
Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20]
- *
offset
Used in paging of the list. This is the start offset of the page. [min value: 0, default: 0]
- *
sorting
Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either asc for ascending or desc for descending). Sortable properties are: amount dateCreated depositDate.
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return ResourceList a ResourceList object that holds the list of Deposit objects and the total
- * number of Deposit objects available for the given criteria.
- * @see ResourceList
- */
- static public function listDeposit($criteria = null, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $val = new Simplify_Deposit();
- $list = Simplify_PaymentsApi::listObject($val, $criteria, $authentication);
-
- return $list;
- }
-
-
- /**
- * Retrieve a Simplify_Deposit object from the API
- *
- * @param string id the id of the Deposit object to retrieve
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return Deposit a Deposit object
- */
- static public function findDeposit($id, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $val = new Simplify_Deposit();
- $val->id = $id;
-
- $obj = Simplify_PaymentsApi::findObject($val, $authentication);
-
- return $obj;
- }
-
- /**
- * @ignore
- */
- public function getClazz() {
- return "Deposit";
- }
-}
diff --git a/includes/gateways/simplify-commerce/includes/Simplify/Event.php b/includes/gateways/simplify-commerce/includes/Simplify/Event.php
deleted file mode 100644
index bdb682edac56b..0000000000000
--- a/includes/gateways/simplify-commerce/includes/Simplify/Event.php
+++ /dev/null
@@ -1,68 +0,0 @@
-payload
The raw JWS payload.
required
- *
url
The URL for the webhook. If present it must match the URL registered for the webhook.
- * @param $authentication Object that contains the API public and private keys. If null the values of the static
- * Simplify::$publicKey and Simplify::$privateKey will be used.
- * @return Payments_Event an Event object.
- * @throws InvalidArgumentException
- */
- static public function createEvent($hash, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $paymentsApi = new Simplify_PaymentsApi();
-
- $jsonObject = $paymentsApi->jwsDecode($hash, $authentication);
-
- if ($jsonObject['event'] == null) {
- throw new InvalidArgumentException("Incorrect data in webhook event");
- }
-
- return $paymentsApi->convertFromHashToObject($jsonObject['event'], self::getClazz());
- }
-
- /**
- * @ignore
- */
- static public function getClazz() {
- return "Event";
- }
-}
diff --git a/includes/gateways/simplify-commerce/includes/Simplify/Exceptions.php b/includes/gateways/simplify-commerce/includes/Simplify/Exceptions.php
deleted file mode 100644
index 2e890ebd25444..0000000000000
--- a/includes/gateways/simplify-commerce/includes/Simplify/Exceptions.php
+++ /dev/null
@@ -1,294 +0,0 @@
-status = $status;
- $this->errorCode = null;
- $this->reference = null;
-
- if ($errorData != null) {
-
- $this->reference = $errorData['reference'];
- $this->errorData = $errorData;
-
- $error = $errorData['error'];
- if ($error != null) {
-
- $m = $error['message'];
- if ($m != null) {
- $this->message = $m;
- }
-
- $this->errorCode = $error['code'];
- }
- }
- }
-
- /**
- * Returns a map of all error data returned by the API.
- * @return array a map containing API error data.
- */
- function getErrorData() {
- return $this->errorData;
- }
-
- /**
- * Returns the HTTP status for the request.
- * @return string HTTP status code (or null if there is no status).
- */
- function getStatus() {
- return $this->status;
- }
-
- /**
- * Returns unique reference for the API error.
- * @return string a reference (or null if there is no reference).
- */
- function getReference() {
- return $this->reference;
- }
-
- /**
- * Returns an code for the API error.
- * @return string the error code.
- */
- function getErrorCode() {
- return $this->errorCode;
- }
-
- /**
- * Returns a description of the error.
- * @return string Description of the error.
- */
- function describe() {
- return get_class($this) . ": \""
- . $this->getMessage() . "\" (status: "
- . $this->getStatus() . ", error code: "
- . $this->getErrorCode() . ", reference: "
- . $this->getReference() . ")";
- }
-
-}
-
-
-/**
- * Exception raised when there are communication problems contacting the API.
- */
-class Simplify_ApiConnectionException extends Simplify_ApiException {
-
- /**
- * @ignore
- */
- function __construct($message, $status = null, $errorData = null) {
- parent::__construct($message, $status, $errorData);
- }
-}
-
-/**
- * Exception raised where there are problems authenticating a request.
- */
-class Simplify_AuthenticationException extends Simplify_ApiException {
-
- /**
- * @ignore
- */
- function __construct($message, $status = null, $errorData = null) {
- parent::__construct($message, $status, $errorData);
- }
-}
-
-/**
- * Exception raised when the API request contains errors.
- */
-class Simplify_BadRequestException extends Simplify_ApiException {
-
- protected $fieldErrors;
-
- /**
- * @ignore
- */
- function __construct($message, $status = null, $errorData = null) {
- parent::__construct($message, $status, $errorData);
-
- $fieldErrors = array();
-
- if ($errorData != null) {
- $error = $errorData['error'];
- if ($error != null) {
- $fieldErrors = $error['fieldErrors'];
- if ($fieldErrors != null) {
- $this->fieldErrors = array();
- foreach ($fieldErrors as $fieldError) {
- array_push($this->fieldErrors, new Simplify_FieldError($fieldError));
- }
- }
- }
- }
- }
-
- /**
- * Returns a boolean indicating whether there are any field errors.
- * @return boolean true if there are field errors; false otherwise.
- */
- function hasFieldErrors() {
- return count($this->fieldErrors) > 0;
- }
-
- /**
- * Returns a list containing all field errors.
- * @return array list of field errors.
- */
- function getFieldErrors() {
- return $this->fieldErrors;
- }
-
- /**
- * Returns a description of the error.
- * @return string description of the error.
- */
- function describe() {
- $s = parent::describe();
- foreach ($this->getFieldErrors() as $fieldError) {
- $s = $s . "\n" . (string) $fieldError;
- }
- return $s . "\n";
- }
-
-}
-
-/**
- * Represents a single error in a field of a request sent to the API.
- */
-class Simplify_FieldError {
-
- protected $field;
- protected $code;
- protected $message;
-
- /**
- * @ignore
- */
- function __construct($errorData) {
-
- $this->field = $errorData['field'];
- $this->code = $errorData['code'];
- $this->message = $errorData['message'];
- }
-
- /**
- * Returns the name of the field with the error.
- * @return string the field name.
- */
- function getFieldName() {
- return $this->field;
- }
-
- /**
- * Returns the code for the error.
- * @return string the error code.
- */
- function getErrorCode() {
- return $this->code;
- }
-
- /**
- * Returns a description of the error.
- * @return string description of the error.
- */
- function getMessage() {
- return $this->message;
- }
-
-
- function __toString() {
- return "Field error: " . $this->getFieldName() . "\"" . $this->getMessage() . "\" (" . $this->getErrorCode() . ")";
- }
-
-}
-
-/**
- * Exception when a requested object cannot be found.
- */
-class Simplify_ObjectNotFoundException extends Simplify_ApiException {
-
- /**
- * @ignore
- */
- function __construct($message, $status = null, $errorData = null) {
- parent::__construct($message, $status, $errorData);
- }
-}
-
-/**
- * Exception when a request was not allowed.
- */
-class Simplify_NotAllowedException extends Simplify_ApiException {
-
- /**
- * @ignore
- */
- function __construct($message, $status = null, $errorData = null) {
- parent::__construct($message, $status, $errorData);
- }
-}
-
-/**
- * Exception when there was a system error processing a request.
- */
-class Simplify_SystemException extends Simplify_ApiException {
-
- /**
- * @ignore
- */
- function __construct($message, $status = null, $errorData = null) {
- parent::__construct($message, $status, $errorData);
- }
-}
diff --git a/includes/gateways/simplify-commerce/includes/Simplify/FraudCheck.php b/includes/gateways/simplify-commerce/includes/Simplify/FraudCheck.php
deleted file mode 100644
index d0fea2a57999e..0000000000000
--- a/includes/gateways/simplify-commerce/includes/Simplify/FraudCheck.php
+++ /dev/null
@@ -1,122 +0,0 @@
-
- *
amount
Amount of the transaction to be checked for fraud (in the smallest unit of your currency). Example: 100 = $1.00USD
- *
card.addressCity
City of the cardholder. [max length: 50, min length: 2]
- *
card.addressCountry
Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder. [max length: 2, min length: 2]
- *
card.addressLine1
Address of the cardholder. [max length: 255]
- *
card.addressLine2
Address of the cardholder if needed. [max length: 255]
- *
card.addressState
State of residence of the cardholder. For the US, this is a 2-digit USPS code. [max length: 255, min length: 2]
- *
card.addressZip
Postal code of the cardholder. The postal code size is between 5 and 9 characters in length and only contains numbers or letters. [max length: 9, min length: 3]
- *
card.cvc
CVC security code of the card. This is the code on the back of the card. Example: 123
- *
card.expMonth
Expiration month of the card. Format is MM. Example: January = 01 [min value: 1, max value: 12] required
- *
card.expYear
Expiration year of the card. Format is YY. Example: 2013 = 13 [min value: 0, max value: 99] required
- *
card.name
Name as it appears on the card. [max length: 50, min length: 2]
- *
card.number
Card number as it appears on the card. [max length: 19, min length: 13] required
- *
currency
Currency code (ISO-4217) for the transaction to be checked for fraud.
- *
description
- Description of the fraud check.
- *
mode
Fraud check mode. “simple” only does an AVS and CVC check; “advanced” does a complete fraud check, running the input against the set up rules. [valid values: simple, advanced, full] required
- *
sessionId
Session ID usd during data collection. [max length: 255]
- *
token
Description
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return FraudCheck a FraudCheck object.
- */
- static public function createFraudCheck($hash, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $instance = new Simplify_FraudCheck();
- $instance->setAll($hash);
-
- $object = Simplify_PaymentsApi::createObject($instance, $authentication);
- return $object;
- }
-
-
-
- /**
- * Retrieve Simplify_FraudCheck objects.
- * @param array criteria a map of parameters; valid keys are:
- *
filter
Allows for ascending or descending sorting of the list.
- *
max
Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20]
- *
offset
Used in paging of the list. This is the start offset of the page. [min value: 0, default: 0]
- *
sorting
Used in paging of the list. This is the start offset of the page. The value maps properties to the sort direction (either asc for ascending or desc for descending). Sortable properties are: .
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return ResourceList a ResourceList object that holds the list of FraudCheck objects and the total
- * number of FraudCheck objects available for the given criteria.
- * @see ResourceList
- */
- static public function listFraudCheck($criteria = null, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $val = new Simplify_FraudCheck();
- $list = Simplify_PaymentsApi::listObject($val, $criteria, $authentication);
-
- return $list;
- }
-
-
- /**
- * Retrieve a Simplify_FraudCheck object from the API
- *
- * @param string id the id of the FraudCheck object to retrieve
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return FraudCheck a FraudCheck object
- */
- static public function findFraudCheck($id, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $val = new Simplify_FraudCheck();
- $val->id = $id;
-
- $obj = Simplify_PaymentsApi::findObject($val, $authentication);
-
- return $obj;
- }
-
- /**
- * @ignore
- */
- public function getClazz() {
- return "FraudCheck";
- }
-}
diff --git a/includes/gateways/simplify-commerce/includes/Simplify/Http.php b/includes/gateways/simplify-commerce/includes/Simplify/Http.php
deleted file mode 100644
index e0925a1bfa455..0000000000000
--- a/includes/gateways/simplify-commerce/includes/Simplify/Http.php
+++ /dev/null
@@ -1,411 +0,0 @@
- self::POST,
- "put" => self::PUT,
- "get" => self::GET,
- "delete" => self::DELETE);
-
- private function request($url, $method, $authentication, $payload = '')
- {
- if ($authentication->publicKey == null) {
- throw new InvalidArgumentException('Must have a valid public key to connect to the API');
- }
-
- if ($authentication->privateKey == null) {
- throw new InvalidArgumentException('Must have a valid API key to connect to the API');
- }
-
- if (!array_key_exists(strtolower($method), self::$_validMethods)) {
- throw new InvalidArgumentException('Invalid method: '.strtolower($method));
- }
-
- $method = self::$_validMethods[strtolower($method)];
-
- $curl = curl_init();
-
- $options = array();
-
- $options[CURLOPT_URL] = $url;
- $options[CURLOPT_CUSTOMREQUEST] = $method;
- $options[CURLOPT_RETURNTRANSFER] = true;
- $options[CURLOPT_FAILONERROR] = false;
-
- $signature = $this->jwsEncode($authentication, $url, $payload, $method == self::POST || $method == self::PUT);
-
- if ($method == self::POST || $method == self::PUT) {
- $headers = array(
- 'Content-type: application/json'
- );
- $options[CURLOPT_POSTFIELDS] = $signature;
- } else {
- $headers = array(
- 'Authorization: JWS ' . $signature
- );
- }
-
- array_push($headers, 'Accept: application/json');
- $user_agent = 'PHP-SDK/' . Simplify_Constants::VERSION;
- if (Simplify::$userAgent != null) {
- $user_agent = $user_agent . ' ' . Simplify::$userAgent;
- }
- array_push($headers, 'User-Agent: ' . $user_agent);
-
- $options[CURLOPT_HTTPHEADER] = $headers;
-
- curl_setopt_array($curl, $options);
-
- $data = curl_exec($curl);
- $errno = curl_errno($curl);
- $status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
-
- if ($data == false || $errno != CURLE_OK) {
- throw new Simplify_ApiConnectionException(curl_error($curl));
- }
-
- $object = json_decode($data, true);
- //'typ' => self::JWS_TYPE,
- $response = array('status' => $status, 'object' => $object);
-
- return $response;
- curl_close($curl);
- }
-
- /**
- * Handles Simplify API requests
- *
- * @param $url
- * @param $method
- * @param $authentication
- * @param string $payload
- * @return mixed
- * @throws Simplify_AuthenticationException
- * @throws Simplify_ObjectNotFoundException
- * @throws Simplify_BadRequestException
- * @throws Simplify_NotAllowedException
- * @throws Simplify_SystemException
- */
- public function apiRequest($url, $method, $authentication, $payload = ''){
-
- $response = $this->request($url, $method, $authentication, $payload);
-
- $status = $response['status'];
- $object = $response['object'];
-
- if ($status == self::HTTP_SUCCESS) {
- return $object;
- }
-
- if ($status == self::HTTP_REDIRECTED) {
- throw new Simplify_BadRequestException("Unexpected response code returned from the API, have you got the correct URL?", $status, $object);
- } else if ($status == self::HTTP_BAD_REQUEST) {
- throw new Simplify_BadRequestException("Bad request", $status, $object);
- } else if ($status == self::HTTP_UNAUTHORIZED) {
- throw new Simplify_AuthenticationException("You are not authorized to make this request. Are you using the correct API keys?", $status, $object);
- } else if ($status == self::HTTP_NOT_FOUND) {
- throw new Simplify_ObjectNotFoundException("Object not found", $status, $object);
- } else if ($status == self::HTTP_NOT_ALLOWED) {
- throw new Simplify_NotAllowedException("Operation not allowed", $status, $object);
- } else if ($status < 500) {
- throw new Simplify_BadRequestException("Bad request", $status, $object);
- }
- throw new Simplify_SystemException("An unexpected error has been raised. Looks like there's something wrong at our end." , $status, $object);
- }
-
- /**
- * Handles Simplify OAuth requests
- *
- * @param $url
- * @param $payload
- * @param $authentication
- * @return mixed
- * @throws Simplify_AuthenticationException
- * @throws Simplify_ObjectNotFoundException
- * @throws Simplify_BadRequestException
- * @throws Simplify_NotAllowedException
- * @throws Simplify_SystemException
- */
- public function oauthRequest($url, $payload, $authentication){
-
- $response = $this->request($url, Simplify_HTTP::POST, $authentication, $payload);
-
- $status = $response['status'];
- $object = $response['object'];
-
- if ($status == self::HTTP_SUCCESS) {
- return $object;
- }
-
- $error = $object['error'];
- $error_description = $object['error_description'];
-
- if ($status == self::HTTP_REDIRECTED) {
- throw new Simplify_BadRequestException("Unexpected response code returned from the API, have you got the correct URL?", $status, $object);
- } else if ($status == self::HTTP_BAD_REQUEST) {
-
- if ( $error == 'invalid_request'){
- throw new Simplify_BadRequestException("", $status, $this->buildOauthError('Error during OAuth request', $error, $error_description));
- }else if ($error == 'unsupported_grant_type'){
- throw new Simplify_BadRequestException("", $status, $this->buildOauthError('Unsupported grant type in OAuth request', $error, $error_description));
- }else if ($error == 'invalid_scope'){
- throw new Simplify_BadRequestException("", $status, $this->buildOauthError('Invalid scope in OAuth request', $error, $error_description));
- }else{
- throw new Simplify_BadRequestException("", $status, $this->buildOauthError('Unknown OAuth error', $error, $error_description));
- }
-
- //TODO: build BadRequestException error JSON
-
- } else if ($status == self::HTTP_UNAUTHORIZED){
-
- if ($error == 'access_denied'){
- throw new Simplify_AuthenticationException("", $status, $this->buildOauthError('Access denied for OAuth request', $error, $error_description));
- }else if ($error == 'invalid_client'){
- throw new Simplify_AuthenticationException("", $status, $this->buildOauthError('Invalid client ID in OAuth request', $error, $error_description));
- }else if ($error == 'unauthorized_client'){
- throw new Simplify_AuthenticationException("", $status, $this->buildOauthError('Unauthorized client in OAuth request', $error, $error_description));
- }else{
- throw new Simplify_AuthenticationException("", $status, $this->buildOauthError('Unknown authentication error', $error, $error_description));
- }
-
- } else if ($status < 500) {
- throw new Simplify_BadRequestException("Bad request", $status, $object);
- }
- throw new Simplify_SystemException("An unexpected error has been raised. Looks like there's something wrong at our end." , $status, $object);
- }
-
- public function jwsDecode($authentication, $hash)
- {
- if ($authentication->publicKey == null) {
- throw new InvalidArgumentException('Must have a valid public key to connect to the API');
- }
-
- if ($authentication->privateKey == null) {
- throw new InvalidArgumentException('Must have a valid API key to connect to the API');
- }
-
- if (!isset($hash['payload'])) {
- throw new InvalidArgumentException('Event data is Missing payload');
- }
- $payload = trim($hash['payload']);
-
-
- try {
- $parts = explode('.', $payload);
- if (count($parts) != 3) {
- $this->jwsAuthError("Incorrectly formatted JWS message");
- }
-
- $headerStr = $this->jwsUrlSafeDecode64($parts[0]);
- $bodyStr = $this->jwsUrlSafeDecode64($parts[1]);
- $sigStr = $parts[2];
-
- $url = null;
- if (isset($hash['url'])) {
- $url = $hash['url'];
- }
- $this->jwsVerifyHeader($headerStr, $url, $authentication->publicKey);
-
- $msg = $parts[0] . "." . $parts[1];
- if (!$this->jwsVerifySignature($authentication->privateKey, $msg, $sigStr)) {
- $this->jwsAuthError("JWS signature does not match");
- }
-
- return $bodyStr;
-
- } catch (ApiException $e) {
- throw $e;
- } catch (Exception $e) {
- $this->jwsAuthError("Exception during JWS decoding: " . $e);
- }
- }
-
- private function jwsEncode($authentication, $url, $payload, $hasPayload)
- {
- // TODO - better seeding of RNG
- $jws_hdr = array('typ' => self::JWS_TYPE,
- 'alg' => self::JWS_ALGORITHM,
- 'kid' => $authentication->publicKey,
- self::JWS_HDR_URI => $url,
- self::JWS_HDR_TIMESTAMP => sprintf("%u000", round(microtime(true))),
- self::JWS_HDR_NONCE => sprintf("%u", mt_rand()),
- );
-
- // add oauth token if provided
- if ( !empty($authentication->accessToken) ){
- $jws_hdr[self::JWS_HDR_TOKEN] = $authentication->accessToken;
- }
-
- $header = $this->jwsUrlSafeEncode64(json_encode($jws_hdr));
-
- if ($hasPayload) {
- $payload = $this->jwsUrlSafeEncode64($payload);
- } else {
- $payload = '';
- }
-
- $msg = $header . "." . $payload;
- return $msg . "." . $this->jwsSign($authentication->privateKey, $msg);
- }
-
- private function jwsSign($privateKey, $msg) {
- $decodedPrivateKey = $this->jwsUrlSafeDecode64($privateKey);
- $sig = hash_hmac('sha256', $msg, $decodedPrivateKey, true);
-
- return $this->jwsUrlSafeEncode64($sig);
- }
-
- private function jwsVerifyHeader($header, $url, $publicKey) {
-
- $hdr = json_decode($header, true);
-
- if (count($hdr) != self::JWS_NUM_HEADERS) {
- $this->jwsAuthError("Incorrect number of JWS header parameters - found " . count($hdr) . " required " . self::JWS_NUM_HEADERS);
- }
-
- if ($hdr['alg'] != self::JWS_ALGORITHM) {
- $this->jwsAuthError("Incorrect algorithm - found " . $hdr['alg'] . " required " . self::WS_ALGORITHM);
- }
-
- if ($hdr['typ'] != self::JWS_TYPE) {
- $this->jwsAuthError("Incorrect type - found " . $hdr['typ'] . " required " . self::JWS_TYPE);
- }
-
- if ($hdr['kid'] == null) {
- $this->jwsAuthError("Missing Key ID");
- }
-
- if ($hdr['kid'] != $publicKey) {
- if ($this->isLiveKey($publicKey)) {
- $this->jwsAuthError("Invalid Key ID");
- }
- }
-
- if ($hdr[self::JWS_HDR_URI] == null) {
- $this->jwsAuthError("Missing URI");
- }
-
- if ($url != null && $hdr[self::JWS_HDR_URI] != $url) {
- $this->jwsAuthError("Incorrect URL - found " . $hdr[self::JWS_HDR_URI] . " required " . $url);
- }
-
-
- if ($hdr[self::JWS_HDR_TIMESTAMP] == null) {
- $this->jwsAuthError("Missing timestamp");
- }
-
- if (!$this->jwsVerifyTimestamp($hdr[self::JWS_HDR_TIMESTAMP])) {
- $this->jwsAuthError("Invalid timestamp");
- }
-
- if ($hdr[self::JWS_HDR_NONCE] == null) {
- $this->jwsAuthError("Missing nonce");
- }
-
- if ($hdr[self::JWS_HDR_UNAME] == null) {
- $this->jwsAuthError("Missing username");
- }
- }
-
-
- private function jwsVerifySignature($privateKey, $msg, $expectedSig) {
- return $this->jwsSign($privateKey, $msg) == $expectedSig;
- }
-
- private function jwsAuthError($reason) {
- throw new Simplify_AuthenticationException("JWS authentication failure: " . $reason);
- }
-
- private function jwsVerifyTimestamp($ts) {
- $now = round(microtime(true)); // Seconds
- return abs($now - $ts / 1000) < self::JWS_MAX_TIMESTAMP_DIFF;
- }
-
- private function isLiveKey($k) {
- return strpos($k, "lvpb") === 0;
- }
-
- private function jwsUrlSafeEncode64($s) {
- return str_replace(array('+', '/', '='),
- array('-', '_', ''),
- base64_encode($s));
- }
-
- private function jwsUrlSafeDecode64($s) {
-
- switch (strlen($s) % 4) {
- case 0: break;
- case 2: $s = $s . "==";
- break;
- case 3: $s = $s . "=";
- break;
- default: throw new InvalidArgumentException('incorrectly formatted JWS payload');
- }
- return base64_decode(str_replace(array('-', '_'), array('+', '/'), $s));
- }
-
- private function buildOauthError($msg, $error, $error_description){
-
- return array(
- 'error' => array(
- 'code' => 'oauth_error',
- 'message' => $msg.', error code: '.$error.', description: '.$error_description.''
- )
- );
- }
-}
diff --git a/includes/gateways/simplify-commerce/includes/Simplify/Invoice.php b/includes/gateways/simplify-commerce/includes/Simplify/Invoice.php
deleted file mode 100644
index afdbcc5917259..0000000000000
--- a/includes/gateways/simplify-commerce/includes/Simplify/Invoice.php
+++ /dev/null
@@ -1,228 +0,0 @@
-
- *
billingAddress.city
Billing address city of the location where the goods or services were supplied. [max length: 255, min length: 2]
- *
billingAddress.country
Billing address country of the location where the goods or services were supplied. [max length: 2, min length: 2]
- *
billingAddress.line1
Billing address line 1 of the location where the goods or services were supplied. [max length: 255]
- *
billingAddress.line2
Billing address line 2 of the location where the goods or services were supplied. [max length: 255]
- *
billingAddress.name
Billing address name of the location where the goods or services were supplied. Will use the customer name if not provided. [max length: 255]
- *
billingAddress.state
Billing address state of the location where the goods or services were supplied. [max length: 255]
- *
billingAddress.zip
Billing address zip of the location where the goods or services were supplied. [max length: 32]
- *
businessAddress.city
Address city of the business that is sending the invoice. [max length: 255, min length: 2]
- *
businessAddress.country
Address country of the business that is sending the invoice. [max length: 2, min length: 2]
- *
businessAddress.line1
Address line 1 of the business that is sending the invoice. [max length: 255]
- *
businessAddress.line2
Address line 2 of the business that is sending the invoice. [max length: 255]
- *
businessAddress.name
The name of the business that is sending the invoice. [max length: 255]
- *
businessAddress.state
Address state of the business that is sending the invoice. [max length: 255]
- *
businessAddress.zip
Address zip of the business that is sending the invoice. [max length: 32]
- *
currency
Currency code (ISO-4217). Must match the currency associated with your account. [max length: 3, min length: 3, default: USD]
- *
customer
The customer ID of the customer we are invoicing. This is optional if invoiceToCopy or a name and email are provided
- *
customerTaxNo
The tax number or VAT id of the person to whom the goods or services were supplied. [max length: 255]
- *
discountRate
The discount percent as a decimal e.g. 12.5. This is used to calculate the discount amount which is subtracted from the total amount due before any tax is applied. [max length: 6]
- *
dueDate
The date invoice payment is due. If a late fee is provided this will be added to the invoice total is the due date has past.
- *
email
The email of the customer we are invoicing. This is optional if customer or invoiceToCopy is provided. A new customer will be created using the the name and email.
- *
invoiceId
User defined invoice id. If not provided the system will generate a numeric id. [max length: 255]
- *
invoiceToCopy
The id of an existing invoice to be copied. This is optional if customer or a name and email are provided
- *
items.amount
Amount of the invoice item (the smallest unit of your currency). Example: 100 = $1.00USD [min value: -9999900, max value: 9999900] required
- *
items.description
The description of the invoice item. [max length: 1024]
- *
items.invoice
The ID of the invoice this item belongs to.
- *
items.product
The product this invoice item refers to.
- *
items.quantity
Quantity of the item. This total amount of the invoice item is the amount * quantity. [min value: 1, max value: 999999, default: 1]
- *
items.reference
User defined reference field. [max length: 255]
- *
items.tax
The tax ID of the tax charge in the invoice item.
- *
lateFee
The late fee amount that will be added to the invoice total is the due date is past due. Value provided must be in the smallest unit of your currency. Example: 100 = $1.00USD [max value: 9999900]
- *
memo
A memo that is displayed to the customer on the invoice payment screen. [max length: 4000]
- *
name
The name of the customer we are invoicing. This is optional if customer or invoiceToCopy is provided. A new customer will be created using the the name and email. [max length: 50, min length: 2]
- *
note
This field can be used to store a note that is not displayed to the customer. [max length: 4000]
- *
reference
User defined reference field. [max length: 255]
- *
shippingAddress.city
Address city of the location where the goods or services were supplied. [max length: 255, min length: 2]
- *
shippingAddress.country
Address country of the location where the goods or services were supplied. [max length: 2, min length: 2]
- *
shippingAddress.line1
Address line 1 of the location where the goods or services were supplied. [max length: 255]
- *
shippingAddress.line2
Address line 2 of the location where the goods or services were supplied. [max length: 255]
- *
shippingAddress.name
Address name of the location where the goods or services were supplied. [max length: 255]
- *
shippingAddress.state
Address state of the location where the goods or services were supplied. [max length: 255]
- *
shippingAddress.zip
Address zip of the location where the goods or services were supplied. [max length: 32]
- *
suppliedDate
The date on which the goods or services were supplied.
- *
taxNo
The tax number or VAT id of the person who supplied the goods or services. [max length: 255]
- *
type
The type of invoice. One of WEB or MOBILE. [valid values: WEB, MOBILE, default: WEB]
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return Invoice a Invoice object.
- */
- static public function createInvoice($hash, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $instance = new Simplify_Invoice();
- $instance->setAll($hash);
-
- $object = Simplify_PaymentsApi::createObject($instance, $authentication);
- return $object;
- }
-
-
- /**
- * Deletes an Simplify_Invoice object.
- *
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- *
- * @return true
- */
- public function deleteInvoice($authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 1);
-
- $obj = Simplify_PaymentsApi::deleteObject($this, $authentication);
- $this->properties = null;
- return true;
- }
-
-
- /**
- * Retrieve Simplify_Invoice objects.
- * @param array criteria a map of parameters; valid keys are:
- *
filter
Filters to apply to the list.
- *
max
Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20]
- *
offset
Used in paging of the list. This is the start offset of the page. [min value: 0, default: 0]
- *
sorting
Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either asc for ascending or desc for descending). Sortable properties are: id invoiceDate dueDate datePaid customer status dateCreated.
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return ResourceList a ResourceList object that holds the list of Invoice objects and the total
- * number of Invoice objects available for the given criteria.
- * @see ResourceList
- */
- static public function listInvoice($criteria = null, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $val = new Simplify_Invoice();
- $list = Simplify_PaymentsApi::listObject($val, $criteria, $authentication);
-
- return $list;
- }
-
-
- /**
- * Retrieve a Simplify_Invoice object from the API
- *
- * @param string id the id of the Invoice object to retrieve
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return Invoice a Invoice object
- */
- static public function findInvoice($id, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $val = new Simplify_Invoice();
- $val->id = $id;
-
- $obj = Simplify_PaymentsApi::findObject($val, $authentication);
-
- return $obj;
- }
-
-
- /**
- * Updates an Simplify_Invoice object.
- *
- * The properties that can be updated:
- *
- *
billingAddress.city
Billing address city of the location where the goods or services were supplied. [max length: 255, min length: 2]
- *
billingAddress.country
Billing address country of the location where the goods or services were supplied. [max length: 2, min length: 2]
- *
billingAddress.line1
Billing address line 1 of the location where the goods or services were supplied. [max length: 255]
- *
billingAddress.line2
Billing address line 2 of the location where the goods or services were supplied. [max length: 255]
- *
billingAddress.name
Billing address name of the location where the goods or services were supplied. [max length: 255]
- *
billingAddress.state
Billing address state of the location where the goods or services were supplied. [max length: 255]
- *
billingAddress.zip
Billing address zip of the location where the goods or services were supplied. [max length: 32]
- *
businessAddress.city
Business address city of the business that is sending the invoice. [max length: 255, min length: 2]
- *
businessAddress.country
Business address country of the business that is sending the invoice. [max length: 2, min length: 2]
- *
businessAddress.line1
Business address line 1 of the business that is sending the invoice. [max length: 255]
- *
businessAddress.line2
Business address line 2 of the business that is sending the invoice. [max length: 255]
- *
businessAddress.name
Business address name of the business that is sending the invoice. [max length: 255]
- *
businessAddress.state
Business address state of the business that is sending the invoice. [max length: 255]
- *
businessAddress.zip
Business address zip of the business that is sending the invoice. [max length: 32]
- *
currency
Currency code (ISO-4217). Must match the currency associated with your account. [max length: 3, min length: 3]
- *
customerTaxNo
The tax number or VAT id of the person to whom the goods or services were supplied. [max length: 255]
- *
datePaid
This is the date the invoice was PAID in UTC millis.
- *
discountRate
The discount percent as a decimal e.g. 12.5. This is used to calculate the discount amount which is subtracted from the total amount due before any tax is applied. [max length: 6]
- *
dueDate
The date invoice payment is due. If a late fee is provided this will be added to the invoice total is the due date has past.
- *
email
The email of the customer we are invoicing. This is optional if customer or invoiceToCopy is provided. A new customer will be created using the the name and email.
- *
invoiceId
User defined invoice id. If not provided the system will generate a numeric id. [max length: 255]
- *
items.amount
Amount of the invoice item in the smallest unit of your currency. Example: 100 = $1.00USD [min value: -9999900, max value: 9999900] required
- *
items.description
The description of the invoice item. [max length: 1024]
- *
items.invoice
The ID of the invoice this item belongs to.
- *
items.product
The Id of the product this item refers to.
- *
items.quantity
Quantity of the item. This total amount of the invoice item is the amount * quantity. [min value: 1, max value: 999999, default: 1]
- *
items.reference
User defined reference field. [max length: 255]
- *
items.tax
The tax ID of the tax charge in the invoice item.
- *
lateFee
The late fee amount that will be added to the invoice total is the due date is past due. Value provided must be in the smallest unit of your currency. Example: 100 = $1.00USD [max value: 9999900]
- *
memo
A memo that is displayed to the customer on the invoice payment screen. [max length: 4000]
- *
name
The name of the customer we are invoicing. This is optional if customer or invoiceToCopy is provided. A new customer will be created using the the name and email. [max length: 50, min length: 2]
- *
note
This field can be used to store a note that is not displayed to the customer. [max length: 4000]
- *
payment
The ID of the payment. Use this ID to query the /payment API. [max length: 255]
- *
reference
User defined reference field. [max length: 255]
- *
shippingAddress.city
Address city of the location where the goods or services were supplied. [max length: 255, min length: 2]
- *
shippingAddress.country
Address country of the location where the goods or services were supplied. [max length: 2, min length: 2]
- *
shippingAddress.line1
Address line 1 of the location where the goods or services were supplied. [max length: 255]
- *
shippingAddress.line2
Address line 2 of the location where the goods or services were supplied. [max length: 255]
- *
shippingAddress.name
Address name of the location where the goods or services were supplied. [max length: 255]
- *
shippingAddress.state
Address state of the location where the goods or services were supplied. [max length: 255]
- *
shippingAddress.zip
Address zip of the location where the goods or services were supplied. [max length: 32]
- *
status
New status of the invoice.
- *
suppliedDate
The date on which the goods or services were supplied.
- *
taxNo
The tax number or VAT id of the person who supplied the goods or services. [max length: 255]
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return Invoice a Invoice object.
- */
- public function updateInvoice($authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 1);
-
- $object = Simplify_PaymentsApi::updateObject($this, $authentication);
- return $object;
- }
-
- /**
- * @ignore
- */
- public function getClazz() {
- return "Invoice";
- }
-}
diff --git a/includes/gateways/simplify-commerce/includes/Simplify/InvoiceItem.php b/includes/gateways/simplify-commerce/includes/Simplify/InvoiceItem.php
deleted file mode 100644
index 9c7d9b8c05344..0000000000000
--- a/includes/gateways/simplify-commerce/includes/Simplify/InvoiceItem.php
+++ /dev/null
@@ -1,128 +0,0 @@
-
- *
amount
Amount of the invoice item in the smallest unit of your currency. Example: 100 = $1.00USD [min value: -9999900, max value: 9999900] required
- *
description
Individual items of an invoice [max length: 1024]
- *
invoice
The ID of the invoice this item belongs to.
- *
product
Product ID this item relates to.
- *
quantity
Quantity of the item. This total amount of the invoice item is the amount * quantity. [min value: 1, max value: 999999, default: 1]
- *
reference
User defined reference field. [max length: 255]
- *
tax
The tax ID of the tax charge in the invoice item.
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return InvoiceItem a InvoiceItem object.
- */
- static public function createInvoiceItem($hash, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $instance = new Simplify_InvoiceItem();
- $instance->setAll($hash);
-
- $object = Simplify_PaymentsApi::createObject($instance, $authentication);
- return $object;
- }
-
-
- /**
- * Deletes an Simplify_InvoiceItem object.
- *
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- *
- * @return true
- */
- public function deleteInvoiceItem($authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 1);
-
- $obj = Simplify_PaymentsApi::deleteObject($this, $authentication);
- $this->properties = null;
- return true;
- }
-
-
- /**
- * Retrieve a Simplify_InvoiceItem object from the API
- *
- * @param string id the id of the InvoiceItem object to retrieve
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return InvoiceItem a InvoiceItem object
- */
- static public function findInvoiceItem($id, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $val = new Simplify_InvoiceItem();
- $val->id = $id;
-
- $obj = Simplify_PaymentsApi::findObject($val, $authentication);
-
- return $obj;
- }
-
-
- /**
- * Updates an Simplify_InvoiceItem object.
- *
- * The properties that can be updated:
- *
- *
amount
Amount of the invoice item in the smallest unit of your currency. Example: 100 = $1.00USD [min value: 1]
- *
description
Individual items of an invoice
- *
quantity
Quantity of the item. This total amount of the invoice item is the amount * quantity. [min value: 1, max value: 999999]
- *
reference
User defined reference field.
- *
tax
The tax ID of the tax charge in the invoice item.
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return InvoiceItem a InvoiceItem object.
- */
- public function updateInvoiceItem($authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 1);
-
- $object = Simplify_PaymentsApi::updateObject($this, $authentication);
- return $object;
- }
-
- /**
- * @ignore
- */
- public function getClazz() {
- return "InvoiceItem";
- }
-}
diff --git a/includes/gateways/simplify-commerce/includes/Simplify/Object.php b/includes/gateways/simplify-commerce/includes/Simplify/Object.php
deleted file mode 100644
index f7fc4e4282035..0000000000000
--- a/includes/gateways/simplify-commerce/includes/Simplify/Object.php
+++ /dev/null
@@ -1,90 +0,0 @@
-properties)) {
- return $this->properties[$key];
- } else {
- return null;
- }
- }
-
- /**
- * @ignore
- *
- * @param string $key
- * @param mixed $value
- */
- public function __set($key, $value) {
- $this->properties[$key] = $value;
- }
-
- /**
- * Updates the object's properties with the values in the specified map.
- * @param $hash array Map of values to set.
- */
- public function setAll($hash) {
- foreach ($hash as $key => $value) {
- $this->$key = $value;
- }
- }
-
- /**
- * @ignore
- */
- public function __toString() {
- return json_encode($this->properties);
- }
-
- /**
- * Returns the object's properties as a map.
- * @return array map of properties.
- */
- public function getProperties() {
- return $this->properties;
- }
-}
diff --git a/includes/gateways/simplify-commerce/includes/Simplify/Payment.php b/includes/gateways/simplify-commerce/includes/Simplify/Payment.php
deleted file mode 100644
index 44f616992b35c..0000000000000
--- a/includes/gateways/simplify-commerce/includes/Simplify/Payment.php
+++ /dev/null
@@ -1,145 +0,0 @@
-
- *
amount
Amount of the payment (in the smallest unit of your currency). Example: 100 = $1.00USD
- *
authorization
The ID of the authorization being used to capture the payment.
- *
card.addressCity
City of the cardholder. [max length: 50, min length: 2]
- *
card.addressCountry
Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder. [max length: 2, min length: 2]
- *
card.addressLine1
Address of the cardholder. [max length: 255]
- *
card.addressLine2
Address of the cardholder if needed. [max length: 255]
- *
card.addressState
State of residence of the cardholder. For the US, this is a 2-digit USPS code. [max length: 255, min length: 2]
- *
card.addressZip
Postal code of the cardholder. The postal code size is between 5 and 9 in length and only contain numbers or letters. [max length: 9, min length: 3]
- *
card.cvc
CVC security code of the card. This is the code on the back of the card. Example: 123
- *
card.expMonth
Expiration month of the card. Format is MM. Example: January = 01 [min value: 1, max value: 12] required
- *
card.expYear
Expiration year of the card. Format is YY. Example: 2013 = 13 [min value: 0, max value: 99] required
- *
card.name
Name as it appears on the card. [max length: 50, min length: 2]
- *
card.number
Card number as it appears on the card. [max length: 19, min length: 13] required
- *
currency
Currency code (ISO-4217) for the transaction. Must match the currency associated with your account. [default: USD] required
- *
customer
ID of customer. If specified, card on file of customer will be used.
- *
description
Free form text field to be used as a description of the payment. This field is echoed back with the payment on any find or list operations. [max length: 1024]
- *
invoice
ID of invoice for which this payment is being made.
- *
reference
Custom reference field to be used with outside systems.
- *
replayId
An identifier that can be sent to uniquely identify a payment request to facilitate retries due to I/O related issues. This identifier must be unique for your account (sandbox or live) across all of your payments. If supplied, we will check for a payment on your account that matches this identifier. If found will attempt to return an identical response of the original request. [max length: 50, min length: 1]
- *
statementDescription.name
Merchant name. required
- *
statementDescription.phoneNumber
Merchant contact phone number.
- *
token
If specified, card associated with card token will be used. [max length: 255]
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return Payment a Payment object.
- */
- static public function createPayment($hash, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $instance = new Simplify_Payment();
- $instance->setAll($hash);
-
- $object = Simplify_PaymentsApi::createObject($instance, $authentication);
- return $object;
- }
-
-
-
- /**
- * Retrieve Simplify_Payment objects.
- * @param array criteria a map of parameters; valid keys are:
- *
filter
Filters to apply to the list.
- *
max
Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20]
- *
offset
Used in paging of the list. This is the start offset of the page. [min value: 0, default: 0]
- *
sorting
Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either asc for ascending or desc for descending). Sortable properties are: dateCreated createdBy amount id description paymentDate.
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return ResourceList a ResourceList object that holds the list of Payment objects and the total
- * number of Payment objects available for the given criteria.
- * @see ResourceList
- */
- static public function listPayment($criteria = null, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $val = new Simplify_Payment();
- $list = Simplify_PaymentsApi::listObject($val, $criteria, $authentication);
-
- return $list;
- }
-
-
- /**
- * Retrieve a Simplify_Payment object from the API
- *
- * @param string id the id of the Payment object to retrieve
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return Payment a Payment object
- */
- static public function findPayment($id, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $val = new Simplify_Payment();
- $val->id = $id;
-
- $obj = Simplify_PaymentsApi::findObject($val, $authentication);
-
- return $obj;
- }
-
-
- /**
- * Updates an Simplify_Payment object.
- *
- * The properties that can be updated:
- *
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return Payment a Payment object.
- */
- public function updatePayment($authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 1);
-
- $object = Simplify_PaymentsApi::updateObject($this, $authentication);
- return $object;
- }
-
- /**
- * @ignore
- */
- public function getClazz() {
- return "Payment";
- }
-}
diff --git a/includes/gateways/simplify-commerce/includes/Simplify/PaymentsApi.php b/includes/gateways/simplify-commerce/includes/Simplify/PaymentsApi.php
deleted file mode 100644
index c6f2a894179ff..0000000000000
--- a/includes/gateways/simplify-commerce/includes/Simplify/PaymentsApi.php
+++ /dev/null
@@ -1,358 +0,0 @@
- 'POST',
- 'delete' => 'DELETE',
- 'list' => 'GET',
- 'show' => 'GET',
- 'update' => 'PUT'
- );
-
- /**
- * @ignore
- *
- * @param object $object
- * @param object $authentication
- *
- * @return mixed
- */
- static public function createObject($object, $authentication = null)
- {
- $paymentsApi = new Simplify_PaymentsApi();
-
- $jsonObject = $paymentsApi->execute("create", $object, $authentication);
-
- $o = $paymentsApi->convertFromHashToObject($jsonObject, $object->getClazz());
-
- return $o;
- }
-
- /**
- * @ignore
- *
- * @param object $object
- * @param object $authentication
- *
- * @return mixed
- */
- static public function findObject($object, $authentication = null)
- {
- $paymentsApi = new Simplify_PaymentsApi();
-
- $jsonObject = $paymentsApi->execute("show", $object, $authentication);
- $o = $paymentsApi->convertFromHashToObject($jsonObject, $object->getClazz());
-
- return $o;
- }
-
- /**
- * @ignore
- *
- * @param object $object
- * @param object $authentication
- *
- * @return mixed
- */
- static public function updateObject($object, $authentication = null) {
- $paymentsApi = new Simplify_PaymentsApi();
-
- $jsonObject = $paymentsApi->execute("update", $object, $authentication);
- $o = $paymentsApi->convertFromHashToObject($jsonObject, $object->getClazz());
-
- return $o;
- }
-
- /**
- * @ignore
- *
- * @param object $object
- * @param object $authentication
- *
- * @return mixed
- */
- static public function deleteObject($object, $authentication = null) {
- $paymentsApi = new Simplify_PaymentsApi();
-
- $jsonObject = $paymentsApi->execute("delete", $object, $authentication);
-
- return $jsonObject;
- }
-
- /**
- * @ignore
- *
- * @param object $object
- * @param array $criteria
- * @param object $authentication
- *
- * @return Simplify_ResourceList
- */
- static public function listObject($object, $criteria = null, $authentication = null) {
- if ($criteria != null) {
- if (isset($criteria['max'])) {
- $object->max = $criteria['max'];
- }
- if (isset($criteria['offset'])) {
- $object->offset = $criteria['offset'];
- }
- if (isset($criteria['sorting'])) {
- $object->sorting = $criteria['sorting'];
- }
- if (isset($criteria['filter'])) {
- $object->filter = $criteria['filter'];
- }
- }
-
- $paymentsApi = new Simplify_PaymentsApi();
- $jsonObject = $paymentsApi->execute("list", $object, $authentication);
-
- $ret = new Simplify_ResourceList();
- if (array_key_exists('list', $jsonObject) & is_array($jsonObject['list'])) {
- foreach ($jsonObject['list'] as $obj) {
- array_push($ret->list, $paymentsApi->convertFromHashToObject($obj, $object->getClazz()));
- }
- $ret->total = $jsonObject['total'];
- }
-
- return $ret;
- }
-
- /**
- * @ignore
- *
- * @param array $from
- * @param string $toClazz
- *
- * @return mixed
- */
- public function convertFromHashToObject($from, $toClazz)
- {
- $clazz = 'stdClass';
- $toClazz = "Simplify_" . $toClazz;
- if ("stdClass" != $toClazz && class_exists("{$toClazz}", false)) {
- $clazz = "{$toClazz}";
- }
- $object = new $clazz();
-
- foreach ($from as $key => $value) {
- if (is_array($value) && count(array_keys($value))) {
- $newClazz = "Simplify_" . ucfirst($key);
- if (!class_exists($newClazz, false)) {
- $newClazz = 'stdClass';
- }
-
- $object->$key = $this->convertFromHashToObject($value, $newClazz);
- } else {
- $object->$key = $value;
- }
- }
-
- return $object;
- }
-
- /**
- * @ignore
- *
- * @param string $publicKey
- * @param string $action
- * @param object $object
- *
- * @return string
- */
- public function getUrl($publicKey, $action, $object)
- {
- $url = $this->fixUrl(Simplify::$apiBaseSandboxUrl);
- if ($this->isLiveKey($publicKey)) {
- $url = $this->fixUrl(Simplify::$apiBaseLiveUrl);
- }
- $url = $this->fixUrl($url) . urlencode(lcfirst($object->getClazz())) . '/';
-
- $queryParams = array();
- if ($action == "show") {
- $url .= urlencode($object->id);
- } elseif ($action == "list") {
- $queryParams = array_merge($queryParams, array('max' => $object->max, 'offset' => $object->offset));
- if (is_array($object->filter) && count(array_keys($object->filter))) {
- foreach ($object->filter as $key => $value) {
- $queryParams["filter[$key]"] = $value;
- }
- }
- if (is_array($object->sorting) && count(array_keys($object->sorting))) {
- foreach ($object->sorting as $key => $value) {
- $queryParams["sorting[$key]"] = $value;
- }
- }
- $query = http_build_query($queryParams);
- if ($query != '') {
- if (strpos($url, '?', strlen($url)) === false) $url .= '?';
- $url .= $query;
- }
-
- } elseif ($action == "delete") {
- $url .= urlencode($object->id);
- } elseif ($action == "update") {
- $url .= urlencode($object->id);
- } elseif ($action == "create") {
- }
- return $url;
- }
-
- /**
- * @ignore
- *
- * @param string $action
- *
- * @return string
- */
- public function getMethod($action)
- {
- if (array_key_exists(strtolower($action), self::$methodMap)) {
- return self::$methodMap[strtolower($action)];
- }
- return 'GET';
- }
-
- /**
- * @ignore
- *
- * @param string $action
- * @param object $object
- * @param object $authentication
- *
- * @return mixed
- */
- private function execute($action, $object, $authentication)
- {
- $http = new Simplify_HTTP();
-
- return $http->apiRequest($this->getUrl($authentication->publicKey, $action, $object), $this->getMethod($action),
- $authentication, json_encode($object->getProperties()));
- }
-
- /**
- * @ignore
- *
- * @param string $hash
- * @param object $authentication
- *
- * @return mixed
- */
- public function jwsDecode($hash, $authentication)
- {
- $http = new Simplify_HTTP();
-
- $data = $http->jwsDecode($authentication, $hash);
-
- return json_decode($data, true);
- }
-
- /**
- * @ignore
- *
- * @param string $url
- *
- * @return string
- */
- private function fixUrl($url)
- {
- if ($this->endsWith($url, '/')) {
- return $url;
- }
- return $url . '/';
- }
-
- /**
- * @ignore
- *
- * @param string $k
- *
- * @return bool
- */
- private function isLiveKey($k) {
- return strpos($k, "lvpb") === 0;
- }
-
- /**
- * @ignore
- *
- * @param string $s
- * @param string $c
- *
- * @return bool
- */
- private function endsWith($s, $c)
- {
- return substr($s, -strlen($c)) == $c;
- }
-
- /**
- * Helper function to build the Authentication object for backwards compatibility.
- * An array of all the arguments passed to one of the API functions is checked against what
- * we expect to received. If it's greater, then we're assuming that the user is using the older way of
- * passing the keys. i.e as two separate strings. We take those two string and create the Authentication object
- *
- * @ignore
- * @param $authentication
- * @param $args
- * @param $expectedArgCount
- * @return Simplify_Authentication
- */
- static function buildAuthenticationObject($authentication = null, $args, $expectedArgCount){
-
- if(sizeof($args) > $expectedArgCount) {
- $authentication = new Simplify_Authentication($args[$expectedArgCount-1], $args[$expectedArgCount]);
- }
-
- if ($authentication == null){
- $authentication = new Simplify_Authentication();
- }
-
- // check that the keys have been set, if not use the global keys
- if ( empty($authentication->publicKey)){
- $authentication->publicKey = Simplify::$publicKey;
- }
- if ( empty($authentication->privateKey)){
- $authentication->privateKey = Simplify::$privateKey;
- }
-
- return $authentication;
- }
-
-}
diff --git a/includes/gateways/simplify-commerce/includes/Simplify/Plan.php b/includes/gateways/simplify-commerce/includes/Simplify/Plan.php
deleted file mode 100644
index 8f11103a09846..0000000000000
--- a/includes/gateways/simplify-commerce/includes/Simplify/Plan.php
+++ /dev/null
@@ -1,151 +0,0 @@
-
- *
amount
Amount of payment for the plan in the smallest unit of your currency. Example: 100 = $1.00USD required
- *
billingCycle
How the plan is billed to the customer. Values must be AUTO (indefinitely until the customer cancels) or FIXED (a fixed number of billing cycles). [default: AUTO]
- *
billingCycleLimit
The number of fixed billing cycles for a plan. Only used if the billingCycle parameter is set to FIXED. Example: 4
- *
currency
Currency code (ISO-4217) for the plan. Must match the currency associated with your account. [default: USD] required
- *
frequency
Frequency of payment for the plan. Used in conjunction with frequencyPeriod. Valid values are "DAILY", "WEEKLY", "MONTHLY" and "YEARLY". [default: MONTHLY] required
- *
frequencyPeriod
Period of frequency of payment for the plan. Example: if the frequency is weekly, and periodFrequency is 2, then the subscription is billed bi-weekly. [min value: 1, default: 1] required
- *
name
Name of the plan [max length: 50, min length: 2] required
- *
renewalReminderLeadDays
If set, how many days before the next billing cycle that a renewal reminder is sent to the customer. If null, then no emails are sent. Minimum value is 7 if set.
- *
trialPeriod
Plan free trial period selection. Must be Days, Weeks, or Month [default: NONE] required
- *
trialPeriodQuantity
Quantity of the trial period. Must be greater than 0 and a whole number. [min value: 1]
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return Plan a Plan object.
- */
- static public function createPlan($hash, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $instance = new Simplify_Plan();
- $instance->setAll($hash);
-
- $object = Simplify_PaymentsApi::createObject($instance, $authentication);
- return $object;
- }
-
-
- /**
- * Deletes an Simplify_Plan object.
- *
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- *
- * @return true
- */
- public function deletePlan($authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 1);
-
- $obj = Simplify_PaymentsApi::deleteObject($this, $authentication);
- $this->properties = null;
- return true;
- }
-
-
- /**
- * Retrieve Simplify_Plan objects.
- * @param array criteria a map of parameters; valid keys are:
- *
filter
Filters to apply to the list.
- *
max
Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20]
- *
offset
Used in paging of the list. This is the start offset of the page. [min value: 0, default: 0]
- *
sorting
Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either asc for ascending or desc for descending). Sortable properties are: dateCreated amount frequency name id.
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return ResourceList a ResourceList object that holds the list of Plan objects and the total
- * number of Plan objects available for the given criteria.
- * @see ResourceList
- */
- static public function listPlan($criteria = null, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $val = new Simplify_Plan();
- $list = Simplify_PaymentsApi::listObject($val, $criteria, $authentication);
-
- return $list;
- }
-
-
- /**
- * Retrieve a Simplify_Plan object from the API
- *
- * @param string id the id of the Plan object to retrieve
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return Plan a Plan object
- */
- static public function findPlan($id, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $val = new Simplify_Plan();
- $val->id = $id;
-
- $obj = Simplify_PaymentsApi::findObject($val, $authentication);
-
- return $obj;
- }
-
-
- /**
- * Updates an Simplify_Plan object.
- *
- * The properties that can be updated:
- *
- *
name
Name of the plan. [min length: 2] required
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return Plan a Plan object.
- */
- public function updatePlan($authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 1);
-
- $object = Simplify_PaymentsApi::updateObject($this, $authentication);
- return $object;
- }
-
- /**
- * @ignore
- */
- public function getClazz() {
- return "Plan";
- }
-}
diff --git a/includes/gateways/simplify-commerce/includes/Simplify/Refund.php b/includes/gateways/simplify-commerce/includes/Simplify/Refund.php
deleted file mode 100644
index 46c22ecfb8773..0000000000000
--- a/includes/gateways/simplify-commerce/includes/Simplify/Refund.php
+++ /dev/null
@@ -1,112 +0,0 @@
-
- *
amount
Amount of the refund in the smallest unit of your currency. Example: 100 = $1.00USD [min value: 1] required
- *
payment
ID of the payment for the refund required
- *
reason
Reason for the refund
- *
reference
Custom reference field to be used with outside systems.
- *
replayId
An identifier that can be sent to uniquely identify a refund request to facilitate retries due to I/O related issues. This identifier must be unique for your account (sandbox or live) across all of your refunds. If supplied, we will check for a refund on your account that matches this identifier. If found we will return an identical response to that of the original request. [max length: 50, min length: 1]
- *
statementDescription.name
Merchant name. required
- *
statementDescription.phoneNumber
Merchant contact phone number.
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return Refund a Refund object.
- */
- static public function createRefund($hash, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $instance = new Simplify_Refund();
- $instance->setAll($hash);
-
- $object = Simplify_PaymentsApi::createObject($instance, $authentication);
- return $object;
- }
-
-
-
- /**
- * Retrieve Simplify_Refund objects.
- * @param array criteria a map of parameters; valid keys are:
- *
filter
Filters to apply to the list.
- *
max
Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20]
- *
offset
Used in paging of the list. This is the start offset of the page. [min value: 0, default: 0]
- *
sorting
Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either asc for ascending or desc for descending). Sortable properties are: id amount description dateCreated paymentDate.
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return ResourceList a ResourceList object that holds the list of Refund objects and the total
- * number of Refund objects available for the given criteria.
- * @see ResourceList
- */
- static public function listRefund($criteria = null, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $val = new Simplify_Refund();
- $list = Simplify_PaymentsApi::listObject($val, $criteria, $authentication);
-
- return $list;
- }
-
-
- /**
- * Retrieve a Simplify_Refund object from the API
- *
- * @param string id the id of the Refund object to retrieve
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return Refund a Refund object
- */
- static public function findRefund($id, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $val = new Simplify_Refund();
- $val->id = $id;
-
- $obj = Simplify_PaymentsApi::findObject($val, $authentication);
-
- return $obj;
- }
-
- /**
- * @ignore
- */
- public function getClazz() {
- return "Refund";
- }
-}
diff --git a/includes/gateways/simplify-commerce/includes/Simplify/ResourceList.php b/includes/gateways/simplify-commerce/includes/Simplify/ResourceList.php
deleted file mode 100644
index 7c31002fe961c..0000000000000
--- a/includes/gateways/simplify-commerce/includes/Simplify/ResourceList.php
+++ /dev/null
@@ -1,48 +0,0 @@
-() methods.
- */
-class Simplify_ResourceList {
-
- /**
- * @var array $list the list of domain objects.
- */
- public $list = array();
-
- /**
- * @var int $total the total number of object available.
- */
- public $total = 0;
-}
diff --git a/includes/gateways/simplify-commerce/includes/Simplify/Subscription.php b/includes/gateways/simplify-commerce/includes/Simplify/Subscription.php
deleted file mode 100644
index 91d33005fa52a..0000000000000
--- a/includes/gateways/simplify-commerce/includes/Simplify/Subscription.php
+++ /dev/null
@@ -1,164 +0,0 @@
-
- *
amount
Amount of the payment in the smallest unit of your currency. Example: 100 = $1.00USD
- *
billingCycle
How the plan is billed to the customer. Values must be AUTO (indefinitely until the customer cancels) or FIXED (a fixed number of billing cycles). [default: AUTO]
- *
billingCycleLimit
The number of fixed billing cycles for a plan. Only used if the billingCycle parameter is set to FIXED. Example: 4
- *
coupon
Coupon ID associated with the subscription
- *
currency
Currency code (ISO-4217). Must match the currency associated with your account. [default: USD]
- *
customer
Customer that is enrolling in the subscription.
- *
frequency
Frequency of payment for the plan. Used in conjunction with frequencyPeriod. Valid values are "DAILY", "WEEKLY", "MONTHLY" and "YEARLY".
- *
frequencyPeriod
Period of frequency of payment for the plan. Example: if the frequency is weekly, and periodFrequency is 2, then the subscription is billed bi-weekly.
- *
name
Name describing subscription
- *
plan
The ID of the plan that should be used for the subscription.
- *
quantity
Quantity of the plan for the subscription. [min value: 1]
- *
renewalReminderLeadDays
If set, how many days before the next billing cycle that a renewal reminder is sent to the customer. If null, then no emails are sent. Minimum value is 7 if set.
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return Subscription a Subscription object.
- */
- static public function createSubscription($hash, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $instance = new Simplify_Subscription();
- $instance->setAll($hash);
-
- $object = Simplify_PaymentsApi::createObject($instance, $authentication);
- return $object;
- }
-
-
- /**
- * Deletes an Simplify_Subscription object.
- *
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- *
- * @return true
- */
- public function deleteSubscription($authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 1);
-
- $obj = Simplify_PaymentsApi::deleteObject($this, $authentication);
- $this->properties = null;
- return true;
- }
-
-
- /**
- * Retrieve Simplify_Subscription objects.
- * @param array criteria a map of parameters; valid keys are:
- *
filter
Filters to apply to the list.
- *
max
Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20]
- *
offset
Used in paging of the list. This is the start offset of the page. [min value: 0, default: 0]
- *
sorting
Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either asc for ascending or desc for descending). Sortable properties are: id plan.
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return ResourceList a ResourceList object that holds the list of Subscription objects and the total
- * number of Subscription objects available for the given criteria.
- * @see ResourceList
- */
- static public function listSubscription($criteria = null, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $val = new Simplify_Subscription();
- $list = Simplify_PaymentsApi::listObject($val, $criteria, $authentication);
-
- return $list;
- }
-
-
- /**
- * Retrieve a Simplify_Subscription object from the API
- *
- * @param string id the id of the Subscription object to retrieve
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return Subscription a Subscription object
- */
- static public function findSubscription($id, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $val = new Simplify_Subscription();
- $val->id = $id;
-
- $obj = Simplify_PaymentsApi::findObject($val, $authentication);
-
- return $obj;
- }
-
-
- /**
- * Updates an Simplify_Subscription object.
- *
- * The properties that can be updated:
- *
- *
amount
Amount of the payment in the smallest unit of your currency. Example: 100 = $1.00USD
- *
billingCycle
How the plan is billed to the customer. Values must be AUTO (indefinitely until the customer cancels) or FIXED (a fixed number of billing cycles). [default: AUTO]
- *
billingCycleLimit
The number of fixed billing cycles for a plan. Only used if the billingCycle parameter is set to FIXED. Example: 4
- *
coupon
Coupon being assigned to this subscription
- *
currency
Currency code (ISO-4217). Must match the currency associated with your account. [default: USD]
- *
frequency
Frequency of payment for the plan. Used in conjunction with frequencyPeriod. Valid values are "DAILY", "WEEKLY", "MONTHLY" and "YEARLY".
- *
frequencyPeriod
Period of frequency of payment for the plan. Example: if the frequency is weekly, and periodFrequency is 2, then the subscription is billed bi-weekly. [min value: 1]
- *
name
Name describing subscription
- *
plan
Plan that should be used for the subscription.
- *
prorate
Whether to prorate existing subscription. [default: true] required
- *
quantity
Quantity of the plan for the subscription. [min value: 1]
- *
renewalReminderLeadDays
If set, how many days before the next billing cycle that a renewal reminder is sent to the customer. If null or 0, no emails are sent. Minimum value is 7 if set.
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return Subscription a Subscription object.
- */
- public function updateSubscription($authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 1);
-
- $object = Simplify_PaymentsApi::updateObject($this, $authentication);
- return $object;
- }
-
- /**
- * @ignore
- */
- public function getClazz() {
- return "Subscription";
- }
-}
diff --git a/includes/gateways/simplify-commerce/includes/Simplify/Tax.php b/includes/gateways/simplify-commerce/includes/Simplify/Tax.php
deleted file mode 100644
index 0e504afd5bf6e..0000000000000
--- a/includes/gateways/simplify-commerce/includes/Simplify/Tax.php
+++ /dev/null
@@ -1,124 +0,0 @@
-
- *
label
The label of the tax object. [max length: 255] required
- *
rate
The tax rate. Decimal value up three decimal places. e.g 12.501. [max length: 6] required
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return Tax a Tax object.
- */
- static public function createTax($hash, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $instance = new Simplify_Tax();
- $instance->setAll($hash);
-
- $object = Simplify_PaymentsApi::createObject($instance, $authentication);
- return $object;
- }
-
-
- /**
- * Deletes an Simplify_Tax object.
- *
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- *
- * @return true
- */
- public function deleteTax($authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 1);
-
- $obj = Simplify_PaymentsApi::deleteObject($this, $authentication);
- $this->properties = null;
- return true;
- }
-
-
- /**
- * Retrieve Simplify_Tax objects.
- * @param array criteria a map of parameters; valid keys are:
- *
filter
Filters to apply to the list.
- *
max
Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20]
- *
offset
Used in paging of the list. This is the start offset of the page. [min value: 0, default: 0]
- *
sorting
Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either asc for ascending or desc for descending). Sortable properties are: id label.
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return ResourceList a ResourceList object that holds the list of Tax objects and the total
- * number of Tax objects available for the given criteria.
- * @see ResourceList
- */
- static public function listTax($criteria = null, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $val = new Simplify_Tax();
- $list = Simplify_PaymentsApi::listObject($val, $criteria, $authentication);
-
- return $list;
- }
-
-
- /**
- * Retrieve a Simplify_Tax object from the API
- *
- * @param string id the id of the Tax object to retrieve
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return Tax a Tax object
- */
- static public function findTax($id, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $val = new Simplify_Tax();
- $val->id = $id;
-
- $obj = Simplify_PaymentsApi::findObject($val, $authentication);
-
- return $obj;
- }
-
- /**
- * @ignore
- */
- public function getClazz() {
- return "Tax";
- }
-}
diff --git a/includes/gateways/simplify-commerce/includes/Simplify/TransactionReview.php b/includes/gateways/simplify-commerce/includes/Simplify/TransactionReview.php
deleted file mode 100644
index 29cd2187a3de7..0000000000000
--- a/includes/gateways/simplify-commerce/includes/Simplify/TransactionReview.php
+++ /dev/null
@@ -1,141 +0,0 @@
-
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return TransactionReview a TransactionReview object.
- */
- static public function createTransactionReview($hash, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $instance = new Simplify_TransactionReview();
- $instance->setAll($hash);
-
- $object = Simplify_PaymentsApi::createObject($instance, $authentication);
- return $object;
- }
-
-
- /**
- * Deletes an Simplify_TransactionReview object.
- *
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- *
- * @return true
- */
- public function deleteTransactionReview($authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 1);
-
- $obj = Simplify_PaymentsApi::deleteObject($this, $authentication);
- $this->properties = null;
- return true;
- }
-
-
- /**
- * Retrieve Simplify_TransactionReview objects.
- * @param array criteria a map of parameters; valid keys are:
- *
filter
Allows for ascending or descending sorting of the list.
- *
max
Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20]
- *
offset
Filters to apply to the list. [min value: 0, default: 0]
- *
sorting
Used in paging of the list. This is the start offset of the page. The value maps properties to the sort direction (either asc for ascending or desc for descending). Sortable properties are: dateCreated status.
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return ResourceList a ResourceList object that holds the list of TransactionReview objects and the total
- * number of TransactionReview objects available for the given criteria.
- * @see ResourceList
- */
- static public function listTransactionReview($criteria = null, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $val = new Simplify_TransactionReview();
- $list = Simplify_PaymentsApi::listObject($val, $criteria, $authentication);
-
- return $list;
- }
-
-
- /**
- * Retrieve a Simplify_TransactionReview object from the API
- *
- * @param string id the id of the TransactionReview object to retrieve
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return TransactionReview a TransactionReview object
- */
- static public function findTransactionReview($id, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $val = new Simplify_TransactionReview();
- $val->id = $id;
-
- $obj = Simplify_PaymentsApi::findObject($val, $authentication);
-
- return $obj;
- }
-
-
- /**
- * Updates an Simplify_TransactionReview object.
- *
- * The properties that can be updated:
- *
- *
status
Status of the transaction review.
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return TransactionReview a TransactionReview object.
- */
- public function updateTransactionReview($authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 1);
-
- $object = Simplify_PaymentsApi::updateObject($this, $authentication);
- return $object;
- }
-
- /**
- * @ignore
- */
- public function getClazz() {
- return "TransactionReview";
- }
-}
diff --git a/includes/gateways/simplify-commerce/includes/Simplify/Webhook.php b/includes/gateways/simplify-commerce/includes/Simplify/Webhook.php
deleted file mode 100644
index efb80f487f8b5..0000000000000
--- a/includes/gateways/simplify-commerce/includes/Simplify/Webhook.php
+++ /dev/null
@@ -1,142 +0,0 @@
-
- *
url
Endpoint URL required
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return Webhook a Webhook object.
- */
- static public function createWebhook($hash, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $instance = new Simplify_Webhook();
- $instance->setAll($hash);
-
- $object = Simplify_PaymentsApi::createObject($instance, $authentication);
- return $object;
- }
-
-
- /**
- * Deletes an Simplify_Webhook object.
- *
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- *
- * @return true
- */
- public function deleteWebhook($authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 1);
-
- $obj = Simplify_PaymentsApi::deleteObject($this, $authentication);
- $this->properties = null;
- return true;
- }
-
-
- /**
- * Retrieve Simplify_Webhook objects.
- * @param array criteria a map of parameters; valid keys are:
- *
filter
Filters to apply to the list.
- *
max
Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20]
- *
offset
Used in paging of the list. This is the start offset of the page. [min value: 0, default: 0]
- *
sorting
Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either asc for ascending or desc for descending). Sortable properties are: dateCreated.
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return ResourceList a ResourceList object that holds the list of Webhook objects and the total
- * number of Webhook objects available for the given criteria.
- * @see ResourceList
- */
- static public function listWebhook($criteria = null, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $val = new Simplify_Webhook();
- $list = Simplify_PaymentsApi::listObject($val, $criteria, $authentication);
-
- return $list;
- }
-
-
- /**
- * Retrieve a Simplify_Webhook object from the API
- *
- * @param string id the id of the Webhook object to retrieve
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return Webhook a Webhook object
- */
- static public function findWebhook($id, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
-
- $val = new Simplify_Webhook();
- $val->id = $id;
-
- $obj = Simplify_PaymentsApi::findObject($val, $authentication);
-
- return $obj;
- }
-
-
- /**
- * Updates an Simplify_Webhook object.
- *
- * The properties that can be updated:
- *
- *
url
Endpoint URL required
- * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
- * @return Webhook a Webhook object.
- */
- public function updateWebhook($authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 1);
-
- $object = Simplify_PaymentsApi::updateObject($this, $authentication);
- return $object;
- }
-
- /**
- * @ignore
- */
- public function getClazz() {
- return "Webhook";
- }
-}
diff --git a/includes/import/abstract-wc-product-importer.php b/includes/import/abstract-wc-product-importer.php
index 64404ed5c60aa..5fbfcf504b792 100644
--- a/includes/import/abstract-wc-product-importer.php
+++ b/includes/import/abstract-wc-product-importer.php
@@ -765,21 +765,21 @@ protected function explode_values_formatter( $value ) {
}
/**
- * The exporter prepends a ' to fields that start with a - which causes
- * issues with negative numbers. This removes the ' if the input is still a valid
- * number after removal.
+ * The exporter prepends a ' to escape fields that start with =, +, - or @.
+ * Remove the prepended ' character preceding those characters.
*
- * @since 3.3.0
- * @param string $value A numeric string that may or may not have ' prepended.
+ * @since 3.5.2
+ * @param string $value A string that may or may not have been escaped with '.
* @return string
*/
- protected function unescape_negative_number( $value ) {
- if ( 0 === strpos( $value, "'-" ) ) {
- $unescaped = trim( $value, "'" );
- if ( is_numeric( $unescaped ) ) {
- return $unescaped;
- }
+ protected function unescape_data( $value ) {
+ $active_content_triggers = array( "'=", "'+", "'-", "'@" );
+
+ if ( in_array( mb_substr( $value, 0, 2 ), $active_content_triggers, true ) ) {
+ $value = mb_substr( $value, 1 );
}
+
return $value;
}
+
}
diff --git a/includes/import/class-wc-product-csv-importer.php b/includes/import/class-wc-product-csv-importer.php
index eb546efafdc18..bdf05d752dce6 100644
--- a/includes/import/class-wc-product-csv-importer.php
+++ b/includes/import/class-wc-product-csv-importer.php
@@ -2,8 +2,8 @@
/**
* WooCommerce Product CSV importer
*
- * @package WooCommerce/Import
- * @version 3.1.0
+ * @package WooCommerce/Import
+ * @version 3.1.0
*/
if ( ! defined( 'ABSPATH' ) ) {
@@ -17,6 +17,10 @@
include_once dirname( __FILE__ ) . '/abstract-wc-product-importer.php';
}
+if ( ! class_exists( 'WC_Product_CSV_Importer_Controller', false ) ) {
+ include_once WC_ABSPATH . 'includes/admin/importers/class-wc-product-csv-importer-controller.php';
+}
+
/**
* WC_Product_CSV_Importer Class.
*/
@@ -64,7 +68,7 @@ public function __construct( $file, $params = array() ) {
*/
protected function read_file() {
if ( ! WC_Product_CSV_Importer_Controller::is_file_valid_csv( $this->file ) ) {
- wp_die( __( 'Invalid file type. The importer supports CSV and TXT file formats.', 'woocommerce' ) );
+ wp_die( esc_html__( 'Invalid file type. The importer supports CSV and TXT file formats.', 'woocommerce' ) );
}
$handle = fopen( $this->file, 'r' ); // @codingStandardsIgnoreLine.
@@ -111,7 +115,8 @@ protected function read_file() {
/**
* Remove UTF-8 BOM signature.
*
- * @param string $string String to handle.
+ * @param string $string String to handle.
+ *
* @return string
*/
protected function remove_utf8_bom( $string ) {
@@ -144,7 +149,8 @@ protected function set_mapped_keys() {
* If mapping to a SKU and the product ID does not exist, a temporary object
* will be created so it can be updated later.
*
- * @param string $value Field value.
+ * @param string $value Field value.
+ *
* @return int|string
*/
public function parse_relative_field( $value ) {
@@ -213,7 +219,8 @@ public function parse_relative_field( $value ) {
* If we're not doing an update, create a placeholder product so mapping works
* for rows following this one.
*
- * @param string $value Field value.
+ * @param string $value Field value.
+ *
* @return int
*/
public function parse_id_field( $value ) {
@@ -263,6 +270,7 @@ public function parse_id_field( $value ) {
* Parse relative comma-delineated field and return product ID.
*
* @param string $value Field value.
+ *
* @return array
*/
public function parse_relative_comma_field( $value ) {
@@ -277,6 +285,7 @@ public function parse_relative_comma_field( $value ) {
* Parse a comma-delineated field from a CSV.
*
* @param string $value Field value.
+ *
* @return array
*/
public function parse_comma_field( $value ) {
@@ -284,6 +293,7 @@ public function parse_comma_field( $value ) {
return array();
}
+ $value = $this->unescape_data( $value );
return array_map( 'wc_clean', $this->explode_values( $value ) );
}
@@ -291,6 +301,7 @@ public function parse_comma_field( $value ) {
* Parse a field that is generally '1' or '0' but can be something else.
*
* @param string $value Field value.
+ *
* @return bool|string
*/
public function parse_bool_field( $value ) {
@@ -310,6 +321,7 @@ public function parse_bool_field( $value ) {
* Parse a float value field.
*
* @param string $value Field value.
+ *
* @return float|string
*/
public function parse_float_field( $value ) {
@@ -318,7 +330,7 @@ public function parse_float_field( $value ) {
}
// Remove the ' prepended to fields that start with - if needed.
- $value = $this->unescape_negative_number( $value );
+ $value = $this->unescape_data( $value );
return floatval( $value );
}
@@ -327,6 +339,7 @@ public function parse_float_field( $value ) {
* Parse the stock qty field.
*
* @param string $value Field value.
+ *
* @return float|string
*/
public function parse_stock_quantity_field( $value ) {
@@ -335,7 +348,7 @@ public function parse_stock_quantity_field( $value ) {
}
// Remove the ' prepended to fields that start with - if needed.
- $value = $this->unescape_negative_number( $value );
+ $value = $this->unescape_data( $value );
return wc_stock_amount( $value );
}
@@ -345,6 +358,7 @@ public function parse_stock_quantity_field( $value ) {
* Categories are separated by commas and subcategories are "parent > subcategory".
*
* @param string $value Field value.
+ *
* @return array of arrays with "parent" and "name" keys.
*/
public function parse_categories_field( $value ) {
@@ -395,7 +409,8 @@ public function parse_categories_field( $value ) {
/**
* Parse a tag field from a CSV.
*
- * @param string $value Field value.
+ * @param string $value Field value.
+ *
* @return array
*/
public function parse_tags_field( $value ) {
@@ -403,6 +418,7 @@ public function parse_tags_field( $value ) {
return array();
}
+ $value = $this->unescape_data( $value );
$names = $this->explode_values( $value );
$tags = array();
@@ -424,7 +440,8 @@ public function parse_tags_field( $value ) {
/**
* Parse a shipping class field from a CSV.
*
- * @param string $value Field value.
+ * @param string $value Field value.
+ *
* @return int
*/
public function parse_shipping_class_field( $value ) {
@@ -448,7 +465,8 @@ public function parse_shipping_class_field( $value ) {
/**
* Parse images list from a CSV. Images can be filenames or URLs.
*
- * @param string $value Field value.
+ * @param string $value Field value.
+ *
* @return array
*/
public function parse_images_field( $value ) {
@@ -473,7 +491,8 @@ public function parse_images_field( $value ) {
* Parse dates from a CSV.
* Dates requires the format YYYY-MM-DD and time is optional.
*
- * @param string $value Field value.
+ * @param string $value Field value.
+ *
* @return string|null
*/
public function parse_date_field( $value ) {
@@ -492,7 +511,8 @@ public function parse_date_field( $value ) {
/**
* Parse backorders from a CSV.
*
- * @param string $value Field value.
+ * @param string $value Field value.
+ *
* @return string
*/
public function parse_backorders_field( $value ) {
@@ -517,7 +537,8 @@ public function parse_backorders_field( $value ) {
* By default is applied wc_clean() to all not listed fields
* in self::get_formating_callback(), use this method to skip any formating.
*
- * @param string $value Field value.
+ * @param string $value Field value.
+ *
* @return string
*/
public function parse_skip_field( $value ) {
@@ -530,6 +551,7 @@ public function parse_skip_field( $value ) {
* Allow shortcodes if present, othersiwe esc_url the value.
*
* @param string $value Field value.
+ *
* @return string
*/
public function parse_download_file_field( $value ) {
@@ -545,15 +567,32 @@ public function parse_download_file_field( $value ) {
* Parse an int value field
*
* @param int $value field value.
+ *
* @return int
*/
public function parse_int_field( $value ) {
// Remove the ' prepended to fields that start with - if needed.
- $value = $this->unescape_negative_number( $value );
+ $value = $this->unescape_data( $value );
return intval( $value );
}
+ /**
+ * Parse a description value field
+ *
+ * @param string $description field value.
+ *
+ * @return string
+ */
+ public function parse_description_field( $description ) {
+ $parts = explode( "\\\\n", $description );
+ foreach ( $parts as $key => $part ) {
+ $parts[ $key ] = str_replace( '\n', "\n", $part );
+ }
+
+ return implode( '\\\n', $parts );
+ }
+
/**
* Get formatting callback.
*
@@ -573,8 +612,8 @@ protected function get_formating_callback() {
'date_on_sale_from' => array( $this, 'parse_date_field' ),
'date_on_sale_to' => array( $this, 'parse_date_field' ),
'name' => array( $this, 'parse_skip_field' ),
- 'short_description' => array( $this, 'parse_skip_field' ),
- 'description' => array( $this, 'parse_skip_field' ),
+ 'short_description' => array( $this, 'parse_description_field' ),
+ 'description' => array( $this, 'parse_description_field' ),
'manage_stock' => array( $this, 'parse_bool_field' ),
'low_stock_amount' => array( $this, 'parse_stock_quantity_field' ),
'backorders' => array( $this, 'parse_backorders_field' ),
@@ -640,8 +679,9 @@ protected function get_formating_callback() {
/**
* Check if strings starts with determined word.
*
- * @param string $haystack Complete sentence.
- * @param string $needle Excerpt.
+ * @param string $haystack Complete sentence.
+ * @param string $needle Excerpt.
+ *
* @return bool
*/
protected function starts_with( $haystack, $needle ) {
@@ -651,7 +691,8 @@ protected function starts_with( $haystack, $needle ) {
/**
* Expand special and internal data into the correct formats for the product CRUD.
*
- * @param array $data Data to import.
+ * @param array $data Data to import.
+ *
* @return array
*/
protected function expand_data( $data ) {
@@ -847,7 +888,8 @@ protected function set_parsed_data() {
/**
* Get a string to identify the row from parsed data.
*
- * @param array $parsed_data Parsed data.
+ * @param array $parsed_data Parsed data.
+ *
* @return string
*/
protected function get_row_id( $parsed_data ) {
@@ -895,7 +937,7 @@ public function import() {
do_action( 'woocommerce_product_import_before_import', $parsed_data );
$id = isset( $parsed_data['id'] ) ? absint( $parsed_data['id'] ) : 0;
- $sku = isset( $parsed_data['sku'] ) ? esc_attr( $parsed_data['sku'] ) : '';
+ $sku = isset( $parsed_data['sku'] ) ? $parsed_data['sku'] : '';
$id_exists = false;
$sku_exists = false;
@@ -911,27 +953,39 @@ public function import() {
}
if ( $id_exists && ! $update_existing ) {
- $data['skipped'][] = new WP_Error( 'woocommerce_product_importer_error', __( 'A product with this ID already exists.', 'woocommerce' ), array(
- 'id' => $id,
- 'row' => $this->get_row_id( $parsed_data ),
- ) );
+ $data['skipped'][] = new WP_Error(
+ 'woocommerce_product_importer_error',
+ esc_html__( 'A product with this ID already exists.', 'woocommerce' ),
+ array(
+ 'id' => $id,
+ 'row' => $this->get_row_id( $parsed_data ),
+ )
+ );
continue;
}
if ( $sku_exists && ! $update_existing ) {
- $data['skipped'][] = new WP_Error( 'woocommerce_product_importer_error', __( 'A product with this SKU already exists.', 'woocommerce' ), array(
- 'sku' => $sku,
- 'row' => $this->get_row_id( $parsed_data ),
- ) );
+ $data['skipped'][] = new WP_Error(
+ 'woocommerce_product_importer_error',
+ esc_html__( 'A product with this SKU already exists.', 'woocommerce' ),
+ array(
+ 'sku' => esc_attr( $sku ),
+ 'row' => $this->get_row_id( $parsed_data ),
+ )
+ );
continue;
}
if ( $update_existing && ( $id || $sku ) && ! $id_exists && ! $sku_exists ) {
- $data['skipped'][] = new WP_Error( 'woocommerce_product_importer_error', __( 'No matching product exists to update.', 'woocommerce' ), array(
- 'id' => $id,
- 'sku' => $sku,
- 'row' => $this->get_row_id( $parsed_data ),
- ) );
+ $data['skipped'][] = new WP_Error(
+ 'woocommerce_product_importer_error',
+ esc_html__( 'No matching product exists to update.', 'woocommerce' ),
+ array(
+ 'id' => $id,
+ 'sku' => esc_attr( $sku ),
+ 'row' => $this->get_row_id( $parsed_data ),
+ )
+ );
continue;
}
diff --git a/includes/libraries/Emogrifier/CssConcatenator.php b/includes/libraries/Emogrifier/CssConcatenator.php
new file mode 100755
index 0000000000000..3ebd33b95d8c0
--- /dev/null
+++ b/includes/libraries/Emogrifier/CssConcatenator.php
@@ -0,0 +1,154 @@
+append(['body'], 'color: blue;');
+ * $concatenator->append(['body'], 'font-size: 16px;');
+ * $concatenator->append(['p'], 'margin: 1em 0;');
+ * $concatenator->append(['ul', 'ol'], 'margin: 1em 0;');
+ * $concatenator->append(['body'], 'font-size: 14px;', '@media screen and (max-width: 400px)');
+ * $concatenator->append(['ul', 'ol'], 'margin: 0.75em 0;', '@media screen and (max-width: 400px)');
+ * $css = $concatenator->getCss();
+ *
+ * `$css` (if unminified) would contain the following CSS:
+ * ` body {
+ * ` color: blue;
+ * ` font-size: 16px;
+ * ` }
+ * ` p, ul, ol {
+ * ` margin: 1em 0;
+ * ` }
+ * ` @media screen and (max-width: 400px) {
+ * ` body {
+ * ` font-size: 14px;
+ * ` }
+ * ` ul, ol {
+ * ` margin: 0.75em 0;
+ * ` }
+ * ` }
+ *
+ * @author Jake Hotson
+ */
+class CssConcatenator
+{
+ /**
+ * Array of media rules in order. Each element is an object with the following properties:
+ * - string `media` - The media query string, e.g. "@media screen and (max-width:639px)", or an empty string for
+ * rules not within a media query block;
+ * - \stdClass[] `ruleBlocks` - Array of rule blocks in order, where each element is an object with the following
+ * properties:
+ * - mixed[] `selectorsAsKeys` - Array whose keys are selectors for the rule block (values are of no
+ * significance);
+ * - string `declarationsBlock` - The property declarations, e.g. "margin-top: 0.5em; padding: 0".
+ *
+ * @var \stdClass[]
+ */
+ private $mediaRules = [];
+
+ /**
+ * Appends a declaration block to the CSS.
+ *
+ * @param string[] $selectors Array of selectors for the rule, e.g. ["ul", "ol", "p:first-child"].
+ * @param string $declarationsBlock The property declarations, e.g. "margin-top: 0.5em; padding: 0".
+ * @param string $media The media query for the rule, e.g. "@media screen and (max-width:639px)",
+ * or an empty string if none.
+ */
+ public function append(array $selectors, $declarationsBlock, $media = '')
+ {
+ $selectorsAsKeys = \array_flip($selectors);
+
+ $mediaRule = $this->getOrCreateMediaRuleToAppendTo($media);
+ $lastRuleBlock = \end($mediaRule->ruleBlocks);
+
+ $hasSameDeclarationsAsLastRule = $lastRuleBlock !== false
+ && $declarationsBlock === $lastRuleBlock->declarationsBlock;
+ if ($hasSameDeclarationsAsLastRule) {
+ $lastRuleBlock->selectorsAsKeys += $selectorsAsKeys;
+ } else {
+ $hasSameSelectorsAsLastRule = $lastRuleBlock !== false
+ && static::hasEquivalentSelectors($selectorsAsKeys, $lastRuleBlock->selectorsAsKeys);
+ if ($hasSameSelectorsAsLastRule) {
+ $lastDeclarationsBlockWithoutSemicolon = \rtrim(\rtrim($lastRuleBlock->declarationsBlock), ';');
+ $lastRuleBlock->declarationsBlock = $lastDeclarationsBlockWithoutSemicolon . ';' . $declarationsBlock;
+ } else {
+ $mediaRule->ruleBlocks[] = (object)\compact('selectorsAsKeys', 'declarationsBlock');
+ }
+ }
+ }
+
+ /**
+ * @return string
+ */
+ public function getCss()
+ {
+ return \implode('', \array_map([$this, 'getMediaRuleCss'], $this->mediaRules));
+ }
+
+ /**
+ * @param string $media The media query for rules to be appended, e.g. "@media screen and (max-width:639px)",
+ * or an empty string if none.
+ *
+ * @return \stdClass Object with properties as described for elements of `$mediaRules`.
+ */
+ private function getOrCreateMediaRuleToAppendTo($media)
+ {
+ $lastMediaRule = \end($this->mediaRules);
+ if ($lastMediaRule !== false && $media === $lastMediaRule->media) {
+ return $lastMediaRule;
+ }
+
+ $newMediaRule = (object)[
+ 'media' => $media,
+ 'ruleBlocks' => [],
+ ];
+ $this->mediaRules[] = $newMediaRule;
+ return $newMediaRule;
+ }
+
+ /**
+ * Tests if two sets of selectors are equivalent (i.e. the same selectors, possibly in a different order).
+ *
+ * @param mixed[] $selectorsAsKeys1 Array in which the selectors are the keys, and the values are of no
+ * significance.
+ * @param mixed[] $selectorsAsKeys2 Another such array.
+ *
+ * @return bool
+ */
+ private static function hasEquivalentSelectors(array $selectorsAsKeys1, array $selectorsAsKeys2)
+ {
+ return \count($selectorsAsKeys1) === \count($selectorsAsKeys2)
+ && \count($selectorsAsKeys1) === \count($selectorsAsKeys1 + $selectorsAsKeys2);
+ }
+
+ /**
+ * @param \stdClass $mediaRule Object with properties as described for elements of `$mediaRules`.
+ *
+ * @return string CSS for the media rule.
+ */
+ private static function getMediaRuleCss(\stdClass $mediaRule)
+ {
+ $css = \implode('', \array_map([static::class, 'getRuleBlockCss'], $mediaRule->ruleBlocks));
+ if ($mediaRule->media !== '') {
+ $css = $mediaRule->media . '{' . $css . '}';
+ }
+ return $css;
+ }
+
+ /**
+ * @param \stdClass $ruleBlock Object with properties as described for elements of the `ruleBlocks` property of
+ * elements of `$mediaRules`.
+ *
+ * @return string CSS for the rule block.
+ */
+ private static function getRuleBlockCss(\stdClass $ruleBlock)
+ {
+ $selectors = \array_keys($ruleBlock->selectorsAsKeys);
+ return \implode(',', $selectors) . '{' . $ruleBlock->declarationsBlock . '}';
+ }
+}
diff --git a/includes/libraries/Emogrifier/CssInliner.php b/includes/libraries/Emogrifier/CssInliner.php
new file mode 100755
index 0000000000000..847767ea41431
--- /dev/null
+++ b/includes/libraries/Emogrifier/CssInliner.php
@@ -0,0 +1,1346 @@
+
+ * @author Roman Ožana
+ * @author Sander Kruger
+ * @author Zoli Szabó
+ */
+class CssInliner
+{
+ /**
+ * @var int
+ */
+ const CACHE_KEY_CSS = 0;
+
+ /**
+ * @var int
+ */
+ const CACHE_KEY_SELECTOR = 1;
+
+ /**
+ * @var int
+ */
+ const CACHE_KEY_CSS_DECLARATIONS_BLOCK = 2;
+
+ /**
+ * @var int
+ */
+ const CACHE_KEY_COMBINED_STYLES = 3;
+
+ /**
+ * Regular expression component matching a static pseudo class in a selector, without the preceding ":",
+ * for which the applicable elements can be determined (by converting the selector to an XPath expression).
+ * (Contains alternation without a group and is intended to be placed within a capturing, non-capturing or lookahead
+ * group, as appropriate for the usage context.)
+ *
+ * @var string
+ */
+ const PSEUDO_CLASS_MATCHER = '\\S+\\-(?:child|type\\()|not\\([[:ascii:]]*\\)';
+
+ /**
+ * @var string
+ */
+ const CONTENT_TYPE_META_TAG = '';
+
+ /**
+ * @var string
+ */
+ const DEFAULT_DOCUMENT_TYPE = '';
+
+ /**
+ * @var \DOMDocument
+ */
+ protected $domDocument = null;
+
+ /**
+ * @var string
+ */
+ private $css = '';
+
+ /**
+ * @var bool[]
+ */
+ private $excludedSelectors = [];
+
+ /**
+ * @var string[]
+ */
+ private $unprocessableHtmlTags = ['wbr'];
+
+ /**
+ * @var bool[]
+ */
+ private $allowedMediaTypes = ['all' => true, 'screen' => true, 'print' => true];
+
+ /**
+ * @var mixed[]
+ */
+ private $caches = [
+ self::CACHE_KEY_CSS => [],
+ self::CACHE_KEY_SELECTOR => [],
+ self::CACHE_KEY_CSS_DECLARATIONS_BLOCK => [],
+ self::CACHE_KEY_COMBINED_STYLES => [],
+ ];
+
+ /**
+ * @var CssSelectorConverter
+ */
+ private $cssSelectorConverter = null;
+
+ /**
+ * the visited nodes with the XPath paths as array keys
+ *
+ * @var \DOMElement[]
+ */
+ private $visitedNodes = [];
+
+ /**
+ * the styles to apply to the nodes with the XPath paths as array keys for the outer array
+ * and the attribute names/values as key/value pairs for the inner array
+ *
+ * @var string[][]
+ */
+ private $styleAttributesForNodes = [];
+
+ /**
+ * Determines whether the "style" attributes of tags in the the HTML passed to this class should be preserved.
+ * If set to false, the value of the style attributes will be discarded.
+ *
+ * @var bool
+ */
+ private $isInlineStyleAttributesParsingEnabled = true;
+
+ /**
+ * Determines whether the
',
+ $html
+ );
+ } else {
+ $reworkedHtml = static::CONTENT_TYPE_META_TAG . $html;
+ }
+
+ return $reworkedHtml;
+ }
+
+ /**
+ * @param string[] $a
+ * @param string[] $b
+ *
+ * @return int
+ */
+ private function sortBySelectorPrecedence(array $a, array $b)
+ {
+ $precedenceA = $this->getCssSelectorPrecedence($a['selector']);
+ $precedenceB = $this->getCssSelectorPrecedence($b['selector']);
+
+ // We want these sorted in ascending order so selectors with lesser precedence get processed first and
+ // selectors with greater precedence get sorted last.
+ $precedenceForEquals = ($a['line'] < $b['line'] ? -1 : 1);
+ $precedenceForNotEquals = ($precedenceA < $precedenceB ? -1 : 1);
+ return ($precedenceA === $precedenceB) ? $precedenceForEquals : $precedenceForNotEquals;
+ }
+
+ /**
+ * @param string $selector
+ *
+ * @return int
+ */
+ private function getCssSelectorPrecedence($selector)
+ {
+ $selectorKey = \md5($selector);
+ if (!isset($this->caches[static::CACHE_KEY_SELECTOR][$selectorKey])) {
+ $precedence = 0;
+ foreach ($this->selectorPrecedenceMatchers as $matcher => $value) {
+ if (\trim($selector) === '') {
+ break;
+ }
+ $number = 0;
+ $selector = \preg_replace('/' . $matcher . '\\w+/', '', $selector, -1, $number);
+ $precedence += ($value * $number);
+ }
+ $this->caches[static::CACHE_KEY_SELECTOR][$selectorKey] = $precedence;
+ }
+
+ return $this->caches[static::CACHE_KEY_SELECTOR][$selectorKey];
+ }
+
+ /**
+ * Parses a CSS declaration block into property name/value pairs.
+ *
+ * Example:
+ *
+ * The declaration block
+ *
+ * "color: #000; font-weight: bold;"
+ *
+ * will be parsed into the following array:
+ *
+ * "color" => "#000"
+ * "font-weight" => "bold"
+ *
+ * @param string $cssDeclarationsBlock the CSS declarations block without the curly braces, may be empty
+ *
+ * @return string[]
+ * the CSS declarations with the property names as array keys and the property values as array values
+ */
+ private function parseCssDeclarationsBlock($cssDeclarationsBlock)
+ {
+ if (isset($this->caches[static::CACHE_KEY_CSS_DECLARATIONS_BLOCK][$cssDeclarationsBlock])) {
+ return $this->caches[static::CACHE_KEY_CSS_DECLARATIONS_BLOCK][$cssDeclarationsBlock];
+ }
+
+ $properties = [];
+ $declarations = \preg_split('/;(?!base64|charset)/', $cssDeclarationsBlock);
+
+ foreach ($declarations as $declaration) {
+ $matches = [];
+ if (!\preg_match('/^([A-Za-z\\-]+)\\s*:\\s*(.+)$/s', \trim($declaration), $matches)) {
+ continue;
+ }
+
+ $propertyName = \strtolower($matches[1]);
+ $propertyValue = $matches[2];
+ $properties[$propertyName] = $propertyValue;
+ }
+ $this->caches[static::CACHE_KEY_CSS_DECLARATIONS_BLOCK][$cssDeclarationsBlock] = $properties;
+
+ return $properties;
+ }
+
+ /**
+ * Find the nodes that are not to be emogrified.
+ *
+ * @param \DOMXPath $xPath
+ *
+ * @return \DOMElement[]
+ *
+ * @throws SyntaxErrorException
+ */
+ private function getNodesToExclude(\DOMXPath $xPath)
+ {
+ $excludedNodes = [];
+ foreach (\array_keys($this->excludedSelectors) as $selectorToExclude) {
+ try {
+ $matchingNodes = $xPath->query($this->cssSelectorConverter->toXPath($selectorToExclude));
+ } catch (SyntaxErrorException $e) {
+ if ($this->debug) {
+ throw $e;
+ }
+ continue;
+ }
+ foreach ($matchingNodes as $node) {
+ $excludedNodes[] = $node;
+ }
+ }
+
+ return $excludedNodes;
+ }
+
+ /**
+ * Sets the debug mode.
+ *
+ * @param bool $debug set to true to enable debug mode
+ *
+ * @return void
+ */
+ public function setDebug($debug)
+ {
+ $this->debug = $debug;
+ }
+}
diff --git a/includes/libraries/Emogrifier/HtmlProcessor/AbstractHtmlProcessor.php b/includes/libraries/Emogrifier/HtmlProcessor/AbstractHtmlProcessor.php
new file mode 100755
index 0000000000000..c5a25eefa6bad
--- /dev/null
+++ b/includes/libraries/Emogrifier/HtmlProcessor/AbstractHtmlProcessor.php
@@ -0,0 +1,221 @@
+
+ */
+abstract class AbstractHtmlProcessor
+{
+ /**
+ * @var string
+ */
+ const DEFAULT_DOCUMENT_TYPE = '';
+
+ /**
+ * @var string
+ */
+ const CONTENT_TYPE_META_TAG = '';
+
+ /**
+ * @var \DOMDocument
+ */
+ protected $domDocument = null;
+
+ /**
+ * @param string $unprocessedHtml raw HTML, must be UTF-encoded, must not be empty
+ *
+ * @throws \InvalidArgumentException if $unprocessedHtml is anything other than a non-empty string
+ */
+ public function __construct($unprocessedHtml)
+ {
+ if (!\is_string($unprocessedHtml)) {
+ throw new \InvalidArgumentException('The provided HTML must be a string.', 1515459744);
+ }
+ if ($unprocessedHtml === '') {
+ throw new \InvalidArgumentException('The provided HTML must not be empty.', 1515763647);
+ }
+
+ $this->setHtml($unprocessedHtml);
+ }
+
+ /**
+ * Sets the HTML to process.
+ *
+ * @param string $html the HTML to process, must be UTF-8-encoded
+ *
+ * @return void
+ */
+ private function setHtml($html)
+ {
+ $this->createUnifiedDomDocument($html);
+ }
+
+ /**
+ * Provides access to the internal DOMDocument representation of the HTML in its current state.
+ *
+ * @return \DOMDocument
+ */
+ public function getDomDocument()
+ {
+ return $this->domDocument;
+ }
+
+ /**
+ * Renders the normalized and processed HTML.
+ *
+ * @return string
+ */
+ public function render()
+ {
+ return $this->domDocument->saveHTML();
+ }
+
+ /**
+ * Renders the content of the BODY element of the normalized and processed HTML.
+ *
+ * @return string
+ */
+ public function renderBodyContent()
+ {
+ $bodyNodeHtml = $this->domDocument->saveHTML($this->getBodyElement());
+
+ return \str_replace(['', ''], '', $bodyNodeHtml);
+ }
+
+ /**
+ * Returns the BODY element.
+ *
+ * This method assumes that there always is a BODY element.
+ *
+ * @return \DOMElement
+ */
+ private function getBodyElement()
+ {
+ return $this->domDocument->getElementsByTagName('body')->item(0);
+ }
+
+ /**
+ * Creates a DOM document from the given HTML and stores it in $this->domDocument.
+ *
+ * The DOM document will always have a BODY element and a document type.
+ *
+ * @param string $html
+ *
+ * @return void
+ */
+ private function createUnifiedDomDocument($html)
+ {
+ $this->createRawDomDocument($html);
+ $this->ensureExistenceOfBodyElement();
+ }
+
+ /**
+ * Creates a DOMDocument instance from the given HTML and stores it in $this->domDocument.
+ *
+ * @param string $html
+ *
+ * @return void
+ */
+ private function createRawDomDocument($html)
+ {
+ $domDocument = new \DOMDocument();
+ $domDocument->strictErrorChecking = false;
+ $domDocument->formatOutput = true;
+ $libXmlState = \libxml_use_internal_errors(true);
+ $domDocument->loadHTML($this->prepareHtmlForDomConversion($html));
+ \libxml_clear_errors();
+ \libxml_use_internal_errors($libXmlState);
+
+ $this->domDocument = $domDocument;
+ }
+
+ /**
+ * Returns the HTML with added document type and Content-Type meta tag if needed,
+ * ensuring that the HTML will be good for creating a DOM document from it.
+ *
+ * @param string $html
+ *
+ * @return string the unified HTML
+ */
+ private function prepareHtmlForDomConversion($html)
+ {
+ $htmlWithDocumentType = $this->ensureDocumentType($html);
+
+ return $this->addContentTypeMetaTag($htmlWithDocumentType);
+ }
+
+ /**
+ * Makes sure that the passed HTML has a document type.
+ *
+ * @param string $html
+ *
+ * @return string HTML with document type
+ */
+ private function ensureDocumentType($html)
+ {
+ $hasDocumentType = \stripos($html, '/i', '' . static::CONTENT_TYPE_META_TAG, $html);
+ } elseif ($hasHtmlTag) {
+ $reworkedHtml = \preg_replace(
+ '//i',
+ '' . static::CONTENT_TYPE_META_TAG . '
',
+ $html
+ );
+ } else {
+ $reworkedHtml = static::CONTENT_TYPE_META_TAG . $html;
+ }
+
+ return $reworkedHtml;
+ }
+
+ /**
+ * Checks that $this->domDocument has a BODY element and adds it if it is missing.
+ *
+ * @return void
+ */
+ private function ensureExistenceOfBodyElement()
+ {
+ if ($this->domDocument->getElementsByTagName('body')->item(0) !== null) {
+ return;
+ }
+
+ $htmlElement = $this->domDocument->getElementsByTagName('html')->item(0);
+ $htmlElement->appendChild($this->domDocument->createElement('body'));
+ }
+}
diff --git a/includes/libraries/Emogrifier/HtmlProcessor/CssToAttributeConverter.php b/includes/libraries/Emogrifier/HtmlProcessor/CssToAttributeConverter.php
new file mode 100755
index 0000000000000..97a94b1c99c4d
--- /dev/null
+++ b/includes/libraries/Emogrifier/HtmlProcessor/CssToAttributeConverter.php
@@ -0,0 +1,320 @@
+
+ */
+class CssToAttributeConverter extends AbstractHtmlProcessor
+{
+ /**
+ * This multi-level array contains simple mappings of CSS properties to
+ * HTML attributes. If a mapping only applies to certain HTML nodes or
+ * only for certain values, the mapping is an object with a whitelist
+ * of nodes and values.
+ *
+ * @var mixed[][]
+ */
+ private $cssToHtmlMap = [
+ 'background-color' => [
+ 'attribute' => 'bgcolor',
+ ],
+ 'text-align' => [
+ 'attribute' => 'align',
+ 'nodes' => ['p', 'div', 'td'],
+ 'values' => ['left', 'right', 'center', 'justify'],
+ ],
+ 'float' => [
+ 'attribute' => 'align',
+ 'nodes' => ['table', 'img'],
+ 'values' => ['left', 'right'],
+ ],
+ 'border-spacing' => [
+ 'attribute' => 'cellspacing',
+ 'nodes' => ['table'],
+ ],
+ ];
+
+ /**
+ * @var string[][]
+ */
+ private static $parsedCssCache = [];
+
+ /**
+ * Maps the CSS from the style nodes to visual HTML attributes.
+ *
+ * @return CssToAttributeConverter fluent interface
+ */
+ public function convertCssToVisualAttributes()
+ {
+ /** @var \DOMElement $node */
+ foreach ($this->getAllNodesWithStyleAttribute() as $node) {
+ $inlineStyleDeclarations = $this->parseCssDeclarationsBlock($node->getAttribute('style'));
+ $this->mapCssToHtmlAttributes($inlineStyleDeclarations, $node);
+ }
+
+ return $this;
+ }
+
+ /**
+ * Returns a list with all DOM nodes that have a style attribute.
+ *
+ * @return \DOMNodeList
+ */
+ private function getAllNodesWithStyleAttribute()
+ {
+ $xPath = new \DOMXPath($this->domDocument);
+
+ return $xPath->query('//*[@style]');
+ }
+
+ /**
+ * Parses a CSS declaration block into property name/value pairs.
+ *
+ * Example:
+ *
+ * The declaration block
+ *
+ * "color: #000; font-weight: bold;"
+ *
+ * will be parsed into the following array:
+ *
+ * "color" => "#000"
+ * "font-weight" => "bold"
+ *
+ * @param string $cssDeclarationsBlock the CSS declarations block without the curly braces, may be empty
+ *
+ * @return string[]
+ * the CSS declarations with the property names as array keys and the property values as array values
+ */
+ private function parseCssDeclarationsBlock($cssDeclarationsBlock)
+ {
+ if (isset(self::$parsedCssCache[$cssDeclarationsBlock])) {
+ return self::$parsedCssCache[$cssDeclarationsBlock];
+ }
+
+ $properties = [];
+ $declarations = \preg_split('/;(?!base64|charset)/', $cssDeclarationsBlock);
+
+ foreach ($declarations as $declaration) {
+ $matches = [];
+ if (!\preg_match('/^([A-Za-z\\-]+)\\s*:\\s*(.+)$/s', \trim($declaration), $matches)) {
+ continue;
+ }
+
+ $propertyName = \strtolower($matches[1]);
+ $propertyValue = $matches[2];
+ $properties[$propertyName] = $propertyValue;
+ }
+ self::$parsedCssCache[$cssDeclarationsBlock] = $properties;
+
+ return $properties;
+ }
+
+ /**
+ * Applies $styles to $node.
+ *
+ * This method maps CSS styles to HTML attributes and adds those to the
+ * node.
+ *
+ * @param string[] $styles the new CSS styles taken from the global styles to be applied to this node
+ * @param \DOMElement $node node to apply styles to
+ *
+ * @return void
+ */
+ private function mapCssToHtmlAttributes(array $styles, \DOMElement $node)
+ {
+ foreach ($styles as $property => $value) {
+ // Strip !important indicator
+ $value = \trim(\str_replace('!important', '', $value));
+ $this->mapCssToHtmlAttribute($property, $value, $node);
+ }
+ }
+
+ /**
+ * Tries to apply the CSS style to $node as an attribute.
+ *
+ * This method maps a CSS rule to HTML attributes and adds those to the node.
+ *
+ * @param string $property the name of the CSS property to map
+ * @param string $value the value of the style rule to map
+ * @param \DOMElement $node node to apply styles to
+ *
+ * @return void
+ */
+ private function mapCssToHtmlAttribute($property, $value, \DOMElement $node)
+ {
+ if (!$this->mapSimpleCssProperty($property, $value, $node)) {
+ $this->mapComplexCssProperty($property, $value, $node);
+ }
+ }
+
+ /**
+ * Looks up the CSS property in the mapping table and maps it if it matches the conditions.
+ *
+ * @param string $property the name of the CSS property to map
+ * @param string $value the value of the style rule to map
+ * @param \DOMElement $node node to apply styles to
+ *
+ * @return bool true if the property can be mapped using the simple mapping table
+ */
+ private function mapSimpleCssProperty($property, $value, \DOMElement $node)
+ {
+ if (!isset($this->cssToHtmlMap[$property])) {
+ return false;
+ }
+
+ $mapping = $this->cssToHtmlMap[$property];
+ $nodesMatch = !isset($mapping['nodes']) || \in_array($node->nodeName, $mapping['nodes'], true);
+ $valuesMatch = !isset($mapping['values']) || \in_array($value, $mapping['values'], true);
+ if (!$nodesMatch || !$valuesMatch) {
+ return false;
+ }
+
+ $node->setAttribute($mapping['attribute'], $value);
+
+ return true;
+ }
+
+ /**
+ * Maps CSS properties that need special transformation to an HTML attribute.
+ *
+ * @param string $property the name of the CSS property to map
+ * @param string $value the value of the style rule to map
+ * @param \DOMElement $node node to apply styles to
+ *
+ * @return void
+ */
+ private function mapComplexCssProperty($property, $value, \DOMElement $node)
+ {
+ switch ($property) {
+ case 'background':
+ $this->mapBackgroundProperty($node, $value);
+ break;
+ case 'width':
+ // intentional fall-through
+ case 'height':
+ $this->mapWidthOrHeightProperty($node, $value, $property);
+ break;
+ case 'margin':
+ $this->mapMarginProperty($node, $value);
+ break;
+ case 'border':
+ $this->mapBorderProperty($node, $value);
+ break;
+ default:
+ }
+ }
+
+ /**
+ * @param \DOMElement $node node to apply styles to
+ * @param string $value the value of the style rule to map
+ *
+ * @return void
+ */
+ private function mapBackgroundProperty(\DOMElement $node, $value)
+ {
+ // parse out the color, if any
+ $styles = \explode(' ', $value);
+ $first = $styles[0];
+ if (!\is_numeric($first[0]) && \strpos($first, 'url') !== 0) {
+ // as this is not a position or image, assume it's a color
+ $node->setAttribute('bgcolor', $first);
+ }
+ }
+
+ /**
+ * @param \DOMElement $node node to apply styles to
+ * @param string $value the value of the style rule to map
+ * @param string $property the name of the CSS property to map
+ *
+ * @return void
+ */
+ private function mapWidthOrHeightProperty(\DOMElement $node, $value, $property)
+ {
+ // only parse values in px and %, but not values like "auto"
+ if (!\preg_match('/^(\\d+)(px|%)$/', $value)) {
+ return;
+ }
+
+ $number = \preg_replace('/[^0-9.%]/', '', $value);
+ $node->setAttribute($property, $number);
+ }
+
+ /**
+ * @param \DOMElement $node node to apply styles to
+ * @param string $value the value of the style rule to map
+ *
+ * @return void
+ */
+ private function mapMarginProperty(\DOMElement $node, $value)
+ {
+ if (!$this->isTableOrImageNode($node)) {
+ return;
+ }
+
+ $margins = $this->parseCssShorthandValue($value);
+ if ($margins['left'] === 'auto' && $margins['right'] === 'auto') {
+ $node->setAttribute('align', 'center');
+ }
+ }
+
+ /**
+ * @param \DOMElement $node node to apply styles to
+ * @param string $value the value of the style rule to map
+ *
+ * @return void
+ */
+ private function mapBorderProperty(\DOMElement $node, $value)
+ {
+ if (!$this->isTableOrImageNode($node)) {
+ return;
+ }
+
+ if ($value === 'none' || $value === '0') {
+ $node->setAttribute('border', '0');
+ }
+ }
+
+ /**
+ * @param \DOMElement $node
+ *
+ * @return bool
+ */
+ private function isTableOrImageNode(\DOMElement $node)
+ {
+ return $node->nodeName === 'table' || $node->nodeName === 'img';
+ }
+
+ /**
+ * Parses a shorthand CSS value and splits it into individual values
+ *
+ * @param string $value a string of CSS value with 1, 2, 3 or 4 sizes
+ * For example: padding: 0 auto;
+ * '0 auto' is split into top: 0, left: auto, bottom: 0,
+ * right: auto.
+ *
+ * @return string[] an array of values for top, right, bottom and left (using these as associative array keys)
+ */
+ private function parseCssShorthandValue($value)
+ {
+ $values = \preg_split('/\\s+/', $value);
+
+ $css = [];
+ $css['top'] = $values[0];
+ $css['right'] = (\count($values) > 1) ? $values[1] : $css['top'];
+ $css['bottom'] = (\count($values) > 2) ? $values[2] : $css['top'];
+ $css['left'] = (\count($values) > 3) ? $values[3] : $css['right'];
+
+ return $css;
+ }
+}
diff --git a/includes/libraries/Emogrifier/HtmlProcessor/HtmlNormalizer.php b/includes/libraries/Emogrifier/HtmlProcessor/HtmlNormalizer.php
new file mode 100755
index 0000000000000..ad3abff378dbd
--- /dev/null
+++ b/includes/libraries/Emogrifier/HtmlProcessor/HtmlNormalizer.php
@@ -0,0 +1,18 @@
+
+ */
+class HtmlNormalizer extends AbstractHtmlProcessor
+{
+}
diff --git a/includes/libraries/action-scheduler/classes/ActionScheduler_Logger.php b/includes/libraries/action-scheduler/classes/ActionScheduler_Logger.php
index 30933ce8737cd..aa14205520f03 100644
--- a/includes/libraries/action-scheduler/classes/ActionScheduler_Logger.php
+++ b/includes/libraries/action-scheduler/classes/ActionScheduler_Logger.php
@@ -73,7 +73,7 @@ public function log_completed_action( $action_id ) {
$this->log( $action_id, __( 'action complete', 'action-scheduler' ) );
}
- public function log_failed_action( $action_id, \Exception $exception ) {
+ public function log_failed_action( $action_id, Exception $exception ) {
$this->log( $action_id, sprintf( __( 'action failed: %s', 'action-scheduler' ), $exception->getMessage() ) );
}
@@ -95,4 +95,4 @@ public function log_ignored_action( $action_id ) {
$this->log( $action_id, __( 'action ignored', 'action-scheduler' ) );
}
}
-
\ No newline at end of file
+
diff --git a/includes/libraries/action-scheduler/classes/ActionScheduler_wpPostStore.php b/includes/libraries/action-scheduler/classes/ActionScheduler_wpPostStore.php
index efddb68651d18..b91e3d19e0f1d 100644
--- a/includes/libraries/action-scheduler/classes/ActionScheduler_wpPostStore.php
+++ b/includes/libraries/action-scheduler/classes/ActionScheduler_wpPostStore.php
@@ -685,7 +685,7 @@ public function get_status( $action_id ) {
$status = $this->get_post_column( $action_id, 'post_status' );
if ( $status === null ) {
- throw new \InvalidArgumentException( __( 'Invalid action ID. No status found.', 'action-scheduler' ) );
+ throw new InvalidArgumentException( __( 'Invalid action ID. No status found.', 'action-scheduler' ) );
}
return $this->get_action_status_by_post_status( $status );
diff --git a/includes/libraries/action-scheduler/composer.json b/includes/libraries/action-scheduler/composer.json
index 4df2c2d0e67fb..b3ff1fe7ab730 100644
--- a/includes/libraries/action-scheduler/composer.json
+++ b/includes/libraries/action-scheduler/composer.json
@@ -6,6 +6,6 @@
"minimum-stability": "dev",
"require": {},
"require-dev": {
- "wp-cli/wp-cli": "^1.3"
+ "wp-cli/wp-cli": "2.1.0"
}
}
diff --git a/includes/libraries/action-scheduler/composer.lock b/includes/libraries/action-scheduler/composer.lock
index de44d8153ec68..6f4b53581f877 100644
--- a/includes/libraries/action-scheduler/composer.lock
+++ b/includes/libraries/action-scheduler/composer.lock
@@ -1,10 +1,10 @@
{
"_readme": [
"This file locks the dependencies of your project to a known state",
- "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file",
+ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
"This file is @generated automatically"
],
- "content-hash": "f4556531e7b95173d1b769b3d7350926",
+ "content-hash": "2a94d15afcb17b214630daa2d90e97fa",
"packages": [],
"packages-dev": [
{
@@ -13,12 +13,12 @@
"source": {
"type": "git",
"url": "https://github.com/composer/ca-bundle.git",
- "reference": "b17e6153cb7f33c7e44eb59578dc12eee5dc8e12"
+ "reference": "45501c64f5d1b6a9c53c9a9def19e141bcbf2260"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/composer/ca-bundle/zipball/b17e6153cb7f33c7e44eb59578dc12eee5dc8e12",
- "reference": "b17e6153cb7f33c7e44eb59578dc12eee5dc8e12",
+ "url": "https://api.github.com/repos/composer/ca-bundle/zipball/45501c64f5d1b6a9c53c9a9def19e141bcbf2260",
+ "reference": "45501c64f5d1b6a9c53c9a9def19e141bcbf2260",
"shasum": ""
},
"require": {
@@ -27,12 +27,9 @@
"php": "^5.3.2 || ^7.0"
},
"require-dev": {
- "phpunit/phpunit": "^4.5",
+ "phpunit/phpunit": "^4.8.35 || ^5.7 || ^6.5",
"psr/log": "^1.0",
- "symfony/process": "^2.5 || ^3.0"
- },
- "suggest": {
- "symfony/process": "This is necessary to reliably check whether openssl_x509_parse is vulnerable on older php versions, but can be ignored on PHP 5.5.6+"
+ "symfony/process": "^2.5 || ^3.0 || ^4.0"
},
"type": "library",
"extra": {
@@ -64,7 +61,7 @@
"ssl",
"tls"
],
- "time": "2017-03-06T11:59:08+00:00"
+ "time": "2018-10-31T14:14:03+00:00"
},
{
"name": "composer/composer",
@@ -149,12 +146,12 @@
"source": {
"type": "git",
"url": "https://github.com/composer/semver.git",
- "reference": "7ea669582e6396857cf6d1c0a6cd2728f4e7e383"
+ "reference": "2b303e43d14d15cc90c8e8db4a1cdb6259f1a5c5"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/composer/semver/zipball/7ea669582e6396857cf6d1c0a6cd2728f4e7e383",
- "reference": "7ea669582e6396857cf6d1c0a6cd2728f4e7e383",
+ "url": "https://api.github.com/repos/composer/semver/zipball/2b303e43d14d15cc90c8e8db4a1cdb6259f1a5c5",
+ "reference": "2b303e43d14d15cc90c8e8db4a1cdb6259f1a5c5",
"shasum": ""
},
"require": {
@@ -203,7 +200,7 @@
"validation",
"versioning"
],
- "time": "2017-05-15T12:49:06+00:00"
+ "time": "2017-11-06T09:05:54+00:00"
},
{
"name": "composer/spdx-licenses",
@@ -211,19 +208,19 @@
"source": {
"type": "git",
"url": "https://github.com/composer/spdx-licenses.git",
- "reference": "2603a0d7ddc00a015deb576fa5297ca43dee6b1c"
+ "reference": "5781a46078ca46330d05f46f90c42eaacba85749"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/composer/spdx-licenses/zipball/2603a0d7ddc00a015deb576fa5297ca43dee6b1c",
- "reference": "2603a0d7ddc00a015deb576fa5297ca43dee6b1c",
+ "url": "https://api.github.com/repos/composer/spdx-licenses/zipball/5781a46078ca46330d05f46f90c42eaacba85749",
+ "reference": "5781a46078ca46330d05f46f90c42eaacba85749",
"shasum": ""
},
"require": {
"php": "^5.3.2 || ^7.0"
},
"require-dev": {
- "phpunit/phpunit": "^4.5 || ^5.0.5",
+ "phpunit/phpunit": "^4.8.35 || ^5.7 || ^6.5",
"phpunit/phpunit-mock-objects": "2.3.0 || ^3.0"
},
"type": "library",
@@ -264,7 +261,7 @@
"spdx",
"validator"
],
- "time": "2017-04-03T19:08:52+00:00"
+ "time": "2018-12-26T21:53:59+00:00"
},
{
"name": "justinrainbow/json-schema",
@@ -272,12 +269,12 @@
"source": {
"type": "git",
"url": "https://github.com/justinrainbow/json-schema.git",
- "reference": "36ed4d935f8f5eb958dbd29e1fa5a241ec3ece4d"
+ "reference": "8560d4314577199ba51bf2032f02cd1315587c23"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/justinrainbow/json-schema/zipball/36ed4d935f8f5eb958dbd29e1fa5a241ec3ece4d",
- "reference": "36ed4d935f8f5eb958dbd29e1fa5a241ec3ece4d",
+ "url": "https://api.github.com/repos/justinrainbow/json-schema/zipball/8560d4314577199ba51bf2032f02cd1315587c23",
+ "reference": "8560d4314577199ba51bf2032f02cd1315587c23",
"shasum": ""
},
"require": {
@@ -286,7 +283,7 @@
"require-dev": {
"friendsofphp/php-cs-fixer": "^2.1",
"json-schema/json-schema-test-suite": "1.2.0",
- "phpunit/phpunit": "^4.8.22"
+ "phpunit/phpunit": "^4.8.35"
},
"bin": [
"bin/validate-json"
@@ -330,7 +327,7 @@
"json",
"schema"
],
- "time": "2017-06-23T11:43:36+00:00"
+ "time": "2018-02-14T22:26:30+00:00"
},
{
"name": "mustache/mustache",
@@ -425,12 +422,12 @@
"source": {
"type": "git",
"url": "https://github.com/php-fig/container.git",
- "reference": "2cc4a01788191489dc7459446ba832fa79a216a7"
+ "reference": "014d250daebff39eba15ba990eeb2a140798e77c"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/php-fig/container/zipball/2cc4a01788191489dc7459446ba832fa79a216a7",
- "reference": "2cc4a01788191489dc7459446ba832fa79a216a7",
+ "url": "https://api.github.com/repos/php-fig/container/zipball/014d250daebff39eba15ba990eeb2a140798e77c",
+ "reference": "014d250daebff39eba15ba990eeb2a140798e77c",
"shasum": ""
},
"require": {
@@ -466,7 +463,7 @@
"container-interop",
"psr"
],
- "time": "2017-06-28T15:35:32+00:00"
+ "time": "2018-12-29T15:36:03+00:00"
},
{
"name": "psr/log",
@@ -558,6 +555,7 @@
"array_column",
"column"
],
+ "abandoned": true,
"time": "2015-03-20T22:07:39+00:00"
},
{
@@ -756,17 +754,18 @@
"source": {
"type": "git",
"url": "https://github.com/symfony/config.git",
- "reference": "d668d8c0502d2b485c00d107db65fdbc56c26282"
+ "reference": "17c5d8941eb75a03d19bc76a43757738632d87b3"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/symfony/config/zipball/d668d8c0502d2b485c00d107db65fdbc56c26282",
- "reference": "d668d8c0502d2b485c00d107db65fdbc56c26282",
+ "url": "https://api.github.com/repos/symfony/config/zipball/17c5d8941eb75a03d19bc76a43757738632d87b3",
+ "reference": "17c5d8941eb75a03d19bc76a43757738632d87b3",
"shasum": ""
},
"require": {
"php": "^5.5.9|>=7.0.8",
- "symfony/filesystem": "~2.8|~3.0|~4.0"
+ "symfony/filesystem": "~2.8|~3.0|~4.0",
+ "symfony/polyfill-ctype": "~1.8"
},
"conflict": {
"symfony/dependency-injection": "<3.3",
@@ -774,6 +773,7 @@
},
"require-dev": {
"symfony/dependency-injection": "~3.3|~4.0",
+ "symfony/event-dispatcher": "~3.3|~4.0",
"symfony/finder": "~3.3|~4.0",
"symfony/yaml": "~3.0|~4.0"
},
@@ -810,7 +810,7 @@
],
"description": "Symfony Config Component",
"homepage": "https://symfony.com",
- "time": "2017-08-05T17:34:46+00:00"
+ "time": "2019-01-01T13:45:19+00:00"
},
{
"name": "symfony/console",
@@ -818,12 +818,12 @@
"source": {
"type": "git",
"url": "https://github.com/symfony/console.git",
- "reference": "0e283478c2d68c9bf9cc52592ad1ef1834083a85"
+ "reference": "a700b874d3692bc8342199adfb6d3b99f62cc61a"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/symfony/console/zipball/0e283478c2d68c9bf9cc52592ad1ef1834083a85",
- "reference": "0e283478c2d68c9bf9cc52592ad1ef1834083a85",
+ "url": "https://api.github.com/repos/symfony/console/zipball/a700b874d3692bc8342199adfb6d3b99f62cc61a",
+ "reference": "a700b874d3692bc8342199adfb6d3b99f62cc61a",
"shasum": ""
},
"require": {
@@ -832,20 +832,19 @@
"symfony/polyfill-mbstring": "~1.0"
},
"conflict": {
- "symfony/dependency-injection": "<3.3",
+ "symfony/dependency-injection": "<3.4",
"symfony/process": "<3.3"
},
"require-dev": {
"psr/log": "~1.0",
"symfony/config": "~3.3|~4.0",
- "symfony/dependency-injection": "~3.3|~4.0",
+ "symfony/dependency-injection": "~3.4|~4.0",
"symfony/event-dispatcher": "~2.8|~3.0|~4.0",
- "symfony/http-kernel": "~2.8|~3.0|~4.0",
"symfony/lock": "~3.4|~4.0",
"symfony/process": "~3.3|~4.0"
},
"suggest": {
- "psr/log": "For using the console logger",
+ "psr/log-implementation": "For using the console logger",
"symfony/event-dispatcher": "",
"symfony/lock": "",
"symfony/process": ""
@@ -880,7 +879,7 @@
],
"description": "Symfony Console Component",
"homepage": "https://symfony.com",
- "time": "2017-08-10T07:07:17+00:00"
+ "time": "2019-01-04T04:42:43+00:00"
},
{
"name": "symfony/debug",
@@ -888,12 +887,12 @@
"source": {
"type": "git",
"url": "https://github.com/symfony/debug.git",
- "reference": "50bda5b4b8641616d45254c6855bcd45f2f64187"
+ "reference": "26d7f23b9bd0b93bee5583e4d6ca5cb1ab31b186"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/symfony/debug/zipball/50bda5b4b8641616d45254c6855bcd45f2f64187",
- "reference": "50bda5b4b8641616d45254c6855bcd45f2f64187",
+ "url": "https://api.github.com/repos/symfony/debug/zipball/26d7f23b9bd0b93bee5583e4d6ca5cb1ab31b186",
+ "reference": "26d7f23b9bd0b93bee5583e4d6ca5cb1ab31b186",
"shasum": ""
},
"require": {
@@ -936,7 +935,7 @@
],
"description": "Symfony Debug Component",
"homepage": "https://symfony.com",
- "time": "2017-08-10T07:07:17+00:00"
+ "time": "2019-01-01T13:45:19+00:00"
},
{
"name": "symfony/dependency-injection",
@@ -944,12 +943,12 @@
"source": {
"type": "git",
"url": "https://github.com/symfony/dependency-injection.git",
- "reference": "aaee88765cb21a838e8da26d6acda4ca2ae3a2ea"
+ "reference": "928a38b18bd632d67acbca74d0b2eed09915e83e"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/symfony/dependency-injection/zipball/aaee88765cb21a838e8da26d6acda4ca2ae3a2ea",
- "reference": "aaee88765cb21a838e8da26d6acda4ca2ae3a2ea",
+ "url": "https://api.github.com/repos/symfony/dependency-injection/zipball/928a38b18bd632d67acbca74d0b2eed09915e83e",
+ "reference": "928a38b18bd632d67acbca74d0b2eed09915e83e",
"shasum": ""
},
"require": {
@@ -957,7 +956,7 @@
"psr/container": "^1.0"
},
"conflict": {
- "symfony/config": "<3.3.1",
+ "symfony/config": "<3.3.7",
"symfony/finder": "<3.3",
"symfony/proxy-manager-bridge": "<3.4",
"symfony/yaml": "<3.4"
@@ -1007,7 +1006,7 @@
],
"description": "Symfony DependencyInjection Component",
"homepage": "https://symfony.com",
- "time": "2017-08-10T19:43:00+00:00"
+ "time": "2019-01-05T12:26:58+00:00"
},
{
"name": "symfony/event-dispatcher",
@@ -1015,12 +1014,12 @@
"source": {
"type": "git",
"url": "https://github.com/symfony/event-dispatcher.git",
- "reference": "cd8b015f859e6b60933324db00067c2f060b4d18"
+ "reference": "d1cdd46c53c264a2bd42505bd0e8ce21423bd0e2"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/symfony/event-dispatcher/zipball/cd8b015f859e6b60933324db00067c2f060b4d18",
- "reference": "cd8b015f859e6b60933324db00067c2f060b4d18",
+ "url": "https://api.github.com/repos/symfony/event-dispatcher/zipball/d1cdd46c53c264a2bd42505bd0e8ce21423bd0e2",
+ "reference": "d1cdd46c53c264a2bd42505bd0e8ce21423bd0e2",
"shasum": ""
},
"require": {
@@ -1070,7 +1069,7 @@
],
"description": "Symfony EventDispatcher Component",
"homepage": "https://symfony.com",
- "time": "2017-08-03T09:34:20+00:00"
+ "time": "2019-01-01T18:08:36+00:00"
},
{
"name": "symfony/filesystem",
@@ -1078,16 +1077,17 @@
"source": {
"type": "git",
"url": "https://github.com/symfony/filesystem.git",
- "reference": "e4d366b620c8b6e2d4977c154f6a1d5b416db4dd"
+ "reference": "c24ce3d18ccc9bb9d7e1d6ce9330fcc6061cafde"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/symfony/filesystem/zipball/e4d366b620c8b6e2d4977c154f6a1d5b416db4dd",
- "reference": "e4d366b620c8b6e2d4977c154f6a1d5b416db4dd",
+ "url": "https://api.github.com/repos/symfony/filesystem/zipball/c24ce3d18ccc9bb9d7e1d6ce9330fcc6061cafde",
+ "reference": "c24ce3d18ccc9bb9d7e1d6ce9330fcc6061cafde",
"shasum": ""
},
"require": {
- "php": "^5.5.9|>=7.0.8"
+ "php": "^5.5.9|>=7.0.8",
+ "symfony/polyfill-ctype": "~1.8"
},
"type": "library",
"extra": {
@@ -1119,7 +1119,7 @@
],
"description": "Symfony Filesystem Component",
"homepage": "https://symfony.com",
- "time": "2017-08-03T09:34:20+00:00"
+ "time": "2019-01-01T13:45:19+00:00"
},
{
"name": "symfony/finder",
@@ -1127,12 +1127,12 @@
"source": {
"type": "git",
"url": "https://github.com/symfony/finder.git",
- "reference": "bf0450cfe7282c5f06539c4733ba64273e91e918"
+ "reference": "3f2a2ab6315dd7682d4c16dcae1e7b95c8b8555e"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/symfony/finder/zipball/bf0450cfe7282c5f06539c4733ba64273e91e918",
- "reference": "bf0450cfe7282c5f06539c4733ba64273e91e918",
+ "url": "https://api.github.com/repos/symfony/finder/zipball/3f2a2ab6315dd7682d4c16dcae1e7b95c8b8555e",
+ "reference": "3f2a2ab6315dd7682d4c16dcae1e7b95c8b8555e",
"shasum": ""
},
"require": {
@@ -1168,7 +1168,65 @@
],
"description": "Symfony Finder Component",
"homepage": "https://symfony.com",
- "time": "2017-08-03T09:34:20+00:00"
+ "time": "2019-01-01T13:45:19+00:00"
+ },
+ {
+ "name": "symfony/polyfill-ctype",
+ "version": "v1.10.0",
+ "source": {
+ "type": "git",
+ "url": "https://github.com/symfony/polyfill-ctype.git",
+ "reference": "e3d826245268269cd66f8326bd8bc066687b4a19"
+ },
+ "dist": {
+ "type": "zip",
+ "url": "https://api.github.com/repos/symfony/polyfill-ctype/zipball/e3d826245268269cd66f8326bd8bc066687b4a19",
+ "reference": "e3d826245268269cd66f8326bd8bc066687b4a19",
+ "shasum": ""
+ },
+ "require": {
+ "php": ">=5.3.3"
+ },
+ "suggest": {
+ "ext-ctype": "For best performance"
+ },
+ "type": "library",
+ "extra": {
+ "branch-alias": {
+ "dev-master": "1.9-dev"
+ }
+ },
+ "autoload": {
+ "psr-4": {
+ "Symfony\\Polyfill\\Ctype\\": ""
+ },
+ "files": [
+ "bootstrap.php"
+ ]
+ },
+ "notification-url": "https://packagist.org/downloads/",
+ "license": [
+ "MIT"
+ ],
+ "authors": [
+ {
+ "name": "Symfony Community",
+ "homepage": "https://symfony.com/contributors"
+ },
+ {
+ "name": "Gert de Pagter",
+ "email": "BackEndTea@gmail.com"
+ }
+ ],
+ "description": "Symfony polyfill for ctype functions",
+ "homepage": "https://symfony.com",
+ "keywords": [
+ "compatibility",
+ "ctype",
+ "polyfill",
+ "portable"
+ ],
+ "time": "2018-08-06T14:22:27+00:00"
},
{
"name": "symfony/polyfill-mbstring",
@@ -1235,12 +1293,12 @@
"source": {
"type": "git",
"url": "https://github.com/symfony/process.git",
- "reference": "9794f948d9af3be0157185051275d78b24d68b92"
+ "reference": "0d41dd7d95ed179aed6a13393b0f4f97bfa2d25c"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/symfony/process/zipball/9794f948d9af3be0157185051275d78b24d68b92",
- "reference": "9794f948d9af3be0157185051275d78b24d68b92",
+ "url": "https://api.github.com/repos/symfony/process/zipball/0d41dd7d95ed179aed6a13393b0f4f97bfa2d25c",
+ "reference": "0d41dd7d95ed179aed6a13393b0f4f97bfa2d25c",
"shasum": ""
},
"require": {
@@ -1276,7 +1334,7 @@
],
"description": "Symfony Process Component",
"homepage": "https://symfony.com",
- "time": "2017-08-03T09:34:20+00:00"
+ "time": "2019-01-02T21:24:08+00:00"
},
{
"name": "symfony/translation",
@@ -1284,12 +1342,12 @@
"source": {
"type": "git",
"url": "https://github.com/symfony/translation.git",
- "reference": "62bb068e004874bbe39624101e1aae70ca7c05cd"
+ "reference": "5f357063f4907cef47e5cf82fa3187fbfb700456"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/symfony/translation/zipball/62bb068e004874bbe39624101e1aae70ca7c05cd",
- "reference": "62bb068e004874bbe39624101e1aae70ca7c05cd",
+ "url": "https://api.github.com/repos/symfony/translation/zipball/5f357063f4907cef47e5cf82fa3187fbfb700456",
+ "reference": "5f357063f4907cef47e5cf82fa3187fbfb700456",
"shasum": ""
},
"require": {
@@ -1299,17 +1357,18 @@
"conflict": {
"symfony/config": "<2.8",
"symfony/dependency-injection": "<3.4",
- "symfony/yaml": "<3.3"
+ "symfony/yaml": "<3.4"
},
"require-dev": {
"psr/log": "~1.0",
"symfony/config": "~2.8|~3.0|~4.0",
"symfony/dependency-injection": "~3.4|~4.0",
+ "symfony/finder": "~2.8|~3.0|~4.0",
"symfony/intl": "^2.8.18|^3.2.5|~4.0",
- "symfony/yaml": "~3.3|~4.0"
+ "symfony/yaml": "~3.4|~4.0"
},
"suggest": {
- "psr/log": "To use logging capability in translator",
+ "psr/log-implementation": "To use logging capability in translator",
"symfony/config": "",
"symfony/yaml": ""
},
@@ -1343,7 +1402,7 @@
],
"description": "Symfony Translation Component",
"homepage": "https://symfony.com",
- "time": "2017-08-03T12:04:31+00:00"
+ "time": "2019-01-01T13:45:19+00:00"
},
{
"name": "symfony/yaml",
@@ -1351,19 +1410,23 @@
"source": {
"type": "git",
"url": "https://github.com/symfony/yaml.git",
- "reference": "1395ddba6f65bf46cdf1d80d59223cbab8ff3ccc"
+ "reference": "554a59a1ccbaac238a89b19c8e551a556fd0e2ea"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/symfony/yaml/zipball/1395ddba6f65bf46cdf1d80d59223cbab8ff3ccc",
- "reference": "1395ddba6f65bf46cdf1d80d59223cbab8ff3ccc",
+ "url": "https://api.github.com/repos/symfony/yaml/zipball/554a59a1ccbaac238a89b19c8e551a556fd0e2ea",
+ "reference": "554a59a1ccbaac238a89b19c8e551a556fd0e2ea",
"shasum": ""
},
"require": {
- "php": "^5.5.9|>=7.0.8"
+ "php": "^5.5.9|>=7.0.8",
+ "symfony/polyfill-ctype": "~1.8"
+ },
+ "conflict": {
+ "symfony/console": "<3.4"
},
"require-dev": {
- "symfony/console": "~2.8|~3.0|~4.0"
+ "symfony/console": "~3.4|~4.0"
},
"suggest": {
"symfony/console": "For validating YAML files using the lint command"
@@ -1398,7 +1461,7 @@
],
"description": "Symfony Yaml Component",
"homepage": "https://symfony.com",
- "time": "2017-08-04T13:29:48+00:00"
+ "time": "2019-01-01T13:45:19+00:00"
},
{
"name": "wp-cli/autoload-splitter",
@@ -2802,101 +2865,66 @@
},
{
"name": "wp-cli/wp-cli",
- "version": "v1.3.0",
+ "version": "v2.1.0",
"source": {
"type": "git",
"url": "https://github.com/wp-cli/wp-cli.git",
- "reference": "4ab0d99da0ad5e6ca39453ff5c82d4f06aecb086"
+ "reference": "6dde820a8f6f183f4b6d751e5be1cd343974f333"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/wp-cli/wp-cli/zipball/4ab0d99da0ad5e6ca39453ff5c82d4f06aecb086",
- "reference": "4ab0d99da0ad5e6ca39453ff5c82d4f06aecb086",
+ "url": "https://api.github.com/repos/wp-cli/wp-cli/zipball/6dde820a8f6f183f4b6d751e5be1cd343974f333",
+ "reference": "6dde820a8f6f183f4b6d751e5be1cd343974f333",
"shasum": ""
},
"require": {
- "composer/composer": "^1.2.0",
- "composer/semver": "~1.0",
+ "ext-curl": "*",
+ "ext-readline": "*",
"mustache/mustache": "~2.4",
- "php": ">=5.3.29",
+ "php": ">=5.4",
"ramsey/array_column": "~1.1",
"rmccue/requests": "~1.6",
- "symfony/config": "^2.7|^3.0",
- "symfony/console": "^2.7|^3.0",
- "symfony/debug": "^2.7|^3.0",
- "symfony/dependency-injection": "^2.7|^3.0",
- "symfony/event-dispatcher": "^2.7|^3.0",
- "symfony/filesystem": "^2.7|^3.0",
- "symfony/finder": "^2.7|^3.0",
- "symfony/process": "^2.1|^3.0",
- "symfony/translation": "^2.7|^3.0",
- "symfony/yaml": "^2.7|^3.0",
- "wp-cli/autoload-splitter": "^0.1.5",
- "wp-cli/cache-command": "^1.0",
- "wp-cli/checksum-command": "^1.0",
- "wp-cli/config-command": "^1.0",
- "wp-cli/core-command": "^1.0",
- "wp-cli/cron-command": "^1.0",
- "wp-cli/db-command": "^1.0",
- "wp-cli/entity-command": "^1.0",
- "wp-cli/eval-command": "^1.0",
- "wp-cli/export-command": "^1.0",
- "wp-cli/extension-command": "^1.0",
- "wp-cli/import-command": "^1.0",
- "wp-cli/language-command": "^1.0",
- "wp-cli/media-command": "^1.0",
+ "symfony/finder": ">2.7",
"wp-cli/mustangostang-spyc": "^0.6.3",
- "wp-cli/package-command": "^1.0",
- "wp-cli/php-cli-tools": "~0.11.2",
- "wp-cli/rewrite-command": "^1.0",
- "wp-cli/role-command": "^1.0",
- "wp-cli/scaffold-command": "^1.0",
- "wp-cli/search-replace-command": "^1.0",
- "wp-cli/server-command": "^1.0",
- "wp-cli/shell-command": "^1.0",
- "wp-cli/super-admin-command": "^1.0",
- "wp-cli/widget-command": "^1.0"
+ "wp-cli/php-cli-tools": "~0.11.2"
},
"require-dev": {
- "behat/behat": "2.5.*",
- "phpunit/phpunit": "3.7.*",
- "roave/security-advisories": "dev-master"
+ "roave/security-advisories": "dev-master",
+ "wp-cli/db-command": "^1.3 || ^2",
+ "wp-cli/entity-command": "^1.2 || ^2",
+ "wp-cli/extension-command": "^1.1 || ^2",
+ "wp-cli/package-command": "^1 || ^2",
+ "wp-cli/wp-cli-tests": "^2.0.8"
},
"suggest": {
- "psy/psysh": "Enhanced `wp shell` functionality"
+ "ext-zip": "Needed to support extraction of ZIP archives when doing downloads or updates"
},
"bin": [
- "bin/wp.bat",
- "bin/wp"
+ "bin/wp",
+ "bin/wp.bat"
],
"type": "library",
"extra": {
- "autoload-splitter": {
- "splitter-logic": "WP_CLI\\AutoloadSplitter",
- "splitter-location": "php/WP_CLI/AutoloadSplitter.php",
- "split-target-prefix-true": "autoload_commands",
- "split-target-prefix-false": "autoload_framework"
+ "branch-alias": {
+ "dev-master": "2.1.x-dev"
}
},
"autoload": {
"psr-0": {
"WP_CLI": "php"
- },
- "psr-4": {
- "": "php/commands/src"
}
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"MIT"
],
- "description": "A command line interface for WordPress",
- "homepage": "http://wp-cli.org",
+ "description": "WP-CLI framework",
+ "homepage": "https://wp-cli.org",
"keywords": [
"cli",
"wordpress"
],
- "time": "2017-08-08T14:28:58+00:00"
+ "time": "2018-12-18T17:37:51+00:00"
}
],
"aliases": [],
diff --git a/includes/libraries/class-emogrifier.php b/includes/libraries/class-emogrifier.php
index 8518c4bf43efb..ddadb6122775c 100644
--- a/includes/libraries/class-emogrifier.php
+++ b/includes/libraries/class-emogrifier.php
@@ -4,8 +4,6 @@
*
* For more information, please see the README.md file.
*
- * @version 2.0.0
- *
* @author Cameron Brooks
* @author Jaime Prado
* @author Oliver Klee
@@ -64,6 +62,16 @@ class Emogrifier
*/
const CLASS_ATTRIBUTE_MATCHER = '/(\\w+|[\\*\\]])?((\\.[\\w\\-]+)+)/';
+ /**
+ * Regular expression component matching a static pseudo class in a selector, without the preceding ":",
+ * for which the applicable elements can be determined (by converting the selector to an XPath expression).
+ * (Contains alternation without a group and is intended to be placed within a capturing, non-capturing or lookahead
+ * group, as appropriate for the usage context.)
+ *
+ * @var string
+ */
+ const PSEUDO_CLASS_MATCHER = '\\S+\\-(?:child|type\\()|not\\([[:ascii:]]*\\)';
+
/**
* @var string
*/
@@ -75,9 +83,9 @@ class Emogrifier
const DEFAULT_DOCUMENT_TYPE = '';
/**
- * @var string
+ * @var \DOMDocument
*/
- private $html = '';
+ protected $domDocument = null;
/**
* @var string
@@ -151,7 +159,23 @@ class Emogrifier
*
* @var bool
*/
- private $shouldKeepInvisibleNodes = true;
+ private $shouldRemoveInvisibleNodes = true;
+
+ /**
+ * For calculating selector precedence order.
+ * Keys are a regular expression part to match before a CSS name.
+ * Values are a multiplier factor per match to weight specificity.
+ *
+ * @var int[]
+ */
+ private $selectorPrecedenceMatchers = [
+ // IDs: worth 10000
+ '\\#' => 10000,
+ // classes, attributes, pseudo-classes (not pseudo-elements) except `:not`: worth 100
+ '(?:\\.|\\[|(? 100,
+ // elements (not attribute values or `:not`), pseudo-elements: worth 1
+ '(?:(? 1,
+ ];
/**
* @var string[]
@@ -172,11 +196,11 @@ class Emogrifier
// type and attribute value with * (substring match)
'/([\\w\\*]+)\\[(\\w+)[\\s]*\\*\\=[\\s]*[\'"]?([\\w\\-_\\s\\/:;]+)[\'"]?\\]/' => '\\1[contains(@\\2, "\\3")]',
// adjacent sibling
- '/\\s+\\+\\s+/' => '/following-sibling::*[1]/self::',
+ '/\\s*\\+\\s*/' => '/following-sibling::*[1]/self::',
// child
'/\\s*>\\s*/' => '/',
- // descendant
- '/\\s+(?=.*[^\\]]{1}$)/' => '//',
+ // descendant (don't match spaces within already translated XPath predicates)
+ '/\\s+(?![^\\[\\]]*+\\])/' => '//',
// type and :first-child
'/([^\\/]+):first-child/i' => '*[1]/self::\\1',
// type and :last-child
@@ -233,35 +257,46 @@ class Emogrifier
private $debug = false;
/**
- * The constructor.
- *
- * @param string $html the HTML to emogrify, must be UTF-8-encoded
+ * @param string $unprocessedHtml the HTML to process, must be UTF-8-encoded
* @param string $css the CSS to merge, must be UTF-8-encoded
*/
- public function __construct($html = '', $css = '')
+ public function __construct($unprocessedHtml = '', $css = '')
{
- $this->setHtml($html);
+ if ($unprocessedHtml !== '') {
+ $this->setHtml($unprocessedHtml);
+ }
$this->setCss($css);
}
/**
- * The destructor.
+ * Sets the HTML to process.
+ *
+ * @param string $html the HTML to process, must be UTF-encoded, must not be empty
+ *
+ * @return void
+ *
+ * @throws \InvalidArgumentException if $unprocessedHtml is anything other than a non-empty string
*/
- public function __destruct()
+ public function setHtml($html)
{
- $this->purgeVisitedNodes();
+ if (!\is_string($html)) {
+ throw new \InvalidArgumentException('The provided HTML must be a string.', 1540403913);
+ }
+ if ($html === '') {
+ throw new \InvalidArgumentException('The provided HTML must not be empty.', 1540403910);
+ }
+
+ $this->createUnifiedDomDocument($html);
}
/**
- * Sets the HTML to emogrify.
- *
- * @param string $html the HTML to emogrify, must be UTF-8-encoded
+ * Provides access to the internal DOMDocument representation of the HTML in its current state.
*
- * @return void
+ * @return \DOMDocument
*/
- public function setHtml($html)
+ public function getDomDocument()
{
- $this->html = $html;
+ return $this->domDocument;
}
/**
@@ -277,7 +312,53 @@ public function setCss($css)
}
/**
- * Applies $this->css to $this->html and returns the HTML with the CSS
+ * Renders the normalized and processed HTML.
+ *
+ * @return string
+ */
+ protected function render()
+ {
+ return $this->domDocument->saveHTML();
+ }
+
+ /**
+ * Renders the content of the BODY element of the normalized and processed HTML.
+ *
+ * @return string
+ */
+ protected function renderBodyContent()
+ {
+ $bodyNodeHtml = $this->domDocument->saveHTML($this->getBodyElement());
+
+ return \str_replace(['', ''], '', $bodyNodeHtml);
+ }
+
+ /**
+ * Returns the BODY element.
+ *
+ * This method assumes that there always is a BODY element.
+ *
+ * @return \DOMElement
+ */
+ private function getBodyElement()
+ {
+ return $this->domDocument->getElementsByTagName('body')->item(0);
+ }
+
+ /**
+ * Returns the HEAD element.
+ *
+ * This method assumes that there always is a HEAD element.
+ *
+ * @return \DOMElement
+ */
+ private function getHeadElement()
+ {
+ return $this->domDocument->getElementsByTagName('head')->item(0);
+ }
+
+ /**
+ * Applies $this->css to the given HTML and returns the HTML with the CSS
* applied.
*
* This method places the CSS inline.
@@ -288,11 +369,15 @@ public function setCss($css)
*/
public function emogrify()
{
- return $this->createAndProcessXmlDocument()->saveHTML();
+ $this->assertExistenceOfHtml();
+
+ $this->process();
+
+ return $this->render();
}
/**
- * Applies $this->css to $this->html and returns only the HTML content
+ * Applies $this->css to the given HTML and returns only the HTML content
* within the tag.
*
* This method places the CSS inline.
@@ -303,50 +388,96 @@ public function emogrify()
*/
public function emogrifyBodyContent()
{
- $xmlDocument = $this->createAndProcessXmlDocument();
- $bodyNodeHtml = $xmlDocument->saveHTML($this->getBodyElement($xmlDocument));
+ $this->assertExistenceOfHtml();
- return str_replace(['', ''], '', $bodyNodeHtml);
+ $this->process();
+
+ return $this->renderBodyContent();
}
/**
- * Creates an XML document from $this->html and emogrifies ist.
+ * Checks that some HTML has been set, and throws an exception otherwise.
*
- * @return \DOMDocument
+ * @return void
*
* @throws \BadMethodCallException
*/
- private function createAndProcessXmlDocument()
+ private function assertExistenceOfHtml()
{
- if ($this->html === '') {
+ if ($this->domDocument === null) {
throw new \BadMethodCallException('Please set some HTML first.', 1390393096);
}
+ }
+
+ /**
+ * Creates a DOM document from the given HTML and stores it in $this->domDocument.
+ *
+ * The DOM document will always have a BODY element.
+ *
+ * @param string $html
+ *
+ * @return void
+ */
+ private function createUnifiedDomDocument($html)
+ {
+ $this->createRawDomDocument($html);
+ $this->ensureExistenceOfBodyElement();
+ }
- $xmlDocument = $this->createRawXmlDocument();
- $this->ensureExistenceOfBodyElement($xmlDocument);
- $this->process($xmlDocument);
+ /**
+ * Creates a DOMDocument instance from the given HTML and stores it in $this->domDocument.
+ *
+ * @param string $html
+ *
+ * @return void
+ */
+ private function createRawDomDocument($html)
+ {
+ $domDocument = new \DOMDocument();
+ $domDocument->encoding = 'UTF-8';
+ $domDocument->strictErrorChecking = false;
+ $domDocument->formatOutput = true;
+ $libXmlState = \libxml_use_internal_errors(true);
+ $domDocument->loadHTML($this->prepareHtmlForDomConversion($html));
+ \libxml_clear_errors();
+ \libxml_use_internal_errors($libXmlState);
+ $domDocument->normalizeDocument();
- return $xmlDocument;
+ $this->domDocument = $domDocument;
}
/**
- * Applies $this->css to $xmlDocument.
+ * Returns the HTML with added document type and Content-Type meta tag if needed,
+ * ensuring that the HTML will be good for creating a DOM document from it.
*
- * This method places the CSS inline.
+ * @param string $html
+ *
+ * @return string the unified HTML
+ */
+ private function prepareHtmlForDomConversion($html)
+ {
+ $htmlWithDocumentType = $this->ensureDocumentType($html);
+
+ return $this->addContentTypeMetaTag($htmlWithDocumentType);
+ }
+
+ /**
+ * Applies $this->css to $this->domDocument.
*
- * @param \DOMDocument $xmlDocument
+ * This method places the CSS inline.
*
* @return void
*
* @throws \InvalidArgumentException
*/
- protected function process(\DOMDocument $xmlDocument)
+ protected function process()
{
- $xPath = new \DOMXPath($xmlDocument);
$this->clearAllCaches();
$this->purgeVisitedNodes();
- set_error_handler([$this, 'handleXpathQueryWarnings'], E_WARNING);
+ $xPath = new \DOMXPath($this->domDocument);
+ \set_error_handler([$this, 'handleXpathQueryWarnings'], E_WARNING);
+ $this->removeUnprocessableTags();
$this->normalizeStyleAttributesOfAllNodes($xPath);
// grab any existing style blocks from the html and append them to the existing CSS
@@ -356,16 +487,15 @@ protected function process(\DOMDocument $xmlDocument)
$allCss .= $this->getCssFromAllStyleNodes($xPath);
}
- $cssParts = $this->splitCssAndMediaQuery($allCss);
$excludedNodes = $this->getNodesToExclude($xPath);
- $cssRules = $this->parseCssRules($cssParts['css']);
- foreach ($cssRules as $cssRule) {
+ $cssRules = $this->parseCssRules($allCss);
+ foreach ($cssRules['inlineable'] as $cssRule) {
// There's no real way to test "PHP Warning" output generated by the following XPath query unless PHPUnit
// converts it to an exception. Unfortunately, this would only apply to tests and not work for production
// executions, which can still flood logs/output unnecessarily. Instead, Emogrifier's error handler should
// always throw an exception and it must be caught here and only rethrown if in debug mode.
try {
- // \DOMXPath::query will always return a DOMNodeList or an exception when errors are caught.
+ // \DOMXPath::query will always return a DOMNodeList or throw an exception when errors are caught.
$nodesMatchingCssSelectors = $xPath->query($this->translateCssToXpath($cssRule['selector']));
} catch (\InvalidArgumentException $e) {
if ($this->debug) {
@@ -376,41 +506,40 @@ protected function process(\DOMDocument $xmlDocument)
/** @var \DOMElement $node */
foreach ($nodesMatchingCssSelectors as $node) {
- if (in_array($node, $excludedNodes, true)) {
+ if (\in_array($node, $excludedNodes, true)) {
continue;
}
- // if it has a style attribute, get it, process it, and append (overwrite) new stuff
- if ($node->hasAttribute('style')) {
- // break it up into an associative array
- $oldStyleDeclarations = $this->parseCssDeclarationsBlock($node->getAttribute('style'));
- } else {
- $oldStyleDeclarations = [];
- }
- $newStyleDeclarations = $this->parseCssDeclarationsBlock($cssRule['declarationsBlock']);
- $node->setAttribute(
- 'style',
- $this->generateStyleStringFromDeclarationsArrays($oldStyleDeclarations, $newStyleDeclarations)
- );
+ $this->copyInlineableCssToStyleAttribute($node, $cssRule);
}
}
if ($this->isInlineStyleAttributesParsingEnabled) {
$this->fillStyleAttributesWithMergedStyles();
}
+ $this->postProcess($xPath);
+
+ $this->removeImportantAnnotationFromAllInlineStyles($xPath);
+ $this->copyUninlineableCssToStyleNode($xPath, $cssRules['uninlineable']);
+
+ \restore_error_handler();
+ }
+
+ /**
+ * Applies some optional post-processing to the HTML in the DOM document.
+ *
+ * @param \DOMXPath $xPath
+ *
+ * @return void
+ */
+ private function postProcess(\DOMXPath $xPath)
+ {
if ($this->shouldMapCssToHtml) {
$this->mapAllInlineStylesToHtmlAttributes($xPath);
}
-
- if ($this->shouldKeepInvisibleNodes) {
+ if ($this->shouldRemoveInvisibleNodes) {
$this->removeInvisibleNodes($xPath);
}
-
- $this->removeImportantAnnotationFromAllInlineStyles($xPath);
-
- $this->copyCssWithMediaToStyleNode($xmlDocument, $xPath, $cssParts['media']);
-
- restore_error_handler();
}
/**
@@ -464,12 +593,12 @@ private function removeImportantAnnotationFromNodeInlineStyle(\DOMElement $node)
$importantStyleDeclarations = [];
foreach ($inlineStyleDeclarations as $property => $value) {
if ($this->attributeValueIsImportant($value)) {
- $importantStyleDeclarations[$property] = trim(str_replace('!important', '', $value));
+ $importantStyleDeclarations[$property] = \trim(\str_replace('!important', '', $value));
} else {
$regularStyleDeclarations[$property] = $value;
}
}
- $inlineStyleDeclarationsInNewOrder = array_merge(
+ $inlineStyleDeclarationsInNewOrder = \array_merge(
$regularStyleDeclarations,
$importantStyleDeclarations
);
@@ -506,7 +635,7 @@ private function mapCssToHtmlAttributes(array $styles, \DOMElement $node)
{
foreach ($styles as $property => $value) {
// Strip !important indicator
- $value = trim(str_replace('!important', '', $value));
+ $value = \trim(\str_replace('!important', '', $value));
$this->mapCssToHtmlAttribute($property, $value, $node);
}
}
@@ -536,7 +665,7 @@ private function mapCssToHtmlAttribute($property, $value, \DOMElement $node)
* @param string $value the value of the style rule to map
* @param \DOMElement $node node to apply styles to
*
- * @return bool true if the property cab be mapped using the simple mapping table
+ * @return bool true if the property can be mapped using the simple mapping table
*/
private function mapSimpleCssProperty($property, $value, \DOMElement $node)
{
@@ -545,8 +674,8 @@ private function mapSimpleCssProperty($property, $value, \DOMElement $node)
}
$mapping = $this->cssToHtmlMap[$property];
- $nodesMatch = !isset($mapping['nodes']) || in_array($node->nodeName, $mapping['nodes'], true);
- $valuesMatch = !isset($mapping['values']) || in_array($value, $mapping['values'], true);
+ $nodesMatch = !isset($mapping['nodes']) || \in_array($node->nodeName, $mapping['nodes'], true);
+ $valuesMatch = !isset($mapping['values']) || \in_array($value, $mapping['values'], true);
if (!$nodesMatch || !$valuesMatch) {
return false;
}
@@ -567,50 +696,114 @@ private function mapSimpleCssProperty($property, $value, \DOMElement $node)
*/
private function mapComplexCssProperty($property, $value, \DOMElement $node)
{
- $nodeName = $node->nodeName;
- $isTable = $nodeName === 'table';
- $isImage = $nodeName === 'img';
- $isTableOrImage = $isTable || $isImage;
-
switch ($property) {
case 'background':
- // Parse out the color, if any
- $styles = explode(' ', $value);
- $first = $styles[0];
- if (!is_numeric($first[0]) && strpos($first, 'url') !== 0) {
- // This is not a position or image, assume it's a color
- $node->setAttribute('bgcolor', $first);
- }
+ $this->mapBackgroundProperty($node, $value);
break;
case 'width':
// intentional fall-through
case 'height':
- // Only parse values in px and %, but not values like "auto".
- if (preg_match('/^\d+(px|%)$/', $value)) {
- // Remove 'px'. This regex only conserves numbers and %
- $number = preg_replace('/[^0-9.%]/', '', $value);
- $node->setAttribute($property, $number);
- }
+ $this->mapWidthOrHeightProperty($node, $value, $property);
break;
case 'margin':
- if ($isTableOrImage) {
- $margins = $this->parseCssShorthandValue($value);
- if ($margins['left'] === 'auto' && $margins['right'] === 'auto') {
- $node->setAttribute('align', 'center');
- }
- }
+ $this->mapMarginProperty($node, $value);
break;
case 'border':
- if ($isTableOrImage) {
- if ($value === 'none' || $value === '0') {
- $node->setAttribute('border', '0');
- }
- }
+ $this->mapBorderProperty($node, $value);
break;
default:
}
}
+ /**
+ * Maps the "background" CSS property to visual HTML attributes.
+ *
+ * @param \DOMElement $node node to apply styles to
+ * @param string $value the value of the style rule to map
+ *
+ * @return void
+ */
+ private function mapBackgroundProperty(\DOMElement $node, $value)
+ {
+ // parse out the color, if any
+ $styles = \explode(' ', $value);
+ $first = $styles[0];
+ if (!\is_numeric($first[0]) && \strpos($first, 'url') !== 0) {
+ // as this is not a position or image, assume it's a color
+ $node->setAttribute('bgcolor', $first);
+ }
+ }
+
+ /**
+ * Maps the "width" or "height" CSS properties to visual HTML attributes.
+ *
+ * @param \DOMElement $node node to apply styles to
+ * @param string $value the value of the style rule to map
+ * @param string $property the name of the CSS property to map
+ *
+ * @return void
+ */
+ private function mapWidthOrHeightProperty(\DOMElement $node, $value, $property)
+ {
+ // only parse values in px and %, but not values like "auto"
+ if (\preg_match('/^\\d+(px|%)$/', $value)) {
+ // Remove 'px'. This regex only conserves numbers and %.
+ $number = \preg_replace('/[^0-9.%]/', '', $value);
+ $node->setAttribute($property, $number);
+ }
+ }
+
+ /**
+ * Maps the "margin" CSS property to visual HTML attributes.
+ *
+ * @param \DOMElement $node node to apply styles to
+ * @param string $value the value of the style rule to map
+ *
+ * @return void
+ */
+ private function mapMarginProperty(\DOMElement $node, $value)
+ {
+ if (!$this->isTableOrImageNode($node)) {
+ return;
+ }
+
+ $margins = $this->parseCssShorthandValue($value);
+ if ($margins['left'] === 'auto' && $margins['right'] === 'auto') {
+ $node->setAttribute('align', 'center');
+ }
+ }
+
+ /**
+ * Maps the "border" CSS property to visual HTML attributes.
+ *
+ * @param \DOMElement $node node to apply styles to
+ * @param string $value the value of the style rule to map
+ *
+ * @return void
+ */
+ private function mapBorderProperty(\DOMElement $node, $value)
+ {
+ if (!$this->isTableOrImageNode($node)) {
+ return;
+ }
+
+ if ($value === 'none' || $value === '0') {
+ $node->setAttribute('border', '0');
+ }
+ }
+
+ /**
+ * Checks whether $node is a table or img element.
+ *
+ * @param \DOMElement $node
+ *
+ * @return bool
+ */
+ private function isTableOrImageNode(\DOMElement $node)
+ {
+ return $node->nodeName === 'table' || $node->nodeName === 'img';
+ }
+
/**
* Parses a shorthand CSS value and splits it into individual values
*
@@ -623,13 +816,13 @@ private function mapComplexCssProperty($property, $value, \DOMElement $node)
*/
private function parseCssShorthandValue($value)
{
- $values = preg_split('/\\s+/', $value);
+ $values = \preg_split('/\\s+/', $value);
$css = [];
$css['top'] = $values[0];
- $css['right'] = (count($values) > 1) ? $values[1] : $css['top'];
- $css['bottom'] = (count($values) > 2) ? $values[2] : $css['top'];
- $css['left'] = (count($values) > 3) ? $values[3] : $css['right'];
+ $css['right'] = (\count($values) > 1) ? $values[1] : $css['top'];
+ $css['bottom'] = (\count($values) > 2) ? $values[2] : $css['top'];
+ $css['left'] = (\count($values) > 3) ? $values[3] : $css['right'];
return $css;
}
@@ -639,57 +832,100 @@ private function parseCssShorthandValue($value)
*
* @param string $css a string of raw CSS code
*
- * @return string[][] an array of string sub-arrays with the keys
- * "selector" (the CSS selector(s), e.g., "*" or "h1"),
- * "declarationsBLock" (the semicolon-separated CSS declarations for that selector(s),
+ * @return string[][][] A 2-entry array with the key "inlineable" containing rules which can be inlined as `style`
+ * attributes and the key "uninlineable" containing rules which cannot. Each value is an array of string
+ * sub-arrays with the keys
+ * "media" (the media query string, e.g. "@media screen and (max-width: 480px)",
+ * or an empty string if not from a `@media` rule),
+ * "selector" (the CSS selector, e.g., "*" or "header h1"),
+ * "hasUnmatchablePseudo" (true if that selector contains psuedo-elements or dynamic pseudo-classes
+ * such that the declarations cannot be applied inline),
+ * "declarationsBlock" (the semicolon-separated CSS declarations for that selector,
* e.g., "color: red; height: 4px;"),
* and "line" (the line number e.g. 42)
*/
private function parseCssRules($css)
{
- $cssKey = md5($css);
- if (!isset($this->caches[self::CACHE_KEY_CSS][$cssKey])) {
- // process the CSS file for selectors and definitions
- preg_match_all('/(?:^|[\\s^{}]*)([^{]+){([^}]*)}/mi', $css, $matches, PREG_SET_ORDER);
+ $cssKey = \md5($css);
+ if (!isset($this->caches[static::CACHE_KEY_CSS][$cssKey])) {
+ $matches = $this->getCssRuleMatches($css);
- $cssRules = [];
+ $cssRules = [
+ 'inlineable' => [],
+ 'uninlineable' => [],
+ ];
/** @var string[][] $matches */
/** @var string[] $cssRule */
foreach ($matches as $key => $cssRule) {
- $cssDeclaration = trim($cssRule[2]);
+ $cssDeclaration = \trim($cssRule['declarations']);
if ($cssDeclaration === '') {
continue;
}
- $selectors = explode(',', $cssRule[1]);
+ $selectors = \explode(',', $cssRule['selectors']);
foreach ($selectors as $selector) {
// don't process pseudo-elements and behavioral (dynamic) pseudo-classes;
// only allow structural pseudo-classes
- $hasPseudoElement = strpos($selector, '::') !== false;
- $hasAnyPseudoClass = (bool)preg_match('/:[a-zA-Z]/', $selector);
- $hasSupportedPseudoClass = (bool)preg_match(
- '/:(\\S+\\-(child|type\\()|not\\([[:ascii:]]*\\))/i',
+ $hasPseudoElement = \strpos($selector, '::') !== false;
+ $hasUnsupportedPseudoClass = (bool)\preg_match(
+ '/:(?!' . static::PSEUDO_CLASS_MATCHER . ')[\\w\\-]/i',
$selector
);
- if ($hasPseudoElement || ($hasAnyPseudoClass && !$hasSupportedPseudoClass)) {
- continue;
- }
+ $hasUnmatchablePseudo = $hasPseudoElement || $hasUnsupportedPseudoClass;
- $cssRules[] = [
- 'selector' => trim($selector),
+ $parsedCssRule = [
+ 'media' => $cssRule['media'],
+ 'selector' => \trim($selector),
+ 'hasUnmatchablePseudo' => $hasUnmatchablePseudo,
'declarationsBlock' => $cssDeclaration,
// keep track of where it appears in the file, since order is important
'line' => $key,
];
+ $ruleType = ($cssRule['media'] === '' && !$hasUnmatchablePseudo) ? 'inlineable' : 'uninlineable';
+ $cssRules[$ruleType][] = $parsedCssRule;
}
}
- usort($cssRules, [$this, 'sortBySelectorPrecedence']);
+ \usort($cssRules['inlineable'], [$this, 'sortBySelectorPrecedence']);
- $this->caches[self::CACHE_KEY_CSS][$cssKey] = $cssRules;
+ $this->caches[static::CACHE_KEY_CSS][$cssKey] = $cssRules;
}
- return $this->caches[self::CACHE_KEY_CSS][$cssKey];
+ return $this->caches[static::CACHE_KEY_CSS][$cssKey];
+ }
+
+ /**
+ * Parses a string of CSS into the media query, selectors and declarations for each ruleset in order.
+ *
+ * @param string $css
+ *
+ * @return string[][] Array of string sub-arrays with the keys
+ * "media" (the media query string, e.g. "@media screen and (max-width: 480px)",
+ * or an empty string if not from an `@media` rule),
+ * "selectors" (the CSS selector(s), e.g., "*" or "h1, h2"),
+ * "declarations" (the semicolon-separated CSS declarations for that/those selector(s),
+ * e.g., "color: red; height: 4px;"),
+ */
+ private function getCssRuleMatches($css)
+ {
+ $ruleMatches = [];
+
+ $splitCss = $this->splitCssAndMediaQuery($css);
+ foreach ($splitCss as $cssPart) {
+ // process each part for selectors and definitions
+ \preg_match_all('/(?:^|[\\s^{}]*)([^{]+){([^}]*)}/mi', $cssPart['css'], $matches, PREG_SET_ORDER);
+
+ /** @var string[][] $matches */
+ foreach ($matches as $cssRule) {
+ $ruleMatches[] = [
+ 'media' => $cssPart['media'],
+ 'selectors' => $cssRule[1],
+ 'declarations' => $cssRule[2],
+ ];
+ }
+ }
+
+ return $ruleMatches;
}
/**
@@ -715,17 +951,21 @@ public function disableStyleBlocksParsing()
/**
* Disables the removal of elements with `display: none` properties.
*
+ * @deprecated will be removed in Emogrifier 3.0
+ *
* @return void
*/
public function disableInvisibleNodeRemoval()
{
- $this->shouldKeepInvisibleNodes = false;
+ $this->shouldRemoveInvisibleNodes = false;
}
/**
* Enables the attachment/override of HTML attributes for which a
* corresponding CSS property has been set.
*
+ * @deprecated will be removed in Emogrifier 3.0, use the CssToAttributeConverter instead
+ *
* @return void
*/
public function enableCssToHtmlMapping()
@@ -740,37 +980,13 @@ public function enableCssToHtmlMapping()
*/
private function clearAllCaches()
{
- $this->clearCache(self::CACHE_KEY_CSS);
- $this->clearCache(self::CACHE_KEY_SELECTOR);
- $this->clearCache(self::CACHE_KEY_XPATH);
- $this->clearCache(self::CACHE_KEY_CSS_DECLARATIONS_BLOCK);
- $this->clearCache(self::CACHE_KEY_COMBINED_STYLES);
- }
-
- /**
- * Clears a single cache by key.
- *
- * @param int $key the cache key, must be CACHE_KEY_CSS, CACHE_KEY_SELECTOR, CACHE_KEY_XPATH
- * or CACHE_KEY_CSS_DECLARATION_BLOCK
- *
- * @return void
- *
- * @throws \InvalidArgumentException
- */
- private function clearCache($key)
- {
- $allowedCacheKeys = [
- self::CACHE_KEY_CSS,
- self::CACHE_KEY_SELECTOR,
- self::CACHE_KEY_XPATH,
- self::CACHE_KEY_CSS_DECLARATIONS_BLOCK,
- self::CACHE_KEY_COMBINED_STYLES,
+ $this->caches = [
+ static::CACHE_KEY_CSS => [],
+ static::CACHE_KEY_SELECTOR => [],
+ static::CACHE_KEY_XPATH => [],
+ static::CACHE_KEY_CSS_DECLARATIONS_BLOCK => [],
+ static::CACHE_KEY_COMBINED_STYLES => [],
];
- if (!in_array($key, $allowedCacheKeys, true)) {
- throw new \InvalidArgumentException('Invalid cache key: ' . $key, 1391822035);
- }
-
- $this->caches[$key] = [];
}
/**
@@ -810,7 +1026,7 @@ public function addUnprocessableHtmlTag($tagName)
*/
public function removeUnprocessableHtmlTag($tagName)
{
- $key = array_search($tagName, $this->unprocessableHtmlTags, true);
+ $key = \array_search($tagName, $this->unprocessableHtmlTags, true);
if ($key !== false) {
unset($this->unprocessableHtmlTags[$key]);
}
@@ -894,7 +1110,7 @@ private function removeInvisibleNodes(\DOMXPath $xPath)
// we don't try to call removeChild on a nonexistent child node
/** @var \DOMNode $node */
foreach ($nodesWithStyleDisplayNone as $node) {
- if ($node->parentNode && is_callable([$node->parentNode, 'removeChild'])) {
+ if ($node->parentNode && \is_callable([$node->parentNode, 'removeChild'])) {
$node->parentNode->removeChild($node);
}
}
@@ -934,10 +1150,10 @@ private function normalizeStyleAttributesOfAllNodes(\DOMXPath $xPath)
*/
private function normalizeStyleAttributes(\DOMElement $node)
{
- $normalizedOriginalStyle = preg_replace_callback(
+ $normalizedOriginalStyle = \preg_replace_callback(
'/[A-z\\-]+(?=\\:)/S',
function (array $m) {
- return strtolower($m[0]);
+ return \strtolower($m[0]);
},
$node->getAttribute('style')
);
@@ -986,12 +1202,12 @@ private function fillStyleAttributesWithMergedStyles()
*/
private function generateStyleStringFromDeclarationsArrays(array $oldStyles, array $newStyles)
{
- $combinedStyles = array_merge($oldStyles, $newStyles);
- $cacheKey = serialize($combinedStyles);
- if (isset($this->caches[self::CACHE_KEY_COMBINED_STYLES][$cacheKey])) {
- return $this->caches[self::CACHE_KEY_COMBINED_STYLES][$cacheKey];
+ $cacheKey = \serialize([$oldStyles, $newStyles]);
+ if (isset($this->caches[static::CACHE_KEY_COMBINED_STYLES][$cacheKey])) {
+ return $this->caches[static::CACHE_KEY_COMBINED_STYLES][$cacheKey];
}
+ // Unset the overridden styles to preserve order, important if shorthand and individual properties are mixed
foreach ($oldStyles as $attributeName => $attributeValue) {
if (!isset($newStyles[$attributeName])) {
continue;
@@ -1001,17 +1217,21 @@ private function generateStyleStringFromDeclarationsArrays(array $oldStyles, arr
if ($this->attributeValueIsImportant($attributeValue)
&& !$this->attributeValueIsImportant($newAttributeValue)
) {
- $combinedStyles[$attributeName] = $attributeValue;
+ unset($newStyles[$attributeName]);
+ } else {
+ unset($oldStyles[$attributeName]);
}
}
+ $combinedStyles = \array_merge($oldStyles, $newStyles);
+
$style = '';
foreach ($combinedStyles as $attributeName => $attributeValue) {
- $style .= strtolower(trim($attributeName)) . ': ' . trim($attributeValue) . '; ';
+ $style .= \strtolower(\trim($attributeName)) . ': ' . \trim($attributeValue) . '; ';
}
- $trimmedStyle = rtrim($style);
+ $trimmedStyle = \rtrim($style);
- $this->caches[self::CACHE_KEY_COMBINED_STYLES][$cacheKey] = $trimmedStyle;
+ $this->caches[static::CACHE_KEY_COMBINED_STYLES][$cacheKey] = $trimmedStyle;
return $trimmedStyle;
}
@@ -1037,61 +1257,90 @@ private function generateStyleStringFromSingleDeclarationsArray(array $styleDecl
*/
private function attributeValueIsImportant($attributeValue)
{
- return strtolower(substr(trim($attributeValue), -10)) === '!important';
+ return \strtolower(\substr(\trim($attributeValue), -10)) === '!important';
+ }
+
+ /**
+ * Copies $cssRule into the style attribute of $node.
+ *
+ * Note: This method does not check whether $cssRule matches $node.
+ *
+ * @param \DOMElement $node
+ * @param string[][] $cssRule
+ *
+ * @return void
+ */
+ private function copyInlineableCssToStyleAttribute(\DOMElement $node, array $cssRule)
+ {
+ // if it has a style attribute, get it, process it, and append (overwrite) new stuff
+ if ($node->hasAttribute('style')) {
+ // break it up into an associative array
+ $oldStyleDeclarations = $this->parseCssDeclarationsBlock($node->getAttribute('style'));
+ } else {
+ $oldStyleDeclarations = [];
+ }
+ $newStyleDeclarations = $this->parseCssDeclarationsBlock($cssRule['declarationsBlock']);
+ $node->setAttribute(
+ 'style',
+ $this->generateStyleStringFromDeclarationsArrays($oldStyleDeclarations, $newStyleDeclarations)
+ );
}
/**
- * Applies $css to $xmlDocument, limited to the media queries that actually apply to the document.
+ * Applies $cssRules to $this->domDocument, limited to the rules that actually apply to the document.
*
- * @param \DOMDocument $xmlDocument the document to match against
* @param \DOMXPath $xPath
- * @param string $css a string of CSS
+ * @param string[][] $cssRules The "uninlineable" array of CSS rules returned by `parseCssRules`
*
* @return void
*/
- private function copyCssWithMediaToStyleNode(\DOMDocument $xmlDocument, \DOMXPath $xPath, $css)
+ private function copyUninlineableCssToStyleNode(\DOMXPath $xPath, array $cssRules)
{
- if ($css === '') {
+ $cssRulesRelevantForDocument = \array_filter(
+ $cssRules,
+ function (array $cssRule) use ($xPath) {
+ $selector = $cssRule['selector'];
+ if ($cssRule['hasUnmatchablePseudo']) {
+ $selector = $this->removeUnmatchablePseudoComponents($selector);
+ }
+ return $this->existsMatchForCssSelector($xPath, $selector);
+ }
+ );
+
+ if ($cssRulesRelevantForDocument === []) {
+ // avoid adding empty style element (or including unneeded class dependency)
return;
}
- $mediaQueriesRelevantForDocument = [];
+ // support use without autoload
+ if (!\class_exists('Pelago\\Emogrifier\\CssConcatenator')) {
+ require_once __DIR__ . '/Emogrifier/CssConcatenator.php';
+ }
- foreach ($this->extractMediaQueriesFromCss($css) as $mediaQuery) {
- foreach ($this->parseCssRules($mediaQuery['css']) as $selector) {
- if ($this->existsMatchForCssSelector($xPath, $selector['selector'])) {
- $mediaQueriesRelevantForDocument[] = $mediaQuery['query'];
- break;
- }
- }
+ $cssConcatenator = new Emogrifier\CssConcatenator();
+ foreach ($cssRulesRelevantForDocument as $cssRule) {
+ $cssConcatenator->append([$cssRule['selector']], $cssRule['declarationsBlock'], $cssRule['media']);
}
- $this->addStyleElementToDocument($xmlDocument, implode($mediaQueriesRelevantForDocument));
+ $this->addStyleElementToDocument($cssConcatenator->getCss());
}
/**
- * Extracts the media queries from $css while skipping empty media queries.
+ * Removes pseudo-elements and dynamic pseudo-classes from a CSS selector, replacing them with "*" if necessary.
*
- * @param string $css
+ * @param string $selector
*
- * @return string[][] numeric array with string sub-arrays with the keys "css" and "query"
+ * @return string Selector which will match the relevant DOM elements if the pseudo-classes are assumed to apply,
+ * or in the case of pseudo-elements will match their originating element.
*/
- private function extractMediaQueriesFromCss($css)
+ private function removeUnmatchablePseudoComponents($selector)
{
- preg_match_all('/@media\\b[^{]*({((?:[^{}]+|(?1))*)})/', $css, $rawMediaQueries, PREG_SET_ORDER);
- $parsedQueries = [];
-
- /** @var string[][] $rawMediaQueries */
- foreach ($rawMediaQueries as $mediaQuery) {
- if ($mediaQuery[2] !== '') {
- $parsedQueries[] = [
- 'css' => $mediaQuery[2],
- 'query' => $mediaQuery[0],
- ];
- }
- }
-
- return $parsedQueries;
+ $pseudoComponentMatcher = ':(?!' . static::PSEUDO_CLASS_MATCHER . '):?+[\\w\\-]++(?:\\([^\\)]*+\\))?+';
+ return \preg_replace(
+ ['/(\\s|^)' . $pseudoComponentMatcher . '/i', '/' . $pseudoComponentMatcher . '/i'],
+ ['$1*', ''],
+ $selector
+ );
}
/**
@@ -1146,73 +1395,49 @@ private function getCssFromAllStyleNodes(\DOMXPath $xPath)
}
/**
- * Adds a style element with $css to $document.
+ * Adds a style element with $css to $this->domDocument.
*
* This method is protected to allow overriding.
*
* @see https://github.com/jjriv/emogrifier/issues/103
*
- * @param \DOMDocument $document
* @param string $css
*
* @return void
*/
- protected function addStyleElementToDocument(\DOMDocument $document, $css)
+ protected function addStyleElementToDocument($css)
{
- $styleElement = $document->createElement('style', $css);
- $styleAttribute = $document->createAttribute('type');
+ $styleElement = $this->domDocument->createElement('style', $css);
+ $styleAttribute = $this->domDocument->createAttribute('type');
$styleAttribute->value = 'text/css';
$styleElement->appendChild($styleAttribute);
- $bodyElement = $this->getBodyElement($document);
- $bodyElement->appendChild($styleElement);
+ $headElement = $this->getHeadElement();
+ $headElement->appendChild($styleElement);
}
/**
- * Checks that $document has a BODY element and adds it if it is missing.
+ * Checks that $this->domDocument has a BODY element and adds it if it is missing.
*
- * @param \DOMDocument $document
+ * @return void
*/
- private function ensureExistenceOfBodyElement(\DOMDocument $document)
+ private function ensureExistenceOfBodyElement()
{
- if ($document->getElementsByTagName('body')->item(0) !== null) {
+ if ($this->domDocument->getElementsByTagName('body')->item(0) !== null) {
return;
}
- $htmlElement = $document->getElementsByTagName('html')->item(0);
-
- $htmlElement->appendChild($document->createElement('body'));
- }
-
- /**
- * Returns the BODY element.
- *
- * This method assumes that there always is a BODY element.
- *
- * @param \DOMDocument $document
- *
- * @return \DOMElement
- *
- * @throws \BadMethodCallException
- */
- private function getBodyElement(\DOMDocument $document)
- {
- $bodyElement = $document->getElementsByTagName('body')->item(0);
- if ($bodyElement === null) {
- throw new \BadMethodCallException(
- 'getBodyElement method may only be called after ensureExistenceOfBodyElement has been called.',
- 1508173775427
- );
- }
-
- return $bodyElement;
+ $htmlElement = $this->domDocument->getElementsByTagName('html')->item(0);
+ $htmlElement->appendChild($this->domDocument->createElement('body'));
}
/**
- * Splits input CSS code to an array where:
+ * Splits input CSS code into an array of parts for different media querues, in order.
+ * Each part is an array where:
*
- * - key "css" will be contains clean CSS code
- * - key "media" will be contains all valuable media queries
+ * - key "css" will contain clean CSS code (for @media rules this will be the group rule body within "{...}")
+ * - key "media" will contain "@media " followed by the media query list, for all allowed media queries,
+ * or an empty string for CSS not within a media query
*
* Example:
*
@@ -1222,98 +1447,83 @@ private function getBodyElement(\DOMDocument $document)
*
* will be parsed into the following array:
*
- * "css" => "h1 { color:red; }"
- * "media" => "@media { h1 {}}"
+ * 0 => [
+ * "css" => "h1 { color:red; }",
+ * "media" => ""
+ * ],
+ * 1 => [
+ * "css" => " h1 {}",
+ * "media" => "@media "
+ * ]
*
* @param string $css
*
- * @return string[]
+ * @return string[][]
*/
private function splitCssAndMediaQuery($css)
{
- $cssWithoutComments = preg_replace('/\\/\\*.*\\*\\//sU', '', $css);
+ $cssWithoutComments = \preg_replace('/\\/\\*.*\\*\\//sU', '', $css);
$mediaTypesExpression = '';
if (!empty($this->allowedMediaTypes)) {
- $mediaTypesExpression = '|' . implode('|', array_keys($this->allowedMediaTypes));
+ $mediaTypesExpression = '|' . \implode('|', \array_keys($this->allowedMediaTypes));
}
- $media = '';
- $cssForAllowedMediaTypes = preg_replace_callback(
- '#@media\\s+(?:only\\s)?(?:[\\s{\\(]\\s*' . $mediaTypesExpression . ')\\s*[^{]*+{.*}\\s*}\\s*#misU',
- function ($matches) use (&$media) {
- $media .= $matches[0];
- },
- $cssWithoutComments
+ $mediaRuleBodyMatcher = '[^{]*+{(?:[^{}]*+{.*})?\\s*+}\\s*+';
+
+ $cssSplitForAllowedMediaTypes = \preg_split(
+ '#(@media\\s++(?:only\\s++)?+(?:(?=[{\\(])' . $mediaTypesExpression . ')' . $mediaRuleBodyMatcher
+ . ')#misU',
+ $cssWithoutComments,
+ -1,
+ PREG_SPLIT_DELIM_CAPTURE
);
- // filter the CSS
- $search = [
- 'import directives' => '/^\\s*@import\\s[^;]+;/misU',
- 'remaining media enclosures' => '/^\\s*@media\\s[^{]+{(.*)}\\s*}\\s/misU',
+ // filter the CSS outside/between allowed @media rules
+ $cssCleaningMatchers = [
+ 'import/charset directives' => '/\\s*+@(?:import|charset)\\s[^;]++;/i',
+ 'remaining media enclosures' => '/\\s*+@media\\s' . $mediaRuleBodyMatcher . '/isU',
];
- $cleanedCss = preg_replace($search, '', $cssForAllowedMediaTypes);
-
- return ['css' => $cleanedCss, 'media' => $media];
- }
-
- /**
- * Creates a DOMDocument instance with the current HTML.
- *
- * @return \DOMDocument
- */
- private function createRawXmlDocument()
- {
- $xmlDocument = new \DOMDocument;
- $xmlDocument->encoding = 'UTF-8';
- $xmlDocument->strictErrorChecking = false;
- $xmlDocument->formatOutput = true;
- $libXmlState = libxml_use_internal_errors(true);
- $xmlDocument->loadHTML($this->getUnifiedHtml());
- libxml_clear_errors();
- libxml_use_internal_errors($libXmlState);
- $xmlDocument->normalizeDocument();
-
- return $xmlDocument;
- }
-
- /**
- * Returns the HTML with the unprocessable HTML tags removed and
- * with added document type and Content-Type meta tag if needed.
- *
- * @return string the unified HTML
- *
- * @throws \BadMethodCallException
- */
- private function getUnifiedHtml()
- {
- $htmlWithoutUnprocessableTags = $this->removeUnprocessableTags($this->html);
- $htmlWithDocumentType = $this->ensureDocumentType($htmlWithoutUnprocessableTags);
-
- return $this->addContentTypeMetaTag($htmlWithDocumentType);
+ $splitCss = [];
+ foreach ($cssSplitForAllowedMediaTypes as $index => $cssPart) {
+ $isMediaRule = $index % 2 !== 0;
+ if ($isMediaRule) {
+ \preg_match('/^([^{]*+){(.*)}[^}]*+$/s', $cssPart, $matches);
+ $splitCss[] = [
+ 'css' => $matches[2],
+ 'media' => $matches[1],
+ ];
+ } else {
+ $cleanedCss = \trim(\preg_replace($cssCleaningMatchers, '', $cssPart));
+ if ($cleanedCss !== '') {
+ $splitCss[] = [
+ 'css' => $cleanedCss,
+ 'media' => '',
+ ];
+ }
+ }
+ }
+ return $splitCss;
}
/**
- * Removes the unprocessable tags from $html (if this feature is enabled).
- *
- * @param string $html
+ * Removes empty unprocessable tags from the DOM document.
*
- * @return string the reworked HTML with the unprocessable tags removed
+ * @return void
*/
- private function removeUnprocessableTags($html)
+ private function removeUnprocessableTags()
{
- if (empty($this->unprocessableHtmlTags)) {
- return $html;
+ foreach ($this->unprocessableHtmlTags as $tagName) {
+ $nodes = $this->domDocument->getElementsByTagName($tagName);
+ /** @var \DOMNode $node */
+ foreach ($nodes as $node) {
+ $hasContent = $node->hasChildNodes() || $node->hasChildNodes();
+ if (!$hasContent) {
+ $node->parentNode->removeChild($node);
+ }
+ }
}
-
- $unprocessableHtmlTags = implode('|', $this->unprocessableHtmlTags);
-
- return preg_replace(
- '/<\\/?(' . $unprocessableHtmlTags . ')[^>]*>/i',
- '',
- $html
- );
}
/**
@@ -1325,43 +1535,45 @@ private function removeUnprocessableTags($html)
*/
private function ensureDocumentType($html)
{
- $hasDocumentType = stripos($html, '/i', '' . self::CONTENT_TYPE_META_TAG, $html);
+ $reworkedHtml = \preg_replace('//i', '' . static::CONTENT_TYPE_META_TAG, $html);
} elseif ($hasHtmlTag) {
- $reworkedHtml = preg_replace(
+ $reworkedHtml = \preg_replace(
'//i',
- '' . self::CONTENT_TYPE_META_TAG . '
',
+ '' . static::CONTENT_TYPE_META_TAG . '
',
$html
);
} else {
- $reworkedHtml = self::CONTENT_TYPE_META_TAG . $html;
+ $reworkedHtml = static::CONTENT_TYPE_META_TAG . $html;
}
return $reworkedHtml;
@@ -1392,26 +1604,21 @@ private function sortBySelectorPrecedence(array $a, array $b)
*/
private function getCssSelectorPrecedence($selector)
{
- $selectorKey = md5($selector);
- if (!isset($this->caches[self::CACHE_KEY_SELECTOR][$selectorKey])) {
+ $selectorKey = \md5($selector);
+ if (!isset($this->caches[static::CACHE_KEY_SELECTOR][$selectorKey])) {
$precedence = 0;
- $value = 100;
- // ids: worth 100, classes: worth 10, elements: worth 1
- $search = ['\\#', '\\.', ''];
-
- foreach ($search as $s) {
- if (trim($selector) === '') {
+ foreach ($this->selectorPrecedenceMatchers as $matcher => $value) {
+ if (\trim($selector) === '') {
break;
}
$number = 0;
- $selector = preg_replace('/' . $s . '\\w+/', '', $selector, -1, $number);
+ $selector = \preg_replace('/' . $matcher . '\\w+/', '', $selector, -1, $number);
$precedence += ($value * $number);
- $value /= 10;
}
- $this->caches[self::CACHE_KEY_SELECTOR][$selectorKey] = $precedence;
+ $this->caches[static::CACHE_KEY_SELECTOR][$selectorKey] = $precedence;
}
- return $this->caches[self::CACHE_KEY_SELECTOR][$selectorKey];
+ return $this->caches[static::CACHE_KEY_SELECTOR][$selectorKey];
}
/**
@@ -1426,20 +1633,20 @@ private function getCssSelectorPrecedence($selector)
private function translateCssToXpath($cssSelector)
{
$paddedSelector = ' ' . $cssSelector . ' ';
- $lowercasePaddedSelector = preg_replace_callback(
+ $lowercasePaddedSelector = \preg_replace_callback(
'/\\s+\\w+\\s+/',
function (array $matches) {
- return strtolower($matches[0]);
+ return \strtolower($matches[0]);
},
$paddedSelector
);
- $trimmedLowercaseSelector = trim($lowercasePaddedSelector);
- $xPathKey = md5($trimmedLowercaseSelector);
- if (isset($this->caches[self::CACHE_KEY_XPATH][$xPathKey])) {
- return $this->caches[self::CACHE_KEY_SELECTOR][$xPathKey];
+ $trimmedLowercaseSelector = \trim($lowercasePaddedSelector);
+ $xPathKey = \md5($trimmedLowercaseSelector);
+ if (isset($this->caches[static::CACHE_KEY_XPATH][$xPathKey])) {
+ return $this->caches[static::CACHE_KEY_SELECTOR][$xPathKey];
}
- $hasNotSelector = (bool)preg_match(
+ $hasNotSelector = (bool)\preg_match(
'/^([^:]+):not\\(\\s*([[:ascii:]]+)\\s*\\)$/',
$trimmedLowercaseSelector,
$matches
@@ -1448,14 +1655,13 @@ function (array $matches) {
$xPath = '//' . $this->translateCssToXpathPass($trimmedLowercaseSelector);
} else {
/** @var string[] $matches */
- $partBeforeNot = $matches[1];
- $notContents = $matches[2];
+ list(, $partBeforeNot, $notContents) = $matches;
$xPath = '//' . $this->translateCssToXpathPass($partBeforeNot) .
'[not(' . $this->translateCssToXpathPassInline($notContents) . ')]';
}
- $this->caches[self::CACHE_KEY_SELECTOR][$xPathKey] = $xPath;
+ $this->caches[static::CACHE_KEY_SELECTOR][$xPathKey] = $xPath;
- return $this->caches[self::CACHE_KEY_SELECTOR][$xPathKey];
+ return $this->caches[static::CACHE_KEY_SELECTOR][$xPathKey];
}
/**
@@ -1501,26 +1707,26 @@ private function translateCssToXpathPassWithMatchClassAttributesCallback(
$trimmedLowercaseSelector,
callable $matchClassAttributesCallback
) {
- $roughXpath = preg_replace(array_keys($this->xPathRules), $this->xPathRules, $trimmedLowercaseSelector);
- $xPathWithIdAttributeMatchers = preg_replace_callback(
- self::ID_ATTRIBUTE_MATCHER,
+ $roughXpath = \preg_replace(\array_keys($this->xPathRules), $this->xPathRules, $trimmedLowercaseSelector);
+ $xPathWithIdAttributeMatchers = \preg_replace_callback(
+ static::ID_ATTRIBUTE_MATCHER,
[$this, 'matchIdAttributes'],
$roughXpath
);
- $xPathWithIdAttributeAndClassMatchers = preg_replace_callback(
- self::CLASS_ATTRIBUTE_MATCHER,
+ $xPathWithIdAttributeAndClassMatchers = \preg_replace_callback(
+ static::CLASS_ATTRIBUTE_MATCHER,
$matchClassAttributesCallback,
$xPathWithIdAttributeMatchers
);
// Advanced selectors are going to require a bit more advanced emogrification.
- $xPathWithIdAttributeAndClassMatchers = preg_replace_callback(
+ $xPathWithIdAttributeAndClassMatchers = \preg_replace_callback(
'/([^\\/]+):nth-child\\(\\s*(odd|even|[+\\-]?\\d|[+\\-]?\\d?n(\\s*[+\\-]\\s*\\d)?)\\s*\\)/i',
[$this, 'translateNthChild'],
$xPathWithIdAttributeAndClassMatchers
);
- $finalXpath = preg_replace_callback(
- '/([^\\/]+):nth-of-type\\(\s*(odd|even|[+\\-]?\\d|[+\\-]?\\d?n(\\s*[+\\-]\\s*\\d)?)\\s*\\)/i',
+ $finalXpath = \preg_replace_callback(
+ '/([^\\/]+):nth-of-type\\(\\s*(odd|even|[+\\-]?\\d|[+\\-]?\\d?n(\\s*[+\\-]\\s*\\d)?)\\s*\\)/i',
[$this, 'translateNthOfType'],
$xPathWithIdAttributeAndClassMatchers
);
@@ -1556,9 +1762,9 @@ private function matchClassAttributes(array $match)
private function matchClassAttributesInline(array $match)
{
return 'contains(concat(" ",@class," "),concat(" ","' .
- implode(
+ \implode(
'"," "))][contains(concat(" ",@class," "),concat(" ","',
- explode('.', substr($match[2], 1))
+ \explode('.', \substr($match[2], 1))
) . '"," "))';
}
@@ -1571,25 +1777,25 @@ private function translateNthChild(array $match)
{
$parseResult = $this->parseNth($match);
- if (isset($parseResult[self::MULTIPLIER])) {
- if ($parseResult[self::MULTIPLIER] < 0) {
- $parseResult[self::MULTIPLIER] = abs($parseResult[self::MULTIPLIER]);
- $xPathExpression = sprintf(
- '*[(last() - position()) mod %1%u = %2$u]/self::%3$s',
- $parseResult[self::MULTIPLIER],
- $parseResult[self::INDEX],
+ if (isset($parseResult[static::MULTIPLIER])) {
+ if ($parseResult[static::MULTIPLIER] < 0) {
+ $parseResult[static::MULTIPLIER] = \abs($parseResult[static::MULTIPLIER]);
+ $xPathExpression = \sprintf(
+ '*[(last() - position()) mod %1%u = %2$u]/static::%3$s',
+ $parseResult[static::MULTIPLIER],
+ $parseResult[static::INDEX],
$match[1]
);
} else {
- $xPathExpression = sprintf(
- '*[position() mod %1$u = %2$u]/self::%3$s',
- $parseResult[self::MULTIPLIER],
- $parseResult[self::INDEX],
+ $xPathExpression = \sprintf(
+ '*[position() mod %1$u = %2$u]/static::%3$s',
+ $parseResult[static::MULTIPLIER],
+ $parseResult[static::INDEX],
$match[1]
);
}
} else {
- $xPathExpression = sprintf('*[%1$u]/self::%2$s', $parseResult[self::INDEX], $match[1]);
+ $xPathExpression = \sprintf('*[%1$u]/static::%2$s', $parseResult[static::INDEX], $match[1]);
}
return $xPathExpression;
@@ -1604,25 +1810,25 @@ private function translateNthOfType(array $match)
{
$parseResult = $this->parseNth($match);
- if (isset($parseResult[self::MULTIPLIER])) {
- if ($parseResult[self::MULTIPLIER] < 0) {
- $parseResult[self::MULTIPLIER] = abs($parseResult[self::MULTIPLIER]);
- $xPathExpression = sprintf(
+ if (isset($parseResult[static::MULTIPLIER])) {
+ if ($parseResult[static::MULTIPLIER] < 0) {
+ $parseResult[static::MULTIPLIER] = \abs($parseResult[static::MULTIPLIER]);
+ $xPathExpression = \sprintf(
'%1$s[(last() - position()) mod %2$u = %3$u]',
$match[1],
- $parseResult[self::MULTIPLIER],
- $parseResult[self::INDEX]
+ $parseResult[static::MULTIPLIER],
+ $parseResult[static::INDEX]
);
} else {
- $xPathExpression = sprintf(
+ $xPathExpression = \sprintf(
'%1$s[position() mod %2$u = %3$u]',
$match[1],
- $parseResult[self::MULTIPLIER],
- $parseResult[self::INDEX]
+ $parseResult[static::MULTIPLIER],
+ $parseResult[static::INDEX]
);
}
} else {
- $xPathExpression = sprintf('%1$s[%2$u]', $match[1], $parseResult[self::INDEX]);
+ $xPathExpression = \sprintf('%1$s[%2$u]', $match[1], $parseResult[static::INDEX]);
}
return $xPathExpression;
@@ -1635,40 +1841,40 @@ private function translateNthOfType(array $match)
*/
private function parseNth(array $match)
{
- if (in_array(strtolower($match[2]), ['even', 'odd'], true)) {
+ if (\in_array(\strtolower($match[2]), ['even', 'odd'], true)) {
// we have "even" or "odd"
- $index = strtolower($match[2]) === 'even' ? 0 : 1;
- return [self::MULTIPLIER => 2, self::INDEX => $index];
+ $index = \strtolower($match[2]) === 'even' ? 0 : 1;
+ return [static::MULTIPLIER => 2, static::INDEX => $index];
}
- if (stripos($match[2], 'n') === false) {
+ if (\stripos($match[2], 'n') === false) {
// if there is a multiplier
- $index = (int)str_replace(' ', '', $match[2]);
- return [self::INDEX => $index];
+ $index = (int)\str_replace(' ', '', $match[2]);
+ return [static::INDEX => $index];
}
if (isset($match[3])) {
- $multipleTerm = str_replace($match[3], '', $match[2]);
- $index = (int)str_replace(' ', '', $match[3]);
+ $multipleTerm = \str_replace($match[3], '', $match[2]);
+ $index = (int)\str_replace(' ', '', $match[3]);
} else {
$multipleTerm = $match[2];
$index = 0;
}
- $multiplier = str_ireplace('n', '', $multipleTerm);
+ $multiplier = \str_ireplace('n', '', $multipleTerm);
if ($multiplier === '') {
$multiplier = 1;
} elseif ($multiplier === '0') {
- return [self::INDEX => $index];
+ return [static::INDEX => $index];
} else {
$multiplier = (int)$multiplier;
}
while ($index < 0) {
- $index += abs($multiplier);
+ $index += \abs($multiplier);
}
- return [self::MULTIPLIER => $multiplier, self::INDEX => $index];
+ return [static::MULTIPLIER => $multiplier, static::INDEX => $index];
}
/**
@@ -1692,24 +1898,24 @@ private function parseNth(array $match)
*/
private function parseCssDeclarationsBlock($cssDeclarationsBlock)
{
- if (isset($this->caches[self::CACHE_KEY_CSS_DECLARATIONS_BLOCK][$cssDeclarationsBlock])) {
- return $this->caches[self::CACHE_KEY_CSS_DECLARATIONS_BLOCK][$cssDeclarationsBlock];
+ if (isset($this->caches[static::CACHE_KEY_CSS_DECLARATIONS_BLOCK][$cssDeclarationsBlock])) {
+ return $this->caches[static::CACHE_KEY_CSS_DECLARATIONS_BLOCK][$cssDeclarationsBlock];
}
$properties = [];
- $declarations = preg_split('/;(?!base64|charset)/', $cssDeclarationsBlock);
+ $declarations = \preg_split('/;(?!base64|charset)/', $cssDeclarationsBlock);
foreach ($declarations as $declaration) {
$matches = [];
- if (!preg_match('/^([A-Za-z\\-]+)\\s*:\\s*(.+)$/', trim($declaration), $matches)) {
+ if (!\preg_match('/^([A-Za-z\\-]+)\\s*:\\s*(.+)$/s', \trim($declaration), $matches)) {
continue;
}
- $propertyName = strtolower($matches[1]);
+ $propertyName = \strtolower($matches[1]);
$propertyValue = $matches[2];
$properties[$propertyName] = $propertyValue;
}
- $this->caches[self::CACHE_KEY_CSS_DECLARATIONS_BLOCK][$cssDeclarationsBlock] = $properties;
+ $this->caches[static::CACHE_KEY_CSS_DECLARATIONS_BLOCK][$cssDeclarationsBlock] = $properties;
return $properties;
}
@@ -1726,7 +1932,7 @@ private function parseCssDeclarationsBlock($cssDeclarationsBlock)
private function getNodesToExclude(\DOMXPath $xPath)
{
$excludedNodes = [];
- foreach (array_keys($this->excludedSelectors) as $selectorToExclude) {
+ foreach (\array_keys($this->excludedSelectors) as $selectorToExclude) {
try {
$matchingNodes = $xPath->query($this->translateCssToXpath($selectorToExclude));
} catch (\InvalidArgumentException $e) {
@@ -1745,7 +1951,7 @@ private function getNodesToExclude(\DOMXPath $xPath)
/**
* Handles invalid xPath expression warnings, generated during the process() method,
- * during querying \DOMDocument and trigger \InvalidArgumentException with invalid selector
+ * during querying \DOMDocument and trigger an \InvalidArgumentException with an invalid selector
* or \RuntimeException, depending on the source of the warning.
*
* @param int $type
@@ -1759,7 +1965,7 @@ private function getNodesToExclude(\DOMXPath $xPath)
* @throws \InvalidArgumentException
* @throws \RuntimeException
*/
- public function handleXpathQueryWarnings( // @codingStandardsIgnoreLine
+ public function handleXpathQueryWarnings(// phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter
$type,
$message,
$file,
@@ -1780,7 +1986,7 @@ public function handleXpathQueryWarnings( // @codingStandardsIgnoreLine
if ($selector !== '') {
throw new \InvalidArgumentException(
- sprintf('%1$s in selector >> %2$s << in %3$s on line %4$u', $message, $selector, $file, $line),
+ \sprintf('%1$s in selector >> %2$s << in %3$s on line %4$u', $message, $selector, $file, $line),
1509279985
);
}
@@ -1788,7 +1994,7 @@ public function handleXpathQueryWarnings( // @codingStandardsIgnoreLine
// Catches eventual warnings generated by method getAllNodesWithStyleAttribute()
if (isset($context['xPath'])) {
throw new \RuntimeException(
- sprintf('%1$s in %2$s on line %3$u', $message, $file, $line),
+ \sprintf('%1$s in %2$s on line %3$u', $message, $file, $line),
1509280067
);
}
diff --git a/includes/log-handlers/class-wc-log-handler-file.php b/includes/log-handlers/class-wc-log-handler-file.php
index 85514dbbfd93c..74079f0a7a19d 100644
--- a/includes/log-handlers/class-wc-log-handler-file.php
+++ b/includes/log-handlers/class-wc-log-handler-file.php
@@ -253,7 +253,7 @@ public function remove( $handle ) {
if ( isset( $logs[ $handle ] ) && $logs[ $handle ] ) {
$file = realpath( trailingslashit( WC_LOG_DIR ) . $logs[ $handle ] );
- if ( 0 === stripos( $file, trailingslashit( WC_LOG_DIR ) ) && is_file( $file ) && is_writable( $file ) ) { // phpcs:ignore WordPress.VIP.FileSystemWritesDisallow.file_ops_is_writable
+ if ( 0 === stripos( $file, realpath( trailingslashit( WC_LOG_DIR ) ) ) && is_file( $file ) && is_writable( $file ) ) { // phpcs:ignore WordPress.VIP.FileSystemWritesDisallow.file_ops_is_writable
$this->close( $file ); // Close first to be certain no processes keep it alive after it is unlinked.
$removed = unlink( $file ); // phpcs:ignore WordPress.VIP.FileSystemWritesDisallow.file_ops_unlink
}
diff --git a/includes/queue/class-wc-action-queue.php b/includes/queue/class-wc-action-queue.php
index a84fa2d596e42..f0e3445f42e9d 100644
--- a/includes/queue/class-wc-action-queue.php
+++ b/includes/queue/class-wc-action-queue.php
@@ -127,7 +127,7 @@ public function get_next( $hook, $args = null, $group = '' ) {
$next_timestamp = as_next_scheduled_action( $hook, $args, $group );
if ( $next_timestamp ) {
- return wc_string_to_datetime( $next_timestamp );
+ return new WC_DateTime( "@{$next_timestamp}", new DateTimeZone( 'UTC' ) );
}
return null;
diff --git a/includes/shipping/flat-rate/class-wc-shipping-flat-rate.php b/includes/shipping/flat-rate/class-wc-shipping-flat-rate.php
index 070253b14667e..d8ea696e628ba 100644
--- a/includes/shipping/flat-rate/class-wc-shipping-flat-rate.php
+++ b/includes/shipping/flat-rate/class-wc-shipping-flat-rate.php
@@ -159,7 +159,7 @@ public function calculate_shipping( $package = array() ) {
}
// Add shipping class costs.
- $shipping_classes = WC()->shipping->get_shipping_classes();
+ $shipping_classes = WC()->shipping()->get_shipping_classes();
if ( ! empty( $shipping_classes ) ) {
$found_shipping_classes = $this->find_shipping_classes( $package );
diff --git a/includes/shipping/flat-rate/includes/settings-flat-rate.php b/includes/shipping/flat-rate/includes/settings-flat-rate.php
index 8e53c331f53bc..803c961aa7693 100644
--- a/includes/shipping/flat-rate/includes/settings-flat-rate.php
+++ b/includes/shipping/flat-rate/includes/settings-flat-rate.php
@@ -38,7 +38,7 @@
),
);
-$shipping_classes = WC()->shipping->get_shipping_classes();
+$shipping_classes = WC()->shipping()->get_shipping_classes();
if ( ! empty( $shipping_classes ) ) {
$settings['class_costs'] = array(
diff --git a/includes/shipping/legacy-flat-rate/includes/settings-flat-rate.php b/includes/shipping/legacy-flat-rate/includes/settings-flat-rate.php
index 71dc5f5248f5d..de0fd0b5a3626 100644
--- a/includes/shipping/legacy-flat-rate/includes/settings-flat-rate.php
+++ b/includes/shipping/legacy-flat-rate/includes/settings-flat-rate.php
@@ -69,7 +69,7 @@
),
);
-$shipping_classes = WC()->shipping->get_shipping_classes();
+$shipping_classes = WC()->shipping()->get_shipping_classes();
if ( ! empty( $shipping_classes ) ) {
$settings['class_costs'] = array(
diff --git a/includes/shortcodes/class-wc-shortcode-cart.php b/includes/shortcodes/class-wc-shortcode-cart.php
index 047219f87c74d..2f3b8d5d88bdd 100644
--- a/includes/shortcodes/class-wc-shortcode-cart.php
+++ b/includes/shortcodes/class-wc-shortcode-cart.php
@@ -22,7 +22,7 @@ class WC_Shortcode_Cart {
*/
public static function calculate_shipping() {
try {
- WC()->shipping->reset_shipping();
+ WC()->shipping()->reset_shipping();
$address = array();
@@ -40,7 +40,7 @@ public static function calculate_shipping() {
}
if ( $address['country'] ) {
- WC()->customer->set_location( $address['country'], $address['state'], $address['postcode'], $address['city'] );
+ WC()->customer->set_billing_location( $address['country'], $address['state'], $address['postcode'], $address['city'] );
WC()->customer->set_shipping_location( $address['country'], $address['state'], $address['postcode'], $address['city'] );
} else {
WC()->customer->set_billing_address_to_base();
diff --git a/includes/shortcodes/class-wc-shortcode-checkout.php b/includes/shortcodes/class-wc-shortcode-checkout.php
index f4646b9e3e173..f44911be77fe6 100644
--- a/includes/shortcodes/class-wc-shortcode-checkout.php
+++ b/includes/shortcodes/class-wc-shortcode-checkout.php
@@ -86,10 +86,10 @@ private static function order_pay( $order_id ) {
try {
$order_key = isset( $_GET['key'] ) ? wc_clean( wp_unslash( $_GET['key'] ) ) : ''; // WPCS: input var ok, CSRF ok.
$order = wc_get_order( $order_id );
- $hold_stock_minutes = (int) get_option( 'woocommerce_hold_stock_minutes', 0 );
+ $hold_stock_minutes = (int) get_option( 'woocommerce_hold_stock_minutes', 0 );
// Order or payment link is invalid.
- if ( ! $order || $order->get_id() !== $order_id || $order->get_order_key() !== $order_key ) {
+ if ( ! $order || $order->get_id() !== $order_id || ! hash_equals( $order->get_order_key(), $order_key ) ) {
throw new Exception( __( 'Sorry, this order is invalid and cannot be paid for.', 'woocommerce' ) );
}
@@ -116,7 +116,7 @@ private static function order_pay( $order_id ) {
}
// Ensure order items are still stocked if paying for a failed order. Pending orders do not need this check because stock is held.
- if ( ! $order->has_status( 'pending' ) ) {
+ if ( ! $order->has_status( wc_get_is_pending_statuses() ) ) {
$quantities = array();
foreach ( $order->get_items() as $item_key => $item ) {
@@ -177,7 +177,8 @@ private static function order_pay( $order_id ) {
}
wc_get_template(
- 'checkout/form-pay.php', array(
+ 'checkout/form-pay.php',
+ array(
'order' => $order,
'available_gateways' => $available_gateways,
'order_button_text' => apply_filters( 'woocommerce_pay_order_button_text', __( 'Pay for order', 'woocommerce' ) ),
@@ -193,7 +194,7 @@ private static function order_pay( $order_id ) {
$order_key = isset( $_GET['key'] ) ? wc_clean( wp_unslash( $_GET['key'] ) ) : ''; // WPCS: input var ok, CSRF ok.
$order = wc_get_order( $order_id );
- if ( $order && $order->get_id() === $order_id && $order->get_order_key() === $order_key ) {
+ if ( $order && $order->get_id() === $order_id && hash_equals( $order->get_order_key(), $order_key ) ) {
if ( $order->needs_payment() ) {
@@ -227,7 +228,7 @@ private static function order_received( $order_id = 0 ) {
if ( $order_id > 0 ) {
$order = wc_get_order( $order_id );
- if ( ! $order || $order->get_order_key() !== $order_key ) {
+ if ( ! $order || ! hash_equals( $order->get_order_key(), $order_key ) ) {
$order = false;
}
}
@@ -251,6 +252,9 @@ private static function order_received( $order_id = 0 ) {
* Show the checkout.
*/
private static function checkout() {
+ // Show non-cart errors.
+ do_action( 'woocommerce_before_checkout_form_cart_notices' );
+
// Check cart has contents.
if ( WC()->cart->is_empty() && ! is_customize_preview() && apply_filters( 'woocommerce_checkout_redirect_empty_cart', true ) ) {
return;
diff --git a/includes/shortcodes/class-wc-shortcode-my-account.php b/includes/shortcodes/class-wc-shortcode-my-account.php
index 5229aa829d6c3..79a550e714682 100644
--- a/includes/shortcodes/class-wc-shortcode-my-account.php
+++ b/includes/shortcodes/class-wc-shortcode-my-account.php
@@ -219,8 +219,10 @@ public static function lost_password() {
*/
} elseif ( ! empty( $_GET['show-reset-form'] ) ) { // WPCS: input var ok, CSRF ok.
if ( isset( $_COOKIE[ 'wp-resetpass-' . COOKIEHASH ] ) && 0 < strpos( $_COOKIE[ 'wp-resetpass-' . COOKIEHASH ], ':' ) ) { // @codingStandardsIgnoreLine
- list( $rp_login, $rp_key ) = array_map( 'wc_clean', explode( ':', wp_unslash( $_COOKIE[ 'wp-resetpass-' . COOKIEHASH ] ), 2 ) ); // @codingStandardsIgnoreLine
- $user = self::check_password_reset_key( $rp_key, $rp_login );
+ list( $rp_id, $rp_key ) = array_map( 'wc_clean', explode( ':', wp_unslash( $_COOKIE[ 'wp-resetpass-' . COOKIEHASH ] ), 2 ) ); // @codingStandardsIgnoreLine
+ $userdata = get_userdata( absint( $rp_id ) );
+ $rp_login = $userdata ? $userdata->user_login : '';
+ $user = self::check_password_reset_key( $rp_key, $rp_login );
// Reset key / login is correct, display reset password form with hidden key / login values.
if ( is_object( $user ) ) {
diff --git a/includes/shortcodes/class-wc-shortcode-products.php b/includes/shortcodes/class-wc-shortcode-products.php
index b4545504a4570..369eb346defeb 100644
--- a/includes/shortcodes/class-wc-shortcode-products.php
+++ b/includes/shortcodes/class-wc-shortcode-products.php
@@ -130,7 +130,9 @@ protected function parse_attributes( $attributes ) {
'page' => 1, // Page for pagination.
'paginate' => false, // Should results be paginated.
'cache' => true, // Should shortcode output be cached.
- ), $attributes, $this->type
+ ),
+ $attributes,
+ $this->type
);
if ( ! absint( $attributes['columns'] ) ) {
@@ -534,7 +536,7 @@ protected function get_wrapper_classes( $columns ) {
* @return string
*/
protected function get_transient_name() {
- $transient_name = 'wc_product_loop' . substr( md5( wp_json_encode( $this->query_args ) . $this->type ), 28 );
+ $transient_name = 'wc_product_loop_' . md5( wp_json_encode( $this->query_args ) . $this->type );
if ( 'rand' === $this->query_args['orderby'] ) {
// When using rand, we'll cache a number of random queries and pull those to avoid querying rand on each page load.
@@ -542,8 +544,6 @@ protected function get_transient_name() {
$transient_name .= $rand_index;
}
- $transient_name .= WC_Cache_Helper::get_transient_version( 'product_query' );
-
return $transient_name;
}
@@ -554,11 +554,14 @@ protected function get_transient_name() {
* @return object Object with the following props; ids, per_page, found_posts, max_num_pages, current_page
*/
protected function get_query_results() {
- $transient_name = $this->get_transient_name();
- $cache = wc_string_to_bool( $this->attributes['cache'] ) === true;
- $results = $cache ? get_transient( $transient_name ) : false;
+ $transient_name = $this->get_transient_name();
+ $transient_version = WC_Cache_Helper::get_transient_version( 'product_query' );
+ $cache = wc_string_to_bool( $this->attributes['cache'] ) === true;
+ $transient_value = $cache ? get_transient( $transient_name ) : false;
- if ( false === $results ) {
+ if ( isset( $transient_value['value'], $transient_value['version'] ) && $transient_value['version'] === $transient_version ) {
+ $results = $transient_value['value'];
+ } else {
if ( 'top_rated_products' === $this->type ) {
add_filter( 'posts_clauses', array( __CLASS__, 'order_by_rating_post_clauses' ) );
$query = new WP_Query( $this->query_args );
@@ -578,11 +581,17 @@ protected function get_query_results() {
);
if ( $cache ) {
- set_transient( $transient_name, $results, DAY_IN_SECONDS * 30 );
+ $transient_value = array(
+ 'version' => $transient_version,
+ 'value' => $results,
+ );
+ set_transient( $transient_name, $transient_value, DAY_IN_SECONDS * 30 );
}
}
+
// Remove ordering query arguments which may have been added by get_catalog_ordering_args.
WC()->query->remove_ordering_args();
+
return $results;
}
diff --git a/includes/wc-attribute-functions.php b/includes/wc-attribute-functions.php
index b4a3616f0c2a0..e77f8efe60f9b 100644
--- a/includes/wc-attribute-functions.php
+++ b/includes/wc-attribute-functions.php
@@ -94,10 +94,11 @@ function wc_attribute_taxonomy_name_by_id( $attribute_id ) {
$attribute_name = $wpdb->get_var(
$wpdb->prepare(
"
- SELECT attribute_name
- FROM {$wpdb->prefix}woocommerce_attribute_taxonomies
- WHERE attribute_id = %d
- ", $attribute_id
+ SELECT attribute_name
+ FROM {$wpdb->prefix}woocommerce_attribute_taxonomies
+ WHERE attribute_id = %d
+ ",
+ $attribute_id
)
);
@@ -116,7 +117,7 @@ function wc_attribute_taxonomy_name_by_id( $attribute_id ) {
* @return int
*/
function wc_attribute_taxonomy_id_by_name( $name ) {
- $name = str_replace( 'pa_', '', wc_sanitize_taxonomy_name( $name ) );
+ $name = wc_attribute_taxonomy_slug( $name );
$taxonomies = wp_list_pluck( wc_get_attribute_taxonomies(), 'attribute_id', 'attribute_name' );
return isset( $taxonomies[ $name ] ) ? (int) $taxonomies[ $name ] : 0;
@@ -131,7 +132,7 @@ function wc_attribute_taxonomy_id_by_name( $name ) {
*/
function wc_attribute_label( $name, $product = '' ) {
if ( taxonomy_is_product_attribute( $name ) ) {
- $name = wc_sanitize_taxonomy_name( str_replace( 'pa_', '', $name ) );
+ $name = wc_attribute_taxonomy_slug( $name );
$all_labels = wp_list_pluck( wc_get_attribute_taxonomies(), 'attribute_label', 'attribute_name' );
$label = isset( $all_labels[ $name ] ) ? $all_labels[ $name ] : $name;
} elseif ( $product ) {
@@ -166,7 +167,7 @@ function wc_attribute_label( $name, $product = '' ) {
function wc_attribute_orderby( $name ) {
global $wc_product_attributes, $wpdb;
- $name = str_replace( 'pa_', '', sanitize_title( $name ) );
+ $name = wc_attribute_taxonomy_slug( $name );
if ( isset( $wc_product_attributes[ 'pa_' . $name ] ) ) {
$orderby = $wc_product_attributes[ 'pa_' . $name ]->attribute_orderby;
@@ -201,7 +202,8 @@ function wc_get_attribute_taxonomy_names() {
*/
function wc_get_attribute_types() {
return (array) apply_filters(
- 'product_attributes_type_selector', array(
+ 'product_attributes_type_selector',
+ array(
'select' => __( 'Select', 'woocommerce' ),
)
);
@@ -382,10 +384,11 @@ function wc_get_attribute( $id ) {
$data = $wpdb->get_row(
$wpdb->prepare(
"
- SELECT *
- FROM {$wpdb->prefix}woocommerce_attribute_taxonomies
- WHERE attribute_id = %d
- ", $id
+ SELECT *
+ FROM {$wpdb->prefix}woocommerce_attribute_taxonomies
+ WHERE attribute_id = %d
+ ",
+ $id
)
);
@@ -543,7 +546,8 @@ function wc_create_attribute( $args ) {
"SELECT post_id, meta_value FROM {$wpdb->postmeta} WHERE meta_key = '_product_attributes' AND meta_value LIKE %s",
'%' . $wpdb->esc_like( $old_taxonomy_name ) . '%'
),
- ARRAY_A );
+ ARRAY_A
+ );
foreach ( $metadatas as $metadata ) {
$product_id = $metadata['post_id'];
$unserialized_data = maybe_unserialize( $metadata['meta_value'] );
@@ -554,7 +558,7 @@ function wc_create_attribute( $args ) {
$unserialized_data[ $new_taxonomy_name ] = $unserialized_data[ $old_taxonomy_name ];
unset( $unserialized_data[ $old_taxonomy_name ] );
$unserialized_data[ $new_taxonomy_name ]['name'] = $new_taxonomy_name;
- update_post_meta( $product_id, '_product_attributes', $unserialized_data );
+ update_post_meta( $product_id, '_product_attributes', wp_slash( $unserialized_data ) );
}
// Update variations which use this taxonomy.
@@ -600,7 +604,8 @@ function wc_update_attribute( $id, $args ) {
SELECT attribute_name
FROM {$wpdb->prefix}woocommerce_attribute_taxonomies
WHERE attribute_id = %d
- ", $args['id']
+ ",
+ $args['id']
)
);
@@ -620,10 +625,11 @@ function wc_delete_attribute( $id ) {
$name = $wpdb->get_var(
$wpdb->prepare(
"
- SELECT attribute_name
- FROM {$wpdb->prefix}woocommerce_attribute_taxonomies
- WHERE attribute_id = %d
- ", $id
+ SELECT attribute_name
+ FROM {$wpdb->prefix}woocommerce_attribute_taxonomies
+ WHERE attribute_id = %d
+ ",
+ $id
)
);
@@ -662,3 +668,26 @@ function wc_delete_attribute( $id ) {
return false;
}
+
+/**
+ * Get an unprefixed product attribute name.
+ *
+ * @since 3.6.0
+ *
+ * @param string $attribute_name Attribute name.
+ * @return string
+ */
+function wc_attribute_taxonomy_slug( $attribute_name ) {
+ $cache_key = 'slug-' . $attribute_name;
+ $cache_value = wp_cache_get( $cache_key, 'woocommerce-attributes' );
+
+ if ( $cache_value ) {
+ return $cache_value;
+ }
+
+ $attribute_name = wc_sanitize_taxonomy_name( $attribute_name );
+ $attribute_slug = 0 === strpos( $attribute_name, 'pa_' ) ? substr( $attribute_name, 3 ) : $attribute_name;
+ wp_cache_set( $cache_key, $attribute_slug, 'woocommerce-attributes' );
+
+ return $attribute_slug;
+}
diff --git a/includes/wc-cart-functions.php b/includes/wc-cart-functions.php
index 54bd1ec2aa60e..d06f981b4b721 100644
--- a/includes/wc-cart-functions.php
+++ b/includes/wc-cart-functions.php
@@ -107,7 +107,7 @@ function wc_add_to_cart_message( $products, $show_qty = false, $return = false )
foreach ( $products as $product_id => $qty ) {
/* translators: %s: product name */
- $titles[] = ( $qty > 1 ? absint( $qty ) . ' × ' : '' ) . apply_filters( 'woocommerce_add_to_cart_item_name_in_quotes', sprintf( _x( '“%s”', 'Item name in quotes', 'woocommerce' ), strip_tags( get_the_title( $product_id ) ) ), $product_id );
+ $titles[] = apply_filters( 'woocommerce_add_to_cart_qty_html', ( $qty > 1 ? absint( $qty ) . ' × ' : '' ), $product_id ) . apply_filters( 'woocommerce_add_to_cart_item_name_in_quotes', sprintf( _x( '“%s”', 'Item name in quotes', 'woocommerce' ), strip_tags( get_the_title( $product_id ) ) ), $product_id );
$count += $qty;
}
@@ -173,7 +173,7 @@ function wc_clear_cart_after_payment() {
if ( $order_id > 0 ) {
$order = wc_get_order( $order_id );
- if ( $order && $order->get_order_key() === $order_key ) {
+ if ( $order && hash_equals( $order->get_order_key(), $order_key ) ) {
WC()->cart->empty_cart();
}
}
@@ -203,7 +203,7 @@ function wc_cart_totals_subtotal_html() {
* Get shipping methods.
*/
function wc_cart_totals_shipping_html() {
- $packages = WC()->shipping->get_packages();
+ $packages = WC()->shipping()->get_packages();
$first = true;
foreach ( $packages as $i => $package ) {
@@ -218,7 +218,8 @@ function wc_cart_totals_shipping_html() {
}
wc_get_template(
- 'cart/cart-shipping.php', array(
+ 'cart/cart-shipping.php',
+ array(
'package' => $package,
'available_methods' => $package['rates'],
'show_package_details' => count( $packages ) > 1,
@@ -341,9 +342,11 @@ function wc_cart_totals_fee_html( $fee ) {
* @return string
*/
function wc_cart_totals_shipping_method_label( $method ) {
- $label = $method->get_label();
+ $label = $method->get_label();
+ $has_cost = 0 < $method->cost;
+ $hide_cost = ! $has_cost && in_array( $method->get_method_id(), array( 'free_shipping', 'local_pickup' ), true );
- if ( $method->cost >= 0 && $method->get_method_id() !== 'free_shipping' ) {
+ if ( $has_cost && ! $hide_cost ) {
if ( WC()->cart->display_prices_including_tax() ) {
$label .= ': ' . wc_price( $method->cost + $method->get_shipping_tax() );
if ( $method->get_shipping_tax() > 0 && ! wc_prices_include_tax() ) {
diff --git a/includes/wc-conditional-functions.php b/includes/wc-conditional-functions.php
index abd62d8b2c1ea..f2d281267dd93 100644
--- a/includes/wc-conditional-functions.php
+++ b/includes/wc-conditional-functions.php
@@ -418,3 +418,33 @@ function wc_post_content_has_shortcode( $tag = '' ) {
return is_singular() && is_a( $post, 'WP_Post' ) && has_shortcode( $post->post_content, $tag );
}
+
+/**
+ * Check if reviews are enabled.
+ *
+ * @since 3.6.0
+ * @return bool
+ */
+function wc_reviews_enabled() {
+ return 'yes' === get_option( 'woocommerce_enable_reviews' );
+}
+
+/**
+ * Check if reviews ratings are enabled.
+ *
+ * @since 3.6.0
+ * @return bool
+ */
+function wc_review_ratings_enabled() {
+ return wc_reviews_enabled() && 'yes' === get_option( 'woocommerce_enable_review_rating' );
+}
+
+/**
+ * Check if review ratings are required.
+ *
+ * @since 3.6.0
+ * @return bool
+ */
+function wc_review_ratings_required() {
+ return 'yes' === get_option( 'woocommerce_review_rating_required' );
+}
diff --git a/includes/wc-core-functions.php b/includes/wc-core-functions.php
index c2cf1c7e1bef7..f71667f350d10 100644
--- a/includes/wc-core-functions.php
+++ b/includes/wc-core-functions.php
@@ -43,6 +43,9 @@
/**
* Short Description (excerpt).
*/
+if ( function_exists( 'do_blocks' ) ) {
+ add_filter( 'woocommerce_short_description', 'do_blocks', 9 );
+}
add_filter( 'woocommerce_short_description', 'wptexturize' );
add_filter( 'woocommerce_short_description', 'convert_smilies' );
add_filter( 'woocommerce_short_description', 'convert_chars' );
@@ -154,21 +157,35 @@ function wc_update_order( $args ) {
* @param string $name Template name (default: '').
*/
function wc_get_template_part( $slug, $name = '' ) {
- $template = '';
+ $cache_key = sanitize_key( implode( '-', array( 'template-part', $slug, $name ) ) );
+ $template = (string) wp_cache_get( $cache_key, 'woocommerce' );
- // Look in yourtheme/slug-name.php and yourtheme/woocommerce/slug-name.php.
- if ( $name && ! WC_TEMPLATE_DEBUG_MODE ) {
- $template = locate_template( array( "{$slug}-{$name}.php", WC()->template_path() . "{$slug}-{$name}.php" ) );
- }
+ if ( ! $template ) {
+ if ( $name ) {
+ $template = WC_TEMPLATE_DEBUG_MODE ? '' : locate_template(
+ array(
+ "{$slug}-{$name}.php",
+ WC()->template_path() . "{$slug}-{$name}.php",
+ )
+ );
- // Get default slug-name.php.
- if ( ! $template && $name && file_exists( WC()->plugin_path() . "/templates/{$slug}-{$name}.php" ) ) {
- $template = WC()->plugin_path() . "/templates/{$slug}-{$name}.php";
- }
+ if ( ! $template ) {
+ $fallback = WC()->plugin_path() . "/templates/{$slug}-{$name}.php";
+ $template = file_exists( $fallback ) ? $fallback : '';
+ }
+ }
- // If template file doesn't exist, look in yourtheme/slug.php and yourtheme/woocommerce/slug.php.
- if ( ! $template && ! WC_TEMPLATE_DEBUG_MODE ) {
- $template = locate_template( array( "{$slug}.php", WC()->template_path() . "{$slug}.php" ) );
+ if ( ! $template ) {
+ // If template file doesn't exist, look in yourtheme/slug.php and yourtheme/woocommerce/slug.php.
+ $template = WC_TEMPLATE_DEBUG_MODE ? '' : locate_template(
+ array(
+ "{$slug}.php",
+ WC()->template_path() . "{$slug}.php",
+ )
+ );
+ }
+
+ wp_cache_set( $cache_key, $template, 'woocommerce' );
}
// Allow 3rd party plugins to filter template file from their plugin.
@@ -188,28 +205,43 @@ function wc_get_template_part( $slug, $name = '' ) {
* @param string $default_path Default path. (default: '').
*/
function wc_get_template( $template_name, $args = array(), $template_path = '', $default_path = '' ) {
- if ( ! empty( $args ) && is_array( $args ) ) {
- extract( $args ); // @codingStandardsIgnoreLine
+ $cache_key = sanitize_key( implode( '-', array( 'template', $template_name, $template_path, $default_path ) ) );
+ $template = (string) wp_cache_get( $cache_key, 'woocommerce' );
+
+ if ( ! $template ) {
+ $template = wc_locate_template( $template_name, $template_path, $default_path );
+ wp_cache_set( $cache_key, $template, 'woocommerce' );
}
- $located = wc_locate_template( $template_name, $template_path, $default_path );
+ // Allow 3rd party plugin filter template file from their plugin.
+ $filter_template = apply_filters( 'wc_get_template', $template, $template_name, $args, $template_path, $default_path );
- if ( ! file_exists( $located ) ) {
- /* translators: %s template */
- wc_doing_it_wrong( __FUNCTION__, sprintf( __( '%s does not exist.', 'woocommerce' ), '' . $located . '' ), '2.1' );
- return;
+ if ( $filter_template !== $template ) {
+ if ( ! file_exists( $filter_template ) ) {
+ /* translators: %s template */
+ wc_doing_it_wrong( __FUNCTION__, sprintf( __( '%s does not exist.', 'woocommerce' ), '' . $template . '' ), '2.1' );
+ return;
+ }
+ $template = $filter_template;
}
- // Allow 3rd party plugin filter template file from their plugin.
- $located = apply_filters( 'wc_get_template', $located, $template_name, $args, $template_path, $default_path );
+ $action_args = array(
+ 'template_name' => $template_name,
+ 'template_path' => $template_path,
+ 'located' => $template,
+ 'args' => $args,
+ );
- do_action( 'woocommerce_before_template_part', $template_name, $template_path, $located, $args );
+ if ( ! empty( $args ) && is_array( $args ) ) {
+ extract( $args ); // @codingStandardsIgnoreLine
+ }
- include $located;
+ do_action( 'woocommerce_before_template_part', $action_args['template_name'], $action_args['template_path'], $action_args['located'], $action_args['args'] );
- do_action( 'woocommerce_after_template_part', $template_name, $template_path, $located, $args );
-}
+ include $template;
+ do_action( 'woocommerce_after_template_part', $action_args['template_name'], $action_args['template_path'], $action_args['located'], $action_args['args'] );
+}
/**
* Like wc_get_template, but returns the HTML instead of outputting.
@@ -401,7 +433,7 @@ function get_woocommerce_currencies() {
'NZD' => __( 'New Zealand dollar', 'woocommerce' ),
'OMR' => __( 'Omani rial', 'woocommerce' ),
'PAB' => __( 'Panamanian balboa', 'woocommerce' ),
- 'PEN' => __( 'Peruvian nuevo sol', 'woocommerce' ),
+ 'PEN' => __( 'Sol', 'woocommerce' ),
'PGK' => __( 'Papua New Guinean kina', 'woocommerce' ),
'PHP' => __( 'Philippine peso', 'woocommerce' ),
'PKR' => __( 'Pakistani rupee', 'woocommerce' ),
@@ -442,6 +474,7 @@ function get_woocommerce_currencies() {
'UYU' => __( 'Uruguayan peso', 'woocommerce' ),
'UZS' => __( 'Uzbekistani som', 'woocommerce' ),
'VEF' => __( 'Venezuelan bolívar', 'woocommerce' ),
+ 'VES' => __( 'Bolívar soberano', 'woocommerce' ),
'VND' => __( 'Vietnamese đồng', 'woocommerce' ),
'VUV' => __( 'Vanuatu vatu', 'woocommerce' ),
'WST' => __( 'Samoan tālā', 'woocommerce' ),
@@ -586,7 +619,7 @@ function get_woocommerce_currency_symbol( $currency = '' ) {
'NZD' => '$',
'OMR' => 'ر.ع.',
'PAB' => 'B/.',
- 'PEN' => 'S/.',
+ 'PEN' => 'S/',
'PGK' => 'K',
'PHP' => '₱',
'PKR' => '₨',
@@ -628,6 +661,7 @@ function get_woocommerce_currency_symbol( $currency = '' ) {
'UYU' => '$',
'UZS' => 'UZS',
'VEF' => 'Bs F',
+ 'VES' => 'Bs.S',
'VND' => '₫',
'VUV' => 'Vt',
'WST' => 'T',
@@ -1068,7 +1102,7 @@ function wc_get_customer_default_location() {
$ua = strtolower( wc_get_user_agent() );
if ( ! strstr( $ua, 'bot' ) && ! strstr( $ua, 'spider' ) && ! strstr( $ua, 'crawl' ) ) {
- $location = WC_Geolocation::geolocate_ip( '', true, false );
+ $location = WC_Geolocation::geolocate_ip( '', false, false );
}
// Base fallback.
@@ -1285,7 +1319,7 @@ function wc_get_checkout_url() {
* @param string|object $shipping_method class name (string) or a class object.
*/
function woocommerce_register_shipping_method( $shipping_method ) {
- WC()->shipping->register_shipping_method( $shipping_method );
+ WC()->shipping()->register_shipping_method( $shipping_method );
}
if ( ! function_exists( 'wc_get_shipping_zone' ) ) {
@@ -1448,27 +1482,35 @@ function wc_postcode_location_matcher( $postcode, $objects, $object_id_key, $obj
function wc_get_shipping_method_count( $include_legacy = false ) {
global $wpdb;
- $transient_name = 'wc_shipping_method_count_' . ( $include_legacy ? 1 : 0 ) . '_' . WC_Cache_Helper::get_transient_version( 'shipping' );
- $method_count = get_transient( $transient_name );
+ $transient_name = $include_legacy ? 'wc_shipping_method_count_legacy' : 'wc_shipping_method_count';
+ $transient_version = WC_Cache_Helper::get_transient_version( 'shipping' );
+ $transient_value = get_transient( $transient_name );
- if ( false === $method_count ) {
- $method_count = absint( $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->prefix}woocommerce_shipping_zone_methods" ) );
+ if ( isset( $transient_value['value'], $transient_value['version'] ) && $transient_value['version'] === $transient_version ) {
+ return absint( $transient_value['value'] );
+ }
- if ( $include_legacy ) {
- // Count activated methods that don't support shipping zones.
- $methods = WC()->shipping->get_shipping_methods();
+ $method_count = absint( $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->prefix}woocommerce_shipping_zone_methods" ) );
- foreach ( $methods as $method ) {
- if ( isset( $method->enabled ) && 'yes' === $method->enabled && ! $method->supports( 'shipping-zones' ) ) {
- $method_count++;
- }
+ if ( $include_legacy ) {
+ // Count activated methods that don't support shipping zones.
+ $methods = WC()->shipping()->get_shipping_methods();
+
+ foreach ( $methods as $method ) {
+ if ( isset( $method->enabled ) && 'yes' === $method->enabled && ! $method->supports( 'shipping-zones' ) ) {
+ $method_count++;
}
}
-
- set_transient( $transient_name, $method_count, DAY_IN_SECONDS * 30 );
}
- return absint( $method_count );
+ $transient_value = array(
+ 'version' => $transient_version,
+ 'value' => $method_count,
+ );
+
+ set_transient( $transient_name, $transient_value, DAY_IN_SECONDS * 30 );
+
+ return $method_count;
}
/**
@@ -1553,6 +1595,21 @@ function wc_uasort_comparison( $a, $b ) {
return ( $a < $b ) ? -1 : 1;
}
+/**
+ * Sort values based on ascii, usefull for special chars in strings.
+ *
+ * @param string $a First value.
+ * @param string $b Second value.
+ * @return int
+ */
+function wc_ascii_uasort_comparison( $a, $b ) {
+ if ( function_exists( 'iconv' ) ) {
+ $a = iconv( 'UTF-8', 'ASCII//TRANSLIT', $a );
+ $b = iconv( 'UTF-8', 'ASCII//TRANSLIT', $b );
+ }
+ return strcmp( $a, $b );
+}
+
/**
* Get rounding mode for internal tax calculations.
*
diff --git a/includes/wc-coupon-functions.php b/includes/wc-coupon-functions.php
index b2e9950b5cd54..13fd7c0f9e34b 100644
--- a/includes/wc-coupon-functions.php
+++ b/includes/wc-coupon-functions.php
@@ -17,7 +17,8 @@
*/
function wc_get_coupon_types() {
return (array) apply_filters(
- 'woocommerce_coupon_discount_types', array(
+ 'woocommerce_coupon_discount_types',
+ array(
'percent' => __( 'Percentage discount', 'woocommerce' ),
'fixed_cart' => __( 'Fixed cart discount', 'woocommerce' ),
'fixed_product' => __( 'Fixed product discount', 'woocommerce' ),
@@ -77,7 +78,7 @@ function wc_coupons_enabled() {
*/
function wc_get_coupon_code_by_id( $id ) {
$data_store = WC_Data_Store::load( 'coupon' );
- return (string) $data_store->get_code_by_id( $id );
+ return empty( $id ) ? '' : (string) $data_store->get_code_by_id( $id );
}
/**
@@ -89,6 +90,11 @@ function wc_get_coupon_code_by_id( $id ) {
* @return int
*/
function wc_get_coupon_id_by_code( $code, $exclude = 0 ) {
+
+ if ( empty( $code ) ) {
+ return 0;
+ }
+
$data_store = WC_Data_Store::load( 'coupon' );
$ids = wp_cache_get( WC_Cache_Helper::get_cache_prefix( 'coupons' ) . 'coupon_id_from_code_' . $code, 'coupons' );
diff --git a/includes/wc-formatting-functions.php b/includes/wc-formatting-functions.php
index 9b363bac4b63a..fa9160df1e518 100644
--- a/includes/wc-formatting-functions.php
+++ b/includes/wc-formatting-functions.php
@@ -933,6 +933,9 @@ function wc_format_postcode( $postcode, $country ) {
case 'US':
$postcode = rtrim( substr_replace( $postcode, '-', 5, 0 ), '-' );
break;
+ case 'NL':
+ $postcode = substr_replace( $postcode, ' ', 4, 0 );
+ break;
}
return apply_filters( 'woocommerce_format_postcode', $postcode, $country );
diff --git a/includes/wc-order-functions.php b/includes/wc-order-functions.php
index 75ae8c08d3a21..0798dda5c1835 100644
--- a/includes/wc-order-functions.php
+++ b/includes/wc-order-functions.php
@@ -124,6 +124,16 @@ function wc_get_is_paid_statuses() {
return apply_filters( 'woocommerce_order_is_paid_statuses', array( 'processing', 'completed' ) );
}
+/**
+ * Get list of statuses which are consider 'pending payment'.
+ *
+ * @since 3.6.0
+ * @return array
+ */
+function wc_get_is_pending_statuses() {
+ return apply_filters( 'woocommerce_order_is_pending_statuses', array( 'pending' ) );
+}
+
/**
* Get the nice name for an order status.
*
@@ -138,6 +148,16 @@ function wc_get_order_status_name( $status ) {
return $status;
}
+/**
+ * Generate an order key.
+ *
+ * @since 3.5.4
+ * @return string The order key.
+ */
+function wc_generate_order_key() {
+ return 'wc_' . apply_filters( 'woocommerce_generate_order_key', 'order_' . wp_generate_password( 13, false ) );
+}
+
/**
* Finds an Order ID based on an order key.
*
@@ -294,7 +314,6 @@ function wc_register_order_type( $type, $args = array() ) {
/**
* Return the count of processing orders.
*
- * @access public
* @return int
*/
function wc_processing_order_count() {
@@ -501,6 +520,7 @@ function wc_create_refund( $args = array() ) {
$refund->set_amount( $args['amount'] );
$refund->set_parent_id( absint( $args['order_id'] ) );
$refund->set_refunded_by( get_current_user_id() ? get_current_user_id() : 1 );
+ $refund->set_prices_include_tax( $order->get_prices_include_tax() );
if ( ! is_null( $args['reason'] ) ) {
$refund->set_reason( $args['reason'] );
@@ -886,7 +906,7 @@ function wc_cancel_unpaid_orders() {
* @param int $order_id Order ID.
*/
function wc_sanitize_order_id( $order_id ) {
- return filter_var( $order_id, FILTER_SANITIZE_NUMBER_INT );
+ return (int) filter_var( $order_id, FILTER_SANITIZE_NUMBER_INT );
}
add_filter( 'woocommerce_shortcode_order_tracking_order_id', 'wc_sanitize_order_id' );
@@ -907,13 +927,15 @@ function wc_get_order_note( $data ) {
}
return (object) apply_filters(
- 'woocommerce_get_order_note', array(
+ 'woocommerce_get_order_note',
+ array(
'id' => (int) $data->comment_ID,
'date_created' => wc_string_to_datetime( $data->comment_date ),
'content' => $data->comment_content,
'customer_note' => (bool) get_comment_meta( $data->comment_ID, 'is_customer_note', true ),
'added_by' => __( 'WooCommerce', 'woocommerce' ) === $data->comment_author ? 'system' : $data->comment_author,
- ), $data
+ ),
+ $data
);
}
diff --git a/includes/wc-product-functions.php b/includes/wc-product-functions.php
index edede570e02d4..f0d9ba27e468f 100644
--- a/includes/wc-product-functions.php
+++ b/includes/wc-product-functions.php
@@ -92,56 +92,38 @@ function wc_product_dimensions_enabled() {
}
/**
- * Clear all transients cache for product data.
+ * Clear transient cache for product data.
*
- * @param int $post_id (default: 0).
+ * @param int $post_id (default: 0) The product ID.
*/
function wc_delete_product_transients( $post_id = 0 ) {
- // Core transients.
+ // Transient data to clear with a fixed name which may be stale after product updates.
$transients_to_clear = array(
'wc_products_onsale',
'wc_featured_products',
'wc_outofstock_count',
'wc_low_stock_count',
- 'wc_count_comments',
);
- // Transient names that include an ID.
- $post_transient_names = array(
- 'wc_product_children_',
- 'wc_var_prices_',
- 'wc_related_',
- 'wc_child_has_weight_',
- 'wc_child_has_dimensions_',
- );
+ foreach ( $transients_to_clear as $transient ) {
+ delete_transient( $transient );
+ }
if ( $post_id > 0 ) {
- foreach ( $post_transient_names as $transient ) {
- $transients_to_clear[] = $transient . $post_id;
- }
-
- // Does this product have a parent?
- $product = wc_get_product( $post_id );
-
- if ( $product ) {
- if ( $product->get_parent_id() > 0 ) {
- wc_delete_product_transients( $product->get_parent_id() );
- }
+ // Transient names that include an ID - since they are dynamic they cannot be cleaned in bulk without the ID.
+ $post_transient_names = array(
+ 'wc_product_children_',
+ 'wc_var_prices_',
+ 'wc_related_',
+ 'wc_child_has_weight_',
+ 'wc_child_has_dimensions_',
+ );
- if ( 'variable' === $product->get_type() ) {
- wp_cache_delete(
- WC_Cache_Helper::get_cache_prefix( 'products' ) . 'product_variation_attributes_' . $product->get_id(),
- 'products'
- );
- }
+ foreach ( $post_transient_names as $transient ) {
+ delete_transient( $transient . $post_id );
}
}
- // Delete transients.
- foreach ( $transients_to_clear as $transient ) {
- delete_transient( $transient );
- }
-
// Increments the transient version to invalidate cache.
WC_Cache_Helper::get_transient_version( 'product', true );
@@ -220,13 +202,14 @@ function wc_product_post_type_link( $permalink, $post ) {
$terms = get_the_terms( $post->ID, 'product_cat' );
if ( ! empty( $terms ) ) {
- if ( function_exists( 'wp_list_sort' ) ) {
- $terms = wp_list_sort( $terms, 'term_id', 'ASC' );
- } else {
- usort( $terms, '_usort_terms_by_ID' );
- }
+ $terms = wp_list_sort(
+ $terms,
+ array(
+ 'parent' => 'DESC',
+ 'term_id' => 'ASC',
+ )
+ );
$category_object = apply_filters( 'wc_product_post_type_link_product_cat', $terms[0], $terms, $post );
- $category_object = get_term( $category_object, 'product_cat' );
$product_cat = $category_object->slug;
if ( $category_object->parent ) {
@@ -271,11 +254,10 @@ function wc_product_post_type_link( $permalink, $post ) {
}
add_filter( 'post_type_link', 'wc_product_post_type_link', 10, 2 );
-
/**
- * Get the placeholder image URL for products etc.
+ * Get the placeholder image URL either from media, or use the fallback image.
*
- * @param string $size Image size.
+ * @param string $size Thumbnail size to use.
* @return string
*/
function wc_placeholder_img_src( $size = 'woocommerce_thumbnail' ) {
@@ -284,7 +266,7 @@ function wc_placeholder_img_src( $size = 'woocommerce_thumbnail' ) {
if ( ! empty( $placeholder_image ) ) {
if ( is_numeric( $placeholder_image ) ) {
- $image = wp_get_attachment_image_src( $placeholder_image, $size );
+ $image = wp_get_attachment_image_src( $placeholder_image, $size );
if ( ! empty( $image[0] ) ) {
$src = $image[0];
@@ -300,13 +282,31 @@ function wc_placeholder_img_src( $size = 'woocommerce_thumbnail' ) {
/**
* Get the placeholder image.
*
+ * Uses wp_get_attachment_image if using an attachment ID @since 3.6.0 to handle responsiveness.
+ *
* @param string $size Image size.
* @return string
*/
function wc_placeholder_img( $size = 'woocommerce_thumbnail' ) {
- $dimensions = wc_get_image_size( $size );
+ $dimensions = wc_get_image_size( $size );
+ $placeholder_image = get_option( 'woocommerce_placeholder_image', 0 );
+
+ if ( wp_attachment_is_image( $placeholder_image ) ) {
+ $image_html = wp_get_attachment_image(
+ $placeholder_image,
+ $size,
+ false,
+ array(
+ 'alt' => __( 'Placeholder', 'woocommerce' ),
+ 'class' => 'woocommerce-placeholder wp-post-image',
+ )
+ );
+ } else {
+ $image = wc_placeholder_img_src( $size );
+ $image_html = '';
+ }
- return apply_filters( 'woocommerce_placeholder_img', '', $size, $dimensions );
+ return apply_filters( 'woocommerce_placeholder_img', $image_html, $size, $dimensions );
}
/**
@@ -530,7 +530,8 @@ function wc_track_product_view() {
*/
function wc_get_product_types() {
return (array) apply_filters(
- 'product_type_selector', array(
+ 'product_type_selector',
+ array(
'simple' => __( 'Simple product', 'woocommerce' ),
'grouped' => __( 'Grouped product', 'woocommerce' ),
'external' => __( 'External/Affiliate product', 'woocommerce' ),
@@ -766,7 +767,8 @@ function wc_get_product_attachment_props( $attachment_id = null, $product = fals
*/
function wc_get_product_visibility_options() {
return apply_filters(
- 'woocommerce_product_visibility_options', array(
+ 'woocommerce_product_visibility_options',
+ array(
'visible' => __( 'Shop and search results', 'woocommerce' ),
'catalog' => __( 'Shop only', 'woocommerce' ),
'search' => __( 'Search results only', 'woocommerce' ),
@@ -808,11 +810,15 @@ function wc_get_min_max_price_meta_query( $args ) {
$max = $class_max;
}
- return array(
- 'key' => '_price',
- 'value' => array( $min, $max ),
- 'compare' => 'BETWEEN',
- 'type' => 'DECIMAL(10,' . wc_get_price_decimals() . ')',
+ return apply_filters(
+ 'woocommerce_get_min_max_price_meta_query',
+ array(
+ 'key' => '_price',
+ 'value' => array( $min, $max ),
+ 'compare' => 'BETWEEN',
+ 'type' => 'DECIMAL(10,' . wc_get_price_decimals() . ')',
+ ),
+ $args
);
}
@@ -912,7 +918,10 @@ function wc_get_related_products( $product_id, $limit = 5, $exclude_ids = array(
}
$related_posts = apply_filters(
- 'woocommerce_related_products', $related_posts, $product_id, array(
+ 'woocommerce_related_products',
+ $related_posts,
+ $product_id,
+ array(
'limit' => $limit,
'excluded_ids' => $exclude_ids,
)
@@ -946,7 +955,8 @@ function wc_get_product_term_ids( $product_id, $taxonomy ) {
*/
function wc_get_price_including_tax( $product, $args = array() ) {
$args = wp_parse_args(
- $args, array(
+ $args,
+ array(
'qty' => '',
'price' => '',
)
@@ -966,10 +976,16 @@ function wc_get_price_including_tax( $product, $args = array() ) {
if ( $product->is_taxable() ) {
if ( ! wc_prices_include_tax() ) {
- $tax_rates = WC_Tax::get_rates( $product->get_tax_class() );
- $taxes = WC_Tax::calc_tax( $line_price, $tax_rates, false );
- $tax_amount = WC_Tax::get_tax_total( $taxes );
- $return_price = round( $line_price + $tax_amount, wc_get_price_decimals() );
+ $tax_rates = WC_Tax::get_rates( $product->get_tax_class() );
+ $taxes = WC_Tax::calc_tax( $line_price, $tax_rates, false );
+
+ if ( 'yes' === get_option( 'woocommerce_tax_round_at_subtotal' ) ) {
+ $taxes_total = array_sum( $taxes );
+ } else {
+ $taxes_total = array_sum( array_map( 'wc_round_tax_total', $taxes ) );
+ }
+
+ $return_price = round( $line_price + $taxes_total, wc_get_price_decimals() );
} else {
$tax_rates = WC_Tax::get_rates( $product->get_tax_class() );
$base_tax_rates = WC_Tax::get_base_tax_rates( $product->get_tax_class( 'unfiltered' ) );
@@ -980,8 +996,14 @@ function wc_get_price_including_tax( $product, $args = array() ) {
*/
if ( ! empty( WC()->customer ) && WC()->customer->get_is_vat_exempt() ) { // @codingStandardsIgnoreLine.
$remove_taxes = apply_filters( 'woocommerce_adjust_non_base_location_prices', true ) ? WC_Tax::calc_tax( $line_price, $base_tax_rates, true ) : WC_Tax::calc_tax( $line_price, $tax_rates, true );
- $remove_tax = array_sum( $remove_taxes );
- $return_price = round( $line_price - $remove_tax, wc_get_price_decimals() );
+
+ if ( 'yes' === get_option( 'woocommerce_tax_round_at_subtotal' ) ) {
+ $remove_taxes_total = array_sum( $remove_taxes );
+ } else {
+ $remove_taxes_total = array_sum( array_map( 'wc_round_tax_total', $remove_taxes ) );
+ }
+
+ $return_price = round( $line_price - $remove_taxes_total, wc_get_price_decimals() );
/**
* The woocommerce_adjust_non_base_location_prices filter can stop base taxes being taken off when dealing with out of base locations.
@@ -991,7 +1013,16 @@ function wc_get_price_including_tax( $product, $args = array() ) {
} elseif ( $tax_rates !== $base_tax_rates && apply_filters( 'woocommerce_adjust_non_base_location_prices', true ) ) {
$base_taxes = WC_Tax::calc_tax( $line_price, $base_tax_rates, true );
$modded_taxes = WC_Tax::calc_tax( $line_price - array_sum( $base_taxes ), $tax_rates, false );
- $return_price = round( $line_price - array_sum( $base_taxes ) + wc_round_tax_total( array_sum( $modded_taxes ), wc_get_price_decimals() ), wc_get_price_decimals() );
+
+ if ( 'yes' === get_option( 'woocommerce_tax_round_at_subtotal' ) ) {
+ $base_taxes_total = array_sum( $base_taxes );
+ $modded_taxes_total = array_sum( $modded_taxes );
+ } else {
+ $base_taxes_total = array_sum( array_map( 'wc_round_tax_total', $base_taxes ) );
+ $modded_taxes_total = array_sum( array_map( 'wc_round_tax_total', $modded_taxes ) );
+ }
+
+ $return_price = round( $line_price - $base_taxes_total + $modded_taxes_total, wc_get_price_decimals() );
}
}
}
@@ -1008,7 +1039,8 @@ function wc_get_price_including_tax( $product, $args = array() ) {
*/
function wc_get_price_excluding_tax( $product, $args = array() ) {
$args = wp_parse_args(
- $args, array(
+ $args,
+ array(
'qty' => '',
'price' => '',
)
@@ -1029,7 +1061,7 @@ function wc_get_price_excluding_tax( $product, $args = array() ) {
$tax_rates = WC_Tax::get_rates( $product->get_tax_class() );
$base_tax_rates = WC_Tax::get_base_tax_rates( $product->get_tax_class( 'unfiltered' ) );
$remove_taxes = apply_filters( 'woocommerce_adjust_non_base_location_prices', true ) ? WC_Tax::calc_tax( $line_price, $base_tax_rates, true ) : WC_Tax::calc_tax( $line_price, $tax_rates, true );
- $return_price = $line_price - array_sum( $remove_taxes );
+ $return_price = $line_price - array_sum( $remove_taxes ); // Unrounded since we're dealing with tax inclusive prices. Matches logic in cart-totals class. @see adjust_non_base_location_price.
} else {
$return_price = $line_price;
}
@@ -1047,7 +1079,8 @@ function wc_get_price_excluding_tax( $product, $args = array() ) {
*/
function wc_get_price_to_display( $product, $args = array() ) {
$args = wp_parse_args(
- $args, array(
+ $args,
+ array(
'qty' => 1,
'price' => $product->get_price(),
)
@@ -1058,13 +1091,15 @@ function wc_get_price_to_display( $product, $args = array() ) {
return 'incl' === get_option( 'woocommerce_tax_display_shop' ) ?
wc_get_price_including_tax(
- $product, array(
+ $product,
+ array(
'qty' => $qty,
'price' => $price,
)
) :
wc_get_price_excluding_tax(
- $product, array(
+ $product,
+ array(
'qty' => $qty,
'price' => $price,
)
diff --git a/includes/wc-rest-functions.php b/includes/wc-rest-functions.php
index 00bf6144457fd..7bc918849f139 100644
--- a/includes/wc-rest-functions.php
+++ b/includes/wc-rest-functions.php
@@ -65,7 +65,6 @@ function wc_rest_allowed_image_mime_types() {
* @return array|WP_Error Attachment data or error message.
*/
function wc_rest_upload_image_from_url( $image_url ) {
- $file_name = basename( current( explode( '?', $image_url ) ) );
$parsed_url = wp_parse_url( $image_url );
// Check parsed URL.
@@ -77,68 +76,47 @@ function wc_rest_upload_image_from_url( $image_url ) {
// Ensure url is valid.
$image_url = esc_url_raw( $image_url );
- // Get the file.
- $response = wp_safe_remote_get(
- $image_url, array(
- 'timeout' => 10,
- )
- );
+ // download_url function is part of wp-admin.
+ if ( ! function_exists( 'download_url' ) ) {
+ include_once ABSPATH . 'wp-admin/includes/file.php';
+ }
+
+ $file_array = array();
+ $file_array['name'] = basename( current( explode( '?', $image_url ) ) );
- if ( is_wp_error( $response ) ) {
+ // Download file to temp location.
+ $file_array['tmp_name'] = download_url( $image_url );
+
+ // If error storing temporarily, return the error.
+ if ( is_wp_error( $file_array['tmp_name'] ) ) {
return new WP_Error( 'woocommerce_rest_invalid_remote_image_url',
/* translators: %s: image URL */
sprintf( __( 'Error getting remote image %s.', 'woocommerce' ), $image_url ) . ' '
/* translators: %s: error message */
- . sprintf( __( 'Error: %s.', 'woocommerce' ), $response->get_error_message() ), array( 'status' => 400 )
+ . sprintf( __( 'Error: %s', 'woocommerce' ), $file_array['tmp_name']->get_error_message() ), array( 'status' => 400 )
);
- } elseif ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
- /* translators: %s: image URL */
- return new WP_Error( 'woocommerce_rest_invalid_remote_image_url', sprintf( __( 'Error getting remote image %s.', 'woocommerce' ), $image_url ), array( 'status' => 400 ) );
- }
-
- // Ensure we have a file name and type.
- $wp_filetype = wp_check_filetype( $file_name, wc_rest_allowed_image_mime_types() );
-
- if ( ! $wp_filetype['type'] ) {
- $headers = wp_remote_retrieve_headers( $response );
- if ( isset( $headers['content-disposition'] ) && strstr( $headers['content-disposition'], 'filename=' ) ) {
- $content = explode( 'filename=', $headers['content-disposition'] );
- $disposition = end( $content );
- $disposition = sanitize_file_name( $disposition );
- $file_name = $disposition;
- } elseif ( isset( $headers['content-type'] ) && strstr( $headers['content-type'], 'image/' ) ) {
- $file_name = 'image.' . str_replace( 'image/', '', $headers['content-type'] );
- }
- unset( $headers );
-
- // Recheck filetype.
- $wp_filetype = wp_check_filetype( $file_name, wc_rest_allowed_image_mime_types() );
-
- if ( ! $wp_filetype['type'] ) {
- return new WP_Error( 'woocommerce_rest_invalid_image_type', __( 'Invalid image type.', 'woocommerce' ), array( 'status' => 400 ) );
- }
}
- // Upload the file.
- $upload = wp_upload_bits( $file_name, '', wp_remote_retrieve_body( $response ) );
-
- if ( $upload['error'] ) {
- return new WP_Error( 'woocommerce_rest_image_upload_error', $upload['error'], array( 'status' => 400 ) );
- }
-
- // Get filesize.
- $filesize = filesize( $upload['file'] );
+ // Do the validation and storage stuff.
+ $file = wp_handle_sideload(
+ $file_array,
+ array(
+ 'test_form' => false,
+ 'mimes' => wc_rest_allowed_image_mime_types(),
+ ),
+ current_time( 'Y/m' )
+ );
- if ( ! $filesize ) {
- @unlink( $upload['file'] ); // @codingStandardsIgnoreLine
- unset( $upload );
+ if ( isset( $file['error'] ) ) {
+ @unlink( $file_array['tmp_name'] ); // @codingStandardsIgnoreLine.
- return new WP_Error( 'woocommerce_rest_image_upload_file_error', __( 'Zero size file downloaded.', 'woocommerce' ), array( 'status' => 400 ) );
+ /* translators: %s: error message */
+ return new WP_Error( 'woocommerce_rest_invalid_image', sprintf( __( 'Invalid image: %s', 'woocommerce' ), $file['error'] ), array( 'status' => 400 ) );
}
- do_action( 'woocommerce_rest_api_uploaded_image_from_url', $upload, $image_url );
+ do_action( 'woocommerce_rest_api_uploaded_image_from_url', $file, $image_url );
- return $upload;
+ return $file;
}
/**
diff --git a/includes/wc-stock-functions.php b/includes/wc-stock-functions.php
index 0e1eb39dbcb36..344fa0f7d730d 100644
--- a/includes/wc-stock-functions.php
+++ b/includes/wc-stock-functions.php
@@ -310,7 +310,7 @@ function wc_get_held_stock_quantity( $product, $exclude_order_id = 0 ) {
AND posts.post_type IN ( '" . implode( "','", wc_get_order_types() ) . "' )
AND posts.post_status = 'wc-pending'
AND posts.ID != %d;",
- 'variation' === get_post_type( $product->get_stock_managed_by_id() ) ? '_variation_id' : '_product_id',
+ 'product_variation' === get_post_type( $product->get_stock_managed_by_id() ) ? '_variation_id' : '_product_id',
$product->get_stock_managed_by_id(),
$exclude_order_id
)
diff --git a/includes/wc-template-functions.php b/includes/wc-template-functions.php
index 9cdd5087f2c5c..3dfd826902e06 100644
--- a/includes/wc-template-functions.php
+++ b/includes/wc-template-functions.php
@@ -16,54 +16,58 @@
function wc_template_redirect() {
global $wp_query, $wp;
+ // When default permalinks are enabled, redirect shop page to post type archive url.
if ( ! empty( $_GET['page_id'] ) && '' === get_option( 'permalink_structure' ) && wc_get_page_id( 'shop' ) === absint( $_GET['page_id'] ) && get_post_type_archive_link( 'product' ) ) { // WPCS: input var ok, CSRF ok.
-
- // When default permalinks are enabled, redirect shop page to post type archive url.
wp_safe_redirect( get_post_type_archive_link( 'product' ) );
exit;
+ }
- } elseif ( is_page( wc_get_page_id( 'checkout' ) ) && wc_get_page_id( 'checkout' ) !== wc_get_page_id( 'cart' ) && WC()->cart->is_empty() && empty( $wp->query_vars['order-pay'] ) && ! isset( $wp->query_vars['order-received'] ) && ! is_customize_preview() && apply_filters( 'woocommerce_checkout_redirect_empty_cart', true ) ) {
-
- // When on the checkout with an empty cart, redirect to cart page.
+ // When on the checkout with an empty cart, redirect to cart page.
+ if ( is_page( wc_get_page_id( 'checkout' ) ) && wc_get_page_id( 'checkout' ) !== wc_get_page_id( 'cart' ) && WC()->cart->is_empty() && empty( $wp->query_vars['order-pay'] ) && ! isset( $wp->query_vars['order-received'] ) && ! is_customize_preview() && apply_filters( 'woocommerce_checkout_redirect_empty_cart', true ) ) {
wc_add_notice( __( 'Checkout is not available whilst your cart is empty.', 'woocommerce' ), 'notice' );
wp_safe_redirect( wc_get_page_permalink( 'cart' ) );
exit;
- } elseif ( isset( $wp->query_vars['customer-logout'] ) && ! empty( $_REQUEST['_wpnonce'] ) && wp_verify_nonce( sanitize_key( $_REQUEST['_wpnonce'] ), 'customer-logout' ) ) { // WPCS: input var ok, CSRF ok.
+ }
- // Logout.
+ // Logout.
+ if ( isset( $wp->query_vars['customer-logout'] ) && ! empty( $_REQUEST['_wpnonce'] ) && wp_verify_nonce( sanitize_key( $_REQUEST['_wpnonce'] ), 'customer-logout' ) ) { // WPCS: input var ok, CSRF ok.
wp_safe_redirect( str_replace( '&', '&', wp_logout_url( wc_get_page_permalink( 'myaccount' ) ) ) );
exit;
+ }
- } elseif ( isset( $wp->query_vars['customer-logout'] ) && 'true' === $wp->query_vars['customer-logout'] ) {
- // Redirect to the correct logout endpoint.
+ // Redirect to the correct logout endpoint.
+ if ( isset( $wp->query_vars['customer-logout'] ) && 'true' === $wp->query_vars['customer-logout'] ) {
wp_safe_redirect( esc_url_raw( wc_get_account_endpoint_url( 'customer-logout' ) ) );
exit;
+ }
- } elseif ( is_search() && is_post_type_archive( 'product' ) && apply_filters( 'woocommerce_redirect_single_search_result', true ) && 1 === absint( $wp_query->found_posts ) ) {
+ // Trigger 404 if trying to access an endpoint on wrong page.
+ if ( is_wc_endpoint_url() && ! is_account_page() && ! is_checkout() ) {
+ $wp_query->set_404();
+ status_header( 404 );
+ include( get_query_template( '404' ) );
+ exit;
+ }
- // Redirect to the product page if we have a single product.
+ // Redirect to the product page if we have a single product.
+ if ( is_search() && is_post_type_archive( 'product' ) && apply_filters( 'woocommerce_redirect_single_search_result', true ) && 1 === absint( $wp_query->found_posts ) ) {
$product = wc_get_product( $wp_query->post );
if ( $product && $product->is_visible() ) {
wp_safe_redirect( get_permalink( $product->get_id() ), 302 );
exit;
}
- } elseif ( is_add_payment_method_page() ) {
-
- // Ensure payment gateways are loaded early.
- WC()->payment_gateways();
-
- } elseif ( is_checkout() ) {
+ }
- // Checkout pages handling
+ // Ensure gateways and shipping methods are loaded early.
+ if ( is_add_payment_method_page() || is_checkout() ) {
// Buffer the checkout page.
ob_start();
// Ensure gateways and shipping methods are loaded early.
WC()->payment_gateways();
WC()->shipping();
-
}
}
add_action( 'template_redirect', 'wc_template_redirect' );
@@ -165,14 +169,17 @@ function wc_setup_loop( $args = array() ) {
// If this is a main WC query, use global args as defaults.
if ( $GLOBALS['wp_query']->get( 'wc_query' ) ) {
- $default_args = array_merge( $default_args, array(
- 'is_search' => $GLOBALS['wp_query']->is_search(),
- 'is_filtered' => is_filtered(),
- 'total' => $GLOBALS['wp_query']->found_posts,
- 'total_pages' => $GLOBALS['wp_query']->max_num_pages,
- 'per_page' => $GLOBALS['wp_query']->get( 'posts_per_page' ),
- 'current_page' => max( 1, $GLOBALS['wp_query']->get( 'paged', 1 ) ),
- ) );
+ $default_args = array_merge(
+ $default_args,
+ array(
+ 'is_search' => $GLOBALS['wp_query']->is_search(),
+ 'is_filtered' => is_filtered(),
+ 'total' => $GLOBALS['wp_query']->found_posts,
+ 'total_pages' => $GLOBALS['wp_query']->max_num_pages,
+ 'per_page' => $GLOBALS['wp_query']->get( 'posts_per_page' ),
+ 'current_page' => max( 1, $GLOBALS['wp_query']->get( 'paged', 1 ) ),
+ )
+ );
}
// Merge any existing values.
@@ -395,6 +402,8 @@ function wc_reset_product_grid_settings() {
if ( ! empty( $product_grid['default_columns'] ) ) {
update_option( 'woocommerce_catalog_columns', absint( $product_grid['default_columns'] ) );
}
+
+ wp_cache_flush(); // Flush any caches which could impact settings or templates.
}
add_action( 'after_switch_theme', 'wc_reset_product_grid_settings' );
@@ -491,10 +500,8 @@ function wc_product_post_class( $classes, $class = '', $post_id = 0 ) {
if ( $product->get_type() ) {
$classes[] = 'product-type-' . $product->get_type();
}
- if ( $product->is_type( 'variable' ) ) {
- if ( ! $product->get_default_attributes() ) {
- $classes[] = 'has-default-attributes';
- }
+ if ( $product->is_type( 'variable' ) && $product->get_default_attributes() ) {
+ $classes[] = 'has-default-attributes';
}
}
@@ -543,7 +550,11 @@ function wc_get_product_taxonomy_class( $term_ids, $taxonomy ) {
/**
* Retrieves the classes for the post div as an array.
*
- * This method is clone from WordPress's get_post_class(), allowing removing taxonomies.
+ * This method was modified from WordPress's get_post_class() to allow the removal of taxonomies
+ * (for performance reasons).
+ *
+ * Previously wc_product_post_class was hooked into post_class. That still happens, but this function
+ * negates the need for it and thus unhooks it when running the post_class hook. @since 3.6.0
*
* @since 3.4.0
* @param string|array $class One or more classes to add to the class list.
@@ -554,87 +565,96 @@ function wc_get_product_class( $class = '', $product_id = null ) {
if ( is_a( $product_id, 'WC_Product' ) ) {
$product = $product_id;
$product_id = $product_id->get_id();
- $post = get_post( $product_id );
} else {
- $post = get_post( $product_id );
- $product = wc_get_product( $post->ID );
+ $product = wc_get_product( $product_id );
}
- $classes = array();
-
- if ( $class ) {
- if ( ! is_array( $class ) ) {
- $class = preg_split( '#\s+#', $class );
- }
- $classes = array_map( 'esc_attr', $class );
+ if ( ! is_array( $class ) ) {
+ $classes = preg_split( '#\s+#', $class );
} else {
- // Ensure that we always coerce class to being an array.
- $class = array();
- }
-
- if ( ! $post || ! $product ) {
- return $classes;
+ $classes = $class;
}
- $classes[] = 'post-' . $post->ID;
- if ( ! is_admin() ) {
- $classes[] = $post->post_type;
+ if ( ! $product ) {
+ return array_map( 'esc_attr', $classes );
}
- $classes[] = 'type-' . $post->post_type;
- $classes[] = 'status-' . $post->post_status;
- // Post format.
- if ( post_type_supports( $post->post_type, 'post-formats' ) ) {
- $post_format = get_post_format( $post->ID );
+ $classes = array_merge(
+ $classes,
+ array(
+ 'product',
+ 'type-product',
+ 'post-' . $product->get_id(),
+ 'status-' . $product->get_status(),
+ wc_get_loop_class(),
+ $product->get_stock_status(),
+ ),
+ wc_get_product_taxonomy_class( $product->get_category_ids(), 'product_cat' ),
+ wc_get_product_taxonomy_class( $product->get_tag_ids(), 'product_tag' )
+ );
- if ( $post_format && ! is_wp_error( $post_format ) ) {
- $classes[] = 'format-' . sanitize_html_class( $post_format );
- } else {
- $classes[] = 'format-standard';
- }
+ if ( $product->get_image_id() ) {
+ $classes[] = 'has-post-thumbnail';
}
-
- // Post requires password.
- $post_password_required = post_password_required( $post->ID );
- if ( $post_password_required ) {
- $classes[] = 'post-password-required';
- } elseif ( ! empty( $post->post_password ) ) {
- $classes[] = 'post-password-protected';
+ if ( $product->get_post_password() ) {
+ $classes[] = post_password_required( $product->get_id() ) ? 'post-password-required' : 'post-password-protected';
}
-
- // Post thumbnails.
- if ( current_theme_supports( 'post-thumbnails' ) && $product->get_image_id() && ! is_attachment( $post ) && ! $post_password_required ) {
- $classes[] = 'has-post-thumbnail';
+ if ( $product->is_on_sale() ) {
+ $classes[] = 'sale';
}
-
- // Sticky for Sticky Posts.
- if ( is_sticky( $post->ID ) ) {
- if ( is_home() && ! is_paged() ) {
- $classes[] = 'sticky';
- } elseif ( is_admin() ) {
- $classes[] = 'status-sticky';
- }
+ if ( $product->is_featured() ) {
+ $classes[] = 'featured';
+ }
+ if ( $product->is_downloadable() ) {
+ $classes[] = 'downloadable';
+ }
+ if ( $product->is_virtual() ) {
+ $classes[] = 'virtual';
+ }
+ if ( $product->is_sold_individually() ) {
+ $classes[] = 'sold-individually';
+ }
+ if ( $product->is_taxable() ) {
+ $classes[] = 'taxable';
+ }
+ if ( $product->is_shipping_taxable() ) {
+ $classes[] = 'shipping-taxable';
+ }
+ if ( $product->is_purchasable() ) {
+ $classes[] = 'purchasable';
+ }
+ if ( $product->get_type() ) {
+ $classes[] = 'product-type-' . $product->get_type();
+ }
+ if ( $product->is_type( 'variable' ) && $product->get_default_attributes() ) {
+ $classes[] = 'has-default-attributes';
}
- // Hentry for hAtom compliance.
- $classes[] = 'hentry';
-
- // Include attributes and any extra taxonomy.
+ // Include attributes and any extra taxonomies only if enabled via the hook - this is a performance issue.
if ( apply_filters( 'woocommerce_get_product_class_include_taxonomies', false ) ) {
$taxonomies = get_taxonomies( array( 'public' => true ) );
+ $type = 'variation' === $product->get_type() ? 'product_variation' : 'product';
foreach ( (array) $taxonomies as $taxonomy ) {
- if ( is_object_in_taxonomy( $post->post_type, $taxonomy ) && ! in_array( $taxonomy, array( 'product_cat', 'product_tag' ), true ) ) {
- $classes = array_merge( $classes, wc_get_product_taxonomy_class( (array) get_the_terms( $post->ID, $taxonomy ), $taxonomy ) );
+ if ( is_object_in_taxonomy( $type, $taxonomy ) && ! in_array( $taxonomy, array( 'product_cat', 'product_tag' ), true ) ) {
+ $classes = array_merge( $classes, wc_get_product_taxonomy_class( (array) get_the_terms( $product->get_id(), $taxonomy ), $taxonomy ) );
}
}
}
- // Categories.
- $classes = array_merge( $classes, wc_get_product_taxonomy_class( $product->get_category_ids(), 'product_cat' ) );
- // Tags.
- $classes = array_merge( $classes, wc_get_product_taxonomy_class( $product->get_tag_ids(), 'product_tag' ) );
+ // If using `wc_get_product_class` instead of `get_post_class`, we don't need to hook `wc_product_post_class` function.
+ $filtered = has_filter( 'post_class', 'wc_product_post_class' );
+
+ if ( $filtered ) {
+ remove_filter( 'post_class', 'wc_product_post_class', 20, 3 );
+ }
+
+ $classes = apply_filters( 'post_class', $classes, $class, $product->get_id() );
- return array_filter( array_unique( apply_filters( 'post_class', $classes, $class, $post->ID ) ) );
+ if ( $filtered ) {
+ add_filter( 'post_class', 'wc_product_post_class', 20, 3 );
+ }
+
+ return array_filter( array_map( 'esc_attr', array_unique( $classes ) ) );
}
/**
@@ -903,13 +923,10 @@ function woocommerce_content() {
-
-
-
-
- ' . wp_kses_post( $notice ) . ' ' . esc_html__( 'Dismiss', 'woocommerce' ) . '', $notice ); // WPCS: XSS ok.
+ $notice_id = md5( $notice );
+
+ echo apply_filters( 'woocommerce_demo_store', '
', $notice ); // WPCS: XSS ok.
}
}
@@ -1063,7 +1082,7 @@ function woocommerce_product_loop_end( $echo = true ) {
* Show the product title in the product loop. By default this is an H2.
*/
function woocommerce_template_loop_product_title() {
- echo '
->plugin_url() . '/assets/images/icons/credit-cards/visa.svg' ) . '){kind=icon}
';
- $icon .= '->plugin_url() . '/assets/images/icons/credit-cards/mastercard.svg' ) . '){kind=icon}
';
- $icon .= '->plugin_url() . '/assets/images/icons/credit-cards/discover.svg' ) . '){kind=icon}
';
- $icon .= '->plugin_url() . '/assets/images/icons/credit-cards/amex.svg' ) . '){kind=icon}
';
- $icon .= '->plugin_url() . '/assets/images/icons/credit-cards/jcb.svg' ) . '){kind=icon}
';
-
- return apply_filters( 'woocommerce_gateway_icon', $icon, $this->id );
- }
-}
diff --git a/includes/gateways/simplify-commerce/includes/Simplify.php b/includes/gateways/simplify-commerce/includes/Simplify.php
deleted file mode 100644
index d0c4859f5c4d1..0000000000000
--- a/includes/gateways/simplify-commerce/includes/Simplify.php
+++ /dev/null
@@ -1,88 +0,0 @@
-setAll($hash);
- }
-
- /**
- * Creates an OAuth access token
- * @param $code - the authorisation code returned from the GET on /oauth/authorize
- * @param $redirect_uri = this must be the redirect_uri set in the apps configuration
- * @param $authentication - Authentication information to access the API. If not value is passed the global key Simplify::$publicKey and Simplify::$privateKey are used
- * @return Simplify_AccessToken
- */
- public static function create($code, $redirect_uri, $authentication = null) {
-
- $args = func_get_args();
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 3);
-
- $props = 'code='.$code.'&redirect_uri='.$redirect_uri.'&grant_type=authorization_code';
- $resp = Simplify_AccessToken::sendRequest($props, "token", $authentication);
-
- return new Simplify_AccessToken($resp);
- }
-
- /**
- * Refreshes the current token. The access_token and refresh_token values will be updated.
- * @param $authentication - Authentication information to access the API. If not value is passed the global key Simplify::$publicKey and Simplify::$privateKey are used
- * @return Simplify_AccessToken
- * @throws InvalidArgumentException
- */
- public function refresh($authentication = null) {
- $args = func_get_args();
-
- $refresh_token = $this->refresh_token;
- if (empty($refresh_token)){
- throw new InvalidArgumentException('Cannot refresh access token; refresh token is invalid');
- }
-
- $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 1);
-
- $props = 'refresh_token='.$refresh_token.'&grant_type=refresh_token';
- $resp = Simplify_AccessToken::sendRequest($props, "token", $authentication);
-
- $this->setAll($resp);
-
- return $this;
- }
-
- /**
- *