Objekty Git

Zobraziť ako Markdown Upraviť na GitHub Dokumentácia na bfe242f

Všetko v repozitári git sa ukladá ako objekt. Existujú štyri typy: bloby (obsah súborov), stromy (zoznamy adresárov), commity (snímky so metadátami) a tagy (označené referencie). Každý objekt je identifikovaný hašom SHA-1 svojho obsahu.

Typy objektov

Blob

Blob obsahuje surový obsah súboru bez metadát (bez názvu súboru a oprávnení).

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

Tree je zoznam adresára. Každá položka obsahuje režim, názov a hash odkazujúci na blob alebo podstrom.

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() zapisuje položky v zadanom poradí a reťazce režimov presne v zadanom tvare, preto ich najprv zoraďte a režimy adresárov zapisujte ako 40000. Strom zapísaný pomocou 040000 alebo v inom poradí má iný hash než strom git a git fsck --strict zobrazuje režim doplnený nulami zľava.

TreeEntry

TreeEntry je nemenný objekt s hodnotou:

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)

Hodnoty režimu:

Režim	Význam
`100644`	Bežný súbor
`100755`	Spustiteľný súbor
`40000`	Adresár (strom); `git ls-tree` ho zobrazuje ako `040000`
`120000`	Symbolický odkaz
`160000`	Gitlink (submodul)

Položky stromu sa zoraďujú podľa názvu; pri porovnávaní sa s názvami adresárov zaobchádza, akoby sa končili znakom /.

Commit

Commit spája strom s jeho históriou a metadátami.

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

Vytváranie obsahu commitu

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

Surový formát commitu:

Kód

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

Anotované tagy sú objekty s metadátami.

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

Surový formát tagu:

Kód

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

ObjectId

ObjectId je nemenný objekt s hodnotou, ktorá predstavuje hash SHA-1 (alebo 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);

Hash sa počíta z nekomprimovaných údajov: sha1("{type} {size}{content}") alebo SHA-256 rovnakých bajtov. fromHex() a fromBinary() vyberajú algoritmus podľa dĺžky.

Výpočetný typ ObjectType

PHP

use Pitmaster\Object\ObjectType;

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

Formát voľných objektov

Voľné objekty sa ukladajú ako samostatné súbory v .git/objects/ a usporadúvajú sa podľa prvých dvoch hexadecimálnych znakov svojho hashu.

Kód

.git/objects/a1/b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2

Obsah súboru je komprimovaný pomocou zlib. Nekomprimovaný obsah má tento tvar:

Kód

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

Napríklad blob obsahujúci „Hello“ sa ukladá takto:

Kód

zlib_encode("blob 5\0Hello")

Čítanie voľných objektov

PHP

use Pitmaster\Storage\LooseObjectStore;

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

LooseObjectStore:

Vypočíta cestu k súboru z hashu
Načíta súbor a dekomprimuje ho pomocou zlib
Analyzuje hlavičku a získa z nej typ a veľkosť
Odovzdá spracovanie príslušnému analyzátoru (Blob, Tree, Commit, Tag)

Zápis voľných objektov

PHP

$store->write($object);

Postup zápisu:

Serializácia: "{type} {size}\0{content}"
Použitie hodnoty id objektu, vypočítanej pri jeho vytvorení (pri čítaní sa hash overuje)
Kompresia: zlib_encode(serialized)
Zápis do .git/objects/{hash[0..1]}/{rest of hash}
Atomický zápis (zápis do dočasného súboru a následné premenovanie)

ObjectSerializer

ObjectSerializer zabezpečuje kódovanie a dekódovanie objektov v prenosovom formáte.

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 je zložené úložisko, ktoré najprv vyhľadáva voľné objekty a potom súbory 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

Zápis do voľného úložiska je zámerný. Nechajte git gc, aby objekty zbalil do súborov pack.

SHA-256 podpora

Pitmaster abstrahuje hašovací algoritmus prostredníctvom ObjectId. SHA-1 je predvolený. SHA-256 sa vyberá pre každý repozitár pri jeho vytvorení:

PHP

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

Shell

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

Týmto sa zapíše extensions.objectformat = sha256 do konfigurácie. Neskôr otvorené repozitáre načítajú formát z tejto položky a všetky operácie s objektmi, stromami, indexom a referenciami potom používajú 64-znakové hexadecimálne reťazce a 32-bajtové binárne hashe. Pre tento algoritmus neexistuje globálny prepínač ani konštanta.

Pri vlastnom vytváraní objektov sa hašovací algoritmus zadáva ako argument tried objektov: Blob::fromContent($content, 'sha256'), Tree::fromEntries($entries, 'sha256'), ObjectId::compute($type, $content, 'sha256'). Pitmaster::clone() vytvára repozitáre SHA-1.

Binárny formát položiek stromu

V obsahu objektu Tree sa každá položka kóduje takto:

Kód

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

Poznámka: hash je v surovej binárnej podobe, nie v hexadecimálnom zápise ako pri objektoch commit a tag.

Položky sa zoraďujú porovnávaním názvov, akoby za názvom každého adresára nasledoval znak /. Toto poradie musí byť presné, aby sa hash stromu zhodoval s výpočtom v git.