first commit

plugins/system/highlight/src/Extension/Highlight.php

@@ -0,0 +1,127 @@
+<?php
+
+/**
+ * @package     Joomla.Plugin
+ * @subpackage  System.highlight
+ *
+ * @copyright   (C) 2011 Open Source Matters, Inc. <https://www.joomla.org>
+ * @license     GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+namespace Joomla\Plugin\System\Highlight\Extension;
+
+use Joomla\CMS\Component\ComponentHelper;
+use Joomla\CMS\Filter\InputFilter;
+use Joomla\CMS\Plugin\CMSPlugin;
+use Joomla\Component\Finder\Administrator\Indexer\Result;
+
+// phpcs:disable PSR1.Files.SideEffects
+\defined('_JEXEC') or die;
+// phpcs:enable PSR1.Files.SideEffects
+
+/**
+ * System plugin to highlight terms.
+ *
+ * @since  2.5
+ */
+final class Highlight extends CMSPlugin
+{
+    /**
+     * Method to catch the onAfterDispatch event.
+     *
+     * This is where we setup the click-through content highlighting for.
+     * The highlighting is done with JavaScript so we just
+     * need to check a few parameters and the JHtml behavior will do the rest.
+     *
+     * @return  void
+     *
+     * @since   2.5
+     */
+    public function onAfterDispatch()
+    {
+        // Check that we are in the site application.
+        if (!$this->getApplication()->isClient('site')) {
+            return;
+        }
+
+        // Set the variables.
+        $input     = $this->getApplication()->getInput();
+        $extension = $input->get('option', '', 'cmd');
+
+        // Check if the highlighter is enabled.
+        if (!ComponentHelper::getParams($extension)->get('highlight_terms', 1)) {
+            return;
+        }
+
+        // Check if the highlighter should be activated in this environment.
+        if ($input->get('tmpl', '', 'cmd') === 'component' || $this->getApplication()->getDocument()->getType() !== 'html') {
+            return;
+        }
+
+        // Get the terms to highlight from the request.
+        $terms = $input->request->get('highlight', null, 'base64');
+        $terms = $terms ? json_decode(base64_decode($terms)) : null;
+
+        // Check the terms.
+        if (empty($terms)) {
+            return;
+        }
+
+        // Clean the terms array.
+        $filter     = InputFilter::getInstance();
+
+        $cleanTerms = [];
+
+        foreach ($terms as $term) {
+            $cleanTerms[] = htmlspecialchars($filter->clean($term, 'string'));
+        }
+
+        /** @var \Joomla\CMS\Document\HtmlDocument $doc */
+        $doc = $this->getApplication()->getDocument();
+
+        // Activate the highlighter.
+        if (!empty($cleanTerms)) {
+            $doc->getWebAssetManager()->useScript('highlight');
+            $doc->addScriptOptions(
+                'highlight',
+                [[
+                    'class'     => 'js-highlight',
+                    'highLight' => $cleanTerms,
+                ]]
+            );
+        }
+
+        // Adjust the component buffer.
+        $buf = $doc->getBuffer('component');
+        $buf = '<div class="js-highlight">' . $buf . '</div>';
+        $doc->setBuffer($buf, 'component');
+    }
+
+    /**
+     * Method to catch the onFinderResult event.
+     *
+     * @param   Result  $item   The search result
+     * @param   object  $query  The search query of this result
+     *
+     * @return  void
+     *
+     * @since   4.0.0
+     */
+    public function onFinderResult($item, $query)
+    {
+        static $params;
+
+        if (\is_null($params)) {
+            $params = ComponentHelper::getParams('com_finder');
+        }
+
+        // Get the route with highlighting information.
+        if (
+            !empty($query->highlight)
+            && empty($item->mime)
+            && $params->get('highlight_terms', 1)
+        ) {
+            $item->route .= '&highlight=' . base64_encode(json_encode($query->highlight));
+        }
+    }
+}