wpsc-meta-util.php

<?php

// this is the priority that all hooks that enforce business rules about visitor meta will run.
// Intentially set to a high priority so that extensions that use the hooks see the visitor meta values
// after the rules have been enforced
if ( ! defined( '_WPSC_USER_META_HOOK_PRIORITY' ) ) {
	define( '_WPSC_USER_META_HOOK_PRIORITY' , 2 );
}

/**
 * Get all meta ids that have the meta value
 *
 * @since 3.8.14
 *
 * @param string $meta_object_type the WordPress meta object type
 * @param string $meta_key ids with the specified meta key
 * @return array of int 	meta object type object ids that match have the meta key
 */
function wpsc_get_meta_ids_by_meta_key( $meta_object_type, $meta_key = '' ) {
	global $wpdb;

	$meta_table    = _wpsc_meta_table_name( 'visitor' );
	$meta_key = _wpsc_meta_key_name( $meta_key );

	$sql = 'SELECT meta_id FROM `' . $meta_table . '` where meta_key = "%s"';
	$sql = $wpdb->prepare( $sql, $meta_key );

	$meta_item_ids = $wpdb->get_col( $sql, 0  );
	$meta_item_ids = array_map( 'intval', $meta_item_ids );

	$meta_item_ids = apply_filters( 'wpsc_get_ids_by_meta_key', $meta_item_ids, $meta_object_type, $meta_key );

	return $meta_item_ids;
}

/**
 * Calls function for each meta matching the timestamp criteria.  Callback function
 * will get a single parameter that is an object representing the meta.
 *
 * @since 3.8.12
 *
 * @param string $meta_object_type the WordPress meta object type
 * @param int|string $timestamp timestamp to compare meta items against, if int a unix timestamp is assumed,
 *								if string a MYSQL timestamp is assumed
 * @param string $comparison any one of the supported comparison operators,(=,>=,>,<=,<,<>,!=)
 * @param string $meta_key restrict testing of meta to the values with the specified meta key
 * @return array metadata matching the query
 */
function wpsc_get_meta_by_timestamp( $meta_object_type, $timestamp = 0, $comparison = '>', $meta_key = '' ) {
	global $wpdb;

	$meta_table    = _wpsc_meta_table_name( $meta_object_type );
	$id_field_name = _wpsc_meta_key_name( 'visitor' );

	if ( ($timestamp == 0) || empty( $timestamp ) ) {
		$sql = 'SELECT ' . $id_field_name . ' AS id FROM ` ' . $meta_table . '` ';
	} else {
		// validate the comparison operator
		if ( ! in_array( $comparison, array( '=', '>=', '>', '<=', '<', '<>', '!='	) ) ) {
			return false;
		}

		if ( is_int( $timestamp ) ) {
			$timestamp = date( 'Y-m-d H:i:s', $timestamp );
		}

		$sql = 'SELECT ' . $id_field_name . ' as id FROM `' . $meta_table. '` where meta_timestamp ' . $comparison . ' "%s"';
		$sql = $wpdb->prepare( $sql , $timestamp );
	}

	if ( ! empty ($meta_key ) ) {
		$sql .= ' AND meta_key = %s';
		$sql = $wpdb->prepare( $sql , $meta_key );
	}

	$meta_item_ids = $wpdb->get_col( $sql, 0  );
	$meta_item_ids = array_map( 'intval', $meta_item_ids );

	$meta_item_ids = apply_filters( 'wpsc_get_meta_by_timestamp', $meta_item_ids, $meta_object_type, $meta_key, $timestamp, $comparison );

	$metas = array();

	foreach ( $meta_item_ids as $id ) {
		$metas[$id] = get_metadata( $meta_object_type , $id , $meta_key );
	}

	return $metas;
}


/**
 * Get meta timestamp of the by object type, meta id and key, if multiple records exist
 * the timestamp of the most recently updated record is returned
 * @since 3.8.12
 *
 * @param string $meta_object_type Type of object metadata is for (e.g., variation. cart, etc)
 * @param int $object_id ID for a specific meta item
 * @return object Meta object timestamp or false.
 */
function wpsc_get_metadata_timestamp( $meta_object_type, $object_id, $meta_key = '' ) {
	global $wpdb;

	$object_id = intval( $object_id );

	if ( ! empty($meta_object_type) && ! empty( $meta_id )  && ! empty( $meta_key ) ) {
		$meta_table_name = _wpsc_meta_table_name( $meta_object_type );
		$id_field_name = _wpsc_meta_key_name( 'visitor' );
		if ( ! empty( $meta_table_name ) ) {
			if ( ! empty ( $meta_key ) ) {
				$sql = 'SELECT meta_timestamp '
						. ' FROM '. $meta_table_name
						. ' WHERE meta_key = %s AND `' . $id_field_name . '` = %d '
						. ' ORDER BY meta_timestamp DESC LIMIT 1';

				$wpdb->prepare( $sql , $meta_key, $object_id );
			} else {
				$sql = 'SELECT meta_timestamp '
						. ' FROM '. $meta_table_name
						. ' WHERE ' . $id_field_name . '` = %d '
						. ' ORDER BY meta_timestamp DESC LIMIT 1';

				$wpdb->prepare( $sql , $meta_key, $object_id );
			}

			$timestamp = $wpdb->get_row( $sql );
		}
	}

	if ( empty( $timestamp ) ) {
		$timestamp = false;
	}

	return $timestamp;
}


/**
 * Get meta timestamp of the by meta object id
 *
 * @since 3.8.14
 *
 * @param string $meta_object_type Type of object metadata is for (e.g., variation. cart, etc)
 * @param int $meta_id ID for a specific meta row
 * @return object Meta object timestamp or false.
 */
function wpsc_get_meta_id_timestamp( $meta_object_type, $meta_id ) {
	global $wpdb;

	$meta_id = intval( $meta_id );

	if ( ! empty($meta_object_type) && ! empty( $meta_id ) ) {
		$meta_table_name = _wpsc_meta_table_name( $meta_object_type );
		if ( ! empty( $meta_table_name ) ) {
			$sql = 'SELECT meta_timestamp FROM '. $meta_table_name .' WHERE meta_id = %d';
			$timestamp = $wpdb->get_var( $wpdb->prepare( $sql , $meta_id ), 0 );
		}
	}

	if ( empty( $timestamp ) ) {
		$timestamp = false;
	}

	return $timestamp;
}


/**
 * Get the meta associated with a specific meta type and meta id
 * the timestamp of the newest record is returned
 * @since 3.8.14
 *
 * @param string $meta_object_type Type of object metadata is for (e.g., variation. cart, etc)
 	* @param int $meta_id ID for a specific meta row
 * @return object Meta object or false.
 */
function _wpsc_get_meta_by_meta_id( $meta_object_type, $meta_id  ) {
	global $wpdb;
	$meta_item = false;

	$meta_id = intval( $meta_id );

	if ( ! empty($meta_object_type) && ! empty( $meta_id ) ) {
		$meta_table_name = _wpsc_meta_table_name( $meta_object_type );

		if ( ! empty( $meta_table_name ) ) {
			$sql = 'SELECT * FROM ' . $meta_table_name . ' WHERE meta_id = %d';
			$sql = $wpdb->prepare( $sql , $meta_id );

			$meta_item = $wpdb->get_row( $sql, OBJECT );

			$meta_item->meta_value = maybe_unserialize( $meta_item->meta_value );

			if ( $meta_item === null ) {
				$meta_item = false;
			}
		}
	}

	return $meta_item;
}


/**
 * Get the meta ids associated with a specific meta type, object id and meta key
 * the timestamp of the newest record is returned
 *
 * @acess private
 * @since 3.8.14
 *
 * @param string $meta_object_type Type of object metadata is for (e.g., variation. cart, etc)
 * @param int $meta_id ID for a specific meta row
 * @return array array of meta ids
 */
function _wpsc_get_meta_ids( $meta_object_type, $object_id, $meta_key  ) {
	global $wpdb;
	$meta_item_ids = array();

	$object_id = intval( $object_id );

	if ( ! empty($meta_object_type) && ! empty( $object_id )  && ! empty( $meta_key ) ) {
		$meta_table_name = _wpsc_meta_table_name( $meta_object_type );

		if ( ! empty( $meta_table_name ) ) {
			$sql = 'SELECT meta_id '
					. ' FROM '. $meta_table_name
					. ' WHERE `' . _wpsc_meta_key_name( $meta_object_type )  . '` = %d '
					. ' AND meta_key = %s';

			$sql = $wpdb->prepare( $sql , $object_id, $meta_key );

			$meta_item_ids = $wpdb->get_col( $sql, 0 );

			if ( ! empty( $meta_item_ids ) ) {
				$meta_item_ids = array_map( 'intval', $meta_item_ids );
			}
		}
	}

	return $meta_item_ids;
}


/**
 * Validate the custom meta object type
 *
 * @since 3.8.14
 * @access private
 * @param string $meta_object_type Type of object metadata is for (e.g., variation. cart, etc)
 * @return validated string, or empty string if it isn't a valid object type
 */
function _wpsc_validate_meta_object_type( $meta_object_type ) {

	// This is a name translation that should stay very small and only be added to
	// in the case where we change a meta object name, or are storing multiple meta
	// types in the same table.
	//
	// TODO: post 3.8.14 enhance by adding the general meta table to this array and validate the the
	// WPEC built in meta infrastructure, with its nifty caching capabilities can be used to access
	// the legacy catch-all meta table
	//
	$valid_meta_object_types = array(
			'visitor'   => 'visitor',    // valid customer meta table
			'purchase'  => 'purchase',   // valid customer meta table
			'cart_item' => 'cart_item',  // valid customer meta table
			'customer'  => 'visitor',    // customer changed to visitor in release 3.8.14
	);


	if ( in_array( $meta_object_type, $valid_meta_object_types ) ) {
		$object_type = $valid_meta_object_types[$meta_object_type];
	} else {
		$object_type = '';
	}

	return $object_type;
}

/**
 * The name of the meta table for a specific meta object type.
 *
 *  if it hasn't been defined in $wpdb the name as it would be defined is returned. The
 *  likely cases where it would not be defined would be during an initialization or
 *  upgrade process. Because it is possible that the meta table name has been overridden
 *  we will check to see if it exists in the $wpdb object before trying to crate it anew.
 *  Note: that function call does not check if the table exits, it only give back the name,
 *
 * @since 3.8.12
 * @access private
 * @param string $meta_object_type Type of object metadata is for (e.g., variation. cart, etc)
 * @return string Name of the custom meta table defined in $wpdb, or the name as it would be defined
 */
function _wpsc_meta_table_name( $meta_object_type ) {
	global $wpdb;

	$meta_table_name_property = _wpsc_wpdb_meta_table( $meta_object_type );

	if ( property_exists( $wpdb, $meta_table_name_property ) ) {
		return $wpdb->$meta_table_name_property;
	} else {
		return $wpdb->prefix . $meta_object_type . '_meta';
	}
}


/**
 * The name of the meta table property for a specific meta object type, this name should be the name
 * found in the $wpdb class for the specified meta type
 *
 * @since 3.8.14
 *
 * @param string $meta_object_type Type of object metadata is for (e.g., variation. cart, etc)
 * @return string Name of the applicable WPEC custom meta table, empty string if the meta type is not valid
 */
function _wpsc_wpdb_meta_table( $meta_object_type ) {
	global $wpdb;

	if ( $meta_object_type = _wpsc_validate_meta_object_type( $meta_object_type ) ) {
		$table_name_property = 'wpsc_'. $meta_object_type . 'meta';
	} else {
		$table_name_property = '';
	}

	return $table_name_property;
}

/**
 * The name of the column in the meta table that contains the key of the target object
 *
 * @since 3.8.14
 *
 * @param string $meta_object_type Type of object metadata is for (e.g., variation. cart, etc)
 * @return string column name of the applicable WPEC custom meta table index field, empty string if the meta type is not valid
 */
function _wpsc_meta_key_name( $meta_object_type ) {
	global $wpdb;

	if ( $meta_object_type = _wpsc_validate_meta_object_type( $meta_object_type ) ) {
		$id_field_name = 'wpsc_' . $meta_object_type . '_id';
	} else {
		$id_field_name = '';
	}

	return $id_field_name;
}

/**
 * Check the visitor meta key to see if it has been aliased to another visitor meta key
 *
 * @since 3.8.14
 *
 * @param string $visitor_meta_key
 * @return string valid unchanged key if original is valid, or replacement visitor meta key
 */
function _wpsc_validate_visitor_meta_key( $visitor_meta_key ) {

	// WPEC internal visitor meta keys are not allowed to be aliased, internal visitor meta keys
	if ( ! ( strpos( $visitor_meta_key, _wpsc_get_visitor_meta_key( '' ) ) === 0 ) ) {

		$build_in_checkout_names = wpsc_checkout_unique_names();

		// the built in checkout names cannot be aliased to something else
		if ( ! in_array( $visitor_meta_key, $build_in_checkout_names ) ) {

			/**
			 * Filter wpsc_visitor_meta_key_replacements
			 *
			 * Get an array of key/value pairs that are used to alias visitor meta keys. The
			 * key is the old name, the value is the new name
			 *
			 * @since 3.8.14
			 *
			 * @param array of key value pairs
			 *
			 */
			$aliased_meta_keys = apply_filters( 'wpsc_visitor_meta_key_replacements', array() );

			if ( isset( $aliased_meta_keys[$visitor_meta_key] ) ) {
				$visitor_meta_key = $aliased_meta_keys[$visitor_meta_key];
			}
		}
	}

	return $visitor_meta_key;
}



/**
 * Replace all of the specified meta keys in the database during an upgrade
 *
 * @since 3.8.14
 *
 * @param  array  array of string parirs old key is the index key, new key is the value
 * @return int    count of values updated
 */
function _wpsc_replace_visitor_meta_keys( $replacements ) {

	$build_in_checkout_names = wpsc_checkout_unique_names();

	$total_count_updated = 0;

	foreach ( $replacements as $old_meta_key => $new_meta_key ) {

		// the built in checkout names cannot be replaced to something else
		if ( ! isset( $build_in_checkout_names[$visitor_meta_key] ) ) {

			$sql = 'UPDATE ' . $wpdb->wpsc_visitormeta . ' SET meta_key = "' . $new_meta_key .

			$rows_updated = $wpdb->update(
					$wpdb->wpsc_visitormeta,                // table
					array( 'meta_key' => $new_meta_key,	),	// data to set
					array( 'meta_key' => $old_meta_key,	),  // where
					array( '%s', ),                         // format
					array( '%s', )                          // where format
			);

			$total_count_updated += $rows_updated;
		}
	}

	if ( $total_count_updated > 0 ) {
		wpsc_core_flush_temporary_data();
	}

	return $total_count_updated;
}


/** Create visitors that we expect to be in the table
 *
 */
function _wpsc_create_well_known_visitors() {

	global $wpdb;

	// user id 1 will be used for a well known bot user
	$wpdb->insert( $wpdb->wpsc_visitors, array( 'id' => 1 ) );
}


if ( defined( 'DOING_AJAX' ) && DOING_AJAX ) {

	add_action( 'wp_ajax_wpsc_migrate_anonymous_user', '_wpsc_meta_migrate_anonymous_user_worker' );
	add_action( 'wp_ajax_nopriv_wpsc_migrate_anonymous_user', '_wpsc_meta_migrate_anonymous_user_worker' );

	function _wpsc_meta_migrate_anonymous_user_worker() {

		global $wpdb;

		$blog_prefix = is_multisite() ? $wpdb->get_blog_prefix() : '';
		$key_pattern = "{$blog_prefix}_wpsc_";

		wp_suspend_cache_addition( true );

		$sql = 'SELECT ID FROM '. $wpdb->users . ' WHERE user_login LIKE "\_%" AND user_email = "" AND user_login = user_nicename AND user_login = display_name LIMIT 100';
		$user_ids = $wpdb->get_col( $sql, 0 );

		// Create an array to store users to be removed.
		$bin = array();

		foreach ( $user_ids as $user_id ) {

			$wpdb->query( 'INSERT INTO ' . $wpdb->wpsc_visitors . '(`id`) VALUES ( ' . $user_id . ' )' );

			wpsc_set_visitor_expiration( $user_id,  DAY_IN_SECONDS );

			$meta = get_user_meta( $user_id );
			foreach ( $meta as $key => $value ) {

				if ( strpos( $key, $key_pattern ) === FALSE )
					continue;

				$short_key = str_replace( $key_pattern, '', $key );
				if ( $short_key !== 'cart' ) {
					wpsc_add_visitor_meta( $user_id , $short_key, $value[0] );
				} else {
					$wpsc_user_cart = maybe_unserialize( base64_decode( $value[0] ) );

					if ( ! ($wpsc_user_cart instanceof wpsc_cart) ) {
						$wpsc_user_cart = new wpsc_cart();
					} else {
						continue;
					}
				}
			}

			$comment_count = $wpdb->get_var( 'SELECT COUNT(comment_ID) FROM ' . $wpdb->comments. ' WHERE user_id = ' . $user_id );
			if ( ! count_user_posts( $user_id ) && ! $comment_count ) {
				//wp_delete_user( $user_id );
				// Add user to bin.
				$bin[] = $user_id;
			}
		}

		// Remove users.
		if ( ! empty( $bin ) ) {
			// Convert $bin to string.
			$bin = implode( ',', $bin );
			$wpdb->query( 'DELETE FROM ' . $wpdb->users . ' WHERE ID IN (' . $bin . ')' );
			$wpdb->query( 'DELETE FROM ' . $wpdb->usermeta . ' WHERE user_id IN (' . $bin . ')' );
		}

		wp_suspend_cache_addition( false );
		exit( 0 );
	}

}

add_action( 'wpsc_migrate_anonymous_user_cron', '_wpsc_meta_migrate_anonymous_user_cron' );


function _wpsc_meta_migrate_anonymous_user_cron() {

	global $wpdb;

	set_time_limit( 10 * 60 ); // 10 minutes maximum for the cron

	// WPEC created user records with a funky format,  no email is a dead giveaway, as is login, user name and display name being idnentical with the '_'
	$sql = 'SELECT count( ID ) FROM '. $wpdb->users . ' WHERE user_login LIKE "\_%" AND user_email = "" AND user_login = user_nicename AND user_login = display_name LIMIT 1';
	$ids_to_migrate = $user_ids = $wpdb->get_var( $sql );

	if ( $ids_to_migrate ) {
		$response = wp_safe_remote_post( admin_url( 'admin-ajax.php' ) . '?action=wpsc_migrate_anonymous_user' , array(  'blocking' => true, ) );
		wp_schedule_single_event( time() + 30 , 'wpsc_migrate_anonymous_user_cron' );
	} else {
		wpsc_core_flush_temporary_data();
	}
}


/**
 * custmer/visitor/user meta has been known by different identifiers. we are trying to standardize on using
 * the uniquename value in the form definition for well known shopper meta.  this function allows
 * old meta keys to return the proper meta value from the database
 *
 * @since 3.8.14
 * @access private
 * @param unknown $meta_keys
 * @return string
 */
function _wpsc_visitor_meta_key_replacements( $meta_keys ) {

	$meta_keys['billing_region']           = 'billingregion';
	$meta_keys['billing_country']          = 'billingcountry';
	$meta_keys['shipping_region']          = 'shippingregion';
	$meta_keys['shipping_country']         = 'shippingcountry';
	$meta_keys['shipping_zip']             = 'shippingpostcode';
	$meta_keys['shipping_zipcode']         = 'shippingpostcode';
	$meta_keys['billing_zip']              = 'billingpostcode';
	$meta_keys['billing_zipcode']          = 'billingpostcode';
	$meta_keys['shippingzip']              = 'shippingpostcode';
	$meta_keys['billingzip']               = 'billingpostcode';
	$meta_keys['shipping_same_as_billing'] = 'shippingSameBilling';
	$meta_keys['delivertoafriend']         = 'shippingSameBilling';
	$meta_keys['shipping_state']           = 'shippingstate';
	return $meta_keys;
}

add_filter( 'wpsc_visitor_meta_key_replacements', '_wpsc_visitor_meta_key_replacements' );


/*
 * Keep track of which visitor location attributes are changing,  when the attributes are done changing
 * at an apprpriate place in the flow there will be a call to _wpsc_has_visitor_location changed.  When
 * that function runs it will check if there has been a change and will fire an action to whomever has
 * hooked it to tell them it's time to do what ever they need to do with the changed location.
 *
 * By keeping track of which attributes have changed on the location different modules can decide what
 * they might need to recalculate.  An example.  USPS rates are dependant on origin and destination
 * zip codes, UPS rates use origin and destination zip codes and destination street address to calculate
 * shipment costs.
 */

/*
 * Record what is changing about the visitors location
 *
 * @since 3.8.14
 * @access private
 *
 * @param string location value being set
 * @param string location attribute name ( see unique_name field checkout definitions)
 * @param int    the visitor/customer unique id
 *
 * @return true if this is a location change, false if we already new that the specified part of the location changed
 *
 */
function _wpsc_visitor_location_is_changing( $meta_value, $meta_key, $visitor_id ) {
	$location_change_updated = false;

	$what_about_the_visitor_location_changed = wpsc_get_visitor_meta( $visitor_id, 'location_attributes_changed', true );
	if ( ! $what_about_the_visitor_location_changed ) {
		$what_about_the_visitor_location_changed = array();
	}

	if ( ! array_key_exists( $meta_key, $what_about_the_visitor_location_changed ) ) {
		$what_about_the_visitor_location_changed[$meta_key] = $meta_value;
		wpsc_update_visitor_meta( $visitor_id, 'location_attributes_changed', $what_about_the_visitor_location_changed );
		$location_change_updated = true;
	}

	return $location_change_updated;
}

/*
 * find out what has changed with visitor location
*
* @since 3.8.14
* @access private
*
* @param int   $visitor_id the visitor/customer unique id
*
* @return array          key value pairs, the key is the unique name of the location element
*                        that changed, the value is the new value assigned to the location attribute
*
*/
function _wpsc_visitor_location_what_changed( $visitor_id = false ) {

	if ( ! $visitor_id ) {
		$visitor_id = wpsc_get_current_customer_id();
	}

	$what_about_the_visitor_location_changed = wpsc_get_visitor_meta( $visitor_id, 'location_attributes_changed', true );
	if ( ! $what_about_the_visitor_location_changed ) {
		$what_about_the_visitor_location_changed = array();
	}

	return $what_about_the_visitor_location_changed;
}

/*
 * clear any tracked changes in shipping location, presumable when shipping quotes are recalculated
*
* @since 3.8.14
* @access private
*
* @param int   $visitor_id the visitor/customer unique id
*
* @return array          key value pairs, the key is the unique name of the location element
*                        that changed, the value is the new value assigned to the location attribute
*
*/
function _wpsc_visitor_location_clear_tracked_changes( $visitor_id = false ) {

	if ( ! $visitor_id ) {
		$visitor_id = wpsc_get_current_customer_id();
	}

	wpsc_delete_visitor_meta( $visitor_id, 'location_attributes_changed' );

	return true;
}

add_action( 'wpsc_before_get_shipping_method', '_wpsc_visitor_location_clear_tracked_changes', 10, 0 );
add_action( 'wpsc_before_shopping_cart_page', '_wpsc_visitor_location_clear_tracked_changes', 10, 0 );

/*
 * It might seem a tad verbose to attach a seperate hook to each meta item but doing it this
 * way as several advantages.
 *
 * 	1) If a developer wants to change the fact that changing the shipping city changes the users location
 * all they have to do is remove the action.
 *
 *  2) Conversely, if someone wants to define an arbitrary attribute to cause the user's location as changing.
 *  For example if the shopper was an interplanetary space traveler and they were moving to Titan, the dev
 *  could add a planet field to checkout shipping information and all the heavy lifting would be taken care
 *  of for them.
 *
 */
add_action( 'wpsc_updated_visitor_meta_shippingregion', '_wpsc_visitor_location_is_changing', _WPSC_USER_META_HOOK_PRIORITY , 3 );
add_action( 'wpsc_updated_visitor_meta_shippingaddress', '_wpsc_visitor_location_is_changing', _WPSC_USER_META_HOOK_PRIORITY , 3 );
add_action( 'wpsc_updated_visitor_meta_shippingcity', '_wpsc_visitor_location_is_changing', _WPSC_USER_META_HOOK_PRIORITY , 3 );
add_action( 'wpsc_updated_visitor_meta_shippingstate', '_wpsc_visitor_location_is_changing', _WPSC_USER_META_HOOK_PRIORITY , 3 );
add_action( 'wpsc_updated_visitor_meta_shippingcountry', '_wpsc_visitor_location_is_changing', _WPSC_USER_META_HOOK_PRIORITY , 3 );
add_action( 'wpsc_updated_visitor_meta_shippingpostcode', '_wpsc_visitor_location_is_changing', _WPSC_USER_META_HOOK_PRIORITY , 3 );
add_action( 'wpsc_updated_visitor_meta', '_wpsc_vistor_shipping_same_as_billing_meta_update', _WPSC_USER_META_HOOK_PRIORITY, 3 );


/*
 * Check if the visitor location has changed, if it has inform those who have requested notification
 *
 * Note that there are two actions fired when location has been found to have changed.
 * The first action tells those who are listening for its broadcast that the vistor
 * location has changed, which elements are changed, and that it is time to do any
 * calculations that may alter any customer meta, and most importantly the
 * meta that is related to a persons address.
 *
 * The second action contains the parameters that have changed, and it's a signal to the code
 * that it's safe to consume the customer meta.
 *
 * Developers have the choice of using both hooks, or either one based on what is appropriate
 * to the circumstance.
 *
 * An example where a well behaved and cooperative shipping plugin would shoose to implement both hooks
 * would be a full implementation of a USPS shipping validation and indicia generation.  The first hook
 * would be used to request the postal service validate and cleanse the desitination shipping address. The
 * cleansed address elements would be stored into customer meta for other plugins and other part of WPEC
 * to take advantage of.
 *
 * The second hook would be use to generate the shipping quotes after other code that may adjust the destination
 * address recorded thier inputs.
 *
 * @param int | boolean visitor id if knowm, false or empty for the current customer
 * @since 3.8.14
 *
 * @access private
 *
 *
 */
function _wpsc_has_visitor_location_changed( $visitor_id = false ) {

	$what_about_the_visitor_location_changed = wpsc_get_visitor_meta( $visitor_id, 'location_attributes_changed', true );

	if ( ! is_array( $what_about_the_visitor_location_changed ) && ! empty( $what_about_the_visitor_location_changed ) ) {
		do_action( 'wpsc_visitor_location_changing', $what_about_the_visitor_location_changed, $visitor_id );
	}

	$what_about_the_visitor_location_changed = wpsc_get_visitor_meta( $visitor_id, 'location_attributes_changed', true );

	if ( ! is_array( $what_about_the_visitor_location_changed ) && ! empty( $what_about_the_visitor_location_changed ) ) {
		do_action( 'wpsc_visitor_location_changed', $what_about_the_visitor_location_changed, $visitor_id );
	}
}

/**
 * Tries to turn an arbitrary value into a valid bool looking at the contents, including for strings like false and no, ...
 *
 * @param varies $value      value to boolify
 *
 * @return boolean true or false
 */
function _wpsc_make_value_into_bool( $value ) {
	if ( ! is_bool( $value ) ) {
		if ( empty( $value ) ) {
			$value = false;
		} elseif ( is_numeric( $value ) ) {
			$value = (bool) $value;
		} elseif ( is_string( $value ) ) {
			$value = strtolower( $value );
			if ( $value == 'no' || $value == 'false' ) {
				$value = false;
			} else {
				$value = true;
			}
		} elseif ( is_array( $value ) ) {
			$value = ! empty( $value );
		} else {
			$value = (bool) $value;
		}
	}

	return $value;
}

/**
 * when visitor meta is updated we need to check if the shipping same as billing
 * option is selected.  If so we need to update the corresponding meta value.
 *
 * @since 3.8.14
 * @access private
 * @param $meta_value varies value being stored
 * @param $meta_key string name of the attribute being stored
 * @param $visitor_id int id of the visitor to which the attribute applies
 * @return n/a
 */
function _wpsc_vistor_shipping_same_as_billing_meta_update( $meta_value, $meta_key, $visitor_id ) {

	// remove the action so we don't cause an infinite loop
	remove_action( 'wpsc_updated_visitor_meta', '_wpsc_vistor_shipping_same_as_billing_meta_update', _WPSC_USER_META_HOOK_PRIORITY );

	// if the shipping same as billing option is being checked then copy meta from billing to shipping
	if ( $meta_key == 'shippingSameBilling' ) {
		$meta_value = _wpsc_make_value_into_bool( $meta_value );

		if ( $meta_value ) {

			$checkout_names = wpsc_checkout_unique_names();

			foreach ( $checkout_names as $meta_key ) {
				$meta_key_starts_with_billing = strpos( $meta_key, 'billing', 0 ) === 0;

				if ( $meta_key_starts_with_billing ) {
					$other_meta_key_name = 'shipping' . substr( $meta_key, strlen( 'billing' ) );
					if ( in_array( $other_meta_key_name, $checkout_names ) ) {
						$billing_meta_value = wpsc_get_customer_meta( $meta_key );
						wpsc_update_visitor_meta( $visitor_id, $other_meta_key_name, $billing_meta_value );
					}
				}
			}
		}
	} else {
		$shipping_same_as_billing = wpsc_get_visitor_meta( $visitor_id, 'shippingSameBilling', true );

		if ( $shipping_same_as_billing ) {

			$meta_key_starts_with_billing  = strpos( $meta_key, 'billing', 0 ) === 0;
			$meta_key_starts_with_shipping = strpos( $meta_key, 'shipping', 0 ) === 0;

			if ( $meta_key_starts_with_billing ) {
				$checkout_names = wpsc_checkout_unique_names();

				$other_meta_key_name = 'shipping' . substr( $meta_key, strlen( 'billing' ) );

				if ( in_array( $other_meta_key_name, $checkout_names ) ) {
					wpsc_update_visitor_meta( $visitor_id, $other_meta_key_name, $meta_value );
				}
			} elseif ( $meta_key_starts_with_shipping ) {
				$checkout_names = wpsc_checkout_unique_names();

				$other_meta_key_name = 'billing' . substr( $meta_key, strlen( 'shipping' ) );

				if ( in_array( $other_meta_key_name, $checkout_names ) ) {
					wpsc_update_visitor_meta( $visitor_id, $other_meta_key_name, $meta_value );
				}
			}
		}
	}

	// restore the action we removed at the start
	add_action( 'wpsc_updated_visitor_meta', '_wpsc_vistor_shipping_same_as_billing_meta_update', _WPSC_USER_META_HOOK_PRIORITY, 3 );
}