mirror of
https://github.com/Part-DB/Part-DB-server.git
synced 2026-02-11 12:09:36 +00:00
Centralized git logic from InstallationTypeDetector and UpdateChecker in GitVersionInfoProvider service
This commit is contained in:
parent
7ff07a7ab4
commit
6dbead6d10
11 changed files with 242 additions and 214 deletions
|
|
@ -23,7 +23,6 @@ declare(strict_types=1);
|
||||||
|
|
||||||
namespace App\Command;
|
namespace App\Command;
|
||||||
|
|
||||||
use App\Services\System\InstallationType;
|
|
||||||
use App\Services\System\UpdateChecker;
|
use App\Services\System\UpdateChecker;
|
||||||
use App\Services\System\UpdateExecutor;
|
use App\Services\System\UpdateExecutor;
|
||||||
use Symfony\Component\Console\Attribute\AsCommand;
|
use Symfony\Component\Console\Attribute\AsCommand;
|
||||||
|
|
@ -134,7 +133,7 @@ HELP
|
||||||
// Handle --refresh option
|
// Handle --refresh option
|
||||||
if ($input->getOption('refresh')) {
|
if ($input->getOption('refresh')) {
|
||||||
$io->text('Refreshing version information...');
|
$io->text('Refreshing version information...');
|
||||||
$this->updateChecker->refreshGitInfo();
|
$this->updateChecker->refreshVersionInfo();
|
||||||
$io->success('Version cache cleared.');
|
$io->success('Version cache cleared.');
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -22,9 +22,9 @@ declare(strict_types=1);
|
||||||
*/
|
*/
|
||||||
namespace App\Command;
|
namespace App\Command;
|
||||||
|
|
||||||
use Symfony\Component\Console\Attribute\AsCommand;
|
use App\Services\System\GitVersionInfoProvider;
|
||||||
use App\Services\Misc\GitVersionInfo;
|
|
||||||
use Shivas\VersioningBundle\Service\VersionManagerInterface;
|
use Shivas\VersioningBundle\Service\VersionManagerInterface;
|
||||||
|
use Symfony\Component\Console\Attribute\AsCommand;
|
||||||
use Symfony\Component\Console\Command\Command;
|
use Symfony\Component\Console\Command\Command;
|
||||||
use Symfony\Component\Console\Input\InputInterface;
|
use Symfony\Component\Console\Input\InputInterface;
|
||||||
use Symfony\Component\Console\Output\OutputInterface;
|
use Symfony\Component\Console\Output\OutputInterface;
|
||||||
|
|
@ -33,7 +33,7 @@ use Symfony\Component\Console\Style\SymfonyStyle;
|
||||||
#[AsCommand('partdb:version|app:version', 'Shows the currently installed version of Part-DB.')]
|
#[AsCommand('partdb:version|app:version', 'Shows the currently installed version of Part-DB.')]
|
||||||
class VersionCommand extends Command
|
class VersionCommand extends Command
|
||||||
{
|
{
|
||||||
public function __construct(protected VersionManagerInterface $versionManager, protected GitVersionInfo $gitVersionInfo)
|
public function __construct(protected VersionManagerInterface $versionManager, protected GitVersionInfoProvider $gitVersionInfo)
|
||||||
{
|
{
|
||||||
parent::__construct();
|
parent::__construct();
|
||||||
}
|
}
|
||||||
|
|
@ -48,9 +48,9 @@ class VersionCommand extends Command
|
||||||
|
|
||||||
$message = 'Part-DB version: '. $this->versionManager->getVersion()->toString();
|
$message = 'Part-DB version: '. $this->versionManager->getVersion()->toString();
|
||||||
|
|
||||||
if ($this->gitVersionInfo->getGitBranchName() !== null) {
|
if ($this->gitVersionInfo->getBranchName() !== null) {
|
||||||
$message .= ' Git branch: '. $this->gitVersionInfo->getGitBranchName();
|
$message .= ' Git branch: '. $this->gitVersionInfo->getBranchName();
|
||||||
$message .= ', Git commit: '. $this->gitVersionInfo->getGitCommitHash();
|
$message .= ', Git commit: '. $this->gitVersionInfo->getCommitHash();
|
||||||
}
|
}
|
||||||
|
|
||||||
$io->success($message);
|
$io->success($message);
|
||||||
|
|
|
||||||
|
|
@ -24,8 +24,8 @@ namespace App\Controller;
|
||||||
|
|
||||||
use App\DataTables\LogDataTable;
|
use App\DataTables\LogDataTable;
|
||||||
use App\Entity\Parts\Part;
|
use App\Entity\Parts\Part;
|
||||||
use App\Services\Misc\GitVersionInfo;
|
|
||||||
use App\Services\System\BannerHelper;
|
use App\Services\System\BannerHelper;
|
||||||
|
use App\Services\System\GitVersionInfoProvider;
|
||||||
use App\Services\System\UpdateAvailableManager;
|
use App\Services\System\UpdateAvailableManager;
|
||||||
use Doctrine\ORM\EntityManagerInterface;
|
use Doctrine\ORM\EntityManagerInterface;
|
||||||
use Omines\DataTablesBundle\DataTableFactory;
|
use Omines\DataTablesBundle\DataTableFactory;
|
||||||
|
|
@ -43,7 +43,7 @@ class HomepageController extends AbstractController
|
||||||
|
|
||||||
|
|
||||||
#[Route(path: '/', name: 'homepage')]
|
#[Route(path: '/', name: 'homepage')]
|
||||||
public function homepage(Request $request, GitVersionInfo $versionInfo, EntityManagerInterface $entityManager,
|
public function homepage(Request $request, GitVersionInfoProvider $versionInfo, EntityManagerInterface $entityManager,
|
||||||
UpdateAvailableManager $updateAvailableManager): Response
|
UpdateAvailableManager $updateAvailableManager): Response
|
||||||
{
|
{
|
||||||
$this->denyAccessUnlessGranted('HAS_ACCESS_PERMISSIONS');
|
$this->denyAccessUnlessGranted('HAS_ACCESS_PERMISSIONS');
|
||||||
|
|
@ -77,8 +77,8 @@ class HomepageController extends AbstractController
|
||||||
|
|
||||||
return $this->render('homepage.html.twig', [
|
return $this->render('homepage.html.twig', [
|
||||||
'banner' => $this->bannerHelper->getBanner(),
|
'banner' => $this->bannerHelper->getBanner(),
|
||||||
'git_branch' => $versionInfo->getGitBranchName(),
|
'git_branch' => $versionInfo->getBranchName(),
|
||||||
'git_commit' => $versionInfo->getGitCommitHash(),
|
'git_commit' => $versionInfo->getCommitHash(),
|
||||||
'show_first_steps' => $show_first_steps,
|
'show_first_steps' => $show_first_steps,
|
||||||
'datatable' => $table,
|
'datatable' => $table,
|
||||||
'new_version_available' => $updateAvailableManager->isUpdateAvailable(),
|
'new_version_available' => $updateAvailableManager->isUpdateAvailable(),
|
||||||
|
|
|
||||||
|
|
@ -27,7 +27,7 @@ use App\Services\Attachments\AttachmentURLGenerator;
|
||||||
use App\Services\Attachments\BuiltinAttachmentsFinder;
|
use App\Services\Attachments\BuiltinAttachmentsFinder;
|
||||||
use App\Services\Doctrine\DBInfoHelper;
|
use App\Services\Doctrine\DBInfoHelper;
|
||||||
use App\Services\Doctrine\NatsortDebugHelper;
|
use App\Services\Doctrine\NatsortDebugHelper;
|
||||||
use App\Services\Misc\GitVersionInfo;
|
use App\Services\System\GitVersionInfoProvider;
|
||||||
use App\Services\System\UpdateAvailableManager;
|
use App\Services\System\UpdateAvailableManager;
|
||||||
use App\Settings\AppSettings;
|
use App\Settings\AppSettings;
|
||||||
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
|
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
|
||||||
|
|
@ -47,7 +47,7 @@ class ToolsController extends AbstractController
|
||||||
}
|
}
|
||||||
|
|
||||||
#[Route(path: '/server_infos', name: 'tools_server_infos')]
|
#[Route(path: '/server_infos', name: 'tools_server_infos')]
|
||||||
public function systemInfos(GitVersionInfo $versionInfo, DBInfoHelper $DBInfoHelper, NatsortDebugHelper $natsortDebugHelper,
|
public function systemInfos(GitVersionInfoProvider $versionInfo, DBInfoHelper $DBInfoHelper, NatsortDebugHelper $natsortDebugHelper,
|
||||||
AttachmentSubmitHandler $attachmentSubmitHandler, UpdateAvailableManager $updateAvailableManager,
|
AttachmentSubmitHandler $attachmentSubmitHandler, UpdateAvailableManager $updateAvailableManager,
|
||||||
AppSettings $settings): Response
|
AppSettings $settings): Response
|
||||||
{
|
{
|
||||||
|
|
@ -55,8 +55,8 @@ class ToolsController extends AbstractController
|
||||||
|
|
||||||
return $this->render('tools/server_infos/server_infos.html.twig', [
|
return $this->render('tools/server_infos/server_infos.html.twig', [
|
||||||
//Part-DB section
|
//Part-DB section
|
||||||
'git_branch' => $versionInfo->getGitBranchName(),
|
'git_branch' => $versionInfo->getBranchName(),
|
||||||
'git_commit' => $versionInfo->getGitCommitHash(),
|
'git_commit' => $versionInfo->getCommitHash(),
|
||||||
'default_locale' => $settings->system->localization->locale,
|
'default_locale' => $settings->system->localization->locale,
|
||||||
'default_timezone' => $settings->system->localization->timezone,
|
'default_timezone' => $settings->system->localization->timezone,
|
||||||
'default_currency' => $settings->system->localization->baseCurrency,
|
'default_currency' => $settings->system->localization->baseCurrency,
|
||||||
|
|
|
||||||
|
|
@ -23,6 +23,7 @@ declare(strict_types=1);
|
||||||
|
|
||||||
namespace App\Controller;
|
namespace App\Controller;
|
||||||
|
|
||||||
|
use App\Services\System\BackupManager;
|
||||||
use App\Services\System\UpdateChecker;
|
use App\Services\System\UpdateChecker;
|
||||||
use App\Services\System\UpdateExecutor;
|
use App\Services\System\UpdateExecutor;
|
||||||
use Shivas\VersioningBundle\Service\VersionManagerInterface;
|
use Shivas\VersioningBundle\Service\VersionManagerInterface;
|
||||||
|
|
@ -47,6 +48,7 @@ class UpdateManagerController extends AbstractController
|
||||||
private readonly UpdateChecker $updateChecker,
|
private readonly UpdateChecker $updateChecker,
|
||||||
private readonly UpdateExecutor $updateExecutor,
|
private readonly UpdateExecutor $updateExecutor,
|
||||||
private readonly VersionManagerInterface $versionManager,
|
private readonly VersionManagerInterface $versionManager,
|
||||||
|
private readonly BackupManager $backupManager,
|
||||||
#[Autowire(env: 'bool:DISABLE_WEB_UPDATES')]
|
#[Autowire(env: 'bool:DISABLE_WEB_UPDATES')]
|
||||||
private readonly bool $webUpdatesDisabled = false,
|
private readonly bool $webUpdatesDisabled = false,
|
||||||
#[Autowire(env: 'bool:DISABLE_BACKUP_RESTORE')]
|
#[Autowire(env: 'bool:DISABLE_BACKUP_RESTORE')]
|
||||||
|
|
@ -96,7 +98,7 @@ class UpdateManagerController extends AbstractController
|
||||||
'is_maintenance' => $this->updateExecutor->isMaintenanceMode(),
|
'is_maintenance' => $this->updateExecutor->isMaintenanceMode(),
|
||||||
'maintenance_info' => $this->updateExecutor->getMaintenanceInfo(),
|
'maintenance_info' => $this->updateExecutor->getMaintenanceInfo(),
|
||||||
'update_logs' => $this->updateExecutor->getUpdateLogs(),
|
'update_logs' => $this->updateExecutor->getUpdateLogs(),
|
||||||
'backups' => $this->updateExecutor->getBackups(),
|
'backups' => $this->backupManager->getBackups(),
|
||||||
'web_updates_disabled' => $this->webUpdatesDisabled,
|
'web_updates_disabled' => $this->webUpdatesDisabled,
|
||||||
'backup_restore_disabled' => $this->backupRestoreDisabled,
|
'backup_restore_disabled' => $this->backupRestoreDisabled,
|
||||||
]);
|
]);
|
||||||
|
|
@ -131,7 +133,7 @@ class UpdateManagerController extends AbstractController
|
||||||
return $this->json(['error' => 'Invalid CSRF token'], Response::HTTP_FORBIDDEN);
|
return $this->json(['error' => 'Invalid CSRF token'], Response::HTTP_FORBIDDEN);
|
||||||
}
|
}
|
||||||
|
|
||||||
$this->updateChecker->refreshGitInfo();
|
$this->updateChecker->refreshVersionInfo();
|
||||||
|
|
||||||
return $this->json([
|
return $this->json([
|
||||||
'success' => true,
|
'success' => true,
|
||||||
|
|
@ -173,7 +175,7 @@ class UpdateManagerController extends AbstractController
|
||||||
#[Route('/log/{filename}', name: 'admin_update_manager_log', methods: ['GET'])]
|
#[Route('/log/{filename}', name: 'admin_update_manager_log', methods: ['GET'])]
|
||||||
public function viewLog(string $filename): Response
|
public function viewLog(string $filename): Response
|
||||||
{
|
{
|
||||||
$this->denyAccessUnlessGranted('@system.show_updates');
|
$this->denyAccessUnlessGranted('@system.manage_updates');
|
||||||
|
|
||||||
// Security: Only allow viewing files from the update logs directory
|
// Security: Only allow viewing files from the update logs directory
|
||||||
$logs = $this->updateExecutor->getUpdateLogs();
|
$logs = $this->updateExecutor->getUpdateLogs();
|
||||||
|
|
@ -303,7 +305,7 @@ class UpdateManagerController extends AbstractController
|
||||||
{
|
{
|
||||||
$this->denyAccessUnlessGranted('@system.manage_updates');
|
$this->denyAccessUnlessGranted('@system.manage_updates');
|
||||||
|
|
||||||
$details = $this->updateExecutor->getBackupDetails($filename);
|
$details = $this->backupManager->getBackupDetails($filename);
|
||||||
|
|
||||||
if (!$details) {
|
if (!$details) {
|
||||||
return $this->json(['error' => 'Backup not found'], 404);
|
return $this->json(['error' => 'Backup not found'], 404);
|
||||||
|
|
@ -344,7 +346,7 @@ class UpdateManagerController extends AbstractController
|
||||||
}
|
}
|
||||||
|
|
||||||
// Verify the backup exists
|
// Verify the backup exists
|
||||||
$backupDetails = $this->updateExecutor->getBackupDetails($filename);
|
$backupDetails = $this->backupManager->getBackupDetails($filename);
|
||||||
if (!$backupDetails) {
|
if (!$backupDetails) {
|
||||||
$this->addFlash('error', 'Backup file not found.');
|
$this->addFlash('error', 'Backup file not found.');
|
||||||
return $this->redirectToRoute('admin_update_manager');
|
return $this->redirectToRoute('admin_update_manager');
|
||||||
|
|
|
||||||
|
|
@ -1,83 +0,0 @@
|
||||||
<?php
|
|
||||||
/**
|
|
||||||
* This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
|
|
||||||
*
|
|
||||||
* Copyright (C) 2019 - 2022 Jan Böhmer (https://github.com/jbtronics)
|
|
||||||
*
|
|
||||||
* This program is free software: you can redistribute it and/or modify
|
|
||||||
* it under the terms of the GNU Affero General Public License as published
|
|
||||||
* by the Free Software Foundation, either version 3 of the License, or
|
|
||||||
* (at your option) any later version.
|
|
||||||
*
|
|
||||||
* This program is distributed in the hope that it will be useful,
|
|
||||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
||||||
* GNU Affero General Public License for more details.
|
|
||||||
*
|
|
||||||
* You should have received a copy of the GNU Affero General Public License
|
|
||||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
||||||
*/
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace App\Services\Misc;
|
|
||||||
|
|
||||||
use Symfony\Component\HttpKernel\KernelInterface;
|
|
||||||
|
|
||||||
class GitVersionInfo
|
|
||||||
{
|
|
||||||
protected string $project_dir;
|
|
||||||
|
|
||||||
public function __construct(KernelInterface $kernel)
|
|
||||||
{
|
|
||||||
$this->project_dir = $kernel->getProjectDir();
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the Git branch name of the installed system.
|
|
||||||
*
|
|
||||||
* @return string|null The current git branch name. Null, if this is no Git installation
|
|
||||||
*/
|
|
||||||
public function getGitBranchName(): ?string
|
|
||||||
{
|
|
||||||
if (is_file($this->project_dir.'/.git/HEAD')) {
|
|
||||||
$git = file($this->project_dir.'/.git/HEAD');
|
|
||||||
$head = explode('/', $git[0], 3);
|
|
||||||
|
|
||||||
if (!isset($head[2])) {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
return trim($head[2]);
|
|
||||||
}
|
|
||||||
|
|
||||||
return null; // this is not a Git installation
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get hash of the last git commit (on remote "origin"!).
|
|
||||||
*
|
|
||||||
* If this method does not work, try to make a "git pull" first!
|
|
||||||
*
|
|
||||||
* @param int $length if this is smaller than 40, only the first $length characters will be returned
|
|
||||||
*
|
|
||||||
* @return string|null The hash of the last commit, null If this is no Git installation
|
|
||||||
*/
|
|
||||||
public function getGitCommitHash(int $length = 7): ?string
|
|
||||||
{
|
|
||||||
$filename = $this->project_dir.'/.git/refs/remotes/origin/'.$this->getGitBranchName();
|
|
||||||
if (is_file($filename)) {
|
|
||||||
$head = file($filename);
|
|
||||||
|
|
||||||
if (!isset($head[0])) {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
$hash = $head[0];
|
|
||||||
|
|
||||||
return substr($hash, 0, $length);
|
|
||||||
}
|
|
||||||
|
|
||||||
return null; // this is not a Git installation
|
|
||||||
}
|
|
||||||
}
|
|
||||||
135
src/Services/System/GitVersionInfoProvider.php
Normal file
135
src/Services/System/GitVersionInfoProvider.php
Normal file
|
|
@ -0,0 +1,135 @@
|
||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
|
||||||
|
*
|
||||||
|
* Copyright (C) 2019 - 2022 Jan Böhmer (https://github.com/jbtronics)
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as published
|
||||||
|
* by the Free Software Foundation, either version 3 of the License, or
|
||||||
|
* (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace App\Services\System;
|
||||||
|
|
||||||
|
use Symfony\Component\DependencyInjection\Attribute\Autowire;
|
||||||
|
use Symfony\Component\Process\Process;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This service provides information about the current Git installation (if any).
|
||||||
|
*/
|
||||||
|
final readonly class GitVersionInfoProvider
|
||||||
|
{
|
||||||
|
public function __construct(#[Autowire(param: 'kernel.project_dir')] private string $project_dir)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check if the project directory is a Git repository.
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
|
public function isGitRepo(): bool
|
||||||
|
{
|
||||||
|
return is_dir($this->getGitDirectory());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the path to the Git directory of the installed system without a trailing slash.
|
||||||
|
* Even if this is no Git installation, the path is returned.
|
||||||
|
* @return string The path to the Git directory of the installed system
|
||||||
|
*/
|
||||||
|
public function getGitDirectory(): string
|
||||||
|
{
|
||||||
|
return $this->project_dir . '/.git';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the Git branch name of the installed system.
|
||||||
|
*
|
||||||
|
* @return string|null The current git branch name. Null, if this is no Git installation
|
||||||
|
*/
|
||||||
|
public function getBranchName(): ?string
|
||||||
|
{
|
||||||
|
if (is_file($this->getGitDirectory() . '/HEAD')) {
|
||||||
|
$git = file($this->getGitDirectory() . '/HEAD');
|
||||||
|
$head = explode('/', $git[0], 3);
|
||||||
|
|
||||||
|
if (!isset($head[2])) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
return trim($head[2]);
|
||||||
|
}
|
||||||
|
|
||||||
|
return null; // this is not a Git installation
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get hash of the last git commit (on remote "origin"!).
|
||||||
|
*
|
||||||
|
* If this method does not work, try to make a "git pull" first!
|
||||||
|
*
|
||||||
|
* @param int $length if this is smaller than 40, only the first $length characters will be returned
|
||||||
|
*
|
||||||
|
* @return string|null The hash of the last commit, null If this is no Git installation
|
||||||
|
*/
|
||||||
|
public function getCommitHash(int $length = 8): ?string
|
||||||
|
{
|
||||||
|
$filename = $this->getGitDirectory() . '/refs/remotes/origin/'.$this->getBranchName();
|
||||||
|
if (is_file($filename)) {
|
||||||
|
$head = file($filename);
|
||||||
|
|
||||||
|
if (!isset($head[0])) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
$hash = $head[0];
|
||||||
|
|
||||||
|
return substr($hash, 0, $length);
|
||||||
|
}
|
||||||
|
|
||||||
|
return null; // this is not a Git installation
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the Git remote URL of the installed system.
|
||||||
|
*/
|
||||||
|
public function getRemoteURL(): ?string
|
||||||
|
{
|
||||||
|
// Get remote URL
|
||||||
|
$configFile = $this->getGitDirectory() . '/config';
|
||||||
|
if (file_exists($configFile)) {
|
||||||
|
$config = file_get_contents($configFile);
|
||||||
|
if (preg_match('#url = (.+)#', $config, $matches)) {
|
||||||
|
return trim($matches[1]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return null; // this is not a Git installation
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check if there are local changes in the Git repository.
|
||||||
|
* Attention: This runs a git command, which might be slow!
|
||||||
|
* @return bool|null True if there are local changes, false if not, null if this is not a Git installation
|
||||||
|
*/
|
||||||
|
public function hasLocalChanges(): ?bool
|
||||||
|
{
|
||||||
|
$process = new Process(['git', 'status', '--porcelain'], $this->project_dir);
|
||||||
|
$process->run();
|
||||||
|
if (!$process->isSuccessful()) {
|
||||||
|
return null; // this is not a Git installation
|
||||||
|
}
|
||||||
|
return !empty(trim($process->getOutput()));
|
||||||
|
}
|
||||||
|
}
|
||||||
65
src/Services/System/InstallationType.php
Normal file
65
src/Services/System/InstallationType.php
Normal file
|
|
@ -0,0 +1,65 @@
|
||||||
|
<?php
|
||||||
|
/*
|
||||||
|
* This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
|
||||||
|
*
|
||||||
|
* Copyright (C) 2019 - 2026 Jan Böhmer (https://github.com/jbtronics)
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as published
|
||||||
|
* by the Free Software Foundation, either version 3 of the License, or
|
||||||
|
* (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace App\Services\System;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Detects the installation type of Part-DB to determine the appropriate update strategy.
|
||||||
|
*/
|
||||||
|
enum InstallationType: string
|
||||||
|
{
|
||||||
|
case GIT = 'git';
|
||||||
|
case DOCKER = 'docker';
|
||||||
|
case ZIP_RELEASE = 'zip_release';
|
||||||
|
case UNKNOWN = 'unknown';
|
||||||
|
|
||||||
|
public function getLabel(): string
|
||||||
|
{
|
||||||
|
return match ($this) {
|
||||||
|
self::GIT => 'Git Clone',
|
||||||
|
self::DOCKER => 'Docker',
|
||||||
|
self::ZIP_RELEASE => 'Release Archive (ZIP File)',
|
||||||
|
self::UNKNOWN => 'Unknown',
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
public function supportsAutoUpdate(): bool
|
||||||
|
{
|
||||||
|
return match ($this) {
|
||||||
|
self::GIT => true,
|
||||||
|
self::DOCKER => false,
|
||||||
|
// ZIP_RELEASE auto-update not yet implemented
|
||||||
|
self::ZIP_RELEASE => false,
|
||||||
|
self::UNKNOWN => false,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
public function getUpdateInstructions(): string
|
||||||
|
{
|
||||||
|
return match ($this) {
|
||||||
|
self::GIT => 'Run: php bin/console partdb:update',
|
||||||
|
self::DOCKER => 'Pull the new Docker image and recreate the container: docker-compose pull && docker-compose up -d',
|
||||||
|
self::ZIP_RELEASE => 'Download the new release ZIP from GitHub, extract it over your installation, and run: php bin/console doctrine:migrations:migrate && php bin/console cache:clear',
|
||||||
|
self::UNKNOWN => 'Unable to determine installation type. Please update manually.',
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -26,51 +26,9 @@ namespace App\Services\System;
|
||||||
use Symfony\Component\DependencyInjection\Attribute\Autowire;
|
use Symfony\Component\DependencyInjection\Attribute\Autowire;
|
||||||
use Symfony\Component\Process\Process;
|
use Symfony\Component\Process\Process;
|
||||||
|
|
||||||
/**
|
readonly class InstallationTypeDetector
|
||||||
* Detects the installation type of Part-DB to determine the appropriate update strategy.
|
|
||||||
*/
|
|
||||||
enum InstallationType: string
|
|
||||||
{
|
{
|
||||||
case GIT = 'git';
|
public function __construct(#[Autowire(param: 'kernel.project_dir')] private string $project_dir, private GitVersionInfoProvider $gitVersionInfoProvider)
|
||||||
case DOCKER = 'docker';
|
|
||||||
case ZIP_RELEASE = 'zip_release';
|
|
||||||
case UNKNOWN = 'unknown';
|
|
||||||
|
|
||||||
public function getLabel(): string
|
|
||||||
{
|
|
||||||
return match($this) {
|
|
||||||
self::GIT => 'Git Clone',
|
|
||||||
self::DOCKER => 'Docker',
|
|
||||||
self::ZIP_RELEASE => 'Release Archive',
|
|
||||||
self::UNKNOWN => 'Unknown',
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
public function supportsAutoUpdate(): bool
|
|
||||||
{
|
|
||||||
return match($this) {
|
|
||||||
self::GIT => true,
|
|
||||||
self::DOCKER => false,
|
|
||||||
// ZIP_RELEASE auto-update not yet implemented
|
|
||||||
self::ZIP_RELEASE => false,
|
|
||||||
self::UNKNOWN => false,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
public function getUpdateInstructions(): string
|
|
||||||
{
|
|
||||||
return match($this) {
|
|
||||||
self::GIT => 'Run: php bin/console partdb:update',
|
|
||||||
self::DOCKER => 'Pull the new Docker image and recreate the container: docker-compose pull && docker-compose up -d',
|
|
||||||
self::ZIP_RELEASE => 'Download the new release ZIP from GitHub, extract it over your installation, and run: php bin/console doctrine:migrations:migrate && php bin/console cache:clear',
|
|
||||||
self::UNKNOWN => 'Unable to determine installation type. Please update manually.',
|
|
||||||
};
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
class InstallationTypeDetector
|
|
||||||
{
|
|
||||||
public function __construct(#[Autowire(param: 'kernel.project_dir')] private readonly string $project_dir)
|
|
||||||
{
|
{
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
@ -129,7 +87,7 @@ class InstallationTypeDetector
|
||||||
*/
|
*/
|
||||||
public function isGitInstall(): bool
|
public function isGitInstall(): bool
|
||||||
{
|
{
|
||||||
return is_dir($this->project_dir . '/.git');
|
return $this->gitVersionInfoProvider->isGitRepo();
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
@ -169,51 +127,21 @@ class InstallationTypeDetector
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Git-specific information.
|
* Get Git-specific information.
|
||||||
|
* @return array{branch: string|null, commit: string|null, remote_url: string|null, has_local_changes: bool}
|
||||||
*/
|
*/
|
||||||
private function getGitInfo(): array
|
private function getGitInfo(): array
|
||||||
{
|
{
|
||||||
$info = [
|
return [
|
||||||
'branch' => null,
|
'branch' => $this->gitVersionInfoProvider->getBranchName(),
|
||||||
'commit' => null,
|
'commit' => $this->gitVersionInfoProvider->getCommitHash(8),
|
||||||
'remote_url' => null,
|
'remote_url' => $this->gitVersionInfoProvider->getRemoteURL(),
|
||||||
'has_local_changes' => false,
|
'has_local_changes' => $this->gitVersionInfoProvider->hasLocalChanges() ?? false,
|
||||||
];
|
];
|
||||||
|
|
||||||
// Get branch
|
|
||||||
$headFile = $this->project_dir . '/.git/HEAD';
|
|
||||||
if (file_exists($headFile)) {
|
|
||||||
$head = file_get_contents($headFile);
|
|
||||||
if (preg_match('#ref: refs/heads/(.+)#', $head, $matches)) {
|
|
||||||
$info['branch'] = trim($matches[1]);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Get remote URL
|
|
||||||
$configFile = $this->project_dir . '/.git/config';
|
|
||||||
if (file_exists($configFile)) {
|
|
||||||
$config = file_get_contents($configFile);
|
|
||||||
if (preg_match('#url = (.+)#', $config, $matches)) {
|
|
||||||
$info['remote_url'] = trim($matches[1]);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Get commit hash
|
|
||||||
$process = new Process(['git', 'rev-parse', '--short', 'HEAD'], $this->project_dir);
|
|
||||||
$process->run();
|
|
||||||
if ($process->isSuccessful()) {
|
|
||||||
$info['commit'] = trim($process->getOutput());
|
|
||||||
}
|
|
||||||
|
|
||||||
// Check for local changes
|
|
||||||
$process = new Process(['git', 'status', '--porcelain'], $this->project_dir);
|
|
||||||
$process->run();
|
|
||||||
$info['has_local_changes'] = !empty(trim($process->getOutput()));
|
|
||||||
|
|
||||||
return $info;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Docker-specific information.
|
* Get Docker-specific information.
|
||||||
|
* @return array{container_id: string|null, image: string|null}
|
||||||
*/
|
*/
|
||||||
private function getDockerInfo(): array
|
private function getDockerInfo(): array
|
||||||
{
|
{
|
||||||
|
|
|
||||||
|
|
@ -48,6 +48,7 @@ class UpdateChecker
|
||||||
private readonly CacheInterface $updateCache, private readonly VersionManagerInterface $versionManager,
|
private readonly CacheInterface $updateCache, private readonly VersionManagerInterface $versionManager,
|
||||||
private readonly PrivacySettings $privacySettings, private readonly LoggerInterface $logger,
|
private readonly PrivacySettings $privacySettings, private readonly LoggerInterface $logger,
|
||||||
private readonly InstallationTypeDetector $installationTypeDetector,
|
private readonly InstallationTypeDetector $installationTypeDetector,
|
||||||
|
private readonly GitVersionInfoProvider $gitVersionInfoProvider,
|
||||||
#[Autowire(param: 'kernel.debug')] private readonly bool $is_dev_mode,
|
#[Autowire(param: 'kernel.debug')] private readonly bool $is_dev_mode,
|
||||||
#[Autowire(param: 'kernel.project_dir')] private readonly string $project_dir)
|
#[Autowire(param: 'kernel.project_dir')] private readonly string $project_dir)
|
||||||
{
|
{
|
||||||
|
|
@ -84,34 +85,15 @@ class UpdateChecker
|
||||||
'is_git_install' => false,
|
'is_git_install' => false,
|
||||||
];
|
];
|
||||||
|
|
||||||
$gitDir = $this->project_dir . '/.git';
|
if (!$this->gitVersionInfoProvider->isGitRepo()) {
|
||||||
|
|
||||||
if (!is_dir($gitDir)) {
|
|
||||||
return $info;
|
return $info;
|
||||||
}
|
}
|
||||||
|
|
||||||
$info['is_git_install'] = true;
|
$info['is_git_install'] = true;
|
||||||
|
|
||||||
// Get branch from HEAD file
|
$info['branch'] = $this->gitVersionInfoProvider->getBranchName();
|
||||||
$headFile = $gitDir . '/HEAD';
|
$info['commit'] = $this->gitVersionInfoProvider->getCommitHash(8);
|
||||||
if (file_exists($headFile)) {
|
$info['has_local_changes'] = $this->gitVersionInfoProvider->hasLocalChanges();
|
||||||
$head = file_get_contents($headFile);
|
|
||||||
if (preg_match('#ref: refs/heads/(.+)#', $head, $matches)) {
|
|
||||||
$info['branch'] = trim($matches[1]);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Get current commit
|
|
||||||
$process = new Process(['git', 'rev-parse', '--short', 'HEAD'], $this->project_dir);
|
|
||||||
$process->run();
|
|
||||||
if ($process->isSuccessful()) {
|
|
||||||
$info['commit'] = trim($process->getOutput());
|
|
||||||
}
|
|
||||||
|
|
||||||
// Check for local changes
|
|
||||||
$process = new Process(['git', 'status', '--porcelain'], $this->project_dir);
|
|
||||||
$process->run();
|
|
||||||
$info['has_local_changes'] = !empty(trim($process->getOutput()));
|
|
||||||
|
|
||||||
// Get commits behind (fetch first)
|
// Get commits behind (fetch first)
|
||||||
if ($info['branch']) {
|
if ($info['branch']) {
|
||||||
|
|
@ -151,7 +133,7 @@ class UpdateChecker
|
||||||
/**
|
/**
|
||||||
* Force refresh git information by invalidating cache.
|
* Force refresh git information by invalidating cache.
|
||||||
*/
|
*/
|
||||||
public function refreshGitInfo(): void
|
public function refreshVersionInfo(): void
|
||||||
{
|
{
|
||||||
$gitInfo = $this->getGitInfo();
|
$gitInfo = $this->getGitInfo();
|
||||||
if ($gitInfo['branch']) {
|
if ($gitInfo['branch']) {
|
||||||
|
|
|
||||||
|
|
@ -7,8 +7,8 @@ namespace App\State;
|
||||||
use ApiPlatform\Metadata\Operation;
|
use ApiPlatform\Metadata\Operation;
|
||||||
use ApiPlatform\State\ProviderInterface;
|
use ApiPlatform\State\ProviderInterface;
|
||||||
use App\ApiResource\PartDBInfo;
|
use App\ApiResource\PartDBInfo;
|
||||||
use App\Services\Misc\GitVersionInfo;
|
|
||||||
use App\Services\System\BannerHelper;
|
use App\Services\System\BannerHelper;
|
||||||
|
use App\Services\System\GitVersionInfoProvider;
|
||||||
use App\Settings\SystemSettings\CustomizationSettings;
|
use App\Settings\SystemSettings\CustomizationSettings;
|
||||||
use App\Settings\SystemSettings\LocalizationSettings;
|
use App\Settings\SystemSettings\LocalizationSettings;
|
||||||
use Shivas\VersioningBundle\Service\VersionManagerInterface;
|
use Shivas\VersioningBundle\Service\VersionManagerInterface;
|
||||||
|
|
@ -17,7 +17,7 @@ class PartDBInfoProvider implements ProviderInterface
|
||||||
{
|
{
|
||||||
|
|
||||||
public function __construct(private readonly VersionManagerInterface $versionManager,
|
public function __construct(private readonly VersionManagerInterface $versionManager,
|
||||||
private readonly GitVersionInfo $gitVersionInfo,
|
private readonly GitVersionInfoProvider $gitVersionInfo,
|
||||||
private readonly BannerHelper $bannerHelper,
|
private readonly BannerHelper $bannerHelper,
|
||||||
private readonly string $default_uri,
|
private readonly string $default_uri,
|
||||||
private readonly LocalizationSettings $localizationSettings,
|
private readonly LocalizationSettings $localizationSettings,
|
||||||
|
|
@ -31,8 +31,8 @@ class PartDBInfoProvider implements ProviderInterface
|
||||||
{
|
{
|
||||||
return new PartDBInfo(
|
return new PartDBInfo(
|
||||||
version: $this->versionManager->getVersion()->toString(),
|
version: $this->versionManager->getVersion()->toString(),
|
||||||
git_branch: $this->gitVersionInfo->getGitBranchName(),
|
git_branch: $this->gitVersionInfo->getBranchName(),
|
||||||
git_commit: $this->gitVersionInfo->getGitCommitHash(),
|
git_commit: $this->gitVersionInfo->getCommitHash(),
|
||||||
title: $this->customizationSettings->instanceName,
|
title: $this->customizationSettings->instanceName,
|
||||||
banner: $this->bannerHelper->getBanner(),
|
banner: $this->bannerHelper->getBanner(),
|
||||||
default_uri: $this->default_uri,
|
default_uri: $this->default_uri,
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue