mediawiki-extensions-AbuseFilter/includes/Filter/Filter.php

<?php

namespace MediaWiki\Extension\AbuseFilter\Filter;

use LogicException;

/**
 * Immutable value object representing a "complete" filter. This can be used to represent filters
 * that already exist in the database.
 */
class Filter extends AbstractFilter {
	/** @var LastEditInfo */
	protected $lastEditInfo;
	/** @var int|null Can be null if not specified */
	protected $id;
	/** @var int|null Can be null if the filter is not current */
	protected $hitCount;
	/** @var bool|null Can be null if the filter is not current */
	protected $throttled;

	/**
	 * @param Specs $specs
	 * @param Flags $flags
	 * @param callable|array[] $actions Array with params or callable that will return them
	 * @phan-param array[]|callable():array[] $actions
	 * @param LastEditInfo $lastEditInfo
	 * @param int|null $id
	 * @param int|null $hitCount
	 * @param bool|null $throttled
	 */
	public function __construct(
		Specs $specs,
		Flags $flags,
		$actions,
		LastEditInfo $lastEditInfo,
		?int $id = null,
		?int $hitCount = null,
		?bool $throttled = null
	) {
		parent::__construct( $specs, $flags, $actions );
		$this->lastEditInfo = clone $lastEditInfo;
		$this->id = $id;
		$this->hitCount = $hitCount;
		$this->throttled = $throttled;
	}

	/**
	 * TEMPORARY HACK.
	 * @param \stdClass $row
	 * @return static
	 * @codeCoverageIgnore
	 */
	public static function newFromRow( \stdClass $row ): self {
		return new self(
			new Specs(
				trim( $row->af_pattern ),
				// FIXME: Make the DB fields for these NOT NULL (T263324)
				(string)$row->af_comments,
				(string)$row->af_public_comments,
				$row->af_actions !== '' ? explode( ',', $row->af_actions ) : [],
				$row->af_group
			),
			new Flags(
				(bool)$row->af_enabled,
				(bool)$row->af_deleted,
				(bool)$row->af_hidden,
				(bool)$row->af_global
			),
			function () {
				// @phan-suppress-previous-line PhanTypeMismatchArgument
				throw new LogicException( 'Not yet implemented!' );
			},
			new LastEditInfo(
				(int)$row->af_user,
				$row->af_user_text,
				$row->af_timestamp
			),
			(int)$row->af_id,
			isset( $row->af_hit_count ) ? (int)$row->af_hit_count : null,
			isset( $row->af_throttled ) ? (bool)$row->af_throttled : null
		);
	}

	/**
	 * TEMPORARY HACK
	 * @return \stdClass
	 * @codeCoverageIgnore
	 */
	public function toDatabaseRow(): \stdClass {
		// T67807: integer 1's & 0's might be better understood than booleans
		return (object)[
			'af_id' => $this->id,
			'af_pattern' => $this->specs->getRules(),
			'af_public_comments' => $this->specs->getName(),
			'af_comments' => $this->specs->getComments(),
			'af_group' => $this->specs->getGroup(),
			'af_actions' => implode( ',', $this->specs->getActionsNames() ),
			'af_enabled' => (int)$this->flags->getEnabled(),
			'af_deleted' => (int)$this->flags->getDeleted(),
			'af_hidden' => (int)$this->flags->getHidden(),
			'af_global' => (int)$this->flags->getGlobal(),
			'af_user' => $this->lastEditInfo->getUserID(),
			'af_user_text' => $this->lastEditInfo->getUserName(),
			'af_timestamp' => $this->lastEditInfo->getTimestamp(),
			'af_hit_count' => $this->hitCount,
			'af_throttled' => (int)$this->throttled,
		];
	}

	/**
	 * @return LastEditInfo
	 */
	public function getLastEditInfo(): LastEditInfo {
		return clone $this->lastEditInfo;
	}

	/**
	 * @return int|null
	 */
	public function getID(): ?int {
		return $this->id;
	}

	/**
	 * @return int
	 */
	public function getUserID(): int {
		return $this->lastEditInfo->getUserID();
	}

	/**
	 * @return string
	 */
	public function getUserName(): string {
		return $this->lastEditInfo->getUserName();
	}

	/**
	 * @return string
	 */
	public function getTimestamp(): string {
		return $this->lastEditInfo->getTimestamp();
	}

	/**
	 * @return int|null
	 */
	public function getHitCount(): ?int {
		return $this->hitCount;
	}

	/**
	 * @return bool|null
	 */
	public function isThrottled(): ?bool {
		return $this->throttled;
	}

	/**
	 * Make sure we don't leave any (writeable) reference
	 */
	public function __clone() {
		parent::__clone();
		$this->lastEditInfo = clone $this->lastEditInfo;
	}
}