Lettura dei repository

Visualizza come Markdown Modifica su GitHub Documentazione di bfe242f

Pitmaster legge i repository git analizzando direttamente i formati su disco: oggetti loose (file compressi con zlib in .git/objects/), file pack (.git/objects/pack/), riferimenti (file in .git/refs/ e packed-refs) e l'indice (.git/index).

Apertura di un repository

PHP

use Pitmaster\Pitmaster;

$repo = Pitmaster::open('/path/to/project');

Pitmaster supporta tre layout di repository:

Repository regolari: .git è una directory nella radice del progetto.
Worktree collegati: .git è un file che contiene gitdir: <path>, che punta a .git/worktrees/<name>/.
Repository bare: il percorso stesso contiene HEAD, objects/ ecc.

PHP

// Detection helpers
Pitmaster::isRepository('/path');  // true for any of the above
Pitmaster::isWorktree('/path');    // true only for linked worktrees

Lettura degli oggetti

Ogni dato in un repository git è memorizzato come oggetto identificato dal proprio hash: SHA-1 (40 caratteri esadecimali) per impostazione predefinita oppure SHA-256 (64 caratteri esadecimali) nei repository creati con Pitmaster::init($path, 'sha256'). Esistono quattro tipi di oggetto: blob, tree, commit e tag.

I metodi basati sull'hash qui sotto richiedono l'hash esadecimale completo; gli hash abbreviati non sono accettati.

readObject

PHP

use Pitmaster\Object\Blob;
use Pitmaster\Object\Tree;
use Pitmaster\Object\Commit;
use Pitmaster\Object\Tag;

$object = $repo->readObject('a1b2c3d4e5f6...');

match (true) {
    $object instanceof Blob   => handleBlob($object),
    $object instanceof Tree   => handleTree($object),
    $object instanceof Commit => handleCommit($object),
    $object instanceof Tag    => handleTag($object),
};

Gli oggetti vengono cercati prima nell'archivio loose, poi nei file pack. Le ricerche nei file pack usano la tabella di fan-out .idx per la ricerca binaria O(log n).

catFile

Per recuperare contenuti in modo semplice senza verificare il tipo:

PHP

$content = $repo->catFile('a1b2c3d4e5f6...');
echo $content;

objectExists

PHP

if ($repo->objectExists('a1b2c3d4e5f6...')) {
    // Object is in the repository
}

listObjects

PHP

$hashes = $repo->listObjects();
// ['a1b2c3d4...', 'f6e5d4c3...', ...]

Restituisce gli hash esadecimali di tutti gli oggetti (loose e impacchettati).

Uso dei blob

Un blob contiene il contenuto grezzo di un file.

PHP

$blob = $repo->readObject($hash);
echo $blob->content;     // Raw file bytes
echo $blob->size();      // Content length
echo $blob->id->hex;     // Object hash

Uso degli alberi

Un tree è un elenco di directory. Ogni voce contiene una modalità, un nome e un hash.

PHP

$tree = $repo->readObject($hash);

foreach ($tree->entries as $entry) {
    echo "{$entry->mode} {$entry->name} {$entry->hash->hex}\n";
    // 100644 README.md abc123...
    // 40000 src def456...
    // 100755 deploy.sh 789012...

    if ($entry->isTree()) {
        // Recurse into subdirectory (mode 40000)
    } elseif ($entry->isExecutable()) {
        // Executable file (mode 100755)
    } elseif ($entry->isBlob()) {
        // Regular file (any 10xxxx mode, so executables match too)
    } elseif ($entry->isSymlink()) {
        // Symbolic link (mode 120000)
    } elseif ($entry->isGitlink()) {
        // Submodule (mode 160000)
    }
}

Uso dei commit

Un commit collega uno snapshot dell'albero ai relativi genitori e metadati.

PHP

$commit = $repo->head();

echo $commit->id->hex;      // Full object hash
echo $commit->tree->hex;    // Tree object hash
echo $commit->author;       // "Name <email> timestamp tz"
echo $commit->committer;    // "Name <email> timestamp tz"
echo $commit->message;      // Full commit message

// Parent commits
foreach ($commit->parents as $parentId) {
    $parent = $repo->readObject($parentId->hex);
}

// Merge detection
if ($commit->isMerge()) {
    // Two or more parents
}

Uso dei tag

I tag annotati sono oggetti con una destinazione, un tipo, un nome, l'autore del tag e un messaggio.

PHP

$tag = $repo->readObject($hash);

echo $tag->object->hex;           // Target object hash
echo $tag->objectType->value;     // 'commit', 'tree', 'blob', or 'tag'
echo $tag->name;            // Tag name
echo $tag->tagger;          // "Name <email> timestamp tz"
echo $tag->message;         // Tag message

Lettura dei riferimenti

HEAD corrente

PHP

$commit = $repo->head();

Risolve HEAD (seguendo i riferimenti simbolici come HEAD -> refs/heads/main -> commit hash) e restituisce l'oggetto commit.

Branch corrente

PHP

$branch = $repo->branch();  // 'main' or null if detached

Elenco di branch e tag

PHP

$branches = $repo->branches();  // ['bugfix/typo', 'feature/login', 'main']
$tags = $repo->tags();          // ['v1.0.0', 'v1.1.0']

Tutti i riferimenti

PHP

$refs = $repo->allRefs();
// [
//     'refs/heads/main' => 'abc123...',
//     'refs/heads/feature' => 'def456...',
//     'refs/tags/v1.0.0' => '789012...',
//     'refs/remotes/origin/main' => 'abc123...',
// ]

Risoluzione delle revisioni

PHP

$id = $repo->resolve('HEAD');
$id = $repo->resolve('main');
$id = $repo->resolve('v1.0.0');
$id = $repo->resolve('HEAD~3');
$id = $repo->resolve('main^2');
$id = $repo->resolve('3f2c1e0b9d6a4f8e7c5b2a1d0e9f8c7b6a5d4e3f');

L'analizzatore delle revisioni supporta gli operatori ~N (antenato) e ^N (genitore), concatenabili senza limiti. Gli hash devono essere forniti per intero.

Scorrimento della cronologia dei commit

log

I commit vengono restituiti dal più recente al più vecchio, ordinati in base alla data e ora del committer.

PHP

// Last 20 commits from HEAD
$commits = $repo->log(20);

foreach ($commits as $commit) {
    $short = substr($commit->id->hex, 0, 7);
    echo "{$short} {$commit->message}\n";
}

log da un commit specifico

PHP

$from = $repo->resolve('feature/login');
$commits = $repo->log(10, $from);

log filtrato per percorso del file

PHP

$commits = $repo->logPath('src/Repository.php', 20);

Restituisce solo i commit in cui il file specificato è stato modificato (aggiunto, modificato, eliminato o rinominato) rispetto al primo genitore. Il percorso deve identificare esattamente un file; le directory non corrispondono. Vengono esaminati solo gli ultimi 5 * $limit commit, quindi potrebbero mancare le corrispondenze più vecchie (#7).

show

PHP

$result = $repo->show('HEAD');
$commit = $result['commit'];
$diffs = $result['diff'];

echo "Author: {$commit->author}\n";
echo "Message: {$commit->message}\n\n";

foreach ($diffs as $diff) {
    echo $diff->format();
}

Rilevamento del branch predefinito

PHP

$default = $repo->defaultBranch();
// Checks: remote HEAD symref -> local HEAD -> main/master fallback

Quando è impostato remote.origin.url e i processi sono abilitati, il primo controllo invia al remoto una richiesta HTTP intelligente. Gli errori di rete vengono ignorati e seguono i controlli locali.

Relazioni di discendenza dei merge

PHP

// Is feature fully merged into main?
$merged = $repo->isBranchMerged('feature/done', 'main');

// Find the merge base of two commits
$base = $repo->mergeBase(
    $repo->resolve('main'),
    $repo->resolve('feature/login'),
);