lib/pkp/classes/cliTool/UpgradeTool.inc.php

   1 <?php
   2
   3 /**
   4  * @file classes/cliTool/UpgradeTool.php
   5  *
   6  * Copyright (c) 2000-2009 John Willinsky
   7  * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
   8  *
   9  * @class upgradeTool
  10  * @ingroup tools
  11  *
  12  * @brief CLI tool for upgrading OJS.
  13  *
  14  * Note: Some functions require fopen wrappers to be enabled.
  15  */
  16
  17 // $Id: UpgradeTool.inc.php,v 1.5 2009/05/13 00:13:20 asmecher Exp $
  18
  19
  20 define('RUNNING_UPGRADE', 1);
  21
  22 import('install.Upgrade');
  23 import('site.Version');
  24 import('site.VersionCheck');
  25
  26 class UpgradeTool extends CommandLineTool {
  27
  28         /** @var string command to execute (check|upgrade|patch|download) */
  29         var $command;
  30         /**
  31          * Constructor.
  32          * @param $argv array command-line arguments
  33          */
  34         function upgradeTool($argv = array()) {
  35                 parent::CommandLineTool($argv);
  36
  37                 if (!isset($this->argv[0]) || !in_array($this->argv[0], array('check', 'latest', 'upgrade', 'patch', 'download'))) {
  38                         $this->usage();
  39                         exit(1);
  40                 }
  41
  42                 $this->command = $this->argv[0];
  43         }
  44
  45         /**
  46          * Print command usage information.
  47          */
  48         function usage() {
  49                 echo "Upgrade tool\n"
  50                         . "Usage: {$this->scriptName} command\n"
  51                         . "Supported commands:\n"
  52                         . "    check                     perform version check\n"
  53                         . "    latest                    display latest version info\n"
  54                         //. "    upgrade [pretend]         execute upgrade script\n"
  55                         . "    patch                     download and apply patch for latest version\n"
  56                         . "    download [package|patch]  download latest version (does not unpack/install)\n";
  57         }
  58
  59         /**
  60          * Execute the specified command.
  61          */
  62         function execute() {
  63                 $command = $this->command;
  64                 $this->$command();
  65         }
  66
  67         /**
  68          * Perform version check against latest available version.
  69          */
  70         function check() {
  71                 $this->checkVersion(VersionCheck::getLatestVersion());
  72         }
  73
  74         /**
  75          * Print information about the latest available version.
  76          */
  77         function latest() {
  78                 $this->checkVersion(VersionCheck::getLatestVersion(), true);
  79         }
  80
  81         /**
  82          * Run upgrade script.
  83          */
  84         function upgrade() {
  85                 $pretend = false; // isset($this->argv[1]) && $this->argv[1] == 'pretend';
  86                 $installer = new Upgrade(array('manualInstall' => $pretend));
  87                 $installer->setLogger($this);
  88
  89                 if ($installer->execute()) {
  90                         if (count($installer->getNotes()) > 0) {
  91                                 printf("\nRelease Notes\n");
  92                                 printf("----------------------------------------\n");
  93                                 foreach ($installer->getNotes() as $note) {
  94                                         printf("%s\n\n", $note);
  95                                 }
  96                         }
  97
  98                         if ($pretend) {
  99                                 if (count($installer->getSQL()) > 0) {
 100                                         printf("\nSQL\n");
 101                                         printf("----------------------------------------\n");
 102                                         foreach ($installer->getSQL() as $sql) {
 103                                                 printf("%s\n\n", $sql);
 104                                         }
 105                                 }
 106
 107                         } else {
 108                         //get current version's name, check if its null, otherwise disable that version
 109                                 $versionDao =& DAORegistry::getDAO('VersionDAO');
 110                                 $currentVersion =& $installer->getCurrentVersion();
 111                                 if ($product = $currentVersion->getProduct() == '') {
 112                                         $product = 'NULL';
 113                                 }
 114                                 $versionDao->disableVersion($product);
 115
 116                                 $newVersion =& $installer->getNewVersion();
 117                                 printf("Successfully upgraded to version %s\n", $newVersion->getVersionString());
 118                         }
 119
 120                 } else {
 121                         printf("ERROR: Upgrade failed: %s\n", $installer->getErrorString());
 122                 }
 123         }
 124
 125         /**
 126          * Apply patch to update code to latest version.
 127          */
 128         function patch() {
 129                 $versionInfo = VersionCheck::getLatestVersion();
 130                 $check = $this->checkVersion($versionInfo);
 131
 132                 if ($check < 0) {
 133                         $patch = VersionCheck::getPatch($versionInfo);
 134                         if (!isset($patch)) {
 135                                 printf("No applicable patch available\n");
 136                                 return;
 137                         }
 138
 139                         $outFile = $versionInfo['application'] . '-' . $versionInfo['release'] . '.patch';
 140                         printf("Download patch: %s\n", $patch);
 141                         printf("Patch will be saved to: %s\n", $outFile);
 142
 143                         if (!$this->promptContinue()) {
 144                                 exit(0);
 145                         }
 146
 147                         $out = fopen($outFile, 'wb');
 148                         if (!$out) {
 149                                 printf("Failed to open %s for writing\n", $outFile);
 150                                 exit(1);
 151                         }
 152
 153                         $in = gzopen($patch, 'r');
 154                         if (!$in) {
 155                                 printf("Failed to open %s for reading\n", $patch);
 156                                 fclose($out);
 157                                 exit(1);
 158                         }
 159
 160                         printf('Downloading patch...');
 161
 162                         while(($data = gzread($in, 4096)) !== '') {
 163                                 printf('.');
 164                                 fwrite($out, $data);
 165                         }
 166
 167                         printf("done\n");
 168
 169                         gzclose($in);
 170                         fclose($out);
 171
 172                         $command = 'patch -p1 < ' . escapeshellarg($outFile);
 173                         printf("Apply patch: %s\n", $command);
 174
 175                         if (!$this->promptContinue()) {
 176                                 exit(0);
 177                         }
 178
 179                         system($command, $ret);
 180                         if ($ret == 0) {
 181                                 printf("Successfully applied patch for version %s\n", $versionInfo['release']);
 182                         } else {
 183                                 printf("ERROR: Failed to apply patch\n");
 184                         }
 185                 }
 186         }
 187
 188         /**
 189          * Download latest package/patch.
 190          */
 191         function download() {
 192                 $versionInfo = VersionCheck::getLatestVersion();
 193                 if (!$versionInfo) {
 194                         $application =& PKPApplication::getApplication();
 195                         printf("Failed to load version info from %s\n", $application->getVersionDescriptorUrl());
 196                         exit(1);
 197                 }
 198
 199                 $type = isset($this->argv[1]) && $this->argv[1] == 'patch' ? 'patch' : 'package';
 200                 if ($type == 'package') {
 201                         $download = $versionInfo['package'];
 202                 } else {
 203                         $download = VersionCheck::getPatch($versionInfo);
 204                 }
 205                 if (!isset($download)) {
 206                         printf("No applicable download available\n");
 207                         return;
 208                 }
 209                 $outFile = basename($download);
 210
 211                 printf("Download %s: %s\n", $type, $download);
 212                 printf("File will be saved to: %s\n", $outFile);
 213
 214                 if (!$this->promptContinue()) {
 215                         exit(0);
 216                 }
 217
 218                 $out = fopen($outFile, 'wb');
 219                 if (!$out) {
 220                         printf("Failed to open %s for writing\n", $outFile);
 221                         exit(1);
 222                 }
 223
 224                 $in = fopen($download, 'rb');
 225                 if (!$in) {
 226                         printf("Failed to open %s for reading\n", $download);
 227                         fclose($out);
 228                         exit(1);
 229                 }
 230
 231                 printf('Downloading file...');
 232
 233                 while(($data = fread($in, 4096)) !== '') {
 234                         printf('.');
 235                         fwrite($out, $data);
 236                 }
 237
 238                 printf("done\n");
 239
 240                 fclose($in);
 241                 fclose($out);
 242         }
 243
 244         /**
 245          * Perform version check.
 246          * @param $versionInfo array latest version info
 247          * @param $displayInfo boolean just display info, don't perform check
 248          */
 249         function checkVersion($versionInfo, $displayInfo = false) {
 250                 if (!$versionInfo) {
 251                         $application =& PKPApplication::getApplication();
 252                         printf("Failed to load version info from %s\n", $application->getVersionDescriptorUrl());
 253                         exit(1);
 254                 }
 255
 256                 $dbVersion = VersionCheck::getCurrentDBVersion();
 257                 $codeVersion = VersionCheck::getCurrentCodeVersion();
 258                 $latestVersion = $versionInfo['version'];
 259
 260                 printf("Code version:      %s\n", $codeVersion->getVersionString());
 261                 printf("Database version:  %s\n", $dbVersion->getVersionString());
 262                 printf("Latest version:    %s\n", $latestVersion->getVersionString());
 263
 264                 $compare1 = $codeVersion->compare($latestVersion);
 265                 $compare2 = $dbVersion->compare($codeVersion);
 266
 267                 if (!$displayInfo) {
 268                         if ($compare2 < 0) {
 269                                 printf("Database version is older than code version\n");
 270                                 printf("Run \"{$this->scriptName} upgrade\" to update\n");
 271                                 exit(0);
 272
 273                         } else if($compare2 > 0) {
 274                                 printf("Database version is newer than code version!\n");
 275                                 exit(1);
 276
 277                         } else if ($compare1 == 0) {
 278                                 printf("Your system is up-to-date\n");
 279
 280                         } else if($compare1 < 0) {
 281                                 printf("A newer version is available:\n");
 282                                 $displayInfo = true;
 283                         } else {
 284                                 printf("Current version is newer than latest!\n");
 285                                 exit(1);
 286                         }
 287                 }
 288
 289                 if ($displayInfo) {
 290                         $patch = VersionCheck::getPatch($versionInfo, $codeVersion);
 291                         printf("         tag:     %s\n", $versionInfo['tag']);
 292                         printf("         date:    %s\n", $versionInfo['date']);
 293                         printf("         info:    %s\n", $versionInfo['info']);
 294                         printf("         package: %s\n", $versionInfo['package']);
 295                         printf("         patch:   %s\n", isset($patch) ? $patch : 'N/A');
 296                 }
 297
 298                 return $compare1;
 299         }
 300
 301         /**
 302          * Prompt user for yes/no input (default no).
 303          * @param $prompt string
 304          */
 305         function promptContinue($prompt = "Continue?") {
 306                 printf("%s [y/N] ", $prompt);
 307                 $continue = fread(STDIN, 255);
 308                 return (strtolower(substr(trim($continue), 0, 1)) == 'y');
 309         }
 310
 311         /**
 312          * Log install message to stdout.
 313          * @param $message string
 314          */
 315         function log($message) {
 316                 printf("[%s]\n", $message);
 317         }
 318
 319 }
 320
 321 ?>