CRM/Upgrade/Page/Upgrade.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  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('cancelURL',
  58       CRM_Utils_System::url('civicrm/dashboard', 'reset=1')
  59     );
  60
  61     $action = CRM_Utils_Array::value('action', $_REQUEST, 'intro');
  62     switch ($action) {
  63       case 'intro':
  64         $this->runIntro();
  65         break;
  66
  67       case 'begin':
  68         $this->runBegin();
  69         break;
  70
  71       case 'finish':
  72         $this->runFinish();
  73         break;
  74
  75       default:
  76         CRM_Core_Error::fatal(ts('Unrecognized upgrade action'));
  77     }
  78   }
  79
  80   /**
  81    * Display an introductory screen with any pre-upgrade messages
  82    */
  83   function runIntro() {
  84     $upgrade = new CRM_Upgrade_Form();
  85     $template = CRM_Core_Smarty::singleton();
  86     list($currentVer, $latestVer) = $upgrade->getUpgradeVersions();
  87
  88     if ($error = $upgrade->checkUpgradeableVersion($currentVer, $latestVer)) {
  89       CRM_Core_Error::fatal($error);
  90     }
  91
  92     $config = CRM_Core_Config::singleton();
  93
  94     // All cached content needs to be cleared because the civi codebase was just replaced
  95     CRM_Core_Resources::singleton()->flushStrings()->resetCacheCode();
  96     CRM_Core_Menu::store();
  97
  98     // This could be removed in later rev
  99     if ($currentVer == '2.1.6') {
 100       $config = CRM_Core_Config::singleton();
 101       // also cleanup the templates_c directory
 102       $config->cleanupCaches();
 103     } else {
 104       $config = CRM_Core_Config::singleton();
 105       // cleanup only the templates_c directory
 106       $config->cleanup(1, FALSE);
 107     }
 108     // end of hack
 109
 110     $preUpgradeMessage = NULL;
 111     $upgrade->setPreUpgradeMessage($preUpgradeMessage, $currentVer, $latestVer);
 112
 113     $template->assign('currentVersion', $currentVer);
 114     $template->assign('newVersion', $latestVer);
 115     $template->assign('upgradeTitle', ts('Upgrade CiviCRM from v %1 To v %2',
 116       array(1 => $currentVer, 2 => $latestVer)
 117     ));
 118     $template->assign('upgraded', FALSE);
 119
 120     // Render page header
 121     if (!defined('CIVICRM_UF_HEAD') && $region = CRM_Core_Region::instance('html-header', FALSE)) {
 122       CRM_Utils_System::addHTMLHead($region->render(''));
 123     }
 124
 125     $template->assign('preUpgradeMessage', $preUpgradeMessage);
 126
 127     $content = $template->fetch('CRM/common/success.tpl');
 128     echo CRM_Utils_System::theme($content, $this->_print, TRUE);
 129   }
 130
 131   /**
 132    * Begin the upgrade by building a queue of tasks and redirecting to the queue-runner
 133    */
 134   function runBegin() {
 135     $upgrade = new CRM_Upgrade_Form();
 136     list($currentVer, $latestVer) = $upgrade->getUpgradeVersions();
 137
 138     if ($error = $upgrade->checkUpgradeableVersion($currentVer, $latestVer)) {
 139       CRM_Core_Error::fatal($error);
 140     }
 141
 142     $config = CRM_Core_Config::singleton();
 143
 144     $postUpgradeMessage = '<span class="bold">' . ts('Congratulations! Your upgrade was successful! (... wasn\'t that easy!)') . '</span>';
 145
 146     // lets drop all the triggers here
 147     CRM_Core_DAO::dropTriggers();
 148
 149     $this->set('isUpgradePending', TRUE);
 150
 151     // Persistent message storage across upgrade steps. TODO: Use structured message store
 152     // Note: In clustered deployments, this file must be accessible by all web-workers.
 153     $this->set('postUpgradeMessageFile', CRM_Utils_File::tempnam('civicrm-post-upgrade'));
 154     file_put_contents($this->get('postUpgradeMessageFile'), $postUpgradeMessage);
 155
 156     $queueRunner = new CRM_Queue_Runner(array(
 157       'title' => ts('CiviCRM Upgrade Tasks'),
 158       'queue' => CRM_Upgrade_Form::buildQueue($currentVer, $latestVer, $this->get('postUpgradeMessageFile')),
 159       'isMinimal' => TRUE,
 160       'pathPrefix' => 'civicrm/upgrade/queue',
 161       'onEndUrl' => CRM_Utils_System::url('civicrm/upgrade', 'action=finish', FALSE, NULL, FALSE ),
 162       'buttons' => array('retry' => $config->debug, 'skip' => $config->debug),
 163       ));
 164     $queueRunner->runAllViaWeb();
 165     CRM_Core_Error::fatal(ts('Upgrade failed to redirect'));
 166   }
 167
 168   /**
 169    * Display any final messages, clear caches, etc
 170    */
 171   function runFinish() {
 172     $upgrade = new CRM_Upgrade_Form();
 173     $template = CRM_Core_Smarty::singleton();
 174
 175     // If we're redirected from queue-runner, then isUpgradePending=true.
 176     // If user then reloads the finish page, the isUpgradePending will be unset. (Because the session has been cleared.)
 177     if ($this->get('isUpgradePending')) {
 178       // TODO: Use structured message store
 179       $postUpgradeMessage = file_get_contents($this->get('postUpgradeMessageFile'));
 180
 181       // This destroys $session, so do it after get('postUpgradeMessageFile')
 182       CRM_Upgrade_Form::doFinish();
 183     } else {
 184       $postUpgradeMessage = ''; // Session was destroyed! Can't recover messages.
 185     }
 186
 187     // do a version check - after doFinish() sets the final version
 188     list($currentVer, $latestVer) = $upgrade->getUpgradeVersions();
 189     if ($error = $upgrade->checkCurrentVersion($currentVer, $latestVer)) {
 190       CRM_Core_Error::fatal($error);
 191     }
 192
 193     $template->assign('message', $postUpgradeMessage);
 194     $template->assign('upgraded', TRUE);
 195
 196     // Render page header
 197     if (!defined('CIVICRM_UF_HEAD') && $region = CRM_Core_Region::instance('html-header', FALSE)) {
 198       CRM_Utils_System::addHTMLHead($region->render(''));
 199     }
 200
 201     $content = $template->fetch('CRM/common/success.tpl');
 202     echo CRM_Utils_System::theme($content, $this->_print, TRUE);
 203   }
 204 }
 205