Add database and database users sync (#537)

* Add database and database users sync

* get mysl users

* add mariadb and postgres

* fix phpstan
This commit is contained in:
Saeed Vaziry
2025-03-12 22:59:25 +01:00
committed by GitHub
parent 493cbb0849
commit 0f06d81aac
17 changed files with 383 additions and 65 deletions

View File

@ -0,0 +1,50 @@
<?php
namespace App\Actions\Database;
use App\Enums\DatabaseUserStatus;
use App\Models\DatabaseUser;
use App\Models\Server;
use App\SSH\Services\Database\Database;
class SyncDatabaseUsers
{
public function sync(Server $server): void
{
$service = $server->database();
if (! $service) {
return;
}
/** @var Database $handler */
$handler = $service->handler();
$this->updateUsers($server, $handler);
}
private function updateUsers(Server $server, Database $handler): void
{
$users = $handler->getUsers();
foreach ($users as $user) {
$databases = $user[2] != 'NULL' ? explode(',', $user[2]) : [];
/** @var ?DatabaseUser $databaseUser */
$databaseUser = $server->databaseUsers()
->where('username', $user[0])
->first();
if ($databaseUser === null) {
$server->databaseUsers()->create([
'username' => $user[0],
'host' => $user[1],
'databases' => $databases,
'status' => DatabaseUserStatus::READY,
]);
continue;
}
$databaseUser->databases = $databases;
$databaseUser->save();
}
}
}

View File

@ -0,0 +1,63 @@
<?php
namespace App\Actions\Database;
use App\Enums\DatabaseStatus;
use App\Models\Server;
use App\Models\Service;
use App\SSH\Services\Database\Database;
class SyncDatabases
{
public function sync(Server $server): void
{
$service = $server->database();
if (! $service) {
return;
}
/** @var Database $handler */
$handler = $service->handler();
$this->updateCharsets($service, $handler);
$this->updateDatabases($server, $handler);
}
private function updateCharsets(Service $service, Database $handler): void
{
$data = $service->type_data ?? [];
$charsets = $handler->getCharsets();
$data['charsets'] = $charsets['charsets'] ?? [];
$data['defaultCharset'] = $charsets['defaultCharset'] ?? '';
$service->type_data = $data;
$service->save();
}
private function updateDatabases(Server $server, Database $handler): void
{
$databases = $handler->getDatabases();
foreach ($databases as $database) {
/** @var ?\App\Models\Database $db */
$db = $server->databases()
->where('name', $database[0])
->first();
if ($db === null) {
$server->databases()->create([
'name' => $database[0],
'collation' => $database[2],
'charset' => $database[1],
'status' => DatabaseStatus::READY,
]);
continue;
}
if ($db->collation !== $database[2] || $db->charset !== $database[1]) {
$db->update([
'collation' => $database[2],
'charset' => $database[1],
]);
}
}
}
}

View File

@ -2,6 +2,7 @@
namespace App\SSH\Services\Database;
use App\Actions\Database\SyncDatabases;
use App\Enums\BackupStatus;
use App\Exceptions\ServiceInstallationFailed;
use App\Exceptions\SSHError;
@ -16,6 +17,11 @@ abstract class AbstractDatabase extends AbstractService implements Database
*/
protected array $systemDbs = [];
/**
* @var array<string>
*/
protected array $systemUsers = [];
protected string $defaultCharset;
protected string $separator = "\t";
@ -60,9 +66,8 @@ public function install(): void
$status = $this->service->server->systemd()->status($this->service->unit);
$this->service->validateInstall($status);
$this->service->server->os()->cleanup();
$this->updateCharsets();
$this->syncDatabases();
/** @TODO implement post-install for services and move it there */
app(SyncDatabases::class)->sync($this->service->server);
}
public function deletionRules(): array
@ -245,7 +250,7 @@ public function restoreBackup(BackupFile $backupFile, string $database): void
/**
* @throws SSHError
*/
public function updateCharsets(): void
public function getCharsets(): array
{
$data = $this->service->server->ssh()->exec(
view($this->getScriptView('get-charsets')),
@ -281,25 +286,22 @@ public function updateCharsets(): void
}
}
foreach ($results as $charset => $data) {
foreach ($results as $charset => $value) {
$results[$charset]['list'] = $charsetCollations[$charset];
}
ksort($results);
$data = array_merge(
$this->service->type_data ?? [],
['charsets' => $results, 'defaultCharset' => $this->defaultCharset]
);
$this->service->update(['type_data' => $data]);
return [
'charsets' => $results,
'defaultCharset' => $this->defaultCharset,
];
}
/**
* @throws SSHError
*/
public function syncDatabases(bool $createNew = true): void
public function getDatabases(): array
{
$data = $this->service->server->ssh()->exec(
view($this->getScriptView('get-db-list')),
@ -308,35 +310,36 @@ public function syncDatabases(bool $createNew = true): void
$databases = $this->tableToArray($data);
foreach ($databases as $database) {
if (in_array($database[0], $this->systemDbs)) {
continue;
}
return array_values(array_filter($databases, function ($database) {
return ! in_array($database[0], $this->systemDbs);
}));
}
/** @var ?\App\Models\Database $db */
$db = $this->service->server->databases()
->where('name', $database[0])
->first();
/**
* @throws SSHError
*/
public function getUsers(): array
{
$data = $this->service->server->ssh()->exec(
view($this->getScriptView('get-users-list')),
'get-users-list'
);
if ($db === null) {
if ($createNew) {
$this->service->server->databases()->create([
'name' => $database[0],
'collation' => $database[2],
'charset' => $database[1],
]);
}
$users = $this->tableToArray($data);
continue;
}
$users = array_values(array_filter($users, function ($users) {
return ! in_array($users[0], $this->systemUsers);
}));
if ($db->collation !== $database[2] || $db->charset !== $database[1]) {
$db->update([
'collation' => $database[2],
'charset' => $database[1],
]);
}
foreach ($users as $key => $user) {
$databases = explode(',', $user[2]);
$databases = array_values(array_filter($databases, function ($database) {
return ! in_array($database, $this->systemDbs);
}));
$users[$key][2] = implode(',', $databases);
}
return $users;
}
/**

View File

@ -26,7 +26,18 @@ public function runBackup(BackupFile $backupFile): void;
public function restoreBackup(BackupFile $backupFile, string $database): void;
public function updateCharsets(): void;
/**
* @return array<string, mixed>
*/
public function getCharsets(): array;
public function syncDatabases(bool $createNew = true): void;
/**
* @return array<int, array<string>>
*/
public function getDatabases(): array;
/**
* @return array<int, array<string>>
*/
public function getUsers(): array;
}

View File

@ -6,5 +6,11 @@ class Mariadb extends AbstractDatabase
{
protected array $systemDbs = ['information_schema', 'performance_schema', 'mysql', 'sys'];
protected array $systemUsers = [
'root',
'mysql',
'mariadb.sys',
];
protected string $defaultCharset = 'utf8mb3';
}

View File

@ -6,5 +6,12 @@ class Mysql extends AbstractDatabase
{
protected array $systemDbs = ['information_schema', 'performance_schema', 'mysql', 'sys'];
protected array $systemUsers = [
'root',
'mysql.session',
'mysql.sys',
'mysql.infoschema',
];
protected string $defaultCharset = 'utf8mb3';
}

View File

@ -6,6 +6,11 @@ class Postgresql extends AbstractDatabase
{
protected array $systemDbs = ['template0', 'template1', 'postgres'];
/**
* @var string[]
*/
protected array $systemUsers = ['postgres'];
protected string $defaultCharset = 'UTF8';
protected int $headerLines = 2;

View File

@ -3,6 +3,7 @@
namespace App\Web\Pages\Servers\Databases;
use App\Actions\Database\CreateDatabase;
use App\Actions\Database\SyncDatabases;
use App\Models\Database;
use App\Models\Server;
use App\Web\Contracts\HasSecondSubNav;
@ -85,6 +86,26 @@ public static function getCollationInput(Server $server): Select
protected function getHeaderActions(): array
{
return [
Action::make('sync')
->color('gray')
->label('Sync Databases')
->icon('heroicon-o-arrow-path')
->authorize(fn () => auth()->user()?->can('create', [Database::class, $this->server]))
->requiresConfirmation()
->modalDescription('This will create databases that exist on the server but not in Vito.')
->modalSubmitActionLabel('Sync')
->action(function () {
run_action($this, function () {
app(SyncDatabases::class)->sync($this->server);
$this->dispatch('$refresh');
Notification::make()
->success()
->title('Databases synced!')
->send();
});
}),
Action::make('create')
->label('Create Database')
->icon('heroicon-o-plus')

View File

@ -4,6 +4,7 @@
use App\Actions\Database\CreateDatabase;
use App\Actions\Database\CreateDatabaseUser;
use App\Actions\Database\SyncDatabaseUsers;
use App\Models\DatabaseUser;
use App\Web\Contracts\HasSecondSubNav;
use App\Web\Pages\Servers\Page;
@ -29,6 +30,26 @@ public function mount(): void
protected function getHeaderActions(): array
{
return [
Action::make('sync')
->color('gray')
->label('Sync Users')
->icon('heroicon-o-arrow-path')
->authorize(fn () => auth()->user()?->can('create', [DatabaseUser::class, $this->server]))
->requiresConfirmation()
->modalDescription('This will create db users that exist on the server but not in Vito.')
->modalSubmitActionLabel('Sync')
->action(function () {
run_action($this, function () {
app(SyncDatabaseUsers::class)->sync($this->server);
$this->dispatch('$refresh');
Notification::make()
->success()
->title('Users synced!')
->send();
});
}),
Action::make('create')
->icon('heroicon-o-plus')
->modalWidth(MaxWidth::Large)
@ -43,6 +64,7 @@ protected function getHeaderActions(): array
Checkbox::make('remote')
->label('Remote')
->default(false)
->visible(in_array($this->server->database()->name, ['mysql', 'mariadb']))
->reactive(),
TextInput::make('host')
->label('Host')