OwlCyberSecurity - MANAGER

Edit File: CssInliner.php

<?php
declare (strict_types=1);
namespace MailPoetVendor\Pelago\Emogrifier;
if (!defined('ABSPATH')) exit;
use MailPoetVendor\Pelago\Emogrifier\Css\CssDocument;
use MailPoetVendor\Pelago\Emogrifier\HtmlProcessor\AbstractHtmlProcessor;
use MailPoetVendor\Pelago\Emogrifier\Utilities\CssConcatenator;
use MailPoetVendor\Symfony\Component\CssSelector\CssSelectorConverter;
use MailPoetVendor\Symfony\Component\CssSelector\Exception\ParseException;
class CssInliner extends AbstractHtmlProcessor
{
 private const CACHE_KEY_SELECTOR = 0;
 private const CACHE_KEY_CSS_DECLARATIONS_BLOCK = 1;
 private const CACHE_KEY_COMBINED_STYLES = 2;
 private const PSEUDO_CLASS_MATCHER = 'empty|(?:first|last|nth(?:-last)?+|only)-(?:child|of-type)|not\$[[:ascii:]]*\$';
 private const OF_TYPE_PSEUDO_CLASS_MATCHER = '(?:first|last|nth(?:-last)?+|only)-of-type';
 private const COMBINATOR_MATCHER = '(?:\\s++|\\s*+[>+~]\\s*+)(?=[[:alpha:]_\\-.#*:\\[])';
 private $excludedSelectors = [];
 private $allowedMediaTypes = ['all' => \true, 'screen' => \true, 'print' => \true];
 private $caches = [self::CACHE_KEY_SELECTOR => [], self::CACHE_KEY_CSS_DECLARATIONS_BLOCK => [], self::CACHE_KEY_COMBINED_STYLES => []];
 private $cssSelectorConverter = null;
 private $visitedNodes = [];
 private $styleAttributesForNodes = [];
 private $isInlineStyleAttributesParsingEnabled = \true;
 private $isStyleBlocksParsingEnabled = \true;
 private $selectorPrecedenceMatchers = [
 // IDs: worth 10000
 '\\#' => 10000,
 // classes, attributes, pseudo-classes (not pseudo-elements) except `:not`: worth 100
 '(?:\\.|\\[|(?<!:):(?!not\\())' => 100,
 // elements (not attribute values or `:not`), pseudo-elements: worth 1
 '(?:(?<![="\':\\w\\-])|::)' => 1,
 ];
 private $matchingUninlinableCssRules = null;
 private $debug = \false;
 public function inlineCss(string $css = '') : self
 {
 $this->clearAllCaches();
 $this->purgeVisitedNodes();
 $this->normalizeStyleAttributesOfAllNodes();
 $combinedCss = $css;
 // grab any existing style blocks from the HTML and append them to the existing CSS
 // (these blocks should be appended so as to have precedence over conflicting styles in the existing CSS)
 if ($this->isStyleBlocksParsingEnabled) {
 $combinedCss .= $this->getCssFromAllStyleNodes();
 }
 $parsedCss = new CssDocument($combinedCss, $this->debug);
 $excludedNodes = $this->getNodesToExclude();
 $cssRules = $this->collateCssRules($parsedCss);
 $cssSelectorConverter = $this->getCssSelectorConverter();
 foreach ($cssRules['inlinable'] as $cssRule) {
 try {
 $nodesMatchingCssSelectors = $this->getXPath()->query($cssSelectorConverter->toXPath($cssRule['selector']));
 foreach ($nodesMatchingCssSelectors as $node) {
 if (\in_array($node, $excludedNodes, \true)) {
 continue;
 }
 $this->copyInlinableCssToStyleAttribute($node, $cssRule);
 }
 } catch (ParseException $e) {
 if ($this->debug) {
 throw $e;
 }
 }
 }
 if ($this->isInlineStyleAttributesParsingEnabled) {
 $this->fillStyleAttributesWithMergedStyles();
 }
 $this->removeImportantAnnotationFromAllInlineStyles();
 $this->determineMatchingUninlinableCssRules($cssRules['uninlinable']);
 $this->copyUninlinableCssToStyleNode($parsedCss);
 return $this;
 }
 public function disableInlineStyleAttributesParsing() : self
 {
 $this->isInlineStyleAttributesParsingEnabled = \false;
 return $this;
 }
 public function disableStyleBlocksParsing() : self
 {
 $this->isStyleBlocksParsingEnabled = \false;
 return $this;
 }
 public function addAllowedMediaType(string $mediaName) : self
 {
 $this->allowedMediaTypes[$mediaName] = \true;
 return $this;
 }
 public function removeAllowedMediaType(string $mediaName) : self
 {
 if (isset($this->allowedMediaTypes[$mediaName])) {
 unset($this->allowedMediaTypes[$mediaName]);
 }
 return $this;
 }
 public function addExcludedSelector(string $selector) : self
 {
 $this->excludedSelectors[$selector] = \true;
 return $this;
 }
 public function removeExcludedSelector(string $selector) : self
 {
 if (isset($this->excludedSelectors[$selector])) {
 unset($this->excludedSelectors[$selector]);
 }
 return $this;
 }
 public function setDebug(bool $debug) : self
 {
 $this->debug = $debug;
 return $this;
 }
 public function getMatchingUninlinableSelectors() : array
 {
 return \array_column($this->getMatchingUninlinableCssRules(), 'selector');
 }
 private function getMatchingUninlinableCssRules() : array
 {
 if (!\is_array($this->matchingUninlinableCssRules)) {
 throw new \BadMethodCallException('inlineCss must be called first', 1568385221);
 }
 return $this->matchingUninlinableCssRules;
 }
 private function clearAllCaches() : void
 {
 $this->caches = [self::CACHE_KEY_SELECTOR => [], self::CACHE_KEY_CSS_DECLARATIONS_BLOCK => [], self::CACHE_KEY_COMBINED_STYLES => []];
 }
 private function purgeVisitedNodes() : void
 {
 $this->visitedNodes = [];
 $this->styleAttributesForNodes = [];
 }
 private function normalizeStyleAttributesOfAllNodes() : void
 {
 foreach ($this->getAllNodesWithStyleAttribute() as $node) {
 if ($this->isInlineStyleAttributesParsingEnabled) {
 $this->normalizeStyleAttributes($node);
 }
 // Remove style attribute in every case, so we can add them back (if inline style attributes
 // parsing is enabled) to the end of the style list, thus keeping the right priority of CSS rules;
 // else original inline style rules may remain at the beginning of the final inline style definition
 // of a node, which may give not the desired results
 $node->removeAttribute('style');
 }
 }
 private function getAllNodesWithStyleAttribute() : \DOMNodeList
 {
 $query = '//*[@style]';
 $matches = $this->getXPath()->query($query);
 if (!$matches instanceof \DOMNodeList) {
 throw new \RuntimeException('XPatch query failed: ' . $query, 1618577797);
 }
 return $matches;
 }
 private function normalizeStyleAttributes(\DOMElement $node) : void
 {
 $normalizedOriginalStyle = \preg_replace_callback(
 '/-?+[_a-zA-Z][\\w\\-]*+(?=:)/S',
 static function (array $propertyNameMatches) : string {
 return \strtolower($propertyNameMatches[0]);
 },
 $node->getAttribute('style')
 );
 // In order to not overwrite existing style attributes in the HTML, we have to save the original HTML styles.
 $nodePath = $node->getNodePath();
 if (\is_string($nodePath) && !isset($this->styleAttributesForNodes[$nodePath])) {
 $this->styleAttributesForNodes[$nodePath] = $this->parseCssDeclarationsBlock($normalizedOriginalStyle);
 $this->visitedNodes[$nodePath] = $node;
 }
 $node->setAttribute('style', $normalizedOriginalStyle);
 }
 private function parseCssDeclarationsBlock(string $cssDeclarationsBlock) : array
 {
 if (isset($this->caches[self::CACHE_KEY_CSS_DECLARATIONS_BLOCK][$cssDeclarationsBlock])) {
 return $this->caches[self::CACHE_KEY_CSS_DECLARATIONS_BLOCK][$cssDeclarationsBlock];
 }
 $properties = [];
 foreach (\preg_split('/;(?!base64|charset)/', $cssDeclarationsBlock) as $declaration) {
 $matches = [];
 if (!\preg_match('/^([A-Za-z\\-]+)\\s*:\\s*(.+)$/s', \trim($declaration), $matches)) {
 continue;
 }
 $propertyName = \strtolower($matches[1]);
 $propertyValue = $matches[2];
 $properties[$propertyName] = $propertyValue;
 }
 $this->caches[self::CACHE_KEY_CSS_DECLARATIONS_BLOCK][$cssDeclarationsBlock] = $properties;
 return $properties;
 }
 private function getCssFromAllStyleNodes() : string
 {
 $styleNodes = $this->getXPath()->query('//style');
 if ($styleNodes === \false) {
 return '';
 }
 $css = '';
 foreach ($styleNodes as $styleNode) {
 if (\is_string($styleNode->nodeValue)) {
 $css .= "\n\n" . $styleNode->nodeValue;
 }
 $parentNode = $styleNode->parentNode;
 if ($parentNode instanceof \DOMNode) {
 $parentNode->removeChild($styleNode);
 }
 }
 return $css;
 }
 private function getNodesToExclude() : array
 {
 $excludedNodes = [];
 foreach (\array_keys($this->excludedSelectors) as $selectorToExclude) {
 try {
 $matchingNodes = $this->getXPath()->query($this->getCssSelectorConverter()->toXPath($selectorToExclude));
 foreach ($matchingNodes as $node) {
 if (!$node instanceof \DOMElement) {
 $path = $node->getNodePath() ?? '$node';
 throw new \UnexpectedValueException($path . ' is not a DOMElement.', 1617975914);
 }
 $excludedNodes[] = $node;
 }
 } catch (ParseException $e) {
 if ($this->debug) {
 throw $e;
 }
 }
 }
 return $excludedNodes;
 }
 private function getCssSelectorConverter() : CssSelectorConverter
 {
 if (!$this->cssSelectorConverter instanceof CssSelectorConverter) {
 $this->cssSelectorConverter = new CssSelectorConverter();
 }
 return $this->cssSelectorConverter;
 }
 private function collateCssRules(CssDocument $parsedCss) : array
 {
 $matches = $parsedCss->getStyleRulesData(\array_keys($this->allowedMediaTypes));
 $cssRules = ['inlinable' => [], 'uninlinable' => []];
 foreach ($matches as $key => $cssRule) {
 if (!$cssRule->hasAtLeastOneDeclaration()) {
 continue;
 }
 $mediaQuery = $cssRule->getContainingAtRule();
 $declarationsBlock = $cssRule->getDeclarationAsText();
 foreach ($cssRule->getSelectors() as $selector) {
 // don't process pseudo-elements and behavioral (dynamic) pseudo-classes;
 // only allow structural pseudo-classes
 $hasPseudoElement = \strpos($selector, '::') !== \false;
 $hasUnmatchablePseudo = $hasPseudoElement || $this->hasUnsupportedPseudoClass($selector);
 $parsedCssRule = [
 'media' => $mediaQuery,
 'selector' => $selector,
 'hasUnmatchablePseudo' => $hasUnmatchablePseudo,
 'declarationsBlock' => $declarationsBlock,
 // keep track of where it appears in the file, since order is important
 'line' => $key,
 ];
 $ruleType = !$cssRule->hasContainingAtRule() && !$hasUnmatchablePseudo ? 'inlinable' : 'uninlinable';
 $cssRules[$ruleType][] = $parsedCssRule;
 }
 }
 \usort(
 $cssRules['inlinable'],
 function (array $first, array $second) : int {
 return $this->sortBySelectorPrecedence($first, $second);
 }
 );
 return $cssRules;
 }
 private function hasUnsupportedPseudoClass(string $selector) : bool
 {
 if (\preg_match('/:(?!' . self::PSEUDO_CLASS_MATCHER . ')[\\w\\-]/i', $selector)) {
 return \true;
 }
 if (!\preg_match('/:(?:' . self::OF_TYPE_PSEUDO_CLASS_MATCHER . ')/i', $selector)) {
 return \false;
 }
 foreach (\preg_split('/' . self::COMBINATOR_MATCHER . '/', $selector) as $selectorPart) {
 if ($this->selectorPartHasUnsupportedOfTypePseudoClass($selectorPart)) {
 return \true;
 }
 }
 return \false;
 }
 private function selectorPartHasUnsupportedOfTypePseudoClass(string $selectorPart) : bool
 {
 if (\preg_match('/^[\\w\\-]/', $selectorPart)) {
 return \false;
 }
 return (bool) \preg_match('/:(?:' . self::OF_TYPE_PSEUDO_CLASS_MATCHER . ')/i', $selectorPart);
 }
 private function sortBySelectorPrecedence(array $first, array $second) : int
 {
 $precedenceOfFirst = $this->getCssSelectorPrecedence($first['selector']);
 $precedenceOfSecond = $this->getCssSelectorPrecedence($second['selector']);
 // We want these sorted in ascending order so selectors with lesser precedence get processed first and
 // selectors with greater precedence get sorted last.
 $precedenceForEquals = $first['line'] < $second['line'] ? -1 : 1;
 $precedenceForNotEquals = $precedenceOfFirst < $precedenceOfSecond ? -1 : 1;
 return $precedenceOfFirst === $precedenceOfSecond ? $precedenceForEquals : $precedenceForNotEquals;
 }
 private function getCssSelectorPrecedence(string $selector) : int
 {
 $selectorKey = \md5($selector);
 if (isset($this->caches[self::CACHE_KEY_SELECTOR][$selectorKey])) {
 return $this->caches[self::CACHE_KEY_SELECTOR][$selectorKey];
 }
 $precedence = 0;
 foreach ($this->selectorPrecedenceMatchers as $matcher => $value) {
 if (\trim($selector) === '') {
 break;
 }
 $number = 0;
 $selector = \preg_replace('/' . $matcher . '\\w+/', '', $selector, -1, $number);
 $precedence += $value * (int) $number;
 }
 $this->caches[self::CACHE_KEY_SELECTOR][$selectorKey] = $precedence;
 return $precedence;
 }
 private function copyInlinableCssToStyleAttribute(\DOMElement $node, array $cssRule) : void
 {
 $declarationsBlock = $cssRule['declarationsBlock'];
 $newStyleDeclarations = $this->parseCssDeclarationsBlock($declarationsBlock);
 if ($newStyleDeclarations === []) {
 return;
 }
 // if it has a style attribute, get it, process it, and append (overwrite) new stuff
 if ($node->hasAttribute('style')) {
 // break it up into an associative array
 $oldStyleDeclarations = $this->parseCssDeclarationsBlock($node->getAttribute('style'));
 } else {
 $oldStyleDeclarations = [];
 }
 $node->setAttribute('style', $this->generateStyleStringFromDeclarationsArrays($oldStyleDeclarations, $newStyleDeclarations));
 }
 private function generateStyleStringFromDeclarationsArrays(array $oldStyles, array $newStyles) : string
 {
 $cacheKey = \serialize([$oldStyles, $newStyles]);
 if (isset($this->caches[self::CACHE_KEY_COMBINED_STYLES][$cacheKey])) {
 return $this->caches[self::CACHE_KEY_COMBINED_STYLES][$cacheKey];
 }
 // Unset the overridden styles to preserve order, important if shorthand and individual properties are mixed
 foreach ($oldStyles as $attributeName => $attributeValue) {
 if (!isset($newStyles[$attributeName])) {
 continue;
 }
 $newAttributeValue = $newStyles[$attributeName];
 if ($this->attributeValueIsImportant($attributeValue) && !$this->attributeValueIsImportant($newAttributeValue)) {
 unset($newStyles[$attributeName]);
 } else {
 unset($oldStyles[$attributeName]);
 }
 }
 $combinedStyles = \array_merge($oldStyles, $newStyles);
 $style = '';
 foreach ($combinedStyles as $attributeName => $attributeValue) {
 $style .= \strtolower(\trim($attributeName)) . ': ' . \trim($attributeValue) . '; ';
 }
 $trimmedStyle = \rtrim($style);
 $this->caches[self::CACHE_KEY_COMBINED_STYLES][$cacheKey] = $trimmedStyle;
 return $trimmedStyle;
 }
 private function attributeValueIsImportant(string $attributeValue) : bool
 {
 return (bool) \preg_match('/!\\s*+important$/i', $attributeValue);
 }
 private function fillStyleAttributesWithMergedStyles() : void
 {
 foreach ($this->styleAttributesForNodes as $nodePath => $styleAttributesForNode) {
 $node = $this->visitedNodes[$nodePath];
 $currentStyleAttributes = $this->parseCssDeclarationsBlock($node->getAttribute('style'));
 $node->setAttribute('style', $this->generateStyleStringFromDeclarationsArrays($currentStyleAttributes, $styleAttributesForNode));
 }
 }
 private function removeImportantAnnotationFromAllInlineStyles() : void
 {
 foreach ($this->getAllNodesWithStyleAttribute() as $node) {
 $this->removeImportantAnnotationFromNodeInlineStyle($node);
 }
 }
 private function removeImportantAnnotationFromNodeInlineStyle(\DOMElement $node) : void
 {
 $inlineStyleDeclarations = $this->parseCssDeclarationsBlock($node->getAttribute('style'));
 $regularStyleDeclarations = [];
 $importantStyleDeclarations = [];
 foreach ($inlineStyleDeclarations as $property => $value) {
 if ($this->attributeValueIsImportant($value)) {
 $importantStyleDeclarations[$property] = $this->pregReplace('/\\s*+!\\s*+important$/i', '', $value);
 } else {
 $regularStyleDeclarations[$property] = $value;
 }
 }
 $inlineStyleDeclarationsInNewOrder = \array_merge($regularStyleDeclarations, $importantStyleDeclarations);
 $node->setAttribute('style', $this->generateStyleStringFromSingleDeclarationsArray($inlineStyleDeclarationsInNewOrder));
 }
 private function generateStyleStringFromSingleDeclarationsArray(array $styleDeclarations) : string
 {
 return $this->generateStyleStringFromDeclarationsArrays([], $styleDeclarations);
 }
 private function determineMatchingUninlinableCssRules(array $cssRules) : void
 {
 $this->matchingUninlinableCssRules = \array_filter($cssRules, function (array $cssRule) : bool {
 return $this->existsMatchForSelectorInCssRule($cssRule);
 });
 }
 private function existsMatchForSelectorInCssRule(array $cssRule) : bool
 {
 $selector = $cssRule['selector'];
 if ($cssRule['hasUnmatchablePseudo']) {
 $selector = $this->removeUnmatchablePseudoComponents($selector);
 }
 return $this->existsMatchForCssSelector($selector);
 }
 private function existsMatchForCssSelector(string $cssSelector) : bool
 {
 try {
 $nodesMatchingSelector = $this->getXPath()->query($this->getCssSelectorConverter()->toXPath($cssSelector));
 } catch (ParseException $e) {
 if ($this->debug) {
 throw $e;
 }
 return \true;
 }
 return $nodesMatchingSelector !== \false && $nodesMatchingSelector->length !== 0;
 }
 private function removeUnmatchablePseudoComponents(string $selector) : string
 {
 // The regex allows nested brackets via `(?2)`.
 // A space is temporarily prepended because the callback can't determine if the match was at the very start.
 $selectorWithoutNots = \ltrim(\preg_replace_callback(
 '/([\\s>+~]?+):not(\$[^()]*+(?:(?2)[^()]*+)*+\$)/i',
 function (array $matches) : string {
 return $this->replaceUnmatchableNotComponent($matches);
 },
 ' ' . $selector
 ));
 $selectorWithoutUnmatchablePseudoComponents = $this->removeSelectorComponents(':(?!' . self::PSEUDO_CLASS_MATCHER . '):?+[\\w\\-]++(?:\$[^\$]*+\\))?+', $selectorWithoutNots);
 if (!\preg_match('/:(?:' . self::OF_TYPE_PSEUDO_CLASS_MATCHER . ')/i', $selectorWithoutUnmatchablePseudoComponents)) {
 return $selectorWithoutUnmatchablePseudoComponents;
 }
 return \implode('', \array_map(function (string $selectorPart) : string {
 return $this->removeUnsupportedOfTypePseudoClasses($selectorPart);
 }, \preg_split('/(' . self::COMBINATOR_MATCHER . ')/', $selectorWithoutUnmatchablePseudoComponents, -1, \PREG_SPLIT_DELIM_CAPTURE | \PREG_SPLIT_NO_EMPTY)));
 }
 private function replaceUnmatchableNotComponent(array $matches) : string
 {
 [$notComponentWithAnyPrecedingCombinator, $anyPrecedingCombinator, $notArgumentInBrackets] = $matches;
 if ($this->hasUnsupportedPseudoClass($notArgumentInBrackets)) {
 return $anyPrecedingCombinator !== '' ? $anyPrecedingCombinator . '*' : '';
 }
 return $notComponentWithAnyPrecedingCombinator;
 }
 private function removeSelectorComponents(string $matcher, string $selector) : string
 {
 return \preg_replace(['/([\\s>+~]|^)' . $matcher . '/i', '/' . $matcher . '/i'], ['$1*', ''], $selector);
 }
 private function removeUnsupportedOfTypePseudoClasses(string $selectorPart) : string
 {
 if (!$this->selectorPartHasUnsupportedOfTypePseudoClass($selectorPart)) {
 return $selectorPart;
 }
 return $this->removeSelectorComponents(':(?:' . self::OF_TYPE_PSEUDO_CLASS_MATCHER . ')(?:\$[^\$]*+\\))?+', $selectorPart);
 }
 private function copyUninlinableCssToStyleNode(CssDocument $parsedCss) : void
 {
 $css = $parsedCss->renderNonConditionalAtRules();
 // avoid including unneeded class dependency if there are no rules
 if ($this->getMatchingUninlinableCssRules() !== []) {
 $cssConcatenator = new CssConcatenator();
 foreach ($this->getMatchingUninlinableCssRules() as $cssRule) {
 $cssConcatenator->append([$cssRule['selector']], $cssRule['declarationsBlock'], $cssRule['media']);
 }
 $css .= $cssConcatenator->getCss();
 }
 // avoid adding empty style element
 if ($css !== '') {
 $this->addStyleElementToDocument($css);
 }
 }
 protected function addStyleElementToDocument(string $css) : void
 {
 $domDocument = $this->getDomDocument();
 $styleElement = $domDocument->createElement('style', $css);
 $styleAttribute = $domDocument->createAttribute('type');
 $styleAttribute->value = 'text/css';
 $styleElement->appendChild($styleAttribute);
 $headElement = $this->getHeadElement();
 $headElement->appendChild($styleElement);
 }
 private function getHeadElement() : \DOMElement
 {
 $node = $this->getDomDocument()->getElementsByTagName('head')->item(0);
 if (!$node instanceof \DOMElement) {
 throw new \UnexpectedValueException('There is no HEAD element. This should never happen.', 1617923227);
 }
 return $node;
 }
 private function pregReplace(string $pattern, string $replacement, string $subject) : string
 {
 $result = \preg_replace($pattern, $replacement, $subject);
 if (!\is_string($result)) {
 $this->logOrThrowPregLastError();
 $result = $subject;
 }
 return $result;
 }
 private function logOrThrowPregLastError() : void
 {
 $pcreConstants = \get_defined_constants(\true)['pcre'];
 $pcreErrorConstantNames = \array_flip(\array_filter($pcreConstants, static function (string $key) : bool {
 return \substr($key, -6) === '_ERROR';
 }, \ARRAY_FILTER_USE_KEY));
 $pregLastError = \preg_last_error();
 $message = 'PCRE regex execution error `' . (string) ($pcreErrorConstantNames[$pregLastError] ?? $pregLastError) . '`';
 if ($this->debug) {
 throw new \RuntimeException($message, 1592870147);
 }
 \trigger_error($message);
 }
}