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