<?php

// (c) Copyright by authors of the Tiki Wiki CMS Groupware Project
//
// All Rights Reserved. See copyright.txt for details and a complete list of authors.
// Licensed under the GNU LESSER GENERAL PUBLIC LICENSE. See license.txt for details.
// $Id$

/**
 * Smarty plugin
 * @package Smarty
 * @subpackage plugins
 *
 * smarty_block_pagination_links: Generate pagination links
 *
 * url: base url to use for links (specified through the content between the pagination_links starting and ending tags).
 *    Defaults to the current URL.
 *
 * params:
 *  - cant: Total number of items. [required]
 *  - offset: Current offset. Defaults to 0.
 *  - reloff: Current relative offset (to keep the original offset unchanged). If not specified, reloff is not used and offset is changed.
 *  - itemname: Untranslated string to use as the item name. Defaults to 'Page'.
 *  - noimg: If set to 'y', will use text instead of images for next/prev links. Only images mode supports first/last links. Defaults to 'n'.
 *  - class: CSS class to use for the whole div. Defaults to 'mini'.
 *  - template: template (.tpl file) used for AJAX_href links. Special value 'noauto',
 *       to get the template that has the same name of the current script (by changing the file extension from .php to .tpl)
 *       and set htmlelement to 'tiki-center' as a default.
 *  - htmlelement: htmlelement used for AJAX_href links.
 *  - step: number to add to an offset to go to the next item. Defaults to 1.
 *  - clean: remove empty arguments from generated URLs (to reduce URL lenght). Defaults to 'y'.
 *  - next: show (or not) next (and last) links. Defaults to 'y' if next elements exists.
 *  - prev: show (or not) previous (and first) links. Defaults to 'y' if previous elements exists.
 *  - usedots: Defaults to 'y'. Only used when 'direct_pagination' pref is set to 'y'.
 *      Instead of displaying one link for each item, only display some items like this
 *      (dots are not replaced by links, it's just a separation text):
 *      1 2 3 ... k-2 k-1 k k+1 k+2 ...  n-2 n-1 n
 *  - offset_arg: Name of the URL argument that contains the offset. Defaults to 'offset'.
 *    - zero_based_offset: Items addressed as zero-based (defaults to 'y'). If 'n' then "one based" offset used (1 to cant + 1)
 *        (jb tiki5: only fully tested without reloffset and step=1)
 *    - show_numbers: Show/hide direct_pagination links, current and total numbers (Defaults to 'y')
 *  - _ajax : if set to 'n', will force disabling AJAX even if the ajax xajax feature is enabled (defaults to 'y')    AJAX_TODO
 *  - _onclick : to allow for custom onclick for link
 *  - offset_jsvar : the variable name of the javascript variable to store the requested offset when pagination link is clicked (does not work with reloff).
 */
function smarty_block_pagination_links($params, $url, $smarty, &$repeat)
{
    global $prefs;

    if ($repeat) {
        return;
    }

    if (isset($params['resultset'])) {
        $resultSet = $params['resultset'];
        $params['cant'] = count($resultSet);
        $params['offset'] = $resultSet->getOffset();
        $params['step'] = $resultSet->getMaxRecords();
        $params['estimate'] = $resultSet->getEstimate();
    }

    $html = '';
    $default_type = 'absolute_path';

    // Check main params and return no pagination links if there is a mistake
    if (! isset($params['cant']) || $params['cant'] <= 0) {
        return '';
    }
    if (isset($params['step']) && $params['step'] == -1) {
        return '';// display all
    }
    if (! isset($params['offset'])) {
        $params['offset'] = 0;
    }
    if (! isset($params['offset_arg'])) {
        $params['offset_arg'] = 'offset';
    }
    if (! isset($params['zero_based_offset'])) {
        $params['zero_based_offset'] = 'y';
    }
    if (! isset($params['show_numbers'])) {
        $params['show_numbers'] = 'y';
    }
    if (! isset($params['_onclick'])) {
        $params['_onclick'] = '';
    }

    if ($params['zero_based_offset'] != 'y') {
        //$params['offset']--;
        $zero_based_min = 1;
        $zero_based_maxminus = 0;
    } else {
        $zero_based_min = 0;
        $zero_based_maxminus = 1;
    }
    $params['_ajax'] = isset($params['_ajax']) ? $params['_ajax'] : 'y';
    if (
        isset($params['reloff']) && (
            $params['reloff'] + $params['offset'] >= $params['cant']
            || $params['reloff'] + $params['offset'] < $zero_based_min
        )
    ) {
        return '';
    }

    if (! isset($params['reloff']) && ($params['offset'] >= $params['cant'] + $zero_based_min || $params['offset'] < $zero_based_min)) {
        return '';
    }

    // Include smarty functions used below
    $smarty->loadPlugin('smarty_block_ajax_href');
    $smarty->loadPlugin('smarty_function_query');
    $smarty->loadPlugin('smarty_function_icon');

    // Make sure every params are initialized
    if (! isset($params['itemname'])) {
        $params['itemname'] = 'Page';
    }
    if (! isset($params['noimg'])) {
        $params['noimg'] = ($prefs['pagination_icons'] == 'n');
    }
    if (! isset($params['usedots'])) {
        $params['usedots'] = 'y';
    }
    if (! isset($params['class'])) {
        $params['class'] = 'mini';
    }
    if (! isset($params['htmlelement'])) {
        $params['htmlelement'] = 'tiki-center';
    }
    if (! isset($params['template'])) {
        $params['template'] = basename($_SERVER['PHP_SELF'], '.php') . '.tpl';
        if ($params['template'] == 'tiki-index.tpl') {
            $params['template'] = 'tiki-show_page.tpl';
        }
    }

    if (! file_exists('templates/' . $params['template']) || $params['template'] == 'noauto') {
        $params['htmlelement'] = '';
        $params['template'] = '';
    }

    if (! isset($params['step']) || $params['step'] <= 0) {
        $params['step'] = 1;
        $nb_pages = $params['cant'];
    } else {
        $nb_pages = ceil($params['cant'] / $params['step']);
    }

    if ($nb_pages == 0 || ($nb_pages == 1 && $prefs['pagination_hide_if_one_page'] == 'y')) {
        return '';
    }

    if (empty($url) || preg_match('/^\s*$/', $url)) {
        $url = smarty_function_query(['_type' => $default_type], $smarty);
    }

    // remove empty url arguments (done by default)
    if (! isset($params['clean']) || $params['clean'] == 'y') {
        $url = preg_replace('/(?<=\?|&amp;)[^=]+=(?=&amp;|$)/U', '', $url);
    }

    // remove old arguments that will be replaced and add new ones
    $url = preg_replace('/(?<=&amp;|&|\?)(move|reloff|' . $params['offset_arg'] . ')=[^&]*/', '', trim($url));

    // remove &amp; that are redundant or at the end of url
    $url = preg_replace('/(?:(\?|&amp;)(&amp;)+|(\?|&amp;))$/', '\\1', $url);

    $url_args_pos = strpos($url, '?');
    if ($url_args_pos === false) {
        $url .= '?';
    } elseif ($url_args_pos < strlen($url) - 1) {
        $url .= '&amp;';
    }

    if (isset($params['reloff'])) {
        $prev_offset = 'reloff=' . ($params['reloff'] - $params['step']) . '&amp;' . $params['offset_arg'] . '=' . $params['offset'];
        $next_offset = 'reloff=' . ($params['reloff'] + $params['step']) . '&amp;' . $params['offset_arg'] . '=' . $params['offset'];
        $prev_fast_offset = 'reloff=' . ($params['reloff'] - $params['step'] * ceil(
            $nb_pages / 10
        )) . '&amp;' . $params['offset_arg'] . '=' . $params['offset'];
        $next_fast_offset = 'reloff=' . ($params['reloff'] + $params['step'] * ceil(
            $nb_pages / 10
        )) . '&amp;' . $params['offset_arg'] . '=' . $params['offset'];
        $real_offset = $params['offset'] + $params['reloff'];
    } else {
        $prev_offset_val = max($zero_based_min, $params['offset'] - $params['step']);
        $prev_offset = $params['offset_arg'] . '=' . $prev_offset_val;
        $next_offset_val = min($params['cant'] - $zero_based_maxminus, $params['offset'] + $params['step']);
        $next_offset = $params['offset_arg'] . '=' . $next_offset_val;
        $prev_fast_offset_val = max($zero_based_min, $params['offset'] - $params['step'] * ceil($nb_pages / 10));
        $prev_fast_offset = $params['offset_arg'] . '=' . $prev_fast_offset_val;
        $next_fast_offset_val = min(
            $params['cant'] - $zero_based_maxminus,
            $params['offset'] + $params['step'] * ceil($nb_pages / 10)
        );
        $next_fast_offset = $params['offset_arg'] . '=' . $next_fast_offset_val;
        $real_offset = $params['offset'];
    }

    if (! isset($params['next'])) {
        $params['next'] = ($real_offset < ($nb_pages - $zero_based_maxminus) * $params['step']) ? 'y' : 'n';
    }
    if (! isset($params['prev'])) {
        $params['prev'] = ($real_offset > $zero_based_min) ? 'y' : 'n';
    }

    // Max. number of links when using direct pagination
    $max_middle_links = max(0, $prefs['direct_pagination_max_middle_links']);
    $max_ending_links = ($prefs['pagination_firstlast'] != 'n') ? max(
        0,
        $prefs['direct_pagination_max_ending_links']
    ) : 0;
    $max_links = (1 + $max_ending_links + $max_middle_links) * 2 + 1;

    if ($params['cant'] > 0) {
        $make_prevnext_link = function ($url, $content, $params, $class = 'prevnext', $linkoffset = 0) {
            $smarty = TikiLib::lib('smarty');

            $link = '<a class="page-link ' . $class . '" ';
            $url = TikiLib::tikiUrlOpt($url);
            if ($params['_ajax'] == 'y') {
                // setting javascript offset variable if requested
                if (! empty($params['offset_jsvar'])) {
                    $params['_onclick'] = $params['offset_jsvar'] . "=$linkoffset;" . $params['_onclick'];
                }

                $link .= smarty_block_ajax_href(
                    [
                        'template' => $params['template'],
                        'htmlelement' => $params['htmlelement'],
                        '_ajax' => $params['_ajax'],
                        '_onclick' => $params['_onclick'],
                    ],
                    $url,
                    $smarty,
                    false
                );
            } else {
                $link .= " href=\"$url\" ";
            }
            $link .= '>' . $content . '</a>';

            return $link;
        };

        if (($prefs['direct_pagination'] == 'y' || $prefs['nextprev_pagination'] === 'y') && $nb_pages > 1) {
            $html .= '<ul class="pagination justify-content-center">';

            if ($prefs['nextprev_pagination'] != 'n' || $params['show_numbers'] !== 'y') {
                if ($params['offset'] == 0) {
                    $html .= '<li class="page-item disabled"><span class="page-link">' .
                        ($params['noimg'] ? tr('Previous') : '«') . '</span></li>';
                } else {
                    $html .= '<li class="page-item">' . $make_prevnext_link(
                        $url . $prev_offset,
                        $params['noimg'] ? tr('Previous') : '«',
                        $params,
                        'prevnext prev',
                        $prev_offset_val
                    ) . '</li>';
                }
            }

            if ($params['show_numbers'] == 'y') {
                $last_dots = false;
                $page_num = floor($real_offset / $params['step']);
                foreach (range(0, $nb_pages - 1) as $k) {
                    if ($k + $zero_based_min == $page_num) {
                        $html .= '<li class="page-item active"><span class="page-link">' . ($k + 1) . ' <span class="sr-only">(' . tr(
                            'current'
                        ) . ')</span></span></li>';
                        $last_dots = false;
                    } elseif (
                        $params['usedots'] != 'y' ||
                        ($params['usedots'] == 'y' &&
                            ($nb_pages <= $max_links ||
                                ($k <= $max_ending_links &&
                                $prefs['pagination_firstlast'] != 'n') ||
                                ($k >= $nb_pages - $max_ending_links - 1 &&
                                $prefs['pagination_firstlast'] != 'n') ||
                                (abs($page_num - $k)) <= $max_middle_links ||
                                ($prefs['pagination_fastmove_links'] == 'y' &&
                                abs($page_num - $k) == ceil(
                                    $nb_pages / 10
                                ))
                            )
                        )
                    ) {
                        if (isset($params['reloff'])) {
                            $url_k = $params['offset_arg'] . '=' . $params['offset']
                                . '&amp;reloff=' . ($params['step'] * $k - $params['offset']);
                        } else {
                            $url_k_val = $params['step'] * ($k + $zero_based_min);
                            $url_k = $params['offset_arg'] . '=' . $url_k_val;
                        }
                        $html .= '<li>' . $make_prevnext_link(
                            $url . $url_k,
                            $k + 1,
                            $params,
                            'prevnext',
                            $url_k_val
                        ) . '</li>';
                        $last_dots = false;
                    } elseif (! $last_dots) {
                        $html .= '<li class="page-item disabled"><span class="page-link">…</span>';
                        $last_dots = true;
                    }
                }
            }

            if ($prefs['nextprev_pagination'] != 'n' || $params['show_numbers'] !== 'y') {
                if ($params['offset'] + $params['step'] >= $params['cant']) {
                    $html .= '<li class="page-item disabled"><span class="page-link">' .
                        ($params['noimg'] ? tr('Next') : '»') . '</span></li>';
                } else {
                    $html .= '<li class="page-item">' . $make_prevnext_link(
                        $url . $next_offset,
                        $params['noimg'] ? tr('Next') : '»',
                        $params,
                        'prevnext next',
                        $next_offset_val
                    ) . '</li>';
                }
            }

            $html .= '</ul>';
        }

        if (isset($params['estimate']) && $params['estimate'] > $params['cant']) {
            $html .= '<div class="alert alert-info">' . tr(
                'More results may be available. Refine criteria to access the estimated %0 results.',
                $params['estimate']
            ) . '</div>';
        }
    }
    return $html;
}