locale_manager.inc

<?php
require_once SQ_FUDGE_PATH.'/general/text.inc';


class Locale_Manager extends MySource_Object
{


    public $locale_stack = Array();


    public $_strings = Array();


    public $_errors = Array();


    public $_internal_messages = Array();


    private $_assets_included = Array();
    
    
    private $_packages_included = Array();
    
    
    private $_core_included = Array();
    
    
    function __construct()
    {
        $this->MySource_Object();

    }//end constructor
    
    
    function __destruct()
    {
        if (array_get_index($this->_tmp, 'strings_modified', FALSE) && isset($GLOBALS['SQ_SYSTEM'])) {
            $this->locale_stack = Array();
            // Attempt to store me so that I don't have to go through all that again.
            $deja_vu = $GLOBALS['SQ_SYSTEM']->getDejaVu();
            if ($deja_vu) {
                $deja_vu->remember(SQ_DEJA_VU_LOCALE, NULL, $this);
            }
        }
        
    }//end destructor


    public function getCurrentLocale()
    {
        if (count($this->locale_stack) <= 0) return FALSE; // no locale is current
        return $this->locale_stack[0];

    }//end getCurrentLocale()


    public function getLocaleName($locale_code=NULL)
    {
        if (is_null($locale_code)) {
            $locale_code = $this->getCurrentLocale();
        }
        require SQ_FUDGE_PATH.'/standards_lists/locales.inc';
        return array_get_index($standards_lists_locales, $locale_code, 'Unknown');

    }//end getLocaleName()


    public function setCurrentLocale($locale)
    {
        array_unshift($this->locale_stack, $locale);
        $this->includeCoreStrings($locale);
        
        return TRUE;

    }//end setCurrentLocale()


    public function restoreCurrentLocale()
    {
        if (count($this->locale_stack) <= 0) return FALSE; // stack would underflow if we tried to shift this out
        array_shift($this->locale_stack);
        return TRUE;

    }//end restoreCurrentLocale()


    public function getLocaleParts($locale)
    {
        $locale_parts = Array(NULL, NULL, NULL);

        preg_match('|([A-Za-z]{2})(\_([A-Za-z]{2})(\@([A-Za-z]+))?)?|', $locale, $matches);

        // switch on the number of match expansions we get - if we have all 3
        // parts we will have 6 matches, if we have language and country we will
        // have 4, if just the language we will have 2. This means the time can
        // be ripe for a fall-through switch

        switch (count($matches)) {
            case 6:
                $locale_parts[2] = $matches[5];
            // no break; fall through to case 4

            case 4:
                $locale_parts[1] = $matches[3];
            // no break; fall through to case 2

            case 2:
                $locale_parts[0] = $matches[1];
            break;

            default:
                trigger_localised_error('SYS0193', E_USER_WARNING, $locale);
                return FALSE;
            break;
        }//end switch

        return $locale_parts;

    }//end getLocaleParts()


    public function getCumulativeLocaleParts($locale, $lang_sep='_', $var_sep='@')
    {
        $locale_parts = $this->getLocaleParts($locale);

        $cum_locale_parts = Array();
        $cum_locale_parts[] = $locale_parts[0];

        if (count($cum_locale_parts) >= 2) {
            $cum_locale_parts[] = $cum_locale_parts[0].$lang_sep.$locale_parts[1];

            if (count($cum_locale_parts) >= 3) {
                $cum_locale_parts[] = $cum_locale_parts[1].$var_sep.$locale_parts[2];
            }
        }

        return $cum_locale_parts;

    }//end getCumulativeLocaleParts()


    public function getString($string_code)
    {
        $locale = $this->getCurrentLocale();

        // if second parameter is an array, use that as our list of params
        if (!is_array($func_args = func_get_arg(1))) {
            $func_args = func_get_args();
            $func_args = array_slice($func_args,1);
        }

        if (!isset($this->_strings[$locale])) {
            return "Source string for $string_code not found";
        }

        if (!isset($this->_strings[$locale][$string_code])) {
            return "Source string for $string_code not found for locale $locale";
        }

        return vsprintf($this->_strings[$locale][$string_code],$func_args);

    }//end getString()


    public function includeAssetStrings($type_code, $locale=NULL)
    {
        if (!isset($this->_assets_included[$type_code])) {
            $this->_assets_included[$type_code] = Array();
        }
        
        if ($locale == NULL) {
            $locale = $this->getCurrentLocale();
        }
        
        
        if (!array_get_index($this->_assets_included[$type_code], $locale, FALSE)) {
            $this->_tmp['strings_modified'] = TRUE; // So that we know we've changed.
            $this->_assets_included[$type_code][$locale] = TRUE;

            // include packages, changing \ for / so it works on Windows systems
            if ($type_code != 'asset') {
                $asset_dir = str_replace('\\', '/', SQ_SYSTEM_ROOT.'/'.$GLOBALS['SQ_SYSTEM']->am->getTypeInfo($type_code, 'dir'));

                if (strpos($asset_dir, str_replace('\\', '/', SQ_CORE_PACKAGE_PATH)) !== FALSE) {
                    $this->includePackageStrings('__core__', $locale);
                } else {
                    $asset_dir = str_replace(str_replace('\\', '/', SQ_PACKAGES_PATH).'/', '', $asset_dir);
                    $package = substr($asset_dir, 0, strpos($asset_dir, '/'));
                    $this->includePackageStrings($package, $locale);
                }
            }

            list($lang, $country, $variant) = $this->getLocaleParts($locale);
            $locales = Array($lang);
            if (!empty($country)) {
                $locales[] = $lang.'_'.$country;
                if (!empty($variant)) {
                    $locales[] = $lang.'_'.$country.'@'.$variant;
                }
            }
            
            foreach ($locales as $this_locale) {
                $file = SQ_DATA_PATH.'/private/asset_types/'.$type_code.'/strings.'.$this_locale;

                if (is_file($file)) {
                    $strings = unserialize(file_get_contents($file));

                    if (!isset($this->_strings[$locale])) {
                        $this->_strings[$locale] = Array();
                    }
                    $this->_strings[$locale] = array_merge($this->_strings[$locale], $strings);
                }
            }
        }//end if

    }//end includeAssetStrings()


    public function includePackageStrings($package_name, $locale=NULL)
    {
        if (!isset($this->_packages_included[$package_name])) {
            $this->_packages_included[$package_name] = Array();
        }
        
        if ($locale == NULL) {
            $locale = $this->getCurrentLocale();
        }

        if (!array_get_index($this->_packages_included[$package_name], $locale, FALSE)) {
            $this->_tmp['strings_modified'] = TRUE; // So that we know we've changed.
            $this->_packages_included[$package_name][$locale] = TRUE;

            list($lang, $country, $variant) = $this->getLocaleParts($locale);
            $locales = Array($lang);
            if (!empty($country)) {
                $locales[] = $lang.'_'.$country;
                if (!empty($variant)) {
                    $locales[] = $lang.'_'.$country.'@'.$variant;
                }
            }

            foreach ($locales as $this_locale) {
                $file = SQ_DATA_PATH.'/private/packages/'.$package_name.'/strings.'.$this_locale;
                if (file_exists($file)) {
                    $strings = unserialize(file_get_contents($file));

                    if (!isset($this->_strings[$locale])) {
                        $this->_strings[$locale] = Array();
                    }
                    $this->_strings[$locale] = array_merge($this->_strings[$locale], $strings);
                }

                $file = SQ_DATA_PATH.'/private/packages/'.$package_name.'/errors.'.$this_locale;
                if (is_file($file)) {
                    $strings = unserialize(file_get_contents($file));

                    if (!isset($this->_errors[$locale])) {
                        $this->_errors[$locale] = Array();
                    }
                    $this->_errors[$locale] = array_merge($this->_errors[$locale], $strings);
                }

                $file = SQ_DATA_PATH.'/private/packages/'.$package_name.'/internal_messages.'.$this_locale;
                if (is_file($file)) {
                    $strings = unserialize(file_get_contents($file));

                    if (!isset($this->_internal_messages[$locale])) {
                        $this->_internal_messages[$locale] = Array();
                    }
                    $this->_internal_messages[$locale] = array_merge($this->_internal_messages[$locale], $strings);
                }
            }
        }//end if

    }//end includePackageStrings()


    public function includeCoreStrings($locale=NULL)
    {
        if ($locale == NULL) {
            $locale = $this->getCurrentLocale();
        }

        if (!array_get_index($this->_core_included, $locale, FALSE)) {
            $this->_tmp['strings_modified'] = TRUE; // So that we know we've changed.
            $this->_core_included[$locale] = TRUE;

            list($lang, $country, $variant) = $this->getLocaleParts($locale);
            $locales = Array($lang);
            if (!empty($country)) {
                $locales[] = $lang.'_'.$country;
                if (!empty($variant)) {
                    $locales[] = $lang.'_'.$country.'@'.$variant;
                }
            }

            foreach ($locales as $this_locale) {
                $file = SQ_DATA_PATH.'/private/system/core/strings.'.$this_locale;
                if (is_file($file)) {
                    $strings = unserialize(file_get_contents($file));

                    if (!isset($this->_strings[$locale])) {
                        $this->_strings[$locale] = Array();
                    }
                    $this->_strings[$locale] = array_merge($this->_strings[$locale], $strings);
                }

                $file = SQ_DATA_PATH.'/private/system/core/errors.'.$this_locale;
                if (is_file($file)) {
                    $strings = unserialize(file_get_contents($file));

                    if (!isset($this->_errors[$locale])) {
                        $this->_errors[$locale] = Array();
                    }
                    $this->_errors[$locale] = array_merge($this->_errors[$locale], $strings);
                }

                $file = SQ_DATA_PATH.'/private/system/core/internal_messages.'.$this_locale;
                if (is_file($file)) {
                    $strings = unserialize(file_get_contents($file));

                    if (!isset($this->_internal_messages[$locale])) {
                        $this->_internal_messages[$locale] = Array();
                    }
                    $this->_internal_messages[$locale] = array_merge($this->_internal_messages[$locale], $strings);
                }
            }
        }//end if

    }//end includeCoreStrings()


    public function raiseError($code, $error_level)
    {
        $locale = $this->getCurrentLocale();

        if (($error_level != E_USER_ERROR) && ($error_level != E_USER_WARNING) && ($error_level != E_USER_NOTICE)) {
            trigger_error('Invalid error level passed when raising error ['.$code.']: '.$error_level, E_USER_WARNING);
            $error_level = E_USER_ERROR;
        }

        // if third parameter is an array, use that as our list of params
        // otherwise, everything after 2nd param is our list of params that we
        // will pump into the error, sprintf() style
        if (func_num_args() == 2) {
            $func_args = Array();
        } else if (!is_array($func_args = func_get_arg(2))) {
            $func_args = func_get_args();
            $func_args = array_slice($func_args,2);
        }

        $error_msg = $this->getErrorMessage($code, $func_args);
        trigger_error($error_msg, $error_level);

    }//end raiseError()


    public function getErrorMessage($code)
    {
        $locale = $this->getCurrentLocale();

        // if second parameter is an array, use that as our list of params
        // otherwise, everything after 1st param is our list of params that we
        // will pump into the error, sprintf() style
        if (func_num_args() == 1) {
            $func_args = Array();
        } else if (!is_array($func_args = func_get_arg(1))) {
            $func_args = func_get_args();
            $func_args = array_slice($func_args,1);
        }

        $valid_code = TRUE;
        if (!isset($this->_errors[$locale])) {
            $valid_code = FALSE;
        }

        if (!isset($this->_errors[$locale][$code])) {
            $valid_code = FALSE;
        }

        if ($valid_code) {
            $error_msg = vsprintf($this->_errors[$locale][$code], $func_args).' ['.$code.']';
        } else {
            $error_msg = 'Error text not found for this code and locale ['.$code.']';
            if (!empty($func_args)) {
                $error_msg .= "\n".var_export($func_args, 1);
            }
        }

        return $error_msg;

    }//end getErrorMessage()


    public function getInternalMessageSubject($type, $keywords, $locale=NULL)
    {
        if (is_null($locale)) {
            $locale = $this->getCurrentLocale();
        }

        $valid_code = TRUE;
        if (!isset($this->_internal_messages[$locale])) {
            $valid_code = FALSE;
        }

        if (!isset($this->_internal_messages[$locale][$type])) {
            $valid_code = FALSE;
        }

        if ($valid_code) {
            $subject = $this->_internal_messages[$locale][$type]['subject'];
            replace_keywords($subject, $keywords);
        } else {
            $subject = 'Internal message translation not found for this code and locale ['.$type.']';
        }

        return $subject;

    }//end getInternalMessageSubject()


    public function getInternalMessageBody($type, $keywords, $locale=NULL)
    {
        if (is_null($locale)) {
            $locale = $this->getCurrentLocale();
        }

        $valid_code = TRUE;
        if (!isset($this->_internal_messages[$locale])) {
            $valid_code = FALSE;
        }

        if (!isset($this->_internal_messages[$locale][$type])) {
            $valid_code = FALSE;
        }

        if ($valid_code) {
            $body = $this->_internal_messages[$locale][$type]['body'];
            replace_keywords($body, $keywords);
        } else {
            $body    = 'Internal message translation not found for this code and locale ['.$type.']';
        }

        return $body;

    }//end getInternalMessageBody()


    public function getJavascriptIncludes()
    {
        $res = Array(sq_web_path('lib').'/js/translation.js'); // we always need this one
        list($lang, $country, $variant) = $this->getLocaleParts($GLOBALS['SQ_SYSTEM']->lm->getCurrentLocale());
        if (file_exists(SQ_DATA_PATH.'/public/system/core/js_strings.'.$lang.'.js')) {
            $res[] = sq_web_path('data').'/system/core/js_strings.'.$lang.'.js';
        }
        if (!empty($country)) {
            if (file_exists(SQ_DATA_PATH.'/public/system/core/js_strings.'.$lang.'_'.$country.'.js')) {
                $res[] = sq_web_path('data').'/system/core/js_strings.'.$lang.'_'.$country.'.js';
            }

            if (!empty($variant)) {
                if (file_exists(SQ_DATA_PATH.'/public/system/core/js_strings.'.$lang.'_'.$country.'@'.$variant.'.js')) {
                    $res[] = sq_web_path('data').'/system/core/js_strings.'.$lang.'_'.$country.'@'.$variant.'.js';
                }
            }
        }
        return $res;

    }//end getJavascriptIncludes()


}//end class
?>