Към съдържанието

Четене на хранилища

Преглед като Markdown Редактиране в GitHub Документация за bfe242f

Pitmaster чете git хранилища, като анализира директно форматите на диска: свободни обекти (компресирани със zlib файлове в .git/objects/), pack файлове (.git/objects/pack/), препратки (файлове в .git/refs/ и packed-refs) и индексът (.git/index).

Отваряне на хранилище

PHP
use Pitmaster\Pitmaster;

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

Pitmaster поддържа три структури на хранилища:

  1. Обикновени хранилища: .git е директория в основната директория на проекта.
  2. Свързани работни дървета: .git е файл, съдържащ gitdir: <path>, който сочи към .git/worktrees/<name>/.
  3. Голи хранилища: самият път съдържа HEAD, objects/ и т.н.
PHP
// Detection helpers
Pitmaster::isRepository('/path');  // true for any of the above
Pitmaster::isWorktree('/path');    // true only for linked worktrees

Четене на обекти

Всяка част от данните в git хранилище се съхранява като обект, идентифициран чрез хеша си: SHA-1 (40 шестнадесетични знака) по подразбиране или SHA-256 (64 шестнадесетични знака) в хранилища, създадени с Pitmaster::init($path, 'sha256'). Има четири типа обекти: blob, дърво, commit и таг.

Методите по-долу, които работят с хешове, приемат пълния шестнадесетичен хеш; съкратени хешове не се приемат.

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

Обектите първо се търсят в свободното хранилище, а след това в pack файловете. При търсене в pack файлове се използва таблицата за разпределение .idx за двоично търсене на O(log n).

catFile

За извличане на съдържание без проверка на типа:

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...', ...]

Връща шестнадесетичните хешове на всички обекти (свободни и пакетирани).

Работа с blob-ове

Blob съдържа необработено съдържание на файл.

PHP
$blob = $repo->readObject($hash);
echo $blob->content;     // Raw file bytes
echo $blob->size();      // Content length
echo $blob->id->hex;     // Object 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)
    }
}

Работа с commit-и

Commit свързва моментна снимка на дървото с неговите родители и метаданни.

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
}

Работа с тагове

Анотираните тагове са обекти с цел, тип, име, автор на тага и съобщение.

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

Четене на препратки

Текущ HEAD

PHP
$commit = $repo->head();

Разрешава HEAD (следвайки символични препратки като HEAD -> refs/heads/main -> commit hash) и връща обекта commit.

Текущ клон

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

Списък с клонове и тагове

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

Всички препратки

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

Разрешаване на ревизии

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

Анализаторът на ревизии поддържа операторите ~N (предшественик) и ^N (родител), които могат да се свързват произволно. Хешовете трябва да се посочват изцяло.

Обхождане на историята на commit-ите

дневник

Commit-ите се връщат от най-новия нататък, подредени по времевия печат на комитъра.

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 от конкретен commit

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

log, филтриран по път до файл

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

Връща само commit-ите, при които посоченият файл е бил променен (добавен, изменен, изтрит или преименуван) спрямо първия родител. Пътят трябва да е точен път до файл; директориите не съвпадат. Проверяват се само най-новите 5 * $limit commit-а, така че по-стари съвпадения може да липсват (#7).

показване

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

Откриване на клона по подразбиране

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

Когато е зададен remote.origin.url и процесите са разрешени, първата проверка изпраща интелигентна заявка HTTP до отдалечения сървър. Мрежовите грешки се игнорират и следват локалните проверки.

Родословие на сливането

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