Extended translations system for arrays & extension

Extended the base Laravel translation system to
allow a locale to be based upon another.

Also adds functionality to take base & fallback locales into account when fetching
an array of translations.

Related to work done in BookStackApp#1159

app/Http/Controllers/HomeController.php

@@ -79,6 +79,7 @@ public function getTranslations()
     {
         $locale = app()->getLocale();
         $cacheKey = 'GLOBAL_TRANSLATIONS_' . $locale;
+
         if (cache()->has($cacheKey) && config('app.env') !== 'development') {
             $resp = cache($cacheKey);
         } else {
@@ -89,15 +90,6 @@ public function getTranslations()
                 'entities' => trans('entities'),
                 'errors' => trans('errors')
             ];
-            if ($locale !== 'en') {
-                $enTrans = [
-                    'common' => trans('common', [], 'en'),
-                    'components' => trans('components', [], 'en'),
-                    'entities' => trans('entities', [], 'en'),
-                    'errors' => trans('errors', [], 'en')
-                ];
-                $translations = array_replace_recursive($enTrans, $translations);
-            }
             $resp = 'window.translations = ' . json_encode($translations);
             cache()->put($cacheKey, $resp, 120);
         }

app/Providers/TranslationServiceProvider.php

@@ -0,0 +1,32 @@
+<?php namespace BookStack\Providers;
+
+
+use BookStack\Translation\Translator;
+
+class TranslationServiceProvider extends \Illuminate\Translation\TranslationServiceProvider
+{
+    /**
+     * Register the service provider.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        $this->registerLoader();
+
+        $this->app->singleton('translator', function ($app) {
+            $loader = $app['translation.loader'];
+
+            // When registering the translator component, we'll need to set the default
+            // locale as well as the fallback locale. So, we'll grab the application
+            // configuration so we can easily get both of these values from there.
+            $locale = $app['config']['app.locale'];
+
+            $trans = new Translator($loader, $locale);
+
+            $trans->setFallback($app['config']['app.fallback_locale']);
+
+            return $trans;
+        });
+    }
+}

app/Translation/Translator.php

@@ -0,0 +1,74 @@
+<?php namespace BookStack\Translation;
+
+
+class Translator extends \Illuminate\Translation\Translator
+{
+
+    /**
+     * Mapping of locales to their base locales
+     * @var array
+     */
+    protected $baseLocaleMap = [
+        'de_informal' => 'de',
+    ];
+
+    /**
+     * Get the translation for a given key.
+     *
+     * @param  string  $key
+     * @param  array   $replace
+     * @param  string  $locale
+     * @return string|array|null
+     */
+    public function trans($key, array $replace = [], $locale = null)
+    {
+        $translation = $this->get($key, $replace, $locale);
+
+        if (is_array($translation)) {
+            $translation = $this->mergeBackupTranslations($translation, $key, $locale);
+        }
+
+        return $translation;
+    }
+
+    /**
+     * Merge the fallback translations, and base translations if existing,
+     * into the provided core key => value array of translations content.
+     * @param array $translationArray
+     * @param string $key
+     * @param null $locale
+     * @return array
+     */
+    protected function mergeBackupTranslations(array $translationArray, string $key, $locale = null)
+    {
+        $fallback = $this->get($key, [], $this->fallback);
+        $baseLocale = $this->getBaseLocale($locale ?? $this->locale);
+        $baseTranslations = $baseLocale ? $this->get($key, [], $baseLocale) : [];
+
+        return array_replace_recursive($fallback, $baseTranslations, $translationArray);
+    }
+
+    /**
+     * Get the array of locales to be checked.
+     *
+     * @param  string|null  $locale
+     * @return array
+     */
+    protected function localeArray($locale)
+    {
+        $primaryLocale = $locale ?: $this->locale;
+        return array_filter([$primaryLocale, $this->getBaseLocale($primaryLocale), $this->fallback]);
+    }
+
+    /**
+     * Get the locale to extend for the given locale.
+     *
+     * @param string $locale
+     * @return string|null
+     */
+    protected function getBaseLocale($locale)
+    {
+        return $this->baseLocaleMap[$locale] ?? null;
+    }
+
+}

composer.json

@@ -6,6 +6,7 @@
     "type": "project",
     "require": {
         "php": ">=7.0.0",
+        "ext-json": "*",
         "ext-tidy": "*",
         "ext-dom": "*",
         "laravel/framework": "~5.5.44",

config/app.php

@@ -187,7 +187,6 @@
         Illuminate\Redis\RedisServiceProvider::class,
         Illuminate\Auth\Passwords\PasswordResetServiceProvider::class,
         Illuminate\Session\SessionServiceProvider::class,
-        Illuminate\Translation\TranslationServiceProvider::class,
         Illuminate\Validation\ValidationServiceProvider::class,
         Illuminate\View\ViewServiceProvider::class,
         Illuminate\Notifications\NotificationServiceProvider::class,
@@ -205,6 +204,7 @@
          * Application Service Providers...
          */
         BookStack\Providers\PaginationServiceProvider::class,
+        BookStack\Providers\TranslationServiceProvider::class,
 
         BookStack\Providers\AuthServiceProvider::class,
         BookStack\Providers\AppServiceProvider::class,

resources/lang/de_informal/activities.php

@@ -1,8 +1,6 @@
 <?php
-$de_formal = (include resource_path() . '/lang/de/' . basename(__FILE__));
 
-$de_informal = [
-
-];
-
-return array_replace($de_formal, $de_informal);
+// Extends 'de'
+return [
+    //
+];

resources/lang/de_informal/auth.php

@@ -1,7 +1,8 @@
 <?php
-$de_formal = (include resource_path() . '/lang/de/' . basename(__FILE__));
 
-$de_informal = [
+// Extends 'de'
+return [
+
     /*
     |--------------------------------------------------------------------------
     | Authentication Language Lines
@@ -13,13 +14,15 @@
     |
     */
     'throttle' => 'Zu viele Anmeldeversuche. Bitte versuche es in :seconds Sekunden erneut.',
+
     /**
      * Login & Register
      */
     'ldap_email_hint' => 'Bitte gib eine E-Mail-Adresse ein, um diese mit dem Account zu nutzen.',
     'register_confirm' => 'Bitte prüfe Deinen Posteingang und bestätig die Registrierung.',
     'registration_email_domain_invalid' => 'Du kannst dich mit dieser E-Mail nicht registrieren.',
     'register_success' => 'Vielen Dank für Deine Registrierung! Die Daten sind gespeichert und Du bist angemeldet.',
+
     /**
      * Password Reset
      */
@@ -28,6 +31,7 @@
     'reset_password_success' => 'Dein Passwort wurde erfolgreich zurückgesetzt.',
     'email_reset_text' => 'Du erhältsts diese E-Mail, weil jemand versucht hat, Dein Passwort zurückzusetzen.',
     'email_reset_not_requested' => 'Wenn Du das nicht warst, brauchst Du nichts weiter zu tun.',
+
     /**
      * Email Confirmation
      */
@@ -40,6 +44,4 @@
     'email_not_confirmed_text' => 'Deine E-Mail-Adresse ist bisher nicht bestätigt.',
     'email_not_confirmed_click_link' => 'Bitte klicke auf den Link in der E-Mail, die Du nach der Registrierung erhalten hast.',
     'email_not_confirmed_resend' => 'Wenn Du die E-Mail nicht erhalten hast, kannst Du die Nachricht erneut anfordern. Fülle hierzu bitte das folgende Formular aus:',
-];
-
-return array_replace($de_formal, $de_informal);
+];

resources/lang/de_informal/common.php

@@ -1,11 +1,9 @@
 <?php
-$de_formal = (include resource_path() . '/lang/de/' . basename(__FILE__));
 
-$de_informal = [
+// Extends 'de'
+return [
     /**
      * Email Content
      */
     'email_action_help' => 'Sollte es beim Anklicken der Schaltfläche ":action_text" Probleme geben, öffne die folgende URL in Deinem Browser:',
-];
-
-return array_replace($de_formal, $de_informal);
+];

resources/lang/de_informal/components.php

@@ -1,12 +1,10 @@
 <?php
-$de_formal = (include resource_path() . '/lang/de/' . basename(__FILE__));
 
-$de_informal = [
+// Extends 'de'
+return [
     /**
      * Image Manager
      */
     'image_delete_confirm' => 'Bitte klicke erneut auf löschen, wenn Du dieses Bild wirklich entfernen möchtest.',
     'image_dropzone' => 'Ziehe Bilder hierher oder klicke hier, um ein Bild auszuwählen',
-];
-
-return array_replace($de_formal, $de_informal);
+];

resources/lang/de_informal/entities.php

@@ -1,21 +1,24 @@
 <?php
-$de_formal = (include resource_path() . '/lang/de/' . basename(__FILE__));
 
-$de_informal = [
+// Extends 'de'
+return [
     /**
      * Shared
      */
     'no_pages_viewed' => 'Du hast bisher keine Seiten angesehen.',
     'no_pages_recently_created' => 'Du hast bisher keine Seiten angelegt.',
     'no_pages_recently_updated' => 'Du hast bisher keine Seiten aktualisiert.',
+
     /**
      * Books
      */
     'books_delete_confirmation' => 'Bist Du sicher, dass Du dieses Buch löschen möchtest?',
+
     /**
      * Chapters
      */
     'chapters_delete_confirm' => 'Bist Du sicher, dass Du dieses Kapitel löschen möchtest?',
+
     /**
      * Pages
      */
@@ -30,6 +33,7 @@
         'time_b' => 'in den letzten :minCount Minuten',
         'message' => ':start :time. Achte darauf, keine Änderungen von anderen Benutzern zu überschreiben!',
     ],
+
     /**
      * Editor sidebar
      */
@@ -39,15 +43,15 @@
     'attachments_dropzone' => 'Ziehe Dateien hierher oder klicke hier, um eine Datei auszuwählen',
     'attachments_explain_link' => 'Wenn Du keine Datei hochladen möchtest, kannst Du stattdessen einen Link hinzufügen. Dieser Link kann auf eine andere Seite oder eine Datei im Internet verweisen.',
     'attachments_edit_drop_upload' => 'Ziehe Dateien hierher, um diese hochzuladen und zu überschreiben',
+
     /**
      * Comments
      */
     'comment_placeholder' => 'Gib hier Deine Kommentare ein (Markdown unterstützt)',
     'comment_delete_confirm' => 'Möchtst Du diesen Kommentar wirklich löschen?',
+
     /**
      * Revision
      */
     'revision_delete_confirm' => 'Bist Du sicher, dass Du diese Revision löschen möchtest?',
 ];
-
-return array_replace($de_formal, $de_informal);

resources/lang/de_informal/errors.php

@@ -1,29 +1,32 @@
 <?php
-$de_formal = (include resource_path() . '/lang/de/' . basename(__FILE__));
 
-$de_informal = [
+// Extends 'de'
+return [
     // Pages
     'permission' => 'Du hast keine Berechtigung, auf diese Seite zuzugreifen.',
     'permissionJson' => 'Du hast keine Berechtigung, die angeforderte Aktion auszuführen.',
+
     // Auth
     'email_already_confirmed' => 'Die E-Mail-Adresse ist bereits bestätigt. Bitte melde dich an.',
     'email_confirmation_invalid' => 'Der Bestätigungslink ist nicht gültig oder wurde bereits verwendet. Bitte registriere dich erneut.',
     'social_account_in_use' => 'Dieses :socialAccount-Konto wird bereits verwendet. Bitte melde dich mit dem :socialAccount-Konto an.',
     'social_account_email_in_use' => 'Die E-Mail-Adresse ":email" ist bereits registriert. Wenn Du bereits registriert bist, kannst Du Dein :socialAccount-Konto in Deinen Profil-Einstellungen verknüpfen.',
     'social_account_not_used' => 'Dieses :socialAccount-Konto ist bisher keinem Benutzer zugeordnet. Du kannst das in Deinen Profil-Einstellungen tun.',
     'social_account_register_instructions' => 'Wenn Du bisher kein Social-Media Konto besitzt, kannst Du ein solches Konto mit der :socialAccount Option anlegen.',
+
     // System
     'path_not_writable' => 'Die Datei kann nicht in den angegebenen Pfad :filePath hochgeladen werden. Stelle sicher, dass dieser Ordner auf dem Server beschreibbar ist.',
     'cannot_create_thumbs' => 'Der Server kann keine Vorschau-Bilder erzeugen. Bitte prüfe, ob die GD PHP-Erweiterung installiert ist.',
     'server_upload_limit' => 'Der Server verbietet das Hochladen von Dateien mit dieser Dateigröße. Bitte versuche es mit einer kleineren Datei.',
+
     // Pages
     'page_draft_autosave_fail' => 'Fehler beim Speichern des Entwurfs. Stelle sicher, dass Du mit dem Internet verbunden bist, bevor Du den Entwurf dieser Seite speicherst.',
     'page_custom_home_deletion' => 'Eine als Startseite gesetzte Seite kann nicht gelöscht werden.',
+
     // Users
     'users_cannot_delete_only_admin' => 'Du kannst den einzigen Administrator nicht löschen.',
     'users_cannot_delete_guest' => 'Du kannst den Gast-Benutzer nicht löschen',
+
     // Error pages
     'sorry_page_not_found' => 'Entschuldigung. Die Seite, die Du angefordert hast, wurde nicht gefunden.',
 ];
-
-return array_replace($de_formal, $de_informal);

resources/lang/de_informal/pagination.php

@@ -1,8 +1,6 @@
 <?php
-$de_formal = (include resource_path() . '/lang/de/' . basename(__FILE__));
 
-$de_informal = [
-
-];
-
-return array_replace($de_formal, $de_informal);
+// Extends 'de'
+return [
+    //
+];

resources/lang/de_informal/passwords.php

@@ -1,8 +1,6 @@
 <?php
-$de_formal = (include resource_path() . '/lang/de/' . basename(__FILE__));
 
-$de_informal = [
-
-];
-
-return array_replace($de_formal, $de_informal);
+// Extends 'de'
+return [
+    //
+];