VersionCheck.inc.php

<?php
 
define('VERSION_CODE_PATH', 'dbscripts/xml/version.xml');
 
import('lib.pkp.classes.db.XMLDAO');
import('lib.pkp.classes.site.Version');
 
class VersionCheck {
 
   static function getLatestVersion() {
      $application = Application::get();
      $includeId = Config::getVar('general', 'installed') &&
         !defined('RUNNING_UPGRADE') &&
         Config::getVar('general', 'enable_beacon', true);
 
      if ($includeId) {
         $pluginSettingsDao =& DAORegistry::getDAO('PluginSettingsDAO');
         $uniqueSiteId = $pluginSettingsDao->getSetting(CONTEXT_SITE, 'UsageEventPlugin', 'uniqueSiteId');
      } else $uniqueSiteId = null;
 
      $request = $application->getRequest();
      return self::parseVersionXML(
         $application->getVersionDescriptorUrl() .
         ($includeId?'?id=' . urlencode($uniqueSiteId) .
            '&oai=' . urlencode($request->url('index', 'oai'))
         :'')
      );
   }
 
   static function getCurrentDBVersion() {
      $versionDao = DAORegistry::getDAO('VersionDAO'); /* @var $versionDao VersionDAO */
      return $versionDao->getCurrentVersion();
   }
 
   static function getCurrentCodeVersion() {
      $versionInfo = self::parseVersionXML(VERSION_CODE_PATH);
      if ($versionInfo) {
         return $versionInfo['version'];
      }
      return false;
   }
 
   static function parseVersionXML($url) {
      $xmlDao = new XMLDAO();
      $data = $xmlDao->parseStruct($url, array());
      if (!$data) return false;
 
      // 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'])) {
         $versionInfo['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']
         );
      }
 
      return $versionInfo;
   }
 
   static function getPatch($versionInfo, $codeVersion = null) {
      if (!isset($codeVersion)) {
         $codeVersion = self::getCurrentCodeVersion();
      }
      if (isset($versionInfo['patch'][$codeVersion->getVersionString()])) {
         return $versionInfo['patch'][$codeVersion->getVersionString()];
      }
      return null;
   }
 
   static function getValidPluginVersionInfo($versionFile) {
      $fileManager = new FileManager();
      if ($fileManager->fileExists($versionFile)) {
         $versionInfo = self::parseVersionXML($versionFile);
      } else {
         throw new Exception(__('manager.plugins.versionFileNotFound'));
      }
 
      // Validate plugin name and type to avoid abuse
      $productType = explode(".", $versionInfo['type']);
      if(count($productType) != 2 || $productType[0] != 'plugins') {
         throw new Exception(__('manager.plugins.versionFileInvalid'));
      }
 
      $pluginVersion = $versionInfo['version'];
      $namesToValidate = array($pluginVersion->getProduct(), $productType[1]);
      foreach($namesToValidate as $nameToValidate) {
         if (!PKPString::regexp_match('/[a-z][a-zA-Z0-9]+/', $nameToValidate)) {
            throw new Exception(__('manager.plugins.versionFileInvalid'));
         }
      }
 
      return $pluginVersion;
   }
 
   static function checkIfNewVersionExists() {
      $versionInfo = self::getLatestVersion();
      $latestVersion = $versionInfo['release'];
 
      $currentVersion = self::getCurrentDBVersion();
      if ($currentVersion->compare($latestVersion) < 0) return $latestVersion;
      return false;
   }
}