Merge pull request #21 from ryanshoover/master

enhance(safety): Cleaning up the GeoIP gut check to be more stable

Author: stevenkword

inc/country-list.php

@@ -103,8 +103,70 @@ This will display “Content just for everyone in Texas and California” strict
 You can mix and match geography and negative geography options to create verbose logic in a single shortcode:
 `[geoip-content country="US" not-city="Austin"]Content for US visitors but not for visitors in Austin[/geoip-content]`
 
+= Limitations =
 
-== Testing Parameters == 
+There is a single limitation in the logic that lets you filter content for multiple geographic areas.
+
+You can progressively limit the area that content is shown in. But once your content is hidden from an area, a subset of that area can't be added back in.
+
+For example,
+If I limit my image to Europe, then hide my image from Great Britain, I can't go back and show it to London.
+
+== Creative Work Arounds and Hacks ==
+
+=== Limit content to some regions of a country (or some cities of a state) ===
+
+You want to show an offer for free shipping to every state in the US *but* Alaska and Hawaii. You may be inclined to write something like
+
+**BAD**
+
+```
+[geoip_content country="US" not_state="AK, HI"]Lorem ipsum dolor sit amet[/geoip_content]
+```
+
+Instead, show it to all other 48 states
+
+**GOOD**
+
+```
+[geoip_content state="AL, AZ, AR, CA, CO, CT, DE, FL, GA, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY"]Free shipping on all orders over $50![/geoip_content]
+```
+
+=== Duplicate location names ===
+
+You want to show discount airfare on a flight to Paris, France. The content should show to all of the US and France, but not Paris itself. 
+
+**BAD**
+
+```
+[geoip_content country="US, FR" not_city="Paris"]Fly to Paris for only $199![/geoip_content]
+```
+
+The problem here is that Paris, Texas will be hidden. The solution? Just have two geoip_content shortcodes.
+
+**GOOD**
+
+```
+[geoip_content country="FR" not_city="Paris"]Fly to Paris for only $199![/geoip_content][geoip_content country="US"]Fly to Paris for only $199![/geoip_content]
+```
+=== Adding an area into an ommited region ===
+
+You want to show an ad written in Spanish to all of South America except for Brazil. Brasilia, however, has enough Spanish speakers that you want to include Brasilia.
+
+**BAD**
+
+```
+[geoip_content continent="SA" not_country="BR" city="Brasilia"]Lorem ipsum dolor sit amet[/geoip_content]
+```
+
+**GOOD**
+
+```
+[geoip_content continent="SA" not_country="BR"]Venta de la Navidad en los adaptadores USB[/geoip_content]
+[geoip_content city="Brasilia"]Venta de la Navidad en los adaptadores USB[/geoip_content]
+```
+
+== Testing Parameters ==
 You can use the following URL parameters to test how your localized content will appear to visitors from various geographic locations. You can add any of the parameters below to any URL of a page using the GeoIP shortcodes or API calls:
 
 Spoof visitor from the state of Texas:
@@ -153,8 +215,11 @@ Please contact the WP Engine [Support Team](https://my.wpengine.com/support#gene
 
 == Changelog ==
 
+= 1.1.2 =
+- Fixes logic for nested parameter selectors in content shortcode
+
 = 1.1.1 =
-- Fixes logic for negated parameters in content shortcake
+- Fixes logic for negated parameters in content shortcode
 - Allows the plugin to run on development sites
 
 = 1.1.0 =
@@ -199,4 +264,4 @@ Please contact the WP Engine [Support Team](https://my.wpengine.com/support#gene
 == Upgrade Notice ==
 
 = 1.1.1 =
-This version adds the following features: fixed a small issue with the content shortcode filters, allows the plugin to run on development sites. This update is recommended for all GeoIP users.
+This version adds the following features: fixed a small issue with the content shortcode filters, allows the plugin to run on development sites. This update is recommended for all GeoIP users.

readme.txt

@@ -1,7 +1,7 @@
 <?php
 /*
 Plugin Name: WP Engine GeoIP
-Version: 1.1.1
+Version: 1.1.2
 Description: Create a personalized user experienced based on location.
 Author: WP Engine
 Author URI: http://wpengine.com
@@ -96,7 +96,7 @@ public function setup() {
 
 		// Get our array of countries and continents
 		require_once( $this->geoip_path . '/inc/country-list.php' );
-		
+
 		$this->countries = apply_filters( 'geoip_country_list', geoip_country_list() );
 
 		$this->geos = $this->get_actuals();
@@ -126,6 +126,8 @@ public function get_actuals() {
 			'postalcode'   => getenv( 'HTTP_GEOIP_POSTAL_CODE' ),
 		);
 
+		$geos['active'] = ( isset( $geos['countrycode'] ) && false !== $geos['countrycode'] )  ? true : false;
+
 		$geos['continent'] = $this->continent( $geos['countrycode'] );
 
 		return $geos;
@@ -412,16 +414,19 @@ function do_shortcode_location( $atts ) {
 	 */
 	function do_shortcode_content( $atts, $content = null ) {
 
-		$keep = FALSE;
+		$keep = true;
+
+		$test_parameters = array();
 
-		foreach( $atts as $geos_label => $value ) {
+		// Process and organzie the test parameters
+		foreach( $atts as $label => $value ) {
 
 			// Intialize our negation parameters
 			$negate = 0;
 			$inline_negate = 0;
 
 			// Check to see if the attribute has "not" in it
-			$negate = preg_match( '/not?[-_]?(.*)/', $geos_label, $matches );
+			$negate = preg_match( '/not?[-_]?(.*)/', $label, $matches );
 
 			// WordPress doesn't like a dash in shortcode parameter labels
 			// Just in case, check to see if the value has "not-" in it
@@ -430,43 +435,55 @@ function do_shortcode_content( $atts, $content = null ) {
 			}
 
 			// Label after the negation match
-			$geos_label = $negate ? $matches[1] : $geos_label;
+			$label = $negate ? $matches[1] : $label;
 
-			// Value after the negation match 
+			// Value after the negation match
 			$value = $inline_negate ? $matches[2] : $value;
 
 			// Replace common synonyms with our values
-			$geos_label = $this->match_label_synonyms( $geos_label );
+			$label = $this->match_label_synonyms( $label );
 
-			// Abort if the geos_label doesn't match
-			if( !isset( $this->geos[ $geos_label ] ) ) {
+			// Abort if the label doesn't match
+			if( !isset( $this->geos[ $label ] ) ) {
 				continue;
 			}
 
-			// sanitize the match value
-			$match_value = strtolower( $this->geos[ $geos_label ] );
-
-			// find out if the value is comma delimited
+			// Find out if the value is comma delimited
 			$test_values = (array) explode( ',',  $value );
 
-			// If we're checking for a negative, we need to start with TRUE
-			if( $negate ) {
-				$keep = TRUE;
-			}
+			// Add the value to the test parameters
+			$test_parameters[ $label ] = array(
+				'test_values' => $test_values,
+				'negate' => $negate,
+				);
+		}
 
-			// Let's run through the test values and see if we get a match
-			foreach( $test_values as $test_value ) {
+		// Sort the test parameters by region type – largest to smallest
+		uksort( $test_parameters, array( $this, 'compare_location_type' ) );
 
-				// sanitize the test value
+		$test_parameters = apply_filters( 'geoip_test_parameters', $test_parameters, $atts );
+
+		// Process through parameters, testing to see if we have a match
+		foreach( $test_parameters as $label => $parameter ) {
+
+			$test_values = $parameter['test_values'];
+
+			$negate = $parameter['negate'];
+
+			// Sanitize the match value
+			$match_value = strtolower( $this->geos[ $label ] );
+
+			// Sanitize the test values
+			foreach( $test_values as &$test_value ) {
 				$test_value = strtolower( trim( $test_value, " \t\"." ) );
+			}
 
-				if( ! $negate && $match_value == $test_value ) {
-					$keep = TRUE;
-				}
+			$is_match = in_array( $match_value, $test_values );
 
-				if( $negate && $match_value == $test_value ) {
-					$keep = FALSE;
-				}
+			$is_match = ! $negate ? $is_match : ! $is_match;
+
+			if( ! $is_match ) {
+				$keep = false;
 			}
 		}
 
@@ -476,18 +493,42 @@ function do_shortcode_content( $atts, $content = null ) {
 		return apply_filters( 'geoip_content', $content, $atts );
 	}
 
+	/**
+	 * Compare the location types
+	 *
+	 * Used for sorting location types from largest area to smallest area
+	 *
+	 * @since 1.1.2
+	 */
+	public function compare_location_type( $a, $b ) {
+		$location_types = array(
+			'continent'    => 1,
+			'countrycode'  => 2,
+			'countrycode3' => 2,
+			'countryname'  => 2,
+			'region'       => 3,
+			'areacode'     => 4,
+			'city'         => 5,
+			'postalcode'   => 6,
+			);
+
+		if( isset( $location_types[ $a ] ) && isset( $location_types[ $b ] ) ) {
+			return $location_types[ $a ] - $location_types[ $b ];
+		} else {
+			return 0;
+		}
+	}
+
 	/**
 	 * Checks if environment variable depencies are available on the server
 	 *
+	 * @todo Include link to query documentation when available on the Plugin Directory
 	 * @since  0.5.0
 	 */
 	public function action_admin_init_check_plugin_dependencies() {
-		// Check to see if we're in a development environment or the environment variables are present
-		$is_wpe = getenv( 'HTTP_GEOIP_COUNTRY_CODE' );
-		$is_dev = preg_match( '/^(.*)(\.dev)$|^(.*)(staging.wpengine.com)$/', get_site_url() );
 
-		if( 1 != $is_dev && ( ! isset( $is_wpe ) || empty( $is_wpe ) ) ) {
-			$this->admin_notices[] = __( 'Please note - this plugin will only function on your <a href="http://wpengine.com/plans/?utm_source=' . self::TEXT_DOMAIN . '">WP Engine account</a>. This will not function outside of the WP Engine environment. Plugin <b>deactivated.</b>', self::TEXT_DOMAIN );
+		if( ! $this->geos['active'] ) {
+			$this->admin_notices[] = __( 'WP Engine GeoIP requires a <a href="http://wpengine.com/plans/?utm_source=' . self::TEXT_DOMAIN . '">WP Engine account</a> for full functionality. Only testing queries will work on this site.', self::TEXT_DOMAIN );
 		}
 		unset( $is_wpe );
 	}
@@ -499,24 +540,21 @@ public function action_admin_init_check_plugin_dependencies() {
 	 */
 	public function action_admin_notices() {
 		if( 0 < count( $this->admin_notices ) ) {
-			// Hide the activation message
-			echo '<style>.wrap .updated{display:none;}</style>';
 
-			// Display the errors
-			echo '<div class="error">';
+			// Display the notices
+			echo '<div class="error notice is-dismissible">';
+
 			foreach( $this->admin_notices as $notice ) {
 				echo "<p>$notice</p>";
 			}
-			echo '</div>';
 
-			// Disable this plugin
-			deactivate_plugins( plugin_basename( __FILE__ ) );
+			echo '</div>';
 		}
 	}
 
 	/**
 	 * As a favor to users, let's match some common synonyms
-	 * 
+	 *
 	 * @since 1.1.0
 	 * @return string label
 	 */