Objetos Git

Ver como Markdown Editar no GitHub Documentação em bfe242f

Tudo em um repositório git é armazenado como um objeto. Há quatro tipos: blobs (conteúdo de arquivos), trees (listagens de diretórios), commits (snapshots com metadados) e tags (referências anotadas). Cada objeto é identificado pelo hash SHA-1 de seu conteúdo.

Tipos de objeto

Blob

Um blob contém o conteúdo bruto de um arquivo, sem metadados (sem nome de arquivo ou permissões).

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

Uma tree é uma listagem de diretório. Cada entrada tem um modo, um nome e um hash que aponta para um blob ou uma subárvore.

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() grava as entradas na ordem fornecida e as strings de modo exatamente como fornecidas; portanto, ordene-as primeiro e grave os modos de diretório como 40000. Uma tree gravada com 040000 ou em outra ordem recebe um hash diferente do calculado por git, e git fsck --strict informa o modo preenchido com zeros à esquerda.

TreeEntry

TreeEntry é um objeto de valor somente para leitura:

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)

Valores de modo:

Modo	Significado
`100644`	Arquivo regular
`100755`	Arquivo executável
`40000`	Diretório (tree); exibido como `040000` por `git ls-tree`
`120000`	Link simbólico
`160000`	Gitlink (submódulo)

As entradas de tree são ordenadas pelo nome, considerando os nomes de diretório como se terminassem com / para fins de comparação.

Commit

Um commit vincula uma tree ao seu histórico e metadados.

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

Construindo o conteúdo do 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",
);

Formato bruto do commit:

Código

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

Tags anotadas são objetos com metadados.

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

Formato bruto da tag:

Código

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

ObjectId

ObjectId é um objeto de valor somente para leitura que representa um hash SHA-1 (ou 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);

O hash é calculado sobre os dados descompactados: sha1("{type} {size}{content}"), ou SHA-256 dos mesmos bytes. fromHex() e fromBinary() escolhem o algoritmo com base no comprimento.

Enum ObjectType

PHP

use Pitmaster\Object\ObjectType;

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

Formato de objeto solto

Objetos soltos são armazenados como arquivos individuais em .git/objects/, organizados pelos dois primeiros caracteres hexadecimais do hash.

Código

.git/objects/a1/b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2

O conteúdo do arquivo é compactado com zlib. O conteúdo descompactado é:

Código

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

Por exemplo, um blob contendo "Hello" é armazenado como:

Código

zlib_encode("blob 5\0Hello")

Lendo objetos soltos

PHP

use Pitmaster\Storage\LooseObjectStore;

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

O LooseObjectStore:

Calcula o caminho do arquivo a partir do hash
Lê e descompacta o arquivo com zlib
Analisa o cabeçalho para extrair o tipo e o tamanho
Encaminha ao analisador apropriado (Blob, Tree, Commit, Tag)

Gravando objetos soltos

PHP

$store->write($object);

O processo de gravação:

Serializar: "{type} {size}\0{content}"
Usar o id do objeto, calculado quando ele foi criado (as leituras verificam o hash)
Compactar: zlib_encode(serialized)
Gravar em .git/objects/{hash[0..1]}/{rest of hash}
Gravação atômica (gravar em um arquivo temporário e depois renomeá-lo)

ObjectSerializer

O ObjectSerializer trata da codificação e decodificação do formato de transmissão do objeto.

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

O ObjectDatabase é um armazenamento composto que pesquisa primeiro objetos soltos e depois arquivos 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

A gravação direta no armazenamento solto é intencional. Deixe git gc reempacotar para otimizar o armazenamento.

Suporte a SHA-256

Pitmaster abstrai o algoritmo de hash por meio de ObjectId. SHA-1 é o padrão. SHA-256 é escolhido por repositório quando ele é criado:

PHP

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

Shell

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

Isso grava extensions.objectformat = sha256 na configuração. Repositórios abertos posteriormente leem o formato dessa entrada, e todas as operações de objeto, tree, índice e ref passam então a usar strings hexadecimais de 64 caracteres e hashes binários de 32 bytes. Não há uma chave global nem uma constante para o algoritmo.

As classes de objeto recebem o algoritmo como argumento quando você mesmo cria objetos: Blob::fromContent($content, 'sha256'), Tree::fromEntries($entries, 'sha256'), ObjectId::compute($type, $content, 'sha256'). Pitmaster::clone() cria repositórios SHA-1.

Formato binário de entrada de tree

No conteúdo de um objeto tree, cada entrada é codificada como:

Código

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

Observação: o hash é binário bruto, não hexadecimal, ao contrário dos hashes hexadecimais em objetos commit e tag.

As entradas são ordenadas comparando os nomes como se os diretórios tivessem / no final. Essa ordem de classificação deve ser exata para que o hash da tree corresponda ao cálculo de git.