<?php
/**
 * The base Model, implementing base methods useful in each Model implementation.
 *
 * @since   6.0.0
 *
 * @package TEC\Events\Custom_Tables\V1\Models
 */

namespace TEC\Events\Custom_Tables\V1\Models;

use Closure;
use Generator;
use Serializable;
use TEC\Common\Contracts\Container;
use TEC\Events\Custom_Tables\V1\Models\Formatters\Formatter;
use TEC\Events\Custom_Tables\V1\Models\Validators\ValidatorInterface;
use Tribe__Cache_Listener;

/**
 * Class Model
 *
 * @since   6.0.0
 *
 * @package TEC\Events\Custom_Tables\V1\Models
 *
 * @method static bool|int upsert( array $unique_by, array $data ) Update or Insert a new record into the table.
 * @method static Model|null find( mixed $value, string $column = null ) Find a record based on the $value and column provided
 * @method static Builder set_batch_size( int $size ) Sets the size of the batch the Builder should use to fetch models in unbound query methods like `find_all`.
 * @method static Generator find_all( mixed $value, string $column = null ) Find all the records based one the $value and column provided.
 * @method bool delete() Run a delete operation
 * @method static array get() An array with the result of a select constructed out with the current filters.
 * @method static int insert( array $data ) All the data than is going to be inserted.
 * @method static Builder where_in( string $column, array $in_values ) A list of all the records that match the query.
 * @method static Builder where_not_in( string $column, array $not_in_values ) A list of values that shouldn't match the query.
 * @method static Builder where( string $column, string $operator = null, string $value = null ) Set a where clause to filter the results.
 * @method static Builder where_raw( string $where, mixed ...$args ) Prepare and set a custom WHERE clause to filter the results.
 * @method static Builder limit( int $limit ) Sets the limit clause on the Query.
 * @method static Builder offset( int $offset ) Set the OFFSET clause on the Query.
 * @method static Builder order_by( string $column = null, string $order = 'ASC' ) Set the order by clause on the Query.
 * @method static Builder builder_instance() Get an instance from the Builder class.
 * @method static Builder count( string $column_name = null ) Count all the records that match the query.
 * @method static bool exists() If the SQL Query has at least one result on the Database.
 * @method static Builder join( string $table_name, string $left_column, string $right_column ) Creates an INNER JOIN statement.
 * @method static Builder output( string $output ) Sets the format that should be used to format results in SELECT queries.
 * @method static Builder all( ) Find all the records based on the built query.
 * @method static int upsert_set( array $data ) Update or Insert a multiple records into the table.
 * @method static array pluck( string $field ) Pluck a single field from the results.
 * @method static array map (callable $callback ) Maps from the results of the query to a new array using the callback.
 */
abstract class Model implements Serializable {
	/**
	 * A map of the Model extensions, `null` when not yet initialized.
	 *
	 * @since 6.0.0
	 *
	 * @var array<string,array<string,array<string,mixed>>>|null
	 */
	protected static $extensions;

	/**
	 * A map relating the columns of this model with a validation class.
	 *
	 * @since 6.0.0
	 * @var array<string,ValidatorInterface>
	 */
	protected $validations = [];

	/**
	 * A map relating the column of this model to the Formatter implementation for each.
	 *
	 * @since 6.0.0
	 *
	 * @var array<string,Formatter>
	 */
	protected $formatters = [];

	/**
	 * Hold the name of the table for this model.
	 *
	 * @since 6.0.0
	 *
	 * @var string The table where this model is persisted.
	 */
	protected $table = '';

	/**
	 * Get a list of the columns that passed the validation.
	 *
	 * @since 6.0.0
	 *
	 * @var array<string> An array with the name of the columns that are valid.
	 */
	private $valid_columns = [];

	/**
	 * An associative array with the key of the error and the error message when validation fails for that particular
	 * column.
	 *
	 * @since 6.0.0
	 *
	 * @var array<string, string>
	 */
	protected $errors = [];

	/**
	 * An associative array with the key of the error and the error message when validation fails for that particular
	 * column. This is cumulative and will retain errors aside from a specific instance. Useful when interacting with the
	 * models with the static API.
	 *
	 * @since 6.0.0
	 *
	 * @var array<string, string>
	 */
	protected static $static_errors = [];

	/**
	 * A reference to the current Service Provider instance.
	 *
	 * @since 6.0.0
	 *
	 * @var Container
	 */
	private $container;

	/**
	 * Array holding all the dynamic values attached to the object, before running the validation.
	 *
	 * @since 6.0.0
	 *
	 * @var array<string, mixed> An array holding the dynamic values set to this model.
	 */
	protected $data = [];

	/**
	 * A name of the column holding a reference to the primary key on this object.
	 *
	 * @since 6.0.0
	 *
	 * @var string $primary_key The name of the primary key.
	 */
	protected $primary_key = '';
	/**
	 * Define the properties or the columns used to create a hash associated with this model.
	 *
	 * @since 6.0.0
	 *
	 * @var array<string> A list with all the keys that are used to generate a hash for this model.
	 */
	protected $hashed_keys = [];

	/**
	 * Enable the model to indicate only a single field validation is happening, useful when we are just checking
	 * the value of a single column instead of a composer series of values.
	 *
	 * @since 6.0.0
	 *
	 * @var array<string, bool> $single_validation
	 */
	public $single_validations = [];

	/**
	 * A map from properties to either the callable that will resolve their value,
	 * or their previously resolved value.
	 *
	 *
	 * @since 6.0.0
	 *
	 * @var array<string,callable|int|float|string>
	 */
	protected $extended_properties = [];

	/**
	 * If this model is memoized, this is the key to retrieve it.
	 *
	 * @since 6.1.3
	 *
	 * @var null|string
	 */
	public $cache_key = null;

	/**
	 * Model constructor.
	 *
	 * @since 6.17.0 Marked $container as explicitly nullable.
	 *
	 * @param  array                    $data       An array with key => value pairs used to populate the model on creation of the object.
	 * @param  Container|null  $container  A reference to the current Dependency Injection container instance.
	 */
	public function __construct( array $data = [], ?Container $container = null ) {
		$this->data = $data;
		$this->container = $container ?: tribe();

		$this->filter_extensions();

		$extended_validators = static::$extensions[ $this->table ]['validators'] ?? [];
		$extended_formatters = static::$extensions[ $this->table ]['formatters'] ?? [];
		$extended_hashed_keys = static::$extensions[ $this->table ]['hashed_keys'] ?? [];
		$extended_properties = static::$extensions[ $this->table ]['properties'] ?? [];

		$this->validations = array_merge( $this->validations, $extended_validators );
		$this->formatters = array_merge( $this->formatters, $extended_formatters );
		$this->hashed_keys = array_merge( $this->hashed_keys, $extended_hashed_keys );
		$this->extended_properties = $extended_properties;
	}

	/**
	 * Flush this instances cache if it was cached.
	 *
	 * @since 6.1.3
	 */
	public function flush_cache() {
		if ( $this->cache_key ) {
			tribe_cache()->delete( $this->cache_key, Tribe__Cache_Listener::TRIGGER_SAVE_POST );
			$this->cache_key = null;
		}
	}

	/**
	 * Get the name of the table that is being affected by this model.
	 *
	 * @since 6.0.0
	 *
	 * @return string The name of the table used for this model.
	 */
	public function table_name() {
		return $this->table;
	}

	/**
	 * Get the name of the primary column of this model.
	 *
	 * @since 6.0.0
	 *
	 * @return string The name of the column with the primary key value.s
	 */
	public function primary_key_name() {
		return $this->primary_key;
	}

	/**
	 * Validates the Entry to make sure all of its data is valid and consistent.
	 *
	 * @since 6.0.0
	 * @since 6.17.0 Marked $columns as explicitly nullable.
	 *
	 * @param  array|null  $columns
	 *
	 * @return bool Whether the Entry is valid and consistent or not.
	 */
	public function validate( ?array $columns = null ) {
		// Reset all the columns before start.
		$this->valid_columns   = [];
		$this->errors          = [];
		static::$static_errors = [];

		if ( is_array( $columns ) ) {
			$validations = $columns;
		} else {
			$validations = array_keys( $this->validations );
		}

		foreach ( $validations as $name ) {
			// This validation does not exist don't use this property.
			if ( empty( $this->validations[ $name ] ) ) {
				continue;
			}

			$validator = $this->container->make( $this->validations[ $name ] );

			if ( ! $validator instanceof ValidatorInterface ) {
				continue;
			}

			if ( $validator->validate( $this, $name, $this->{$name} ) ) {
				$this->valid_columns[] = $name;
				continue;
			}

			$error_string                   = implode( " : ", $validator->get_error_messages() );
			$this->errors[ $name ]          = $error_string;
			static::$static_errors[ $name ] = $error_string;
		}

		if ( ! empty( $this->errors() ) ) {
			// For debug purposes, log validation errors.
			// These will fail update/insertions on the database.
			do_action( 'tribe_log',
				'debug',
				"Model failed validation.", [
					'source' => __METHOD__ . ':' . __LINE__,
					'errors' => $this->errors(),
				] );

			return false;
		}

		// No errors were found.
		return true;
	}

	/**
	 * If this function passed the validation or not.
	 *
	 * @since 6.0.0
	 *
	 * @return bool If this function passed the validation or not.
	 */
	public function is_valid() {
		return empty( $this->errors() );
	}

	/**
	 * Whether the validations on this model failed.
	 *
	 * @since 6.0.0
	 *
	 * @return bool If the validation on this model failed.
	 */
	public function is_invalid() {
		return ! $this->is_valid();
	}

	/**
	 * Returns the set of errors, if any, generated during the Entry validation.
	 *
	 * @since 6.0.0
	 *
	 * @return array<string> The set of errors, if any, generated during the Entry validation.
	 */
	public function errors() {
		// Remove all empty strings from the errors.
		return array_filter( $this->errors );
	}

	/**
	 * Returns the set of errors, if any, generated during validation across the most recent instances operation.
	 * This is useful for situations when interacting with models via the static API.
	 *
	 * @since 6.0.0
	 *
	 * @return array<string> The set of errors, if any, generated during the Entry validation.
	 */
	public static function last_errors() {
		return array_filter( static::$static_errors );
	}

	/**
	 * Format only the column that were considered or are marked as valid, only valid and formatted columns are considered
	 * as valid.
	 *
	 * @since 6.0.0
	 *
	 * @return array<array<string, mixed>, array<string>> An array with 2 elements, first the data as column => value, second array
	 *                                                    is the format of each column like '%d' and such.
	 */
	public function format() {
		$data   = [];
		$format = [];

		foreach ( $this->valid_columns as $name ) {
			// Not found on the format, don't save this value.
			if ( ! isset( $this->formatters[ $name ] ) ) {
				continue;
			}

			$formatter = $this->container->make( $this->formatters[ $name ] );
			if ( $formatter instanceof Formatter ) {
				$data[ $name ] = $formatter->format( $this->{$name} );
				if ( $data[ $name ] !== null ) {
					$format[ $name ] = $formatter->prepare();
				}
			}
		}

		return [ $data, $format ];
	}

	/**
	 * Create a unique hash for this occurrence.
	 *
	 * @since 6.0.0
	 *
	 * @param  array  $keys
	 *
	 * @return string|null The generated hash if valid, null otherwise.
	 */
	public function generate_hash() {
		if ( empty ( $this->hashed_keys ) ) {
			return null;
		}

		$this->validate( $this->hashed_keys );
		list( $data ) = $this->format();

		if ( $this->is_invalid() ) {
			return null;
		}

		$pieces = [];
		foreach ( $data as $column => $value ) {
			if ( $value !== null && in_array( $column, $this->hashed_keys, true ) ) {
				$pieces[] = $value;
			}
		}

		return sha1( implode( ':', $pieces ) );
	}

	/**
	 * Reset the data of the model back to a clear state.
	 *
	 * @since 6.0.0
	 */
	public function reset() {
		$this->data               = [];
		$this->errors             = [];
		static::$static_errors    = [];
		$this->single_validations = [];
		// If we have a cache, let's clear it.
		$this->flush_cache();

		return $this;
	}

	/**
	 * Any static method call that is not found is proxies to this magic method that creates a new instance of this model
	 * and forwards the call to the builder.
	 *
	 * @since 6.0.0
	 *
	 * @param  string  $name       The name of the method.
	 * @param  array   $arguments  An array with all the parameters to the method.
	 *
	 * @return mixed The result of calling a not found static method on this class.
	 */
	public static function __callStatic( $name, $arguments ) {
		return ( new static() )->{$name}( ...$arguments );
	}

	/**
	 * Any method that was not found on the model, pass it through the builder class.
	 *
	 * @since 6.0.0
	 *
	 * @param  string  $name       The name of the method.
	 * @param  array   $arguments  An array with all the parameters to the method.
	 *
	 * @return mixed The result of calling the method inside of the builder class.
	 */
	public function __call( $name, $arguments ) {
		if ( isset( static::$extensions[$this->table]['methods'][ $name ] ) ) {
			$method = static::$extensions[$this->table]['methods'][ $name ];

			if ( $method instanceof Closure ) {
				/*
				 * Extensions can define new methods on the Model using the `methods`
				 * entry of the extensions filter. To make the extension easier, bind
				 * this instance to the method.
				 */
				$method = Closure::bind( $method, $this );
			}

			// Use `call_user_func` as the method might have been provided as array.
			return call_user_func( $method, ...$arguments );
		}

		return ( new Builder( $this ) )->{$name}( ...$arguments );
	}

	/**
	 * Set a value to a dynamic property.
	 *
	 * @since 6.0.0
	 *
	 * @param  string  $name   The name of the property.
	 * @param  mixed   $value  The value of the property.
	 */
	public function __set( $name, $value ) {
		$this->data[ $name ] = $value;
	}

	/**
	 * Getter to access dynamic properties, to allow to change the value when reading from MySQL, due all properties
	 * are returned as string or NULL when those are null on the columns of each row.
	 *
	 * @since 6.0.0
	 *
	 * @param  string  $name  The name of the property.
	 *
	 * @return mixed|null null if the value does not exists mixed otherwise the the value to the dynamic property.
	 */
	public function __get( $name ) {
		if ( array_key_exists( $name, $this->extended_properties ) ) {
			if ( is_callable( $this->extended_properties[ $name ] ) ) {
				// Resolve the property value once.
				$this->extended_properties[ $name ] = $this->extended_properties[$name]( $this->data );
			}

			return $this->extended_properties[ $name ];
		}

		if ( array_key_exists( $name, $this->data ) ) {
			// Try to fin a method on this instance like `get_property_name_attribute
			$method = 'get_' . strtolower( $name ) . '_attribute';

			if ( method_exists( $this, $method ) ) {
				return $this->{$method}( $this->data[ $name ] );
			}

			return $this->data[ $name ];
		}

		return null;
	}

	/**
	 * Getter to retrieve all currently stored model values.
	 *
	 * @since 6.0.0
	 *
	 * @return array<string,mixed> The model data, in array format.
	 */
	public function get_values() {
		return $this->data;
	}

	/**
	 * Make sure when using `isset` or `empty` with a model the value reviews the dynamic properties instead.
	 *
	 * @since 6.0.0
	 *
	 * @param  string  $name  The name of the property.
	 *
	 * @return bool If the property has been defined as dynamic attribute.
	 */
	public function __isset( $name ) {
		return array_key_exists( $name, $this->data );
	}

	/**
	 * Create a new method to transform the values from a model into an array.
	 *
	 * @since 6.0.0
	 * @return array An array with the result of the data associated with this model.
	 */
	public function to_array() {
		$result = [];

		foreach ( $this->data as $key => $value ) {
			// Use dynamic getter to fire all the accessors.
			$result[ $key ] = $this->{$key};
		}

		return $result;
	}

	/**
	 * Returns whether a Column is valid for the model or not.
	 *
	 * @since 6.0.0
	 *
	 * @param  string  $column  The column to check against the Model.
	 *
	 * @return bool Whether a Column is valid for the model or not.
	 */
	public function valid_column( $column ) {
		return array_key_exists( $column, $this->validations );
	}

	/**
	 * If a model is cached, make sure only the important data is serialized, to reduce the amount of space that the
	 * object uses when stored as a string.
	 *
	 * @since 6.0.6
	 *
	 * @return array The array representation of the object.
	 */
	public function __serialize(): array {
		return $this->to_array();
	}

	/**
	 * If a model is cached, make sure only the important data is serialized, to reduce the amount of space that the
	 * object uses when stored as a string.
	 *
	 * @since 6.0.0
	 * @since 6.0.6 - Utilize magic method for 8.1 support.
	 *
	 * @return string The string representing the object.
	 */
	public function serialize(): string {
		return serialize( $this->__serialize() );
	}

	/**
	 * If this object is constructed out of a `unserialize` call make sure the properties are set up correctly on the
	 * object.
	 *
	 * @since 6.0.6
	 *
	 * @param  array  $serialized The array representation of the object.
	 */
	public function __unserialize(array $serialized): void {
		foreach ( $serialized as $column => $value ) {
			$this->{$column} = $value;
		}
	}

	/**
	 * If this object is constructed out of a `unserialize` call make sure the properties are set up correctly on the
	 * object.
	 *
	 * @since 6.0.0
	 * @since 6.0.6 - Utilize magic method for 8.1 support.
	 *
	 * @param  string  $serialized
	 */
	public function unserialize( $serialized ) {
		$this->__unserialize( unserialize( $serialized ) );
	}

	/**
	 * Mechanism to detect if the specified column was set as single validation.
	 *
	 * @since 6.0.0
	 *
	 * @param string $column The name of the column on the database where we are checking validation against with.
	 *
	 * @return bool `true` if the column was set as single validation `false` otherwise.
	 */
	public function has_single_validation( $column ) {
		return isset( $this->single_validations[ $column ] );
	}

	/**
	 * Mechanism to set a column with single validation
	 *
	 * @since 6.0.0
	 *
	 * @param string $column The name of the column on the database where we are checking validation against with.
	 *
	 * @return $this An instance to the current model.
	 */
	public function enable_single_validation( $column ) {
		$this->single_validations[ $column ] = true;

		return $this;
	}

	/**
	 * Mechanism to revert a single validation into a column.
	 *
	 * @since 6.0.0
	 *
	 * @param string $column The name of the column on the database where we are checking validation against with.
	 *
	 * @return $this An instance to the current model.
	 */
	public function disable_single_validation( $column ) {
		unset( $this->single_validations[ $column ] );

		return $this;
	}

	/**
	 * Allow to convert this model into a string value.
	 *
	 * @since 6.0.0
	 * @return string
	 */
	public function __toString() {
		return $this->serialize();
	}

	/**
	 * Filters the Model to allow its extension.
	 *
	 * To avoid performance issues, Models can only be extended before
	 * the `init` action.
	 *
	 * @since 6.0.0
	 *
	 * @return void The method does not return any value and has the side effect of
	 *              setting the static extensions property that will be applied to all
	 *              instances of the Model.
	 */
	private function filter_extensions() {
		// Filter at least once, and no more after `init`.
		if ( isset( static::$extensions[ $this->table_name() ] ) && did_action( 'init' ) ) {
			return;
		}

		/**
		 * Allows extending the Model to add fields, and required functionality, to it.
		 *
		 * @since 6.0.0
		 *
		 * @param array<string,array<string,mixed>> An array of possible extensions.
		 */
		$extensions = apply_filters( "tec_custom_tables_{$this->table}_model_v1_extensions", [
			'validators'  => [],
			'formatters'  => [],
			'hashed_keys' => [],
		] );

		static::$extensions[ $this->table ] = $extensions;
	}
}
