From 8f9bd7d0bfde7f0100ba1102f9eca81c14f83434 Mon Sep 17 00:00:00 2001
From: Mike Jolley <mike.jolley@me.com>
Date: Tue, 5 Dec 2017 15:00:07 +0000
Subject: [PATCH] Return packages with no rates.

---
 includes/class-wc-shipping.php | 70 ++++++++++++++++++----------------
 1 file changed, 37 insertions(+), 33 deletions(-)

diff --git a/includes/class-wc-shipping.php b/includes/class-wc-shipping.php
index 150e6f9bdb9..4bbd1af69d2 100644
--- a/includes/class-wc-shipping.php
+++ b/includes/class-wc-shipping.php
@@ -278,8 +278,11 @@ class WC_Shipping {
 
 	/**
 	 * See if package is shippable.
-	 * @param  array  $package
-	 * @return boolean
+	 *
+	 * Packages are shippable until proven otherwise e.g. after getting a shipping country.
+	 *
+	 * @param  array $package Package of cart items.
+	 * @return bool
 	 */
 	protected function is_package_shippable( $package ) {
 
@@ -297,51 +300,52 @@ class WC_Shipping {
 	 *
 	 * Calculates each shipping methods cost. Rates are stored in the session based on the package hash to avoid re-calculation every page load.
 	 *
-	 * @param array $package cart items
+	 * @param array $package Package of cart items.
 	 * @param int   $package_key Index of the package being calculated. Used to cache multiple package rates.
 	 *
 	 * @return array|bool
 	 */
 	public function calculate_shipping_for_package( $package = array(), $package_key = 0 ) {
-		if ( ! $this->enabled || empty( $package ) || ! $this->is_package_shippable( $package ) ) {
+		// If shipping is disabled or the package is invalid, return false.
+		if ( ! $this->enabled || empty( $package ) ) {
 			return false;
 		}
 
-		// Check if we need to recalculate shipping for this package
-		$package_to_hash = $package;
+		$package['rates'] = array();
 
-		// Remove data objects so hashes are consistent
-		foreach ( $package_to_hash['contents'] as $item_id => $item ) {
-			unset( $package_to_hash['contents'][ $item_id ]['data'] );
-		}
+		// If the package is not shippable, e.g. trying to ship to an invalid country, do not calculate rates.
+		if ( $this->is_package_shippable( $package ) ) {
+			// Check if we need to recalculate shipping for this package.
+			$package_to_hash = $package;
 
-		$package_hash = 'wc_ship_' . md5( json_encode( $package_to_hash ) . WC_Cache_Helper::get_transient_version( 'shipping' ) );
-		$session_key  = 'shipping_for_package_' . $package_key;
-		$stored_rates = WC()->session->get( $session_key );
-
-		if ( ! is_array( $stored_rates ) || $package_hash !== $stored_rates['package_hash'] || 'yes' === get_option( 'woocommerce_shipping_debug_mode', 'no' ) ) {
-			// Calculate shipping method rates
-			$package['rates'] = array();
-
-			foreach ( $this->load_shipping_methods( $package ) as $shipping_method ) {
-				// Shipping instances need an ID
-				if ( ! $shipping_method->supports( 'shipping-zones' ) || $shipping_method->get_instance_id() ) {
-					$package['rates'] = $package['rates'] + $shipping_method->get_rates_for_package( $package ); // + instead of array_merge maintains numeric keys
-				}
+			// Remove data objects so hashes are consistent.
+			foreach ( $package_to_hash['contents'] as $item_id => $item ) {
+				unset( $package_to_hash['contents'][ $item_id ]['data'] );
 			}
 
-			// Filter the calculated rates
-			$package['rates'] = apply_filters( 'woocommerce_package_rates', $package['rates'], $package );
+			$package_hash = 'wc_ship_' . md5( wp_json_encode( $package_to_hash ) . WC_Cache_Helper::get_transient_version( 'shipping' ) );
+			$session_key  = 'shipping_for_package_' . $package_key;
+			$stored_rates = WC()->session->get( $session_key );
 
-			// Store in session to avoid recalculation
-			WC()->session->set( $session_key, array(
-				'package_hash' => $package_hash,
-				'rates'        => $package['rates'],
-			) );
-		} else {
-			$package['rates'] = $stored_rates['rates'];
+			if ( ! is_array( $stored_rates ) || $package_hash !== $stored_rates['package_hash'] || 'yes' === get_option( 'woocommerce_shipping_debug_mode', 'no' ) ) {
+				foreach ( $this->load_shipping_methods( $package ) as $shipping_method ) {
+					if ( ! $shipping_method->supports( 'shipping-zones' ) || $shipping_method->get_instance_id() ) {
+						$package['rates'] = $package['rates'] + $shipping_method->get_rates_for_package( $package ); // + instead of array_merge maintains numeric keys
+					}
+				}
+
+				// Filter the calculated rates.
+				$package['rates'] = apply_filters( 'woocommerce_package_rates', $package['rates'], $package );
+
+				// Store in session to avoid recalculation.
+				WC()->session->set( $session_key, array(
+					'package_hash' => $package_hash,
+					'rates'        => $package['rates'],
+				) );
+			} else {
+				$package['rates'] = $stored_rates['rates'];
+			}
 		}
-
 		return $package;
 	}