Changeset 1021

Timestamp:

04/24/06 16:44:17 (7 years ago)

Author:

benoitg

Message:

* Major system locale handling overhaull. Hopefully abstract out the UTF8 problems once and for all,

allowing everyone to define them the same way. Fix a few bugs along the way.
Should also be a little faster.

Location:

trunk/wifidog-auth

Files:

• CHANGELOG (modified) (1 diff)
• wifidog/classes/Locale.php (modified) (4 diffs)
• wifidog/classes/LocaleList.php (modified) (1 diff)
• wifidog/classes/Style.php (modified) (1 diff)
• wifidog/classes/User.php (modified) (1 diff)
• wifidog/config.php (modified) (2 diffs)
• wifidog/include/language.php (modified) (1 diff)

trunk/wifidog-auth/CHANGELOG

@@ +1 @@
+2006-04-24 Benoit Grégoire  <bock@step.polymtl.ca>
+        * Major locale handling changes.  Hopefully abstract out the UTF8 problems once and for all, 
+        allowing everyone to define them the same way.  Fix a few bugs along the way.  
+        Should also be a little faster.
+
 2006-04-24 Benoit Grégoire  <bock@step.polymtl.ca>
         * Revert Rob's SYSTEM_PATH change.  Sorry about that.  The devs spent hours to finally get the PATH

trunk/wifidog-auth/wifidog/classes/Locale.php

@@ -128 +128 @@
         $object = null;
         $locale_id = $session->get(SESS_LANGUAGE_VAR);
+        //echo sprintf("Debug in /classes/Locale.php getCurrentLocale(): session->get(SESS_LANGUAGE_VAR)=%s", $session->get(SESS_LANGUAGE_VAR))."<br/>";
 
         /* Try to guess the lang */
@@ -137 +138 @@
         if (empty ($locale_id)) {
             $object = self :: getObject(DEFAULT_LANG);
-            self :: setCurrentLocale($object);
         } else {
             $object = self :: getObject($locale_id);
-            self :: setCurrentLocale($object);
         }
 
@@ -213 +212 @@
         }
 
-    /**
-     * @todo Don't trust the value in the cookie, verify that the value is in
-     * the AVAILABLE locales set in the config.
+    /** Initialise the system locale (gettext, setlocale, etc.)
      * @return boolean true on success, false on failure.
      */
     public static function setCurrentLocale($locale) {
         global $session;
+         global $AVAIL_LOCALE_ARRAY;
         $retval = false;
-
+ 
         // Get new locale ID, assume default if null
         if ($locale != null) {
             $locale_id = $locale->getId();
-            $session->set(SESS_LANGUAGE_VAR, $locale_id);
             $retval = true;
-            $q = "parm";
+            $q = "parameter";
         } else {
             $locale_id = DEFAULT_LANG;
-            $session->set(SESS_LANGUAGE_VAR, $locale_id);
             $retval = false;
-            $q = "dflt";
-        }
+            $q = "default";
+        }
+        //pretty_print_r($locale);
+        //echo sprintf("Debug in /classes/Locale.php setCurentLocale(): locale_id=%s", $locale_id)."<br/>";
 
         if (GETTEXT_AVAILABLE) {
+            $lang_only_locale_id = substr ($locale_id, 0 , 2);
+                   if(!isset($AVAIL_LOCALE_ARRAY[$locale_id]) && !isset($AVAIL_LOCALE_ARRAY[$lang_only_locale_id]))
+                   {
+                     echo srintf("Warning in /classes/Locale.php setCurentLocale: Neither %s or %s are available in AVAIL_LOCALE_ARRAY", $locale_id, $lang_only_locale_id)."<br/>";
+                   }
             // Try to set locale
-            $current_locale = setlocale(LC_ALL, $locale_id);
+            $candidate_locale_array[] = str_ireplace('.UTF8', '', $locale_id).'.UTF-8';
+            $candidate_locale_array[] = str_ireplace('.UTF8', '', $locale_id);
+            $candidate_locale_array[] = $lang_only_locale_id.'.UTF-8';
+            $candidate_locale_array[] = $lang_only_locale_id;
+
+             
+            $current_locale = setlocale(LC_ALL, $candidate_locale_array);
+               //echo sprintf("Warning in /classes/Locale.php setCurentLocale: Unable to setlocale() to %s: %s.  I tried %s, %s, %s, %s, and got return value: %s, current locale is: %s",$q, $locale_id, $candidate_locale_array[0], $candidate_locale_array[1], $candidate_locale_array[2], $candidate_locale_array[3], $current_locale, setlocale(LC_ALL, 0))."<br/>";
 
             // Test it against current PHP locale
-            if ($current_locale != $locale_id) {
-                echo "Warning in /classes/Locale.php setCurentLocale: Unable to setlocale() to ".$q.":".$locale_id.", return value: $current_locale, current locale: ".setlocale(LC_ALL, 0)."<br/>";
+            if (substr ($current_locale, 0 , 2) != $lang_only_locale_id) {
+                echo sprintf("Warning in /classes/Locale.php setCurentLocale: Unable to setlocale() to %s: %s.  I tried %s, %s, %s, %s, and got return value: %s, current locale is: %s",$q, $locale_id, $candidate_locale_array[0], $candidate_locale_array[1], $candidate_locale_array[2], $candidate_locale_array[3], $current_locale, setlocale(LC_ALL, 0))."<br/>";
                 $retval = false;
             } else {
@@ -248 +258 @@
                 textDomain('messages');
 
-                putenv("LC_ALL=".$locale_id);
-                putenv("LANGUAGE=".$locale_id);
-                $session->set(SESS_LANGUAGE_VAR, $locale_id);
+                putenv("LC_ALL=".$current_locale);
+                putenv("LANGUAGE=".$current_locale);
                 $retval = true;
             }
         }
-
         return $retval;
     }

trunk/wifidog-auth/wifidog/classes/LocaleList.php

@@ -131 +131 @@
             $locale = $user->getPreferedLocale();
         } else {
-            $locale = $session->get('SESS_LANGUAGE_VAR');
+            $locale = $session->get(SESS_LANGUAGE_VAR);
 
             if (empty ($locale)) {

trunk/wifidog-auth/wifidog/classes/Style.php

@@ -68 +68 @@
 {
   function Style() {
-    $session = new Session();
-    if (!empty($_REQUEST['lang']))
-      {
-        $session->set('SESS_LANGUAGE_VAR', $_REQUEST['lang']);
-      }
 
-    if ($session->get('SESS_LANGUAGE_VAR')) {
-        setlocale(LC_ALL, $session->get('SESS_LANGUAGE_VAR'));
-    }
   }
 

trunk/wifidog-auth/wifidog/classes/User.php

@@ -371 +371 @@
       $locale = $this->mRow['prefered_locale'];
       if (empty($locale) && !empty($session))
-        $locale = $session->get('SESS_LANGUAGE_VAR');
+        $locale = $session->get(SESS_LANGUAGE_VAR);
       if (empty($locale))
         $locale = DEFAULT_LANG;

trunk/wifidog-auth/wifidog/config.php

@@ -169 +169 @@
 global $AVAIL_LOCALE_ARRAY;
 
-/*$AVAIL_LOCALE_ARRAY = array('fr' => 'Français',
-                            'en' => 'English',
-                            'de' => 'Deutsch',
-                            'pt' => 'Português');
-*/
-/**
- * A lot of linux distributions (Debian, BSD and Mac OS X) use locales like this:
- */
-//$AVAIL_LOCALE_ARRAY = array('fr_CA' => 'Français',
-//                            'en_US' => 'English',
-//                            'de_DE' => 'Deutsch',
-//                            'pt_PT' => 'Português');
-
-/**
- * Other linux distributions (Ubuntu, Mandriva 10.1) use locales like this:
- */
-$AVAIL_LOCALE_ARRAY = array('fr_CA.UTF8' => 'Français',
-                            'en_US.UTF8' => 'English',
-                            'de_DE.UTF8' => 'Deutsch',
-                            'pt_PT.UTF8' => 'Português');
+
+/**
+ * Array of available languages for the user.  Each entry must have:
+ * -The language code (the part before the _) be present in wifidog/locales
+ * -Have the entire locale available in your system locale
+ * OR
+ * -Have a system locale available with only the language (ex: an en locale).
+ * Note that if you specify en_UK and en_US, and have only en available the
+ * system will NOT warn you that both will have identical results.
+ * Note that even if your system uses locales like fr_CA.UTF8, you do not need
+ * to change this, ifidog will translate for you.
+ * @TODO:  Setting an array of only one entry should disable the language select
+ * box.
+ */
+$AVAIL_LOCALE_ARRAY = array('fr_CA' => 'Français',
+                            'en_US' => 'English',
+                            'de_DE' => 'Deutsch',
+                            'pt_PT' => 'Português');
 
 /**
@@ -194 +192 @@
  * ================
  *
- * Define the default language of the WiFiDOG auth server.
- *
- * Remember to change this value to a valid locale, i.e.:
- * - fr
- * - fr_CA
- * - fr_CA.UTF8
- */
-define('DEFAULT_LANG', 'fr_CA.UTF8');
+ * Define the default language of the WiFiDOG auth server.  The language code
+ * (the part before the _) must be part of the array above (the country
+ * subcode may differ, and should be set to your country subcode)
+ */
+define('DEFAULT_LANG', 'fr_CA');
 
 /********************************************************************\

trunk/wifidog-auth/wifidog/include/language.php

@@ -48 +48 @@
 
 if (!empty ($_REQUEST['wifidog_language'])) {
-    Locale::setCurrentLocale(Locale::getObject($_REQUEST['wifidog_language']));
+    
+            //echo "Setting to $_REQUEST[wifidog_language]<br/>";
+        $session->set(SESS_LANGUAGE_VAR, $_REQUEST['wifidog_language']);
 }
 
 $locale = Locale::getCurrentLocale();
+Locale::setCurrentLocale($locale);
 $locale_id = $locale->getId();