Objetos Git

Ver como Markdown Editar en GitHub Documentación de bfe242f

Todo en un repositorio de git se almacena como un objeto. Hay cuatro tipos: blobs (contenido de archivos), árboles (listados de directorios), commits (instantáneas con metadatos) y etiquetas (referencias anotadas). Cada objeto se identifica mediante el hash SHA-1 de su contenido.

Tipos de objeto

Blob

Un blob contiene contenido de archivo sin procesar y sin metadatos (sin nombre de archivo ni permisos).

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)

Árbol

Un árbol es un listado de directorio. Cada entrada tiene un modo, un nombre y un hash que apunta a un blob o subárbol.

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() escribe las entradas en el orden indicado y las cadenas de modo exactamente como se proporcionan, así que ordénelas primero y escriba los modos de directorio como 40000. Un árbol escrito con 040000 o en otro orden obtiene un hash distinto al de git, y git fsck --strict muestra el modo con ceros a la izquierda.

TreeEntry

TreeEntry es un objeto de valor de solo lectura:

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`	Archivo normal
`100755`	Archivo ejecutable
`40000`	Directorio (árbol); se muestra como `040000` mediante `git ls-tree`
`120000`	Enlace simbólico
`160000`	Gitlink (submódulo)

Las entradas del árbol se ordenan por nombre, tratando los nombres de directorio como si terminaran en / a efectos de comparación.

Commit

Un commit vincula un árbol con su historial y sus metadatos.

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

Construir el contenido del 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 del commit sin procesar:

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>

Etiqueta

Las etiquetas anotadas son objetos con metadatos.

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 de etiqueta sin procesar:

Código

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

ObjectId

ObjectId es un objeto de valor de solo lectura que representa un hash SHA-1 (o 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);

El hash se calcula sobre los datos sin comprimir: sha1("{type} {size}{content}") o SHA-256 de los mismos bytes. fromHex() y fromBinary() eligen el algoritmo según la longitud.

Enumeración ObjectType

PHP

use Pitmaster\Object\ObjectType;

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

Formato de objetos sueltos

Los objetos sueltos se almacenan como archivos individuales en .git/objects/, organizados por los dos primeros caracteres hexadecimales de su hash.

Código

.git/objects/a1/b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2

El contenido del archivo está comprimido con zlib. El contenido descomprimido es:

Código

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

Por ejemplo, un blob que contiene «Hello» se almacena así:

Código

zlib_encode("blob 5\0Hello")

Leer objetos sueltos

PHP

use Pitmaster\Storage\LooseObjectStore;

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

El LooseObjectStore:

Calcula la ruta del archivo a partir del hash
Lee y descomprime el archivo con zlib
Analiza el encabezado para extraer el tipo y el tamaño
Delega en el analizador correspondiente (Blob, Tree, Commit, Tag)

Escribir objetos sueltos

PHP

$store->write($object);

El proceso de escritura:

Serializar: "{type} {size}\0{content}"
Usar el id del objeto, calculado al construirlo (las lecturas verifican el hash)
Comprimir: zlib_encode(serialized)
Escribir en .git/objects/{hash[0..1]}/{rest of hash}
Escritura atómica (escribir en un archivo temporal y luego renombrarlo)

ObjectSerializer

El ObjectSerializer se encarga de codificar y decodificar el formato de objeto en el flujo binario.

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

El ObjectDatabase es un almacén compuesto que busca primero objetos sueltos y luego archivos 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

La escritura directa en el almacenamiento de objetos sueltos es intencional. Deje que git gc los reempaquete en archivos pack.

Compatibilidad con SHA-256

Pitmaster abstrae el algoritmo hash mediante ObjectId. SHA-1 es el predeterminado. SHA-256 se elige por repositorio al crearlo:

PHP

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

Shell

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

Esto escribe extensions.objectformat = sha256 en la configuración. Los repositorios que se abran más adelante leen el formato de esa entrada, y todas las operaciones de objetos, árboles, índices y refs usan entonces cadenas hexadecimales de 64 caracteres y hashes binarios de 32 bytes. No hay un interruptor global ni una constante para el algoritmo.

Las clases de objeto reciben el algoritmo como argumento cuando se crean objetos manualmente: Blob::fromContent($content, 'sha256'), Tree::fromEntries($entries, 'sha256'), ObjectId::compute($type, $content, 'sha256'). Pitmaster::clone() crea repositorios SHA-1.

Formato binario de las entradas del árbol

Dentro del contenido de un objeto árbol, cada entrada se codifica así:

Código

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

Nota: el hash es binario sin procesar, no hexadecimal, a diferencia de los hashes hexadecimales de los objetos commit y tag.

Las entradas se ordenan comparando los nombres como si los directorios tuvieran un / al final. Este orden debe ser exacto para que el hash del árbol coincida con el cálculo de git.