3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
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 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
17 class CRM_Upgrade_Page_Upgrade
extends CRM_Core_Page
{
22 public function preProcess() {
31 public function run() {
32 // lets get around the time limit issue if possible for upgrades
33 if (!ini_get('safe_mode')) {
37 Civi
::resources()->addStyleFile('civicrm', 'css/admin.css');
39 $upgrade = new CRM_Upgrade_Form();
40 list($currentVer, $latestVer) = $upgrade->getUpgradeVersions();
42 CRM_Utils_System
::setTitle(ts('Upgrade CiviCRM to Version %1',
46 $template = CRM_Core_Smarty
::singleton();
47 $template->assign('pageTitle', ts('Upgrade CiviCRM to Version %1',
50 $template->assign('cancelURL',
51 CRM_Utils_System
::url('civicrm/dashboard', 'reset=1')
54 $action = CRM_Utils_Array
::value('action', $_REQUEST, 'intro');
69 throw new CRM_Core_Exception(ts('Unrecognized upgrade action'));
74 * Display an introductory screen with any pre-upgrade messages.
76 public function runIntro() {
77 $upgrade = new CRM_Upgrade_Form();
78 $template = CRM_Core_Smarty
::singleton();
79 list($currentVer, $latestVer) = $upgrade->getUpgradeVersions();
81 if ($error = $upgrade->checkUpgradeableVersion($currentVer, $latestVer)) {
82 throw new CRM_Core_Exception($error);
85 $config = CRM_Core_Config
::singleton();
87 // All cached content needs to be cleared because the civi codebase was just replaced
88 CRM_Core_Resources
::singleton()->flushStrings()->resetCacheCode();
90 // cleanup only the templates_c directory
91 $config->cleanup(1, FALSE);
93 $preUpgradeMessage = NULL;
94 $upgrade->setPreUpgradeMessage($preUpgradeMessage, $currentVer, $latestVer);
96 $template->assign('currentVersion', $currentVer);
97 $template->assign('newVersion', $latestVer);
98 $template->assign('upgradeTitle', ts('Upgrade CiviCRM from v %1 To v %2',
99 [1 => $currentVer, 2 => $latestVer]
101 $template->assign('upgraded', FALSE);
103 // Render page header
104 if (!defined('CIVICRM_UF_HEAD') && $region = CRM_Core_Region
::instance('html-header', FALSE)) {
105 CRM_Utils_System
::addHTMLHead($region->render(''));
108 $template->assign('preUpgradeMessage', $preUpgradeMessage);
110 $content = $template->fetch('CRM/common/success.tpl');
111 echo CRM_Utils_System
::theme($content, $this->_print
, TRUE);
115 * Begin the upgrade by building a queue of tasks and redirecting to the queue-runner
117 public function runBegin() {
118 $upgrade = new CRM_Upgrade_Form();
119 list($currentVer, $latestVer) = $upgrade->getUpgradeVersions();
121 if ($error = $upgrade->checkUpgradeableVersion($currentVer, $latestVer)) {
122 throw new CRM_Core_Exception($error);
125 $config = CRM_Core_Config
::singleton();
127 $postUpgradeMessage = '<span class="bold">' . ts('Congratulations! Your upgrade was successful!') . '</span>';
129 // lets drop all the triggers here
130 CRM_Core_DAO
::dropTriggers();
132 $this->set('isUpgradePending', TRUE);
134 // Persistent message storage across upgrade steps. TODO: Use structured message store
135 // Note: In clustered deployments, this file must be accessible by all web-workers.
136 $this->set('postUpgradeMessageFile', CRM_Utils_File
::tempnam('civicrm-post-upgrade'));
137 file_put_contents($this->get('postUpgradeMessageFile'), $postUpgradeMessage);
139 $queueRunner = new CRM_Queue_Runner([
140 'title' => ts('CiviCRM Upgrade Tasks'),
141 'queue' => CRM_Upgrade_Form
::buildQueue($currentVer, $latestVer, $this->get('postUpgradeMessageFile')),
143 'pathPrefix' => 'civicrm/upgrade/queue',
144 'onEndUrl' => CRM_Utils_System
::url('civicrm/upgrade', 'action=finish', FALSE, NULL, FALSE),
145 'buttons' => ['retry' => $config->debug
, 'skip' => $config->debug
],
147 $queueRunner->runAllViaWeb();
148 throw new CRM_Core_Exception(ts('Upgrade failed to redirect'));
152 * Display any final messages, clear caches, etc
154 public function runFinish() {
155 $upgrade = new CRM_Upgrade_Form();
156 $template = CRM_Core_Smarty
::singleton();
158 // If we're redirected from queue-runner, then isUpgradePending=true.
159 // If user then reloads the finish page, the isUpgradePending will be unset. (Because the session has been cleared.)
160 if ($this->get('isUpgradePending')) {
161 // TODO: Use structured message store
162 $postUpgradeMessage = file_get_contents($this->get('postUpgradeMessageFile'));
164 // This destroys $session, so do it after get('postUpgradeMessageFile')
165 CRM_Upgrade_Form
::doFinish();
168 // Session was destroyed! Can't recover messages.
169 $postUpgradeMessage = '';
172 // do a version check - after doFinish() sets the final version
173 list($currentVer, $latestVer) = $upgrade->getUpgradeVersions();
174 if ($error = $upgrade->checkCurrentVersion($currentVer, $latestVer)) {
175 throw new CRM_Core_Exception($error);
178 $template->assign('message', $postUpgradeMessage);
179 $template->assign('upgraded', TRUE);
180 $template->assign('sid', CRM_Utils_System
::getSiteID());
181 $template->assign('newVersion', $latestVer);
183 // Render page header
184 if (!defined('CIVICRM_UF_HEAD') && $region = CRM_Core_Region
::instance('html-header', FALSE)) {
185 CRM_Utils_System
::addHTMLHead($region->render(''));
188 $content = $template->fetch('CRM/common/success.tpl');
189 echo CRM_Utils_System
::theme($content, $this->_print
, TRUE);