From: Marcel Werk <burntime@woltlab.com>
Date: Fri, 19 Aug 2016 17:02:13 +0000 (+0200)
Subject: Added missing search keyword highlighting
X-Git-Tag: 3.0.0_Beta_1~648
X-Git-Url: https://git.stricted.de/?a=commitdiff_plain;h=9a1a2f1e2937b4558475515301791a3b27ffe568;p=GitHub%2FWoltLab%2FWCF.git

Added missing search keyword highlighting
---

diff --git a/wcfsetup/install/files/lib/system/bbcode/KeywordHighlighter.class.php b/wcfsetup/install/files/lib/system/bbcode/KeywordHighlighter.class.php
index d4df438321..086ccede2e 100644
--- a/wcfsetup/install/files/lib/system/bbcode/KeywordHighlighter.class.php
+++ b/wcfsetup/install/files/lib/system/bbcode/KeywordHighlighter.class.php
@@ -135,4 +135,13 @@ class KeywordHighlighter extends SingletonFactory {
 		$keywordPattern = str_replace('\*', '\w*', $keywordPattern);
 		return preg_replace('+(?<!&|&\w{1}|&\w{2}|&\w{3}|&\w{4}|&\w{5}|&\w{6})'.$keywordPattern.'(?![^<]*>)+i', '<span class="highlight">\\1</span>', $text);
 	}
+	
+	/**
+	 * Returns search keywords
+	 * 
+	 * @return	string[]
+	 */
+	public function getKeywords() {
+		return $this->keywords;
+	}
 }
diff --git a/wcfsetup/install/files/lib/system/html/output/HtmlOutputProcessor.class.php b/wcfsetup/install/files/lib/system/html/output/HtmlOutputProcessor.class.php
index 6e28572b9f..fdc0865a51 100644
--- a/wcfsetup/install/files/lib/system/html/output/HtmlOutputProcessor.class.php
+++ b/wcfsetup/install/files/lib/system/html/output/HtmlOutputProcessor.class.php
@@ -29,14 +29,16 @@ class HtmlOutputProcessor extends AbstractHtmlProcessor {
 	/**
 	 * Processes the input html string.
 	 *
-	 * @param       string          $html           html string
-	 * @param       string          $objectType     object type identifier
-	 * @param       integer         $objectID       object id
+	 * @param       string          $html                           html string
+	 * @param       string          $objectType                     object type identifier
+	 * @param       integer         $objectID                       object id
+	 * @param	boolean		$doKeywordHighlighting                                   
 	 */
-	public function process($html, $objectType, $objectID) {
+	public function process($html, $objectType, $objectID, $doKeywordHighlighting = true) {
 		$this->setContext($objectType, $objectID);
 		
 		$this->getHtmlOutputNodeProcessor()->setOutputType($this->outputType);
+		$this->getHtmlOutputNodeProcessor()->enableKeywordHighlighting($doKeywordHighlighting);
 		$this->getHtmlOutputNodeProcessor()->load($this, $html);
 		$this->getHtmlOutputNodeProcessor()->process();
 	}
diff --git a/wcfsetup/install/files/lib/system/html/output/node/HtmlOutputNodeProcessor.class.php b/wcfsetup/install/files/lib/system/html/output/node/HtmlOutputNodeProcessor.class.php
index c3402703c2..4379be102d 100644
--- a/wcfsetup/install/files/lib/system/html/output/node/HtmlOutputNodeProcessor.class.php
+++ b/wcfsetup/install/files/lib/system/html/output/node/HtmlOutputNodeProcessor.class.php
@@ -1,5 +1,7 @@
 <?php
 namespace wcf\system\html\output\node;
+use wcf\system\bbcode\HtmlBBCodeParser;
+use wcf\system\bbcode\KeywordHighlighter;
 use wcf\system\html\node\AbstractHtmlNodeProcessor;
 use wcf\system\html\node\IHtmlNode;
 use wcf\util\DOMUtil;
@@ -26,6 +28,24 @@ class HtmlOutputNodeProcessor extends AbstractHtmlNodeProcessor {
 	 */
 	protected $outputType = 'text/html';
 	
+	/**
+	 * enables keyword highlighting
+	 * @var boolean
+	 */
+	protected $keywordHighlighting = true;
+	
+	/**
+	 * @var string[]
+	 */
+	protected $sourceBBCodes = [];
+	
+	/**
+	 * HtmlOutputNodeProcessor constructor.
+	 */
+	public function __construct() {
+		$this->sourceBBCodes = HtmlBBCodeParser::getInstance()->getSourceBBCodes();
+	}
+	
 	/**
 	 * Sets the desired output type.
 	 * 
@@ -39,6 +59,9 @@ class HtmlOutputNodeProcessor extends AbstractHtmlNodeProcessor {
 	 * @inheritDoc
 	 */
 	public function process() {
+		// highlight keywords
+		$this->highlightKeywords();
+		
 		$this->invokeHtmlNode(new HtmlOutputNodeWoltlabMetacode());
 		
 		// dynamic node handlers
@@ -125,6 +148,81 @@ class HtmlOutputNodeProcessor extends AbstractHtmlNodeProcessor {
 		return $html;
 	}
 	
+	/**
+	 * Enables the keyword highlighting.
+	 * 
+	 * @param       boolean         $enable
+	 */
+	public function enableKeywordHighlighting($enable = true) {
+		$this->keywordHighlighting = $enable;
+	}
+	
+	/**
+	 * Executes the keyword highlighting.
+	 */
+	protected function highlightKeywords() {
+		if (!$this->keywordHighlighting) return;
+		if (!count(KeywordHighlighter::getInstance()->getKeywords())) return;
+		$keywordPattern = '('.implode('|', KeywordHighlighter::getInstance()->getKeywords()).')';
+		
+		$nodes = [];
+		foreach ($this->getXPath()->query('//text()') as $node) {
+			$value = StringUtil::trim($node->textContent);
+			if (empty($value)) {
+				// skip empty nodes
+				continue;
+			}
+			
+			// check if node is within a code element or link
+			if ($this->hasCodeParent($node)) {
+				continue;
+			}
+			
+			$nodes[] = $node;
+		}
+		foreach ($nodes as $node) {
+			$split = preg_split('+'.$keywordPattern.'+', $node->textContent, -1, PREG_SPLIT_DELIM_CAPTURE);
+			if (count($split) == 1) return;
+			
+			for ($i = 0; $i < count($split); $i++) {
+				if ($i % 2 == 0) { // text
+					$node->parentNode->insertBefore($node->ownerDocument->createTextNode($split[$i]), $node);
+				}
+				else { // match
+					$element = $node->ownerDocument->createElement('span');
+					$element->setAttribute('class', 'highlight');
+					$element->appendChild($node->ownerDocument->createTextNode($split[$i]));
+					$node->parentNode->insertBefore($element, $node);
+				}
+			}
+			
+			DOMUtil::removeNode($node);
+		}
+	}
+	
+	/**
+	 * Returns true if text node is inside a code element, suppresing any
+	 * auto-detection of content.
+	 *
+	 * @param       \DOMText        $text           text node
+	 * @return      boolean         true if text node is inside a code element
+	 */
+	protected function hasCodeParent(\DOMText $text) {
+		$parent = $text;
+		/** @var \DOMElement $parent */
+		while ($parent = $parent->parentNode) {
+			$nodeName = $parent->nodeName;
+			if ($nodeName === 'code' || $nodeName === 'kbd' || $nodeName === 'pre') {
+				return true;
+			}
+			else if ($nodeName === 'woltlab-metacode' && in_array($parent->getAttribute('data-name'), $this->sourceBBCodes)) {
+				return true;
+			}
+		}
+		
+		return false;
+	}
+	
 	/**
 	 * @inheritDoc
 	 */