Skip to content

Add metadata to download buttons, refactor Platform.php, Os.php #413

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.

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

Merged
merged 2 commits into from
May 23, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 6 additions & 6 deletions lib/Artifacts.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

use Github\Client;
use LMMS\HttpClientPlugin\UriRecordPlugin;
use LMMS\PlatformParser;
use LMMS\Platform;
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;

class Artifacts
Expand Down Expand Up @@ -51,7 +51,7 @@ public function getForPullRequest(int $id): array
// Find a check run corresponding to the GitHub Actions build workflow
foreach ($checks['check_runs'] as $run) {
if ($run['app']['slug'] === 'github-actions') {
$parser = new PlatformParser($run['name']);
$parser = new Platform($run['name']);
if($parser->found()) {
$jobId = $run['id'];
break;
Expand Down Expand Up @@ -83,9 +83,9 @@ public function getArtifactDownloadUrl(int $artifactId): string
private function mapBranchAssetsFromJson(array $json): array
{
return array_map(function (array $artifact) {
$parsed = new PlatformParser($artifact['name']);
$parsed = new Platform($artifact['name']);
return new Asset(
platform: $parsed->getPlatform(),
platform: $parsed,
platformName: $parsed, // __toString()
releaseName: '@' . substr($artifact['workflow_run']['head_sha'], 0, 7),
downloadUrl: $this->router->generate('download_artifact', ['id' => $artifact['id']]),
Expand All @@ -99,9 +99,9 @@ private function mapBranchAssetsFromJson(array $json): array
private function mapPullRequestAssetsFromJson(array $json, string $pr, string $description): array
{
return array_map(function (array $artifact) use ($pr, $description) {
$parsed = new PlatformParser($artifact['name']);
$parsed = new Platform($artifact['name']);
return new Asset(
platform: $parsed->getPlatform(),
platform: $parsed,
platformName: $parsed, // __toString()
releaseName: '#' . $pr . ' @' . substr($artifact['workflow_run']['head_sha'], 0, 7),
downloadUrl: $this->router->generate('download_artifact', ['id' => $artifact['id']]),
Expand Down
22 changes: 19 additions & 3 deletions lib/Asset.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,27 @@

class Asset
{
private string $metaData = '';
public function __construct(
private Platform $platform,
private string $platformName,
private string $releaseName,
private string $downloadUrl,
private ?string $description,
private string $gitRef,
private string $date
)
{ }
private string $date,
) {
$_metaData = array();
$_metaData['data-arch'] = $this->platform->architecture->name;
$_metaData['data-os'] = $this->platform->os->name;
$_metaData['data-qualifier'] = $this->platform->qualifier->name;
$_metaData['data-osver'] = $this->platform->osVersion;

foreach ($_metaData as $attr => $value) {
$_value = strtolower($value);
$this->metaData .= " $attr=\"$_value\"";
}
}

public function getPlatform(): Platform
{
Expand Down Expand Up @@ -48,4 +59,9 @@ public function getDate(): string
{
return $this->date;
}

public function getMetaData(): string
{
return $this->metaData;
}
}
10 changes: 10 additions & 0 deletions lib/Os.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<?php
namespace LMMS;

enum Os: string
{
case Unknown = "Unknown";
case Linux = "Linux" ;
case MacOS = "macOS";
case Windows = "Windows";
}
169 changes: 164 additions & 5 deletions lib/Platform.php
Original file line number Diff line number Diff line change
@@ -1,10 +1,169 @@
<?php
namespace LMMS;
use LMMS\Os;

enum Platform: string
{
enum Architecture: string {
case Intel = "32-bit";
case Intel64 = "Intel";
case Arm = "ARM";
case Arm64 = "ARM64";
case Riscv = "RISC-V 32-bit";
case Riscv64 = "RISC-V";
case Ppc = "PowerPC 32-bit";
case Ppc64 = "PowerPC";
case Unknown = "Unknown";
case Linux = "Linux" ;
case MacOS = "macOS";
case Windows = "Windows";
}

enum Qualifier: string {
case Mingw = "mingw";
case Msvc = "msvc";
case Gcc = "gcc";
case Clang = "clang";
case Vcpkg = "vcpkg";
case Msys2 = "msys2";
case Unknown = "Unknown";
}

class Platform {
const ARCHITECTURE_PATTERNS = [
// 64 first: matches x86_64 before x86, etc
Architecture::Intel64->value => ['x86_64', 'amd64', 'mingw64', 'win64'],
Architecture::Intel->value => ['x86', 'i386', 'i686', 'mingw32', 'win32'],
Architecture::Arm64->value => ['arm64', 'aarch64', 'armv8'],
Architecture::Arm->value => ['arm', 'arm32', 'armv7'],
Architecture::Riscv64->value => ['riscv64'],
Architecture::Riscv->value => ['riscv'],
Architecture::Ppc64->value => ['ppc64', 'powerpc64'],
Architecture::Ppc->value => ['ppc', 'powerpc'],
];

const OS_PATTERNS = [
Os::Linux->value => ['linux', '.AppImage', '.run', '.rpm', '.deb'],
Os::Windows->value => ['windows', 'win32', 'win64', 'msys2', 'mingw32', 'mingw64', '.exe', 'msvc'],
Os::MacOS->value => ['mac', 'osx', '.pkg', '.dmg'],
];

const QUALIFIER_PATTERNS = [
Qualifier::Mingw->value => ['mingw'],
Qualifier::Msvc->value => ['msvc'],
Qualifier::Clang->value => ['clang', 'llvm'],
Qualifier::Vcpkg->value => ['vcpkg'],
Qualifier::Msys2->value => ['msys2'],
Qualifier::Gcc->value => ['gcc'],
];

public Architecture $architecture = Architecture::Unknown;
public Os $os = Os::Unknown;
public string $osVersion = '';
public Qualifier $qualifier = Qualifier::Unknown;
public string $platformVersion = '';

public function __construct(string $filename) {
$filename = strtolower($filename);

// Platform must be set first
$this->os = self::parse(self::OS_PATTERNS, $filename) ?: Os::Unknown;

// Determine architecture
$this->architecture = self::parse(self::ARCHITECTURE_PATTERNS, $filename) ?:
// Historically, macOS is Intel64 if we can't parse it
($this->os === Os::MacOS ?
Architecture::Intel64 : self::getDefaultArchitecture($this->os));

// Determine platform version (currently macOS only)
$this->osVersion = self::getOsVersion($this->os, $filename);

$this->qualifier = self::parse(self::QUALIFIER_PATTERNS, $filename) ?: self::getDefaultQualifier($this->os, $this->architecture);
}

private static function parse(array $patternsArray, string $filename) {
foreach ($patternsArray as $key => $value) {
foreach ($value as $pattern) {
if (strpos($filename, $pattern) !== false) {
switch(true) {
case $patternsArray === self::OS_PATTERNS:
return Os::tryFrom($key);
case $patternsArray === self::ARCHITECTURE_PATTERNS:
return Architecture::tryFrom($key);
case $patternsArray === self::QUALIFIER_PATTERNS:
return Qualifier::tryFrom($key);
}
}
}
}
return false;
}

private static function getDefaultArchitecture(Os $os): Architecture {
switch($os) {
case Os::Linux:
case Os::Windows:
return Architecture::Intel64;
case Os::MacOS:
return Architecture::Arm64;
case Os::Unknown:
return Architecture::Unknown;
}
}

private static function getDefaultQualifier(Os $os, Architecture $architecture): Qualifier {
switch($os) {
case Os::MacOS:
return Qualifier::Clang;
case Os::Linux:
return Qualifier::Gcc;
case Os::Windows:
return $architecture === Architecture::Arm64 ? Qualifier::Msys2 : Qualifier::Mingw;
case Os::Unknown:
return Qualifier::Unknown;
}
}

// Parse os version information from filename for displaying os compatibility
private static function getOsVersion(Os $os, string $filename): string {
if($os === Os::MacOS) {
if (strpos($filename, '.dmg') !== false) {
$parts = explode('-', explode('.dmg', $filename)[0]);
return filter_var(array_pop($parts), FILTER_SANITIZE_NUMBER_FLOAT, FILTER_FLAG_ALLOW_FRACTION);
}
}
return '';
}

public function getOs(): Os {
return $this->os;
}

public function getArchitecture(): Architecture {
return $this->architecture;
}

public function getQualifier(): Qualifier {
return $this->qualifier;
}

private function isDefaultArchitecture(): bool {
return self::getDefaultArchitecture($this->os) === $this->architecture;
}

private function isDefaultQualifier(): bool {
return self::getDefaultQualifier($this->os, $this->architecture) === $this->qualifier;
}

public function __toString(): string {
$platform = $this->os->value . ' ';
$platformVersion = empty($this->platformVersion) ? '' : $this->platformVersion . ' ';
$architecture = $this->isDefaultArchitecture() ? '' : $this->architecture->value . ' ';
$qualifier = $this->isDefaultQualifier() ? '' : "(" . strtolower($this->qualifier->name) . ")";
return trim($platform . $platformVersion . $architecture . $qualifier);
}

public function found() : bool {
return $this->os !== Os::Unknown &&
$this->architecture !== Architecture::Unknown;
}
}

// Example usage:
// echo new Platform("lmms-1.2.2-arm64.pkg"); // __toString()

Loading