CRM/Upgrade/Page/Upgrade.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.3                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2013
  32  * $Id$
  33  *
  34  */
  35 class CRM_Upgrade_Page_Upgrade extends CRM_Core_Page {
  36   function preProcess() {
  37     parent::preProcess();
  38   }
  39
  40   function run() {
  41     // lets get around the time limit issue if possible for upgrades
  42     if (!ini_get('safe_mode')) {
  43       set_time_limit(0);
  44     }
  45
  46     $upgrade = new CRM_Upgrade_Form();
  47     list($currentVer, $latestVer) = $upgrade->getUpgradeVersions();
  48
  49     CRM_Utils_System::setTitle(ts('Upgrade CiviCRM to Version %1',
  50       array(1 => $latestVer)
  51     ));
  52
  53     $template = CRM_Core_Smarty::singleton();
  54     $template->assign('pageTitle', ts('Upgrade CiviCRM to Version %1',
  55       array(1 => $latestVer)
  56     ));
  57     $template->assign('menuRebuildURL',
  58       CRM_Utils_System::url('civicrm/menu/rebuild', 'reset=1')
  59     );
  60     $template->assign('cancelURL',
  61       CRM_Utils_System::url('civicrm/dashboard', 'reset=1')
  62     );
  63
  64     $action = CRM_Utils_Array::value('action', $_REQUEST, 'intro');
  65     switch ($action) {
  66       case 'intro':
  67         $this->runIntro();
  68         break;
  69
  70       case 'begin':
  71         $this->runBegin();
  72         break;
  73
  74       case 'finish':
  75         $this->runFinish();
  76         break;
  77
  78       default:
  79         CRM_Core_Error::fatal(ts('Unrecognized upgrade action'));
  80     }
  81   }
  82
  83   /**
  84    * Display an introductory screen with any pre-upgrade messages
  85    */
  86   function runIntro() {
  87     $upgrade = new CRM_Upgrade_Form();
  88     $template = CRM_Core_Smarty::singleton();
  89     list($currentVer, $latestVer) = $upgrade->getUpgradeVersions();
  90
  91     if ($error = $upgrade->checkUpgradeableVersion($currentVer, $latestVer)) {
  92       CRM_Core_Error::fatal($error);
  93     }
  94
  95     // This could be removed in later rev
  96     if ($currentVer == '2.1.6') {
  97       $config = CRM_Core_Config::singleton();
  98       // also cleanup the templates_c directory
  99       $config->cleanupCaches();
 100     } else {
 101       $config = CRM_Core_Config::singleton();
 102       // cleanup only the templates_c directory
 103       $config->cleanup(1, FALSE);
 104     }
 105     // end of hack
 106
 107     $preUpgradeMessage = NULL;
 108     $upgrade->setPreUpgradeMessage($preUpgradeMessage, $currentVer, $latestVer);
 109
 110     $template->assign('currentVersion', $currentVer);
 111     $template->assign('newVersion', $latestVer);
 112     $template->assign('upgradeTitle', ts('Upgrade CiviCRM from v %1 To v %2',
 113       array(1 => $currentVer, 2 => $latestVer)
 114     ));
 115     $template->assign('upgraded', FALSE);
 116
 117     // Render page header
 118     if (!defined('CIVICRM_UF_HEAD') && $region = CRM_Core_Region::instance('html-header', FALSE)) {
 119       CRM_Utils_System::addHTMLHead($region->render(''));
 120     }
 121
 122     $template->assign('preUpgradeMessage', $preUpgradeMessage);
 123     // $template->assign( 'message', $postUpgradeMessage );
 124
 125     $content = $template->fetch('CRM/common/success.tpl');
 126     echo CRM_Utils_System::theme($content, $this->_print, TRUE);
 127   }
 128
 129   /**
 130    * Begin the upgrade by building a queue of tasks and redirecting to the queue-runner
 131    */
 132   function runBegin() {
 133     $upgrade = new CRM_Upgrade_Form();
 134     list($currentVer, $latestVer) = $upgrade->getUpgradeVersions();
 135
 136     if ($error = $upgrade->checkUpgradeableVersion($currentVer, $latestVer)) {
 137       CRM_Core_Error::fatal($error);
 138     }
 139
 140     $config = CRM_Core_Config::singleton();
 141     // This could be removed in later rev
 142     if ($currentVer == '2.1.6') {
 143       // also cleanup the templates_c directory
 144       $config->cleanupCaches();
 145     }
 146     // end of hack
 147
 148     $postUpgradeMessage = ts('CiviCRM upgrade was successful.');
 149
 150     // lets drop all the triggers here
 151     CRM_Core_DAO::dropTriggers();
 152
 153     $this->set('isUpgradePending', TRUE);
 154
 155     // Persistent message storage across upgrade steps. TODO: Use structured message store
 156     // Note: In clustered deployments, this file must be accessible by all web-workers.
 157     $this->set('postUpgradeMessageFile', CRM_Utils_File::tempnam('civicrm-post-upgrade'));
 158     file_put_contents($this->get('postUpgradeMessageFile'), $postUpgradeMessage);
 159
 160     $queueRunner = new CRM_Queue_Runner(array(
 161       'title' => ts('CiviCRM Upgrade Tasks'),
 162       'queue' => CRM_Upgrade_Form::buildQueue($currentVer, $latestVer, $this->get('postUpgradeMessageFile')),
 163       'isMinimal' => TRUE,
 164       'pathPrefix' => 'civicrm/upgrade/queue',
 165       'onEndUrl' => CRM_Utils_System::url('civicrm/upgrade', 'action=finish', FALSE, NULL, FALSE ),
 166       'buttons' => array('retry' => $config->debug, 'skip' => $config->debug),
 167       ));
 168     $queueRunner->runAllViaWeb();
 169     CRM_Core_Error::fatal(ts('Upgrade failed to redirect'));
 170   }
 171
 172   /**
 173    * Display any final messages, clear caches, etc
 174    */
 175   function runFinish() {
 176     $upgrade = new CRM_Upgrade_Form();
 177     $template = CRM_Core_Smarty::singleton();
 178
 179     // If we're redirected from queue-runner, then isUpgradePending=true.
 180     // If user then reloads the finish page, the isUpgradePending will be unset. (Because the session has been cleared.)
 181     if ($this->get('isUpgradePending')) {
 182       // TODO: Use structured message store
 183       $postUpgradeMessage = file_get_contents($this->get('postUpgradeMessageFile'));
 184
 185       // This destroys $session, so do it after get('postUpgradeMessageFile')
 186       CRM_Upgrade_Form::doFinish();
 187     } else {
 188       $postUpgradeMessage = ''; // Session was destroyed! Can't recover messages.
 189     }
 190
 191     // do a version check - after doFinish() sets the final version
 192     list($currentVer, $latestVer) = $upgrade->getUpgradeVersions();
 193     if ($error = $upgrade->checkCurrentVersion($currentVer, $latestVer)) {
 194       CRM_Core_Error::fatal($error);
 195     }
 196
 197     $template->assign('message', $postUpgradeMessage);
 198     $template->assign('upgraded', TRUE);
 199
 200     // Render page header
 201     if (!defined('CIVICRM_UF_HEAD') && $region = CRM_Core_Region::instance('html-header', FALSE)) {
 202       CRM_Utils_System::addHTMLHead($region->render(''));
 203     }
 204
 205     $content = $template->fetch('CRM/common/success.tpl');
 206     echo CRM_Utils_System::theme($content, $this->_print, TRUE);
 207   }
 208 }
 209