3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
37 * This class is a container for legacy upgrade logic which predates
38 * the current 'CRM/Incremental/php/*' structure.
40 class CRM_Upgrade_Incremental_Legacy
{
43 * Compute any messages which should be displayed before upgrade.
45 * @param string $preUpgradeMessage
50 public static function setPreUpgradeMessage(&$preUpgradeMessage, $currentVer, $latestVer) {
51 $upgrade = new CRM_Upgrade_Form();
52 $template = CRM_Core_Smarty
::singleton();
54 if ((version_compare($currentVer, '3.3.alpha1') < 0 &&
55 version_compare($latestVer, '3.3.alpha1') >= 0
57 (version_compare($currentVer, '3.4.alpha1') < 0 &&
58 version_compare($latestVer, '3.4.alpha1') >= 0
63 FROM civicrm_mailing_job
64 WHERE status NOT IN ( 'Complete', 'Canceled' ) AND is_test = 0 LIMIT 1";
65 $mjId = CRM_Core_DAO
::singleValueQuery($query);
67 $preUpgradeMessage = ts("There are one or more Scheduled or In Progress mailings in your install. Scheduled mailings will not be sent and In Progress mailings will not finish if you continue with the upgrade. We strongly recommend that all Scheduled and In Progress mailings be completed or cancelled and then upgrade your CiviCRM install.");
71 //turning some tables to monolingual during 3.4.beta3, CRM-7869
72 $upgradeTo = str_replace('4.0.', '3.4.', $latestVer);
73 $upgradeFrom = str_replace('4.0.', '3.4.', $currentVer);
75 // check for changed message templates
76 self
::checkMessageTemplate($template, $preUpgradeMessage, $upgradeTo, $upgradeFrom);
78 $upgrade = new CRM_Upgrade_Form();
79 if ($upgrade->multilingual
&&
80 version_compare($upgradeFrom, '3.4.beta3') == -1 &&
81 version_compare($upgradeTo, '3.4.beta3') >= 0
83 $config = CRM_Core_Config
::singleton();
84 $preUpgradeMessage .= '<br />' . ts("As per <a href='%1'>the related blog post</a>, we are making contact names, addresses and mailings monolingual; the values entered for the default locale (%2) will be preserved and values for other locales removed.", array(
85 1 => 'http://civicrm.org/blogs/shot/multilingual-civicrm-3440-making-some-fields-monolingual',
86 2 => $config->lcMessages
,
90 if (version_compare($currentVer, '3.4.6') == -1 &&
91 version_compare($latestVer, '3.4.6') >= 0
93 $googleProcessorExists = CRM_Core_DAO
::singleValueQuery("SELECT id FROM civicrm_payment_processor WHERE payment_processor_type = 'Google_Checkout' AND is_active = 1 LIMIT 1;");
95 if ($googleProcessorExists) {
96 $preUpgradeMessage .= '<br />' . ts('To continue using Google Checkout Payment Processor with latest version of CiviCRM, requires updating merchant account settings. Please refer "Set API callback URL and other settings" section of <a href="%1" target="_blank"><strong>Google Checkout Configuration</strong></a> doc.', array(1 => 'http://wiki.civicrm.org/confluence/x/zAJTAg'));
100 // http://issues.civicrm.org/jira/browse/CRM-13572
101 // Depending on how the code was upgraded, some sites may still have copies of old
102 // source files left behind. This is often a forgivable offense, but it's quite
103 // dangerous for CIVI-SA-2013-001.
104 global $civicrm_root;
105 $ofcFile = "$civicrm_root/packages/OpenFlashChart/php-ofc-library/ofc_upload_image.php";
106 if (file_exists($ofcFile)) {
107 if (@unlink
($ofcFile)) {
108 $preUpgradeMessage .= '<br />' . ts('This system included an outdated, insecure script (%1). The file was automatically deleted.', array(
113 $preUpgradeMessage .= '<br />' . ts('This system includes an outdated, insecure script (%1). Please delete it.', array(
119 if (CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SEARCH_PREFERENCES_NAME
, 'enable_innodb_fts', NULL, FALSE)) {
120 // The FTS indexing feature dynamically manipulates the schema which could
121 // cause conflicts with other layers that manipulate the schema. The
122 // simplest thing is to turn it off and back on.
124 // It may not always be necessary to do this -- but I doubt we're going to test
125 // systematically in future releases. When it is necessary, one could probably
126 // ignore the matter and simply run CRM_Core_InnoDBIndexer::fixSchemaDifferences
127 // after the upgrade. But that's speculative. For now, we'll leave this
128 // advanced feature in the hands of the sysadmin.
129 $preUpgradeMessage .= '<br />' . ts('This database uses InnoDB Full Text Search for optimized searching. The upgrade procedure has not been tested with this feature. You should disable (and later re-enable) the feature by navigating to "Administer => System Settings => Miscellaneous".');
139 public static function checkMessageTemplate(&$template, &$message, $latestVer, $currentVer) {
140 if (version_compare($currentVer, '3.1.alpha1') < 0) {
144 $sql = "SELECT orig.workflow_id as workflow_id,
145 orig.msg_title as title
146 FROM civicrm_msg_template diverted JOIN civicrm_msg_template orig ON (
147 diverted.workflow_id = orig.workflow_id AND
148 orig.is_reserved = 1 AND (
149 diverted.msg_subject != orig.msg_subject OR
150 diverted.msg_text != orig.msg_text OR
151 diverted.msg_html != orig.msg_html
155 $dao = &CRM_Core_DAO
::executeQuery($sql);
156 while ($dao->fetch()) {
157 $workflows[$dao->workflow_id
] = $dao->title
;
160 if (empty($workflows)) {
165 $pathName = dirname(dirname(__FILE__
));
167 foreach ($workflows as $workflow => $title) {
168 $name = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue',
174 // check if file exists locally
175 $textFileName = implode(DIRECTORY_SEPARATOR
,
178 "{$latestVer}.msg_template",
184 $htmlFileName = implode(DIRECTORY_SEPARATOR
,
187 "{$latestVer}.msg_template",
193 if (file_exists($textFileName) ||
194 file_exists($htmlFileName)
197 $html .= "<li>{$title}</li>";
202 $html = "<ul>" . $html . "<ul>";
204 $message .= '<br />' . ts("The default copies of the message templates listed below will be updated to handle new features or correct a problem. Your installation has customized versions of these message templates, and you will need to apply the updates manually after running this upgrade. <a href='%1' style='color:white; text-decoration:underline; font-weight:bold;' target='_blank'>Click here</a> for detailed instructions. %2", array(
205 1 => 'http://wiki.civicrm.org/confluence/display/CRMDOC/Message+Templates#MessageTemplates-UpgradesandCustomizedSystemWorkflowTemplates',
212 * Compute any messages which should be displayed after upgrade.
214 * @param string $postUpgradeMessage
217 * an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
220 public static function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
221 if ($rev == '3.2.alpha1') {
222 $postUpgradeMessage .= '<br />' . ts("We have reset the COUNTED flag to false for the event participant status 'Pending from incomplete transaction'. This change ensures that people who have a problem during registration can try again.");
224 if ($rev == '3.2.beta3') {
225 $subTypes = CRM_Contact_BAO_ContactType
::subTypes();
227 if (is_array($subTypes) && !empty($subTypes)) {
228 $config = CRM_Core_Config
::singleton();
229 $subTypeTemplates = array();
231 if (isset($config->customTemplateDir
)) {
232 foreach ($subTypes as $key => $subTypeName) {
233 $customContactSubTypeEdit = $config->customTemplateDir
. "CRM/Contact/Form/Edit/" . $subTypeName . ".tpl";
234 $customContactSubTypeView = $config->customTemplateDir
. "CRM/Contact/Page/View/" . $subTypeName . ".tpl";
235 if (file_exists($customContactSubTypeEdit) ||
file_exists($customContactSubTypeView)) {
236 $subTypeTemplates[$subTypeName] = $subTypeName;
241 foreach ($subTypes as $key => $subTypeName) {
242 $customContactSubTypeEdit = $config->templateDir
. "CRM/Contact/Form/Edit/" . $subTypeName . ".tpl";
243 $customContactSubTypeView = $config->templateDir
. "CRM/Contact/Page/View/" . $subTypeName . ".tpl";
244 if (file_exists($customContactSubTypeEdit) ||
file_exists($customContactSubTypeView)) {
245 $subTypeTemplates[$subTypeName] = $subTypeName;
249 if (!empty($subTypeTemplates)) {
250 $subTypeTemplates = implode(',', $subTypeTemplates);
251 $postUpgradeMessage .= '<br />' . ts('You are using custom template for contact subtypes: %1.', array(1 => $subTypeTemplates)) . '<br />' . ts('You need to move these subtype templates to the SubType directory in %1 and %2 respectively.', array(
252 1 => 'CRM/Contact/Form/Edit',
253 2 => 'CRM/Contact/Page/View',
258 if ($rev == '3.2.beta4') {
259 $statuses = array('New', 'Current', 'Grace', 'Expired', 'Pending', 'Cancelled', 'Deceased');
261 SELECT count( id ) as statusCount
262 FROM civicrm_membership_status
263 WHERE name IN ( '" . implode("' , '", $statuses) . "' ) ";
264 $count = CRM_Core_DAO
::singleValueQuery($sql);
265 if ($count < count($statuses)) {
266 $postUpgradeMessage .= '<br />' . ts("One or more Membership Status Rules was disabled during the upgrade because it did not match a recognized status name. if custom membership status rules were added to this site - review the disabled statuses and re-enable any that are still needed (Administer > CiviMember > Membership Status Rules).");
269 if ($rev == '3.4.alpha1') {
270 $renamedBinScripts = array(
271 'ParticipantProcessor.php',
272 'RespondentProcessor.php',
273 'UpdateGreeting.php',
274 'UpdateMembershipRecord.php',
275 'UpdatePledgeRecord.php ',
277 $postUpgradeMessage .= '<br />' . ts('The following files have been renamed to have a ".php" extension instead of a ".php.txt" extension') . ': ' . implode(', ', $renamedBinScripts);
282 * Perform an incremental upgrade.
285 * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
287 public static function upgrade_2_2_alpha1($rev) {
288 for ($stepID = 1; $stepID <= 4; $stepID++
) {
289 $formName = "CRM_Upgrade_TwoTwo_Form_Step{$stepID}";
290 $form = new $formName();
293 if (!$form->verifyPreDBState($error)) {
294 if (!isset($error)) {
295 $error = "pre-condition failed for current upgrade step $stepID, rev $rev";
297 CRM_Core_Error
::fatal($error);
304 $template = CRM_Core_Smarty
::singleton();
306 $eventFees = array();
307 $query = "SELECT og.id ogid FROM civicrm_option_group og WHERE og.name LIKE %1";
308 $params = array(1 => array('civicrm_event_page.amount%', 'String'));
309 $dao = CRM_Core_DAO
::executeQuery($query, $params);
310 while ($dao->fetch()) {
311 $eventFees[$dao->ogid
] = $dao->ogid
;
313 $template->assign('eventFees', $eventFees);
317 if (!$form->verifyPostDBState($error)) {
318 if (!isset($error)) {
319 $error = "post-condition failed for current upgrade step $stepID, rev $rev";
321 CRM_Core_Error
::fatal($error);
327 * Perform an incremental upgrade.
330 * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
332 public static function upgrade_2_1_2($rev) {
333 $formName = "CRM_Upgrade_TwoOne_Form_TwoOneTwo";
334 $form = new $formName($rev);
337 if (!$form->verifyPreDBState($error)) {
338 if (!isset($error)) {
339 $error = "pre-condition failed for current upgrade for $rev";
341 CRM_Core_Error
::fatal($error);
346 if (!$form->verifyPostDBState($error)) {
347 if (!isset($error)) {
348 $error = "post-condition failed for current upgrade for $rev";
350 CRM_Core_Error
::fatal($error);
355 * This function should check if if need to skip current sql file.
356 * Name of this function will change according to the latest release
358 public static function upgrade_2_2_alpha3($rev) {
359 // skip processing sql file, if fresh install -
360 if (!CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', 'mail_protocol', 'id', 'name')) {
361 $upgrade = new CRM_Upgrade_Form();
362 $upgrade->processSQL($rev);
368 * Perform an incremental upgrade.
371 * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
373 public static function upgrade_2_2_beta1($rev) {
374 if (!CRM_Core_DAO
::checkFieldExists('civicrm_pcp_block', 'notify_email')) {
375 $template = CRM_Core_Smarty
::singleton();
376 $template->assign('notifyAbsent', TRUE);
378 $upgrade = new CRM_Upgrade_Form();
379 $upgrade->processSQL($rev);
383 * Perform an incremental upgrade.
386 * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
388 public static function upgrade_2_2_beta2($rev) {
389 $template = CRM_Core_Smarty
::singleton();
390 if (!CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue',
391 'CRM_Contact_Form_Search_Custom_ZipCodeRange', 'id', 'name'
394 $template->assign('customSearchAbsentAll', TRUE);
396 elseif (!CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue',
397 'CRM_Contact_Form_Search_Custom_MultipleValues', 'id', 'name'
400 $template->assign('customSearchAbsent', TRUE);
402 $upgrade = new CRM_Upgrade_Form();
403 $upgrade->processSQL($rev);
407 * Perform an incremental upgrade.
410 * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
412 public static function upgrade_2_2_beta3($rev) {
413 $template = CRM_Core_Smarty
::singleton();
414 if (!CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', 'custom_data_type', 'id', 'name')) {
415 $template->assign('customDataType', TRUE);
418 $upgrade = new CRM_Upgrade_Form();
419 $upgrade->processSQL($rev);
423 * Perform an incremental upgrade.
426 * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
428 public static function upgrade_3_0_alpha1($rev) {
430 $threeZero = new CRM_Upgrade_ThreeZero_ThreeZero();
433 if (!$threeZero->verifyPreDBState($error)) {
434 if (!isset($error)) {
435 $error = 'pre-condition failed for current upgrade for 3.0.alpha2';
437 CRM_Core_Error
::fatal($error);
440 $threeZero->upgrade($rev);
444 * Perform an incremental upgrade.
447 * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
449 public static function upgrade_3_1_alpha1($rev) {
451 $threeOne = new CRM_Upgrade_ThreeOne_ThreeOne();
454 if (!$threeOne->verifyPreDBState($error)) {
455 if (!isset($error)) {
456 $error = 'pre-condition failed for current upgrade for 3.0.alpha2';
458 CRM_Core_Error
::fatal($error);
461 $threeOne->upgrade($rev);
465 * Perform an incremental upgrade.
468 * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
470 public static function upgrade_2_2_7($rev) {
471 $upgrade = new CRM_Upgrade_Form();
472 $upgrade->processSQL($rev);
473 $sql = "UPDATE civicrm_report_instance
474 SET form_values = REPLACE(form_values,'#',';') ";
475 CRM_Core_DAO
::executeQuery($sql, CRM_Core_DAO
::$_nullArray);
477 // make report component enabled by default
478 $domain = new CRM_Core_DAO_Domain();
479 $domain->selectAdd();
480 $domain->selectAdd('config_backend');
482 if ($domain->config_backend
) {
483 $defaults = unserialize($domain->config_backend
);
485 if (is_array($defaults['enableComponents'])) {
486 $compId = CRM_Core_DAO
::singleValueQuery("SELECT id FROM civicrm_component WHERE name = 'CiviReport'");
488 $defaults['enableComponents'][] = 'CiviReport';
489 $defaults['enableComponentIDs'][] = $compId;
491 CRM_Core_BAO_ConfigSetting
::add($defaults);
498 * Perform an incremental upgrade.
501 * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
503 public static function upgrade_3_0_2($rev) {
505 $template = CRM_Core_Smarty
::singleton();
506 //check whether upgraded from 2.1.x or 2.2.x
507 $inboundEmailID = CRM_Core_OptionGroup
::getValue('activity_type', 'Inbound Email', 'name');
509 if (!empty($inboundEmailID)) {
510 $template->assign('addInboundEmail', FALSE);
513 $template->assign('addInboundEmail', TRUE);
516 $upgrade = new CRM_Upgrade_Form();
517 $upgrade->processSQL($rev);
521 * Perform an incremental upgrade.
524 * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
526 public static function upgrade_3_0_4($rev) {
527 //make sure 'Deceased' membership status present in db,CRM-5636
528 $template = CRM_Core_Smarty
::singleton();
530 $addDeceasedStatus = FALSE;
531 $sql = "SELECT max(id) FROM civicrm_membership_status where name = 'Deceased'";
532 if (!CRM_Core_DAO
::singleValueQuery($sql)) {
533 $addDeceasedStatus = TRUE;
535 $template->assign('addDeceasedStatus', $addDeceasedStatus);
537 $upgrade = new CRM_Upgrade_Form();
538 $upgrade->processSQL($rev);
542 * Perform an incremental upgrade.
545 * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
547 public static function upgrade_3_1_0($rev) {
548 // upgrade all roles who have 'access CiviEvent' permission, to also have
549 // newly added permission 'edit_all_events', CRM-5472
550 $config = CRM_Core_Config
::singleton();
551 if (is_callable(array(
555 $config->userSystem
->replacePermission('access CiviEvent', array('access CiviEvent', 'edit all events'));
558 //make sure 'Deceased' membership status present in db,CRM-5636
559 $template = CRM_Core_Smarty
::singleton();
561 $addDeceasedStatus = FALSE;
562 $sql = "SELECT max(id) FROM civicrm_membership_status where name = 'Deceased'";
563 if (!CRM_Core_DAO
::singleValueQuery($sql)) {
564 $addDeceasedStatus = TRUE;
566 $template->assign('addDeceasedStatus', $addDeceasedStatus);
568 $upgrade = new CRM_Upgrade_Form();
569 $upgrade->processSQL($rev);
573 * Perform an incremental upgrade.
576 * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
578 public static function upgrade_3_1_3($rev) {
579 $threeOne = new CRM_Upgrade_ThreeOne_ThreeOne();
580 $threeOne->upgrade_3_1_3();
582 $upgrade = new CRM_Upgrade_Form();
583 $upgrade->processSQL($rev);
587 * Perform an incremental upgrade.
590 * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
592 public static function upgrade_3_1_4($rev) {
593 $threeOne = new CRM_Upgrade_ThreeOne_ThreeOne();
594 $threeOne->upgrade_3_1_4();
596 $upgrade = new CRM_Upgrade_Form();
597 $upgrade->processSQL($rev);