Allow custom ts functions in extensions; defer custom ts calls until booted #15411
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Can one of the admins verify this patch? |
|
(Standard links)
|
|
Jenkins add to whitelist |
|
The build failure is relevant - i.e. indicating that |
totten
changed the title
|
Jenkins re test this please |
|
Changes make sense to me and the fact the build site runs is a good sign this PR is working. |
seamuslee001
changed the title
|
(CiviCRM Review Template WORD-1.2)
|
bjendres
pushed a commit
to systopia/civicrm-core
that referenced
this pull request
Oct 9, 2019
Allow custom ts functions in extensions; defer custom ts calls until booted
bjendres
pushed a commit
to systopia/civicrm-core
that referenced
this pull request
Oct 9, 2019
totten
added a commit
to totten/civicrm-core
that referenced
this pull request
Jan 23, 2020
Overview -------- This fixes a regression in which seed data is not translated. Before ------ The `civicrm_data.*.mysql` files are not translated. After ----- The `civicrm_data.*.mysql` files are translated. There's a unit-test to check this. Comments -------- This regression stems from civicrm#15411, which aimed to allow extensions to define custom variants of `ts()`. The crux of the issue is "What happens if you try to translate a string before the system is bootstrapped - before the extension is loaded? What's your fallback behavior?" In civicrm#15411, it used a fallback behavior of "do no translation". In theory, you shouldn't really get into this scenario since UIs are pretty much always generated post-boot. However, it turns out that there is a situation where you have an un-booted system and need to translate strings -- i.e. when generating the localized `civicrm_data.*.mysql` data. Hence the bug. This patch preserves most of the changes from civicrm#15411, but it changes the fallback behavior from "do no translation" to "use the built-in/default translator".
totten
added a commit
to totten/civicrm-core
that referenced
this pull request
Jan 23, 2020
Overview -------- This fixes a regression in which seed data is not translated. Before ------ The `civicrm_data.*.mysql` files are not translated. After ----- The `civicrm_data.*.mysql` files are translated. There's a unit-test to check this. Comments -------- This regression stems from civicrm#15411, which aimed to allow extensions to define custom variants of `ts()`. The crux of the issue is "What happens if you try to translate a string before the system is bootstrapped - before the extension is loaded? What's your fallback behavior?" In civicrm#15411, it used a fallback behavior of "do no translation". In theory, you shouldn't really get into this scenario since UIs are pretty much always generated post-boot. However, it turns out that there is a situation where you have an un-booted system and need to translate strings -- i.e. when generating the localized `civicrm_data.*.mysql` data. Hence the bug. This patch preserves most of the changes from civicrm#15411, but it changes the fallback behavior from "do no translation" to "use the built-in/default translator".
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Custom ts functions didn't work when they are defined by extensions. The reason is that the
I18nclass starts looking for it when the extension files aren'trequired yet, and then gives up before they become available.Before
If you set a custom ts function (
CRM_Core_Config::singleton()->customTranslateFunction) that is defined in themodule.phpfile in an extension, it wouldn't work.After
It does work.
Technical Details
Changes discussed with @totten:
\Civi\Core\Container::isContainerBooted()instead of\Civi\Core\Container::getBootService('settings_manager')$areSettingsAvailableto$bootstrapReadyfor clarity.skip_translationflag tots()parametersavoid spinning up gettext during bootstrap (in case there is a custom ts function)Comments
Anything else you would like the reviewer to note