<?php
/**
 * Eventin Count Bookings Tool
 *
 * @package Aisentic\Integrations\Eventin
 */

declare(strict_types=1);

namespace Aisentic\Integrations\Eventin;

use Aisentic\Contracts\Read_Only_Tool_Contract;
use Aisentic\Util\Log;
use NeuronAI\Tools\PropertyType;
use NeuronAI\Tools\ToolProperty;

defined( 'ABSPATH' ) || exit;

/**
 * How many bookings there are, filtered and split.
 *
 * A booking is one Eventin order (an `etn-order` post). One booking can hold
 * several tickets, so bookings and attendees are different numbers.
 */
class Eventin_Count_Bookings_Tool extends Eventin_Stats_Base_Tool implements Read_Only_Tool_Contract {

	/**
	 * Booking statuses Eventin writes.
	 */
	public const STATUSES = [ 'completed', 'pending', 'failed', 'refunded', 'partially_refunded', 'waitlisted' ];

	/**
	 * Ways the count can be split.
	 */
	private const GROUPS = [ 'none', 'status', 'event', 'date' ];

	/**
	 * Constructor.
	 *
	 * @param Eventin_Stats_Query|null $query Count queries; tests pass a fake.
	 */
	public function __construct( ?Eventin_Stats_Query $query = null ) {
		parent::__construct(
			'eventin-count-bookings',
			'Count Eventin bookings (orders). Filter by event, status and booking date, and split the count by status, event or date. One booking can hold several attendees; for people or tickets use eventin-count-attendees. Never count the rows of a list instead. Every result has a status: "ok" means say the numbers from it; "needs_clarification" means ask the question it gives and never pick for them; "not_found" or "not_available" means say plainly you cannot see it and open the page in the result. Never assume a missing event or date range; "this month" and "last week" are fine, worked out from today. To open a page, use the page url in the result.',
			$query
		);
	}

	/**
	 * Define tool properties.
	 *
	 * @return array
	 */
	protected function properties(): array {
		return [
			new ToolProperty(
				name: 'event_id',
				type: PropertyType::NUMBER,
				description: 'Only bookings for this event.',
				required: false
			),
			new ToolProperty(
				name: 'event_name',
				type: PropertyType::STRING,
				description: 'Only bookings for the event with this title, when you do not have its ID.',
				required: false
			),
			new ToolProperty(
				name: 'status',
				type: PropertyType::STRING,
				description: 'Only bookings with this status. "completed" means paid and confirmed.',
				required: false,
				enum: self::STATUSES
			),
			new ToolProperty(
				name: 'date_from',
				type: PropertyType::STRING,
				description: 'Only bookings made on or after this day, as YYYY-MM-DD.',
				required: false
			),
			new ToolProperty(
				name: 'date_to',
				type: PropertyType::STRING,
				description: 'Only bookings made on or before this day, as YYYY-MM-DD.',
				required: false
			),
			new ToolProperty(
				name: 'group_by',
				type: PropertyType::STRING,
				description: 'Split the count. "date" gives one row per day for ranges up to 31 days, else per month. Default: none.',
				required: false,
				enum: self::GROUPS
			),
		];
	}

	/**
	 * Execute the tool.
	 *
	 * @param int|null    $event_id   Event ID.
	 * @param string|null $event_name Event title.
	 * @param string|null $status     Booking status.
	 * @param string|null $date_from  First day, Y-m-d.
	 * @param string|null $date_to    Last day, Y-m-d.
	 * @param string|null $group_by   Split.
	 * @return array
	 */
	public function __invoke( ?int $event_id = null, ?string $event_name = null, ?string $status = null, ?string $date_from = null, ?string $date_to = null, ?string $group_by = null ): array {
		return $this->answer( $event_id, $event_name, $status, $date_from, $date_to, $group_by );
	}

	/**
	 * Work out the answer.
	 *
	 * @param int|null    $event_id   Event ID.
	 * @param string|null $event_name Event title.
	 * @param string|null $status     Booking status.
	 * @param string|null $date_from  First day, Y-m-d.
	 * @param string|null $date_to    Last day, Y-m-d.
	 * @param string|null $group_by   Split.
	 * @return array
	 */
	private function answer( ?int $event_id, ?string $event_name, ?string $status, ?string $date_from, ?string $date_to, ?string $group_by ): array {
		$check = $this->guard( 'etn_manage_order' );
		if ( $check ) {
			return $check;
		}

		$page     = $this->page( __( 'Bookings', 'aisentic' ), '/bookings' );
		$status   = trim( (string) $status );
		$group_by = ( null === $group_by || '' === $group_by ) ? 'none' : $group_by;

		if ( '' !== $status && ! in_array( $status, self::STATUSES, true ) ) {
			return $this->unclear( "\"{$status}\" is not a booking status.", $page, self::STATUSES );
		}

		if ( ! in_array( $group_by, self::GROUPS, true ) ) {
			return $this->unclear( "Cannot split bookings by \"{$group_by}\".", $page, self::GROUPS );
		}

		$from = $this->read_date( $date_from );
		$to   = $this->read_date( $date_to );

		if ( false === $from || false === $to ) {
			return $this->unclear( 'The date could not be read. Dates must be YYYY-MM-DD.', $page );
		}

		if ( null !== $from && null !== $to && $from > $to ) {
			return $this->unclear( "The start date {$from} is after the end date {$to}.", $page );
		}

		list( $event_id, $event_title, $stop ) = $this->resolve_event( $event_id, $event_name, $page );
		if ( null !== $stop ) {
			return $stop;
		}

		try {
			$filters = array_filter(
				[
					'event_id'  => $event_id,
					'status'    => $status,
					'date_from' => $from,
					'date_to'   => $to,
				]
			);

			$counts = $this->query->count_records( 'booking', $filters, 'none' === $group_by ? '' : $group_by );

			$result = [
				'status'  => 'ok',
				'total'   => $counts['total'],
				'filters' => $filters + ( '' !== $event_title ? [ 'event_title' => $event_title ] : [] ),
				'page'    => $event_id ? $this->event_page( $event_id, $event_title ) : $page,
			];

			if ( 'none' !== $group_by ) {
				$result += $this->split( $counts['groups'], $group_by );
			}

			return $result;
		} catch ( \Throwable $e ) {
			Log::error( 'Eventin_Count_Bookings_Tool error', [ 'error' => $e->getMessage() ] );

			return [ 'error' => 'Could not count bookings: ' . $e->getMessage() ];
		}
	}

	/**
	 * Shape the split for the model.
	 *
	 * @param array<string,int> $groups   Raw groups.
	 * @param string            $group_by Split.
	 * @return array
	 */
	private function split( array $groups, string $group_by ): array {
		if ( 'event' !== $group_by ) {
			return [ 'by_' . $group_by => $groups ];
		}

		list( $kept, $folded, $others ) = $this->top_groups( $groups );

		$result = [ 'by_event' => $this->named_event_groups( $kept ) ];

		if ( $folded > 0 ) {
			$result['other_events'] = [
				'events'   => $folded,
				'bookings' => $others,
				'note'     => 'Only the 10 events with the most bookings are listed.',
			];
		}

		return $result;
	}
}