<?php
/**
 * Value object representing the outcome of a single security check.
 *
 * @package AardwolfSecurityScanner
 */

if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

/**
 * Class Aardwolf_Check_Result.
 *
 * A small immutable-ish data holder describing one finding: its status,
 * severity, a human explanation and the remediation the site owner should
 * perform.
 */
class Aardwolf_Check_Result {

	// Status constants. A check either passes, raises a warning, or fails.
	const STATUS_PASS = 'pass';
	const STATUS_WARN = 'warning';
	const STATUS_FAIL = 'fail';
	const STATUS_INFO = 'info';

	// Severity constants, loosely following common pen-test reporting bands.
	const SEVERITY_INFO   = 'info';
	const SEVERITY_LOW    = 'low';
	const SEVERITY_MEDIUM = 'medium';
	const SEVERITY_HIGH   = 'high';

	/** @var string Machine readable identifier for the check. */
	public $id;

	/** @var string Human readable label. */
	public $label;

	/** @var string Group/category the check belongs to. */
	public $category;

	/** @var string One of the STATUS_* constants. */
	public $status;

	/** @var string One of the SEVERITY_* constants. */
	public $severity;

	/** @var string Short summary of what was found. */
	public $summary;

	/** @var string Actionable remediation guidance. */
	public $remediation;

	/** @var string Optional reference/further-reading URL. */
	public $reference;

	/**
	 * Constructor.
	 *
	 * @param array $args {
	 *     @type string $id          Check identifier.
	 *     @type string $label       Human label.
	 *     @type string $category    Category name.
	 *     @type string $status      STATUS_* constant.
	 *     @type string $severity    SEVERITY_* constant.
	 *     @type string $summary     What was found.
	 *     @type string $remediation How to fix it.
	 *     @type string $reference   Optional URL.
	 * }
	 */
	public function __construct( array $args ) {
		$defaults = array(
			'id'          => '',
			'label'       => '',
			'category'    => '',
			'status'      => self::STATUS_INFO,
			'severity'    => self::SEVERITY_INFO,
			'summary'     => '',
			'remediation' => '',
			'reference'   => '',
		);

		$args = array_merge( $defaults, $args );

		$this->id          = (string) $args['id'];
		$this->label       = (string) $args['label'];
		$this->category    = (string) $args['category'];
		$this->status      = (string) $args['status'];
		$this->severity    = (string) $args['severity'];
		$this->summary     = (string) $args['summary'];
		$this->remediation = (string) $args['remediation'];
		$this->reference   = (string) $args['reference'];
	}

	/**
	 * Whether this result represents a problem that needs attention.
	 *
	 * @return bool
	 */
	public function is_problem() {
		return in_array( $this->status, array( self::STATUS_WARN, self::STATUS_FAIL ), true );
	}

	/**
	 * Numeric weight used when computing the overall security score.
	 * Higher severity failures cost more points.
	 *
	 * @return int
	 */
	public function weight() {
		switch ( $this->severity ) {
			case self::SEVERITY_HIGH:
				return 5;
			case self::SEVERITY_MEDIUM:
				return 3;
			case self::SEVERITY_LOW:
				return 1;
			default:
				return 0;
		}
	}

	/**
	 * Convert to a plain array for storage/JSON.
	 *
	 * @return array
	 */
	public function to_array() {
		return array(
			'id'          => $this->id,
			'label'       => $this->label,
			'category'    => $this->category,
			'status'      => $this->status,
			'severity'    => $this->severity,
			'summary'     => $this->summary,
			'remediation' => $this->remediation,
			'reference'   => $this->reference,
		);
	}

	/**
	 * Rehydrate from a stored array.
	 *
	 * @param array $data Stored data.
	 * @return Aardwolf_Check_Result
	 */
	public static function from_array( array $data ) {
		return new self( $data );
	}
}