Merge remote-tracking branch 'upstream/develop' into conversation-receivers

[friendica.git] / src / Render / FriendicaSmartyEngine.php

diff --git a/src/Render/FriendicaSmartyEngine.php b/src/Render/FriendicaSmartyEngine.php
index c6e95ee068498ca0505577597057e761f5ac273e..6fc8f4480676eb892583c7f113968ff2bd4fc243 100644 (file)
--- a/src/Render/FriendicaSmartyEngine.php
+++ b/src/Render/FriendicaSmartyEngine.php
@@ -1,82 +1,127 @@
 <?php
 /**
- * @file src/Render/FriendicaSmartyEngine.php
+ * @copyright Copyright (C) 2010-2022, the Friendica project
+ *
+ * @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\Render;
 
-use Friendica\Core\Addon;
+use Friendica\Core\Hook;
+use Friendica\DI;
+use Friendica\Network\HTTPException\ServiceUnavailableException;
+use Friendica\Util\Strings;
 
 /**
- * Smarty implementation of the Friendica template engine interface
- *
- * @author Hypolite Petovan <mrpetovan@gmail.com>
+ * Smarty implementation of the Friendica template abstraction
  */
-class FriendicaSmartyEngine implements ITemplateEngine
+final class FriendicaSmartyEngine extends TemplateEngine
 {
        static $name = "smarty3";
 
-       public function __construct()
+       const FILE_PREFIX = 'file:';
+       const STRING_PREFIX = 'string:';
+
+       /** @var FriendicaSmarty */
+       private $smarty;
+
+       /**
+        * @inheritDoc
+        */
+       public function __construct(string $theme, array $theme_info)
        {
-               if (!is_writable('view/smarty3/')) {
-                       echo "<b>ERROR:</b> folder <tt>view/smarty3/</tt> must be writable by webserver.";
-                       killme();
+               $this->theme = $theme;
+               $this->theme_info = $theme_info;
+               $this->smarty = new FriendicaSmarty($this->theme, $this->theme_info);
+
+               if (!is_writable(DI::basePath() . '/view/smarty3')) {
+                       $admin_message = DI::l10n()->t('The folder view/smarty3/ must be writable by webserver.');
+                       DI::logger()->critical($admin_message);
+                       $message = DI::app()->isSiteAdmin() ?
+                               $admin_message :
+                               DI::l10n()->t('Friendica can\'t display this page at the moment, please contact the administrator.');
+                       throw new ServiceUnavailableException($message);
                }
        }
 
-       // ITemplateEngine interface
-       public function replaceMacros($s, $r)
+       /**
+        * @inheritDoc
+        */
+       public function testInstall(array &$errors = null)
        {
-               $template = '';
-               if (gettype($s) === 'string') {
-                       $template = $s;
-                       $s = new FriendicaSmarty();
-               }
+               $this->smarty->testInstall($errors);
+       }
 
-               $r['$APP'] = get_app();
+       /**
+        * @inheritDoc
+        */
+       public function replaceMacros(string $template, array $vars)
+       {
+               if (!Strings::startsWith($template, self::FILE_PREFIX)) {
+                       $template = self::STRING_PREFIX . $template;
+               }
 
                // "middleware": inject variables into templates
                $arr = [
-                       "template" => basename($s->filename),
-                       "vars" => $r
+                       'template' => basename($this->smarty->filename),
+                       'vars' => $vars
                ];
-               Addon::callHooks("template_vars", $arr);
-               $r = $arr['vars'];
+               Hook::callAll('template_vars', $arr);
+               $vars = $arr['vars'];
 
-               foreach ($r as $key => $value) {
+               $this->smarty->clearAllAssign();
+
+               foreach ($vars as $key => $value) {
                        if ($key[0] === '$') {
                                $key = substr($key, 1);
                        }
 
-                       $s->assign($key, $value);
+                       $this->smarty->assign($key, $value);
                }
-               return $s->parsed($template);
+
+               return $this->smarty->fetch($template);
        }
 
-       public function getTemplateFile($file, $root = '')
+       /**
+        * @inheritDoc
+        */
+       public function getTemplateFile(string $file, string $subDir = '')
        {
-               $a = get_app();
-               $template = new FriendicaSmarty();
-
                // Make sure $root ends with a slash /
-               if ($root !== '' && substr($root, -1, 1) !== '/') {
-                       $root = $root . '/';
+               if ($subDir !== '' && substr($subDir, -1, 1) !== '/') {
+                       $subDir = $subDir . '/';
                }
 
-               $theme = $a->getCurrentTheme();
-               $filename = $template::SMARTY3_TEMPLATE_FOLDER . '/' . $file;
+               $root = DI::basePath() . '/' . $subDir;
+
+               $filename = $this->smarty::SMARTY3_TEMPLATE_FOLDER . '/' . $file;
 
-               if (file_exists("{$root}view/theme/$theme/$filename")) {
-                       $template_file = "{$root}view/theme/$theme/$filename";
-               } elseif (x($a->theme_info, 'extends') && file_exists(sprintf('%sview/theme/%s}/%s', $root, $a->theme_info['extends'], $filename))) {
-                       $template_file = sprintf('%sview/theme/%s}/%s', $root, $a->theme_info['extends'], $filename);
+               if (file_exists("{$root}view/theme/$this->theme/$filename")) {
+                       $template_file = "{$root}view/theme/$this->theme/$filename";
+               } elseif (!empty($this->theme_info['extends']) && file_exists(sprintf('%sview/theme/%s}/%s', $root, $this->theme_info['extends'], $filename))) {
+                       $template_file = sprintf('%sview/theme/%s}/%s', $root, $this->theme_info['extends'], $filename);
                } elseif (file_exists("{$root}/$filename")) {
                        $template_file = "{$root}/$filename";
                } else {
                        $template_file = "{$root}view/$filename";
                }
 
-               $template->filename = $template_file;
+               $this->smarty->filename = $template_file;
 
-               return $template;
+               return self::FILE_PREFIX . $template_file;
        }
 }