Merge pull request #5 from marktopper/master

Cache the language strings

Author: marktopper

src/TranslationServiceProvider.php

@@ -13,7 +13,7 @@ class TranslationServiceProvider extends LaravelTranslationServiceProvider
      */
     public function boot()
     {
-        parent::boot();
+        //parent::boot();
 
         $this->publishes([
             __DIR__.'/../config/languagecenter.php' => config_path('languagecenter.php'),

src/Translator.php

@@ -2,9 +2,10 @@
 
 namespace Novasa\LaravelLanguageCenter;
 
+use Carbon\Carbon;
 use GuzzleHttp\Client;
 use Illuminate\Support\Arr;
-use Illuminate\Support\Facades\Config;
+use Illuminate\Support\Facades\Cache;
 use Illuminate\Translation\LoaderInterface;
 use Illuminate\Translation\Translator as LaravelTranslator;
 
@@ -26,7 +27,7 @@ public function __construct(LoaderInterface $loader, $locale)
         $this->loader = $loader;
         $this->locale = $locale;
 
-        // Load langauges from API
+        // Load languages from API
         if (count($this->languages) == 0) {
             $this->loadLanguages();
         }
@@ -47,24 +48,30 @@ public function get($data, array $replace = [], $locale = null, $fallback = true
         // Make support for array data
         if (is_array($data)) {
             $key = $data['key'];
+
             if (isset($data['string'])) {
                 $string = $data['string'];
             }
+
             if (isset($data['platform'])) {
                 $platform = $data['platform'];
             }
+
             if (isset($data['comment'])) {
                 $comment = $data['comment'];
             }
         } else {
             $key = $data;
         }
+
         if (!isset($string)) {
             $string = $key;
         }
+
         if (!isset($platform)) {
             $platform = $this->getDefaultPlatform();
         }
+
         if (!isset($comment)) {
             $comment = null;
         }
@@ -106,42 +113,37 @@ public function get($data, array $replace = [], $locale = null, $fallback = true
         return $line;
     }
 
-    /**
-     * Retrieve a language line out the loaded array.
-     *
-     * @param string $namespace
-     * @param string $group
-     * @param string $locale
-     * @param string $item
-     * @param array  $replace
-     *
-     * @return string|array|null
-     */
-    protected function getLine($namespace, $group, $locale, $item, array $replace, $platform = null)
+    public function setLocale($locale)
     {
-        if ($platform == null) {
-            $platform = $this->getDefaultPlatform();
-        }
+        config()->set('app.locale', $locale);
+        config()->set('fallback_locale', $locale);
 
-        $this->loadLanguageStrings($locale, $platform);
+        $this->locale = $locale;
+    }
 
-        $key = implode('.', [$group, $item]);
-        if (isset($this->strings[$locale]) && isset($this->strings[$locale][$key])) {
-            return $this->makeReplacements($this->strings[$locale][$key], $replace);
+    public function loadLanguages()
+    {
+        $timestamp = Carbon::now()->subSeconds($this->getUpdateAfter())->timestamp;
+        $lastUpdated = Cache::get('languagecenter.timestamp', 0);
+
+        if ($timestamp > $lastUpdated && !is_null($timestamp)) {
+            $this->updateLanguages();
         }
 
-        $line = Arr::get($this->loaded[$namespace][$group][$locale], $item);
+        $languages = Cache::get('languagecenter.languages');
 
-        if (is_string($line)) {
-            return $this->makeReplacements($line, $replace);
-        } elseif (is_array($line) && count($line) > 0) {
-            return $line;
+        foreach ($languages as $language) {
+            $this->languages[] = $language->codename;
+
+            if ($language->is_fallback) {
+                $this->setLocale($language->codename);
+            }
         }
     }
 
-    protected function loadLanguageStrings($locale, $platform = null, $force = false)
+    public function loadStrings($locale, $platform = null, $check = null)
     {
-        // Load langauges from API
+        // Load languages from API
         if (count($this->languages) == 0) {
             $this->loadLanguages();
         }
@@ -150,82 +152,96 @@ protected function loadLanguageStrings($locale, $platform = null, $force = false
             $platform = $this->getDefaultPlatform();
         }
 
-        if (in_array($locale, $this->languages)) {
-            if ($force or !isset($this->strings[$locale])) {
-                $client = $this->getClient();
+        if (is_null($check)) {
+            $check = !is_null($this->getUpdateAfter());
+        }
 
-                $res = $client->request('GET', $this->getApiUrl().'strings?platform='.$platform.'&language='.$locale, [
-                    'auth' => $this->getAuthentication(),
-                ]);
+        if ($check) {
+            $languages = Cache::get('languagecenter.languages', []);
 
-                if ($res->getStatusCode() != 200) {
-                    throw new ApiException("API returned status [{$res->getStatusCode()}].");
-                }
+            foreach ($languages as $language) {
+                $timestamp = Cache::get('languagecenter.language.'.$language->codename.'.timestamp', 0);
 
-                $strings = json_decode((string) $res->getBody());
-
-                $this->strings[$locale] = [];
-                foreach ($strings as $string) {
-                    $this->strings[$locale][$string->key] = $string->value;
-                    $this->strings[$string->language][$string->key] = $string->value;
+                if ($language->timestamp > $timestamp) {
+                    $this->updateStrings($locale, $platform);
                 }
             }
         }
-    }
 
-    protected function getClient()
-    {
-        return new Client();
+        $this->strings = Cache::get('languagecenter.strings', []);
     }
 
-    protected function getApiUrl()
+    public function updateLanguages()
     {
-        return Config::get('languagecenter.url');
-    }
+        $timestamp = Carbon::now()->timestamp;
 
-    protected function getUsername()
-    {
-        return Config::get('languagecenter.username');
-    }
+        $client = $this->getClient();
 
-    protected function getPassword()
-    {
-        return Config::get('languagecenter.password');
-    }
+        try {
+            $res = $client->request('GET', $this->getApiUrl() . 'languages', [
+                'auth' => $this->getAuthentication(),
+                'query' => [
+                    'timestamp' => 'on',
+                ],
+            ]);
 
-    protected function getAuthentication()
-    {
-        return [
-            $this->getUsername(),
-            $this->getPassword(),
-        ];
+            if ($res->getStatusCode() != 200) {
+                throw new ApiException("API returned status [{$res->getStatusCode()}].");
+            }
+
+            $languages = json_decode((string)$res->getBody());
+
+            Cache::forever('languagecenter.languages', $languages);
+            Cache::forever('languagecenter.timestamp', $timestamp);
+        } catch (\Exception $exception) {
+            $languages = Cache::get('languagecenter.languages');
+
+            if (is_null($languages)) {
+                throw $exception; // Nothing to do, can not restore data, throw exception
+            }
+        }
     }
 
-    protected function loadLanguages()
+    public function updateStrings($locale, $platform = null)
     {
-        $client = $this->getClient();
+        try {
+            $timestamp = Carbon::now()->timestamp;
 
-        $res = $client->request('GET', $this->getApiUrl().'languages', [
-            'auth' => $this->getAuthentication(),
-        ]);
+            if (is_null($platform)) {
+                $platform = $this->getDefaultPlatform();
+            }
 
-        if ($res->getStatusCode() != 200) {
-            throw new ApiException("API returned status [{$res->getStatusCode()}].");
-        }
+            $client = $this->getClient();
 
-        $languages = json_decode((string) $res->getBody());
+            $res = $client->request('GET', $this->getApiUrl() . 'strings?platform=' . $platform . '&language=' . $locale, [
+                'auth' => $this->getAuthentication(),
+            ]);
 
-        foreach ($languages as $language) {
-            $this->languages[] = $language->codename;
-            if ($language->is_fallback) {
-                Config::set('app.locale', $language->codename);
-                Config::set('app.fallback_locale', $language->codename);
-                $this->locale = $language->codename;
+            if ($res->getStatusCode() != 200) {
+                throw new ApiException("API returned status [{$res->getStatusCode()}].");
+            }
+
+            $strings = json_decode((string)$res->getBody());
+
+            if (!isset($this->strings[$locale])) {
+                $this->strings[$locale] = [];
             }
+
+            $this->strings[$locale][$platform] = [];
+
+            foreach ($strings as $string) {
+                $this->strings[$locale][$platform][$string->key] = $string->value;
+                $this->strings[$string->language][$platform][$string->key] = $string->value;
+            }
+
+            Cache::forever('languagecenter.strings', $this->strings);
+            Cache::forever('languagecenter.language.' . $locale . '.timestamp', $timestamp);
+        } catch (\Exception $exception) {
+            // failed to update string - it's okay - we do it later
         }
     }
 
-    protected function createString($key, $string, $platform = null, $comment = null)
+    public function createString($key, $string, $platform = null, $comment = null)
     {
         if ($platform == null) {
             $platform = $this->getDefaultPlatform();
@@ -240,30 +256,103 @@ protected function createString($key, $string, $platform = null, $comment = null
         $category = str_replace(['_'], [' '], ucfirst(substr($key, 0, $dotpos)));
         $name = str_replace(['_'], [' '], ucfirst(substr($key, $dotpos + 1)));
 
-        $client = $this->getClient();
+        try {
+            $client = $this->getClient();
+
+            $res = $client->request('POST', $this->getApiUrl() . 'string', [
+                'auth' => $this->getAuthentication(),
+                'form_params' => [
+                    'platform' => $platform,
+                    'category' => $category,
+                    'key' => $name,
+                    'value' => $string,
+                    'comment' => $comment,
+                ],
+            ]);
+
+            if ($res->getStatusCode() != 200) {
+                throw new ApiException("API returned status [{$res->getStatusCode()}].");
+            }
+        } catch (\Exception $exception) {
+            // failed to create string, will just try later.
+        }
+
+        foreach ($this->strings as $locale => $platforms) {
+            $this->strings[$locale][$platform][$key] = $string;
+        }
+
+        Cache::forever('languagecenter.strings', $this->strings);
+    }
+
+    /**
+     * Retrieve a language line out the loaded array.
+     *
+     * @param string $namespace
+     * @param string $group
+     * @param string $locale
+     * @param string $item
+     * @param array  $replace
+     *
+     * @return string|array|null
+     */
+    protected function getLine($namespace, $group, $locale, $item, array $replace, $platform = null)
+    {
+        if ($platform == null) {
+            $platform = $this->getDefaultPlatform();
+        }
+
+        $this->loadStrings($locale, $platform);
+
+        $key = implode('.', [$group, $item]);
 
-        $res = $client->request('POST', $this->getApiUrl().'string', [
-            'auth'        => $this->getAuthentication(),
-            'form_params' => [
-                'platform' => $platform,
-                'category' => $category,
-                'key'      => $name,
-                'value'    => $string,
-                'comment'  => $comment,
-            ],
-        ]);
-
-        if ($res->getStatusCode() != 200) {
-            throw new ApiException("API returned status [{$res->getStatusCode()}].");
+        if (isset($this->strings[$locale]) && isset($this->strings[$locale][$platform]) && isset($this->strings[$locale][$platform][$key])) {
+            return $this->makeReplacements($this->strings[$locale][$platform][$key], $replace);
         }
 
-        foreach ($this->strings as $locale => $strings) {
-            $this->strings[$locale][$key] = $string;
+        $line = Arr::get($this->loaded[$namespace][$group][$locale], $item);
+
+        if (is_string($line)) {
+            return $this->makeReplacements($line, $replace);
+        } elseif (is_array($line) && count($line) > 0) {
+            return $line;
         }
     }
 
+    protected function getClient()
+    {
+        return new Client();
+    }
+
+    protected function getApiUrl()
+    {
+        return config('languagecenter.url');
+    }
+
+    protected function getUsername()
+    {
+        return config('languagecenter.username');
+    }
+
+    protected function getPassword()
+    {
+        return config('languagecenter.password');
+    }
+
+    protected function getUpdateAfter()
+    {
+        return config('languagecenter.update_after', 60);
+    }
+
     protected function getDefaultPlatform()
     {
-        return Config::get('languagecenter.platform', 'web');
+        return config('languagecenter.platform', 'web');
+    }
+
+    protected function getAuthentication()
+    {
+        return [
+            $this->getUsername(),
+            $this->getPassword(),
+        ];
     }
 }