Objekty Git

Zobrazit jako Markdown Upravit na GitHub Dokumentace na bfe242f

Vše v úložišti git je uloženo jako objekt. Existují čtyři typy: bloby (obsah souborů), stromy (seznamy adresářů), commity (snímky s metadaty) a tagy (anotované odkazy). Každý objekt je identifikován hashem SHA-1 svého obsahu.

Typy objektů

Blob

Blob obsahuje surový obsah souboru bez metadat (bez názvu souboru a oprávnění).

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)

Strom

Strom je seznam adresáře. Každá položka obsahuje režim, název a hash odkazující na blob nebo 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 zadaném pořadí a řetězce režimů přesně podle zadání, proto je nejprve seřaďte a režimy adresářů zapisujte jako 40000. Strom zapsaný pomocí 040000 nebo v jiném pořadí bude mít jiný hash než strom v gitu a git fsck --strict uvádí režim s nulami na začátku.

TreeEntry

TreeEntry je objekt hodnoty pouze pro čtení:

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`	Běžný soubor
`100755`	Spustitelný soubor
`40000`	Adresář (strom); `git ls-tree` jej zobrazuje jako `040000`
`120000`	Symbolický odkaz
`160000`	Gitlink (submodul)

Položky stromu se řadí podle názvu; při porovnávání se s názvy adresářů zachází, jako by končily znakem /.

Commit

Commit propojuje strom s jeho historií a metadaty.

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

Sestavení 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 jsou objekty s metadaty.

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 objekt hodnoty pouze pro čtení, který představuje hash SHA-1 (nebo 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 se počítá z nekomprimovaných dat: sha1("{type} {size}{content}") nebo SHA-256 stejných bajtů. fromHex() a fromBinary() vyberou algoritmus podle délky.

Výčet ObjectType

PHP

use Pitmaster\Object\ObjectType;

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

Formát volných objektů

Volné objekty se ukládají jako jednotlivé soubory do .git/objects/ a organizují se podle prvních dvou hexadecimálních znaků svého hashe.

Kód

.git/objects/a1/b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2

Obsah souboru je komprimován pomocí zlib. Nekomprimovaný obsah má podobu:

Kód

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

Například blob obsahující „Hello“ se ukládá takto:

Kód

zlib_encode("blob 5\0Hello")

Čtení volných objektů

PHP

use Pitmaster\Storage\LooseObjectStore;

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

LooseObjectStore:

Vypočítá cestu k souboru z hashe
Načte a dekomprimuje soubor pomocí zlib
Z hlavičky načte typ a velikost
Předá data příslušnému parseru (Blob, Tree, Commit, Tag)

Zápis volných objektů

PHP

$store->write($object);

Postup zápisu:

Serializace: "{type} {size}\0{content}"
Použití id objektu, vypočítaného při jeho vytvoření (čtení hash ověřuje)
Komprese: zlib_encode(serialized)
Zápis do .git/objects/{hash[0..1]}/{rest of hash}
Atomický zápis (zápis do dočasného souboru a jeho následné přejmenování)

ObjectSerializer

ObjectSerializer zajišťuje kódování a dekódování přenosového formátu objektů.

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 složené úložiště, které nejprve prohledá volné objekty a poté soubory 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 volného úložiště je záměrný. Přenechte přebalení do souborů pack nástroji git gc.

SHA-256 podpora

Pitmaster abstrahuje algoritmus hashování prostřednictvím ObjectId. Výchozí je SHA-1. SHA-256 se volí při vytvoření každého úložiště:

PHP

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

Shell

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

Tím se do konfigurace zapíše extensions.objectformat = sha256. Později otevřená úložiště načtou formát z této položky a všechny operace s objekty, stromy, indexy a odkazy pak používají 64znakové hexadecimální řetězce a 32bajtové binární hashe. Pro algoritmus neexistuje globální přepínač ani konstanta.

Třídám objektů předáte algoritmus jako argument, pokud objekty vytváříte sami: Blob::fromContent($content, 'sha256'), Tree::fromEntries($entries, 'sha256'), ObjectId::compute($type, $content, 'sha256'). Pitmaster::clone() vytváří úložiště SHA-1.

Binární formát položky stromu

V obsahu objektu stromu se 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 surová binární hodnota, nikoli hexadecimální, na rozdíl od hexadecimálních hashů v objektech commit a tag.

Položky se řadí porovnáním názvů, jako by adresáře měly na konci /. Toto pořadí musí přesně odpovídat výpočtu hashe stromu v gitu.