Objekti Git

Prikaži kot Markdown Uredi na GitHub Dokumentacija za bfe242f

Vse v git repozitoriju je shranjeno kot objekt. Obstajajo štiri vrste: blobs (vsebina datoteke), trees (seznami imenikov), commiti (posnetki z metapodatki) in oznake (opremljene reference). Vsak objekt je določen z SHA-1 zgoščeno vrednostjo svoje vsebine.

Vrste objektov

Blob

Blob vsebuje surovo vsebino datoteke brez metapodatkov (brez imena datoteke in dovoljenj).

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 seznam imenika. Vsak vnos ima način, ime in zgoščeno vrednost, ki kaže na blob ali podrejeni tree.

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() zapiše vnose v podanem vrstnem redu in nize načinov natančno tako, kot so podani, zato jih najprej razvrstite, načine imenikov pa zapišite kot 40000. Tree, zapisan z 040000 ali v drugačnem vrstnem redu, dobi drugačno zgoščeno vrednost kot pri git, git fsck --strict pa poroča o načinu z ničlami na začetku.

TreeEntry

TreeEntry je nespremenljiv objekt vrednosti samo za branje:

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)

Vrednosti načinov:

Način	Pomen
`100644`	Navadna datoteka
`100755`	Izvedljiva datoteka
`40000`	Imenik (tree); `git ls-tree` ga prikaže kot `040000`
`120000`	Simbolna povezava
`160000`	Gitlink (podmodul)

Vnosi tree so razvrščeni po imenu; pri primerjavi se imena imenikov obravnavajo, kot da bi se končala z /.

Commit

Commit poveže tree z njegovo zgodovino in metapodatki.

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

Sestavljanje vsebine commita

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

Surova oblika commita:

Koda

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>

Oznaka

Opremljene oznake so objekti z metapodatki.

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

Surova oblika oznake:

Koda

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

ObjectId

ObjectId je nespremenljiv objekt vrednosti samo za branje, ki predstavlja zgoščeno vrednost SHA-1 (ali 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);

Zgoščena vrednost se izračuna na podlagi nestisnjenih podatkov: sha1("{type} {size}{content}") ali SHA-256 istih bajtov. fromHex() in fromBinary() izbereta algoritem glede na dolžino.

Enum ObjectType

PHP

use Pitmaster\Object\ObjectType;

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

Oblika nepripetih objektov

Nepripeti objekti so shranjeni kot posamezne datoteke v .git/objects/, razvrščene po prvih dveh šestnajstiških znakih njihove zgoščene vrednosti.

Koda

.git/objects/a1/b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2

Vsebina datoteke je stisnjena z zlib. Nestisnjena vsebina je:

Koda

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

Primer: blob z vsebino »Hello« je shranjen tako:

Koda

zlib_encode("blob 5\0Hello")

Branje nepripetih objektov

PHP

use Pitmaster\Storage\LooseObjectStore;

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

LooseObjectStore:

Izračuna pot do datoteke iz zgoščene vrednosti
Prebere in z zlib razširi datoteko
Razčleni glavo, da pridobi vrsto in velikost
Klic prepusti ustreznemu razčlenjevalniku (Blob, Tree, Commit, Tag)

Zapisovanje nepripetih objektov

PHP

$store->write($object);

Postopek zapisovanja:

Serializacija: "{type} {size}\0{content}"
Uporabi id objekta, izračunan ob njegovi izdelavi (branje preveri zgoščeno vrednost)
Stiskanje: zlib_encode(serialized)
Zapis v .git/objects/{hash[0..1]}/{rest of hash}
Atomski zapis (zapis v začasno datoteko, nato preimenovanje)

ObjectSerializer

ObjectSerializer skrbi za kodiranje in dekodiranje žične oblike objekta.

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 sestavljeno skladišče, ki najprej išče nepripete objekte, nato pa datoteke 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

Neposreden zapis v nepripeto shrambo je nameren. Pustite, da git gc preuredi objekte v datoteke pack.

Podpora za SHA-256

Pitmaster abstrahira algoritem zgoščevanja prek ObjectId. SHA-1 je privzeta možnost. SHA-256 se izbere za posamezen repozitorij ob njegovem ustvarjanju:

PHP

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

Lupina

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

To zapiše extensions.objectformat = sha256 v konfiguracijo. Pozneje odprti repozitoriji preberejo obliko iz tega vnosa, nato pa vse operacije z objekti, drevesi, indeksom in referencami uporabljajo 64-mestne šestnajstiške nize in 32-bajtne binarne zgoščene vrednosti. Za algoritem ni globalnega stikala ali konstante.

Razredi objektov sprejmejo algoritem kot argument, ko objekte ustvarite sami: Blob::fromContent($content, 'sha256'), Tree::fromEntries($entries, 'sha256'), ObjectId::compute($type, $content, 'sha256'). Pitmaster::clone() ustvari repozitorije SHA-1.

Binarna oblika vnosa tree

Vsebina objekta tree kodira vsak vnos tako:

Koda

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

Opomba: zgoščena vrednost je surova binarna vrednost, ne šestnajstiška, za razliko od šestnajstiških zgoščenih vrednosti v objektih commit in tag.

Vnosi se razvrstijo s primerjavo imen, kot da bi imena imenikov imela na koncu /. Ta vrstni red razvrščanja mora biti natančen, da se zgoščena vrednost tree ujema z izračunom git.