Merge pull request #29 from oveleon/develop

Bugfixes for automatic glossary conversion / linking
oveleon · Jun 2, 2023 · c3762d3 · c3762d3
2 parents 8c9707c + ea21953
commit c3762d3
Show file tree

Hide file tree

Showing 8 changed files with 2,344 additions and 27 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+/composer.lock
diff --git a/README.md b/README.md
@@ -597,7 +597,7 @@ markupAttr: {
     <td>PopperJS options -> check https://popper.js.org/docs/v2/</td>
   </tr>
   <tr>
-    <td>includes</td>
+    <td>includes (array)</td>
     <td>
 <pre>
 'body',
@@ -612,6 +612,15 @@ markupAttr: {
 </td>
     <td>Readable nodes for glossary item markup. Elements (and thus it's children) that are not listed within the includes, will not be converted.</td>
   </tr>
+<tr>
+    <td>excludeClasses (array)</td>
+    <td>
+<pre>
+'gl-none'
+</pre>
+</td>
+    <td>Readable nodes matching one or more classes within excludeClasses will not be converted.</td>
+  </tr>
   <tr>
     <td>route: {<br/>&nbsp;&nbsp;&nbsp;prefix:<br/>&nbsp;&nbsp;&nbsp;suffix:<br/>&nbsp;&nbsp;&nbsp;cache:<br/>}</td>
     <td>&nbsp;<br>'/api/glossary/item/'<br/>'/html'<br/>true<br/>&nbsp;</td>

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -17,10 +17,10 @@
         }
     ],
     "devDependencies": {
-        "webpack": "^5.4.0",
-        "webpack-cli": "^4.2.0"
+        "webpack": "^5.85",
+        "webpack-cli": "^5.1"
     },
     "dependencies": {
-        "@popperjs/core": "^2.10.2"
+        "@popperjs/core": "^2.11"
     }
 }
diff --git a/src/EventListener/BreadcrumbListener.php b/src/EventListener/BreadcrumbListener.php
@@ -15,6 +15,7 @@
 namespace Oveleon\ContaoGlossaryBundle\EventListener;
 
 use Contao\Config;
+use Contao\CoreBundle\Exception\RouteParametersException;
 use Contao\Input;
 use Contao\StringUtil;
 use Oveleon\ContaoGlossaryBundle\Glossary;
@@ -27,28 +28,45 @@ class BreadcrumbListener
 {
     public function __invoke(array $items): array
     {
-        $alias = Input::get('items');
+        $alias = Input::get('items', false, true);
 
         // Set the item from the auto_item parameter
-        if (!isset($_GET['items']) && isset($_GET['auto_item']) && Config::get('useAutoItem')) {
-            $alias = Input::get('auto_item');
+        if (!isset($_GET['items']) && isset($_GET['auto_item']) && Config::get('useAutoItem'))
+        {
+            $alias = Input::get('auto_item', false, true);
         }
 
-        if ($alias && ($glossaryItem = GlossaryItemModel::findPublishedByIdOrAlias($alias)) !== null) {
-            // Mark the last item as inactive
-            $items[\count($items) - 1]['href'] = $GLOBALS['objPage']->getFrontendUrl();
-            $items[\count($items) - 1]['isActive'] = false;
-
-            // Add the new item
-            $items[] = [
-                'isRoot' => false,
+        if ($alias && ($glossaryItem = GlossaryItemModel::findPublishedByIdOrAlias($alias)) !== null)
+        {
+            $breadcrumbItem = [
+                'isRoot'   => false,
                 'isActive' => true,
-                'href' => Glossary::generateUrl($glossaryItem),
-                'title' => StringUtil::specialchars($glossaryItem->keyword),
-                'link' => $glossaryItem->keyword,
-                'data' => $glossaryItem->row(),
-                'class' => '',
+                'href'     => Glossary::generateUrl($glossaryItem),
+                'title'    => StringUtil::specialchars($glossaryItem->keyword),
+                'link'     => $glossaryItem->keyword,
+                'data'     => $glossaryItem->row(),
+                'class'    => '',
             ];
+
+            try {
+                $href = $GLOBALS['objPage']->getFrontendUrl();
+            } catch (RouteParametersException $e) {
+                $href = '';
+            }
+
+            if (!strlen($href))
+            {
+                // In case the route alias already exists on the parent page, and it requires an item, simply replace the item
+                $items[\count($items) - 1] = $breadcrumbItem;
+            }
+            else
+            {
+                $items[\count($items) - 1]['href'] = $href;
+                $items[\count($items) - 1]['isActive'] = false;
+
+                // Append new item
+                $items[] = $breadcrumbItem;
+            }
         }
 
         return $items;

diff --git a/src/EventListener/GeneratePageListener.php b/src/EventListener/GeneratePageListener.php
@@ -17,6 +17,7 @@
 use Contao\Config;
 use Contao\CoreBundle\Framework\ContaoFramework;
 use Contao\FrontendTemplate;
+use Contao\Input;
 use Contao\LayoutModel;
 use Contao\PageModel;
 use Contao\PageRegular;
@@ -72,11 +73,18 @@ public function __invoke(PageModel $pageModel, LayoutModel $layoutModel, PageReg
         }
 
         // Load glossary configuration template
-        $objTemplate = new FrontendTemplate($objRootPage->glossaryConfigTemplate ?: 'config_glossary_default');
-
+        $objTemplate      = new FrontendTemplate($objRootPage->glossaryConfigTemplate ?: 'config_glossary_default');
         $objGlossaryItems = GlossaryItemModel::findPublishedByPids($glossaryArchives, ['order' => "LENGTH(tl_glossary_item.keyword) DESC"]);
+        $glossaryConfig   = null;
 
-        $glossaryConfig = null;
+        $pageId = $pageModel->id;
+        $alias  = Input::get('items');
+
+        // Set the item from the auto_item parameter
+        if (!isset($_GET['items']) && isset($_GET['auto_item']) && Config::get('useAutoItem'))
+        {
+            $alias = Input::get('auto_item');
+        }
 
         if (null !== $objGlossaryItems)
         {
@@ -87,6 +95,23 @@ public function __invoke(PageModel $pageModel, LayoutModel $layoutModel, PageReg
                 // Check if keywords exist
                 if (array_filter($arrKeywords = StringUtil::deserialize($objGlossaryItem->keywords, true)))
                 {
+                    switch ($objGlossaryItem->source)
+                    {
+                        case 'default':
+                            if ($alias === $objGlossaryItem->alias)
+                            {
+                                continue 2; // Skip config entry if we are on the same page
+                            }
+                            break;
+
+                        case 'internal':
+                            if ($pageId === $objGlossaryItem->jumpTo)
+                            {
+                                continue 2; // Skip config entry if we are on the same page
+                            }
+                            break;
+                    }
+
                     $arrGlossaryItems[] = [
                         'id' => $objGlossaryItem->id,
 

diff --git a/src/Resources/public/scripts/Glossary.js b/src/Resources/public/scripts/Glossary.js
@@ -65,6 +65,9 @@ export class Glossary
                 'mark,abbr',
                 'sub,sup'
             ],
+            excludeClasses: [                   // Exclude-classes to skip allowed nodes
+                'gl-none'
+            ],
             route: {                            // API settings
                 prefix: '/api/glossary/item/',
                 suffix: '/html',
@@ -173,7 +176,7 @@ export class Glossary
      */
     _isValidNode(node)
     {
-        return node.nodeType === Node.TEXT_NODE || (node.nodeType === Node.ELEMENT_NODE && !!node.matches(this.options.includes.join(',')))
+        return node.nodeType === Node.TEXT_NODE || (node.nodeType === Node.ELEMENT_NODE && !!node.matches(this.options.includes.join(',')) && !(!!node.classList.length && node.matches(this.options.excludeClasses.map(c=>'.'+c).join(','))))
     }
 
     /**
@@ -210,7 +213,7 @@ export class Glossary
                     // Lookbehind in JS regular expressions ( ?>= ) : https://caniuse.com/js-regexp-lookbehind
                     if (this.isNewIE)
                     {
-                        const matchRgx = new RegExp("(?:>|^|\\()(" + match + ")\\b", 'gu')
+                        const matchRgx = new RegExp("(?:>|^|\\()(" + match + ")(?!\-)\\b", 'gu')
                         let sentence = []
 
                         for (let word of node.textContent.split(' '))
@@ -229,7 +232,7 @@ export class Glossary
                     else
                     {
                         // Lookbehind regex for other browsers
-                        const matchRgx = new RegExp("(?<!glc=\"1\">)(?<=\\s|>|^|\\()(" + match + ")\\b", 'gu')
+                        const matchRgx = new RegExp("(?<!glc=\"1\">)(?<=\\s|>|^|\\()(" + match + ")(?!\-)\\b", 'gu')
 
                         if (matchRgx.test(node.textContent))
                         {

diff --git a/src/Resources/public/scripts/dist/main.js b/src/Resources/public/scripts/dist/main.js