classes/help/Help.inc.php

<?php

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


class Help {
   var $mappingFiles;

   function &getHelp() {
      $instance =& Registry::get('help');
      if ($instance == null) {
         unset($instance);
         $instance = new Help();
         Registry::set('help', $instance);
      }
      return $instance;
   }

   function Help() {
      import('help.OJSHelpMappingFile');
      $mainMappingFile =& new OJSHelpMappingFile();
      $this->mappingFiles = array();
      $this->addMappingFile($mainMappingFile);
   }

   function &getMappingFiles() {
      return $this->mappingFiles;
   }

   function addMappingFile(&$mappingFile) {
      $this->mappingFiles[] =& $mappingFile;
   }

   function getLocale() {
      $locale = Locale::getLocale();
      if (!file_exists("help/$locale/.")) {
         return 'en_US';
      }
      return $locale;
   }

   function translate($key) {
      $key = trim($key);
      if (empty($key)) {
         return '';
      }

      $mappingFiles =& $this->getMappingFiles();
      for ($i=0; $i < count($mappingFiles); $i++) {
         // Not using foreach because it runs by value
         $mappingFile =& $mappingFiles[$i];
         $value = $mappingFile->map($key);
         if ($value !== null) return $value;
         unset($mappingFile);
      }

      if (!isset($value)) {
         return '##' . $key . '##';
      }
   }

   function &_getTocCache() {
      static $cache;

      if (!isset($cache)) {
         import('cache.CacheManager');
         $cacheManager =& CacheManager::getManager();
         $cache = $cacheManager->getFileCache(
            'help', 'toc',
            array('Help', '_tocCacheMiss')
         );

         // Check to see if the cache info is outdated.
         $cacheTime = $cache->getCacheTime();
         if ($cacheTime !== null && $cacheTime < $this->dirmtime('help/'. $this->getLocale() . '/.', true)) {
            // The cached data is out of date.
            $cache->flush();
         }
      }
      return $cache;
   }

   function _mappingCacheMiss(&$cache, $id) {
      // Keep a secondary cache of the mappings so that a few
      // cache misses won't destroy the server
      static $mappings;

      $result = null;
      if (HookRegistry::call('Help::_mappingCacheMiss', array(&$cache, &$id, &$mappings, &$result))) return $result;

      if (!isset($mappings)) {
         $mappings =& $this->loadHelpMappings();
         $cache->setEntireCache($mappings);
      }
      return isset($mappings[$id])?$mappings[$id]:null;
   }

   function _tocCacheMiss(&$cache, $id) {
      // Keep a secondary cache of the TOC so that a few
      // cache misses won't destroy the server
      static $toc;
      if (!isset($toc)) {
         $helpToc = array();
         $topicId = 'index/topic/000000';
         $help =& Help::getHelp();
         $helpToc = $help->buildTopicSection($topicId);
         $toc =& $help->buildToc($helpToc);

         $cache->setEntireCache($toc);
      }
      return null;
   }

   function &getTableOfContents() {
      $cache =& $this->_getTocCache();
      return $cache->getContents();
   }

   function &buildToc($helpToc) {

      $toc = array();
      foreach($helpToc as $topicId => $section) {
         $toc[$topicId] = array('title' => $section['title'], 'prefix' => '');
         $this->buildTocHelper($toc, $section['section'], '');
      }
      return $toc;
   }

   function buildTocHelper(&$toc, $section, $prefix) {
      if (isset($section)) {
         $prefix = "&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;$prefix";
         foreach($section as $topicId => $sect) {
            $toc[$topicId] = array('title' => $sect['title'], 'prefix' => $prefix);
            $this->buildTocHelper($toc, $sect['section'], $prefix);
         }
      }
   }

   function buildTopicSection($topicId, $prevTocId = null) {
      $topicDao =& DAORegistry::getDAO('HelpTopicDAO');
      $tocDao =& DAORegistry::getDAO('HelpTocDAO');

      $topic = $topicDao->getTopic($topicId);
      if ($topicId == 'index/topic/000000') {
         $tocId = $topic->getTocId();
      } else {
         $tocId = $topic->getSubTocId();
      }

      $section = array();
      if ($tocId && $tocId != $prevTocId) {
         $toc = $tocDao->getToc($tocId);
         $topics = $toc->getTopics();
         foreach($topics as $currTopic) {
            $currId = $currTopic->getId();
            $currTitle = $currTopic->getTitle();
            if ($currId != $topicId) {
               $section[$currId] = array('title' => $currTitle, 'section' => $this->buildTopicSection($currId, $tocId)); 
            }
         }
      }
      if (empty($section)) {
         $section = null;
      }

      return $section;
   }

   function dirmtime($dirName,$doRecursive) {
      $d = dir($dirName);
      $lastModified = 0;
      while($entry = $d->read()) {
         if ($entry != "." && $entry != "..") {
            if (!is_dir($dirName."/".$entry)) {
               $currentModified = filemtime($dirName."/".$entry);
            } else if ($doRecursive && is_dir($dirName."/".$entry)) {
               $currentModified = $this->dirmtime($dirName."/".$entry,true);
            }
            if ($currentModified > $lastModified) {
               $lastModified = $currentModified;
            }
         }
      }
      $d->close();
      return $lastModified;
   }

   function getSearchPaths() {
      $mappingFiles =& $this->getMappingFiles();
      $searchPaths = array();
      for ($i = 0; $i < count($mappingFiles); $i++) {
         $searchPaths[$mappingFiles[$i]->getSearchPath()] =& $mappingFiles[$i];
      }
      return $searchPaths;
   }
}

?>

---