Перейти до вмісту

Читання репозиторіїв

Переглянути як 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, tree, commit і tag.

У наведених нижче методах на основі хешу потрібно вказувати повний шістнадцятковий хеш; скорочені хеші не приймаються.

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

Робота з комітами

Коміт пов’язує знімок дерева з його батьківськими комітами та метаданими.

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) і повертає об’єкт коміту.

Поточна гілка

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 (батьківський коміт), які можна довільно поєднувати. Хеші потрібно вказувати повністю.

Перегляд історії комітів

журнал

Коміти повертаються від найновішого до найстарішого, у порядку часової мітки автора коміту.

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 від певного коміту

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

log із фільтром за шляхом до файлу

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

Повертає лише коміти, у яких зазначений файл було змінено (додано, змінено, видалено або перейменовано) порівняно з першим батьківським комітом. Шлях має точно вказувати на файл; каталоги не враховуються. Перевіряються лише 5 * $limit найновіших комітів, тому старіші збіги можуть бути відсутні (#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'),
);