<?php

/**
 * Customer notification email
 *
 * Customer notification email sent to customer when a there's an upcoming payment/expity/free trial expiry.
 *
 * @class WCS_Email_Customer_Notification
 * @version 7.7.0
 * @package WooCommerce/Classes/Emails
 */
class WCS_Email_Customer_Notification extends WC_Email {

	public function __construct() {
		// These values are only available later, but it's an available placeholder.
		$this->placeholders = array_merge(
			[
				'{customers_first_name}' => '',
				'{time_until_renewal}'   => '',
			],
			$this->placeholders
		);

		parent::__construct();
	}

	/**
	 * Initialise Settings Form Fields - these are generic email options most will use.
	 */
	public function init_form_fields() {
		/* translators: %s: list of placeholders */
		$placeholder_text  = sprintf( __( 'Available placeholders: %s', 'woocommerce-subscriptions' ), '<code>' . esc_html( implode( '</code>, <code>', array_keys( $this->placeholders ) ) ) . '</code>' );
		$this->form_fields = array(
			'enabled'            => array(
				'title'   => __( 'Enable/Disable', 'woocommerce-subscriptions' ),
				'type'    => 'checkbox',
				'label'   => __( 'Enable this email notification. Disabled automatically on staging sites.', 'woocommerce-subscriptions' ),
				'default' => 'yes',
			),
			'subject'            => array(
				'title'       => __( 'Subject', 'woocommerce-subscriptions' ),
				'type'        => 'text',
				'desc_tip'    => true,
				'description' => $placeholder_text,
				'placeholder' => $this->get_default_subject(),
				'default'     => '',
			),
			'heading'            => array(
				'title'       => __( 'Email heading', 'woocommerce-subscriptions' ),
				'type'        => 'text',
				'desc_tip'    => true,
				'description' => $placeholder_text,
				'placeholder' => $this->get_default_heading(),
				'default'     => '',
			),
			'additional_content' => array(
				'title'       => __( 'Additional content', 'woocommerce-subscriptions' ),
				'description' => __( 'Text to appear below the main email content.', 'woocommerce-subscriptions' ) . ' ' . $placeholder_text,
				'css'         => 'width:400px; height: 75px;',
				'placeholder' => __( 'N/A', 'woocommerce-subscriptions' ),
				'type'        => 'textarea',
				'default'     => $this->get_default_additional_content(),
				'desc_tip'    => true,
			),
			'email_type'         => array(
				'title'       => __( 'Email type', 'woocommerce-subscriptions' ),
				'type'        => 'select',
				'description' => __( 'Choose which format of email to send.', 'woocommerce-subscriptions' ),
				'default'     => 'html',
				'class'       => 'email_type wc-enhanced-select',
				'options'     => $this->get_email_type_options(),
				'desc_tip'    => true,
			),
		);
	}

	/**
	 * Trigger function.
	 *
	 * @return void
	 */
	public function trigger( $subscription_id ) {
		$subscription    = wcs_get_subscription( $subscription_id );
		$this->object    = $subscription;
		$this->recipient = $subscription->get_billing_email();

		if ( ! $this->should_send_reminder_email( $subscription ) ) {
			return;
		}

		$this->setup_locale();

		try {
			$this->placeholders['{customers_first_name}'] = $subscription->get_billing_first_name();
			$this->placeholders['{time_until_renewal}']   = $this->get_time_until_date( $subscription, 'next_payment' );

			$result = $this->send( $this->get_recipient(), $this->get_subject(), $this->get_content(), $this->get_headers(), $this->get_attachments() );

			if ( $result ) {
				/* translators: 1: Notification type, 2: customer's email. */
				$order_note_msg = sprintf( __( '%1$s was successfully sent to %2$s.', 'woocommerce-subscriptions' ), $this->title, $this->recipient );
			} else {
				/* translators: 1: Notification type, 2: customer's email. */
				$order_note_msg = sprintf( __( 'Attempt to send %1$s to %2$s failed.', 'woocommerce-subscriptions' ), $this->title, $this->recipient );
			}

			$subscription->add_order_note( $order_note_msg );
		} finally {
			$this->restore_locale();
		}
	}

	/**
	 * Get content for the HTML-version of the email.
	 *
	 * @return string
	 */
	public function get_content_html() {
		$subscription = $this->object;

		if ( wcs_can_user_renew_early( $subscription, $subscription->get_customer_id() )
			&& $subscription->payment_method_supports( 'subscription_date_changes' )
			&& WCS_Early_Renewal_Manager::is_early_renewal_enabled()
			&& WCS_Manual_Renewal_Manager::is_manual_renewal_enabled()
		) {
			$url_for_renewal = wcs_get_early_renewal_url( $subscription );
			$can_renew_early = true;
		} else {
			$url_for_renewal = $subscription->get_view_order_url();
			$can_renew_early = false;
		}

		return wc_get_template_html(
			$this->template_html,
			[
				'subscription'                => $subscription,
				'order'                       => $subscription->get_parent(),
				'email_heading'               => $this->get_heading(),
				'subscription_time_til_event' => $this->get_time_until_date( $subscription, $this->get_relevant_date_type() ),
				'subscription_event_date'     => $this->get_formatted_date( $subscription, $this->get_relevant_date_type() ),
				'url_for_renewal'             => $url_for_renewal,
				'can_renew_early'             => $can_renew_early,
				'additional_content'          => is_callable(
					[
						$this,
						'get_additional_content',
					]
				) ? $this->get_additional_content() : '',
				// WC 3.7 introduced an additional content field for all emails.
				'sent_to_admin'               => false,
				'plain_text'                  => false,
				'email'                       => $this,
			],
			'',
			$this->template_base
		);
	}

	/**
	 * Get content for the plain (text, non-HTML) version of the email.
	 *
	 * @return string
	 */
	public function get_content_plain() {
		$subscription = $this->object;

		if ( wcs_can_user_renew_early( $subscription, $subscription->get_customer_id() )
			&& $subscription->payment_method_supports( 'subscription_date_changes' )
			&& WCS_Early_Renewal_Manager::is_early_renewal_enabled()
			&& WCS_Manual_Renewal_Manager::is_manual_renewal_enabled()
		) {
			$url_for_renewal = wcs_get_early_renewal_url( $subscription );
			$can_renew_early = true;
		} else {
			$url_for_renewal = $subscription->get_view_order_url();
			$can_renew_early = false;
		}

		return wc_get_template_html(
			$this->template_plain,
			[
				'subscription'                => $subscription,
				'order'                       => $subscription->get_parent(),
				'email_heading'               => $this->get_heading(),
				'subscription_time_til_event' => $this->get_time_until_date( $subscription, $this->get_relevant_date_type() ),
				'subscription_event_date'     => $this->get_formatted_date( $subscription, $this->get_relevant_date_type() ),
				'url_for_renewal'             => $url_for_renewal,
				'can_renew_early'             => $can_renew_early,
				'additional_content'          => is_callable(
					[
						$this,
						'get_additional_content',
					]
				) ? $this->get_additional_content() : '',
				// WC 3.7 introduced an additional content field for all emails.
				'sent_to_admin'               => false,
				'plain_text'                  => true,
				'email'                       => $this,
			],
			'',
			$this->template_base
		);
	}

	/**
	 * Returns number of days until date_type for subscription.
	 *
	 * This method is needed when sending out the emails as the email queue might be delayed, in which case the email
	 * should state the correct number of days until the date_type.
	 *
	 * @param WC_Subscription $subscription Subscription to check.
	 * @param string $date_type Date type to count days to.
	 *
	 * @return false|int|string Number of days from now until the date type event's time. Empty string if subscription doesn't have the date_type defined. False if DateTime can't process the data.
	 */
	public function get_time_until_date( $subscription, $date_type ) {
		$next_event = $subscription->get_date( $date_type );

		if ( ! $next_event ) {
			return '';
		}

		$next_event_dt = new DateTime( $next_event, new DateTimeZone( 'UTC' ) );
		$now           = new DateTime( 'now', new DateTimeZone( 'UTC' ) );

		// Both dates to midnight so we only compare days, not hours.
		$next_event_dt->setTime( 0, 0 );
		$now->setTime( 0, 0 );

		// Add some buffer, otherwise it will claim that only 2 full days are left when in reality it's 2 days, 23 hours and 59 minutes.
		$now->modify( '-1 hour' );
		return human_time_diff( $now->getTimestamp(), $next_event_dt->getTimestamp() );
	}

	/**
	 * Return subscription's date of date type in localized format.
	 *
	 * @param WC_Subscription $subscription
	 * @param string $date_type
	 *
	 * @return string
	 */
	public function get_formatted_date( $subscription, $date_type ) {
		return date_i18n( wc_date_format(), $subscription->get_time( $date_type, 'site' ) );
	}

	/**
	 * Default content to show below main email content.
	 *
	 * @return string
	 */
	public function get_default_additional_content() {
		return __( 'Thank you for choosing {site_title}!', 'woocommerce-subscriptions' );
	}

	/**
	 * Determines whether the customer reminder email should be sent.
	 *
	 * Reminder emails are not sent if:
	 * - The Customer Notification feature is disabled.
	 * - The store is a staging or development site.
	 * - The recipient email address is missing.
	 * - The subscription's billing cycle is too short.
	 *
	 * @param WC_Subscription $subscription
	 *
	 * @return bool
	 */
	public function should_send_reminder_email( $subscription ) {
		if ( ! $this->is_enabled() ) {
			return $this->log_reminder_email_not_sent( $subscription, __( 'Reminder emails disabled.', 'woocommerce-subscriptions' ) );
		}

		$skipped_reasons = [];

		if ( ! WC_Subscriptions_Email_Notifications::should_send_notification() ) {
			$skipped_reasons[] = __( 'Not a production site, or notifications have been globally disabled', 'woocommerce-subscriptions' );
		}

		if ( ! $this->get_recipient() ) {
			$skipped_reasons[] = __( 'Recipient not found', 'woocommerce-subscriptions' );
		}

		if ( WCS_Action_Scheduler_Customer_Notifications::is_subscription_period_too_short( $subscription ) ) {
			$skipped_reasons[] = __( 'Subscription billing cycle too short', 'woocommerce-subscriptions' );
		}

		return empty( $skipped_reasons ) || $this->log_reminder_email_not_sent( $subscription, $skipped_reasons );
	}

	/**
	 * If WCS_DEBUG or WP_DEBUG is enabled, attach a note to the subscription to detail why a reminder email was not sent.
	 *
	 * @param WC_Subscription $subscription
	 * @param array|string    $reasons
	 *
	 * @return false
	 */
	private function log_reminder_email_not_sent( $subscription, $reasons ) {
		if ( ( defined( 'WCS_DEBUG' ) && WCS_DEBUG ) || ( defined( 'WP_DEBUG' ) && WP_DEBUG ) ) {
			$reasons = (array) $reasons;

			// translators: %1$s: email title, %2$s: list of reasons why email was skipped.
			$subscription->add_order_note( sprintf( __( 'Skipped sending "%1$s": %2$s', 'woocommerce-subscriptions' ), $this->title, '<br>- ' . implode( '<br>- ', $reasons ) ) );
		}

		return false;
	}
}