From 8e6a35d1f17b71038369718d52de0b485c69e931 Mon Sep 17 00:00:00 2001
From: Jeffrey Schutzman <jeff@pyebrook.com>
Date: Sun, 4 May 2014 16:15:43 -0400
Subject: [PATCH] Nag store admin to check store settings after upgrade * also
 adds a general administrator nag class to our repertoire to make future
 nagging and error reporting that much more fun

Addresses issues #1272 and #1270
---
 wpsc-admin/db-upgrades/routines/14.php        |  30 +++
 wpsc-core/wpsc-includes.php                   |   1 +
 .../wpsc-admin-notifications.class.php        | 174 ++++++++++++++++++
 3 files changed, 205 insertions(+)
 create mode 100644 wpsc-admin/db-upgrades/routines/14.php
 create mode 100644 wpsc-includes/wpsc-admin-notifications.class.php

diff --git a/wpsc-admin/db-upgrades/routines/14.php b/wpsc-admin/db-upgrades/routines/14.php
new file mode 100644
index 0000000000..372845373d
--- /dev/null
+++ b/wpsc-admin/db-upgrades/routines/14.php
@@ -0,0 +1,30 @@
+<?php
+/**
+ * Control database upgrade to version 14
+*
+* @access private
+* @since 3.8.14.1
+*
+*/
+function _wpsc_db_upgrade_14() {
+	_wpsc_nag_user_to_verify_checkout_state_fields();
+}
+
+/**
+ * add the county region label to the uk
+ *
+ * @access private
+ * @since 3.8.14.1
+ */
+function _wpsc_nag_user_to_verify_checkout_state_fields() {
+	wpsc_admin_nag(
+		__(
+			'WP-e-Commerce has been updated, please confirm the checkout field display
+			settings are correct for your store.<br><br><i>The visibility of the checkout billing and shipping
+			drop downs that show states and provinces is now controlled by the "billingstate" and "shippingstate"
+			options set in the <b>Store Settings</b> on the  <b>Checkout</b> tab.  Prior versions used
+			the "billingcountry" and "shippingcountry" settings to control the visibility of the drop downs.</i>',
+			'wpsc'
+		)
+	);
+}
diff --git a/wpsc-core/wpsc-includes.php b/wpsc-core/wpsc-includes.php
index ac9300f6aa..fb256404be 100644
--- a/wpsc-core/wpsc-includes.php
+++ b/wpsc-core/wpsc-includes.php
@@ -4,6 +4,7 @@
 	require_once( WPSC_FILE_PATH . '/wpsc-core/wpsc-deprecated.php' );
 
 // Start including the rest of the plugin here
+require_once( WPSC_FILE_PATH . '/wpsc-includes/wpsc-admin-notifications.class.php'  );
 require_once( WPSC_FILE_PATH . '/wpsc-includes/wpsc-meta-util.php'                  );
 require_once( WPSC_FILE_PATH . '/wpsc-includes/wpsc-checkout-localization.php'      );
 require_once( WPSC_FILE_PATH . '/wpsc-includes/wpsc-checkout-ajax.php'              );
diff --git a/wpsc-includes/wpsc-admin-notifications.class.php b/wpsc-includes/wpsc-admin-notifications.class.php
new file mode 100644
index 0000000000..486602e25d
--- /dev/null
+++ b/wpsc-includes/wpsc-admin-notifications.class.php
@@ -0,0 +1,174 @@
+<?php
+
+/**
+ *  Show WPeC admin notifications, a.k.a. Nags
+ *
+ * an admin notifications class is defined here in core includes so that notifications
+ * can be queued by logic running on the user facing side that will be visisble to
+ * store administrators when they are on the admin pages
+ *
+ * @access public
+ *
+ * @since 3.8.14.1
+ *
+ */
+class WPSC_Admin_Notifications {
+
+	static $instance = null;
+
+	function __construct() {
+
+		if ( ! self::$instance ) {
+			self::$instance = $this;
+			if ( is_admin() ) {
+				add_action( 'admin_notices', array( $this, 'show_messages' ) );
+				add_action( 'wp_ajax_wpsc_dismiss_admin_msg',  array( $this, 'dismiss_msg' ) );
+			}
+		}
+	}
+
+	/**
+	 * add one or more new messages to be shown to the administrator
+	 * @param string|array[string] $new_messages to show to the admin
+	 */
+	function new_message( $new_messages ) {
+
+		if ( empty ( $new_messages ) )
+			return;
+
+		if ( is_string( $new_messages ) ) {
+			$new_messages = array( $new_messages );
+		}
+
+		$messages = get_option( __CLASS__ , array() );
+		$save_admin_messages = false;
+
+		foreach ( $new_messages as $new_message ) {
+			// using the hash key is an easy way of preventing duplicate messages
+			$id = md5( $new_message );
+
+			if ( ! isset($messages[$id] ) ) {
+				$messages[$id] = $new_message;
+				$save_admin_messages = true;
+			}
+		}
+
+		// only save the admin messages if they have been updated
+		if ( $save_admin_messages ) {
+			update_option( __CLASS__ , $messages );
+		}
+
+		if ( did_action( 'admin_notices' ) ) {
+			$wpsc_admin_notifications = new WPSC_Admin_Notifications();
+			$wpsc_admin_notifications->show_messages();
+		}
+	}
+
+	/**
+	 * display admin messages(nags)
+	 *
+	 * @since 3.8.14.1
+	 */
+	function show_messages() {
+		$messages = get_option( __CLASS__ , array() );
+
+		static $script_already_sent = false;
+		static $already_displayed   = array();
+
+		// first time though this function and we should add the admin nag script to the page
+		if ( ! $script_already_sent  ) {
+			?>
+				<script type="text/javascript">
+				// WPeC Admin nag handler
+				jQuery(document).ready(function ($) {
+					function wpsc_dismiss_admin_msg(id) {
+						jQuery( "#wpsc-admin-message-"+id ).hide();
+						jQuery.ajax({
+							type : "post",
+							dataType : "text",
+							url : "<?php echo admin_url( 'admin-ajax.php' );?>",
+							data : {action: "wpsc_dismiss_admin_msg", id : id},
+							success: function (response) {
+							},
+							error: function (response) {
+								;
+							},
+						});
+					}
+					jQuery(".wpsc-admin-message-dismiss").click(function(event) {
+						wpsc_dismiss_admin_msg(event.target.id);
+						return false;
+					});
+				});
+			</script>
+			<?php
+			$script_already_sent = true;
+		}
+
+		foreach ( $messages as $id => $message ) {
+			if ( in_array( $id, $already_displayed ) )
+				continue;
+
+			$already_displayed[] = $id;
+
+
+			?>
+			<div class="updated wpsc-admin-message" id="wpsc-admin-message-<?php echo esc_attr( $id );?>">
+				<div class="message-text">
+					<p>
+						<?php echo $message; ?>
+					</p>
+				</div>
+				<div class="wpsc-admin-message-action" style="width: 100%; text-align: right;">
+					<a class="wpsc-admin-message-dismiss" id="<?php echo esc_attr( $id );?>"><?php _e( 'Dismiss', 'wpec' )?></a>
+				</div>
+			</div>
+			<?php
+		}
+	}
+
+	/**
+	 * Dismiss an admin message
+	 *
+	 * @param string $message_id  the unqiue message id to be dismissed
+	 */
+	function dismiss_msg( $message_id = false ) {
+		if ( ! $message_id ) {
+			if ( isset( $_REQUEST['id'] ) ) {
+				$message_id = $_REQUEST['id'];
+			}
+		}
+
+		$messages = get_option( __CLASS__ , array() );
+
+		if ( isset($messages[$message_id] ) ) {
+			unset( $messages[$message_id] );
+			update_option( __CLASS__, $messages );
+		}
+
+		wp_send_json_success( true );
+	}
+}
+
+/**
+ * Show one or more admin notification(s) that must be acknowledged
+ *
+ * @param string|array[string] $messages admin the messages(nags) to show
+ */
+function wpsc_admin_nag( $messages ) {
+	static $wpsc_admin_notifications = null;
+
+	if ( empty( $wpsc_admin_notifications ) ) {
+		$wpsc_admin_notifications = new WPSC_Admin_Notifications();
+	}
+
+	$wpsc_admin_notifications->new_message( $messages );
+}
+
+
+
+// If we are showing an admin page we want to show the admin nags
+if ( is_admin() ) {
+	$wpsc_admin_notifications = new WPSC_Admin_Notifications();
+}
+