lochmueller / sourceopt

Classes/Manipulation/RemoveComments.php

Indentation +51 added lines, -51 removed lines

@@ -6,61 +6,61 @@
 
 class RemoveComments implements ManipulationInterface
 {
-    /**
-     * Patterns for white-listing comments inside content.
-     */
-    protected array $whiteListCommentsPatterns = [];
+	/**
+	 * Patterns for white-listing comments inside content.
+	 */
+	protected array $whiteListCommentsPatterns = [];
 
-    /**
-     * @param string $html          The original HTML
-     * @param array  $configuration Configuration
-     *
-     * @return string the manipulated HTML
-     */
-    public function manipulate(string $html, array $configuration = []): string
-    {
-        if (isset($configuration['keep.'])) {
-            $this->whiteListCommentsPatterns = $configuration['keep.'];
-        }
+	/**
+	 * @param string $html          The original HTML
+	 * @param array  $configuration Configuration
+	 *
+	 * @return string the manipulated HTML
+	 */
+	public function manipulate(string $html, array $configuration = []): string
+	{
+		if (isset($configuration['keep.'])) {
+			$this->whiteListCommentsPatterns = $configuration['keep.'];
+		}
 
-        // match all comments, styles and scripts
-        $matches = [];
-        preg_match_all(
-            '/(?s)((<!--.*?-->)|(<[ \n\r]*style[^>]*>.*?<[ \n\r]*\/style[^>]*>)|(<[ \n\r]*script[^>]*>.*?<[ \n\r]*\/script[^>]*>))/im',
-            $html,
-            $matches
-        );
-        foreach ($matches[0] as $tag) {
-            if (false === $this->keepComment($tag)) {
-                $html = str_replace($tag, '', $html);
-            }
-        }
+		// match all comments, styles and scripts
+		$matches = [];
+		preg_match_all(
+			'/(?s)((<!--.*?-->)|(<[ \n\r]*style[^>]*>.*?<[ \n\r]*\/style[^>]*>)|(<[ \n\r]*script[^>]*>.*?<[ \n\r]*\/script[^>]*>))/im',
+			$html,
+			$matches
+		);
+		foreach ($matches[0] as $tag) {
+			if (false === $this->keepComment($tag)) {
+				$html = str_replace($tag, '', $html);
+			}
+		}
 
-        return $html;
-    }
+		return $html;
+	}
 
-    /**
-     * Check if a comment is defined to be kept in a pattern whiteListOfComments.
-     */
-    protected function keepComment(string $commentHtml): bool
-    {
-        // if not even a comment, skip this
-        if (!preg_match('/^\<\!\-\-(.*?)\-\-\>$/usi', $commentHtml)) {
-            return true;
-        }
+	/**
+	 * Check if a comment is defined to be kept in a pattern whiteListOfComments.
+	 */
+	protected function keepComment(string $commentHtml): bool
+	{
+		// if not even a comment, skip this
+		if (!preg_match('/^\<\!\-\-(.*?)\-\-\>$/usi', $commentHtml)) {
+			return true;
+		}
 
-        // if not defined in white list
-        if (!empty($this->whiteListCommentsPatterns)) {
-            $commentHtml = str_replace('<!--', '', $commentHtml);
-            $commentHtml = str_replace('-->', '', $commentHtml);
-            $commentHtml = trim($commentHtml);
-            foreach ($this->whiteListCommentsPatterns as $pattern) {
-                if (!empty($pattern) && preg_match($pattern, $commentHtml)) {
-                    return true;
-                }
-            }
-        }
+		// if not defined in white list
+		if (!empty($this->whiteListCommentsPatterns)) {
+			$commentHtml = str_replace('<!--', '', $commentHtml);
+			$commentHtml = str_replace('-->', '', $commentHtml);
+			$commentHtml = trim($commentHtml);
+			foreach ($this->whiteListCommentsPatterns as $pattern) {
+				if (!empty($pattern) && preg_match($pattern, $commentHtml)) {
+					return true;
+				}
+			}
+		}
 
-        return false;
-    }
+		return false;
+	}
 }

Classes/Manipulation/ManipulationInterface.php

Indentation +7 added lines, -7 removed lines

@@ -6,11 +6,11 @@
 
 interface ManipulationInterface
 {
-    /**
-     * @param string $html          The original HTML
-     * @param array  $configuration Configuration
-     *
-     * @return string the manipulated HTML
-     */
-    public function manipulate(string $html, array $configuration = []): string;
+	/**
+	 * @param string $html          The original HTML
+	 * @param array  $configuration Configuration
+	 *
+	 * @return string the manipulated HTML
+	 */
+	public function manipulate(string $html, array $configuration = []): string;
 }

Classes/Manipulation/RemoveGenerator.php

Indentation +11 added lines, -11 removed lines

@@ -6,16 +6,16 @@
 
 class RemoveGenerator implements ManipulationInterface
 {
-    /**
-     * @param string $html          The original HTML
-     * @param array  $configuration Configuration
-     *
-     * @return string the manipulated HTML
-     */
-    public function manipulate(string $html, array $configuration = []): string
-    {
-        $regex = '<meta name=["\']?generator["\']? [^>]+>';
+	/**
+	 * @param string $html          The original HTML
+	 * @param array  $configuration Configuration
+	 *
+	 * @return string the manipulated HTML
+	 */
+	public function manipulate(string $html, array $configuration = []): string
+	{
+		$regex = '<meta name=["\']?generator["\']? [^>]+>';
 
-        return (string) preg_replace('/' . $regex . '/is', '', $html);
-    }
+		return (string) preg_replace('/' . $regex . '/is', '', $html);
+	}
 }

Classes/Service/CleanHtmlService.php

Indentation +370 added lines, -370 removed lines

@@ -17,374 +17,374 @@
  */
 class CleanHtmlService implements SingletonInterface
 {
-    /**
-     * Enable Debug comment in footer.
-     */
-    protected bool $debugComment = false;
-
-    /**
-     * Format Type.
-     */
-    protected int $formatType = 0;
-
-    /**
-     * Tab character.
-     */
-    protected string $tab = "\t";
-
-    /**
-     * Newline character.
-     */
-    protected string $newline = "\n";
-
-    /**
-     * Configured extra header comment.
-     */
-    protected string $headerComment = '';
-
-    /**
-     * Empty space char.
-     */
-    protected string $emptySpaceChar = ' ';
-
-    /**
-     * Set variables based on given config.
-     */
-    public function setVariables(array $config): void
-    {
-        if (isset($config['headerComment']) && !empty($config['headerComment'])) {
-            $this->headerComment = $config['headerComment'];
-        }
-
-        if (isset($config['formatHtml']) && is_numeric($config['formatHtml'])) {
-            $this->formatType = (int) $config['formatHtml'];
-        }
-
-        if (isset($config['formatHtml.']['tabSize']) && is_numeric($config['formatHtml.']['tabSize'])) {
-            $this->tab = str_pad('', (int) $config['formatHtml.']['tabSize'], ' ');
-        }
-
-        if (isset($config['formatHtml.']['debugComment'])) {
-            $this->debugComment = (bool) $config['formatHtml.']['debugComment'];
-        }
-
-        if (isset($config['dropEmptySpaceChar']) && (bool) $config['dropEmptySpaceChar']) {
-            $this->emptySpaceChar = '';
-        }
-    }
-
-    /**
-     * Clean given HTML with formatter.
-     */
-    public function clean(string $html, array $config = []): string
-    {
-        if (!empty($config)) {
-            $this->setVariables($config);
-        }
-
-        // convert line-breaks to UNIX
-        $this->convNlOs($html);
-
-        $manipulations = [];
-
-        if (isset($config['removeGenerator']) && (bool) $config['removeGenerator']) {
-            $manipulations['removeGenerator'] = GeneralUtility::makeInstance(RemoveGenerator::class);
-        }
-
-        if (isset($config['removeComments']) && (bool) $config['removeComments']) {
-            $manipulations['removeComments'] = GeneralUtility::makeInstance(RemoveComments::class);
-        }
-
-        if (!empty($this->headerComment)) {
-            $this->includeHeaderComment($html);
-        }
-
-        foreach ($manipulations as $key => $manipulation) {
-            /** @var ManipulationInterface $manipulation */
-            $configuration = isset($config[$key . '.']) && \is_array($config[$key . '.']) ? $config[$key . '.'] : [];
-            $html = $manipulation->manipulate($html, $configuration);
-        }
-
-        // cleanup HTML5 self-closing elements
-        if (!isset($GLOBALS['TSFE']->config['config']['doctype'])
-            || 'x' !== substr($GLOBALS['TSFE']->config['config']['doctype'], 0, 1)) {
-            $html = preg_replace(
-                '/<((?:area|base|br|col|embed|hr|img|input|link|meta|param|source|track|wbr)\s[^>]+?)\s*\\\?\/>/',
-                '<$1>',
-                $html
-            );
-        }
-
-        if ($this->formatType > 0) {
-            $html = $this->formatHtml($html);
-        }
-
-        // remove white space after line ending
-        $this->rTrimLines($html);
-
-        // recover line-breaks
-        if (Environment::isWindows()) {
-            $html = str_replace($this->newline, "\r\n", $html);
-        }
-
-        return (string) $html;
-    }
-
-    /**
-     * Formats the (X)HTML code:
-     *  - taps according to the hirarchy of the tags
-     *  - removes empty spaces between tags
-     *  - removes linebreaks within tags (spares where necessary: pre, textarea, comments, ..)
-     *  choose from five options:
-     *    0 => off
-     *    1 => no line break at all  (code in one line)
-     *    2 => minimalistic line breaks (structure defining box-elements)
-     *    3 => aesthetic line breaks (important box-elements)
-     *    4 => logic line breaks (all box-elements)
-     *    5 => max line breaks (all elements).
-     */
-    protected function formatHtml(string $html): string
-    {
-        // Save original formated pre, textarea, comments, styles and scripts & replace them with markers
-        preg_match_all(
-            '/(?s)((<!--.*?-->)|(<[ \n\r]*pre[^>]*>.*?<[ \n\r]*\/pre[^>]*>)|(<[ \n\r]*textarea[^>]*>.*?<[ \n\r]*\/textarea[^>]*>)|(<[ \n\r]*style[^>]*>.*?<[ \n\r]*\/style[^>]*>)|(<[ \n\r]*script[^>]*>.*?<[ \n\r]*\/script[^>]*>))/im',
-            $html,
-            $matches
-        );
-        $noFormat = $matches[0]; // do not format these block elements
-        for ($i = 0; $i < \count($noFormat); ++$i) {
-            $html = str_replace($noFormat[$i], "\n<!-- ELEMENT {$i} -->", $html);
-        }
-
-        // define box elements for formatting
-        $trueBoxElements = 'address|blockquote|center|dir|div|dl|fieldset|form|h1|h2|h3|h4|h5|h6|hr|isindex|menu|noframes|noscript|ol|p|pre|table|ul|article|aside|details|figcaption|figure|footer|header|hgroup|menu|nav|section';
-        $functionalBoxElements = 'dd|dt|frameset|li|tbody|td|tfoot|th|thead|tr|colgroup';
-        $usableBoxElements = 'applet|button|del|iframe|ins|map|object|script';
-        $imagineBoxElements = 'html|body|head|meta|title|link|script|base|!--';
-        $allBoxLikeElements = '(?>' . $trueBoxElements . '|' . $functionalBoxElements . '|' . $usableBoxElements . '|' . $imagineBoxElements . ')';
-        $esteticBoxLikeElements = '(?>html|head|body|meta name|title|div|table|h1|h2|h3|h4|h5|h6|p|form|pre|center|!--)';
-        $structureBoxLikeElements = '(?>html|head|body|div|!--)';
-
-        // split html into it's elements
-        $htmlArrayTemp = preg_split(
-            '/(<(?:[^<>]+(?:"[^"]*"|\'[^\']*\')?)+>)/',
-            $html,
-            -1,
-            \PREG_SPLIT_DELIM_CAPTURE | \PREG_SPLIT_NO_EMPTY
-        );
-
-        if (false === $htmlArrayTemp) {
-            // Restore saved comments, styles and scripts
-            for ($i = 0; $i < \count($noFormat); ++$i) {
-                $html = str_replace("<!-- ELEMENT {$i} -->", $noFormat[$i], $html);
-            }
-
-            return $html;
-        }
-        // remove empty lines
-        $htmlArray = [''];
-        $index = 1;
-        for ($x = 0; $x < \count($htmlArrayTemp); ++$x) {
-            $text = trim($htmlArrayTemp[$x]);
-            $htmlArray[$index] = '' !== $text ? $htmlArrayTemp[$x] : $this->emptySpaceChar;
-            ++$index;
-        }
-
-        // rebuild html
-        $html = '';
-        $tabs = 0;
-        for ($x = 0; $x < \count($htmlArray); ++$x) {
-            $htmlArrayBefore = $htmlArray[$x - 1] ?? '';
-            $htmlArrayCurrent = $htmlArray[$x] ?? '';
-
-            // check if the element should stand in a new line
-            $newline = false;
-            if ('<?xml' == substr($htmlArrayBefore, 0, 5)) {
-                $newline = true;
-            } elseif (2 == $this->formatType && ( // minimalistic line break
-                // this element has a line break before itself
-                preg_match(
-                    '/<' . $structureBoxLikeElements . '(.*)>/Usi',
-                    $htmlArrayCurrent
-                ) || preg_match(
-                    '/<' . $structureBoxLikeElements . '(.*) \/>/Usi',
-                    $htmlArrayCurrent
-                ) // one element before is a element that has a line break after
-                || preg_match(
-                    '/<\/' . $structureBoxLikeElements . '(.*)>/Usi',
-                    $htmlArrayBefore
-                ) || '<!--' == substr(
-                    $htmlArrayBefore,
-                    0,
-                    4
-                ) || preg_match('/<' . $structureBoxLikeElements . '(.*) \/>/Usi', $htmlArrayBefore))
-            ) {
-                $newline = true;
-            } elseif (3 == $this->formatType && ( // aestetic line break
-                // this element has a line break before itself
-                preg_match(
-                    '/<' . $esteticBoxLikeElements . '(.*)>/Usi',
-                    $htmlArrayCurrent
-                ) || preg_match(
-                    '/<' . $esteticBoxLikeElements . '(.*) \/>/Usi',
-                    $htmlArrayCurrent
-                ) // one element before is a element that has a line break after
-                || preg_match('/<\/' . $esteticBoxLikeElements . '(.*)>/Usi', $htmlArrayBefore) || '<!--' == substr(
-                    $htmlArrayBefore,
-                    0,
-                    4
-                ) || preg_match('/<' . $esteticBoxLikeElements . '(.*) \/>/Usi', $htmlArrayBefore))
-            ) {
-                $newline = true;
-            } elseif ($this->formatType >= 4 && ( // logical line break
-                // this element has a line break before itself
-                preg_match(
-                    '/<' . $allBoxLikeElements . '(.*)>/Usi',
-                    $htmlArrayCurrent
-                ) || preg_match(
-                    '/<' . $allBoxLikeElements . '(.*) \/>/Usi',
-                    $htmlArrayCurrent
-                ) // one element before is a element that has a line break after
-                || preg_match('/<\/' . $allBoxLikeElements . '(.*)>/Usi', $htmlArrayBefore) || '<!--' == substr(
-                    $htmlArrayBefore,
-                    0,
-                    4
-                ) || preg_match('/<' . $allBoxLikeElements . '(.*) \/>/Usi', $htmlArrayBefore))
-            ) {
-                $newline = true;
-            }
-
-            // count down a tab
-            if ('</' == substr($htmlArrayCurrent, 0, 2)) {
-                --$tabs;
-            }
-
-            // add tabs and line breaks in front of the current tag
-            if ($newline) {
-                $html .= $this->newline;
-                for ($y = 0; $y < $tabs; ++$y) {
-                    $html .= $this->tab;
-                }
-            }
-
-            // remove white spaces and line breaks and add current tag to the html-string
-            if ('<![CDATA[' == substr($htmlArrayCurrent, 0, 9) // remove multiple white space in CDATA / XML
-                || '<?xml' == substr($htmlArrayCurrent, 0, 5)
-            ) {
-                $html .= $this->killWhiteSpace($htmlArrayCurrent);
-            } else { // remove all line breaks
-                $html .= $this->killLineBreaks($htmlArrayCurrent);
-            }
-
-            // count up a tab
-            if ('<' == substr($htmlArrayCurrent, 0, 1) && '/' != substr($htmlArrayCurrent, 1, 1)) {
-                if (' ' !== substr($htmlArrayCurrent, 1, 1)
-                    && 'img' !== substr($htmlArrayCurrent, 1, 3)
-                    && 'source' !== substr($htmlArrayCurrent, 1, 6)
-                    && 'br' !== substr($htmlArrayCurrent, 1, 2)
-                    && 'hr' !== substr($htmlArrayCurrent, 1, 2)
-                    && 'input' !== substr($htmlArrayCurrent, 1, 5)
-                    && 'link' !== substr($htmlArrayCurrent, 1, 4)
-                    && 'meta' !== substr($htmlArrayCurrent, 1, 4)
-                    && 'col ' !== substr($htmlArrayCurrent, 1, 4)
-                    && 'frame' !== substr($htmlArrayCurrent, 1, 5)
-                    && 'isindex' !== substr($htmlArrayCurrent, 1, 7)
-                    && 'param' !== substr($htmlArrayCurrent, 1, 5)
-                    && 'area' !== substr($htmlArrayCurrent, 1, 4)
-                    && 'base' !== substr($htmlArrayCurrent, 1, 4)
-                    && '<!' !== substr($htmlArrayCurrent, 0, 2)
-                    && '<?xml' !== substr($htmlArrayCurrent, 0, 5)
-                ) {
-                    ++$tabs;
-                }
-            }
-        }
-
-        // Remove empty lines
-        if ($this->formatType > 1) {
-            $this->removeEmptyLines($html);
-        }
-
-        // Restore saved comments, styles and scripts
-        for ($i = 0; $i < \count($noFormat); ++$i) {
-            $html = str_replace("<!-- ELEMENT {$i} -->", $noFormat[$i], $html);
-        }
-
-        // include debug comment at the end
-        if (0 != $tabs && true === $this->debugComment) {
-            $html .= "<!-- {$tabs} open elements found -->";
-        }
-
-        return $html;
-    }
-
-    /**
-     * Remove ALL line breaks and multiple white space.
-     */
-    protected function killLineBreaks(string $html): string
-    {
-        $html = str_replace($this->newline, '', $html);
-
-        return preg_replace('/\s\s+/u', ' ', $html);
-        // ? return preg_replace('/\n|\s+(\s)/u', '$1', $html);
-    }
-
-    /**
-     * Remove multiple white space, keeps line breaks.
-     */
-    protected function killWhiteSpace(string $html): string
-    {
-        $temp = explode($this->newline, $html);
-        for ($i = 0; $i < \count($temp); ++$i) {
-            if (!trim($temp[$i])) {
-                unset($temp[$i]);
-                continue;
-            }
-
-            $temp[$i] = trim($temp[$i]);
-            $temp[$i] = preg_replace('/\s\s+/', ' ', $temp[$i]);
-        }
-
-        return implode($this->newline, $temp);
-    }
-
-    /**
-     * Remove white space at the end of lines, keeps other white space and line breaks.
-     */
-    protected function rTrimLines(string &$html): void
-    {
-        $html = preg_replace('/\s+$/m', '', $html);
-    }
-
-    /**
-     * Convert newlines according to the current OS.
-     */
-    protected function convNlOs(string &$html): void
-    {
-        $html = preg_replace("(\r\n|\r)", $this->newline, $html);
-    }
-
-    /**
-     * Remove empty lines.
-     */
-    protected function removeEmptyLines(string &$html): void
-    {
-        $temp = explode($this->newline, $html);
-        $result = [];
-        for ($i = 0; $i < \count($temp); ++$i) {
-            if ('' == trim($temp[$i])) {
-                continue;
-            }
-            $result[] = $temp[$i];
-        }
-        $html = implode($this->newline, $result);
-    }
-
-    /**
-     * Include configured header comment in HTML content block.
-     */
-    public function includeHeaderComment(string &$html): void
-    {
-        $html = preg_replace('/^(-->)$/m', "\n\t" . $this->headerComment . "\n$1", $html);
-    }
+	/**
+	 * Enable Debug comment in footer.
+	 */
+	protected bool $debugComment = false;
+
+	/**
+	 * Format Type.
+	 */
+	protected int $formatType = 0;
+
+	/**
+	 * Tab character.
+	 */
+	protected string $tab = "\t";
+
+	/**
+	 * Newline character.
+	 */
+	protected string $newline = "\n";
+
+	/**
+	 * Configured extra header comment.
+	 */
+	protected string $headerComment = '';
+
+	/**
+	 * Empty space char.
+	 */
+	protected string $emptySpaceChar = ' ';
+
+	/**
+	 * Set variables based on given config.
+	 */
+	public function setVariables(array $config): void
+	{
+		if (isset($config['headerComment']) && !empty($config['headerComment'])) {
+			$this->headerComment = $config['headerComment'];
+		}
+
+		if (isset($config['formatHtml']) && is_numeric($config['formatHtml'])) {
+			$this->formatType = (int) $config['formatHtml'];
+		}
+
+		if (isset($config['formatHtml.']['tabSize']) && is_numeric($config['formatHtml.']['tabSize'])) {
+			$this->tab = str_pad('', (int) $config['formatHtml.']['tabSize'], ' ');
+		}
+
+		if (isset($config['formatHtml.']['debugComment'])) {
+			$this->debugComment = (bool) $config['formatHtml.']['debugComment'];
+		}
+
+		if (isset($config['dropEmptySpaceChar']) && (bool) $config['dropEmptySpaceChar']) {
+			$this->emptySpaceChar = '';
+		}
+	}
+
+	/**
+	 * Clean given HTML with formatter.
+	 */
+	public function clean(string $html, array $config = []): string
+	{
+		if (!empty($config)) {
+			$this->setVariables($config);
+		}
+
+		// convert line-breaks to UNIX
+		$this->convNlOs($html);
+
+		$manipulations = [];
+
+		if (isset($config['removeGenerator']) && (bool) $config['removeGenerator']) {
+			$manipulations['removeGenerator'] = GeneralUtility::makeInstance(RemoveGenerator::class);
+		}
+
+		if (isset($config['removeComments']) && (bool) $config['removeComments']) {
+			$manipulations['removeComments'] = GeneralUtility::makeInstance(RemoveComments::class);
+		}
+
+		if (!empty($this->headerComment)) {
+			$this->includeHeaderComment($html);
+		}
+
+		foreach ($manipulations as $key => $manipulation) {
+			/** @var ManipulationInterface $manipulation */
+			$configuration = isset($config[$key . '.']) && \is_array($config[$key . '.']) ? $config[$key . '.'] : [];
+			$html = $manipulation->manipulate($html, $configuration);
+		}
+
+		// cleanup HTML5 self-closing elements
+		if (!isset($GLOBALS['TSFE']->config['config']['doctype'])
+			|| 'x' !== substr($GLOBALS['TSFE']->config['config']['doctype'], 0, 1)) {
+			$html = preg_replace(
+				'/<((?:area|base|br|col|embed|hr|img|input|link|meta|param|source|track|wbr)\s[^>]+?)\s*\\\?\/>/',
+				'<$1>',
+				$html
+			);
+		}
+
+		if ($this->formatType > 0) {
+			$html = $this->formatHtml($html);
+		}
+
+		// remove white space after line ending
+		$this->rTrimLines($html);
+
+		// recover line-breaks
+		if (Environment::isWindows()) {
+			$html = str_replace($this->newline, "\r\n", $html);
+		}
+
+		return (string) $html;
+	}
+
+	/**
+	 * Formats the (X)HTML code:
+	 *  - taps according to the hirarchy of the tags
+	 *  - removes empty spaces between tags
+	 *  - removes linebreaks within tags (spares where necessary: pre, textarea, comments, ..)
+	 *  choose from five options:
+	 *    0 => off
+	 *    1 => no line break at all  (code in one line)
+	 *    2 => minimalistic line breaks (structure defining box-elements)
+	 *    3 => aesthetic line breaks (important box-elements)
+	 *    4 => logic line breaks (all box-elements)
+	 *    5 => max line breaks (all elements).
+	 */
+	protected function formatHtml(string $html): string
+	{
+		// Save original formated pre, textarea, comments, styles and scripts & replace them with markers
+		preg_match_all(
+			'/(?s)((<!--.*?-->)|(<[ \n\r]*pre[^>]*>.*?<[ \n\r]*\/pre[^>]*>)|(<[ \n\r]*textarea[^>]*>.*?<[ \n\r]*\/textarea[^>]*>)|(<[ \n\r]*style[^>]*>.*?<[ \n\r]*\/style[^>]*>)|(<[ \n\r]*script[^>]*>.*?<[ \n\r]*\/script[^>]*>))/im',
+			$html,
+			$matches
+		);
+		$noFormat = $matches[0]; // do not format these block elements
+		for ($i = 0; $i < \count($noFormat); ++$i) {
+			$html = str_replace($noFormat[$i], "\n<!-- ELEMENT {$i} -->", $html);
+		}
+
+		// define box elements for formatting
+		$trueBoxElements = 'address|blockquote|center|dir|div|dl|fieldset|form|h1|h2|h3|h4|h5|h6|hr|isindex|menu|noframes|noscript|ol|p|pre|table|ul|article|aside|details|figcaption|figure|footer|header|hgroup|menu|nav|section';
+		$functionalBoxElements = 'dd|dt|frameset|li|tbody|td|tfoot|th|thead|tr|colgroup';
+		$usableBoxElements = 'applet|button|del|iframe|ins|map|object|script';
+		$imagineBoxElements = 'html|body|head|meta|title|link|script|base|!--';
+		$allBoxLikeElements = '(?>' . $trueBoxElements . '|' . $functionalBoxElements . '|' . $usableBoxElements . '|' . $imagineBoxElements . ')';
+		$esteticBoxLikeElements = '(?>html|head|body|meta name|title|div|table|h1|h2|h3|h4|h5|h6|p|form|pre|center|!--)';
+		$structureBoxLikeElements = '(?>html|head|body|div|!--)';
+
+		// split html into it's elements
+		$htmlArrayTemp = preg_split(
+			'/(<(?:[^<>]+(?:"[^"]*"|\'[^\']*\')?)+>)/',
+			$html,
+			-1,
+			\PREG_SPLIT_DELIM_CAPTURE | \PREG_SPLIT_NO_EMPTY
+		);
+
+		if (false === $htmlArrayTemp) {
+			// Restore saved comments, styles and scripts
+			for ($i = 0; $i < \count($noFormat); ++$i) {
+				$html = str_replace("<!-- ELEMENT {$i} -->", $noFormat[$i], $html);
+			}
+
+			return $html;
+		}
+		// remove empty lines
+		$htmlArray = [''];
+		$index = 1;
+		for ($x = 0; $x < \count($htmlArrayTemp); ++$x) {
+			$text = trim($htmlArrayTemp[$x]);
+			$htmlArray[$index] = '' !== $text ? $htmlArrayTemp[$x] : $this->emptySpaceChar;
+			++$index;
+		}
+
+		// rebuild html
+		$html = '';
+		$tabs = 0;
+		for ($x = 0; $x < \count($htmlArray); ++$x) {
+			$htmlArrayBefore = $htmlArray[$x - 1] ?? '';
+			$htmlArrayCurrent = $htmlArray[$x] ?? '';
+
+			// check if the element should stand in a new line
+			$newline = false;
+			if ('<?xml' == substr($htmlArrayBefore, 0, 5)) {
+				$newline = true;
+			} elseif (2 == $this->formatType && ( // minimalistic line break
+				// this element has a line break before itself
+				preg_match(
+					'/<' . $structureBoxLikeElements . '(.*)>/Usi',
+					$htmlArrayCurrent
+				) || preg_match(
+					'/<' . $structureBoxLikeElements . '(.*) \/>/Usi',
+					$htmlArrayCurrent
+				) // one element before is a element that has a line break after
+				|| preg_match(
+					'/<\/' . $structureBoxLikeElements . '(.*)>/Usi',
+					$htmlArrayBefore
+				) || '<!--' == substr(
+					$htmlArrayBefore,
+					0,
+					4
+				) || preg_match('/<' . $structureBoxLikeElements . '(.*) \/>/Usi', $htmlArrayBefore))
+			) {
+				$newline = true;
+			} elseif (3 == $this->formatType && ( // aestetic line break
+				// this element has a line break before itself
+				preg_match(
+					'/<' . $esteticBoxLikeElements . '(.*)>/Usi',
+					$htmlArrayCurrent
+				) || preg_match(
+					'/<' . $esteticBoxLikeElements . '(.*) \/>/Usi',
+					$htmlArrayCurrent
+				) // one element before is a element that has a line break after
+				|| preg_match('/<\/' . $esteticBoxLikeElements . '(.*)>/Usi', $htmlArrayBefore) || '<!--' == substr(
+					$htmlArrayBefore,
+					0,
+					4
+				) || preg_match('/<' . $esteticBoxLikeElements . '(.*) \/>/Usi', $htmlArrayBefore))
+			) {
+				$newline = true;
+			} elseif ($this->formatType >= 4 && ( // logical line break
+				// this element has a line break before itself
+				preg_match(
+					'/<' . $allBoxLikeElements . '(.*)>/Usi',
+					$htmlArrayCurrent
+				) || preg_match(
+					'/<' . $allBoxLikeElements . '(.*) \/>/Usi',
+					$htmlArrayCurrent
+				) // one element before is a element that has a line break after
+				|| preg_match('/<\/' . $allBoxLikeElements . '(.*)>/Usi', $htmlArrayBefore) || '<!--' == substr(
+					$htmlArrayBefore,
+					0,
+					4
+				) || preg_match('/<' . $allBoxLikeElements . '(.*) \/>/Usi', $htmlArrayBefore))
+			) {
+				$newline = true;
+			}
+
+			// count down a tab
+			if ('</' == substr($htmlArrayCurrent, 0, 2)) {
+				--$tabs;
+			}
+
+			// add tabs and line breaks in front of the current tag
+			if ($newline) {
+				$html .= $this->newline;
+				for ($y = 0; $y < $tabs; ++$y) {
+					$html .= $this->tab;
+				}
+			}
+
+			// remove white spaces and line breaks and add current tag to the html-string
+			if ('<![CDATA[' == substr($htmlArrayCurrent, 0, 9) // remove multiple white space in CDATA / XML
+				|| '<?xml' == substr($htmlArrayCurrent, 0, 5)
+			) {
+				$html .= $this->killWhiteSpace($htmlArrayCurrent);
+			} else { // remove all line breaks
+				$html .= $this->killLineBreaks($htmlArrayCurrent);
+			}
+
+			// count up a tab
+			if ('<' == substr($htmlArrayCurrent, 0, 1) && '/' != substr($htmlArrayCurrent, 1, 1)) {
+				if (' ' !== substr($htmlArrayCurrent, 1, 1)
+					&& 'img' !== substr($htmlArrayCurrent, 1, 3)
+					&& 'source' !== substr($htmlArrayCurrent, 1, 6)
+					&& 'br' !== substr($htmlArrayCurrent, 1, 2)
+					&& 'hr' !== substr($htmlArrayCurrent, 1, 2)
+					&& 'input' !== substr($htmlArrayCurrent, 1, 5)
+					&& 'link' !== substr($htmlArrayCurrent, 1, 4)
+					&& 'meta' !== substr($htmlArrayCurrent, 1, 4)
+					&& 'col ' !== substr($htmlArrayCurrent, 1, 4)
+					&& 'frame' !== substr($htmlArrayCurrent, 1, 5)
+					&& 'isindex' !== substr($htmlArrayCurrent, 1, 7)
+					&& 'param' !== substr($htmlArrayCurrent, 1, 5)
+					&& 'area' !== substr($htmlArrayCurrent, 1, 4)
+					&& 'base' !== substr($htmlArrayCurrent, 1, 4)
+					&& '<!' !== substr($htmlArrayCurrent, 0, 2)
+					&& '<?xml' !== substr($htmlArrayCurrent, 0, 5)
+				) {
+					++$tabs;
+				}
+			}
+		}
+
+		// Remove empty lines
+		if ($this->formatType > 1) {
+			$this->removeEmptyLines($html);
+		}
+
+		// Restore saved comments, styles and scripts
+		for ($i = 0; $i < \count($noFormat); ++$i) {
+			$html = str_replace("<!-- ELEMENT {$i} -->", $noFormat[$i], $html);
+		}
+
+		// include debug comment at the end
+		if (0 != $tabs && true === $this->debugComment) {
+			$html .= "<!-- {$tabs} open elements found -->";
+		}
+
+		return $html;
+	}
+
+	/**
+	 * Remove ALL line breaks and multiple white space.
+	 */
+	protected function killLineBreaks(string $html): string
+	{
+		$html = str_replace($this->newline, '', $html);
+
+		return preg_replace('/\s\s+/u', ' ', $html);
+		// ? return preg_replace('/\n|\s+(\s)/u', '$1', $html);
+	}
+
+	/**
+	 * Remove multiple white space, keeps line breaks.
+	 */
+	protected function killWhiteSpace(string $html): string
+	{
+		$temp = explode($this->newline, $html);
+		for ($i = 0; $i < \count($temp); ++$i) {
+			if (!trim($temp[$i])) {
+				unset($temp[$i]);
+				continue;
+			}
+
+			$temp[$i] = trim($temp[$i]);
+			$temp[$i] = preg_replace('/\s\s+/', ' ', $temp[$i]);
+		}
+
+		return implode($this->newline, $temp);
+	}
+
+	/**
+	 * Remove white space at the end of lines, keeps other white space and line breaks.
+	 */
+	protected function rTrimLines(string &$html): void
+	{
+		$html = preg_replace('/\s+$/m', '', $html);
+	}
+
+	/**
+	 * Convert newlines according to the current OS.
+	 */
+	protected function convNlOs(string &$html): void
+	{
+		$html = preg_replace("(\r\n|\r)", $this->newline, $html);
+	}
+
+	/**
+	 * Remove empty lines.
+	 */
+	protected function removeEmptyLines(string &$html): void
+	{
+		$temp = explode($this->newline, $html);
+		$result = [];
+		for ($i = 0; $i < \count($temp); ++$i) {
+			if ('' == trim($temp[$i])) {
+				continue;
+			}
+			$result[] = $temp[$i];
+		}
+		$html = implode($this->newline, $result);
+	}
+
+	/**
+	 * Include configured header comment in HTML content block.
+	 */
+	public function includeHeaderComment(string &$html): void
+	{
+		$html = preg_replace('/^(-->)$/m', "\n\t" . $this->headerComment . "\n$1", $html);
+	}
 }

Classes/Service/SvgStoreService.php

Indentation +231 added lines, -231 removed lines

@@ -18,235 +18,235 @@
  */
 class SvgStoreService implements \TYPO3\CMS\Core\SingletonInterface
 {
-    /**
-     * SVG-Sprite relativ storage directory.
-     */
-    protected string $outputDir = '/typo3temp/assets/svg/';
-
-    /**
-     * TYPO3 absolute path to public web.
-     */
-    protected string $sitePath = '';
-
-    /**
-     * Final TYPO3 Frontend-Cache object.
-     */
-    protected FrontendInterface $svgCache;
-
-    /**
-     * Cached SVG-Sprite relativ file path.
-     */
-    protected string $spritePath = '';
-
-    /**
-     * Cached used SVG files (incl. defs).
-     */
-    protected array $svgFileArr = [];
-
-    /**
-     * Final SVG-Sprite Vectors.
-     */
-    protected array $svgs = [];
-
-    /**
-     * Final SVG-Sprite Styles.
-     */
-    protected array $styl = []; // ToFix ; https://stackoverflow.com/questions/39583880/external-svg-fails-to-apply-internal-css
-
-    /**
-     * Final SVG-Sprite Objects.
-     */
-    protected array $defs = []; // ToFix ; https://bugs.chromium.org/p/chromium/issues/detail?id=751733#c14
-
-    public function __construct()
-    {
-        $this->sitePath = Environment::getPublicPath(); // [^/]$
-        $this->svgCache = GeneralUtility::makeInstance(CacheManager::class)->getCache('svgstore');
-
-        $this->spritePath = $this->svgCache->get('spritePath') ?: '';
-        $this->svgFileArr = $this->svgCache->get('svgFileArr') ?: [];
-
-        if (empty($this->spritePath) && !$this->populateCache()) {
-            throw new \Exception('could not write file: ' . $this->sitePath . $this->spritePath);
-        }
-
-        if (!file_exists($this->sitePath . $this->spritePath)) {
-            throw new \Exception('file does not exists: ' . $this->sitePath . $this->spritePath);
-        }
-    }
-
-    public function process(string $html): string
-    {
-        if (empty($this->svgFileArr)) {
-            return $html;
-        }
-
-        if ($GLOBALS['TSFE']->config['config']['disableAllHeaderCode'] ?? false) {
-            $dom = ['head' => '', 'body' => $html];
-        } elseif (!preg_match('/(?<head>.+?<\/head>)(?<body>.+)/s', $html, $dom)) {
-            return $html;
-        }
-
-        // https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#attributes
-        $dom['body'] = preg_replace_callback('/<img(?<pre>[^>]*)src="(?:https?:)?(?:\/\/[^\/]+?)?(?<src>\/[^"]+\.svg)"(?<post>[^>]*?)[\s\/]*>(?!\s*<\/picture>)/s', function (array $match): string { // ^[/]
-            if (!isset($this->svgFileArr[$match['src']])) { // check usage
-                return $match[0];
-            }
-            $attr = preg_replace('/\s(?:alt|ismap|loading|title|sizes|srcset|usemap|crossorigin|decoding|fetchpriority|referrerpolicy)="[^"]*"/', '', $match['pre'] . $match['post']); // cleanup
-
-            return \sprintf('<svg %s %s><use href="%s#%s"/></svg>', $this->svgFileArr[$match['src']]['attr'], trim($attr), $this->spritePath, $this->convertFilePath($match['src']));
-        }, $dom['body']);
-
-        // https://developer.mozilla.org/en-US/docs/Web/HTML/Element/object#attributes
-        $dom['body'] = preg_replace_callback('/<object(?<pre>[^>]*)data="(?<data>\/[^"]+\.svg)"(?<post>[^>]*?)[\s\/]*>(?:<\/object>)/s', function (array $match): string { // ^[/]
-            if (!isset($this->svgFileArr[$match['data']])) { // check usage
-                return $match[0];
-            }
-            $attr = preg_replace('/\s(?:form|name|type|usemap)="[^"]*"/', '', $match['pre'] . $match['post']); // cleanup
-
-            return \sprintf('<svg %s %s><use href="%s#%s"/></svg>', $this->svgFileArr[$match['data']]['attr'], trim($attr), $this->spritePath, $this->convertFilePath($match['data']));
-        }, $dom['body']);
-
-        return $dom['head'] . $dom['body'];
-    }
-
-    private function convertFilePath(string $path): string
-    {
-        return preg_replace('/.svg$|[^\w\-]/', '', str_replace('/', '-', ltrim($path, '/'))); // ^[^/]
-    }
-
-    private function addFileToSpriteArr(string $hash, string $path, array $attr = []): ?array
-    {
-        if (!file_exists($this->sitePath . $path)) {
-            return null;
-        }
-
-        $svg = file_get_contents($this->sitePath . $path);
-
-        if (preg_match('/(?:;base64|i:a?i?pgf)/', $svg)) { // noop!
-            return null;
-        }
-
-        if (preg_match('/<(?:style|defs)|url\(/', $svg)) {
-            return null; // check links @ __construct
-        }
-
-        // https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/xlink:href
-        $svg = preg_replace('/^.*?<svg|\s*(<\/svg>)(?!.*\1).*$|xlink:|\s(?:(?:version|xmlns)|(?:[a-z\-]+\:[a-z\-]+))="[^"]*"/s', '', $svg); // cleanup
-
-        // $svg = preg_replace('/(?<=(?:id|class)=")/', $hash.'__', $svg); // extend  IDs
-        // $svg = preg_replace('/(?<=href="|url\()#/', $hash.'__', $svg); // recover IDs
-
-        // $svg = preg_replace_callback('/<style[^>]*>(?<styl>.+?)<\/style>|<defs[^>]*>(?<defs>.+?)<\/defs>/s', function(array $match) use($hash): string {
-        //
-        //    if(isset($match['styl']))
-        //    {
-        //        $this->styl[] = preg_replace('/\s*(\.|#){1}(.+?)\s*\{/', '$1'.$hash.'__$2{', $match['styl']); // patch CSS # https://mathiasbynens.be/notes/css-escapes
-        //    }
-        //    if(isset($match['defs']))
-        //    {
-        //        $this->defs[] = trim($match['defs']);
-        //    }
-        //    return '';
-        // }, $svg);
-
-        // https://developer.mozilla.org/en-US/docs/Web/SVG/Element/svg#attributes
-        $svg = preg_replace_callback('/([^>]*)\s*(?=>)/s', function (array $match) use (&$attr): string {
-            if (false === preg_match_all('/(?!\s)(?<attr>[a-z\-]+)="\s*(?<value>[^"]+)\s*"/i', $match[1], $matches)) {
-                return $match[0];
-            }
-            foreach ($matches['attr'] as $index => $attribute) {
-                switch ($attribute) {
-                    case 'id':
-                    case 'width':
-                    case 'height':
-                        unset($matches[0][$index]);
-                        break;
-
-                    case 'viewBox':
-                        if (false !== preg_match('/(?<minX>[-+]?[\d\.]+)\s(?<minY>[-+]?[\d\.]+)\s\+?(?<width>[\d\.]+)\s\+?(?<height>[\d\.]+)/', $matches['value'][$index], $match)) {
-                            $attr[] = \sprintf('%s="%s %s %s %s"', $attribute, $match['minX'], $match['minY'], $match['width'], $match['height']); // save!
-                        }
-                }
-            }
-
-            return implode(' ', $matches[0]);
-        }, $svg, 1);
-
-        if (empty($attr)) {
-            return null;
-        }
-
-        $this->svgs[] = \sprintf('id="%s" %s', $this->convertFilePath($path), $svg); // prepend ID
-
-        return ['attr' => implode(' ', $attr), 'hash' => $hash];
-    }
-
-    private function populateCache(): bool
-    {
-        $storageArr = GeneralUtility::makeInstance(StorageRepository::class)->findByStorageType('Local');
-        foreach ($storageArr as $storage) {
-            $storageConfig = $storage->getConfiguration();
-            if (!\is_array($storageConfig) || !isset($storageConfig['pathType'], $storageConfig['basePath'])) {
-                continue;
-            }
-            if ('relative' == $storageConfig['pathType']) {
-                $storageArr[$storage->getUid()] = rtrim($storageConfig['basePath'], '/'); // [^/]$
-            }
-        }
-        unset($storageArr[0]); // keep!
-
-        $fileArr = GeneralUtility::makeInstance(SvgFileRepository::class)->findAllByStorageUids(array_keys($storageArr));
-        foreach ($fileArr as $file) {
-            $file['path'] = '/' . $storageArr[$file['storage']] . $file['identifier']; // ^[/]
-            $file['defs'] = $this->addFileToSpriteArr($file['sha1'], $file['path']);
-
-            if (null !== $file['defs']) {
-                $this->svgFileArr[$file['path']] = $file['defs'];
-            }
-        }
-
-        if (empty($this->svgFileArr)) {
-            return true;
-        }
-
-        $svg = preg_replace_callback(
-            '/<use(?<pre>.*?)(?:xlink:)?href="(?<href>\/.+?\.svg)(?:#[^"]*?)?"(?<post>.*?)[\s\/]*>(?:<\/use>)?/s',
-            function (array $match): string {
-                if (!isset($this->svgFileArr[$match['href']])) { // check usage
-                    return $match[0];
-                }
-
-                return \sprintf('<use%s href="#%s"/>', $match['pre'] . $match['post'], $this->convertFilePath($match['href']));
-            },
-            '<svg xmlns="http://www.w3.org/2000/svg">'
-            // ."\n<style>\n".implode("\n", $this->styl)."\n</style>"
-            // ."\n<defs>\n".implode("\n", $this->defs)."\n</defs>"
-            . "\n<symbol " . implode("</symbol>\n<symbol ", $this->svgs) . "</symbol>\n"
-            . '</svg>'
-        );
-
-        if ($GLOBALS['TSFE']->config['config']['sourceopt.']['formatHtml'] ?? false) {
-            $svg = preg_replace('/(?<=>)\s+(?=<)/', '', $svg); // remove emptiness
-            $svg = preg_replace('/[\t\v]/', ' ', $svg); // prepare shrinkage
-            $svg = preg_replace('/\s{2,}/', ' ', $svg); // shrink whitespace
-        }
-
-        $svg = preg_replace('/<([a-z\-]+)\s*(\/|>\s*<\/\1)>\s*|\s+(?=\/>)/i', '', $svg); // remove emtpy TAGs & shorten endings
-        $svg = preg_replace('/<((circle|ellipse|line|path|polygon|polyline|rect|stop|use)\s[^>]+?)\s*>\s*<\/\2>/', '<$1/>', $svg); // shorten/minify TAG syntax
-
-        if (!is_dir($this->sitePath . $this->outputDir)) {
-            GeneralUtility::mkdir_deep($this->sitePath . $this->outputDir);
-        }
-
-        $this->spritePath = $this->outputDir . hash('sha1', serialize($this->svgFileArr)) . '.svg';
-        if (false === file_put_contents($this->sitePath . $this->spritePath, $svg)) {
-            return false;
-        }
-
-        $this->svgCache->set('spritePath', $this->spritePath);
-        $this->svgCache->set('svgFileArr', $this->svgFileArr);
-
-        return true;
-    }
+	/**
+	 * SVG-Sprite relativ storage directory.
+	 */
+	protected string $outputDir = '/typo3temp/assets/svg/';
+
+	/**
+	 * TYPO3 absolute path to public web.
+	 */
+	protected string $sitePath = '';
+
+	/**
+	 * Final TYPO3 Frontend-Cache object.
+	 */
+	protected FrontendInterface $svgCache;
+
+	/**
+	 * Cached SVG-Sprite relativ file path.
+	 */
+	protected string $spritePath = '';
+
+	/**
+	 * Cached used SVG files (incl. defs).
+	 */
+	protected array $svgFileArr = [];
+
+	/**
+	 * Final SVG-Sprite Vectors.
+	 */
+	protected array $svgs = [];
+
+	/**
+	 * Final SVG-Sprite Styles.
+	 */
+	protected array $styl = []; // ToFix ; https://stackoverflow.com/questions/39583880/external-svg-fails-to-apply-internal-css
+
+	/**
+	 * Final SVG-Sprite Objects.
+	 */
+	protected array $defs = []; // ToFix ; https://bugs.chromium.org/p/chromium/issues/detail?id=751733#c14
+
+	public function __construct()
+	{
+		$this->sitePath = Environment::getPublicPath(); // [^/]$
+		$this->svgCache = GeneralUtility::makeInstance(CacheManager::class)->getCache('svgstore');
+
+		$this->spritePath = $this->svgCache->get('spritePath') ?: '';
+		$this->svgFileArr = $this->svgCache->get('svgFileArr') ?: [];
+
+		if (empty($this->spritePath) && !$this->populateCache()) {
+			throw new \Exception('could not write file: ' . $this->sitePath . $this->spritePath);
+		}
+
+		if (!file_exists($this->sitePath . $this->spritePath)) {
+			throw new \Exception('file does not exists: ' . $this->sitePath . $this->spritePath);
+		}
+	}
+
+	public function process(string $html): string
+	{
+		if (empty($this->svgFileArr)) {
+			return $html;
+		}
+
+		if ($GLOBALS['TSFE']->config['config']['disableAllHeaderCode'] ?? false) {
+			$dom = ['head' => '', 'body' => $html];
+		} elseif (!preg_match('/(?<head>.+?<\/head>)(?<body>.+)/s', $html, $dom)) {
+			return $html;
+		}
+
+		// https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#attributes
+		$dom['body'] = preg_replace_callback('/<img(?<pre>[^>]*)src="(?:https?:)?(?:\/\/[^\/]+?)?(?<src>\/[^"]+\.svg)"(?<post>[^>]*?)[\s\/]*>(?!\s*<\/picture>)/s', function (array $match): string { // ^[/]
+			if (!isset($this->svgFileArr[$match['src']])) { // check usage
+				return $match[0];
+			}
+			$attr = preg_replace('/\s(?:alt|ismap|loading|title|sizes|srcset|usemap|crossorigin|decoding|fetchpriority|referrerpolicy)="[^"]*"/', '', $match['pre'] . $match['post']); // cleanup
+
+			return \sprintf('<svg %s %s><use href="%s#%s"/></svg>', $this->svgFileArr[$match['src']]['attr'], trim($attr), $this->spritePath, $this->convertFilePath($match['src']));
+		}, $dom['body']);
+
+		// https://developer.mozilla.org/en-US/docs/Web/HTML/Element/object#attributes
+		$dom['body'] = preg_replace_callback('/<object(?<pre>[^>]*)data="(?<data>\/[^"]+\.svg)"(?<post>[^>]*?)[\s\/]*>(?:<\/object>)/s', function (array $match): string { // ^[/]
+			if (!isset($this->svgFileArr[$match['data']])) { // check usage
+				return $match[0];
+			}
+			$attr = preg_replace('/\s(?:form|name|type|usemap)="[^"]*"/', '', $match['pre'] . $match['post']); // cleanup
+
+			return \sprintf('<svg %s %s><use href="%s#%s"/></svg>', $this->svgFileArr[$match['data']]['attr'], trim($attr), $this->spritePath, $this->convertFilePath($match['data']));
+		}, $dom['body']);
+
+		return $dom['head'] . $dom['body'];
+	}
+
+	private function convertFilePath(string $path): string
+	{
+		return preg_replace('/.svg$|[^\w\-]/', '', str_replace('/', '-', ltrim($path, '/'))); // ^[^/]
+	}
+
+	private function addFileToSpriteArr(string $hash, string $path, array $attr = []): ?array
+	{
+		if (!file_exists($this->sitePath . $path)) {
+			return null;
+		}
+
+		$svg = file_get_contents($this->sitePath . $path);
+
+		if (preg_match('/(?:;base64|i:a?i?pgf)/', $svg)) { // noop!
+			return null;
+		}
+
+		if (preg_match('/<(?:style|defs)|url\(/', $svg)) {
+			return null; // check links @ __construct
+		}
+
+		// https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/xlink:href
+		$svg = preg_replace('/^.*?<svg|\s*(<\/svg>)(?!.*\1).*$|xlink:|\s(?:(?:version|xmlns)|(?:[a-z\-]+\:[a-z\-]+))="[^"]*"/s', '', $svg); // cleanup
+
+		// $svg = preg_replace('/(?<=(?:id|class)=")/', $hash.'__', $svg); // extend  IDs
+		// $svg = preg_replace('/(?<=href="|url\()#/', $hash.'__', $svg); // recover IDs
+
+		// $svg = preg_replace_callback('/<style[^>]*>(?<styl>.+?)<\/style>|<defs[^>]*>(?<defs>.+?)<\/defs>/s', function(array $match) use($hash): string {
+		//
+		//    if(isset($match['styl']))
+		//    {
+		//        $this->styl[] = preg_replace('/\s*(\.|#){1}(.+?)\s*\{/', '$1'.$hash.'__$2{', $match['styl']); // patch CSS # https://mathiasbynens.be/notes/css-escapes
+		//    }
+		//    if(isset($match['defs']))
+		//    {
+		//        $this->defs[] = trim($match['defs']);
+		//    }
+		//    return '';
+		// }, $svg);
+
+		// https://developer.mozilla.org/en-US/docs/Web/SVG/Element/svg#attributes
+		$svg = preg_replace_callback('/([^>]*)\s*(?=>)/s', function (array $match) use (&$attr): string {
+			if (false === preg_match_all('/(?!\s)(?<attr>[a-z\-]+)="\s*(?<value>[^"]+)\s*"/i', $match[1], $matches)) {
+				return $match[0];
+			}
+			foreach ($matches['attr'] as $index => $attribute) {
+				switch ($attribute) {
+					case 'id':
+					case 'width':
+					case 'height':
+						unset($matches[0][$index]);
+						break;
+
+					case 'viewBox':
+						if (false !== preg_match('/(?<minX>[-+]?[\d\.]+)\s(?<minY>[-+]?[\d\.]+)\s\+?(?<width>[\d\.]+)\s\+?(?<height>[\d\.]+)/', $matches['value'][$index], $match)) {
+							$attr[] = \sprintf('%s="%s %s %s %s"', $attribute, $match['minX'], $match['minY'], $match['width'], $match['height']); // save!
+						}
+				}
+			}
+
+			return implode(' ', $matches[0]);
+		}, $svg, 1);
+
+		if (empty($attr)) {
+			return null;
+		}
+
+		$this->svgs[] = \sprintf('id="%s" %s', $this->convertFilePath($path), $svg); // prepend ID
+
+		return ['attr' => implode(' ', $attr), 'hash' => $hash];
+	}
+
+	private function populateCache(): bool
+	{
+		$storageArr = GeneralUtility::makeInstance(StorageRepository::class)->findByStorageType('Local');
+		foreach ($storageArr as $storage) {
+			$storageConfig = $storage->getConfiguration();
+			if (!\is_array($storageConfig) || !isset($storageConfig['pathType'], $storageConfig['basePath'])) {
+				continue;
+			}
+			if ('relative' == $storageConfig['pathType']) {
+				$storageArr[$storage->getUid()] = rtrim($storageConfig['basePath'], '/'); // [^/]$
+			}
+		}
+		unset($storageArr[0]); // keep!
+
+		$fileArr = GeneralUtility::makeInstance(SvgFileRepository::class)->findAllByStorageUids(array_keys($storageArr));
+		foreach ($fileArr as $file) {
+			$file['path'] = '/' . $storageArr[$file['storage']] . $file['identifier']; // ^[/]
+			$file['defs'] = $this->addFileToSpriteArr($file['sha1'], $file['path']);
+
+			if (null !== $file['defs']) {
+				$this->svgFileArr[$file['path']] = $file['defs'];
+			}
+		}
+
+		if (empty($this->svgFileArr)) {
+			return true;
+		}
+
+		$svg = preg_replace_callback(
+			'/<use(?<pre>.*?)(?:xlink:)?href="(?<href>\/.+?\.svg)(?:#[^"]*?)?"(?<post>.*?)[\s\/]*>(?:<\/use>)?/s',
+			function (array $match): string {
+				if (!isset($this->svgFileArr[$match['href']])) { // check usage
+					return $match[0];
+				}
+
+				return \sprintf('<use%s href="#%s"/>', $match['pre'] . $match['post'], $this->convertFilePath($match['href']));
+			},
+			'<svg xmlns="http://www.w3.org/2000/svg">'
+			// ."\n<style>\n".implode("\n", $this->styl)."\n</style>"
+			// ."\n<defs>\n".implode("\n", $this->defs)."\n</defs>"
+			. "\n<symbol " . implode("</symbol>\n<symbol ", $this->svgs) . "</symbol>\n"
+			. '</svg>'
+		);
+
+		if ($GLOBALS['TSFE']->config['config']['sourceopt.']['formatHtml'] ?? false) {
+			$svg = preg_replace('/(?<=>)\s+(?=<)/', '', $svg); // remove emptiness
+			$svg = preg_replace('/[\t\v]/', ' ', $svg); // prepare shrinkage
+			$svg = preg_replace('/\s{2,}/', ' ', $svg); // shrink whitespace
+		}
+
+		$svg = preg_replace('/<([a-z\-]+)\s*(\/|>\s*<\/\1)>\s*|\s+(?=\/>)/i', '', $svg); // remove emtpy TAGs & shorten endings
+		$svg = preg_replace('/<((circle|ellipse|line|path|polygon|polyline|rect|stop|use)\s[^>]+?)\s*>\s*<\/\2>/', '<$1/>', $svg); // shorten/minify TAG syntax
+
+		if (!is_dir($this->sitePath . $this->outputDir)) {
+			GeneralUtility::mkdir_deep($this->sitePath . $this->outputDir);
+		}
+
+		$this->spritePath = $this->outputDir . hash('sha1', serialize($this->svgFileArr)) . '.svg';
+		if (false === file_put_contents($this->sitePath . $this->spritePath, $svg)) {
+			return false;
+		}
+
+		$this->svgCache->set('spritePath', $this->spritePath);
+		$this->svgCache->set('svgFileArr', $this->svgFileArr);
+
+		return true;
+	}
 }

Classes/Middleware/RegExRepMiddleware.php

Indentation +13 added lines, -13 removed lines

@@ -11,20 +11,20 @@
 
 class RegExRepMiddleware extends AbstractMiddleware
 {
-    public function __construct(protected RegExRepService $regExRepService) {}
+	public function __construct(protected RegExRepService $regExRepService) {}
 
-    /**
-     * RegEx search & replace @ HTML output.
-     */
-    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
-    {
-        $response = $handler->handle($request);
+	/**
+	 * RegEx search & replace @ HTML output.
+	 */
+	public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
+	{
+		$response = $handler->handle($request);
 
-        if ($this->responseIsAlterable($response) && ($GLOBALS['TSFE']->config['config']['replacer.'] ?? false)) {
-            $processedHtml = $this->regExRepService->process((string) $response->getBody());
-            $response = $response->withBody($this->getStringStream($processedHtml));
-        }
+		if ($this->responseIsAlterable($response) && ($GLOBALS['TSFE']->config['config']['replacer.'] ?? false)) {
+			$processedHtml = $this->regExRepService->process((string) $response->getBody());
+			$response = $response->withBody($this->getStringStream($processedHtml));
+		}
 
-        return $response;
-    }
+		return $response;
+	}
 }

Classes/Middleware/SvgStoreMiddleware.php

Indentation +13 added lines, -13 removed lines

@@ -11,20 +11,20 @@
 
 class SvgStoreMiddleware extends AbstractMiddleware
 {
-    public function __construct(protected SvgStoreService $svgStoreService) {}
+	public function __construct(protected SvgStoreService $svgStoreService) {}
 
-    /**
-     * Search/Extract/Merge SVGs @ HTML output.
-     */
-    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
-    {
-        $response = $handler->handle($request);
+	/**
+	 * Search/Extract/Merge SVGs @ HTML output.
+	 */
+	public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
+	{
+		$response = $handler->handle($request);
 
-        if ($this->responseIsAlterable($response) && ($GLOBALS['TSFE']->config['config']['svgstore.']['enabled'] ?? false)) {
-            $processedHtml = $this->svgStoreService->process((string) $response->getBody());
-            $response = $response->withBody($this->getStringStream($processedHtml));
-        }
+		if ($this->responseIsAlterable($response) && ($GLOBALS['TSFE']->config['config']['svgstore.']['enabled'] ?? false)) {
+			$processedHtml = $this->svgStoreService->process((string) $response->getBody());
+			$response = $response->withBody($this->getStringStream($processedHtml));
+		}
 
-        return $response;
-    }
+		return $response;
+	}
 }

Classes/Middleware/CleanHtmlMiddleware.php

Indentation +16 added lines, -16 removed lines

@@ -11,23 +11,23 @@
 
 class CleanHtmlMiddleware extends AbstractMiddleware
 {
-    public function __construct(protected CleanHtmlService $cleanHtmlService) {}
+	public function __construct(protected CleanHtmlService $cleanHtmlService) {}
 
-    /**
-     * Clean the HTML output.
-     */
-    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
-    {
-        $response = $handler->handle($request);
+	/**
+	 * Clean the HTML output.
+	 */
+	public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
+	{
+		$response = $handler->handle($request);
 
-        if ($this->responseIsAlterable($response) && ($GLOBALS['TSFE']->config['config']['sourceopt.']['enabled'] ?? false)) {
-            $processedHtml = $this->cleanHtmlService->clean(
-                (string) $response->getBody(),
-                (array) $GLOBALS['TSFE']->config['config']['sourceopt.']
-            );
-            $response = $response->withBody($this->getStringStream($processedHtml));
-        }
+		if ($this->responseIsAlterable($response) && ($GLOBALS['TSFE']->config['config']['sourceopt.']['enabled'] ?? false)) {
+			$processedHtml = $this->cleanHtmlService->clean(
+				(string) $response->getBody(),
+				(array) $GLOBALS['TSFE']->config['config']['sourceopt.']
+			);
+			$response = $response->withBody($this->getStringStream($processedHtml));
+		}
 
-        return $response;
-    }
+		return $response;
+	}
 }

Classes/Service/RegExRepService.php

Indentation +42 added lines, -42 removed lines

@@ -16,46 +16,46 @@
  */
 class RegExRepService implements SingletonInterface
 {
-    public function process(string $html): string
-    {
-        $config = $GLOBALS['TSFE']->config['config']['replacer.'];
-
-        foreach (['search.', 'replace.'] as $section) {
-            if (!isset($config[$section]) || !\is_array($config[$section])) {
-                throw new \Exception('missing entry @ config.replacer.' . $section);
-            }
-
-            if (preg_match_all('/"([\w\-]+)\.";/', serialize(array_keys($config[$section])), $matches)) {
-                $cObj ??= ($GLOBALS['TSFE']->cObj ?? GeneralUtility::makeInstance(ContentObjectRenderer::class));
-
-                foreach ($matches[1] as $key) {
-                    $config[$section][$key] = $cObj
-                        ->stdWrap(
-                            $config[$section][$key],
-                            $config[$section][$key . '.']
-                        )
-                    ;
-                    unset($config[$section][$key . '.']); // keep!
-                }
-            }
-
-            ksort($config[$section], \SORT_NATURAL); // safety
-        }
-
-        if (Environment::getContext()->isDevelopment()) {
-            foreach ($config['search.'] as $key => $val) {
-                if (false === @preg_match($val, '')) {
-                    throw new \Exception(preg_last_error_msg() . ' : please check your regex syntax @ ' . "{$key} = {$val}");
-                }
-            }
-        }
-
-        $arrIntersectKeysCnt = 2 * \count(array_intersect_key($config['search.'], $config['replace.']));
-
-        if ((bool) (\count($config['search.']) + \count($config['replace.']) - $arrIntersectKeysCnt)) {
-            throw new \Exception('config.replacer requests have diverged');
-        }
-
-        return preg_replace($config['search.'], $config['replace.'], $html);
-    }
+	public function process(string $html): string
+	{
+		$config = $GLOBALS['TSFE']->config['config']['replacer.'];
+
+		foreach (['search.', 'replace.'] as $section) {
+			if (!isset($config[$section]) || !\is_array($config[$section])) {
+				throw new \Exception('missing entry @ config.replacer.' . $section);
+			}
+
+			if (preg_match_all('/"([\w\-]+)\.";/', serialize(array_keys($config[$section])), $matches)) {
+				$cObj ??= ($GLOBALS['TSFE']->cObj ?? GeneralUtility::makeInstance(ContentObjectRenderer::class));
+
+				foreach ($matches[1] as $key) {
+					$config[$section][$key] = $cObj
+						->stdWrap(
+							$config[$section][$key],
+							$config[$section][$key . '.']
+						)
+					;
+					unset($config[$section][$key . '.']); // keep!
+				}
+			}
+
+			ksort($config[$section], \SORT_NATURAL); // safety
+		}
+
+		if (Environment::getContext()->isDevelopment()) {
+			foreach ($config['search.'] as $key => $val) {
+				if (false === @preg_match($val, '')) {
+					throw new \Exception(preg_last_error_msg() . ' : please check your regex syntax @ ' . "{$key} = {$val}");
+				}
+			}
+		}
+
+		$arrIntersectKeysCnt = 2 * \count(array_intersect_key($config['search.'], $config['replace.']));
+
+		if ((bool) (\count($config['search.']) + \count($config['replace.']) - $arrIntersectKeysCnt)) {
+			throw new \Exception('config.replacer requests have diverged');
+		}
+
+		return preg_replace($config['search.'], $config['replace.'], $html);
+	}
 }