IniReader.php

<?php
/**
 * IniReader
 *
 * PHP 5
 *
 * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
 * Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
 *
 * Licensed under The MIT License
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright     Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
 * @link          http://cakephp.org CakePHP(tm) Project
 * @package       Cake.Configure
 * @since         CakePHP(tm) v 2.0
 * @license       MIT License (http://www.opensource.org/licenses/mit-license.php)
 */
namespace Cake\Configure;

use Cake\Core\App;
use Cake\Error;
use Cake\Utility\Hash;

/**
 * Ini file configuration engine.
 *
 * Since IniReader uses parse_ini_file underneath, you should be aware that this
 * class shares the same behavior, especially with regards to boolean and null values.
 *
 * In addition to the native `parse_ini_file` features, IniReader also allows you
 * to create nested array structures through usage of `.` delimited names.  This allows
 * you to create nested arrays structures in an ini config file. For example:
 *
 * `db.password = secret` would turn into `array('db' => array('password' => 'secret'))`
 *
 * You can nest properties as deeply as needed using `.`'s. In addition to using `.` you
 * can use standard ini section notation to create nested structures:
 *
 * {{{
 * [section]
 * key = value
 * }}}
 *
 * Once loaded into Configure, the above would be accessed using:
 *
 * `Configure::read('section.key');
 *
 * You can combine `.` separated values with sections to create more deeply
 * nested structures.
 *
 * IniReader also manipulates how the special ini values of
 * 'yes', 'no', 'on', 'off', 'null' are handled. These values will be
 * converted to their boolean equivalents.
 *
 * @package       Cake.Configure
 * @see http://php.net/parse_ini_file
 */
class IniReader implements ConfigReaderInterface {

/**
 * The path to read ini files from.
 *
 * @var array
 */
	protected $_path;

/**
 * The section to read, if null all sections will be read.
 *
 * @var string
 */
	protected $_section;

/**
 * Build and construct a new ini file parser. The parser can be used to read
 * ini files that are on the filesystem.
 *
 * @param string $path Path to load ini config files from. Defaults to APP . 'Config' . DS
 * @param string $section Only get one section, leave null to parse and fetch
 *     all sections in the ini file.
 */
	public function __construct($path = null, $section = null) {
		if (!$path) {
			$path = APP . 'Config/';
		}
		$this->_path = $path;
		$this->_section = $section;
	}

/**
 * Read an ini file and return the results as an array.
 *
 * For backwards compatibility, acl.ini.php will be treated specially until 3.0.
 *
 * @param string $key The identifier to read from. If the key has a . it will be treated
 *  as a plugin prefix. The chosen file must be on the reader's path.
 * @return array Parsed configuration values.
 * @throws Cake\Error\ConfigureException when files don't exist.
 *  Or when files contain '..' as this could lead to abusive reads.
 */
	public function read($key) {
		if (strpos($key, '..') !== false) {
			throw new Error\ConfigureException(__d('cake_dev', 'Cannot load configuration files with ../ in them.'));
		}
		if (substr($key, -8) === '.ini.php') {
			$key = substr($key, 0, -8);
			list($plugin, $key) = pluginSplit($key);
			$key .= '.ini.php';
		} else {
			if (substr($key, -4) === '.ini') {
				$key = substr($key, 0, -4);
			}
			list($plugin, $key) = pluginSplit($key);
			$key .= '.ini';
		}

		if ($plugin) {
			$file = App::pluginPath($plugin) . 'Config/' . $key;
		} else {
			$file = $this->_path . $key;
		}
		if (!is_file($file)) {
			throw new Error\ConfigureException(__d('cake_dev', 'Could not load configuration file: %s', $file));
		}

		$contents = parse_ini_file($file, true);
		if (!empty($this->_section) && isset($contents[$this->_section])) {
			$values = $this->_parseNestedValues($contents[$this->_section]);
		} else {
			$values = array();
			foreach ($contents as $section => $attribs) {
				if (is_array($attribs)) {
					$values[$section] = $this->_parseNestedValues($attribs);
				} else {
					$parse = $this->_parseNestedValues(array($attribs));
					$values[$section] = array_shift($parse);
				}
			}
		}
		return $values;
	}

/**
 * parses nested values out of keys.
 *
 * @param array $values Values to be exploded.
 * @return array Array of values exploded
 */
	protected function _parseNestedValues($values) {
		foreach ($values as $key => $value) {
			if ($value === '1') {
				$value = true;
			}
			if ($value === '') {
				$value = false;
			}
			unset($values[$key]);
			if (strpos($key, '.') !== false) {
				$values = Hash::insert($values, $key, $value);
			} else {
				$values[$key] = $value;
			}
		}
		return $values;
	}

/**
 * Dumps the state of Configure data into an ini formatted string.
 *
 * @param string $filename The filename on $this->_path to save into.
 * 	Extension ".ini" will be automatically appended if not included in filename.
 * @param array $data The data to convert to ini file.
 * @return int Bytes saved.
 */
	public function dump($filename, $data) {
		$result = array();
		foreach ($data as $key => $value) {
			$isSection = false;
			if ($key[0] != '[') {
				$result[] = "[$key]";
				$isSection = true;
			}
			if (is_array($value)) {
				$keyValues = Hash::flatten($value, '.');
				foreach ($keyValues as $k => $v) {
					$result[] = "$k = " . $this->_value($v);
				}
			}
			if ($isSection) {
				$result[] = '';
			}
		}
		$contents = trim(implode("\n", $result));

		if (substr($filename, -4) !== '.ini') {
			$filename .= '.ini';
		}
		return file_put_contents($this->_path . $filename, $contents);
	}

/**
 * Converts a value into the ini equivalent
 *
 * @param mixed $value to export.
 * @return string String value for ini file.
 */
	protected function _value($val) {
		if ($val === null) {
			return 'null';
		}
		if ($val === true) {
			return 'true';
		}
		if ($val === false) {
			return 'false';
		}
		return (string)$val;
	}

}