first commit

system/src/Grav/Common/Assets/Traits/AssetUtilsTrait.php

@@ -0,0 +1,182 @@
+<?php
+
+/**
+ * @package    Grav\Common\Assets\Traits
+ *
+ * @copyright  Copyright (C) 2015 - 2019 Trilby Media, LLC. All rights reserved.
+ * @license    MIT License; see LICENSE file for details.
+ */
+
+namespace Grav\Common\Assets\Traits;
+
+use Grav\Common\Grav;
+use Grav\Common\Utils;
+
+trait AssetUtilsTrait
+{
+    /**
+     * Determine whether a link is local or remote.
+     * Understands both "http://" and "https://" as well as protocol agnostic links "//"
+     *
+     * @param  string $link
+     * @return bool
+     */
+    public static function isRemoteLink($link)
+    {
+        $base = Grav::instance()['uri']->rootUrl(true);
+
+        // Sanity check for local URLs with absolute URL's enabled
+        if (Utils::startsWith($link, $base)) {
+            return false;
+        }
+
+        return (0 === strpos($link, 'http://') || 0 === strpos($link, 'https://') || 0 === strpos($link, '//'));
+    }
+
+    /**
+     * Download and concatenate the content of several links.
+     *
+     * @param  array $assets
+     * @param  bool $css
+     *
+     * @return string
+     */
+    protected function gatherLinks(array $assets, $css = true)
+    {
+        $buffer = '';
+
+
+        foreach ($assets as $id => $asset) {
+            $local = true;
+
+            $link = $asset->getAsset();
+            $relative_path = $link;
+
+            if (static::isRemoteLink($link)) {
+                $local = false;
+                if (0 === strpos($link, '//')) {
+                    $link = 'http:' . $link;
+                }
+                $relative_dir = \dirname($relative_path);
+            } else {
+                // Fix to remove relative dir if grav is in one
+                if (($this->base_url !== '/') && Utils::startsWith($relative_path, $this->base_url)) {
+                    $base_url = '#' . preg_quote($this->base_url, '#') . '#';
+                    $relative_path = ltrim(preg_replace($base_url, '/', $link, 1), '/');
+                }
+
+                $relative_dir = \dirname($relative_path);
+                $link = ROOT_DIR . $relative_path;
+            }
+
+            $file = ($this->fetch_command instanceof \Closure) ? @$this->fetch_command->__invoke($link) : @file_get_contents($link);
+
+            // No file found, skip it...
+            if ($file === false) {
+                continue;
+            }
+
+            // Double check last character being
+            if (!$css) {
+                $file = rtrim($file, ' ;') . ';';
+            }
+
+            // If this is CSS + the file is local + rewrite enabled
+            if ($css && $this->css_rewrite) {
+                $file = $this->cssRewrite($file, $relative_dir, $local);
+            }
+
+            $file = rtrim($file) . PHP_EOL;
+            $buffer .= $file;
+        }
+
+        // Pull out @imports and move to top
+        if ($css) {
+            $buffer = $this->moveImports($buffer);
+        }
+
+        return $buffer;
+    }
+
+    /**
+     * Moves @import statements to the top of the file per the CSS specification
+     *
+     * @param  string $file the file containing the combined CSS files
+     *
+     * @return string       the modified file with any @imports at the top of the file
+     */
+    protected function moveImports($file)
+    {
+        $imports = [];
+
+        $file = (string)preg_replace_callback(self::CSS_IMPORT_REGEX, function ($matches) use (&$imports) {
+            $imports[] = $matches[0];
+
+            return '';
+        }, $file);
+
+        return implode("\n", $imports) . "\n\n" . $file;
+    }
+
+    /**
+     *
+     * Build an HTML attribute string from an array.
+     *
+     * @return string
+     */
+    protected function renderAttributes()
+    {
+        $html = '';
+        $no_key = ['loading'];
+
+        foreach ($this->attributes as $key => $value) {
+            if (is_numeric($key)) {
+                $key = $value;
+            }
+            if (\is_array($value)) {
+                $value = implode(' ', $value);
+            }
+
+            if (\in_array($key, $no_key, true)) {
+                $element = htmlentities($value, ENT_QUOTES, 'UTF-8', false);
+            } else {
+                $element = $key . '="' . htmlentities($value, ENT_QUOTES, 'UTF-8', false) . '"';
+            }
+
+            $html .= ' ' . $element;
+        }
+
+        return $html;
+    }
+
+    /**
+     * Render Querystring
+     *
+     * @param string $asset
+     * @return string
+     */
+    protected function renderQueryString($asset = null)
+    {
+        $querystring = '';
+
+        $asset = $asset ?? $this->asset;
+
+        if (!empty($this->query)) {
+            if (Utils::contains($asset, '?')) {
+                $querystring .=  '&' . $this->query;
+            } else {
+                $querystring .= '?' . $this->query;
+            }
+        }
+
+        if ($this->timestamp) {
+            if (Utils::contains($asset, '?') || $querystring) {
+                $querystring .=  '&' . $this->timestamp;
+            } else {
+                $querystring .= '?' . $this->timestamp;
+            }
+        }
+
+        return $querystring;
+    }
+}

system/src/Grav/Common/Assets/Traits/LegacyAssetsTrait.php

@@ -0,0 +1,125 @@
+<?php
+
+/**
+ * @package    Grav\Common\Assets\Traits
+ *
+ * @copyright  Copyright (C) 2015 - 2019 Trilby Media, LLC. All rights reserved.
+ * @license    MIT License; see LICENSE file for details.
+ */
+
+namespace Grav\Common\Assets\Traits;
+
+use Grav\Common\Assets;
+
+trait LegacyAssetsTrait
+{
+
+    /**
+     * @param array $args
+     * @param string $type
+     * @return array
+     */
+    protected function unifyLegacyArguments($args, $type = Assets::CSS_TYPE)
+    {
+        // First argument is always the asset
+        array_shift($args);
+
+        if (count($args) === 0) {
+            return [];
+        }
+        // New options array format
+        if (count($args) === 1 && is_array($args[0])) {
+            return $args[0];
+        }
+        // Handle obscure case where options array is mixed with a priority
+        if (count($args) === 2 && is_array($args[0]) && is_int($args[1])) {
+            $arguments = $args[0];
+            $arguments['priority'] = $args[1];
+            return $arguments;
+        }
+
+        switch ($type) {
+            case(Assets::JS_TYPE):
+                $defaults = ['priority' => null, 'pipeline' => true, 'loading' => null, 'group' => null];
+                $arguments = $this->createArgumentsFromLegacy($args, $defaults);
+                break;
+
+            case(Assets::INLINE_JS_TYPE):
+                $defaults = ['priority' => null, 'group' => null, 'attributes' => null];
+                $arguments = $this->createArgumentsFromLegacy($args, $defaults);
+
+                // special case to handle old attributes being passed in
+                if (isset($arguments['attributes'])) {
+                    $old_attributes = $arguments['attributes'];
+                    $arguments = array_merge($arguments, $old_attributes);
+                }
+                unset($arguments['attributes']);
+
+                break;
+
+            case(Assets::INLINE_CSS_TYPE):
+                $defaults = ['priority' => null, 'group' => null];
+                $arguments = $this->createArgumentsFromLegacy($args, $defaults);
+                break;
+
+            default:
+            case(Assets::CSS_TYPE):
+                $defaults = ['priority' => null, 'pipeline' => true, 'group' => null, 'loading' => null];
+                $arguments = $this->createArgumentsFromLegacy($args, $defaults);
+        }
+
+        return $arguments;
+    }
+
+    protected function createArgumentsFromLegacy(array $args, array $defaults)
+    {
+        // Remove arguments with old default values.
+        $arguments = [];
+        foreach ($args as $arg) {
+            $default = current($defaults);
+            if ($arg !== $default) {
+                $arguments[key($defaults)] = $arg;
+            }
+            next($defaults);
+        }
+
+        return $arguments;
+    }
+
+    /**
+     * Convenience wrapper for async loading of JavaScript
+     *
+     * @param string|array  $asset
+     * @param int           $priority
+     * @param bool          $pipeline
+     * @param string        $group name of the group
+     *
+     * @return \Grav\Common\Assets
+     * @deprecated Please use dynamic method with ['loading' => 'async'].
+     */
+    public function addAsyncJs($asset, $priority = 10, $pipeline = true, $group = 'head')
+    {
+        user_error(__CLASS__ . '::' . __FUNCTION__ . '() is deprecated since Grav 1.6, use dynamic method with [\'loading\' => \'async\']', E_USER_DEPRECATED);
+
+        return $this->addJs($asset, $priority, $pipeline, 'async', $group);
+    }
+
+    /**
+     * Convenience wrapper for deferred loading of JavaScript
+     *
+     * @param string|array  $asset
+     * @param int           $priority
+     * @param bool          $pipeline
+     * @param string        $group name of the group
+     *
+     * @return \Grav\Common\Assets
+     * @deprecated Please use dynamic method with ['loading' => 'defer'].
+     */
+    public function addDeferJs($asset, $priority = 10, $pipeline = true, $group = 'head')
+    {
+        user_error(__CLASS__ . '::' . __FUNCTION__ . '() is deprecated since Grav 1.6, use dynamic method with [\'loading\' => \'defer\']', E_USER_DEPRECATED);
+
+        return $this->addJs($asset, $priority, $pipeline, 'defer', $group);
+    }
+
+}

system/src/Grav/Common/Assets/Traits/TestingAssetsTrait.php

@@ -0,0 +1,343 @@
+<?php
+
+/**
+ * @package    Grav\Common\Assets\Traits
+ *
+ * @copyright  Copyright (C) 2015 - 2019 Trilby Media, LLC. All rights reserved.
+ * @license    MIT License; see LICENSE file for details.
+ */
+
+namespace Grav\Common\Assets\Traits;
+
+use Grav\Common\Grav;
+
+trait TestingAssetsTrait
+{
+    /**
+     * Determines if an asset exists as a collection, CSS or JS reference
+     *
+     * @param string $asset
+     *
+     * @return bool
+     */
+    public function exists($asset)
+    {
+        return isset($this->collections[$asset]) || isset($this->assets_css[$asset]) || isset($this->assets_js[$asset]);
+    }
+
+    /**
+     * Return the array of all the registered collections
+     *
+     * @return array
+     */
+    public function getCollections()
+    {
+        return $this->collections;
+    }
+
+    /**
+     * Set the array of collections explicitly
+     *
+     * @param array $collections
+     *
+     * @return $this
+     */
+    public function setCollection($collections)
+    {
+        $this->collections = $collections;
+
+        return $this;
+    }
+
+    /**
+     * Return the array of all the registered CSS assets
+     * If a $key is provided, it will try to return only that asset
+     * else it will return null
+     *
+     * @param null|string $key the asset key
+     * @return array
+     */
+    public function getCss($key = null)
+    {
+        if (null !== $key) {
+            $asset_key = md5($key);
+
+            return $this->assets_css[$asset_key] ?? null;
+        }
+
+        return $this->assets_css;
+    }
+
+    /**
+     * Return the array of all the registered JS assets
+     * If a $key is provided, it will try to return only that asset
+     * else it will return null
+     *
+     * @param null|string $key the asset key
+     * @return array
+     */
+    public function getJs($key = null)
+    {
+        if (null !== $key) {
+            $asset_key = md5($key);
+
+            return $this->assets_js[$asset_key] ?? null;
+        }
+
+        return $this->assets_js;
+    }
+
+    /**
+     * Set the whole array of CSS assets
+     *
+     * @param array $css
+     *
+     * @return $this
+     */
+    public function setCss($css)
+    {
+        $this->assets_css = $css;
+
+        return $this;
+    }
+
+    /**
+     * Set the whole array of JS assets
+     *
+     * @param array $js
+     *
+     * @return $this
+     */
+    public function setJs($js)
+    {
+        $this->assets_js = $js;
+
+        return $this;
+    }
+
+    /**
+     * Removes an item from the CSS array if set
+     *
+     * @param string $key  The asset key
+     *
+     * @return $this
+     */
+    public function removeCss($key)
+    {
+        $asset_key = md5($key);
+        if (isset($this->assets_css[$asset_key])) {
+            unset($this->assets_css[$asset_key]);
+        }
+
+        return $this;
+    }
+
+    /**
+     * Removes an item from the JS array if set
+     *
+     * @param string $key  The asset key
+     *
+     * @return $this
+     */
+    public function removeJs($key)
+    {
+        $asset_key = md5($key);
+        if (isset($this->assets_js[$asset_key])) {
+            unset($this->assets_js[$asset_key]);
+        }
+
+        return $this;
+    }
+
+    /**
+     * Sets the state of CSS Pipeline
+     *
+     * @param bool $value
+     *
+     * @return $this
+     */
+    public function setCssPipeline($value)
+    {
+        $this->css_pipeline = (bool)$value;
+
+        return $this;
+    }
+
+    /**
+     * Sets the state of JS Pipeline
+     *
+     * @param bool $value
+     *
+     * @return $this
+     */
+    public function setJsPipeline($value)
+    {
+        $this->js_pipeline = (bool)$value;
+
+        return $this;
+    }
+
+    /**
+     * Reset all assets.
+     *
+     * @return $this
+     */
+    public function reset()
+    {
+        $this->resetCss();
+        $this->resetJs();
+        $this->setCssPipeline(false);
+        $this->setJsPipeline(false);
+
+        return $this;
+    }
+
+    /**
+     * Reset JavaScript assets.
+     *
+     * @return $this
+     */
+    public function resetJs()
+    {
+        $this->assets_js = [];
+
+        return $this;
+    }
+
+    /**
+     * Reset CSS assets.
+     *
+     * @return $this
+     */
+    public function resetCss()
+    {
+        $this->assets_css = [];
+
+        return $this;
+    }
+
+    /**
+     * Explicitly set's a timestamp for assets
+     *
+     * @param string|int $value
+     */
+    public function setTimestamp($value)
+    {
+        $this->timestamp = $value;
+    }
+
+    /**
+     * Get the timestamp for assets
+     *
+     * @param  bool  $include_join
+     * @return string
+     */
+    public function getTimestamp($include_join = true)
+    {
+        if ($this->timestamp) {
+            return $include_join ? '?' . $this->timestamp : $this->timestamp;
+        }
+
+        return null;
+    }
+
+    /**
+     * Add all assets matching $pattern within $directory.
+     *
+     * @param  string $directory Relative to the Grav root path, or a stream identifier
+     * @param  string $pattern   (regex)
+     *
+     * @return $this
+     */
+    public function addDir($directory, $pattern = self::DEFAULT_REGEX)
+    {
+        $root_dir = rtrim(ROOT_DIR, '/');
+
+        // Check if $directory is a stream.
+        if (strpos($directory, '://')) {
+            $directory = Grav::instance()['locator']->findResource($directory, null);
+        }
+
+        // Get files
+        $files = $this->rglob($root_dir . DIRECTORY_SEPARATOR . $directory, $pattern, $root_dir . '/');
+
+        // No luck? Nothing to do
+        if (!$files) {
+            return $this;
+        }
+
+        // Add CSS files
+        if ($pattern === self::CSS_REGEX) {
+            foreach ($files as $file) {
+                $this->addCss($file);
+            }
+
+            return $this;
+        }
+
+        // Add JavaScript files
+        if ($pattern === self::JS_REGEX) {
+            foreach ($files as $file) {
+                $this->addJs($file);
+            }
+
+            return $this;
+        }
+
+        // Unknown pattern.
+        foreach ($files as $asset) {
+            $this->add($asset);
+        }
+
+        return $this;
+    }
+
+    /**
+     * Add all JavaScript assets within $directory
+     *
+     * @param  string $directory Relative to the Grav root path, or a stream identifier
+     *
+     * @return $this
+     */
+    public function addDirJs($directory)
+    {
+        return $this->addDir($directory, self::JS_REGEX);
+    }
+
+    /**
+     * Add all CSS assets within $directory
+     *
+     * @param  string $directory Relative to the Grav root path, or a stream identifier
+     *
+     * @return $this
+     */
+    public function addDirCss($directory)
+    {
+        return $this->addDir($directory, self::CSS_REGEX);
+    }
+
+    /**
+     * Recursively get files matching $pattern within $directory.
+     *
+     * @param  string $directory
+     * @param  string $pattern (regex)
+     * @param  string $ltrim   Will be trimmed from the left of the file path
+     *
+     * @return array
+     */
+    protected function rglob($directory, $pattern, $ltrim = null)
+    {
+        $iterator = new \RegexIterator(new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($directory,
+            \FilesystemIterator::SKIP_DOTS)), $pattern);
+        $offset = \strlen($ltrim);
+        $files = [];
+
+        foreach ($iterator as $file) {
+            $files[] = substr($file->getPathname(), $offset);
+        }
+
+        return $files;
+    }
+
+
+}