Alixar\Base\Translate::load()

Complexity

Conditions	57
Paths	> 20000

Size

Total Lines	196
Code Lines	101

Duplication

Lines	0
Ratio	0 %

Importance

Changes

0

<?php
    function load($domain, $alt = 0, $stopafterdirection = 0, $forcelangdir = '', $loadfromfileonly = 0)
    {
        global $conf, $db;

        //dol_syslog("Translate::Load Start domain=".$domain." alt=".$alt." forcelangdir=".$forcelangdir." this->defaultlang=".$this->defaultlang);
        // Check parameters
        if (empty($domain)) {
            dol_print_error('', get_class($this) . "::Load ErrorWrongParameters");
            return -1;
        }
        if ($this->defaultlang == 'none_NONE')
            return 0;    // Special language code to not translate keys


// Load $this->tab_translate[] from database
        if (empty($loadfromfileonly) && count($this->tab_translate) == 0)
            $this->loadFromDatabase($db);      // No translation was never loaded yet, so we load database.


        $newdomain = $domain;
        $modulename = '';

        // Search if a module directory name is provided into lang file name
        if (preg_match('/^([^@]+)@([^@]+)$/i', $domain, $regs)) {
            $newdomain = $regs[1];
            $modulename = $regs[2];
        }

        // Check cache
        if (!empty($this->_tab_loaded[$newdomain])) { // File already loaded for this domain
            //dol_syslog("Translate::Load already loaded for newdomain=".$newdomain);
            return 0;
        }

        $fileread = 0;
        $langofdir = (empty($forcelangdir) ? $this->defaultlang : $forcelangdir);

        // Redefine alt
        $langarray = explode('_', $langofdir);
        if ($alt < 1 && isset($langarray[1]) && (strtolower($langarray[0]) == strtolower($langarray[1]) || in_array(strtolower($langofdir), array('el_gr'))))
            $alt = 1;
        if ($alt < 2 && strtolower($langofdir) == 'en_us')
            $alt = 2;

        if (empty($langofdir)) { // This may occurs when load is called without setting the language and without providing a value for forcelangdir
            dol_syslog("Error: " . get_class($this) . "::Load was called but language was not set yet with langs->setDefaultLang(). Nothing will be loaded.", LOG_WARNING);
            return -1;
        }

        foreach ($this->dir as $keydir => $searchdir) {
            // Directory of translation files
            $file_lang = $searchdir . ($modulename ? '/' . $modulename : '') . "/langs/" . $langofdir . "/" . $newdomain . ".lang";
            $file_lang_osencoded = AlDolUtils::dol_osencode($file_lang);

            $filelangexists = is_file($file_lang_osencoded);

            //dol_syslog(get_class($this).'::Load Try to read for alt='.$alt.' langofdir='.$langofdir.' domain='.$domain.' newdomain='.$newdomain.' modulename='.$modulename.' file_lang='.$file_lang." => filelangexists=".$filelangexists);
            //print 'Try to read for alt='.$alt.' langofdir='.$langofdir.' domain='.$domain.' newdomain='.$newdomain.' modulename='.$modulename.' this->_tab_loaded[newdomain]='.$this->_tab_loaded[$newdomain].' file_lang='.$file_lang." => filelangexists=".$filelangexists."\n";

            if ($filelangexists) {
                // TODO Move cache read out of loop on dirs or at least filelangexists
                $found = false;

                // Enable caching of lang file in memory (not by default)
                $usecachekey = '';
                // Using a memcached server
                if (!empty($conf->memcached->enabled) && !empty($conf->global->MEMCACHED_SERVER)) {
                    $usecachekey = $newdomain . '_' . $langofdir . '_' . md5($file_lang);    // Should not contains special chars
                } // Using cache with shmop. Speed gain: 40ms - Memory overusage: 200ko (Size of session cache file)
                else if (isset($conf->global->MAIN_OPTIMIZE_SPEED) && ($conf->global->MAIN_OPTIMIZE_SPEED & 0x02)) {
                    $usecachekey = $newdomain;
                }

                if ($usecachekey) {
                    //dol_syslog('Translate::Load we will cache result into usecachekey '.$usecachekey);
                    //global $aaa; $aaa+=1;
                    //print $aaa." ".$usecachekey."\n";
                    require_once DOL_BASE_PATH . '/core/lib/memory.lib.php';
                    $tmparray = dol_getcache($usecachekey);
                    if (is_array($tmparray) && count($tmparray)) {
                        $this->tab_translate += $tmparray; // Faster than array_merge($tmparray,$this->tab_translate). Note: If a value already exists into tab_translate, value into tmparaay is not added.
                        //print $newdomain."\n";
                        //var_dump($this->tab_translate);
                        if ($alt == 2)
                            $fileread = 1;
                        $found = true;      // Found in dolibarr PHP cache
                    }
                }

                if (!$found) {
                    if ($fp = @fopen($file_lang, "rt")) {
                        if ($usecachekey)
                            $tabtranslatedomain = array(); // To save lang content in cache

                        /**
                         * Read each lines until a '=' (with any combination of spaces around it)
                         * and split the rest until a line feed.
                         * This is more efficient than fgets + explode + trim by a factor of ~2.
                         */
                        while ($line = fscanf($fp, "%[^= ]%*[ =]%[^\n]")) {
                            if (isset($line[1])) {
                                list($key, $value) = $line;
                                //if ($domain == 'orders') print "Domain=$domain, found a string for $tab[0] with value $tab[1]. Currently in cache ".$this->tab_translate[$key]."<br>";
                                //if ($key == 'Order') print "Domain=$domain, found a string for key=$key=$tab[0] with value $tab[1]. Currently in cache ".$this->tab_translate[$key]."<br>";
                                if (empty($this->tab_translate[$key])) { // If translation was already found, we must not continue, even if MAIN_FORCELANGDIR is set (MAIN_FORCELANGDIR is to replace lang dir, not to overwrite entries)
                                    $value = preg_replace('/\\n/', "\n", $value); // Parse and render carriage returns
                                    if ($key == 'DIRECTION') { // This is to declare direction of language
                                        if ($alt < 2 || empty($this->tab_translate[$key])) { // We load direction only for primary files or if not yet loaded
                                            $this->tab_translate[$key] = $value;
                                            if ($stopafterdirection) {
                                                break; // We do not save tab if we stop after DIRECTION
                                            } elseif ($usecachekey) {
                                                $tabtranslatedomain[$key] = $value;
                                            }
                                        }
                                    } elseif ($key[0] == '#') {
                                        continue;
                                    } else {
                                        $this->tab_translate[$key] = $value;
                                        //if ($domain == 'orders') print "$tab[0] value $value<br>";
                                        if ($usecachekey) {
                                            $tabtranslatedomain[$key] = $value;
                                        } // To save lang content in cache
                                    }
                                }
                            }
                        }
                        fclose($fp);
                        $fileread = 1;

                        // TODO Move cache write out of loop on dirs
                        // To save lang content for usecachekey into cache
                        if ($usecachekey && count($tabtranslatedomain)) {
                            $ressetcache = dol_setcache($usecachekey, $tabtranslatedomain);
                            if ($ressetcache < 0) {
                                $error = 'Failed to set cache for usecachekey=' . $usecachekey . ' result=' . $ressetcache;
                                dol_syslog($error, LOG_ERR);
                            }
                        }

                        if (empty($conf->global->MAIN_FORCELANGDIR))
                            break;  // Break loop on each root dir. If a module has forced dir, we do not stop loop.
                    }
                }
            }
        }

        // Now we complete with next file (fr_CA->fr_FR, es_MX->ex_ES, ...)
        if ($alt == 0) {
            // This function MUST NOT contains call to syslog
            //dol_syslog("Translate::Load loading alternate translation file (to complete ".$this->defaultlang."/".$newdomain.".lang file)", LOG_DEBUG);
            $langofdir = strtolower($langarray[0]) . '_' . strtoupper($langarray[0]);
            if ($langofdir == 'el_EL')
                $langofdir = 'el_GR';                     // main parent for el_CY is not 'el_EL' but 'el_GR'
            if ($langofdir == 'ar_AR')
                $langofdir = 'ar_SA';                     // main parent for ar_EG is not 'ar_AR' but 'ar_SA'
            $this->load($domain, $alt + 1, $stopafterdirection, $langofdir);
        }

        // Now we complete with reference file (en_US)
        if ($alt == 1) {
            // This function MUST NOT contains call to syslog
            //dol_syslog("Translate::Load loading alternate translation file (to complete ".$this->defaultlang."/".$newdomain.".lang file)", LOG_DEBUG);
            $langofdir = 'en_US';
            $this->load($domain, $alt + 1, $stopafterdirection, $langofdir);
        }

        // We are in the pass of the reference file. No more files to scan to complete.
        if ($alt == 2) {
            if ($fileread)
                $this->_tab_loaded[$newdomain] = 1;        // Set domain file as found so loaded

            if (empty($this->_tab_loaded[$newdomain]))
                $this->_tab_loaded[$newdomain] = 2; // Set this file as not found
        }

        // This part is deprecated and replaced with table llx_overwrite_trans
        // Kept for backward compatibility.
        if (empty($loadfromfileonly)) {
            $overwritekey = 'MAIN_OVERWRITE_TRANS_' . $this->defaultlang;
            if (!empty($conf->global->$overwritekey)) {    // Overwrite translation with key1:newstring1,key2:newstring2
                // Overwrite translation with param MAIN_OVERWRITE_TRANS_xx_XX
                $tmparray = explode(',', $conf->global->$overwritekey);
                foreach ($tmparray as $tmp) {
                    $tmparray2 = explode(':', $tmp);
                    if (!empty($tmparray2[1]))
                        $this->tab_translate[$tmparray2[0]] = $tmparray2[1];
                }
            }
        }

        // Check to be sure that SeparatorDecimal differs from SeparatorThousand
        if (!empty($this->tab_translate["SeparatorDecimal"]) && !empty($this->tab_translate["SeparatorThousand"]) && $this->tab_translate["SeparatorDecimal"] == $this->tab_translate["SeparatorThousand"])
            $this->tab_translate["SeparatorThousand"] = '';

        return 1;
    }