class.ilIniFile.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */
 
 
class ilIniFile
{
        var $INI_FILE_NAME = "";
 
        var $ERROR = "";
 
        var $GROUPS = array();
 
        var $CURRENT_GROUP = "";
 
        function __construct($a_ini_file_name)
        {
                //check if a filename is given
                if (empty($a_ini_file_name))
                {
                        $this->error("no_file_given");
                        return false;
                }
 
                $this->INI_FILE_NAME = $a_ini_file_name;
                return true;
        }
 
        function read()
        {
                //check if file exists
                if (!file_exists($this->INI_FILE_NAME))
                {
                        $this->error("file_does_not_exist");
                        return false;
                }
                else
                {
                        //parse the file
                        if ($this->parse() == false)
                        {
                                return false;
                        }
                }
 
                return true;
        }
 
        function parse()
        {
                //use php4 function parse_ini_file
                $this->GROUPS = @parse_ini_file($this->INI_FILE_NAME, true);
 
                //check if groups are filled
                if ($this->GROUPS == false)
                {
                        // second try
                        $this->fixIniFile();
                        
                        $this->GROUPS = @parse_ini_file($this->INI_FILE_NAME, true);
                        if ($this->GROUPS == false)
                        {
                                $this->error("file_not_accessible");
                                return false;
                        }
                }
                //set current group
                $temp = array_keys($this->GROUPS);
                $this->CURRENT_GROUP = $temp[count($temp)-1];
                return true;
                
        }
 
        function fixIniFile()
        {
                // first read content
                $lines = array();
                $fp = @fopen($this->INI_FILE_NAME,"r");
                while (!feof($fp))
                {
                        $l = fgets($fp, 4096);
                        $skip = false;
                        if ((substr($l, 0, 2) == "/*" && $starttag) ||
                                substr($l, 0, 5) == "*/ ?>")
                        {
                                $skip = true;
                        }
                        $starttag = false;
                        if (substr($l, 0, 5) == "<?php")
                        {
                                $l = "; <?php exit; ?>";
                                $starttag = true; 
                        }
                        if (!$skip)
                        {
                                $l = str_replace("\n", "", $l);
                                $l = str_replace("\r", "", $l);
                                $lines[] = $l;
                        }
                }
                fclose($fp);
                
                // now write it back
                $fp = @fopen($this->INI_FILE_NAME,"w");
                
                if (!empty($fp))
                {
                        foreach ($lines as $l)
                        {
                                fwrite($fp, $l."\r\n");
                        }
                }
                fclose($fp);
                
        }
        
        function write()
        {
                $fp = @fopen($this->INI_FILE_NAME,"w");
                
                if (empty($fp))
                {
                        $this->error("Cannot create file $this->INI_FILE_NAME");
                        return false;
                }
                
                //write php tags (security issue)
                $result = fwrite($fp, "; <?php exit; ?>\r\n");
 
                $groups = $this->readGroups();
                $group_cnt = count($groups);
                
                for ($i=0; $i<$group_cnt; $i++)
                {
                        $group_name = $groups[$i];
                        //prevent empty line at beginning of ini-file
                        if ($i==0)
                        {
                                $res = sprintf("[%s]\r\n",$group_name);
                        }
                        else
                        {
                                $res = sprintf("\r\n[%s]\r\n",$group_name);
                        }
                        
                        $result = fwrite($fp, $res);
                        $group = $this->readGroup($group_name);
                        
                        for (reset($group); $key=key($group);next($group))
                        {
                                $res = sprintf("%s = %s\r\n",$key,"\"".$group[$key]."\"");
                                $result = fwrite($fp,$res);
                        }
                }
                
                
                fclose($fp);
 
                return true;
        }
 
        function show()
        {
                $groups = $this->readGroups();
                $group_cnt = count($groups);
                
                //clear content
                $content = "";
                
                // go through all groups
                for ($i=0; $i<$group_cnt; $i++)
                {
                        $group_name = $groups[$i];
                        //prevent empty line at beginning of ini-file
                        if ($i==0)
                        {
                                $content = sprintf("[%s]\n",$group_name);
                        }
                        else
                        {
                                $content .= sprintf("\n[%s]\n",$group_name);
                        }
 
                        $group = $this->readGroup($group_name);
                        
                        //go through group an display all variables
                        for (reset($group); $key=key($group);next($group))
                        {
                                $content .= sprintf("%s = %s\n",$key,$group[$key]);
                        }
                }
 
                return $content;
        }
        
        function getGroupCount()
        {
                return count($this->GROUPS);
        }
        
        function readGroups()
        {
                $groups = array();
 
                for (reset($this->GROUPS);$key=key($this->GROUPS);next($this->GROUPS))
                {
                        $groups[]=$key;
                }
 
                return $groups;
        }
        
        function groupExists($a_group_name)
        {
                if (!isset($this->GROUPS[$a_group_name]))
                {
                        return false;
                }
                
                return true;
        }
        
        function readGroup($a_group_name)
        {
                if (!$this->groupExists($a_group_name))
                {
                        $this->error("Group '".$a_group_name."' does not exist");
                        return false;           
                }
                
                return $this->GROUPS[$a_group_name];
        }
        
        function addGroup($a_group_name)
        {
                if ($this->groupExists($a_group_name))
                {
                        $this->error("Group '".$a_group_name."' exists");
                        return false;           
                }
 
                $this->GROUPS[$a_group_name] = array();
                return true;
        }
        
        function removeGroup($a_group_name)
        {
                if (!$this->groupExists($a_group_name))
                {
                        $this->error("Group '".$a_group_name."' does not exist");
                        return false;           
                }
 
                unset($this->GROUPS[$a_group_name]);
                return true;
        }
 
        function variableExists($a_group, $a_var_name) 
        {
            return isset($this->GROUPS[$a_group][$a_var_name]);
        }
        
        
        function readVariable($a_group, $a_var_name)
        {
                if (!isset($this->GROUPS[$a_group][$a_var_name]))
                {
                        $this->error("'".$a_var_name."' does not exist in '".$a_group."'");
                        return false;
                }
                
                return trim($this->GROUPS[$a_group][$a_var_name]);
        }
        
        function setVariable($a_group_name, $a_var_name, $a_var_value)
        {
                if (!$this->groupExists($a_group_name))
                {
                        $this->error("Group '".$a_group_name."' does not exist");
                        return false;   
                }
                
                $this->GROUPS[$a_group_name][$a_var_name] = $a_var_value;
                return true;
        }       
        
        function error($a_errmsg)
        {
                $this->ERROR = $a_errmsg;
 
                return true;
        }
        
        function getError()
        {
                return $this->ERROR;
        }
} //END class.ilIniFile
?>