Git objektid

Vaata Markdownina Muuda teenuses GitHub Dokumentatsioon: bfe242f

Kõik git-hoidlas salvestatakse objektina. Neid on nelja tüüpi: blobid (faili sisu), puud (kataloogide loendid), commit’id (metaandmetega hetktõmmised) ja sildid (kommenteeritud viited). Iga objekti tuvastab selle sisu SHA-1 räsi.

Objektitüübid

Blob

Blob sisaldab töötlemata failisisu ilma metaandmeteta (failinime ja õigusteta).

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)

Puu

Puu on kataloogi loend. Igal kirjel on režiim, nimi ja räsi, mis viitab blob-objektile või alampuule.

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() kirjutab kirjed antud järjekorras ja režiimistringid täpselt etteantud kujul, seega sortige need esmalt ning kirjutage kataloogirežiimid kujul 40000. 040000 abil või teises järjekorras kirjutatud puu saab git-i omast erineva räsi ning git fsck --strict kuvab nullidega täidetud režiimi.

TreeEntry

TreeEntry on kirjutuskaitstud väärtusobjekt:

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)

Režiimiväärtused:

Režiim	Tähendus
`100644`	Tavaline fail
`100755`	Käivitatav fail
`40000`	Kataloog (puu); `git ls-tree` kuvab selle kujul `040000`
`120000`	Sümbollink
`160000`	Gitlink (alamoodul)

Puu kirjed sorditakse nime järgi, käsitledes katalooginimesid võrdlemisel nii, nagu lõppeksid need märgiga /.

Commit

Commit seob puu selle ajaloo ja metaandmetega.

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’i sisu koostamine

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’i töötlemata vorming:

Kood

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>

Silt

Kommenteeritud sildid on metaandmetega objektid.

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

Sildi töötlemata vorming:

Kood

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

ObjectId

ObjectId on kirjutuskaitstud väärtusobjekt, mis esindab SHA-1 (või SHA-256) räsi.

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

Räsi arvutatakse pakkimata andmete põhjal: sha1("{type} {size}{content}") ehk samade baitide SHA-256. fromHex() ja fromBinary() valivad algoritmi pikkuse alusel.

ObjectType enum

PHP

use Pitmaster\Object\ObjectType;

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

Lahtiste objektide vorming

Lahtised objektid salvestatakse üksikute failidena asukohta .git/objects/ ning korraldatakse räsi kahe esimese kuueteistkümnendmärgi järgi.

Kood

.git/objects/a1/b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2

Faili sisu on zlib-iga tihendatud. Pakkimata sisu on järgmine:

Kood

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

Näiteks salvestatakse „Hello“ sisaldav blob järgmiselt:

Kood

zlib_encode("blob 5\0Hello")

Lahtiste objektide lugemine

PHP

use Pitmaster\Storage\LooseObjectStore;

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

LooseObjectStore:

Arvutab räsi põhjal failitee
Loeb faili ja pakib selle zlib-iga lahti
Parsib päise, et eraldada tüüp ja suurus
Suunab andmed sobivale parserile (Blob, Tree, Commit, Tag)

Lahtiste objektide kirjutamine

PHP

$store->write($object);

Kirjutamise käik:

Serialiseerimine: "{type} {size}\0{content}"
Kasutatakse objekti id, mis arvutati objekti loomisel (lugemisel kontrollitakse räsi)
Tihendamine: zlib_encode(serialized)
Kirjutamine asukohta .git/objects/{hash[0..1]}/{rest of hash}
Aatomkirjutamine (kirjutatakse ajutisse faili ja nimetatakse seejärel ümber)

ObjectSerializer

ObjectSerializer haldab objekti juhtvormingus kodeerimist ja dekodeerimist.

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 on liitandmehoidla, mis otsib esmalt lahtisi objekte ja seejärel pakifaile.

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

Lahtisesse salvestuskohta kirjutamine on tahtlik. Laske git gc-l objektid tõhusamaks salvestamiseks pakifailidesse ümber pakkida.

SHA-256 tugi

Pitmaster abstraheerib räsialgoritmi ObjectId abil. Vaikimisi kasutatakse SHA-1. SHA-256 valitakse hoidla loomisel:

PHP

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

Shell

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

See kirjutab konfiguratsiooni extensions.objectformat = sha256. Hiljem avatud hoidlad loevad vormingu sellest kirjest ning seejärel kasutavad kõik objektide, puude, indeksite ja viidete toimingud 64-märgilisi kuueteistkümnendstringe ja 32-baidiseid binaarräsisid. Algoritmi jaoks puudub globaalne lüliti või konstant.

Objekti ise koostades tuleb objektiklassidele algoritm argumendina anda: Blob::fromContent($content, 'sha256'), Tree::fromEntries($entries, 'sha256'), ObjectId::compute($type, $content, 'sha256'). Pitmaster::clone() loob SHA-1 hoidlaid.

Puu kirje binaarvorming

Puuobjekti sisus kodeeritakse iga kirje järgmiselt:

Kood

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

Märkus: räsi on töötlemata binaarandmed, mitte kuueteistkümnendkuju, erinevalt commit- ja sildiobjektide kuueteistkümnendräsidest.

Kirjed sorditakse, võrreldes nimesid nii, nagu oleks katalooginimede lõpus /. See järjestus peab olema täpne, et puu räsi vastaks git-i arvutatud räsile.