AbstractHtmlProcessor.php
6 days ago
CssToAttributeConverter.php
6 days ago
CssVariableEvaluator.php
6 days ago
HtmlNormalizer.php
6 days ago
HtmlPruner.php
6 days ago
HtmlPruner.php
119 lines
| 1 | <?php |
| 2 | |
| 3 | declare (strict_types=1); |
| 4 | namespace ProfilePressVendor\Pelago\Emogrifier\HtmlProcessor; |
| 5 | |
| 6 | use ProfilePressVendor\Pelago\Emogrifier\CssInliner; |
| 7 | use ProfilePressVendor\Pelago\Emogrifier\Utilities\ArrayIntersector; |
| 8 | use function ProfilePressVendor\Safe\preg_match_all; |
| 9 | use function ProfilePressVendor\Safe\preg_split; |
| 10 | /** |
| 11 | * This class can remove things from HTML. |
| 12 | */ |
| 13 | final class HtmlPruner extends AbstractHtmlProcessor |
| 14 | { |
| 15 | /** |
| 16 | * We need to look for display:none, but we need to do a case-insensitive search. Since DOMDocument only |
| 17 | * supports XPath 1.0, lower-case() isn't available to us. We've thus far only set attributes to lowercase, |
| 18 | * not attribute values. Consequently, we need to translate() the letters that would be in 'NONE' ("NOE") |
| 19 | * to lowercase. |
| 20 | */ |
| 21 | private const DISPLAY_NONE_MATCHER = '//*[@style and contains(translate(translate(@style," ",""),"NOE","noe"),"display:none")' . ' and not(@class and contains(concat(" ", normalize-space(@class), " "), " -emogrifier-keep "))]'; |
| 22 | /** |
| 23 | * Removes elements that have a "display: none;" style. |
| 24 | * |
| 25 | * @return $this |
| 26 | */ |
| 27 | public function removeElementsWithDisplayNone(): self |
| 28 | { |
| 29 | $elementsWithStyleDisplayNone = $this->getXPath()->query(self::DISPLAY_NONE_MATCHER); |
| 30 | if ($elementsWithStyleDisplayNone->length === 0) { |
| 31 | return $this; |
| 32 | } |
| 33 | foreach ($elementsWithStyleDisplayNone as $element) { |
| 34 | $parentNode = $element->parentNode; |
| 35 | if ($parentNode !== null) { |
| 36 | $parentNode->removeChild($element); |
| 37 | } |
| 38 | } |
| 39 | return $this; |
| 40 | } |
| 41 | /** |
| 42 | * Removes classes that are no longer required (e.g. because there are no longer any CSS rules that reference them) |
| 43 | * from `class` attributes. |
| 44 | * |
| 45 | * Note that this does not inspect the CSS, but expects to be provided with a list of classes that are still in use. |
| 46 | * |
| 47 | * This method also has the (presumably beneficial) side-effect of minifying (removing superfluous whitespace from) |
| 48 | * `class` attributes. |
| 49 | * |
| 50 | * @param array<array-key, string> $classesToKeep names of classes that should not be removed |
| 51 | * |
| 52 | * @return $this |
| 53 | */ |
| 54 | public function removeRedundantClasses(array $classesToKeep = []): self |
| 55 | { |
| 56 | /** @var \DOMNodeList<\DOMElement> $elementsWithClassAttribute */ |
| 57 | $elementsWithClassAttribute = $this->getXPath()->query('//*[@class]'); |
| 58 | if ($classesToKeep !== []) { |
| 59 | $this->removeClassesFromElements($elementsWithClassAttribute, $classesToKeep); |
| 60 | } else { |
| 61 | // Avoid unnecessary processing if there are no classes to keep. |
| 62 | $this->removeClassAttributeFromElements($elementsWithClassAttribute); |
| 63 | } |
| 64 | return $this; |
| 65 | } |
| 66 | /** |
| 67 | * Removes classes from the `class` attribute of each element in `$elements`, except any in `$classesToKeep`, |
| 68 | * removing the `class` attribute itself if the resultant list is empty. |
| 69 | * |
| 70 | * @param \DOMNodeList<\DOMElement> $elements |
| 71 | * @param array<array-key, string> $classesToKeep |
| 72 | */ |
| 73 | private function removeClassesFromElements(\DOMNodeList $elements, array $classesToKeep): void |
| 74 | { |
| 75 | $classesToKeepIntersector = new ArrayIntersector($classesToKeep); |
| 76 | foreach ($elements as $element) { |
| 77 | $elementClasses = preg_split('/\s++/', \trim($element->getAttribute('class'))); |
| 78 | $elementClassesToKeep = $classesToKeepIntersector->intersectWith($elementClasses); |
| 79 | if ($elementClassesToKeep !== []) { |
| 80 | $element->setAttribute('class', \implode(' ', $elementClassesToKeep)); |
| 81 | } else { |
| 82 | $element->removeAttribute('class'); |
| 83 | } |
| 84 | } |
| 85 | } |
| 86 | /** |
| 87 | * @param \DOMNodeList<\DOMElement> $elements |
| 88 | */ |
| 89 | private function removeClassAttributeFromElements(\DOMNodeList $elements): void |
| 90 | { |
| 91 | foreach ($elements as $element) { |
| 92 | $element->removeAttribute('class'); |
| 93 | } |
| 94 | } |
| 95 | /** |
| 96 | * After CSS has been inlined, there will likely be some classes in `class` attributes that are no longer referenced |
| 97 | * by any remaining (uninlinable) CSS. This method removes such classes. |
| 98 | * |
| 99 | * Note that it does not inspect the remaining CSS, but uses information readily available from the `CssInliner` |
| 100 | * instance about the CSS rules that could not be inlined. |
| 101 | * |
| 102 | * @param CssInliner $cssInliner object instance that performed the CSS inlining |
| 103 | * |
| 104 | * @return $this |
| 105 | * |
| 106 | * @throws \BadMethodCallException if `inlineCss` has not first been called on `$cssInliner` |
| 107 | */ |
| 108 | public function removeRedundantClassesAfterCssInlined(CssInliner $cssInliner): self |
| 109 | { |
| 110 | $classesToKeepAsKeys = []; |
| 111 | foreach ($cssInliner->getMatchingUninlinableSelectors() as $selector) { |
| 112 | preg_match_all('/\.(-?+[_a-zA-Z][\w\-]*+)/', $selector, $matches); |
| 113 | $classesToKeepAsKeys += \array_fill_keys($matches[1], \true); |
| 114 | } |
| 115 | $this->removeRedundantClasses(\array_keys($classesToKeepAsKeys)); |
| 116 | return $this; |
| 117 | } |
| 118 | } |
| 119 |