Přejít k obsahu

Git LFS

Zobrazit jako Markdown Upravit na GitHub Dokumentace na bfe242f

Git Large File Storage (LFS) nahrazuje velké soubory v repozitáři malými soubory s ukazateli. Skutečný obsah souborů se ukládá na samostatném serveru LFS. Pitmaster umí parsovat a vytvářet ukazatele LFS a komunikovat se servery LFS prostřednictvím dávkového API. Nečte .gitattributes ani nespouští filtry clean a smudge LFS: add() ukládá soubory beze změny a checkout() zapisuje soubory s ukazateli. Načtení skutečného obsahu zajišťuje váš kód, jak ukazuje následující příklad.

Soubory s ukazateli LFS

Když je soubor sledován pomocí LFS, git místo skutečného obsahu ukládá soubor s ukazatelem:

Kód
version https://git-lfs.github.com/spec/v1
oid sha256:4d7a214614ab2935c943f9e0ff69d22eadbb8f32b1258daaa5e2ca24d17e2393
size 12345

Ukazatel obsahuje:

  • version: verzi specifikace LFS URL
  • oid: hash SHA-256 skutečného obsahu souboru (s předponou sha256:)
  • size: skutečnou velikost souboru v bajtech

Parsování ukazatelů

PHP
use Pitmaster\Lfs\LfsPointer;

$content = file_get_contents('.git-lfs-tracked-file');
$pointer = LfsPointer::parse($content);

if ($pointer !== null) {
    echo "OID: {$pointer->oid}\n";
    echo "Size: {$pointer->size}\n";
    echo "Version: {$pointer->version}\n";
}

parse() vrátí null, pokud chybí řádek version, oid sha256: nebo size. Hodnoty neověřuje (přijme i nehexadecimální OID nebo nečíselnou velikost).

Detekce ukazatelů

PHP
if (LfsPointer::isPointer($blobContent)) {
    // This blob is an LFS pointer, not actual file content
    $pointer = LfsPointer::parse($blobContent);
}

isPointer() kontroluje přítomnost polí version URL, oid sha256: a size bez úplného parsování.

Vytváření ukazatelů

PHP
// From known OID and size
$pointer = new LfsPointer(
    oid: '4d7a214614ab2935c943f9e0ff69d22eadbb8f32b1258daaa5e2ca24d17e2393',
    size: 12345,
);

// From file content (computes SHA-256 hash)
$pointer = LfsPointer::forContent($actualFileContent);

echo $pointer->oid;   // SHA-256 hash
echo $pointer->size;  // Content length

Serializace ukazatelů

PHP
$content = $pointer->serialize();
// "version https://git-lfs.github.com/spec/v1\noid sha256:4d7a21...\nsize 12345\n"

Klient LFS

LfsClient komunikuje se servery LFS pomocí dávkového API (POST na <url>/objects/batch).

Vytvoření klienta

PHP
use Pitmaster\Lfs\LfsClient;

// From a git remote URL (appends /info/lfs)
$client = LfsClient::fromRemoteUrl('https://github.com/user/repo.git');
// LFS URL: https://github.com/user/repo.git/info/lfs

// Direct URL
$client = new LfsClient('https://lfs.example.com/repo', timeout: 60);

Metoda fromRemoteUrl() se řídí běžnou konvencí: přidá /info/lfs ke git URL (a doplní .git, pokud chybí). Použitelnou LFS URL poskytují pouze vzdálené adresy URL ve formátu HTTP(S); vzdálené adresy SSH ve stylu SCP (git@host:repo.git) ji neposkytují.

LfsClient používá obalovací stream HTTP z PHP (musí být povoleno allow_url_fopen). Neposílá žádné přihlašovací údaje a ignoruje mapu header vrácenou u každé akce, takže funguje pouze se servery LFS a adresami úložišť, které nevyžadují ověření. Není navázán na instanci repozitáře, takže odesílá síťové požadavky i při práci s repozitářem otevřeným pomocí Pitmaster::processFreeOptions().

Stahování souborů

PHP
// Single file download
$content = $client->download($pointer->oid, $pointer->size);
file_put_contents('large-file.bin', $content);

Na pozadí download():

  1. Odešle dávkový požadavek pro operaci download
  2. Přijme od serveru adresu URL ke stažení URL
  3. Načte obsah souboru z této adresy URL

Stažené bajty se neověřují vůči OID ani velikosti.

Dávkové stahování

PHP
$results = $client->batchDownload([
    ['oid' => 'abc123...', 'size' => 12345],
    ['oid' => 'def456...', 'size' => 67890],
]);

foreach ($results as $result) {
    if ($result['error'] !== null) {
        echo "Error: {$result['error']}\n";
        continue;
    }

    if ($result['href'] !== null) {
        // Download from $result['href']
    }
}

Nahrávání souborů

PHP
$client->upload($pointer->oid, $pointer->size, $fileContent);

Nahrávání odešle dávkový požadavek pro operaci upload. Pokud server objekt již má, nevrátí adresu URL pro nahrání URL a operace se neprovede. Výsledek samotného požadavku na nahrání se neověřuje, takže neúspěšné nahrání se neohlásí a akce verify se nevolá.

Dávkové nahrávání

PHP
$results = $client->batchUpload([
    ['oid' => 'abc123...', 'size' => 12345],
]);

foreach ($results as $result) {
    if ($result['href'] !== null) {
        // Server needs this object, upload to $result['href']
    }
    // No href means server already has it
}

Protokol dávkového API

Dávkové API LFS používá JSON přes HTTP:

Požadavek

Kód
POST <lfs-url>/objects/batch
Content-Type: application/vnd.git-lfs+json
Accept: application/vnd.git-lfs+json

{
    "operation": "download",
    "transfers": ["basic"],
    "objects": [
        {"oid": "abc123...", "size": 12345}
    ]
}

Odpověď

JSON
{
    "objects": [
        {
            "oid": "abc123...",
            "size": 12345,
            "actions": {
                "download": {
                    "href": "https://storage.example.com/abc123...",
                    "header": {
                        "Authorization": "Bearer token"
                    }
                }
            }
        }
    ]
}

Integrace LFS s operacemi repozitáře

Při čtení repozitáře, který používá LFS, může obsah blobů tvořit ukazatel LFS namísto skutečných dat souboru. Skutečný obsah získáte takto:

PHP
$blob = $repo->readObject($hash);

if (LfsPointer::isPointer($blob->content)) {
    $pointer = LfsPointer::parse($blob->content);
    $remoteUrl = $repo->config()->get('remote.origin.url');
    $client = LfsClient::fromRemoteUrl($remoteUrl);
    $realContent = $client->download($pointer->oid, $pointer->size);
} else {
    $realContent = $blob->content;
}

Zpracování chyb

Neúspěšný nebo neplatný dávkový požadavek a neúspěšný požadavek na stažení vyvolají ProtocolException. download() vyvolá chybu také v případě, že server pro objekt nevrátí adresu URL ke stažení URL, a nezobrazí přitom chybovou zprávu serveru. batchDownload() ani batchUpload() nevyvolávají chybu při chybách jednotlivých objektů; vracejí je v poli error.

PHP
use Pitmaster\Exceptions\ProtocolException;

try {
    $content = $client->download($oid, $size);
} catch (ProtocolException $e) {
    // Server unreachable, invalid response, no download URL
    echo "LFS error: {$e->getMessage()}\n";
}

Vlastnosti ukazatele LFS

Třída LfsPointer je pouze pro čtení:

PHP
$pointer->oid;      // string: SHA-256 hash (hex)
$pointer->size;     // int: file size in bytes
$pointer->version;  // string: spec version URL