Объекты Git

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

В репозитории git всё хранится в виде объектов. Существует четыре типа: blob (содержимое файла), tree (список каталогов), commit (снимок с метаданными) и tag (аннотированная ссылка). Каждый объект идентифицируется хешем SHA-1 своего содержимого.

Типы объектов

Blob

Blob содержит исходное содержимое файла без метаданных (имени файла и прав доступа).

PHP

use Pitmaster\Object\Blob;

// Create from content
$blob = Blob::fromContent('Hello, world!');
echo $blob->content;    // 'Hello, world!'
echo $blob->size();     // 13
echo $blob->id->hex;    // SHA-1 hash
echo $blob->type->value; // 'blob' (the property is ObjectType::Blob)

Дерево

Tree — это список каталога. Каждая запись содержит режим, имя и хеш, указывающий на blob или вложенное дерево.

PHP

use Pitmaster\Object\Tree;
use Pitmaster\Object\TreeEntry;

// Read a tree
$tree = $repo->readObject($treeHash);

foreach ($tree->entries as $entry) {
    echo "{$entry->mode} {$entry->name} {$entry->hash->hex}\n";
}

// Look up a specific entry
$entry = $tree->entry('README.md');

// Create a tree (entries already in git's sort order)
$entries = [
    new TreeEntry('100644', 'README.md', $blobId),
    new TreeEntry('100755', 'deploy.sh', $execBlobId),
    new TreeEntry('40000', 'src', $subtreeId),
];

$tree = Tree::fromEntries($entries);

Tree::fromEntries() записывает записи в заданном порядке и строки режимов точно в указанном виде, поэтому сначала отсортируйте их, а для каталогов используйте режим 40000. Дерево, записанное с помощью 040000 или в другом порядке, получит хеш, отличный от хеша git. При этом git fsck --strict выводит режим с нулями в начале.

TreeEntry

TreeEntry — неизменяемый объект-значение:

PHP

use Pitmaster\Object\TreeEntry;

$entry->mode;   // '100644', '100755', '40000', '120000', '160000'
$entry->name;   // Filename
$entry->hash;   // ObjectId

// Type checks
$entry->isBlob();        // regular or executable file (mode 10xxxx)
$entry->isExecutable();  // mode 100755
$entry->isTree();        // mode 40000 (also accepts 040000)
$entry->isSymlink();     // mode 120000
$entry->isGitlink();     // mode 160000 (submodule)

Значения режимов:

Режим	Значение
`100644`	Обычный файл
`100755`	Исполняемый файл
`40000`	Каталог (tree); отображается как `040000` с помощью `git ls-tree`
`120000`	Символическая ссылка
`160000`	Gitlink (субмодуль)

Записи tree сортируются по имени; при сравнении считается, что в конце имен каталогов стоит /.

Коммит

Commit связывает дерево с историей и метаданными.

PHP

use Pitmaster\Object\Commit;

$commit = $repo->head();

$commit->id;         // ObjectId
$commit->tree;       // ObjectId of the tree
$commit->parents;    // array of ObjectId (zero for root, one for normal, two+ for merge)
$commit->author;     // 'Name <email> timestamp timezone'
$commit->committer;  // 'Name <email> timestamp timezone'
$commit->message;    // Full commit message

$commit->isMerge();  // true if two or more parents

Формирование содержимого коммита

PHP

$content = Commit::buildContent(
    tree: $treeId,
    parents: [$parentId],
    author: 'Jane <jane@example.com> 1700000000 +0000',
    committer: 'Jane <jane@example.com> 1700000000 +0000',
    message: "Add feature\n",
);

Формат данных коммита:

Код

tree <hex hash>\n
parent <hex hash>\n       (zero or more)
author <name> <<email>> <timestamp> <tz>\n
committer <name> <<email>> <timestamp> <tz>\n
\n
<message>

Тег

Аннотированные теги — это объекты с метаданными.

PHP

use Pitmaster\Object\Tag;

$tag = $repo->readObject($tagHash);

$tag->object;        // ObjectId of the target
$tag->objectType;    // ObjectType enum (ObjectType::Commit, ...)
$tag->name;          // Tag name
$tag->tagger;        // 'Name <email> timestamp timezone'
$tag->message;       // Tag message

Формат данных тега:

Код

object <hex hash>\n
type commit\n
tag <name>\n
tagger <name> <<email>> <timestamp> <tz>\n
\n
<message>

ObjectId

ObjectId — неизменяемый объект-значение, представляющий хеш SHA-1 (или SHA-256).

PHP

use Pitmaster\Object\ObjectId;
use Pitmaster\Object\ObjectType;

// From hex string
$id = ObjectId::fromHex('a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2');

// From binary (20 bytes for SHA-1, 32 for SHA-256)
$id = ObjectId::fromBinary($rawBytes);

// Compute from content
$id = ObjectId::compute(ObjectType::Blob, 'Hello, world!');
$id = ObjectId::compute(ObjectType::Blob, 'Hello, world!', 'sha256');

// Zero hash
$id = ObjectId::zero();
$id = ObjectId::zero('sha256');

// Properties
$id->hex;      // 40-character hex string (64 for SHA-256)
$id->binary;   // 20-byte raw binary (32 for SHA-256)
$id->algo;     // 'sha1' or 'sha256'
$id->isSha256();
$id->isZero();

// Comparison
$id->equals($otherId);

Хеш вычисляется по несжатым данным: sha1("{type} {size}{content}") или SHA-256 тех же байтов. fromHex() и fromBinary() выбирают алгоритм по длине.

Перечисление ObjectType

PHP

use Pitmaster\Object\ObjectType;

ObjectType::Blob;    // 'blob'
ObjectType::Tree;    // 'tree'
ObjectType::Commit;  // 'commit'
ObjectType::Tag;     // 'tag'

Формат отдельных объектов

Отдельные объекты хранятся в виде отдельных файлов в .git/objects/, упорядоченных по первым двум шестнадцатеричным символам их хеша.

Код

.git/objects/a1/b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2

Содержимое файла сжато с помощью zlib. Несжатое содержимое имеет вид:

Код

<type> <decimal size>\0<raw content>

Например, blob со строкой "Hello" хранится так:

Код

zlib_encode("blob 5\0Hello")

Чтение отдельных объектов

PHP

use Pitmaster\Storage\LooseObjectStore;

$store = new LooseObjectStore('/path/to/.git/objects');
$object = $store->read($objectId);

LooseObjectStore:

Вычисляет путь к файлу по хешу
Читает файл и распаковывает его с помощью zlib
Разбирает заголовок, чтобы извлечь тип и размер
Передает данные соответствующему анализатору (Blob, Tree, Commit, Tag)

Запись отдельных объектов

PHP

$store->write($object);

Этапы записи:

Сериализация: "{type} {size}\0{content}"
Использование id объекта, вычисленного при его создании (при чтении хеш проверяется)
Сжатие: zlib_encode(serialized)
Запись в .git/objects/{hash[0..1]}/{rest of hash}
Атомарная запись (запись во временный файл с последующим переименованием)

ObjectSerializer

ObjectSerializer кодирует и декодирует объектный формат передачи данных.

PHP

use Pitmaster\Storage\ObjectSerializer;

// Encode
$raw = ObjectSerializer::encodeRaw($object);
// "blob 5\0Hello"
$compressed = ObjectSerializer::encode($object);
// zlib-compressed form, as stored in a loose object file

// Decode
$object = ObjectSerializer::decodeRaw($raw);
$object = ObjectSerializer::decode($compressed, $expectedHex); // throws CorruptObjectException on a hash mismatch

ObjectDatabase

ObjectDatabase — составное хранилище: сначала оно ищет отдельные объекты, затем — в pack-файлах.

PHP

use Pitmaster\Storage\ObjectDatabase;

$db = new ObjectDatabase('/path/to/.git/objects');

$object = $db->read($objectId);    // Search loose, then packs
$db->write($object);               // Always writes to loose
$exists = $db->exists($objectId);  // Check loose, then packs
$all = $db->listAll();             // All hashes from loose + packs

Запись в отдельное хранилище выполняется намеренно. Позвольте git gc перепаковать объекты в pack-файлы.

Поддержка SHA-256

Pitmaster абстрагирует алгоритм хеширования через ObjectId. По умолчанию используется SHA-1. Для репозитория выбирается SHA-256 при его создании:

PHP

$repo = Pitmaster::init('/path/to/project', 'sha256');

Командная оболочка

./vendor/bin/pitmaster init --object-format=sha256

Эта операция записывает extensions.objectformat = sha256 в конфигурацию. Впоследствии открытые репозитории читают формат из этой записи, после чего все операции с объектами, деревьями, индексом и ссылками используют 64-символьные шестнадцатеричные строки и 32-байтовые двоичные хеши. Глобального переключателя или константы для алгоритма нет.

При самостоятельном создании объектов их классы принимают алгоритм как аргумент: Blob::fromContent($content, 'sha256'), Tree::fromEntries($entries, 'sha256'), ObjectId::compute($type, $content, 'sha256'). Pitmaster::clone() создает репозитории SHA-1.

Двоичный формат записей дерева

В содержимом объекта tree каждая запись кодируется так:

Код

<octal mode as ASCII> <space> <filename> \0 <binary hash: 20 bytes SHA-1, 32 bytes SHA-256>

Примечание: хеш представлен необработанными двоичными данными, а не шестнадцатеричным числом, в отличие от хешей в объектах commit и tag.

Записи сортируются путем сравнения имен, как если бы после имен каталогов стоял символ /. Для совпадения хеша дерева с результатом вычисления git порядок сортировки должен быть точным.