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 $message = is_site_admin() ?
91 DI::l10n()->t('Friendica can\'t display this page at the moment, please contact the administrator.');
92 throw new InternalServerErrorException($message);
95 DI::profiler()->saveTimestamp($stamp1, "rendering");
101 * Load a given template $s
103 * @param string $file Template to load.
104 * @param string $subDir Subdirectory (Optional)
106 * @return string template.
107 * @throws InternalServerErrorException
109 public static function getMarkupTemplate($file, $subDir = '')
111 $stamp1 = microtime(true);
112 $t = self::getTemplateEngine();
115 $template = $t->getTemplateFile($file, $subDir);
116 } catch (Exception $e) {
117 DI::logger()->critical($e->getMessage(), ['file' => $file, 'subDir' => $subDir]);
118 $message = is_site_admin() ?
120 DI::l10n()->t('Friendica can\'t display this page at the moment, please contact the administrator.');
121 throw new InternalServerErrorException($message);
124 DI::profiler()->saveTimestamp($stamp1, "file");
130 * Register template engine class
132 * @param string $class
133 * @throws InternalServerErrorException
135 public static function registerTemplateEngine($class)
137 $v = get_class_vars($class);
139 if (!empty($v['name'])) {
141 self::$template_engines[$name] = $class;
143 $admin_message = DI::l10n()->t('template engine cannot be registered without a name.');
144 DI::logger()->critical($admin_message, ['class' => $class]);
145 $message = is_site_admin() ?
147 DI::l10n()->t('Friendica can\'t display this page at the moment, please contact the administrator.');
148 throw new InternalServerErrorException($message);
153 * Return template engine instance.
155 * If $name is not defined, return engine defined by theme,
158 * @return TemplateEngine Template Engine instance
159 * @throws InternalServerErrorException
161 public static function getTemplateEngine()
163 $template_engine = (self::$theme['template_engine'] ?? '') ?: 'smarty3';
165 if (isset(self::$template_engines[$template_engine])) {
166 if (isset(self::$template_engine_instance[$template_engine])) {
167 return self::$template_engine_instance[$template_engine];
170 $class = self::$template_engines[$template_engine];
171 $obj = new $class($a->getCurrentTheme(), $a->theme_info);
172 self::$template_engine_instance[$template_engine] = $obj;
177 $admin_message = DI::l10n()->t('template engine is not registered!');
178 DI::logger()->critical($admin_message, ['template_engine' => $template_engine]);
179 $message = is_site_admin() ?
181 DI::l10n()->t('Friendica can\'t display this page at the moment, please contact the administrator.');
182 throw new InternalServerErrorException($message);
186 * Returns the active template engine.
188 * @return string the active template engine
190 public static function getActiveTemplateEngine()
192 return self::$theme['template_engine'];
196 * sets the active template engine
198 * @param string $engine the template engine (default is Smarty3)
200 public static function setActiveTemplateEngine($engine = 'smarty3')
202 self::$theme['template_engine'] = $engine;
206 * Gets the right delimiter for a template engine
212 * @param string $engine The template engine (default is Smarty3)
214 * @return string the right delimiter
216 public static function getTemplateLeftDelimiter($engine = 'smarty3')
218 return self::$ldelim[$engine];
222 * Gets the left delimiter for a template engine
228 * @param string $engine The template engine (default is Smarty3)
230 * @return string the left delimiter
232 public static function getTemplateRightDelimiter($engine = 'smarty3')
234 return self::$rdelim[$engine];