Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
7e9e8871 | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
fa938177 | 6 | | Copyright CiviCRM LLC (c) 2004-2016 | |
6a488035 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
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. | | |
13 | | | | |
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. | | |
18 | | | | |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
fa938177 | 31 | * @copyright CiviCRM LLC (c) 2004-2016 |
6a488035 TO |
32 | */ |
33 | class CRM_Dedupe_Merger { | |
6a488035 | 34 | |
e0ef6999 | 35 | /** |
4f1f1f2a CW |
36 | * FIXME: consider creating a common structure with cidRefs() and eidRefs() |
37 | * FIXME: the sub-pages references by the URLs should | |
38 | * be loaded dynamically on the merge form instead | |
e0ef6999 EM |
39 | * @return array |
40 | */ | |
00be9182 | 41 | public static function relTables() { |
6a488035 TO |
42 | static $relTables; |
43 | ||
12d73bba | 44 | // Setting these merely prevents enotices - but it may be more appropriate not to add the user table below |
45 | // if the url can't be retrieved. A more standardised way to retrieve them is. | |
46 | // CRM_Core_Config::singleton()->userSystem->getUserRecordUrl() - however that function takes a contact_id & | |
47 | // we may need a different function when it is not known. | |
48 | $title = $userRecordUrl = ''; | |
49 | ||
6a488035 TO |
50 | $config = CRM_Core_Config::singleton(); |
51 | if ($config->userSystem->is_drupal) { | |
52 | $userRecordUrl = CRM_Utils_System::url('user/%ufid'); | |
53 | $title = ts('%1 User: %2; user id: %3', array(1 => $config->userFramework, 2 => '$ufname', 3 => '$ufid')); | |
54 | } | |
55 | elseif ($config->userFramework == 'Joomla') { | |
b8feed6e | 56 | $userRecordUrl = $config->userSystem->getVersion() > 1.5 ? $config->userFrameworkBaseURL . "index.php?option=com_users&view=user&task=user.edit&id=" . '%ufid' : $config->userFrameworkBaseURL . "index2.php?option=com_users&view=user&task=edit&id[]=" . '%ufid'; |
6a488035 TO |
57 | $title = ts('%1 User: %2; user id: %3', array(1 => $config->userFramework, 2 => '$ufname', 3 => '$ufid')); |
58 | } | |
59 | ||
60 | if (!$relTables) { | |
61 | $relTables = array( | |
62 | 'rel_table_contributions' => array( | |
63 | 'title' => ts('Contributions'), | |
64 | 'tables' => array('civicrm_contribution', 'civicrm_contribution_recur', 'civicrm_contribution_soft'), | |
65 | 'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=contribute'), | |
66 | ), | |
67 | 'rel_table_contribution_page' => array( | |
68 | 'title' => ts('Contribution Pages'), | |
69 | 'tables' => array('civicrm_contribution_page'), | |
70 | 'url' => CRM_Utils_System::url('civicrm/admin/contribute', 'reset=1&cid=$cid'), | |
71 | ), | |
72 | 'rel_table_memberships' => array( | |
73 | 'title' => ts('Memberships'), | |
74 | 'tables' => array('civicrm_membership', 'civicrm_membership_log', 'civicrm_membership_type'), | |
75 | 'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=member'), | |
76 | ), | |
77 | 'rel_table_participants' => array( | |
78 | 'title' => ts('Participants'), | |
79 | 'tables' => array('civicrm_participant'), | |
80 | 'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=participant'), | |
81 | ), | |
82 | 'rel_table_events' => array( | |
83 | 'title' => ts('Events'), | |
84 | 'tables' => array('civicrm_event'), | |
85 | 'url' => CRM_Utils_System::url('civicrm/event/manage', 'reset=1&cid=$cid'), | |
86 | ), | |
87 | 'rel_table_activities' => array( | |
88 | 'title' => ts('Activities'), | |
91da6cd5 | 89 | 'tables' => array('civicrm_activity', 'civicrm_activity_contact'), |
6a488035 TO |
90 | 'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=activity'), |
91 | ), | |
92 | 'rel_table_relationships' => array( | |
93 | 'title' => ts('Relationships'), | |
94 | 'tables' => array('civicrm_relationship'), | |
95 | 'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=rel'), | |
96 | ), | |
97 | 'rel_table_custom_groups' => array( | |
98 | 'title' => ts('Custom Groups'), | |
99 | 'tables' => array('civicrm_custom_group'), | |
100 | 'url' => CRM_Utils_System::url('civicrm/admin/custom/group', 'reset=1'), | |
101 | ), | |
102 | 'rel_table_uf_groups' => array( | |
103 | 'title' => ts('Profiles'), | |
104 | 'tables' => array('civicrm_uf_group'), | |
105 | 'url' => CRM_Utils_System::url('civicrm/admin/uf/group', 'reset=1'), | |
106 | ), | |
107 | 'rel_table_groups' => array( | |
108 | 'title' => ts('Groups'), | |
109 | 'tables' => array('civicrm_group_contact'), | |
110 | 'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=group'), | |
111 | ), | |
112 | 'rel_table_notes' => array( | |
113 | 'title' => ts('Notes'), | |
114 | 'tables' => array('civicrm_note'), | |
115 | 'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=note'), | |
116 | ), | |
117 | 'rel_table_tags' => array( | |
118 | 'title' => ts('Tags'), | |
119 | 'tables' => array('civicrm_entity_tag'), | |
120 | 'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=tag'), | |
121 | ), | |
122 | 'rel_table_mailings' => array( | |
123 | 'title' => ts('Mailings'), | |
124 | 'tables' => array('civicrm_mailing', 'civicrm_mailing_event_queue', 'civicrm_mailing_event_subscribe'), | |
f521f375 | 125 | 'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=mailing'), |
6a488035 TO |
126 | ), |
127 | 'rel_table_cases' => array( | |
128 | 'title' => ts('Cases'), | |
129 | 'tables' => array('civicrm_case_contact'), | |
130 | 'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=case'), | |
131 | ), | |
132 | 'rel_table_grants' => array( | |
133 | 'title' => ts('Grants'), | |
134 | 'tables' => array('civicrm_grant'), | |
135 | 'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=grant'), | |
136 | ), | |
137 | 'rel_table_pcp' => array( | |
138 | 'title' => ts('PCPs'), | |
139 | 'tables' => array('civicrm_pcp'), | |
140 | 'url' => CRM_Utils_System::url('civicrm/contribute/pcp/manage', 'reset=1'), | |
141 | ), | |
142 | 'rel_table_pledges' => array( | |
143 | 'title' => ts('Pledges'), | |
144 | 'tables' => array('civicrm_pledge', 'civicrm_pledge_payment'), | |
145 | 'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=pledge'), | |
146 | ), | |
147 | 'rel_table_users' => array( | |
148 | 'title' => $title, | |
149 | 'tables' => array('civicrm_uf_match'), | |
150 | 'url' => $userRecordUrl, | |
151 | ), | |
152 | ); | |
153 | ||
76c53278 CW |
154 | $relTables += self::getMultiValueCustomSets('relTables'); |
155 | ||
6a488035 TO |
156 | // Allow hook_civicrm_merge() to adjust $relTables |
157 | CRM_Utils_Hook::merge('relTables', $relTables); | |
158 | } | |
159 | return $relTables; | |
160 | } | |
161 | ||
162 | /** | |
fe482240 | 163 | * Returns the related tables groups for which a contact has any info entered. |
ad37ac8e | 164 | * |
165 | * @param int $cid | |
166 | * | |
167 | * @return array | |
6a488035 | 168 | */ |
00be9182 | 169 | public static function getActiveRelTables($cid) { |
6a488035 TO |
170 | $cid = (int) $cid; |
171 | $groups = array(); | |
172 | ||
173 | $relTables = self::relTables(); | |
174 | $cidRefs = self::cidRefs(); | |
175 | $eidRefs = self::eidRefs(); | |
176 | foreach ($relTables as $group => $params) { | |
177 | $sqls = array(); | |
178 | foreach ($params['tables'] as $table) { | |
179 | if (isset($cidRefs[$table])) { | |
180 | foreach ($cidRefs[$table] as $field) { | |
181 | $sqls[] = "SELECT COUNT(*) AS count FROM $table WHERE $field = $cid"; | |
182 | } | |
183 | } | |
184 | if (isset($eidRefs[$table])) { | |
185 | foreach ($eidRefs[$table] as $entityTable => $entityId) { | |
186 | $sqls[] = "SELECT COUNT(*) AS count FROM $table WHERE $entityId = $cid AND $entityTable = 'civicrm_contact'"; | |
187 | } | |
188 | } | |
189 | foreach ($sqls as $sql) { | |
190 | if (CRM_Core_DAO::singleValueQuery($sql) > 0) { | |
191 | $groups[] = $group; | |
192 | } | |
193 | } | |
194 | } | |
195 | } | |
196 | return array_unique($groups); | |
197 | } | |
198 | ||
199 | /** | |
3ae0ae3d | 200 | * Get array tables and fields that reference civicrm_contact.id. |
201 | * | |
202 | * This includes core tables, custom group tables, tables added by the merge | |
203 | * hook and (somewhat randomly) the entity_tag table. | |
204 | * | |
205 | * Refer to CRM-17454 for information on the danger of querying the information | |
206 | * schema to derive this. | |
207 | * | |
208 | * @todo create an 'entity hook' to allow entities to be registered to CiviCRM | |
209 | * including all info that is normally in the DAO. | |
6a488035 | 210 | */ |
00be9182 | 211 | public static function cidRefs() { |
3ae0ae3d | 212 | $cidRefs = array(); |
213 | $coreReferences = CRM_Core_DAO::getReferencesToTable('civicrm_contact'); | |
214 | foreach ($coreReferences as $coreReference) { | |
215 | if (!is_a($coreReference, 'CRM_Core_Reference_Dynamic')) { | |
216 | $cidRefs[$coreReference->getReferenceTable()][] = $coreReference->getReferenceKey(); | |
6a488035 | 217 | } |
3ae0ae3d | 218 | } |
219 | self::addCustomTablesExtendingContactsToCidRefs($cidRefs); | |
64b3569d | 220 | |
3ae0ae3d | 221 | // FixME for time being adding below line statically as no Foreign key constraint defined for table 'civicrm_entity_tag' |
222 | $cidRefs['civicrm_entity_tag'][] = 'entity_id'; | |
6a488035 | 223 | |
3ae0ae3d | 224 | // Allow hook_civicrm_merge() to adjust $cidRefs. |
225 | // @todo consider adding a way to register entities and have them | |
226 | // automatically added to this list. | |
227 | CRM_Utils_Hook::merge('cidRefs', $cidRefs); | |
6a488035 TO |
228 | return $cidRefs; |
229 | } | |
230 | ||
231 | /** | |
232 | * Return tables and their fields referencing civicrm_contact.contact_id with entity_id | |
233 | */ | |
00be9182 | 234 | public static function eidRefs() { |
6a488035 TO |
235 | static $eidRefs; |
236 | if (!$eidRefs) { | |
237 | // FIXME: this should be generated dynamically from the schema | |
238 | // tables that reference contacts with entity_{id,table} | |
239 | $eidRefs = array( | |
240 | 'civicrm_acl' => array('entity_table' => 'entity_id'), | |
241 | 'civicrm_acl_entity_role' => array('entity_table' => 'entity_id'), | |
242 | 'civicrm_entity_file' => array('entity_table' => 'entity_id'), | |
243 | 'civicrm_log' => array('entity_table' => 'entity_id'), | |
244 | 'civicrm_mailing_group' => array('entity_table' => 'entity_id'), | |
245 | 'civicrm_note' => array('entity_table' => 'entity_id'), | |
6a488035 TO |
246 | ); |
247 | ||
248 | // Allow hook_civicrm_merge() to adjust $eidRefs | |
249 | CRM_Utils_Hook::merge('eidRefs', $eidRefs); | |
250 | } | |
251 | return $eidRefs; | |
252 | } | |
253 | ||
9da04f20 | 254 | /** |
fe482240 | 255 | * Return tables using locations. |
9da04f20 | 256 | */ |
00be9182 | 257 | public static function locTables() { |
9da04f20 AS |
258 | static $locTables; |
259 | if (!$locTables) { | |
481a74f4 | 260 | $locTables = array('civicrm_email', 'civicrm_address', 'civicrm_phone'); |
9da04f20 AS |
261 | |
262 | // Allow hook_civicrm_merge() to adjust $locTables | |
263 | CRM_Utils_Hook::merge('locTables', $locTables); | |
264 | } | |
265 | return $locTables; | |
266 | } | |
267 | ||
76c53278 CW |
268 | /** |
269 | * We treat multi-valued custom sets as "related tables" similar to activities, contributions, etc. | |
98997235 TO |
270 | * @param string $request |
271 | * 'relTables' or 'cidRefs'. | |
76c53278 CW |
272 | * @see CRM-13836 |
273 | */ | |
00be9182 | 274 | public static function getMultiValueCustomSets($request) { |
76c53278 CW |
275 | static $data = NULL; |
276 | if ($data === NULL) { | |
277 | $data = array( | |
278 | 'relTables' => array(), | |
279 | 'cidRefs' => array(), | |
280 | ); | |
281 | $result = civicrm_api3('custom_group', 'get', array( | |
282 | 'is_multiple' => 1, | |
283 | 'extends' => array('IN' => array('Individual', 'Organization', 'Household', 'Contact')), | |
284 | 'return' => array('id', 'title', 'table_name', 'style'), | |
285 | )); | |
22e263ad | 286 | foreach ($result['values'] as $custom) { |
76c53278 CW |
287 | $data['cidRefs'][$custom['table_name']] = array('entity_id'); |
288 | $urlSuffix = $custom['style'] == 'Tab' ? '&selectedChild=custom_' . $custom['id'] : ''; | |
289 | $data['relTables']['rel_table_custom_' . $custom['id']] = array( | |
290 | 'title' => $custom['title'], | |
291 | 'tables' => array($custom['table_name']), | |
292 | 'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid' . $urlSuffix), | |
293 | ); | |
294 | } | |
295 | } | |
296 | return $data[$request]; | |
297 | } | |
298 | ||
6a488035 TO |
299 | /** |
300 | * Tables which require custom processing should declare functions to call here. | |
301 | * Doing so will override normal processing. | |
302 | */ | |
00be9182 | 303 | public static function cpTables() { |
6a488035 TO |
304 | static $tables; |
305 | if (!$tables) { | |
306 | $tables = array( | |
307 | 'civicrm_case_contact' => array('CRM_Case_BAO_Case' => 'mergeContacts'), | |
308 | 'civicrm_group_contact' => array('CRM_Contact_BAO_GroupContact' => 'mergeGroupContact'), | |
309 | // Empty array == do nothing - this table is handled by mergeGroupContact | |
310 | 'civicrm_subscription_history' => array(), | |
311 | 'civicrm_relationship' => array('CRM_Contact_BAO_Relationship' => 'mergeRelationships'), | |
312 | ); | |
313 | } | |
314 | return $tables; | |
315 | } | |
316 | ||
317 | /** | |
100fef9d | 318 | * Return payment related table. |
6a488035 | 319 | */ |
00be9182 | 320 | public static function paymentTables() { |
6a488035 TO |
321 | static $tables; |
322 | if (!$tables) { | |
323 | $tables = array('civicrm_pledge', 'civicrm_membership', 'civicrm_participant'); | |
324 | } | |
6a488035 TO |
325 | return $tables; |
326 | } | |
327 | ||
328 | /** | |
100fef9d | 329 | * Return payment update Query. |
54957108 | 330 | * |
331 | * @param string $tableName | |
332 | * @param int $mainContactId | |
333 | * @param int $otherContactId | |
334 | * | |
335 | * @return array | |
6a488035 | 336 | */ |
00be9182 | 337 | public static function paymentSql($tableName, $mainContactId, $otherContactId) { |
6a488035 TO |
338 | $sqls = array(); |
339 | if (!$tableName || !$mainContactId || !$otherContactId) { | |
340 | return $sqls; | |
341 | } | |
342 | ||
343 | $paymentTables = self::paymentTables(); | |
344 | if (!in_array($tableName, $paymentTables)) { | |
345 | return $sqls; | |
346 | } | |
347 | ||
348 | switch ($tableName) { | |
349 | case 'civicrm_pledge': | |
350 | $sqls[] = " | |
351 | UPDATE IGNORE civicrm_contribution contribution | |
352 | INNER JOIN civicrm_pledge_payment payment ON ( payment.contribution_id = contribution.id ) | |
353 | INNER JOIN civicrm_pledge pledge ON ( pledge.id = payment.pledge_id ) | |
354 | SET contribution.contact_id = $mainContactId | |
355 | WHERE pledge.contact_id = $otherContactId"; | |
356 | break; | |
357 | ||
358 | case 'civicrm_membership': | |
359 | $sqls[] = " | |
360 | UPDATE IGNORE civicrm_contribution contribution | |
361 | INNER JOIN civicrm_membership_payment payment ON ( payment.contribution_id = contribution.id ) | |
362 | INNER JOIN civicrm_membership membership ON ( membership.id = payment.membership_id ) | |
363 | SET contribution.contact_id = $mainContactId | |
364 | WHERE membership.contact_id = $otherContactId"; | |
365 | break; | |
366 | ||
367 | case 'civicrm_participant': | |
368 | $sqls[] = " | |
369 | UPDATE IGNORE civicrm_contribution contribution | |
370 | INNER JOIN civicrm_participant_payment payment ON ( payment.contribution_id = contribution.id ) | |
371 | INNER JOIN civicrm_participant participant ON ( participant.id = payment.participant_id ) | |
372 | SET contribution.contact_id = $mainContactId | |
373 | WHERE participant.contact_id = $otherContactId"; | |
374 | break; | |
375 | } | |
376 | ||
377 | return $sqls; | |
378 | } | |
379 | ||
e0ef6999 | 380 | /** |
100fef9d CW |
381 | * @param int $mainId |
382 | * @param int $otherId | |
383 | * @param string $tableName | |
e0ef6999 EM |
384 | * @param array $tableOperations |
385 | * @param string $mode | |
386 | * | |
387 | * @return array | |
388 | */ | |
00be9182 | 389 | public static function operationSql($mainId, $otherId, $tableName, $tableOperations = array(), $mode = 'add') { |
6a488035 TO |
390 | $sqls = array(); |
391 | if (!$tableName || !$mainId || !$otherId) { | |
392 | return $sqls; | |
393 | } | |
394 | ||
6a488035 TO |
395 | switch ($tableName) { |
396 | case 'civicrm_membership': | |
d58a19a1 TO |
397 | if (array_key_exists($tableName, $tableOperations) && $tableOperations[$tableName]['add']) { |
398 | break; | |
399 | } | |
400 | if ($mode == 'add') { | |
401 | $sqls[] = " | |
6a488035 TO |
402 | DELETE membership1.* FROM civicrm_membership membership1 |
403 | INNER JOIN civicrm_membership membership2 ON membership1.membership_type_id = membership2.membership_type_id | |
404 | AND membership1.contact_id = {$mainId} | |
405 | AND membership2.contact_id = {$otherId} "; | |
d58a19a1 TO |
406 | } |
407 | if ($mode == 'payment') { | |
408 | $sqls[] = " | |
6a488035 TO |
409 | DELETE contribution.* FROM civicrm_contribution contribution |
410 | INNER JOIN civicrm_membership_payment payment ON payment.contribution_id = contribution.id | |
411 | INNER JOIN civicrm_membership membership1 ON membership1.id = payment.membership_id | |
412 | AND membership1.contact_id = {$mainId} | |
413 | INNER JOIN civicrm_membership membership2 ON membership1.membership_type_id = membership2.membership_type_id | |
414 | AND membership2.contact_id = {$otherId}"; | |
d58a19a1 TO |
415 | } |
416 | break; | |
6a488035 TO |
417 | |
418 | case 'civicrm_uf_match': | |
419 | // normal queries won't work for uf_match since that will lead to violation of unique constraint, | |
b44e3f84 | 420 | // failing to meet intended result. Therefore we introduce this additional query: |
6a488035 TO |
421 | $sqls[] = "DELETE FROM civicrm_uf_match WHERE contact_id = {$mainId}"; |
422 | break; | |
423 | } | |
424 | ||
425 | return $sqls; | |
426 | } | |
427 | ||
428 | /** | |
429 | * Based on the provided two contact_ids and a set of tables, move the | |
430 | * belongings of the other contact to the main one. | |
431 | * | |
54957108 | 432 | * @param int $mainId |
433 | * @param int $otherId | |
434 | * @param bool $tables | |
435 | * @param array $tableOperations | |
6a488035 | 436 | */ |
00be9182 | 437 | public static function moveContactBelongings($mainId, $otherId, $tables = FALSE, $tableOperations = array()) { |
6a488035 TO |
438 | $cidRefs = self::cidRefs(); |
439 | $eidRefs = self::eidRefs(); | |
440 | $cpTables = self::cpTables(); | |
441 | $paymentTables = self::paymentTables(); | |
c5c263ca AH |
442 | // CRM-12695: |
443 | $membershipMerge = FALSE; | |
6a488035 TO |
444 | |
445 | $affected = array_merge(array_keys($cidRefs), array_keys($eidRefs)); | |
446 | if ($tables !== FALSE) { | |
447 | // if there are specific tables, sanitize the list | |
448 | $affected = array_unique(array_intersect($affected, $tables)); | |
449 | } | |
450 | else { | |
451 | // if there aren't any specific tables, don't affect the ones handled by relTables() | |
9da04f20 | 452 | // also don't affect tables in locTables() CRM-15658 |
6a488035 | 453 | $relTables = self::relTables(); |
9da04f20 | 454 | $handled = self::locTables(); |
6a488035 TO |
455 | foreach ($relTables as $params) { |
456 | $handled = array_merge($handled, $params['tables']); | |
457 | } | |
458 | $affected = array_diff($affected, $handled); | |
ada104d5 AW |
459 | /** |
460 | * CRM-12695 | |
461 | * Set $membershipMerge flag only once | |
462 | * while doing contact related migration | |
463 | * to call addMembershipToRealtedContacts() | |
464 | * function only once. | |
465 | * Since the current function (moveContactBelongings) is called twice | |
466 | * with & without parameters $tables & $tableOperations | |
467 | */ | |
468 | // retrieve main contact's related table(s) | |
469 | $activeMainRelTables = CRM_Dedupe_Merger::getActiveRelTables($mainId); | |
470 | // check if membership table exists in main contact's related table(s) | |
c5c263ca | 471 | // set membership flag - CRM-12695 |
ada104d5 | 472 | if (in_array('rel_table_memberships', $activeMainRelTables)) { |
c5c263ca | 473 | $membershipMerge = TRUE; |
ada104d5 | 474 | } |
6a488035 TO |
475 | } |
476 | ||
477 | $mainId = (int) $mainId; | |
478 | $otherId = (int) $otherId; | |
479 | ||
480 | $sqls = array(); | |
481 | foreach ($affected as $table) { | |
482 | // Call custom processing function for objects that require it | |
483 | if (isset($cpTables[$table])) { | |
484 | foreach ($cpTables[$table] as $className => $fnName) { | |
485 | $className::$fnName($mainId, $otherId, $sqls); | |
486 | } | |
487 | // Skip normal processing | |
488 | continue; | |
489 | } | |
b3fdbf3d | 490 | |
6a488035 TO |
491 | // use UPDATE IGNORE + DELETE query pair to skip on situations when |
492 | // there's a UNIQUE restriction on ($field, some_other_field) pair | |
493 | if (isset($cidRefs[$table])) { | |
494 | foreach ($cidRefs[$table] as $field) { | |
495 | // carry related contributions CRM-5359 | |
496 | if (in_array($table, $paymentTables)) { | |
6a488035 TO |
497 | $paymentSqls = self::paymentSql($table, $mainId, $otherId); |
498 | $sqls = array_merge($sqls, $paymentSqls); | |
71560cf3 C |
499 | |
500 | if (!empty($tables) && !in_array('civicrm_contribution', $tables)) { | |
501 | $payOprSqls = self::operationSql($mainId, $otherId, $table, $tableOperations, 'payment'); | |
502 | $sqls = array_merge($sqls, $payOprSqls); | |
503 | } | |
6a488035 TO |
504 | } |
505 | ||
506 | $preOperationSqls = self::operationSql($mainId, $otherId, $table, $tableOperations); | |
507 | $sqls = array_merge($sqls, $preOperationSqls); | |
508 | ||
509 | $sqls[] = "UPDATE IGNORE $table SET $field = $mainId WHERE $field = $otherId"; | |
510 | $sqls[] = "DELETE FROM $table WHERE $field = $otherId"; | |
511 | } | |
512 | } | |
513 | if (isset($eidRefs[$table])) { | |
514 | foreach ($eidRefs[$table] as $entityTable => $entityId) { | |
515 | $sqls[] = "UPDATE IGNORE $table SET $entityId = $mainId WHERE $entityId = $otherId AND $entityTable = 'civicrm_contact'"; | |
516 | $sqls[] = "DELETE FROM $table WHERE $entityId = $otherId AND $entityTable = 'civicrm_contact'"; | |
517 | } | |
518 | } | |
519 | } | |
520 | ||
521 | // Allow hook_civicrm_merge() to add SQL statements for the merge operation. | |
522 | CRM_Utils_Hook::merge('sqls', $sqls, $mainId, $otherId, $tables); | |
523 | ||
524 | // call the SQL queries in one transaction | |
525 | $transaction = new CRM_Core_Transaction(); | |
526 | foreach ($sqls as $sql) { | |
527 | CRM_Core_DAO::executeQuery($sql, array(), TRUE, NULL, TRUE); | |
528 | } | |
ada104d5 AW |
529 | // CRM-12695 |
530 | if ($membershipMerge) { | |
531 | // call to function adding membership to related contacts | |
532 | CRM_Dedupe_Merger::addMembershipToRealtedContacts($mainId); | |
533 | } | |
6a488035 TO |
534 | $transaction->commit(); |
535 | } | |
536 | ||
537 | /** | |
4eea8606 | 538 | * Load all non-empty fields for the contacts |
b3fdbf3d | 539 | * |
98997235 TO |
540 | * @param array $main |
541 | * Contact details. | |
542 | * @param array $other | |
543 | * Contact details. | |
6a488035 | 544 | * |
77b97be7 | 545 | * @return array |
6a488035 | 546 | */ |
4eea8606 | 547 | public static function retrieveFields($main, $other) { |
6a488035 TO |
548 | $result = array( |
549 | 'contact' => array(), | |
550 | 'custom' => array(), | |
551 | ); | |
16254ae1 | 552 | foreach (self::getContactFields() as $validField) { |
eb61dc07 J |
553 | // CRM-17556 Get all non-empty fields, to make comparison easier |
554 | if (!empty($main[$validField]) || !empty($other[$validField])) { | |
6a488035 TO |
555 | $result['contact'][] = $validField; |
556 | } | |
557 | } | |
558 | ||
559 | $mainEvs = CRM_Core_BAO_CustomValueTable::getEntityValues($main['id']); | |
560 | $otherEvs = CRM_Core_BAO_CustomValueTable::getEntityValues($other['id']); | |
561 | $keys = array_unique(array_merge(array_keys($mainEvs), array_keys($otherEvs))); | |
562 | foreach ($keys as $key) { | |
76c53278 CW |
563 | // Exclude multi-value fields CRM-13836 |
564 | if (strpos($key, '_')) { | |
565 | continue; | |
566 | } | |
6a488035 TO |
567 | $key1 = CRM_Utils_Array::value($key, $mainEvs); |
568 | $key2 = CRM_Utils_Array::value($key, $otherEvs); | |
eb61dc07 | 569 | // CRM-17556 Get all non-empty fields, to make comparison easier |
08ef1f91 | 570 | if (!empty($key1) || !empty($key2)) { |
6a488035 TO |
571 | $result['custom'][] = $key; |
572 | } | |
573 | } | |
574 | return $result; | |
575 | } | |
576 | ||
577 | /** | |
100fef9d | 578 | * Batch merge a set of contacts based on rule-group and group. |
6a488035 | 579 | * |
98997235 TO |
580 | * @param int $rgid |
581 | * Rule group id. | |
582 | * @param int $gid | |
583 | * Group id. | |
584 | * @param string $mode | |
585 | * Helps decide how to behave when there are conflicts. | |
15a793bb EM |
586 | * A 'safe' value skips the merge if there are any un-resolved conflicts, wheras 'aggressive' |
587 | * mode does a force merge. | |
c301f76e | 588 | * @param bool $autoFlip to let api decide which contact to retain and which to delete. |
76ddbc8e | 589 | * Whether to let api decide which contact to retain and which to delete. |
f931b74c | 590 | * @param int $batchLimit number of merges to carry out in one batch. |
591 | * @param int $isSelected if records with is_selected column needs to be processed. | |
6a488035 | 592 | * |
e23e26ec | 593 | * @param array $criteria |
594 | * Criteria to use in the filter. | |
595 | * | |
77b97be7 | 596 | * @return array|bool |
6a488035 | 597 | */ |
e23e26ec | 598 | public static function batchMerge($rgid, $gid = NULL, $mode = 'safe', $autoFlip = TRUE, $batchLimit = 1, $isSelected = 2, $criteria = array()) { |
63ef778e | 599 | $redirectForPerformance = ($batchLimit > 1) ? TRUE : FALSE; |
2988f5c7 | 600 | $reloadCacheIfEmpty = (!$redirectForPerformance && $isSelected == 2); |
e23e26ec | 601 | $dupePairs = self::getDuplicatePairs($rgid, $gid, $reloadCacheIfEmpty, $batchLimit, $isSelected, '', ($mode == 'aggressive'), $criteria); |
6a488035 TO |
602 | |
603 | $cacheParams = array( | |
e23e26ec | 604 | 'cache_key_string' => self::getMergeCacheKeyString($rgid, $gid, $criteria), |
2988f5c7 | 605 | // @todo stop passing these parameters in & instead calculate them in the merge function based |
606 | // on the 'real' params like $isRespectExclusions $batchLimit and $isSelected. | |
607 | 'join' => self::getJoinOnDedupeTable(), | |
608 | 'where' => self::getWhereString($batchLimit, $isSelected), | |
6a488035 TO |
609 | ); |
610 | return CRM_Dedupe_Merger::merge($dupePairs, $cacheParams, $mode, $autoFlip, $redirectForPerformance); | |
611 | } | |
612 | ||
2ae26001 | 613 | /** |
614 | * Get the string to join the prevnext cache to the dedupe table. | |
615 | * | |
616 | * @return string | |
617 | * The join string to join prevnext cache on the dedupe table. | |
618 | */ | |
619 | public static function getJoinOnDedupeTable() { | |
620 | return " | |
621 | LEFT JOIN civicrm_dedupe_exception de | |
622 | ON ( | |
623 | pn.entity_id1 = de.contact_id1 | |
624 | AND pn.entity_id2 = de.contact_id2 ) | |
625 | "; | |
626 | } | |
627 | ||
2988f5c7 | 628 | /** |
629 | * Get where string for dedupe join. | |
630 | * | |
631 | * @param int $batchLimit | |
632 | * @param bool $isSelected | |
633 | * | |
634 | * @return string | |
635 | */ | |
636 | protected static function getWhereString($batchLimit, $isSelected) { | |
637 | $where = "de.id IS NULL"; | |
638 | if ($isSelected === 0 || $isSelected === 1) { | |
639 | $where .= " AND pn.is_selected = {$isSelected}"; | |
640 | } | |
641 | // else consider all dupe pairs | |
642 | // @todo Adding limit to Where??!! | |
643 | $where .= " LIMIT {$batchLimit}"; | |
644 | return $where; | |
645 | } | |
646 | ||
f931b74c | 647 | public static function updateMergeStats($cacheKeyString, $result = array()) { |
63ef778e | 648 | // gather latest stats |
649 | $merged = count($result['merged']); | |
650 | $skipped = count($result['skipped']); | |
651 | ||
652 | if ($merged <= 0 && $skipped <= 0) { | |
653 | return; | |
654 | } | |
655 | ||
656 | // get previous stats | |
657 | $previousStats = CRM_Core_BAO_PrevNextCache::retrieve("{$cacheKeyString}_stats"); | |
658 | if (!empty($previousStats)) { | |
659 | if ($previousStats[0]['merged']) { | |
660 | $merged = $merged + $previousStats[0]['merged']; | |
661 | } | |
662 | if ($previousStats[0]['skipped']) { | |
663 | $skipped = $skipped + $previousStats[0]['skipped']; | |
664 | } | |
665 | } | |
666 | ||
667 | // delete old stats | |
668 | CRM_Dedupe_Merger::resetMergeStats($cacheKeyString); | |
669 | ||
670 | // store the updated stats | |
671 | $data = array( | |
672 | 'merged' => $merged, | |
673 | 'skipped' => $skipped, | |
674 | ); | |
675 | $data = CRM_Core_DAO::escapeString(serialize($data)); | |
676 | ||
677 | $values = array(); | |
678 | $values[] = " ( 'civicrm_contact', 0, 0, '{$cacheKeyString}_stats', '$data' ) "; | |
679 | CRM_Core_BAO_PrevNextCache::setItem($values); | |
680 | } | |
681 | ||
f931b74c | 682 | public static function resetMergeStats($cacheKeyString) { |
63ef778e | 683 | return CRM_Core_BAO_PrevNextCache::deleteItem(NULL, "{$cacheKeyString}_stats"); |
684 | } | |
685 | ||
f931b74c | 686 | public static function getMergeStats($cacheKeyString) { |
63ef778e | 687 | $stats = CRM_Core_BAO_PrevNextCache::retrieve("{$cacheKeyString}_stats"); |
688 | if (!empty($stats)) { | |
689 | $stats = $stats[0]; | |
690 | } | |
691 | return $stats; | |
692 | } | |
693 | ||
f931b74c | 694 | public static function getMergeStatsMsg($cacheKeyString) { |
63ef778e | 695 | $msg = ''; |
696 | $stats = CRM_Dedupe_Merger::getMergeStats($cacheKeyString); | |
697 | if (!empty($stats['merged'])) { | |
8dcd31bf | 698 | $msg = "{$stats['merged']} " . ts('Contact(s) were merged.'); |
63ef778e | 699 | } |
700 | if (!empty($stats['skipped'])) { | |
8dcd31bf | 701 | $msg .= $stats['skipped'] . ts('Contact(s) were skipped.'); |
63ef778e | 702 | } |
703 | return $msg; | |
704 | } | |
705 | ||
6a488035 | 706 | /** |
100fef9d | 707 | * Merge given set of contacts. Performs core operation. |
6a488035 | 708 | * |
98997235 TO |
709 | * @param array $dupePairs |
710 | * Set of pair of contacts for whom merge is to be done. | |
711 | * @param array $cacheParams | |
712 | * Prev-next-cache params based on which next pair of contacts are computed. | |
6a488035 | 713 | * Generally used with batch-merge. |
98997235 TO |
714 | * @param string $mode |
715 | * Helps decide how to behave when there are conflicts. | |
6a488035 TO |
716 | * A 'safe' value skips the merge if there are any un-resolved conflicts. |
717 | * Does a force merge otherwise (aggressive mode). | |
c301f76e | 718 | * @param bool $autoFlip to let api decide which contact to retain and which to delete. |
98997235 | 719 | * Wether to let api decide which contact to retain and which to delete. |
6a488035 TO |
720 | * |
721 | * | |
77b97be7 EM |
722 | * @param bool $redirectForPerformance |
723 | * | |
724 | * @return array|bool | |
6a488035 | 725 | */ |
00be9182 | 726 | public static function merge($dupePairs = array(), $cacheParams = array(), $mode = 'safe', |
353ffa53 | 727 | $autoFlip = TRUE, $redirectForPerformance = FALSE |
6a488035 TO |
728 | ) { |
729 | $cacheKeyString = CRM_Utils_Array::value('cache_key_string', $cacheParams); | |
730 | $resultStats = array('merged' => array(), 'skipped' => array()); | |
731 | ||
732 | // we don't want dupe caching to get reset after every-merge, and therefore set the | |
733 | // doNotResetCache flag | |
734 | $config = CRM_Core_Config::singleton(); | |
735 | $config->doNotResetCache = 1; | |
78272750 | 736 | $deletedContacts = array(); |
6a488035 TO |
737 | |
738 | while (!empty($dupePairs)) { | |
78272750 | 739 | foreach ($dupePairs as $index => $dupes) { |
740 | if (in_array($dupes['dstID'], $deletedContacts) || in_array($dupes['srcID'], $deletedContacts)) { | |
741 | unset($dupePairs[$index]); | |
742 | continue; | |
743 | } | |
1cf05c3e | 744 | CRM_Utils_Hook::merge('flip', $dupes, $dupes['dstID'], $dupes['srcID']); |
6a488035 TO |
745 | $mainId = $dupes['dstID']; |
746 | $otherId = $dupes['srcID']; | |
602789b5 DS |
747 | $isAutoFlip = CRM_Utils_Array::value('auto_flip', $dupes, $autoFlip); |
748 | // if we can, make sure that $mainId is the one with lower id number | |
749 | if ($isAutoFlip && ($mainId > $otherId)) { | |
6a488035 TO |
750 | $mainId = $dupes['srcID']; |
751 | $otherId = $dupes['dstID']; | |
752 | } | |
753 | if (!$mainId || !$otherId) { | |
754 | // return error | |
755 | return FALSE; | |
756 | } | |
757 | ||
758 | // Generate var $migrationInfo. The variable structure is exactly same as | |
759 | // $formValues submitted during a UI merge for a pair of contacts. | |
721248d4 | 760 | $rowsElementsAndInfo = CRM_Dedupe_Merger::getRowsElementsAndInfo($mainId, $otherId); |
6a488035 TO |
761 | |
762 | $migrationInfo = &$rowsElementsAndInfo['migration_info']; | |
763 | ||
764 | // add additional details that we might need to resolve conflicts | |
765 | $migrationInfo['main_details'] = &$rowsElementsAndInfo['main_details']; | |
766 | $migrationInfo['other_details'] = &$rowsElementsAndInfo['other_details']; | |
6a488035 TO |
767 | $migrationInfo['rows'] = &$rowsElementsAndInfo['rows']; |
768 | ||
769 | // go ahead with merge if there is no conflict | |
63ef778e | 770 | $conflicts = array(); |
771 | if (!CRM_Dedupe_Merger::skipMerge($mainId, $otherId, $migrationInfo, $mode, $conflicts)) { | |
6a488035 | 772 | CRM_Dedupe_Merger::moveAllBelongings($mainId, $otherId, $migrationInfo); |
c940014d | 773 | $resultStats['merged'][] = array('main_id' => $mainId, 'other_id' => $otherId); |
78272750 | 774 | $deletedContacts[] = $otherId; |
6a488035 TO |
775 | } |
776 | else { | |
c940014d | 777 | $resultStats['skipped'][] = array('main_id' => $mainId, 'other_id' => $otherId); |
6a488035 TO |
778 | } |
779 | ||
0971143c | 780 | // store any conflicts |
63ef778e | 781 | if (!empty($conflicts)) { |
fd630ef9 | 782 | foreach ($conflicts as $key => $dnc) { |
783 | $conflicts[$key] = "{$migrationInfo['rows'][$key]['title']}: '{$migrationInfo['rows'][$key]['main']}' vs. '{$migrationInfo['rows'][$key]['other']}'"; | |
784 | } | |
63ef778e | 785 | CRM_Core_BAO_PrevNextCache::markConflict($mainId, $otherId, $cacheKeyString, $conflicts); |
f931b74c | 786 | } |
787 | else { | |
63ef778e | 788 | // delete entry from PrevNextCache table so we don't consider the pair next time |
789 | // pair may have been flipped, so make sure we delete using both orders | |
790 | CRM_Core_BAO_PrevNextCache::deletePair($mainId, $otherId, $cacheKeyString, TRUE); | |
791 | } | |
6a488035 TO |
792 | |
793 | CRM_Core_DAO::freeResult(); | |
794 | unset($rowsElementsAndInfo, $migrationInfo); | |
795 | } | |
796 | ||
797 | if ($cacheKeyString && !$redirectForPerformance) { | |
798 | // retrieve next pair of dupes | |
2988f5c7 | 799 | // @todo call getDuplicatePairs. |
6a488035 TO |
800 | $dupePairs = CRM_Core_BAO_PrevNextCache::retrieve($cacheKeyString, |
801 | $cacheParams['join'], | |
66eceb0b | 802 | $cacheParams['where'], |
803 | 0, | |
804 | 0, | |
805 | array(), | |
806 | '', | |
807 | FALSE | |
6a488035 TO |
808 | ); |
809 | } | |
810 | else { | |
811 | // do not proceed. Terminate the loop | |
812 | unset($dupePairs); | |
813 | } | |
814 | } | |
63ef778e | 815 | |
816 | CRM_Dedupe_Merger::updateMergeStats($cacheKeyString, $resultStats); | |
6a488035 TO |
817 | return $resultStats; |
818 | } | |
819 | ||
820 | /** | |
821 | * A function which uses various rules / algorithms for choosing which contact to bias to | |
822 | * when there's a conflict (to handle "gotchas"). Plus the safest route to merge. | |
823 | * | |
98997235 TO |
824 | * @param int $mainId |
825 | * Main contact with whom merge has to happen. | |
826 | * @param int $otherId | |
827 | * Duplicate contact which would be deleted after merge operation. | |
828 | * @param array $migrationInfo | |
829 | * Array of information about which elements to merge. | |
830 | * @param string $mode | |
831 | * Helps decide how to behave when there are conflicts. | |
13919cf8 J |
832 | * - A 'safe' value skips the merge if there are any un-resolved conflicts. |
833 | * - Does a force merge otherwise (aggressive mode). | |
6a488035 | 834 | * |
ad37ac8e | 835 | * @param array $conflicts |
836 | * | |
77b97be7 | 837 | * @return bool |
6a488035 | 838 | */ |
63ef778e | 839 | public static function skipMerge($mainId, $otherId, &$migrationInfo, $mode = 'safe', &$conflicts = array()) { |
0971143c | 840 | |
c08fae40 | 841 | $originalMigrationInfo = $migrationInfo; |
6a488035 TO |
842 | foreach ($migrationInfo as $key => $val) { |
843 | if ($val === "null") { | |
0971143c | 844 | // Rule: Never overwrite with an empty value (in any mode) |
6a488035 TO |
845 | unset($migrationInfo[$key]); |
846 | continue; | |
847 | } | |
16254ae1 | 848 | elseif ((in_array(substr($key, 5), CRM_Dedupe_Merger::getContactFields()) or |
6a488035 | 849 | substr($key, 0, 12) == 'move_custom_' |
353ffa53 TO |
850 | ) and $val != NULL |
851 | ) { | |
0971143c J |
852 | // Rule: If both main-contact, and other-contact have a field with a |
853 | // different value, then let $mode decide if to merge it or not | |
4eea8606 J |
854 | if ( |
855 | !empty($migrationInfo['rows'][$key]['main']) | |
856 | && $migrationInfo['rows'][$key]['main'] != $migrationInfo['rows'][$key]['other'] | |
857 | ) { | |
fd630ef9 | 858 | |
859 | // note it down & lets wait for response from the hook. | |
860 | // For no response $mode will decide if to skip this merge | |
861 | $conflicts[$key] = NULL; | |
6a488035 TO |
862 | } |
863 | } | |
864 | elseif (substr($key, 0, 14) == 'move_location_' and $val != NULL) { | |
865 | $locField = explode('_', $key); | |
866 | $fieldName = $locField[2]; | |
867 | $fieldCount = $locField[3]; | |
868 | ||
4ece0d26 | 869 | // Rule: Catch address conflicts (same address type on both contacts) |
6a488035 | 870 | if ($fieldName == 'address') { |
4ece0d26 J |
871 | if ( |
872 | isset($migrationInfo['main_details']['location_blocks']['address']) && | |
873 | !empty($migrationInfo['main_details']['location_blocks']['address']) | |
874 | ) { | |
d48ad2c0 | 875 | $otherAddresses = $migrationInfo['other_details']['location_blocks']['address']; |
876 | $otherAddressLookup = array(); | |
877 | foreach ($otherAddresses as $otherAddressIndex => $otherAddress) { | |
878 | $otherAddressLookup[$otherAddress['location_type_id']] = $otherAddressIndex; | |
879 | } | |
4ece0d26 J |
880 | // Look for this LocTypeId in the results |
881 | // @todo This can be streamlined using array_column() in PHP 5.5+ | |
882 | foreach ($migrationInfo['main_details']['location_blocks']['address'] as $addressKey => $addressRecord) { | |
d48ad2c0 | 883 | $otherAddressIndex = CRM_Utils_Array::value($addressRecord['location_type_id'], $otherAddressLookup); |
884 | $hasMatchingAddress = FALSE; | |
885 | foreach ($otherAddresses as $otherAddress) { | |
886 | if (self::addressIsSame($addressRecord, $otherAddress)) { | |
887 | $hasMatchingAddress = TRUE; | |
888 | } | |
889 | } | |
890 | if ($hasMatchingAddress) { | |
891 | unset($migrationInfo[$key]); | |
892 | } | |
893 | elseif (!empty($otherAddresses[$otherAddressIndex]) && !self::addressIsSame($addressRecord, $otherAddresses[$otherAddressIndex])) { | |
4ece0d26 J |
894 | $conflicts[$key] = NULL; |
895 | break; | |
6a488035 TO |
896 | } |
897 | } | |
6a488035 TO |
898 | } |
899 | } | |
4ece0d26 | 900 | // For other locations, don't merge/add if the values are the same |
6a488035 | 901 | elseif ($migrationInfo['rows'][$key]['main'] == $migrationInfo['rows'][$key]['other']) { |
6a488035 TO |
902 | unset($migrationInfo[$key]); |
903 | } | |
904 | } | |
905 | } | |
906 | ||
907 | // A hook to implement other algorithms for choosing which contact to bias to when | |
908 | // there's a conflict (to handle "gotchas"). fields_in_conflict could be modified here | |
909 | // merge happens with new values filled in here. For a particular field / row not to be merged | |
910 | // field should be unset from fields_in_conflict. | |
c08fae40 | 911 | $migrationData = array( |
912 | 'old_migration_info' => $originalMigrationInfo, | |
913 | 'mode' => $mode, | |
914 | 'fields_in_conflict' => $conflicts, | |
915 | 'merge_mode' => $mode, | |
916 | 'migration_info' => $migrationInfo, | |
917 | ); | |
6a488035 TO |
918 | CRM_Utils_Hook::merge('batch', $migrationData, $mainId, $otherId); |
919 | $conflicts = $migrationData['fields_in_conflict']; | |
63ef778e | 920 | // allow hook to override / manipulate migrationInfo as well |
c08fae40 | 921 | $migrationInfo = $migrationData['migration_info']; |
6a488035 TO |
922 | |
923 | if (!empty($conflicts)) { | |
924 | foreach ($conflicts as $key => $val) { | |
925 | if ($val === NULL and $mode == 'safe') { | |
63ef778e | 926 | // un-resolved conflicts still present. Lets skip this merge after saving the conflict / reason. |
6a488035 TO |
927 | return TRUE; |
928 | } | |
929 | else { | |
930 | // copy over the resolved values | |
931 | $migrationInfo[$key] = $val; | |
932 | } | |
933 | } | |
fd630ef9 | 934 | // if there are conflicts and mode is aggressive, allow hooks to decide if to skip merges |
935 | if (array_key_exists('skip_merge', $migrationData)) { | |
936 | return (bool) $migrationData['skip_merge']; | |
937 | } | |
6a488035 TO |
938 | } |
939 | return FALSE; | |
940 | } | |
941 | ||
d48ad2c0 | 942 | /** |
943 | * Compare 2 addresses to see if they are the same. | |
944 | * | |
945 | * @param array $mainAddress | |
946 | * @param array $comparisonAddress | |
947 | * | |
948 | * @return bool | |
949 | */ | |
950 | static protected function addressIsSame($mainAddress, $comparisonAddress) { | |
951 | $keysToIgnore = array('id', 'is_primary', 'is_billing', 'manual_geo_code', 'contact_id'); | |
952 | foreach ($comparisonAddress as $field => $value) { | |
953 | if (in_array($field, $keysToIgnore)) { | |
954 | continue; | |
955 | } | |
956 | if (!empty($value) && $mainAddress[$field] != $value) { | |
957 | return FALSE; | |
958 | } | |
959 | } | |
960 | return TRUE; | |
961 | } | |
962 | ||
34917198 J |
963 | /** |
964 | * A function to build an array of information about location blocks that is | |
965 | * required when merging location fields | |
966 | * | |
967 | * @return array | |
968 | */ | |
969 | public static function getLocationBlockInfo() { | |
970 | $locationBlocks = array( | |
971 | 'address' => array( | |
972 | 'label' => 'Address', | |
973 | 'displayField' => 'display', | |
974 | 'sortString' => 'location_type_id', | |
975 | 'hasLocation' => TRUE, | |
976 | 'hasType' => FALSE, | |
977 | ), | |
978 | 'email' => array( | |
979 | 'label' => 'Email', | |
980 | 'displayField' => 'email', | |
981 | 'sortString' => 'location_type_id', | |
982 | 'hasLocation' => TRUE, | |
983 | 'hasType' => FALSE, | |
984 | ), | |
985 | 'im' => array( | |
986 | 'label' => 'IM', | |
987 | 'displayField' => 'name', | |
988 | 'sortString' => 'location_type_id,provider_id', | |
989 | 'hasLocation' => TRUE, | |
990 | 'hasType' => 'provider_id', | |
991 | ), | |
992 | 'phone' => array( | |
993 | 'label' => 'Phone', | |
994 | 'displayField' => 'phone', | |
995 | 'sortString' => 'location_type_id,phone_type_id', | |
996 | 'hasLocation' => TRUE, | |
997 | 'hasType' => 'phone_type_id', | |
998 | ), | |
999 | 'website' => array( | |
1000 | 'label' => 'Website', | |
1001 | 'displayField' => 'url', | |
1002 | 'sortString' => 'website_type_id', | |
1003 | 'hasLocation' => FALSE, | |
1004 | 'hasType' => 'website_type_id', | |
1005 | ), | |
1006 | ); | |
1007 | return $locationBlocks; | |
1008 | } | |
1009 | ||
6a488035 TO |
1010 | /** |
1011 | * A function to build an array of information required by merge function and the merge UI. | |
1012 | * | |
98997235 TO |
1013 | * @param int $mainId |
1014 | * Main contact with whom merge has to happen. | |
1015 | * @param int $otherId | |
1016 | * Duplicate contact which would be deleted after merge operation. | |
6a488035 | 1017 | * |
77b97be7 | 1018 | * @return array|bool|int |
1e3e0eed J |
1019 | * |
1020 | * rows => An array of arrays, each is row of merge information for the table | |
1021 | * Format: move_fieldname, eg: move_contact_type | |
1022 | * main => Value associated with the main contact | |
1023 | * other => Value associated with the other contact | |
1024 | * title => The title of the field to display in the merge table | |
1025 | * | |
1026 | * elements => An array of form elements for the merge UI | |
1027 | * | |
1028 | * rel_table_elements => An array of form elements for the merge UI for | |
1029 | * entities related to the contact (eg: checkbox to move 'mailings') | |
1030 | * | |
1e3e0eed J |
1031 | * rel_tables => Stores the tables that have related entities for the contact |
1032 | * for example mailings, groups | |
1033 | * | |
1034 | * main_details => An array of core contact field values, eg: first_name, etc. | |
1035 | * location_blocks => An array of location block data for the main contact | |
1036 | * stored as the 'result' of an API call. | |
1037 | * eg: main_details['location_blocks']['address'][0]['id'] | |
1038 | * eg: main_details['location_blocks']['email'][1]['id'] | |
1039 | * | |
1040 | * other_details => As above, but for the 'other' contact | |
1041 | * | |
1042 | * migration_info => Stores the 'default' merge actions for each field which | |
1043 | * is used when programatically merging contacts. It contains instructions | |
1044 | * to move all fields from the 'other' contact to the 'main' contact, as | |
1045 | * though the form had been submitted with those options. | |
1046 | * | |
6a488035 | 1047 | */ |
00be9182 | 1048 | public static function getRowsElementsAndInfo($mainId, $otherId) { |
6a488035 TO |
1049 | $qfZeroBug = 'e8cddb72-a257-11dc-b9cc-0016d3330ee9'; |
1050 | ||
1051 | // Fetch contacts | |
1052 | foreach (array('main' => $mainId, 'other' => $otherId) as $moniker => $cid) { | |
353ffa53 TO |
1053 | $params = array( |
1054 | 'contact_id' => $cid, | |
1055 | 'version' => 3, | |
c301f76e | 1056 | 'return' => array_merge(array('display_name'), self::getContactFields()), |
353ffa53 | 1057 | ); |
6a488035 TO |
1058 | $result = civicrm_api('contact', 'get', $params); |
1059 | ||
1060 | if (empty($result['values'][$cid]['contact_type'])) { | |
1061 | return FALSE; | |
1062 | } | |
9b96584d J |
1063 | |
1064 | // CRM-18480: Cancel the process if the contact is already deleted | |
1065 | if (isset($result['values'][$cid]['contact_is_deleted']) && !empty($result['values'][$cid]['contact_is_deleted'])) { | |
78272750 | 1066 | throw new CRM_Core_Exception(ts('Cannot merge because the \'%1\' contact (ID %2) has been deleted.', array(1 => $moniker, 2 => $cid))); |
9b96584d J |
1067 | } |
1068 | ||
6a488035 TO |
1069 | $$moniker = $result['values'][$cid]; |
1070 | } | |
1071 | ||
cbed7205 | 1072 | $fields = CRM_Contact_DAO_Contact::fields(); |
6a488035 TO |
1073 | |
1074 | // FIXME: there must be a better way | |
1075 | foreach (array('main', 'other') as $moniker) { | |
1076 | $contact = &$$moniker; | |
1077 | $preferred_communication_method = CRM_Utils_array::value('preferred_communication_method', $contact); | |
1078 | $value = empty($preferred_communication_method) ? array() : $preferred_communication_method; | |
1079 | $specialValues[$moniker] = array( | |
1080 | 'preferred_communication_method' => $value, | |
0e357872 | 1081 | 'communication_style_id' => $value, |
6a488035 TO |
1082 | ); |
1083 | ||
9b873358 | 1084 | if (!empty($contact['preferred_communication_method'])) { |
d58a19a1 TO |
1085 | // api 3 returns pref_comm_method as an array, which breaks the lookup; so we reconstruct |
1086 | $prefCommList = is_array($specialValues[$moniker]['preferred_communication_method']) ? implode(CRM_Core_DAO::VALUE_SEPARATOR, $specialValues[$moniker]['preferred_communication_method']) : $specialValues[$moniker]['preferred_communication_method']; | |
6a488035 TO |
1087 | $specialValues[$moniker]['preferred_communication_method'] = CRM_Core_DAO::VALUE_SEPARATOR . $prefCommList . CRM_Core_DAO::VALUE_SEPARATOR; |
1088 | } | |
1089 | $names = array( | |
c301f76e | 1090 | 'preferred_communication_method' => array( |
1091 | 'newName' => 'preferred_communication_method_display', | |
1092 | 'groupName' => 'preferred_communication_method', | |
1093 | ), | |
6a488035 TO |
1094 | ); |
1095 | CRM_Core_OptionGroup::lookupValues($specialValues[$moniker], $names); | |
a14df814 | 1096 | |
0e357872 C |
1097 | if (!empty($contact['communication_style'])) { |
1098 | $specialValues[$moniker]['communication_style_id_display'] = $contact['communication_style']; | |
1099 | } | |
6a488035 TO |
1100 | } |
1101 | ||
1102 | static $optionValueFields = array(); | |
1103 | if (empty($optionValueFields)) { | |
1104 | $optionValueFields = CRM_Core_OptionValue::getFields(); | |
1105 | } | |
1106 | foreach ($optionValueFields as $field => $params) { | |
1107 | $fields[$field]['title'] = $params['title']; | |
1108 | } | |
1109 | ||
4eea8606 | 1110 | $compareFields = self::retrieveFields($main, $other); |
6a488035 TO |
1111 | |
1112 | $rows = $elements = $relTableElements = $migrationInfo = array(); | |
1113 | ||
4eea8606 | 1114 | foreach ($compareFields['contact'] as $field) { |
4d5f18cc | 1115 | if ($field == 'contact_sub_type') { |
1116 | // CRM-15681 don't display sub-types in UI | |
1117 | continue; | |
1118 | } | |
6a488035 TO |
1119 | foreach (array('main', 'other') as $moniker) { |
1120 | $contact = &$$moniker; | |
1121 | $value = CRM_Utils_Array::value($field, $contact); | |
1122 | if (isset($specialValues[$moniker][$field]) && is_string($specialValues[$moniker][$field])) { | |
1123 | $value = CRM_Core_DAO::VALUE_SEPARATOR . trim($specialValues[$moniker][$field], CRM_Core_DAO::VALUE_SEPARATOR) . CRM_Core_DAO::VALUE_SEPARATOR; | |
1124 | } | |
1125 | $label = isset($specialValues[$moniker]["{$field}_display"]) ? $specialValues[$moniker]["{$field}_display"] : $value; | |
a7488080 | 1126 | if (!empty($fields[$field]['type']) && $fields[$field]['type'] == CRM_Utils_Type::T_DATE) { |
6a488035 TO |
1127 | if ($value) { |
1128 | $value = str_replace('-', '', $value); | |
1129 | $label = CRM_Utils_Date::customFormat($label); | |
1130 | } | |
1131 | else { | |
1132 | $value = "null"; | |
1133 | } | |
1134 | } | |
a7488080 | 1135 | elseif (!empty($fields[$field]['type']) && $fields[$field]['type'] == CRM_Utils_Type::T_BOOLEAN) { |
6a488035 TO |
1136 | if ($label === '0') { |
1137 | $label = ts('[ ]'); | |
1138 | } | |
1139 | if ($label === '1') { | |
1140 | $label = ts('[x]'); | |
1141 | } | |
00f3da2e BS |
1142 | } |
1143 | elseif ($field == 'individual_prefix' || $field == 'prefix_id') { | |
1144 | $label = CRM_Utils_Array::value('individual_prefix', $contact); | |
6a488035 TO |
1145 | $value = CRM_Utils_Array::value('prefix_id', $contact); |
1146 | $field = 'prefix_id'; | |
00f3da2e BS |
1147 | } |
1148 | elseif ($field == 'individual_suffix' || $field == 'suffix_id') { | |
1149 | $label = CRM_Utils_Array::value('individual_suffix', $contact); | |
6a488035 TO |
1150 | $value = CRM_Utils_Array::value('suffix_id', $contact); |
1151 | $field = 'suffix_id'; | |
1152 | } | |
4f88c9cf | 1153 | elseif ($field == 'gender_id' && !empty($value)) { |
5b28be84 J |
1154 | $genderOptions = civicrm_api3('contact', 'getoptions', array('field' => 'gender_id')); |
1155 | $label = $genderOptions['values'][$value]; | |
4f88c9cf C |
1156 | } |
1157 | elseif ($field == 'current_employer_id' && !empty($value)) { | |
1158 | $label = "$value (" . CRM_Contact_BAO_Contact::displayName($value) . ")"; | |
1159 | } | |
6a488035 TO |
1160 | $rows["move_$field"][$moniker] = $label; |
1161 | if ($moniker == 'other') { | |
7154d2a4 BS |
1162 | //CRM-14334 |
1163 | if ($value === NULL || $value == '') { | |
6a488035 TO |
1164 | $value = 'null'; |
1165 | } | |
1166 | if ($value === 0 or $value === '0') { | |
1167 | $value = $qfZeroBug; | |
1168 | } | |
8cc574cf | 1169 | if (is_array($value) && empty($value[1])) { |
6a488035 TO |
1170 | $value[1] = NULL; |
1171 | } | |
13919cf8 J |
1172 | |
1173 | // Display a checkbox to migrate, only if the values are different | |
1174 | if ($value != $main[$field]) { | |
1175 | $elements[] = array('advcheckbox', "move_$field", NULL, NULL, NULL, $value); | |
1176 | } | |
1177 | ||
6a488035 TO |
1178 | $migrationInfo["move_$field"] = $value; |
1179 | } | |
1180 | } | |
1181 | $rows["move_$field"]['title'] = $fields[$field]['title']; | |
1182 | } | |
1183 | ||
eb61dc07 J |
1184 | // Handle location blocks. |
1185 | // @todo OpenID not in API yet, so is not supported here. | |
65a35632 | 1186 | |
087f00ec | 1187 | // Set up useful information about the location blocks |
34917198 | 1188 | $locationBlocks = self::getLocationBlockInfo(); |
087f00ec J |
1189 | |
1190 | $locations = array( | |
1191 | 'main' => array(), | |
1192 | 'other' => array(), | |
13919cf8 | 1193 | ); |
b814df56 | 1194 | |
087f00ec J |
1195 | // @todo This could probably be defined and used earlier |
1196 | $mergeTargets = array( | |
1197 | 'main' => $mainId, | |
1198 | 'other' => $otherId, | |
1199 | ); | |
6a488035 | 1200 | |
087f00ec | 1201 | foreach ($locationBlocks as $blockName => $blockInfo) { |
6a488035 | 1202 | |
087f00ec J |
1203 | // Collect existing fields from both 'main' and 'other' contacts first |
1204 | // This allows us to match up location/types when building the table rows | |
1205 | foreach ($mergeTargets as $moniker => $cid) { | |
6a488035 | 1206 | $cnt = 1; |
b932e89e J |
1207 | $searchParams = array( |
1208 | 'version' => 3, | |
1209 | 'contact_id' => $cid, | |
087f00ec J |
1210 | // CRM-17556 Order by field-specific criteria |
1211 | 'options' => array( | |
1212 | 'sort' => $blockInfo['sortString'], | |
1213 | ), | |
b932e89e | 1214 | ); |
b932e89e | 1215 | $values = civicrm_api($blockName, 'get', $searchParams); |
087f00ec J |
1216 | if ($values['count']) { |
1217 | $cnt = 0; | |
1218 | foreach ($values['values'] as $index => $value) { | |
1219 | $locations[$moniker][$blockName][$cnt] = $value; | |
1220 | // Fix address display | |
34917198 | 1221 | $display = ''; |
eb61dc07 | 1222 | if ($blockName == 'address') { |
087f00ec J |
1223 | CRM_Core_BAO_Address::fixAddress($value); |
1224 | $display = CRM_Utils_Address::format($value); | |
eb61dc07 | 1225 | $locations[$moniker][$blockName][$cnt]['display'] = $display; |
6a488035 | 1226 | } |
abb422f9 | 1227 | |
087f00ec | 1228 | $cnt++; |
6a488035 TO |
1229 | } |
1230 | } | |
1231 | } | |
6a488035 | 1232 | |
087f00ec J |
1233 | // Now, build the table rows appropriately, based off the information on |
1234 | // the 'other' contact | |
34917198 J |
1235 | if (!empty($locations['other']) && !empty($locations['other'][$blockName])) { |
1236 | foreach ($locations['other'][$blockName] as $count => $value) { | |
6a488035 | 1237 | |
087f00ec | 1238 | $displayValue = $value[$blockInfo['displayField']]; |
65a35632 | 1239 | |
087f00ec J |
1240 | // Add this value to the table rows |
1241 | $rows["move_location_{$blockName}_{$count}"]['other'] = $displayValue; | |
65a35632 | 1242 | |
087f00ec J |
1243 | // CRM-17556 Only display 'main' contact value if it's the same location + type |
1244 | // Look it up from main values... | |
65a35632 | 1245 | |
087f00ec J |
1246 | $lookupLocation = FALSE; |
1247 | if ($blockInfo['hasLocation']) { | |
1248 | $lookupLocation = $value['location_type_id']; | |
1249 | } | |
65a35632 | 1250 | |
087f00ec J |
1251 | $lookupType = FALSE; |
1252 | if ($blockInfo['hasType']) { | |
1253 | $lookupType = $value[$blockInfo['hasType']]; | |
1254 | } | |
65a35632 | 1255 | |
34917198 J |
1256 | // Hold ID of main contact's matching block |
1257 | $mainContactBlockId = 0; | |
1258 | ||
087f00ec J |
1259 | if (!empty($locations['main'][$blockName])) { |
1260 | foreach ($locations['main'][$blockName] as $mainValueCheck) { | |
1261 | // No location/type, or matching location and type | |
1262 | if ( | |
1263 | (empty($lookupLocation) || $lookupLocation == $mainValueCheck['location_type_id']) | |
1264 | && (empty($lookupType) || $lookupType == $mainValueCheck[$blockInfo['hasType']]) | |
1265 | ) { | |
34917198 | 1266 | // Set this value as the default against the 'other' contact value |
087f00ec | 1267 | $rows["move_location_{$blockName}_{$count}"]['main'] = $mainValueCheck[$blockInfo['displayField']]; |
34917198 | 1268 | $mainContactBlockId = $mainValueCheck['id']; |
087f00ec J |
1269 | break; |
1270 | } | |
6a488035 | 1271 | } |
087f00ec | 1272 | } |
65a35632 | 1273 | |
087f00ec J |
1274 | // Add checkbox to migrate data from 'other' to 'main' |
1275 | $elements[] = array('advcheckbox', "move_location_{$blockName}_{$count}"); | |
65a35632 | 1276 | |
087f00ec J |
1277 | // Flag up this field to skipMerge function (@todo: do we need to?) |
1278 | $migrationInfo["move_location_{$blockName}_{$count}"] = 1; | |
65a35632 | 1279 | |
34917198 | 1280 | // Add a hidden field to store the ID of the target main contact block |
972947a7 | 1281 | $elements[] = array('hidden', "location_blocks[$blockName][$count][mainContactBlockId]", $mainContactBlockId); |
34917198 | 1282 | |
087f00ec J |
1283 | // Setup variables |
1284 | $thisTypeId = FALSE; | |
1285 | $thisLocId = FALSE; | |
65a35632 | 1286 | |
087f00ec J |
1287 | // Provide a select drop-down for the location's location type |
1288 | // eg: Home, Work... | |
65a35632 | 1289 | |
087f00ec | 1290 | $js = NULL; |
65a35632 | 1291 | |
087f00ec J |
1292 | if ($blockInfo['hasLocation']) { |
1293 | ||
5b28be84 J |
1294 | // Load the location options for this entity |
1295 | $locationOptions = civicrm_api3($blockName, 'getoptions', array('field' => 'location_type_id')); | |
1296 | ||
087f00ec J |
1297 | // JS lookup 'main' contact's location (if there are any) |
1298 | if (!empty($locations['main'][$blockName])) { | |
1299 | $js = array('onChange' => "mergeBlock('$blockName', this, $count, 'locTypeId' );"); | |
6a488035 | 1300 | } |
087f00ec J |
1301 | |
1302 | $thisLocId = $value['location_type_id']; | |
1303 | ||
1304 | // Put this field's location type at the top of the list | |
5b28be84 | 1305 | $tmpIdList = $locationOptions['values']; |
087f00ec J |
1306 | $defaultLocId = array($thisLocId => $tmpIdList[$thisLocId]); |
1307 | unset($tmpIdList[$thisLocId]); | |
1308 | ||
1309 | // Add the element | |
eb61dc07 J |
1310 | $elements[] = array( |
1311 | 'select', | |
972947a7 | 1312 | "location_blocks[$blockName][$count][locTypeId]", |
eb61dc07 | 1313 | NULL, |
087f00ec | 1314 | $defaultLocId + $tmpIdList, |
eb61dc07 | 1315 | $js, |
6a488035 | 1316 | ); |
087f00ec J |
1317 | |
1318 | // Add the relevant information to the $migrationInfo | |
1319 | // Keep location-type-id same as that of other-contact | |
1320 | // @todo Check this logic out | |
1321 | $migrationInfo['location_blocks'][$blockName][$count]['locTypeId'] = $thisLocId; | |
abb422f9 | 1322 | if ($blockName != 'address') { |
972947a7 | 1323 | $elements[] = array('advcheckbox', "location_blocks[{$blockName}][$count][operation]", NULL, ts('add new')); |
087f00ec | 1324 | // always use add operation |
abb422f9 | 1325 | $migrationInfo['location_blocks'][$blockName][$count]['operation'] = 1; |
6a488035 | 1326 | } |
087f00ec | 1327 | |
6a488035 | 1328 | } |
6a488035 | 1329 | |
087f00ec J |
1330 | // Provide a select drop-down for the location's type/provider |
1331 | // eg websites: Google+, Facebook... | |
1332 | ||
6a488035 | 1333 | $js = NULL; |
087f00ec J |
1334 | |
1335 | if ($blockInfo['hasType']) { | |
1336 | ||
5b28be84 J |
1337 | // Load the type options for this entity |
1338 | $typeOptions = civicrm_api3($blockName, 'getoptions', array('field' => $blockInfo['hasType'])); | |
1339 | ||
1340 | // CRM-17556 Set up JS lookup of 'main' contact's value by type | |
087f00ec | 1341 | if (!empty($locations['main'][$blockName])) { |
abb422f9 | 1342 | $js = array('onChange' => "mergeBlock('$blockName', this, $count, 'typeTypeId' );"); |
087f00ec J |
1343 | } |
1344 | ||
1345 | $thisTypeId = $value[$blockInfo['hasType']]; | |
1346 | ||
1347 | // Put this field's location type at the top of the list | |
5b28be84 | 1348 | $tmpIdList = $typeOptions['values']; |
087f00ec J |
1349 | $defaultTypeId = array($thisTypeId => $tmpIdList[$thisTypeId]); |
1350 | unset($tmpIdList[$thisTypeId]); | |
1351 | ||
1352 | // Add the element | |
65a35632 J |
1353 | $elements[] = array( |
1354 | 'select', | |
972947a7 | 1355 | "location_blocks[$blockName][$count][typeTypeId]", |
65a35632 | 1356 | NULL, |
087f00ec | 1357 | $defaultTypeId + $tmpIdList, |
65a35632 J |
1358 | $js, |
1359 | ); | |
65a35632 | 1360 | |
1e3e0eed | 1361 | // Add the information to the migrationInfo |
34917198 | 1362 | $migrationInfo['location_blocks'][$blockName][$count]['typeTypeId'] = $thisTypeId; |
65a35632 | 1363 | |
6a488035 | 1364 | } |
087f00ec J |
1365 | |
1366 | // Set the label for this row | |
34917198 J |
1367 | $rowTitle = $blockInfo['label'] . ' ' . ($count + 1); |
1368 | if (!empty($thisLocId)) { | |
5b28be84 | 1369 | $rowTitle .= ' (' . $locationOptions['values'][$thisLocId] . ')'; |
6a488035 | 1370 | } |
34917198 | 1371 | if (!empty($thisTypeId)) { |
5b28be84 | 1372 | $rowTitle .= ' (' . $typeOptions['values'][$thisTypeId] . ')'; |
34917198 J |
1373 | } |
1374 | $rows["move_location_{$blockName}_$count"]['title'] = $rowTitle; | |
65a35632 | 1375 | |
34917198 | 1376 | } // End loop through 'other' locations of this type |
087f00ec | 1377 | |
34917198 | 1378 | } // End if 'other' location for this type exists |
6a488035 | 1379 | |
34917198 | 1380 | } // End loop through each location block entity |
6a488035 TO |
1381 | |
1382 | // add the related tables and unset the ones that don't sport any of the duplicate contact's info | |
1383 | $config = CRM_Core_Config::singleton(); | |
1384 | $mainUfId = CRM_Core_BAO_UFMatch::getUFId($mainId); | |
1385 | $mainUser = NULL; | |
1386 | if ($mainUfId) { | |
1387 | // d6 compatible | |
1388 | if ($config->userSystem->is_drupal == '1' && function_exists($mainUser)) { | |
1389 | $mainUser = user_load($mainUfId); | |
1390 | } | |
1391 | elseif ($config->userFramework == 'Joomla') { | |
1392 | $mainUser = JFactory::getUser($mainUfId); | |
1393 | } | |
1394 | } | |
1395 | $otherUfId = CRM_Core_BAO_UFMatch::getUFId($otherId); | |
1396 | $otherUser = NULL; | |
1397 | if ($otherUfId) { | |
1398 | // d6 compatible | |
1399 | if ($config->userSystem->is_drupal == '1' && function_exists($mainUser)) { | |
1400 | $otherUser = user_load($otherUfId); | |
1401 | } | |
1402 | elseif ($config->userFramework == 'Joomla') { | |
1403 | $otherUser = JFactory::getUser($otherUfId); | |
1404 | } | |
1405 | } | |
1406 | ||
1407 | $relTables = CRM_Dedupe_Merger::relTables(); | |
1408 | $activeRelTables = CRM_Dedupe_Merger::getActiveRelTables($otherId); | |
1409 | $activeMainRelTables = CRM_Dedupe_Merger::getActiveRelTables($mainId); | |
1410 | foreach ($relTables as $name => $null) { | |
1411 | if (!in_array($name, $activeRelTables) && | |
1412 | !(($name == 'rel_table_users') && in_array($name, $activeMainRelTables)) | |
1413 | ) { | |
1414 | unset($relTables[$name]); | |
1415 | continue; | |
1416 | } | |
1417 | ||
1418 | $relTableElements[] = array('checkbox', "move_$name"); | |
1419 | $migrationInfo["move_$name"] = 1; | |
1420 | ||
1421 | $relTables[$name]['main_url'] = str_replace('$cid', $mainId, $relTables[$name]['url']); | |
1422 | $relTables[$name]['other_url'] = str_replace('$cid', $otherId, $relTables[$name]['url']); | |
1423 | if ($name == 'rel_table_users') { | |
1424 | $relTables[$name]['main_url'] = str_replace('%ufid', $mainUfId, $relTables[$name]['url']); | |
1425 | $relTables[$name]['other_url'] = str_replace('%ufid', $otherUfId, $relTables[$name]['url']); | |
1426 | $find = array('$ufid', '$ufname'); | |
1427 | if ($mainUser) { | |
1428 | $replace = array($mainUfId, $mainUser->name); | |
1429 | $relTables[$name]['main_title'] = str_replace($find, $replace, $relTables[$name]['title']); | |
1430 | } | |
1431 | if ($otherUser) { | |
1432 | $replace = array($otherUfId, $otherUser->name); | |
1433 | $relTables[$name]['other_title'] = str_replace($find, $replace, $relTables[$name]['title']); | |
1434 | } | |
1435 | } | |
1436 | if ($name == 'rel_table_memberships') { | |
1437 | $elements[] = array('checkbox', "operation[move_{$name}][add]", NULL, ts('add new')); | |
1438 | $migrationInfo["operation"]["move_{$name}"]['add'] = 1; | |
1439 | } | |
1440 | } | |
1441 | foreach ($relTables as $name => $null) { | |
1442 | $relTables["move_$name"] = $relTables[$name]; | |
1443 | unset($relTables[$name]); | |
1444 | } | |
1445 | ||
1446 | // handle custom fields | |
1447 | $mainTree = CRM_Core_BAO_CustomGroup::getTree($main['contact_type'], CRM_Core_DAO::$_nullObject, $mainId, -1, | |
1448 | CRM_Utils_Array::value('contact_sub_type', $main) | |
1449 | ); | |
1450 | $otherTree = CRM_Core_BAO_CustomGroup::getTree($main['contact_type'], CRM_Core_DAO::$_nullObject, $otherId, -1, | |
1451 | CRM_Utils_Array::value('contact_sub_type', $other) | |
1452 | ); | |
1453 | CRM_Core_DAO::freeResult(); | |
1454 | ||
1455 | foreach ($otherTree as $gid => $group) { | |
1456 | $foundField = FALSE; | |
1457 | if (!isset($group['fields'])) { | |
1458 | continue; | |
1459 | } | |
1460 | ||
1461 | foreach ($group['fields'] as $fid => $field) { | |
4eea8606 | 1462 | if (in_array($fid, $compareFields['custom'])) { |
6a488035 TO |
1463 | if (!$foundField) { |
1464 | $rows["custom_group_$gid"]['title'] = $group['title']; | |
1465 | $foundField = TRUE; | |
1466 | } | |
a7488080 | 1467 | if (!empty($mainTree[$gid]['fields'][$fid]['customValue'])) { |
6a488035 | 1468 | foreach ($mainTree[$gid]['fields'][$fid]['customValue'] as $valueId => $values) { |
51a3717f | 1469 | $rows["move_custom_$fid"]['main'] = CRM_Core_BAO_CustomField::displayValue($values['data'], $fid); |
6a488035 TO |
1470 | } |
1471 | } | |
1472 | $value = "null"; | |
a7488080 | 1473 | if (!empty($otherTree[$gid]['fields'][$fid]['customValue'])) { |
6a488035 | 1474 | foreach ($otherTree[$gid]['fields'][$fid]['customValue'] as $valueId => $values) { |
51a3717f | 1475 | $rows["move_custom_$fid"]['other'] = CRM_Core_BAO_CustomField::displayValue($values['data'], $fid); |
6a488035 TO |
1476 | if ($values['data'] === 0 || $values['data'] === '0') { |
1477 | $values['data'] = $qfZeroBug; | |
d58a19a1 | 1478 | } |
6a488035 | 1479 | $value = ($values['data']) ? $values['data'] : $value; |
d58a19a1 | 1480 | } |
6a488035 TO |
1481 | } |
1482 | $rows["move_custom_$fid"]['title'] = $field['label']; | |
1483 | ||
1484 | $elements[] = array('advcheckbox', "move_custom_$fid", NULL, NULL, NULL, $value); | |
1485 | $migrationInfo["move_custom_$fid"] = $value; | |
1486 | } | |
1487 | } | |
1488 | } | |
abb422f9 | 1489 | |
6a488035 TO |
1490 | $result = array( |
1491 | 'rows' => $rows, | |
1492 | 'elements' => $elements, | |
1493 | 'rel_table_elements' => $relTableElements, | |
6a488035 TO |
1494 | 'rel_tables' => $relTables, |
1495 | 'main_details' => $main, | |
1496 | 'other_details' => $other, | |
1497 | 'migration_info' => $migrationInfo, | |
1498 | ); | |
1499 | ||
34917198 J |
1500 | $result['main_details']['location_blocks'] = $locations['main']; |
1501 | $result['other_details']['location_blocks'] = $locations['other']; | |
6a488035 TO |
1502 | |
1503 | return $result; | |
1504 | } | |
1505 | ||
1506 | /** | |
1507 | * Based on the provided two contact_ids and a set of tables, move the belongings of the | |
1508 | * other contact to the main one - be it Location / CustomFields or Contact .. related info. | |
1509 | * A superset of moveContactBelongings() function. | |
1510 | * | |
98997235 TO |
1511 | * @param int $mainId |
1512 | * Main contact with whom merge has to happen. | |
1513 | * @param int $otherId | |
1514 | * Duplicate contact which would be deleted after merge operation. | |
77b97be7 EM |
1515 | * |
1516 | * @param $migrationInfo | |
6a488035 | 1517 | * |
77b97be7 | 1518 | * @return bool |
6a488035 | 1519 | */ |
00be9182 | 1520 | public static function moveAllBelongings($mainId, $otherId, $migrationInfo) { |
6a488035 TO |
1521 | if (empty($migrationInfo)) { |
1522 | return FALSE; | |
1523 | } | |
1524 | ||
1525 | $qfZeroBug = 'e8cddb72-a257-11dc-b9cc-0016d3330ee9'; | |
1526 | $relTables = CRM_Dedupe_Merger::relTables(); | |
1527 | $moveTables = $locBlocks = $tableOperations = array(); | |
1528 | foreach ($migrationInfo as $key => $value) { | |
1529 | if ($value == $qfZeroBug) { | |
1530 | $value = '0'; | |
1531 | } | |
7154d2a4 | 1532 | if ((in_array(substr($key, 5), CRM_Dedupe_Merger::getContactFields()) || |
353ffa53 | 1533 | substr($key, 0, 12) == 'move_custom_') && |
7154d2a4 BS |
1534 | $value != NULL |
1535 | ) { | |
6a488035 TO |
1536 | $submitted[substr($key, 5)] = $value; |
1537 | } | |
34917198 J |
1538 | |
1539 | // Set up initial information for handling migration of location blocks | |
6a488035 TO |
1540 | elseif (substr($key, 0, 14) == 'move_location_' and $value != NULL) { |
1541 | $locField = explode('_', $key); | |
1542 | $fieldName = $locField[2]; | |
1543 | $fieldCount = $locField[3]; | |
34917198 J |
1544 | |
1545 | // Set up the operation type (add/overwrite) | |
6832d4a9 | 1546 | // Ignore operation for websites |
34917198 | 1547 | // @todo Tidy this up |
6832d4a9 J |
1548 | $operation = 0; |
1549 | if ($fieldName != 'website') { | |
972947a7 | 1550 | $operation = CRM_Utils_Array::value('operation', $migrationInfo['location_blocks'][$fieldName][$fieldCount]); |
6832d4a9 | 1551 | } |
6a488035 TO |
1552 | // default operation is overwrite. |
1553 | if (!$operation) { | |
1554 | $operation = 2; | |
1555 | } | |
6a488035 | 1556 | $locBlocks[$fieldName][$fieldCount]['operation'] = $operation; |
0971143c | 1557 | |
6a488035 | 1558 | } |
34917198 | 1559 | |
6a488035 TO |
1560 | elseif (substr($key, 0, 15) == 'move_rel_table_' and $value == '1') { |
1561 | $moveTables = array_merge($moveTables, $relTables[substr($key, 5)]['tables']); | |
1562 | if (array_key_exists('operation', $migrationInfo)) { | |
1563 | foreach ($relTables[substr($key, 5)]['tables'] as $table) { | |
1564 | if (array_key_exists($key, $migrationInfo['operation'])) { | |
1565 | $tableOperations[$table] = $migrationInfo['operation'][$key]; | |
1566 | } | |
1567 | } | |
1568 | } | |
1569 | } | |
1570 | } | |
1571 | ||
eb61dc07 | 1572 | // **** Do location related migration. |
eb61dc07 | 1573 | // @todo Handle OpenID (not currently in API). |
6a488035 | 1574 | if (!empty($locBlocks)) { |
13919cf8 | 1575 | |
34917198 | 1576 | $locationBlocks = self::getLocationBlockInfo(); |
6a488035 TO |
1577 | |
1578 | $primaryBlockIds = CRM_Contact_BAO_Contact::getLocBlockIds($mainId, array('is_primary' => 1)); | |
1579 | $billingBlockIds = CRM_Contact_BAO_Contact::getLocBlockIds($mainId, array('is_billing' => 1)); | |
1580 | ||
1581 | foreach ($locBlocks as $name => $block) { | |
1582 | if (!is_array($block) || CRM_Utils_System::isNull($block)) { | |
1583 | continue; | |
1584 | } | |
34917198 | 1585 | $daoName = 'CRM_Core_DAO_' . $locationBlocks[$name]['label']; |
6a488035 TO |
1586 | $primaryDAOId = (array_key_exists($name, $primaryBlockIds)) ? array_pop($primaryBlockIds[$name]) : NULL; |
1587 | $billingDAOId = (array_key_exists($name, $billingBlockIds)) ? array_pop($billingBlockIds[$name]) : NULL; | |
1588 | ||
1589 | foreach ($block as $blkCount => $values) { | |
6a488035 | 1590 | |
34917198 J |
1591 | // For the block which belongs to other-contact, link the location block to main-contact |
1592 | $otherBlockDAO = new $daoName(); | |
1593 | $otherBlockDAO->contact_id = $mainId; | |
6a488035 | 1594 | |
34917198 J |
1595 | // Get the ID of this block on the 'other' contact, otherwise skip |
1596 | $otherBlockId = CRM_Utils_Array::value('id', $migrationInfo['other_details']['location_blocks'][$name][$blkCount]); | |
6a488035 TO |
1597 | if (!$otherBlockId) { |
1598 | continue; | |
1599 | } | |
6a488035 | 1600 | $otherBlockDAO->id = $otherBlockId; |
6a488035 | 1601 | |
34917198 J |
1602 | // Add/update location and type information from the form, if applicable |
1603 | if ($locationBlocks[$name]['hasLocation']) { | |
972947a7 | 1604 | $locTypeId = CRM_Utils_Array::value('locTypeId', $migrationInfo['location_blocks'][$name][$blkCount]); |
34917198 | 1605 | $otherBlockDAO->location_type_id = $locTypeId; |
08ef1f91 | 1606 | } |
34917198 | 1607 | if ($locationBlocks[$name]['hasType']) { |
972947a7 | 1608 | $typeTypeId = CRM_Utils_Array::value('typeTypeId', $migrationInfo['location_blocks'][$name][$blkCount]); |
34917198 | 1609 | $otherBlockDAO->{$locationBlocks[$name]['hasType']} = $typeTypeId; |
08ef1f91 R |
1610 | } |
1611 | ||
34917198 | 1612 | // Get main block ID |
972947a7 | 1613 | $mainBlockId = CRM_Utils_Array::value('mainContactBlockId', $migrationInfo['location_blocks'][$name][$blkCount], 0); |
6a488035 TO |
1614 | |
1615 | // if main contact already has primary & billing, set the flags to 0. | |
1616 | if ($primaryDAOId) { | |
1617 | $otherBlockDAO->is_primary = 0; | |
1618 | } | |
1619 | if ($billingDAOId) { | |
1620 | $otherBlockDAO->is_billing = 0; | |
1621 | } | |
1622 | ||
34917198 | 1623 | $operation = CRM_Utils_Array::value('operation', $values, 2); |
6a488035 | 1624 | // overwrite - need to delete block which belongs to main-contact. |
34917198 | 1625 | if (!empty($mainBlockId) && ($operation == 2)) { |
6a488035 TO |
1626 | $deleteDAO = new $daoName(); |
1627 | $deleteDAO->id = $mainBlockId; | |
1628 | $deleteDAO->find(TRUE); | |
1629 | ||
1630 | // if we about to delete a primary / billing block, set the flags for new block | |
1631 | // that we going to assign to main-contact | |
1632 | if ($primaryDAOId && ($primaryDAOId == $deleteDAO->id)) { | |
1633 | $otherBlockDAO->is_primary = 1; | |
1634 | } | |
1635 | if ($billingDAOId && ($billingDAOId == $deleteDAO->id)) { | |
1636 | $otherBlockDAO->is_billing = 1; | |
1637 | } | |
1638 | ||
1639 | $deleteDAO->delete(); | |
1640 | $deleteDAO->free(); | |
1641 | } | |
1642 | ||
1643 | $otherBlockDAO->update(); | |
1644 | $otherBlockDAO->free(); | |
1645 | } | |
1646 | } | |
1647 | } | |
1648 | ||
1649 | // **** Do tables related migrations | |
1650 | if (!empty($moveTables)) { | |
1651 | CRM_Dedupe_Merger::moveContactBelongings($mainId, $otherId, $moveTables, $tableOperations); | |
1652 | unset($moveTables, $tableOperations); | |
1653 | } | |
1654 | ||
1655 | // **** Do contact related migrations | |
1656 | CRM_Dedupe_Merger::moveContactBelongings($mainId, $otherId); | |
1657 | ||
1658 | // FIXME: fix gender, prefix and postfix, so they're edible by createProfileContact() | |
1659 | $names['gender'] = array('newName' => 'gender_id', 'groupName' => 'gender'); | |
1660 | $names['individual_prefix'] = array('newName' => 'prefix_id', 'groupName' => 'individual_prefix'); | |
1661 | $names['individual_suffix'] = array('newName' => 'suffix_id', 'groupName' => 'individual_suffix'); | |
aa62b355 | 1662 | $names['communication_style'] = array('newName' => 'communication_style_id', 'groupName' => 'communication_style'); |
6a488035 TO |
1663 | $names['addressee'] = array('newName' => 'addressee_id', 'groupName' => 'addressee'); |
1664 | $names['email_greeting'] = array('newName' => 'email_greeting_id', 'groupName' => 'email_greeting'); | |
1665 | $names['postal_greeting'] = array('newName' => 'postal_greeting_id', 'groupName' => 'postal_greeting'); | |
1666 | CRM_Core_OptionGroup::lookupValues($submitted, $names, TRUE); | |
1667 | ||
1668 | // fix custom fields so they're edible by createProfileContact() | |
1669 | static $treeCache = array(); | |
1670 | if (!array_key_exists($migrationInfo['main_details']['contact_type'], $treeCache)) { | |
1671 | $treeCache[$migrationInfo['main_details']['contact_type']] = CRM_Core_BAO_CustomGroup::getTree($migrationInfo['main_details']['contact_type'], | |
1672 | CRM_Core_DAO::$_nullObject, NULL, -1 | |
1673 | ); | |
1674 | } | |
1675 | $cgTree = &$treeCache[$migrationInfo['main_details']['contact_type']]; | |
1676 | ||
1677 | $cFields = array(); | |
1678 | foreach ($cgTree as $key => $group) { | |
1679 | if (!isset($group['fields'])) { | |
1680 | continue; | |
1681 | } | |
1682 | foreach ($group['fields'] as $fid => $field) { | |
1683 | $cFields[$fid]['attributes'] = $field; | |
1684 | } | |
1685 | } | |
1686 | ||
1687 | if (!isset($submitted)) { | |
1688 | $submitted = array(); | |
1689 | } | |
1690 | foreach ($submitted as $key => $value) { | |
1691 | if (substr($key, 0, 7) == 'custom_') { | |
1692 | $fid = (int) substr($key, 7); | |
0e357872 C |
1693 | if (empty($cFields[$fid])) { |
1694 | continue; | |
1695 | } | |
6a488035 TO |
1696 | $htmlType = $cFields[$fid]['attributes']['html_type']; |
1697 | switch ($htmlType) { | |
1698 | case 'File': | |
1699 | $customFiles[] = $fid; | |
1700 | unset($submitted["custom_$fid"]); | |
1701 | break; | |
1702 | ||
1703 | case 'Select Country': | |
1704 | case 'Select State/Province': | |
8cee0c70 | 1705 | $submitted[$key] = CRM_Core_BAO_CustomField::displayValue($value, $fid); |
6a488035 TO |
1706 | break; |
1707 | ||
1708 | case 'CheckBox': | |
1709 | case 'AdvMulti-Select': | |
1710 | case 'Multi-Select': | |
1711 | case 'Multi-Select Country': | |
1712 | case 'Multi-Select State/Province': | |
1713 | // Merge values from both contacts for multivalue fields, CRM-4385 | |
1714 | // get the existing custom values from db. | |
1715 | $customParams = array('entityID' => $mainId, $key => TRUE); | |
1716 | $customfieldValues = CRM_Core_BAO_CustomValueTable::getValues($customParams); | |
a7488080 | 1717 | if (!empty($customfieldValues[$key])) { |
6a488035 TO |
1718 | $existingValue = explode(CRM_Core_DAO::VALUE_SEPARATOR, $customfieldValues[$key]); |
1719 | if (is_array($existingValue) && !empty($existingValue)) { | |
1720 | $mergeValue = $submmtedCustomValue = array(); | |
1721 | if ($value) { | |
1722 | $submmtedCustomValue = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value); | |
1723 | } | |
1724 | ||
1725 | //hack to remove null and duplicate values from array. | |
1726 | foreach (array_merge($submmtedCustomValue, $existingValue) as $k => $v) { | |
1727 | if ($v != '' && !in_array($v, $mergeValue)) { | |
1728 | $mergeValue[] = $v; | |
1729 | } | |
1730 | } | |
1731 | ||
1732 | //keep state and country as array format. | |
1733 | //for checkbox and m-select format w/ VALUE_SEPARATOR | |
1734 | if (in_array($htmlType, array( | |
353ffa53 TO |
1735 | 'CheckBox', |
1736 | 'Multi-Select', | |
c301f76e | 1737 | 'AdvMulti-Select', |
353ffa53 | 1738 | ))) { |
6a488035 | 1739 | $submitted[$key] = CRM_Core_DAO::VALUE_SEPARATOR . implode(CRM_Core_DAO::VALUE_SEPARATOR, |
353ffa53 TO |
1740 | $mergeValue |
1741 | ) . CRM_Core_DAO::VALUE_SEPARATOR; | |
6a488035 TO |
1742 | } |
1743 | else { | |
1744 | $submitted[$key] = $mergeValue; | |
1745 | } | |
1746 | } | |
1747 | } | |
1748 | elseif (in_array($htmlType, array( | |
353ffa53 | 1749 | 'Multi-Select Country', |
c301f76e | 1750 | 'Multi-Select State/Province', |
353ffa53 | 1751 | ))) { |
6a488035 TO |
1752 | //we require submitted values should be in array format |
1753 | if ($value) { | |
1754 | $mergeValueArray = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value); | |
1755 | //hack to remove null values from array. | |
1756 | $mergeValue = array(); | |
1757 | foreach ($mergeValueArray as $k => $v) { | |
1758 | if ($v != '') { | |
1759 | $mergeValue[] = $v; | |
1760 | } | |
1761 | } | |
1762 | $submitted[$key] = $mergeValue; | |
1763 | } | |
1764 | } | |
1765 | break; | |
1766 | ||
1767 | default: | |
1768 | break; | |
1769 | } | |
1770 | } | |
1771 | } | |
1772 | ||
1773 | // **** Do file custom fields related migrations | |
1774 | // FIXME: move this someplace else (one of the BAOs) after discussing | |
b3fdbf3d | 1775 | // where to, and whether CRM_Core_BAO_File::deleteFileReferences() shouldn't actually, |
6a488035 TO |
1776 | // like, delete a file... |
1777 | ||
1778 | if (!isset($customFiles)) { | |
1779 | $customFiles = array(); | |
1780 | } | |
1781 | foreach ($customFiles as $customId) { | |
1782 | list($tableName, $columnName, $groupID) = CRM_Core_BAO_CustomField::getTableColumnGroup($customId); | |
1783 | ||
1784 | // get the contact_id -> file_id mapping | |
1785 | $fileIds = array(); | |
1786 | $sql = "SELECT entity_id, {$columnName} AS file_id FROM {$tableName} WHERE entity_id IN ({$mainId}, {$otherId})"; | |
9d2678f4 | 1787 | $dao = CRM_Core_DAO::executeQuery($sql); |
6a488035 TO |
1788 | while ($dao->fetch()) { |
1789 | $fileIds[$dao->entity_id] = $dao->file_id; | |
1790 | } | |
1791 | $dao->free(); | |
1792 | ||
1793 | // delete the main contact's file | |
1794 | if (!empty($fileIds[$mainId])) { | |
b3fdbf3d | 1795 | CRM_Core_BAO_File::deleteFileReferences($fileIds[$mainId], $mainId, $customId); |
6a488035 TO |
1796 | } |
1797 | ||
1798 | // move the other contact's file to main contact | |
1799 | //NYSS need to INSERT or UPDATE depending on whether main contact has an existing record | |
481a74f4 | 1800 | if (CRM_Core_DAO::singleValueQuery("SELECT id FROM {$tableName} WHERE entity_id = {$mainId}")) { |
d58a19a1 | 1801 | $sql = "UPDATE {$tableName} SET {$columnName} = {$fileIds[$otherId]} WHERE entity_id = {$mainId}"; |
6a488035 TO |
1802 | } |
1803 | else { | |
1804 | $sql = "INSERT INTO {$tableName} ( entity_id, {$columnName} ) VALUES ( {$mainId}, {$fileIds[$otherId]} )"; | |
1805 | } | |
9d2678f4 | 1806 | CRM_Core_DAO::executeQuery($sql); |
6a488035 | 1807 | |
481a74f4 | 1808 | if (CRM_Core_DAO::singleValueQuery(" |
6a488035 TO |
1809 | SELECT id |
1810 | FROM civicrm_entity_file | |
353ffa53 TO |
1811 | WHERE entity_table = '{$tableName}' AND file_id = {$fileIds[$otherId]}") |
1812 | ) { | |
6a488035 TO |
1813 | $sql = " |
1814 | UPDATE civicrm_entity_file | |
1815 | SET entity_id = {$mainId} | |
1816 | WHERE entity_table = '{$tableName}' AND file_id = {$fileIds[$otherId]}"; | |
1817 | } | |
1818 | else { | |
1819 | $sql = " | |
1820 | INSERT INTO civicrm_entity_file ( entity_table, entity_id, file_id ) | |
1821 | VALUES ( '{$tableName}', {$mainId}, {$fileIds[$otherId]} )"; | |
1822 | } | |
9d2678f4 | 1823 | CRM_Core_DAO::executeQuery($sql); |
6a488035 TO |
1824 | } |
1825 | ||
1826 | // move view only custom fields CRM-5362 | |
1827 | $viewOnlyCustomFields = array(); | |
1828 | foreach ($submitted as $key => $value) { | |
1829 | $fid = (int) substr($key, 7); | |
8cc574cf | 1830 | if (array_key_exists($fid, $cFields) && !empty($cFields[$fid]['attributes']['is_view'])) { |
6a488035 TO |
1831 | $viewOnlyCustomFields[$key] = $value; |
1832 | } | |
1833 | } | |
1834 | ||
1835 | // special case to set values for view only, CRM-5362 | |
1836 | if (!empty($viewOnlyCustomFields)) { | |
1837 | $viewOnlyCustomFields['entityID'] = $mainId; | |
1838 | CRM_Core_BAO_CustomValueTable::setValues($viewOnlyCustomFields); | |
1839 | } | |
1840 | ||
6a488035 TO |
1841 | if (CRM_Core_Permission::check('merge duplicate contacts') && |
1842 | CRM_Core_Permission::check('delete contacts') | |
1843 | ) { | |
1844 | // if ext id is submitted then set it null for contact to be deleted | |
a7488080 | 1845 | if (!empty($submitted['external_identifier'])) { |
6a488035 TO |
1846 | $query = "UPDATE civicrm_contact SET external_identifier = null WHERE id = {$otherId}"; |
1847 | CRM_Core_DAO::executeQuery($query); | |
1848 | } | |
1849 | ||
5ea06a7b | 1850 | civicrm_api3('contact', 'delete', array('id' => $otherId)); |
6a488035 TO |
1851 | CRM_Core_BAO_PrevNextCache::deleteItem($otherId); |
1852 | } | |
1853 | // FIXME: else part | |
5ea06a7b | 1854 | // else { |
1855 | // CRM_Core_Session::setStatus( ts('Do not have sufficient permission to delete duplicate contact.') ); | |
1856 | // } | |
6a488035 | 1857 | |
4d5f18cc | 1858 | // CRM-15681 merge sub_types |
1859 | if ($other_sub_types = CRM_Utils_array::value('contact_sub_type', $migrationInfo['other_details'])) { | |
1860 | if ($main_sub_types = CRM_Utils_array::value('contact_sub_type', $migrationInfo['main_details'])) { | |
481a74f4 | 1861 | $submitted['contact_sub_type'] = array_unique(array_merge($main_sub_types, $other_sub_types)); |
0db6c3e1 TO |
1862 | } |
1863 | else { | |
4d5f18cc | 1864 | $submitted['contact_sub_type'] = $other_sub_types; |
1865 | } | |
1866 | } | |
1867 | ||
6a488035 TO |
1868 | // **** Update contact related info for the main contact |
1869 | if (!empty($submitted)) { | |
1870 | $submitted['contact_id'] = $mainId; | |
1871 | ||
1872 | //update current employer field | |
1873 | if ($currentEmloyerId = CRM_Utils_Array::value('current_employer_id', $submitted)) { | |
1874 | if (!CRM_Utils_System::isNull($currentEmloyerId)) { | |
1875 | $submitted['current_employer'] = $submitted['current_employer_id']; | |
0db6c3e1 TO |
1876 | } |
1877 | else { | |
6a488035 TO |
1878 | $submitted['current_employer'] = ''; |
1879 | } | |
1880 | unset($submitted['current_employer_id']); | |
1881 | } | |
1882 | ||
00f3da2e | 1883 | //CRM-14312 include prefix/suffix from mainId if not overridden for proper construction of display/sort name |
481a74f4 | 1884 | if (!isset($submitted['prefix_id']) && !empty($migrationInfo['main_details']['prefix_id'])) { |
00f3da2e BS |
1885 | $submitted['prefix_id'] = $migrationInfo['main_details']['prefix_id']; |
1886 | } | |
481a74f4 | 1887 | if (!isset($submitted['suffix_id']) && !empty($migrationInfo['main_details']['suffix_id'])) { |
00f3da2e BS |
1888 | $submitted['suffix_id'] = $migrationInfo['main_details']['suffix_id']; |
1889 | } | |
1890 | ||
6a488035 | 1891 | CRM_Contact_BAO_Contact::createProfileContact($submitted, CRM_Core_DAO::$_nullArray, $mainId); |
6a488035 TO |
1892 | } |
1893 | ||
61bc2c0f | 1894 | CRM_Utils_Hook::post('merge', 'Contact', $mainId, CRM_Core_DAO::$_nullObject); |
f00283b5 | 1895 | self::createMergeActivities($mainId, $otherId); |
5ea06a7b | 1896 | |
6a488035 TO |
1897 | return TRUE; |
1898 | } | |
16254ae1 ARW |
1899 | |
1900 | /** | |
f00283b5 | 1901 | * Get fields in the contact table suitable for merging. |
1902 | * | |
a6c01b45 | 1903 | * @return array |
f00283b5 | 1904 | * Array of field names to be potentially merged. |
16254ae1 | 1905 | */ |
00be9182 | 1906 | public static function getContactFields() { |
16254ae1 | 1907 | $contactFields = CRM_Contact_DAO_Contact::fields(); |
353ffa53 TO |
1908 | $invalidFields = array( |
1909 | 'api_key', | |
353ffa53 TO |
1910 | 'created_date', |
1911 | 'display_name', | |
1912 | 'hash', | |
1913 | 'id', | |
1914 | 'modified_date', | |
1915 | 'primary_contact_id', | |
1916 | 'sort_name', | |
c301f76e | 1917 | 'user_unique_id', |
353ffa53 | 1918 | ); |
bdd7870e RN |
1919 | foreach ($contactFields as $field => $value) { |
1920 | if (in_array($field, $invalidFields)) { | |
1921 | unset($contactFields[$field]); | |
1922 | } | |
1923 | } | |
16254ae1 ARW |
1924 | return array_keys($contactFields); |
1925 | } | |
ada104d5 AW |
1926 | |
1927 | /** | |
1928 | * Added for CRM-12695 | |
c301f76e | 1929 | * Based on the contactID provided |
ada104d5 AW |
1930 | * add/update membership(s) to related contacts |
1931 | * | |
c301f76e | 1932 | * @param int $contactID |
ada104d5 | 1933 | */ |
00be9182 | 1934 | public static function addMembershipToRealtedContacts($contactID) { |
ada104d5 AW |
1935 | $dao = new CRM_Member_DAO_Membership(); |
1936 | $dao->contact_id = $contactID; | |
1937 | $dao->is_test = 0; | |
1938 | $dao->find(); | |
1939 | ||
1940 | //checks membership of contact itself | |
1941 | while ($dao->fetch()) { | |
1942 | $relationshipTypeId = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $dao->membership_type_id, 'relationship_type_id', 'id'); | |
1943 | if ($relationshipTypeId) { | |
1944 | $membershipParams = array( | |
1945 | 'id' => $dao->id, | |
1946 | 'contact_id' => $dao->contact_id, | |
1947 | 'membership_type_id' => $dao->membership_type_id, | |
1948 | 'join_date' => CRM_Utils_Date::isoToMysql($dao->join_date), | |
1949 | 'start_date' => CRM_Utils_Date::isoToMysql($dao->start_date), | |
1950 | 'end_date' => CRM_Utils_Date::isoToMysql($dao->end_date), | |
1951 | 'source' => $dao->source, | |
21dfd5f5 | 1952 | 'status_id' => $dao->status_id, |
ada104d5 AW |
1953 | ); |
1954 | // create/update membership(s) for related contact(s) | |
1955 | CRM_Member_BAO_Membership::createRelatedMemberships($membershipParams, $dao); | |
1956 | } // end of if relationshipTypeId | |
1957 | } | |
1958 | } | |
96025800 | 1959 | |
3ae0ae3d | 1960 | /** |
1961 | * Add custom tables that extend contacts to the list of contact references. | |
1962 | * | |
1963 | * CRM_Core_BAO_CustomGroup::getAllCustomGroupsByBaseEntity seems like a safe-ish | |
1964 | * function to be sure all are retrieved & we don't miss subtypes or inactive or multiples | |
1965 | * - the down side is it is not cached. | |
1966 | * | |
1967 | * Further changes should be include tests in the CRM_Core_MergerTest class | |
1968 | * to ensure that disabled, subtype, multiple etc groups are still captured. | |
1969 | * | |
1970 | * @param array $cidRefs | |
1971 | */ | |
1972 | public static function addCustomTablesExtendingContactsToCidRefs(&$cidRefs) { | |
1973 | $customValueTables = CRM_Core_BAO_CustomGroup::getAllCustomGroupsByBaseEntity('Contact'); | |
1974 | $customValueTables->find(); | |
1975 | while ($customValueTables->fetch()) { | |
1976 | $cidRefs[$customValueTables->table_name] = array('entity_id'); | |
1977 | } | |
1978 | } | |
1979 | ||
f00283b5 | 1980 | /** |
1981 | * Create activities tracking the merge on affected contacts. | |
1982 | * | |
1983 | * @param int $mainId | |
1984 | * @param int $otherId | |
1985 | * | |
1986 | * @throws \CiviCRM_API3_Exception | |
1987 | */ | |
1988 | public static function createMergeActivities($mainId, $otherId) { | |
1989 | $params = array( | |
1990 | 1 => $otherId, | |
1991 | 2 => $mainId, | |
1992 | ); | |
1993 | $activity = civicrm_api3('activity', 'create', array( | |
dc33398e J |
1994 | 'source_contact_id' => CRM_Core_Session::getLoggedInContactID() ? CRM_Core_Session::getLoggedInContactID() : |
1995 | $mainId, | |
f00283b5 | 1996 | 'subject' => ts('Contact ID %1 has been merged and deleted.', $params), |
1997 | 'target_contact_id' => $mainId, | |
1998 | 'activity_type_id' => 'Contact Merged', | |
1999 | 'status_id' => 'Completed', | |
2000 | )); | |
4d834a99 | 2001 | if (civicrm_api3('Setting', 'getvalue', array('name' => 'contact_undelete', 'group' => 'CiviCRM Preferences'))) { |
2002 | civicrm_api3('activity', 'create', array( | |
dc33398e J |
2003 | 'source_contact_id' => CRM_Core_Session::getLoggedInContactID() ? CRM_Core_Session::getLoggedInContactID() : |
2004 | $otherId, | |
4d834a99 | 2005 | 'subject' => ts('Contact ID %1 has been merged into Contact ID %2 and deleted.', $params), |
2006 | 'target_contact_id' => $otherId, | |
2007 | 'activity_type_id' => 'Contact Deleted by Merge', | |
2008 | 'parent_id' => $activity['id'], | |
2009 | 'status_id' => 'Completed', | |
2010 | )); | |
2011 | } | |
f00283b5 | 2012 | } |
2013 | ||
2988f5c7 | 2014 | /** |
2015 | * Get Duplicate Pairs based on a rule for a group. | |
2016 | * | |
2017 | * @param int $rule_group_id | |
2018 | * @param int $group_id | |
2019 | * @param bool $reloadCacheIfEmpty | |
2020 | * @param int $batchLimit | |
2021 | * @param bool $isSelected | |
66eceb0b | 2022 | * @param array $orderByClause |
2023 | * @param bool $includeConflicts | |
e23e26ec | 2024 | * @param array $criteria |
2025 | * Additional criteria to narrow down the merge group. | |
2988f5c7 | 2026 | * |
2027 | * @return array | |
2028 | * Array of matches meeting the criteria. | |
2029 | */ | |
e23e26ec | 2030 | public static function getDuplicatePairs($rule_group_id, $group_id, $reloadCacheIfEmpty, $batchLimit, $isSelected, $orderByClause = '', $includeConflicts = TRUE, $criteria = array()) { |
2988f5c7 | 2031 | $where = self::getWhereString($batchLimit, $isSelected); |
e23e26ec | 2032 | $cacheKeyString = self::getMergeCacheKeyString($rule_group_id, $group_id, $criteria); |
2988f5c7 | 2033 | $join = self::getJoinOnDedupeTable(); |
66eceb0b | 2034 | $dupePairs = CRM_Core_BAO_PrevNextCache::retrieve($cacheKeyString, $join, $where, 0, 0, array(), $orderByClause, $includeConflicts); |
2988f5c7 | 2035 | if (empty($dupePairs) && $reloadCacheIfEmpty) { |
2036 | // If we haven't found any dupes, probably cache is empty. | |
66eceb0b | 2037 | // Try filling cache and give another try. We don't need to specify include conflicts here are there will not be any |
2038 | // until we have done some processing. | |
e23e26ec | 2039 | CRM_Core_BAO_PrevNextCache::refillCache($rule_group_id, $group_id, $cacheKeyString, $criteria); |
66eceb0b | 2040 | $dupePairs = CRM_Core_BAO_PrevNextCache::retrieve($cacheKeyString, $join, $where, 0, 0, array(), $orderByClause, $includeConflicts); |
2988f5c7 | 2041 | return $dupePairs; |
2042 | } | |
2043 | return $dupePairs; | |
2044 | } | |
2045 | ||
2ae26001 | 2046 | /** |
2047 | * Get the cache key string for the merge action. | |
2048 | * | |
2049 | * @param int $rule_group_id | |
2050 | * @param int $group_id | |
e23e26ec | 2051 | * @param array $criteria |
2052 | * Additional criteria to narrow down the merge group. | |
2053 | * Currently we are only supporting the key 'contact' within it. | |
2ae26001 | 2054 | * |
2055 | * @return string | |
2056 | */ | |
e23e26ec | 2057 | public static function getMergeCacheKeyString($rule_group_id, $group_id, $criteria = array()) { |
2ae26001 | 2058 | $contactType = CRM_Dedupe_BAO_RuleGroup::getContactTypeForRuleGroup($rule_group_id); |
2059 | $cacheKeyString = "merge {$contactType}"; | |
2060 | $cacheKeyString .= $rule_group_id ? "_{$rule_group_id}" : '_0'; | |
2061 | $cacheKeyString .= $group_id ? "_{$group_id}" : '_0'; | |
e23e26ec | 2062 | $cacheKeyString .= !empty($criteria) ? serialize($criteria) : '_0'; |
2ae26001 | 2063 | return $cacheKeyString; |
2064 | } | |
2065 | ||
6a488035 | 2066 | } |