Version 5.0.0 beta 1

system/Session/Admin.php

@@ -11,30 +11,46 @@
 namespace IPS\Session;
 
 /* To prevent PHP errors (extending class does not exist) revealing path */
-if ( !\defined( '\IPS\SUITE_UNIQUE_KEY' ) )
+
+use DomainException;
+use Exception;
+use IPS\Db;
+use IPS\Dispatcher;
+use IPS\Http\Useragent;
+use IPS\Member;
+use IPS\Request;
+use IPS\Session;
+use IPS\Settings;
+use function defined;
+use const IPS\ACP_SESSION_TIMEOUT;
+use const IPS\BYPASS_ACP_IP_CHECK;
+use const IPS\DEV_DISABLE_ACP_SESSION_TIMEOUT;
+use const IPS\IN_DEV;
+
+if ( !defined( '\IPS\SUITE_UNIQUE_KEY' ) )
 {
-	header( ( isset( $_SERVER['SERVER_PROTOCOL'] ) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0' ) . ' 403 Forbidden' );
+	header( ( $_SERVER['SERVER_PROTOCOL'] ?? 'HTTP/1.0' ) . ' 403 Forbidden' );
 	exit;
 }
 
 /**
  * Admin Session Handler
  */
-class _Admin extends \IPS\Session
+class Admin extends Session
 {
 	/**
 	 * @brief	Unix Timestamp of log in time
 	 */
-	public $logInTime;
+	public int $logInTime;
 				
 	/**
 	 * Open Session
 	 *
 	 * @param	string	$savePath	Save path
 	 * @param	string	$sessionName Session Name
-	 * @return	void
+	 * @return	bool
 	 */
-	public function open( $savePath, $sessionName )
+	public function open( string $savePath, string $sessionName ) : bool
 	{
 		return TRUE;
 	}
@@ -45,49 +61,49 @@ class _Admin extends \IPS\Session
 	 * @param	string	$sessionId	Session ID
 	 * @return	string
 	 */
-	public function read( $sessionId )
+	public function read( string $sessionId ) : string
 	{
 		/* Get user agent info */
-		$this->userAgent	= \IPS\Http\Useragent::parse();
+		$this->userAgent	= Useragent::parse();
 
 		try
 		{
 			$where = array( array( 'session_id=?', $sessionId ) );
 
-			if( !\IPS\IN_DEV OR !\IPS\DEV_DISABLE_ACP_SESSION_TIMEOUT )
+			if( !IN_DEV OR !DEV_DISABLE_ACP_SESSION_TIMEOUT )
 			{
-				$where[] = array( 'session_running_time>=?', ( time() - \IPS\ACP_SESSION_TIMEOUT ) );
+				$where[] = array( 'session_running_time>=?', ( time() - ACP_SESSION_TIMEOUT ) );
 			}
 
 			/* Load session */
-			$session = \IPS\Db::i()->select( '*', 'core_sys_cp_sessions', $where )->first();
+			$session = Db::i()->select( '*', 'core_sys_cp_sessions', $where )->first();
 			$this->logInTime = $session['session_log_in_time'];
 			
 			/* Store this so plugins can access */
 			$this->sessionData	= $session;
 
 			/* Load member */
-			$this->member = $session['session_member_id'] ? \IPS\Member::load( $session['session_member_id'] ) : new \IPS\Member;
+			$this->member = $session['session_member_id'] ? Member::load( $session['session_member_id'] ) : new Member;
 			if ( $this->member->member_id and !$this->member->isAdmin() )
 			{
-				throw new \DomainException('NO_ACPACCESS');
+				throw new DomainException('NO_ACPACCESS');
 			}
 									
 			/* Check IP address */
-			if ( ( \defined( '\IPS\BYPASS_ACP_IP_CHECK' ) and !\IPS\BYPASS_ACP_IP_CHECK ) and \IPS\Settings::i()->match_ipaddress and $session['session_ip_address'] !== \IPS\Request::i()->ipAddress() )
+			if ( ( defined( '\IPS\BYPASS_ACP_IP_CHECK' ) and !BYPASS_ACP_IP_CHECK ) and Settings::i()->match_ipaddress and $session['session_ip_address'] !== Request::i()->ipAddress() )
 			{
-				throw new \DomainException('BAD_IP');
+				throw new DomainException('BAD_IP');
 			}
 			
 			/* Return data */
 			return $session['session_app_data'];
 		}
-		catch ( \Exception $e )
+		catch ( Exception $e )
 		{
-			$this->member = new \IPS\Member;
+			$this->member = new Member;
 			$this->logInTime = 0;
 			$this->error = $e;
-			return isset( $this->sessionData['session_app_data'] ) ? $this->sessionData['session_app_data'] : '';
+			return $this->sessionData['session_app_data'] ?? '';
 		}
 	}
 	
@@ -98,17 +114,17 @@ class _Admin extends \IPS\Session
 	 * @param	string	$data		Session Data
 	 * @return	bool
 	 */
-	public function write( $sessionId, $data )
+	public function write( string $sessionId, string $data ) : bool
 	{
-		\IPS\Db::i()->replace( 'core_sys_cp_sessions', array(
+		Db::i()->replace( 'core_sys_cp_sessions', array(
 			'session_id'				=> $sessionId,
-			'session_ip_address'		=> \IPS\Request::i()->ipAddress(),
+			'session_ip_address'		=> Request::i()->ipAddress(),
 			'session_member_name'		=> $this->member->name ?: '-',
 			'session_member_id'			=> $this->member->member_id ?: 0,
-			'session_location'			=> 'app=' . ( \IPS\Dispatcher::i()->application ? \IPS\Dispatcher::i()->application->directory : '' ) . '&module=' . ( \IPS\Dispatcher::i()->module ? \IPS\Dispatcher::i()->module->key : '' ) . '&controller=' . \IPS\Dispatcher::i()->controller,
+			'session_location'			=> 'app=' . ( Dispatcher::i()->application ? Dispatcher::i()->application->directory : '' ) . '&module=' . ( Dispatcher::i()->module ? Dispatcher::i()->module->key : '' ) . '&controller=' . Dispatcher::i()->controller,
 			'session_log_in_time'		=> $this->logInTime,
 			'session_running_time'		=> time(),
-			'session_url'				=> \IPS\Request::i()->url(),
+			'session_url'				=> Request::i()->url(),
 			'session_app_data'			=> $data
 		) );
 		
@@ -120,7 +136,7 @@ class _Admin extends \IPS\Session
 	 *
 	 * @return	bool
 	 */
-	public function close()
+	public function close() : bool
 	{
 		return TRUE;
 	}
@@ -131,9 +147,9 @@ class _Admin extends \IPS\Session
 	 * @param	string	$sessionId	Session ID
 	 * @return	bool
 	 */
-	public function destroy( $sessionId )
+	public function destroy( string $sessionId ) : bool
 	{
-		\IPS\Db::i()->delete( 'core_sys_cp_sessions', array( 'session_id=?', $sessionId ) );
+		Db::i()->delete( 'core_sys_cp_sessions', array( 'session_id=?', $sessionId ) );
 		return TRUE;
 	}
 	
@@ -143,52 +159,12 @@ class _Admin extends \IPS\Session
 	 * @param	int		$lifetime	Number of seconds to consider sessions expired beyond
 	 * @return	bool
 	 */
-	public function gc( $lifetime )
+	public function gc( int $lifetime ) : bool
 	{
 		/* We ignore $lifetime because we explicitly control how long sessions are valid for via a constant */
-		$lifetime = \IPS\ACP_SESSION_TIMEOUT;
+		$lifetime = ACP_SESSION_TIMEOUT;
 
-		\IPS\Db::i()->delete( 'core_sys_cp_sessions', array( 'session_running_time<?', ( time() - $lifetime ) ) );
+		Db::i()->delete( 'core_sys_cp_sessions', array( 'session_running_time<?', ( time() - $lifetime ) ) );
 		return TRUE;
 	}
-	
-	/**
-	 * Admin Log
-	 *
-	 * @code
-	 	\IPS\Session::i()->log( 'acplog__enhancements_enable', array( 'enhancements__foo' => TRUE ) );
-	 * @endcode
-	 * @param	string	$langKey	Language key for log
-	 * @param	array	$params		Key/Values - keys are variables to use in sprintf on $langKey, values are booleans indicating if they are language keys themselves (TRUE) or raw data (FALSE)
-	 * @param	bool	$noDupes	If TRUE, will check the last log and not log again if it's the same and less than an hour ago
-	 * @return	void
-	 */
-	public function log( $langKey, $params=array(), $noDupes=FALSE )
-	{
-		if ( $noDupes )
-		{
-			try
-			{
-				$lastLog = \IPS\Db::i()->select( '*', 'core_admin_logs', array( 'member_id=?', $this->member->member_id ), 'ctime DESC', 1 )->first();
-				if ( $lastLog['ctime'] > ( time() - 3600 ) and $lastLog['lang_key'] == $langKey )
-				{
-					return;
-				}
-			}
-			catch ( \UnderflowException $e ) { }
-		}
-	
-		\IPS\Db::i()->insert( 'core_admin_logs', array(
-			'member_id'		=> $this->member->member_id,
-			'member_name'	=> \IPS\Member::loggedIn()->name,
-			'ctime'			=> time(),
-			'note'			=> json_encode( $params ),
-			'ip_address'	=> \IPS\Request::i()->ipAddress(),
-			'appcomponent'	=> \IPS\Dispatcher::i()->application->directory,
-			'module'		=> \IPS\Dispatcher::i()->module->key,
-			'controller'	=> \IPS\Dispatcher::i()->controller,
-			'do'			=> \IPS\Request::i()->do,
-			'lang_key'		=> $langKey
-		) );
-	}
 }