Preskočiť na obsah

Git LFS

Zobraziť ako Markdown Upraviť na GitHub Dokumentácia na bfe242f

Git Veľké súbory v úložisku (LFS) nahrádza v repozitári malými súbormi ukazovateľov. Skutočný obsah súborov sa ukladá na samostatnom serveri LFS. Pitmaster dokáže analyzovať a vytvárať ukazovatele LFS a komunikovať so servermi LFS prostredníctvom dávkového API. Nečíta .gitattributes ani nespúšťa filtre LFS clean a smudge: add() ukladá súbory v nezmenenej podobe a checkout() zapisuje súbory ukazovateľov. Načítanie skutočného obsahu je na vašom kóde, ako ukazuje príklad nižšie.

Súbory ukazovateľov LFS

Keď je súbor sledovaný pomocou LFS, git namiesto skutočného obsahu uloží súbor ukazovateľa:

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

Ukazovateľ obsahuje:

  • version: verziu špecifikácie LFS URL
  • oid: hašovací súčet SHA-256 skutočného obsahu súboru (s predponou sha256:)
  • size: skutočnú veľkosť súboru v bajtoch

Analýza ukazovateľov

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áti null, ak chýba riadok version, oid sha256: alebo size. Hodnoty neoveruje (akceptuje aj nehexadecimálne OID a nenumerickú veľkosť).

Rozpoznávanie ukazovateľov

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

isPointer() kontroluje prítomnosť polí version URL, oid sha256: a size bez úplnej analýzy.

Vytváranie ukazovateľov

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

Serializácia ukazovateľov

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

Klient LFS

LfsClient komunikuje so servermi LFS pomocou dávkového API (odoslanie POST na <url>/objects/batch).

Vytvorenie 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);

Metóda fromRemoteUrl() sa riadi štandardným postupom: k git URL pripojí /info/lfs (ak chýba, doplní aj .git). Použiteľný LFS URL poskytujú iba vzdialené adresy URL typu HTTP(S); vzdialené repozitáre v štýle SCP SSH (git@host:repo.git) ho neposkytujú.

LfsClient používa obalový prúd HTTP od PHP (musí byť povolené allow_url_fopen). Neposiela prihlasovacie údaje a ignoruje mapu header vrátenú pri každej akcii, preto funguje iba so servermi LFS a adresami URL úložísk, ktoré nevyžadujú autentifikáciu. Nie je naviazaný na objekt repozitára, takže odosiela sieťové požiadavky aj pri práci s repozitárom otvoreným pomocou Pitmaster::processFreeOptions().

Sťahovanie súborov

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

Vnútorne download():

  1. Odošle dávkovú požiadavku na operáciu download
  2. Dostane od servera URL na stiahnutie
  3. Získa obsah súboru z tejto URL

Stiahnuté bajty sa neporovnávajú s OID ani veľkosťou.

Dávkové sťahovanie

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ávanie súborov

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

Nahrávanie odošle dávkovú požiadavku na operáciu upload. Ak server objekt už má, nevráti URL na nahratie a operácia neurobí nič. Výsledok samotnej požiadavky na nahratie sa nekontroluje, preto sa prípadné zlyhanie nenahlási a akcia verify sa nevolá.

Dávkové nahrávanie

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žíva JSON cez HTTP:

Požiadavka

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}
    ]
}

Odpoveď

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

Integrácia LFS s operáciami repozitára

Pri čítaní repozitára, ktorý používa LFS, môže obsah objektu blob predstavovať ukazovateľ LFS namiesto skutočných údajov súboru. Skutočný obsah získate 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;
}

Spracovanie chýb

Neúspešná alebo neplatná dávková požiadavka a neúspešná požiadavka na stiahnutie vyvolajú ProtocolException. download() ho vyvolá aj vtedy, keď server pre objekt nevráti URL na stiahnutie; správa servera o chybe sa nezobrazí. batchDownload() a batchUpload() nevyvolávajú výnimku pri chybách jednotlivých objektov, ale vrátia ich 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 ukazovateľa LFS

Trieda LfsPointer umožňuje iba čítanie:

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