Unifi-Voucher-Tool/updater/Version.php
Friederich Loheide d93cbbadc2
Some checks failed
CI / PHP Lint (push) Successful in 41s
CI / PHP Lint-1 (push) Successful in 40s
CI / Unit Tests & Static Analysis (push) Failing after 39s
CI / PHP Lint (pull_request) Successful in 41s
CI / PHP Lint-1 (pull_request) Successful in 41s
CI / Unit Tests & Static Analysis (pull_request) Failing after 41s
Verweis auf das Änderungsprotokoll folgt dem eingestellten Kanal
Wurde die Vorschau gekürzt, zeigt die Oberfläche einen Verweis auf das
vollständige Änderungsprotokoll. Der zeigte fest auf den stabilen Kanal,
auch wenn die Installation auf dem Entwicklungskanal läuft.

Aufgefallen beim ersten echten Durchlauf mit Vorschau: der Dienst kennt
jetzt 3.0.0 und liefert die Abschnitte samt "complete": false.

Freigabe nach dem dokumentierten Ablauf: Changelog ergänzt, VERSION und
Version::RELEASE auf 3.0.1 angehoben.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-09-25 19:52:58 +00:00

105 lines
3 KiB
PHP

<?php
namespace Updater;
/**
* Versions-Auskunft.
*
* Zwei Angaben beschreiben einen Stand:
* - die Release-Version (SemVer) steht als Konstante im Code und wandert
* damit automatisch mit jedem Update mit,
* - der Git-Commit-SHA ist die technische Identitaet und steht in einer
* DATEI unter updater/storage/.version.
*
* Die Datei ist Absicht: der Updater muss den installierten Stand auch dann
* lesen koennen, wenn die Datenbank gerade nicht erreichbar ist. Ausserdem
* liegt storage/ auf der Liste der geschuetzten Pfade - ein Update
* ueberschreibt die Datei also nie mit dem Stand aus dem Archiv.
*/
final class Version
{
/**
* Release-Version dieses Codes (SemVer).
* Bei jeder Aenderung anheben, siehe CHANGELOG.md.
*/
public const RELEASE = '3.0.1';
/** @var string|null Nur fuer Tests: abweichender Ablageort. */
private static $storageOverride = null;
public static function storageDir(): string
{
return self::$storageOverride ?? __DIR__ . '/storage';
}
/**
* Lenkt Version, Fortschritt und Wartungsmarkierung in ein anderes
* Verzeichnis um. Ausschliesslich fuer Tests gedacht - im Betrieb bleibt
* es bei updater/storage/.
*/
public static function useStorageDir(?string $dir): void
{
self::$storageOverride = $dir === null ? null : rtrim($dir, '/');
}
private static function file(): string
{
return self::storageDir() . '/.version';
}
/** Installierter Commit-SHA oder null bei einer frischen Installation. */
public static function current(): ?string
{
$file = self::file();
if (!is_file($file)) {
return null;
}
$sha = trim((string)@file_get_contents($file));
return self::isSha($sha) ? $sha : null;
}
/**
* Schreibt den Stand zurueck. Ungueltige Werte werden abgelehnt, damit
* eine halbe Proxy-Antwort nicht als Version einzementiert wird.
*/
public static function save(string $sha): bool
{
$sha = strtolower(trim($sha));
if (!self::isSha($sha)) {
return false;
}
$dir = self::storageDir();
if (!is_dir($dir) && !@mkdir($dir, 0775, true) && !is_dir($dir)) {
return false;
}
return @file_put_contents(self::file(), $sha . "\n") !== false;
}
public static function isSha(string $value): bool
{
return (bool)preg_match('/^[0-9a-f]{40}$/', strtolower(trim($value)));
}
/** Kurzform fuer die Anzeige. */
public static function short(?string $sha = null): string
{
$sha = $sha ?? self::current();
return $sha === null ? '' : substr($sha, 0, 7);
}
public static function release(): string
{
return self::RELEASE;
}
/** "3.0.0 (a1b2c3d)" bzw. nur "3.0.0", solange kein SHA bekannt ist. */
public static function full(): string
{
$short = self::short();
return $short === '' ? self::RELEASE : self::RELEASE . ' (' . $short . ')';
}
}