CRM/Upgrade/Page/Upgrade.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17 class CRM_Upgrade_Page_Upgrade extends CRM_Core_Page {
  18
  19   /**
  20    * Pre-process.
  21    */
  22   public function preProcess() {
  23     parent::preProcess();
  24   }
  25
  26   /**
  27    * Run upgrade.
  28    *
  29    * @throws \Exception
  30    */
  31   public function run() {
  32     // lets get around the time limit issue if possible for upgrades
  33     if (!ini_get('safe_mode')) {
  34       set_time_limit(0);
  35     }
  36
  37     Civi::resources()->addStyleFile('civicrm', 'css/admin.css');
  38
  39     $upgrade = new CRM_Upgrade_Form();
  40     list($currentVer, $latestVer) = $upgrade->getUpgradeVersions();
  41
  42     CRM_Utils_System::setTitle(ts('Upgrade CiviCRM to Version %1',
  43       [1 => $latestVer]
  44     ));
  45
  46     $template = CRM_Core_Smarty::singleton();
  47     $template->assign('pageTitle', ts('Upgrade CiviCRM to Version %1',
  48       [1 => $latestVer]
  49     ));
  50     $template->assign('cancelURL',
  51       CRM_Utils_System::url('civicrm/dashboard', 'reset=1')
  52     );
  53
  54     $action = CRM_Utils_Array::value('action', $_REQUEST, 'intro');
  55     switch ($action) {
  56       case 'intro':
  57         $this->runIntro();
  58         break;
  59
  60       case 'begin':
  61         $this->runBegin();
  62         break;
  63
  64       case 'finish':
  65         $this->runFinish();
  66         break;
  67
  68       default:
  69         CRM_Core_Error::fatal(ts('Unrecognized upgrade action'));
  70     }
  71   }
  72
  73   /**
  74    * Display an introductory screen with any pre-upgrade messages.
  75    */
  76   public function runIntro() {
  77     $upgrade = new CRM_Upgrade_Form();
  78     $template = CRM_Core_Smarty::singleton();
  79     list($currentVer, $latestVer) = $upgrade->getUpgradeVersions();
  80
  81     if ($error = $upgrade->checkUpgradeableVersion($currentVer, $latestVer)) {
  82       CRM_Core_Error::fatal($error);
  83     }
  84
  85     $config = CRM_Core_Config::singleton();
  86
  87     // All cached content needs to be cleared because the civi codebase was just replaced
  88     CRM_Core_Resources::singleton()->flushStrings()->resetCacheCode();
  89     CRM_Core_Menu::store();
  90
  91     // cleanup only the templates_c directory
  92     $config->cleanup(1, FALSE);
  93
  94     $preUpgradeMessage = NULL;
  95     $upgrade->setPreUpgradeMessage($preUpgradeMessage, $currentVer, $latestVer);
  96
  97     $template->assign('currentVersion', $currentVer);
  98     $template->assign('newVersion', $latestVer);
  99     $template->assign('upgradeTitle', ts('Upgrade CiviCRM from v %1 To v %2',
 100       [1 => $currentVer, 2 => $latestVer]
 101     ));
 102     $template->assign('upgraded', FALSE);
 103
 104     // Render page header
 105     if (!defined('CIVICRM_UF_HEAD') && $region = CRM_Core_Region::instance('html-header', FALSE)) {
 106       CRM_Utils_System::addHTMLHead($region->render(''));
 107     }
 108
 109     $template->assign('preUpgradeMessage', $preUpgradeMessage);
 110
 111     $content = $template->fetch('CRM/common/success.tpl');
 112     echo CRM_Utils_System::theme($content, $this->_print, TRUE);
 113   }
 114
 115   /**
 116    * Begin the upgrade by building a queue of tasks and redirecting to the queue-runner
 117    */
 118   public function runBegin() {
 119     $upgrade = new CRM_Upgrade_Form();
 120     list($currentVer, $latestVer) = $upgrade->getUpgradeVersions();
 121
 122     if ($error = $upgrade->checkUpgradeableVersion($currentVer, $latestVer)) {
 123       CRM_Core_Error::fatal($error);
 124     }
 125
 126     $config = CRM_Core_Config::singleton();
 127
 128     $postUpgradeMessage = '<span class="bold">' . ts('Congratulations! Your upgrade was successful!') . '</span>';
 129
 130     // lets drop all the triggers here
 131     CRM_Core_DAO::dropTriggers();
 132
 133     $this->set('isUpgradePending', TRUE);
 134
 135     // Persistent message storage across upgrade steps. TODO: Use structured message store
 136     // Note: In clustered deployments, this file must be accessible by all web-workers.
 137     $this->set('postUpgradeMessageFile', CRM_Utils_File::tempnam('civicrm-post-upgrade'));
 138     file_put_contents($this->get('postUpgradeMessageFile'), $postUpgradeMessage);
 139
 140     $queueRunner = new CRM_Queue_Runner([
 141       'title' => ts('CiviCRM Upgrade Tasks'),
 142       'queue' => CRM_Upgrade_Form::buildQueue($currentVer, $latestVer, $this->get('postUpgradeMessageFile')),
 143       'isMinimal' => TRUE,
 144       'pathPrefix' => 'civicrm/upgrade/queue',
 145       'onEndUrl' => CRM_Utils_System::url('civicrm/upgrade', 'action=finish', FALSE, NULL, FALSE),
 146       'buttons' => ['retry' => $config->debug, 'skip' => $config->debug],
 147     ]);
 148     $queueRunner->runAllViaWeb();
 149     CRM_Core_Error::fatal(ts('Upgrade failed to redirect'));
 150   }
 151
 152   /**
 153    * Display any final messages, clear caches, etc
 154    */
 155   public function runFinish() {
 156     $upgrade = new CRM_Upgrade_Form();
 157     $template = CRM_Core_Smarty::singleton();
 158
 159     // If we're redirected from queue-runner, then isUpgradePending=true.
 160     // If user then reloads the finish page, the isUpgradePending will be unset. (Because the session has been cleared.)
 161     if ($this->get('isUpgradePending')) {
 162       // TODO: Use structured message store
 163       $postUpgradeMessage = file_get_contents($this->get('postUpgradeMessageFile'));
 164
 165       // This destroys $session, so do it after get('postUpgradeMessageFile')
 166       CRM_Upgrade_Form::doFinish();
 167     }
 168     else {
 169       // Session was destroyed! Can't recover messages.
 170       $postUpgradeMessage = '';
 171     }
 172
 173     // do a version check - after doFinish() sets the final version
 174     list($currentVer, $latestVer) = $upgrade->getUpgradeVersions();
 175     if ($error = $upgrade->checkCurrentVersion($currentVer, $latestVer)) {
 176       CRM_Core_Error::fatal($error);
 177     }
 178
 179     $template->assign('message', $postUpgradeMessage);
 180     $template->assign('upgraded', TRUE);
 181     $template->assign('sid', CRM_Utils_System::getSiteID());
 182     $template->assign('newVersion', $latestVer);
 183
 184     // Render page header
 185     if (!defined('CIVICRM_UF_HEAD') && $region = CRM_Core_Region::instance('html-header', FALSE)) {
 186       CRM_Utils_System::addHTMLHead($region->render(''));
 187     }
 188
 189     $content = $template->fetch('CRM/common/success.tpl');
 190     echo CRM_Utils_System::theme($content, $this->_print, TRUE);
 191   }
 192
 193 }