<?php
/**
 * Integrations: Base Class
 *
 * @package     AffiliateWP Checkout Referrals
 * @subpackage  Integrations
 * @copyright   Copyright (c) 2021, Sandhills Development, LLC
 * @license     http://opensource.org/licenses/gpl-2.0.php GNU Public License
 * @since       1.0.0
 *
 * phpcs:disable Generic.WhiteSpace.ScopeIndent.Incorrect
 */

#[\AllowDynamicProperties]

/**
 * Base integration class.
 *
 * @since 1.0.0
 */
class Affiliate_WP_Checkout_Referrals_Base {

	public $context;

	public function __construct() {
		$this->init();
	}

	/**
	 * Gets things started
	 *
	 * @access  public
	 * @since   1.0
	 * @return  void
	 */
	public function init() {}

	/**
	 * Check to see if user is already tracking a referral link in their cookies
	 *
	 * @return boolean true if tracking affiliate, false otherwise
	 * @since  1.0
	 */
	public function already_tracking_referral() {

		$affiliate_id = affiliate_wp()->tracking->get_fallback_affiliate_id();

		// Check if valid affiliate link on initial page load.
		if ( $affiliate_id && $this->is_valid_affiliate( $affiliate_id ) ) {
			return (bool) true;
		}

		// Check if the logged in user is linked to an affiliate.
		if ( is_user_logged_in() && $this->is_user_linked() ) {
			return (bool) true;
		}

		// Get tracking cookie name.
		$affwp_version = defined( 'AFFILIATEWP_VERSION' ) ? AFFILIATEWP_VERSION : 'undefined';
		if ( version_compare( $affwp_version, '2.7.1', '>=' ) ) {
			$ref_cookie = affiliate_wp()->tracking->get_cookie_name( 'referral' );
		} else {
			$ref_cookie = 'affwp_ref';
		}

		$tracking_referral = isset( $_COOKIE[ $ref_cookie ] ) && $this->is_valid_affiliate( $_COOKIE[ $ref_cookie ] );

		return (bool) $tracking_referral;
	}

	/**
	 * Retrieves the array of affiliates.
	 *
	 * @since 1.0
	 *
	 * @return array Affiliate IDs and their corresponding user IDs.
	 */
	public function get_affiliates() {

		$args = array(
			'status' => 'active',
			'number' => -1
		);

		/**
		 * Filters the arguments used to retrieve affiliates for assigning an affiliate at checkout.
		 *
		 * @since 1.0.8
		 *
		 * @param array  $args    Arguments passed to Affiliate_WP_DB_Affiliates::get_affiliates(). Defaults to
		 *                        retrieving all active affiliates.
		 * @param string $context Slug for the integration being used, such as 'woocommerce', 'edd', or 'rcp'.
		 */
		$args = apply_filters( 'affwp_checkout_referrals_get_affiliates_args', $args, $this->context );

		// Get all active affiliates
		$affiliates = affiliate_wp()->affiliates->get_affiliates( $args );

		$affiliate_list = array();

		if ( $affiliates ) {
			foreach ( $affiliates as $affiliate ) {
				$affiliate_list[ $affiliate->affiliate_id ] = $affiliate->user_id;
			}
		}

		return $affiliate_list;
	}

	/**
	 * Retrieves the list of affiliates to feed the select.
	 *
	 * @since 1.0.9
	 * @since 1.2.2 Updated to say "Select Affiliate" as the default option instead
	 *               of "Select".
	 *
	 * @param array $affiliate_list Array of affiliates IDs and their corresponding display.
	 *
	 * @return array Affiliate IDs and their corresponding display sorted.
	 */
	public function get_affiliates_select_list( $affiliate_list ) {
		$affiliates = array( 0 => __( 'Select Affiliate', 'affiliatewp-checkout-referrals' ) );

		// build out a list by display
		$display = affwp_cr_affiliate_display();
		foreach ( $affiliate_list as $affiliate_id => $user_id ) {
			$user_info = get_userdata( $user_id );

			if ( false !== $user_info ) {
				$affiliates[ $affiliate_id ] = $user_info->$display;
			}
		}

		// sort list if alphabetical
		$sorting = affwp_cr_affiliates_sorting_order();
		if( 'alphabetical' === $sorting ) {
			uksort( $affiliates, function( $id1, $id2 ) use ( $affiliates ) {
				if( 0 === $id1 ) {  // leave item "Select" at the top
					return -1;
				}
				$affiliate1 = strtolower( $affiliates[$id1] );
				$affiliate2 = strtolower( $affiliates[$id2] );
				return strcmp( $affiliate1, $affiliate2 );
			} );
		}

		return $affiliates;
	}

	/**
	 * Show affiliate select menu or input field
	 *
	 * @since  1.0.3
	 * @return void
	 */
	public function show_select_or_input() {

		if ( $this->already_tracking_referral() ) {
		 	return;
		}

		// get affiliate list
		$affiliate_list = $this->get_affiliates();

		$description  = affwp_cr_checkout_text();
		$required     = affwp_cr_require_affiliate();

		$required_html = '';

		if ( $required ) {
			switch ( $this->context ) {
				case 'edd':
					$required_html = ' <span class="edd-required-indicator">*</span>';
					break;
			}
		}

		$required = $required ? ' <abbr title="required" class="required">*</abbr>' : '';

		?>

		<fieldset class="<?php echo $this->context; ?>-affiliate-fieldset">
		<p>
			<?php if ( $description ) : ?>
			<label for="<?php echo $this->context;?>-affiliate"><?php echo esc_attr( $description ); ?><?php echo $required_html; ?></label>
			<?php endif; ?>

			<?php do_action( 'affwp_checkout_referrals_after_label' ); ?>

			<?php if ( 'input' === $this->get_affiliate_selection() ) : // input menu ?>

				<input type="text" id="<?php echo $this->context; ?>-affiliate" name="<?php echo $this->context;?>_affiliate" />

			<?php else : // select menu ?>

				<?php $affiliates = $this->get_affiliates_select_list( $affiliate_list ); ?>

				<select id="<?php echo $this->context;?>-affiliate" name="<?php echo $this->context;?>_affiliate" class="<?php echo $this->context;?>-select">
				<?php foreach ( $affiliates as $affiliate_id => $affiliate_display ) : ?>
					<option value="<?php echo esc_attr( $affiliate_id ); ?>"><?php echo $affiliate_display; ?></option>
				<?php endforeach; ?>
				</select>

			<?php endif; ?>

		</p>
	</fieldset>

	<?php
	}

	/**
	 * Set the affiliate ID.
	 *
	 * This overrides a tracked affiliate id
	 *
	 * @param mixed  $affiliate_id The Affiliate ID (sometimes username).
	 * @param int    $reference    The Order ID (usually).
	 * @param string $context      The context (e.g. `woocommerce`).
	 *
	 * @since  1.0.1
	 * @return int
	 */
	public function set_affiliate_id( $affiliate_id, $reference, $context ) {

		// This allow the tracked affiliate to always take precedence over the affiliate
		// selected at checkout.
		$tracked_affiliate_id = affiliate_wp()->tracking->get_affiliate_id();

		if ( $tracked_affiliate_id ) {
			// Return the tracked affiliate ID.
			return absint( $tracked_affiliate_id );

		}

		// phpcs:ignore WordPress.Security.NonceVerification.Missing -- We sanitize later.
		$posted_affiliate = $_POST[ "{$this->context}_affiliate" ];

		// Input field. Accepts either an affiliate ID or username.
		if ( 'input' === $this->get_affiliate_selection() ) {
			if ( isset( $posted_affiliate ) && $posted_affiliate ) {

				// Affiliate ID.
				if ( is_numeric( $posted_affiliate ) ) {

					$affiliate_id = $posted_affiliate;

				// Username.
				} elseif ( is_string( $posted_affiliate ) ) {

					// Get affiliate ID from username.
					$user = get_user_by( 'login', sanitize_text_field( urldecode( $posted_affiliate ) ) );

					if ( $user ) {
						$affiliate_id = affwp_get_affiliate_id( $user->ID );
					}
				}
			}

		// Select Dropdown.
		} else {

			if ( isset( $posted_affiliate ) && $posted_affiliate ) {
				$affiliate_id = $posted_affiliate;
			}
		}

		// Return the affiliate ID.
		return absint( $affiliate_id );
	}

	/**
	 * Get affiliate selection
	 * @since 1.0.3
	 */
	public function get_affiliate_selection() {

		$affiliate_selection = affiliate_wp()->settings->get( 'checkout_referrals_affiliate_selection' );

		return $affiliate_selection;
	}

	/**
	 * Validates an affiliate
	 *
	 * @since 1.0.3
	 * @param $affiliate $affiliate username or ID of affiliate
	 * @return boolean true if affiliate is valid, false otherwise
	 */
	public function is_valid_affiliate( $affiliate = '' ) {

		// set flag to false
		$valid_affiliate = false;

		if ( is_numeric( $affiliate ) ) {

			// affiliate ID provided
			if ( affwp_is_active_affiliate( $affiliate ) ) {
				$valid_affiliate = true;
			}

		} else {

			// username provided. Uppercase or lowercase usernames are ok
			if ( affwp_is_active_affiliate( affiliate_wp()->tracking->get_affiliate_id_from_login( $affiliate ) ) ) {
				$valid_affiliate = true;
			}

		}

		return $valid_affiliate;
	}

	/**
	 * Error messages
	 *
	 * @since 1.0.3
	 */
	public function get_error( $affiliate = '' ) {

		// Whether an affiliate is required to be selected or entered
		$require_affiliate = affiliate_wp()->settings->get( 'checkout_referrals_require_affiliate' );

		// either input or select menu
		$affiliate_selection = $this->get_affiliate_selection();

		// the affiliate that was submitted
		$affiliate_submitted = isset( $affiliate ) && $affiliate ? $affiliate : '';

		$error = '';

		/**
		 * Affiliate is required but not affiliate was selected/entered
		 */
		if ( $require_affiliate && ! $affiliate_submitted ) {

			if ( 'input' === $affiliate_selection ) {
				// input field
				$error = __( 'Please enter an affiliate', 'affiliatewp-checkout-referrals' );

			} else {
				// select menu
				$error = __( 'Please select an affiliate', 'affiliatewp-checkout-referrals' );
			}

		} else {

			/**
			 * Validate the affiliate submitted
			 * Set error if affiliate was submitted but the affiliate is invalid
			 */

			if ( $affiliate_submitted && ! $this->is_valid_affiliate( $affiliate_submitted ) ) {
				$error = __( 'Please enter a valid affiliate', 'affiliatewp-checkout-referrals' );
			}

		}

		if ( $error ) {
			return apply_filters( 'affwp_checkout_referrals_require_affiliate_error', $error );
		} else {
			return false;
		}

	}

	/**
	 * Check to see if the logged in user is linked to an affiliate.
	 *
	 * @since  1.0.7
	 * @return boolean true if user is linked to an affiliate, false otherwise
	 */
	public function is_user_linked() {

		if ( function_exists( 'affiliate_wp_lifetime_commissions' ) && true === version_compare( AFFILIATEWP_VERSION, '2.2', '>=' ) ) {

			$user_email = is_user_logged_in() ? wp_get_current_user()->user_email : false;

			if ( $user_email ) {

				$customer = affiliate_wp()->customers->get_by( 'email', $user_email );

				if ( $customer ) {

					$affiliate_id = affwp_get_customer_meta( $customer->customer_id, 'affiliate_id' );

					if ( $affiliate_id ) {

						return (bool) true;

					}
				}

			}

		}

		return (bool) false;

	}

}