3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2017
37 * Fix for bug CRM-392. Not sure if this is the best fix or it will impact
38 * other similar PEAR packages. doubt it
40 if (!class_exists('Smarty')) {
41 require_once 'Smarty/Smarty.class.php';
47 class CRM_Core_Smarty
extends Smarty
{
49 // use print.tpl and bypass the CMS. Civi prints a valid html file
51 // this and all the below bypasses the CMS html surrounding it and assumes we will embed this within other pages
53 // sends the generated html to the chosen pdf engine
55 // this options also skips the enclosing form html and does not
56 // generate any of the hidden fields, most notably qfKey
57 // this is typically used in ajax scripts to embed form snippets based on user choices
59 // this prints a complete form and also generates a qfKey, can we replace this with
60 // snippet = 2?? Does the constant _NOFFORM do anything?
62 // Note: added in v 4.3 with the value '6'
63 // Value changed in 4.5 to 'json' for better readability
64 // @see CRM_Core_Page_AJAX::returnJsonResponse
68 * We only need one instance of this object. So we use the singleton
69 * pattern and cache the instance in this variable
73 static private $_singleton = NULL;
76 * @var array (string $name => mixed $value) a list of variables ot save temporarily
78 private $backupFrames = array();
83 * @return CRM_Core_Smarty
85 public function __construct() {
86 parent
::__construct();
89 private function initialize() {
90 $config = CRM_Core_Config
::singleton();
92 if (isset($config->customTemplateDir
) && $config->customTemplateDir
) {
93 $this->template_dir
= array_merge(array($config->customTemplateDir
),
98 $this->template_dir
= $config->templateDir
;
100 $this->compile_dir
= CRM_Utils_File
::addTrailingSlash(CRM_Utils_File
::addTrailingSlash($config->templateCompileDir
) . $this->getLocale());
101 CRM_Utils_File
::createDir($this->compile_dir
);
102 CRM_Utils_File
::restrictAccess($this->compile_dir
);
104 // check and ensure it is writable
105 // else we sometime suppress errors quietly and this results
106 // in blank emails etc
107 if (!is_writable($this->compile_dir
)) {
108 echo "CiviCRM does not have permission to write temp files in {$this->compile_dir}, Exiting";
112 //Check for safe mode CRM-2207
113 if (ini_get('safe_mode')) {
114 $this->use_sub_dirs
= FALSE;
117 $this->use_sub_dirs
= TRUE;
120 $customPluginsDir = NULL;
121 if (isset($config->customPHPPathDir
)) {
123 = $config->customPHPPathDir
. DIRECTORY_SEPARATOR
.
124 'CRM' . DIRECTORY_SEPARATOR
.
125 'Core' . DIRECTORY_SEPARATOR
.
126 'Smarty' . DIRECTORY_SEPARATOR
.
127 'plugins' . DIRECTORY_SEPARATOR
;
128 if (!file_exists($customPluginsDir)) {
129 $customPluginsDir = NULL;
133 $smartyDir = dirname(dirname(__DIR__
)) . DIRECTORY_SEPARATOR
. 'packages' . DIRECTORY_SEPARATOR
. 'Smarty' . DIRECTORY_SEPARATOR
;
134 $pluginsDir = __DIR__
. DIRECTORY_SEPARATOR
. 'Smarty' . DIRECTORY_SEPARATOR
. 'plugins' . DIRECTORY_SEPARATOR
;
136 if ($customPluginsDir) {
137 $this->plugins_dir
= array($customPluginsDir, $smartyDir . 'plugins', $pluginsDir);
140 $this->plugins_dir
= array($smartyDir . 'plugins', $pluginsDir);
143 // add the session and the config here
144 $session = CRM_Core_Session
::singleton();
146 $this->assign_by_ref('config', $config);
147 $this->assign_by_ref('session', $session);
149 $tsLocale = CRM_Core_I18n
::getLocale();
150 $this->assign('tsLocale', $tsLocale);
152 // CRM-7163 hack: we don’t display langSwitch on upgrades anyway
153 if (!CRM_Core_Config
::isUpgradeMode()) {
154 $this->assign('langSwitch', CRM_Core_I18n
::languages(TRUE));
157 $this->register_function('crmURL', array('CRM_Utils_System', 'crmURL'));
158 $this->load_filter('pre', 'resetExtScope');
160 $this->assign('crmPermissions', new CRM_Core_Smarty_Permissions());
164 * Static instance provider.
166 * Method providing static instance of SmartTemplate, as
167 * in Singleton pattern.
169 public static function &singleton() {
170 if (!isset(self
::$_singleton)) {
171 self
::$_singleton = new CRM_Core_Smarty();
172 self
::$_singleton->initialize();
174 self
::registerStringResource();
176 return self
::$_singleton;
180 * Executes & returns or displays the template results
182 * @param string $resource_name
183 * @param string $cache_id
184 * @param string $compile_id
185 * @param bool $display
187 * @return bool|mixed|string
189 public function fetch($resource_name, $cache_id = NULL, $compile_id = NULL, $display = FALSE) {
190 if (preg_match('/^(\s+)?string:/', $resource_name)) {
191 $old_security = $this->security
;
192 $this->security
= TRUE;
194 $output = parent
::fetch($resource_name, $cache_id, $compile_id, $display);
195 if (isset($old_security)) {
196 $this->security
= $old_security;
202 * Fetch a template (while using certain variables)
204 * @param string $resource_name
206 * (string $name => mixed $value) variables to export to Smarty.
208 * @return bool|mixed|string
210 public function fetchWith($resource_name, $vars) {
211 $this->pushScope($vars);
213 $result = $this->fetch($resource_name);
215 catch (Exception
$e) {
216 // simulate try { ... } finally { ... }
225 * @param string $name
228 public function appendValue($name, $value) {
229 $currentValue = $this->get_template_vars($name);
230 if (!$currentValue) {
231 $this->assign($name, $value);
234 if (strpos($currentValue, $value) === FALSE) {
235 $this->assign($name, $currentValue . $value);
240 public function clearTemplateVars() {
241 foreach (array_keys($this->_tpl_vars
) as $key) {
242 if ($key == 'config' ||
$key == 'session') {
245 unset($this->_tpl_vars
[$key]);
249 public static function registerStringResource() {
250 require_once 'CRM/Core/Smarty/resources/String.php';
251 civicrm_smarty_register_string_resource();
257 public function addTemplateDir($path) {
258 if (is_array($this->template_dir
)) {
259 array_unshift($this->template_dir
, $path);
262 $this->template_dir
= array($path, $this->template_dir
);
268 * Temporarily assign a list of variables.
271 * $smarty->pushScope(array(
272 * 'first_name' => 'Alice',
273 * 'last_name' => 'roberts',
275 * $html = $smarty->fetch('view-contact.tpl');
276 * $smarty->popScope();
280 * (string $name => mixed $value).
281 * @return CRM_Core_Smarty
284 public function pushScope($vars) {
285 $oldVars = $this->get_template_vars();
286 $backupFrame = array();
287 foreach ($vars as $key => $value) {
288 $backupFrame[$key] = isset($oldVars[$key]) ?
$oldVars[$key] : NULL;
290 $this->backupFrames
[] = $backupFrame;
292 $this->assignAll($vars);
298 * Remove any values that were previously pushed.
300 * @return CRM_Core_Smarty
303 public function popScope() {
304 $this->assignAll(array_pop($this->backupFrames
));
310 * (string $name => mixed $value).
311 * @return CRM_Core_Smarty
313 public function assignAll($vars) {
314 foreach ($vars as $key => $value) {
315 $this->assign($key, $value);
321 * Get the locale for translation.
325 private function getLocale() {
326 $tsLocale = CRM_Core_I18n
::getLocale();
327 if (!empty($tsLocale)) {
331 $config = CRM_Core_Config
::singleton();
332 if (!empty($config->lcMessages
)) {
333 return $config->lcMessages
;