mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-06-27 23:19:35 +02:00
Ensure that shortcodes inside script tags are parsed. Fixes #4332.
The problem is that the marker images aren’t picked up by DOMDocument if they are inserted into a <script> tag, due to the semantics of HTML. This fix does an additional replacement after the marker images are replaced in this way to pick up any leftover tags.
This commit is contained in:
Sam Minnee
parent
3907688f7d
commit
6d05c57881
|
|
@ -103,11 +103,47 @@ class ShortcodeParser extends Object {
|
|||
$this->shortcodes = array();
|
||||
}
|
||||
|
||||
/**
|
||||
* Call a shortcode and return its replacement text
|
||||
* Returns false if the shortcode isn't registered
|
||||
*/
|
||||
public function callShortcode($tag, $attributes, $content, $extra = array()) {
|
||||
if (!isset($this->shortcodes[$tag])) return false;
|
||||
if (!$tag || !isset($this->shortcodes[$tag])) return false;
|
||||
return call_user_func($this->shortcodes[$tag], $attributes, $content, $this, $tag, $extra);
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the text to insert in place of a shoprtcode.
|
||||
* Behaviour in the case of missing shortcodes depends on the setting of ShortcodeParser::$error_behavior.
|
||||
* @param $tag A map containing the the following keys:
|
||||
* - 'open': The name of the tag
|
||||
* - 'attrs': Attributes of the tag
|
||||
* - 'content': Content of the tag
|
||||
* @param $extra Extra-meta data
|
||||
* @param $isHTMLAllowed A boolean indicating whether it's okay to insert HTML tags into the result
|
||||
*/
|
||||
function getShortcodeReplacementText($tag, $extra = array(), $isHTMLAllowed = true) {
|
||||
$content = $this->callShortcode($tag['open'], $tag['attrs'], $tag['content'], $extra);
|
||||
|
||||
// Missing tag
|
||||
if ($content === false) {
|
||||
if(ShortcodeParser::$error_behavior == ShortcodeParser::ERROR) {
|
||||
user_error('Unknown shortcode tag '.$tag['open'], E_USER_ERRROR);
|
||||
}
|
||||
else if (self::$error_behavior == self::WARN && $isHTMLAllowed) {
|
||||
$content = '<strong class="warning">'.$tag['text'].'</strong>';
|
||||
}
|
||||
else if(ShortcodeParser::$error_behavior == ShortcodeParser::STRIP) {
|
||||
return '';
|
||||
}
|
||||
else {
|
||||
return $tag['text'];
|
||||
}
|
||||
}
|
||||
|
||||
return $content;
|
||||
}
|
||||
|
||||
// --------------------------------------------------------------------------------------------------------------
|
||||
|
||||
protected function removeNode($node) {
|
||||
|
|
@ -207,6 +243,7 @@ class ShortcodeParser extends Object {
|
|||
protected function extractTags($content) {
|
||||
$tags = array();
|
||||
|
||||
// Step 1: perform basic regex scan of individual tags
|
||||
if(preg_match_all(static::tagrx(), $content, $matches, PREG_SET_ORDER | PREG_OFFSET_CAPTURE)) {
|
||||
foreach($matches as $match) {
|
||||
// Ignore any elements
|
||||
|
|
@ -236,8 +273,9 @@ class ShortcodeParser extends Object {
|
|||
'escaped' => !empty($match['oesc'][0]) || !empty($match['cesc1'][0]) || !empty($match['cesc2'][0])
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Step 2: cluster open/close tag pairs into single entries
|
||||
$i = count($tags);
|
||||
while($i--) {
|
||||
if(!empty($tags[$i]['close'])) {
|
||||
|
|
@ -337,24 +375,11 @@ class ShortcodeParser extends Object {
|
|||
|
||||
if($tags) {
|
||||
$node->nodeValue = $this->replaceTagsWithText($node->nodeValue, $tags,
|
||||
function($idx, $tag) use ($parser, $extra){
|
||||
$content = $parser->callShortcode($tag['open'], $tag['attrs'], $tag['content'], $extra);
|
||||
|
||||
if ($content === false) {
|
||||
if(ShortcodeParser::$error_behavior == ShortcodeParser::ERROR) {
|
||||
user_error('Unknown shortcode tag '.$tag['open'], E_USER_ERRROR);
|
||||
}
|
||||
else if(ShortcodeParser::$error_behavior == ShortcodeParser::STRIP) {
|
||||
return '';
|
||||
}
|
||||
else {
|
||||
return $tag['text'];
|
||||
}
|
||||
function($idx, $tag) use ($parser, $extra) {
|
||||
return $parser->getShortcodeReplacementText($tag, $extra, false);
|
||||
}
|
||||
|
||||
return $content;
|
||||
});
|
||||
}
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -365,17 +390,17 @@ class ShortcodeParser extends Object {
|
|||
*/
|
||||
protected function replaceElementTagsWithMarkers($content) {
|
||||
$tags = $this->extractTags($content);
|
||||
|
||||
|
||||
if($tags) {
|
||||
$markerClass = self::$marker_class;
|
||||
|
||||
$content = $this->replaceTagsWithText($content, $tags, function($idx, $tag) use ($markerClass) {
|
||||
return '<img class="'.$markerClass.'" data-tagid="'.$idx.'" />';
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
return array($content, $tags);
|
||||
}
|
||||
}
|
||||
|
||||
protected function findParentsForMarkers($nodes) {
|
||||
$parents = array();
|
||||
|
|
@ -477,23 +502,7 @@ class ShortcodeParser extends Object {
|
|||
* @param array $tag
|
||||
*/
|
||||
protected function replaceMarkerWithContent($node, $tag) {
|
||||
$content = false;
|
||||
if($tag['open']) $content = $this->callShortcode($tag['open'], $tag['attrs'], $tag['content']);
|
||||
|
||||
if ($content === false) {
|
||||
if(self::$error_behavior == self::ERROR) {
|
||||
user_error('Unknown shortcode tag '.$tag['open'], E_USER_ERRROR);
|
||||
}
|
||||
if (self::$error_behavior == self::WARN) {
|
||||
$content = '<strong class="warning">'.$tag['text'].'</strong>';
|
||||
}
|
||||
else if (self::$error_behavior == self::LEAVE) {
|
||||
$content = $tag['text'];
|
||||
}
|
||||
else {
|
||||
// self::$error_behavior == self::STRIP - NOP
|
||||
}
|
||||
}
|
||||
$content = $this->getShortcodeReplacementText($tag);
|
||||
|
||||
if ($content) {
|
||||
$parsed = Injector::inst()->create('HTMLValue', $content);
|
||||
|
|
@ -567,8 +576,21 @@ class ShortcodeParser extends Object {
|
|||
$this->replaceMarkerWithContent($shortcode, $tag);
|
||||
}
|
||||
|
||||
return $htmlvalue->getContent();
|
||||
$content = $htmlvalue->getContent();
|
||||
|
||||
// Clean up any marker classes left over, for example, those injected into <script> tags
|
||||
$parser = $this;
|
||||
$content = preg_replace_callback(
|
||||
// Not a general-case parser; assumes that the HTML generated in replaceElementTagsWithMarkers()
|
||||
// hasn't been heavily modified
|
||||
'/<img[^>]+class="'.preg_quote(self::$marker_class).'"[^>]+data-tagid="([^"]+)"[^>]+>/i',
|
||||
function ($matches) use ($tags, $parser) {
|
||||
$tag = $tags[$matches[1]];
|
||||
return $parser->getShortcodeReplacementText($tag);
|
||||
},
|
||||
$content
|
||||
);
|
||||
|
||||
return $content;
|
||||
}
|
||||
|
||||
|
||||
}
|
||||
|
|
|
|||
|
|
@ -211,6 +211,37 @@ class ShortcodeParserTest extends SapphireTest {
|
|||
);
|
||||
}
|
||||
|
||||
public function testShortcodesInsideScriptTag() {
|
||||
$this->assertEqualsIgnoringWhitespace(
|
||||
'<script>hello</script>',
|
||||
$this->parser->parse('<script>[test_shortcode]hello[/test_shortcode]</script>')
|
||||
);
|
||||
}
|
||||
|
||||
public function testNumericShortcodes() {
|
||||
$this->assertEqualsIgnoringWhitespace(
|
||||
'[2]',
|
||||
$this->parser->parse('[2]')
|
||||
);
|
||||
$this->assertEqualsIgnoringWhitespace(
|
||||
'<script>[2]</script>',
|
||||
$this->parser->parse('<script>[2]</script>')
|
||||
);
|
||||
|
||||
$this->parser->register('2', function($attributes, $content, $this, $tag, $extra) {
|
||||
return 'this is 2';
|
||||
});
|
||||
|
||||
$this->assertEqualsIgnoringWhitespace(
|
||||
'this is 2',
|
||||
$this->parser->parse('[2]')
|
||||
);
|
||||
$this->assertEqualsIgnoringWhitespace(
|
||||
'<script>this is 2</script>',
|
||||
$this->parser->parse('<script>[2]</script>')
|
||||
);
|
||||
}
|
||||
|
||||
public function testExtraContext() {
|
||||
$this->parser->parse('<a href="[test_shortcode]">Test</a>');
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user