mirror of
				https://github.com/smarty-php/smarty.git
				synced 2025-11-03 22:01:36 +01:00 
			
		
		
		
	
		
			
	
	
		
			250 lines
		
	
	
		
			8.5 KiB
		
	
	
	
		
			PHP
		
	
	
	
	
	
		
		
			
		
	
	
			250 lines
		
	
	
		
			8.5 KiB
		
	
	
	
		
			PHP
		
	
	
	
	
	
| 
								 | 
							
								<?php
							 | 
						||
| 
								 | 
							
								/**
							 | 
						||
| 
								 | 
							
								* Smarty Internal Plugin Config
							 | 
						||
| 
								 | 
							
								* 
							 | 
						||
| 
								 | 
							
								* Main class for config variables
							 | 
						||
| 
								 | 
							
								* 
							 | 
						||
| 
								 | 
							
								* @ignore 
							 | 
						||
| 
								 | 
							
								* @package Smarty
							 | 
						||
| 
								 | 
							
								* @subpackage Config
							 | 
						||
| 
								 | 
							
								* @author Uwe Tews 
							 | 
						||
| 
								 | 
							
								*/
							 | 
						||
| 
								 | 
							
								class Smarty_Internal_Config extends Smarty_Internal_Base {
							 | 
						||
| 
								 | 
							
								    static $config_objects = array();
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    public function __construct($config_resource)
							 | 
						||
| 
								 | 
							
								    {
							 | 
						||
| 
								 | 
							
								        parent::__construct(); 
							 | 
						||
| 
								 | 
							
								        // set instance object
							 | 
						||
| 
								 | 
							
								        // self::instance($this);
							 | 
						||
| 
								 | 
							
								        // initianlize
							 | 
						||
| 
								 | 
							
								        $this->config_resource = $config_resource;
							 | 
						||
| 
								 | 
							
								        $this->config_resource_type = null;
							 | 
						||
| 
								 | 
							
								        $this->config_resource_name = null;
							 | 
						||
| 
								 | 
							
								        $this->config_filepath = null;
							 | 
						||
| 
								 | 
							
								        $this->config_timestamp = null;
							 | 
						||
| 
								 | 
							
								        $this->config_source = null;
							 | 
						||
| 
								 | 
							
								        $this->compiled_config = null;
							 | 
						||
| 
								 | 
							
								        $this->compiled_filepath = null;
							 | 
						||
| 
								 | 
							
								        $this->compiled_timestamp = null;
							 | 
						||
| 
								 | 
							
								        $this->mustCompile = null;
							 | 
						||
| 
								 | 
							
								        $this->compiler_object = null; 
							 | 
						||
| 
								 | 
							
								        // parse config resource name
							 | 
						||
| 
								 | 
							
								        if (!$this->parseConfigResourceName ($config_resource)) {
							 | 
						||
| 
								 | 
							
								            throw new Exception ("Unable to parse config resource '{$config_resource}'");
							 | 
						||
| 
								 | 
							
								        } 
							 | 
						||
| 
								 | 
							
								    } 
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    public function getConfigFilepath ()
							 | 
						||
| 
								 | 
							
								    {
							 | 
						||
| 
								 | 
							
								        return $this->config_filepath === null ?
							 | 
						||
| 
								 | 
							
								        $this->config_filepath = $this->buildConfigFilepath() :
							 | 
						||
| 
								 | 
							
								        $this->config_filepath;
							 | 
						||
| 
								 | 
							
								    } 
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    public function getTimestamp ()
							 | 
						||
| 
								 | 
							
								    {
							 | 
						||
| 
								 | 
							
								        return $this->config_timestamp === null ?
							 | 
						||
| 
								 | 
							
								        $this->config_timestamp = filemtime($this->getConfigFilepath()) :
							 | 
						||
| 
								 | 
							
								        $this->config_timestamp;
							 | 
						||
| 
								 | 
							
								    } 
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    private function parseConfigResourceName($config_resource)
							 | 
						||
| 
								 | 
							
								    {
							 | 
						||
| 
								 | 
							
								        if (empty($config_resource))
							 | 
						||
| 
								 | 
							
								            return false;
							 | 
						||
| 
								 | 
							
								        if (strpos($config_resource, ':') === false) {
							 | 
						||
| 
								 | 
							
								            // no resource given, use default
							 | 
						||
| 
								 | 
							
								            $this->config_resource_type = $this->smarty->default_config_type;
							 | 
						||
| 
								 | 
							
								            $this->config_resource_name = $config_resource;
							 | 
						||
| 
								 | 
							
								        } else {
							 | 
						||
| 
								 | 
							
								            // get type and name from path
							 | 
						||
| 
								 | 
							
								            list($this->config_resource_type, $this->config_resource_name) = explode(':', $config_resource, 2);
							 | 
						||
| 
								 | 
							
								            if (strlen($this->config_resource_type) == 1) {
							 | 
						||
| 
								 | 
							
								                // 1 char is not resource type, but part of filepath
							 | 
						||
| 
								 | 
							
								                $this->config_resource_type = $this->smarty->default_config_type;
							 | 
						||
| 
								 | 
							
								                $this->config_resource_name = $config_resource;
							 | 
						||
| 
								 | 
							
								            } else {
							 | 
						||
| 
								 | 
							
								                $this->config_resource_type = strtolower($this->config_resource_type);
							 | 
						||
| 
								 | 
							
								            } 
							 | 
						||
| 
								 | 
							
								        } 
							 | 
						||
| 
								 | 
							
								        return true;
							 | 
						||
| 
								 | 
							
								    } 
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    /*
							 | 
						||
| 
								 | 
							
								     * get system filepath to config
							 | 
						||
| 
								 | 
							
								     */
							 | 
						||
| 
								 | 
							
								    public function buildConfigFilepath ()
							 | 
						||
| 
								 | 
							
								    {
							 | 
						||
| 
								 | 
							
								        foreach((array)$this->smarty->config_dir as $_config_dir) {
							 | 
						||
| 
								 | 
							
								            if (substr($_config_dir, -1) != DIRECTORY_SEPARATOR) {
							 | 
						||
| 
								 | 
							
								                $_config_dir .= DIRECTORY_SEPARATOR;
							 | 
						||
| 
								 | 
							
								            } 
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								            $_filepath = $_config_dir . $this->config_resource_name;
							 | 
						||
| 
								 | 
							
								            if (file_exists($_filepath))
							 | 
						||
| 
								 | 
							
								                return $_filepath;
							 | 
						||
| 
								 | 
							
								        } 
							 | 
						||
| 
								 | 
							
								        // no tpl file found
							 | 
						||
| 
								 | 
							
								        throw new Exception("Unable to load config file \"{$this->config_resource_name}\"");
							 | 
						||
| 
								 | 
							
								        return false;
							 | 
						||
| 
								 | 
							
								    } 
							 | 
						||
| 
								 | 
							
								    /**
							 | 
						||
| 
								 | 
							
								    * Read config file source
							 | 
						||
| 
								 | 
							
								    * 
							 | 
						||
| 
								 | 
							
								    * @return string content of source file
							 | 
						||
| 
								 | 
							
								    */
							 | 
						||
| 
								 | 
							
								    /**
							 | 
						||
| 
								 | 
							
								    * Returns the template source code
							 | 
						||
| 
								 | 
							
								    * 
							 | 
						||
| 
								 | 
							
								    * The template source is being read by the actual resource handler
							 | 
						||
| 
								 | 
							
								    * 
							 | 
						||
| 
								 | 
							
								    * @return string the template source
							 | 
						||
| 
								 | 
							
								    */
							 | 
						||
| 
								 | 
							
								    public function getConfigSource ()
							 | 
						||
| 
								 | 
							
								    {
							 | 
						||
| 
								 | 
							
								        if ($this->config_source === null) {
							 | 
						||
| 
								 | 
							
								            if ($this->readConfigSource($this) === false) {
							 | 
						||
| 
								 | 
							
								                throw new Exception("Unable to load config file \"{$this->config_resource_name}\"");
							 | 
						||
| 
								 | 
							
								            } 
							 | 
						||
| 
								 | 
							
								        } 
							 | 
						||
| 
								 | 
							
								        return $this->config_source;
							 | 
						||
| 
								 | 
							
								    } 
							 | 
						||
| 
								 | 
							
								    public function readConfigSource()
							 | 
						||
| 
								 | 
							
								    { 
							 | 
						||
| 
								 | 
							
								        // read source file
							 | 
						||
| 
								 | 
							
								        if (file_exists($this->getConfigFilepath())) {
							 | 
						||
| 
								 | 
							
								            $this->config_source = file_get_contents($this->getConfigFilepath());
							 | 
						||
| 
								 | 
							
								            return true;
							 | 
						||
| 
								 | 
							
								        } else {
							 | 
						||
| 
								 | 
							
								            return false;
							 | 
						||
| 
								 | 
							
								        } 
							 | 
						||
| 
								 | 
							
								    } 
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    /**
							 | 
						||
| 
								 | 
							
								    * Returns the compiled  filepath
							 | 
						||
| 
								 | 
							
								    * 
							 | 
						||
| 
								 | 
							
								    * @return string the compiled filepath
							 | 
						||
| 
								 | 
							
								    */
							 | 
						||
| 
								 | 
							
								    public function getCompiledFilepath ()
							 | 
						||
| 
								 | 
							
								    {
							 | 
						||
| 
								 | 
							
								        return $this->compiled_filepath === null ?
							 | 
						||
| 
								 | 
							
								        ($this->compiled_filepath = $this->buildCompiledFilepath()) :
							 | 
						||
| 
								 | 
							
								        $this->compiled_filepath;
							 | 
						||
| 
								 | 
							
								    } 
							 | 
						||
| 
								 | 
							
								    public function buildCompiledFilepath()
							 | 
						||
| 
								 | 
							
								    {
							 | 
						||
| 
								 | 
							
								        $_filepath = md5($this->config_resource_name); 
							 | 
						||
| 
								 | 
							
								        // if use_sub_dirs, break file into directories
							 | 
						||
| 
								 | 
							
								        if ($this->smarty->use_sub_dirs) {
							 | 
						||
| 
								 | 
							
								            $_filepath = substr($_filepath, 0, 3) . DIRECTORY_SEPARATOR
							 | 
						||
| 
								 | 
							
								             . substr($_filepath, 0, 2) . DIRECTORY_SEPARATOR
							 | 
						||
| 
								 | 
							
								             . substr($_filepath, 0, 1) . DIRECTORY_SEPARATOR
							 | 
						||
| 
								 | 
							
								             . $_filepath;
							 | 
						||
| 
								 | 
							
								        } 
							 | 
						||
| 
								 | 
							
								        $_compile_dir = $this->smarty->compile_dir;
							 | 
						||
| 
								 | 
							
								        if (substr($_compile_dir, -1) != DIRECTORY_SEPARATOR) {
							 | 
						||
| 
								 | 
							
								            $_compile_dir .= DIRECTORY_SEPARATOR;
							 | 
						||
| 
								 | 
							
								        } 
							 | 
						||
| 
								 | 
							
								        return $_compile_dir . $_filepath . '.' . basename($this->config_resource_name) . '.config' . $this->smarty->php_ext;
							 | 
						||
| 
								 | 
							
								    } 
							 | 
						||
| 
								 | 
							
								    /**
							 | 
						||
| 
								 | 
							
								    * Returns the timpestamp of the compiled file
							 | 
						||
| 
								 | 
							
								    * 
							 | 
						||
| 
								 | 
							
								    * @return integer the file timestamp
							 | 
						||
| 
								 | 
							
								    */
							 | 
						||
| 
								 | 
							
								    public function getCompiledTimestamp ()
							 | 
						||
| 
								 | 
							
								    {
							 | 
						||
| 
								 | 
							
								        return $this->compiled_timestamp === null ?
							 | 
						||
| 
								 | 
							
								        ($this->compiled_timestamp = (file_exists($this->getCompiledFilepath())) ? filemtime($this->getCompiledFilepath()) : false) :
							 | 
						||
| 
								 | 
							
								        $this->compiled_timestamp;
							 | 
						||
| 
								 | 
							
								    } 
							 | 
						||
| 
								 | 
							
								    /**
							 | 
						||
| 
								 | 
							
								    * Returns if the current config file must be compiled 
							 | 
						||
| 
								 | 
							
								    * 
							 | 
						||
| 
								 | 
							
								    * It does compare the timestamps of config source and the compiled config and checks the force compile configuration
							 | 
						||
| 
								 | 
							
								    * 
							 | 
						||
| 
								 | 
							
								    * @return boolean true if the file must be compiled
							 | 
						||
| 
								 | 
							
								    */
							 | 
						||
| 
								 | 
							
								    public function mustCompile ()
							 | 
						||
| 
								 | 
							
								    {
							 | 
						||
| 
								 | 
							
								        return $this->mustCompile === null ?
							 | 
						||
| 
								 | 
							
								        $this->mustCompile = ($this->smarty->force_compile || $this->getCompiledTimestamp () !== $this->getTimestamp ()):
							 | 
						||
| 
								 | 
							
								        $this->mustCompile;
							 | 
						||
| 
								 | 
							
								    } 
							 | 
						||
| 
								 | 
							
								    /**
							 | 
						||
| 
								 | 
							
								    * Returns the compiled config file 
							 | 
						||
| 
								 | 
							
								    * 
							 | 
						||
| 
								 | 
							
								    * It checks if the config file must be compiled or just read the compiled version
							 | 
						||
| 
								 | 
							
								    * 
							 | 
						||
| 
								 | 
							
								    * @return string the compiled config file
							 | 
						||
| 
								 | 
							
								    */
							 | 
						||
| 
								 | 
							
								    public function getCompiledConfig ()
							 | 
						||
| 
								 | 
							
								    {
							 | 
						||
| 
								 | 
							
								        if ($this->compiled_config === null) {
							 | 
						||
| 
								 | 
							
								            // see if template needs compiling.
							 | 
						||
| 
								 | 
							
								            if ($this->mustCompile()) {
							 | 
						||
| 
								 | 
							
								                $this->compileConfigSource();
							 | 
						||
| 
								 | 
							
								            } else {
							 | 
						||
| 
								 | 
							
								                $this->compiled_config = file_get_contents($this->getCompiledFilepath());
							 | 
						||
| 
								 | 
							
								            } 
							 | 
						||
| 
								 | 
							
								        } 
							 | 
						||
| 
								 | 
							
								        return $this->compiled_config;
							 | 
						||
| 
								 | 
							
								    } 
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    /**
							 | 
						||
| 
								 | 
							
								    * Compiles the config files
							 | 
						||
| 
								 | 
							
								    */
							 | 
						||
| 
								 | 
							
								    public function compileConfigSource ()
							 | 
						||
| 
								 | 
							
								    { 
							 | 
						||
| 
								 | 
							
								        // compile template
							 | 
						||
| 
								 | 
							
								        if (!is_object($this->compiler_object)) {
							 | 
						||
| 
								 | 
							
								            // load compiler
							 | 
						||
| 
								 | 
							
								            $this->smarty->loadPlugin('Smarty_Internal_Config_File_Compiler');
							 | 
						||
| 
								 | 
							
								            $this->compiler_object = new Smarty_Internal_Config_File_Compiler;
							 | 
						||
| 
								 | 
							
								        } 
							 | 
						||
| 
								 | 
							
								        if (!is_object($this->smarty->write_file_object)) {
							 | 
						||
| 
								 | 
							
								            $this->smarty->loadPlugin("Smarty_Internal_Write_File");
							 | 
						||
| 
								 | 
							
								            $this->smarty->write_file_object = new Smarty_Internal_Write_File;
							 | 
						||
| 
								 | 
							
								        } 
							 | 
						||
| 
								 | 
							
								        // call compiler
							 | 
						||
| 
								 | 
							
								        if ($this->compiler_object->compileSource($this)) {
							 | 
						||
| 
								 | 
							
								            // compiling succeded
							 | 
						||
| 
								 | 
							
								            // write compiled template
							 | 
						||
| 
								 | 
							
								            $this->smarty->write_file_object->writeFile($this->getCompiledFilepath(), $this->getCompiledConfig()); 
							 | 
						||
| 
								 | 
							
								            // make template and compiled file timestamp match
							 | 
						||
| 
								 | 
							
								            touch($this->getCompiledFilepath(), $this->getTimestamp());
							 | 
						||
| 
								 | 
							
								        } else {
							 | 
						||
| 
								 | 
							
								            // error compiling template
							 | 
						||
| 
								 | 
							
								            throw new Exception("Error compiling template {$this->getConfigFilepath ()}");
							 | 
						||
| 
								 | 
							
								            return false;
							 | 
						||
| 
								 | 
							
								        } 
							 | 
						||
| 
								 | 
							
								    } 
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    /*
							 | 
						||
| 
								 | 
							
								     * load config variables
							 | 
						||
| 
								 | 
							
								    *
							 | 
						||
| 
								 | 
							
								    * @param mixed $sections array of section names, single section or null
							 | 
						||
| 
								 | 
							
								    * @param object $scope global,parent or local
							 | 
						||
| 
								 | 
							
								    */
							 | 
						||
| 
								 | 
							
								    public function loadConfigVars ($sections = null, $scope)
							 | 
						||
| 
								 | 
							
								    {
							 | 
						||
| 
								 | 
							
								        $config_data = unserialize($this->getCompiledConfig());
							 | 
						||
| 
								 | 
							
								        // var_dump($config_data); 
							 | 
						||
| 
								 | 
							
								        // copy global config vars
							 | 
						||
| 
								 | 
							
								        foreach ($config_data['vars'] as $variable => $value) {
							 | 
						||
| 
								 | 
							
								            $scope->config_vars[$variable] = $value;
							 | 
						||
| 
								 | 
							
								        } 
							 | 
						||
| 
								 | 
							
								        // scan sections
							 | 
						||
| 
								 | 
							
								        foreach ($config_data['sections'] as $this_section => $dummy) {
							 | 
						||
| 
								 | 
							
								            if ($sections == null || in_array($this_section, (array)$sections)) {
							 | 
						||
| 
								 | 
							
								                foreach ($config_data['sections'][$this_section]['vars'] as $variable => $value) {
							 | 
						||
| 
								 | 
							
								                    $scope->config_vars[$variable] = $value;
							 | 
						||
| 
								 | 
							
								                } 
							 | 
						||
| 
								 | 
							
								            } 
							 | 
						||
| 
								 | 
							
								        } 
							 | 
						||
| 
								 | 
							
								    } 
							 | 
						||
| 
								 | 
							
								} 
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								?>
							 |