Обекти Git

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

Всичко в git хранилище се съхранява като обект. Има четири типа: blobs (съдържание на файлове), trees (списъци с директории), commits (моментни състояния с метаданни) и tags (анотирани препратки). Всеки обект се идентифицира чрез 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

Създаване на съдържанието на commit

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

Необработен формат на commit:

Код

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>

Етикет

Анотираните tag-ове са обекти с метаданни.

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

Необработен формат на tag:

Код

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 в конфигурацията. Хранилищата, отворени по-късно, прочитат формата от този запис и след това всички операции с обекти, дървета, индекси и refs използват 64-знакови шестнадесетични низове и 32-байтови двоични хешове. Няма глобална настройка или константа за алгоритъма.

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

Двоичен формат на записите в Tree

В съдържанието на обект Tree всеки запис се кодира така:

Код

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

Забележка: хешът е в суров двоичен формат, а не шестнадесетичен, за разлика от шестнадесетичните хешове в обектите commit и tag.

Записите се сортират чрез сравнение на имената, като се приема, че имената на директориите завършват с /. Този ред на сортиране трябва да е точен, за да съвпадне хешът на дървото с изчислението на git.