Build status and problems of the ILIAS modules served by TranslationGettextRepository: which modules are shipped, whether a .po is left unbuilt, and the problems of this request for the administration. More...

Collaboration diagram for ILIAS\Language\ComponentTranslation\MigratedTranslations:

Static Public Member Functions
static	isShippedModule (string $module)
	Whether $module belongs to the ILIAS components (never served from lng_data then). More...

static	shipsPoFor (string $module, string $lang_key)
	Whether the template directory of $module has a `<module>_<lang>.po`. More...

static	clientDataDir ()
	CLIENT_DATA_DIR, before it is defined (Setup, CLI) resolveClientDataDir(); cached until reset(). More...

static	shipsPoWithoutBuild (string $module, string $lang_key, ?LanguageFileDirectory $directory)
	Whether $module ships a `.po` for $lang_key that the build does not serve; cached until reset(). More...

static	reportMissingBuild ()
	Reports (fatal) a missing build; `false` if there is one. More...

static	reportProblem (string $message, bool $fatal=false)
	Records a problem (logged once per request, see getProblem()). More...

static	getProblem (?string $client_data_dir)
	The first fatal problem of this request, otherwise the first one - after checking the first module of the build, so the administration can show it even if no migrated module was used yet. More...

static	reportActivationProblem (string $reason)
	Native gettext cannot be activated (first use or later): one message per request, whatever the reason. More...

static	reset ()
	Forgets what was read in this request, the served translations included (e.g. More...

static	resetForTests ()
	Forgets everything read so far, the problems included - for tests only. More...

static	pointer ()

static	artifactDirectory ()

Static Private Member Functions
static	missingBuildMessage ()

static	reportNewerOtherBuild (array $pointer)
	Records (not fatal, not logged) that the pointer of the other locale kind was switched later than $pointer to a build of other shipped files. More...

static	otherBuildHint (string $prefix, bool $system_locale)

static	shippedTemplates ()

static	iliasDirectory ()

Static Private Attributes
static bool	$pointer_read = false

static bool	$pointer_system_locale = null
	The locale kind (NativeGettext::usesSystemLocale()) $pointer was read for. More...

static array	$pointer = null

static array	$shipped_templates = null

static array	$shipped_modules = []

static string	$client_data_dir = null

static bool	$client_data_dir_resolved = false

static array	$shipped_without_build = []

static array	$problems = []

static bool	$activation_problem_reported = false

Detailed Description

Build status and problems of the ILIAS modules served by TranslationGettextRepository: which modules are shipped, whether a .po is left unbuilt, and the problems of this request for the administration.

Static: the problems are collected per request like a log, also from static callers (ilLanguage::_lookupEntry(), the write paths). No part of TranslationRepository, as no translation is read here.

@phpstan-import-type Pointer from ShippedTranslationsBuild

Definition at line 32 of file MigratedTranslations.php.

Member Function Documentation

◆ artifactDirectory()

static ILIAS\Language\ComponentTranslation\MigratedTranslations::artifactDirectory ( )

static

Definition at line 327 of file MigratedTranslations.php.

                                              : string
    {
        return MigratedLanguageFilePaths::shippedArtifactDirectory(self::iliasDirectory());
    }

References ILIAS\Language\ComponentTranslation\MigratedLanguageFilePaths\shippedArtifactDirectory().

Referenced by ILIAS\Language\ComponentTranslation\TranslationGettextRepository\state().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clientDataDir()

static ILIAS\Language\ComponentTranslation\MigratedTranslations::clientDataDir ( )

static

CLIENT_DATA_DIR, before it is defined (Setup, CLI) resolveClientDataDir(); cached until reset().

Definition at line 103 of file MigratedTranslations.php.

                                          : ?string
    {
        if (defined('CLIENT_DATA_DIR')) {
            return (string) CLIENT_DATA_DIR;
        }
        if (!self::$client_data_dir_resolved) {
            self::$client_data_dir = MigratedLanguageFilePaths::resolveClientDataDir(self::iliasDirectory());
            self::$client_data_dir_resolved = true;
        }
 
        return self::$client_data_dir;
    }

References ILIAS\Language\ComponentTranslation\MigratedTranslations\$client_data_dir, CLIENT_DATA_DIR, and ILIAS\Language\ComponentTranslation\MigratedLanguageFilePaths\resolveClientDataDir().

Here is the call graph for this function:

◆ getProblem()

static ILIAS\Language\ComponentTranslation\MigratedTranslations::getProblem ( ?string $client_data_dir )

static

The first fatal problem of this request, otherwise the first one - after checking the first module of the build, so the administration can show it even if no migrated module was used yet.

null if there is none. Paths below the ILIAS directory and the client data directory are relative in the message (<data>/…); the log has them in full.

Returns: array{message: string, fatal: bool}|null

Definition at line 177 of file MigratedTranslations.php.

                                                               : ?array
    {
        $pointer = self::pointer();
        if ($pointer === null) {
            self::reportProblem(self::missingBuildMessage(), true);
        } else {
            foreach ($pointer['modules'] as $module => $languages) {
                if ($languages !== []) {
                    (new TranslationGettextRepository())->getKeys((string) $module, $languages[0], $client_data_dir);
                    break;
                }
            }
        }
 
        if (self::$problems === []) {
            return null;
        }
        $message = (string) (array_search(true, self::$problems, true) ?: array_key_first(self::$problems));
        $replace = [
            rtrim(self::iliasDirectory(), '/') . '/' => '',
            rtrim(self::artifactDirectory(), '/') . '/' => 'artifacts/language/',
        ];
        if ($client_data_dir !== null) {
            $replace[rtrim($client_data_dir, '/') . '/'] = '<data>/';
        }
 
        return ['message' => strtr($message, $replace), 'fatal' => self::$problems[$message]];
    }

References ILIAS\Language\ComponentTranslation\MigratedTranslations\$client_data_dir, $message, $module, ILIAS\Language\ComponentTranslation\MigratedTranslations\$pointer, ILIAS\Language\ComponentTranslation\MigratedTranslations\pointer(), and ILIAS\Language\ComponentTranslation\MigratedTranslations\reportProblem().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ iliasDirectory()

static ILIAS\Language\ComponentTranslation\MigratedTranslations::iliasDirectory ( )

staticprivate

Definition at line 332 of file MigratedTranslations.php.

                                            : string
    {
        return defined('ILIAS_ABSOLUTE_PATH') ? (string) ILIAS_ABSOLUTE_PATH : dirname(__DIR__, 5);
    }

◆ isShippedModule()

array< string, bool > see ILIAS\Language\ComponentTranslation\MigratedTranslations::isShippedModule ( string $module )

static

Whether $module belongs to the ILIAS components (never served from lng_data then).

Works without the component graph: from the build's recorded contributions, else from the shipped templates.

Definition at line 75 of file MigratedTranslations.php.

                                                          : bool
    {
        if (!isset(self::$shipped_modules[$module])) {
            $pointer = self::pointer();
            // a pointer without build (e.g. written from no directories) lists nothing reliable
            self::$shipped_modules[$module] = $pointer !== null && $pointer['build'] !== null && $pointer['shipped'] !== null
                ? in_array($module, $pointer['shipped'], true)
                : isset($pointer['modules'][$module]) || isset(self::shippedTemplates()[$module]);
        }
 
        return self::$shipped_modules[$module];
    }

References $module, ILIAS\Language\ComponentTranslation\MigratedTranslations\$pointer, and ILIAS\Language\ComponentTranslation\MigratedTranslations\pointer().

Referenced by ILIAS\Language\ComponentTranslation\MigratedTranslationsTest\testAModuleIsShippedIfItIsBuiltOrHasATemplateInTheComponents(), ILIAS\Language\ComponentTranslation\MigratedTranslationsTest\testWithABuildTheRecordedContributionsDecideEvenForAModuleWithoutAnyPo(), and ILIAS\Language\ComponentTranslation\MigratedTranslationsTest\testWithoutABuildOrAListOfContributionsTheShippedTemplatesDecide().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ missingBuildMessage()

static ILIAS\Language\ComponentTranslation\MigratedTranslations::missingBuildMessage ( )

staticprivate

Definition at line 247 of file MigratedTranslations.php.

                                                 : string
    {
        $message = sprintf(
            'There is no build of the language files ("%s") - run "php cli/setup.php build".',
            MigratedLanguageFilePaths::buildPointerFile(self::artifactDirectory())
        );
        $system_locale = !NativeGettext::usesSystemLocale();
 
        return is_file(MigratedLanguageFilePaths::buildPointerFileOf(self::artifactDirectory(), $system_locale))
            ? $message . ' ' . self::otherBuildHint('A build exists', $system_locale)
            : $message;
    }

References $message, ILIAS\Language\ComponentTranslation\MigratedLanguageFilePaths\buildPointerFile(), ILIAS\Language\ComponentTranslation\MigratedLanguageFilePaths\buildPointerFileOf(), ILIAS\Language\ComponentTranslation\MigratedTranslations\otherBuildHint(), and ILIAS\Language\ComponentTranslation\NativeGettext\usesSystemLocale().

Here is the call graph for this function:

◆ otherBuildHint()

static ILIAS\Language\ComponentTranslation\MigratedTranslations::otherBuildHint	(	string	$prefix,
		bool	$system_locale
	)

staticprivate

Definition at line 283 of file MigratedTranslations.php.

                                                                               : string
    {
        return sprintf(
            '%s for %s ("%s") - run "php cli/setup.php build" on the platform of the web server to serve it.',
            $prefix,
            $system_locale ? 'a system locale (macOS/BSD)' : 'glibc',
            MigratedLanguageFilePaths::buildPointerFileOf(self::artifactDirectory(), $system_locale)
        );
    }

References ILIAS\Language\ComponentTranslation\MigratedLanguageFilePaths\buildPointerFileOf().

Referenced by ILIAS\Language\ComponentTranslation\MigratedTranslations\missingBuildMessage(), and ILIAS\Language\ComponentTranslation\MigratedTranslations\reportNewerOtherBuild().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pointer()

static ILIAS\Language\ComponentTranslation\MigratedTranslations::pointer ( )

static

Definition at line 306 of file MigratedTranslations.php.

                                    : ?array
    {
        $system_locale = NativeGettext::usesSystemLocale();
        if (self::$pointer_read && self::$pointer_system_locale !== $system_locale) {
            self::reset();
        }
        if (!self::$pointer_read) {
            self::$pointer = ShippedTranslationsBuild::readPointer(self::artifactDirectory());
            self::$pointer_read = true;
            self::$pointer_system_locale = $system_locale;
            if (self::$pointer !== null) {
                self::reportNewerOtherBuild(self::$pointer);
            }
        }
 
        return self::$pointer;
    }

References ILIAS\Language\ComponentTranslation\MigratedTranslations\$pointer, ILIAS\Language\ComponentTranslation\ShippedTranslationsBuild\readPointer(), ILIAS\Language\ComponentTranslation\MigratedTranslations\reportNewerOtherBuild(), ILIAS\Language\ComponentTranslation\MigratedTranslations\reset(), and ILIAS\Language\ComponentTranslation\NativeGettext\usesSystemLocale().

Referenced by ILIAS\Language\ComponentTranslation\MigratedTranslations\getProblem(), ILIAS\Language\ComponentTranslation\MigratedTranslations\isShippedModule(), ILIAS\Language\ComponentTranslation\MigratedTranslations\reportMissingBuild(), ILIAS\Language\ComponentTranslation\TranslationGettextRepository\state(), and ILIAS\Language\ComponentTranslation\MigratedTranslationsTest\testSwitchingTheLocaleKindReadsTheOtherPointerWithoutAReset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reportActivationProblem()

static ILIAS\Language\ComponentTranslation\MigratedTranslations::reportActivationProblem ( string $reason )

static

Native gettext cannot be activated (first use or later): one message per request, whatever the reason.

Definition at line 209 of file MigratedTranslations.php.

                                                                  : void
    {
        if (self::$activation_problem_reported) {
            return;
        }
        self::$activation_problem_reported = true;
        self::reportProblem(sprintf('Native gettext is not available: %s.', $reason), true);
    }

References ILIAS\Language\ComponentTranslation\MigratedTranslations\reportProblem().

Referenced by ILIAS\Language\ComponentTranslation\TranslationGettextRepository\reportLostActivation(), and ILIAS\Language\ComponentTranslation\TranslationGettextRepository\state().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reportMissingBuild()

static ILIAS\Language\ComponentTranslation\MigratedTranslations::reportMissingBuild ( )

static

Reports (fatal) a missing build; false if there is one.

Definition at line 137 of file MigratedTranslations.php.

                                               : bool
    {
        $pointer = self::pointer();
        if ($pointer !== null && $pointer['build'] !== null) {
            return false;
        }
        self::reportProblem(self::missingBuildMessage(), true);
 
        return true;
    }

References ILIAS\Language\ComponentTranslation\MigratedTranslations\$pointer, ILIAS\Language\ComponentTranslation\MigratedTranslations\pointer(), and ILIAS\Language\ComponentTranslation\MigratedTranslations\reportProblem().

Referenced by ILIAS\Language\ComponentTranslation\MigratedTranslationsTest\testReportMissingBuildIsFatalWithoutABuildAndSilentWithOne().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reportNewerOtherBuild()

static ILIAS\Language\ComponentTranslation\MigratedTranslations::reportNewerOtherBuild ( array $pointer )

staticprivate

Records (not fatal, not logged) that the pointer of the other locale kind was switched later than $pointer to a build of other shipped files.

Parameters

Pointer $pointer

Definition at line 266 of file MigratedTranslations.php.

                                                                 : void
    {
        $system_locale = !NativeGettext::usesSystemLocale();
        $other_file = MigratedLanguageFilePaths::buildPointerFileOf(self::artifactDirectory(), $system_locale);
        $other_time = @filemtime($other_file);
        $own_time = @filemtime(MigratedLanguageFilePaths::buildPointerFile(self::artifactDirectory()));
        if ($other_time === false || ($own_time !== false && $own_time >= $other_time)) {
            return;
        }
        $other = ShippedTranslationsBuild::readPointerOf(self::artifactDirectory(), $system_locale);
        if ($other === null || $other['build'] === null || ($pointer['sources'] !== null && $pointer['sources'] === $other['sources'])) {
            return;
        }
        // a state of the installation for the administration, not worth a log line on every request
        self::$problems[self::otherBuildHint('A newer build exists', $system_locale)] ??= false;
    }

References ILIAS\Language\ComponentTranslation\MigratedTranslations\$pointer, ILIAS\Language\ComponentTranslation\MigratedLanguageFilePaths\buildPointerFile(), ILIAS\Language\ComponentTranslation\MigratedLanguageFilePaths\buildPointerFileOf(), ILIAS\Language\ComponentTranslation\MigratedTranslations\otherBuildHint(), ILIAS\Language\ComponentTranslation\ShippedTranslationsBuild\readPointerOf(), and ILIAS\Language\ComponentTranslation\NativeGettext\usesSystemLocale().

Referenced by ILIAS\Language\ComponentTranslation\MigratedTranslations\pointer().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reportProblem()

static ILIAS\Language\ComponentTranslation\MigratedTranslations::reportProblem	(	string	$message,
		bool	$fatal = `false`
	)

static

Records a problem (logged once per request, see getProblem()).

Parameters

bool $fatal whether it concerns every migrated module (no native gettext, no build) rather than one module, language or overlay

Definition at line 154 of file MigratedTranslations.php.

                                                                              : void
    {
        if (isset(self::$problems[$message])) {
            return;
        }
        self::$problems[$message] = $fatal;
 
        global $DIC;
        try {
            $DIC->logger()->forComponent('lang')->warning($message);
        } catch (\Throwable) {
            error_log($message);
        }
    }

References $DIC, and $message.

Referenced by ILIAS\Language\ComponentTranslation\MigratedTranslations\getProblem(), ILIAS\Language\ComponentTranslation\MigratedTranslations\reportActivationProblem(), ILIAS\Language\ComponentTranslation\MigratedTranslations\reportMissingBuild(), ILIAS\Language\ComponentTranslation\TranslationGettextRepository\state(), ILIAS\Language\Activities\RepositoryProvider\updateModuleCache(), and ILIAS\Language\ComponentTranslation\TranslationGettextRepository\withOverlay().

Here is the caller graph for this function:

◆ reset()

static ILIAS\Language\ComponentTranslation\MigratedTranslations::reset ( )

static

Forgets what was read in this request, the served translations included (e.g.

after a new build in the same process).

Definition at line 222 of file MigratedTranslations.php.

                                  : void
    {
        (new TranslationGettextRepository())->invalidateAll();
        self::$pointer_read = false;
        self::$pointer = null;
        self::$pointer_system_locale = null;
        self::$shipped_templates = null;
        self::$shipped_modules = [];
        self::$client_data_dir = null;
        self::$client_data_dir_resolved = false;
        self::$shipped_without_build = [];
    }

Here is the caller graph for this function:

◆ resetForTests()

static ILIAS\Language\ComponentTranslation\MigratedTranslations::resetForTests ( )

static

Forgets everything read so far, the problems included - for tests only.

Definition at line 240 of file MigratedTranslations.php.

                                          : void
    {
        self::reset();
        self::$problems = [];
        self::$activation_problem_reported = false;
    }

References ILIAS\Language\ComponentTranslation\MigratedTranslations\reset().

Here is the call graph for this function:

◆ shippedTemplates()

static ILIAS\Language\ComponentTranslation\MigratedTranslations::shippedTemplates ( )

staticprivate

Returns: array<string, string>

Definition at line 296 of file MigratedTranslations.php.

                                              : array
    {
        return self::$shipped_templates ??= MigratedLanguageFilePaths::findShippedTemplates(self::iliasDirectory());
    }

References ILIAS\Language\ComponentTranslation\MigratedLanguageFilePaths\findShippedTemplates().

Referenced by ILIAS\Language\ComponentTranslation\MigratedTranslations\shipsPoFor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ shipsPoFor()

static ILIAS\Language\ComponentTranslation\MigratedTranslations::shipsPoFor	(	string	$module,
		string	$lang_key
	)

static

Whether the template directory of $module has a <module>_<lang>.po.

Definition at line 91 of file MigratedTranslations.php.

                                                                       : bool
    {
        $directory = self::shippedTemplates()[$module] ?? null;
 
        return $directory !== null
            && MigratedLanguageFilePaths::isValidLanguageKey($lang_key)
            && is_file($directory . '/' . $module . '_' . $lang_key . '.po');
    }

References $module, ILIAS\Language\ComponentTranslation\MigratedLanguageFilePaths\isValidLanguageKey(), and ILIAS\Language\ComponentTranslation\MigratedTranslations\shippedTemplates().

Referenced by ILIAS\Language\ComponentTranslation\MigratedTranslations\shipsPoWithoutBuild(), and ILIAS\Language\ComponentTranslation\MigratedTranslationsTest\testShipsPoForNeedsATemplateADefaultNamedPoAndAValidLanguageKey().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ shipsPoWithoutBuild()

static ILIAS\Language\ComponentTranslation\MigratedTranslations::shipsPoWithoutBuild	(	string	$module,
		string	$lang_key,
		?LanguageFileDirectory	$directory
	)

static

Whether $module ships a .po for $lang_key that the build does not serve; cached until reset().

Definition at line 119 of file MigratedTranslations.php.

                                                                                                                   : bool
    {
        if (!isset(self::$shipped_without_build[$module . '|' . $lang_key])) {
            try {
                self::$shipped_without_build[$module . '|' . $lang_key] = $directory === null
                    ? self::shipsPoFor($module, $lang_key)
                    : is_file(MigratedLanguageFilePaths::shippedBasePath(self::iliasDirectory(), $directory, $lang_key) . '.po');
            } catch (\InvalidArgumentException) {
                self::$shipped_without_build[$module . '|' . $lang_key] = false;
            }
        }
 
        return self::$shipped_without_build[$module . '|' . $lang_key];
    }

References $module, ILIAS\Language\ComponentTranslation\MigratedLanguageFilePaths\shippedBasePath(), and ILIAS\Language\ComponentTranslation\MigratedTranslations\shipsPoFor().

Here is the call graph for this function:

Field Documentation

◆ $activation_problem_reported

bool ILIAS\Language\ComponentTranslation\MigratedTranslations::$activation_problem_reported = false

staticprivate

Definition at line 69 of file MigratedTranslations.php.

◆ $client_data_dir

string ILIAS\Language\ComponentTranslation\MigratedTranslations::$client_data_dir = null

staticprivate

Definition at line 54 of file MigratedTranslations.php.

Referenced by ILIAS\Language\ComponentTranslation\MigratedTranslations\clientDataDir(), and ILIAS\Language\ComponentTranslation\MigratedTranslations\getProblem().

◆ $client_data_dir_resolved

bool ILIAS\Language\ComponentTranslation\MigratedTranslations::$client_data_dir_resolved = false

staticprivate

Definition at line 55 of file MigratedTranslations.php.

◆ $pointer

array ILIAS\Language\ComponentTranslation\MigratedTranslations::$pointer = null

staticprivate

Definition at line 42 of file MigratedTranslations.php.

Referenced by ILIAS\Language\ComponentTranslation\MigratedTranslations\getProblem(), ILIAS\Language\ComponentTranslation\MigratedTranslations\isShippedModule(), ILIAS\Language\ComponentTranslation\MigratedTranslations\pointer(), ILIAS\Language\ComponentTranslation\MigratedTranslations\reportMissingBuild(), and ILIAS\Language\ComponentTranslation\MigratedTranslations\reportNewerOtherBuild().

◆ $pointer_read

bool ILIAS\Language\ComponentTranslation\MigratedTranslations::$pointer_read = false

staticprivate

Definition at line 34 of file MigratedTranslations.php.

◆ $pointer_system_locale

bool ILIAS\Language\ComponentTranslation\MigratedTranslations::$pointer_system_locale = null

staticprivate

The locale kind (NativeGettext::usesSystemLocale()) $pointer was read for.

Definition at line 37 of file MigratedTranslations.php.

◆ $problems

array ILIAS\Language\ComponentTranslation\MigratedTranslations::$problems = []

staticprivate

Definition at line 67 of file MigratedTranslations.php.

◆ $shipped_modules

array ILIAS\Language\ComponentTranslation\MigratedTranslations::$shipped_modules = []

staticprivate

Definition at line 52 of file MigratedTranslations.php.

◆ $shipped_templates

array ILIAS\Language\ComponentTranslation\MigratedTranslations::$shipped_templates = null

staticprivate

Definition at line 47 of file MigratedTranslations.php.

◆ $shipped_without_build

array ILIAS\Language\ComponentTranslation\MigratedTranslations::$shipped_without_build = []

staticprivate

Definition at line 60 of file MigratedTranslations.php.

The documentation for this class was generated from the following file:

components/ILIAS/Language/src/ComponentTranslation/MigratedTranslations.php

Static Public Member Functions

Static Private Member Functions

Static Private Attributes

Detailed Description

Member Function Documentation

◆ artifactDirectory()

◆ clientDataDir()

◆ getProblem()

◆ iliasDirectory()

◆ isShippedModule()

◆ missingBuildMessage()

◆ otherBuildHint()

◆ pointer()

◆ reportActivationProblem()

◆ reportMissingBuild()

◆ reportNewerOtherBuild()

◆ reportProblem()

◆ reset()

◆ resetForTests()

◆ shippedTemplates()

◆ shipsPoFor()

◆ shipsPoWithoutBuild()

Field Documentation

◆ $activation_problem_reported

◆ $client_data_dir

◆ $client_data_dir_resolved

◆ $pointer

◆ $pointer_read

◆ $pointer_system_locale

◆ $problems

◆ $shipped_modules

◆ $shipped_templates

◆ $shipped_without_build