<?php
/**
 * Form messages whose email could not be sent (F-FORMS-03).
 *
 * @package ForensixDigital
 */

declare(strict_types=1);

namespace ForensixDigital\Apps\Forms;

defined( 'ABSPATH' ) || exit;

use ForensixDigital\Services\Findings\FindingStore;
use ForensixDigital\Services\Findings\Observation;
use ForensixDigital\Services\Findings\Priority;
use ForensixDigital\Services\Scan\StoredContentCheck;
use ForensixDigital\Services\Sources\Source;

/**
 * Messages are saved before any email is sent, so nothing is lost when the mail fails, but the
 * owner still has to know that the notification never arrived. This adds one finding to a site
 * scan while saved messages have a failed notification.
 */
final class MailFailureCheck implements StoredContentCheck {

	public const ID = 'forms.mail_failed';

	/**
	 * Creates the check.
	 *
	 * @param string       $app     App id the finding belongs to.
	 * @param FindingStore $store   Findings.
	 * @param EntryStore   $entries Saved messages.
	 */
	public function __construct( private string $app, private FindingStore $store, private EntryStore $entries ) {}

	/**
	 * Records the finding in a single step.
	 *
	 * @param int                  $scan_id Scan id.
	 * @param array<string, mixed> $cursor  Not used.
	 * @return array<string, mixed>|null
	 */
	public function step( int $scan_id, array $cursor ): ?array {
		$failed = $this->entries->failed_mail();
		if ( $failed > 0 ) {
			$source = new Source( Source::OPTION, 'forensix_forms' );
			$this->store->record(
				$scan_id,
				$this->app,
				new Observation(
					self::ID,
					Priority::HIGH,
					Priority::ERROR,
					__( 'Form messages arrived but the email about them was not sent', 'forensix-digital' ),
					home_url( '/' ),
					$source->type,
					$source->ref,
					__( 'Forms', 'forensix-digital' ),
					array( 'count' => $failed )
				),
				admin_url( 'admin.php?page=forensix-forms' ),
				sprintf(
					/* translators: %d: number of messages. */
					_n( '%d message', '%d messages', $failed, 'forensix-digital' ),
					$failed
				)
			);
		}
		return null;
	}
}