Перейти до вмісту

Git LFS

Переглянути як Markdown Редагувати на GitHub Документація для bfe242f

Git Large File Storage (LFS) замінює великі файли у вашому репозиторії невеликими файлами-покажчиками. Фактичний вміст файлів зберігається на окремому сервері LFS. Pitmaster може розбирати й створювати покажчики LFS та взаємодіяти із серверами LFS через пакетний API. Він не читає .gitattributes і не запускає фільтри очищення та відновлення LFS: add() зберігає файли як є, а checkout() записує файли-покажчики. Отримання фактичного вмісту — завдання вашого коду, як показано нижче.

Файли-покажчики LFS

Коли файл відстежується за допомогою LFS, git зберігає файл-покажчик замість фактичного вмісту:

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

Покажчик містить:

  • version: версію специфікації LFS URL
  • oid: хеш SHA-256 фактичного вмісту файла (з префіксом sha256:)
  • size: фактичний розмір файла в байтах

Розбір покажчиків

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() повертає null, якщо відсутній рядок version, oid sha256: або size. Значення не перевіряються (не hex OID або нечисловий розмір приймаються).

Виявлення покажчиків

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

isPointer() перевіряє наявність полів version URL, oid sha256: і size, не виконуючи повного розбору.

Створення покажчиків

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

Серіалізація покажчиків

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

Клієнт LFS

LfsClient взаємодіє із серверами LFS за допомогою пакетного API (POST на <url>/objects/batch).

Створення клієнта

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

Метод fromRemoteUrl() дотримується стандартної домовленості: додає /info/lfs до git URL (додаючи .git, якщо його немає). Придатний URL LFS URL дають лише віддалені репозиторії з HTTP(S); віддалені репозиторії у форматі SCP SSH (git@host:repo.git) не підходять.

LfsClient використовує потокову обгортку HTTP з PHP (потрібно ввімкнути allow_url_fopen). Він не надсилає облікових даних і ігнорує мапу header, повернену разом із кожною дією, тому працює лише із серверами LFS і URL сховищ, що не потребують автентифікації. Він не прив’язаний до дескриптора репозиторію, тож надсилає мережеві запити, навіть коли ви працюєте з репозиторієм, відкритим із Pitmaster::processFreeOptions().

Завантаження файлів

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

Усередині download() відбувається таке:

  1. Надсилається пакетний запит для операції download
  2. Від сервера надходить URL завантаження
  3. Вміст файла отримується за цим URL

Завантажені байти не перевіряються за OID або розміром.

Пакетне завантаження

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

Вивантаження файлів

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

Для вивантаження надсилається пакетний запит для операції upload. Якщо об’єкт уже є на сервері, той не повертає URL для вивантаження, і операція нічого не змінює. Результат самого запиту на вивантаження не перевіряється, тому про невдале вивантаження не повідомляється, а дія verify не викликається.

Пакетне вивантаження

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
}

Пакетний протокол API

Пакетний API LFS використовує JSON через HTTP:

Запит

Код
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}
    ]
}

Відповідь

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

Інтеграція LFS з операціями репозиторію

Під час читання репозиторію, що використовує LFS, вміст blob може бути покажчиком LFS, а не фактичними даними файла. Щоб отримати справжній вміст:

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

Обробка помилок

Невдалий або некоректний пакетний запит і невдалий запит на завантаження спричиняють ProtocolException. download() також спричиняє помилку, коли сервер не повертає URL завантаження для об’єкта; повідомлення сервера про помилку не додається. batchDownload() і batchUpload() не спричиняють помилки через помилки окремих об’єктів, а повертають їх у полі 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";
}

Властивості покажчика LFS

Клас LfsPointer незмінний:

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