Nosial/socialbox-php
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Refactor SessionFlags handling and improve test coverage

Browse source
This commit is contained in:
netkas 2025-01-14 14:53:47 -05:00
parent 9d98659541
commit cd12c1b987
4 changed files with 293 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

67
src/Socialbox/Enums/Flags/SessionFlags.php
View file

@ -2,6 +2,8 @@
namespace Socialbox\Enums\Flags;
use Socialbox\Classes\Logger;
enum SessionFlags : string
{
// Session states
@ -45,20 +47,20 @@
public static function getRegistrationFlags(): array
{
return [
self::SET_PASSWORD->value,
self::SET_OTP->value,
self::SET_DISPLAY_NAME->value,
self::SET_DISPLAY_PICTURE->value,
self::SET_PHONE->value,
self::SET_BIRTHDAY->value,
self::SET_EMAIL->value,
self::VER_PRIVACY_POLICY->value,
self::VER_TERMS_OF_SERVICE->value,
self::VER_COMMUNITY_GUIDELINES->value,
self::VER_EMAIL->value,
self::VER_SMS->value,
self::VER_PHONE_CALL->value,
self::VER_IMAGE_CAPTCHA->value
self::SET_PASSWORD,
self::SET_OTP,
self::SET_DISPLAY_NAME,
self::SET_DISPLAY_PICTURE,
self::SET_PHONE,
self::SET_BIRTHDAY,
self::SET_EMAIL,
self::VER_PRIVACY_POLICY,
self::VER_TERMS_OF_SERVICE,
self::VER_COMMUNITY_GUIDELINES,
self::VER_EMAIL,
self::VER_SMS,
self::VER_PHONE_CALL,
self::VER_IMAGE_CAPTCHA
];
}
@ -70,10 +72,10 @@
public static function getAuthenticationFlags(): array
{
return [
self::VER_IMAGE_CAPTCHA->value,
self::VER_PASSWORD->value,
self::VER_OTP->value,
self::VER_AUTHENTICATION->value
self::VER_IMAGE_CAPTCHA,
self::VER_PASSWORD,
self::VER_OTP,
self::VER_AUTHENTICATION
];
}
@ -112,20 +114,35 @@
*/
public static function isComplete(array $flags): bool
{
$flags = array_map(function ($flag) {return is_string($flag) ? SessionFlags::from($flag) : $flag;}, $flags);
$flags = array_map(fn(SessionFlags $flag) => $flag->value, $flags);
// Map provided flags to their scalar values if they are enums
$flagValues = array_map(fn($flag) => $flag instanceof SessionFlags ? $flag->value : $flag, $flags);
if (in_array(SessionFlags::REGISTRATION_REQUIRED->value, $flags))
if (in_array(SessionFlags::REGISTRATION_REQUIRED, $flags, true))
{
return !array_intersect(self::getRegistrationFlags(), $flags); // Check if the intersection is empty
Logger::getLogger()->info('Checking registration flags');
// Compare values instead of objects
return empty(array_intersect(self::getScalarValues(self::getRegistrationFlags()), $flagValues));
}
if (in_array(SessionFlags::AUTHENTICATION_REQUIRED->value, $flags))
if (in_array(SessionFlags::AUTHENTICATION_REQUIRED, $flags, true))
{
return !array_intersect(self::getAuthenticationFlags(), $flags); // Check if the intersection is empty
Logger::getLogger()->info('Checking authentication flags');
// Compare values instead of objects
return empty(array_intersect(self::getScalarValues(self::getAuthenticationFlags()), $flagValues));
}
Logger::getLogger()->info('Neither registration nor authentication flags found');
return true;
}
/**
* Helper method: Converts an array of SessionFlags enums to their scalar values (strings)
*
* @param array $flagEnums Array of SessionFlags objects
* @return array Array of scalar values corresponding to the flags
*/
private static function getScalarValues(array $flagEnums): array
{
return array_map(fn(SessionFlags $flag) => $flag->value, $flagEnums);
}
}

21
src/Socialbox/Managers/SessionManager.php
View file

@ -11,7 +11,6 @@
use Socialbox\Classes\Cryptography;
use Socialbox\Classes\Database;
use Socialbox\Classes\Logger;
use Socialbox\Classes\Utilities;
use Socialbox\Enums\Flags\SessionFlags;
use Socialbox\Enums\SessionState;
use Socialbox\Enums\StandardError;
@ -33,9 +32,7 @@
* @param string $clientPublicSigningKey The client's public signing key, which must be a valid Ed25519 key.
* @param string $clientPublicEncryptionKey The client's public encryption key, which must be a valid X25519 key.
* @param KeyPair $serverEncryptionKeyPair The server's key pair for encryption, including both public and private keys.
*
* @return string The UUID of the newly created session.
*
* @throws InvalidArgumentException If the provided public signing key or encryption key is invalid.
* @throws DatabaseOperationException If there is an error during the session creation in the database.
*/
@ -310,7 +307,7 @@
* Retrieves the flags associated with a specific session.
*
* @param string $uuid The UUID of the session to retrieve flags for.
* @return array An array of flags associated with the specified session.
* @return SessionFlags[] An array of flags associated with the specified session.
* @throws StandardException If the specified session does not exist.
* @throws DatabaseOperationException If there
*/
@ -359,7 +356,7 @@
try
{
$statement = Database::getConnection()->prepare("UPDATE sessions SET flags=? WHERE uuid=?");
$statement->bindValue(1, Utilities::serializeList($flags));
$statement->bindValue(1, SessionFlags::toString($flags));
$statement->bindParam(2, $uuid);
$statement->execute();
}
@ -381,15 +378,16 @@
{
Logger::getLogger()->verbose(sprintf("Removing flags from session %s", $uuid));
$existingFlags = self::getFlags($uuid);
$flagsToRemove = array_map(fn($flag) => $flag->value, $flags);
$updatedFlags = array_filter($existingFlags, fn($flag) => !in_array($flag->value, $flagsToRemove));
$flags = SessionFlags::toString($updatedFlags);
$existingFlags = array_map(fn(SessionFlags $flag) => $flag->value, self::getFlags($uuid));
$flagsToRemove = array_map(fn(SessionFlags $flag) => $flag->value, $flags);
$updatedFlags = array_diff($existingFlags, $flagsToRemove);
$flagString = SessionFlags::toString(array_map(fn(string $value) => SessionFlags::from($value), $updatedFlags));
try
{
// Update the session flags in the database
$statement = Database::getConnection()->prepare("UPDATE sessions SET flags=? WHERE uuid=?");
$statement->bindValue(1, $flags); // Directly use the toString() result
$statement->bindValue(1, $flagString); // Use the stringified updated flags
$statement->bindParam(2, $uuid);
$statement->execute();
}
@ -436,7 +434,7 @@
public static function updateFlow(SessionRecord $session, array $flagsToRemove=[]): void
{
// Don't do anything if the session is already authenticated
if(!in_array(SessionFlags::REGISTRATION_REQUIRED, $session->getFlags()) || !in_array(SessionFlags::AUTHENTICATION_REQUIRED, $session->getFlags()))
if (!$session->flagExists(SessionFlags::AUTHENTICATION_REQUIRED) && !$session->flagExists(SessionFlags::REGISTRATION_REQUIRED))
{
return;
}
@ -456,6 +454,7 @@
{
SessionManager::removeFlags($session->getUuid(), [SessionFlags::REGISTRATION_REQUIRED, SessionFlags::AUTHENTICATION_REQUIRED]); // Remove the registration/authentication flags
SessionManager::setAuthenticated($session->getUuid(), true); // Mark the session as authenticated
RegisteredPeerManager::enablePeer($session->getPeerUuid()); // Enable the peer
}
}
}