<?php
/**
 * One file seen by the walker.
 *
 * Built by the adapter; ask FileInspector::needs() first to know which of
 * md5 / sha256 / head / content are worth reading for this path.
 *
 * - path     string   Relative to ABSPATH, '/' separators, no leading '/' ("wp-includes/version.php").
 * - size     int      Bytes.
 * - readable bool     False when the file could not be opened: no rule runs, it is counted as unreadable.
 * - md5      ?string  Lowercase hex md5 of the whole file (core and plugin folders), null if not computed.
 * - sha256   ?string  Lowercase hex sha256 (plugin folders, optional), null if not computed.
 * - head     ?string  First Assumptions::HEAD_BYTES bytes (uploads, plugin headers), null if not read.
 * - content  ?string  Whole file when size <= Assumptions::CONTENT_MAX_BYTES and needs()['content'], else null.
 * - mtime    ?int     Unix modification time, null if unknown.
 *
 * @package Timaub\AfterHackChecklist
 */

namespace Timaub\AfterHackChecklist\Domain;

final class FileEntry {
	/** @var string */
	public $path = '';
	/** @var int */
	public $size = 0;
	/** @var bool */
	public $readable = true;
	/** @var string|null */
	public $md5;
	/** @var string|null */
	public $sha256;
	/** @var string|null */
	public $head;
	/** @var string|null */
	public $content;
	/** @var int|null */
	public $mtime;

	public static function fromArray( array $a ): self {
		$f           = new self();
		$f->path     = ltrim( str_replace( '\\', '/', (string) $a['path'] ), '/' );
		$f->size     = isset( $a['size'] ) ? (int) $a['size'] : 0;
		$f->readable = isset( $a['readable'] ) ? (bool) $a['readable'] : true;
		$f->md5      = isset( $a['md5'] ) ? strtolower( (string) $a['md5'] ) : null;
		$f->sha256   = isset( $a['sha256'] ) ? strtolower( (string) $a['sha256'] ) : null;
		$f->head     = isset( $a['head'] ) ? (string) $a['head'] : null;
		$f->content  = isset( $a['content'] ) ? (string) $a['content'] : null;
		$f->mtime    = isset( $a['mtime'] ) ? (int) $a['mtime'] : null;
		if ( null === $f->head && null !== $f->content ) {
			$f->head = substr( $f->content, 0, Assumptions::HEAD_BYTES );
		}
		return $f;
	}

	public function toArray(): array {
		return array(
			'path'     => $this->path,
			'size'     => $this->size,
			'readable' => $this->readable,
			'md5'      => $this->md5,
			'sha256'   => $this->sha256,
			'head'     => $this->head,
			'content'  => $this->content,
			'mtime'    => $this->mtime,
		);
	}

	/** Content if read, else head, else ''. Always bounded by CONTENT_MAX_BYTES. */
	public function text(): string {
		$t = null !== $this->content ? $this->content : (string) $this->head;
		return substr( $t, 0, Assumptions::CONTENT_MAX_BYTES );
	}
}