classes/journal/JournalSettingsDAO.inc.php

<?php

// $Id: JournalSettingsDAO.inc.php,v 1.29 2008/07/07 17:02:52 asmecher Exp $


class JournalSettingsDAO extends DAO {
   function &_getCache($journalId) {
      static $settingCache;
      if (!isset($settingCache)) {
         $settingCache = array();
      }
      if (!isset($settingCache[$journalId])) {
         import('cache.CacheManager');
         $cacheManager =& CacheManager::getManager();
         $settingCache[$journalId] = $cacheManager->getCache(
            'journalSettings', $journalId,
            array($this, '_cacheMiss')
         );
      }
      return $settingCache[$journalId];
   }

   function &getSetting($journalId, $name, $locale = null) {
      $cache =& $this->_getCache($journalId);
      $returner = $cache->get($name);
      if ($locale !== null) {
         if (!isset($returner[$locale]) || !is_array($returner)) {
            unset($returner);
            $returner = null;
            return $returner;
         }
         return $returner[$locale];
      }
      return $returner;
   }

   function _cacheMiss(&$cache, $id) {
      $settings =& $this->getJournalSettings($cache->getCacheId());
      if (!isset($settings[$id])) {
         // Make sure that even null values are cached
         $cache->setCache($id, null);
         return null;
      }
      return $settings[$id];
   }

   function &getJournalSettings($journalId) {
      $journalSettings = array();

      $result = &$this->retrieve(
         'SELECT setting_name, setting_value, setting_type, locale FROM journal_settings WHERE journal_id = ?', $journalId
      );

      if ($result->RecordCount() == 0) {
         $returner = null;
         $result->Close();
         return $returner;

      } else {
         while (!$result->EOF) {
            $row = &$result->getRowAssoc(false);
            $value = $this->convertFromDB($row['setting_value'], $row['setting_type']);
            if ($row['locale'] == '') $journalSettings[$row['setting_name']] = $value;
            else $journalSettings[$row['setting_name']][$row['locale']] = $value;
            $result->MoveNext();
         }
         $result->close();
         unset($result);

         $cache =& $this->_getCache($journalId);
         $cache->setEntireCache($journalSettings);

         return $journalSettings;
      }
   }

   function updateSetting($journalId, $name, $value, $type = null, $isLocalized = false) {
      $cache =& $this->_getCache($journalId);
      $cache->setCache($name, $value);

      $keyFields = array('setting_name', 'locale', 'journal_id');
      
      if (!$isLocalized) {
         $value = $this->convertToDB($value, $type);
         $this->replace('journal_settings',
            array(
               'journal_id' => $journalId,
               'setting_name' => $name,
               'setting_value' => $value,
               'setting_type' => $type,
               'locale' => ''
            ),
            $keyFields
         );
      } else {
         if (is_array($value)) foreach ($value as $locale => $localeValue) {
            $this->update('DELETE FROM journal_settings WHERE journal_id = ? AND setting_name = ? AND locale = ?', array($journalId, $name, $locale));
            if (empty($localeValue)) continue;
            $type = null;
            $this->update('INSERT INTO journal_settings
               (journal_id, setting_name, setting_value, setting_type, locale)
               VALUES (?, ?, ?, ?, ?)',
               array(
                  $journalId, $name, $this->convertToDB($localeValue, $type), $type, $locale
               )
            );
         }
      }
   }

   function deleteSetting($journalId, $name, $locale = null) {
      $cache =& $this->_getCache($journalId);
      $cache->setCache($name, null);

      $params = array($journalId, $name);
      $sql = 'DELETE FROM journal_settings WHERE journal_id = ? AND setting_name = ?';
      if ($locale !== null) {
         $params[] = $locale;
         $sql .= ' AND locale = ?';
      }

      return $this->update($sql, $params);
   }

   function deleteSettingsByJournal($journalId) {
      $cache =& $this->_getCache($journalId);
      $cache->flush();

      return $this->update(
            'DELETE FROM journal_settings WHERE journal_id = ?', $journalId
      );
   }

   function _performReplacement($rawInput, $paramArray = array()) {
      $value = preg_replace_callback('{{translate key="([^"]+)"}}', '_installer_regexp_callback', $rawInput);
      foreach ($paramArray as $pKey => $pValue) {
         $value = str_replace('{$' . $pKey . '}', $pValue, $value);
      }
      return $value;
   }

   function &_buildObject (&$node, $paramArray = array()) {
      $value = array();
      foreach ($node->getChildren() as $element) {
         $key = $element->getAttribute('key');
         $childArray = &$element->getChildByName('array');
         if (isset($childArray)) {
            $content = $this->_buildObject($childArray, $paramArray);
         } else {
            $content = $this->_performReplacement($element->getValue(), $paramArray);
         }
         if (!empty($key)) {
            $key = $this->_performReplacement($key, $paramArray);
            $value[$key] = $content;
         } else $value[] = $content;
      }
      return $value;
   }

   function installSettings($journalId, $filename, $paramArray = array()) {
      $xmlParser = &new XMLParser();
      $tree = $xmlParser->parse($filename);

      if (!$tree) {
         $xmlParser->destroy();
         return false;
      }

      foreach ($tree->getChildren() as $setting) {
         $nameNode = &$setting->getChildByName('name');
         $valueNode = &$setting->getChildByName('value');

         if (isset($nameNode) && isset($valueNode)) {
            $type = $setting->getAttribute('type');
            $isLocaleField = $setting->getAttribute('locale');
            $name = &$nameNode->getValue();

            if ($type == 'object') {
               $arrayNode = &$valueNode->getChildByName('array');
               $value = $this->_buildObject($arrayNode, $paramArray);
            } else {
               $value = $this->_performReplacement($valueNode->getValue(), $paramArray);
            }

            // Replace translate calls with translated content
            $this->updateSetting(
               $journalId,
               $name,
               $isLocaleField?array(Locale::getLocale() => $value):$value,
               $type,
               $isLocaleField
            );
         }
      }

      $xmlParser->destroy();

   }

   function _performLocalizedReplacement($rawInput, $paramArray = array(), $locale = null) {
      $value = preg_replace_callback('{{translate key="([^"]+)"}}',
                                                   // this only translates from mail locale file 
                                                   create_function('$matches', 
                                                      '$locale = "' . $locale . '";'.
                                                      '$localeFileName = Locale::getMainLocaleFilename($locale);'.
                                                      '$localeFile =& new LocaleFile($locale, $localeFileName);'. 
                                                      'return $localeFile->translate($matches[1]);'
                                                      ),
                                                      $rawInput); 
      foreach ($paramArray as $pKey => $pValue) {
         $value = str_replace('{$' . $pKey . '}', $pValue, $value);
      }
      return $value;
   }

   function &_buildLocalizedObject (&$node, $paramArray = array(), $locale = null) {
      $value = array();
      foreach ($node->getChildren() as $element) {
         $key = $element->getAttribute('key');
         $childArray = &$element->getChildByName('array');
         if (isset($childArray)) {
            $content = $this->_buildLocalizedObject($childArray, $paramArray, $locale);
         } else {
            $content = $this->_performLocalizedReplacement($element->getValue(), $paramArray, $locale);
         }
         if (!empty($key)) {
            $key = $this->_performLocalizedReplacement($key, $paramArray, $locale);
            $value[$key] = $content;
         } else $value[] = $content;
      }
      return $value;
   }

   function reloadLocalizedDefaultSettings($journalId, $filename, $paramArray, $locale) {
      $xmlParser = &new XMLParser();
      $tree = $xmlParser->parse($filename);

      if (!$tree) {
         $xmlParser->destroy();
         return false;
      }

      foreach ($tree->getChildren() as $setting) {
         $nameNode = &$setting->getChildByName('name');
         $valueNode = &$setting->getChildByName('value');

         if (isset($nameNode) && isset($valueNode)) {
            $type = $setting->getAttribute('type');
            $isLocaleField = $setting->getAttribute('locale');
            $name = &$nameNode->getValue();

            //skip all settings that are not locale fields
            if (!$isLocaleField) continue;

            if ($type == 'object') {
               $arrayNode = &$valueNode->getChildByName('array');
               $value = $this->_buildLocalizedObject($arrayNode, $paramArray, $locale);
            } else {
               $value = $this->_performLocalizedReplacement($valueNode->getValue(), $paramArray, $locale);
            }
            
            // Replace translate calls with translated content
            $this->updateSetting(
               $journalId,
               $name,
               array($locale => $value),
               $type,
               true
            );
         }
      }

      $xmlParser->destroy();

   }
}

function _installer_regexp_callback($matches) {
   return Locale::translate($matches[1]);
}

?>

---