<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* WooCommerce Shipping Label Banner Display Rules.

[2] Fix | Delete

*/

[3] Fix | Delete

[4] Fix | Delete

namespace Automattic\WooCommerce\Internal\Admin;

[5] Fix | Delete

[6] Fix | Delete

/**

[7] Fix | Delete

* Determines whether the Shipping Label Banner should be displayed

[8] Fix | Delete

*/

[9] Fix | Delete

class ShippingLabelBannerDisplayRules {

[10] Fix | Delete

[11] Fix | Delete

/**

[12] Fix | Delete

* Whether the site is connected to wordpress.com.

[13] Fix | Delete

*

[14] Fix | Delete

* @var bool

[15] Fix | Delete

*/

[16] Fix | Delete

private $dotcom_connected;

[17] Fix | Delete

[18] Fix | Delete

/**

[19] Fix | Delete

* Whether installed plugins are incompatible with the banner.

[20] Fix | Delete

*

[21] Fix | Delete

* @var bool

[22] Fix | Delete

*/

[23] Fix | Delete

private $no_incompatible_plugins_installed;

[24] Fix | Delete

[25] Fix | Delete

/**

[26] Fix | Delete

* Holds the installed WooCommerce Shipping & Tax version.

[27] Fix | Delete

*

[28] Fix | Delete

* @var string

[29] Fix | Delete

*/

[30] Fix | Delete

private $wcs_version;

[31] Fix | Delete

[32] Fix | Delete

/**

[33] Fix | Delete

* Supported countries by USPS, see: https://webpmt.usps.gov/pmt010.cfm

[34] Fix | Delete

*

[35] Fix | Delete

* @var array

[36] Fix | Delete

*/

[37] Fix | Delete

private $supported_countries = array( 'US', 'AS', 'PR', 'VI', 'GU', 'MP', 'UM', 'FM', 'MH' );

[38] Fix | Delete

[39] Fix | Delete

/**

[40] Fix | Delete

* Array of supported currency codes.

[41] Fix | Delete

*

[42] Fix | Delete

* @var array

[43] Fix | Delete

*/

[44] Fix | Delete

private $supported_currencies = array( 'USD' );

[45] Fix | Delete

[46] Fix | Delete

[47] Fix | Delete

/**

[48] Fix | Delete

* Constructor.

[49] Fix | Delete

*

[50] Fix | Delete

* @param bool $dotcom_connected Is site connected to wordpress.com?.

[51] Fix | Delete

* @param string|null $wcs_version Installed WooCommerce Shipping version to check, null if not installed.

[52] Fix | Delete

* @param bool $incompatible_plugins_installed Are there any incompatible plugins installed?.

[53] Fix | Delete

*/

[54] Fix | Delete

public function __construct( $dotcom_connected, $wcs_version, $incompatible_plugins_installed ) {

[55] Fix | Delete

$this->dotcom_connected = $dotcom_connected;

[56] Fix | Delete

$this->wcs_version = $wcs_version;

[57] Fix | Delete

$this->no_incompatible_plugins_installed = ! $incompatible_plugins_installed;

[58] Fix | Delete

}

[59] Fix | Delete

[60] Fix | Delete

/**

[61] Fix | Delete

* Determines whether banner is eligible for display (does not include a/b logic).

[62] Fix | Delete

*/

[63] Fix | Delete

public function should_display_banner() {

[64] Fix | Delete

return $this->banner_not_dismissed() &&

[65] Fix | Delete

$this->dotcom_connected &&

[66] Fix | Delete

$this->no_incompatible_plugins_installed &&

[67] Fix | Delete

$this->order_has_shippable_products() &&

[68] Fix | Delete

$this->store_in_us_and_usd() &&

[69] Fix | Delete

$this->wcs_not_installed();

[70] Fix | Delete

}

[71] Fix | Delete

[72] Fix | Delete

/**

[73] Fix | Delete

* Checks if the banner was not dismissed by the user.

[74] Fix | Delete

*

[75] Fix | Delete

* @return bool

[76] Fix | Delete

*/

[77] Fix | Delete

private function banner_not_dismissed() {

[78] Fix | Delete

$dismissed_timestamp_ms = get_option( 'woocommerce_shipping_dismissed_timestamp' );

[79] Fix | Delete

[80] Fix | Delete

if ( ! is_numeric( $dismissed_timestamp_ms ) ) {

[81] Fix | Delete

return true;

[82] Fix | Delete

}

[83] Fix | Delete

$dismissed_timestamp_ms = intval( $dismissed_timestamp_ms );

[84] Fix | Delete

$dismissed_timestamp = intval( round( $dismissed_timestamp_ms / 1000 ) );

[85] Fix | Delete

$expired_timestamp = $dismissed_timestamp + 24 * 60 * 60; // 24 hours from click time

[86] Fix | Delete

[87] Fix | Delete

$dismissed_for_good = -1 === $dismissed_timestamp_ms;

[88] Fix | Delete

$dismissed_24h = time() < $expired_timestamp;

[89] Fix | Delete

[90] Fix | Delete

return ! $dismissed_for_good && ! $dismissed_24h;

[91] Fix | Delete

}

[92] Fix | Delete

[93] Fix | Delete

/**

[94] Fix | Delete

* Checks if there's a shippable product in the current order.

[95] Fix | Delete

*

[96] Fix | Delete

* @return bool

[97] Fix | Delete

*/

[98] Fix | Delete

private function order_has_shippable_products() {

[99] Fix | Delete

$order = wc_get_order();

[100] Fix | Delete

[101] Fix | Delete

if ( ! $order ) {

[102] Fix | Delete

return false;

[103] Fix | Delete

}

[104] Fix | Delete

// At this point (no packaging data), only show if there's at least one existing and shippable product.

[105] Fix | Delete

foreach ( $order->get_items() as $item ) {

[106] Fix | Delete

if ( $item instanceof \WC_Order_Item_Product ) {

[107] Fix | Delete

$product = $item->get_product();

[108] Fix | Delete

[109] Fix | Delete

if ( $product && $product->needs_shipping() ) {

[110] Fix | Delete

return true;

[111] Fix | Delete

}

[112] Fix | Delete

}

[113] Fix | Delete

}

[114] Fix | Delete

[115] Fix | Delete

return false;

[116] Fix | Delete

}

[117] Fix | Delete

[118] Fix | Delete

/**

[119] Fix | Delete

* Checks if the store is in the US and has its default currency set to USD.

[120] Fix | Delete

*

[121] Fix | Delete

* @return bool

[122] Fix | Delete

*/

[123] Fix | Delete

private function store_in_us_and_usd() {

[124] Fix | Delete

$base_currency = get_woocommerce_currency();

[125] Fix | Delete

$base_location = wc_get_base_location();

[126] Fix | Delete

[127] Fix | Delete

return in_array( $base_currency, $this->supported_currencies, true ) && in_array( $base_location['country'], $this->supported_countries, true );

[128] Fix | Delete

}

[129] Fix | Delete

[130] Fix | Delete

/**

[131] Fix | Delete

* Checks if WooCommerce Shipping & Tax is not installed.

[132] Fix | Delete

*

[133] Fix | Delete

* @return bool

[134] Fix | Delete

*/

[135] Fix | Delete

private function wcs_not_installed() {

[136] Fix | Delete

return ! $this->wcs_version;

[137] Fix | Delete

}

[138] Fix | Delete

}

[139] Fix | Delete

[140] Fix | Delete