AnonymousFox

//home/develito/.trash/v6/libraries/src/HTML/HTMLHelper.php

<?php

/**
 * Joomla! Content Management System
 *
 * @copyright  (C) 2005 Open Source Matters, Inc. <https://www.joomla.org>
 * @license    GNU General Public License version 2 or later; see LICENSE.txt
 */

namespace Joomla\CMS\HTML;

use Joomla\CMS\Environment\Browser;
use Joomla\CMS\Factory;
use Joomla\CMS\Language\Text;
use Joomla\CMS\Layout\LayoutHelper;
use Joomla\CMS\Uri\Uri;
use Joomla\Filesystem\File;
use Joomla\Filesystem\Path;
use Joomla\Utilities\ArrayHelper;

// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects

/**
 * Utility class for all HTML drawing classes
 *
 * @since  1.5
 */
abstract class HTMLHelper
{
    /**
     * Option values related to the generation of HTML output. Recognized
     * options are:
     *     fmtDepth, integer. The current indent depth.
     *     fmtEol, string. The end of line string, default is linefeed.
     *     fmtIndent, string. The string to use for indentation, default is
     *     tab.
     *
     * @var    array
     * @since  1.5
     */
    public static $formatOptions = ['format.depth' => 0, 'format.eol' => "\n", 'format.indent' => "\t"];

/**
     * An array to hold included paths
     *
     * @var    string[]
     * @since  1.5
     * @deprecated  4.0 will be removed in 7.0
     */
    protected static $includePaths = [];

/**
     * An array to hold method references
     *
     * @var    callable[]
     * @since  1.6
     * @deprecated  4.0 will be removed in 7.0
     */
    protected static $registry = [];

/**
     * The service registry for custom and overridden JHtml helpers
     *
     * @var    Registry
     * @since  4.0.0
     */
    protected static $serviceRegistry;

/**
     * Method to extract a key
     *
     * @param   string  $key  The name of helper method to load, (prefix).(class).function
     *                        prefix and class are optional and can be used to load custom html helpers.
     *
     * @return  array  Contains lowercase key, prefix, file, function.
     *
     * @since       1.6
     * @deprecated  4.0 will be removed in 7.0
     *              Use the service registry instead
     *              HTMLHelper::getServiceRegistry()->getService($file);
     */
    protected static function extract($key)
    {
        $key = preg_replace('#[^A-Z0-9_\.]#i', '', $key);

// Check to see whether we need to load a helper file
        $parts = explode('.', $key);

if (\count($parts) === 3) {
            @trigger_error(
                'Support for a three segment service key is deprecated and will be removed in Joomla 6.0, use the service registry instead',
                E_USER_DEPRECATED
            );
        }

$prefix = \count($parts) === 3 ? array_shift($parts) : HTMLHelper::class;
        $file   = \count($parts) === 2 ? array_shift($parts) : '';
        $func   = array_shift($parts);

if (strtolower($prefix) === 'jhtml') {
            $prefix = HTMLHelper::class;
        }

return [strtolower($prefix . '.' . $file . '.' . $func), $prefix, $file, $func];
    }

/**
     * Class loader method
     *
     * Additional arguments may be supplied and are passed to the sub-class.
     * Additional include paths are also able to be specified for third-party use
     *
     * @param   string  $key         The name of helper method to load, (prefix).(class).function
     *                               prefix and class are optional and can be used to load custom
     *                               html helpers.
     * @param   mixed   $methodArgs  The arguments to pass forward to the method being called
     *
     * @return  mixed  Result of HTMLHelper::call($function, $args)
     *
     * @since   1.5
     * @throws  \InvalidArgumentException
     */
    final public static function _(string $key, ...$methodArgs)
    {
        [$key, $prefix, $file, $func] = static::extract($key);

if (\array_key_exists($key, static::$registry)) {
            $function = static::$registry[$key];

return static::call($function, $methodArgs);
        }

/*
         * Support fetching services from the registry if a custom class prefix was not given (a three segment key),
         * the service comes from a class other than this one, and a service has been registered for the file.
         */
        if ($prefix === 'Joomla\\CMS\\HTML\\HTMLHelper' && $file !== '' && static::getServiceRegistry()->hasService($file)) {
            $service = static::getServiceRegistry()->getService($file);

$toCall = [$service, $func];

if (!\is_callable($toCall)) {
                throw new \InvalidArgumentException(\sprintf('%s::%s not found.', $file, $func), 500);
            }

static::register($key, $toCall);

return static::call($toCall, $methodArgs);
        }

$className = $prefix . ucfirst($file);

if (!class_exists($className)) {
            $path = Path::find(static::$includePaths, strtolower($file) . '.php');

if (!$path) {
                throw new \InvalidArgumentException(\sprintf('%s %s not found.', $prefix, $file), 500);
            }

\JLoader::register($className, $path);

if (!class_exists($className)) {
                if ($prefix !== 'Joomla\\CMS\\HTML\\HTMLHelper') {
                    throw new \InvalidArgumentException(\sprintf('%s not found.', $className), 500);
                }

// @deprecated with 5.0 remove with 6.0 or 7.0 (depends on other relevant code)
                $className = 'JHtml' . ucfirst($file);

\JLoader::register($className, $path);

if (!class_exists($className)) {
                    throw new \InvalidArgumentException(\sprintf('%s not found.', $className), 500);
                }
            }
        }

// If calling a method from this class, do not allow access to internal methods
        if ($className === __CLASS__) {
            if (!((new \ReflectionMethod($className, $func))->isPublic())) {
                throw new \InvalidArgumentException('Access to internal class methods is not allowed.');
            }
        }

$toCall = [$className, $func];

if (!\is_callable($toCall)) {
            throw new \InvalidArgumentException(\sprintf('%s::%s not found.', $className, $func), 500);
        }

static::register($key, $toCall);

return static::call($toCall, $methodArgs);
    }

/**
     * Registers a function to be called with a specific key
     *
     * @param   string    $key       The name of the key
     * @param   callable  $function  Function or method
     *
     * @return  boolean  True if the function is callable
     *
     * @since       1.6
     * @deprecated  4.0 will be removed in 7.0
     *              Use the service registry instead
     *              HTMLHelper::getServiceRegistry()->register($key, $function);
     */
    public static function register($key, callable $function)
    {
        @trigger_error(
            'Support for registering functions is deprecated and will be removed in Joomla 7.0, use the service registry instead',
            E_USER_DEPRECATED
        );

[$key] = static::extract($key);

static::$registry[$key] = $function;

return true;
    }

/**
     * Removes a key for a method from registry.
     *
     * @param   string  $key  The name of the key
     *
     * @return  boolean  True if a set key is unset
     *
     * @since       1.6
     * @deprecated  4.0 will be removed in 7.0
     *              Use the service registry instead
     */
    public static function unregister($key)
    {
        @trigger_error(
            'Support for registering functions is deprecated and will be removed in Joomla 7.0, use the service registry instead',
            E_USER_DEPRECATED
        );

[$key] = static::extract($key);

if (isset(static::$registry[$key])) {
            unset(static::$registry[$key]);

return true;
        }

return false;
    }

/**
     * Test if the key is registered.
     *
     * @param   string  $key  The name of the key
     *
     * @return  boolean  True if the key is registered.
     *
     * @since   1.6
     */
    public static function isRegistered($key)
    {
        [$key] = static::extract($key);

return isset(static::$registry[$key]);
    }

/**
     * Retrieves the service registry.
     *
     * @return  Registry
     *
     * @since   4.0.0
     */
    public static function getServiceRegistry(): Registry
    {
        if (!static::$serviceRegistry) {
            static::$serviceRegistry = Factory::getContainer()->get(Registry::class);
        }

return static::$serviceRegistry;
    }

/**
     * Function caller method
     *
     * @param   callable  $function  Function or method to call
     * @param   array     $args      Arguments to be passed to function
     *
     * @return  mixed   Function result or false on error.
     *
     * @link    https://www.php.net/manual/en/function.call-user-func-array.php
     * @since   1.6
     * @throws  \InvalidArgumentException
     */
    protected static function call(callable $function, $args)
    {
        // Workaround to allow calling helper methods have arguments passed by reference
        $temp = [];

foreach ($args as &$arg) {
            $temp[] = &$arg;
        }

return \call_user_func_array($function, $temp);
    }

/**
     * Write a `<a>` element
     *
     * @param   string        $url      The relative URL to use for the href attribute
     * @param   string        $text     The target attribute to use
     * @param   array|string  $attribs  Attributes to be added to the `<a>` element
     *
     * @return  string
     *
     * @since   1.5
     */
    public static function link($url, $text, $attribs = null)
    {
        if (\is_array($attribs)) {
            $attribs = ArrayHelper::toString($attribs);
        }

return '<a href="' . $url . '" ' . $attribs . '>' . $text . '</a>';
    }

/**
     * Write a `<iframe>` element
     *
     * @param   string        $url       The relative URL to use for the src attribute.
     * @param   string        $name      The target attribute to use.
     * @param   array|string  $attribs   Attributes to be added to the `<iframe>` element
     * @param   string        $noFrames  The message to display if the iframe tag is not supported.
     *
     * @return  string
     *
     * @since   1.5
     */
    public static function iframe($url, $name, $attribs = null, $noFrames = '')
    {
        if (\is_array($attribs)) {
            $attribs = ArrayHelper::toString($attribs);
        }

return '<iframe src="' . $url . '" ' . $attribs . ' name="' . $name . '">' . $noFrames . '</iframe>';
    }

/**
     * Look for path relatively to media folder.
     *
     * @param   string   $folder   Folder name to search in (i.e. images, css, js).
     * @param   string   $file     Path to file to check.
     * @param   array    $options  Array with additional options:
     *                             relative: Flag if the path to the file is relative to the /media folder (and searches in template);
     *                             detectBrowser: Flag if the browser should be detected to include specific browser file;
     *                             detectDebug: Flag if debug mode is enabled to include uncompressed files (for css, js)
     *                               (boolean) - will enable debugging depends on site configuration, (1) - force debug On, (-1) - force debug Off;
     *
     * @return string
     * @since  5.3.0
     */
    final public static function mediaPath(string $folder, string $file, array $options = []): string
    {
        $relative      = $options['relative'] ?? false;
        $detectBrowser = $options['detectBrowser'] ?? false;
        $detectDebug   = $options['detectDebug'] ?? true;

$includes      = static::includeRelativeFiles($folder, $file, $relative, $detectBrowser, $detectDebug);

return $includes[0] ?? '';
    }

/**
     * Compute the files to be included
     *
     * @param   string   $folder         Folder name to search in (i.e. images, css, js).
     * @param   string   $file           Path to file.
     * @param   boolean  $relative       Flag if the path to the file is relative to the /media folder (and searches in template).
     * @param   boolean  $detectBrowser  Flag if the browser should be detected to include specific browser files.
     * @param   boolean  $detectDebug    Flag if debug mode is enabled to include uncompressed files if debug is on.
     *                                   (boolean) - will enable debugging depends on site configuration, (1) - force debug On, (-1) - force debug Off;
     *
     * @return  array    files to be included.
     *
     * @see     Browser
     * @since   1.6
     */
    protected static function includeRelativeFiles($folder, $file, $relative, $detectBrowser, $detectDebug)
    {
        // Detect debug mode
        switch (true) {
            case \is_bool($detectDebug):
                $debugMode = $detectDebug && JDEBUG;
                break;
            case $detectDebug === 1:
                $debugMode = true;
                break;
            case $detectDebug === -1:
            default:
                $debugMode = false;
        }

// If http is present in filename
        if (str_starts_with($file, 'http') || str_starts_with($file, '//')) {
            $includes = [$file];
        } else {
            // Extract extension and strip the file
            $strip = File::stripExt($file);
            $ext   = File::getExt($file);

// Prepare array of files
            $includes = [];

// Detect browser and compute potential files
            if ($detectBrowser) {
                $navigator = Browser::getInstance();
                $browser   = $navigator->getBrowser();
                $major     = $navigator->getMajor();
                $minor     = $navigator->getMinor();
                $minExt    = '';

if (\strlen($strip) > 4 && preg_match('#\.min$#', $strip)) {
                    $minExt    = '.min';
                    $strip     = preg_replace('#\.min$#', '', $strip);
                }

// Try to include files named filename.ext, filename_browser.ext, filename_browser_major.ext, filename_browser_major_minor.ext
                // where major and minor are the browser version names
                $potential = [
                    $strip . $minExt,
                    $strip . '_' . $browser . $minExt,
                    $strip . '_' . $browser . '_' . $major . $minExt,
                    $strip . '_' . $browser . '_' . $major . '_' . $minor . $minExt,
                ];
            } else {
                $potential = [$strip];
            }

// If relative search in template directory or media directory
            if ($relative) {
                $app        = Factory::getApplication();
                $template   = $app->getTemplate(true);
                $templaPath = JPATH_THEMES;

if ($template->inheritable || !empty($template->parent)) {
                    $client     = $app->isClient('administrator') === true ? 'administrator' : 'site';
                    $templaPath = JPATH_PUBLIC . "/media/templates/$client";
                }

// For each potential files
                foreach ($potential as $strip) {
                    $files   = [];
                    $files[] = $strip . '.' . $ext;

/**
                     * Loop on 1 or 2 files and break on first found.
                     * Add the content of the MD5SUM file located in the same folder to url to ensure cache browser refresh
                     * This MD5SUM file must represent the signature of the folder content
                     */
                    foreach ($files as $file) {
                        if (!empty($template->parent)) {
                            $found = static::addFileToBuffer("$templaPath/$template->template/$folder/$file", $ext, $debugMode);

if (empty($found)) {
                                $found = static::addFileToBuffer("$templaPath/$template->parent/$folder/$file", $ext, $debugMode);
                            }
                        } else {
                            $found = static::addFileToBuffer("$templaPath/$template->template/$folder/$file", $ext, $debugMode);
                        }

if (!empty($found)) {
                            $includes[] = $found;

break;
                        }

// If the file contains any /: it can be in a media extension subfolder
                        if (strpos($file, '/')) {
                            // Divide the file extracting the extension as the first part before /
                            [$extension, $file] = explode('/', $file, 2);

// If the file yet contains any /: it can be a plugin
                            if (strpos($file, '/')) {
                                // Divide the file extracting the element as the first part before /
                                [$element, $file] = explode('/', $file, 2);

// Try to deal with plugins group in the media folder
                                $found = static::addFileToBuffer(JPATH_PUBLIC . "/media/$extension/$element/$folder/$file", $ext, $debugMode);

if (!empty($found)) {
                                    $includes[] = $found;

break;
                                }

// Try to deal with classical file in a media subfolder called element
                                $found = static::addFileToBuffer(JPATH_PUBLIC . "/media/$extension/$folder/$element/$file", $ext, $debugMode);

if (!empty($found)) {
                                    $includes[] = $found;

break;
                                }

// Try to deal with system files in the template folder
                                if (!empty($template->parent)) {
                                    $found = static::addFileToBuffer("$templaPath/$template->template/$folder/system/$element/$file", $ext, $debugMode);