-
Notifications
You must be signed in to change notification settings - Fork 93
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[TASK] Add NamespaceDetectionTemplateProcessor
This commit adds an NamespaceDetectionTemplateProcessor that takes care of 3 things: - replace cdata sections with empty lines (including nested cdata) - register/ignore namespaces through xmlns and shorthand syntax - report any unregistered/unignored namespaces through exception
- Loading branch information
Marc Neuhaus
committed
Dec 28, 2015
1 parent
3ed660d
commit 978071f
Showing
7 changed files
with
302 additions
and
70 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
187 changes: 187 additions & 0 deletions
187
src/Core/Parser/TemplateProcessor/NamespaceDetectionTemplateProcessor.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,187 @@ | ||
| <?php | ||
| namespace TYPO3Fluid\Fluid\Core\Parser\TemplateProcessor; | ||
|
|
||
| /* | ||
| * This file belongs to the package "TYPO3 Fluid". | ||
| * See LICENSE.txt that was shipped with this package. | ||
| */ | ||
|
|
||
| use TYPO3Fluid\Fluid\Core\Parser\Patterns; | ||
| use TYPO3Fluid\Fluid\Core\Parser\TemplateParser; | ||
| use TYPO3Fluid\Fluid\Core\Parser\UnknownNamespaceException; | ||
| use TYPO3Fluid\Fluid\Core\Parser\TemplateProcessorInterface; | ||
| use TYPO3Fluid\Fluid\Core\ViewHelper\ViewHelperResolver; | ||
|
|
||
| /** | ||
| * This template processor takes care of the following things: | ||
| * | ||
| * - replace cdata sections with empty lines (including nested cdata) | ||
| * - register/ignore namespaces through xmlns and shorthand syntax | ||
| * - report any unregistered/unignored namespaces through exception | ||
| * | ||
| */ | ||
| class NamespaceDetectionTemplateProcessor implements TemplateProcessorInterface { | ||
|
|
||
| const NAMESPACE_DECLARATION = '/(?<!\\\\){namespace\s*(?P<identifier>[a-zA-Z\*]+[a-zA-Z0-9\.\*]*)\s*(=\s*(?P<phpNamespace>(?:[A-Za-z0-9\.]+|Tx)(?:\\\\\w+)+)\s*)?}/m'; | ||
|
|
||
| const SPLIT_PATTERN_TEMPLATE_OPEN_NAMESPACETAG = '/xmlns:([a-z0-9\.]+)=("[^"]+"|\'[^\']+\')*/xi'; | ||
|
|
||
| /** | ||
| * @var TemplateParser | ||
| */ | ||
| protected $templateParser; | ||
|
|
||
| /** | ||
| * @var ViewHelperResolver | ||
| */ | ||
| protected $viewHelperResolver; | ||
|
|
||
| /** | ||
| * @var array() | ||
| */ | ||
| protected $localNamespaces = array(); | ||
|
|
||
| /** | ||
| * Setter for passing the TemplateParser instance | ||
| * that is currently processing the template. | ||
| * | ||
| * @param TemplateParser $templateParser | ||
| * @return void | ||
| */ | ||
| public function setTemplateParser(TemplateParser $templateParser) { | ||
| $this->templateParser = $templateParser; | ||
| } | ||
|
|
||
| /** | ||
| * Setter for passing the ViewHelperResolver instance | ||
| * being used by the TemplateParser to resolve classes | ||
| * and namespaces of ViewHelpers. | ||
| * | ||
| * @param ViewHelperResolver $viewHelperResolver | ||
| * @return void | ||
| */ | ||
| public function setViewHelperResolver(ViewHelperResolver $viewHelperResolver) { | ||
| $this->viewHelperResolver = $viewHelperResolver; | ||
| } | ||
|
|
||
| /** | ||
| * Pre-process the template source before it is | ||
| * returned to the TemplateParser or passed to | ||
| * the next TemplateProcessorInterface instance. | ||
| * | ||
| * @param string $templateSource | ||
| * @return string | ||
| */ | ||
| public function preProcessSource($templateSource) { | ||
| $templateSource = $this->replaceCdataSectionsByEmptyLines($templateSource); | ||
| $this->registerNamespacesFromTemplateSource($templateSource); | ||
| $this->throwExceptionsForUnhandledNamespaces($templateSource); | ||
| return $templateSource; | ||
| } | ||
|
|
||
| /** | ||
| * Replaces all cdata sections with empty lines to exclude it from further | ||
| * processing in the templateParser while maintaining the line-count | ||
| * of the template string for the exception handler to reference to. | ||
| * | ||
| * @param string $templateSource | ||
| * @return string | ||
| */ | ||
| public function replaceCdataSectionsByEmptyLines($templateSource) { | ||
| $parts = preg_split('/(\<\!\[CDATA\[|\]\]\>)/', $templateSource, -1, PREG_SPLIT_DELIM_CAPTURE); | ||
|
|
||
| $balance = 0; | ||
| foreach ($parts as $index => $part) { | ||
| if ($part === '<![CDATA[') { | ||
| $balance++; | ||
| } | ||
| if ($balance > 0) { | ||
| $parts[$index] = str_repeat(PHP_EOL, substr_count($part, PHP_EOL)); | ||
| } | ||
| if ($part === ']]>') { | ||
| $balance--; | ||
| } | ||
| } | ||
|
|
||
| return implode('', $parts); | ||
| } | ||
|
|
||
| /** | ||
| * Register all namespaces that are declared inside the template string | ||
| * | ||
| * @param string $templateSource | ||
| * @return void | ||
| */ | ||
| public function registerNamespacesFromTemplateSource($templateSource) { | ||
| if (preg_match_all(static::SPLIT_PATTERN_TEMPLATE_OPEN_NAMESPACETAG, $templateSource, $matchedVariables, PREG_SET_ORDER) > 0) { | ||
| foreach ($matchedVariables as $namespaceMatch) { | ||
| $viewHelperNamespace = $this->unquoteString($namespaceMatch[2]); | ||
| $phpNamespace = $this->viewHelperResolver->resolvePhpNamespaceFromFluidNamespace($viewHelperNamespace); | ||
| if (stristr($phpNamespace, '/') === FALSE) { | ||
| $this->viewHelperResolver->registerNamespace($namespaceMatch[1], $phpNamespace); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| preg_match_all(static::NAMESPACE_DECLARATION, $templateSource, $namespaces); | ||
| foreach ($namespaces['identifier'] as $key => $identifier) { | ||
| $namespace = $namespaces['phpNamespace'][$key]; | ||
| if (strlen($namespace) === 0) { | ||
| $namespace = NULL; | ||
| } | ||
| $this->viewHelperResolver->registerNamespace($identifier, $namespace); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Throw an UnknownNamespaceException for any unknown and not ignored | ||
| * namespace inside the template string | ||
| * | ||
| * @param string $templateSource | ||
| * @return void | ||
| */ | ||
| public function throwExceptionsForUnhandledNamespaces($templateSource) { | ||
| $splitTemplate = preg_split(Patterns::$SPLIT_PATTERN_TEMPLATE_DYNAMICTAGS, $templateSource, -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY); | ||
| foreach ($splitTemplate as $templateElement) { | ||
| if (preg_match(Patterns::$SCAN_PATTERN_TEMPLATE_VIEWHELPERTAG, $templateElement, $matchedVariables) > 0) { | ||
| if (!$this->viewHelperResolver->isNamespaceValidOrIgnored($matchedVariables['NamespaceIdentifier'])) { | ||
| throw new UnknownNamespaceException('Unkown Namespace: ' . htmlspecialchars($matchedVariables[0])); | ||
| } | ||
| continue; | ||
| } elseif (preg_match(Patterns::$SCAN_PATTERN_TEMPLATE_CLOSINGVIEWHELPERTAG, $templateElement, $matchedVariables) > 0) { | ||
| continue; | ||
| } | ||
|
|
||
| $sections = preg_split(Patterns::$SPLIT_PATTERN_SHORTHANDSYNTAX, $templateElement, -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY); | ||
| foreach ($sections as $section) { | ||
| if (preg_match(Patterns::$SCAN_PATTERN_SHORTHANDSYNTAX_OBJECTACCESSORS, $section, $matchedVariables) > 0) { | ||
| preg_match_all(Patterns::$SPLIT_PATTERN_SHORTHANDSYNTAX_VIEWHELPER, $section, $shorthandViewHelpers, PREG_SET_ORDER); | ||
| foreach ($shorthandViewHelpers as $shorthandViewHelper) { | ||
| if (!$this->viewHelperResolver->isNamespaceValidOrIgnored($shorthandViewHelper['NamespaceIdentifier'])) { | ||
| throw new UnknownNamespaceException('Unkown Namespace: ' . $shorthandViewHelper['NamespaceIdentifier']); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Removes escapings from a given argument string and trims the outermost | ||
| * quotes. | ||
| * | ||
| * This method is meant as a helper for regular expression results. | ||
| * | ||
| * @param string $quotedValue Value to unquote | ||
| * @return string Unquoted value | ||
| */ | ||
| protected function unquoteString($quotedValue) { | ||
| $value = $quotedValue; | ||
| if ($quotedValue{0} === '"') { | ||
| $value = str_replace('\\"', '"', preg_replace('/(^"|"$)/', '', $quotedValue)); | ||
| } elseif ($quotedValue{0} === '\'') { | ||
| $value = str_replace("\\'", "'", preg_replace('/(^\'|\'$)/', '', $quotedValue)); | ||
| } | ||
| return str_replace('\\\\', '\\', $value); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.