add ltm_user_locales ui_settings for react, fix user_id index to unique.

Author: vsch

database/migrations/2018_04_09_17054701_add_ui_settings_to_ltm_user_locales.php

@@ -0,0 +1,41 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+
+class AddUiSettingsToLtmUserLocales extends Migration
+{
+
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        $prefix = \Config::get('laravel-translation-manager::config.table_prefix', '');
+        Schema::table($prefix . 'ltm_user_locales', function (Blueprint $table) use ($prefix) {
+            $table->dropIndex('ix_ltm_user_locales_user_id');
+
+            $table->unique('user_id', 'ixk_user_id_users_id');
+            $table->text('ui_settings')->nullable();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        $prefix = \Config::get('laravel-translation-manager::config.table_prefix', '');
+        Schema::table($prefix . 'ltm_user_locales', function (Blueprint $table) use ($prefix) {
+            $table->dropColumn('ui_settings');
+
+            $table->dropUnique('ixk_user_id_users_id');
+            $table->index(['user_id'], 'ix_ltm_user_locales_user_id');
+        });
+    }
+
+}

src/Controller.php

@@ -10,7 +10,6 @@
 use Illuminate\Support\Facades\Request;
 use Illuminate\Support\Facades\Response;
 use Illuminate\Support\Facades\Route;
-use Illuminate\Support\Facades\Session;
 use Illuminate\Support\Facades\View;
 use Symfony\Component\HttpFoundation\ParameterBag;
 use Vsch\TranslationManager\Events\TranslationsPublished;
@@ -111,7 +110,18 @@ private function loadCookieData()
         $this->displayLocales = $displayLocales;
 
 //        $this->webUIState = json_decode(Cookie::get($this->cookieName(self::COOKIE_WEB_UI_STATE), "{}"), true);
-        $this->webUIState = Session::get($this->manager->config(Manager::PERSISTENT_PREFIX_KEY) . Manager::WEB_UI_SETTINGS_PERSISTENT_SUFFIX, null);
+//        $this->webUIState = Session::get($this->manager->config(Manager::PERSISTENT_PREFIX_KEY) . Manager::WEB_UI_SETTINGS_PERSISTENT_SUFFIX, null);
+        $this->webUIState = null;
+        $userId = Auth::id();
+        if ($userId !== null) {
+            $userLocalesModel = new UserLocales();
+            $userLocalesModel->setConnection($connectionName);
+            $userLocalesResult = $userLocalesModel->query()->where('user_id', $userId)->first();
+            if ($userLocalesResult && $userLocalesResult->ui_settings) {
+                $this->webUIState = json_decode($userLocalesResult->ui_settings, true);
+            }
+        }
+
         if (!$this->webUIState) {
             // put defaults in it
             $this->webUIState = [];
@@ -170,7 +180,7 @@ private function normalizeLocaleDataRaw()
                 $userLocalesModel = new UserLocales();
                 $userLocalesModel->setConnection($connectionName);
                 $userLocalesResult = $userLocalesModel->query()->where('user_id', $userId)->first();
-                if ($userLocalesResult && trim($userLocalesResult->locales)) {
+                if ($userLocalesResult && $userLocalesResult->locales && trim($userLocalesResult->locales)) {
                     $userLocales = explode(',', $userLocalesResult->locales);
                 }
             }
@@ -694,10 +704,18 @@ private function processUISettings($json)
             }
         }
 
-        if ($hadWebUIState) {
-            Session::put($this->manager->config(Manager::PERSISTENT_PREFIX_KEY) . Manager::WEB_UI_SETTINGS_PERSISTENT_SUFFIX, $this->webUIState);
-        } else {
-            Session::remove($this->manager->config(Manager::PERSISTENT_PREFIX_KEY) . Manager::WEB_UI_SETTINGS_PERSISTENT_SUFFIX);
+        $userId = Auth::id();
+        if ($userId !== null) {
+            if ($hadWebUIState) {
+                $userLocalesModel = new UserLocales();
+                $userLocalesModel->setConnection($this->getConnectionName());
+                $userLocalesResult = $userLocalesModel->query()->where('user_id', $userId)->firstOrNew([]);
+                $json_encode = json_encode($this->webUIState, JSON_PRETTY_PRINT);
+                $userLocalesResult->ui_settings = $json_encode;
+                $userLocalesResult->user_id = $userLocalesResult->user_id ?: $userId;
+                $userLocalesResult->locales = $userLocalesResult->locales ?: '';
+                $userLocalesResult->save();
+            }
         }
 
         // do all the init processing so the returned results are adjusted for display locales and the rest

src/Manager.php

@@ -40,7 +40,6 @@ class Manager
     const EXCLUDE_GROUPS_KEY = 'exclude_groups';
     const MISSING_KEYS_LOTTERY_KEY = 'missing_keys_lottery';
     const LOTTERY_PERSISTENT_SUFFIX = 'lottery';
-    const WEB_UI_SETTINGS_PERSISTENT_SUFFIX = 'web_ui_settings';
     const LOG_KEY_USAGE_INFO_KEY = 'log_key_usage_info';
     const ADDITIONAL_LOCALES_KEY = 'locales';
     const SHOW_LOCALES_KEY = 'show_locales';

versioninfo.md

@@ -3,6 +3,12 @@
 The 1.x.x versions are for Laravel 4.2, 2.1.x versions are for Laravel 5.1+, 2.3.x for Laravel
 5.3, 2.4.x for Laravel 5.4, 2.5.x for Laravel 5.5 and 2.6.x for Laravel 5.6 compatibility.
 
+#### Next: 2.6.8
+
+* Add: ui_settings to ltm_user_locales to store the user's react ui app settings for
+  persistence. Sessions are too short and too much data for one cookie and splitting is a pain.
+* Fix: change ltm_user_locales index on user_id to unique 
+
 #### Next: 2.6.6
 
 * Fix: Pass x-edit popup title translations to JS