UpgradeTool.inc.php

<?php
 
define('RUNNING_UPGRADE', 1);
 
import('classes.install.Upgrade');
import('lib.pkp.classes.site.Version');
import('lib.pkp.classes.site.VersionCheck');
 
class UpgradeTool extends CommandLineTool {
 
   var $command;
 
   function __construct($argv = array()) {
      parent::__construct($argv);
 
      if (!isset($this->argv[0]) || !in_array($this->argv[0], array('check', 'latest', 'upgrade', 'download'))) {
         $this->usage();
         exit(1);
      }
 
      $this->command = $this->argv[0];
      AppLocale::requireComponents(LOCALE_COMPONENT_PKP_INSTALLER);
   }
 
   function usage() {
      echo "Upgrade tool\n"
         . "Usage: {$this->scriptName} command\n"
         . "Supported commands:\n"
         . "    check     perform version check\n"
         . "    latest    display latest version info\n"
         . "    upgrade   execute upgrade script\n"
         . "    download  download latest version (does not unpack/install)\n";
   }
 
   function execute() {
      $command = $this->command;
      $this->$command();
   }
 
   function check() {
      $this->checkVersion(VersionCheck::getLatestVersion());
   }
 
   function latest() {
      $this->checkVersion(VersionCheck::getLatestVersion(), true);
   }
 
   function upgrade() {
      $installer = new Upgrade(array());
      $installer->setLogger($this);
 
      if ($installer->execute()) {
         if (count($installer->getNotes()) > 0) {
            printf("\nRelease Notes\n");
            printf("----------------------------------------\n");
            foreach ($installer->getNotes() as $note) {
               printf("%s\n\n", $note);
            }
         }
 
         $newVersion = $installer->getNewVersion();
         printf("Successfully upgraded to version %s\n", $newVersion->getVersionString(false));
 
      } else {
         printf("ERROR: Upgrade failed: %s\n", $installer->getErrorString());
      }
   }
 
   function download() {
      $versionInfo = VersionCheck::getLatestVersion();
      if (!$versionInfo) {
         $application = Application::get();
         printf("Failed to load version info from %s\n", $application->getVersionDescriptorUrl());
         exit(1);
      }
 
      $download = $versionInfo['package'];
      $outFile = basename($download);
 
      printf("Download: %s\n", $download);
      printf("File will be saved to: %s\n", $outFile);
 
      if (!$this->promptContinue()) {
         exit(0);
      }
 
      $out = fopen($outFile, 'wb');
      if (!$out) {
         printf("Failed to open %s for writing\n", $outFile);
         exit(1);
      }
 
      $in = fopen($download, 'rb');
      if (!$in) {
         printf("Failed to open %s for reading\n", $download);
         fclose($out);
         exit(1);
      }
 
      printf('Downloading file...');
 
      while(($data = fread($in, 4096)) !== '') {
         printf('.');
         fwrite($out, $data);
      }
 
      printf("done\n");
 
      fclose($in);
      fclose($out);
   }
 
   function checkVersion($versionInfo, $displayInfo = false) {
      if (!$versionInfo) {
         $application = Application::get();
         printf("Failed to load version info from %s\n", $application->getVersionDescriptorUrl());
         exit(1);
      }
 
      $dbVersion = VersionCheck::getCurrentDBVersion();
      $codeVersion = VersionCheck::getCurrentCodeVersion();
      $latestVersion = $versionInfo['version'];
 
      printf("Code version:      %s\n", $codeVersion->getVersionString(false));
      printf("Database version:  %s\n", $dbVersion->getVersionString(false));
      printf("Latest version:    %s\n", $latestVersion->getVersionString(false));
 
      $compare1 = $codeVersion->compare($latestVersion);
      $compare2 = $dbVersion->compare($codeVersion);
 
      if (!$displayInfo) {
         if ($compare2 < 0) {
            printf("Database version is older than code version\n");
            printf("Run \"{$this->scriptName} upgrade\" to update\n");
            exit(0);
 
         } else if($compare2 > 0) {
            printf("Database version is newer than code version!\n");
            exit(1);
 
         } else if ($compare1 == 0) {
            printf("Your system is up-to-date\n");
 
         } else if($compare1 < 0) {
            printf("A newer version is available:\n");
            $displayInfo = true;
         } else {
            printf("Current version is newer than latest!\n");
            exit(1);
         }
      }
 
      if ($displayInfo) {
         printf("         tag:     %s\n", $versionInfo['tag']);
         printf("         date:    %s\n", $versionInfo['date']);
         printf("         info:    %s\n", $versionInfo['info']);
         printf("         package: %s\n", $versionInfo['package']);
      }
 
      return $compare1;
   }
 
   function promptContinue($prompt = "Continue?") {
      printf("%s [y/N] ", $prompt);
      $continue = fread(STDIN, 255);
      return (strtolower(substr(trim($continue), 0, 1)) == 'y');
   }
 
   function log($message) {
      printf("[%s]\n", $message);
   }
 
}