Part-DB-server/src/Services/System/UpdateAvailableFacade.php
2026-05-01 20:21:58 +02:00

110 lines
3.4 KiB
PHP

<?php
/*
* This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
*
* Copyright (C) 2019 - 2023 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 App\Settings\SystemSettings\PrivacySettings;
use Symfony\Contracts\Cache\CacheInterface;
use Symfony\Contracts\Cache\ItemInterface;
use Version\Version;
/**
* This class checks if a new version of Part-DB is available.
*/
class UpdateAvailableFacade
{
private const CACHE_KEY = 'uam_latest_version';
private const CACHE_TTL = 60 * 60 * 24 * 2; // 2 day
public function __construct(
private readonly CacheInterface $updateCache,
private readonly PrivacySettings $privacySettings,
private readonly UpdateChecker $updateChecker,
)
{
}
/**
* Gets the latest version of Part-DB as string (e.g. "1.2.3").
* This value is cached for 2 days.
* @return string
*/
public function getLatestVersionString(): string
{
return $this->getLatestVersionInfo()['version'];
}
/**
* Gets the latest version of Part-DB as Version object.
*/
public function getLatestVersion(): Version
{
return Version::fromString($this->getLatestVersionString());
}
/**
* Gets the URL to the latest version of Part-DB on GitHub.
* @return string
*/
public function getLatestVersionUrl(): string
{
return $this->getLatestVersionInfo()['url'];
}
/**
* Checks if a new version of Part-DB is available. This value is cached for 2 days.
* @return bool
*/
public function isUpdateAvailable(): bool
{
//If we don't want to check for updates, we can return false
if (!$this->privacySettings->checkForUpdates) {
return false;
}
$latestVersion = $this->getLatestVersion();
return $this->updateChecker->isNewerVersionThanCurrent($latestVersion);
}
/**
* Get the latest version info. The value is cached for 2 days.
* @return array
* @phpstan-return array{version: string, url: string}
*/
private function getLatestVersionInfo(): array
{
//If we don't want to check for updates, we can return dummy data
if (!$this->privacySettings->checkForUpdates) {
return [
'version' => '0.0.1',
'url' => 'update-checking-disabled'
];
}
return $this->updateCache->get(self::CACHE_KEY, function (ItemInterface $item) {
$item->expiresAfter(self::CACHE_TTL);
return $this->updateChecker->getLatestVersion();
}) ?? ['version' => '0.0.1', 'url' => 'update-checking-failed'];
}
}