src/Core/Renderer.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2020, Friendica
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Core;
  23
  24 use Exception;
  25 use Friendica\DI;
  26 use Friendica\Render\FriendicaSmarty;
  27 use Friendica\Render\ITemplateEngine;
  28
  29 /**
  30  * This class handles Renderer related functions.
  31  */
  32 class Renderer
  33 {
  34         /**
  35          * An array of registered template engines ('name'=>'class name')
  36          */
  37         public static $template_engines = [];
  38
  39         /**
  40          * An array of instanced template engines ('name'=>'instance')
  41          */
  42         public static $template_engine_instance = [];
  43
  44         /**
  45          * An array for all theme-controllable parameters
  46          *
  47          * Mostly unimplemented yet. Only options 'template_engine' and
  48          * beyond are used.
  49          */
  50         public static $theme = [
  51                 'sourcename' => '',
  52                 'videowidth' => 425,
  53                 'videoheight' => 350,
  54                 'force_max_items' => 0,
  55                 'stylesheet' => '',
  56                 'template_engine' => 'smarty3',
  57         ];
  58
  59         private static $ldelim = [
  60                 'internal' => '',
  61                 'smarty3' => '{{'
  62         ];
  63         private static $rdelim = [
  64                 'internal' => '',
  65                 'smarty3' => '}}'
  66         ];
  67
  68         /**
  69          * This is our template processor
  70          *
  71          * @param string|FriendicaSmarty $s    The string requiring macro substitution or an instance of FriendicaSmarty
  72          * @param array                  $vars Key value pairs (search => replace)
  73          *
  74          * @return string substituted string
  75          * @throws Exception
  76          */
  77         public static function replaceMacros($s, array $vars = [])
  78         {
  79                 $stamp1 = microtime(true);
  80
  81                 // pass $baseurl to all templates if it isn't set
  82                 $vars = array_merge(['$baseurl' => DI::baseUrl()->get()], $vars);
  83
  84                 $t = self::getTemplateEngine();
  85
  86                 try {
  87                         $output = $t->replaceMacros($s, $vars);
  88                 } catch (Exception $e) {
  89                         echo "<pre><b>" . __FUNCTION__ . "</b>: " . $e->getMessage() . "</pre>";
  90                         exit();
  91                 }
  92
  93                 DI::profiler()->saveTimestamp($stamp1, "rendering", System::callstack());
  94
  95                 return $output;
  96         }
  97
  98         /**
  99          * Load a given template $s
 100          *
 101          * @param string $s    Template to load.
 102          * @param string $root Optional.
 103          *
 104          * @return string template.
 105          * @throws Exception
 106          */
 107         public static function getMarkupTemplate($s, $root = '')
 108         {
 109                 $stamp1 = microtime(true);
 110                 $a = DI::app();
 111                 $t = self::getTemplateEngine();
 112
 113                 try {
 114                         $template = $t->getTemplateFile($s, $root);
 115                 } catch (Exception $e) {
 116                         echo "<pre><b>" . __FUNCTION__ . "</b>: " . $e->getMessage() . "</pre>";
 117                         exit();
 118                 }
 119
 120                 DI::profiler()->saveTimestamp($stamp1, "file", System::callstack());
 121
 122                 return $template;
 123         }
 124
 125         /**
 126          * Register template engine class
 127          *
 128          * @param string $class
 129          */
 130         public static function registerTemplateEngine($class)
 131         {
 132                 $v = get_class_vars($class);
 133
 134                 if (!empty($v['name']))
 135                 {
 136                         $name = $v['name'];
 137                         self::$template_engines[$name] = $class;
 138                 } else {
 139                         echo "template engine <tt>$class</tt> cannot be registered without a name.\n";
 140                         die();
 141                 }
 142         }
 143
 144         /**
 145          * Return template engine instance.
 146          *
 147          * If $name is not defined, return engine defined by theme,
 148          * or default
 149          *
 150          * @return ITemplateEngine Template Engine instance
 151          */
 152         public static function getTemplateEngine()
 153         {
 154                 $template_engine = (self::$theme['template_engine'] ?? '') ?: 'smarty3';
 155
 156                 if (isset(self::$template_engines[$template_engine])) {
 157                         if (isset(self::$template_engine_instance[$template_engine])) {
 158                                 return self::$template_engine_instance[$template_engine];
 159                         } else {
 160                                 $class = self::$template_engines[$template_engine];
 161                                 $obj = new $class;
 162                                 self::$template_engine_instance[$template_engine] = $obj;
 163                                 return $obj;
 164                         }
 165                 }
 166
 167                 echo "template engine <tt>$template_engine</tt> is not registered!\n";
 168                 exit();
 169         }
 170
 171         /**
 172          * Returns the active template engine.
 173          *
 174          * @return string the active template engine
 175          */
 176         public static function getActiveTemplateEngine()
 177         {
 178                 return self::$theme['template_engine'];
 179         }
 180
 181         /**
 182          * sets the active template engine
 183          *
 184          * @param string $engine the template engine (default is Smarty3)
 185          */
 186         public static function setActiveTemplateEngine($engine = 'smarty3')
 187         {
 188                 self::$theme['template_engine'] = $engine;
 189         }
 190
 191         /**
 192          * Gets the right delimiter for a template engine
 193          *
 194          * Currently:
 195          * Internal = ''
 196          * Smarty3 = '{{'
 197          *
 198          * @param string $engine The template engine (default is Smarty3)
 199          *
 200          * @return string the right delimiter
 201          */
 202         public static function getTemplateLeftDelimiter($engine = 'smarty3')
 203         {
 204                 return self::$ldelim[$engine];
 205         }
 206
 207         /**
 208          * Gets the left delimiter for a template engine
 209          *
 210          * Currently:
 211          * Internal = ''
 212          * Smarty3 = '}}'
 213          *
 214          * @param string $engine The template engine (default is Smarty3)
 215          *
 216          * @return string the left delimiter
 217          */
 218         public static function getTemplateRightDelimiter($engine = 'smarty3')
 219         {
 220                 return self::$rdelim[$engine];
 221         }
 222 }