CoreLibs/development
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Convert static Session class to normal session class

Browse Source 
All static Session:: calls (except for checking valid session name) are
converted to object type. This Object is passed on to Login, Admin
Backend and any other class that needs basic session checking
This commit is contained in:
Clemens Schwaighofer
2022-05-24 15:00:04 +09:00
parent 5b581c2ed6
commit db8e17ae7c
39 changed files with 166 additions and 252 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
www/lib/CoreLibs/ACL/Login.php
View File

@@ -69,7 +69,6 @@ declare(strict_types=1);
namespace CoreLibs\ACL;
use CoreLibs\Check\Password;
use CoreLibs\Create\Session;
class Login
{
@@ -162,24 +161,30 @@ class Login
public $db;
/** @var \CoreLibs\Language\L10n language */
public $l;
/** @var \CoreLibs\Create\Session session class */
public $session;
/**
* constructor, does ALL, opens db, works through connection checks,
* finishes itself
*
* @param \CoreLibs\DB\IO $db Database connection class
* @param \CoreLibs\Debug\Logging $log Logging class
* @param \CoreLibs\DB\IO $db Database connection class
* @param \CoreLibs\Debug\Logging $log Logging class
* @param \CoreLibs\Create\Session $session Session interface class
*/
public function __construct(
\CoreLibs\DB\IO $db,
\CoreLibs\Debug\Logging $log
\CoreLibs\Debug\Logging $log,
\CoreLibs\Create\Session $session
) {
// attach db class
$this->db = $db;
// log login data for this class only
$log->setLogPer('class', true);
// attach logger
$this->log = $log;
// attach db class
$this->db = $db;
// attach session class
$this->session = $session;
// set internal page name
$this->page_name = \CoreLibs\Get\System::getPageName();
// set db special errors
@@ -192,12 +197,9 @@ class Login
// initial the session if there is no session running already
// check if session exists and could be created
// TODO: move session creation and check to outside?
if (Session::startSession() === false) {
if ($this->session->checkActiveSession() === false) {
$this->login_error = 1;
echo '<b>Session not started or could not be started!</b><br>'
. 'Use \'\CoreLibs\Create\Session::startSession();\'.<br>'
. 'For less problems with other session, you can set a '
. 'session name with \'\CoreLibs\Create\Session::startSession(\'name\');\'.<br>';
echo '<b>No active session found</b>';
exit;
}
@@ -289,7 +291,7 @@ class Login
// ** LANGUAGE SET AFTER LOGIN **
// set the locale
if (
Session::getSessionId() !== false &&
$this->session->checkActiveSession() === true &&
!empty($_SESSION['DEFAULT_LANG'])
) {
$locale = $_SESSION['DEFAULT_LOCALE'] ?? '';
@@ -1369,7 +1371,7 @@ EOM;
$q .= "NULL, ";
}
}
$q .= "'" . Session::getSessionId() . "', ";
$q .= "'" . $this->session->getSessionId() . "', ";
$q .= "'" . $this->db->dbEscapeString($this->action) . "', ";
$q .= "'" . $this->db->dbEscapeString($this->username) . "', ";
$q .= "NULL, ";

22
www/lib/CoreLibs/Admin/Backend.php
View File

@@ -101,6 +101,8 @@ class Backend
public $db;
/** @var \CoreLibs\Language\L10n language */
public $l;
/** @var \CoreLibs\Create\Session session class */
public $session;
// smarty publics [end processing in smarty class]
/** @var array<mixed> */
public $DATA;
@@ -114,23 +116,27 @@ class Backend
// CONSTRUCTOR / DECONSTRUCTOR |====================================>
/**
* main class constructor
* @param \CoreLibs\DB\IO $db Database connection class
* @param \CoreLibs\Debug\Logging $log Logging class
* @param \CoreLibs\Language\L10n $l10n l10n language class
* @param array<string,string> $locale locale data read from setLocale
* @param \CoreLibs\DB\IO $db Database connection class
* @param \CoreLibs\Debug\Logging $log Logging class
* @param \CoreLibs\Create\Session $session Session interface class
* @param \CoreLibs\Language\L10n $l10n l10n language class
* @param array<string,string> $locale locale data read from setLocale
*/
public function __construct(
\CoreLibs\DB\IO $db,
\CoreLibs\Debug\Logging $log,
\CoreLibs\Create\Session $session,
\CoreLibs\Language\L10n $l10n,
array $locale
) {
// attach db class
$this->db = $db;
// set to log not per class
$log->setLogPer('class', false);
// attach logger
$this->log = $log;
// attach db class
$this->db = $db;
// attach session class
$this->session = $session;
// get the language sub class & init it
$this->l = $l10n;
// parse and read, legacy stuff
@@ -232,9 +238,9 @@ class Backend
. "'" . $this->db->dbEscapeString($_SERVER['HTTP_ACCEPT'] ?? '') . "', "
. "'" . $this->db->dbEscapeString($_SERVER['HTTP_ACCEPT_CHARSET'] ?? '') . "', "
. "'" . $this->db->dbEscapeString($_SERVER['HTTP_ACCEPT_ENCODING'] ?? '') . "', "
. (\CoreLibs\Create\Session::getSessionId() === false ?
. ($this->session->getSessionId() === false ?
"NULL" :
"'" . \CoreLibs\Create\Session::getSessionId() . "'")
"'" . $this->session->getSessionId() . "'")
. ", "
. "'" . $this->db->dbEscapeString($this->action) . "', "
. "'" . $this->db->dbEscapeString($this->action_id) . "', "

4
www/lib/CoreLibs/Basic.php
View File

@@ -66,6 +66,8 @@ class Basic
// logging interface, Debug\Logging class
/** @var \CoreLibs\Debug\Logging */
public $log;
/** @var\CoreLibs\Create\Session */
public $session;
// email valid checks
/** @var array<mixed> */
@@ -148,7 +150,7 @@ class Basic
$this->email_regex_check = \CoreLibs\Check\Email::getEmailRegexCheck();
// initial the session if there is no session running already
\CoreLibs\Create\Session::startSession($session_name);
$this->session = new \CoreLibs\Create\Session($session_name ?? '');
}
/**

73
www/lib/CoreLibs/Create/Session.php
View File

@@ -6,7 +6,7 @@
* start a php sesseion
* name can be given via startSession parameter
* if not set tries to read $SET_SESSION_NAME from global
* if this is not set tries to read SET_SESSION_NAME constant
* else will use default set in php.ini
*/
declare(strict_types=1);
@@ -16,13 +16,29 @@ namespace CoreLibs\Create;
class Session
{
/** @var string list for errors*/
private static $error_str = '';
private $error_str = '';
/**
* init a session
* init a session, if array is empty or array does not have session_name set
* then no auto init is run
*
* @param string $session_name if set and not empty, will start session
*/
public function __construct()
public function __construct(string $session_name = '')
{
if (!empty($session_name)) {
$this->startSession($session_name);
}
}
/**
* check if we are in CLI, we set this, so we can mock this too
*
* @return bool
*/
private function checkCLI(): bool
{
return \CoreLibs\Get\System::checkCLI();
}
/**
@@ -30,9 +46,9 @@ class Session
*
* @return string Last error string
*/
public static function getErrorStr(): string
public function getErrorStr(): string
{
return self::$error_str;
return $this->error_str;
}
/**
@@ -69,39 +85,30 @@ class Session
* @param string|null $session_name
* @return string|bool
*/
public static function startSession(?string $session_name = null)
public function startSession(?string $session_name = null)
{
// we can't start sessions on command line
if (\CoreLibs\Get\System::checkCLI()) {
self::$error_str = '[SESSION] No sessions in php cli';
if ($this->checkCLI()) {
$this->error_str = '[SESSION] No sessions in php cli';
return false;
}
// if session are OFF
if (self::getSessionStatus() === PHP_SESSION_DISABLED) {
self::$error_str = '[SESSION] Sessions are disabled';
if ($this->getSessionStatus() === PHP_SESSION_DISABLED) {
$this->error_str = '[SESSION] Sessions are disabled';
return false;
}
// session_status
// initial the session if there is no session running already
if (!self::checkActiveSession()) {
if (!$this->checkActiveSession()) {
// if session name is emtpy, check if there is a global set
// this is a deprecated fallback
$session_name = $session_name ?? $GLOBALS['SET_SESSION_NAME'] ?? '';
// check if we have an external session name given, else skip this step
// this is a deprecated fallback
if (
empty($session_name) &&
defined('SET_SESSION_NAME') &&
!empty(SET_SESSION_NAME)
) {
// set the session name for possible later check
$session_name = SET_SESSION_NAME;
}
// DEPRECTED: constant SET_SESSION_NAME is no longer used
// if set, set special session name
if (!empty($session_name)) {
// invalid session name, abort
if (!self::checkValidSessionName($session_name)) {
self::$error_str = '[SESSION] Invalid session name: ' . $session_name;
if (!$this->checkValidSessionName($session_name)) {
$this->error_str = '[SESSION] Invalid session name: ' . $session_name;
return false;
}
session_name($session_name);
@@ -110,11 +117,11 @@ class Session
session_start();
}
// if we still have no active session
if (!self::checkActiveSession()) {
self::$error_str = '[SESSION] Failed to activate session';
if (!$this->checkActiveSession()) {
$this->error_str = '[SESSION] Failed to activate session';
return false;
}
return self::getSessionId();
return $this->getSessionId();
}
/**
@@ -122,7 +129,7 @@ class Session
*
* @return string|bool
*/
public static function getSessionId()
public function getSessionId()
{
return session_id();
}
@@ -132,7 +139,7 @@ class Session
*
* @return string|bool
*/
public static function getSessionName()
public function getSessionName()
{
return session_name();
}
@@ -143,9 +150,9 @@ class Session
*
* @return bool True if there is an active session, else false
*/
public static function checkActiveSession(): bool
public function checkActiveSession(): bool
{
if (self::getSessionStatus() === PHP_SESSION_ACTIVE) {
if ($this->getSessionStatus() === PHP_SESSION_ACTIVE) {
return true;
} else {
return false;
@@ -160,7 +167,7 @@ class Session
*
* @return bool True und sucess, false on failure
*/
public static function writeClose(): bool
public function writeClose(): bool
{
return session_write_close();
}
@@ -175,7 +182,7 @@ class Session
*
* @return int
*/
public static function getSessionStatus(): int
public function getSessionStatus(): int
{
return session_status();
}