friendica/src/Core/Renderer.php

239 lines
6.4 KiB
PHP
Raw Normal View History

<?php
/**
2023-01-01 14:36:24 +00:00
* @copyright Copyright (C) 2010-2023, the Friendica project
2020-02-09 14:45:36 +00:00
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
*/
namespace Friendica\Core;
use Exception;
use Friendica\DI;
2021-10-29 23:21:07 +00:00
use Friendica\Network\HTTPException\ServiceUnavailableException;
use Friendica\Render\TemplateEngine;
/**
2020-01-19 06:05:23 +00:00
* This class handles Renderer related functions.
*/
class Renderer
{
2019-04-14 12:05:48 +00:00
/**
2020-01-19 06:05:23 +00:00
* An array of registered template engines ('name'=>'class name')
*/
2019-04-14 12:05:48 +00:00
public static $template_engines = [];
2019-04-14 12:05:48 +00:00
/**
2020-01-19 06:05:23 +00:00
* An array of instanced template engines ('name'=>'instance')
*/
public static $template_engine_instance = [];
2019-04-14 12:05:48 +00:00
/**
2020-01-19 06:05:23 +00:00
* An array for all theme-controllable parameters
*
* Mostly unimplemented yet. Only options 'template_engine' and
* beyond are used.
*/
public static $theme = [
'videowidth' => 425,
'videoheight' => 350,
'stylesheet' => '',
'template_engine' => 'smarty3',
];
2019-04-14 12:05:48 +00:00
private static $ldelim = [
'internal' => '',
'smarty3' => '{{'
];
private static $rdelim = [
'internal' => '',
'smarty3' => '}}'
2019-04-14 12:05:48 +00:00
];
/**
* Returns the rendered template output from the template string and variables
*
* @param string $template
* @param array $vars
* @return string
2021-10-29 23:21:07 +00:00
* @throws ServiceUnavailableException
*/
2022-06-19 22:51:59 +00:00
public static function replaceMacros(string $template, array $vars = []): string
2019-04-14 12:05:48 +00:00
{
2021-07-27 04:57:29 +00:00
DI::profiler()->startRecording('rendering');
// pass $baseurl to all templates if it isn't set
$vars = array_merge(['$baseurl' => DI::baseUrl(), '$APP' => DI::app()], $vars);
2019-04-14 12:05:48 +00:00
$t = self::getTemplateEngine();
2019-04-14 12:05:48 +00:00
try {
$output = $t->replaceMacros($template, $vars);
2019-04-14 12:05:48 +00:00
} catch (Exception $e) {
DI::logger()->critical($e->getMessage(), ['template' => $template, 'vars' => $vars]);
$message = DI::app()->isSiteAdmin() ?
$e->getMessage() :
DI::l10n()->t('Friendica can\'t display this page at the moment, please contact the administrator.');
2021-10-29 23:21:07 +00:00
throw new ServiceUnavailableException($message);
2019-04-14 12:05:48 +00:00
}
2021-07-27 04:57:29 +00:00
DI::profiler()->stopRecording();
2019-04-14 12:05:48 +00:00
return $output;
}
2019-01-06 21:06:53 +00:00
/**
2020-01-19 06:05:23 +00:00
* Load a given template $s
2019-01-06 21:06:53 +00:00
*
* @param string $file Template to load.
* @param string $subDir Subdirectory (Optional)
2019-01-06 21:06:53 +00:00
*
* @return string Template
2021-10-29 23:21:07 +00:00
* @throws ServiceUnavailableException
2019-01-06 21:06:53 +00:00
*/
public static function getMarkupTemplate(string $file, string $subDir = ''): string
2019-04-14 12:05:48 +00:00
{
2021-07-27 04:57:29 +00:00
DI::profiler()->startRecording('file');
2019-04-14 12:05:48 +00:00
$t = self::getTemplateEngine();
try {
$template = $t->getTemplateFile($file, $subDir);
2019-04-14 12:05:48 +00:00
} catch (Exception $e) {
DI::logger()->critical($e->getMessage(), ['file' => $file, 'subDir' => $subDir]);
$message = DI::app()->isSiteAdmin() ?
$e->getMessage() :
DI::l10n()->t('Friendica can\'t display this page at the moment, please contact the administrator.');
2021-10-29 23:21:07 +00:00
throw new ServiceUnavailableException($message);
2019-04-14 12:05:48 +00:00
}
2021-07-27 04:57:29 +00:00
DI::profiler()->stopRecording();
2019-04-14 12:05:48 +00:00
return $template;
}
2019-04-14 12:05:48 +00:00
/**
2020-01-19 06:05:23 +00:00
* Register template engine class
*
* @param string $class
*
* @return void
2021-10-29 23:21:07 +00:00
* @throws ServiceUnavailableException
*/
public static function registerTemplateEngine(string $class)
{
2019-04-14 12:05:48 +00:00
$v = get_class_vars($class);
if (!empty($v['name'])) {
$name = $v['name'];
self::$template_engines[$name] = $class;
} else {
$admin_message = DI::l10n()->t('template engine cannot be registered without a name.');
DI::logger()->critical($admin_message, ['class' => $class]);
$message = DI::app()->isSiteAdmin() ?
$admin_message :
DI::l10n()->t('Friendica can\'t display this page at the moment, please contact the administrator.');
2021-10-29 23:21:07 +00:00
throw new ServiceUnavailableException($message);
}
}
/**
2020-01-19 06:05:23 +00:00
* Return template engine instance.
*
* If $name is not defined, return engine defined by theme,
* or default
*
* @return TemplateEngine Template Engine instance
2021-10-29 23:21:07 +00:00
* @throws ServiceUnavailableException
*/
public static function getTemplateEngine(): TemplateEngine
{
$template_engine = (self::$theme['template_engine'] ?? '') ?: 'smarty3';
if (isset(self::$template_engines[$template_engine])) {
if (isset(self::$template_engine_instance[$template_engine])) {
return self::$template_engine_instance[$template_engine];
} else {
$a = DI::app();
$class = self::$template_engines[$template_engine];
2021-07-25 19:39:10 +00:00
$obj = new $class($a->getCurrentTheme(), $a->getThemeInfo());
self::$template_engine_instance[$template_engine] = $obj;
return $obj;
}
}
$admin_message = DI::l10n()->t('template engine is not registered!');
DI::logger()->critical($admin_message, ['template_engine' => $template_engine]);
$message = DI::app()->isSiteAdmin() ?
$admin_message :
DI::l10n()->t('Friendica can\'t display this page at the moment, please contact the administrator.');
2021-10-29 23:21:07 +00:00
throw new ServiceUnavailableException($message);
2019-04-14 12:05:48 +00:00
}
/**
2020-01-19 06:05:23 +00:00
* Returns the active template engine.
*
* @return string the active template engine
*/
public static function getActiveTemplateEngine(): string
{
return self::$theme['template_engine'];
}
/**
* sets the active template engine
*
* @param string $engine the template engine (default is Smarty3)
*
* @return void
*/
public static function setActiveTemplateEngine(string $engine = 'smarty3')
{
self::$theme['template_engine'] = $engine;
}
2019-04-14 12:05:48 +00:00
/**
* Gets the right delimiter for a template engine
*
* Currently:
* Internal = ''
* Smarty3 = '{{'
*
* @param string $engine The template engine (default is Smarty3)
*
* @return string the right delimiter
*/
public static function getTemplateLeftDelimiter(string $engine = 'smarty3'): string
{
return self::$ldelim[$engine];
}
/**
* Gets the left delimiter for a template engine
*
* Currently:
* Internal = ''
* Smarty3 = '}}'
*
* @param string $engine The template engine (default is Smarty3)
*
* @return string the left delimiter
*/
public static function getTemplateRightDelimiter(string $engine = 'smarty3'): string
{
return self::$rdelim[$engine];
}
}