tnhfw / tnh-fw

core/classes/database/Database.php

Indentation +322 added lines, -322 removed lines

@@ -1,113 +1,113 @@ 
 <?php
     defined('ROOT_PATH') || exit('Access denied');
-  /**
-   * TNH Framework
-   *
-   * A simple PHP framework using HMVC architecture
-   *
-   * This content is released under the GNU GPL License (GPL)
-   *
-   * Copyright (C) 2017 Tony NGUEREZA
-   *
-   * This program is free software; you can redistribute it and/or
-   * modify it under the terms of the GNU General Public License
-   * as published by the Free Software Foundation; either version 3
-   * of the License, or (at your option) any later version.
-   *
-   * This program 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 General Public License for more details.
-   *
-   * You should have received a copy of the GNU General Public License
-   * along with this program; if not, write to the Free Software
-   * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-  */
-  class Database extends BaseClass{
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program 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 General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
+    class Database extends BaseClass{
 	
-  	/**
-  	 * The PDO instance
-  	 * @var object
-  	*/
+        /**
+         * The PDO instance
+         * @var object
+         */
     private $pdo                 = null;
     
-  	/**
-  	 * The database name used for the application
-  	 * @var string
-  	*/
-	  private $databaseName        = null;
+        /**
+         * The database name used for the application
+         * @var string
+         */
+        private $databaseName        = null;
 	
-  	/**
-  	 * The number of rows returned by the last query
-  	 * @var int
-  	*/
+        /**
+         * The number of rows returned by the last query
+         * @var int
+         */
     private $numRows             = 0;
 	
-  	/**
-  	 * The last insert id for the primary key column that have auto increment or sequence
-  	 * @var mixed
-  	*/
+        /**
+         * The last insert id for the primary key column that have auto increment or sequence
+         * @var mixed
+         */
     private $insertId            = null;
 	
-  	/**
-  	 * The full SQL query statment after build for each command
-  	 * @var string
-  	*/
+        /**
+         * The full SQL query statment after build for each command
+         * @var string
+         */
     private $query               = null;
 	
-  	/**
-  	 * The result returned for the last query
-  	 * @var mixed
-  	*/
+        /**
+         * The result returned for the last query
+         * @var mixed
+         */
     private $result              = array();
 	
-  	/**
-  	 * The cache default time to live in second. 0 means no need to use the cache feature
-  	 * @var int
-  	*/
-  	private $cacheTtl             = 0;
+        /**
+         * The cache default time to live in second. 0 means no need to use the cache feature
+         * @var int
+         */
+        private $cacheTtl             = 0;
 	
-  	/**
-  	 * The cache current time to live. 0 means no need to use the cache feature
-  	 * @var int
-  	*/
+        /**
+         * The cache current time to live. 0 means no need to use the cache feature
+         * @var int
+         */
     private $temporaryCacheTtl   = 0;
 	
-  	/**
-  	 * The number of executed query for the current request
-  	 * @var int
-  	*/
+        /**
+         * The number of executed query for the current request
+         * @var int
+         */
     private $queryCount          = 0;
 	
-  	/**
-  	 * The default data to be used in the statments query INSERT, UPDATE
-  	 * @var array
-  	*/
+        /**
+         * The default data to be used in the statments query INSERT, UPDATE
+         * @var array
+         */
     private $data                = array();
 	
-  	/**
-  	 * The database configuration
-  	 * @var array
-  	*/
+        /**
+         * The database configuration
+         * @var array
+         */
     private $config              = array();
 	
     /**
-    * The cache instance
-    * @var object
-    */
+     * The cache instance
+     * @var object
+     */
     private $cacheInstance       = null;
 
     
-  	/**
-    * The DatabaseQueryBuilder instance
-    * @var object
-    */
+        /**
+         * The DatabaseQueryBuilder instance
+         * @var object
+         */
     protected $queryBuilder        = null;
     
     /**
-    * The DatabaseQueryRunner instance
-    * @var object
-    */
+     * The DatabaseQueryRunner instance
+     * @var object
+     */
     protected $queryRunner         = null;
 
 
@@ -119,7 +119,7 @@ 
     public function __construct($overwriteConfig = array(), $autoConnect = true){
         parent::__construct();
 		
-    		//Set DatabaseQueryBuilder instance to use
+            //Set DatabaseQueryBuilder instance to use
         $this->setDependencyInstanceFromParamOrCreate('queryBuilder', null, 'DatabaseQueryBuilder', 'classes/database');
        
         //Set DatabaseQueryRunner instance to use
@@ -137,8 +137,8 @@ 
      * @return bool 
      */
     public function connect(){
-      $config = $this->getDatabaseConfiguration();
-      if (! empty($config)){
+        $config = $this->getDatabaseConfiguration();
+        if (! empty($config)){
         try{
             $this->pdo = new PDO($this->getDsnValueFromConfig(), $config['username'], $config['password']);
             $this->pdo->exec("SET NAMES '" . $config['charset'] . "' COLLATE '" . $config['collation'] . "'");
@@ -149,14 +149,14 @@ 
             $this->updateQueryBuilderAndRunnerProperties();
 
             return is_object($this->pdo);
-          }
-          catch (PDOException $e){
+            }
+            catch (PDOException $e){
             $this->logger->fatal($e->getMessage());
             show_error('Cannot connect to Database.');
             return false;
-          }
-      }
-      return false;
+            }
+        }
+        return false;
     }
 
 
@@ -165,7 +165,7 @@ 
      * @return int
      */
     public function numRows(){
-      return $this->numRows;
+        return $this->numRows;
     }
 
     /**
@@ -173,7 +173,7 @@ 
      * @return mixed
      */
     public function insertId(){
-      return $this->insertId;
+        return $this->insertId;
     }
 
 
@@ -184,13 +184,13 @@ 
      * @return mixed       the query SQL string or the record result
      */
     public function get($returnSQLQueryOrResultType = false){
-      $this->queryBuilder->limit(1);
-      $query = $this->getAll(true);
-      if ($returnSQLQueryOrResultType === true){
+        $this->queryBuilder->limit(1);
+        $query = $this->getAll(true);
+        if ($returnSQLQueryOrResultType === true){
         return $query;
-      } else {
+        } else {
         return $this->query($query, false, $returnSQLQueryOrResultType == 'array');
-      }
+        }
     }
 
     /**
@@ -200,11 +200,11 @@ 
      * @return mixed       the query SQL string or the record result
      */
     public function getAll($returnSQLQueryOrResultType = false){
-	   $query = $this->queryBuilder->getQuery();
-	   if ($returnSQLQueryOrResultType === true){
-      	return $query;
-      }
-      return $this->query($query, true, $returnSQLQueryOrResultType == 'array');
+        $query = $this->queryBuilder->getQuery();
+        if ($returnSQLQueryOrResultType === true){
+            return $query;
+        }
+        return $this->query($query, true, $returnSQLQueryOrResultType == 'array');
     }
 
     /**
@@ -214,19 +214,19 @@ 
      * @return mixed          the insert id of the new record or null
      */
     public function insert($data = array(), $escape = true){
-      if (empty($data) && ! empty($this->data)){
+        if (empty($data) && ! empty($this->data)){
         //as when using $this->setData() may be the data already escaped
         $escape = false;
         $data = $this->data;
-      }
-      $query = $this->queryBuilder->insert($data, $escape)->getQuery();
-      $result = $this->query($query);
-      if ($result){
+        }
+        $query = $this->queryBuilder->insert($data, $escape)->getQuery();
+        $result = $this->query($query);
+        if ($result){
         $this->insertId = $this->pdo->lastInsertId();
-		    //if the table doesn't have the auto increment field or sequence, the value of 0 will be returned 
+            //if the table doesn't have the auto increment field or sequence, the value of 0 will be returned 
         return ! ($this->insertId) ? true : $this->insertId;
-      }
-      return false;
+        }
+        return false;
     }
 
     /**
@@ -236,13 +236,13 @@ 
      * @return mixed          the update status
      */
     public function update($data = array(), $escape = true){
-      if (empty($data) && ! empty($this->data)){
+        if (empty($data) && ! empty($this->data)){
         //as when using $this->setData() may be the data already escaped
         $escape = false;
         $data = $this->data;
-      }
-      $query = $this->queryBuilder->update($data, $escape)->getQuery();
-      return $this->query($query);
+        }
+        $query = $this->queryBuilder->update($data, $escape)->getQuery();
+        return $this->query($query);
     }
 
     /**
@@ -250,8 +250,8 @@ 
      * @return mixed the delete status
      */
     public function delete(){
-		  $query = $this->queryBuilder->delete()->getQuery();
-    	return $this->query($query);
+            $query = $this->queryBuilder->delete()->getQuery();
+        return $this->query($query);
     }
 
     /**
@@ -260,17 +260,17 @@ 
      * @return object        the current Database instance
      */
     public function setCache($ttl = 0){
-      $this->cacheTtl = $ttl;
-      $this->temporaryCacheTtl = $ttl;
-      return $this;
+        $this->cacheTtl = $ttl;
+        $this->temporaryCacheTtl = $ttl;
+        return $this;
     }
 	
-	/**
-	 * Enabled cache temporary for the current query not globally	
-	 * @param  integer $ttl the cache time to live in second
-	 * @return object        the current Database instance
-	 */
-  	public function cached($ttl = 0){
+    /**
+     * Enabled cache temporary for the current query not globally	
+     * @param  integer $ttl the cache time to live in second
+     * @return object        the current Database instance
+     */
+        public function cached($ttl = 0){
         $this->temporaryCacheTtl = $ttl;
         return $this;
     }
@@ -283,11 +283,11 @@ 
      * need escaped
      */
     public function escape($data, $escaped = true){
-      $data = trim($data);
-      if($escaped){
+        $data = trim($data);
+        if($escaped){
         return $this->pdo->quote($data);
-      }
-      return $data; 
+        }
+        return $data; 
     }
 
     /**
@@ -295,7 +295,7 @@ 
      * @return int
      */
     public function queryCount(){
-      return $this->queryCount;
+        return $this->queryCount;
     }
 
     /**
@@ -303,7 +303,7 @@ 
      * @return string
      */
     public function getQuery(){
-      return $this->query;
+        return $this->query;
     }
 
     /**
@@ -311,7 +311,7 @@ 
      * @return string
      */
     public function getDatabaseName(){
-      return $this->databaseName;
+        return $this->databaseName;
     }
 
     /**
@@ -319,44 +319,44 @@ 
      * @return object
      */
     public function getPdo(){
-      return $this->pdo;
+        return $this->pdo;
     }
 
     /**
      * Set the PDO instance
      * @param object $pdo the pdo object
-	 * @return object Database
+     * @return object Database
      */
     public function setPdo(PDO $pdo){
-      $this->pdo = $pdo;
-      return $this;
+        $this->pdo = $pdo;
+        return $this;
     }
 
-     /**
-     * Return the cache instance
-     * @return CacheInterface
-     */
+        /**
+         * Return the cache instance
+         * @return CacheInterface
+         */
     public function getCacheInstance(){
-      return $this->cacheInstance;
+        return $this->cacheInstance;
     }
 
     /**
      * Set the cache instance
      * @param CacheInterface $cache the cache object
-	 * @return object Database
+     * @return object Database
      */
     public function setCacheInstance($cache){
-      $this->cacheInstance = $cache;
-      return $this;
+        $this->cacheInstance = $cache;
+        return $this;
     }
 	
 	
-	   /**
-     * Return the DatabaseQueryBuilder instance
-     * @return object DatabaseQueryBuilder
-     */
+        /**
+         * Return the DatabaseQueryBuilder instance
+         * @return object DatabaseQueryBuilder
+         */
     public function getQueryBuilder(){
-      return $this->queryBuilder;
+        return $this->queryBuilder;
     }
 
     /**
@@ -364,8 +364,8 @@ 
      * @param object DatabaseQueryBuilder $queryBuilder the DatabaseQueryBuilder object
      */
     public function setQueryBuilder(DatabaseQueryBuilder $queryBuilder){
-      $this->queryBuilder = $queryBuilder;
-      return $this;
+        $this->queryBuilder = $queryBuilder;
+        return $this;
     }
     
     /**
@@ -373,7 +373,7 @@ 
      * @return object DatabaseQueryRunner
      */
     public function getQueryRunner(){
-      return $this->queryRunner;
+        return $this->queryRunner;
     }
 
     /**
@@ -381,8 +381,8 @@ 
      * @param object DatabaseQueryRunner $queryRunner the DatabaseQueryRunner object
      */
     public function setQueryRunner(DatabaseQueryRunner $queryRunner){
-      $this->queryRunner = $queryRunner;
-      return $this;
+        $this->queryRunner = $queryRunner;
+        return $this;
     }
 
     /**
@@ -390,7 +390,7 @@ 
      * @return array
      */
     public function getData(){
-      return $this->data;
+        return $this->data;
     }
 
     /**
@@ -401,62 +401,62 @@ 
      * @return object        the current Database instance
      */
     public function setData($key, $value = null, $escape = true){
-  	  if (is_array($key)){
-    		foreach($key as $k => $v){
-    			$this->setData($k, $v, $escape);
-    		}	
-  	  } else {
+        if (is_array($key)){
+            foreach($key as $k => $v){
+                $this->setData($k, $v, $escape);
+            }	
+        } else {
         $this->data[$key] = $this->escape($value, $escape);
-  	  }
-      return $this;
+        }
+        return $this;
     }
 
-     /**
-     * Execute an SQL query
-     * @param  string  $query the query SQL string
-     * @param  boolean $returnAsList  indicate whether to return all record or just one row 
-     * @param  boolean $returnAsArray return the result as array or not
-     * @return mixed         the query result
-     */
+        /**
+         * Execute an SQL query
+         * @param  string  $query the query SQL string
+         * @param  boolean $returnAsList  indicate whether to return all record or just one row 
+         * @param  boolean $returnAsArray return the result as array or not
+         * @return mixed         the query result
+         */
     public function query($query, $returnAsList = true, $returnAsArray = false){
-      $this->reset();
-      $this->query = preg_replace('/\s\s+|\t\t+/', ' ', trim($query));
-      //If is the SELECT query
-      $isSqlSELECTQuery = stristr($this->query, 'SELECT');
+        $this->reset();
+        $this->query = preg_replace('/\s\s+|\t\t+/', ' ', trim($query));
+        //If is the SELECT query
+        $isSqlSELECTQuery = stristr($this->query, 'SELECT');
 
-      //cache expire time
-      $cacheExpire = $this->temporaryCacheTtl;
+        //cache expire time
+        $cacheExpire = $this->temporaryCacheTtl;
       
-      //return to the initial cache time
-      $this->temporaryCacheTtl = $this->cacheTtl;
+        //return to the initial cache time
+        $this->temporaryCacheTtl = $this->cacheTtl;
       
-      //config for cache
-      $cacheEnable = get_config('cache_enable');
+        //config for cache
+        $cacheEnable = get_config('cache_enable');
       
-      //the database cache content
-      $cacheContent = null;
+        //the database cache content
+        $cacheContent = null;
 
-      //if can use cache feature for this query
-      $dbCacheStatus = $cacheEnable && $cacheExpire > 0;
+        //if can use cache feature for this query
+        $dbCacheStatus = $cacheEnable && $cacheExpire > 0;
     
-      if ($dbCacheStatus && $isSqlSELECTQuery){
-          $this->logger->info('The cache is enabled for this query, try to get result from cache'); 
-          $cacheContent = $this->getCacheContentForQuery($query, $returnAsList, $returnAsArray);  
-      }
+        if ($dbCacheStatus && $isSqlSELECTQuery){
+            $this->logger->info('The cache is enabled for this query, try to get result from cache'); 
+            $cacheContent = $this->getCacheContentForQuery($query, $returnAsList, $returnAsArray);  
+        }
       
-      if (!$cacheContent){
-  	   	//count the number of query execution to server
+        if (!$cacheContent){
+                //count the number of query execution to server
         $this->queryCount++;
         
         $queryResult = $this->queryRunner->setQuery($query)
-                                          ->setReturnType($returnAsList)
-                                          ->setReturnAsArray($returnAsArray)
-                                          ->execute();
+                                            ->setReturnType($returnAsList)
+                                            ->setReturnAsArray($returnAsArray)
+                                            ->execute();
 
         if (!is_object($queryResult)){
-          $this->result = false;
-          $this->numRows = 0;
-          return $this->result;
+            $this->result = false;
+            $this->numRows = 0;
+            return $this->result;
         }
         $this->result  = $queryResult->getResult();
         $this->numRows = $queryResult->getNumRows();
@@ -464,72 +464,72 @@ 
             $key = $this->getCacheKeyForQuery($this->query, $returnAsList, $returnAsArray);
             $this->setCacheContentForQuery($this->query, $key, $this->result, $cacheExpire);
         }
-      } else if ($isSqlSELECTQuery){
-          $this->logger->info('The result for query [' .$this->query. '] already cached use it');
-          $this->result = $cacheContent;
-          $this->numRows = count($this->result);
-      }
-      return $this->result;
-    }
-
-   /**
-    * Setting the database configuration using the configuration file and additional configuration from param
-    * @param array $overwriteConfig the additional configuration to overwrite with the existing one
-    * @param boolean $useConfigFile whether to use database configuration file
-    * @param boolean $autoConnect whether to connect to database after set the configuration
-	  * @return object Database
-    */
+        } else if ($isSqlSELECTQuery){
+            $this->logger->info('The result for query [' .$this->query. '] already cached use it');
+            $this->result = $cacheContent;
+            $this->numRows = count($this->result);
+        }
+        return $this->result;
+    }
+
+    /**
+     * Setting the database configuration using the configuration file and additional configuration from param
+     * @param array $overwriteConfig the additional configuration to overwrite with the existing one
+     * @param boolean $useConfigFile whether to use database configuration file
+     * @param boolean $autoConnect whether to connect to database after set the configuration
+     * @return object Database
+     */
     public function setDatabaseConfiguration(array $overwriteConfig = array(), $useConfigFile = true, $autoConnect = false){
-      $db = array();
-      if ($useConfigFile && file_exists(CONFIG_PATH . 'database.php')){
-          //here don't use require_once because somewhere user can create database instance directly
-          require CONFIG_PATH . 'database.php';
-      }
+        $db = array();
+        if ($useConfigFile && file_exists(CONFIG_PATH . 'database.php')){
+            //here don't use require_once because somewhere user can create database instance directly
+            require CONFIG_PATH . 'database.php';
+        }
       
-      //merge with the parameter  
-      $db = array_merge($db, $overwriteConfig);
+        //merge with the parameter  
+        $db = array_merge($db, $overwriteConfig);
       
-      //get the default configuration
-      $config = $this->getDatabaseDefaultConfiguration();
+        //get the default configuration
+        $config = $this->getDatabaseDefaultConfiguration();
 		  
-    	$config = array_merge($config, $db);
-    	//determine the port using the hostname like localhost:3307
-      //hostname will be "localhost", and port "3307"
-      $p = explode(':', $config['hostname']);
-  	  if (count($p) >= 2){
-  		  $config['hostname'] = $p[0];
-  		  $config['port'] = $p[1];
-  		}
+        $config = array_merge($config, $db);
+        //determine the port using the hostname like localhost:3307
+        //hostname will be "localhost", and port "3307"
+        $p = explode(':', $config['hostname']);
+        if (count($p) >= 2){
+            $config['hostname'] = $p[0];
+            $config['port'] = $p[1];
+            }
 		
-		 $this->databaseName = $config['database'];
-		 $this->config = $config;
-		 $this->logger->info(
-								'The database configuration are listed below: ' 
-								. stringfy_vars(array_merge(
-															$this->config, 
-															array('password' => string_hidden($this->config['password']))
-												))
-							);
-  	  if($autoConnect){
-    		 //Now connect to the database
-    		 $this->connect();
-  		}
-		 return $this;
-    }
-
-    /**
-   * Return the database configuration
-   * @return array
-   */
+            $this->databaseName = $config['database'];
+            $this->config = $config;
+            $this->logger->info(
+                                'The database configuration are listed below: ' 
+                                . stringfy_vars(array_merge(
+                                                            $this->config, 
+                                                            array('password' => string_hidden($this->config['password']))
+                                                ))
+                            );
+        if($autoConnect){
+                //Now connect to the database
+                $this->connect();
+            }
+            return $this;
+    }
+
+    /**
+     * Return the database configuration
+     * @return array
+     */
     public  function getDatabaseConfiguration(){
-      return $this->config;
+        return $this->config;
     }
 
     /**
      * Close the connexion
      */
     public function close(){
-      $this->pdo = null;
+        $this->pdo = null;
     }
 
     /**
@@ -537,16 +537,16 @@ 
      * @return array
      */
     protected function getDatabaseDefaultConfiguration(){
-      return array(
-              'driver' => '',
-              'username' => '',
-              'password' => '',
-              'database' => '',
-              'hostname' => 'localhost',
-              'charset' => 'utf8',
-              'collation' => 'utf8_general_ci',
-              'prefix' => '',
-              'port' => ''
+        return array(
+                'driver' => '',
+                'username' => '',
+                'password' => '',
+                'database' => '',
+                'hostname' => 'localhost',
+                'charset' => 'utf8',
+                'collation' => 'utf8_general_ci',
+                'prefix' => '',
+                'port' => ''
             );
     }
 
@@ -555,18 +555,18 @@ 
      * @return void
      */
     protected function updateQueryBuilderAndRunnerProperties(){
-       //update queryBuilder with some properties needed
-     if (is_object($this->queryBuilder)){
+        //update queryBuilder with some properties needed
+        if (is_object($this->queryBuilder)){
         $this->queryBuilder->setDriver($this->config['driver'])
-                           ->setPrefix($this->config['prefix'])
-                           ->setPdo($this->pdo);
-     }
+                            ->setPrefix($this->config['prefix'])
+                            ->setPdo($this->pdo);
+        }
 
-      //update queryRunner with some properties needed
-     if (is_object($this->queryRunner)){
+        //update queryRunner with some properties needed
+        if (is_object($this->queryRunner)){
         $this->queryRunner->setDriver($this->config['driver'])
-                          ->setPdo($this->pdo);
-     }
+                            ->setPdo($this->pdo);
+        }
     }
 	
 
@@ -575,21 +575,21 @@ 
      * @return string|null the DSN string or null if can not find it
      */
     protected function getDsnValueFromConfig(){
-      $dsn = null;
-      $config = $this->getDatabaseConfiguration();
-      if (! empty($config)){
+        $dsn = null;
+        $config = $this->getDatabaseConfiguration();
+        if (! empty($config)){
         $driver = $config['driver'];
         $driverDsnMap = array(
-                              'mysql'  => $this->getDsnValueForDriver('mysql'),
-                              'pgsql'  => $this->getDsnValueForDriver('pgsql'),
-                              'sqlite' => $this->getDsnValueForDriver('sqlite'),
-                              'oracle' => $this->getDsnValueForDriver('oracle')
-                              );
+                                'mysql'  => $this->getDsnValueForDriver('mysql'),
+                                'pgsql'  => $this->getDsnValueForDriver('pgsql'),
+                                'sqlite' => $this->getDsnValueForDriver('sqlite'),
+                                'oracle' => $this->getDsnValueForDriver('oracle')
+                                );
         if (isset($driverDsnMap[$driver])){
-          $dsn = $driverDsnMap[$driver];
+            $dsn = $driverDsnMap[$driver];
         }
-      }    
-      return $dsn;
+        }    
+        return $dsn;
     }
 
     /**
@@ -598,32 +598,32 @@ 
      * @return string|null         the dsn name
      */
     protected function getDsnValueForDriver($driver){
-      $dsn = '';
-      $config = $this->getDatabaseConfiguration();
-      if (empty($config)){
+        $dsn = '';
+        $config = $this->getDatabaseConfiguration();
+        if (empty($config)){
         return null;
-      }
-      switch ($driver) {
+        }
+        switch ($driver) {
         case 'mysql':
         case 'pgsql':
           $port = '';
-          if (! empty($config['port'])) {
+            if (! empty($config['port'])) {
             $port = 'port=' . $config['port'] . ';';
-          }
-          $dsn = $driver . ':host=' . $config['hostname'] . ';' . $port . 'dbname=' . $config['database'];
-          break;
+            }
+            $dsn = $driver . ':host=' . $config['hostname'] . ';' . $port . 'dbname=' . $config['database'];
+            break;
         case 'sqlite':
           $dsn = 'sqlite:' . $config['database'];
-          break;
-          case 'oracle':
+            break;
+            case 'oracle':
           $port = '';
-          if (! empty($config['port'])) {
+            if (! empty($config['port'])) {
             $port = ':' . $config['port'];
-          }
-          $dsn =  'oci:dbname=' . $config['hostname'] . $port . '/' . $config['database'];
-          break;
-      }
-      return $dsn;
+            }
+            $dsn =  'oci:dbname=' . $config['hostname'] . $port . '/' . $config['database'];
+            break;
+        }
+        return $dsn;
     }
 
     /**
@@ -635,11 +635,11 @@ 
     protected function getCacheContentForQuery($query, $returnAsList, $returnAsArray){
         $cacheKey = $this->getCacheKeyForQuery($query, $returnAsList, $returnAsArray);
         if (! is_object($this->cacheInstance)){
-    			//can not call method with reference in argument
-    			//like $this->setCacheInstance(& get_instance()->cache);
-    			//use temporary variable
-    			$instance = & get_instance()->cache;
-    			$this->cacheInstance = $instance;
+                //can not call method with reference in argument
+                //like $this->setCacheInstance(& get_instance()->cache);
+                //use temporary variable
+                $instance = & get_instance()->cache;
+                $this->cacheInstance = $instance;
         }
         return $this->cacheInstance->get($cacheKey);
     }
@@ -651,27 +651,27 @@ 
      * @param mixed $result the query result to save
      * @param int $expire the cache TTL
      */
-     protected function setCacheContentForQuery($query, $key, $result, $expire){
+        protected function setCacheContentForQuery($query, $key, $result, $expire){
         $this->logger->info('Save the result for query [' .$query. '] into cache for future use');
         if (! is_object($this->cacheInstance)){
-  				//can not call method with reference in argument
-  				//like $this->setCacheInstance(& get_instance()->cache);
-  				//use temporary variable
-  				$instance = & get_instance()->cache;
-  				$this->cacheInstance = $instance;
-  			}
+                    //can not call method with reference in argument
+                    //like $this->setCacheInstance(& get_instance()->cache);
+                    //use temporary variable
+                    $instance = & get_instance()->cache;
+                    $this->cacheInstance = $instance;
+                }
         $this->cacheInstance->set($key, $result, $expire);
-     }
+        }
 
     
-	 /**
-     * Return the cache key for the given query
-     * @see Database::query
-     * 
-     *  @return string
-     */
+        /**
+         * Return the cache key for the given query
+         * @see Database::query
+         * 
+         *  @return string
+         */
     protected function getCacheKeyForQuery($query, $returnAsList, $returnAsArray){
-      return md5($query . $returnAsList . $returnAsArray);
+        return md5($query . $returnAsList . $returnAsArray);
     }
 
 	
@@ -679,20 +679,20 @@ 
      * Reset the database class attributs to the initail values before each query.
      */
     private function reset(){
-	   //query builder reset
-      $this->queryBuilder->reset();
-      $this->numRows  = 0;
-      $this->insertId = null;
-      $this->query    = null;
-      $this->result   = array();
-      $this->data     = array();
+        //query builder reset
+        $this->queryBuilder->reset();
+        $this->numRows  = 0;
+        $this->insertId = null;
+        $this->query    = null;
+        $this->result   = array();
+        $this->data     = array();
     }
 
     /**
      * The class destructor
      */
     public function __destruct(){
-      $this->pdo = null;
+        $this->pdo = null;
     }
 
 }

core/classes/DBSessionHandler.php

Indentation +296 added lines, -296 removed lines

@@ -1,75 +1,75 @@ 
 <?php 
-	defined('ROOT_PATH') || exit('Access denied');
-	/**
-	 * TNH Framework
-	 *
-	 * A simple PHP framework using HMVC architecture
-	 *
-	 * This content is released under the GNU GPL License (GPL)
-	 *
-	 * Copyright (C) 2017 Tony NGUEREZA
-	 *
-	 * This program is free software; you can redistribute it and/or
-	 * modify it under the terms of the GNU General Public License
-	 * as published by the Free Software Foundation; either version 3
-	 * of the License, or (at your option) any later version.
-	 *
-	 * This program 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 General Public License for more details.
-	 *
-	 * You should have received a copy of the GNU General Public License
-	 * along with this program; if not, write to the Free Software
-	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-	*/
+    defined('ROOT_PATH') || exit('Access denied');
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program 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 General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
 	
-	/**
-	 * check if the interface "SessionHandlerInterface" exists (normally in PHP 5.4 this already exists)
-	 */
-	if ( !interface_exists('SessionHandlerInterface')){
-		show_error('"SessionHandlerInterface" interface does not exists or is disabled can not use it to handler database session.');
-	}
-
-	class DBSessionHandler extends BaseClass implements SessionHandlerInterface{
+    /**
+     * check if the interface "SessionHandlerInterface" exists (normally in PHP 5.4 this already exists)
+     */
+    if ( !interface_exists('SessionHandlerInterface')){
+        show_error('"SessionHandlerInterface" interface does not exists or is disabled can not use it to handler database session.');
+    }
+
+    class DBSessionHandler extends BaseClass implements SessionHandlerInterface{
 		
-		/**
-		 * The encryption method to use to encrypt session data in database
-		 * @const string
-		 */
-		const DB_SESSION_HASH_METHOD = 'AES-256-CBC';
+        /**
+         * The encryption method to use to encrypt session data in database
+         * @const string
+         */
+        const DB_SESSION_HASH_METHOD = 'AES-256-CBC';
 		
-		/**
-		 * Super global instance
-		 * @var object
-		 */
-		protected $OBJ = null;
-
-		/**
-		 * Session secret to use 
-		 * @var string
-		 */
-		private $sessionSecret = null;
-
-		/**
-		 * The initialisation vector to use for openssl
-		 * @var string
-		 */
-		private $iv = null;
-
-		/**
-		 * The model instance to use
-		 * @var object
-		 */
-		private $modelInstance = null;
-
-		/**
-		 * The columns of the table to use to store session data
-		 * @var array
-		 */
-		private $sessionTableColumns = array();
-
-		/**
+        /**
+         * Super global instance
+         * @var object
+         */
+        protected $OBJ = null;
+
+        /**
+         * Session secret to use 
+         * @var string
+         */
+        private $sessionSecret = null;
+
+        /**
+         * The initialisation vector to use for openssl
+         * @var string
+         */
+        private $iv = null;
+
+        /**
+         * The model instance to use
+         * @var object
+         */
+        private $modelInstance = null;
+
+        /**
+         * The columns of the table to use to store session data
+         * @var array
+         */
+        private $sessionTableColumns = array();
+
+        /**
          * Instance of the Loader class
          * @var Loader
          */
@@ -79,225 +79,225 @@ 
          * Create new instance of Database session handler
          * @param object $modelInstance the model instance
          */
-		public function __construct(DBSessionHandlerModel $modelInstance = null){
-			parent::__construct();
+        public function __construct(DBSessionHandlerModel $modelInstance = null){
+            parent::__construct();
 			
-	    	//Set Loader instance to use
-	        $this->setDependencyInstanceFromParamOrCreate('loader', null, 'Loader', 'classes');
+            //Set Loader instance to use
+            $this->setDependencyInstanceFromParamOrCreate('loader', null, 'Loader', 'classes');
 	       
-		    $this->OBJ = & get_instance();
+            $this->OBJ = & get_instance();
 		    
-			if (is_object($modelInstance)){
-				$this->setModelInstance($modelInstance);
-			}
-		}
-
-		/**
-		 * Set the session secret used to encrypt the data in database 
-		 * @param string $secret the base64 string secret
-		 */
-		public function setSessionSecret($secret){
-			$this->sessionSecret = $secret;
-			return $this;
-		}
-
-		/**
-		 * Return the session secret
-		 * @return string 
-		 */
-		public function getSessionSecret(){
-			return $this->sessionSecret;
-		}
-
-
-		/**
-		 * Set the initializer vector for openssl 
-		 * @param string $key the session secret used in base64 format
-		 */
-		public function setInitializerVector($key){
-			$ivLength = openssl_cipher_iv_length(self::DB_SESSION_HASH_METHOD);
-			$key = base64_decode($key);
-			$this->iv = substr(hash('sha256', $key), 0, $ivLength);
-			return $this;
-		}
-
-		/**
-		 * Return the initializer vector
-		 * @return string 
-		 */
-		public function getInitializerVector(){
-			return $this->iv;
-		}
-
-		/**
-		 * Open the database session handler, here nothing to do just return true
-		 * @param  string $savePath    the session save path
-		 * @param  string $sessionName the session name
-		 * @return boolean 
-		 */
-		public function open($savePath, $sessionName){
-			$this->logger->debug('Opening database session handler for [' . $sessionName . ']');
-			//try to check if session secret is set before
-			$secret = $this->getSessionSecret();
-			if (empty($secret)){
-				$secret = get_config('session_secret', null);
-				$this->setSessionSecret($secret);
-			}
-			$this->logger->info('Session secret: ' . $secret);
-
-			if (! is_object($this->modelInstance)){
-				$this->setModelInstanceFromSessionConfig();
-			}
-			$this->setInitializerVector($secret);
-
-			//set session tables columns
-			$this->sessionTableColumns = $this->modelInstance->getSessionTableColumns();
-
-			if (empty($this->sessionTableColumns)){
-				show_error('The session handler is "database" but the table columns not set');
-			}
-			$this->logger->info('Database session, the model columns are listed below: ' . stringfy_vars($this->sessionTableColumns));
+            if (is_object($modelInstance)){
+                $this->setModelInstance($modelInstance);
+            }
+        }
+
+        /**
+         * Set the session secret used to encrypt the data in database 
+         * @param string $secret the base64 string secret
+         */
+        public function setSessionSecret($secret){
+            $this->sessionSecret = $secret;
+            return $this;
+        }
+
+        /**
+         * Return the session secret
+         * @return string 
+         */
+        public function getSessionSecret(){
+            return $this->sessionSecret;
+        }
+
+
+        /**
+         * Set the initializer vector for openssl 
+         * @param string $key the session secret used in base64 format
+         */
+        public function setInitializerVector($key){
+            $ivLength = openssl_cipher_iv_length(self::DB_SESSION_HASH_METHOD);
+            $key = base64_decode($key);
+            $this->iv = substr(hash('sha256', $key), 0, $ivLength);
+            return $this;
+        }
+
+        /**
+         * Return the initializer vector
+         * @return string 
+         */
+        public function getInitializerVector(){
+            return $this->iv;
+        }
+
+        /**
+         * Open the database session handler, here nothing to do just return true
+         * @param  string $savePath    the session save path
+         * @param  string $sessionName the session name
+         * @return boolean 
+         */
+        public function open($savePath, $sessionName){
+            $this->logger->debug('Opening database session handler for [' . $sessionName . ']');
+            //try to check if session secret is set before
+            $secret = $this->getSessionSecret();
+            if (empty($secret)){
+                $secret = get_config('session_secret', null);
+                $this->setSessionSecret($secret);
+            }
+            $this->logger->info('Session secret: ' . $secret);
+
+            if (! is_object($this->modelInstance)){
+                $this->setModelInstanceFromSessionConfig();
+            }
+            $this->setInitializerVector($secret);
+
+            //set session tables columns
+            $this->sessionTableColumns = $this->modelInstance->getSessionTableColumns();
+
+            if (empty($this->sessionTableColumns)){
+                show_error('The session handler is "database" but the table columns not set');
+            }
+            $this->logger->info('Database session, the model columns are listed below: ' . stringfy_vars($this->sessionTableColumns));
 			
-			//delete the expired session
-			$timeActivity = get_config('session_inactivity_time', 100);
-			$this->gc($timeActivity);
+            //delete the expired session
+            $timeActivity = get_config('session_inactivity_time', 100);
+            $this->gc($timeActivity);
 			
-			return true;
-		}
-
-		/**
-		 * Close the session
-		 * @return boolean
-		 */
-		public function close(){
-			$this->logger->debug('Closing database session handler');
-			return true;
-		}
-
-		/**
-		 * Get the session value for the given session id
-		 * @param  string $sid the session id to use
-		 * @return string      the session data in serialiaze format
-		 */
-		public function read($sid){
-			$this->logger->debug('Reading database session data for SID: ' . $sid);
-			$instance = $this->getModelInstance();
-			$columns = $this->sessionTableColumns;
-			$this->loader->functions('user_agent'); 
-			$this->loader->library('Browser'); 
+            return true;
+        }
+
+        /**
+         * Close the session
+         * @return boolean
+         */
+        public function close(){
+            $this->logger->debug('Closing database session handler');
+            return true;
+        }
+
+        /**
+         * Get the session value for the given session id
+         * @param  string $sid the session id to use
+         * @return string      the session data in serialiaze format
+         */
+        public function read($sid){
+            $this->logger->debug('Reading database session data for SID: ' . $sid);
+            $instance = $this->getModelInstance();
+            $columns = $this->sessionTableColumns;
+            $this->loader->functions('user_agent'); 
+            $this->loader->library('Browser'); 
 			
-			$ip = get_ip();
-			$host = @gethostbyaddr($ip) or null;
-			$browser = $this->OBJ->browser->getPlatform().', '.$this->OBJ->browser->getBrowser().' '.$this->OBJ->browser->getVersion();
+            $ip = get_ip();
+            $host = @gethostbyaddr($ip) or null;
+            $browser = $this->OBJ->browser->getPlatform().', '.$this->OBJ->browser->getBrowser().' '.$this->OBJ->browser->getVersion();
 			
-			$data = $instance->get_by(array($columns['sid'] => $sid, $columns['shost'] => $host, $columns['sbrowser'] => $browser));
-			if ($data && isset($data->{$columns['sdata']})){
-				//checking inactivity 
-				$timeInactivity = time() - get_config('session_inactivity_time', 100);
-				if ($data->{$columns['stime']} < $timeInactivity){
-					$this->logger->info('Database session data for SID: ' . $sid . ' already expired, destroy it');
-					$this->destroy($sid);
-					return null;
-				}
-				return $this->decode($data->{$columns['sdata']});
-			}
-			$this->logger->info('Database session data for SID: ' . $sid . ' is not valid return false, may be the session ID is wrong');
-			return null;
-		}
-
-		/**
-		 * Save the session data
-		 * @param  string $sid  the session ID
-		 * @param  mixed $data the session data to save in serialize format
-		 * @return boolean 
-		 */
-		public function write($sid, $data){
-			$this->logger->debug('Saving database session data for SID: ' . $sid . ', data: ' . stringfy_vars($data));
-			$instance = $this->getModelInstance();
-			$columns = $this->sessionTableColumns;
-
-			$this->loader->functions('user_agent'); 
-			$this->loader->library('Browser'); 
-
-			$ip = get_ip();
-			$keyValue = $instance->getKeyValue();
-			$host = @gethostbyaddr($ip) or null;
-			$browser = $this->OBJ->browser->getPlatform().', '.$this->OBJ->browser->getBrowser().' '.$this->OBJ->browser->getVersion();
-			$data = $this->encode($data);
-			$params = array(
-							$columns['sid'] => $sid,
-							$columns['sdata'] => $data,
-							$columns['stime'] => time(),
-							$columns['shost'] => $host,
-							$columns['sbrowser'] => $browser,
-							$columns['sip'] => $ip,
-							$columns['skey'] => $keyValue
-						);
-			$this->logger->info('Database session data to save are listed below :' . stringfy_vars($params));
-			$exists = $instance->get($sid);
-			if ($exists){
-				$this->logger->info('Session data for SID: ' . $sid . ' already exists, just update it');
-				//update
-				unset($params[$columns['sid']]);
-				return $instance->update($sid, $params);
-			}
-			$this->logger->info('Session data for SID: ' . $sid . ' not yet exists, insert it now');
-			return $instance->insert($params);
-		}
-
-
-		/**
-		 * Destroy the session data for the given session id
-		 * @param  string $sid the session id value
-		 * @return boolean
-		 */
-		public function destroy($sid){
-			$this->logger->debug('Destroy of session data for SID: ' . $sid);
-			$instance = $this->modelInstance;
-			$instance->delete($sid);
-			return true;
-		}
-
-		/**
-		 * Clean the expire session data to save espace
-		 * @param  integer $maxLifetime the max lifetime
-		 * @return boolean
-		 */
-		public function gc($maxLifetime){
-			$instance = $this->modelInstance;
-			$time = time() - $maxLifetime;
-			$this->logger->debug('Garbage collector of expired session. maxLifetime [' . $maxLifetime . '] sec, expired time [' . $time . ']');
-			$instance->deleteByTime($time);
-			return true;
-		}
-
-		/**
-		 * Encode the session data using the openssl
-		 * @param  mixed $data the session data to encode
-		 * @return mixed the encoded session data
-		 */
-		public function encode($data){
-			$key = base64_decode($this->sessionSecret);
-			$dataEncrypted = openssl_encrypt($data , self::DB_SESSION_HASH_METHOD, $key, OPENSSL_RAW_DATA, $this->getInitializerVector());
-			$output = base64_encode($dataEncrypted);
-			return $output;
-		}
-
-
-		/**
-		 * Decode the session data using the openssl
-		 * @param  mixed $data the data to decode
-		 * @return mixed       the decoded data
-		 */
-		public function decode($data){
-			$key = base64_decode($this->sessionSecret);
-			$data = base64_decode($data);
-			$data = openssl_decrypt($data, self::DB_SESSION_HASH_METHOD, $key, OPENSSL_RAW_DATA, $this->getInitializerVector());
-			return $data;
-		}
+            $data = $instance->get_by(array($columns['sid'] => $sid, $columns['shost'] => $host, $columns['sbrowser'] => $browser));
+            if ($data && isset($data->{$columns['sdata']})){
+                //checking inactivity 
+                $timeInactivity = time() - get_config('session_inactivity_time', 100);
+                if ($data->{$columns['stime']} < $timeInactivity){
+                    $this->logger->info('Database session data for SID: ' . $sid . ' already expired, destroy it');
+                    $this->destroy($sid);
+                    return null;
+                }
+                return $this->decode($data->{$columns['sdata']});
+            }
+            $this->logger->info('Database session data for SID: ' . $sid . ' is not valid return false, may be the session ID is wrong');
+            return null;
+        }
+
+        /**
+         * Save the session data
+         * @param  string $sid  the session ID
+         * @param  mixed $data the session data to save in serialize format
+         * @return boolean 
+         */
+        public function write($sid, $data){
+            $this->logger->debug('Saving database session data for SID: ' . $sid . ', data: ' . stringfy_vars($data));
+            $instance = $this->getModelInstance();
+            $columns = $this->sessionTableColumns;
+
+            $this->loader->functions('user_agent'); 
+            $this->loader->library('Browser'); 
+
+            $ip = get_ip();
+            $keyValue = $instance->getKeyValue();
+            $host = @gethostbyaddr($ip) or null;
+            $browser = $this->OBJ->browser->getPlatform().', '.$this->OBJ->browser->getBrowser().' '.$this->OBJ->browser->getVersion();
+            $data = $this->encode($data);
+            $params = array(
+                            $columns['sid'] => $sid,
+                            $columns['sdata'] => $data,
+                            $columns['stime'] => time(),
+                            $columns['shost'] => $host,
+                            $columns['sbrowser'] => $browser,
+                            $columns['sip'] => $ip,
+                            $columns['skey'] => $keyValue
+                        );
+            $this->logger->info('Database session data to save are listed below :' . stringfy_vars($params));
+            $exists = $instance->get($sid);
+            if ($exists){
+                $this->logger->info('Session data for SID: ' . $sid . ' already exists, just update it');
+                //update
+                unset($params[$columns['sid']]);
+                return $instance->update($sid, $params);
+            }
+            $this->logger->info('Session data for SID: ' . $sid . ' not yet exists, insert it now');
+            return $instance->insert($params);
+        }
+
+
+        /**
+         * Destroy the session data for the given session id
+         * @param  string $sid the session id value
+         * @return boolean
+         */
+        public function destroy($sid){
+            $this->logger->debug('Destroy of session data for SID: ' . $sid);
+            $instance = $this->modelInstance;
+            $instance->delete($sid);
+            return true;
+        }
+
+        /**
+         * Clean the expire session data to save espace
+         * @param  integer $maxLifetime the max lifetime
+         * @return boolean
+         */
+        public function gc($maxLifetime){
+            $instance = $this->modelInstance;
+            $time = time() - $maxLifetime;
+            $this->logger->debug('Garbage collector of expired session. maxLifetime [' . $maxLifetime . '] sec, expired time [' . $time . ']');
+            $instance->deleteByTime($time);
+            return true;
+        }
+
+        /**
+         * Encode the session data using the openssl
+         * @param  mixed $data the session data to encode
+         * @return mixed the encoded session data
+         */
+        public function encode($data){
+            $key = base64_decode($this->sessionSecret);
+            $dataEncrypted = openssl_encrypt($data , self::DB_SESSION_HASH_METHOD, $key, OPENSSL_RAW_DATA, $this->getInitializerVector());
+            $output = base64_encode($dataEncrypted);
+            return $output;
+        }
+
+
+        /**
+         * Decode the session data using the openssl
+         * @param  mixed $data the data to decode
+         * @return mixed       the decoded data
+         */
+        public function decode($data){
+            $key = base64_decode($this->sessionSecret);
+            $data = base64_decode($data);
+            $data = openssl_decrypt($data, self::DB_SESSION_HASH_METHOD, $key, OPENSSL_RAW_DATA, $this->getInitializerVector());
+            return $data;
+        }
 
 		
-		/**
+        /**
          * Return the loader instance
          * @return object Loader the loader instance
          */
@@ -309,7 +309,7 @@ 
          * set the loader instance for future use
          * @param object Loader $loader the loader object
          */
-         public function setLoader($loader){
+            public function setLoader($loader){
             $this->loader = $loader;
             return $this;
         }
@@ -326,27 +326,27 @@ 
          * set the model instance for future use
          * @param DBSessionHandlerModel $modelInstance the model object
          */
-         public function setModelInstance(DBSessionHandlerModel $modelInstance){
+            public function setModelInstance(DBSessionHandlerModel $modelInstance){
             $this->modelInstance = $modelInstance;
             return $this;
         }
 
-	    /**
-	     * Set the model instance using the configuration for session
-	     */
-	    protected function setModelInstanceFromSessionConfig(){
-	    	$modelName = get_config('session_save_path');
-			$this->logger->info('The database session model: ' . $modelName);
-			$this->loader->model($modelName, 'dbsessionhandlerinstance'); 
-			//@codeCoverageIgnoreStart
+        /**
+         * Set the model instance using the configuration for session
+         */
+        protected function setModelInstanceFromSessionConfig(){
+            $modelName = get_config('session_save_path');
+            $this->logger->info('The database session model: ' . $modelName);
+            $this->loader->model($modelName, 'dbsessionhandlerinstance'); 
+            //@codeCoverageIgnoreStart
             if (isset($this->OBJ->dbsessionhandlerinstance) 
-            	&& ! ($this->OBJ->dbsessionhandlerinstance instanceof DBSessionHandlerModel)
+                && ! ($this->OBJ->dbsessionhandlerinstance instanceof DBSessionHandlerModel)
             ) {
-				show_error('To use database session handler, your class model "' . get_class($this->OBJ->dbsessionhandlerinstance) . '" need extends "DBSessionHandlerModel"');
-			}  
-			//@codeCoverageIgnoreEnd
+                show_error('To use database session handler, your class model "' . get_class($this->OBJ->dbsessionhandlerinstance) . '" need extends "DBSessionHandlerModel"');
+            }  
+            //@codeCoverageIgnoreEnd
 			
-			//set model instance
-			$this->modelInstance = $this->OBJ->dbsessionhandlerinstance;
-	    }
-	}
+            //set model instance
+            $this->modelInstance = $this->OBJ->dbsessionhandlerinstance;
+        }
+    }

core/classes/Lang.php

Indentation +198 added lines, -198 removed lines

@@ -1,201 +1,201 @@
 <?php
-	defined('ROOT_PATH') || exit('Access denied');
-	/**
-	 * TNH Framework
-	 *
-	 * A simple PHP framework using HMVC architecture
-	 *
-	 * This content is released under the GNU GPL License (GPL)
-	 *
-	 * Copyright (C) 2017 Tony NGUEREZA
-	 *
-	 * This program is free software; you can redistribute it and/or
-	 * modify it under the terms of the GNU General Public License
-	 * as published by the Free Software Foundation; either version 3
-	 * of the License, or (at your option) any later version.
-	 *
-	 * This program 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 General Public License for more details.
-	 *
-	 * You should have received a copy of the GNU General Public License
-	 * along with this program; if not, write to the Free Software
-	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-	*/
-
-	/**
-	 * For application languages management
-	 */
-	class Lang extends BaseClass{
+    defined('ROOT_PATH') || exit('Access denied');
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program 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 General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
+
+    /**
+     * For application languages management
+     */
+    class Lang extends BaseClass{
 		
-		/**
-		 * The supported available language for this application.
-		 * @example "en" => "english" 
-		 * @see Lang::addLang()
-		 * @var array
-		 */
-		protected $availables = array();
-
-		/**
-		 * The all messages language
-		 * @var array
-		 */
-		protected $languages = array();
-
-		/**
-		 * The default language to use if can not
-		 *  determine the client language
-		 *  
-		 * @example $default = 'en'
-		 * @var string
-		 */
-		protected $default = null;
-
-		/**
-		 * The current client language
-		 * @var string
-		 */
-		protected $current = null;
-
-		/**
-		 * Construct new Lang instance
-		 */
-		public function __construct(){
-			parent::__construct();
-
-			$this->default = get_config('default_language', 'en');
-			$this->logger->debug('Setting the supported languages');
+        /**
+         * The supported available language for this application.
+         * @example "en" => "english" 
+         * @see Lang::addLang()
+         * @var array
+         */
+        protected $availables = array();
+
+        /**
+         * The all messages language
+         * @var array
+         */
+        protected $languages = array();
+
+        /**
+         * The default language to use if can not
+         *  determine the client language
+         *  
+         * @example $default = 'en'
+         * @var string
+         */
+        protected $default = null;
+
+        /**
+         * The current client language
+         * @var string
+         */
+        protected $current = null;
+
+        /**
+         * Construct new Lang instance
+         */
+        public function __construct(){
+            parent::__construct();
+
+            $this->default = get_config('default_language', 'en');
+            $this->logger->debug('Setting the supported languages');
 			
-			//add the supported languages ('key', 'display name')
-			$languages = get_config('languages', null);
-			if(! empty($languages)){
-				foreach($languages as $key => $displayName){
-					$this->addLang($key, $displayName);
-				}
-			}
-			unset($languages);
-
-			//if the language exists in cookie use it
-			$cfgKey = get_config('language_cookie_name');
-			$this->logger->debug('Getting current language from cookie [' .$cfgKey. ']');
-			$objCookie = & class_loader('Cookie');
-			$cookieLang = $objCookie->get($cfgKey);
-			if($cookieLang && $this->isValid($cookieLang)){
-				$this->current = $cookieLang;
-				$this->logger->info('Language from cookie [' .$cfgKey. '] is valid so we will set the language using the cookie value [' .$cookieLang. ']');
-			}
-			else{
-				$this->logger->info('Language from cookie [' .$cfgKey. '] is not set, use the default value [' .$this->getDefault(). ']');
-				$this->current = $this->getDefault();
-			}
-		}
-
-		/**
-		 * Get the all languages messages
-		 *
-		 * @return array the language message list
-		 */
-		public function getAll(){
-			return $this->languages;
-		}
-
-		/**
-		 * Set the language message
-		 *
-		 * @param string $key the language key to identify
-		 * @param string $value the language message value
-		 */
-		public function set($key, $value){
-			$this->languages[$key] = $value;
-		}
-
-		/**
-		 * Get the language message for the given key. If can't find return the default value
-		 *
-		 * @param  string $key the message language key
-		 * @param  string $default the default value to return if can not found the language message key
-		 *
-		 * @return string the language message value
-		 */
-		public function get($key, $default = 'LANGUAGE_ERROR'){
-			if(isset($this->languages[$key])){
-				return $this->languages[$key];
-			}
-			$this->logger->warning('Language key  [' .$key. '] does not exist use the default value [' .$default. ']');
-			return $default;
-		}
-
-		/**
-		 * Check whether the language file for given name exists
-		 *
-		 * @param  string  $language the language name like "fr", "en", etc.
-		 *
-		 * @return boolean true if the language directory exists, false or not
-		 */
-		public function isValid($language){
-			$searchDir = array(CORE_LANG_PATH, APP_LANG_PATH);
-			foreach($searchDir as $dir){
-				if(file_exists($dir . $language) && is_dir($dir . $language)){
-					return true;
-				}
-			}
-			return false;
-		}
-
-		/**
-		 * Get the default language value like "en" , "fr", etc.
-		 *
-		 * @return string the default language
-		 */
-		public function getDefault(){
-			return $this->default;
-		}
-
-		/**
-		 * Get the current language defined by cookie or the default value
-		 *
-		 * @return string the current language
-		 */
-		public function getCurrent(){
-			return $this->current;
-		}
-
-		/**
-		 * Add new supported or available language
-		 *
-		 * @param string $name the short language name like "en", "fr".
-		 * @param string $description the human readable description of this language
-		 */
-		public function addLang($name, $description){
-			if(isset($this->availables[$name])){
-				return; //already added cost in performance
-			}
-			if($this->isValid($name)){
-				$this->availables[$name] = $description;
-			}
-			else{
-				show_error('The language [' . $name . '] is not valid or does not exists.');
-			}
-		}
-
-		/**
-		 * Get the list of the application supported language
-		 *
-		 * @return array the list of the application language
-		 */
-		public function getSupported(){
-			return $this->availables;
-		}
-
-		/**
-		 * Add new language messages
-		 *
-		 * @param array $langs the languages array of the messages to be added
-		 */
-		public function addLangMessages(array $langs){
-			foreach ($langs as $key => $value) {
-				$this->set($key, $value);
-			}
-		}
-	}
+            //add the supported languages ('key', 'display name')
+            $languages = get_config('languages', null);
+            if(! empty($languages)){
+                foreach($languages as $key => $displayName){
+                    $this->addLang($key, $displayName);
+                }
+            }
+            unset($languages);
+
+            //if the language exists in cookie use it
+            $cfgKey = get_config('language_cookie_name');
+            $this->logger->debug('Getting current language from cookie [' .$cfgKey. ']');
+            $objCookie = & class_loader('Cookie');
+            $cookieLang = $objCookie->get($cfgKey);
+            if($cookieLang && $this->isValid($cookieLang)){
+                $this->current = $cookieLang;
+                $this->logger->info('Language from cookie [' .$cfgKey. '] is valid so we will set the language using the cookie value [' .$cookieLang. ']');
+            }
+            else{
+                $this->logger->info('Language from cookie [' .$cfgKey. '] is not set, use the default value [' .$this->getDefault(). ']');
+                $this->current = $this->getDefault();
+            }
+        }
+
+        /**
+         * Get the all languages messages
+         *
+         * @return array the language message list
+         */
+        public function getAll(){
+            return $this->languages;
+        }
+
+        /**
+         * Set the language message
+         *
+         * @param string $key the language key to identify
+         * @param string $value the language message value
+         */
+        public function set($key, $value){
+            $this->languages[$key] = $value;
+        }
+
+        /**
+         * Get the language message for the given key. If can't find return the default value
+         *
+         * @param  string $key the message language key
+         * @param  string $default the default value to return if can not found the language message key
+         *
+         * @return string the language message value
+         */
+        public function get($key, $default = 'LANGUAGE_ERROR'){
+            if(isset($this->languages[$key])){
+                return $this->languages[$key];
+            }
+            $this->logger->warning('Language key  [' .$key. '] does not exist use the default value [' .$default. ']');
+            return $default;
+        }
+
+        /**
+         * Check whether the language file for given name exists
+         *
+         * @param  string  $language the language name like "fr", "en", etc.
+         *
+         * @return boolean true if the language directory exists, false or not
+         */
+        public function isValid($language){
+            $searchDir = array(CORE_LANG_PATH, APP_LANG_PATH);
+            foreach($searchDir as $dir){
+                if(file_exists($dir . $language) && is_dir($dir . $language)){
+                    return true;
+                }
+            }
+            return false;
+        }
+
+        /**
+         * Get the default language value like "en" , "fr", etc.
+         *
+         * @return string the default language
+         */
+        public function getDefault(){
+            return $this->default;
+        }
+
+        /**
+         * Get the current language defined by cookie or the default value
+         *
+         * @return string the current language
+         */
+        public function getCurrent(){
+            return $this->current;
+        }
+
+        /**
+         * Add new supported or available language
+         *
+         * @param string $name the short language name like "en", "fr".
+         * @param string $description the human readable description of this language
+         */
+        public function addLang($name, $description){
+            if(isset($this->availables[$name])){
+                return; //already added cost in performance
+            }
+            if($this->isValid($name)){
+                $this->availables[$name] = $description;
+            }
+            else{
+                show_error('The language [' . $name . '] is not valid or does not exists.');
+            }
+        }
+
+        /**
+         * Get the list of the application supported language
+         *
+         * @return array the list of the application language
+         */
+        public function getSupported(){
+            return $this->availables;
+        }
+
+        /**
+         * Add new language messages
+         *
+         * @param array $langs the languages array of the messages to be added
+         */
+        public function addLangMessages(array $langs){
+            foreach ($langs as $key => $value) {
+                $this->set($key, $value);
+            }
+        }
+    }

core/classes/Router.php

Indentation +572 added lines, -572 removed lines

@@ -1,586 +1,586 @@
 <?php
-	defined('ROOT_PATH') or exit('Access denied');
-	/**
-	 * TNH Framework
-	 *
-	 * A simple PHP framework using HMVC architecture
-	 *
-	 * This content is released under the GNU GPL License (GPL)
-	 *
-	 * Copyright (C) 2017 Tony NGUEREZA
-	 *
-	 * This program is free software; you can redistribute it and/or
-	 * modify it under the terms of the GNU General Public License
-	 * as published by the Free Software Foundation; either version 3
-	 * of the License, or (at your option) any later version.
-	 *
-	 * This program 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 General Public License for more details.
-	 *
-	 * You should have received a copy of the GNU General Public License
-	 * along with this program; if not, write to the Free Software
-	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-	*/
-
-	class Router extends BaseClass{
-		/**
-		* @var array $pattern: The list of URIs to validate against
-		*/
-		private $pattern = array();
-
-		/**
-		* @var array $callback: The list of callback to call
-		*/
-		private $callback = array();
-
-		/**
-		* @var string $uriTrim: The char to remove from the URIs
-		*/
-		protected $uriTrim = '/\^$';
-
-		/**
-		* @var string $uri: The route URI to use
-		*/
-		protected $uri = '';
-
-		/**
-		 * The module name of the current request
-		 * @var string
-		 */
-		protected $module = null;
+    defined('ROOT_PATH') or exit('Access denied');
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program 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 General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
+
+    class Router extends BaseClass{
+        /**
+         * @var array $pattern: The list of URIs to validate against
+         */
+        private $pattern = array();
+
+        /**
+         * @var array $callback: The list of callback to call
+         */
+        private $callback = array();
+
+        /**
+         * @var string $uriTrim: The char to remove from the URIs
+         */
+        protected $uriTrim = '/\^$';
+
+        /**
+         * @var string $uri: The route URI to use
+         */
+        protected $uri = '';
+
+        /**
+         * The module name of the current request
+         * @var string
+         */
+        protected $module = null;
 		
-		/**
-		 * The controller name of the current request
-		 * @var string
-		 */
-		protected $controller = null;
-
-		/**
-		 * The controller path
-		 * @var string
-		 */
-		protected $controllerPath = null;
-
-		/**
-		 * The method name. The default value is "index"
-		 * @var string
-		 */
-		protected $method = 'index';
-
-		/**
-		 * List of argument to pass to the method
-		 * @var array
-		 */
-		protected $args = array();
-
-		/**
-		 * List of routes configurations
-		 * @var array
-		 */
-		protected $routes = array();
-
-		/**
-		 * The segments array for the current request
-		 * @var array
-		 */
-		protected $segments = array();
-
-		/**
-		 * Construct the new Router instance
-		 */
-		public function __construct(){
-			parent::__construct();
+        /**
+         * The controller name of the current request
+         * @var string
+         */
+        protected $controller = null;
+
+        /**
+         * The controller path
+         * @var string
+         */
+        protected $controllerPath = null;
+
+        /**
+         * The method name. The default value is "index"
+         * @var string
+         */
+        protected $method = 'index';
+
+        /**
+         * List of argument to pass to the method
+         * @var array
+         */
+        protected $args = array();
+
+        /**
+         * List of routes configurations
+         * @var array
+         */
+        protected $routes = array();
+
+        /**
+         * The segments array for the current request
+         * @var array
+         */
+        protected $segments = array();
+
+        /**
+         * Construct the new Router instance
+         */
+        public function __construct(){
+            parent::__construct();
 			
-			//loading routes for module
-			$moduleRouteList = array();
-			$modulesRoutes = Module::getModulesRoutesConfig();
-			if($modulesRoutes && is_array($modulesRoutes)){
-				$moduleRouteList = $modulesRoutes;
-				unset($modulesRoutes);
-			}
-			$this->setRouteConfiguration($moduleRouteList);
-			$this->logger->info('The routes configuration are listed below: ' . stringfy_vars($this->routes));
-
-			//Set route informations
-			$this->setRouteConfigurationInfos();
-		}
-
-		/**
-		 * Get the route patterns
-		 * @return array
-		 */
-		public function getPattern(){
-			return $this->pattern;
-		}
-
-		/**
-		 * Get the route callbacks
-		 * @return array
-		 */
-		public function getCallback(){
-			return $this->callback;
-		}
-
-	    /**
-		 * Get the module name
-		 * @return string
-		 */
-		public function getModule(){
-			return $this->module;
-		}
+            //loading routes for module
+            $moduleRouteList = array();
+            $modulesRoutes = Module::getModulesRoutesConfig();
+            if($modulesRoutes && is_array($modulesRoutes)){
+                $moduleRouteList = $modulesRoutes;
+                unset($modulesRoutes);
+            }
+            $this->setRouteConfiguration($moduleRouteList);
+            $this->logger->info('The routes configuration are listed below: ' . stringfy_vars($this->routes));
+
+            //Set route informations
+            $this->setRouteConfigurationInfos();
+        }
+
+        /**
+         * Get the route patterns
+         * @return array
+         */
+        public function getPattern(){
+            return $this->pattern;
+        }
+
+        /**
+         * Get the route callbacks
+         * @return array
+         */
+        public function getCallback(){
+            return $this->callback;
+        }
+
+        /**
+         * Get the module name
+         * @return string
+         */
+        public function getModule(){
+            return $this->module;
+        }
 		
-		/**
-		 * Get the controller name
-		 * @return string
-		 */
-		public function getController(){
-			return $this->controller;
-		}
-
-		/**
-		 * Get the controller file path
-		 * @return string
-		 */
-		public function getControllerPath(){
-			return $this->controllerPath;
-		}
-
-		/**
-		 * Get the controller method
-		 * @return string
-		 */
-		public function getMethod(){
-			return $this->method;
-		}
-
-		/**
-		 * Get the request arguments
-		 * @return array
-		 */
-		public function getArgs(){
-			return $this->args;
-		}
-
-		/**
-		 * Get the URL segments array
-		 * @return array
-		 */
-		public function getSegments(){
-			return $this->segments;
-		}
-
-	    /**
-		 * Get the route URI
-		 * @return string
-		 */
-		public function getRouteUri(){
-			return $this->uri;
-		}
-
-		/**
-		* Add the URI and callback to the list of URIs to validate
-		*
-		* @param string $uri the request URI
-		* @param string $callback the callback function
-		*
-		* @return object the current instance
-		*/
-		public function add($uri, $callback) {
-			$uri = trim($uri, $this->uriTrim);
-			if(in_array($uri, $this->pattern)){
-				$this->logger->warning('The route [' . $uri . '] already added, may be adding again can have route conflict');
-			}
-			$this->pattern[] = $uri;
-			$this->callback[] = $callback;
-			return $this;
-		}
-
-		/**
-		* Remove the route configuration
-		*
-		* @param string $uri the URI
-		*
-		* @return object the current instance
-		*/
-		public function removeRoute($uri) {
-			$index  = array_search($uri, $this->pattern, true);
-			if($index !== false){
-				$this->logger->info('Remove route for uri [' . $uri . '] from the configuration');
-				unset($this->pattern[$index]);
-				unset($this->callback[$index]);
-			}
-			return $this;
-		}
-
-
-		/**
-		* Remove all the routes from the configuration
-		*
-		* @return object the current instance
-		*/
-		public function removeAllRoute() {
-			$this->logger->info('Remove all routes from the configuration');
-			$this->pattern  = array();
-			$this->callback = array();
-			$this->routes = array();
-			return $this;
-		}
-
-
-		/**
-	     * Set the route URI to use later
-	     * @param string $uri the route URI, if is empty will determine automatically
-	     * @return object
-	     */
-	    public function setRouteUri($uri = ''){
-	    	$routeUri = '';
-	    	if(! empty($uri)){
-	    		$routeUri = $uri;
-	    	}
-	    	//if the application is running in CLI mode use the first argument
-			else if(IS_CLI && isset($_SERVER['argv'][1])){
-				$routeUri = $_SERVER['argv'][1];
-			}
-			else if(isset($_SERVER['REQUEST_URI'])){
-				$routeUri = $_SERVER['REQUEST_URI'];
-			}
-			$this->logger->debug('Check if URL suffix is enabled in the configuration');
-			//remove url suffix from the request URI
-			$suffix = get_config('url_suffix');
-			if ($suffix) {
-				$this->logger->info('URL suffix is enabled in the configuration, the value is [' . $suffix . ']' );
-				$routeUri = str_ireplace($suffix, '', $routeUri);
-			} 
-			if (strpos($routeUri, '?') !== false){
-				$routeUri = substr($routeUri, 0, strpos($routeUri, '?'));
-			}
-			$this->uri = trim($routeUri, $this->uriTrim);
-			return $this;
-	    }
-
-	     /**
-		 * Set the route segments informations
-		 * @param array $segements the route segments information
-		 * 
-		 * @return object
-		 */
-		public function setRouteSegments(array $segments = array()){
-			if(! empty($segments)){
-				$this->segments = $segments;
-			} else if (!empty($this->uri)) {
-				$this->segments = explode('/', $this->uri);
-			}
-			$segment = $this->segments;
-			$baseUrl = get_config('base_url');
-			//check if the app is not in DOCUMENT_ROOT
-			if(isset($segment[0]) && stripos($baseUrl, $segment[0]) !== false){
-				array_shift($segment);
-				$this->segments = $segment;
-			}
-			$this->logger->debug('Check if the request URI contains the front controller');
-			if(isset($segment[0]) && $segment[0] == SELF){
-				$this->logger->info('The request URI contains the front controller');
-				array_shift($segment);
-				$this->segments = $segment;
-			}
-			return $this;
-		}
-
-		/**
-		 * Setting the route parameters like module, controller, method, argument
-		 * @return object the current instance
-		 */
-		public function determineRouteParamsInformation() {
-			$this->logger->debug('Routing process start ...');
+        /**
+         * Get the controller name
+         * @return string
+         */
+        public function getController(){
+            return $this->controller;
+        }
+
+        /**
+         * Get the controller file path
+         * @return string
+         */
+        public function getControllerPath(){
+            return $this->controllerPath;
+        }
+
+        /**
+         * Get the controller method
+         * @return string
+         */
+        public function getMethod(){
+            return $this->method;
+        }
+
+        /**
+         * Get the request arguments
+         * @return array
+         */
+        public function getArgs(){
+            return $this->args;
+        }
+
+        /**
+         * Get the URL segments array
+         * @return array
+         */
+        public function getSegments(){
+            return $this->segments;
+        }
+
+        /**
+         * Get the route URI
+         * @return string
+         */
+        public function getRouteUri(){
+            return $this->uri;
+        }
+
+        /**
+         * Add the URI and callback to the list of URIs to validate
+         *
+         * @param string $uri the request URI
+         * @param string $callback the callback function
+         *
+         * @return object the current instance
+         */
+        public function add($uri, $callback) {
+            $uri = trim($uri, $this->uriTrim);
+            if(in_array($uri, $this->pattern)){
+                $this->logger->warning('The route [' . $uri . '] already added, may be adding again can have route conflict');
+            }
+            $this->pattern[] = $uri;
+            $this->callback[] = $callback;
+            return $this;
+        }
+
+        /**
+         * Remove the route configuration
+         *
+         * @param string $uri the URI
+         *
+         * @return object the current instance
+         */
+        public function removeRoute($uri) {
+            $index  = array_search($uri, $this->pattern, true);
+            if($index !== false){
+                $this->logger->info('Remove route for uri [' . $uri . '] from the configuration');
+                unset($this->pattern[$index]);
+                unset($this->callback[$index]);
+            }
+            return $this;
+        }
+
+
+        /**
+         * Remove all the routes from the configuration
+         *
+         * @return object the current instance
+         */
+        public function removeAllRoute() {
+            $this->logger->info('Remove all routes from the configuration');
+            $this->pattern  = array();
+            $this->callback = array();
+            $this->routes = array();
+            return $this;
+        }
+
+
+        /**
+         * Set the route URI to use later
+         * @param string $uri the route URI, if is empty will determine automatically
+         * @return object
+         */
+        public function setRouteUri($uri = ''){
+            $routeUri = '';
+            if(! empty($uri)){
+                $routeUri = $uri;
+            }
+            //if the application is running in CLI mode use the first argument
+            else if(IS_CLI && isset($_SERVER['argv'][1])){
+                $routeUri = $_SERVER['argv'][1];
+            }
+            else if(isset($_SERVER['REQUEST_URI'])){
+                $routeUri = $_SERVER['REQUEST_URI'];
+            }
+            $this->logger->debug('Check if URL suffix is enabled in the configuration');
+            //remove url suffix from the request URI
+            $suffix = get_config('url_suffix');
+            if ($suffix) {
+                $this->logger->info('URL suffix is enabled in the configuration, the value is [' . $suffix . ']' );
+                $routeUri = str_ireplace($suffix, '', $routeUri);
+            } 
+            if (strpos($routeUri, '?') !== false){
+                $routeUri = substr($routeUri, 0, strpos($routeUri, '?'));
+            }
+            $this->uri = trim($routeUri, $this->uriTrim);
+            return $this;
+        }
+
+            /**
+             * Set the route segments informations
+             * @param array $segements the route segments information
+             * 
+             * @return object
+             */
+        public function setRouteSegments(array $segments = array()){
+            if(! empty($segments)){
+                $this->segments = $segments;
+            } else if (!empty($this->uri)) {
+                $this->segments = explode('/', $this->uri);
+            }
+            $segment = $this->segments;
+            $baseUrl = get_config('base_url');
+            //check if the app is not in DOCUMENT_ROOT
+            if(isset($segment[0]) && stripos($baseUrl, $segment[0]) !== false){
+                array_shift($segment);
+                $this->segments = $segment;
+            }
+            $this->logger->debug('Check if the request URI contains the front controller');
+            if(isset($segment[0]) && $segment[0] == SELF){
+                $this->logger->info('The request URI contains the front controller');
+                array_shift($segment);
+                $this->segments = $segment;
+            }
+            return $this;
+        }
+
+        /**
+         * Setting the route parameters like module, controller, method, argument
+         * @return object the current instance
+         */
+        public function determineRouteParamsInformation() {
+            $this->logger->debug('Routing process start ...');
 			
-			//determine route parameters using the config
-			$this->determineRouteParamsFromConfig();
+            //determine route parameters using the config
+            $this->determineRouteParamsFromConfig();
 			
-			//if can not determine the module/controller/method via the defined routes configuration we will use
-			//the URL like http://domain.com/module/controller/method/arg1/arg2
-			if(! $this->controller){
-				$this->logger->info('Cannot determine the routing information using the predefined routes configuration, will use the request URI parameters');
-				//determine route parameters using the REQUEST_URI param
-				$this->determineRouteParamsFromRequestUri();
-			}
-			//Set the controller file path if not yet set
-			$this->setControllerFilePath();
-			$this->logger->debug('Routing process end.');
-
-			return $this;
-		}
+            //if can not determine the module/controller/method via the defined routes configuration we will use
+            //the URL like http://domain.com/module/controller/method/arg1/arg2
+            if(! $this->controller){
+                $this->logger->info('Cannot determine the routing information using the predefined routes configuration, will use the request URI parameters');
+                //determine route parameters using the REQUEST_URI param
+                $this->determineRouteParamsFromRequestUri();
+            }
+            //Set the controller file path if not yet set
+            $this->setControllerFilePath();
+            $this->logger->debug('Routing process end.');
+
+            return $this;
+        }
 	
-		 /**
-		 * Routing the request to the correspondant module/controller/method if exists
-		 * otherwise send 404 error.
-		 */
-	    public function processRequest(){
-	    	//Setting the route URI
-			$this->setRouteUri();
-
-			//setting route segments
-			$this->setRouteSegments();
-
-			$this->logger->info('The final Request URI is [' . implode('/', $this->segments) . ']' );
-
-	    	//determine the route parameters information
-	    	$this->determineRouteParamsInformation();
-
-	    	$e404 = false;
-	    	$classFilePath = $this->controllerPath;
-	    	$controller = ucfirst($this->controller);
-	    	$this->logger->info('The routing information are: module [' . $this->module . '], controller [' . $controller . '], method [' . $this->method . '], args [' . stringfy_vars($this->args) . ']');
-	    	$this->logger->debug('Loading controller [' . $controller . '], the file path is [' . $classFilePath . ']...');
+            /**
+             * Routing the request to the correspondant module/controller/method if exists
+             * otherwise send 404 error.
+             */
+        public function processRequest(){
+            //Setting the route URI
+            $this->setRouteUri();
+
+            //setting route segments
+            $this->setRouteSegments();
+
+            $this->logger->info('The final Request URI is [' . implode('/', $this->segments) . ']' );
+
+            //determine the route parameters information
+            $this->determineRouteParamsInformation();
+
+            $e404 = false;
+            $classFilePath = $this->controllerPath;
+            $controller = ucfirst($this->controller);
+            $this->logger->info('The routing information are: module [' . $this->module . '], controller [' . $controller . '], method [' . $this->method . '], args [' . stringfy_vars($this->args) . ']');
+            $this->logger->debug('Loading controller [' . $controller . '], the file path is [' . $classFilePath . ']...');
 	    	
-			if(file_exists($classFilePath)){
-				require_once $classFilePath;
-				if(! class_exists($controller, false)){
-					$e404 = true;
-					$this->logger->warning('The controller file [' .$classFilePath. '] exists but does not contain the class [' . $controller . ']');
-				}
-				else{
-					$controllerInstance = new $controller();
-					$controllerMethod = $this->getMethod();
-					if(! method_exists($controllerInstance, $controllerMethod)){
-						$e404 = true;
-						$this->logger->warning('The controller [' . $controller . '] exist but does not contain the method [' . $controllerMethod . ']');
-					}
-					else{
-						$this->logger->info('Routing data is set correctly now GO!');
-						call_user_func_array(array($controllerInstance, $controllerMethod), $this->args);
-						//render the final page to user
-						$this->logger->info('Render the final output to the browser');
-						get_instance()->response->renderFinalPage();
-					}
-				}
-			}
-			else{
-				$this->logger->info('The controller file path [' . $classFilePath . '] does not exist');
-				$e404 = true;
-			}
-			if($e404){
-				if(IS_CLI){
-					set_http_status_header(404);
-					echo 'Error 404: page not found.';
-				} else {
-					$response =& class_loader('Response', 'classes');
-					$response->send404();
-				}
-			}
-	    }
-
-
-	    /**
-	    * Setting the route configuration using the configuration file and additional configuration from param
-	    * @param array $overwriteConfig the additional configuration to overwrite with the existing one
-	    * @param boolean $useConfigFile whether to use route configuration file
-		* @return object
-	    */
-	    public function setRouteConfiguration(array $overwriteConfig = array(), $useConfigFile = true){
-	        $route = array();
-	        if ($useConfigFile && file_exists(CONFIG_PATH . 'routes.php')){
-	            require_once CONFIG_PATH . 'routes.php';
-	        }
-	        $route = array_merge($route, $overwriteConfig);
-	        $this->routes = $route;
-	        //if route is empty remove all configuration
-	        if(empty($route)){
-	        	$this->removeAllRoute();
-	        }
-			return $this;
-	    }
-
-	     /**
-		 * Get the route configuration
-		 * @return array
-		 */
-		public function getRouteConfiguration(){
-			return $this->routes;
-		}
+            if(file_exists($classFilePath)){
+                require_once $classFilePath;
+                if(! class_exists($controller, false)){
+                    $e404 = true;
+                    $this->logger->warning('The controller file [' .$classFilePath. '] exists but does not contain the class [' . $controller . ']');
+                }
+                else{
+                    $controllerInstance = new $controller();
+                    $controllerMethod = $this->getMethod();
+                    if(! method_exists($controllerInstance, $controllerMethod)){
+                        $e404 = true;
+                        $this->logger->warning('The controller [' . $controller . '] exist but does not contain the method [' . $controllerMethod . ']');
+                    }
+                    else{
+                        $this->logger->info('Routing data is set correctly now GO!');
+                        call_user_func_array(array($controllerInstance, $controllerMethod), $this->args);
+                        //render the final page to user
+                        $this->logger->info('Render the final output to the browser');
+                        get_instance()->response->renderFinalPage();
+                    }
+                }
+            }
+            else{
+                $this->logger->info('The controller file path [' . $classFilePath . '] does not exist');
+                $e404 = true;
+            }
+            if($e404){
+                if(IS_CLI){
+                    set_http_status_header(404);
+                    echo 'Error 404: page not found.';
+                } else {
+                    $response =& class_loader('Response', 'classes');
+                    $response->send404();
+                }
+            }
+        }
+
+
+        /**
+         * Setting the route configuration using the configuration file and additional configuration from param
+         * @param array $overwriteConfig the additional configuration to overwrite with the existing one
+         * @param boolean $useConfigFile whether to use route configuration file
+         * @return object
+         */
+        public function setRouteConfiguration(array $overwriteConfig = array(), $useConfigFile = true){
+            $route = array();
+            if ($useConfigFile && file_exists(CONFIG_PATH . 'routes.php')){
+                require_once CONFIG_PATH . 'routes.php';
+            }
+            $route = array_merge($route, $overwriteConfig);
+            $this->routes = $route;
+            //if route is empty remove all configuration
+            if(empty($route)){
+                $this->removeAllRoute();
+            }
+            return $this;
+        }
+
+            /**
+             * Get the route configuration
+             * @return array
+             */
+        public function getRouteConfiguration(){
+            return $this->routes;
+        }
 
 	    
-	    /**
-	     * Set the controller file path if is not set
-	     * @param string $path the file path if is null will using the route 
-	     * information
-	     *
-	     * @return object the current instance
-	     */
-	    public function setControllerFilePath($path = null){
-	    	if($path !== null){
-	    		$this->controllerPath = $path;
-	    		return $this;
-	    	}
-	    	//did we set the controller, so set the controller path
-			if($this->controller && ! $this->controllerPath){
-				$this->logger->debug('Setting the file path for the controller [' . $this->controller . ']');
-				$controllerPath = APPS_CONTROLLER_PATH . ucfirst($this->controller) . '.php';
-				//if the controller is in module
-				if($this->module){
-					$path = Module::findControllerFullPath(ucfirst($this->controller), $this->module);
-					if($path !== false){
-						$controllerPath = $path;
-					}
-				}
-				$this->controllerPath = $controllerPath;
-			}
-			return $this;
-	    }
-
-	    /**
-	     * Determine the route parameters from route configuration
-	     * @return void
-	     */
-	    protected function determineRouteParamsFromConfig(){
-	    	$uri = implode('/', $this->segments);
-	    	/*
+        /**
+         * Set the controller file path if is not set
+         * @param string $path the file path if is null will using the route 
+         * information
+         *
+         * @return object the current instance
+         */
+        public function setControllerFilePath($path = null){
+            if($path !== null){
+                $this->controllerPath = $path;
+                return $this;
+            }
+            //did we set the controller, so set the controller path
+            if($this->controller && ! $this->controllerPath){
+                $this->logger->debug('Setting the file path for the controller [' . $this->controller . ']');
+                $controllerPath = APPS_CONTROLLER_PATH . ucfirst($this->controller) . '.php';
+                //if the controller is in module
+                if($this->module){
+                    $path = Module::findControllerFullPath(ucfirst($this->controller), $this->module);
+                    if($path !== false){
+                        $controllerPath = $path;
+                    }
+                }
+                $this->controllerPath = $controllerPath;
+            }
+            return $this;
+        }
+
+        /**
+         * Determine the route parameters from route configuration
+         * @return void
+         */
+        protected function determineRouteParamsFromConfig(){
+            $uri = implode('/', $this->segments);
+            /*
 	   		* Generics routes patterns
 	    	*/
-			$pattern = array(':num', ':alpha', ':alnum', ':any');
-			$replace = array('[0-9]+', '[a-zA-Z]+', '[a-zA-Z0-9]+', '.*');
-
-			$this->logger->debug(
-									'Begin to loop in the predefined routes configuration ' 
-									. 'to check if the current request match'
-									);
-
-			// Cycle through the URIs stored in the array
-			foreach ($this->pattern as $index => $uriList) {
-				$uriList = str_ireplace($pattern, $replace, $uriList);
-				// Check for an existant matching URI
-				if (preg_match("#^$uriList$#", $uri, $args)) {
-					$this->logger->info(
-										'Route found for request URI [' . $uri . '] using the predefined configuration '
-										. ' [' . $this->pattern[$index] . '] --> [' . $this->callback[$index] . ']'
-									);
-					array_shift($args);
-					//check if this contains an module
-					$moduleControllerMethod = explode('#', $this->callback[$index]);
-					if(is_array($moduleControllerMethod) && count($moduleControllerMethod) >= 2){
-						$this->logger->info('The current request use the module [' . $moduleControllerMethod[0] . ']');
-						$this->module = $moduleControllerMethod[0];
-						$moduleControllerMethod = explode('@', $moduleControllerMethod[1]);
-					}
-					else{
-						$this->logger->info('The current request does not use the module');
-						$moduleControllerMethod = explode('@', $this->callback[$index]);
-					}
-					if(is_array($moduleControllerMethod)){
-						if(isset($moduleControllerMethod[0])){
-							$this->controller = $moduleControllerMethod[0];	
-						}
-						if(isset($moduleControllerMethod[1])){
-							$this->method = $moduleControllerMethod[1];
-						}
-						$this->args = $args;
-					}
-					// stop here
-					break;
-				}
-			}
-
-			//first if the controller is not set and the module is set use the module name as the controller
-			if(! $this->controller && $this->module){
-				$this->logger->info(
-									'After loop in predefined routes configuration, 
+            $pattern = array(':num', ':alpha', ':alnum', ':any');
+            $replace = array('[0-9]+', '[a-zA-Z]+', '[a-zA-Z0-9]+', '.*');
+
+            $this->logger->debug(
+                                    'Begin to loop in the predefined routes configuration ' 
+                                    . 'to check if the current request match'
+                                    );
+
+            // Cycle through the URIs stored in the array
+            foreach ($this->pattern as $index => $uriList) {
+                $uriList = str_ireplace($pattern, $replace, $uriList);
+                // Check for an existant matching URI
+                if (preg_match("#^$uriList$#", $uri, $args)) {
+                    $this->logger->info(
+                                        'Route found for request URI [' . $uri . '] using the predefined configuration '
+                                        . ' [' . $this->pattern[$index] . '] --> [' . $this->callback[$index] . ']'
+                                    );
+                    array_shift($args);
+                    //check if this contains an module
+                    $moduleControllerMethod = explode('#', $this->callback[$index]);
+                    if(is_array($moduleControllerMethod) && count($moduleControllerMethod) >= 2){
+                        $this->logger->info('The current request use the module [' . $moduleControllerMethod[0] . ']');
+                        $this->module = $moduleControllerMethod[0];
+                        $moduleControllerMethod = explode('@', $moduleControllerMethod[1]);
+                    }
+                    else{
+                        $this->logger->info('The current request does not use the module');
+                        $moduleControllerMethod = explode('@', $this->callback[$index]);
+                    }
+                    if(is_array($moduleControllerMethod)){
+                        if(isset($moduleControllerMethod[0])){
+                            $this->controller = $moduleControllerMethod[0];	
+                        }
+                        if(isset($moduleControllerMethod[1])){
+                            $this->method = $moduleControllerMethod[1];
+                        }
+                        $this->args = $args;
+                    }
+                    // stop here
+                    break;
+                }
+            }
+
+            //first if the controller is not set and the module is set use the module name as the controller
+            if(! $this->controller && $this->module){
+                $this->logger->info(
+                                    'After loop in predefined routes configuration, 
 									the module name is set but the controller is not set, 
 									so we will use module as the controller'
-								);
-				$this->controller = $this->module;
-			}
-	    }
-
-	    /**
-	     * Determine the route parameters using the server variable "REQUEST_URI"
-	     * @return void
-	     */
-	    protected function determineRouteParamsFromRequestUri(){
-	    	$segment = $this->segments;
-	    	$nbSegment = count($segment);
-			//if segment is null so means no need to perform
-			if($nbSegment > 0){
-				//get the module list
-				$modules = Module::getModuleList();
-				//first check if no module
-				if(empty($modules)){
-					$this->logger->info('No module was loaded will skip the module checking');
-					//the application don't use module
-					//controller
-					if(isset($segment[0])){
-						$this->controller = $segment[0];
-						array_shift($segment);
-					}
-					//method
-					if(isset($segment[0])){
-						$this->method = $segment[0];
-						array_shift($segment);
-					}
-					//args
-					$this->args = $segment;
-				}
-				else{
-					$this->logger->info('The application contains a loaded module will check if the current request is found in the module list');
-					if(in_array($segment[0], $modules)){
-						$this->logger->info('Found, the current request use the module [' . $segment[0] . ']');
-						$this->module = $segment[0];
-						array_shift($segment);
-						//check if the second arg is the controller from module
-						if(isset($segment[0])){
-							$this->controller = $segment[0];
-							//check if the request use the same module name and controller
-							$path = Module::findControllerFullPath(ucfirst($this->controller), $this->module);
-							if(! $path){
-								$this->logger->info('The controller [' . $this->controller . '] not found in the module, may be will use the module [' . $this->module . '] as controller');
-								$this->controller = $this->module;
-							}
-							else{
-								$this->controllerPath = $path;
-								array_shift($segment);
-							}
-						}
-						//check for method
-						if(isset($segment[0])){
-							$this->method = $segment[0];
-							array_shift($segment);
-						}
-						//the remaining is for args
-						$this->args = $segment;
-					}
-					else{
-						$this->logger->info('The current request information is not found in the module list');
-						//controller
-						if(isset($segment[0])){
-							$this->controller = $segment[0];
-							array_shift($segment);
-						}
-						//method
-						if(isset($segment[0])){
-							$this->method = $segment[0];
-							array_shift($segment);
-						}
-						//args
-						$this->args = $segment;
-					}
-				}
-				if(! $this->controller && $this->module){
-					$this->logger->info('After using the request URI the module name is set but the controller is not set so we will use module as the controller');
-					$this->controller = $this->module;
-				}
-			}
-	    }
-
-	    /**
-	     * Set the route informations using the configuration
-	     *
-	     * @return object the current instance
-	     */
-	    protected function setRouteConfigurationInfos(){
-	    	//adding route
-			foreach($this->routes as $pattern => $callback){
-				$this->add($pattern, $callback);
-			}
-			return $this;
-		}
-	}
+                                );
+                $this->controller = $this->module;
+            }
+        }
+
+        /**
+         * Determine the route parameters using the server variable "REQUEST_URI"
+         * @return void
+         */
+        protected function determineRouteParamsFromRequestUri(){
+            $segment = $this->segments;
+            $nbSegment = count($segment);
+            //if segment is null so means no need to perform
+            if($nbSegment > 0){
+                //get the module list
+                $modules = Module::getModuleList();
+                //first check if no module
+                if(empty($modules)){
+                    $this->logger->info('No module was loaded will skip the module checking');
+                    //the application don't use module
+                    //controller
+                    if(isset($segment[0])){
+                        $this->controller = $segment[0];
+                        array_shift($segment);
+                    }
+                    //method
+                    if(isset($segment[0])){
+                        $this->method = $segment[0];
+                        array_shift($segment);
+                    }
+                    //args
+                    $this->args = $segment;
+                }
+                else{
+                    $this->logger->info('The application contains a loaded module will check if the current request is found in the module list');
+                    if(in_array($segment[0], $modules)){
+                        $this->logger->info('Found, the current request use the module [' . $segment[0] . ']');
+                        $this->module = $segment[0];
+                        array_shift($segment);
+                        //check if the second arg is the controller from module
+                        if(isset($segment[0])){
+                            $this->controller = $segment[0];
+                            //check if the request use the same module name and controller
+                            $path = Module::findControllerFullPath(ucfirst($this->controller), $this->module);
+                            if(! $path){
+                                $this->logger->info('The controller [' . $this->controller . '] not found in the module, may be will use the module [' . $this->module . '] as controller');
+                                $this->controller = $this->module;
+                            }
+                            else{
+                                $this->controllerPath = $path;
+                                array_shift($segment);
+                            }
+                        }
+                        //check for method
+                        if(isset($segment[0])){
+                            $this->method = $segment[0];
+                            array_shift($segment);
+                        }
+                        //the remaining is for args
+                        $this->args = $segment;
+                    }
+                    else{
+                        $this->logger->info('The current request information is not found in the module list');
+                        //controller
+                        if(isset($segment[0])){
+                            $this->controller = $segment[0];
+                            array_shift($segment);
+                        }
+                        //method
+                        if(isset($segment[0])){
+                            $this->method = $segment[0];
+                            array_shift($segment);
+                        }
+                        //args
+                        $this->args = $segment;
+                    }
+                }
+                if(! $this->controller && $this->module){
+                    $this->logger->info('After using the request URI the module name is set but the controller is not set so we will use module as the controller');
+                    $this->controller = $this->module;
+                }
+            }
+        }
+
+        /**
+         * Set the route informations using the configuration
+         *
+         * @return object the current instance
+         */
+        protected function setRouteConfigurationInfos(){
+            //adding route
+            foreach($this->routes as $pattern => $callback){
+                $this->add($pattern, $callback);
+            }
+            return $this;
+        }
+    }

core/classes/Session.php

Indentation +138 added lines, -138 removed lines

@@ -1,150 +1,150 @@
 <?php
-	defined('ROOT_PATH') or exit('Access denied');
-	/**
-	 * TNH Framework
-	 *
-	 * A simple PHP framework using HMVC architecture
-	 *
-	 * This content is released under the GNU GPL License (GPL)
-	 *
-	 * Copyright (C) 2017 Tony NGUEREZA
-	 *
-	 * This program is free software; you can redistribute it and/or
-	 * modify it under the terms of the GNU General Public License
-	 * as published by the Free Software Foundation; either version 3
-	 * of the License, or (at your option) any later version.
-	 *
-	 * This program 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 General Public License for more details.
-	 *
-	 * You should have received a copy of the GNU General Public License
-	 * along with this program; if not, write to the Free Software
-	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-	*/
-	class Session extends BaseStaticClass{
+    defined('ROOT_PATH') or exit('Access denied');
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program 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 General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
+    class Session extends BaseStaticClass{
 		
-		/**
-		 * The session flash key to use
-		 * @const
-		 */
-		const SESSION_FLASH_KEY = 'session_flash';
+        /**
+         * The session flash key to use
+         * @const
+         */
+        const SESSION_FLASH_KEY = 'session_flash';
 
-		/**
-		 * Get the session item value
-		 * @param  string $item    the session item name to get
-		 * @param  mixed $default the default value to use if can not find the session item in the list
-		 * @return mixed          the session value if exist or the default value
-		 */
-		public static function get($item, $default = null){
-			$logger = self::getLogger();
-			$logger->debug('Getting session data for item [' .$item. '] ...');
-			if(array_key_exists($item, $_SESSION)){
-				$logger->info('Found session data for item [' . $item . '] the vaue is : [' . stringfy_vars($_SESSION[$item]) . ']');
-				return $_SESSION[$item];
-			}
-			$logger->warning('Cannot find session item [' . $item . '] using the default value ['. $default . ']');
-			return $default;
-		}
+        /**
+         * Get the session item value
+         * @param  string $item    the session item name to get
+         * @param  mixed $default the default value to use if can not find the session item in the list
+         * @return mixed          the session value if exist or the default value
+         */
+        public static function get($item, $default = null){
+            $logger = self::getLogger();
+            $logger->debug('Getting session data for item [' .$item. '] ...');
+            if(array_key_exists($item, $_SESSION)){
+                $logger->info('Found session data for item [' . $item . '] the vaue is : [' . stringfy_vars($_SESSION[$item]) . ']');
+                return $_SESSION[$item];
+            }
+            $logger->warning('Cannot find session item [' . $item . '] using the default value ['. $default . ']');
+            return $default;
+        }
 
-		/**
-		 * Set the session item value
-		 * @param string $item  the session item name to set
-		 * @param mixed $value the session item value
-		 */
-		public static function set($item, $value){
-			$logger = self::getLogger();
-			$logger->debug('Setting session data for item [' . $item . '], value [' . stringfy_vars($value) . ']');
-			$_SESSION[$item] = $value;
-		}
+        /**
+         * Set the session item value
+         * @param string $item  the session item name to set
+         * @param mixed $value the session item value
+         */
+        public static function set($item, $value){
+            $logger = self::getLogger();
+            $logger->debug('Setting session data for item [' . $item . '], value [' . stringfy_vars($value) . ']');
+            $_SESSION[$item] = $value;
+        }
 
-		/**
-		 * Get the session flash item value
-		 * @param  string $item    the session flash item name to get
-		 * @param  mixed $default the default value to use if can not find the session flash item in the list
-		 * @return mixed          the session flash value if exist or the default value
-		 */
-		public static function getFlash($item, $default = null){
-			$logger = self::getLogger();
-			$key = self::SESSION_FLASH_KEY.'_'.$item;
-			$return = array_key_exists($key, $_SESSION) ?
-			($_SESSION[$key]) : $default;
-			if(array_key_exists($key, $_SESSION)){
-				unset($_SESSION[$key]);
-			}
-			else{
-				$logger->warning('Cannot find session flash item ['. $key .'] using the default value ['. $default .']');
-			}
-			return $return;
-		}
+        /**
+         * Get the session flash item value
+         * @param  string $item    the session flash item name to get
+         * @param  mixed $default the default value to use if can not find the session flash item in the list
+         * @return mixed          the session flash value if exist or the default value
+         */
+        public static function getFlash($item, $default = null){
+            $logger = self::getLogger();
+            $key = self::SESSION_FLASH_KEY.'_'.$item;
+            $return = array_key_exists($key, $_SESSION) ?
+            ($_SESSION[$key]) : $default;
+            if(array_key_exists($key, $_SESSION)){
+                unset($_SESSION[$key]);
+            }
+            else{
+                $logger->warning('Cannot find session flash item ['. $key .'] using the default value ['. $default .']');
+            }
+            return $return;
+        }
 
-		/**
-		 * Check whether the given session flash item exists
-		 * @param  string  $item the session flash item name
-		 * @return boolean 
-		 */
-		public static function hasFlash($item){
-			$key = self::SESSION_FLASH_KEY.'_'.$item;
-			return array_key_exists($key, $_SESSION);
-		}
+        /**
+         * Check whether the given session flash item exists
+         * @param  string  $item the session flash item name
+         * @return boolean 
+         */
+        public static function hasFlash($item){
+            $key = self::SESSION_FLASH_KEY.'_'.$item;
+            return array_key_exists($key, $_SESSION);
+        }
 
-		/**
-		 * Set the session flash item value
-		 * @param string $item  the session flash item name to set
-		 * @param mixed $value the session flash item value
-		 */
-		public static function setFlash($item, $value){
-			$key = self::SESSION_FLASH_KEY.'_'.$item;
-			$_SESSION[$key] = $value;
-		}
+        /**
+         * Set the session flash item value
+         * @param string $item  the session flash item name to set
+         * @param mixed $value the session flash item value
+         */
+        public static function setFlash($item, $value){
+            $key = self::SESSION_FLASH_KEY.'_'.$item;
+            $_SESSION[$key] = $value;
+        }
 
-		/**
-		 * Clear the session item in the list
-		 * @param  string $item the session item name to be deleted
-		 */
-		public static function clear($item){
-			$logger = self::getLogger();
-			if(array_key_exists($item, $_SESSION)){
-				$logger->info('Deleting of session for item ['.$item.' ]');
-				unset($_SESSION[$item]);
-			}
-			else{
-				$logger->warning('Session item ['.$item.'] to be deleted does not exists');
-			}
-		}
+        /**
+         * Clear the session item in the list
+         * @param  string $item the session item name to be deleted
+         */
+        public static function clear($item){
+            $logger = self::getLogger();
+            if(array_key_exists($item, $_SESSION)){
+                $logger->info('Deleting of session for item ['.$item.' ]');
+                unset($_SESSION[$item]);
+            }
+            else{
+                $logger->warning('Session item ['.$item.'] to be deleted does not exists');
+            }
+        }
 		
-		/**
-		 * Clear the session flash item in the list
-		 * @param  string $item the session flash item name to be deleted
-		 */
-		public static function clearFlash($item){
-			$logger = self::getLogger();
-			$key = self::SESSION_FLASH_KEY.'_'.$item;
-			if(array_key_exists($key, $_SESSION)){
-				$logger->info('Delete session flash for item ['.$item.']');
-				unset($_SESSION[$item]);
-			}
-			else{
-				$logger->warning('Dession flash item ['.$item.'] to be deleted does not exists');
-			}
-		}
+        /**
+         * Clear the session flash item in the list
+         * @param  string $item the session flash item name to be deleted
+         */
+        public static function clearFlash($item){
+            $logger = self::getLogger();
+            $key = self::SESSION_FLASH_KEY.'_'.$item;
+            if(array_key_exists($key, $_SESSION)){
+                $logger->info('Delete session flash for item ['.$item.']');
+                unset($_SESSION[$item]);
+            }
+            else{
+                $logger->warning('Dession flash item ['.$item.'] to be deleted does not exists');
+            }
+        }
 
-		/**
-		 * Check whether the given session item exists
-		 * @param  string  $item the session item name
-		 * @return boolean 
-		 */
-		public static function exists($item){
-			return array_key_exists($item, $_SESSION);
-		}
+        /**
+         * Check whether the given session item exists
+         * @param  string  $item the session item name
+         * @return boolean 
+         */
+        public static function exists($item){
+            return array_key_exists($item, $_SESSION);
+        }
 
-		/**
-		 * Destroy all session data values
-		 */
-		public static function clearAll(){
-			session_unset();
-			session_destroy();
-		}
+        /**
+         * Destroy all session data values
+         */
+        public static function clearAll(){
+            session_unset();
+            session_destroy();
+        }
 
-	}
+    }

core/classes/cache/ApcCache.php

Indentation +165 added lines, -165 removed lines

@@ -1,183 +1,183 @@
 <?php
-	defined('ROOT_PATH') or exit('Access denied');
-	/**
-	 * TNH Framework
-	 *
-	 * A simple PHP framework using HMVC architecture
-	 *
-	 * This content is released under the GNU GPL License (GPL)
-	 *
-	 * Copyright (C) 2017 Tony NGUEREZA
-	 *
-	 * This program is free software; you can redistribute it and/or
-	 * modify it under the terms of the GNU General Public License
-	 * as published by the Free Software Foundation; either version 3
-	 * of the License, or (at your option) any later version.
-	 *
-	 * This program 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 General Public License for more details.
-	 *
-	 * You should have received a copy of the GNU General Public License
-	 * along with this program; if not, write to the Free Software
-	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-	*/
+    defined('ROOT_PATH') or exit('Access denied');
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program 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 General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
 	
-	class ApcCache extends BaseClass implements CacheInterface{
+    class ApcCache extends BaseClass implements CacheInterface{
 
 		
 		
-		public function __construct(){
-			parent::__construct();
-			if(! $this->isSupported()){
-				show_error('The cache for APC[u] driver is not available. Check if APC[u] extension is loaded and enabled.');
-			}
-		}
+        public function __construct(){
+            parent::__construct();
+            if(! $this->isSupported()){
+                show_error('The cache for APC[u] driver is not available. Check if APC[u] extension is loaded and enabled.');
+            }
+        }
 
-		/**
-		 * This is used to get the cache data using the key
-		 * @param  string $key the key to identify the cache data
-		 * @return mixed      the cache data if exists else return false
-		 */
-		public function get($key){
-			$this->logger->debug('Getting cache data for key ['. $key .']');
-			$success = false;
-			$data = apc_fetch($key, $success);
-			if($success === false){
-				$this->logger->info('No cache found for the key ['. $key .'], return false');
-				return false;
-			}
-			else{
-				$cacheInfo = $this->_getCacheInfo($key);
-				$expire = time();
-				if($cacheInfo){
-					$expire = $cacheInfo['creation_time'] + $cacheInfo['ttl'];
-				}
-				$this->logger->info('The cache not yet expire, now return the cache data for key ['. $key .'], the cache will expire at [' . date('Y-m-d H:i:s', $expire) . ']');
-				return $data;
-			}
-		}
+        /**
+         * This is used to get the cache data using the key
+         * @param  string $key the key to identify the cache data
+         * @return mixed      the cache data if exists else return false
+         */
+        public function get($key){
+            $this->logger->debug('Getting cache data for key ['. $key .']');
+            $success = false;
+            $data = apc_fetch($key, $success);
+            if($success === false){
+                $this->logger->info('No cache found for the key ['. $key .'], return false');
+                return false;
+            }
+            else{
+                $cacheInfo = $this->_getCacheInfo($key);
+                $expire = time();
+                if($cacheInfo){
+                    $expire = $cacheInfo['creation_time'] + $cacheInfo['ttl'];
+                }
+                $this->logger->info('The cache not yet expire, now return the cache data for key ['. $key .'], the cache will expire at [' . date('Y-m-d H:i:s', $expire) . ']');
+                return $data;
+            }
+        }
 
 
-		/**
-		 * Save data to the cache
-		 * @param string  $key  the key to identify this cache data
-		 * @param mixed  $data the cache data to be saved
-		 * @param integer $ttl  the cache life time
-		 * @return boolean true if success otherwise will return false
-		 */
-		public function set($key, $data, $ttl = 0){
-			$expire = time() + $ttl;
-			$this->logger->debug('Setting cache data for key ['. $key .'], time to live [' .$ttl. '], expire at [' . date('Y-m-d H:i:s', $expire) . ']');
-			$result = apc_store($key, $data, $ttl);
-			if($result === false){
-		    	$this->logger->error('Can not write cache data for the key ['. $key .'], return false');
-		    	return false;
-		    }
-		    else{
-		    	$this->logger->info('Cache data saved for the key ['. $key .']');
-		    	return true;
-		    }
-		}
+        /**
+         * Save data to the cache
+         * @param string  $key  the key to identify this cache data
+         * @param mixed  $data the cache data to be saved
+         * @param integer $ttl  the cache life time
+         * @return boolean true if success otherwise will return false
+         */
+        public function set($key, $data, $ttl = 0){
+            $expire = time() + $ttl;
+            $this->logger->debug('Setting cache data for key ['. $key .'], time to live [' .$ttl. '], expire at [' . date('Y-m-d H:i:s', $expire) . ']');
+            $result = apc_store($key, $data, $ttl);
+            if($result === false){
+                $this->logger->error('Can not write cache data for the key ['. $key .'], return false');
+                return false;
+            }
+            else{
+                $this->logger->info('Cache data saved for the key ['. $key .']');
+                return true;
+            }
+        }
 
 
-		/**
-		 * Delete the cache data for given key
-		 * @param  string $key the key for cache to be deleted
-		 * @return boolean      true if the cache is deleted, false if can't delete 
-		 * the cache or the cache with the given key not exist
-		 */
-		public function delete($key){
-			$this->logger->debug('Deleting of cache data for key [' .$key. ']');
-			$cacheInfo = $this->_getCacheInfo($key);
-			if($cacheInfo === false){
-				$this->logger->info('This cache data does not exists skipping');
-				return false;
-			}
-			else{
-				$this->logger->info('Found cache data for the key [' .$key. '] remove it');
-	      		return apc_delete($key) === true;
-			}
-		}
+        /**
+         * Delete the cache data for given key
+         * @param  string $key the key for cache to be deleted
+         * @return boolean      true if the cache is deleted, false if can't delete 
+         * the cache or the cache with the given key not exist
+         */
+        public function delete($key){
+            $this->logger->debug('Deleting of cache data for key [' .$key. ']');
+            $cacheInfo = $this->_getCacheInfo($key);
+            if($cacheInfo === false){
+                $this->logger->info('This cache data does not exists skipping');
+                return false;
+            }
+            else{
+                $this->logger->info('Found cache data for the key [' .$key. '] remove it');
+                    return apc_delete($key) === true;
+            }
+        }
 		
-		/**
-		 * Get the cache information for given key
-		 * @param  string $key the key for cache to get the information for
-		 * @return boolean|array    the cache information. The associative array and must contains the following information:
-		 * 'mtime' => creation time of the cache (Unix timestamp),
-		 * 'expire' => expiration time of the cache (Unix timestamp),
-		 * 'ttl' => the time to live of the cache in second
-		 */
-		public function getInfo($key){
-			$this->logger->debug('Getting of cache info for key [' .$key. ']');
-			$cacheInfos = $this->_getCacheInfo($key);
-			if($cacheInfos){
-				$data = array(
-							'mtime' => $cacheInfos['creation_time'],
-							'expire' => $cacheInfos['creation_time'] + $cacheInfos['ttl'],
-							'ttl' => $cacheInfos['ttl']
-							);
-				return $data;
-			}
-			else{
-				$this->logger->info('This cache does not exists skipping');
-				return false;
-			}
-		}
+        /**
+         * Get the cache information for given key
+         * @param  string $key the key for cache to get the information for
+         * @return boolean|array    the cache information. The associative array and must contains the following information:
+         * 'mtime' => creation time of the cache (Unix timestamp),
+         * 'expire' => expiration time of the cache (Unix timestamp),
+         * 'ttl' => the time to live of the cache in second
+         */
+        public function getInfo($key){
+            $this->logger->debug('Getting of cache info for key [' .$key. ']');
+            $cacheInfos = $this->_getCacheInfo($key);
+            if($cacheInfos){
+                $data = array(
+                            'mtime' => $cacheInfos['creation_time'],
+                            'expire' => $cacheInfos['creation_time'] + $cacheInfos['ttl'],
+                            'ttl' => $cacheInfos['ttl']
+                            );
+                return $data;
+            }
+            else{
+                $this->logger->info('This cache does not exists skipping');
+                return false;
+            }
+        }
 
 
-		/**
-		 * Used to delete expired cache data
-		 */
-		public function deleteExpiredCache(){
-			//for APC[u] is done automatically
-			return true;
-		}
+        /**
+         * Used to delete expired cache data
+         */
+        public function deleteExpiredCache(){
+            //for APC[u] is done automatically
+            return true;
+        }
 
-		/**
-		 * Remove all cache data
-		 */
-		public function clean(){
-			$this->logger->debug('Deleting of all cache data');
-			$cacheInfos = apc_cache_info('user');
-			if(empty($cacheInfos['cache_list'])){
-				$this->logger->info('No cache data were found skipping');
-				return false;
-			}
-			else{
-				$this->logger->info('Found [' . count($cacheInfos) . '] cache data to remove');
-				return apc_clear_cache('user');
-			}
-		}
+        /**
+         * Remove all cache data
+         */
+        public function clean(){
+            $this->logger->debug('Deleting of all cache data');
+            $cacheInfos = apc_cache_info('user');
+            if(empty($cacheInfos['cache_list'])){
+                $this->logger->info('No cache data were found skipping');
+                return false;
+            }
+            else{
+                $this->logger->info('Found [' . count($cacheInfos) . '] cache data to remove');
+                return apc_clear_cache('user');
+            }
+        }
 		
 		
-		/**
-		 * Check whether the cache feature for the handle is supported
-		 *
-		 * @return bool
-		 */
-		public function isSupported(){
-			return (extension_loaded('apc') || extension_loaded('apcu')) && ini_get('apc.enabled');
-		}
+        /**
+         * Check whether the cache feature for the handle is supported
+         *
+         * @return bool
+         */
+        public function isSupported(){
+            return (extension_loaded('apc') || extension_loaded('apcu')) && ini_get('apc.enabled');
+        }
 		
-		/**
-		* Return the array of cache information
-		*
-		* @param string $key the cache key to get the cache information 
-		* @return boolean|array
-		*/
-		private function _getCacheInfo($key){
-			$caches = apc_cache_info('user');
-			if(! empty($caches['cache_list'])){
-				$cacheLists = $caches['cache_list'];
-				foreach ($cacheLists as $c){
-					if(isset($c['info']) && $c['info'] === $key){
-						return $c;
-					}
-				}
+        /**
+         * Return the array of cache information
+         *
+         * @param string $key the cache key to get the cache information 
+         * @return boolean|array
+         */
+        private function _getCacheInfo($key){
+            $caches = apc_cache_info('user');
+            if(! empty($caches['cache_list'])){
+                $cacheLists = $caches['cache_list'];
+                foreach ($cacheLists as $c){
+                    if(isset($c['info']) && $c['info'] === $key){
+                        return $c;
+                    }
+                }
 				
-			}
-			return false;
-		}
-	}
+            }
+            return false;
+        }
+    }

core/classes/cache/FileCache.php

Indentation +263 added lines, -263 removed lines

@@ -1,283 +1,283 @@
 <?php
-	defined('ROOT_PATH') or exit('Access denied');
-	/**
-	 * TNH Framework
-	 *
-	 * A simple PHP framework using HMVC architecture
-	 *
-	 * This content is released under the GNU GPL License (GPL)
-	 *
-	 * Copyright (C) 2017 Tony NGUEREZA
-	 *
-	 * This program is free software; you can redistribute it and/or
-	 * modify it under the terms of the GNU General Public License
-	 * as published by the Free Software Foundation; either version 3
-	 * of the License, or (at your option) any later version.
-	 *
-	 * This program 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 General Public License for more details.
-	 *
-	 * You should have received a copy of the GNU General Public License
-	 * along with this program; if not, write to the Free Software
-	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-	*/
+    defined('ROOT_PATH') or exit('Access denied');
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program 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 General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
 
-	class FileCache extends BaseClass implements CacheInterface{
+    class FileCache extends BaseClass implements CacheInterface{
 		
-		/**
-		 * Whether to enable compression of the cache data file.
-		 * @var boolean
-		 */
-		private $compressCacheData = true;
+        /**
+         * Whether to enable compression of the cache data file.
+         * @var boolean
+         */
+        private $compressCacheData = true;
 
-		/**
-		 * Class constructor
-		 */
-		public function __construct(){
-			parent::__construct();
-			if(! $this->isSupported()){
-				show_error('The cache for file system is not available. Check the cache directory if is exists or is writable.');
-			}
+        /**
+         * Class constructor
+         */
+        public function __construct(){
+            parent::__construct();
+            if(! $this->isSupported()){
+                show_error('The cache for file system is not available. Check the cache directory if is exists or is writable.');
+            }
 			
-			//if Zlib extension is not loaded set compressCacheData to false
-			if(! extension_loaded('zlib')){
-				$this->logger->warning('The zlib extension is not loaded set cache compress data to FALSE');
-				$this->compressCacheData = false;
-			}
-		}
+            //if Zlib extension is not loaded set compressCacheData to false
+            if(! extension_loaded('zlib')){
+                $this->logger->warning('The zlib extension is not loaded set cache compress data to FALSE');
+                $this->compressCacheData = false;
+            }
+        }
 
-		/**
-		 * This is used to get the cache data using the key
-		 * @param  string $key the key to identify the cache data
-		 * @return mixed      the cache data if exists else return false
-		 */
-		public function get($key){
-			$this->logger->debug('Getting cache data for key ['. $key .']');
-			$filePath = $this->getFilePath($key);
-			if(! file_exists($filePath)){
-				$this->logger->info('No cache file found for the key ['. $key .'], return false');
-				return false;
-			}
-			$this->logger->info('The cache file [' .$filePath. '] for the key ['. $key .'] exists, check if the cache data is valid');
-			$handle = fopen($filePath,'r');
-			if(! is_resource($handle)){
-				$this->logger->error('Can not open the file cache [' .$filePath. '] for the key ['. $key .'], return false');
-				return false;
-			}
-			// Getting a shared lock 
-		    flock($handle, LOCK_SH);
-		    $data = file_get_contents($filePath);
-      		fclose($handle);
-      		$data = @unserialize($this->compressCacheData ? gzinflate($data) : $data);
-      		if (! $data) {
-      			$this->logger->error('Can not unserialize the cache data for the key ['. $key .'], return false');
-		         // If unserializing somehow didn't work out, we'll delete the file
-		         unlink($filePath);
-		         return false;
-	      	}
-	      	if (time() > $data['expire']) {
-	      		$this->logger->info('The cache data for the key ['. $key .'] already expired delete the cache file [' .$filePath. ']');
-		        // Unlinking when the file was expired
-		        unlink($filePath);
-		        return false;
-		     }
-		     else{
-		     	$this->logger->info('The cache not yet expire, now return the cache data for key ['. $key .'], the cache will expire at [' . date('Y-m-d H:i:s', $data['expire']) . ']');
-		     	return $data['data'];
-		     }
-		}
+        /**
+         * This is used to get the cache data using the key
+         * @param  string $key the key to identify the cache data
+         * @return mixed      the cache data if exists else return false
+         */
+        public function get($key){
+            $this->logger->debug('Getting cache data for key ['. $key .']');
+            $filePath = $this->getFilePath($key);
+            if(! file_exists($filePath)){
+                $this->logger->info('No cache file found for the key ['. $key .'], return false');
+                return false;
+            }
+            $this->logger->info('The cache file [' .$filePath. '] for the key ['. $key .'] exists, check if the cache data is valid');
+            $handle = fopen($filePath,'r');
+            if(! is_resource($handle)){
+                $this->logger->error('Can not open the file cache [' .$filePath. '] for the key ['. $key .'], return false');
+                return false;
+            }
+            // Getting a shared lock 
+            flock($handle, LOCK_SH);
+            $data = file_get_contents($filePath);
+                fclose($handle);
+                $data = @unserialize($this->compressCacheData ? gzinflate($data) : $data);
+                if (! $data) {
+                    $this->logger->error('Can not unserialize the cache data for the key ['. $key .'], return false');
+                    // If unserializing somehow didn't work out, we'll delete the file
+                    unlink($filePath);
+                    return false;
+                }
+                if (time() > $data['expire']) {
+                    $this->logger->info('The cache data for the key ['. $key .'] already expired delete the cache file [' .$filePath. ']');
+                // Unlinking when the file was expired
+                unlink($filePath);
+                return false;
+                }
+                else{
+                    $this->logger->info('The cache not yet expire, now return the cache data for key ['. $key .'], the cache will expire at [' . date('Y-m-d H:i:s', $data['expire']) . ']');
+                    return $data['data'];
+                }
+        }
 
 
-		/**
-		 * Save data to the cache
-		 * @param string  $key  the key to identify this cache data
-		 * @param mixed  $data the cache data
-		 * @param integer $ttl  the cache life time
-		 * @return boolean true if success otherwise will return false
-		 */
-		public function set($key, $data, $ttl = 0){
-			$expire = time() + $ttl;
-			$this->logger->debug('Setting cache data for key ['. $key .'], time to live [' .$ttl. '], expire at [' . date('Y-m-d H:i:s', $expire) . ']');
-			$filePath = $this->getFilePath($key);
-			$handle = fopen($filePath,'w');
-			if(! is_resource($handle)){
-				$this->logger->error('Can not open the file cache [' .$filePath. '] for the key ['. $key .'], return false');
-				return false;
-			}
-			flock($handle, LOCK_EX); // exclusive lock, will get released when the file is closed
-			//Serializing along with the TTL
-		    $cacheData = serialize(array(
-									'mtime' => time(),
-									'expire' => $expire,
-									'data' => $data,
-									'ttl' => $ttl
-									)
-								);		   
-		    $result = fwrite($handle, $this->compressCacheData ? gzdeflate($cacheData, 9) : $cacheData);
-		    if(! $result){
-		    	$this->logger->error('Can not write cache data into file [' .$filePath. '] for the key ['. $key .'], return false');
-		    	fclose($handle);
-		    	return false;
-		    }
-		    else{
-		    	$this->logger->info('Cache data saved into file [' .$filePath. '] for the key ['. $key .']');
-		    	fclose($handle);
-				chmod($filePath, 0640);
-				return true;
-		    }
-		}	
+        /**
+         * Save data to the cache
+         * @param string  $key  the key to identify this cache data
+         * @param mixed  $data the cache data
+         * @param integer $ttl  the cache life time
+         * @return boolean true if success otherwise will return false
+         */
+        public function set($key, $data, $ttl = 0){
+            $expire = time() + $ttl;
+            $this->logger->debug('Setting cache data for key ['. $key .'], time to live [' .$ttl. '], expire at [' . date('Y-m-d H:i:s', $expire) . ']');
+            $filePath = $this->getFilePath($key);
+            $handle = fopen($filePath,'w');
+            if(! is_resource($handle)){
+                $this->logger->error('Can not open the file cache [' .$filePath. '] for the key ['. $key .'], return false');
+                return false;
+            }
+            flock($handle, LOCK_EX); // exclusive lock, will get released when the file is closed
+            //Serializing along with the TTL
+            $cacheData = serialize(array(
+                                    'mtime' => time(),
+                                    'expire' => $expire,
+                                    'data' => $data,
+                                    'ttl' => $ttl
+                                    )
+                                );		   
+            $result = fwrite($handle, $this->compressCacheData ? gzdeflate($cacheData, 9) : $cacheData);
+            if(! $result){
+                $this->logger->error('Can not write cache data into file [' .$filePath. '] for the key ['. $key .'], return false');
+                fclose($handle);
+                return false;
+            }
+            else{
+                $this->logger->info('Cache data saved into file [' .$filePath. '] for the key ['. $key .']');
+                fclose($handle);
+                chmod($filePath, 0640);
+                return true;
+            }
+        }	
 
 
-		/**
-		 * Delete the cache data for given key
-		 * @param  string $key the key for cache to be deleted
-		 * @return boolean      true if the cache is delete, false if can't delete 
-		 * the cache or the cache with the given key not exist
-		 */
-		public function delete($key){
-			$this->logger->debug('Deleting of cache data for key [' .$key. ']');
-			$filePath = $this->getFilePath($key);
-			$this->logger->info('The file path for the key [' .$key. '] is [' .$filePath. ']');
-			if(! file_exists($filePath)){
-				$this->logger->info('This cache file does not exists skipping');
-				return false;
-			}
-			else{
-				$this->logger->info('Found cache file [' .$filePath. '] remove it');
-	      		unlink($filePath);
-				return true;
-			}
-		}
+        /**
+         * Delete the cache data for given key
+         * @param  string $key the key for cache to be deleted
+         * @return boolean      true if the cache is delete, false if can't delete 
+         * the cache or the cache with the given key not exist
+         */
+        public function delete($key){
+            $this->logger->debug('Deleting of cache data for key [' .$key. ']');
+            $filePath = $this->getFilePath($key);
+            $this->logger->info('The file path for the key [' .$key. '] is [' .$filePath. ']');
+            if(! file_exists($filePath)){
+                $this->logger->info('This cache file does not exists skipping');
+                return false;
+            }
+            else{
+                $this->logger->info('Found cache file [' .$filePath. '] remove it');
+                    unlink($filePath);
+                return true;
+            }
+        }
 		
-		/**
-		 * Get the cache information for given key
-		 * @param  string $key the key for cache to get the information for
-		 * @return boolean|array    the cache information. The associative array and must contains the following information:
-		 * 'mtime' => creation time of the cache (Unix timestamp),
-		 * 'expire' => expiration time of the cache (Unix timestamp),
-		 * 'ttl' => the time to live of the cache in second
-		 */
-		public function getInfo($key){
-			$this->logger->debug('Getting of cache info for key [' .$key. ']');
-			$filePath = $this->getFilePath($key);
-			$this->logger->info('The file path for the key [' .$key. '] is [' .$filePath. ']');
-			if(! file_exists($filePath)){
-				$this->logger->info('This cache file does not exists skipping');
-				return false;
-			}
-			$this->logger->info('Found cache file [' .$filePath. '] check the validity');
-      		$data = file_get_contents($filePath);
-			$data = @unserialize($this->compressCacheData ? gzinflate($data) : $data);
-			if(! $data){
-				$this->logger->warning('Can not unserialize the cache data for file [' . $filePath . ']');
-				return false;
-			}
-			$this->logger->info('This cache data is OK check for expire');
-			if(isset($data['expire']) && $data['expire'] > time()){
-				$this->logger->info('This cache not yet expired return cache informations');
-				$info = array(
-					'mtime' => $data['mtime'],
-					'expire' => $data['expire'],
-					'ttl' => $data['ttl']
-					);
-				return $info;
-			}
-			$this->logger->info('This cache already expired return false');
-			return false;
-		}
+        /**
+         * Get the cache information for given key
+         * @param  string $key the key for cache to get the information for
+         * @return boolean|array    the cache information. The associative array and must contains the following information:
+         * 'mtime' => creation time of the cache (Unix timestamp),
+         * 'expire' => expiration time of the cache (Unix timestamp),
+         * 'ttl' => the time to live of the cache in second
+         */
+        public function getInfo($key){
+            $this->logger->debug('Getting of cache info for key [' .$key. ']');
+            $filePath = $this->getFilePath($key);
+            $this->logger->info('The file path for the key [' .$key. '] is [' .$filePath. ']');
+            if(! file_exists($filePath)){
+                $this->logger->info('This cache file does not exists skipping');
+                return false;
+            }
+            $this->logger->info('Found cache file [' .$filePath. '] check the validity');
+                $data = file_get_contents($filePath);
+            $data = @unserialize($this->compressCacheData ? gzinflate($data) : $data);
+            if(! $data){
+                $this->logger->warning('Can not unserialize the cache data for file [' . $filePath . ']');
+                return false;
+            }
+            $this->logger->info('This cache data is OK check for expire');
+            if(isset($data['expire']) && $data['expire'] > time()){
+                $this->logger->info('This cache not yet expired return cache informations');
+                $info = array(
+                    'mtime' => $data['mtime'],
+                    'expire' => $data['expire'],
+                    'ttl' => $data['ttl']
+                    );
+                return $info;
+            }
+            $this->logger->info('This cache already expired return false');
+            return false;
+        }
 
 
-		/**
-		 * Used to delete expired cache data
-		 */
-		public function deleteExpiredCache(){
-			$this->logger->debug('Deleting of expired cache files');
-			$list = glob(CACHE_PATH . '*.cache');
-			if(! $list){
-				$this->logger->info('No cache files were found skipping');
-			}
-			else{
-				$this->logger->info('Found [' . count($list) . '] cache files to remove if expired');
-				foreach ($list as $file) {
-					$this->logger->debug('Processing the cache file [' . $file . ']');
-					$data = file_get_contents($file);
-		      		$data = @unserialize($this->compressCacheData ? gzinflate($data) : $data);
-		      		if(! $data){
-		      			$this->logger->warning('Can not unserialize the cache data for file [' . $file . ']');
-		      		}
-		      		else if(time() > $data['expire']){
-		      			$this->logger->info('The cache data for file [' . $file . '] already expired remove it');
-		      			unlink($file);
-		      		}
-		      		else{
-		      			$this->logger->info('The cache data for file [' . $file . '] not yet expired skip it');
-		      		}
-				}
-			}
-		}	
+        /**
+         * Used to delete expired cache data
+         */
+        public function deleteExpiredCache(){
+            $this->logger->debug('Deleting of expired cache files');
+            $list = glob(CACHE_PATH . '*.cache');
+            if(! $list){
+                $this->logger->info('No cache files were found skipping');
+            }
+            else{
+                $this->logger->info('Found [' . count($list) . '] cache files to remove if expired');
+                foreach ($list as $file) {
+                    $this->logger->debug('Processing the cache file [' . $file . ']');
+                    $data = file_get_contents($file);
+                        $data = @unserialize($this->compressCacheData ? gzinflate($data) : $data);
+                        if(! $data){
+                            $this->logger->warning('Can not unserialize the cache data for file [' . $file . ']');
+                        }
+                        else if(time() > $data['expire']){
+                            $this->logger->info('The cache data for file [' . $file . '] already expired remove it');
+                            unlink($file);
+                        }
+                        else{
+                            $this->logger->info('The cache data for file [' . $file . '] not yet expired skip it');
+                        }
+                }
+            }
+        }	
 
-		/**
-		 * Remove all file from cache folder
-		 */
-		public function clean(){
-			$this->logger->debug('Deleting of all cache files');
-			$list = glob(CACHE_PATH . '*.cache');
-			if(! $list){
-				$this->logger->info('No cache files were found skipping');
-			}
-			else{
-				$this->logger->info('Found [' . count($list) . '] cache files to remove');
-				foreach ($list as $file) {
-					$this->logger->debug('Processing the cache file [' . $file . ']');
-					unlink($file);
-				}
-			}
-		}
+        /**
+         * Remove all file from cache folder
+         */
+        public function clean(){
+            $this->logger->debug('Deleting of all cache files');
+            $list = glob(CACHE_PATH . '*.cache');
+            if(! $list){
+                $this->logger->info('No cache files were found skipping');
+            }
+            else{
+                $this->logger->info('Found [' . count($list) . '] cache files to remove');
+                foreach ($list as $file) {
+                    $this->logger->debug('Processing the cache file [' . $file . ']');
+                    unlink($file);
+                }
+            }
+        }
 	
-	    /**
-	     * @return boolean
-	     */
-	    public function isCompressCacheData(){
-	        return $this->compressCacheData;
-	    }
+        /**
+         * @return boolean
+         */
+        public function isCompressCacheData(){
+            return $this->compressCacheData;
+        }
 
-	    /**
-	     * @param boolean $compressCacheData
-	     *
-	     * @return object
-	     */
-	    public function setCompressCacheData($status = true){
-			//if Zlib extension is not loaded set compressCacheData to false
-			if($status === true && ! extension_loaded('zlib')){
+        /**
+         * @param boolean $compressCacheData
+         *
+         * @return object
+         */
+        public function setCompressCacheData($status = true){
+            //if Zlib extension is not loaded set compressCacheData to false
+            if($status === true && ! extension_loaded('zlib')){
 				
-				$this->logger->warning('The zlib extension is not loaded set cache compress data to FALSE');
-				$this->compressCacheData = false;
-			}
-			else{
-				$this->compressCacheData = $status;
-			}
-			return $this;
-	    }
+                $this->logger->warning('The zlib extension is not loaded set cache compress data to FALSE');
+                $this->compressCacheData = false;
+            }
+            else{
+                $this->compressCacheData = $status;
+            }
+            return $this;
+        }
 		
-		/**
-		 * Check whether the cache feature for the handle is supported
-		 *
-		 * @return bool
-		 */
-		public function isSupported(){
-			return CACHE_PATH && is_dir(CACHE_PATH) && is_writable(CACHE_PATH);
-		}
+        /**
+         * Check whether the cache feature for the handle is supported
+         *
+         * @return bool
+         */
+        public function isSupported(){
+            return CACHE_PATH && is_dir(CACHE_PATH) && is_writable(CACHE_PATH);
+        }
 
 	
-		/**
-		* Get the cache file full path for the given key
-		*
-		* @param string $key the cache item key
-		* @return string the full cache file path for this key
-		*/
-		private function getFilePath($key){
-			return CACHE_PATH . md5($key) . '.cache';
-		}
-	}
+        /**
+         * Get the cache file full path for the given key
+         *
+         * @param string $key the cache item key
+         * @return string the full cache file path for this key
+         */
+        private function getFilePath($key){
+            return CACHE_PATH . md5($key) . '.cache';
+        }
+    }

core/classes/Controller.php

Indentation +106 added lines, -106 removed lines

@@ -1,126 +1,126 @@
 <?php
-	defined('ROOT_PATH') || exit('Access denied');
-	/**
-	 * TNH Framework
-	 *
-	 * A simple PHP framework using HMVC architecture
-	 *
-	 * This content is released under the GNU GPL License (GPL)
-	 *
-	 * Copyright (C) 2017 Tony NGUEREZA
-	 *
-	 * This program is free software; you can redistribute it and/or
-	 * modify it under the terms of the GNU General Public License
-	 * as published by the Free Software Foundation; either version 3
-	 * of the License, or (at your option) any later version.
-	 *
-	 * This program 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 General Public License for more details.
-	 *
-	 * You should have received a copy of the GNU General Public License
-	 * along with this program; if not, write to the Free Software
-	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-	*/
+    defined('ROOT_PATH') || exit('Access denied');
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program 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 General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
 
-	class Controller extends BaseClass{
+    class Controller extends BaseClass{
 		
-		/**
-		 * The name of the module if this controller belong to an module
-		 * @var string
-		 */
-		public $moduleName = null;
+        /**
+         * The name of the module if this controller belong to an module
+         * @var string
+         */
+        public $moduleName = null;
 
-		/**
-		 * The singleton of the super object
-		 * @var Controller
-		 */
-		private static $instance;
+        /**
+         * The singleton of the super object
+         * @var Controller
+         */
+        private static $instance;
 
 
-		/**
-		 * Class constructor
-		 */
-		public function __construct(){
-			parent::__construct();
+        /**
+         * Class constructor
+         */
+        public function __construct(){
+            parent::__construct();
 			
-			//instance of the super object
-			self::$instance = & $this;
+            //instance of the super object
+            self::$instance = & $this;
 
-			//Load the resources loaded during the application bootstrap
-			$this->logger->debug('Adding the loaded classes to the super instance');
-			foreach (class_loaded() as $var => $class){
-				$this->$var =& class_loader($class);
-			}
+            //Load the resources loaded during the application bootstrap
+            $this->logger->debug('Adding the loaded classes to the super instance');
+            foreach (class_loaded() as $var => $class){
+                $this->$var =& class_loader($class);
+            }
 			
-			//set module using the router
-			$this->setModuleNameFromRouter();
+            //set module using the router
+            $this->setModuleNameFromRouter();
 
-			//load the required resources
-			$this->loadRequiredResources();
+            //load the required resources
+            $this->loadRequiredResources();
 			
-			//set the cache using the configuration
-			$this->setCacheFromParamOrConfig(null);
+            //set the cache using the configuration
+            $this->setCacheFromParamOrConfig(null);
 			
-			//set application session configuration
-			$this->logger->debug('Setting PHP application session handler');
-			set_session_config();
+            //set application session configuration
+            $this->logger->debug('Setting PHP application session handler');
+            set_session_config();
 
-			//dispatch the loaded instance of super controller event
-			$this->eventdispatcher->dispatch('SUPER_CONTROLLER_CREATED');
-		}
+            //dispatch the loaded instance of super controller event
+            $this->eventdispatcher->dispatch('SUPER_CONTROLLER_CREATED');
+        }
 
 
-		/**
-		 * This is a very useful method it's used to get the super object instance
-		 * @return Controller the super object instance
-		 */
-		public static function &get_instance(){
-			return self::$instance;
-		}
+        /**
+         * This is a very useful method it's used to get the super object instance
+         * @return Controller the super object instance
+         */
+        public static function &get_instance(){
+            return self::$instance;
+        }
 
-		/**
-		 * This method is used to set the module name
-		 */
-		protected function setModuleNameFromRouter(){
-			//set the module using the router instance
-			if(isset($this->router) && $this->router->getModule()){
-				$this->moduleName = $this->router->getModule();
-			}
-		}
+        /**
+         * This method is used to set the module name
+         */
+        protected function setModuleNameFromRouter(){
+            //set the module using the router instance
+            if(isset($this->router) && $this->router->getModule()){
+                $this->moduleName = $this->router->getModule();
+            }
+        }
 
-		/**
-		 * Set the cache using the argument otherwise will use the configuration
-		 * @param CacheInterface $cache the implementation of CacheInterface if null will use the configured
-		 */
-		protected function setCacheFromParamOrConfig(CacheInterface $cache = null){
-			$this->logger->debug('Setting the cache handler instance');
-			//set cache handler instance
-			if(get_config('cache_enable', false)){
-				if ($cache !== null){
-					$this->cache = $cache;
-				} else if (isset($this->{strtolower(get_config('cache_handler'))})){
-					$this->cache = $this->{strtolower(get_config('cache_handler'))};
-					unset($this->{strtolower(get_config('cache_handler'))});
-				} 
-			}
-		}
+        /**
+         * Set the cache using the argument otherwise will use the configuration
+         * @param CacheInterface $cache the implementation of CacheInterface if null will use the configured
+         */
+        protected function setCacheFromParamOrConfig(CacheInterface $cache = null){
+            $this->logger->debug('Setting the cache handler instance');
+            //set cache handler instance
+            if(get_config('cache_enable', false)){
+                if ($cache !== null){
+                    $this->cache = $cache;
+                } else if (isset($this->{strtolower(get_config('cache_handler'))})){
+                    $this->cache = $this->{strtolower(get_config('cache_handler'))};
+                    unset($this->{strtolower(get_config('cache_handler'))});
+                } 
+            }
+        }
 
 
-		/**
-		 * This method is used to load the required resources for framework to work
-		 * @return void 
-		 */
-		private function loadRequiredResources(){
-			$this->logger->debug('Loading the required classes into super instance');
-			$this->eventdispatcher =& class_loader('EventDispatcher', 'classes');
-			$this->loader =& class_loader('Loader', 'classes');
-			$this->lang =& class_loader('Lang', 'classes');
-			$this->request =& class_loader('Request', 'classes');
-			//dispatch the request instance created event
-			$this->eventdispatcher->dispatch('REQUEST_CREATED');
-			$this->response =& class_loader('Response', 'classes', 'classes');
-		}
+        /**
+         * This method is used to load the required resources for framework to work
+         * @return void 
+         */
+        private function loadRequiredResources(){
+            $this->logger->debug('Loading the required classes into super instance');
+            $this->eventdispatcher =& class_loader('EventDispatcher', 'classes');
+            $this->loader =& class_loader('Loader', 'classes');
+            $this->lang =& class_loader('Lang', 'classes');
+            $this->request =& class_loader('Request', 'classes');
+            //dispatch the request instance created event
+            $this->eventdispatcher->dispatch('REQUEST_CREATED');
+            $this->response =& class_loader('Response', 'classes', 'classes');
+        }
 
-	}
+    }

core/classes/Security.php

Indentation +131 added lines, -131 removed lines

@@ -1,138 +1,138 @@
 <?php
-	defined('ROOT_PATH') or exit('Access denied');
-	/**
-	 * TNH Framework
-	 *
-	 * A simple PHP framework using HMVC architecture
-	 *
-	 * This content is released under the GNU GPL License (GPL)
-	 *
-	 * Copyright (C) 2017 Tony NGUEREZA
-	 *
-	 * This program is free software; you can redistribute it and/or
-	 * modify it under the terms of the GNU General Public License
-	 * as published by the Free Software Foundation; either version 3
-	 * of the License, or (at your option) any later version.
-	 *
-	 * This program 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 General Public License for more details.
-	 *
-	 * You should have received a copy of the GNU General Public License
-	 * along with this program; if not, write to the Free Software
-	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-	*/
+    defined('ROOT_PATH') or exit('Access denied');
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program 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 General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
 
-	class Security extends BaseStaticClass{
+    class Security extends BaseStaticClass{
 
-		/**
-		 * This method is used to generate the CSRF token
-		 * @return string the generated CSRF token
-		 */
-		public static function generateCSRF(){
-			$logger = self::getLogger();
-			$logger->debug('Generation of CSRF ...');
+        /**
+         * This method is used to generate the CSRF token
+         * @return string the generated CSRF token
+         */
+        public static function generateCSRF(){
+            $logger = self::getLogger();
+            $logger->debug('Generation of CSRF ...');
 			
-			$key = get_config('csrf_key', 'csrf_key');
-			$expire = get_config('csrf_expire', 60);
-			$keyExpire = 'csrf_expire';
-			$currentTime = time();
-			if(Session::exists($key) && Session::exists($keyExpire) && Session::get($keyExpire) > $currentTime){
-				$logger->info('The CSRF token not yet expire just return it');
-				return Session::get($key);
-			}
-			else{
-				$newTime = $currentTime + $expire;
-				$token = sha1(uniqid()) . sha1(uniqid());
-				$logger->info('The CSRF informations are listed below: key [' .$key. '], key expire [' .$keyExpire. '], expire time [' .$expire. '], token [' .$token. ']');
-				Session::set($keyExpire, $newTime);
-				Session::set($key, $token);
-				return Session::get($key);
-			}
-		}
+            $key = get_config('csrf_key', 'csrf_key');
+            $expire = get_config('csrf_expire', 60);
+            $keyExpire = 'csrf_expire';
+            $currentTime = time();
+            if(Session::exists($key) && Session::exists($keyExpire) && Session::get($keyExpire) > $currentTime){
+                $logger->info('The CSRF token not yet expire just return it');
+                return Session::get($key);
+            }
+            else{
+                $newTime = $currentTime + $expire;
+                $token = sha1(uniqid()) . sha1(uniqid());
+                $logger->info('The CSRF informations are listed below: key [' .$key. '], key expire [' .$keyExpire. '], expire time [' .$expire. '], token [' .$token. ']');
+                Session::set($keyExpire, $newTime);
+                Session::set($key, $token);
+                return Session::get($key);
+            }
+        }
 
-		/**
-		 * This method is used to check the CSRF if is valid, not yet expire, etc.
-		 * @return boolean true if valid, false if not valid
-		 */
-		public static function validateCSRF(){
-			$logger = self::getLogger();
-			$logger->debug('Validation of CSRF ...');
+        /**
+         * This method is used to check the CSRF if is valid, not yet expire, etc.
+         * @return boolean true if valid, false if not valid
+         */
+        public static function validateCSRF(){
+            $logger = self::getLogger();
+            $logger->debug('Validation of CSRF ...');
 				
-			$key = get_config('csrf_key', 'csrf_key');
-			$expire = get_config('csrf_expire', 60);
-			$keyExpire = 'csrf_expire';
-			$currentTime = time();
-			$logger->info('The CSRF informations are listed below: key [' .$key. '], key expire [' .$keyExpire. '], expire time [' .$expire. ']');
-			if(! Session::exists($key) || Session::get($keyExpire) <= $currentTime){
-				$logger->warning('The CSRF session data is not valide');
-				return false;
-			}
-			//perform form data
-			//need use request->query() for best retrieve
-			//super instance
-			$obj = & get_instance();
-			$token = $obj->request->query($key);
-			if(! $token || $token !== Session::get($key) || Session::get($keyExpire) <= $currentTime){
-				$logger->warning('The CSRF data [' .$token. '] is not valide may be attacker do his job');
-				return false;
-			}
-			$logger->info('The CSRF data [' .$token. '] is valide the form data is safe continue');
-			//remove the token from session
-			Session::clear($key);
-			Session::clear($keyExpire);
-			return true;
-		}
+            $key = get_config('csrf_key', 'csrf_key');
+            $expire = get_config('csrf_expire', 60);
+            $keyExpire = 'csrf_expire';
+            $currentTime = time();
+            $logger->info('The CSRF informations are listed below: key [' .$key. '], key expire [' .$keyExpire. '], expire time [' .$expire. ']');
+            if(! Session::exists($key) || Session::get($keyExpire) <= $currentTime){
+                $logger->warning('The CSRF session data is not valide');
+                return false;
+            }
+            //perform form data
+            //need use request->query() for best retrieve
+            //super instance
+            $obj = & get_instance();
+            $token = $obj->request->query($key);
+            if(! $token || $token !== Session::get($key) || Session::get($keyExpire) <= $currentTime){
+                $logger->warning('The CSRF data [' .$token. '] is not valide may be attacker do his job');
+                return false;
+            }
+            $logger->info('The CSRF data [' .$token. '] is valide the form data is safe continue');
+            //remove the token from session
+            Session::clear($key);
+            Session::clear($keyExpire);
+            return true;
+        }
 		
-		/**
-		 * This method is used to check the whitelist IP address access
-		 */
-		 public static function checkWhiteListIpAccess(){
-			$logger = self::getLogger();
-			$logger->debug('Validation of the IP address access ...');
-			$logger->debug('Check if whitelist IP access is enabled in the configuration ...');
-			$isEnable = get_config('white_list_ip_enable', false);
-			if($isEnable){
-				$logger->info('Whitelist IP access is enabled in the configuration');
-				$list = get_config('white_list_ip_addresses', array());
-				if(! empty($list)){
-					//Can't use Loader::functions() at this time because teh "Loader" library is loader after the security prossessing
-					require_once CORE_FUNCTIONS_PATH . 'function_user_agent.php';
-					$ip = get_ip();
-					if((count($list) == 1 && $list[0] == '*') || in_array($ip, $list)){
-						$logger->info('IP address ' . $ip . ' allowed using the wildcard "*" or the full IP');
-						//wildcard to access all ip address
-						return;
-					}
-					else{
-						// go through all whitelisted ips
-						foreach ($list as $ipaddr) {
-							// find the wild card * in whitelisted ip (f.e. find position in "127.0.*" or "127*")
-							$wildcardPosition = strpos($ipaddr, '*');
-							if ($wildcardPosition === false) {
-								// no wild card in whitelisted ip --continue searching
-								continue;
-							}
-							// cut ip at the position where we got the wild card on the whitelisted ip
-							// and add the wold card to get the same pattern
-							if (substr($ip, 0, $wildcardPosition) . '*' === $ipaddr) {
-								// f.e. we got
-								//  ip "127.0.0.1"
-								//  whitelisted ip "127.0.*"
-								// then we compared "127.0.*" with "127.0.*"
-								// return success
-								$logger->info('IP address ' . $ip . ' allowed using the wildcard like "x.x.x.*"');
-								return;
-							}
-						}
-						$logger->warning('IP address ' . $ip . ' is not allowed to access to this application');
-						show_error('Access to this application is not allowed');
-					}
-				}
-			}
-			else{
-				$logger->info('Whitelist IP access is not enabled in the configuration, ignore checking');
-			}
-		 }
-	}
+        /**
+         * This method is used to check the whitelist IP address access
+         */
+            public static function checkWhiteListIpAccess(){
+            $logger = self::getLogger();
+            $logger->debug('Validation of the IP address access ...');
+            $logger->debug('Check if whitelist IP access is enabled in the configuration ...');
+            $isEnable = get_config('white_list_ip_enable', false);
+            if($isEnable){
+                $logger->info('Whitelist IP access is enabled in the configuration');
+                $list = get_config('white_list_ip_addresses', array());
+                if(! empty($list)){
+                    //Can't use Loader::functions() at this time because teh "Loader" library is loader after the security prossessing
+                    require_once CORE_FUNCTIONS_PATH . 'function_user_agent.php';
+                    $ip = get_ip();
+                    if((count($list) == 1 && $list[0] == '*') || in_array($ip, $list)){
+                        $logger->info('IP address ' . $ip . ' allowed using the wildcard "*" or the full IP');
+                        //wildcard to access all ip address
+                        return;
+                    }
+                    else{
+                        // go through all whitelisted ips
+                        foreach ($list as $ipaddr) {
+                            // find the wild card * in whitelisted ip (f.e. find position in "127.0.*" or "127*")
+                            $wildcardPosition = strpos($ipaddr, '*');
+                            if ($wildcardPosition === false) {
+                                // no wild card in whitelisted ip --continue searching
+                                continue;
+                            }
+                            // cut ip at the position where we got the wild card on the whitelisted ip
+                            // and add the wold card to get the same pattern
+                            if (substr($ip, 0, $wildcardPosition) . '*' === $ipaddr) {
+                                // f.e. we got
+                                //  ip "127.0.0.1"
+                                //  whitelisted ip "127.0.*"
+                                // then we compared "127.0.*" with "127.0.*"
+                                // return success
+                                $logger->info('IP address ' . $ip . ' allowed using the wildcard like "x.x.x.*"');
+                                return;
+                            }
+                        }
+                        $logger->warning('IP address ' . $ip . ' is not allowed to access to this application');
+                        show_error('Access to this application is not allowed');
+                    }
+                }
+            }
+            else{
+                $logger->info('Whitelist IP access is not enabled in the configuration, ignore checking');
+            }
+            }
+    }