3 * @copyright Copyright (C) 2010-2022, the Friendica project
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\Render;
24 use Friendica\Core\Hook;
26 use Friendica\Network\HTTPException\ServiceUnavailableException;
27 use Friendica\Util\Strings;
30 * Smarty implementation of the Friendica template abstraction
32 final class FriendicaSmartyEngine extends TemplateEngine
34 static $name = "smarty3";
36 const FILE_PREFIX = 'file:';
37 const STRING_PREFIX = 'string:';
39 /** @var FriendicaSmarty */
45 public function __construct(string $theme, array $theme_info)
47 $this->theme = $theme;
48 $this->theme_info = $theme_info;
49 $this->smarty = new FriendicaSmarty($this->theme, $this->theme_info);
52 * Enable sub-directory splitting for reducing directory descriptor
53 * size. The default behavior is to put all compiled/cached files into
54 * one single directory. Under Linux and EXT4 (and maybe other FS) this
55 * will increase the descriptor's size (which contains information
56 * about entries inside the described directory. If the descriptor is
57 * getting to big, the system will slow down as it has to read the
58 * whole directory descriptor all over again (unless you have tons of
59 * RAM available + have enabled caching inode tables (aka.
60 * "descriptors"). Still it won't hurt you.
62 $this->smarty->setUseSubDirs(true);
64 if (!is_writable(DI::basePath() . '/view/smarty3')) {
65 $admin_message = DI::l10n()->t('The folder view/smarty3/ must be writable by webserver.');
66 DI::logger()->critical($admin_message);
67 $message = DI::app()->isSiteAdmin() ?
69 DI::l10n()->t('Friendica can\'t display this page at the moment, please contact the administrator.');
70 throw new ServiceUnavailableException($message);
77 public function testInstall(array &$errors = null)
79 $this->smarty->testInstall($errors);
85 public function replaceMacros(string $template, array $vars): string
87 if (!Strings::startsWith($template, self::FILE_PREFIX)) {
88 $template = self::STRING_PREFIX . $template;
91 // "middleware": inject variables into templates
93 'template' => basename($this->smarty->filename),
96 Hook::callAll('template_vars', $arr);
99 $this->smarty->clearAllAssign();
101 foreach ($vars as $key => $value) {
102 if ($key[0] === '$') {
103 $key = substr($key, 1);
106 $this->smarty->assign($key, $value);
109 return $this->smarty->fetch($template);
115 public function getTemplateFile(string $file, string $subDir = '')
117 // Make sure $root ends with a slash /
118 if ($subDir !== '' && substr($subDir, -1, 1) !== '/') {
119 $subDir = $subDir . '/';
122 $root = DI::basePath() . '/' . $subDir;
124 $filename = $this->smarty::SMARTY3_TEMPLATE_FOLDER . '/' . $file;
126 if (file_exists("{$root}view/theme/$this->theme/$filename")) {
127 $template_file = "{$root}view/theme/$this->theme/$filename";
128 } elseif (!empty($this->theme_info['extends']) && file_exists(sprintf('%sview/theme/%s}/%s', $root, $this->theme_info['extends'], $filename))) {
129 $template_file = sprintf('%sview/theme/%s}/%s', $root, $this->theme_info['extends'], $filename);
130 } elseif (file_exists("{$root}/$filename")) {
131 $template_file = "{$root}/$filename";
133 $template_file = "{$root}view/$filename";
136 $this->smarty->filename = $template_file;
138 return self::FILE_PREFIX . $template_file;