3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2018
33 class CRM_Upgrade_Page_Upgrade
extends CRM_Core_Page
{
38 public function preProcess() {
47 public function run() {
48 // lets get around the time limit issue if possible for upgrades
49 if (!ini_get('safe_mode')) {
53 Civi
::resources()->addStyleFile('civicrm', 'css/admin.css');
55 $upgrade = new CRM_Upgrade_Form();
56 list($currentVer, $latestVer) = $upgrade->getUpgradeVersions();
58 CRM_Utils_System
::setTitle(ts('Upgrade CiviCRM to Version %1',
59 array(1 => $latestVer)
62 $template = CRM_Core_Smarty
::singleton();
63 $template->assign('pageTitle', ts('Upgrade CiviCRM to Version %1',
64 array(1 => $latestVer)
66 $template->assign('cancelURL',
67 CRM_Utils_System
::url('civicrm/dashboard', 'reset=1')
70 $action = CRM_Utils_Array
::value('action', $_REQUEST, 'intro');
85 CRM_Core_Error
::fatal(ts('Unrecognized upgrade action'));
90 * Display an introductory screen with any pre-upgrade messages.
92 public function runIntro() {
93 $upgrade = new CRM_Upgrade_Form();
94 $template = CRM_Core_Smarty
::singleton();
95 list($currentVer, $latestVer) = $upgrade->getUpgradeVersions();
97 if ($error = $upgrade->checkUpgradeableVersion($currentVer, $latestVer)) {
98 CRM_Core_Error
::fatal($error);
101 $config = CRM_Core_Config
::singleton();
103 // All cached content needs to be cleared because the civi codebase was just replaced
104 CRM_Core_Resources
::singleton()->flushStrings()->resetCacheCode();
105 CRM_Core_Menu
::store();
107 // cleanup only the templates_c directory
108 $config->cleanup(1, FALSE);
110 $preUpgradeMessage = NULL;
111 $upgrade->setPreUpgradeMessage($preUpgradeMessage, $currentVer, $latestVer);
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)
118 $template->assign('upgraded', FALSE);
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(''));
125 $template->assign('preUpgradeMessage', $preUpgradeMessage);
127 $content = $template->fetch('CRM/common/success.tpl');
128 echo CRM_Utils_System
::theme($content, $this->_print
, TRUE);
132 * Begin the upgrade by building a queue of tasks and redirecting to the queue-runner
134 public function runBegin() {
135 $upgrade = new CRM_Upgrade_Form();
136 list($currentVer, $latestVer) = $upgrade->getUpgradeVersions();
138 if ($error = $upgrade->checkUpgradeableVersion($currentVer, $latestVer)) {
139 CRM_Core_Error
::fatal($error);
142 $config = CRM_Core_Config
::singleton();
144 $postUpgradeMessage = '<span class="bold">' . ts('Congratulations! Your upgrade was successful!') . '</span>';
146 // lets drop all the triggers here
147 CRM_Core_DAO
::dropTriggers();
149 $this->set('isUpgradePending', TRUE);
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);
156 $queueRunner = new CRM_Queue_Runner(array(
157 'title' => ts('CiviCRM Upgrade Tasks'),
158 'queue' => CRM_Upgrade_Form
::buildQueue($currentVer, $latestVer, $this->get('postUpgradeMessageFile')),
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
),
164 $queueRunner->runAllViaWeb();
165 CRM_Core_Error
::fatal(ts('Upgrade failed to redirect'));
169 * Display any final messages, clear caches, etc
171 public function runFinish() {
172 $upgrade = new CRM_Upgrade_Form();
173 $template = CRM_Core_Smarty
::singleton();
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'));
181 // This destroys $session, so do it after get('postUpgradeMessageFile')
182 CRM_Upgrade_Form
::doFinish();
185 $postUpgradeMessage = ''; // Session was destroyed! Can't recover messages.
188 // do a version check - after doFinish() sets the final version
189 list($currentVer, $latestVer) = $upgrade->getUpgradeVersions();
190 if ($error = $upgrade->checkCurrentVersion($currentVer, $latestVer)) {
191 CRM_Core_Error
::fatal($error);
194 $template->assign('message', $postUpgradeMessage);
195 $template->assign('upgraded', TRUE);
196 $template->assign('sid', CRM_Utils_System
::getSiteID());
197 $template->assign('newVersion', $latestVer);
199 // Render page header
200 if (!defined('CIVICRM_UF_HEAD') && $region = CRM_Core_Region
::instance('html-header', FALSE)) {
201 CRM_Utils_System
::addHTMLHead($region->render(''));
204 $content = $template->fetch('CRM/common/success.tpl');
205 echo CRM_Utils_System
::theme($content, $this->_print
, TRUE);