3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
35 class CRM_Upgrade_Page_Upgrade
extends CRM_Core_Page
{
36 function preProcess() {
41 // lets get around the time limit issue if possible for upgrades
42 if (!ini_get('safe_mode')) {
46 $upgrade = new CRM_Upgrade_Form();
47 list($currentVer, $latestVer) = $upgrade->getUpgradeVersions();
49 CRM_Utils_System
::setTitle(ts('Upgrade CiviCRM to Version %1',
50 array(1 => $latestVer)
53 $template = CRM_Core_Smarty
::singleton();
54 $template->assign('pageTitle', ts('Upgrade CiviCRM to Version %1',
55 array(1 => $latestVer)
57 $template->assign('cancelURL',
58 CRM_Utils_System
::url('civicrm/dashboard', 'reset=1')
61 $action = CRM_Utils_Array
::value('action', $_REQUEST, 'intro');
76 CRM_Core_Error
::fatal(ts('Unrecognized upgrade action'));
81 * Display an introductory screen with any pre-upgrade messages
84 $upgrade = new CRM_Upgrade_Form();
85 $template = CRM_Core_Smarty
::singleton();
86 list($currentVer, $latestVer) = $upgrade->getUpgradeVersions();
88 if ($error = $upgrade->checkUpgradeableVersion($currentVer, $latestVer)) {
89 CRM_Core_Error
::fatal($error);
92 // This could be removed in later rev
93 if ($currentVer == '2.1.6') {
94 $config = CRM_Core_Config
::singleton();
95 // also cleanup the templates_c directory
96 $config->cleanupCaches();
98 $config = CRM_Core_Config
::singleton();
99 // cleanup only the templates_c directory
100 $config->cleanup(1, FALSE);
104 $preUpgradeMessage = NULL;
105 $upgrade->setPreUpgradeMessage($preUpgradeMessage, $currentVer, $latestVer);
107 $template->assign('currentVersion', $currentVer);
108 $template->assign('newVersion', $latestVer);
109 $template->assign('upgradeTitle', ts('Upgrade CiviCRM from v %1 To v %2',
110 array(1 => $currentVer, 2 => $latestVer)
112 $template->assign('upgraded', FALSE);
114 // Render page header
115 if (!defined('CIVICRM_UF_HEAD') && $region = CRM_Core_Region
::instance('html-header', FALSE)) {
116 CRM_Utils_System
::addHTMLHead($region->render(''));
119 $template->assign('preUpgradeMessage', $preUpgradeMessage);
120 // $template->assign( 'message', $postUpgradeMessage );
122 $content = $template->fetch('CRM/common/success.tpl');
123 echo CRM_Utils_System
::theme($content, $this->_print
, TRUE);
127 * Begin the upgrade by building a queue of tasks and redirecting to the queue-runner
129 function runBegin() {
130 $upgrade = new CRM_Upgrade_Form();
131 list($currentVer, $latestVer) = $upgrade->getUpgradeVersions();
133 if ($error = $upgrade->checkUpgradeableVersion($currentVer, $latestVer)) {
134 CRM_Core_Error
::fatal($error);
137 $config = CRM_Core_Config
::singleton();
138 // This could be removed in later rev
139 if ($currentVer == '2.1.6') {
140 // also cleanup the templates_c directory
141 $config->cleanupCaches();
145 $postUpgradeMessage = ts('Congratulations! Your upgrade was successful! (... wasn\'t that easy!)');
147 // lets drop all the triggers here
148 CRM_Core_DAO
::dropTriggers();
150 $this->set('isUpgradePending', TRUE);
152 // Persistent message storage across upgrade steps. TODO: Use structured message store
153 // Note: In clustered deployments, this file must be accessible by all web-workers.
154 $this->set('postUpgradeMessageFile', CRM_Utils_File
::tempnam('civicrm-post-upgrade'));
155 file_put_contents($this->get('postUpgradeMessageFile'), $postUpgradeMessage);
157 $queueRunner = new CRM_Queue_Runner(array(
158 'title' => ts('CiviCRM Upgrade Tasks'),
159 'queue' => CRM_Upgrade_Form
::buildQueue($currentVer, $latestVer, $this->get('postUpgradeMessageFile')),
161 'pathPrefix' => 'civicrm/upgrade/queue',
162 'onEndUrl' => CRM_Utils_System
::url('civicrm/upgrade', 'action=finish', FALSE, NULL, FALSE ),
163 'buttons' => array('retry' => $config->debug
, 'skip' => $config->debug
),
165 $queueRunner->runAllViaWeb();
166 CRM_Core_Error
::fatal(ts('Upgrade failed to redirect'));
170 * Display any final messages, clear caches, etc
172 function runFinish() {
173 $upgrade = new CRM_Upgrade_Form();
174 $template = CRM_Core_Smarty
::singleton();
176 // If we're redirected from queue-runner, then isUpgradePending=true.
177 // If user then reloads the finish page, the isUpgradePending will be unset. (Because the session has been cleared.)
178 if ($this->get('isUpgradePending')) {
179 // TODO: Use structured message store
180 $postUpgradeMessage = file_get_contents($this->get('postUpgradeMessageFile'));
182 // This destroys $session, so do it after get('postUpgradeMessageFile')
183 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);
197 // Render page header
198 if (!defined('CIVICRM_UF_HEAD') && $region = CRM_Core_Region
::instance('html-header', FALSE)) {
199 CRM_Utils_System
::addHTMLHead($region->render(''));
202 $content = $template->fetch('CRM/common/success.tpl');
203 echo CRM_Utils_System
::theme($content, $this->_print
, TRUE);