/**
* Handle a cache miss
* @param $cache GenericCache
* @param $id mixed ID that wasn't found in the cache
* @return null
*/
function _cacheMiss($cache, $id)
{
$allCodelistItems =& Registry::get('all' . $this->getName() . '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();
$nodeName = $this->getName();
// i.e., subject
$data = $xmlDao->parseStruct($filename, array($nodeName));
// Build array with ($charKey => array(stuff))
if (isset($data[$nodeName])) {
foreach ($data[$nodeName] as $codelistData) {
$allCodelistItems[$codelistData['attributes']['code']] = array($codelistData['attributes']['text']);
}
}
if (is_array($allCodelistItems)) {
asort($allCodelistItems);
}
$cache->setEntireCache($allCodelistItems);
}
return null;
}
function _cacheMiss($cache, $id)
{
$allLanguages =& Registry::get('allLanguages-' . $cache->cacheId, true, null);
if ($allLanguages === 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->getLanguageFilename($locale);
$notes[] = array('debug.notes.languageListLoad', array('filename' => $filename));
// Reload locale registry file
$xmlDao = new XMLDAO();
$data = $xmlDao->parseStruct($filename, array('language'));
// Build array with ($charKey => array(stuff))
if (isset($data['language'])) {
foreach ($data['language'] as $languageData) {
$allLanguages[$languageData['attributes']['code']] = array($languageData['attributes']['name']);
}
}
if (is_array($allLanguages)) {
asort($allLanguages);
}
$cache->setEntireCache($allLanguages);
}
if (isset($allLanguages[$id])) {
return $allLanguages[$id];
} else {
return null;
}
}
/**
* Parse information from a version XML file.
* @return array
*/
function &parseVersionXML($url)
{
$xmlDao = new XMLDAO();
$data = $xmlDao->parseStruct($url, array());
if (!$data) {
$result = false;
return $result;
}
// FIXME validate parsed data?
$versionInfo = array();
if (isset($data['application'][0]['value'])) {
$versionInfo['application'] = $data['application'][0]['value'];
}
if (isset($data['type'][0]['value'])) {
$versionInfo['type'] = $data['type'][0]['value'];
}
if (isset($data['release'][0]['value'])) {
$versionInfo['release'] = $data['release'][0]['value'];
}
if (isset($data['tag'][0]['value'])) {
$versionInfo['tag'] = $data['tag'][0]['value'];
}
if (isset($data['date'][0]['value'])) {
$versionInfo['date'] = $data['date'][0]['value'];
}
if (isset($data['info'][0]['value'])) {
$versionInfo['info'] = $data['info'][0]['value'];
}
if (isset($data['package'][0]['value'])) {
$versionInfo['package'] = $data['package'][0]['value'];
}
if (isset($data['patch'][0]['value'])) {
$versionInfo['patch'] = array();
foreach ($data['patch'] as $patch) {
$versionInfo['patch'][$patch['attributes']['from']] = $patch['value'];
}
}
if (isset($data['class'][0]['value'])) {
$versionInfo['class'] = (string) $data['class'][0]['value'];
}
$versionInfo['lazy-load'] = isset($data['lazy-load'][0]['value']) ? (int) $data['lazy-load'][0]['value'] : 0;
$versionInfo['sitewide'] = isset($data['sitewide'][0]['value']) ? (int) $data['sitewide'][0]['value'] : 0;
if (isset($data['release'][0]['value']) && isset($data['application'][0]['value'])) {
$version =& Version::fromString($data['release'][0]['value'], isset($data['type'][0]['value']) ? $data['type'][0]['value'] : null, $data['application'][0]['value'], isset($data['class'][0]['value']) ? $data['class'][0]['value'] : '', $versionInfo['lazy-load'], $versionInfo['sitewide']);
$versionInfo['version'] =& $version;
}
return $versionInfo;
}
/**
* This function is called when the cache cannot be loaded;
* in this case, re-generate the cache from XML.
* @param $cache object
* @param $id string (fixed to "mapping")
*/
function _mapCacheMiss(&$cache, $id)
{
static $mappings;
if (!isset($mappings)) {
// Load the mapping list.
$xmlDao = new XMLDAO();
$data = $xmlDao->parseStruct($this->getPluginPath() . '/' . LANGUAGE_MAP_FILE, array('mapping'));
if (isset($data['mapping'])) {
foreach ($data['mapping'] as $mapping) {
$mappings[$mapping['attributes']['from']] = $mapping['attributes']['to'];
}
}
$cache->setEntireCache($mappings);
}
return null;
}
function _countryCacheMiss($cache, $id)
{
$countries =& Registry::get('allCountriesData', true, array());
if (!isset($countries[$id])) {
// Reload country registry file
$xmlDao = new XMLDAO();
$data = $xmlDao->parseStruct($this->getFilename(), array('countries', 'country'));
if (isset($data['countries'])) {
foreach ($data['country'] as $countryData) {
$countries[$id][$countryData['attributes']['code']] = $countryData['attributes']['name'];
}
}
asort($countries[$id]);
$cache->setEntireCache($countries[$id]);
}
return null;
}
function _cacheMiss(&$cache, $id)
{
$mappings = array();
// Add a debug note indicating an XML load.
$notes =& Registry::get('system.debug.notes');
$notes[] = array('debug.notes.helpMappingLoad', array('id' => $id, 'filename' => $this->filename));
// Reload help XML file
$xmlDao = new XMLDAO();
$data = $xmlDao->parseStruct($this->filename, array('topic'));
// Build associative array of page keys and ids
if (isset($data['topic'])) {
foreach ($data['topic'] as $helpData) {
$mappings[$helpData['attributes']['key']] = $helpData['attributes']['id'];
}
}
$cache->setEntireCache($mappings);
return isset($mappings[$id]) ? $mappings[$id] : null;
}
function _timeZoneCacheMiss($cache, $id)
{
$timeZones =& Registry::get('allTimeZonesData', true, null);
if ($timeZones === null) {
// Reload time zone registry file
$xmlDao = new XMLDAO();
$data = $xmlDao->parseStruct($this->getFilename(), array('timezones', 'entry'));
$timeZones = array();
if (isset($data['timezones'])) {
foreach ($data['entry'] as $timeZoneData) {
$timeZones[$timeZoneData['attributes']['key']] = $timeZoneData['attributes']['name'];
}
}
asort($timeZones);
$cache->setEntireCache($timeZones);
}
return null;
}
/**
* This function is called when the cache cannot be loaded;
* in this case, re-generate the cache from XML.
* @param $cache object
* @param $id string (fixed to "mapping")
*/
function _mapCacheMiss(&$cache, $id)
{
static $mappings;
if (!isset($mappings)) {
// Load the mapping list.
$xmlDao = new XMLDAO();
// $cache->cacheId has the same value as the archive ID (but ask Alec to verify this is always
// true in this context)
$typemap_file = "typemap-" . $cache->cacheId . ".xml";
$data = $xmlDao->parseStruct($this->getPluginPath() . '/' . $typemap_file, array('mapping'));
if (isset($data['mapping'])) {
foreach ($data['mapping'] as $mapping) {
$mappings[$mapping['attributes']['from']] = $mapping['attributes']['to'];
}
}
$cache->setEntireCache($mappings);
}
return null;
}
/**
* Parse information from a version XML file.
* @return array
*/
function &parseVersionXML($url)
{
$xmlDao = new XMLDAO();
$data = $xmlDao->parseStruct($url, array());
if (!$data) {
$result = false;
return $result;
}
// FIXME validate parsed data?
$versionInfo = array();
if (isset($data['application'][0]['value'])) {
$versionInfo['application'] = $data['application'][0]['value'];
}
if (isset($data['type'][0]['value'])) {
$versionInfo['type'] = $data['type'][0]['value'];
}
if (isset($data['release'][0]['value'])) {
$versionInfo['release'] = $data['release'][0]['value'];
}
if (isset($data['tag'][0]['value'])) {
$versionInfo['tag'] = $data['tag'][0]['value'];
}
if (isset($data['date'][0]['value'])) {
$versionInfo['date'] = $data['date'][0]['value'];
}
if (isset($data['info'][0]['value'])) {
$versionInfo['info'] = $data['info'][0]['value'];
}
if (isset($data['package'][0]['value'])) {
$versionInfo['package'] = $data['package'][0]['value'];
}
if (isset($data['patch'][0]['value'])) {
$versionInfo['patch'] = array();
foreach ($data['patch'] as $patch) {
$versionInfo['patch'][$patch['attributes']['from']] = $patch['value'];
}
}
if (isset($data['version'][0]['value'])) {
$versionInfo['version'] = Version::fromString($data['release'][0]['value'], $data['application'][0]['value'], isset($data['type'][0]['value']) ? $data['type'][0]['value'] : null);
}
return $versionInfo;
}
/**
* This function is called when the cache cannot be loaded;
* in this case, re-generate the cache from XML.
* @param $cache object
* @param $id string (fixed to "mapping")
*/
function _mapCacheMiss(&$cache, $id)
{
static $mappings;
if (!isset($mappings)) {
// Load the mapping list.
$xmlDao = new XMLDAO();
$typemapFile = $this->getPluginPath() . '/typemap-' . (int) $cache->cacheId . '.xml';
if (file_exists($typemapFile)) {
$data = $xmlDao->parseStruct($typemapFile, array('mapping'));
} else {
$data = array();
}
if (isset($data['mapping'])) {
foreach ($data['mapping'] as $mapping) {
$mappings[$mapping['attributes']['from']] = $mapping['attributes']['to'];
}
}
$cache->setEntireCache($mappings);
}
return null;
}
function _cacheMiss($cache, $id)
{
$allCurrencies =& Registry::get('allCurrencies', true, null);
if ($allCurrencies === null) {
// Add a locale load to the debug notes.
$notes =& Registry::get('system.debug.notes');
$filename = $this->getCurrencyFilename(AppLocale::getLocale());
$notes[] = array('debug.notes.currencyListLoad', array('filename' => $filename));
// Reload locale registry file
$xmlDao = new XMLDAO();
$data = $xmlDao->parseStruct($filename, array('currency'));
// Build array with ($charKey => array(stuff))
if (isset($data['currency'])) {
foreach ($data['currency'] as $currencyData) {
$allCurrencies[$currencyData['attributes']['code_alpha']] = array($currencyData['attributes']['name'], $currencyData['attributes']['code_numeric']);
}
}
asort($allCurrencies);
$cache->setEntireCache($allCurrencies);
}
return null;
}
/**
* Load a locale list from a file.
* @param $filename string
* @return array
*/
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;
}
/**
* Install email templates from an XML file.
* NOTE: Uses qstr instead of ? bindings so that SQL can be fetched
* rather than executed.
* @param $templatesFile string Filename to install
* @param $returnSql boolean Whether or not to return SQL rather than
* executing it
* @param $emailKey string Optional name of single email key to install,
* skipping others
* @param $skipExisting boolean If true, do not install email templates
* that already exist in the database
* @param $emailKey string If specified, the key of the single template
* to install (otherwise all are installed)
* @return array
*/
function installEmailTemplates($templatesFile, $returnSql = false, $emailKey = null, $skipExisting = false)
{
$xmlDao = new XMLDAO();
$sql = array();
$data = $xmlDao->parseStruct($templatesFile, array('email'));
if (!isset($data['email'])) {
return false;
}
foreach ($data['email'] as $entry) {
$attrs = $entry['attributes'];
if ($emailKey && $emailKey != $attrs['key']) {
continue;
}
if ($skipExisting && $this->templateExistsByKey($attrs['key'])) {
continue;
}
$sql[] = 'INSERT INTO email_templates_default
(email_key, can_disable, can_edit, from_role_id, to_role_id)
VALUES
(' . $this->_dataSource->qstr($attrs['key']) . ', ' . ($attrs['can_disable'] ? 1 : 0) . ', ' . ($attrs['can_edit'] ? 1 : 0) . ', ' . (isset($attrs['from_role_id']) ? (int) $attrs['from_role_id'] : 'null') . ', ' . (isset($attrs['to_role_id']) ? (int) $attrs['to_role_id'] : 'null') . ")";
if (!$returnSql) {
$this->update(array_shift($sql));
}
}
if ($returnSql) {
return $sql;
}
return true;
}
/**
* Install genres from an XML file.
* @param $pressId int
* @return boolean
*/
function installDefaultBase($pressId)
{
$xmlDao = new XMLDAO();
$data = $xmlDao->parseStruct($this->getDefaultBaseFilename(), array('genre'));
if (!isset($data['genre'])) {
return false;
}
foreach ($data['genre'] as $entry) {
$attrs = $entry['attributes'];
$this->update('INSERT INTO genres
(entry_key, sortable, press_id, category)
VALUES
(?, ?, ?, ?)', array($attrs['key'], $attrs['sortable'] ? 1 : 0, $pressId, $attrs['category']));
}
return true;
}
/**
* Static method: Load a locale array from a file. Not cached!
* @param $filename string Filename to locale XML to load
* @param array
*/
function &load($filename)
{
$localeData = array();
// Reload localization XML file
$xmlDao = new XMLDAO();
$data = $xmlDao->parseStruct($filename, array('message'));
// Build array with ($key => $string)
if (isset($data['message'])) {
foreach ($data['message'] as $messageData) {
$localeData[$messageData['attributes']['key']] = $messageData['value'];
}
}
return $localeData;
}
/**
* Install default data for settings.
* @param $contextId int Context ID
* @param $locales array List of locale codes
*/
function installDefaults($contextId, $locales)
{
// Load all the necessary locales.
foreach ($locales as $locale) {
AppLocale::requireComponents(LOCALE_COMPONENT_APP_DEFAULT, LOCALE_COMPONENT_PKP_DEFAULT, $locale);
}
$xmlDao = new XMLDAO();
$data = $xmlDao->parseStruct('registry/genres.xml', array('genre'));
if (!isset($data['genre'])) {
return false;
}
$seq = 0;
foreach ($data['genre'] as $entry) {
$attrs = $entry['attributes'];
// attempt to retrieve an installed Genre with this key.
// Do this to preserve the genreId.
$genre = $this->getByKey($attrs['key'], $contextId);
if (!$genre) {
$genre = $this->newDataObject();
}
$genre->setContextId($contextId);
$genre->setKey($attrs['key']);
$genre->setSortable($attrs['sortable']);
$genre->setCategory($attrs['category']);
$genre->setDependent($attrs['dependent']);
$genre->setSupplementary($attrs['supplementary']);
$genre->setSequence($seq++);
foreach ($locales as $locale) {
$genre->setName(__($attrs['localeKey'], array(), $locale), $locale);
}
$genre->setDesignation($attrs['designation']);
if ($genre->getId() > 0) {
// existing genre.
$this->updateObject($genre);
} else {
$this->insertObject($genre);
}
}
}
function _ICD10CacheMiss(&$cache, $id)
{
$ICD10s =& Registry::get('allICD10sData', true, array());
if (!isset($ICD10s[$id])) {
// Reload ICD10 registry file
$xmlDao = new XMLDAO();
$data = $xmlDao->parseStruct($this->getFilename(), array('ICD10s', 'ICD10'));
if (isset($data['ICD10s'])) {
foreach ($data['ICD10'] as $ICD10Data) {
if (strlen($ICD10Data['attributes']['name']) > 60) {
$name = substr($ICD10Data['attributes']['name'], 0, 60) . '...';
} else {
$name = $ICD10Data['attributes']['name'];
}
$ICD10s[$id][$ICD10Data['attributes']['code']] = $ICD10Data['attributes']['code'] . ' ' . $name;
}
}
asort($ICD10s[$id]);
$cache->setEntireCache($ICD10s[$id]);
}
return null;
}
function _PharmaClassCacheMiss(&$cache, $id)
{
$pharmaClasses =& Registry::get('allPharmaClassesData', true, array());
if (!isset($pharmaClasses[$id])) {
// Reload pharma classes registry file
$xmlDao = new XMLDAO();
$data = $xmlDao->parseStruct($this->getFilename(), array('pharmaClasses', 'pharmaClass'));
if (isset($data['pharmaClasses'])) {
foreach ($data['pharmaClass'] as $pharmaClassData) {
if (strlen($pharmaClassData['attributes']['name']) > 60) {
$name = substr($pharmaClassData['attributes']['name'], 0, 60) . '...';
} else {
$name = $pharmaClassData['attributes']['name'];
}
$pharmaClasses[$id][$pharmaClassData['attributes']['code']] = $pharmaClassData['attributes']['code'] . ' ' . $name;
}
}
asort($pharmaClasses[$id]);
$cache->setEntireCache($pharmaClasses[$id]);
}
return null;
}
/**
* Install publication formats from an XML file.
* @param $pressId int
* @return boolean
*/
function installDefaultBase($pressId)
{
$xmlDao = new XMLDAO();
$data = $xmlDao->parseStruct($this->getDefaultBaseFilename(), array('publicationFormat'));
if (!isset($data['publicationFormat'])) {
return false;
}
foreach ($data['publicationFormat'] as $entry) {
$attrs = $entry['attributes'];
$this->update('INSERT INTO publication_formats
(entry_key, press_id)
VALUES
(?, ?)', array($attrs['key'], $pressId));
}
return true;
}
