WebAppSession::isDestroySessionRequest() - Code Metrics - Inspection of "lang: typo succesful -> successful" - grommunio/grommunio-web - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed
Push — master ( 647c72...cd42b5 )

unknown
created 2022-05-28 23:49 UTC
WebAppSession::isDestroySessionRequest() B

↳ Parent: WebAppSession
Complexity

Conditions	7
Paths	3
Size

Total Lines	15
Code Lines	7
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	7
eloc	7
nc	3
nop	1
dl	0
loc	15
rs	8.8333
c	0
b	0
f	0
<?php

//Includes. Will probably already be included.
require_once(BASE_PATH . 'config.php');
require_once(BASE_PATH . 'defaults.php');
require_once(BASE_PATH . 'server/includes/util.php');
require_once(BASE_PATH . 'server/includes/exceptions/class.JSONException.php');

/**
 * A class with helper functions for the PHP session
 * @singleton
 */
class WebAppSession
{
	// Holds the instance of this class
	// Use public static method getInstance() to retrieve its value
	private static $instance = null;

	// Set to true when the the session has timed out
	// Use public method hasTimedOut() to retrieve its value
	private $timeout = false;

	/**
	 * Constructor
	 */
	private function __construct(){
		$secure = useSecureCookies();
		if (defined('COOKIE_NAME')) {
			//Create a named session (otherwise use the PHP default, normally PHPSESSID)
			if ($secure){
				//Create a named session and set secure cookies params.
				session_name('__Secure-' . COOKIE_NAME);

			} else {
				session_name(COOKIE_NAME);
			}
		}
		$lifetime = ini_get('session.cookie_lifetime');
		$path = ini_get('session.cookie_path');
		$domain = ini_get('session.cookie_domain');
		session_set_cookie_params($lifetime, $path, $domain, $secure, true);
		session_set_cookie_params(/** @scrutinizer ignore-type */ $lifetime, $path, $domain, $secure, true);

		// Start the session so we can use it for timeout checking
		$this->start();

		if ( basename($_SERVER['PHP_SELF']) != 'grommunio.php' ){
			//We will only check for timeout in the grommunio.php page
			$this->setStartTime();
		} else {
			$this->checkForTimeout();
		}
	}

	/**
	 * returns the instance of this class. Creates one if it doesn't exist yet.
	 * To force this class to be used as singleton, the constructor is private
	 * and the single instance can be created/retrieved with this static method
	 * e.g.: $session = WebAppSession::createInstance()
	 *
	 * @return WebAppSession the only available instance of this class
	 */
	public static function getInstance()
	{
		if ( !isset(WebAppSession::$instance) ){
			WebAppSession::$instance = new WebAppSession();
		}
		return WebAppSession::$instance;
	}

	/**
	 * The method getInstance() was first called createInstance(), so
	 * for backward compatibility we also define createInstance as an alias
	 */
	public static function createInstance()
	{
		return WebAppSession::getInstance();
	}

	/**
	 * Starts the session
	 */
	public function start()
	{
		session_start();
	}

	/**
	 * Closes the session
	 */
	public function close()
	 {
	 	session_write_close();
	 }

	/**
	 * Destroy the session
	 */
	public function destroy()
	{
		// Make sure the session is open
		if ( session_status() !== PHP_SESSION_ACTIVE ){
			session_start();
		}

		// Destroy the session cookie
		if (isset($_COOKIE[session_name()])) {
			setcookie(session_name(), '', time()-42000, '/');
		}

		// Destroy the session
		$_SESSION = array();
		session_destroy();
	}

	/**
	 * Sets the start time in the session to current timestamp.
	 * This is used to logout the user when CLIENT_TIMEOUT has
	 * been set in config.php
	 */
	public function setStartTime()
	{
		$_SESSION['starttime'] = time();
	}

	/**
	 * gets the start time from the session. This is used to logout the user
	 * when CLIENT_TIMEOUT has been set in config.php
	 *
	 * @return integer|false The starttime (timestamp) when set, false otherwise
	 */
	public function getStartTime()
	{
		if ( isset($_SESSION['starttime']) ){
			return $_SESSION['starttime'];
		} else {
			return false;
		}
	}

	/**
	 * Checks if the session should timeout and destroys the session if it should.
	 */
	private function checkForTimeout()
	{
		if ( !defined('CLIENT_TIMEOUT') || !CLIENT_TIMEOUT ){

			//Timeout was not set in configuration, so do nothing
			return;
		}

		if (array_key_exists('HTTP_CONTENT_TYPE', $_SERVER) && strpos($_SERVER['HTTP_CONTENT_TYPE'], 'application/json') === false) {
			return;
		}

		$starttime = $this->getStartTime();
		// let's add 5 seconds to the CLIENT_TIMEOUT to handle possible latency
		if ( $starttime && (time()-$starttime > CLIENT_TIMEOUT+5) ){
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
			$this->destroy();
			$this->timeout = true;
		} else {
			try{
				// decode JSON data
				$requestJsonString = readData();
				$requestJson = json_decode_data($requestJsonString, true);
			}catch(JSONException $e){
				// Invalid json sent with the request
				// Log the error and do nothing is best option
				dump($e->getMessage());
				return;
			}

			$isReminderlistRequest = $this->isReminderListRequest($requestJson);
			$isDestroySessionRequest = $this->isDestroySessionRequest($requestJson);

			if ( !$isReminderlistRequest && !$isDestroySessionRequest){
				//Set a new session start time
				$this->setStartTime();
			} elseif ( $isDestroySessionRequest ){
				// sessiondestroy is sent because of timeout at client side
				$this->timeout = true;
				$this->destroy();
			}
		}
	}

	/**
	 * Checks if the current request is a destroysession request
	 *
	 * @param array $requestJson The JSON that was sent as the current request
	 * @return boolean
	 */
	private function isDestroySessionRequest($requestJson)
	{
		$isDestroySession = false;

		if ( isset($requestJson) && isset($requestJson['zarafa']) ){
			if ( isset($requestJson['zarafa']['hierarchymodule']) ){
				foreach ( $requestJson['zarafa']['hierarchymodule'] as $requestId=>$action ){
					if ( isset($action) && isset($action['destroysession']) ){
						$isDestroySession = true;
					}
				}
			}
		}

		return $isDestroySession;
	}

	/**
	 * Checks if the current request is a reminderlist request
	 *
	 * @param array $requestJson The JSON that was sent as the current request
	 * @return boolean
	 */
	private function isReminderListRequest($requestJson)
	{
		return isset($requestJson) && isset($requestJson['zarafa']) && isset($requestJson['zarafa']['reminderlistmodule']);
	}

	/**
	 * Returns true if the current session has timed out, false otherwise
	 *
	 * @return boolean
	 */
	public function hasTimedOut()
	{
		return $this->timeout;
	}
}

grommunio / grommunio-web

Push — master ( 647c72...cd42b5 )

WebAppSession::isDestroySessionRequest() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
