Controller::setAppSessionConfig() - Code Metrics - Inspection of "Change static class Loader, Module to instance cla..." - tnhfw/tnh-fw - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — 1.0.0-dev ( 024223...5d8234 )

by nguereza

created 2020-03-12 12:07 UTC

Controller::setAppSessionConfig() A

↳ Parent: Controller

Complexity

Conditions	5
Paths	5

Size

Total Lines	22
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	5
eloc	16
nc	5
nop	0
dl	0
loc	22
rs	9.4222
c	0
b	0
f	0

<?php
    defined('ROOT_PATH') || exit('Access denied');
    /**
     * TNH Framework
     *
     * A simple PHP framework using HMVC architecture
     *
     * This content is released under the MIT License (MIT)
     *
     * Copyright (c) 2017 TNH Framework
     *
     * Permission is hereby granted, free of charge, to any person obtaining a copy
     * of this software and associated documentation files (the "Software"), to deal
     * in the Software without restriction, including without limitation the rights
     * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     * copies of the Software, and to permit persons to whom the Software is
     * furnished to do so, subject to the following conditions:
     *
     * The above copyright notice and this permission notice shall be included in all
     * copies or substantial portions of the Software.
     *
     * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
     * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
     * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
     * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
     * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
     * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
     * SOFTWARE.
     */

    class Controller extends BaseClass {
		
        /**
         * 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;


        /**
         * Class constructor
         */
        public function __construct() {
            parent::__construct();
			
            //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);
            }
			
            //set module using the router
            $this->setModuleNameFromRouter();

            //load the required resources
            $this->loadRequiredResources();

            //set application supported languages
            $this->setAppSupportedLanguages();
			
            //set the cache instance using the configuration
            $this->setCacheFromParamOrConfig(null);
			
            //set application session configuration and then started it
            $this->logger->debug('Starting application session handler');
            $this->startAppSession();

            //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 object the super object instance
         */
        public static function &getInstance(){
            return self::$instance;
        }

        /**
         * This method is used to set the session configuration
         * using the configured value and start the session if not yet started
         *
         * @codeCoverageIgnore
         */
         protected function startAppSession() {
            //$_SESSION is not available on cli mode 
            if (!IS_CLI) {
                //set session params
                $sessionName = $this->config->get('session_name');

                $this->logger->info('Session name: ' . $sessionName);
                if ($sessionName) {
                    session_name($sessionName);
                }

                //Set app session handler configuration
                $this->setAppSessionConfig();

                $lifetime = $this->config->get('session_cookie_lifetime', 0);
                $path = $this->config->get('session_cookie_path', '/');
                $domain = $this->config->get('session_cookie_domain', '');
                $secure = $this->config->get('session_cookie_secure', false);
                if (is_https()) {
                    $secure = true;
                }
                session_set_cookie_params(
                    $lifetime,
                    $path,
                    $domain,
                    $secure,
                    $httponly = true /*for security for access to cookie via javascript or XSS attack*/
                );
                //to prevent attack of Session Fixation 
                //thank to https://www.phparch.com/2018/01/php-sessions-in-depth/
                ini_set('session.use_strict_mode ', 1);
                ini_set('session.use_only_cookies', 1);
                ini_set('session.use_trans_sid ', 0);
                
                $this->logger->info('Session lifetime: ' . $lifetime);
                $this->logger->info('Session cookie path: ' . $path);
                $this->logger->info('Session domain: ' . $domain);
                $this->logger->info('Session is secure: ' . ($secure ? 'TRUE' : 'FALSE'));
                
                if ((session_status() !== PHP_SESSION_ACTIVE) || !session_id()) {
                    $this->logger->info('Session not yet start, start it now');
                    session_start();
                }
            }
        }

        /**
         * Set the session handler configuration
         * @codeCoverageIgnore
         */
        protected function setAppSessionConfig() {
             //the default is to store in the files
            $sessionHandler = $this->config->get('session_handler', 'files');

            $this->logger->info('Session handler: ' . $sessionHandler);
            if ($sessionHandler == 'files') {
                $sessionSavePath = $this->config->get('session_save_path');
                if ($sessionSavePath) {
                    if (!is_dir($sessionSavePath)) {
                        mkdir($sessionSavePath, 1773);
                    }
                    $this->logger->info('Session save path: ' . $sessionSavePath);
                    session_save_path($sessionSavePath);
                }
            } else if ($sessionHandler == 'database') {
                //load database session handle library
                //Database Session handler Model
                require_once CORE_CLASSES_MODEL_PATH . 'DBSessionHandlerModel.php';
                $dbSessionHandler = & class_loader('DBSessionHandler', 'classes');
                session_set_save_handler($dbSessionHandler, true);
                $this->logger->info('Session database handler model: ' . $this->config->get('session_save_path'));
            } else {
                show_error('Invalid session handler configuration');
            }
        }

        /**
         * 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 ($this->config->get('cache_enable', false)) {

                if ($cache !== null) {
                    $this->cache = $cache;

                } else if (isset($this->{strtolower($this->config->get('cache_handler'))})) {
                    $this->cache = $this->{strtolower($this->config->get('cache_handler'))};
                    unset($this->{strtolower($this->config->get('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');
        }

        /**
         * Set the application supported languages
         */
        private function setAppSupportedLanguages() {
            //add the supported languages ('key', 'display name')
            $languages = $this->config->get('languages', array());

            foreach ($languages as $key => $displayName) {
                $this->lang->addLang($key, $displayName);
            }
            unset($languages);
        }

    }


1			<?php
2			defined('ROOT_PATH') \|\| exit('Access denied');
3			/**
4			* TNH Framework
5			*
6			* A simple PHP framework using HMVC architecture
7			*
8			* This content is released under the MIT License (MIT)
9			*
10			* Copyright (c) 2017 TNH Framework
11			*
12			* Permission is hereby granted, free of charge, to any person obtaining a copy
13			* of this software and associated documentation files (the "Software"), to deal
14			* in the Software without restriction, including without limitation the rights
15			* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
16			* copies of the Software, and to permit persons to whom the Software is
17			* furnished to do so, subject to the following conditions:
18			*
19			* The above copyright notice and this permission notice shall be included in all
20			* copies or substantial portions of the Software.
21			*
22			* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
23			* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24			* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
25			* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26			* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
27			* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
28			* SOFTWARE.
29			*/
30
31			class Controller extends BaseClass {
32
33			/**
34			* The name of the module if this controller belong to an module
35			* @var string
36			*/
37			public $moduleName = null;
38
39			/**
40			* The singleton of the super object
41			* @var Controller
42			*/
43			private static $instance;
44
45
46			/**
47			* Class constructor
48			*/
49			public function __construct() {
50			parent::__construct();
51
52			//instance of the super object
53			self::$instance = & $this;
54
55			//Load the resources loaded during the application bootstrap
56			$this->logger->debug('Adding the loaded classes to the super instance');
57			foreach (class_loaded() as $var => $class) {
58			$this->$var = & class_loader($class);
59			}
60
61			//set module using the router
62			$this->setModuleNameFromRouter();
63
64			//load the required resources
65			$this->loadRequiredResources();
66
67			//set application supported languages
68			$this->setAppSupportedLanguages();
69
70			//set the cache instance using the configuration
71			$this->setCacheFromParamOrConfig(null);
72
73			//set application session configuration and then started it
74			$this->logger->debug('Starting application session handler');
75			$this->startAppSession();
76
77			//dispatch the loaded instance of super controller event
78			$this->eventdispatcher->dispatch('SUPER_CONTROLLER_CREATED');
79			}
80
81
82			/**
83			* This is a very useful method it's used to get the super object instance
84			* @return object the super object instance
85			*/
86			public static function &getInstance(){
87			return self::$instance;
88			}
89
90			/**
91			* This method is used to set the session configuration
92			* using the configured value and start the session if not yet started
93			*
94			* @codeCoverageIgnore
95			*/
96			protected function startAppSession() {
97			//$_SESSION is not available on cli mode
98			if (!IS_CLI) {
99			//set session params
100			$sessionName = $this->config->get('session_name');
			1 ignored issue – show Bug Best Practice introduced 2020-03-12 12:10 UTC by Report Bug Copy Issue Report The property `config` does not exist on `Controller`. Did you maybe forget to declare it? Loading history...
101			$this->logger->info('Session name: ' . $sessionName);
102			if ($sessionName) {
103			session_name($sessionName);
104			}
105
106			//Set app session handler configuration
107			$this->setAppSessionConfig();
108
109			$lifetime = $this->config->get('session_cookie_lifetime', 0);
110			$path = $this->config->get('session_cookie_path', '/');
111			$domain = $this->config->get('session_cookie_domain', '');
112			$secure = $this->config->get('session_cookie_secure', false);
113			if (is_https()) {
114			$secure = true;
115			}
116			session_set_cookie_params(
117			$lifetime,
118			$path,
119			$domain,
120			$secure,
121			$httponly = true /for security for access to cookie via javascript or XSS attack/
122			);
123			//to prevent attack of Session Fixation
124			//thank to https://www.phparch.com/2018/01/php-sessions-in-depth/
125			ini_set('session.use_strict_mode ', 1);
126			ini_set('session.use_only_cookies', 1);
127			ini_set('session.use_trans_sid ', 0);
128
129			$this->logger->info('Session lifetime: ' . $lifetime);
130			$this->logger->info('Session cookie path: ' . $path);
131			$this->logger->info('Session domain: ' . $domain);
132			$this->logger->info('Session is secure: ' . ($secure ? 'TRUE' : 'FALSE'));
133
134			if ((session_status() !== PHP_SESSION_ACTIVE) \|\| !session_id()) {
135			$this->logger->info('Session not yet start, start it now');
136			session_start();
137			}
138			}
139			}
140
141			/**
142			* Set the session handler configuration
143			* @codeCoverageIgnore
144			*/
145			protected function setAppSessionConfig() {
146			//the default is to store in the files
147			$sessionHandler = $this->config->get('session_handler', 'files');
			1 ignored issue – show Bug Best Practice introduced 2020-03-12 12:10 UTC by Report Bug Copy Issue Report The property `config` does not exist on `Controller`. Did you maybe forget to declare it? Loading history...
148			$this->logger->info('Session handler: ' . $sessionHandler);
149			if ($sessionHandler == 'files') {
150			$sessionSavePath = $this->config->get('session_save_path');
151			if ($sessionSavePath) {
152			if (!is_dir($sessionSavePath)) {
153			mkdir($sessionSavePath, 1773);
154			}
155			$this->logger->info('Session save path: ' . $sessionSavePath);
156			session_save_path($sessionSavePath);
157			}
158			} else if ($sessionHandler == 'database') {
159			//load database session handle library
160			//Database Session handler Model
161			require_once CORE_CLASSES_MODEL_PATH . 'DBSessionHandlerModel.php';
162			$dbSessionHandler = & class_loader('DBSessionHandler', 'classes');
163			session_set_save_handler($dbSessionHandler, true);
164			$this->logger->info('Session database handler model: ' . $this->config->get('session_save_path'));
165			} else {
166			show_error('Invalid session handler configuration');
167			}
168			}
169
170			/**
171			* This method is used to set the module name
172			*/
173			protected function setModuleNameFromRouter() {
174			//set the module using the router instance
175			if (isset($this->router) && $this->router->getModule()) {
176			$this->moduleName = $this->router->getModule();
177			}
178			}
179
180			/**
181			* Set the cache using the argument otherwise will use the configuration
182			* @param CacheInterface $cache the implementation of CacheInterface if null will use the configured
183			*/
184			protected function setCacheFromParamOrConfig(CacheInterface $cache = null) {
185			$this->logger->debug('Setting the cache handler instance');
186			//set cache handler instance
187			if ($this->config->get('cache_enable', false)) {
			1 ignored issue – show Bug Best Practice introduced 2020-03-12 12:10 UTC by Report Bug Copy Issue Report The property `config` does not exist on `Controller`. Did you maybe forget to declare it? Loading history...
188			if ($cache !== null) {
189			$this->cache = $cache;
			0 ignored issues – show Bug Best Practice introduced 2020-02-18 21:51 UTC by Report Bug Copy Issue Report The property `cache` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
190			} else if (isset($this->{strtolower($this->config->get('cache_handler'))})) {
191			$this->cache = $this->{strtolower($this->config->get('cache_handler'))};
192			unset($this->{strtolower($this->config->get('cache_handler'))});
193			}
194			}
195			}
196
197
198			/**
199			* This method is used to load the required resources for framework to work
200			* @return void
201			*/
202			private function loadRequiredResources() {
203			$this->logger->debug('Loading the required classes into super instance');
204			$this->eventdispatcher = & class_loader('EventDispatcher', 'classes');
			0 ignored issues – show Bug Best Practice introduced 2020-02-18 21:51 UTC by Report Bug Copy Issue Report The property `eventdispatcher` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
205			$this->loader = & class_loader('Loader', 'classes');
206			$this->lang = & class_loader('Lang', 'classes');
207			$this->request = & class_loader('Request', 'classes');
208			//dispatch the request instance created event
209			$this->eventdispatcher->dispatch('REQUEST_CREATED');
210			$this->response = & class_loader('Response', 'classes', 'classes');
211			}
212
213			/**
214			* Set the application supported languages
215			*/
216			private function setAppSupportedLanguages() {
217			//add the supported languages ('key', 'display name')
218			$languages = $this->config->get('languages', array());
			1 ignored issue – show Bug Best Practice introduced 2020-03-12 12:10 UTC by Report Bug Copy Issue Report The property `config` does not exist on `Controller`. Did you maybe forget to declare it? Loading history...
219			foreach ($languages as $key => $displayName) {
220			$this->lang->addLang($key, $displayName);
221			}
222			unset($languages);
223			}
224
225			}
226

tnhfw / tnh-fw

Push — 1.0.0-dev ( 024223...5d8234 )

Controller::setAppSessionConfig() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like