Config_File - Code Metrics - adamjakab/SuiteCRM - Measure and Improve Code Quality continuously with Scrutinizer

Config_File C
last analyzed 2016-05-10 08:39 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	351
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

Metric	Value
dl	0
loc	351
ccs	0
cts	202
cp	0
rs	6.8
wmc	55
lcom	1
cbo	0

13 Methods

Rating	Name	Size	Complexity
A	__construct()	5	2
B	set_path()	14	6
C	get()	31	8
A	get_key()	6	1
A	get_file_names()	4	1
A	get_section_names()	10	2
A	get_var_names()	15	4
A	clear()	7	3
A	load_file()	17	4
A	set_file_contents()	5	1
C	parse_contents()	72	13
D	_set_config_var()	28	9
A	_trigger_error_msg()	4	1

How to fix Complexity

<?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
 *
 * For questions, help, comments, discussion, etc., please join the
 * Smarty mailing list. Send a blank e-mail to
 * [email protected] 
 *
 * @link http://www.smarty.net/
 * @version 2.6.29
 * @copyright Copyright: 2001-2005 New Digital Group, Inc.
 * @author Andrei Zmievski <[email protected]>
 * @access public
 * @package Smarty
 */

/* $Id$ */

/**
 * 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
     */
    public function __construct($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
/**
 * @param array $germany
 * @param array $ireland
 */
function finale($germany, $island) {
    return "2:1";
}
     * @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);
        $contents = @sugar_file_get_contents($config_file);
        if ($contents === false) {
            $this->_trigger_error_msg("Could not open config file '$config_file'");
            return false;
        }

        $this->_config_data[$config_file] = $this->parse_contents($contents);
        return true;
    }

    /**
     * Store the contents of a file manually.
     *
     * @param string $config_file file name of the related contents
     * @param string $contents the file-contents to parse
     */
    function set_file_contents($config_file, $contents)
    {
        $this->_config_data[$config_file] = $this->parse_contents($contents);
        return true;
    }

    /**
     * parse the source of a configuration file manually.
     *
     * @param string $contents the file-contents to parse
     */
    function parse_contents($contents)
    {
        if($this->fix_newlines) {
            // fix mac/dos formatted newlines
            $contents = preg_replace('!\r\n?!', "\n", $contents);
        }

        $config_data = array();
        $config_data['sections'] = array();
        $config_data['vars'] = array();

        /* reference to fill with data */
        $vars =& $config_data['vars'];

        /* parse file line by line */
        preg_match_all('!^.*\r?\n?!m', $contents, $match);
        $lines = $match[0];
        for ($i=0, $count=count($lines); $i<$count; $i++) {
            $line = $lines[$i];
            if (empty($line)) continue;

            if ( substr($line, 0, 1) == '[' && preg_match('!^\[(.*?)\]!', $line, $match) ) {
                /* section found */
                if (substr($match[1], 0, 1) == '.') {
                    /* hidden section */
                    if ($this->read_hidden) {
                        $section_name = substr($match[1], 1);
                    } else {
                        /* break reference to $vars to ignore hidden section */
                        unset($vars);
                        $vars = array();
                        continue;
                    }
                } else {                    
                    $section_name = $match[1];
                }
                if (!isset($config_data['sections'][$section_name]))
                    $config_data['sections'][$section_name] = array('vars' => array());
                $vars =& $config_data['sections'][$section_name]['vars'];
                continue;
            }

            if (preg_match('/^\s*(\.?\w+)\s*=\s*(.*)/s', $line, $match)) {
                /* variable found */
                $var_name = rtrim($match[1]);
                if (strpos($match[2], '"""') === 0) {
                    /* handle multiline-value */
                    $lines[$i] = substr($match[2], 3);
                    $var_value = '';
                    while ($i<$count) {
                        if (($pos = strpos($lines[$i], '"""')) === false) {
                            $var_value .= $lines[$i++];
                        } else {
                            /* end of multiline-value */
                            $var_value .= substr($lines[$i], 0, $pos);
                            break;
                        }
                    }
                    $booleanize = false;

                } else {
                    /* handle simple value */
                    $var_value = preg_replace('/^([\'"])(.*)\1$/', '\2', rtrim($match[2]));
                    $booleanize = $this->booleanize;

                }
                $this->_set_config_var($vars, $var_name, $var_value, $booleanize);
            }
            /* else unparsable line / means it is a comment / means ignore it */
        }
        return $config_data;
    }

    /**#@+ @access private */
    /**
     * @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 (substr($var_name, 0, 1) == '.') {
            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);
    }
    /**#@-*/
}

?>


1			<?php
2
3			/**
4			* Config_File class.
5			*
6			* This library is free software; you can redistribute it and/or
7			* modify it under the terms of the GNU Lesser General Public
8			* License as published by the Free Software Foundation; either
9			* version 2.1 of the License, or (at your option) any later version.
10			*
11			* This library is distributed in the hope that it will be useful,
12			* but WITHOUT ANY WARRANTY; without even the implied warranty of
13			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14			* Lesser General Public License for more details.
15			*
16			* You should have received a copy of the GNU Lesser General Public
17			* License along with this library; if not, write to the Free Software
18			* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19			*
20			* For questions, help, comments, discussion, etc., please join the
21			* Smarty mailing list. Send a blank e-mail to
22			* [email protected]
23			*
24			* @link http://www.smarty.net/
25			* @version 2.6.29
26			* @copyright Copyright: 2001-2005 New Digital Group, Inc.
27			* @author Andrei Zmievski <[email protected]>
28			* @access public
29			* @package Smarty
30			*/
31
32			/* $Id$ */
33
34			/**
35			* Config file reading class
36			* @package Smarty
37			*/
38			class Config_File {
39			/**#@+
40			* Options
41			* @var boolean
42			*/
43			/**
44			* Controls whether variables with the same name overwrite each other.
45			*/
46			var $overwrite = true;
47
48			/**
49			* Controls whether config values of on/true/yes and off/false/no get
50			* converted to boolean values automatically.
51			*/
52			var $booleanize = true;
53
54			/**
55			* Controls whether hidden config sections/vars are read from the file.
56			*/
57			var $read_hidden = true;
58
59			/**
60			* Controls whether or not to fix mac or dos formatted newlines.
61			* If set to true, \r or \r\n will be changed to \n.
62			*/
63			var $fix_newlines = true;
64			/*#@-/
65
66			/** @access private */
67			var $_config_path = "";
68			var $_config_data = array();
69			/*#@-/
70
71			/**
72			* Constructs a new config file class.
73			*
74			* @param string $config_path (optional) path to the config files
75			*/
76			public function __construct($config_path = NULL)
77			{
78			if (isset($config_path))
79			$this->set_path($config_path);
80			}
81
82
83			/**
84			* Set the path where configuration files can be found.
85			*
86			* @param string $config_path path to the config files
87			*/
88			function set_path($config_path)
89			{
90			if (!empty($config_path)) {
91			if (!is_string($config_path) \|\| !file_exists($config_path) \|\| !is_dir($config_path)) {
92			$this->_trigger_error_msg("Bad config file path '$config_path'");
93			return;
94			}
95			if(substr($config_path, -1) != DIRECTORY_SEPARATOR) {
96			$config_path .= DIRECTORY_SEPARATOR;
97			}
98
99			$this->_config_path = $config_path;
100			}
101			}
102
103
104			/**
105			* Retrieves config info based on the file, section, and variable name.
106			*
107			* @param string $file_name config file to get info for
108			* @param string $section_name (optional) section to get info for
109			* @param string $var_name (optional) variable to get info for
110			* @return string\|array a value or array of values
111			*/
112			function get($file_name, $section_name = NULL, $var_name = NULL)
113			{
114			if (empty($file_name)) {
115			$this->_trigger_error_msg('Empty config file name');
116			return;
117			} else {
118			$file_name = $this->_config_path . $file_name;
119			if (!isset($this->_config_data[$file_name]))
120			$this->load_file($file_name, false);
121			}
122
123			if (!empty($var_name)) {
124			if (empty($section_name)) {
125			return $this->_config_data[$file_name]["vars"][$var_name];
126			} else {
127			if(isset($this->_config_data[$file_name]["sections"][$section_name]["vars"][$var_name]))
128			return $this->_config_data[$file_name]["sections"][$section_name]["vars"][$var_name];
129			else
130			return array();
131			}
132			} else {
133			if (empty($section_name)) {
134			return (array)$this->_config_data[$file_name]["vars"];
135			} else {
136			if(isset($this->_config_data[$file_name]["sections"][$section_name]["vars"]))
137			return (array)$this->_config_data[$file_name]["sections"][$section_name]["vars"];
138			else
139			return array();
140			}
141			}
142			}
143
144
145			/**
146			* Retrieves config info based on the key.
147			*
148			* @param $file_name string config key (filename/section/var)
149			* @return string\|array same as get()
150			* @uses get() retrieves information from config file and returns it
151			*/
152			function &get_key($config_key)
153			{
154			list($file_name, $section_name, $var_name) = explode('/', $config_key, 3);
155			$result = &$this->get($file_name, $section_name, $var_name);
156			return $result;
157			}
158
159			/**
160			* Get all loaded config file names.
161			*
162			* @return array an array of loaded config file names
163			*/
164			function get_file_names()
165			{
166			return array_keys($this->_config_data);
167			}
168
169
170			/**
171			* Get all section names from a loaded file.
172			*
173			* @param string $file_name config file to get section names from
174			* @return array an array of section names from the specified file
175			*/
176			function get_section_names($file_name)
177			{
178			$file_name = $this->_config_path . $file_name;
179			if (!isset($this->_config_data[$file_name])) {
180			$this->_trigger_error_msg("Unknown config file '$file_name'");
181			return;
182			}
183
184			return array_keys($this->_config_data[$file_name]["sections"]);
185			}
186
187
188			/**
189			* Get all global or section variable names.
190			*
191			* @param string $file_name config file to get info for
192			* @param string $section_name (optional) section to get info for
			0 ignored issues – show Documentation introduced 2016-03-07 17:58 UTC by Report Bug Copy Issue Report There is no parameter named `$section_name`. Did you maybe mean `$section`? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. It has, however, found a similar but not annotated parameter which might be a good fit. Consider the following example. The parameter `$ireland` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $ireland */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was changed, but the annotation was not. Loading history...
193			* @return array an array of variables names from the specified file/section
194			*/
195			function get_var_names($file_name, $section = NULL)
196			{
197			if (empty($file_name)) {
198			$this->_trigger_error_msg('Empty config file name');
199			return;
200			} else if (!isset($this->_config_data[$file_name])) {
201			$this->_trigger_error_msg("Unknown config file '$file_name'");
202			return;
203			}
204
205			if (empty($section))
206			return array_keys($this->_config_data[$file_name]["vars"]);
207			else
208			return array_keys($this->_config_data[$file_name]["sections"][$section]["vars"]);
209			}
210
211
212			/**
213			* Clear loaded config data for a certain file or all files.
214			*
215			* @param string $file_name file to clear config data for
216			*/
217			function clear($file_name = NULL)
218			{
219			if ($file_name === NULL)
220			$this->_config_data = array();
221			else if (isset($this->_config_data[$file_name]))
222			$this->_config_data[$file_name] = array();
223			}
224
225
226			/**
227			* Load a configuration file manually.
228			*
229			* @param string $file_name file name to load
230			* @param boolean $prepend_path whether current config path should be
231			* prepended to the filename
232			*/
233			function load_file($file_name, $prepend_path = true)
234			{
235			if ($prepend_path && $this->_config_path != "")
236			$config_file = $this->_config_path . $file_name;
237			else
238			$config_file = $file_name;
239
240			ini_set('track_errors', true);
241			$contents = @sugar_file_get_contents($config_file);
242			if ($contents === false) {
243			$this->_trigger_error_msg("Could not open config file '$config_file'");
244			return false;
245			}
246
247			$this->_config_data[$config_file] = $this->parse_contents($contents);
248			return true;
249			}
250
251			/**
252			* Store the contents of a file manually.
253			*
254			* @param string $config_file file name of the related contents
255			* @param string $contents the file-contents to parse
256			*/
257			function set_file_contents($config_file, $contents)
258			{
259			$this->_config_data[$config_file] = $this->parse_contents($contents);
260			return true;
261			}
262
263			/**
264			* parse the source of a configuration file manually.
265			*
266			* @param string $contents the file-contents to parse
267			*/
268			function parse_contents($contents)
269			{
270			if($this->fix_newlines) {
271			// fix mac/dos formatted newlines
272			$contents = preg_replace('!\r\n?!', "\n", $contents);
273			}
274
275			$config_data = array();
276			$config_data['sections'] = array();
277			$config_data['vars'] = array();
278
279			/* reference to fill with data */
280			$vars =& $config_data['vars'];
281
282			/* parse file line by line */
283			preg_match_all('!^.*\r?\n?!m', $contents, $match);
284			$lines = $match[0];
285			for ($i=0, $count=count($lines); $i<$count; $i++) {
286			$line = $lines[$i];
287			if (empty($line)) continue;
288
289			if ( substr($line, 0, 1) == '[' && preg_match('!^\[(.*?)\]!', $line, $match) ) {
290			/* section found */
291			if (substr($match[1], 0, 1) == '.') {
292			/* hidden section */
293			if ($this->read_hidden) {
294			$section_name = substr($match[1], 1);
295			} else {
296			/* break reference to $vars to ignore hidden section */
297			unset($vars);
298			$vars = array();
299			continue;
300			}
301			} else {
302			$section_name = $match[1];
303			}
304			if (!isset($config_data['sections'][$section_name]))
305			$config_data['sections'][$section_name] = array('vars' => array());
306			$vars =& $config_data['sections'][$section_name]['vars'];
307			continue;
308			}
309
310			if (preg_match('/^\s(\.?\w+)\s=\s(.)/s', $line, $match)) {
311			/* variable found */
312			$var_name = rtrim($match[1]);
313			if (strpos($match[2], '"""') === 0) {
314			/* handle multiline-value */
315			$lines[$i] = substr($match[2], 3);
316			$var_value = '';
317			while ($i<$count) {
318			if (($pos = strpos($lines[$i], '"""')) === false) {
319			$var_value .= $lines[$i++];
320			} else {
321			/* end of multiline-value */
322			$var_value .= substr($lines[$i], 0, $pos);
323			break;
324			}
325			}
326			$booleanize = false;
327
328			} else {
329			/* handle simple value */
330			$var_value = preg_replace('/^([\'"])(.*)\1$/', '\2', rtrim($match[2]));
331			$booleanize = $this->booleanize;
332
333			}
334			$this->_set_config_var($vars, $var_name, $var_value, $booleanize);
335			}
336			/* else unparsable line / means it is a comment / means ignore it */
337			}
338			return $config_data;
339			}
340
341			/*#@+ @access private /
342			/**
343			* @param array &$container
344			* @param string $var_name
345			* @param mixed $var_value
346			* @param boolean $booleanize determines whether $var_value is converted to
347			* to true/false
348			*/
349			function _set_config_var(&$container, $var_name, $var_value, $booleanize)
350			{
351			if (substr($var_name, 0, 1) == '.') {
352			if (!$this->read_hidden)
353			return;
354			else
355			$var_name = substr($var_name, 1);
356			}
357
358			if (!preg_match("/^[a-zA-Z_]\w*$/", $var_name)) {
359			$this->_trigger_error_msg("Bad variable name '$var_name'");
360			return;
361			}
362
363			if ($booleanize) {
364			if (preg_match("/^(on\|true\|yes)$/i", $var_value))
365			$var_value = true;
366			else if (preg_match("/^(off\|false\|no)$/i", $var_value))
367			$var_value = false;
368			}
369
370			if (!isset($container[$var_name]) \|\| $this->overwrite)
371			$container[$var_name] = $var_value;
372			else {
373			settype($container[$var_name], 'array');
374			$container[$var_name][] = $var_value;
375			}
376			}
377
378			/**
379			* @uses trigger_error() creates a PHP warning/error
380			* @param string $error_msg
381			* @param integer $error_type one of
382			*/
383			function _trigger_error_msg($error_msg, $error_type = E_USER_WARNING)
384			{
385			trigger_error("Config_File error: $error_msg", $error_type);
386			}
387			/*#@-/
388			}
389
390			?>
391

adamjakab / SuiteCRM

Config_File C last analyzed 2016-05-10 08:39 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

13 Methods

How to fix Complexity

Complex Class

Duplication Side-by-Side

Filter issues like

Config_File C
last analyzed 2016-05-10 08:39 UTC