src/Render/FriendicaSmartyEngine.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2022, the Friendica project
   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\Render;
  23
  24 use Friendica\Core\Hook;
  25 use Friendica\DI;
  26 use Friendica\Network\HTTPException\ServiceUnavailableException;
  27 use Friendica\Util\Strings;
  28
  29 /**
  30  * Smarty implementation of the Friendica template abstraction
  31  */
  32 final class FriendicaSmartyEngine extends TemplateEngine
  33 {
  34         static $name = "smarty3";
  35
  36         const FILE_PREFIX = 'file:';
  37         const STRING_PREFIX = 'string:';
  38
  39         /** @var FriendicaSmarty */
  40         private $smarty;
  41
  42         /**
  43          * @inheritDoc
  44          */
  45         public function __construct(string $theme, array $theme_info)
  46         {
  47                 $this->theme = $theme;
  48                 $this->theme_info = $theme_info;
  49                 $work_dir = DI::config()->get('smarty3', 'config_dir');
  50                 $this->smarty = new FriendicaSmarty($this->theme, $this->theme_info, $work_dir);
  51
  52                 if (!is_writable($work_dir)) {
  53                         $admin_message = DI::l10n()->t('The folder %s must be writable by webserver.', $work_dir);
  54                         DI::logger()->critical($admin_message);
  55                         $message = DI::app()->isSiteAdmin() ?
  56                                 $admin_message :
  57                                 DI::l10n()->t('Friendica can\'t display this page at the moment, please contact the administrator.');
  58                         throw new ServiceUnavailableException($message);
  59                 }
  60         }
  61
  62         /**
  63          * @inheritDoc
  64          */
  65         public function testInstall(array &$errors = null)
  66         {
  67                 $this->smarty->testInstall($errors);
  68         }
  69
  70         /**
  71          * @inheritDoc
  72          */
  73         public function replaceMacros(string $template, array $vars): string
  74         {
  75                 if (!Strings::startsWith($template, self::FILE_PREFIX)) {
  76                         $template = self::STRING_PREFIX . $template;
  77                 }
  78
  79                 // "middleware": inject variables into templates
  80                 $arr = [
  81                         'template' => basename($this->smarty->filename),
  82                         'vars' => $vars
  83                 ];
  84                 Hook::callAll('template_vars', $arr);
  85                 $vars = $arr['vars'];
  86
  87                 $this->smarty->clearAllAssign();
  88
  89                 foreach ($vars as $key => $value) {
  90                         if ($key[0] === '$') {
  91                                 $key = substr($key, 1);
  92                         }
  93
  94                         $this->smarty->assign($key, $value);
  95                 }
  96
  97                 return $this->smarty->fetch($template);
  98         }
  99
 100         /**
 101          * @inheritDoc
 102          */
 103         public function getTemplateFile(string $file, string $subDir = '')
 104         {
 105                 // Make sure $root ends with a slash /
 106                 if ($subDir !== '' && substr($subDir, -1, 1) !== '/') {
 107                         $subDir = $subDir . '/';
 108                 }
 109
 110                 $root = DI::basePath() . '/' . $subDir;
 111
 112                 $filename = $this->smarty::SMARTY3_TEMPLATE_FOLDER . '/' . $file;
 113
 114                 if (file_exists("{$root}view/theme/$this->theme/$filename")) {
 115                         $template_file = "{$root}view/theme/$this->theme/$filename";
 116                 } elseif (!empty($this->theme_info['extends']) && file_exists(sprintf('%sview/theme/%s}/%s', $root, $this->theme_info['extends'], $filename))) {
 117                         $template_file = sprintf('%sview/theme/%s}/%s', $root, $this->theme_info['extends'], $filename);
 118                 } elseif (file_exists("{$root}/$filename")) {
 119                         $template_file = "{$root}/$filename";
 120                 } else {
 121                         $template_file = "{$root}view/$filename";
 122                 }
 123
 124                 $this->smarty->filename = $template_file;
 125
 126                 return self::FILE_PREFIX . $template_file;
 127         }
 128 }