LanguageInstallationManagerMigratedDroppedKeysTest.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 ILIAS\Language\Setup\InstalledLanguageRepository;
use ILIAS\Language\Setup\LanguageDataNotSavedException;
use ILIAS\Language\Setup\LanguageInstallationManager;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\TestCase;
 
class LanguageInstallationManagerMigratedDroppedKeysTest extends LanguageInstallationManagerMigratedModulesTestCase
{
    public function testAKeyDroppedFromTheShippedPoWithoutALocalChangeInTheOverlayIsRemoved(): void
    {
        $this->shipPo(['farewell' => 'Tschüss']); // 'greeting' is no longer shipped
        $this->seedOverlay(['greeting' => ['value' => 'Hallo', 'original' => 'Hallo']]);
        $this->db_local_changes = [self::MODULE => ['greeting' => 'Hallo']];
 
        $this->manager()->insertLanguageForInstallation('de');
 
        $this->assertArrayNotHasKey('greeting', $this->lngModules()[self::MODULE]);
        // the overlay is the only source and holds no local change: nothing local to drop, lng_data is not read
        $this->assertSame([], $this->droppedIdentifiers(self::MODULE));
        // nothing local is left, so the overlay is removed completely
        $this->assertFileDoesNotExist($this->overlayBase() . '.po', 'dropped from the overlay as well');
    }
 
    public function testAKeyDroppedFromTheShippedPoButWithARealLocalChangeIsKept(): void
    {
        $this->shipPo(['farewell' => 'Tschüss']);
        $this->seedOverlay(['greeting' => [
            'value' => 'Servus',
            'original' => 'Hallo',
            'local_change' => '2025-05-05T05:05:05Z',
        ]]);
        $this->db_local_changes = [self::MODULE => ['greeting' => 'Servus']];
 
        $this->manager()->insertLanguageForInstallation('de');
 
        $this->assertSame('Servus', $this->lngModules()[self::MODULE]['greeting']);
        $this->assertSame([], $this->droppedIdentifiers(self::MODULE), 'a real local change is never dropped');
        $this->assertSame('Servus', $this->overlayPo()->find(null, 'greeting')->getTranslation());
    }
 
    public function testAKeyDroppedFromTheShippedPoWithACorruptOverlayLeavesItsModuleUnchanged(): void
    {
        $this->expectManagerWarning();
        $this->shipPo(['farewell' => 'Tschüss']);
        $this->seedOverlay(['farewell' => ['value' => 'Tschüss', 'original' => 'Tschüss']]);
        file_put_contents($this->overlayBase() . '.po', "msgid \"kaputt\n");
        $this->db_local_changes = [self::MODULE => ['greeting' => 'Hallo']];
 
        $this->manager()->insertLanguageForInstallation('de');
 
        $this->assertArrayNotHasKey(self::MODULE, $this->lngModules(), 'nothing of the module is written');
        $this->assertSame([], $this->droppedIdentifiers(self::MODULE));
    }
 
    public function testACustomizingValueForAKeyDroppedFromTheShippedPoStaysLocal(): void
    {
        $this->shipPo(['farewell' => 'Tschüss']);
        $this->seedOverlay(['greeting' => ['value' => 'Hallo', 'original' => 'Hallo']]);
        $this->writeLang('lang/customizing/ilias_de.lang.local', ['pilot#:#greeting#:#Hallo']);
 
        $this->manager()->insertLanguageForInstallation('de');
 
        $this->assertSame('Hallo', $this->lngModules()[self::MODULE]['greeting']);
        $this->assertSame(['value' => 'Hallo', 'local_change' => self::NOW], $this->lngData()['pilot|greeting']);
        $this->assertSame([], $this->droppedIdentifiers(self::MODULE));
    }
 
    public function testAKeyThatReturnsAfterBeingUnshippedKeepsTheLocalChangeOfTheOverlay(): void
    {
        $this->shipPo(['farewell' => 'Tschüss']); // 'greeting' not shipped this run
        $this->seedOverlay(['greeting' => [
            'value' => 'Angepasst',
            'original' => 'Hallo',
            'local_change' => '2025-05-05T05:05:05Z',
        ]]);
        $this->db_local_changes = [self::MODULE => ['greeting' => 'Angepasst']];
 
        $this->manager()->insertLanguageForInstallation('de');
        $this->assertSame(
            'Angepasst',
            $this->lngModules()[self::MODULE]['greeting'],
            'sanity: kept in run 1 because L != O'
        );
 
        $this->queries = [];
        $this->shipPo(['greeting' => 'Neu', 'farewell' => 'Tschüss']); // the key ships again, with a new value
        $this->db_local_changes = [self::MODULE => ['greeting' => 'Hallo']]; // reverted to the (preserved) original
 
        $this->manager()->insertLanguageForInstallation('de');
 
        $this->assertSame(
            'Angepasst',
            $this->lngModules()[self::MODULE]['greeting'],
            'the overlay is the only source: the revert in lng_data is not read, its local change stays'
        );
        $this->assertSame('Angepasst', $this->lngData()['pilot|greeting']['value']);
    }
 
    public function testAWholeMissingShippedPoIsBridgedByThePreservedOverlayAcrossTwoUpdates(): void
    {
        $this->seedOverlay([
            'A' => ['value' => 'A1', 'original' => 'A1'],
            'B' => ['value' => 'B1', 'original' => 'B1'],
            'C' => ['value' => 'C_custom', 'original' => 'C1', 'local_change' => '2025-01-01T00:00:00Z'],
        ]);
        $po_before_the_gap = file_get_contents($this->overlayBase() . '.po');
        $mo_before_the_gap = file_get_contents(MigratedPoFixture::overlayMo($this->overlayBase()));
        // no shipped `.po` for the whole gap: the module falls back to its plain `.lang` file
        $this->writeLang('components/pilot/lang/ilias_de.lang', ['A#:#A1', 'B#:#B1', 'C#:#C_custom']);
 
        $this->manager()->insertLanguageForInstallation('de');
 
        $this->assertSame(
            ['A' => 'A1', 'B' => 'B1', 'C' => 'C_custom'],
            $this->lngModules()[self::MODULE],
            'sanity: the .lang fallback is used while the .po is missing'
        );
        $this->assertSame(
            ['value' => 'C_custom', 'local_change' => null],
            $this->lngData()['pilot|C'],
            'the DB no longer sees C as a local change while the module is not migrated'
        );
        $this->assertSame($po_before_the_gap, file_get_contents($this->overlayBase() . '.po'), 'the overlay is untouched during the gap');
        $this->assertSame($mo_before_the_gap, file_get_contents(MigratedPoFixture::overlayMo($this->overlayBase())), 'the overlay is untouched during the gap');
 
        // the module is migrated again - A's shipped value changed, B's did not, C is not shipped
        // with the (never-shipped) customized value at all
        $this->queries = [];
        $this->shipPo(['A' => 'A2', 'B' => 'B1', 'C' => 'C1']);
 
        $this->manager()->insertLanguageForInstallation('de');
 
        $this->assertSame(
            ['C' => 'C_custom', 'A' => 'A2', 'B' => 'B1'],
            $this->lngModules()[self::MODULE]
        );
        $this->assertSame(['value' => 'A2', 'local_change' => null], $this->lngData()['pilot|A'], 'L === preserved O -> S wins');
        $this->assertSame(['value' => 'B1', 'local_change' => null], $this->lngData()['pilot|B'], 'unchanged');
        $this->assertSame(
            ['value' => 'C_custom', 'local_change' => '2025-01-01 00:00:00'],
            $this->lngData()['pilot|C'],
            'the overlay-only local change is taken over again - the known limitation above'
        );
        // A and B carry the shipped values and leave the full legacy overlay, only the local change C stays
        $overlay = $this->overlayPo();
        $this->assertNull($overlay->find(null, 'A'));
        $this->assertNull($overlay->find(null, 'B'));
        $this->assertSame('A2', $this->effective()['A']['value']);
        $this->assertSame('C_custom', $overlay->find(null, 'C')->getTranslation());
        $this->assertNotNull(LocalChangeComments::getLocalChange($overlay->find(null, 'C')));
    }
}