vendor/pimcore/pimcore/lib/Twig/Extension/Templating/HeadScript.php line 522

Open in your IDE?
  1. <?php
  3. /**
  4.  * Pimcore
  5.  *
  6.  * This source file is available under two different licenses:
  7.  * - GNU General Public License version 3 (GPLv3)
  8.  * - Pimcore Commercial License (PCL)
  9.  * Full copyright and license information is available in
  10.  * LICENSE.md which is distributed with this source code.
  11.  *
  12.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  13.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  14.  */
  16. /**
  17.  * ----------------------------------------------------------------------------------
  18.  * based on @author ZF1 Zend_View_Helper_HeadScript
  19.  * ----------------------------------------------------------------------------------
  20.  */
  22. /**
  23.  * Zend Framework
  24.  *
  25.  * LICENSE
  26.  *
  27.  * This source file is subject to the new BSD license that is bundled
  28.  * with this package in the file LICENSE.txt.
  29.  * It is also available through the world-wide-web at this URL:
  30.  * http://framework.zend.com/license/new-bsd
  31.  * If you did not receive a copy of the license and are unable to
  32.  * obtain it through the world-wide-web, please send an email
  33.  * to license@zend.com so we can send you a copy immediately.
  34.  *
  35.  * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
  36.  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  37.  */
  39. namespace Pimcore\Twig\Extension\Templating;
  41. use Pimcore\Event\FrontendEvents;
  42. use Pimcore\Twig\Extension\Templating\Placeholder\CacheBusterAware;
  43. use Pimcore\Twig\Extension\Templating\Placeholder\Container;
  44. use Pimcore\Twig\Extension\Templating\Placeholder\ContainerService;
  45. use Pimcore\Twig\Extension\Templating\Placeholder\Exception;
  46. use Pimcore\Twig\Extension\Templating\Traits\WebLinksTrait;
  47. use Symfony\Bridge\Twig\Extension\WebLinkExtension;
  48. use Symfony\Component\EventDispatcher\GenericEvent;
  49. use Twig\Extension\RuntimeExtensionInterface;
  51. /**
  52.  * @method $this appendFile($src, $type = 'text/javascript', array $attrs = array())
  53.  * @method $this appendScript($script, $type = 'text/javascript', array $attrs = array())
  54.  * @method $this offsetSetFile($index, $src, $type = 'text/javascript', array $attrs = array())
  55.  * @method $this offsetSetScript($index, $script, $type = 'text/javascript', array $attrs = array())
  56.  * @method $this prependFile($src, $type = 'text/javascript', array $attrs = array())
  57.  * @method $this prependScript($script, $type = 'text/javascript', array $attrs = array())
  58.  * @method $this setFile($src, $type = 'text/javascript', array $attrs = array())
  59.  * @method $this setScript($script, $type = 'text/javascript', array $attrs = array())
  60.  *
  61.  */
  62. class HeadScript extends CacheBusterAware implements RuntimeExtensionInterface
  63. {
  64.     use WebLinksTrait;
  66.     /**#@+
  67.      * Script type contants
  68.      * @const string
  69.      */
  70.     const FILE = 'FILE';
  72.     const SCRIPT = 'SCRIPT';
  74.     // #@-
  76.     /**
  77.      * Registry key for placeholder
  78.      *
  79.      * @var string
  80.      */
  81.     protected $_regKey = 'HeadScript';
  83.     /**
  84.      * Are arbitrary attributes allowed?
  85.      *
  86.      * @var bool
  87.      */
  88.     protected $_arbitraryAttributes = false;
  90.     /**#@+
  91.      * Capture type and/or attributes (used for hinting during capture)
  92.      * @var string
  93.      */
  94.     protected $_captureLock;
  96.     protected $_captureScriptType = null;
  98.     protected $_captureScriptAttrs = null;
  100.     protected $_captureType;
  102.     // #@-
  104.     /**
  105.      * Optional allowed attributes for script tag
  106.      *
  107.      * @var array
  108.      */
  109.     protected $_optionalAttributes = [
  110.         'charset', 'defer', 'language', 'src', 'type',
  111.     ];
  113.     /**
  114.      * Required attributes for script tag
  115.      *
  116.      * @var array
  117.      */
  118.     protected $_requiredAttributes = ['type'];
  120.     /**
  121.      * Whether or not to format scripts using CDATA; used only if doctype
  122.      * helper is not accessible
  123.      *
  124.      * @var bool
  125.      */
  126.     public $useCdata = false;
  128.     /**
  129.      * Default attributes for generated WebLinks (HTTP/2 push).
  130.      *
  131.      * @var array
  132.      */
  133.     protected $webLinkAttributes = ['as' => 'script'];
  135.     /**
  136.      * HeadScript constructor.
  137.      *
  138.      * Set separator to PHP_EOL.
  139.      *
  140.      * @param ContainerService $containerService
  141.      * @param WebLinkExtension $webLinkExtension
  142.      */
  143.     public function __construct(
  144.         ContainerService $containerService,
  145.         WebLinkExtension $webLinkExtension
  146.     ) {
  147.         parent::__construct($containerService);
  149.         $this->webLinkExtension = $webLinkExtension;
  150.         $this->setSeparator(PHP_EOL);
  151.     }
  153.     /**
  154.      * Return headScript object
  155.      *
  156.      * Returns headScript helper object; optionally, allows specifying a script
  157.      * or script file to include.
  158.      *
  159.      * @param  string $mode Script or file
  160.      * @param  string $spec Script/url
  161.      * @param  string $placement Append, prepend, or set
  162.      * @param  array $attrs Array of script attributes
  163.      * @param  string $type Script type and/or array of script attributes
  164.      *
  165.      * @return HeadScript
  166.      */
  167.     public function __invoke($mode = self::FILE, $spec = null, $placement = 'APPEND', array $attrs = [], $type = 'text/javascript')
  168.     {
  169.         if ((null !== $spec) && is_string($spec)) {
  170.             $action = ucfirst(strtolower($mode));
  171.             $placement = strtolower($placement);
  172.             switch ($placement) {
  173.                 case 'set':
  174.                 case 'prepend':
  175.                 case 'append':
  176.                     $action = $placement . $action;
  178.                     break;
  179.                 default:
  180.                     $action = 'append' . $action;
  182.                     break;
  183.             }
  184.             $this->$action($spec, $type, $attrs);
  185.         }
  187.         return $this;
  188.     }
  190.     /**
  191.      * Start capture action
  192.      *
  193.      * @param string $captureType
  194.      * @param string $type
  195.      * @param array $attrs
  196.      *
  197.      * @return void
  198.      */
  199.     public function captureStart($captureType = Container::APPEND, $type = 'text/javascript', $attrs = [])
  200.     {
  201.         if ($this->_captureLock) {
  202.             throw new Exception('Cannot nest headScript captures');
  203.         }
  205.         $this->_captureLock = true;
  206.         $this->_captureType = $captureType;
  207.         $this->_captureScriptType = $type;
  208.         $this->_captureScriptAttrs = $attrs;
  209.         ob_start();
  210.     }
  212.     /**
  213.      * End capture action and store
  214.      *
  215.      * @return void
  216.      */
  217.     public function captureEnd()
  218.     {
  219.         $content = ob_get_clean();
  220.         $type = $this->_captureScriptType;
  221.         $attrs = $this->_captureScriptAttrs;
  222.         $this->_captureScriptType = null;
  223.         $this->_captureScriptAttrs = null;
  224.         $this->_captureLock = false;
  226.         switch ($this->_captureType) {
  227.             case Container::SET:
  228.             case Container::PREPEND:
  229.             case Container::APPEND:
  230.                 $action = strtolower($this->_captureType) . 'Script';
  232.                 break;
  233.             default:
  234.                 $action = 'appendScript';
  236.                 break;
  237.         }
  238.         $this->$action($content, $type, $attrs);
  239.     }
  241.     /**
  242.      * Overload method access
  243.      *
  244.      * Allows the following method calls:
  245.      * - appendFile($src, $type = 'text/javascript', $attrs = array())
  246.      * - offsetSetFile($index, $src, $type = 'text/javascript', $attrs = array())
  247.      * - prependFile($src, $type = 'text/javascript', $attrs = array())
  248.      * - setFile($src, $type = 'text/javascript', $attrs = array())
  249.      * - appendScript($script, $type = 'text/javascript', $attrs = array())
  250.      * - offsetSetScript($index, $src, $type = 'text/javascript', $attrs = array())
  251.      * - prependScript($script, $type = 'text/javascript', $attrs = array())
  252.      * - setScript($script, $type = 'text/javascript', $attrs = array())
  253.      *
  254.      * @param  string $method
  255.      * @param  array $args
  256.      *
  257.      * @return HeadScript
  258.      *
  259.      * @throws Exception if too few arguments or invalid method
  260.      */
  261.     public function __call($method, $args)
  262.     {
  263.         if (preg_match('/^(?P<action>set|(ap|pre)pend|offsetSet)(?P<mode>File|Script)$/', $method, $matches)) {
  264.             if (1 > count($args)) {
  265.                 throw new Exception(sprintf('Method "%s" requires at least one argument', $method));
  266.             }
  268.             $action = $matches['action'];
  269.             $mode = strtolower($matches['mode']);
  270.             $type = 'text/javascript';
  271.             $attrs = [];
  272.             $index = null;
  274.             if ('offsetSet' == $action) {
  275.                 $index = array_shift($args);
  276.                 if (1 > count($args)) {
  277.                     throw new Exception(sprintf('Method "%s" requires at least two arguments, an index and source', $method));
  278.                 }
  279.             }
  281.             $content = $args[0];
  283.             if (isset($args[1])) {
  284.                 $type = (string) $args[1];
  285.             }
  286.             if (isset($args[2])) {
  287.                 $attrs = (array) $args[2];
  288.             }
  290.             switch ($mode) {
  291.                 case 'script':
  292.                     $item = $this->createData($type, $attrs, $content);
  293.                     if ('offsetSet' == $action) {
  294.                         $this->offsetSet($index, $item);
  295.                     } else {
  296.                         $this->$action($item);
  297.                     }
  299.                     break;
  300.                 case 'file':
  301.                 default:
  302.                     if (!$this->_isDuplicate($content) || $action == 'set') {
  303.                         $attrs['src'] = $content;
  304.                         $item = $this->createData($type, $attrs);
  305.                         if ('offsetSet' == $action) {
  306.                             $this->offsetSet($index, $item);
  307.                         } else {
  308.                             $this->$action($item);
  309.                         }
  310.                     }
  312.                     break;
  313.             }
  315.             return $this;
  316.         }
  318.         return parent::__call($method, $args);
  319.     }
  321.     /**
  322.      * Is the file specified a duplicate?
  323.      *
  324.      * @param  string $file
  325.      *
  326.      * @return bool
  327.      */
  328.     protected function _isDuplicate($file)
  329.     {
  330.         foreach ($this->getContainer() as $item) {
  331.             if (($item->source === null)
  332.                 && array_key_exists('src', $item->attributes)
  333.                 && ($file == $item->attributes['src'])) {
  334.                 return true;
  335.             }
  336.         }
  338.         return false;
  339.     }
  341.     /**
  342.      * Is the script provided valid?
  343.      *
  344.      * @param mixed $value
  345.      *
  346.      * @return bool
  347.      */
  348.     protected function _isValid($value)
  349.     {
  350.         if ((!$value instanceof \stdClass)
  351.             || !isset($value->type)
  352.             || (!isset($value->source) && !isset($value->attributes))) {
  353.             return false;
  354.         }
  356.         return true;
  357.     }
  359.     /**
  360.      * Override append
  361.      *
  362.      * @param  string $value
  363.      *
  364.      * @return void
  365.      */
  366.     public function append($value)
  367.     {
  368.         if (!$this->_isValid($value)) {
  369.             throw new Exception('Invalid argument passed to append(); please use one of the helper methods, appendScript() or appendFile()');
  370.         }
  372.         $this->getContainer()->append($value);
  373.     }
  375.     /**
  376.      * Override prepend
  377.      *
  378.      * @param  string $value
  379.      *
  380.      * @return void
  381.      */
  382.     public function prepend($value)
  383.     {
  384.         if (!$this->_isValid($value)) {
  385.             throw new Exception('Invalid argument passed to prepend(); please use one of the helper methods, prependScript() or prependFile()');
  386.         }
  388.         $this->getContainer()->prepend($value);
  389.     }
  391.     /**
  392.      * Override set
  393.      *
  394.      * @param  string $value
  395.      *
  396.      * @return void
  397.      */
  398.     public function set($value)
  399.     {
  400.         if (!$this->_isValid($value)) {
  401.             throw new Exception('Invalid argument passed to set(); please use one of the helper methods, setScript() or setFile()');
  402.         }
  404.         $this->getContainer()->set($value);
  405.     }
  407.     /**
  408.      * Override offsetSet
  409.      *
  410.      * @param  string|int $index
  411.      * @param  mixed $value
  412.      *
  413.      * @return void
  414.      */
  415.     public function offsetSet($index, $value)
  416.     {
  417.         if (!$this->_isValid($value)) {
  418.             throw new Exception('Invalid argument passed to offsetSet(); please use one of the helper methods, offsetSetScript() or offsetSetFile()');
  419.         }
  421.         $this->getContainer()->offsetSet($index, $value);
  422.     }
  424.     /**
  425.      * Set flag indicating if arbitrary attributes are allowed
  426.      *
  427.      * @param  bool $flag
  428.      *
  429.      * @return HeadScript
  430.      */
  431.     public function setAllowArbitraryAttributes($flag)
  432.     {
  433.         $this->_arbitraryAttributes = (bool) $flag;
  435.         return $this;
  436.     }
  438.     /**
  439.      * Are arbitrary attributes allowed?
  440.      *
  441.      * @return bool
  442.      */
  443.     public function arbitraryAttributesAllowed()
  444.     {
  445.         return $this->_arbitraryAttributes;
  446.     }
  448.     /**
  449.      * Create script HTML
  450.      *
  451.      * @param \stdClass $item
  452.      * @param string $indent
  453.      * @param string $escapeStart
  454.      * @param string $escapeEnd
  455.      *
  456.      * @return string
  457.      */
  458.     public function itemToString($item, $indent, $escapeStart, $escapeEnd)
  459.     {
  460.         $attrString = '';
  462.         $type = ($this->_autoEscape) ? $this->_escape($item->type) : $item->type;
  463.         if ($type != 'text/javascript') {
  464.             $item->attributes['type'] = $type;
  465.         }
  467.         if (!empty($item->attributes)) {
  468.             foreach ($item->attributes as $key => $value) {
  469.                 if ((!$this->arbitraryAttributesAllowed() && !in_array($key, $this->_optionalAttributes))
  470.                     || in_array($key, ['conditional', 'noescape'])) {
  471.                     continue;
  472.                 }
  473.                 if ('defer' == $key) {
  474.                     $value = 'defer';
  475.                 }
  476.                 $attrString .= sprintf(' %s="%s"', $key, ($this->_autoEscape) ? $this->_escape($value) : $value);
  477.             }
  478.         }
  480.         $addScriptEscape = !(isset($item->attributes['noescape']) && filter_var($item->attributes['noescape'], FILTER_VALIDATE_BOOLEAN));
  482.         $html = '<script' . $attrString . '>';
  483.         if (!empty($item->source)) {
  484.             $html .= PHP_EOL ;
  486.             if ($addScriptEscape) {
  487.                 $html .= $indent . '    ' . $escapeStart . PHP_EOL;
  488.             }
  490.             $html .= $indent . '    ' . $item->source;
  492.             if ($addScriptEscape) {
  493.                 $html .= $indent . '    ' . $escapeEnd . PHP_EOL;
  494.             }
  496.             $html .= $indent;
  497.         }
  498.         $html .= '</script>';
  500.         if (isset($item->attributes['conditional'])
  501.             && !empty($item->attributes['conditional'])
  502.             && is_string($item->attributes['conditional'])) {
  503.             // inner wrap with comment end and start if !IE
  504.             if (str_replace(' ', '', $item->attributes['conditional']) === '!IE') {
  505.                 $html = '<!-->' . $html . '<!--';
  506.             }
  507.             $html = $indent . '<!--[if ' . $item->attributes['conditional'] . ']>' . $html . '<![endif]-->';
  508.         } else {
  509.             $html = $indent . $html;
  510.         }
  512.         return $html;
  513.     }
  515.     /**
  516.      * Retrieve string representation
  517.      *
  518.      * @param  string|int $indent
  519.      *
  520.      * @return string
  521.      */
  522.     public function toString($indent = null)
  523.     {
  524.         $this->prepareEntries();
  526.         $indent = (null !== $indent)
  527.             ? $this->getWhitespace($indent)
  528.             : $this->getIndent();
  530.         $useCdata = $this->useCdata ? true : false;
  531.         $escapeStart = ($useCdata) ? '//<![CDATA[' : '//<!--';
  532.         $escapeEnd = ($useCdata) ? '//]]>' : '//-->';
  534.         $items = [];
  535.         $this->getContainer()->ksort();
  536.         foreach ($this as $item) {
  537.             if (!$this->_isValid($item)) {
  538.                 continue;
  539.             }
  541.             $items[] = $this->itemToString($item, $indent, $escapeStart, $escapeEnd);
  542.         }
  544.         $return = implode($this->getSeparator(), $items);
  546.         return $return;
  547.     }
  549.     protected function prepareEntries()
  550.     {
  551.         foreach ($this as &$item) {
  552.             if (!$this->_isValid($item)) {
  553.                 continue;
  554.             }
  556.             if ($this->isCacheBuster()) {
  557.                 // adds the automatic cache buster functionality
  558.                 if (is_array($item->attributes)) {
  559.                     if (isset($item->attributes['src'])) {
  560.                         $realFile = PIMCORE_WEB_ROOT . $item->attributes['src'];
  561.                         if (file_exists($realFile)) {
  562.                             $item->attributes['src'] = '/cache-buster-' . filemtime($realFile) . $item->attributes['src'];
  563.                         }
  564.                     }
  565.                 }
  566.             }
  568.             $event = new GenericEvent($this, [
  569.                 'item' => $item,
  570.             ]);
  571.             \Pimcore::getEventDispatcher()->dispatch(FrontendEvents::VIEW_HELPER_HEAD_SCRIPT, $event);
  573.             if (isset($item->attributes) && is_array($item->attributes)) {
  574.                 $source = (string)($item->attributes['src'] ?? '');
  575.                 $itemAttributes = $item->attributes;
  577.                 if (isset($item->attributes['webLink'])) {
  578.                     unset($item->attributes['webLink']);
  579.                 }
  581.                 if (!empty($source)) {
  582.                     $this->handleWebLink($item, $source, $itemAttributes);
  583.                 }
  584.             }
  585.         }
  586.     }
  588.     /**
  589.      * Create data item containing all necessary components of script
  590.      *
  591.      * @param  string $type
  592.      * @param  array $attributes
  593.      * @param  string $content
  594.      *
  595.      * @return \stdClass
  596.      */
  597.     public function createData($type, array $attributes, $content = null)
  598.     {
  599.         $data = new \stdClass();
  600.         $data->type = $type;
  601.         $data->attributes = $attributes;
  602.         $data->source = $content;
  604.         return $data;
  605.     }
  606. }
  608. class_alias(HeadScript::class, 'Pimcore\Templating\Helper\HeadScript');