MigratedLanguageFileSyncReadersTest.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
use ILIAS\Language\ComponentTranslation\CustomizingLanguageFileDirectory;
use ILIAS\Language\ComponentTranslation\Catalog\TranslationCatalog;
use ILIAS\Language\ComponentTranslation\LanguageFileDirectory;
use ILIAS\Language\ComponentTranslation\LanguageFileDirectoryManager;
use ILIAS\Language\ComponentTranslation\LocalChangeComments;
use ILIAS\Language\ComponentTranslation\MainLanguageFileDirectory;
use ILIAS\Language\ComponentTranslation\MigratedLanguageFileSync;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\TestCase;
 
class MigratedLanguageFileSyncReadersTest extends MigratedLanguageFileSyncTestCase
{
    public function testLoadLocalChangesNeverParsesTheShippedPoOnlyChecksItExists(): void
    {
        file_put_contents($this->shippedPo(), "msgid \"kaputt\n");
        $this->seedOverlay(['greeting' => ['value' => 'Servus', 'original' => 'Hallo', 'local_change' => '2020-01-01T00:00:00Z']]);
 
        $result = MigratedLanguageFileSync::loadLocalChanges($this->manager, 'de', self::MODULE, $this->client_data_dir);
 
        $this->assertSame(
            ['value' => 'Servus', 'local_change' => true, 'local_change_date' => '2020-01-01 00:00:00', 'original' => 'Hallo'],
            $result['greeting']
        );
    }
 
    public function testLoadLocalChangesReturnsOnlyTheOverlayEntriesNotTheShippedOnes(): void
    {
        $this->seedShipped(['greeting' => 'Hallo', 'farewell' => 'Tschüss']);
        $this->seedOverlay(['greeting' => ['value' => 'Servus', 'original' => 'Hallo']]);
 
        $this->assertSame(
            ['greeting' => ['value' => 'Servus', 'local_change' => false, 'local_change_date' => null, 'original' => 'Hallo']],
            MigratedLanguageFileSync::loadLocalChanges($this->manager, 'de', self::MODULE, $this->client_data_dir)
        );
    }
 
    public function testLoadLocalChangesReturnsAnEmptyArrayWithoutAnyOverlay(): void
    {
        $this->seedShipped(['greeting' => 'Hallo']);
 
        $this->assertSame([], MigratedLanguageFileSync::loadLocalChanges($this->manager, 'de', self::MODULE, $this->client_data_dir));
    }
 
    public function testLoadLocalChangesReturnsNullWithoutAShippedPo(): void
    {
        $this->seedOverlay(['greeting' => 'Servus']);
 
        $this->assertNull(MigratedLanguageFileSync::loadLocalChanges($this->manager, 'de', self::MODULE, $this->client_data_dir));
    }
 
    public function testLoadLocalChangesReturnsNullForAnUnknownModuleOrWithoutClientDataDir(): void
    {
        $this->seedShipped(['greeting' => 'Hallo']);
 
        $this->assertNull(MigratedLanguageFileSync::loadLocalChanges($this->manager, 'de', 'other_module', $this->client_data_dir));
        $this->assertNull(MigratedLanguageFileSync::loadLocalChanges($this->manager, 'de', self::MODULE, null));
    }
 
    public function testAnOverlayMoWithoutItsPoThrowsInsteadOfBeingTreatedAsAbsent(): void
    {
        $this->seedShipped(['greeting' => 'Hallo']);
        MigratedPoFixture::writeOverlayRevision($this->overlayBase(), MigratedPoFixture::catalog(self::MODULE, ['greeting' => 'Servus']));
 
        $this->expectException(RuntimeException::class);
        $this->expectExceptionMessageMatches('/has no/');
        MigratedLanguageFileSync::loadModuleTranslations($this->manager, 'de', self::MODULE, $this->client_data_dir);
    }
 
    public function testLoadLocalChangesThrowsForAnOverlayMoWithoutItsPo(): void
    {
        $this->seedShipped(['greeting' => 'Hallo']);
        MigratedPoFixture::writeOverlayRevision($this->overlayBase(), MigratedPoFixture::catalog(self::MODULE, ['greeting' => 'Servus']));
 
        $this->expectException(RuntimeException::class);
        MigratedLanguageFileSync::loadLocalChanges($this->manager, 'de', self::MODULE, $this->client_data_dir);
    }
 
    public function testAnIrregularFileAtTheOverlayPoPositionThrows(): void
    {
        $this->seedShipped(['greeting' => 'Hallo']);
        mkdir($this->overlayBase() . '.po', 0775, true);
 
        $this->expectException(RuntimeException::class);
        $this->expectExceptionMessageMatches('/no regular file/');
        MigratedLanguageFileSync::loadModuleTranslations($this->manager, 'de', self::MODULE, $this->client_data_dir);
    }
 
    public function testSyncThrowsForAnOverlayMoWithoutItsPoInsteadOfRemovingOrRebuildingIt(): void
    {
        $this->seedShipped(['greeting' => 'Hallo']);
        MigratedPoFixture::writeOverlayRevision($this->overlayBase(), MigratedPoFixture::catalog(self::MODULE, ['greeting' => 'Servus']));
 
        $this->expectException(RuntimeException::class);
        $this->sync(['greeting' => 'Hallo']);
    }
 
    public function testLoadShippedModulesReturnsTheShippedValuesOfEveryMigratedModuleForTheLanguage(): void
    {
        $second_directory = MigratedPoFixture::directory('stwo', $this->directory->getPath());
        $not_migrated = MigratedPoFixture::directory('nomig', $this->directory->getPath());
        $manager = new LanguageFileDirectoryManager(
            new CustomizingLanguageFileDirectory(),
            new MainLanguageFileDirectory(),
            $this->directory,
            $second_directory,
            $not_migrated
        );
        $this->seedShipped([
            'greeting' => 'Hallo',
            'foreign' => ['value' => 'Fremd', 'context' => 'other_module'],
        ]);
        $this->seedShipped(['farewell' => 'Tschüss'], 'de', 'stwo');
        $this->seedShipped(['farewell' => 'Bye'], 'en', 'stwo');
        $this->seedShipped(['x' => 'only english'], 'en', 'nomig');
 
        $this->assertSame(
            [self::MODULE => ['greeting' => 'Hallo'], 'stwo' => ['farewell' => 'Tschüss']],
            MigratedLanguageFileSync::loadShippedModules($manager, $this->ilias_root, 'de')
        );
    }
 
    public function testLoadShippedModulesReturnsAnEmptyListForAModuleWhoseShippedPoIsEmpty(): void
    {
        $this->seedShipped([]);
 
        $this->assertSame(
            [self::MODULE => []],
            MigratedLanguageFileSync::loadShippedModules($this->manager, $this->ilias_root, 'de')
        );
    }
 
    public function testAChangedShippedPoWithinTheSameRequestIsReReadNotServedFromTheCache(): void
    {
        $this->seedShipped(['greeting' => 'Hallo']);
        $this->assertSame(
            ['greeting' => 'Hallo'],
            MigratedLanguageFileSync::loadShippedModules($this->manager, $this->ilias_root, 'de')[self::MODULE]
        );
 
        $this->seedShipped(['greeting' => 'Servus']);
 
        $this->assertSame(
            ['greeting' => 'Servus'],
            MigratedLanguageFileSync::loadShippedModules($this->manager, $this->ilias_root, 'de')[self::MODULE]
        );
    }
 
    public function testTheShippedPoCacheNeverGrowsBeyondItsConfiguredLimit(): void
    {
        $cache = new ReflectionProperty(MigratedLanguageFileSync::class, 'shipped_catalogs');
        $cache->setValue(null, []);
 
        try {
            for ($i = 0; $i < 520; $i++) {
                $module = 'cachetest' . $i;
                $directory = MigratedPoFixture::directory($module, $this->directory->getPath());
                MigratedPoFixture::writePo(
                    $this->fixture_directory . '/' . $module . '_de.po',
                    MigratedPoFixture::catalog($module, ['x' => 'y'])
                );
                MigratedLanguageFileSync::loadShippedModuleEntries($this->fixture_directory . '/' . $module . '_de.po', $module);
                unset($directory);
            }
 
            $this->assertLessThanOrEqual(512, count($cache->getValue()));
        } finally {
            $cache->setValue(null, []);
        }
    }
 
    public function testFindShippedModuleFilesListsEveryModuleWithAShippedPoForTheLanguage(): void
    {
        $corrupt = MigratedPoFixture::directory('scorrupt', $this->directory->getPath());
        $english_only = MigratedPoFixture::directory('senonly', $this->directory->getPath());
        $manager = new LanguageFileDirectoryManager(
            new CustomizingLanguageFileDirectory(),
            new MainLanguageFileDirectory(),
            $this->directory,
            $corrupt,
            $english_only
        );
        $this->seedShipped(['greeting' => 'Hallo']);
        file_put_contents($this->shippedPo('de', 'scorrupt'), "msgid \"kaputt\n");
        $this->seedShipped(['x' => 'only english'], 'en', 'senonly');
 
        $this->assertSame(
            [self::MODULE => $this->shippedPo(), 'scorrupt' => $this->shippedPo('de', 'scorrupt')],
            MigratedLanguageFileSync::findShippedModuleFiles($manager, $this->ilias_root, 'de')
        );
    }
 
    public function testHasShippedModulesOnlyForALanguageWithAShippedPo(): void
    {
        $this->seedShipped(['greeting' => 'Hallo']);
 
        $this->assertFalse(MigratedLanguageFileSync::hasShippedModules($this->manager, $this->ilias_root, []));
        $this->assertFalse(MigratedLanguageFileSync::hasShippedModules($this->manager, $this->ilias_root, ['en']));
        $this->assertTrue(MigratedLanguageFileSync::hasShippedModules($this->manager, $this->ilias_root, ['en', 'de']));
    }
 
    public function testLoadShippedModuleEntriesReturnsValueAndJoinedExtractedComment(): void
    {
        $catalog = MigratedPoFixture::catalog(self::MODULE, [
            'greeting' => "Hallo\nWelt",
            'farewell' => 'Tschüss',
            'foreign' => ['value' => 'Fremd', 'context' => 'other_module'],
        ]);
        $catalog->find(self::MODULE, 'greeting')->addExtractedComment('shown on the login page');
        $catalog->find(self::MODULE, 'greeting')->addExtractedComment('keep it short');
        $catalog->find('other_module', 'foreign')->addExtractedComment('not returned');
        MigratedPoFixture::writePo($this->shippedPo(), $catalog);
 
        $entries = MigratedLanguageFileSync::loadShippedModuleEntries($this->shippedPo(), self::MODULE);
        ksort($entries);
 
        $this->assertSame(
            [
                'farewell' => ['value' => 'Tschüss', 'comment' => null],
                'greeting' => ['value' => "Hallo\nWelt", 'comment' => 'shown on the login page keep it short'],
            ],
            $entries
        );
    }
 
    public function testTheTranslatorCommentIsTheNoteAndBothKindsAreShippedComments(): void
    {
        $catalog = MigratedPoFixture::catalog(self::MODULE, ['greeting' => 'Hej', 'farewell' => 'Hejdå']);
        $catalog->find(self::MODULE, 'greeting')->addExtractedComment('en note');
        $catalog->find(self::MODULE, 'greeting')->addTranslatorNote('egen anteckning');
        $catalog->find(self::MODULE, 'farewell')->addExtractedComment('en note');
        MigratedPoFixture::writePo($this->shippedPo(), $catalog);
 
        $entries = MigratedLanguageFileSync::loadShippedModuleEntries($this->shippedPo(), self::MODULE);
 
        $this->assertSame('egen anteckning', $entries['greeting']['comment']);
        $this->assertSame('en note', $entries['farewell']['comment']);
        $this->assertSame(
            ['greeting' => ['egen anteckning'], 'farewell' => ['en note']],
            MigratedLanguageFileSync::loadShippedNotes($this->shippedPo(), self::MODULE)
        );
    }
 
    public function testLoadShippedModuleEntriesThrowsForACorruptPo(): void
    {
        file_put_contents($this->shippedPo(), "msgid \"kaputt\n");
 
        $this->expectException(RuntimeException::class);
        MigratedLanguageFileSync::loadShippedModuleEntries($this->shippedPo(), self::MODULE);
    }
 
    public function testLoadModuleTranslationsReturnsValueLocalChangeDateAndOriginalPerEntry(): void
    {
        $this->seedShipped(['changed' => 'Hallo']);
        $this->seedOverlay([
            'changed' => ['value' => 'Servus', 'original' => 'Hallo', 'local_change' => '2026-09-21T10:11:12Z'],
            'unchanged' => ['value' => 'Tschüss', 'original' => 'Tschüss'],
            'foreign' => ['value' => 'x', 'context' => 'other_module'],
        ]);
 
        $this->assertSame(
            [
                'changed' => [
                    'value' => 'Servus',
                    'local_change' => true,
                    'local_change_date' => '2026-09-21 10:11:12',
                    'original' => 'Hallo',
                ],
                'unchanged' => [
                    'value' => 'Tschüss',
                    'local_change' => false,
                    'local_change_date' => null,
                    'original' => 'Tschüss',
                ],
            ],
            MigratedLanguageFileSync::loadModuleTranslations($this->manager, 'de', self::MODULE, $this->client_data_dir)
        );
    }
 
    public function testLoadModuleTranslationsIgnoresAMissingOverlayMoAndStillReadsTheOverlayPo(): void
    {
        $this->seedShipped(['greeting' => 'Hallo']);
        $this->seedOverlay(['greeting' => ['value' => 'Servus', 'original' => 'Hallo', 'local_change' => '2020-01-01T00:00:00Z']]);
        unlink(MigratedPoFixture::overlayMo($this->overlayBase()));
 
        $this->assertSame(
            ['value' => 'Servus', 'local_change' => true, 'local_change_date' => '2020-01-01 00:00:00', 'original' => 'Hallo'],
            MigratedLanguageFileSync::loadModuleTranslations($this->manager, 'de', self::MODULE, $this->client_data_dir)['greeting']
        );
    }
 
    public function testAnOverlayMoWithoutItsPoIsUnreadableAndNotRemovedByAWrite(): void
    {
        $this->seedShipped(['greeting' => 'Hallo']);
        MigratedPoFixture::writeOverlayRevision($this->overlayBase(), MigratedPoFixture::catalog(self::MODULE, ['greeting' => 'Stray']));
 
        try {
            MigratedLanguageFileSync::loadModuleTranslations($this->manager, 'de', self::MODULE, $this->client_data_dir);
            $this->fail('Expected a RuntimeException');
        } catch (RuntimeException $e) {
            $this->assertStringContainsString('has no', $e->getMessage());
        }
        try {
            $this->sync(['greeting' => 'Hallo']);
            $this->fail('Expected a RuntimeException');
        } catch (RuntimeException) {
        }
 
        $this->assertSame(['greeting' => 'Stray'], MigratedPoFixture::readMo(MigratedPoFixture::overlayMo($this->overlayBase())));
    }
 
    public function testGetMigratedModulesListsAModuleByItsShippedPoAloneIndependentOfAnyOverlay(): void
    {
        $this->seedShipped(['greeting' => 'Hallo']);
        $this->seedOverlay(['greeting' => 'Servus']);
 
        $this->assertSame([self::MODULE], MigratedLanguageFileSync::getMigratedModules($this->manager, 'de', $this->client_data_dir));
        $this->assertSame([], MigratedLanguageFileSync::getMigratedModules($this->manager, 'en', $this->client_data_dir));
        $this->assertSame([], MigratedLanguageFileSync::getMigratedModules($this->manager, 'de', null));
    }
 
    public function testGetMigratedModulesListsAModuleWithNoOverlayFileWhatsoever(): void
    {
        $this->seedShipped(['greeting' => 'Hallo']);
 
        $this->assertDirectoryDoesNotExist(dirname($this->overlayBase()));
        $this->assertSame([self::MODULE], MigratedLanguageFileSync::getMigratedModules($this->manager, 'de', $this->client_data_dir));
    }
 
    public function testRemoveOverlayDeletesBothOverlayFilesButLeavesTheShippedPoUntouched(): void
    {
        $this->seedShipped(['greeting' => 'Hallo']);
        $this->seedOverlay(['greeting' => 'Hallo']);
        $shipped_before = file_get_contents($this->shippedPo());
 
        MigratedLanguageFileSync::removeOverlay($this->manager, 'de', self::MODULE, $this->client_data_dir);
 
        $this->assertFileDoesNotExist($this->overlayBase() . '.po');
        $this->assertFileDoesNotExist(MigratedPoFixture::overlayMo($this->overlayBase()));
        $this->assertSame($shipped_before, file_get_contents($this->shippedPo()));
    }
 
    public function testRemoveOverlayOnlyRemovesTheRequestedLanguage(): void
    {
        $this->seedOverlay(['greeting' => 'Hallo'], 'de');
        $this->seedOverlay(['greeting' => 'Hello'], 'en');
 
        MigratedLanguageFileSync::removeOverlay($this->manager, 'de', self::MODULE, $this->client_data_dir);
 
        $this->assertFileExists($this->overlayBase('en') . '.po');
        $this->assertFileExists(MigratedPoFixture::overlayMo($this->overlayBase('en')));
    }
 
    public function testRemoveOverlayIsANoOpWithoutOverlayUnknownModuleOrClientDataDir(): void
    {
        MigratedLanguageFileSync::removeOverlay($this->manager, 'de', self::MODULE, $this->client_data_dir);
        $this->seedOverlay(['greeting' => 'Hallo']);
 
        MigratedLanguageFileSync::removeOverlay($this->manager, 'de', 'other_module', $this->client_data_dir);
        MigratedLanguageFileSync::removeOverlay($this->manager, 'de', self::MODULE, null);
 
        $this->assertFileExists($this->overlayBase() . '.po');
        $this->assertFileExists(MigratedPoFixture::overlayMo($this->overlayBase()));
    }
 
    public function testRemoveOverlayThrowsWhenAnOverlayFileCannotBeRemoved(): void
    {
        if (function_exists('posix_geteuid') && posix_geteuid() === 0) {
            $this->markTestSkipped('A non-removable file cannot be forced for root (no root-proof variant for unlink()).');
        }
        $this->seedOverlay(['greeting' => 'Hallo']);
        $overlay_directory = dirname($this->overlayBase());
        chmod($overlay_directory, 0555);
 
        // the lock file cannot be created in the read-only directory either - logged (error_log)
        $this->expectErrorLog();
        set_error_handler(static fn(): bool => true, E_WARNING);
        try {
            $this->expectException(RuntimeException::class);
            $this->expectExceptionMessageMatches('/overlay file/i');
            MigratedLanguageFileSync::removeOverlay($this->manager, 'de', self::MODULE, $this->client_data_dir);
        } finally {
            restore_error_handler();
            chmod($overlay_directory, 0775);
        }
    }
}