<?php

/**
 * Kunena Component
 *
 * @package       Kunena.Administrator.Template
 * @subpackage    Categories
 *
 * @copyright     Copyright (C) 2008 - @currentyear@ Kunena Team. All rights reserved.
 * @license       https://www.gnu.org/copyleft/gpl.html GNU/GPL
 * @link          https://www.kunena.org
 **/

namespace Kunena\Forum\Libraries\Layout;

\defined('_JEXEC') or die();

use Exception;
use Joomla\CMS\Factory;
use Joomla\Input\Input;
use Kunena\Forum\Libraries\Controller\KunenaControllerDisplay;
use Kunena\Forum\Libraries\Factory\KunenaFactory;
use Kunena\Forum\Libraries\Request\KunenaRequest;
use Kunena\Forum\Libraries\Route\KunenaRoute;

/**
 * implements \Kunena specific functions for page layouts.
 *
 * @see     KunenaLayout
 *
 * @since   Kunena 6.0
 */
class KunenaPage extends KunenaLayout
{
    public $breadcrumb;

    /**
     * Returns layout class.
     *
     * <code>
     *    // Output pagination/pages layout with current cart instance.
     *    echo \Kunena\Forum\Libraries\Layout\Layout::factory('Pagination/Pages')->set('pagination', $this->pagination);
     * </code>
     *
     * @param   mixed   $paths  String or array of strings.
     * @param   string  $base   Base path.
     *
     * @return  KunenaLayout
     *
     * @since   Kunena 6.0
     *
     * @throws  Exception
     */
    public static function factory($paths, $base = 'pages')
    {
        $paths = (array) $paths;

        $app = Factory::getApplication();

        // Add all paths for the template overrides.
        if ($app->isClient('administrator')) {
            $template = KunenaFactory::getAdminTemplate();
        } else {
            $template = KunenaFactory::getTemplate();
        }

        $templatePaths = [];

        foreach ($paths as $path) {
            if (!$path) {
                continue;
            }

            $path   = (string) preg_replace('|\\\|', '/', strtolower($path));
            $lookup = $template->getTemplatePaths("{$base}/{$path}", true);

            foreach ($lookup as $loc) {
                array_unshift($templatePaths, $loc);
            }
        }

        // Go through all the matching layouts.
        $path = 'Undefined';

        foreach ($paths as $path) {
            if (!$path) {
                continue;
            }

            // Attempt to load layout class if it doesn't exist.
            $class = 'KunenaPage' . (string) preg_replace('/[^A-Z0-9_]/i', '', $path);
            $fpath = (string) preg_replace('|\\\|', '/', strtolower($path));

            if (!class_exists($class)) {
                $filename = JPATH_BASE . "/components/com_kunena/page/{$fpath}.php";

                if (!is_file($filename)) {
                    continue;
                }

                require_once $filename;
            }

            // Create layout object.
            return new $class($fpath, $templatePaths);
        }

        // Create default layout object.
        return new KunenaPage($path, $templatePaths);
    }

    /**
     * Execute main MVC triad to get the current layout.
     *
     * @param   mixed       $path     path
     * @param   Input|null  $input    input
     * @param   mixed       $options  options
     *
     * @return  KunenaLayout
     *
     * @since   Kunena 6.0
     *
     * @throws  Exception
     */
    public function execute($path, ?Input $input = null, $options = null)
    {
        return $this->request($path, $input, $options)->execute();
    }

    /**
     * Get main MVC triad from current layout.
     *
     * @param   mixed       $path     path
     * @param   Input|null  $input    input
     * @param   mixed       $options  options
     *
     * @return  KunenaControllerDisplay
     *
     * @since   Kunena 6.0
     * @throws Exception
     */
    public function request($path, ?Input $input = null, $options = null)
    {
        return KunenaRequest::factory($path . '/Display', $input, $options ? $options : $this->getOptions())
            ->setPrimary()->set('layout', $this->getLayout());
    }

    /**
     * Add path to breadcrumbs.
     *
     * @param   string  $text    text
     * @param   string  $uri     uri
     * @param   bool    $ignore  ignore
     *
     * @return  $this
     *
     * @since   Kunena 6.0
     *
     * @throws Exception
     */
    public function addBreadcrumb(string $text, $uri, $ignore = true)
    {
        if ($ignore) {
            $active = KunenaRoute::$active;
            $view   = isset($active->query['view']) ? $active->query['view'] : '';
            $layout = isset($active->query['layout']) ? $active->query['layout'] : 'default';

            if ($active && $active->component == 'com_kunena' && strtolower("{$view}/{$layout}") == strtolower($this->_name)) {
                return $this;
            }
        }

        $this->breadcrumb->addItem($text, KunenaRoute::normalize($uri));

        return $this;
    }
}