<?php

namespace Kirby\Toolkit;

use Kirby\Exception\ErrorPageException;
use Kirby\Exception\Exception;

/**
 * Basic pagination handling
 *
 * @package   Kirby Toolkit
 * @author    Bastian Allgeier <bastian@getkirby.com>
 * @link      https://getkirby.com
 * @copyright Bastian Allgeier GmbH
 * @license   https://opensource.org/licenses/MIT
 */
class Pagination
{
    use Properties {
        setProperties as protected baseSetProperties;
    }

    /**
     * The current page
     *
     * @var int
     */
    protected $page;

    /**
     * Total number of items
     *
     * @var int
     */
    protected $total = 0;

    /**
     * The number of items per page
     *
     * @var int
     */
    protected $limit = 20;

    /**
     * Whether validation of the pagination page
     * is enabled; will throw Exceptions if true
     *
     * @var bool
     */
    public static $validate = true;

    /**
     * Creates a new pagination object
     * with the given parameters
     *
     * @param array $props
     */
    public function __construct(array $props = [])
    {
        $this->setProperties($props);
    }

    /**
     * Creates a pagination instance for the given
     * collection with a flexible argument api
     *
     * @param \Kirby\Toolkit\Collection $collection
     * @param mixed ...$arguments
     * @return self
     */
    public static function for(Collection $collection, ...$arguments)
    {
        $a = $arguments[0] ?? null;
        $b = $arguments[1] ?? null;

        $params = [];

        if (is_array($a) === true) {

            /**
             * First argument is an option array
             *
             * $collection->paginate([...])
             */
            $params = $a;
        } elseif (is_int($a) === true && $b === null) {

            /**
             * First argument is the limit
             *
             * $collection->paginate(10)
             */
            $params['limit'] = $a;
        } elseif (is_int($a) === true && is_int($b) === true) {

            /**
             * First argument is the limit,
             * second argument is the page
             *
             * $collection->paginate(10, 2)
             */
            $params['limit'] = $a;
            $params['page']  = $b;
        } elseif (is_int($a) === true && is_array($b) === true) {

            /**
             * First argument is the limit,
             * second argument are options
             *
             * $collection->paginate(10, [...])
             */
            $params = $b;
            $params['limit'] = $a;
        }

        // add the total count from the collection
        $params['total'] = $collection->count();

        // remove null values to make later merges work properly
        $params = array_filter($params);

        // create the pagination instance
        return new static($params);
    }

    /**
     * Getter for the current page
     *
     * @deprecated 3.3.0 Setter is no longer supported, use $pagination->clone()
     * @return int
     */
    public function page(int $page = null): int
    {
        if ($page !== null) {
            throw new Exception('$pagination->page() setter is no longer supported, use $pagination->clone()'); // @codeCoverageIgnore
        }

        return $this->page;
    }

    /**
     * Getter for the total number of items
     *
     * @deprecated 3.3.0 Setter is no longer supported, use $pagination->clone()
     * @return int
     */
    public function total(int $total = null): int
    {
        if ($total !== null) {
            throw new Exception('$pagination->total() setter is no longer supported, use $pagination->clone()'); // @codeCoverageIgnore
        }

        return $this->total;
    }

    /**
     * Getter for the number of items per page
     *
     * @deprecated 3.3.0 Setter is no longer supported, use $pagination->clone()
     * @return int
     */
    public function limit(int $limit = null): int
    {
        if ($limit !== null) {
            throw new Exception('$pagination->limit() setter is no longer supported, use $pagination->clone()'); // @codeCoverageIgnore
        }

        return $this->limit;
    }

    /**
     * Returns the index of the first item on the page
     *
     * @return int
     */
    public function start(): int
    {
        $index = $this->page() - 1;

        if ($index < 0) {
            $index = 0;
        }

        return $index * $this->limit() + 1;
    }

    /**
     * Returns the index of the last item on the page
     *
     * @return int
     */
    public function end(): int
    {
        $value = ($this->start() - 1) + $this->limit();

        if ($value <= $this->total()) {
            return $value;
        }

        return $this->total();
    }

    /**
     * Returns the total number of pages
     *
     * @return int
     */
    public function pages(): int
    {
        if ($this->total() === 0) {
            return 0;
        }

        return ceil($this->total() / $this->limit());
    }

    /**
     * Returns the first page
     *
     * @return int
     */
    public function firstPage(): int
    {
        return $this->total() === 0 ? 0 : 1;
    }

    /**
     * Returns the last page
     *
     * @return int
     */
    public function lastPage(): int
    {
        return $this->pages();
    }

    /**
     * Returns the offset (i.e. for db queries)
     *
     * @return int
     */
    public function offset(): int
    {
        return $this->start() - 1;
    }

    /**
     * Checks if the given page exists
     *
     * @param int $page
     * @return bool
     */
    public function hasPage(int $page): bool
    {
        if ($page <= 0) {
            return false;
        }

        if ($page > $this->pages()) {
            return false;
        }

        return true;
    }

    /**
     * Checks if there are any pages at all
     *
     * @return bool
     */
    public function hasPages(): bool
    {
        return $this->total() > $this->limit();
    }

    /**
     * Checks if there's a previous page
     *
     * @return bool
     */
    public function hasPrevPage(): bool
    {
        return $this->page() > 1;
    }

    /**
     * Returns the previous page
     *
     * @return int|null
     */
    public function prevPage()
    {
        return $this->hasPrevPage() ? $this->page() - 1 : null;
    }

    /**
     * Checks if there's a next page
     *
     * @return bool
     */
    public function hasNextPage(): bool
    {
        return $this->end() < $this->total();
    }

    /**
     * Returns the next page
     *
     * @return int|null
     */
    public function nextPage()
    {
        return $this->hasNextPage() ? $this->page() + 1 : null;
    }

    /**
     * Checks if the current page is the first page
     *
     * @return bool
     */
    public function isFirstPage(): bool
    {
        return $this->page() === $this->firstPage();
    }

    /**
     * Checks if the current page is the last page
     *
     * @return bool
     */
    public function isLastPage(): bool
    {
        return $this->page() === $this->lastPage();
    }

    /**
     * Creates a range of page numbers for Google-like pagination
     *
     * @param int $range
     * @return array
     */
    public function range(int $range = 5): array
    {
        $page  = $this->page();
        $pages = $this->pages();
        $start = 1;
        $end   = $pages;

        if ($pages <= $range) {
            return range($start, $end);
        }

        $start = $page - (int)floor($range/2);
        $end   = $page + (int)floor($range/2);

        if ($start <= 0) {
            $end   += abs($start);
            $start  = 1;
        }

        if ($end > $pages) {
            $start -= $end - $pages;
            $end    = $pages;
        }

        return range($start, $end);
    }

    /**
     * Returns the first page of the created range
     *
     * @param int $range
     * @return int
     */
    public function rangeStart(int $range = 5): int
    {
        return $this->range($range)[0];
    }

    /**
     * Returns the last page of the created range
     *
     * @param int $range
     * @return int
     */
    public function rangeEnd(int $range = 5): int
    {
        $range = $this->range($range);
        return array_pop($range);
    }

    /**
     * Sets the properties limit, total and page
     * and validates that the properties match
     *
     * @param array $props Array with keys limit, total and/or page
     * @return self
     */
    protected function setProperties(array $props)
    {
        $this->baseSetProperties($props);

        // ensure that page is set to something, otherwise
        // generate "default page" based on other params
        if ($this->page === null) {
            $this->page = $this->firstPage();
        }

        // allow a page value of 1 even if there are no pages;
        // otherwise the exception will get thrown for this pretty common case
        $min = $this->firstPage();
        $max = $this->pages();
        if ($this->page === 1 && $max === 0) {
            $this->page = 0;
        }

        // validate page based on all params if validation is enabled,
        // otherwise limit the page number to the bounds
        if ($this->page < $min || $this->page > $max) {
            if (static::$validate === true) {
                throw new ErrorPageException('Pagination page ' . $this->page . ' does not exist, expected ' . $min . '-' . $max);
            } else {
                $this->page = max(min($this->page, $max), $min);
            }
        }

        return $this;
    }

    /**
     * Sets the number of items per page
     *
     * @param int $limit
     * @return self
     */
    protected function setLimit(int $limit = 20)
    {
        if ($limit < 1) {
            throw new Exception('Invalid pagination limit: ' . $limit);
        }

        $this->limit = $limit;
        return $this;
    }

    /**
     * Sets the total number of items
     *
     * @param int $total
     * @return self
     */
    protected function setTotal(int $total = 0)
    {
        if ($total < 0) {
            throw new Exception('Invalid total number of items: ' . $total);
        }

        $this->total = $total;
        return $this;
    }

    /**
     * Sets the current page
     *
     * @param int|string|null $page Int or int in string form;
     *                              automatically determined if null
     * @return self
     */
    protected function setPage($page = null)
    {
        // if $page is null, it is set to a default in the setProperties() method
        if ($page !== null) {
            if (is_numeric($page) !== true || $page < 0) {
                throw new Exception('Invalid page number: ' . $page);
            }

            $this->page = (int)$page;
        }

        return $this;
    }

    /**
     * Returns an array with all properties
     *
     * @return array
     */
    public function toArray(): array
    {
        return [
            'page'      => $this->page(),
            'firstPage' => $this->firstPage(),
            'lastPage'  => $this->lastPage(),
            'pages'     => $this->pages(),
            'offset'    => $this->offset(),
            'limit'     => $this->limit(),
            'total'     => $this->total(),
            'start'     => $this->start(),
            'end'       => $this->end(),
        ];
    }
}