Przejdź do treści

Git LFS

Wyświetl jako Markdown Edytuj w GitHub Dokumentacja: bfe242f

Git Large File Storage (LFS) zastępuje duże pliki w repozytorium małymi plikami wskaźnikowymi. Rzeczywista zawartość plików jest przechowywana na osobnym serwerze LFS. Pitmaster może parsować i tworzyć wskaźniki LFS oraz komunikować się z serwerami LFS za pomocą zbiorczego API. Nie odczytuje .gitattributes ani nie uruchamia filtrów LFS clean i smudge: add() przechowuje pliki w niezmienionej postaci, a checkout() zapisuje pliki wskaźnikowe. Pobranie właściwej zawartości należy do Twojego kodu, jak pokazano poniżej.

Pliki wskaźnikowe LFS

Gdy plik jest śledzony przez LFS, git zapisuje plik wskaźnikowy zamiast właściwej zawartości:

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

Wskaźnik zawiera:

  • version: wersję specyfikacji LFS URL
  • oid: hash SHA-256 właściwej zawartości pliku (z prefiksem sha256:)
  • size: rzeczywisty rozmiar pliku w bajtach

Parsowanie wskaźników

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() zwraca null, jeśli brakuje wiersza version, oid sha256: lub size. Nie weryfikuje wartości (akceptowany jest niehexadecymalny OID lub nienumeryczny rozmiar).

Wykrywanie wskaźników

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

isPointer() sprawdza obecność pól version URL, oid sha256: i size bez pełnego parsowania.

Tworzenie wskaźników

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

Serializowanie wskaźników

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

Klient LFS

LfsClient komunikuje się z serwerami LFS za pomocą zbiorczego API (POST do <url>/objects/batch).

Tworzenie 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() działa zgodnie ze standardową konwencją: dodaje /info/lfs do git URL (dodając .git, jeśli go brakuje). Tylko adresy URL remote HTTP(S) zapewniają użyteczny LFS URL; remote w stylu SCP SSH (git@host:repo.git) nie działają.

LfsClient używa wrappera strumieniowego HTTP z PHP (musi być włączony allow_url_fopen). Nie wysyła poświadczeń i ignoruje mapę header zwracaną wraz z każdą akcją, więc działa tylko z serwerami LFS i adresami URL pamięci masowej, które nie wymagają uwierzytelniania. Nie jest powiązany z uchwytem repozytorium, więc wysyła żądania sieciowe nawet podczas pracy z repozytorium otwartym za pomocą Pitmaster::processFreeOptions().

Pobieranie plików

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

W tle download():

  1. Wysyła zbiorcze żądanie dla operacji download
  2. Otrzymuje od serwera URL pobierania
  3. Pobiera zawartość pliku z tego URL

Pobrane bajty nie są porównywane z OID ani rozmiarem.

Pobieranie zbiorcze

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

Przesyłanie plików

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

Przesyłanie wysyła zbiorcze żądanie dla operacji upload. Jeśli serwer ma już obiekt, nie zwraca URL przesyłania i operacja nic nie robi. Wynik samego żądania przesłania nie jest sprawdzany, więc niezgłoszone zostaje nieudane przesłanie, a akcja verify nie jest wywoływana.

Przesyłanie zbiorcze

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
}

Protokół zbiorczy API

Zbiorczy protokół LFS API używa JSON przez HTTP:

Żądanie

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

Odpowiedź

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

Integracja LFS z operacjami na repozytorium

Podczas odczytu repozytorium korzystającego z LFS zawartością blobów mogą być wskaźniki LFS, a nie właściwe dane plików. Aby pobrać właściwą zawartość:

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

Obsługa błędów

Nieudane lub nieprawidłowe żądanie zbiorcze oraz nieudane żądanie pobrania zgłaszają ProtocolException. download() również zgłasza wyjątek, gdy serwer nie zwróci URL pobierania dla obiektu, bez komunikatu o błędzie serwera. batchDownload() i batchUpload() nie zgłaszają wyjątków dla błędów poszczególnych obiektów; zwracają je w polu 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";
}

Właściwości wskaźników LFS

Klasa LfsPointer jest tylko do odczytu:

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