1 <?php
  2 
  3 #######################################################################################
  4 ####
  5 ####    MAGRATHEA PHP
  6 ####    v. 1.0
  7 ####
  8 ####    Magrathea by Paulo Henrique Martins
  9 ####    Platypus technology
 10 ####
 11 #######################################################################################
 12 ####    
 13 ####    created: 2012-12 by Paulo Martins
 14 ####
 15 #######################################################################################
 16 
 17 /**
 18 * This class will provide you the quickest access possible to the magrathea.conf config file.
 19 * 
 20 */
 21 class MagratheaConfig {
 22     private $path = __DIR__;
 23     private $config_file_name = "configs/magrathea.conf";
 24     private $configs = null;
 25     private $environment = null;
 26     protected static $inst = null;
 27 
 28     public static function Instance(){
 29         if(!isset(self::$inst)){
 30             self::$inst = new MagratheaConfig();
 31         }
 32         return self::$inst;
 33     }
 34 
 35     /**
 36     * Function for openning the file specified in `$this->config_file_name`
 37     * actually, it works checking if file exists and throwing an error if don't.
 38     * @throws Magrathea Exception for file not found
 39     */
 40     private function loadFile(){
 41         if(!file_exists($this->path."/".$this->config_file_name)){
 42             die ("Config file could not be found - ".$this->path."/".$this->config_file_name);
 43         }
 44     }
 45 
 46     /**
 47     * set path for config file
 48     * @param string $p Path to the file
 49     * @return itself
 50     */
 51     public function setPath($p){
 52         $this->path = $p;
 53         return $this;
 54     }
 55 
 56     /**
 57     * This function will change the default environment to anything that the users wants to.
 58     * @param string Environment name
 59     * @return itself
 60     */
 61     public function SetDefaultEnvironment($env){
 62         $this->environment = $env;
 63         return $this;
 64     }
 65 
 66     /**
 67     * This function will return the environment being used in the project.
 68     * The environment is defined in `general/use_environment` property and can be defined in the `magrathea.conf` file. 
 69     * @return string Environment name
 70     */
 71     public function GetEnvironment(){
 72         if(!isset($this->environment)){
 73             $this->environment = $this->GetConfig("general/use_environment");
 74         }
 75         return $this->environment;
 76     }
 77 
 78     /**
 79     * `$config_name` can be called to get a parameter from inside a section of the config file. To achieve this, you should use a slash (/) to separate the section from the property.
 80     * If the slash is not used, the function will return the property only if it's on the root.
 81     * If `$config_name` is a section name, the function will return the full section as an Array.
 82     * If `$config_name` is empty, the function will return the full config as an Array (**not recommended!**).
 83     * @param    string      $config_name    Item to be returned from the `magrathea.conf`.
 84     * @return   array or string
 85     * @todo     exception 704 on key does not exists
 86     */
 87     public function GetConfig($config_name=""){
 88         if( $this->configs == null ){
 89             $this->loadFile();
 90             $this->configs = @parse_ini_file($this->path."/".$this->config_file_name, true);
 91             if( !$this->configs ){
 92                 throw new MagratheaConfigException("There was an error trying to load the config file.<br/>");
 93             }
 94         }
 95         if( empty($config_name) ){
 96             return $this->configs;
 97         } else {
 98             $c_split = explode("/", $config_name);
 99             return ( count($c_split) == 1 ? $this->configs[$config_name] : $this->configs[$c_split[0]][$c_split[1]] );
100         }
101     }
102 
103     /**
104      * Alias for GetConfigFromDefault
105      * @param   string  $config_name Item to be returned from the `magrathea.conf`. 
106      * @return  string
107      */
108     public function GetFromDefault($config_name){
109         return $this->GetConfigFromDefault($config_name);
110     }
111     /**
112     * This function will get the $config_name property from `magrathea.conf`.
113     * It will get from the section defined on `general/use_environment`.
114     * @param    string  $config_name Item to be returned from the `magrathea.conf`.
115     * @return   string
116     */
117     public function GetConfigFromDefault($config_name){
118         if( $this->configs == null ){
119             $this->loadFile();
120             $this->configs = @parse_ini_file($this->path."/".$this->config_file_name, true);
121             if( !$this->configs ){
122                 throw new MagratheaException("There was an error trying to load the config file.<br/>");
123             }
124         }
125         $environment = $this->configs["general"]["use_environment"];
126         if(array_key_exists($config_name, $this->configs[$environment])){
127             return $this->configs[$environment][$config_name];
128         } else {
129             throw new MagratheaConfigException("Key ".$config_name." does not exist in magratheaconf!", 704);
130         }
131     }
132 
133     /**
134     * `$section_name` is the name of the section that will be returned as an array.
135     * @param string $section_name Name of the section to be returned from the `magrathea.conf`.
136     * @return array
137     * @todo     exception 704 on key does not exists
138     */
139     public function GetConfigSection($section_name){
140         $this->loadFile();
141         $configSection = @parse_ini_file($this->path."/".$this->config_file_name, true);
142         if( !$configSection ){
143             throw new MagratheaException("There was an error trying to load the config file.<br/>");
144         }
145         return $configSection[$section_name];
146     }
147 }
148 
149 
150 /**
151 * Magrathea Config loads and saves information in config files.
152 * 
153 */
154 class MagratheaConfigFile { 
155     private $path = __DIR__;
156     private $config_file_name = "configs/magrathea_plus.conf";
157     private $configs = null;
158 
159     public function __construct(){
160         $this->configs = null;
161     }
162 
163     /**
164     *   Set the path to the confi file
165     *   @param  string  $p      Path to be set
166     *   @return     itself
167     */
168     public function setPath($p){
169         $this->path = $p;
170         return $this;
171     }
172     /**
173     *   Sets the config information
174     *   @param  array   $c      Config to be set
175     *   @return     itself
176     */
177     public function setConfig($c){
178         $this->configs = $c;
179         return $this;
180     }
181     /**
182     *   Sets the name of the config file
183     *   @param  string  $filePath   Name of the config file
184     *   @return     itself
185     */
186     public function setFile($filePath){
187         $this->config_file_name = $filePath;
188         return $this;
189     }
190     /**
191     *   Loads the configuration file
192     */
193     private function loadFile(){
194         if(!file_exists($this->path."/".$this->config_file_name)){
195             throw new MagratheaException("Config file could not be found - ".$this->path."/".$this->config_file_name);
196         }
197     }
198     /**
199     *   Creates the configuration file if it doesn't exists. And saves it.
200     *   @return     boolean     True if the file exists; Return of `Save()` function if it doesn't
201     */
202     public function createFileIfNotExists(){
203         if(!file_exists($this->path."/".$this->config_file_name)){
204             return $this->Save();
205         } else return true;
206     }
207     /**
208     *   Gets configuration
209     *   @param  string  $config_name    Configuration to be got. If empty, returns all the configuration into the file
210     *                                   If an acceptable config name, returns its value
211     *   @return     string/int/array    If `$config_name` is empty, returns all the configuration. Otherwise, 
212     *   @todo   exception 704 on key does not exists
213     */
214     public function getConfig($config_name=""){
215         if( is_null($this->configs) ){
216             $this->loadFile();
217             $this->configs = @parse_ini_file($this->path."/".$this->config_file_name, true);
218         }
219         if( empty($config_name) ){
220             return $this->configs;
221         } else {
222             $c_split = explode("/", $config_name);
223             return ( count($c_split) == 1 ? $this->configs[$config_name] : $this->configs[$c_split[0]][$c_split[1]] );
224         }
225     }
226     /**
227     *   Gets a full config section
228     *
229     *   @param  string  $section_name   Name of the section to be shown
230     *
231     *   @return     array       All the values of the given section
232     *   @todo   exception 704 on key does not exists
233     */
234     public function getConfigSection($section_name){
235         $this->loadFile();
236         $configSection = @parse_ini_file($this->path.$this->config_file_name, true);
237         if( empty($configSection ) ) return null;
238         if( !$configSection ){
239             throw new MagratheaException("There was an error trying to load the config file.<br/>");
240         }
241         return $configSection[$section_name];
242     }
243     /**
244     *   Saves the config file
245     *
246     *   @param  boolean     $save_sections      A flag indicating if the sections should be saved also.
247     *                                           Default: `true`
248     *
249     *   @return     boolean     True if the saved succesfully. False if got any error in the process
250     */
251     public function Save($save_sections=true) { 
252         $content = "// generated by Magrathea at ".@date("Y-m-d h:i:s")."\n";
253         $data = $this->configs;
254         if( $data == null ) $data = array();
255         if ($save_sections) { 
256             foreach ($data as $key=>$elem) { 
257                 $content .= "\n[".$key."]\n"; 
258                 if(!is_array($elem)){
259                     throw new MagratheaConfigException("Hey, you! If you are gonna save a config file with sections, all the configs must be inside one section...", 1);
260                     
261                 }
262                 foreach ($elem as $key2=>$elem2) { 
263                     if(is_array($elem2)) { 
264                         for($i=0;$i<count($elem2);$i++) { 
265                             $content .= "\t".$key2."[] = \"".$elem2[$i]."\"\n"; 
266                         } 
267                     } else if($elem2=="") $content .= "\t".$key2." = \n"; 
268                     else $content .= "\t".$key2." = \"".$elem2."\"\n"; 
269                 } 
270             } 
271         } else { 
272             foreach ($data as $key=>$elem) { 
273                 if(is_array($elem)) { 
274                     for($i=0;$i<count($elem);$i++) { 
275                         $content .= $key."[] = \"".$elem[$i]."\"\n";
276                     } 
277                 } else if($elem=="") $content .= $key." = \n"; 
278                 else $content .= $key." = \"".$elem."\"\n"; 
279             } 
280         } 
281         if(!is_writable($this->path)){
282             throw new MagratheaConfigException("Permission denied on path: ".$this->path);
283             return false; 
284         }
285         $file = $this->path."/".$this->config_file_name;
286         if(file_exists($file)){
287             @unlink($file);
288         }
289         if (!$handle = fopen($file, 'w')) { 
290             throw new MagratheaConfigException("Oh noes! Could not open File: ".$file);
291             return false; 
292         } 
293         if (!fwrite($handle, $content)) { 
294             throw new MagratheaConfigException("Oh noes! Could not save File: ".$file);
295             return false; 
296         } 
297         fclose($handle); 
298         return true; 
299     }
300 
301     
302     
303     
304 }
305 
306