3 * @copyright Copyright (C) 2020, Friendica
5 * @license GNU AGPL version 3 or any later version
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.
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.
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/>.
22 namespace Friendica\Core;
26 use Friendica\Network\HTTPException\InternalServerErrorException;
27 use Friendica\Render\TemplateEngine;
30 * This class handles Renderer related functions.
35 * An array of registered template engines ('name'=>'class name')
37 public static $template_engines = [];
40 * An array of instanced template engines ('name'=>'instance')
42 public static $template_engine_instance = [];
45 * An array for all theme-controllable parameters
47 * Mostly unimplemented yet. Only options 'template_engine' and
50 public static $theme = [
54 'force_max_items' => 0,
56 'template_engine' => 'smarty3',
59 private static $ldelim = [
63 private static $rdelim = [
69 * Returns the rendered template output from the template string and variables
71 * @param string $template
74 * @throws InternalServerErrorException
76 public static function replaceMacros(string $template, array $vars = [])
78 $stamp1 = microtime(true);
80 // pass $baseurl to all templates if it isn't set
81 $vars = array_merge(['$baseurl' => DI::baseUrl()->get(), '$APP' => DI::app()], $vars);
83 $t = self::getTemplateEngine();
86 $output = $t->replaceMacros($template, $vars);
87 } catch (Exception $e) {
88 DI::logger()->critical($e->getMessage(), ['template' => $template, 'vars' => $vars]);
89 throw new InternalServerErrorException(DI::l10n()->t('Friendica can\'t display this page at the moment, please contact the administrator or check the Friendica log for errors.'));
92 DI::profiler()->saveTimestamp($stamp1, "rendering", System::callstack());
98 * Load a given template $s
100 * @param string $file Template to load.
101 * @param string $subDir Subdirectory (Optional)
103 * @return string template.
104 * @throws InternalServerErrorException
106 public static function getMarkupTemplate($file, $subDir = '')
108 $stamp1 = microtime(true);
109 $t = self::getTemplateEngine();
112 $template = $t->getTemplateFile($file, $subDir);
113 } catch (Exception $e) {
114 DI::logger()->critical($e->getMessage(), ['file' => $file, 'subDir' => $subDir]);
115 throw new InternalServerErrorException(DI::l10n()->t('Friendica can\'t display this page at the moment, please contact the administrator or check the Friendica log for errors.'));
118 DI::profiler()->saveTimestamp($stamp1, "file", System::callstack());
124 * Register template engine class
126 * @param string $class
127 * @throws InternalServerErrorException
129 public static function registerTemplateEngine($class)
131 $v = get_class_vars($class);
133 if (!empty($v['name'])) {
135 self::$template_engines[$name] = $class;
137 DI::logger()->critical(DI::l10n()->t('template engine cannot be registered without a name.'), ['class' => $class]);
138 throw new InternalServerErrorException(DI::l10n()->t('Friendica can\'t display this page at the moment, please contact the administrator or check the Friendica log for errors.'));
143 * Return template engine instance.
145 * If $name is not defined, return engine defined by theme,
148 * @return TemplateEngine Template Engine instance
149 * @throws InternalServerErrorException
151 public static function getTemplateEngine()
153 $template_engine = (self::$theme['template_engine'] ?? '') ?: 'smarty3';
155 if (isset(self::$template_engines[$template_engine])) {
156 if (isset(self::$template_engine_instance[$template_engine])) {
157 return self::$template_engine_instance[$template_engine];
160 $class = self::$template_engines[$template_engine];
161 $obj = new $class($a->getCurrentTheme(), $a->theme_info);
162 self::$template_engine_instance[$template_engine] = $obj;
167 DI::logger()->critical(DI::l10n()->t('template engine is not registered!'), ['template_engine' => $template_engine]);
168 throw new InternalServerErrorException(DI::l10n()->t('Friendica can\'t display this page at the moment, please contact the administrator or check the Friendica log for errors.'));
172 * Returns the active template engine.
174 * @return string the active template engine
176 public static function getActiveTemplateEngine()
178 return self::$theme['template_engine'];
182 * sets the active template engine
184 * @param string $engine the template engine (default is Smarty3)
186 public static function setActiveTemplateEngine($engine = 'smarty3')
188 self::$theme['template_engine'] = $engine;
192 * Gets the right delimiter for a template engine
198 * @param string $engine The template engine (default is Smarty3)
200 * @return string the right delimiter
202 public static function getTemplateLeftDelimiter($engine = 'smarty3')
204 return self::$ldelim[$engine];
208 * Gets the left delimiter for a template engine
214 * @param string $engine The template engine (default is Smarty3)
216 * @return string the left delimiter
218 public static function getTemplateRightDelimiter($engine = 'smarty3')
220 return self::$rdelim[$engine];