chore: integrate Legendary support into the build process
- Updated .gitignore to exclude Legendary files. - Modified electron-builder.yml to include beforePack, afterPack, and afterSign scripts for Legendary. - Added prepare:legendary script to package.json for preparing Legendary binaries. - Created GitHub Actions workflow for Legendary integration testing. - Added entitlements for macOS signing in build/entitlements.legendary.mac.plist. - Included LICENSE and NOTICE.md files for Legendary in resources. - Implemented scripts for handling Legendary packaging and signing processes. - Added tests for Legendary packaging and integration.
This commit is contained in:
Rodrigo Borges
parent
c4eec1370b
commit
0dbbd5b96c
18 changed files with 2006 additions and 471 deletions
146
.github/workflows/legendary.yml
vendored
Normal file
146
.github/workflows/legendary.yml
vendored
Normal file
|
|
@ -0,0 +1,146 @@
|
|||
name: Legendary
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
pull_request:
|
||||
paths:
|
||||
- ".github/workflows/legendary.yml"
|
||||
- "scripts/*legendary*"
|
||||
- "src/main/services/legendary*"
|
||||
- "src/shared/legendary*"
|
||||
- "resources/legendary/**"
|
||||
- "electron-builder.yml"
|
||||
- "build/entitlements.legendary.mac.plist"
|
||||
- "package.json"
|
||||
- "docs/legendary.md"
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
paths:
|
||||
- ".github/workflows/legendary.yml"
|
||||
- "scripts/*legendary*"
|
||||
- "src/main/services/legendary*"
|
||||
- "src/shared/legendary*"
|
||||
- "resources/legendary/**"
|
||||
- "electron-builder.yml"
|
||||
- "build/entitlements.legendary.mac.plist"
|
||||
- "package.json"
|
||||
- "docs/legendary.md"
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
native-smoke:
|
||||
name: ${{ matrix.platform }}-${{ matrix.arch }}
|
||||
strategy:
|
||||
fail-fast: false
|
||||
# Match the native runners used by Legendary's pinned release build.
|
||||
matrix:
|
||||
include:
|
||||
- runner: windows-2025
|
||||
platform: win32
|
||||
arch: x64
|
||||
- runner: windows-11-arm
|
||||
platform: win32
|
||||
arch: arm64
|
||||
- runner: macos-15-intel
|
||||
platform: darwin
|
||||
arch: x64
|
||||
- runner: macos-15
|
||||
platform: darwin
|
||||
arch: arm64
|
||||
runs-on: ${{ matrix.runner }}
|
||||
timeout-minutes: 10
|
||||
env:
|
||||
LEGENDARY_PLATFORM: ${{ matrix.platform }}
|
||||
LEGENDARY_ARCH: ${{ matrix.arch }}
|
||||
defaults:
|
||||
run:
|
||||
shell: bash
|
||||
steps:
|
||||
- name: Check out Git repository
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Install native Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 22.21.0
|
||||
architecture: ${{ matrix.arch }}
|
||||
|
||||
# Preparation uses only Node.js built-ins. Do not install launcher or Python dependencies.
|
||||
- name: Download and verify pinned executable
|
||||
run: node scripts/prepare-legendary.cjs --platform "$LEGENDARY_PLATFORM" --arch "$LEGENDARY_ARCH"
|
||||
|
||||
- name: Check native executable version
|
||||
run: |
|
||||
node <<'NODE'
|
||||
const assert = require("node:assert/strict");
|
||||
const { execFileSync } = require("node:child_process");
|
||||
const path = require("node:path");
|
||||
const manifest = require("./src/shared/legendary-manifest.json");
|
||||
const platform = process.env.LEGENDARY_PLATFORM;
|
||||
const arch = process.env.LEGENDARY_ARCH;
|
||||
|
||||
assert.equal(process.platform, platform);
|
||||
assert.equal(process.arch, arch);
|
||||
const executable = path.resolve(
|
||||
"legendary", platform, arch, manifest.artifacts[platform][arch].fileName
|
||||
);
|
||||
const output = execFileSync(executable, ["--version"], {
|
||||
encoding: "utf8",
|
||||
shell: false,
|
||||
timeout: 60000,
|
||||
windowsHide: true,
|
||||
});
|
||||
assert.ok(output.includes(`legendary version "${manifest.version}"`), output);
|
||||
console.log(output.trim());
|
||||
NODE
|
||||
|
||||
- name: Check macOS execution after hardened signing
|
||||
if: matrix.platform == 'darwin'
|
||||
run: |
|
||||
node <<'NODE'
|
||||
const assert = require("node:assert/strict");
|
||||
const { execFileSync } = require("node:child_process");
|
||||
const { copyFileSync, chmodSync } = require("node:fs");
|
||||
const path = require("node:path");
|
||||
const manifest = require("./src/shared/legendary-manifest.json");
|
||||
const source = path.resolve("legendary", "darwin", process.arch, "legendary");
|
||||
const executable = path.join(process.env.RUNNER_TEMP, "legendary-signed");
|
||||
copyFileSync(source, executable);
|
||||
chmodSync(executable, 0o755);
|
||||
execFileSync("codesign", [
|
||||
"--force", "--sign", "-", "--options", "runtime",
|
||||
"--entitlements", "build/entitlements.legendary.mac.plist", executable,
|
||||
], { shell: false, timeout: 15000, stdio: "inherit" });
|
||||
const output = execFileSync(executable, ["--version"], {
|
||||
encoding: "utf8", shell: false, timeout: 60000,
|
||||
});
|
||||
assert.ok(output.includes(`legendary version "${manifest.version}"`), output);
|
||||
console.log(output.trim());
|
||||
NODE
|
||||
|
||||
linux-regression:
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 5
|
||||
steps:
|
||||
- name: Check out Git repository
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Install Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 22.21.0
|
||||
|
||||
- name: Test preparation and packaging regressions
|
||||
run: node --test scripts/legendary.test.mjs
|
||||
|
||||
- name: Confirm Linux preparation creates no binary cache
|
||||
run: |
|
||||
node scripts/prepare-legendary.cjs --platform linux --arch x64
|
||||
node -e 'require("node:assert/strict").equal(require("node:fs").existsSync("legendary"), false)'
|
||||
1
.gitignore
vendored
1
.gitignore
vendored
|
|
@ -11,6 +11,7 @@ out
|
|||
ludusavi/**
|
||||
!ludusavi/config.yaml
|
||||
/hydra-native/
|
||||
/legendary/
|
||||
native/hydra-native/target/
|
||||
|
||||
# Sentry Config File
|
||||
|
|
|
|||
9
build/entitlements.legendary.mac.plist
Normal file
9
build/entitlements.legendary.mac.plist
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
||||
<plist version="1.0">
|
||||
<dict>
|
||||
<!-- The official PyInstaller one-file executable extracts ad-hoc signed Python libraries. -->
|
||||
<key>com.apple.security.cs.disable-library-validation</key>
|
||||
<true/>
|
||||
</dict>
|
||||
</plist>
|
||||
|
|
@ -1,471 +0,0 @@
|
|||
# Integração Steam no cliente
|
||||
|
||||
O tag `profile-steam` da API (Hydra API 1.0) deixa o **cliente** orquestrar o import da biblioteca Steam. O launcher busca a library na Steam Web API com o token da sessão e as conquistas na community (`persist:steam`). A API só valida o snapshot e publica.
|
||||
|
||||
Isso não cria sessão Lerna e não muda membership. É uma integração de perfil, no mesmo espírito do RetroAchievements.
|
||||
|
||||
Este doc é o plano de implementação no hydra-2. Desktop (renderer + main) primeiro. Big Picture fica por último.
|
||||
|
||||
## Decisões
|
||||
|
||||
1. **Orquestrador no main, não no renderer.** `window.electron.hydraApi` descarta o status HTTP e devolve só `error.message`. Sync precisa de `429`/`502`/`409`/`403` de verdade, `AbortSignal`, e tem que sobreviver o usuário saindo de Settings. RetroAchievements pode viver no renderer porque é um POST. Steam não.
|
||||
2. **Não chamar `.../schema` no v1.** O PUT do snapshot só manda achievements desbloqueados (`name` + `unlockTime`). Schema é GetSchemaForGame em inglês, cacheado, e não entra no payload. Se no futuro a UI quiser mostrar nomes durante o sync, aí busca.
|
||||
3. **Steam OpenID no `BrowserWindow` `persist:steam`.** O mesmo login deixa cookies da loja e da community no partition. Sync lê `webapi_token` em `store.steampowered.com` para `GetOwnedGames` e usa a sessão da community para conquistas. Sem `STEAM_API_KEY` e sem `source/*`.
|
||||
4. **Um sync por vez.** Se a API devolver `409`, reusar `latestSyncRun.id` quando estiver `PENDING`. Não abrir outra run.
|
||||
5. **Não escrever playtime/unlocks locais a partir do snapshot.** O PUT não é autoritativo sobre runtime Hydra. Depois do `204`, puxar a verdade com `mergeWithRemoteGames()`.
|
||||
6. **Sem feature flag** até o backend ter uma. Mostrar a seção só com usuário logado na Hydra. Sem login, CTA de sign-in (`openAuthWindow(AuthPage.SignIn)`).
|
||||
|
||||
## Contrato (o que o cliente chama)
|
||||
|
||||
Todos autenticados com bearer.
|
||||
|
||||
| Método | Path | O que faz |
|
||||
| -------- | ------------------------------------------------ | ----------------------------------------------------------------------------------------------- |
|
||||
| `GET` | `/profile/oauth/steam/start` | Query opcional `return_to`, `lng`. Resposta `{ authorizationUrl }`. |
|
||||
| `DELETE` | `/profile/oauth/steam` | Query `deleteImportedData` (default `true`). `204`. `400` se Steam for o último método de auth. |
|
||||
| `GET` | `/profile/integrations/steam` | Status discriminado. Ver abaixo. |
|
||||
| `POST` | `/profile/integrations/steam/sync` | `202 { syncRunId }`. Não publica nada. |
|
||||
| `GET` | `/profile/integrations/steam/sync/{syncRunId}` | Estado da run. |
|
||||
| `DELETE` | `/profile/integrations/steam/sync/{syncRunId}` | Cancela só `PENDING`. Snapshot antigo fica. |
|
||||
| `PUT` | `.../snapshot/chunks/{chunkIndex}` | Armazena um chunk sem publicar. `chunkIndex` começa em `0`. `204`. |
|
||||
| `POST` | `.../snapshot/commit` | Valida e publica todos os chunks atomicamente. `204`. |
|
||||
| `PUT` | `.../snapshot` | Fallback para APIs antigas. Publica em uma chamada. `204`. |
|
||||
| `PUT` | `/profile/integrations/steam/games/{steamAppId}` | Atualiza playtime e adiciona conquistas de um jogo. `204`. |
|
||||
|
||||
`steamAppId` é **string** `^[1-9][0-9]{0,9}$`. Não converter pra number.
|
||||
|
||||
### Status (`GET /profile/integrations/steam`)
|
||||
|
||||
União de três objetos. Discriminar por `connected` + `snapshotPreserved`:
|
||||
|
||||
- Sem nada: `{ connected: false, snapshotPreserved: false }`
|
||||
- Conectado: `connected: true`, `snapshotPreserved: false`, mais `steamId64`, `username`, `avatarUrl`, `connectedAt`, `disconnectedAt`, `lastSyncedAt`, `latestSyncRun`
|
||||
- Snapshot preservado: `connected: false`, `snapshotPreserved: true`, mesmos campos de conta (histórico visível, sync bloqueado)
|
||||
|
||||
`latestSyncRun` (nullable):
|
||||
|
||||
```ts
|
||||
{
|
||||
id: string; // uuid
|
||||
trigger: "FIRST_LINK" | "MANUAL";
|
||||
status: "PENDING" | "RUNNING" | "SUCCEEDED" | "FAILED";
|
||||
gamesFound: number;
|
||||
gamesUpserted: number;
|
||||
achievementsUnlocked: number;
|
||||
error: string | null;
|
||||
startedAt: string | null;
|
||||
completedAt: string | null;
|
||||
createdAt: string;
|
||||
}
|
||||
```
|
||||
|
||||
### Snapshot em chunks
|
||||
|
||||
O cliente divide o snapshot em chunks com no máximo 2.000 conquistas. Cada
|
||||
`PUT .../snapshot/chunks/{chunkIndex}` envia o índice no path e o total no body:
|
||||
|
||||
```ts
|
||||
{
|
||||
totalChunks: number;
|
||||
games: SteamSnapshotGame[];
|
||||
}
|
||||
```
|
||||
|
||||
Os índices são sequenciais a partir de `0`. Um jogo pode aparecer em mais de um
|
||||
chunk; a API reúne suas conquistas na ordem dos chunks. Depois de enviar todos,
|
||||
o cliente chama `POST .../snapshot/commit`. Somente o commit altera os dados
|
||||
visíveis. Se um chunk falhar, o cliente não chama o commit e a run pode ser
|
||||
retomada: chunks reenviados no mesmo índice são idempotentes.
|
||||
|
||||
Se o upload em chunks responder `404`, o launcher assume uma API
|
||||
anterior e usa `PUT .../snapshot`. Para respeitar o limite antigo, jogos com mais
|
||||
de 2.000 conquistas omitem `achievements` nesse primeiro request. Depois que o
|
||||
snapshot cria ou atualiza os jogos, o launcher envia todas as conquistas desses
|
||||
jogos em blocos de até 2.000 pelo `PUT .../games/{steamAppId}`. Assim biblioteca,
|
||||
playtime e todas as conquistas também são sincronizados com a API anterior.
|
||||
|
||||
### Formato do snapshot
|
||||
|
||||
```ts
|
||||
{
|
||||
games: {
|
||||
steamAppId: string;
|
||||
name: string;
|
||||
playTimeInSeconds: number;
|
||||
lastPlayedAt: string | null; // ISO
|
||||
achievements: {
|
||||
name: string;
|
||||
unlockTime: string;
|
||||
}
|
||||
[]; // só unlocked
|
||||
}
|
||||
[];
|
||||
}
|
||||
```
|
||||
|
||||
Source achievements vêm com `{ name, unlocked, unlockTime }`. `unlockTime` é nullable. No PUT, filtrar `unlocked === true` e `unlockTime != null`.
|
||||
|
||||
### Erros
|
||||
|
||||
O OpenAPI copia o mesmo example (`profile/steam-sync-run-not-found`) em quase todo 4xx/5xx. **Não confiar nos examples.** Mapear primeiro por HTTP status, depois por `message` quando o backend confirmar os códigos reais.
|
||||
|
||||
| Status | Onde | O que o cliente faz |
|
||||
| ------ | ----------------------- | ---------------------------------------------------- |
|
||||
| `400` | snapshot / cancel / ids | Payload inválido, UUID ruim, ou Steam é último auth. |
|
||||
| `403` | Steam direto | Token inválido / sessão expirada. Pedir reconnect. |
|
||||
| `404` | sync / oauth | Sem conexão ativa, ou run inexistente. |
|
||||
| `409` | POST sync | Já tem run `PENDING`/`RUNNING`. Reusar. |
|
||||
| `409` | snapshot / cancel | Run não está mais `PENDING`. |
|
||||
| `429` | Steam direto | Backoff curto no launcher. |
|
||||
| `502` | Steam direto | Retry curto, depois falha a run. |
|
||||
|
||||
## Arquitetura
|
||||
|
||||
```
|
||||
Settings (renderer)
|
||||
GET status, start OAuth, disconnect
|
||||
startSteamSync / cancelSteamSync (IPC)
|
||||
onSteamSyncProgress / onSteamSyncFinished
|
||||
|
||||
main/services/steam-integration
|
||||
POST sync, lê webapi_token no partition persist:steam,
|
||||
GetOwnedGames + community HTML/XML via axios + cookies persist:steam (pool), monta snapshot
|
||||
PUT chunks em ordem, POST commit; se chunks responderem 404, usa PUT legado
|
||||
e completa jogos acima de 2.000 conquistas pelo endpoint incremental
|
||||
DELETE run se o usuário cancelar ou se a orquestração falhar
|
||||
depois do 204: mergeWithRemoteGames()
|
||||
```
|
||||
|
||||
Não orquestrar via `hydraApi` do preload. Usar `HydraApi` direto no main (`src/main/services/hydra-api.ts`). Ele já aceita `signal` e o axios trata `202`/`204` como sucesso (`validateStatus` padrão 2xx).
|
||||
|
||||
`POST /sync` devolve `{ syncRunId }`. `DELETE`/`PUT` `204` devolvem body vazio. Ok.
|
||||
|
||||
## Layout de arquivos
|
||||
|
||||
```
|
||||
src/types/steam-integration.types.ts
|
||||
src/main/services/steam-integration/
|
||||
steam-source-retry.ts
|
||||
steam-source-retry.test.ts
|
||||
steam-sync-snapshot.ts
|
||||
steam-sync-snapshot.test.ts
|
||||
steam-sync-orchestrator.ts
|
||||
steam-sync-orchestrator.test.ts
|
||||
src/main/events/user/
|
||||
get-steam-integration-status.ts
|
||||
start-steam-oauth.ts
|
||||
disconnect-steam.ts
|
||||
start-steam-sync.ts
|
||||
cancel-steam-sync.ts
|
||||
get-steam-sync-state.ts
|
||||
src/renderer/src/pages/settings/settings-steam.tsx
|
||||
src/renderer/src/pages/settings/settings-steam.scss
|
||||
```
|
||||
|
||||
Reexportar tipos em `src/types/index.ts`.
|
||||
|
||||
IPC segue o padrão de `src/main/events/user/index.ts` + `preload/index.ts` + `src/renderer/src/declaration.d.ts`.
|
||||
|
||||
Strings em `src/locales/en/translation.json` (namespace `settings`). Sem hardcode no JSX. `logger` no main (`@main/services`) e no renderer (`@renderer/logger`). Arrays em `T[]`.
|
||||
|
||||
Referência de UI: `settings-retroachievements.tsx` + scss. Encaixar em `settings-context-integrations.tsx` **acima** do RetroAchievements.
|
||||
|
||||
Logo: `src/renderer/src/assets/steam-logo.svg`.
|
||||
|
||||
---
|
||||
|
||||
## M1. Status, OAuth e disconnect
|
||||
|
||||
Entrega: o usuário logado conecta e desconecta a Steam em Settings → Integrations. Sem sync ainda.
|
||||
|
||||
### UI
|
||||
|
||||
Card no mesmo formato do RA: header colapsável, logo, descrição, corpo.
|
||||
|
||||
Estados:
|
||||
|
||||
1. Loading
|
||||
2. Sem conexão (`connected: false`, `snapshotPreserved: false`): botão Connect
|
||||
3. Conectado: avatar, username, steamId64 opcional em texto secundário, "Connected", Disconnect. Sem botão Sync neste milestone.
|
||||
4. Snapshot preservado: avatar/username, texto de que os dados importados continuam visíveis, botões Reconnect e "Remove imported data"
|
||||
5. Sem login Hydra: não chama o GET. CTA de sign-in.
|
||||
|
||||
### Connect
|
||||
|
||||
1. `GET /profile/oauth/steam/start` com:
|
||||
- `lng`: `i18n.language`
|
||||
- `return_to`: `hydralauncher://steam-connected`
|
||||
2. Main abre `authorizationUrl` num `BrowserWindow` `persist:steam`
|
||||
3. Toast "Complete the Steam login in the window that opened"
|
||||
4. Quando o protocolo voltar, ou quando a janela da Hydra ganhar foco, `GET /profile/integrations/steam` de novo
|
||||
|
||||
Deep link em `src/main/index.ts` (`handleDeepLinkPath`):
|
||||
|
||||
```
|
||||
hydralauncher://steam-connected
|
||||
→ WindowManager.sendToAppWindows("on-steam-connected")
|
||||
→ WindowManager.redirect("settings?tab=integrations")
|
||||
```
|
||||
|
||||
`settings.context.tsx` já lê `?tab=integrations`.
|
||||
|
||||
Se a API recusar `hydralauncher://` como `return_to` (schema diz `format: uri`, mas custom scheme é loteria), omitir `return_to` e depender do refresh no `focus`. Confirmar com o backend no primeiro teste real.
|
||||
|
||||
Não reusar `hydralauncher://auth`. Isso é login Hydra (`HydraApi.handleExternalAuth`).
|
||||
|
||||
### Disconnect
|
||||
|
||||
Modal no molde do RA:
|
||||
|
||||
- Checkbox "Also delete imported Steam data" (default **ligado**, igual `deleteImportedData` default `true`)
|
||||
- Se marcado, segundo modal de confirmação
|
||||
- `DELETE /profile/oauth/steam?deleteImportedData=true|false`
|
||||
|
||||
`400` "Steam is the last authentication method": toast específico. O usuário precisa de outro método de login antes.
|
||||
|
||||
### IPC vs hydraApi no renderer
|
||||
|
||||
GET status, start OAuth e DELETE oauth são request/response curtos. Podem ir pelo `hydraApi` do renderer, **ou** por IPC fino se quiser esconder a URL. Prefira IPC só se o main precisar interceptar (deep link, abrir a janela Steam). Start OAuth combina bem com um evento `startSteamOAuth` que já chama a API e abre o `BrowserWindow` `persist:steam`. Disconnect e GET status podem ficar no renderer.
|
||||
|
||||
Sugestão mínima:
|
||||
|
||||
- `startSteamOAuth(): Promise<void>` no main (GET start + janela `persist:steam`)
|
||||
- GET status e DELETE no renderer via `hydraApi`
|
||||
|
||||
### Traduções (en, namespace `settings`)
|
||||
|
||||
Chaves novas, no estilo `retroachievements_*`:
|
||||
|
||||
- `steam_integration_title`
|
||||
- `steam_integration_description` (importa biblioteca, playtime e achievements da Steam pra o perfil Hydra. Não troca o login da Hydra.)
|
||||
- `steam_connect` / `steam_disconnect` / `steam_reconnect`
|
||||
- `steam_loading`
|
||||
- `steam_status_connected`
|
||||
- `steam_status_snapshot_preserved`
|
||||
- `steam_connect_opened` (browser aberto)
|
||||
- `steam_account_linked` / `steam_account_unlinked`
|
||||
- `steam_disconnect_title` / `steam_disconnect_description`
|
||||
- `steam_delete_on_disconnect`
|
||||
- `steam_delete_confirm_title` / `steam_delete_confirm_description` / `steam_delete_confirm_button`
|
||||
- `steam_last_auth_method`
|
||||
- `steam_connect_error`
|
||||
- `steam_sign_in_required`
|
||||
|
||||
### Aceite
|
||||
|
||||
- Logado, Connect abre o OpenID da Steam. Depois do callback (ou focus), o card mostra username/avatar.
|
||||
- Disconnect com delete some com a conexão e volta ao estado vazio.
|
||||
- Disconnect sem delete cai no estado `snapshotPreserved`.
|
||||
- Sem login Hydra, não dispara 401 no GET.
|
||||
- Nenhuma chamada a `/sync`.
|
||||
|
||||
---
|
||||
|
||||
## M2. Sync happy path
|
||||
|
||||
Entrega: botão Sync no card conectado. Main busca library + achievements, publica snapshot, UI mostra progresso.
|
||||
|
||||
### Orquestrador (`steam-sync-orchestrator.ts`)
|
||||
|
||||
Singleton. Se já estiver rodando, o IPC de start devolve o estado atual em vez de criar outra run.
|
||||
|
||||
Fluxo:
|
||||
|
||||
1. `POST /profile/integrations/steam/sync` → `syncRunId`
|
||||
2. Se `409`, `GET /profile/integrations/steam` e:
|
||||
- `latestSyncRun.status === "PENDING"` → usar esse `id`
|
||||
- `RUNNING` → não começar outro. Emitir progresso "já em andamento" (no M2, se não temos progresso interno, só recusar com toast)
|
||||
- outro status → erro
|
||||
3. Offscreen `store.steampowered.com` → `webapi_token`. Conferir steamid com o status.
|
||||
4. `GetOwnedGames` na Steam → `{ games }`
|
||||
5. Emitir progresso `{ phase: "library", gamesFound: n }`
|
||||
6. Para cada jogo, conquistas com **pool de 3** na community. O Chromium `fetch` do Electron descarta `Cookie`; o cliente lê os cookies de `persist:steam` e chama a community com axios (`node:https`, IPv4). Ordem: HTML `profiles/{steamid}/stats/{appid}/achievements?l=english` → se não mapear unlock, HTML do dono `/my/stats/{appid}` → XML público só se nenhuma das páginas tiver `.achieveRow`. Casa os unlocks com `IPlayerService/GetGameAchievements` (`access_token`) para obter o `apiname`. Sem `steamLoginSecure` na community, falha com sessão expirada — não publica snapshot vazio. Snapshot com 0 unlocks não apaga unlocks já publicados.
|
||||
7. Montar snapshot (`steam-sync-snapshot.ts`)
|
||||
8. `PUT .../snapshot/chunks/{chunkIndex}` para cada chunk, depois `POST .../snapshot/commit`. Se a API não tiver essas rotas, usar o `PUT .../snapshot` legado.
|
||||
9. `mergeWithRemoteGames()`
|
||||
10. `GET /profile/integrations/steam` e emitir finished com o status novo
|
||||
|
||||
`AbortController` no singleton. Cancel do usuário aborta fetches e dá `DELETE .../sync/{id}`. **Não** dar PUT parcial.
|
||||
|
||||
Falha no meio (depois de ter `syncRunId`): `DELETE` a run se ainda estiver `PENDING`, senão o próximo Sync toma `409`. Cancel da API só aceita `PENDING`. Se o PUT já começou (`RUNNING` no servidor), não tem cancel. Deixar terminar ou falhar sozinho.
|
||||
|
||||
### Snapshot builder
|
||||
|
||||
Função pura. Testes em `steam-sync-snapshot.test.ts`:
|
||||
|
||||
- `steamAppId` permanece string
|
||||
- `playTimeInSeconds` e `lastPlayedAt` vêm da library, não dos achievements
|
||||
- achievements: só `unlocked && unlockTime`
|
||||
- jogo sem achievements, ou GET que falhou de forma pulável: `achievements: []`
|
||||
- ordem estável (library order)
|
||||
|
||||
Não incluir schema.
|
||||
|
||||
### Retry (`steam-source-retry.ts`)
|
||||
|
||||
Nos GETs da Steam Web API (library e achievements).
|
||||
|
||||
- `429`: esperar `Retry-After` (segundos) se for número. Senão 1s, 2s, 4s, 8s, cap 30s. Máximo 5 tentativas por request.
|
||||
- `502`: 3 tentativas, backoff curto
|
||||
- `403` na **library**: falha a run inteira (perfil privado)
|
||||
- `400`/`403`/`409`/`429`/`502` em **achievements de um app**: pular o jogo (achievements `[]`), seguir os outros. `400` inclui "Requested app has no stats" e auth recusada nesse endpoint.
|
||||
- resto: falha a run
|
||||
|
||||
Testes com `AxiosError` de verdade, no estilo de `cloud-save/snapshot-retry-policy.test.ts`.
|
||||
|
||||
Passar `signal` em todo `HydraApi.get`/`put`/`post`/`delete` da run.
|
||||
|
||||
### IPC
|
||||
|
||||
```
|
||||
startSteamSync(): Promise<SteamSyncState>
|
||||
cancelSteamSync(): Promise<void>
|
||||
getSteamSyncState(): Promise<SteamSyncState>
|
||||
onSteamSyncProgress(cb): unsubscribe
|
||||
onSteamSyncFinished(cb): unsubscribe
|
||||
```
|
||||
|
||||
`SteamSyncState` (esboço):
|
||||
|
||||
```ts
|
||||
type SteamSyncState =
|
||||
| { status: "idle" }
|
||||
| {
|
||||
status: "running";
|
||||
syncRunId: string;
|
||||
phase: "starting" | "library" | "achievements" | "publishing";
|
||||
gamesFound: number;
|
||||
gamesProcessed: number;
|
||||
}
|
||||
| { status: "cancelling"; syncRunId: string };
|
||||
```
|
||||
|
||||
Finished payload: `{ ok: true, status: SteamIntegrationStatus } | { ok: false, message: string }`.
|
||||
|
||||
`WindowManager.sendToAppWindows` nos canais, igual cloud save.
|
||||
|
||||
### UI
|
||||
|
||||
No card conectado:
|
||||
|
||||
- `lastSyncedAt` formatado com `useDate` (o mesmo helper do resto do app)
|
||||
- Botão Sync (ícone `SyncIcon` do Primer, igual RA refresh)
|
||||
- Durante running: texto "Importing Steam library…" + `gamesProcessed / gamesFound` quando `phase === "achievements"`
|
||||
- Botão Cancel visível só em running
|
||||
- Sync desabilitado se `snapshotPreserved` ou se já running
|
||||
|
||||
Não precisa de progress bar sofisticada. Número é suficiente.
|
||||
|
||||
### Persistência da run
|
||||
|
||||
Guardar `{ syncRunId }` em Level (`levelKeys.steamSyncRun`) quando a run começa. Apagar no finished/cancel.
|
||||
|
||||
Se o app fechar durante o upload, a run fica `PENDING` no servidor. O próximo
|
||||
start reutiliza a run, refaz os GETs source e reenvia os chunks desde o índice
|
||||
`0`. O staging é idempotente e nada fica visível antes do commit.
|
||||
|
||||
### Aceite
|
||||
|
||||
- Sync de uma conta com biblioteca pequena (uns jogos) chega em `SUCCEEDED` e `lastSyncedAt` atualiza.
|
||||
- Library local ganha os jogos Steam via `mergeWithRemoteGames` (remoteId, playtime máximo, achievement counts).
|
||||
- Cancel no meio não chama PUT. Status volta a conectado, `latestSyncRun` `FAILED`.
|
||||
- Perfil Steam privado: toast claro, sem PUT.
|
||||
- Zero chamadas a `.../schema`.
|
||||
|
||||
---
|
||||
|
||||
## M3. FIRST_LINK, focus e erros chatos
|
||||
|
||||
Entrega: o primeiro link não deixa run órfã, e o usuário não precisa adivinhar o que quebrou.
|
||||
|
||||
### FIRST_LINK
|
||||
|
||||
Depois do OAuth, `GET status`. Se `connected && latestSyncRun?.trigger === "FIRST_LINK" && latestSyncRun.status === "PENDING"`, o cliente **começa o orquestrador com esse `syncRunId`**, sem `POST /sync`.
|
||||
|
||||
Isso pode acontecer no `on-steam-connected` e no refresh de focus. Guardar um lock pra não disparar duas orquestrações.
|
||||
|
||||
Se `FIRST_LINK` já veio `FAILED`, mostrar o erro da run e deixar o usuário clicar Sync (`MANUAL`).
|
||||
|
||||
Confirmar no backend se o callback do OpenID cria essa run sozinho. Se não criar, o M3 só adiciona um Sync automático pós-connect (POST `/sync` na hora que o status passar a `connected` e `lastSyncedAt === null`). Mesma UX.
|
||||
|
||||
### Refresh no focus
|
||||
|
||||
Na seção Steam montada (e no listener global de `on-steam-connected`):
|
||||
|
||||
- `window` `focus` → GET status
|
||||
- Se passou de desconectado para conectado, toast de linked
|
||||
- Se tem `PENDING` FIRST_LINK, M2/M3 pega
|
||||
|
||||
Não pollear a cada 2s. Focus + deep link chega.
|
||||
|
||||
### Mensagens de erro
|
||||
|
||||
Mapa no renderer (status HTTP + `error.message` da run):
|
||||
|
||||
- privado → `steam_error_private_profile` (pedir perfil público / games details visíveis)
|
||||
- rate limit persistente → `steam_error_rate_limited`
|
||||
- proxy 502 → `steam_error_steam_unavailable`
|
||||
- 409 running → `steam_error_sync_in_progress`
|
||||
- last auth → já no M1
|
||||
- default → `steam_error_sync_failed`
|
||||
|
||||
Notificações da API (se existirem no feed, path tipo `/profile/integrations/steam`): em `notification-item.tsx`, igual RA, navegar para `/settings?tab=integrations`.
|
||||
|
||||
### Restart do app
|
||||
|
||||
No boot do main, se `levelKeys.steamSyncRun` existir:
|
||||
|
||||
1. `GET .../sync/{id}`
|
||||
2. `PENDING` → pode retomar o orquestrador (library + achievements de novo)
|
||||
3. `RUNNING`/`SUCCEEDED`/`FAILED`/`404` → limpar a key
|
||||
|
||||
Não retomar automaticamente no boot se o usuário não está na frente. Opção mais simples: limpar a key e `DELETE` se `PENDING` (cancela run órfã). Sync fica explícito. FIRST_LINK pendente ainda aparece no GET status, e o card pode oferecer "Finish importing".
|
||||
|
||||
Recomendação: **não cancelar no boot**. Mostrar no card "Import incompleto" + botão Continue, que reusa o `syncRunId`.
|
||||
|
||||
### Aceite
|
||||
|
||||
- Conectar Steam pela primeira vez dispara o import sem segundo clique, **ou** o card mostra Continue se a run FIRST_LINK ficou PENDING.
|
||||
- Matar o app no meio do sync não deixa o próximo POST eternamente em 409 sem saída.
|
||||
- Perfil privado e 429 têm copy distinta.
|
||||
|
||||
---
|
||||
|
||||
## M4. Big Picture (depois do desktop)
|
||||
|
||||
O BP hoje em `src/big-picture/src/pages/settings/integrations.tsx` só tem debrid. Não tem RA.
|
||||
|
||||
Fazer só quando M1–M3 estiverem estáveis. Reusar o orquestrador do main (IPC já manda `sendToAppWindows`). UI nova no foco/gamepad, não copiar o JSX do renderer.
|
||||
|
||||
Fora do v1 se o prazo apertar. Desktop é o caminho que o OAuth e o sync longo pedem.
|
||||
|
||||
---
|
||||
|
||||
## Fora de escopo (não fazer nesses milestones)
|
||||
|
||||
- Auto-sync periódico em background. Manual + FIRST_LINK chega.
|
||||
- Buscar schema por jogo.
|
||||
- Sobrescrever achievements locais de cracker/Steam com o snapshot. A API já diz que unlocks Hydra não são overwritten. O merge remoto só atualiza counts via `/profile/games`.
|
||||
- Assinar na Hydra com essa conexão. Continua o OAuth de login em `hydralauncher://auth`.
|
||||
- Escrever `steamId64` em `UserDetails`. Status vive no GET da integração.
|
||||
- Traduzir as chaves novas em todos os `src/locales/*`. Só `en` no PR. O resto no Weblate/fluxo normal.
|
||||
|
||||
## Ordem de PRs
|
||||
|
||||
1. M1 sozinho. Dá pra testar OAuth contra `localhost:3000` sem esperar o sync.
|
||||
2. M2 com testes de snapshot + retry. Sem UI linda de progresso, mas com números.
|
||||
3. M3 em cima do M2, não misturar FIRST_LINK no mesmo PR do orquestrador se o callback ainda estiver incerto.
|
||||
4. M4 quando alguém for usar Steam no Deck/BP.
|
||||
|
||||
## Como testar na mão (depois do M2)
|
||||
|
||||
1. API local em `:3000`, launcher apontando pra ela.
|
||||
2. Login Hydra (não Steam).
|
||||
3. Settings → Integrations → Connect Steam → completar OpenID.
|
||||
4. Sync. Library de teste pequena primeiro.
|
||||
5. Conferir `GET /profile/integrations/steam` (status `SUCCEEDED`) e a library da Hydra.
|
||||
6. Disconnect com preserve. Card no estado preservado. Reconnect. Disconnect com delete. Volta ao vazio.
|
||||
7. Perfil Steam privado: 403 na library, toast, sem jogos novos.
|
||||
8. Cancel no meio de uma library grande.
|
||||
|
||||
Se o OpenAPI local divergir (códigos de `message`, se FIRST_LINK nasce no callback), atualizar este doc na hora. O cliente deve seguir o comportamento real, não o example copiado do Swagger.
|
||||
|
|
@ -1,5 +1,8 @@
|
|||
appId: gg.hydralauncher.hydra
|
||||
productName: Hydra
|
||||
beforePack: scripts/legendary-before-pack.cjs
|
||||
afterPack: scripts/legendary-after-pack.cjs
|
||||
afterSign: scripts/legendary-after-pack.cjs
|
||||
directories:
|
||||
buildResources: build
|
||||
extraResources:
|
||||
|
|
@ -10,6 +13,8 @@ extraResources:
|
|||
- from: resources/achievement.wav
|
||||
files:
|
||||
- "!.cache/**"
|
||||
- "!legendary/**"
|
||||
- "!resources/legendary/**"
|
||||
- "!native/torrent-bridge/**"
|
||||
- "!**/.vscode/*"
|
||||
- "!src/*"
|
||||
|
|
@ -27,6 +32,15 @@ asarUnpack:
|
|||
win:
|
||||
executableName: Hydra
|
||||
extraResources:
|
||||
- from: legendary/win32/${arch}
|
||||
to: legendary
|
||||
filter:
|
||||
- legendary.exe
|
||||
- from: resources/legendary
|
||||
to: legendary
|
||||
filter:
|
||||
- LICENSE
|
||||
- NOTICE.md
|
||||
- from: binaries/7z.exe
|
||||
- from: binaries/7z.dll
|
||||
target:
|
||||
|
|
@ -44,8 +58,18 @@ portable:
|
|||
artifactName: ${name}-${version}-portable.${ext}
|
||||
unpackDirName: false
|
||||
mac:
|
||||
sign: scripts/legendary-mac-sign.cjs
|
||||
entitlementsInherit: build/entitlements.mac.plist
|
||||
extraResources:
|
||||
- from: legendary/darwin/${arch}
|
||||
to: legendary
|
||||
filter:
|
||||
- legendary
|
||||
- from: resources/legendary
|
||||
to: legendary
|
||||
filter:
|
||||
- LICENSE
|
||||
- NOTICE.md
|
||||
- from: binaries/7zz
|
||||
extendInfo:
|
||||
- NSCameraUsageDescription: Application requests access to the device's camera.
|
||||
|
|
|
|||
|
|
@ -23,6 +23,7 @@
|
|||
"typecheck": "npm run typecheck:node && npm run typecheck:web",
|
||||
"check:ota-bridge": "node scripts/check-ota-bridge.mjs",
|
||||
"build:native": "node ./scripts/build-native-addon.cjs",
|
||||
"prepare:legendary": "node ./scripts/prepare-legendary.cjs",
|
||||
"start": "electron-vite preview",
|
||||
"dev": "electron-vite dev",
|
||||
"build": "npm run typecheck && electron-vite build",
|
||||
|
|
|
|||
674
resources/legendary/LICENSE
Normal file
674
resources/legendary/LICENSE
Normal file
|
|
@ -0,0 +1,674 @@
|
|||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU 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 General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
17
resources/legendary/NOTICE.md
Normal file
17
resources/legendary/NOTICE.md
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
# Legendary
|
||||
|
||||
Hydra distributes the unmodified official Legendary 0.21.1 executable for the
|
||||
installer's platform and architecture. Application code signing may add a
|
||||
signature to the executable.
|
||||
|
||||
Legendary is licensed under GPL-3.0-or-later. The accompanying LICENSE contains
|
||||
the GNU General Public License version 3.
|
||||
|
||||
- Project: https://github.com/legendary-gl/legendary
|
||||
- Release: https://github.com/legendary-gl/legendary/releases/tag/0.21.1
|
||||
- Corresponding source: https://github.com/legendary-gl/legendary/tree/0.21.1
|
||||
- Source archive: https://github.com/legendary-gl/legendary/archive/refs/tags/0.21.1.tar.gz
|
||||
- Official build instructions: https://github.com/legendary-gl/legendary/blob/0.21.1/.github/workflows/build-base.yml
|
||||
|
||||
Keep this notice and the source references in sync when changing the pinned
|
||||
version in src/shared/legendary-manifest.json.
|
||||
33
scripts/legendary-after-pack.cjs
Normal file
33
scripts/legendary-after-pack.cjs
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
const path = require("node:path");
|
||||
const fs = require("node:fs/promises");
|
||||
const manifest = require("../src/shared/legendary-manifest.json");
|
||||
const {
|
||||
getLegendaryArtifact,
|
||||
verifyLegendaryVersion,
|
||||
} = require("./prepare-legendary.cjs");
|
||||
const { Arch } = require("builder-util");
|
||||
|
||||
async function afterPack(context) {
|
||||
const platform = context.electronPlatformName;
|
||||
const arch = Arch[context.arch];
|
||||
const artifact = getLegendaryArtifact(platform, arch);
|
||||
if (!artifact) return;
|
||||
|
||||
const binaryPath = path.join(
|
||||
context.packager.getResourcesDir(context.appOutDir),
|
||||
"legendary",
|
||||
artifact.fileName
|
||||
);
|
||||
// Windows signs extraResources while copying them, before afterPack. The
|
||||
// upstream checksum was checked by beforePack; signed bytes may differ here.
|
||||
if (!(await fs.stat(binaryPath)).isFile()) {
|
||||
throw new Error(
|
||||
`Packaged Legendary executable missing: ${platform}/${arch}`
|
||||
);
|
||||
}
|
||||
if (platform === process.platform && arch === process.arch) {
|
||||
await verifyLegendaryVersion(binaryPath, manifest.version);
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = afterPack;
|
||||
12
scripts/legendary-before-pack.cjs
Normal file
12
scripts/legendary-before-pack.cjs
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
const { Arch } = require("builder-util");
|
||||
const { prepareLegendary } = require("./prepare-legendary.cjs");
|
||||
|
||||
async function beforePack(context) {
|
||||
await prepareLegendary({
|
||||
projectDir: context.packager.projectDir,
|
||||
platform: context.electronPlatformName,
|
||||
arch: Arch[context.arch],
|
||||
});
|
||||
}
|
||||
|
||||
module.exports = beforePack;
|
||||
49
scripts/legendary-mac-sign.cjs
Normal file
49
scripts/legendary-mac-sign.cjs
Normal file
|
|
@ -0,0 +1,49 @@
|
|||
const path = require("node:path");
|
||||
const { sign } = require("app-builder-lib/out/codeSign/macCodeSign");
|
||||
|
||||
function createSigningOptions(options, projectDir) {
|
||||
const legendaryPath = path.join(
|
||||
options.app,
|
||||
"Contents",
|
||||
"Resources",
|
||||
"legendary",
|
||||
"legendary"
|
||||
);
|
||||
return {
|
||||
...options,
|
||||
optionsForFile(filePath) {
|
||||
const inherited = options.optionsForFile
|
||||
? options.optionsForFile(filePath)
|
||||
: {};
|
||||
if (filePath !== legendaryPath) return inherited;
|
||||
// Scope the PyInstaller library-validation entitlement to this helper.
|
||||
// Keep Hydra, Electron, and every other native binary's options intact.
|
||||
return {
|
||||
...inherited,
|
||||
entitlements: path.join(
|
||||
projectDir,
|
||||
"build",
|
||||
"entitlements.legendary.mac.plist"
|
||||
),
|
||||
};
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
async function signMac(options, packager) {
|
||||
// A custom hook makes electron-builder call us even without a certificate.
|
||||
// Preserve its usual unsigned development build behavior.
|
||||
if (!options.identity) {
|
||||
if (packager.forceCodeSigning || options.platform === "mas") {
|
||||
throw new Error(
|
||||
"Cannot sign macOS application: no signing identity available."
|
||||
);
|
||||
}
|
||||
return;
|
||||
}
|
||||
// Delegate to the same signer and retry policy electron-builder normally uses.
|
||||
await sign(createSigningOptions(options, packager.projectDir));
|
||||
}
|
||||
|
||||
module.exports = signMac;
|
||||
module.exports.createSigningOptions = createSigningOptions;
|
||||
182
scripts/legendary-packaging.test.mjs
Normal file
182
scripts/legendary-packaging.test.mjs
Normal file
|
|
@ -0,0 +1,182 @@
|
|||
import assert from "node:assert/strict";
|
||||
import fs from "node:fs/promises";
|
||||
import os from "node:os";
|
||||
import path from "node:path";
|
||||
import { createRequire } from "node:module";
|
||||
import { test } from "node:test";
|
||||
import YAML from "yaml";
|
||||
|
||||
const require = createRequire(import.meta.url);
|
||||
const config = YAML.parse(
|
||||
await fs.readFile(new URL("../electron-builder.yml", import.meta.url), "utf8")
|
||||
);
|
||||
const beforePack = require("./legendary-before-pack.cjs");
|
||||
const afterPack = require("./legendary-after-pack.cjs");
|
||||
const { createSigningOptions } = require("./legendary-mac-sign.cjs");
|
||||
const signMac = require("./legendary-mac-sign.cjs");
|
||||
|
||||
test("Linux packaging ignores Legendary even when other platforms are cached", async () => {
|
||||
const context = {
|
||||
electronPlatformName: "linux",
|
||||
arch: 1,
|
||||
packager: {
|
||||
projectDir: "/unreachable/project",
|
||||
getResourcesDir: () =>
|
||||
assert.fail("Linux must not access packaged Legendary"),
|
||||
},
|
||||
};
|
||||
await beforePack(context);
|
||||
await afterPack(context);
|
||||
assert.ok(config.files.includes("!legendary/**"));
|
||||
assert.ok(config.files.includes("!resources/legendary/**"));
|
||||
for (const resource of [
|
||||
...config.extraResources,
|
||||
...config.linux.extraResources,
|
||||
]) {
|
||||
assert.doesNotMatch(
|
||||
typeof resource === "string" ? resource : resource.from,
|
||||
/legendary/
|
||||
);
|
||||
}
|
||||
});
|
||||
|
||||
test("packaging chooses only the target architecture outside ASAR and includes notices", () => {
|
||||
assert.equal(config.beforePack, "scripts/legendary-before-pack.cjs");
|
||||
assert.equal(config.afterPack, "scripts/legendary-after-pack.cjs");
|
||||
assert.equal(config.afterSign, "scripts/legendary-after-pack.cjs");
|
||||
for (const [platform, directory, fileName] of [
|
||||
["win", "win32", "legendary.exe"],
|
||||
["mac", "darwin", "legendary"],
|
||||
]) {
|
||||
const binary = config[platform].extraResources.find((resource) =>
|
||||
resource.from.startsWith("legendary/")
|
||||
);
|
||||
assert.equal(binary.from, `legendary/${directory}/\${arch}`);
|
||||
assert.equal(binary.to, "legendary");
|
||||
assert.deepEqual(binary.filter, [fileName]);
|
||||
const notice = config[platform].extraResources.find(
|
||||
(resource) => resource.from === "resources/legendary"
|
||||
);
|
||||
assert.equal(notice.to, "legendary");
|
||||
assert.deepEqual(notice.filter, ["LICENSE", "NOTICE.md"]);
|
||||
}
|
||||
});
|
||||
|
||||
test("both hooks reject unsupported target architectures without falling back to the host", async () => {
|
||||
const context = {
|
||||
electronPlatformName: "win32",
|
||||
arch: 0,
|
||||
packager: {
|
||||
projectDir: "/unreachable/project",
|
||||
getResourcesDir: () =>
|
||||
assert.fail("unsupported target must not read resources"),
|
||||
},
|
||||
};
|
||||
await assert.rejects(
|
||||
beforePack(context),
|
||||
/Unsupported Legendary architecture: ia32/
|
||||
);
|
||||
await assert.rejects(
|
||||
afterPack(context),
|
||||
/Unsupported Legendary architecture: ia32/
|
||||
);
|
||||
});
|
||||
|
||||
test("packaged Windows executable may have signed bytes different from the upstream hash", async (t) => {
|
||||
const resourcesDir = await fs.mkdtemp(
|
||||
path.join(os.tmpdir(), "legendary-signed-")
|
||||
);
|
||||
t.after(() => fs.rm(resourcesDir, { recursive: true, force: true }));
|
||||
await fs.mkdir(path.join(resourcesDir, "legendary"));
|
||||
await fs.writeFile(
|
||||
path.join(resourcesDir, "legendary", "legendary.exe"),
|
||||
"signed executable bytes"
|
||||
);
|
||||
// A foreign architecture skips execution but still validates the packaged file.
|
||||
const arch = process.platform === "win32" && process.arch === "x64" ? 3 : 1;
|
||||
await afterPack({
|
||||
electronPlatformName: "win32",
|
||||
arch,
|
||||
appOutDir: "unused",
|
||||
packager: { getResourcesDir: () => resourcesDir },
|
||||
});
|
||||
});
|
||||
|
||||
test("macOS PyInstaller signing entitlements are scoped to Legendary only", async () => {
|
||||
const app = path.join("project", "Hydra.app");
|
||||
const projectDir = "project";
|
||||
const originalFileOptions = {
|
||||
entitlements: "existing-hydra-entitlements.plist",
|
||||
hardenedRuntime: true,
|
||||
timestamp: "original-timestamp",
|
||||
};
|
||||
const options = {
|
||||
app,
|
||||
identity: "existing-signing-identity",
|
||||
optionsForFile: () => originalFileOptions,
|
||||
};
|
||||
const scoped = createSigningOptions(options, projectDir);
|
||||
assert.equal(scoped.identity, options.identity);
|
||||
for (const relativeFile of [
|
||||
["Contents", "MacOS", "Hydra"],
|
||||
["Contents", "Frameworks", "Hydra Helper.app"],
|
||||
["Contents", "Resources", "hydra-native", "hydra-native.node"],
|
||||
["Contents", "Resources", "ludusavi", "ludusavi"],
|
||||
]) {
|
||||
assert.equal(
|
||||
scoped.optionsForFile(path.join(app, ...relativeFile)),
|
||||
originalFileOptions
|
||||
);
|
||||
}
|
||||
assert.deepEqual(
|
||||
scoped.optionsForFile(
|
||||
path.join(app, "Contents", "Resources", "legendary", "legendary")
|
||||
),
|
||||
{
|
||||
...originalFileOptions,
|
||||
entitlements: path.join(
|
||||
projectDir,
|
||||
"build",
|
||||
"entitlements.legendary.mac.plist"
|
||||
),
|
||||
}
|
||||
);
|
||||
assert.equal(
|
||||
originalFileOptions.entitlements,
|
||||
"existing-hydra-entitlements.plist"
|
||||
);
|
||||
const entitlements = await fs.readFile(
|
||||
new URL("../build/entitlements.legendary.mac.plist", import.meta.url),
|
||||
"utf8"
|
||||
);
|
||||
assert.match(
|
||||
entitlements,
|
||||
/com\.apple\.security\.cs\.disable-library-validation/
|
||||
);
|
||||
assert.equal(config.mac.sign, "scripts/legendary-mac-sign.cjs");
|
||||
assert.equal(config.mac.entitlementsInherit, "build/entitlements.mac.plist");
|
||||
});
|
||||
|
||||
test("macOS development builds remain unsigned when no certificate is available", async () => {
|
||||
await signMac(
|
||||
{ app: "nonexistent/Hydra.app", platform: "darwin" },
|
||||
{ projectDir: "unused", forceCodeSigning: false }
|
||||
);
|
||||
});
|
||||
|
||||
test("macOS builds requiring signing still fail without an identity", async () => {
|
||||
await assert.rejects(
|
||||
signMac(
|
||||
{ app: "nonexistent/Hydra.app", platform: "darwin" },
|
||||
{ projectDir: "unused", forceCodeSigning: true }
|
||||
),
|
||||
/no signing identity available/
|
||||
);
|
||||
await assert.rejects(
|
||||
signMac(
|
||||
{ app: "nonexistent/Hydra.app", platform: "mas" },
|
||||
{ projectDir: "unused", forceCodeSigning: false }
|
||||
),
|
||||
/no signing identity available/
|
||||
);
|
||||
});
|
||||
279
scripts/legendary.test.mjs
Normal file
279
scripts/legendary.test.mjs
Normal file
|
|
@ -0,0 +1,279 @@
|
|||
import assert from "node:assert/strict";
|
||||
import { createHash } from "node:crypto";
|
||||
import fs from "node:fs/promises";
|
||||
import os from "node:os";
|
||||
import path from "node:path";
|
||||
import { createRequire } from "node:module";
|
||||
import { test } from "node:test";
|
||||
|
||||
const require = createRequire(import.meta.url);
|
||||
const manifest = require("../src/shared/legendary-manifest.json");
|
||||
const {
|
||||
getLegendaryArtifact,
|
||||
prepareLegendary,
|
||||
parseArguments,
|
||||
} = require("./prepare-legendary.cjs");
|
||||
|
||||
const checksum = (content) =>
|
||||
createHash("sha256").update(content).digest("hex");
|
||||
|
||||
function fixtureManifest(contents) {
|
||||
const artifacts = {};
|
||||
for (const platform of ["win32", "darwin"]) {
|
||||
artifacts[platform] = {};
|
||||
for (const arch of ["x64", "arm64"]) {
|
||||
artifacts[platform][arch] = {
|
||||
fileName: platform === "win32" ? "legendary.exe" : "legendary",
|
||||
url: `https://fixture.invalid/${platform}/${arch}`,
|
||||
sha256: checksum(contents[`${platform}/${arch}`] || "fixture"),
|
||||
};
|
||||
}
|
||||
}
|
||||
return { ...manifest, artifacts };
|
||||
}
|
||||
|
||||
async function directory(t) {
|
||||
const projectDir = await fs.mkdtemp(
|
||||
path.join(os.tmpdir(), "legendary-test-")
|
||||
);
|
||||
t.after(() => fs.rm(projectDir, { recursive: true, force: true }));
|
||||
return projectDir;
|
||||
}
|
||||
|
||||
test("selects official pinned artifacts for all four targets", () => {
|
||||
assert.equal(manifest.version, "0.21.1");
|
||||
for (const platform of ["win32", "darwin"]) {
|
||||
for (const arch of ["x64", "arm64"]) {
|
||||
const artifact = getLegendaryArtifact(platform, arch);
|
||||
const name = `${platform === "win32" ? "windows" : "macOS"}_${arch}${platform === "win32" ? ".exe" : ""}`;
|
||||
assert.equal(
|
||||
artifact.url,
|
||||
`https://github.com/legendary-gl/legendary/releases/download/${manifest.version}/legendary_${name}`
|
||||
);
|
||||
assert.match(artifact.sha256, /^[a-f0-9]{64}$/);
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
test("downloads the explicit target, regardless of the host", async (t) => {
|
||||
const projectDir = await directory(t);
|
||||
const artifactManifest = fixtureManifest({});
|
||||
const targets = [];
|
||||
for (const platform of ["win32", "darwin"]) {
|
||||
for (const arch of ["x64", "arm64"]) {
|
||||
const result = await prepareLegendary({
|
||||
projectDir,
|
||||
platform,
|
||||
arch,
|
||||
artifactManifest,
|
||||
fetchImpl: async (url, { signal }) => {
|
||||
targets.push(url);
|
||||
assert.ok(signal instanceof AbortSignal);
|
||||
return new Response("fixture");
|
||||
},
|
||||
});
|
||||
assert.equal(result.cached, false);
|
||||
assert.equal(
|
||||
result.binaryPath,
|
||||
path.join(
|
||||
projectDir,
|
||||
"legendary",
|
||||
platform,
|
||||
arch,
|
||||
platform === "win32" ? "legendary.exe" : "legendary"
|
||||
)
|
||||
);
|
||||
assert.equal(await fs.readFile(result.binaryPath, "utf8"), "fixture");
|
||||
}
|
||||
}
|
||||
assert.deepEqual(targets, [
|
||||
"https://fixture.invalid/win32/x64",
|
||||
"https://fixture.invalid/win32/arm64",
|
||||
"https://fixture.invalid/darwin/x64",
|
||||
"https://fixture.invalid/darwin/arm64",
|
||||
]);
|
||||
});
|
||||
|
||||
test("valid cache is hashed and reused without network; mac permissions restored", async (t) => {
|
||||
const projectDir = await directory(t);
|
||||
const options = {
|
||||
projectDir,
|
||||
platform: "darwin",
|
||||
arch: "arm64",
|
||||
artifactManifest: fixtureManifest({}),
|
||||
fetchImpl: async () => new Response("fixture"),
|
||||
};
|
||||
const first = await prepareLegendary(options);
|
||||
await fs.chmod(first.binaryPath, 0o644);
|
||||
const cached = await prepareLegendary({
|
||||
...options,
|
||||
fetchImpl: () => assert.fail("valid cache must not download"),
|
||||
});
|
||||
assert.equal(cached.cached, true);
|
||||
if (process.platform !== "win32") {
|
||||
assert.equal((await fs.stat(cached.binaryPath)).mode & 0o777, 0o755);
|
||||
}
|
||||
});
|
||||
|
||||
test("corrupt cache is replaced only after a verified download", async (t) => {
|
||||
const projectDir = await directory(t);
|
||||
const options = {
|
||||
projectDir,
|
||||
platform: "win32",
|
||||
arch: "x64",
|
||||
artifactManifest: fixtureManifest({}),
|
||||
fetchImpl: async () => new Response("fixture"),
|
||||
};
|
||||
const first = await prepareLegendary(options);
|
||||
await fs.writeFile(first.binaryPath, "old-version");
|
||||
const repaired = await prepareLegendary(options);
|
||||
assert.equal(repaired.cached, false);
|
||||
assert.equal(await fs.readFile(repaired.binaryPath, "utf8"), "fixture");
|
||||
assert.deepEqual(await fs.readdir(path.dirname(repaired.binaryPath)), [
|
||||
"legendary.exe",
|
||||
]);
|
||||
});
|
||||
|
||||
test("checksum mismatch leaves no executable or temporary download", async (t) => {
|
||||
const projectDir = await directory(t);
|
||||
await assert.rejects(
|
||||
prepareLegendary({
|
||||
projectDir,
|
||||
platform: "darwin",
|
||||
arch: "x64",
|
||||
artifactManifest: fixtureManifest({}),
|
||||
fetchImpl: async () => new Response("wrong release"),
|
||||
}),
|
||||
/checksum mismatch/
|
||||
);
|
||||
assert.deepEqual(
|
||||
await fs.readdir(path.join(projectDir, "legendary", "darwin", "x64")),
|
||||
[]
|
||||
);
|
||||
});
|
||||
|
||||
test("interrupted download leaves no executable or temporary file", async (t) => {
|
||||
const projectDir = await directory(t);
|
||||
await assert.rejects(
|
||||
prepareLegendary({
|
||||
projectDir,
|
||||
platform: "win32",
|
||||
arch: "arm64",
|
||||
artifactManifest: fixtureManifest({}),
|
||||
fetchImpl: async () =>
|
||||
new Response(
|
||||
new ReadableStream({
|
||||
pull(controller) {
|
||||
controller.error(new Error("network interrupted"));
|
||||
},
|
||||
})
|
||||
),
|
||||
}),
|
||||
/network interrupted/
|
||||
);
|
||||
assert.deepEqual(
|
||||
await fs.readdir(path.join(projectDir, "legendary", "win32", "arm64")),
|
||||
[]
|
||||
);
|
||||
});
|
||||
|
||||
test("HTTP errors do not install an executable", async (t) => {
|
||||
const projectDir = await directory(t);
|
||||
await assert.rejects(
|
||||
prepareLegendary({
|
||||
projectDir,
|
||||
platform: "darwin",
|
||||
arch: "arm64",
|
||||
fetchImpl: async () => new Response("not found", { status: 404 }),
|
||||
}),
|
||||
/HTTP 404/
|
||||
);
|
||||
assert.deepEqual(
|
||||
await fs.readdir(path.join(projectDir, "legendary", "darwin", "arm64")),
|
||||
[]
|
||||
);
|
||||
});
|
||||
|
||||
test("Linux skips all filesystem/network work even with a foreign cache", async (t) => {
|
||||
const projectDir = await directory(t);
|
||||
const foreignPath = path.join(projectDir, "legendary", "darwin", "arm64");
|
||||
await fs.mkdir(foreignPath, { recursive: true });
|
||||
await fs.writeFile(path.join(foreignPath, "legendary"), "cached Mac binary");
|
||||
const result = await prepareLegendary({
|
||||
projectDir,
|
||||
platform: "linux",
|
||||
arch: "ia32",
|
||||
fetchImpl: () => assert.fail("Linux must not download"),
|
||||
});
|
||||
assert.equal(result.skipped, true);
|
||||
assert.deepEqual(await fs.readdir(path.join(projectDir, "legendary")), [
|
||||
"darwin",
|
||||
]);
|
||||
assert.equal(
|
||||
await fs.readFile(path.join(foreignPath, "legendary"), "utf8"),
|
||||
"cached Mac binary"
|
||||
);
|
||||
});
|
||||
|
||||
test("unsupported targets fail before downloading or creating cache", async (t) => {
|
||||
const projectDir = await directory(t);
|
||||
for (const [platform, arch] of [
|
||||
["win32", "ia32"],
|
||||
["darwin", "universal"],
|
||||
["freebsd", "x64"],
|
||||
]) {
|
||||
await assert.rejects(
|
||||
prepareLegendary({
|
||||
projectDir,
|
||||
platform,
|
||||
arch,
|
||||
fetchImpl: () => assert.fail("must not download"),
|
||||
}),
|
||||
/Unsupported Legendary/
|
||||
);
|
||||
}
|
||||
assert.deepEqual(await fs.readdir(projectDir), []);
|
||||
});
|
||||
|
||||
test("concurrent preparation keeps architectures separate and installs atomically", async (t) => {
|
||||
const projectDir = await directory(t);
|
||||
const contents = { "win32/x64": "x64 exe", "win32/arm64": "arm64 exe" };
|
||||
const artifactManifest = fixtureManifest(contents);
|
||||
const prepare = (arch) =>
|
||||
prepareLegendary({
|
||||
projectDir,
|
||||
platform: "win32",
|
||||
arch,
|
||||
artifactManifest,
|
||||
fetchImpl: async (url) =>
|
||||
new Response(contents[url.replace("https://fixture.invalid/", "")]),
|
||||
});
|
||||
const results = await Promise.all([
|
||||
prepare("x64"),
|
||||
prepare("arm64"),
|
||||
prepare("x64"),
|
||||
]);
|
||||
for (const result of results) {
|
||||
assert.equal(
|
||||
await fs.readFile(result.binaryPath, "utf8"),
|
||||
contents[`win32/${result.arch}`]
|
||||
);
|
||||
assert.deepEqual(await fs.readdir(path.dirname(result.binaryPath)), [
|
||||
"legendary.exe",
|
||||
]);
|
||||
}
|
||||
});
|
||||
|
||||
test("CLI accepts explicit target and rejects missing/unknown arguments", () => {
|
||||
assert.deepEqual(parseArguments(["--platform", "win32", "--arch", "arm64"]), {
|
||||
platform: "win32",
|
||||
arch: "arm64",
|
||||
});
|
||||
assert.deepEqual(parseArguments([]), {});
|
||||
assert.throws(() => parseArguments(["--arch"]), /Missing value/);
|
||||
assert.throws(
|
||||
() => parseArguments(["--platform", "--arch", "x64"]),
|
||||
/Missing value/
|
||||
);
|
||||
assert.throws(() => parseArguments(["--unknown", "x64"]), /Unknown/);
|
||||
});
|
||||
157
scripts/prepare-legendary.cjs
Normal file
157
scripts/prepare-legendary.cjs
Normal file
|
|
@ -0,0 +1,157 @@
|
|||
const { createHash, randomUUID } = require("node:crypto");
|
||||
const { createReadStream, createWriteStream } = require("node:fs");
|
||||
const fs = require("node:fs/promises");
|
||||
const path = require("node:path");
|
||||
const { Readable } = require("node:stream");
|
||||
const { pipeline } = require("node:stream/promises");
|
||||
const { execFile } = require("node:child_process");
|
||||
const { promisify } = require("node:util");
|
||||
const manifest = require("../src/shared/legendary-manifest.json");
|
||||
|
||||
const DOWNLOAD_TIMEOUT_MS = 60_000;
|
||||
// Build checks allow cold PyInstaller/macOS library validation to complete.
|
||||
// The launcher service keeps its separate 15-second timeout.
|
||||
const VERSION_TIMEOUT_MS = 60_000;
|
||||
const execFileAsync = promisify(execFile);
|
||||
|
||||
function getLegendaryArtifact(platform, arch, artifactManifest = manifest) {
|
||||
if (platform === "linux") return null;
|
||||
if (platform !== "win32" && platform !== "darwin") {
|
||||
throw new Error(`Unsupported Legendary platform: ${platform}`);
|
||||
}
|
||||
if (arch !== "x64" && arch !== "arm64") {
|
||||
throw new Error(`Unsupported Legendary architecture: ${arch}`);
|
||||
}
|
||||
const artifact = artifactManifest.artifacts[platform][arch];
|
||||
if (!artifact || !/^[a-f0-9]{64}$/.test(artifact.sha256)) {
|
||||
throw new Error(`Invalid Legendary artifact manifest: ${platform}/${arch}`);
|
||||
}
|
||||
return artifact;
|
||||
}
|
||||
|
||||
async function sha256File(filePath) {
|
||||
const hash = createHash("sha256");
|
||||
for await (const chunk of createReadStream(filePath)) hash.update(chunk);
|
||||
return hash.digest("hex");
|
||||
}
|
||||
|
||||
async function hasExpectedChecksum(filePath, expectedChecksum) {
|
||||
try {
|
||||
return (await sha256File(filePath)) === expectedChecksum;
|
||||
} catch (error) {
|
||||
if (error.code === "ENOENT") return false;
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
|
||||
async function prepareLegendary({
|
||||
projectDir = path.resolve(__dirname, ".."),
|
||||
platform = process.platform,
|
||||
arch = process.arch,
|
||||
artifactManifest = manifest,
|
||||
fetchImpl = global.fetch,
|
||||
} = {}) {
|
||||
const artifact = getLegendaryArtifact(platform, arch, artifactManifest);
|
||||
// Linux must not touch the filesystem or network, including a foreign cache.
|
||||
if (!artifact) return { skipped: true, platform, arch };
|
||||
|
||||
const directory = path.join(projectDir, "legendary", platform, arch);
|
||||
const binaryPath = path.join(directory, artifact.fileName);
|
||||
if (await hasExpectedChecksum(binaryPath, artifact.sha256)) {
|
||||
if (platform === "darwin") await fs.chmod(binaryPath, 0o755);
|
||||
return { skipped: false, binaryPath, cached: true, platform, arch };
|
||||
}
|
||||
|
||||
await fs.mkdir(directory, { recursive: true });
|
||||
const temporaryPath = path.join(directory, `.download-${randomUUID()}`);
|
||||
try {
|
||||
const signal = AbortSignal.timeout(DOWNLOAD_TIMEOUT_MS);
|
||||
const response = await fetchImpl(artifact.url, { signal });
|
||||
if (!response.ok || !response.body) {
|
||||
throw new Error(`Legendary download failed: HTTP ${response.status}`);
|
||||
}
|
||||
await pipeline(
|
||||
Readable.fromWeb(response.body),
|
||||
createWriteStream(temporaryPath, { flags: "wx", mode: 0o755 }),
|
||||
{ signal }
|
||||
);
|
||||
if (!(await hasExpectedChecksum(temporaryPath, artifact.sha256))) {
|
||||
throw new Error(`Legendary checksum mismatch: ${platform}/${arch}`);
|
||||
}
|
||||
if (platform === "darwin") await fs.chmod(temporaryPath, 0o755);
|
||||
try {
|
||||
await fs.rename(temporaryPath, binaryPath);
|
||||
} catch (error) {
|
||||
// Another preparation may have atomically installed the same artifact.
|
||||
if (!(await hasExpectedChecksum(binaryPath, artifact.sha256)))
|
||||
throw error;
|
||||
}
|
||||
return { skipped: false, binaryPath, cached: false, platform, arch };
|
||||
} finally {
|
||||
await fs.rm(temporaryPath, { force: true });
|
||||
}
|
||||
}
|
||||
|
||||
async function verifyLegendaryVersion(
|
||||
binaryPath,
|
||||
expectedVersion = manifest.version
|
||||
) {
|
||||
const { stdout } = await execFileAsync(binaryPath, ["--version"], {
|
||||
shell: false,
|
||||
windowsHide: true,
|
||||
timeout: VERSION_TIMEOUT_MS,
|
||||
maxBuffer: 64 * 1024,
|
||||
});
|
||||
const version = /legendary version ["']([^"']+)["']/i.exec(stdout)?.[1];
|
||||
if (version !== expectedVersion) {
|
||||
throw new Error(`Unexpected Legendary version: ${version || "unknown"}`);
|
||||
}
|
||||
return version;
|
||||
}
|
||||
|
||||
function parseArguments(args) {
|
||||
const options = {};
|
||||
for (let index = 0; index < args.length; index++) {
|
||||
const name = args[index];
|
||||
if (name !== "--platform" && name !== "--arch") {
|
||||
throw new Error(`Unknown Legendary preparation argument: ${name}`);
|
||||
}
|
||||
const value = args[++index];
|
||||
if (!value || value.startsWith("--")) {
|
||||
throw new Error(`Missing value for ${name}`);
|
||||
}
|
||||
options[name.slice(2)] = value;
|
||||
}
|
||||
return options;
|
||||
}
|
||||
|
||||
async function main() {
|
||||
const result = await prepareLegendary(parseArguments(process.argv.slice(2)));
|
||||
if (result.skipped) {
|
||||
console.log("Legendary preparation skipped on Linux.");
|
||||
return;
|
||||
}
|
||||
// Never execute a foreign-platform/architecture binary on the build machine.
|
||||
if (result.platform === process.platform && result.arch === process.arch) {
|
||||
await verifyLegendaryVersion(result.binaryPath);
|
||||
}
|
||||
console.log(
|
||||
`Legendary ${manifest.version} prepared for ${result.platform}/${result.arch}${result.cached ? " (cache verified)" : ""}.`
|
||||
);
|
||||
}
|
||||
|
||||
module.exports = {
|
||||
getLegendaryArtifact,
|
||||
prepareLegendary,
|
||||
sha256File,
|
||||
hasExpectedChecksum,
|
||||
verifyLegendaryVersion,
|
||||
parseArguments,
|
||||
};
|
||||
|
||||
if (require.main === module) {
|
||||
main().catch((error) => {
|
||||
console.error(error.message);
|
||||
process.exitCode = 1;
|
||||
});
|
||||
}
|
||||
232
src/main/services/legendary-core.test.ts
Normal file
232
src/main/services/legendary-core.test.ts
Normal file
|
|
@ -0,0 +1,232 @@
|
|||
import assert from "node:assert/strict";
|
||||
import fs from "node:fs/promises";
|
||||
import os from "node:os";
|
||||
import path from "node:path";
|
||||
import test from "node:test";
|
||||
import {
|
||||
getLegendaryAvailability,
|
||||
resolveLegendaryBinaryPath,
|
||||
type LegendaryEnvironment,
|
||||
} from "./legendary-core.ts";
|
||||
|
||||
const environment = (
|
||||
overrides: Partial<LegendaryEnvironment> = {}
|
||||
): LegendaryEnvironment => ({
|
||||
platform: "darwin",
|
||||
arch: "arm64",
|
||||
isPackaged: false,
|
||||
developmentRoot: "/Users/me/Hydra repo",
|
||||
resourcesPath: "/Applications/Hydra.app/Contents/Resources",
|
||||
...overrides,
|
||||
});
|
||||
|
||||
const expectedVersion = "0.21.1";
|
||||
const versionOutput = 'legendary version "0.21.1", codename "Test"\n';
|
||||
|
||||
test("resolves the development executable for each platform and architecture", () => {
|
||||
for (const arch of ["x64", "arm64"]) {
|
||||
assert.equal(
|
||||
resolveLegendaryBinaryPath(environment({ arch })),
|
||||
`/Users/me/Hydra repo/legendary/darwin/${arch}/legendary`
|
||||
);
|
||||
assert.equal(
|
||||
resolveLegendaryBinaryPath(
|
||||
environment({
|
||||
platform: "win32",
|
||||
arch,
|
||||
developmentRoot: "C:\\Hydra repo",
|
||||
})
|
||||
),
|
||||
`C:\\Hydra repo\\legendary\\win32\\${arch}\\legendary.exe`
|
||||
);
|
||||
}
|
||||
});
|
||||
|
||||
test("runs the packaged resource directly for each target, never a cached userData copy", () => {
|
||||
for (const arch of ["x64", "arm64"]) {
|
||||
assert.equal(
|
||||
resolveLegendaryBinaryPath(environment({ isPackaged: true, arch })),
|
||||
"/Applications/Hydra.app/Contents/Resources/legendary/legendary"
|
||||
);
|
||||
assert.equal(
|
||||
resolveLegendaryBinaryPath(
|
||||
environment({
|
||||
platform: "win32",
|
||||
arch,
|
||||
isPackaged: true,
|
||||
resourcesPath: "C:\\Program Files\\Hydra\\resources",
|
||||
})
|
||||
),
|
||||
"C:\\Program Files\\Hydra\\resources\\legendary\\legendary.exe"
|
||||
);
|
||||
}
|
||||
});
|
||||
|
||||
test("does not inspect or execute Legendary on Linux or unsupported architectures", async () => {
|
||||
const overrides = {
|
||||
isFile: async () => {
|
||||
assert.fail("unsupported target must not access the file system");
|
||||
},
|
||||
execFile: () => {
|
||||
assert.fail("unsupported target must not execute Legendary");
|
||||
},
|
||||
};
|
||||
for (const isPackaged of [false, true]) {
|
||||
assert.equal(
|
||||
resolveLegendaryBinaryPath(
|
||||
environment({ platform: "linux", isPackaged })
|
||||
),
|
||||
null
|
||||
);
|
||||
assert.deepEqual(
|
||||
await getLegendaryAvailability(
|
||||
environment({ platform: "linux", isPackaged }),
|
||||
expectedVersion,
|
||||
overrides
|
||||
),
|
||||
{ available: false, reason: "unsupported-platform" }
|
||||
);
|
||||
assert.deepEqual(
|
||||
await getLegendaryAvailability(
|
||||
environment({ arch: "ia32", isPackaged }),
|
||||
expectedVersion,
|
||||
overrides
|
||||
),
|
||||
{ available: false, reason: "unsupported-architecture" }
|
||||
);
|
||||
}
|
||||
});
|
||||
|
||||
test("a missing executable is unavailable and never starts a process", async () => {
|
||||
const result = await getLegendaryAvailability(
|
||||
environment(),
|
||||
expectedVersion,
|
||||
{
|
||||
isFile: async () => false,
|
||||
execFile: () => assert.fail("missing executable must not execute"),
|
||||
}
|
||||
);
|
||||
assert.equal(result.available, false);
|
||||
if (!result.available) assert.equal(result.reason, "missing");
|
||||
});
|
||||
|
||||
test("calls only --version without a shell, with timeout and bounded output", async () => {
|
||||
const result = await getLegendaryAvailability(
|
||||
environment(),
|
||||
expectedVersion,
|
||||
{
|
||||
isFile: async () => true,
|
||||
execFile: (binaryPath, args, options, callback) => {
|
||||
assert.equal(
|
||||
binaryPath,
|
||||
"/Users/me/Hydra repo/legendary/darwin/arm64/legendary"
|
||||
);
|
||||
assert.deepEqual(args, ["--version"]);
|
||||
assert.deepEqual(options, {
|
||||
shell: false,
|
||||
timeout: 15_000,
|
||||
windowsHide: true,
|
||||
maxBuffer: 16 * 1024,
|
||||
encoding: "utf8",
|
||||
});
|
||||
callback(null, versionOutput);
|
||||
},
|
||||
}
|
||||
);
|
||||
assert.deepEqual(result, {
|
||||
available: true,
|
||||
binaryPath: "/Users/me/Hydra repo/legendary/darwin/arm64/legendary",
|
||||
version: expectedVersion,
|
||||
});
|
||||
});
|
||||
|
||||
test("does not accept exit zero with a wrong or unrelated version output", async () => {
|
||||
for (const output of [
|
||||
'legendary version "0.21.0", codename "Test"',
|
||||
"some executable version 0.21.1",
|
||||
"",
|
||||
]) {
|
||||
const result = await getLegendaryAvailability(
|
||||
environment(),
|
||||
expectedVersion,
|
||||
{
|
||||
isFile: async () => true,
|
||||
execFile: (_file, _args, _options, callback) => callback(null, output),
|
||||
}
|
||||
);
|
||||
assert.equal(result.available, false);
|
||||
if (!result.available) assert.equal(result.reason, "version-mismatch");
|
||||
}
|
||||
});
|
||||
|
||||
test("execution failures, timeout and output overflow remain optional integration failures", async () => {
|
||||
for (const error of [
|
||||
Object.assign(new Error("ENOENT"), { code: "ENOENT" }),
|
||||
Object.assign(new Error("timed out"), { killed: true, signal: "SIGTERM" }),
|
||||
Object.assign(new Error("stdout maxBuffer length exceeded"), {
|
||||
code: "ERR_CHILD_PROCESS_STDIO_MAXBUFFER",
|
||||
}),
|
||||
]) {
|
||||
const result = await getLegendaryAvailability(
|
||||
environment(),
|
||||
expectedVersion,
|
||||
{
|
||||
isFile: async () => true,
|
||||
execFile: (_file, _args, _options, callback) =>
|
||||
callback(error, versionOutput),
|
||||
}
|
||||
);
|
||||
assert.equal(result.available, false);
|
||||
if (!result.available) assert.equal(result.reason, "execution-failed");
|
||||
}
|
||||
|
||||
const result = await getLegendaryAvailability(
|
||||
environment(),
|
||||
expectedVersion,
|
||||
{
|
||||
isFile: async () => true,
|
||||
execFile: () => {
|
||||
throw new Error("spawn failed");
|
||||
},
|
||||
}
|
||||
);
|
||||
assert.equal(result.available, false);
|
||||
if (!result.available) assert.equal(result.reason, "execution-failed");
|
||||
});
|
||||
|
||||
test("a file-system failure returns unavailable instead of rejecting", async () => {
|
||||
const result = await getLegendaryAvailability(
|
||||
environment(),
|
||||
expectedVersion,
|
||||
{
|
||||
isFile: async () => {
|
||||
throw new Error("permission denied");
|
||||
},
|
||||
execFile: () => assert.fail("unreachable file must not execute"),
|
||||
}
|
||||
);
|
||||
assert.equal(result.available, false);
|
||||
if (!result.available) assert.equal(result.reason, "missing");
|
||||
});
|
||||
|
||||
test("default file inspection rejects missing executables and directories", async (t) => {
|
||||
const directory = await fs.mkdtemp(
|
||||
path.join(os.tmpdir(), "hydra-legendary-")
|
||||
);
|
||||
t.after(() => fs.rm(directory, { recursive: true, force: true }));
|
||||
const env = environment({ isPackaged: true, resourcesPath: directory });
|
||||
const binaryPath = resolveLegendaryBinaryPath(env)!;
|
||||
|
||||
assert.deepEqual(await getLegendaryAvailability(env, expectedVersion), {
|
||||
available: false,
|
||||
reason: "missing",
|
||||
binaryPath,
|
||||
});
|
||||
|
||||
await fs.mkdir(binaryPath, { recursive: true });
|
||||
assert.deepEqual(await getLegendaryAvailability(env, expectedVersion), {
|
||||
available: false,
|
||||
reason: "missing",
|
||||
binaryPath,
|
||||
});
|
||||
});
|
||||
132
src/main/services/legendary-core.ts
Normal file
132
src/main/services/legendary-core.ts
Normal file
|
|
@ -0,0 +1,132 @@
|
|||
import {
|
||||
execFile,
|
||||
type ExecFileOptionsWithStringEncoding,
|
||||
} from "node:child_process";
|
||||
import fs from "node:fs";
|
||||
import path from "node:path";
|
||||
|
||||
const VERSION_CHECK_TIMEOUT_MS = 15_000;
|
||||
const VERSION_CHECK_MAX_BUFFER_BYTES = 16 * 1024;
|
||||
|
||||
export interface LegendaryEnvironment {
|
||||
platform: string;
|
||||
arch: string;
|
||||
isPackaged: boolean;
|
||||
developmentRoot: string;
|
||||
resourcesPath: string;
|
||||
}
|
||||
|
||||
export type LegendaryAvailability =
|
||||
| { available: true; binaryPath: string; version: string }
|
||||
| {
|
||||
available: false;
|
||||
reason:
|
||||
| "unsupported-platform"
|
||||
| "unsupported-architecture"
|
||||
| "missing"
|
||||
| "execution-failed"
|
||||
| "version-mismatch";
|
||||
binaryPath?: string;
|
||||
version?: string;
|
||||
};
|
||||
|
||||
interface LegendaryDependencies {
|
||||
isFile: (binaryPath: string) => Promise<boolean>;
|
||||
execFile: (
|
||||
binaryPath: string,
|
||||
args: string[],
|
||||
options: ExecFileOptionsWithStringEncoding,
|
||||
callback: (error: Error | null, stdout: string) => void
|
||||
) => void;
|
||||
}
|
||||
|
||||
const defaultDependencies: LegendaryDependencies = {
|
||||
isFile: async (binaryPath) => {
|
||||
try {
|
||||
return (await fs.promises.stat(binaryPath)).isFile();
|
||||
} catch {
|
||||
return false;
|
||||
}
|
||||
},
|
||||
execFile: (binaryPath, args, options, callback) => {
|
||||
execFile(binaryPath, args, options, callback);
|
||||
},
|
||||
};
|
||||
|
||||
export const resolveLegendaryBinaryPath = (
|
||||
environment: LegendaryEnvironment
|
||||
): string | null => {
|
||||
const { platform, arch, isPackaged, developmentRoot, resourcesPath } =
|
||||
environment;
|
||||
|
||||
if (platform !== "win32" && platform !== "darwin") return null;
|
||||
if (arch !== "x64" && arch !== "arm64") return null;
|
||||
|
||||
const paths = platform === "win32" ? path.win32 : path.posix;
|
||||
const binaryName = platform === "win32" ? "legendary.exe" : "legendary";
|
||||
|
||||
return isPackaged
|
||||
? paths.join(resourcesPath, "legendary", binaryName)
|
||||
: paths.join(developmentRoot, "legendary", platform, arch, binaryName);
|
||||
};
|
||||
|
||||
/** Runs only when explicitly requested. Packaged executables may be signed, so
|
||||
* integrity against the upstream hash is checked during preparation, not here.
|
||||
*/
|
||||
export const getLegendaryAvailability = async (
|
||||
environment: LegendaryEnvironment,
|
||||
expectedVersion: string,
|
||||
overrides: Partial<LegendaryDependencies> = {}
|
||||
): Promise<LegendaryAvailability> => {
|
||||
if (environment.platform !== "win32" && environment.platform !== "darwin") {
|
||||
return { available: false, reason: "unsupported-platform" };
|
||||
}
|
||||
|
||||
const binaryPath = resolveLegendaryBinaryPath(environment);
|
||||
if (!binaryPath) {
|
||||
return { available: false, reason: "unsupported-architecture" };
|
||||
}
|
||||
|
||||
const dependencies = { ...defaultDependencies, ...overrides };
|
||||
try {
|
||||
if (!(await dependencies.isFile(binaryPath))) {
|
||||
return { available: false, reason: "missing", binaryPath };
|
||||
}
|
||||
} catch {
|
||||
return { available: false, reason: "missing", binaryPath };
|
||||
}
|
||||
|
||||
try {
|
||||
const stdout = await new Promise<string>((resolve, reject) => {
|
||||
dependencies.execFile(
|
||||
binaryPath,
|
||||
["--version"],
|
||||
{
|
||||
shell: false,
|
||||
timeout: VERSION_CHECK_TIMEOUT_MS,
|
||||
windowsHide: true,
|
||||
maxBuffer: VERSION_CHECK_MAX_BUFFER_BYTES,
|
||||
encoding: "utf8",
|
||||
},
|
||||
(error, output) => (error ? reject(error) : resolve(output))
|
||||
);
|
||||
});
|
||||
|
||||
const version = /^legendary version "([^"]+)", codename "[^"]*"\s*$/.exec(
|
||||
stdout.trim()
|
||||
)?.[1];
|
||||
|
||||
if (version !== expectedVersion) {
|
||||
return {
|
||||
available: false,
|
||||
reason: "version-mismatch",
|
||||
binaryPath,
|
||||
version,
|
||||
};
|
||||
}
|
||||
|
||||
return { available: true, binaryPath, version };
|
||||
} catch {
|
||||
return { available: false, reason: "execution-failed", binaryPath };
|
||||
}
|
||||
};
|
||||
26
src/main/services/legendary.ts
Normal file
26
src/main/services/legendary.ts
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
import { app } from "electron";
|
||||
import path from "node:path";
|
||||
import manifest from "../../shared/legendary-manifest.json" with { type: "json" };
|
||||
import {
|
||||
getLegendaryAvailability,
|
||||
resolveLegendaryBinaryPath,
|
||||
type LegendaryEnvironment,
|
||||
} from "./legendary-core";
|
||||
|
||||
const getEnvironment = (): LegendaryEnvironment => ({
|
||||
platform: process.platform,
|
||||
arch: process.arch,
|
||||
isPackaged: app.isPackaged,
|
||||
developmentRoot: path.join(__dirname, "..", ".."),
|
||||
resourcesPath: process.resourcesPath,
|
||||
});
|
||||
|
||||
export class Legendary {
|
||||
public static getBinaryPath() {
|
||||
return resolveLegendaryBinaryPath(getEnvironment());
|
||||
}
|
||||
|
||||
public static checkVersion() {
|
||||
return getLegendaryAvailability(getEnvironment(), manifest.version);
|
||||
}
|
||||
}
|
||||
32
src/shared/legendary-manifest.json
Normal file
32
src/shared/legendary-manifest.json
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
{
|
||||
"version": "0.21.1",
|
||||
"releaseUrl": "https://github.com/legendary-gl/legendary/releases/tag/0.21.1",
|
||||
"sourceUrl": "https://github.com/legendary-gl/legendary/tree/0.21.1",
|
||||
"license": "GPL-3.0-or-later",
|
||||
"artifacts": {
|
||||
"win32": {
|
||||
"x64": {
|
||||
"fileName": "legendary.exe",
|
||||
"url": "https://github.com/legendary-gl/legendary/releases/download/0.21.1/legendary_windows_x64.exe",
|
||||
"sha256": "6be77857dc0a6dd33ea7442ce8b5291944ec6da53757f81ca95b57ce794baf5b"
|
||||
},
|
||||
"arm64": {
|
||||
"fileName": "legendary.exe",
|
||||
"url": "https://github.com/legendary-gl/legendary/releases/download/0.21.1/legendary_windows_arm64.exe",
|
||||
"sha256": "5ca178d75713cb92ee24daa5df1905c75f05b8b403383669ca7aa32a5809fba3"
|
||||
}
|
||||
},
|
||||
"darwin": {
|
||||
"x64": {
|
||||
"fileName": "legendary",
|
||||
"url": "https://github.com/legendary-gl/legendary/releases/download/0.21.1/legendary_macOS_x64",
|
||||
"sha256": "3dfab50277284b5bb0104f8710e4ff1d9ff00c992e44f5843fd0c977c5cc99c4"
|
||||
},
|
||||
"arm64": {
|
||||
"fileName": "legendary",
|
||||
"url": "https://github.com/legendary-gl/legendary/releases/download/0.21.1/legendary_macOS_arm64",
|
||||
"sha256": "d87978321dba9cb731fab40c72f0a30bed55baca8b5341ab21024c5733cd837e"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Loading…
Reference in a new issue