Перейти к содержимому

Чтение репозиториев

Просмотреть как 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-файлах используется таблица fanout формата .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'),
);