src/Render/FriendicaSmarty.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 Smarty;
  25 use Friendica\Core\Renderer;
  26
  27 /**
  28  * Friendica extension of the Smarty3 template engine
  29  */
  30 class FriendicaSmarty extends Smarty
  31 {
  32         const SMARTY3_TEMPLATE_FOLDER = 'templates';
  33
  34         public $filename;
  35
  36         public function __construct(string $theme, array $theme_info, string $work_dir, bool $use_sub_dirs)
  37         {
  38                 parent::__construct();
  39
  40                 // setTemplateDir can be set to an array, which Smarty will parse in order.
  41                 // The order is thus very important here
  42                 $template_dirs = ['theme' => "view/theme/$theme/" . self::SMARTY3_TEMPLATE_FOLDER . '/'];
  43                 if (!empty($theme_info['extends'])) {
  44                         $template_dirs = $template_dirs + ['extends' => 'view/theme/' . $theme_info['extends'] . '/' . self::SMARTY3_TEMPLATE_FOLDER . '/'];
  45                 }
  46
  47                 $template_dirs = $template_dirs + ['base' => 'view/' . self::SMARTY3_TEMPLATE_FOLDER . '/'];
  48                 $this->setTemplateDir($template_dirs);
  49
  50                 $work_dir = rtrim($work_dir, '/');
  51
  52                 $this->setCompileDir($work_dir . '/compiled');
  53                 $this->setConfigDir($work_dir . '/');
  54                 $this->setCacheDir($work_dir . '/');
  55
  56                 /*
  57                  * Enable sub-directory splitting for reducing directory descriptor
  58                  * size. The default behavior is to put all compiled/cached files into
  59                  * one single directory. Under Linux and EXT4 (and maybe other FS) this
  60                  * will increase the descriptor's size (which contains information
  61                  * about entries inside the described directory. If the descriptor is
  62                  * getting to big, the system will slow down as it has to read the
  63                  * whole directory descriptor all over again (unless you have tons of
  64                  * RAM available + have enabled caching inode tables (aka.
  65                  * "descriptors"). Still it won't hurt you.
  66                  */
  67                 $this->setUseSubDirs($use_sub_dirs);
  68
  69                 $this->left_delimiter  = Renderer::getTemplateLeftDelimiter();
  70                 $this->right_delimiter = Renderer::getTemplateRightDelimiter();
  71
  72                 $this->escape_html = true;
  73
  74                 // Don't report errors so verbosely
  75                 $this->error_reporting = E_ALL & ~E_NOTICE;
  76
  77                 $this->muteUndefinedOrNullWarnings();
  78         }
  79 }