Перейти к содержимому

Git LFS

Просмотреть как Markdown Редактировать на GitHub Документация по bfe242f

Git Large File Storage (LFS) заменяет большие файлы в репозитории небольшими файлами-указателями. Фактическое содержимое хранится на отдельном сервере LFS. Pitmaster может разбирать и создавать указатели LFS, а также взаимодействовать с серверами LFS через пакетный протокол API. Он не читает .gitattributes и не запускает фильтры clean и smudge 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. Значения не проверяются (принимаются и не шестнадцатеричный 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, если его ещё нет). Использовать клиент 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 URL для загрузки
  3. Загружает содержимое файла по этому URL 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 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

Пакетный протокол LFS API использует 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 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