Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean code, resolve psalm type error #5308

Closed
wants to merge 7 commits into from
Closed

Clean code, resolve psalm type error #5308

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d8bb5cf
use space for indent
docjyJ Sep 24, 2024
a0fba85
Typesafe ConfigurationController.php
docjyJ Sep 24, 2024
4dcf8be
Clean code and use const
docjyJ Sep 24, 2024
73cbf84
Clean ConfigurationController.php
docjyJ Sep 24, 2024
20857c4
Refactor
docjyJ Sep 24, 2024
25e2dd8
Auth readonly class
docjyJ Sep 24, 2024
2ebc759
Merge branch 'main' into enh/noid/optimize-psalm
docjyJ Sep 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions php/psalm.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
<?xml version="1.0"?>
<psalm
errorLevel="2"
resolveFromConfigFile="true"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="https://getpsalm.org/schema/config"
xsi:schemaLocation="https://getpsalm.org/schema/config"
errorLevel="2"
resolveFromConfigFile="true"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="https://getpsalm.org/schema/config"
xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
errorBaseline="psalm-baseline.xml"
findUnusedBaselineEntry="true"
findUnusedCode="false"
findUnusedBaselineEntry="true"
findUnusedCode="false"
>
<projectFiles>
<directory name="templates"/>
<directory name="src"/>
<file name="public/index.php"/>
</projectFiles>
<projectFiles>
<directory name="templates"/>
<directory name="src"/>
<file name="public/index.php"/>
</projectFiles>
</psalm>
18 changes: 9 additions & 9 deletions php/src/Auth/AuthManager.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,25 @@

use AIO\Data\ConfigurationManager;
use AIO\Data\DataConst;
use \DateTime;
use DateTime;

class AuthManager {
readonly class AuthManager {
private const string SESSION_KEY = 'aio_authenticated';
private ConfigurationManager $configurationManager;

public function __construct(ConfigurationManager $configurationManager) {
$this->configurationManager = $configurationManager;
public function __construct(
private ConfigurationManager $configurationManager
) {
}

public function CheckCredentials(string $password) : bool {
public function CheckCredentials(string $password): bool {
return hash_equals($this->configurationManager->GetPassword(), $password);
}

public function CheckToken(string $token) : bool {
public function CheckToken(string $token): bool {
return hash_equals($this->configurationManager->GetToken(), $token);
}

public function SetAuthState(bool $isLoggedIn) : void {
public function SetAuthState(bool $isLoggedIn): void {

if (!$this->IsAuthenticated() && $isLoggedIn === true) {
$date = new DateTime();
Expand All @@ -40,7 +40,7 @@ public function SetAuthState(bool $isLoggedIn) : void {
$_SESSION[self::SESSION_KEY] = $isLoggedIn;
}

public function IsAuthenticated() : bool {
public function IsAuthenticated(): bool {
return isset($_SESSION[self::SESSION_KEY]) && $_SESSION[self::SESSION_KEY] === true;
}
}
18 changes: 10 additions & 8 deletions php/src/Auth/PasswordGenerator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

namespace AIO\Auth;

use AIO\Data\ConfigurationManager;
use Random\RandomException;

class PasswordGenerator
{
private array $words = [
readonly class PasswordGenerator {

private const array WORDS = [
'abacus',
'abdomen',
'abdominal',
Expand Down Expand Up @@ -7785,14 +7785,16 @@ class PasswordGenerator
'zoom',
];

public function GeneratePassword(int $length) : string {

/** @throws RandomException */
public function GeneratePassword(int $length): string {
$password = '';

for($i = 0; $i < $length; $i ++) {
if($password !== '') {
for ($i = 0; $i < $length; $i++) {
if ($password !== '') {
$password = $password . ' ';
}
$password = $password . $this->words[random_int(0, 7775)];
$password = $password . PasswordGenerator::WORDS[random_int(0, 7775)];
}

return $password;
Expand Down
178 changes: 57 additions & 121 deletions php/src/Controller/ConfigurationController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,142 +2,78 @@

namespace AIO\Controller;

use AIO\ContainerDefinitionFetcher;
use AIO\Data\ConfigurationManager;
use AIO\Data\InvalidSettingConfigurationException;
use AIO\Docker\DockerActionManager;
use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request;

class ConfigurationController
{
private ConfigurationManager $configurationManager;
readonly class ConfigurationController {

public function __construct(
ConfigurationManager $configurationManager
private ConfigurationManager $configurationManager
) {
$this->configurationManager = $configurationManager;
}

public function SetConfig(Request $request, Response $response, array $args) : Response {
public function SetConfig(Request $request, Response $response, array $args): Response {
try {
if (isset($request->getParsedBody()['domain'])) {
$domain = $request->getParsedBody()['domain'] ?? '';
$this->configurationManager->SetDomain($domain);
}

if (isset($request->getParsedBody()['current-master-password']) || isset($request->getParsedBody()['new-master-password'])) {
$currentMasterPassword = $request->getParsedBody()['current-master-password'] ?? '';
$newMasterPassword = $request->getParsedBody()['new-master-password'] ?? '';
$this->configurationManager->ChangeMasterPassword($currentMasterPassword, $newMasterPassword);
}

if (isset($request->getParsedBody()['borg_backup_host_location'])) {
$location = $request->getParsedBody()['borg_backup_host_location'] ?? '';
$this->configurationManager->SetBorgBackupHostLocation($location);
}

if (isset($request->getParsedBody()['borg_restore_host_location']) || isset($request->getParsedBody()['borg_restore_password'])) {
$restoreLocation = $request->getParsedBody()['borg_restore_host_location'] ?? '';
$borgPassword = $request->getParsedBody()['borg_restore_password'] ?? '';
$this->configurationManager->SetBorgRestoreHostLocationAndPassword($restoreLocation, $borgPassword);
}

if (isset($request->getParsedBody()['daily_backup_time'])) {
if (isset($request->getParsedBody()['automatic_updates'])) {
$enableAutomaticUpdates = true;
} else {
$enableAutomaticUpdates = false;
}
if (isset($request->getParsedBody()['success_notification'])) {
$successNotification = true;
} else {
$successNotification = false;
}
$dailyBackupTime = $request->getParsedBody()['daily_backup_time'] ?? '';
$this->configurationManager->SetDailyBackupTime($dailyBackupTime, $enableAutomaticUpdates, $successNotification);
}

if (isset($request->getParsedBody()['delete_daily_backup_time'])) {
$this->configurationManager->DeleteDailyBackupTime();
}

if (isset($request->getParsedBody()['additional_backup_directories'])) {
$additionalBackupDirectories = $request->getParsedBody()['additional_backup_directories'] ?? '';
$this->configurationManager->SetAdditionalBackupDirectories($additionalBackupDirectories);
}

if (isset($request->getParsedBody()['delete_timezone'])) {
$this->configurationManager->DeleteTimezone();
}

if (isset($request->getParsedBody()['timezone'])) {
$timezone = $request->getParsedBody()['timezone'] ?? '';
$this->configurationManager->SetTimezone($timezone);
}

if (isset($request->getParsedBody()['options-form'])) {
if (isset($request->getParsedBody()['collabora']) && isset($request->getParsedBody()['onlyoffice'])) {
throw new InvalidSettingConfigurationException("Collabora and Onlyoffice are not allowed to be enabled at the same time!");
}
if (isset($request->getParsedBody()['clamav'])) {
$this->configurationManager->SetClamavEnabledState(1);
} else {
$this->configurationManager->SetClamavEnabledState(0);
}
if (isset($request->getParsedBody()['onlyoffice'])) {
$this->configurationManager->SetOnlyofficeEnabledState(1);
} else {
$this->configurationManager->SetOnlyofficeEnabledState(0);
}
if (isset($request->getParsedBody()['collabora'])) {
$this->configurationManager->SetCollaboraEnabledState(1);
} else {
$this->configurationManager->SetCollaboraEnabledState(0);
}
if (isset($request->getParsedBody()['talk'])) {
$this->configurationManager->SetTalkEnabledState(1);
} else {
$this->configurationManager->SetTalkEnabledState(0);
$body = $request->getParsedBody();
if (is_array($body)) {
if (is_string($body['domain']))
$this->configurationManager->SetDomain($body['domain']);

$currentMasterPassword = is_string($body['current-master-password']) ? $body['current-master-password'] : null;
$newMasterPassword = is_string($body['new-master-password']) ? $body['new-master-password'] : null;
if ($currentMasterPassword !== null || $newMasterPassword !== null)
$this->configurationManager->ChangeMasterPassword($currentMasterPassword ?? '', $newMasterPassword ?? '');

if (is_string($body['borg_backup_host_location']))
$this->configurationManager->SetBorgBackupHostLocation($body['borg_backup_host_location']);

$borgRestoreHostLocation = is_string($body['borg_restore_host_location']) ? $body['borg_restore_host_location'] : null;
$borgRestorePassword = is_string($body['borg_restore_password']) ? $body['borg_restore_password'] : null;
if ($borgRestoreHostLocation !== null || $borgRestorePassword !== null)
$this->configurationManager->SetBorgRestoreHostLocationAndPassword($borgRestoreHostLocation ?? '', $borgRestorePassword ?? '');

if (is_string($body['daily_backup_time']))
$this->configurationManager->SetDailyBackupTime(
$body['daily_backup_time'],
isset($body['automatic_updates']),
isset($body['success_notification']));

if (isset($body['delete_daily_backup_time']))
$this->configurationManager->DeleteDailyBackupTime();

if (is_string($body['additional_backup_directories']))
$this->configurationManager->SetAdditionalBackupDirectories($body['additional_backup_directories']);

if (isset($body['delete_timezone']))
$this->configurationManager->DeleteTimezone();

if (is_string($body['timezone']))
$this->configurationManager->SetTimezone($body['timezone']);

if (isset($body['options-form'])) {
if (isset($body['collabora']) && isset($body['onlyoffice']))
throw new InvalidSettingConfigurationException("Collabora and Onlyoffice are not allowed to be enabled at the same time!");
$this->configurationManager->SetClamavEnabledState(isset($body['clamav']) ? 1 : 0);
$this->configurationManager->SetOnlyofficeEnabledState(isset($body['onlyoffice']) ? 1 : 0);
$this->configurationManager->SetCollaboraEnabledState(isset($body['collabora']) ? 1 : 0);
$this->configurationManager->SetTalkEnabledState(isset($body['talk']) ? 1 : 0);
$this->configurationManager->SetTalkRecordingEnabledState(isset($body['talk-recording']) ? 1 : 0);
$this->configurationManager->SetImaginaryEnabledState(isset($body['imaginary']) ? 1 : 0);
$this->configurationManager->SetFulltextsearchEnabledState(isset($body['fulltextsearch']) ? 1 : 0);
$this->configurationManager->SetDockerSocketProxyEnabledState(isset($body['docker-socket-proxy']) ? 1 : 0);
$this->configurationManager->SetWhiteboardEnabledState(isset($body['whiteboard']) ? 1 : 0);
}
if (isset($request->getParsedBody()['talk-recording'])) {
$this->configurationManager->SetTalkRecordingEnabledState(1);
} else {
$this->configurationManager->SetTalkRecordingEnabledState(0);
}
if (isset($request->getParsedBody()['imaginary'])) {
$this->configurationManager->SetImaginaryEnabledState(1);
} else {
$this->configurationManager->SetImaginaryEnabledState(0);
}
if (isset($request->getParsedBody()['fulltextsearch'])) {
$this->configurationManager->SetFulltextsearchEnabledState(1);
} else {
$this->configurationManager->SetFulltextsearchEnabledState(0);
}
if (isset($request->getParsedBody()['docker-socket-proxy'])) {
$this->configurationManager->SetDockerSocketProxyEnabledState(1);
} else {
$this->configurationManager->SetDockerSocketProxyEnabledState(0);
}
if (isset($request->getParsedBody()['whiteboard'])) {
$this->configurationManager->SetWhiteboardEnabledState(1);
} else {
$this->configurationManager->SetWhiteboardEnabledState(0);
}
}

if (isset($request->getParsedBody()['delete_collabora_dictionaries'])) {
$this->configurationManager->DeleteCollaboraDictionaries();
}
if (isset($body['delete_collabora_dictionaries']))
$this->configurationManager->DeleteCollaboraDictionaries();

if (isset($request->getParsedBody()['collabora_dictionaries'])) {
$collaboraDictionaries = $request->getParsedBody()['collabora_dictionaries'] ?? '';
$this->configurationManager->SetCollaboraDictionaries($collaboraDictionaries);
}
if (is_string($body['collabora_dictionaries']))
$this->configurationManager->SetCollaboraDictionaries($body['collabora_dictionaries']);

if (isset($request->getParsedBody()['delete_borg_backup_host_location'])) {
$this->configurationManager->DeleteBorgBackupHostLocation();
if (isset($body['delete_borg_backup_host_location']))
$this->configurationManager->DeleteBorgBackupHostLocation();
}

return $response->withStatus(201)->withHeader('Location', '/');
Expand Down