Merge branch 'release/4.1.0'

Author: rhukster

CHANGELOG.md

@@ -1,3 +1,9 @@
+# v4.1.0
+## 04/14/2019
+
+1. [](#new)
+    * Support for a `ShortCodeManager::getRawHandlers()` to support shortcodes that need to process **before** Markdown (like upcoming `Prism-Highlighter`)
+
 # v4.0.1
 ## 03/21/2019
 

blueprints.yaml

@@ -1,5 +1,5 @@
 name: Shortcode Core
-version: 4.0.1
+version: 4.1.0
 description: "This plugin provides the core functionality for shortcode plugins"
 icon: code
 author:

classes/ShortcodeManager.php

@@ -23,6 +23,9 @@ class ShortcodeManager
     /** @var  HandlerContainer $handlers */
     protected $handlers;
 
+    /** @var  HandlerContainer $raw_handlers */
+    protected $raw_handlers;
+
     /** @var  EventContainer $events */
     protected $events;
 
@@ -41,6 +44,7 @@ public function __construct()
         $this->grav = Grav::instance();
         $this->config = $this->grav['config'];
         $this->handlers = new HandlerContainer();
+        $this->raw_handlers = new HandlerContainer();
         $this->events = new EventContainer();
         $this->states = [];
         $this->assets = [];
@@ -138,6 +142,16 @@ public function getHandlers()
         return $this->handlers;
     }
 
+    /**
+     * returns the current raw handler container object
+     *
+     * @return HandlerContainer
+     */
+    public function getRawHandlers()
+    {
+        return $this->raw_handlers;
+    }
+
     /**
      * returns the current event container object
      *         
@@ -211,25 +225,36 @@ public function setupMarkdown($markdown)
     /**
      * process the content by running over all the known shortcodes with the
      * chosen parser
-     * 
-     * @param  Page   $page   the page to work on
-     * @param  Data   $config configuration merged with the page config
+     *
+     * @param Page $page the page to work on
+     * @param Data $config configuration merged with the page config
+     * @param null $handlers
+     * @return string
      */
-    public function processContent(Page $page, Data $config)
+    public function processContent(Page $page, Data $config, $handlers = null)
     {
         $parser = $this->getParser($config->get('parser'));
 
+        if (!$handlers) {
+            $handlers = $this->handlers;
+        }
+
         if ($page && $config->get('enabled')) {
             $this->page = $page;
             $content = $page->getRawContent();
-            $processor = new Processor(new $parser(new CommonSyntax()), $this->handlers);
+            $processor = new Processor(new $parser(new CommonSyntax()), $handlers);
             $processor = $processor->withEventContainer($this->events);
             $processed_content = $processor->process($content);
 
             return $processed_content;
         }
     }
 
+    public function processRawContent(Page $page, Data $config)
+    {
+        return $this->processContent($page, $config, $this->raw_handlers);
+    }
+
     /**
      * Allow the processing of shortcodes directly on a string
      * For example when used by Twig directly

shortcode-core.php

@@ -45,6 +45,7 @@ public function onPluginsInitialized()
             'onThemeInitialized'        => ['onThemeInitialized', 0],
             'onMarkdownInitialized'     => ['onMarkdownInitialized', 0],
             'onShortcodeHandlers'       => ['onShortcodeHandlers', 0],
+            'onPageContentRaw'          => ['onPageContentRaw', 0],
             'onPageContentProcessed'    => ['onPageContentProcessed', 0],
             'onPageContent'             => ['onPageContent', 0],
             'onTwigInitialized'         => ['onTwigInitialized', 0],
@@ -73,39 +74,45 @@ public function onMarkdownInitialized(Event $event)
         $this->shortcodes->setupMarkdown($event['markdown']);
     }
 
+    /**
+     * Process shortcodes before Grav's processing
+     *
+     * @param Event $e
+     */
+    public function onPageContentRaw(Event $e)
+    {
+        $this->processShortcodes($e['page'], 'processRawContent');
+    }
+
     /**
      * Process shortcodes after Grav's processing, but before caching
      *
      * @param Event $e
      */
     public function onPageContentProcessed(Event $e)
     {
-        /** @var Page $page */
-        $page = $e['page'];
-        $config = $this->mergeConfig($page);
+        $this->processShortcodes($e['page'], 'processContent');
+    }
+
+    protected function processShortcodes($page, $type = 'processContent') {
         $meta = [];
+        $config = $this->mergeConfig($page);
 
         // Don't run in admin pages other than content
         $admin_pages_only = isset($config['admin_pages_only']) ? $config['admin_pages_only'] : true;
-        if ($admin_pages_only &&
-            $this->isAdmin() &&
-            !Utils::startsWith($page->filePath(), $this->grav['locator']->findResource('page://'))) {
+        if ($admin_pages_only && $this->isAdmin() && !Utils::startsWith($page->filePath(), $this->grav['locator']->findResource('page://'))) {
             return;
+        } else {
+            $this->active = $config->get('active', true);
         }
 
-        $this->active = $config->get('active', true);
-
         // if the plugin is not active (either global or on page) exit
         if (!$this->active) {
             return;
         }
 
-        // reset objects and assets for the page
-        $this->shortcodes->resetObjects();
-        $this->shortcodes->resetAssets();
-
         // process the content for shortcodes
-        $page->setRawContent($this->shortcodes->processContent($page, $config));
+        $page->setRawContent($this->shortcodes->$type($page, $config));
 
         // if objects found set them as page content meta
         $shortcode_objects = $this->shortcodes->getObjects();
@@ -125,6 +132,24 @@ public function onPageContentProcessed(Event $e)
         }
     }
 
+    protected function getConfig($page)
+    {
+        $config = $this->mergeConfig($page);
+        $this->active = false;
+
+        // Don't run in admin pages other than content
+        $admin_pages_only = isset($config['admin_pages_only']) ? $config['admin_pages_only'] : true;
+        if ($admin_pages_only &&
+            $this->isAdmin() &&
+            !Utils::startsWith($page->filePath(), $this->grav['locator']->findResource('page://'))) {
+
+        } else {
+            $this->active = $config->get('active', true);
+        }
+
+        return $config;
+    }
+
     /**
      * Handle the assets that might be associated with this page
      */