Migrate Language component to the Component Revision architecture and introduce Activities by c-knof · Pull Request #12090 · ILIAS-eLearning/ILIAS

c-knof · 2026-09-17T10:32:57Z

Summary

Migrates the Language component to the Component Revision architecture ($define/$implement/$use/$contribute/$seek/$provide/$pull/$internal) and introduces Activity implementations for its domain operations, replacing logic previously embedded directly in the GUI classes.

Introduce 7 Language Activities (components/ILIAS/Language/src/Activities): InstallLanguage, UninstallLanguage, UpdateLanguage, AddLanguageEntry, RemoveLocalLanguageChanges, SetLanguageDetectionEnabled, SetLanguageTranslationEnabled, plus supporting traits/classes (GrindsFormInput, GrindingInputAccess, ParsesLanguageKeyList, ResolvesLanguageKeysToObjIds, RendersActivityErrors, exception types)
Extract corresponding domain logic out of class.ilObjLanguageFolderGUI.php / class.ilObjLanguageExtGUI.php into these Activities
Add InstalledLanguageRepository/InstalledLanguageDatabaseRepository and LanguageInstallationManager/LanguageFileParsing under src/Setup to back the new Activities and setup objectives
Add ComponentTranslation support (ComponentLanguageFileDirectory, CustomizingLanguageFileDirectory, MainLanguageFileDirectory, LanguageFileDirectoryManager) so individual components can ship their own language files instead of everything living in the central lang/ files; implemented exemplarily for the File component (components/ILIAS/File/File.php, components/ILIAS/File/lang/ilias_{de,en}.lang) as a reference for how other components can adopt this going forward
Replace several SELECT * FROM lng_modules queries with queries selecting only the needed columns (e.g. SELECT lang_array FROM lng_modules) as part of the lng_modules access rewrite in class.ilSetupLanguage.php / class.ilObjLanguage.php
Wire the new dependency graph in Language.php, Init.php, and AllModernComponents.php
Extend README.md and docs/development/language.md with the Activities overview and documented, known deviations from the Activity contract
Add extensive PHPUnit coverage for every new Activity, the setup repository/manager, the component dependency graph, and GUI call sites

Other changes

ilCertificateDateHelperTest.php: loosen the lng_modules query mock match (SELECT * FROM lng_modules → FROM lng_modules), since the column list actually queried against lng_modules changed as part of this migration (see above) and the previous exact-string match no longer applied.

matthiaskunkel · 2026-10-03T10:02:22Z

I removed the ‘Authorities’ label because this is not a PR that should change authority assignments in the maintenance.md.

c-knof · 2026-10-16T12:29:17Z

Rebased onto current trunk to resolve a conflict in components/ILIAS/File/File.php with the new File Activities (4eeebdf). The contribution of the language directory now sits below the Activity contributions; no other changes.

c-knof · 2026-10-19T10:20:49Z

Aligns the Activities of the Language component with the File Activities that were merged in 4eeebdf:

Errors carry status codes: a denied permission is a DomainException with 403, invalid input 400, ambiguous language titles 409. Everything else is masked as a generic 500 with the original as previous, so callers other than the GUI no longer see internal messages (also for PDOExceptions, whose SQLSTATE string would otherwise compare as 4xx).
Unknown and anonymous users are refused before RBAC is asked; the trusted user id is passed to perform() directly.
Descriptions use ILIAS\Data\Factory, inputs are titled sections, and all legacy access goes through one RepositoryProvider instead of closures in every Activity.

Kept on purpose: the input is still ground through getInputDescription() as the Activities README asks, and forSetup() stays for the Setup. No callers outside the Language component are affected.

c-knof · 2026-10-23T07:10:50Z

New commits on top of the reviewed state (271e5617014..dd29d5ec2b0), all within the Language component:

f29b291 Protect the table actions of ilObjLanguageFolderGUI against CSRF: the table actions ran without a command, so ilCtrl never checked a token. The class now implements ilCtrlSecurityInterface, runs them through the unsafe command executeTableAction and dispatches an exact allowlist (ilCtrl compares commands case-sensitively, PHP calls methods case-insensitively). Requires the ctrl security artifact to be rebuilt (composer dump-autoload / setup build).
4151a27 [FIX] Load ilLangDeprecated through the autoloader (listing deprecated entries failed with an error).
12d8b93 Remove the unreachable confirmation screens from ilObjLanguageFolderGUI.
c4c65f3 Pass the previous exception positionally in GrindsFormInput (no named arguments).
e07cf87 Expect the calls whose arguments the tests check (PHPUnit 14 deprecations).
dd29d5e Mark the internal settings, cache and installation root types as @internal.

… introduce Activities

The seven Activities now get `ILIAS\AccessControl\PublicInterface\RBAC` via `$use` instead of reaching into `$GLOBALS['DIC']->rbac()`, and call `system()` only in `isAllowedToPerform()`. The Setup agent uses `InstallLanguage::forSetup()`/`UpdateLanguage::forSetup()`, since Setup checks no permissions and needs no RBAC.

`InstalledLanguageDatabaseRepository`, `LanguageInstallationManager`, `AddLanguageEntry` and the `ilSetupLanguage` of the web Activities now get `ILIAS\Database\Connection` via `$pull` instead of resolving `$GLOBALS['ilDB']`. `ilSetupLanguage` takes an optional connection; Setup keeps handing in its database via `setDbHandler()`, also for the metrics, and the file-only checks need no database.

The Setup CLI asks `ilLanguagesInstalledAndUpdatedObjective` for its label before `achieve()`, so `getLabel()` only worked through a leftover `$GLOBALS['ilDB']`. `isApplicable()`, which the CLI calls first, now reads the languages from the Setup database and `getLabel()` lists them without database access.

The repository and the installation manager in the component graph now get the root from `ILIAS\Environment\Configuration\Installation\Directories` at resolve time instead of a path computed in `init()`. Callers outside the graph keep passing the path themselves.

… container `AllModernComponents` bound `$DIC[ILIAS\Language\Language::class]` to the `$use`d language, whose legacy adapter itself delegates to `$DIC->language()`. Nothing reads the key, so the constructor parameter and the binding are removed.

No component pulls `InstalledLanguageRepository` or `LanguageInstallationManager`, so they stay internal services of the component; `ilSetupLanguage` remains the entry point for callers outside it.

The Activities took the ref_id of the language folder as `int|\Closure` defaulting to 0. They now require `ILIAS\Language\LanguageFolder`, whose `LanguageFolderLegacyProxy` looks the ref_id up only when a permission is checked.

Keep only what the code does not say itself (the why, a constraint or a pitfall), mostly in one line, and drop the history of how it got there.

…vities A denied permission is now a `DomainException` with code 403 instead of a localized string, and `Failure::of()` masks every error outside the 4xx range as a generic 500, so callers other than the GUI no longer see internal messages. `InvalidInputException` carries 400, `AmbiguousLanguageTitleException` 409; `RendersActivityErrors` decides by code, which replaces the `SafeToDisplayActivityError` marker.

…the File Activities `LanguageActivity::isAllowedToPerform()` now rejects unknown and anonymous users before asking RBAC, as `FileUpload\Activities\AccessCheck` does for the File Activities. `maybePerformAs()` hands the trusted user id to `perform()` directly, which replaces the `additionalPerformParameters()` hook.

…ections like the File Activities The descriptions are built with `ILIAS\Data\Factory` instead of an own markdown helper, so the Activities no longer need the Refinery. The input of every Activity is a titled `section` instead of an untitled `group`, as in the File Activities.

…Provider` like the File Activities The language objects, language entries, the module cache, the user lookup and the settings are reached through one `RepositoryProvider` instead of optional closures with legacy defaults in every Activity. `UninstallLanguage`, `RemoveLocalLanguageChanges`, `AddLanguageEntry` and the two settings Activities take it as their only dependency besides language, RBAC and language folder; the tests mock it.

A `PDOException` carries its SQLSTATE as string code, and `'42S02'` compares as a 4xx code, so `Failure::of()` and `RendersActivityErrors` showed the database message as input error. Both now require an integer code. The test doubles no longer call the removed `markdown()` helper.

Keeps only what the code does not say itself, as in the File component: the reasons in `Language.php` shrink to the two real traps (no `final` Activities, the order of the contributions), and the tests lose their history notes.

`LanguageActivity` no longer takes `Language`: only `AddLanguageEntry` needs it, for the labels of its translation fields. The other six Activities, their `forSetup()` variants and the wiring drop the parameter.

… of the component translation classes

…nges

…ndent of their order

…tead of a path read during wiring

…y proxy instead of a global $DIC fallback

…st CSRF The table actions were read from the query by `executeCommand()` without a command, so ilCtrl never checked a token. `ilObjLanguageFolderGUI` now implements `ilCtrlSecurityInterface`, runs the table actions only through the unsafe command `executeTableAction` and dispatches an exact allowlist of commands, since ilCtrl compares commands case-sensitively but PHP calls methods case-insensitively. Takes effect after the ctrl security artifact is rebuilt (`composer dump-autoload` or `setup build`).

…ObjLanguageFolderGUI` Listing and downloading the deprecated entries failed with an error, because `ilObjLanguageFolderGUI` still included `ilLangDeprecated` from the former `Services/Language` directory.

…uageFolderGUI` `confirmRefreshSelectedObject()`, `confirmUninstallObject()`, `confirmUninstallChangesObject()` and the table action `edit` could no longer be reached since the table actions confirm in modals, and their confirmations failed for lack of language ids.

Named arguments are not used in the core (review criteria).

PHPUnit 14 no longer allows `with()` without `expects()`, so the mocks in `SetLanguageTranslationEnabledTest`, `AddLanguageEntryTest` and `LanguageInstallationManagerTest` now expect their calls once.

…es as `@internal` `TranslationCache`, `InstallationRoot`, `LanguageSettings` and their implementations are only wired in `$internal` and used inside the Language component, like the language file directories that already carry the marker.

c-knof · 2026-10-23T15:43:59Z

Rebased onto the current trunk (808b710a6be, LTI rework #12232). The only conflict was in Init.php and
AllModernComponents.php, where both sides append to the same lists, and both are kept. The commits from my previous comment are
now cdc2f8a (CSRF), 7beef90, 0599fd9, bec2aa8, bdec72f and cfeb84f.

c-knof requested review from chfsx, mjansenDatabay and thibsy September 17, 2026 10:32

c-knof self-assigned this Sep 17, 2026

c-knof added improvement php Pull requests that update Php code authorities Pull requests that contain updates to the authorities of a component. labels Sep 17, 2026

c-knof assigned katringross and dkippKPG Sep 17, 2026

matthiaskunkel removed the authorities Pull requests that contain updates to the authorities of a component. label Oct 3, 2026

c-knof force-pushed the language-component-revision branch from 9b99a5f to 1d1950c Compare October 12, 2026 15:53

mjansenDatabay approved these changes Oct 13, 2026

View reviewed changes

c-knof force-pushed the language-component-revision branch from 6f12808 to db2fc38 Compare October 16, 2026 12:28

c-knof force-pushed the language-component-revision branch from 77bc179 to 32877f6 Compare October 19, 2026 15:40

chfsx mentioned this pull request Oct 19, 2026

Language: small follow-ups to the Component Revision kroepelin-projekte/ILIAS#135

Merged

c-knof force-pushed the language-component-revision branch from dd29d5e to 7bc37a8 Compare October 23, 2026 07:48

c-knof added 10 commits October 23, 2026 16:49

Migrate Language component to the Component Revision architecture and…

d314bb8

… introduce Activities

Language: Stop providing the installation repository and manager

0cc0c8b

No component pulls `InstalledLanguageRepository` or `LanguageInstallationManager`, so they stay internal services of the component; `ilSetupLanguage` remains the entry point for callers outside it.

Language: Note the remaining legacy container use in the roadmap

28be27f

Language: Shorten the comments added by the Component Revision

cf99651

Keep only what the code does not say itself (the why, a constraint or a pitfall), mostly in one line, and drop the history of how it got there.

c-knof and others added 19 commits October 23, 2026 16:49

Language: Give the language service only to AddLanguageEntry

39edbb6

`LanguageActivity` no longer takes `Language`: only `AddLanguageEntry` needs it, for the labels of its translation fields. The other six Activities, their `forSetup()` variants and the wiring drop the parameter.

[FIX] File: take the current wording of could_not_create_file_objs

bcba0b5

[REFACTOR] Language: add license header and restore @internal markers…

b751724

… of the component translation classes

[FIX] Language: invalidate the translation cache when lng_modules cha…

84eebae

…nges

[REFACTOR] Language: assert the contributions of the component indepe…

5365798

…ndent of their order

[REFACTOR] Language: hand the installation root to the repository ins…

0645be2

…tead of a path read during wiring

[REFACTOR] Language: take the settings of the Activities from a legac…

69eabd8

…y proxy instead of a global $DIC fallback

[FIX] Language: Load ilLangDeprecated through the autoloader in `il…

7beef90

…ObjLanguageFolderGUI` Listing and downloading the deprecated entries failed with an error, because `ilObjLanguageFolderGUI` still included `ilLangDeprecated` from the former `Services/Language` directory.

Language: Pass the previous exception positionally in GrindsFormInput

bec2aa8

Named arguments are not used in the core (review criteria).

Language: Expect the calls whose arguments the tests check

bdec72f

PHPUnit 14 no longer allows `with()` without `expects()`, so the mocks in `SetLanguageTranslationEnabledTest`, `AddLanguageEntryTest` and `LanguageInstallationManagerTest` now expect their calls once.

c-knof force-pushed the language-component-revision branch from 7bc37a8 to cfeb84f Compare October 23, 2026 15:38

c-knof mentioned this pull request Oct 23, 2026

Language: Maintain the translations of language modules in PO files #12261

Open

Navigation Menu

Repository navigation

Migrate Language component to the Component Revision architecture and introduce Activities - #12090

Migrate Language component to the Component Revision architecture and introduce Activities#12090
c-knof wants to merge 29 commits into
ILIAS-eLearning:trunkfrom
kroepelin-projekte:language-component-revision

c-knof commented Sep 17, 2026

Uh oh!

matthiaskunkel commented Oct 3, 2026

Uh oh!

c-knof commented Oct 16, 2026

Uh oh!

c-knof commented Oct 19, 2026

Uh oh!

c-knof commented Oct 23, 2026 •

edited

Loading

Uh oh!

c-knof commented Oct 23, 2026

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Conversation

c-knof commented Sep 17, 2026

Summary

Other changes

Uh oh!

matthiaskunkel commented Oct 3, 2026

Uh oh!

c-knof commented Oct 16, 2026

Uh oh!

c-knof commented Oct 19, 2026

Uh oh!

c-knof commented Oct 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

c-knof commented Oct 23, 2026

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

c-knof commented Oct 23, 2026 •

edited

Loading