/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Config_File.class.php

<?php



/**

 * Config_File class.

 *

 * This library is free software; you can redistribute it and/or

 * modify it under the terms of the GNU Lesser General Public

 * License as published by the Free Software Foundation; either

 * version 2.1 of the License, or (at your option) any later version.

 *

 * This library 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

 * Lesser General Public License for more details.

 *

 * You should have received a copy of the GNU Lesser General Public

 * License along with this library; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 *

 * You may contact the author of Config_File by e-mail at:

 * {@link andrei@php.net}

 *

 * The latest version of Config_File can be obtained from:

 * http://smarty.php.net/

 *

 * @link http://smarty.php.net/

 * @version 2.6.0

 * @copyright Copyright: 2001-2003 ispi of Lincoln, Inc.

 * @author Andrei Zmievski <andrei@php.net>

 * @access public

 * @package Smarty

 */



/* $Id: Config_File.class.php,v 1.1 2005/10/17 18:37:39 jeichorn Exp $ */

/**

 * Config file reading class

 * @package Smarty

 */

class Config_File {

    /**#@+

     * Options

     * @var boolean

     */

    /**

     * Controls whether variables with the same name overwrite each other.

     */

    var $overwrite        =    true;



    /**

     * Controls whether config values of on/true/yes and off/false/no get

     * converted to boolean values automatically.

     */

    var $booleanize        =    true;



    /**

     * Controls whether hidden config sections/vars are read from the file.

     */

    var $read_hidden     =    true;



    /**

     * Controls whether or not to fix mac or dos formatted newlines.

     * If set to true, \r or \r\n will be changed to \n.

     */

    var $fix_newlines =    true;

    /**#@-*/



    /** @access private */

    var $_config_path    = "";

    var $_config_data    = array();

    /**#@-*/



    /**

     * Constructs a new config file class.

     *

     * @param string $config_path (optional) path to the config files

     */

    function Config_File($config_path = NULL)

    {

        if (isset($config_path))

            $this->set_path($config_path);

    }





    /**

     * Set the path where configuration files can be found.

     *

     * @param string $config_path path to the config files

     */

    function set_path($config_path)

    {

        if (!empty($config_path)) {

            if (!is_string($config_path) || !file_exists($config_path) || !is_dir($config_path)) {

                $this->_trigger_error_msg("Bad config file path '$config_path'");

                return;

            }

            if(substr($config_path, -1) != DIRECTORY_SEPARATOR) {

                $config_path .= DIRECTORY_SEPARATOR;

            }



            $this->_config_path = $config_path;

        }

    }





    /**

     * Retrieves config info based on the file, section, and variable name.

     *

     * @param string $file_name config file to get info for

     * @param string $section_name (optional) section to get info for

     * @param string $var_name (optional) variable to get info for

     * @return string|array a value or array of values

     */

    function &get($file_name, $section_name = NULL, $var_name = NULL)

    {

        if (empty($file_name)) {

            $this->_trigger_error_msg('Empty config file name');

            return;

        } else {

            $file_name = $this->_config_path . $file_name;

            if (!isset($this->_config_data[$file_name]))

                $this->load_file($file_name, false);

        }



        if (!empty($var_name)) {

            if (empty($section_name)) {

                return $this->_config_data[$file_name]["vars"][$var_name];

            } else {

                if(isset($this->_config_data[$file_name]["sections"][$section_name]["vars"][$var_name]))

                    return $this->_config_data[$file_name]["sections"][$section_name]["vars"][$var_name];

                else

                    return array();

            }

        } else {

            if (empty($section_name)) {

                return (array)$this->_config_data[$file_name]["vars"];

            } else {

                if(isset($this->_config_data[$file_name]["sections"][$section_name]["vars"]))

                    return (array)$this->_config_data[$file_name]["sections"][$section_name]["vars"];

                else

                    return array();

            }

        }

    }





    /**

     * Retrieves config info based on the key.

     *

     * @param $file_name string config key (filename/section/var)

     * @return string|array same as get()

     * @uses get() retrieves information from config file and returns it

     */

    function &get_key($config_key)

    {

        list($file_name, $section_name, $var_name) = explode('/', $config_key, 3);

        $result = &$this->get($file_name, $section_name, $var_name);

        return $result;

    }



    /**

     * Get all loaded config file names.

     *

     * @return array an array of loaded config file names

     */

    function get_file_names()

    {

        return array_keys($this->_config_data);

    }





    /**

     * Get all section names from a loaded file.

     *

     * @param string $file_name config file to get section names from

     * @return array an array of section names from the specified file

     */

    function get_section_names($file_name)

    {

        $file_name = $this->_config_path . $file_name;

        if (!isset($this->_config_data[$file_name])) {

            $this->_trigger_error_msg("Unknown config file '$file_name'");

            return;

        }



        return array_keys($this->_config_data[$file_name]["sections"]);

    }





    /**

     * Get all global or section variable names.

     *

     * @param string $file_name config file to get info for

     * @param string $section_name (optional) section to get info for

     * @return array an array of variables names from the specified file/section

     */

    function get_var_names($file_name, $section = NULL)

    {

        if (empty($file_name)) {

            $this->_trigger_error_msg('Empty config file name');

            return;

        } else if (!isset($this->_config_data[$file_name])) {

            $this->_trigger_error_msg("Unknown config file '$file_name'");

            return;

        }



        if (empty($section))

            return array_keys($this->_config_data[$file_name]["vars"]);

        else

            return array_keys($this->_config_data[$file_name]["sections"][$section]["vars"]);

    }





    /**

     * Clear loaded config data for a certain file or all files.

     *

     * @param string $file_name file to clear config data for

     */

    function clear($file_name = NULL)

    {

        if ($file_name === NULL)

            $this->_config_data = array();

        else if (isset($this->_config_data[$file_name]))

            $this->_config_data[$file_name] = array();

    }





    /**

     * Load a configuration file manually.

     *

     * @param string $file_name file name to load

     * @param boolean $prepend_path whether current config path should be

     *                              prepended to the filename

     */

    function load_file($file_name, $prepend_path = true)

    {

        if ($prepend_path && $this->_config_path != "")

            $config_file = $this->_config_path . $file_name;

        else

            $config_file = $file_name;



        ini_set('track_errors', true);

        $fp = @fopen($config_file, "r");

        if (!is_resource($fp)) {

            $this->_trigger_error_msg("Could not open config file '$config_file'");

            return false;

        }



        $contents = fread($fp, filesize($config_file));

        fclose($fp);



        if($this->fix_newlines) {

            // fix mac/dos formatted newlines

            $contents = preg_replace('!\r\n?!',"\n",$contents);

        }



        $config_data = array();



        /* replace all multi-line values by placeholders */

        if (preg_match_all('/"""(.*)"""/Us', $contents, $match)) {

            $_triple_quotes = $match[1];

            $_i = 0;

            $contents = preg_replace('/""".*"""/Use', '"\x1b\x1b\x1b".$_i++."\x1b\x1b\x1b"', $contents);

        } else {

            $_triple_quotes = null;

        }



        /* Get global variables first. */

        if ($contents{0} != '[' && preg_match("/^(.*?)(\n\[|\Z)/s", $contents, $match))

            $config_data["vars"] = $this->_parse_config_block($match[1], $_triple_quotes);



        /* Get section variables. */

        $config_data["sections"] = array();

        preg_match_all("/^\[(.*?)\]/m", $contents, $match);

        foreach ($match[1] as $section) {

            if ($section{0} == '.' && !$this->read_hidden)

                continue;

            if (preg_match("/\[".preg_quote($section, '/')."\](.*?)(\n\[|\Z)/s", $contents, $match))

                if ($section{0} == '.')

                    $section = substr($section, 1);

                $config_data["sections"][$section]["vars"] = $this->_parse_config_block($match[1], $_triple_quotes);

        }



        $this->_config_data[$config_file] = $config_data;



        return true;

    }



    /**#@+ @access private */

    /**

     * @var string $config_block

     */

    function _parse_config_block($config_block, $triple_quotes)

    {

        $vars = array();



        /* First we grab the multi-line values. */

        if (preg_match_all("/^([^=\n]+)=\s*\x1b\x1b\x1b(\d+)\x1b\x1b\x1b\s*$/ms", $config_block, $match, PREG_SET_ORDER)) {

            for ($i = 0; $i < count($match); $i++) {

                $this->_set_config_var($vars, trim($match[$i][1]), $triple_quotes[$match[$i][2]], false);

            }

            $config_block = preg_replace("/^[^=\n]+=\s*\x1b\x1b\x1b\d+\x1b\x1b\x1b\s*$/ms", "", $config_block);

        }





        $config_lines = preg_split("/\n+/", $config_block);



        foreach ($config_lines as $line) {

            if (preg_match("/^\s*(\.?\w+)\s*=(.*)/", $line, $match)) {

                $var_value = preg_replace('/^([\'"])(.*)\1$/', '\2', trim($match[2]));

                $this->_set_config_var($vars, trim($match[1]), $var_value, $this->booleanize);

            }

        }



        return $vars;

    }



    /**

     * @param array &$container

     * @param string $var_name

     * @param mixed $var_value

     * @param boolean $booleanize determines whether $var_value is converted to

     *                            to true/false

     */

    function _set_config_var(&$container, $var_name, $var_value, $booleanize)

    {

        if ($var_name{0} == '.') {

            if (!$this->read_hidden)

                return;

            else

                $var_name = substr($var_name, 1);

        }



        if (!preg_match("/^[a-zA-Z_]\w*$/", $var_name)) {

            $this->_trigger_error_msg("Bad variable name '$var_name'");

            return;

        }



        if ($booleanize) {

            if (preg_match("/^(on|true|yes)$/i", $var_value))

                $var_value = true;

            else if (preg_match("/^(off|false|no)$/i", $var_value))

                $var_value = false;

        }



        if (!isset($container[$var_name]) || $this->overwrite)

            $container[$var_name] = $var_value;

        else {

            settype($container[$var_name], 'array');

            $container[$var_name][] = $var_value;

        }

    }



    /**

     * @uses trigger_error() creates a PHP warning/error

     * @param string $error_msg

     * @param integer $error_type one of

     */

    function _trigger_error_msg($error_msg, $error_type = E_USER_WARNING)

    {

        trigger_error("Config_File error: $error_msg", $error_type);

    }

    /**#@-*/

}



?>