Added support for Shortcode filter methods

classes/Autoloader.php

@@ -21,7 +21,7 @@ public function __construct($routes = [])
   {
     // Set routes for autoloading
     if (!is_array($routes) || count($routes) == 0) {
-      $routes = [__NAMESPACE__ => __DIR__];
+      $routes = [__NAMESPACE__ . '\\' => __DIR__];
     }
 
     $this->route($routes);
@@ -89,14 +89,14 @@ public function autoload($class)
    */
   public function register($prepend = false)
   {
-    spl_autoload_register(array($this, 'autoload'), false, $prepend);
+    spl_autoload_register([$this, 'autoload'], false, $prepend);
   }
 
   /**
    * Unregisters this instance as an autoloader
    */
   public function unregister()
   {
-    spl_autoload_unregister(array($this, 'autoload'));
+    spl_autoload_unregister([$this, 'autoload']);
   }
 }

classes/BlockShortcode.php

@@ -22,7 +22,7 @@ class BlockShortcode extends Twig\GenericShortcode
    * @param callable  $callable Callable to call for the shortcode.
    * @param array     $options  An array of shortcode options.
    */
-  public function __construct($name, $callable, array $options = array())
+  public function __construct($name, $callable, array $options = [])
   {
     parent::__construct($name, $callable, 'block', $options);
   }

classes/InlineShortcode.php

@@ -22,7 +22,7 @@ class InlineShortcode extends Twig\GenericShortcode
    * @param callable  $callable Callable to call for the shortcode.
    * @param array     $options  An array of shortcode options.
    */
-  public function __construct($name, $callable, array $options = array())
+  public function __construct($name, $callable, array $options = [])
   {
     parent::__construct($name, $callable, 'inline', $options);
   }

classes/ShortcodeFilter.php

@@ -0,0 +1,18 @@
+<?php
+/**
+ * ShortcodeFilter
+ *
+ * This file is part of Grav Shortcodes plugin.
+ *
+ * Dual licensed under the MIT or GPL Version 3 licenses, see LICENSE.
+ * http://benjamin-regler.de/license/
+ */
+
+namespace Grav\Plugin\Shortcodes;
+
+/**
+ * ShortcodeFilter
+ */
+class ShortcodeFilter extends Twig\GenericShortcodeFilter
+{
+}

classes/Shortcodes.php

@@ -10,15 +10,10 @@
 
 namespace Grav\Plugin\Shortcodes;
 
-use Grav\Common\Grav;
 use Grav\Common\GravTrait;
 use Grav\Common\Data\Data;
 use RocketTheme\Toolbox\Event\Event;
 
-use Grav\Plugin\Shortcodes\Twig;
-use Grav\Plugin\Shortcodes\ShortcodesTrait;
-use Grav\Plugin\Shortcodes\ShortcodeInterface;
-
 /**
  * Shortcodes
  *
@@ -59,13 +54,27 @@ class Shortcodes
    */
   protected $config;
 
+  /**
+   * The current page to render
+   *
+   * @var \Grav\Common\Page\Page
+   */
+  protected $page;
+
   /**
    * Shortcode registry
    *
    * @var array
    */
   protected $shortcodes = [];
 
+  /**
+   * A key-valued array used for hashing shortcodes of a page
+   *
+   * @var array
+   */
+  protected $hashes = [];
+
   /**
    * Constructor
    *
@@ -126,17 +135,38 @@ public function render($content, $options = [], $page = null)
       return $event;
     };
 
+    // Wrapper for shortcodes filter function
+    $filter_function = function($name, $content, $context, $env) {
+      return $this->filterShortcode($name, $content, $context, $env);
+    };
+
     // Process in-page shortcodes Twig
     $name = '@Shortcodes:' . $page->path();
     $this->loader->setTemplate($name, $content);
-    $vars = ['__shortcodes' => $function];
+    $vars = [
+      '__shortcodes' => $function,
+      '__shortcodes_filter' => $filter_function
+    ];
 
     try {
+      $page_default = $this->page;
+      $this->page = $page;
+
       $output = $this->twig->render($name, $vars);
     } catch (\Twig_Error_Loader $e) {
       throw new \RuntimeException($e->getRawMessage(), 404, $e);
     }
 
+    $shortcodes = isset($page->header()->shortcodes) ? $page->header()->shortcodes : [];
+    if (isset($shortcodes['extra'])) {
+      /** @var Cache $cache */
+      $cache = self::getGrav()['cache'];
+
+      $cache_id = md5('shortcodes' . $page->id() . $cache->getKey());
+      $cache->save($cache_id, $shortcodes['extra']);
+    }
+
+    $this->page = $page_default;
     return $output;
   }
 
@@ -185,14 +215,32 @@ public function register($shortcode, $options = [])
       $this->twig->addShortcode($shortcode);
       return true;
 
+    // Register shortcode filters from ShortcodeFilter filters
+    } elseif ($shortcode instanceof Twig\GenericShortcodeFilter) {
+      $this->twig->addShortcodeFilter($shortcode);
+      return true;
+
     // Register shortcodes from Shortcode extensions
-    } elseif ($shortcode instanceof Twig\ExtensionInterface || (is_object($shortcode) && method_exists($shortcode, 'getShortcodes'))) {
-      $shortcodes = $shortcode->getShortcodes();
-      foreach ($shortcodes as $shortcode) {
-        $this->twig->addShortcode($shortcode);
+    } elseif ($shortcode instanceof Twig\ExtensionInterface || is_object($shortcode)) {
+      $result = false;
+
+      if (method_exists($shortcode, 'getShortcodes')) {
+        $result = true;
+        $shortcodes = $shortcode->getShortcodes();
+        foreach ($shortcodes as $shortcode) {
+          $this->twig->addShortcode($shortcode);
+        }
       }
 
-      return true;
+      if (method_exists($shortcode, 'getShortcodeFilters')) {
+        $result = true;
+        $shortcodeFilters = $shortcode->getShortcodeFilters();
+        foreach ($shortcodeFilters as $shortcodeFilter) {
+          $this->twig->addShortcodeFilter($shortcodeFilter);
+        }
+      }
+
+      return $result;
     }
 
     return false;
@@ -204,16 +252,40 @@ public function register($shortcode, $options = [])
    * @param string $group   The group name to add the extra items to.
    * @param any    $extra   The item to store.
    */
-  public function addExtra($group, $extra)
+  public function addExtra($group, $method, $arguments = null)
   {
-    /* @var \Grav\Common\Page\Page $page */
-    $page = self::getGrav()['page'];
+    $header = $this->page->header();
+    $arguments = is_array($arguments) ? $arguments : [$arguments];
 
-    $header = $page->header();
+    // Modify page header
     $shortcodes = isset($header->shortcodes) ? $header->shortcodes : [];
-    $shortcodes['extra'][$group][] = $extra;
+    $shortcodes['extra'][$group][] = [$method, $arguments];
 
-    $page->modifyHeader('shortcodes', $shortcodes);
+    // Temporally store Shortcode extras in page header
+    $this->page->modifyHeader('shortcodes', $shortcodes);
+
+    if ($this->page->id() == self::getGrav()['page']->id()) {
+      $object = ($group != 'page') ? self::getGrav()[$group] : $page;
+      call_user_func_array([$object, $method], $arguments);
+    }
+  }
+
+  /**
+   * Normalize content i.e. replace all hashes with their corresponding
+   * shortcodes
+   *
+   * @param  string $content The content to be processed
+   *
+   * @return string          The processed content
+   */
+  public function normalize($content)
+  {
+    // Fast replace hashes with their corresponding math formula
+    $hashes = array_keys($this->hashes);
+    $content = str_replace($hashes, $this->hashes, $content);
+
+    // Return normalized content
+    return $content;
   }
 
   /**
@@ -238,10 +310,102 @@ protected function loadShortcodes()
 
     // Fire event
     self::getGrav()->fireEvent('onShortcodesInitialized', new Event(['shortcodes' => $this]));
-    // deprecated
-    self::getGrav()->fireEvent('onShortcodesEvent', new Event(['shortcodes' => $this]));
 
     $this->shortcodes = $this->twig->getShortcodes();
     return array_keys($this->shortcodes);
   }
+
+  /**
+   * A filter function for shortcode filters
+   *
+   * @param  string $name         The name of the shortcode filter to be
+   *                              applied.
+   * @param  string $content      The content to be filtered.
+   * @param  mixed  $context      The Twig context
+   * @param  mixed  $environment  The Twig environment
+   *
+   * @return string               The filtered content (here a hash); use
+   *                              $this->normalize() to replace the hash
+   *                              with the filtered content.
+   */
+  protected function filterShortcode($name, $content, $context = null, $environment = null)
+  {
+    $output = $content;
+    $extra = [$name, $this];
+
+    $filters = $this->twig->getShortcodeFilter($name);
+    foreach ($filters as $filter) {
+      $arguments = [$output];
+      if ($filter->needsEnvironment()) {
+        $arguments[] = $environment;
+      }
+      if ($filter->needsContext()) {
+        $arguments[] = $context;
+      }
+
+      $arguments = array_merge($arguments, $filter->getArguments(), $extra);
+      $output = call_user_func_array($filter->getCallable(), $arguments);
+
+      if (!$output) {
+        break;
+      }
+    }
+
+    // Replace shortcode with a hash to be replaced later
+    return $this->hash($output);
+  }
+
+  /**
+   * Reset shortcode hashes
+   */
+  protected function reset()
+  {
+    $this->hashes = [];
+  }
+
+  /**
+   * Hash a given text.
+   *
+   * Called whenever a tag must be hashed when a function insert an
+   * atomic element in the text stream. Passing $text to through this
+   * function gives a unique text-token which will be reverted back when
+   * calling unhash.
+   *
+   * @param  string $text The text to be hashed
+   *
+   * @return string       Return a unique text-token which will be
+   *                      reverted back when calling unhash.
+   */
+  protected function hash($text)
+  {
+    static $counter = 0;
+
+    // Swap back any tag hash found in $text so we do not have to `unhash`
+    // multiple times at the end.
+    $text = $this->unhash($text);
+
+    // Then hash the block
+    $key = implode("\1A", array('shortcodes', $this->page->id(), ++$counter, 'S'));
+    $this->hashes[$key] = $text;
+
+    // String that will replace the tag
+    return $key;
+  }
+
+  /**
+   * Swap back in all the tags hashed by hash.
+   *
+   * @param  string $text The text to be un-hashed
+   *
+   * @return string       A text containing no hash inside
+   */
+  protected function unhash($text)
+  {
+    $pattern = '~shortcodes\x1A([0-9a-z]+)\x1A([0-9]+)\x1AS~i';
+    $text = preg_replace_callback($pattern, function($matches) {
+      return $this->hashes[$matches[0]];
+    }, $text);
+
+    return $text;
+  }
 }

classes/ShortcodesTrait.php

@@ -15,33 +15,33 @@
  */
 trait ShortcodesTrait
 {
-    /**
-     * A Shortcode instance.
-     *
-     * @var \Grav\Plugin\Shortcodes\Shortcodes
-     */
-    protected static $shortcodes;
+  /**
+   * A Shortcode instance.
+   *
+   * @var \Grav\Plugin\Shortcodes\Shortcodes
+   */
+  protected static $shortcodes;
 
-    /**
-     * Get the Shortcode instance.
-     *
-     * @return \Grav\Plugin\Shortcodes
-     */
-    public static function getShortcodesClass()
-    {
-        if (!self::$shortcodes) {
-            self::$shortcodes = Shortcodes::instance();
-        }
-        return self::$shortcodes;
+  /**
+   * Get the Shortcode instance.
+   *
+   * @return \Grav\Plugin\Shortcodes
+   */
+  public static function getShortcodesClass()
+  {
+    if (!self::$shortcodes) {
+      self::$shortcodes = Shortcodes::instance();
     }
+    return self::$shortcodes;
+  }
 
-    /**
-     * Sets a Shortcode instance.
-     *
-     * @param Grav\Plugin\Shortcodes $shortcodes The Shortcode instance
-     */
-    public static function setShortcodesClass(Shortcodes $shortcodes)
-    {
-        self::$shortcodes = $shortcodes;
-    }
+  /**
+   * Sets a Shortcode instance.
+   *
+   * @param Grav\Plugin\Shortcodes $shortcodes The Shortcode instance
+   */
+  public static function setShortcodesClass(Shortcodes $shortcodes)
+  {
+    self::$shortcodes = $shortcodes;
+  }
 }