classes/i18n/Locale.inc.php

<?php

// $Id: Locale.inc.php,v 1.38 2008/07/01 01:16:09 asmecher Exp $


import('i18n.LocaleFile');

define('LOCALE_REGISTRY_FILE', Config::getVar('general', 'registry_dir') . DIRECTORY_SEPARATOR . 'locales.xml');
define('LOCALE_DEFAULT', Config::getVar('i18n', 'locale'));
define('LOCALE_ENCODING', Config::getVar('i18n', 'client_charset'));

define('MASTER_LOCALE', 'en_US');

// Error types for locale checking.
// Note: Cannot use numeric symbols for the constants below because
// array_merge_recursive doesn't treat numeric keys nicely.
define('LOCALE_ERROR_MISSING_KEY',     'LOCALE_ERROR_MISSING_KEY');
define('LOCALE_ERROR_EXTRA_KEY',    'LOCALE_ERROR_EXTRA_KEY');
define('LOCALE_ERROR_SUSPICIOUS_LENGTH',  'LOCALE_ERROR_SUSPICIOUS_LENGTH');
define('LOCALE_ERROR_DIFFERING_PARAMS',      'LOCALE_ERROR_DIFFERING_PARAMS');
define('LOCALE_ERROR_MISSING_FILE',    'LOCALE_ERROR_MISSING_FILE');

define('EMAIL_ERROR_MISSING_EMAIL',    'EMAIL_ERROR_MISSING_EMAIL');
define('EMAIL_ERROR_EXTRA_EMAIL',      'EMAIL_ERROR_EXTRA_EMAIL');
define('EMAIL_ERROR_DIFFERING_PARAMS',    'EMAIL_ERROR_DIFFERING_PARAMS');

class Locale {
   function &getLocaleFiles($locale = null) {
      static $localeFiles;
      if (!isset($localeFiles)) {
         $localeFiles = array();
      }

      if ($locale !== null) {
         if (!isset($localeFiles[$locale])) $localeFiles[$locale] = array();
         return $localeFiles[$locale];
      }
      return $localeFiles;
   }

   function translate($key, $params = array(), $locale = null) {
      if (!isset($locale)) $locale = Locale::getLocale();
      if (($key = trim($key)) == '') return '';

      $localeFiles =& Locale::getLocaleFiles($locale);
      $value = '';
      for ($i = 0; $i < count($localeFiles); $i++) { // By reference
         $value = $localeFiles[$i]->translate($key, $params);
         if ($value !== null) return $value;
      }

      // Add a missing key to the debug notes.
      $notes =& Registry::get('system.debug.notes');
      $notes[] = array('debug.notes.missingLocaleKey', array('key' => $key));

      // Add some octothorpes to missing keys to make them more obvious
      return '##' . $key . '##';
   }

   function getMainLocaleFilename($locale) {
      return "locale/$locale/locale.xml";
   }

   function initialize() {
      // Use defaults if locale info unspecified.
      $locale = Locale::getLocale();
      $localeFile = Locale::getMainLocaleFilename($locale);

      $sysLocale = $locale . '.' . LOCALE_ENCODING;
      if (!@setlocale(LC_ALL, $sysLocale, $locale)) {
         // For PHP < 4.3.0
         if(setlocale(LC_ALL, $sysLocale) != $sysLocale) {
            setlocale(LC_ALL, $locale);
         }
      }

      Locale::registerLocaleFile($locale, $localeFile);
   }

   function &registerLocaleFile ($locale, $filename, $addToTop = false) {
      $localeFiles =& Locale::getLocaleFiles($locale);
      $localeFile =& new LocaleFile($locale, $filename);
      if (!$localeFile->isValid()) {
         $localeFile = null;
         return $localeFile;
      }
      if ($addToTop) {
         // Work-around: unshift by reference.
         array_unshift($localeFiles, '');
         $localeFiles[0] =& $localeFile;
      } else {
         $localeFiles[] =& $localeFile;
      }
      return $localeFile;
   }

   function getSupportedLocales() {
      static $supportedLocales;
      if (!isset($supportedLocales)) {
         if (defined('SESSION_DISABLE_INIT') || !Config::getVar('general', 'installed')) {
            $supportedLocales = Locale::getAllLocales();
         } elseif (($journal =& Request::getJournal())) {
            $supportedLocales = $journal->getSupportedLocaleNames();
         } else {
            $site =& Request::getSite();
            $supportedLocales = $site->getSupportedLocaleNames();
         }
      }
      return $supportedLocales;
   }

   function getLocale() {
      static $currentLocale;
      if (!isset($currentLocale)) {
         if (defined('SESSION_DISABLE_INIT') || !Config::getVar('general', 'installed')) {
            // If the locale is specified in the URL, allow
            // it to override. (Necessary when locale is
            // being set, as cookie will not yet be re-set)
            $locale = Request::getUserVar('setLocale');
            if (empty($locale) || !in_array($locale, Locale::getSupportedLocales())) $locale = Request::getCookieVar('currentLocale');
         } else {
            $sessionManager = &SessionManager::getManager();
            $session = &$sessionManager->getUserSession();
            $locale = $session->getSessionVar('currentLocale');

            $journal = &Request::getJournal();
            $site = &Request::getSite();

            if (!isset($locale)) {
               $locale = Request::getCookieVar('currentLocale');
            }

            if (isset($locale)) {
               // Check if user-specified locale is supported
               if ($journal != null) {
                  $locales = &$journal->getSupportedLocaleNames();
               } else {
                  $locales = &$site->getSupportedLocaleNames();
               }

               if (!in_array($locale, array_keys($locales))) {
                  unset($locale);
               }
            }

            if (!isset($locale)) {
               // Use journal/site default
               if ($journal != null) {
                  $locale = $journal->getPrimaryLocale();
               }

               if (!isset($locale)) {
                  $locale = $site->getPrimaryLocale();
               }
            }
         }

         if (!Locale::isLocaleValid($locale)) {
            $locale = LOCALE_DEFAULT;
         }

         $currentLocale = $locale;
      }
      return $currentLocale;
   }

   function getLocaleStyleSheet($locale) {
      $allLocales =& Locale::_getAllLocalesCache();
      $contents = $allLocales->getContents();
      if (isset($contents[$locale]['stylesheet'])) {
         return $contents[$locale]['stylesheet'];
      }
      return null;
   }

   function isLocaleValid($locale) {
      if (empty($locale)) return false;
      if (!preg_match('/^[a-z][a-z]_[A-Z][A-Z]$/', $locale)) return false;
      if (file_exists(Locale::getMainLocaleFilename($locale))) return true;
      return false;
   }

   function getLocalePrecedence() {
      static $localePrecedence;
      if (!isset($localePrecedence)) {
         $localePrecedence = array(Locale::getLocale());

         $journal =& Request::getJournal();
         if ($journal && !in_array($journal->getPrimaryLocale(), $localePrecedence)) $localePrecedence[] = $journal->getPrimaryLocale();

         $site =& Request::getSite();
         if ($site && !in_array($site->getPrimaryLocale(), $localePrecedence)) $localePrecedence[] = $site->getPrimaryLocale();
      }
      return $localePrecedence;
   }

   function getPrimaryLocale() {
      $journal = &Request::getJournal();

      if (isset($journal)) {
         $locale = $journal->getPrimaryLocale();
      }

      if (!isset($locale)) {
         $site = &Request::getSite();
         $locale = $site->getPrimaryLocale();
      }

      if (!isset($locale) || !Locale::isLocaleValid($locale)) {
         $locale = LOCALE_DEFAULT;
      }

      return $locale;
   }

   function &_getAllLocalesCache() {
      static $cache;
      if (!isset($cache)) {
         import('cache.CacheManager');
         $cacheManager =& CacheManager::getManager();
         $cache = $cacheManager->getFileCache(
            'locale', 'list',
            array('Locale', '_allLocalesCacheMiss')
         );

         // Check to see if the data is outdated
         $cacheTime = $cache->getCacheTime();
         if ($cacheTime !== null && $cacheTime < filemtime(LOCALE_REGISTRY_FILE)) {
            $cache->flush();
         }
      }
      return $cache;
   }

   function &loadLocaleList($filename) {
      $xmlDao = &new XMLDAO();
      $data = $xmlDao->parseStruct($filename, array('locale'));
      $allLocales = array();

      // Build array with ($localKey => $localeName)
      if (isset($data['locale'])) {
         foreach ($data['locale'] as $localeData) {
            $allLocales[$localeData['attributes']['key']] = $localeData['attributes'];
         }
      }

      return $allLocales;
   }

   function _allLocalesCacheMiss(&$cache, $id) {
      static $allLocales;
      if (!isset($allLocales)) {
         // Add a locale load to the debug notes.
         $notes =& Registry::get('system.debug.notes');
         $notes[] = array('debug.notes.localeListLoad', array('localeList' => LOCALE_REGISTRY_FILE));

         // Reload locale registry file
         $allLocales = Locale::loadLocaleList(LOCALE_REGISTRY_FILE);
         asort($allLocales);
         $cache->setEntireCache($allLocales);
      }
      return null;
   }

   function &getAllLocales() {
      $cache =& Locale::_getAllLocalesCache();
      $rawContents = $cache->getContents();
      $allLocales = array();

      foreach ($rawContents as $locale => $contents) {
         $allLocales[$locale] = $contents['name'];
      }

      // if client encoding is set to iso-8859-1, transcode locales from utf8
      if (LOCALE_ENCODING == "iso-8859-1") {
         $allLocales = array_map('utf8_decode', $allLocales);
      }

      return $allLocales;
   }

   function getEmailTemplateFilename($locale) {
      return 'dbscripts/xml/data/locale/' . $locale . '/email_templates_data.xml';
   }

   function getFilesToInstall($locale) {
      return array(
         Locale::getEmailTemplateFilename($locale)
      );
   }

   function installLocale($locale) {
      // Install default locale-specific data
      import('db.DBDataXMLParser');

      $filesToInstall = Locale::getFilesToInstall($locale);

      $dataXMLParser = &new DBDataXMLParser();
      foreach ($filesToInstall as $fileName) {
         if (file_exists($fileName)) {
            $sql = $dataXMLParser->parseData($fileName);
            $dataXMLParser->executeData();
         }
      }
      $dataXMLParser->destroy();
   }

   function uninstallLocale($locale) {
      // Delete locale-specific data
      $emailTemplateDao = &DAORegistry::getDAO('EmailTemplateDAO');
      $emailTemplateDao->deleteEmailTemplatesByLocale($locale);
      $emailTemplateDao->deleteDefaultEmailTemplatesByLocale($locale);
   }

   function reloadLocale($locale) {
      Locale::uninstallLocale($locale);
      Locale::installLocale($locale);
   }

   function testLocale($locale, $referenceLocale) {
      $localeFile =& new LocaleFile($locale, Locale::getMainLocaleFilename($locale));
      $referenceLocaleFile =& new LocaleFile($referenceLocale, Locale::getMainLocaleFilename($referenceLocale));

      $errors = $localeFile->testLocale($referenceLocaleFile);
      unset($localeFile);
      unset($referenceLocaleFile);

      $plugins =& PluginRegistry::loadAllPlugins();
      foreach (array_keys($plugins) as $key) {
         $plugin =& $plugins[$key];
         $referenceLocaleFilename = $plugin->getLocaleFilename($referenceLocale);
         if ($referenceLocaleFilename) {
            $localeFile =& new LocaleFile($locale, $plugin->getLocaleFilename($locale));
            $referenceLocaleFile =& new LocaleFile($referenceLocale, $referenceLocaleFilename);
            $errors = array_merge_recursive($errors, $localeFile->testLocale($referenceLocaleFile));
            unset($localeFile);
            unset($referenceLocaleFile);
         }
         unset($plugin);
      }
      return $errors;
   }

   function testEmails($locale, $referenceLocale) {
      $errors = array(
      );

      $xmlParser =& new XMLParser();
      $referenceEmails =& $xmlParser->parse(Locale::getEmailTemplateFilename($referenceLocale));
      $emails =& $xmlParser->parse(Locale::getEmailTemplateFilename($locale));
      $emailsTable =& $emails->getChildByName('table');
      $referenceEmailsTable =& $referenceEmails->getChildByName('table');
      $matchedReferenceEmails = array();

      // Pass 1: For all translated emails, check that they match
      // against reference translations.
      for ($emailIndex = 0; ($email =& $emailsTable->getChildByName('row', $emailIndex)) !== null; $emailIndex++) { 
         // Extract the fields from the email to be tested.
         $fields = Locale::extractFields($email);

         // Locate the reference email and extract its fields.
         for ($referenceEmailIndex = 0; ($referenceEmail =& $referenceEmailsTable->getChildByName('row', $referenceEmailIndex)) !== null; $referenceEmailIndex++) {
            $referenceFields = Locale::extractFields($referenceEmail);
            if ($referenceFields['email_key'] == $fields['email_key']) break;
         }

         // Check if a matching reference email was found.
         if (!isset($referenceEmail) || $referenceEmail === null) {
            $errors[EMAIL_ERROR_EXTRA_EMAIL][] = array(
               'key' => $fields['email_key']
            );
            continue;
         }

         // We've successfully found a matching reference email.
         // Compare it against the translation.
         $bodyParams = Locale::getParameterNames($fields['body']);
         $referenceBodyParams = Locale::getParameterNames($referenceFields['body']);
         $diff = array_diff($bodyParams, $referenceBodyParams);
         if (!empty($diff)) {
            $errors[EMAIL_ERROR_DIFFERING_PARAMS][] = array(
               'key' => $fields['email_key'],
               'mismatch' => $diff
            );
         }

         $subjectParams = Locale::getParameterNames($fields['subject']);
         $referenceSubjectParams = Locale::getParameterNames($referenceFields['subject']);

         $diff = array_diff($subjectParams, $referenceSubjectParams);
         if (!empty($diff)) {
            $errors[EMAIL_ERROR_DIFFERING_PARAMS][] = array(
               'key' => $fields['email_key'],
               'mismatch' => $diff
            );
         }

         $matchedReferenceEmails[] = $fields['email_key'];

         unset($email);
         unset($referenceEmail);
      }

      // Pass 2: Make sure that there are no missing translations.
      for ($referenceEmailIndex = 0; ($referenceEmail =& $referenceEmailsTable->getChildByName('row', $referenceEmailIndex)) !== null; $referenceEmailIndex++) {
         // Extract the fields from the email to be tested.
         $referenceFields = Locale::extractFields($referenceEmail);
         if (!in_array($referenceFields['email_key'], $matchedReferenceEmails)) {
            $errors[EMAIL_ERROR_MISSING_EMAIL][] = array(
               'key' => $referenceFields['email_key']
            );
         }
      }

      return $errors;
   }

   function extractFields(&$node) {
      $returner = array();
      foreach ($node->getChildren() as $field) if ($field->getName() === 'field') {
         $returner[$field->getAttribute('name')] = $field->getValue();
      }
      return $returner;
   }

   function checkLengths($reference, $value) {
      $referenceLength = String::strlen($reference);
      $length = String::strlen($value);
      $lengthDifference = abs($referenceLength - $length);
      if ($referenceLength == 0) return ($length == 0);
      if ($lengthDifference / $referenceLength > 1 && $lengthDifference > 10) return false;
      return true;
   }

   function getParameterNames($source) {
      $matches = null;
      String::regexp_match_all('/({\$[^}]+})/' /* '/{\$[^}]+})/' */, $source, $matches);
      array_shift($matches); // Knock the top element off the array
      return $matches;
   }
}

?>

---