ONIXCodelistItemDAO.inc.php

<?php
 
import('classes.codelist.ONIXCodelistItem');
 
class ONIXCodelistItemDAO extends DAO {
 
   /* The name of the codelist we are interested in */
   var $_list;
 
   function __construct() {
      parent::__construct();
   }
 
   function &_getCache($locale = null) {
      if ($locale == null) {
         $locale = AppLocale::getLocale();
      }
 
      $cacheName = 'Onix' . $this->getListName() . 'Cache';
 
      $cache =& Registry::get($cacheName, true, null);
      if ($cache === null) {
         $cacheManager = CacheManager::getManager();
         $cache = $cacheManager->getFileCache(
            $this->getListName() . '_codelistItems', $locale,
            array($this, '_cacheMiss')
         );
         $cacheTime = $cache->getCacheTime();
         if ($cacheTime !== null && $cacheTime < filemtime($this->getFilename($locale))) {
            $cache->flush();
         }
      }
 
      return $cache;
   }
 
   function _cacheMiss($cache, $id) {
      $allCodelistItems =& Registry::get('all' . $this->getListName() . 'CodelistItems', true, null);
      if ($allCodelistItems === null) {
         // Add a locale load to the debug notes.
         $notes =& Registry::get('system.debug.notes');
         $locale = $cache->cacheId;
         if ($locale == null) {
            $locale = AppLocale::getLocale();
         }
         $filename = $this->getFilename($locale);
         $notes[] = array('debug.notes.codelistItemListLoad', array('filename' => $filename));
 
         // Reload locale registry file
         $xmlDao = new XMLDAO();
         $listName = $this->getListName(); // i.e., 'List30'
         import('classes.codelist.ONIXParserDOMHandler');
         $handler = new ONIXParserDOMHandler($listName);
 
         import('lib.pkp.classes.xslt.XSLTransformer');
         import('lib.pkp.classes.file.FileManager');
         import('lib.pkp.classes.file.TemporaryFileManager');
 
         $temporaryFileManager = new TemporaryFileManager();
         $fileManager = new FileManager();
 
         // Ensure that the temporary file dir exists
         $tmpDir = $temporaryFileManager->getBasePath();
         if (!file_exists($tmpDir)) mkdir($tmpDir);
 
         $tmpName = tempnam($tmpDir, 'ONX');
         $xslTransformer = new XSLTransformer();
         $xslTransformer->setParameters(array('listName' => $listName));
         $xslTransformer->setRegisterPHPFunctions(true);
 
         $xslFile = 'lib/pkp/xml/onixFilter.xsl';
         $filteredXml = $xslTransformer->transform($filename, XSL_TRANSFORMER_DOCTYPE_FILE, $xslFile, XSL_TRANSFORMER_DOCTYPE_FILE, XSL_TRANSFORMER_DOCTYPE_STRING);
         if (!$filteredXml) {assert(false);}
 
         $data = null;
 
         if (is_writeable($tmpName)) {
            $fp = fopen($tmpName, 'wb');
            fwrite($fp, $filteredXml);
            fclose($fp);
            $data = $xmlDao->parseWithHandler($tmpName, $handler);
            $fileManager->deleteByPath($tmpName);
         } else {
            fatalError('misconfigured directory permissions on: ' . $tmpDir);
         }
 
         // Build array with ($charKey => array(stuff))
 
         if (isset($data[$listName])) {
            foreach ($data[$listName] as $code => $codelistData) {
               $allCodelistItems[$code] = $codelistData;
            }
         }
         if (is_array($allCodelistItems)) {
            asort($allCodelistItems);
         }
 
         $cache->setEntireCache($allCodelistItems);
 
      }
      return null;
   }
 
   function getFilename($locale) {
      $masterLocale = MASTER_LOCALE;
      $localizedFile = "locale/$locale/ONIX_BookProduct_CodeLists.xsd";
      if (AppLocale::isLocaleValid($locale) && file_exists($localizedFile)) {
         return $localizedFile;
      }
 
      // Fall back on the version for the master locale.
      return "locale/$masterLocale/ONIX_BookProduct_CodeLists.xsd";
   }
 
   function setListName($list) {
      $this->_list =& $list;
   }
 
   function getListName() {
      return $this->_list;
   }
 
   function newDataObject() {
      return new ONIXCodelistItem();
   }
 
   function &getCodelistItems($list, $locale = null) {
      $this->setListName($list);
      $cache =& $this->_getCache($locale);
      $returner = array();
      foreach ($cache->getContents() as $code => $entry) {
         $returner[] =& $this->_fromRow($code, $entry);
      }
      return $returner;
   }
 
   function &getCodes($list, $codesToExclude = array(), $codesFilter = null, $locale = null) {
      $this->setListName($list);
      $cache =& $this->_getCache($locale);
      $returner = array();
      $cacheContents =& $cache->getContents();
      if (is_array($cacheContents)) {
         foreach ($cache->getContents() as $code => $entry) {
            if ($code != '') {
               if (!in_array($code, $codesToExclude) && (empty($codesFilter) || preg_match("/^" . preg_quote($codesFilter) . "/i", $entry[0])))
                  $returner[$code] =& $entry[0];
            }
         }
      }
      return $returner;
   }
 
   function codeExistsInList($code, $list) {
      $listKeys = array_keys($this->getCodes($list));
      return ($code != null && in_array($code, $listKeys));
   }
 
   function getCodeFromValue($value, $list) {
      $codes = $this->getCodes($list);
      $codes = array_flip($codes);
      if (array_key_exists($value, $codes)) {
         return $codes[$value];
      }
      return '';
   }
 
   function &_fromRow($code, &$entry) {
      $codelistItem = $this->newDataObject();
      $codelistItem->setCode($code);
      $codelistItem->setText($entry[0]);
 
      HookRegistry::call('ONIXCodelistItemDAO::_fromRow', array(&$codelistItem, &$code, &$entry));
 
      return $codelistItem;
   }
}