3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
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. |
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 along with this program; if not, contact CiviCRM LLC |
21 | at info[AT]civicrm[DOT]org. If you have questions about the |
22 | GNU Affero General Public License or the licensing of CiviCRM, |
23 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
24 +--------------------------------------------------------------------+
30 * @copyright CiviCRM LLC (c) 2004-2014
34 class CRM_Upgrade_Incremental_php_FourFour
{
35 const BATCH_SIZE
= 5000;
37 const MAX_WORD_REPLACEMENT_SIZE
= 255;
44 public function verifyPreDBstate(&$errors) {
49 * Compute any messages which should be displayed beforeupgrade
51 * Note: This function is called iteratively for each upcoming
52 * revision to the database.
54 * @param $preUpgradeMessage
56 * a version number, e.g. '4.4.alpha1', '4.4.beta3', '4.4.0'.
57 * @param null $currentVer
61 public function setPreUpgradeMessage(&$preUpgradeMessage, $rev, $currentVer = NULL) {
62 if ($rev == '4.4.beta1') {
63 $apiCalls = self
::getConfigArraysAsAPIParams(FALSE);
64 $oversizedEntries = 0;
65 foreach ($apiCalls as $params) {
66 if (!self
::isValidWordReplacement($params)) {
70 if ($oversizedEntries > 0) {
71 $preUpgradeMessage .= '<br/>' . ts("WARNING: There are %1 word-replacement entries which will not be valid in v4.4+ (eg with over 255 characters). They will be dropped during upgrade. For details, consult the CiviCRM log.", array(
72 1 => $oversizedEntries,
79 * Compute any messages which should be displayed after upgrade
81 * @param string $postUpgradeMessage
84 * an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
87 public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
88 if ($rev == '4.4.1') {
89 $config = CRM_Core_Config
::singleton();
90 if (!empty($config->useIDS
)) {
91 $postUpgradeMessage .= '<br />' . ts("The setting to skip IDS check has been removed. Your site has this configured in civicrm.settings.php but it will no longer work. Instead, use the new permission 'skip IDS check' to bypass the IDS system.");
94 if ($rev == '4.4.3') {
95 $postUpgradeMessage .= '<br /><br />' . ts('Default versions of the following System Workflow Message Templates have been modified to handle new functionality: <ul><li>Events - Registration Confirmation and Receipt (on-line)</li></ul> If you have modified these templates, please review the new default versions and implement updates as needed to your copies (Administer > Communications > Message Templates > System Workflow Messages).');
97 if ($rev == '4.4.3') {
98 $query = "SELECT cft.id financial_trxn
99 FROM civicrm_financial_trxn cft
100 LEFT JOIN civicrm_entity_financial_trxn ceft ON ceft.financial_trxn_id = cft.id
101 LEFT JOIN civicrm_contribution cc ON ceft.entity_id = cc.id
102 WHERE ceft.entity_table = 'civicrm_contribution' AND cft.payment_instrument_id IS NULL;";
103 $dao = CRM_Core_DAO
::executeQuery($query);
105 $postUpgradeMessage .= '<br /><br /><strong>' . ts('Your database contains %1 financial transaction records with no payment instrument (Paid By is empty). If you use the Accounting Batches feature this may result in unbalanced transactions. If you do not use this feature, you can ignore the condition (although you will be required to select a Paid By value for new transactions). <a href="%2" target="_blank">You can review steps to correct transactions with missing payment instruments on the wiki.</a>', array(
107 2 => 'http://wiki.civicrm.org/confluence/display/CRMDOC/Fixing+Transactions+Missing+a+Payment+Instrument+-+4.4.3+Upgrades',
111 if ($rev == '4.4.6') {
112 $postUpgradeMessage .= '<br /><br /><strong>' . ts('Your contact image urls have been upgraded. If your contact image urls did not follow the standard format for image Urls they have not been upgraded. Please check the log to see image urls that were not upgraded.');
121 public function upgrade_4_4_alpha1($rev) {
122 // task to process sql
123 $this->addTask(ts('Upgrade DB to %1: SQL', array(1 => '4.4.alpha1')), 'task_4_4_x_runSql', $rev);
125 // Consolidate activity contacts CRM-12274.
126 $this->addTask('Consolidate activity contacts', 'activityContacts');
134 public function upgrade_4_4_beta1($rev) {
135 $this->addTask(ts('Upgrade DB to %1: SQL', array(1 => '4.4.beta1')), 'task_4_4_x_runSql', $rev);
137 // add new 'data' column in civicrm_batch
138 $query = 'ALTER TABLE civicrm_batch ADD data LONGTEXT NULL COMMENT "cache entered data"';
139 CRM_Core_DAO
::executeQuery($query, array(), TRUE, NULL, FALSE, FALSE);
141 // check if batch entry data exists in civicrm_cache table
142 $query = 'SELECT path, data FROM civicrm_cache WHERE group_name = "batch entry"';
143 $dao = CRM_Core_DAO
::executeQuery($query);
144 while ($dao->fetch()) {
145 // get batch id $batchId[2]
146 $batchId = explode('-', $dao->path
);
147 $data = unserialize($dao->data
);
149 // move the data to civicrm_batch table
150 CRM_Core_DAO
::setFieldValue('CRM_Batch_DAO_Batch', $batchId[2], 'data', json_encode(array('values' => $data)));
153 // delete entries from civicrm_cache table
154 $query = 'DELETE FROM civicrm_cache WHERE group_name = "batch entry"';
155 CRM_Core_DAO
::executeQuery($query);
157 $this->addTask('Migrate custom word-replacements', 'wordReplacements');
163 public function upgrade_4_4_1($rev) {
164 $config = CRM_Core_Config
::singleton();
165 // CRM-13327 upgrade handling for the newly added name badges
166 $ogID = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', 'name_badge', 'id', 'name');
167 $nameBadges = array_flip(array_values(CRM_Core_BAO_OptionValue
::getOptionValuesAssocArrayFromName('name_badge')));
168 unset($nameBadges['Avery 5395']);
169 if (!empty($nameBadges)) {
170 $dimension = '{"paper-size":"a4","orientation":"portrait","font-name":"times","font-size":6,"font-style":"","NX":2,"NY":4,"metric":"mm","lMargin":6,"tMargin":19,"SpaceX":0,"SpaceY":0,"width":100,"height":65,"lPadding":0,"tPadding":0}';
171 $query = "UPDATE civicrm_option_value
172 SET value = '{$dimension}'
173 WHERE option_group_id = %1 AND name = 'Fattorini Name Badge 100x65'";
175 CRM_Core_DAO
::executeQuery($query, array(1 => array($ogID, 'Integer')));
179 1 => '{"paper-size":"a4","orientation":"landscape","font-name":"times","font-size":6,"font-style":"","NX":2,"NY":1,"metric":"mm","lMargin":25,"tMargin":27,"SpaceX":0,"SpaceY":35,"width":106,"height":150,"lPadding":5,"tPadding":5}',
180 2 => '{"paper-size":"a4","orientation":"portrait","font-name":"times","font-size":6,"font-style":"","NX":2,"NY":4,"metric":"mm","lMargin":6,"tMargin":19,"SpaceX":0,"SpaceY":0,"width":100,"height":65,"lPadding":0,"tPadding":0}',
181 3 => '{"paper-size":"a4","orientation":"portrait","font-name":"times","font-size":6,"font-style":"","NX":2,"NY":2,"metric":"mm","lMargin":10,"tMargin":28,"SpaceX":0,"SpaceY":0,"width":96,"height":121,"lPadding":5,"tPadding":5}',
183 $insertStatements = array(
184 1 => "($ogID, %1, '{$dimensions[1]}', %1, NULL, 0, NULL, 2, NULL, 0, 0, 1, NULL, NULL)",
185 2 => "($ogID, %2, '{$dimensions[2]}', %2, NULL, 0, NULL, 3, NULL, 0, 0, 1, NULL, NULL)",
186 3 => "($ogID, %3, '{$dimensions[3]}', %3, NULL, 0, NULL, 4, NULL, 0, 0, 1, NULL, NULL)",
189 $queryParams = array(
190 1 => array('A6 Badge Portrait 150x106', 'String'),
191 2 => array('Fattorini Name Badge 100x65', 'String'),
192 3 => array('Hanging Badge 3-3/4" x 4-3"/4', 'String'),
195 foreach ($insertStatements as $values) {
196 $query = 'INSERT INTO civicrm_option_value (`option_group_id`, `label`, `value`, `name`, `grouping`, `filter`, `is_default`, `weight`, `description`, `is_optgroup`, `is_reserved`, `is_active`, `component_id`, `visibility_id`) VALUES' . $values;
197 CRM_Core_DAO
::executeQuery($query, $queryParams);
201 // CRM-12578 - Prior to this version a CSS file under drupal would disable core css
202 if (!empty($config->customCSSURL
) && strpos($config->userFramework
, 'Drupal') === 0) {
203 // The new setting doesn't exist yet - need to create it first
204 CRM_Core_BAO_Setting
::updateSettingsFromMetaData();
205 CRM_Core_BAO_Setting
::setItem('1', CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'disable_core_css');
208 // CRM-13701 - Fix $config->timeInputFormat
211 FROM civicrm_preferences_date
212 WHERE time_format IS NOT NULL
213 AND time_format <> ''
216 $timeInputFormat = CRM_Core_DAO
::singleValueQuery($sql);
217 if ($timeInputFormat && $timeInputFormat != $config->timeInputFormat
) {
218 $params = array('timeInputFormat' => $timeInputFormat);
219 CRM_Core_BAO_ConfigSetting
::add($params);
222 // CRM-13698 - add 'Available' and 'No-show' activity statuses
223 $insertStatus = array();
224 $nsinc = $avinc = $inc = 0;
225 if (!CRM_Core_OptionGroup
::getValue('activity_status', 'Available', 'name')) {
226 $insertStatus[] = "(%1, 'Available', %2, 'Available', NULL, 0, NULL, %3, 0, 0, 1, NULL, NULL)";
229 if (!CRM_Core_OptionGroup
::getValue('activity_status', 'No_show', 'name')) {
230 $insertStatus[] = "(%1, 'No-show', %4, 'No_show', NULL, 0, NULL, %5, 0, 0, 1, NULL, NULL)";
233 if (!empty($insertStatus)) {
234 $acOptionGroupID = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', 'activity_status', 'id', 'name');
235 $maxVal = CRM_Core_DAO
::singleValueQuery("SELECT MAX(ROUND(op.value)) FROM civicrm_option_value op WHERE op.option_group_id = $acOptionGroupID");
236 $maxWeight = CRM_Core_DAO
::singleValueQuery("SELECT MAX(weight) FROM civicrm_option_value WHERE option_group_id = $acOptionGroupID");
238 $p[1] = array($acOptionGroupID, 'Integer');
240 $p[2] = array($avinc +
$maxVal, 'Integer');
241 $p[3] = array($avinc +
$maxWeight, 'Integer');
244 $p[4] = array($nsinc +
$maxVal, 'Integer');
245 $p[5] = array($nsinc +
$maxWeight, 'Integer');
247 $insertStatus = implode(',', $insertStatus);
251 civicrm_option_value (`option_group_id`, label, `value`, `name`, `grouping`, `filter`, `is_default`, `weight`, `is_optgroup`, `is_reserved`, `is_active`, `component_id`, `visibility_id`)
252 VALUES {$insertStatus}";
253 CRM_Core_DAO
::executeQuery($sql, $p);
256 $this->addTask(ts('Upgrade DB to %1: SQL', array(1 => '4.4.1')), 'task_4_4_x_runSql', $rev);
257 $this->addTask('Patch word-replacement schema', 'wordReplacements_patch', $rev);
265 public function upgrade_4_4_4($rev) {
266 $fkConstraint = array();
267 if (!CRM_Core_DAO
::checkFKConstraintInFormat('civicrm_activity_contact', 'activity_id')) {
268 $fkConstraint[] = "ADD CONSTRAINT `FK_civicrm_activity_contact_activity_id` FOREIGN KEY (`activity_id`) REFERENCES `civicrm_activity` (`id`) ON DELETE CASCADE";
270 if (!CRM_Core_DAO
::checkFKConstraintInFormat('civicrm_activity_contact', 'contact_id')) {
271 $fkConstraint[] = "ADD CONSTRAINT `FK_civicrm_activity_contact_contact_id` FOREIGN KEY (`contact_id`) REFERENCES `civicrm_contact` (`id`) ON DELETE CASCADE;
275 if (!empty($fkConstraint)) {
276 $fkConstraint = implode(',', $fkConstraint);
277 $sql = "ALTER TABLE `civicrm_activity_contact`
280 // CRM-14036 : delete entries of un-mapped contacts
281 CRM_Core_DAO
::executeQuery("DELETE ac FROM civicrm_activity_contact ac
282 LEFT JOIN civicrm_contact c
283 ON c.id = ac.contact_id
286 // delete entries of un-mapped activities
287 CRM_Core_DAO
::executeQuery("DELETE ac FROM civicrm_activity_contact ac
288 LEFT JOIN civicrm_activity a
289 ON a.id = ac.activity_id
293 CRM_Core_DAO
::executeQuery("SET FOREIGN_KEY_CHECKS=0;");
294 CRM_Core_DAO
::executeQuery($sql);
295 CRM_Core_DAO
::executeQuery("SET FOREIGN_KEY_CHECKS=1;");
298 // task to process sql
299 $this->addTask(ts('Upgrade DB to %1: SQL', array(1 => '4.4.4')), 'task_4_4_x_runSql', $rev);
301 // CRM-13892 : add `name` column to dashboard schema
303 ALTER TABLE civicrm_dashboard
304 ADD name varchar(64) COLLATE utf8_unicode_ci DEFAULT NULL COMMENT 'Internal name of dashlet.' AFTER domain_id ";
305 CRM_Core_DAO
::executeQuery($query, array(), TRUE, NULL, FALSE, FALSE);
307 $dashboard = new CRM_Core_DAO_Dashboard();
309 while ($dashboard->fetch()) {
310 $urlElements = explode('/', $dashboard->url
);
311 if ($urlElements[1] == 'dashlet') {
312 $url = explode('&', $urlElements[2]);
315 elseif ($urlElements[1] == 'report') {
316 $url = explode('&', $urlElements[3]);
317 $name = 'report/' . $url[0];
320 WHEN {$dashboard->id} THEN '{$name}'
325 UPDATE civicrm_dashboard
330 CRM_Core_DAO
::executeQuery($query, array(), TRUE, NULL, FALSE, FALSE);
332 // CRM-13998 : missing alter statements for civicrm_report_instance
333 $this->addTask(ts('Confirm civicrm_report_instance sql table for upgrades'), 'updateReportInstanceTable');
341 public function upgrade_4_4_6($rev) {
342 $sql = "SELECT count(*) AS count FROM INFORMATION_SCHEMA.STATISTICS where " .
343 "TABLE_SCHEMA = database() AND INDEX_NAME = 'index_image_url' AND TABLE_NAME = 'civicrm_contact';";
344 $dao = CRM_Core_DAO
::executeQuery($sql);
346 if ($dao->count
< 1) {
347 $sql = "CREATE INDEX index_image_url ON civicrm_contact (image_url);";
348 $dao = CRM_Core_DAO
::executeQuery($sql);
350 $minId = CRM_Core_DAO
::singleValueQuery('SELECT coalesce(min(id),0) FROM civicrm_contact WHERE image_URL IS NOT NULL');
351 $maxId = CRM_Core_DAO
::singleValueQuery('SELECT coalesce(max(id),0) FROM civicrm_contact WHERE image_URL IS NOT NULL');
352 for ($startId = $minId; $startId <= $maxId; $startId +
= self
::BATCH_SIZE
) {
353 $endId = $startId + self
::BATCH_SIZE
- 1;
354 $title = ts('Upgrade image_urls (%1 => %2)', array(1 => $startId, 2 => $endId));
355 $this->addTask($title, 'upgradeImageUrls', $startId, $endId);
361 * @param $originalVer
366 public function upgrade_4_4_7($rev, $originalVer, $latestVer) {
367 // For WordPress/Joomla(?), cleanup broken image_URL from 4.4.6 upgrades - https://issues.civicrm.org/jira/browse/CRM-14971
368 $exBackendUrl = CRM_Utils_System
::url('civicrm/contact/imagefile', 'photo=XXX', TRUE); // URL formula from 4.4.6 upgrade
369 $exFrontendUrl = CRM_Utils_System
::url('civicrm/contact/imagefile', 'photo=XXX', TRUE, NULL, TRUE, TRUE);
370 if ($originalVer == '4.4.6' && $exBackendUrl != $exFrontendUrl) {
371 $minId = CRM_Core_DAO
::singleValueQuery('SELECT coalesce(min(id),0) FROM civicrm_contact WHERE image_URL IS NOT NULL');
372 $maxId = CRM_Core_DAO
::singleValueQuery('SELECT coalesce(max(id),0) FROM civicrm_contact WHERE image_URL IS NOT NULL');
373 for ($startId = $minId; $startId <= $maxId; $startId +
= self
::BATCH_SIZE
) {
374 $endId = $startId + self
::BATCH_SIZE
- 1;
375 $title = ts('Upgrade image_urls (%1 => %2)', array(1 => $startId, 2 => $endId));
376 $this->addTask($title, 'cleanupBackendImageUrls', $startId, $endId);
379 $this->addTask(ts('Update saved search information'), 'changeSavedSearch');
382 public static function upgradeImageUrls(CRM_Queue_TaskContext
$ctx, $startId, $endId) {
383 $dao = self
::findContactImageUrls($startId, $endId);
385 while ($dao->fetch()) {
386 $imageURL = $dao->image_url
;
387 $baseurl = CIVICRM_UF_BASEURL
;
388 $baselen = strlen($baseurl);
389 if (substr($imageURL, 0, $baselen) == $baseurl) {
390 $photo = basename($dao->image_url
);
391 $config = CRM_Core_Config
::singleton();
392 $fullpath = $config->customFileUploadDir
. $photo;
393 if (file_exists($fullpath)) {
394 // For anyone who upgraded 4.4.6 release (eg 4.4.0=>4.4.6), the $newImageUrl incorrectly used backend URLs.
395 // For anyone who skipped 4.4.6 (eg 4.4.0=>4.4.7), the $newImageUrl correctly uses frontend URLs
396 self
::setContactImageUrl($dao->id
,
397 CRM_Utils_System
::url('civicrm/contact/imagefile', 'photo=' . $photo, TRUE, NULL, TRUE, TRUE));
400 $failures[$dao->id
] = $dao->image_url
;
404 $failures[$dao->id
] = $dao->image_url
;
407 CRM_Core_Error
::debug_var('imageUrlsNotUpgraded', $failures);
411 public static function changeSavedSearch(CRM_Queue_TaskContext
$ctx) {
412 $membershipStatuses = array_flip(CRM_Member_PseudoConstant
::membershipStatus());
414 $dao = new CRM_Contact_DAO_SavedSearch();
416 while ($dao->fetch()) {
417 $formValues = CRM_Contact_BAO_SavedSearch
::getFormValues($dao->id
);
418 if (!empty($formValues['mapper'])) {
419 foreach ($formValues['mapper'] as $key => $value) {
420 foreach ($value as $k => $v) {
421 if ($v[0] == 'Membership' && in_array($v[1], array('membership_status', 'membership_status_id'))) {
422 $value = $formValues['value'][$key][$k];
423 $op = $formValues['operator'][$key][$k];
425 $value = trim($value);
426 $value = str_replace('(', '', $value);
427 $value = str_replace(')', '', $value);
429 $v = explode(',', $value);
431 foreach ($v as $k1 => $v2) {
432 if (is_numeric($v2)) {
435 $value[$k1] = $membershipStatuses[$v2];
437 $formValues['value'][$key][$k] = "(" . implode(',', $value) . ")";
439 elseif (in_array($op, array('=', '!='))) {
440 if (is_numeric($value)) {
443 $formValues['value'][$key][$k] = $membershipStatuses[$value];
448 $dao->form_values
= serialize($formValues);
457 * For WordPress/Joomla(?) sites which upgraded to 4.4.6, find back-end image_URLs
458 * (e.g. "http://example.com/wp-admin/admin.php?page=CiviCRM&q=civicrm/contact/imagefile&photo=123.jpg")
459 * and convert them to front-end URLs
460 * (e.g. "http://example.com/?page=CiviCRM&q=civicrm/contact/imagefile&photo=123.jpg").
462 * @param CRM_Queue_TaskContext $ctx
463 * @param int $startId
467 public static function cleanupBackendImageUrls(CRM_Queue_TaskContext
$ctx, $startId, $endId) {
468 $dao = self
::findContactImageUrls($startId, $endId);
469 while ($dao->fetch()) {
470 $imageUrl = str_replace('&', '&', $dao->image_url
);
471 if (preg_match(":civicrm/contact/imagefile.*photo=:", $imageUrl)) {
472 // looks like one of ours
473 $imageUrlParts = parse_url($imageUrl);
474 parse_str($imageUrlParts['query'], $imageUrlQuery);
475 self
::setContactImageUrl($dao->id
,
476 CRM_Utils_System
::url('civicrm/contact/imagefile', 'photo=' . $imageUrlQuery['photo'], TRUE, NULL, TRUE, TRUE));
483 * @param int $startId
485 * @return CRM_Core_DAO
486 * columns include "id" and "image_URL"
488 public static function findContactImageUrls($startId, $endId) {
493 AND id BETWEEN %1 AND %2
494 AND image_URL IS NOT NULL
498 1 => array($startId, 'Integer'),
499 2 => array($endId, 'Integer'),
501 $dao = CRM_Core_DAO
::executeQuery($sql, $params, TRUE, NULL, FALSE, FALSE);
507 * @param string $newImageUrl
509 public static function setContactImageUrl($cid, $newImageUrl) {
510 $sql = 'UPDATE civicrm_contact SET image_url=%1 WHERE id=%2';
512 1 => array($newImageUrl, 'String'),
513 2 => array($cid, 'Integer'),
515 $updatedao = CRM_Core_DAO
::executeQuery($sql, $params);
519 * Update activity contacts CRM-12274
521 * @param CRM_Queue_TaskContext $ctx
526 public static function activityContacts(CRM_Queue_TaskContext
$ctx) {
527 $upgrade = new CRM_Upgrade_Form();
529 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
530 $ovValue[] = $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
531 $ovValue[] = $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
532 $ovValue[] = $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
534 $optionGroupID = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', 'activity_contacts', 'id', 'name');
535 if (!empty($ovValue)) {
536 $ovValues = implode(', ', $ovValue);
538 UPDATE civicrm_option_value
540 WHERE option_group_id = {$optionGroupID} AND value IN ($ovValues)";
542 $dao = CRM_Core_DAO
::executeQuery($query);
547 $value[] = "({$optionGroupID}, 'Activity Assignees', 1, 'Activity Assignees', 1, 1, 1)";
551 $value[] = "({$optionGroupID}, 'Activity Source', 2, 'Activity Source', 2, 1, 1)";
555 $value[] = "({$optionGroupID}, 'Activity Targets', 3, 'Activity Targets', 3, 1, 1)";
558 if (!$assigneeID ||
!$sourceID ||
!$targetID) {
560 INSERT INTO civicrm_option_value
561 (option_group_id, label, value, name, weight, is_reserved, is_active)
565 $values = implode(', ', $value);
566 $query = $insert . $values;
567 $dao = CRM_Core_DAO
::executeQuery($query);
570 // sometimes an user does not make a clean backup and the above table
571 // already exists, so lets delete this table - CRM-13665
572 $query = "DROP TABLE IF EXISTS civicrm_activity_contact";
573 $dao = CRM_Core_DAO
::executeQuery($query);
576 CREATE TABLE IF NOT EXISTS civicrm_activity_contact (
577 id int(10) unsigned NOT NULL AUTO_INCREMENT COMMENT 'Activity contact id',
578 activity_id int(10) unsigned NOT NULL COMMENT 'Foreign key to the activity for this record.',
579 contact_id int(10) unsigned NOT NULL COMMENT 'Foreign key to the contact for this record.',
580 record_type_id int(10) unsigned DEFAULT NULL COMMENT 'The record type id for this row',
582 UNIQUE KEY UI_activity_contact (contact_id,activity_id,record_type_id),
583 KEY FK_civicrm_activity_contact_activity_id (activity_id)
584 ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;
587 $dao = CRM_Core_DAO
::executeQuery($query);
590 INSERT INTO civicrm_activity_contact (activity_id, contact_id, record_type_id)
591 SELECT activity_id, target_contact_id, {$targetID} as record_type_id
592 FROM civicrm_activity_target";
594 $dao = CRM_Core_DAO
::executeQuery($query);
597 INSERT INTO civicrm_activity_contact (activity_id, contact_id, record_type_id)
598 SELECT activity_id, assignee_contact_id, {$assigneeID} as record_type_id
599 FROM civicrm_activity_assignment";
600 $dao = CRM_Core_DAO
::executeQuery($query);
603 INSERT INTO civicrm_activity_contact (activity_id, contact_id, record_type_id)
604 SELECT id, source_contact_id, {$sourceID} as record_type_id
605 FROM civicrm_activity
606 WHERE source_contact_id IS NOT NULL";
608 $dao = CRM_Core_DAO
::executeQuery($query);
610 $query = "DROP TABLE civicrm_activity_target";
611 $dao = CRM_Core_DAO
::executeQuery($query);
613 $query = "DROP TABLE civicrm_activity_assignment";
614 $dao = CRM_Core_DAO
::executeQuery($query);
616 $query = "ALTER TABLE civicrm_activity
617 DROP FOREIGN KEY FK_civicrm_activity_source_contact_id";
619 $dao = CRM_Core_DAO
::executeQuery($query);
621 $query = "ALTER TABLE civicrm_activity DROP COLUMN source_contact_id";
622 $dao = CRM_Core_DAO
::executeQuery($query);
628 * Migrate word-replacements from $config to civicrm_word_replacement
630 * @param CRM_Queue_TaskContext $ctx
634 * @see http://issues.civicrm.org/jira/browse/CRM-13187
636 public static function wordReplacements(CRM_Queue_TaskContext
$ctx) {
638 CREATE TABLE IF NOT EXISTS `civicrm_word_replacement` (
639 `id` int unsigned NOT NULL AUTO_INCREMENT COMMENT 'Word replacement ID',
640 `find_word` varchar(255) COLLATE utf8_bin COMMENT 'Word which need to be replaced',
641 `replace_word` varchar(255) COLLATE utf8_bin COMMENT 'Word which will replace the word in find',
642 `is_active` tinyint COMMENT 'Is this entry active?',
643 `match_type` enum('wildcardMatch', 'exactMatch') DEFAULT 'wildcardMatch',
644 `domain_id` int unsigned COMMENT 'FK to Domain ID. This is for Domain specific word replacement',
645 PRIMARY KEY ( `id` ),
646 UNIQUE INDEX `UI_domain_find` (domain_id, find_word),
647 CONSTRAINT FK_civicrm_word_replacement_domain_id FOREIGN KEY (`domain_id`) REFERENCES `civicrm_domain`(`id`)
648 ) ENGINE=InnoDB DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci ;
650 $dao = CRM_Core_DAO
::executeQuery($query);
652 self
::rebuildWordReplacementTable();
657 * Fix misconfigured constraints created in 4.4.0. To distinguish the good
658 * and bad configurations, we change the constraint name from "UI_find"
659 * (the original name in 4.4.0) to "UI_domain_find" (the new name in
662 * @param CRM_Queue_TaskContext $ctx
667 * @see http://issues.civicrm.org/jira/browse/CRM-13655
669 public static function wordReplacements_patch(CRM_Queue_TaskContext
$ctx, $rev) {
670 if (CRM_Core_DAO
::checkConstraintExists('civicrm_word_replacement', 'UI_find')) {
671 CRM_Core_DAO
::executeQuery("ALTER TABLE civicrm_word_replacement DROP FOREIGN KEY FK_civicrm_word_replacement_domain_id;");
672 CRM_Core_DAO
::executeQuery("ALTER TABLE civicrm_word_replacement DROP KEY FK_civicrm_word_replacement_domain_id;");
673 CRM_Core_DAO
::executeQuery("ALTER TABLE civicrm_word_replacement DROP KEY UI_find;");
674 CRM_Core_DAO
::executeQuery("ALTER TABLE civicrm_word_replacement MODIFY COLUMN `find_word` varchar(255) COLLATE utf8_bin DEFAULT NULL COMMENT 'Word which need to be replaced';");
675 CRM_Core_DAO
::executeQuery("ALTER TABLE civicrm_word_replacement MODIFY COLUMN `replace_word` varchar(255) COLLATE utf8_bin DEFAULT NULL COMMENT 'Word which will replace the word in find';");
676 CRM_Core_DAO
::executeQuery("ALTER TABLE civicrm_word_replacement ADD CONSTRAINT UI_domain_find UNIQUE KEY `UI_domain_find` (`domain_id`,`find_word`);");
677 CRM_Core_DAO
::executeQuery("ALTER TABLE civicrm_word_replacement ADD CONSTRAINT FK_civicrm_word_replacement_domain_id FOREIGN KEY (`domain_id`) REFERENCES `civicrm_domain` (`id`);");
683 * (Queue Task Callback)
685 public static function task_4_4_x_runSql(CRM_Queue_TaskContext
$ctx, $rev) {
686 $upgrade = new CRM_Upgrade_Form();
687 $upgrade->processSQL($rev);
693 * Syntatic sugar for adding a task which (a) is in this class and (b) has
696 * After passing the $funcName, you can also pass parameters that will go to
697 * the function. Note that all params must be serializable.
699 protected function addTask($title, $funcName) {
700 $queue = CRM_Queue_Service
::singleton()->load(array(
702 'name' => CRM_Upgrade_Form
::QUEUE_NAME
,
705 $args = func_get_args();
706 $title = array_shift($args);
707 $funcName = array_shift($args);
708 $task = new CRM_Queue_Task(
709 array(get_class($this), $funcName),
713 $queue->createItem($task, array('weight' => -1));
717 * Get all the word-replacements stored in config-arrays
718 * and convert them to params for the WordReplacement.create API.
720 * Note: This function is duplicated in CRM_Core_BAO_WordReplacement and
721 * CRM_Upgrade_Incremental_php_FourFour to ensure that the incremental upgrade
722 * step behaves consistently even as the BAO evolves in future versions.
723 * However, if there's a bug in here prior to 4.4.0, we should apply the
724 * bugfix in both places.
726 * @param bool $rebuildEach
727 * Whether to perform rebuild after each individual API call.
729 * Each item is $params for WordReplacement.create
730 * @see CRM_Core_BAO_WordReplacement::convertConfigArraysToAPIParams
732 public static function getConfigArraysAsAPIParams($rebuildEach) {
733 $wordReplacementCreateParams = array();
735 $result = civicrm_api3('domain', 'get', array(
736 'return' => array('locale_custom_strings'),
738 if (!empty($result["values"])) {
739 foreach ($result["values"] as $value) {
741 $params["domain_id"] = $value["id"];
742 $params["options"] = array('wp-rebuild' => $rebuildEach);
743 // unserialize word match string
744 $localeCustomArray = array();
745 if (!empty($value["locale_custom_strings"])) {
746 $localeCustomArray = unserialize($value["locale_custom_strings"]);
748 if (!empty($localeCustomArray)) {
749 $wordMatchArray = array();
750 // Traverse Language array
751 foreach ($localeCustomArray as $localCustomData) {
752 // Traverse status array "enabled" "disabled"
753 foreach ($localCustomData as $status => $matchTypes) {
754 $params["is_active"] = ($status == "enabled") ?
TRUE : FALSE;
755 // Traverse Match Type array "wildcardMatch" "exactMatch"
756 foreach ($matchTypes as $matchType => $words) {
757 $params["match_type"] = $matchType;
758 foreach ($words as $word => $replace) {
759 $params["find_word"] = $word;
760 $params["replace_word"] = $replace;
761 $wordReplacementCreateParams[] = $params;
769 return $wordReplacementCreateParams;
773 * Get all the word-replacements stored in config-arrays
774 * and write them out as records in civicrm_word_replacement.
776 * Note: This function is duplicated in CRM_Core_BAO_WordReplacement and
777 * CRM_Upgrade_Incremental_php_FourFour to ensure that the incremental upgrade
778 * step behaves consistently even as the BAO evolves in future versions.
779 * However, if there's a bug in here prior to 4.4.0, we should apply the
780 * bugfix in both places.
782 public static function rebuildWordReplacementTable() {
783 civicrm_api3('word_replacement', 'replace', array(
784 'options' => array('match' => array('domain_id', 'find_word')),
785 'values' => array_filter(self
::getConfigArraysAsAPIParams(FALSE), array(__CLASS__
, 'isValidWordReplacement')),
787 CRM_Core_BAO_WordReplacement
::rebuild();
792 * CRM-13998 missing alter statements for civicrm_report_instance
794 public function updateReportInstanceTable() {
796 // add civicrm_report_instance.name
798 $sql = "SELECT count(*) FROM information_schema.columns "
799 . "WHERE table_schema = database() AND table_name = 'civicrm_report_instance' AND COLUMN_NAME = 'name' ";
801 $res = CRM_Core_DAO
::singleValueQuery($sql);
804 $sql = "ALTER TABLE civicrm_report_instance ADD `name` varchar(255) COLLATE utf8_unicode_ci DEFAULT NULL COMMENT 'when combined with report_id/template uniquely identifies the instance'";
805 $res = CRM_Core_DAO
::executeQuery($sql);
808 // add civicrm_report_instance args
810 $sql = "SELECT count(*) FROM information_schema.columns WHERE table_schema = database() AND table_name = 'civicrm_report_instance' AND COLUMN_NAME = 'args' ";
812 $res = CRM_Core_DAO
::singleValueQuery($sql);
815 $sql = "ALTER TABLE civicrm_report_instance ADD `args` varchar(255) COLLATE utf8_unicode_ci DEFAULT NULL COMMENT 'arguments that are passed in the url when invoking the instance'";
817 $res = CRM_Core_DAO
::executeQuery($sql);
824 * @param array $params
826 * TRUE if $params is valid
828 public static function isValidWordReplacement($params) {
829 $result = strlen($params['find_word']) <= self
::MAX_WORD_REPLACEMENT_SIZE
&& strlen($params['replace_word']) <= self
::MAX_WORD_REPLACEMENT_SIZE
;
831 CRM_Core_Error
::debug_var('invalidWordReplacement', $params);