<?php
namespace FluidTYPO3\Vhs\ViewHelpers\Menu;

/*
 * This file is part of the FluidTYPO3/Vhs project under GPLv2 or later.
 *
 * For the full copyright and license information, please read the
 * LICENSE.md file that was distributed with this source code.
 */

/**
 * ### Page: Browse Menu ViewHelper
 *
 * ViewHelper for rendering TYPO3 browse menus in Fluid
 *
 * Renders links to browse inside a menu branch including
 * first, previous, next, last and up to the parent page.
 * Supports both automatic, tag-based rendering (which
 * defaults to `ul > li` with options to set both the
 * parent and child tag names. When using manual rendering
 * a range of support CSS classes are available along
 * with each page record.
 */
class BrowseViewHelper extends AbstractMenuViewHelper
{
    public function initializeArguments(): void
    {
        parent::initializeArguments();
        $this->registerArgument('labelFirst', 'string', 'Label for the "first" link', false, 'first');
        $this->registerArgument('labelLast', 'string', 'Label for the "last" link', false, 'last');
        $this->registerArgument('labelPrevious', 'string', 'Label for the "previous" link', false, 'previous');
        $this->registerArgument('labelNext', 'string', 'Label for the "next" link', false, 'next');
        $this->registerArgument('labelUp', 'string', 'Label for the "up" link', false, 'up');
        $this->registerArgument(
            'renderFirst',
            'boolean',
            'If set to FALSE the "first" link will not be rendered',
            false,
            true
        );
        $this->registerArgument(
            'renderLast',
            'boolean',
            'If set to FALSE the "last" link will not be rendered',
            false,
            true
        );
        $this->registerArgument(
            'renderUp',
            'boolean',
            'If set to FALSE the "up" link will not be rendered',
            false,
            true
        );
        $this->registerArgument(
            'usePageTitles',
            'boolean',
            'If set to TRUE, uses target page titles instead of "next", "previous" etc. labels',
            false,
            false
        );
        $this->registerArgument(
            'pageUid',
            'integer',
            'Optional parent page UID to use as top level of menu. If unspecified, current page UID is used'
        );
        $this->registerArgument(
            'currentPageUid',
            'integer',
            'Optional page UID to use as current page. If unspecified, current page UID from globals is used'
        );
    }

    /**
     * @return string
     */
    public function render()
    {
        $defaultUid = $GLOBALS['TSFE']->id;
        $showAccessProtected = (boolean) $this->arguments['showAccessProtected'];
        $pageUid = (integer) (null !== $this->arguments['pageUid'] ? $this->arguments['pageUid'] : $defaultUid);
        $currentUid = (integer) ($this->arguments['currentPageUid'] ?: $defaultUid);
        $currentPage = $this->pageService->getPage($currentUid, $showAccessProtected);
        $parentUid = (integer) (null !== $this->arguments['pageUid'] ? $pageUid : ($currentPage['pid'] ?? 0));
        $parentPage = $this->pageService->getPage($parentUid, $showAccessProtected);
        $menuData = $this->getMenu($parentUid);
        if (empty($menuData)) {
            if (empty($this->arguments['as'])) {
                $content = $this->renderChildren();
                return is_scalar($content) ? (string) $content : '';
            }
            return '';
        }
        $pageUids = array_keys($menuData);
        $uidCount = count($pageUids);
        $firstUid = $pageUids[0];
        $lastUid = $pageUids[$uidCount - 1];
        $nextUid = null;
        $prevUid = null;
        for ($i = 0; $i < $uidCount; $i++) {
            if ((integer) $pageUids[$i] === $currentUid) {
                if ($i > 0) {
                    $prevUid = $pageUids[$i - 1];
                }
                $nextUid = $pageUids[$i + 1] ?? null;
                break;
            }
        }
        $pages = [];
        if ($this->arguments['renderFirst']) {
            $pages['first'] = $menuData[$firstUid];
        }
        if (null !== $prevUid) {
            $pages['prev'] = $menuData[$prevUid];
        }
        if ($this->arguments['renderUp']) {
            $pages['up'] = $parentPage;
        }
        if (null !== $nextUid) {
            $pages['next'] = $menuData[$nextUid];
        }
        if ($this->arguments['renderLast']) {
            $pages['last'] = $menuData[$lastUid];
        }
        $menuItems = $this->parseMenu($pages);
        $menu = [];
        if (isset($pages['first'], $menuItems['first'])) {
            $menu['first'] = $menuItems['first'];
            $menu['first']['linktext'] = $this->getCustomLabelOrPageTitle('labelFirst', $menuItems['first']);
        }
        if (isset($pages['prev'], $menuItems['prev'])) {
            $menu['prev'] = $menuItems['prev'];
            $menu['prev']['linktext'] = $this->getCustomLabelOrPageTitle('labelPrevious', $menuItems['prev']);
        }
        if (isset($pages['up'], $menuItems['up'])) {
            $menu['up'] = $menuItems['up'];
            $menu['up']['linktext'] = $this->getCustomLabelOrPageTitle('labelUp', $menuItems['up']);
        }
        if (isset($pages['next'], $menuItems['next'])) {
            $menu['next'] = $menuItems['next'];
            $menu['next']['linktext'] = $this->getCustomLabelOrPageTitle('labelNext', $menuItems['next']);
        }
        if (isset($pages['last'], $menuItems['last'])) {
            $menu['last'] = $menuItems['last'];
            $menu['last']['linktext'] = $this->getCustomLabelOrPageTitle('labelLast', $menuItems['last']);
        }
        $variableProvider = $this->renderingContext->getVariableProvider();
        $this->backupVariables();
        /** @var string $as */
        $as = $this->arguments['as'];
        $variableProvider->add($as, $menu);
        $output = $this->renderContent($menu);
        $variableProvider->remove($as);
        $this->restoreVariables();
        return $output;
    }

    protected function getCustomLabelOrPageTitle(string $labelName, array $pageRecord): string
    {
        /** @var string $title */
        $title = $this->arguments[$labelName];
        if ($this->arguments['usePageTitles']) {
            $title = $this->getItemTitle($pageRecord);
        }

        return $title;
    }
}