# Подмодули

Git подмодули встраивают один репозиторий в другой. В дереве родительского репозитория подмодуль представлен записью gitlink (режим `160000`), указывающей на определенный коммит в репозитории подмодуля. URL и путь подмодуля задаются в файле `.gitmodules`.

## Основные понятия

В дереве родительского репозитория:

```
100644 blob abc123...  README.md
040000 tree def456...  src/
160000 commit 789012... lib/external    <-- gitlink entry (submodule)
```

Запись gitlink указывает, какой коммит подмодуля следует извлечь. Сам репозиторий подмодуля находится в `.git/modules/<name>/`.

## SubmoduleManager

```php
use Pitmaster\Submodule\SubmoduleManager;

$manager = new SubmoduleManager(
    $repo->objectDatabase(),
    $repo->workDir(),
    $repo->gitDir(),
);
```

### Список подмодулей

```php
$submodules = $manager->list();

foreach ($submodules as $sub) {
    echo "{$sub->name}: {$sub->url} at {$sub->path}\n";
    if ($sub->branch !== null) {
        echo "  tracks branch: {$sub->branch}\n";
    }
}
```

### Объект значения подмодуля

```php
use Pitmaster\Submodule\Submodule;

$sub->name;     // Submodule name (from .gitmodules section header)
$sub->path;     // Path in the working tree
$sub->url;      // Remote URL
$sub->branch;   // Tracked branch (nullable)
```

## Разбор .gitmodules

Файл `.gitmodules` задает конфигурацию подмодулей:

```ini
[submodule "lib/external"]
    path = lib/external
    url = https://github.com/vendor/lib.git
    branch = main

[submodule "tools/helper"]
    path = tools/helper
    url = https://github.com/vendor/helper.git
```

```php
$content = file_get_contents('.gitmodules');
$submodules = SubmoduleManager::parseGitmodules($content);

foreach ($submodules as $sub) {
    echo "{$sub->name} -> {$sub->url}\n";
}
```

Парсер обрабатывает:
- Заголовки секций: `[submodule "<name>"]`
- Пары «ключ — значение»: `path = ...`, `url = ...`, `branch = ...`
- Комментарии (строки, начинающиеся с `#`)
- Пробелы и отступы

Записи без `path` или `url` пропускаются. Значения не удаляются из кавычек.

## Записи Gitlink

Записи gitlink — это записи дерева с режимом `160000`. Они указывают на коммит (а не дерево или blob) в репозитории подмодуля.

```php
$tree = $repo->readObject($treeHash);

foreach ($tree->entries as $entry) {
    if ($entry->isGitlink()) {
        echo "Submodule at {$entry->name}: commit {$entry->hash->hex}\n";
    }
}
```

### Обнаружение TreeEntry

```php
$entry->isGitlink();  // true if mode is '160000'
$entry->mode;         // '160000'
```

## Инициализация подмодулей

```php
$manager->init();
```

Для каждого подмодуля, объявленного в `.gitmodules`, выполняются следующие действия:
1. Создается пустой каталог `.git/modules/<name>/`
2. Создается каталог по пути подмодуля, если он еще не существует
3. В `.git/config` записываются `submodule.<name>.active = true` и `submodule.<name>.url`

Это не загружает данные и ничего не извлекает; файл `.git` подмодуля также не записывается.

## Обновление подмодулей

```php
$manager->update($repo->head()->tree);
```

Для каждого подмодуля, зафиксированного в указанном дереве, `update()` копирует каталог git исходного репозитория в `.git/modules/<name>/`, заменяет рабочие файлы подмодуля файлами из источника, записывает файл `.git` с указанием на каталог модуля, устанавливает `core.worktree` и отсоединяет HEAD на зафиксированном коммите.

Путь к подмодулю URL должен быть локальным: абсолютным или относительным к рабочему дереву родительского репозитория (git разрешает относительные URL относительно удаленного URL родительского репозитория). URL со схемой (`https://...`) вызывает `RuntimeException('Submodule update currently supports only local paths: ...')`.

После обновления каждый подмодуль можно открыть как отдельный репозиторий:

```php
$subRepo = Pitmaster::open($repo->workDir() . '/lib/external');
```

## Проверка зафиксированных коммитов

```php
$headCommit = $repo->head();
$pinnedId = $manager->pinnedCommit('lib/external', $headCommit->tree);

if ($pinnedId !== null) {
    echo "lib/external is pinned to commit {$pinnedId->hex}\n";
}
```

Метод `pinnedCommit()` проходит по иерархии дерева, находит запись gitlink по указанному пути и возвращает хеш целевого коммита.

## Состояние подмодуля

```php
$headCommit = $repo->head();
$statuses = $manager->status($headCommit->tree);

foreach ($statuses as $status) {
    $expected = $status['expected'] ?? 'not pinned';
    $actual = $status['actual'] ?? 'not initialized';
    $dirty = $status['dirty'] ? ' (dirty)' : '';

    echo "{$status['name']}: expected={$expected}, actual={$actual}{$dirty}\n";
}
```

Поля состояния:
- `name`: имя подмодуля
- `path`: путь в рабочем дереве
- `expected`: хеш коммита, зафиксированного в дереве родительского репозитория (null, если отсутствует)
- `actual`: текущий HEAD подмодуля (null, если не инициализирован)
- `dirty`: true, если известны оба коммита и они различаются. Изменения в рабочем дереве подмодуля не проверяются.

## Структура каталогов

```
project/
  .git/
    modules/
      lib/
        external/          # Submodule's actual git directory (.git/modules/<name>)
        HEAD
        objects/
        refs/
        ...
  .gitmodules              # Submodule declarations
  lib/
    external/
      .git                 # File: "gitdir: ../../.git/modules/lib/external"
      src/
      README.md
  src/
  README.md
```

## Работа с подмодулями

```php
// 1. Open the parent repo
$repo = Pitmaster::open('/path/to/project');

// 2. List submodules
$manager = new SubmoduleManager(
    $repo->objectDatabase(),
    $repo->workDir(),
    $repo->gitDir(),
);

$submodules = $manager->list();

// 3. Populate the submodules pinned at HEAD (local source paths only)
$manager->update($repo->head()->tree);

// 4. Check status
$statuses = $manager->status($repo->head()->tree);

// 5. Open a submodule as its own repo
$subRepo = Pitmaster::open($repo->workDir() . '/lib/external');
$subHead = $subRepo->head();
echo "Submodule HEAD: {$subHead->id->hex}\n";
```