Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
7e9e8871 | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
e7112fa7 | 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
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 | |
e7112fa7 | 31 | * @copyright CiviCRM LLC (c) 2004-2015 |
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'), | |
125 | 'url' => CRM_Utils_System::url('civicrm/mailing', 'reset=1&force=1&cid=$cid'), | |
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. | |
6a488035 TO |
586 | * A 'safe' value skips the merge if there are any un-resolved conflicts. |
587 | * Does a force merge otherwise. | |
c301f76e | 588 | * @param bool $autoFlip to let api decide which contact to retain and which to delete. |
98997235 | 589 | * Wether 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 | * |
77b97be7 | 593 | * @return array|bool |
6a488035 | 594 | */ |
63ef778e | 595 | public static function batchMerge($rgid, $gid = NULL, $mode = 'safe', $autoFlip = TRUE, $batchLimit = 1, $isSelected = 2) { |
6a488035 TO |
596 | $contactType = CRM_Core_DAO::getFieldValue('CRM_Dedupe_DAO_RuleGroup', $rgid, 'contact_type'); |
597 | $cacheKeyString = "merge {$contactType}"; | |
598 | $cacheKeyString .= $rgid ? "_{$rgid}" : '_0'; | |
599 | $cacheKeyString .= $gid ? "_{$gid}" : '_0'; | |
600 | $join = "LEFT JOIN civicrm_dedupe_exception de ON ( pn.entity_id1 = de.contact_id1 AND | |
601 | pn.entity_id2 = de.contact_id2 )"; | |
602 | ||
63ef778e | 603 | $where = "de.id IS NULL"; |
604 | if ($isSelected === 0 || $isSelected === 1) { | |
605 | $where .= " AND pn.is_selected = {$isSelected}"; | |
606 | }// else consider all dupe pairs | |
607 | $where .= " LIMIT {$batchLimit}"; | |
608 | ||
609 | $redirectForPerformance = ($batchLimit > 1) ? TRUE : FALSE; | |
6a488035 TO |
610 | |
611 | $dupePairs = CRM_Core_BAO_PrevNextCache::retrieve($cacheKeyString, $join, $where); | |
63ef778e | 612 | if (empty($dupePairs) && !$redirectForPerformance && $isSelected == 2) { |
6a488035 TO |
613 | // If we haven't found any dupes, probably cache is empty. |
614 | // Try filling cache and give another try. | |
615 | CRM_Core_BAO_PrevNextCache::refillCache($rgid, $gid, $cacheKeyString); | |
616 | $dupePairs = CRM_Core_BAO_PrevNextCache::retrieve($cacheKeyString, $join, $where); | |
617 | } | |
618 | ||
619 | $cacheParams = array( | |
620 | 'cache_key_string' => $cacheKeyString, | |
621 | 'join' => $join, | |
622 | 'where' => $where, | |
623 | ); | |
624 | return CRM_Dedupe_Merger::merge($dupePairs, $cacheParams, $mode, $autoFlip, $redirectForPerformance); | |
625 | } | |
626 | ||
f931b74c | 627 | public static function updateMergeStats($cacheKeyString, $result = array()) { |
63ef778e | 628 | // gather latest stats |
629 | $merged = count($result['merged']); | |
630 | $skipped = count($result['skipped']); | |
631 | ||
632 | if ($merged <= 0 && $skipped <= 0) { | |
633 | return; | |
634 | } | |
635 | ||
636 | // get previous stats | |
637 | $previousStats = CRM_Core_BAO_PrevNextCache::retrieve("{$cacheKeyString}_stats"); | |
638 | if (!empty($previousStats)) { | |
639 | if ($previousStats[0]['merged']) { | |
640 | $merged = $merged + $previousStats[0]['merged']; | |
641 | } | |
642 | if ($previousStats[0]['skipped']) { | |
643 | $skipped = $skipped + $previousStats[0]['skipped']; | |
644 | } | |
645 | } | |
646 | ||
647 | // delete old stats | |
648 | CRM_Dedupe_Merger::resetMergeStats($cacheKeyString); | |
649 | ||
650 | // store the updated stats | |
651 | $data = array( | |
652 | 'merged' => $merged, | |
653 | 'skipped' => $skipped, | |
654 | ); | |
655 | $data = CRM_Core_DAO::escapeString(serialize($data)); | |
656 | ||
657 | $values = array(); | |
658 | $values[] = " ( 'civicrm_contact', 0, 0, '{$cacheKeyString}_stats', '$data' ) "; | |
659 | CRM_Core_BAO_PrevNextCache::setItem($values); | |
660 | } | |
661 | ||
f931b74c | 662 | public static function resetMergeStats($cacheKeyString) { |
63ef778e | 663 | return CRM_Core_BAO_PrevNextCache::deleteItem(NULL, "{$cacheKeyString}_stats"); |
664 | } | |
665 | ||
f931b74c | 666 | public static function getMergeStats($cacheKeyString) { |
63ef778e | 667 | $stats = CRM_Core_BAO_PrevNextCache::retrieve("{$cacheKeyString}_stats"); |
668 | if (!empty($stats)) { | |
669 | $stats = $stats[0]; | |
670 | } | |
671 | return $stats; | |
672 | } | |
673 | ||
f931b74c | 674 | public static function getMergeStatsMsg($cacheKeyString) { |
63ef778e | 675 | $msg = ''; |
676 | $stats = CRM_Dedupe_Merger::getMergeStats($cacheKeyString); | |
677 | if (!empty($stats['merged'])) { | |
678 | $msg = "{$stats['merged']} " . ts(' Contact(s) were merged. '); | |
679 | } | |
680 | if (!empty($stats['skipped'])) { | |
681 | $msg .= $stats['skipped'] . ts(' Contact(s) were skipped.'); | |
682 | } | |
683 | return $msg; | |
684 | } | |
685 | ||
6a488035 | 686 | /** |
100fef9d | 687 | * Merge given set of contacts. Performs core operation. |
6a488035 | 688 | * |
98997235 TO |
689 | * @param array $dupePairs |
690 | * Set of pair of contacts for whom merge is to be done. | |
691 | * @param array $cacheParams | |
692 | * Prev-next-cache params based on which next pair of contacts are computed. | |
6a488035 | 693 | * Generally used with batch-merge. |
98997235 TO |
694 | * @param string $mode |
695 | * Helps decide how to behave when there are conflicts. | |
6a488035 TO |
696 | * A 'safe' value skips the merge if there are any un-resolved conflicts. |
697 | * Does a force merge otherwise (aggressive mode). | |
c301f76e | 698 | * @param bool $autoFlip to let api decide which contact to retain and which to delete. |
98997235 | 699 | * Wether to let api decide which contact to retain and which to delete. |
6a488035 TO |
700 | * |
701 | * | |
77b97be7 EM |
702 | * @param bool $redirectForPerformance |
703 | * | |
704 | * @return array|bool | |
6a488035 | 705 | */ |
00be9182 | 706 | public static function merge($dupePairs = array(), $cacheParams = array(), $mode = 'safe', |
353ffa53 | 707 | $autoFlip = TRUE, $redirectForPerformance = FALSE |
6a488035 TO |
708 | ) { |
709 | $cacheKeyString = CRM_Utils_Array::value('cache_key_string', $cacheParams); | |
710 | $resultStats = array('merged' => array(), 'skipped' => array()); | |
711 | ||
712 | // we don't want dupe caching to get reset after every-merge, and therefore set the | |
713 | // doNotResetCache flag | |
714 | $config = CRM_Core_Config::singleton(); | |
715 | $config->doNotResetCache = 1; | |
716 | ||
717 | while (!empty($dupePairs)) { | |
718 | foreach ($dupePairs as $dupes) { | |
1cf05c3e | 719 | CRM_Utils_Hook::merge('flip', $dupes, $dupes['dstID'], $dupes['srcID']); |
6a488035 TO |
720 | $mainId = $dupes['dstID']; |
721 | $otherId = $dupes['srcID']; | |
602789b5 DS |
722 | $isAutoFlip = CRM_Utils_Array::value('auto_flip', $dupes, $autoFlip); |
723 | // if we can, make sure that $mainId is the one with lower id number | |
724 | if ($isAutoFlip && ($mainId > $otherId)) { | |
6a488035 TO |
725 | $mainId = $dupes['srcID']; |
726 | $otherId = $dupes['dstID']; | |
727 | } | |
728 | if (!$mainId || !$otherId) { | |
729 | // return error | |
730 | return FALSE; | |
731 | } | |
732 | ||
733 | // Generate var $migrationInfo. The variable structure is exactly same as | |
734 | // $formValues submitted during a UI merge for a pair of contacts. | |
721248d4 | 735 | $rowsElementsAndInfo = CRM_Dedupe_Merger::getRowsElementsAndInfo($mainId, $otherId); |
6a488035 TO |
736 | |
737 | $migrationInfo = &$rowsElementsAndInfo['migration_info']; | |
738 | ||
739 | // add additional details that we might need to resolve conflicts | |
740 | $migrationInfo['main_details'] = &$rowsElementsAndInfo['main_details']; | |
741 | $migrationInfo['other_details'] = &$rowsElementsAndInfo['other_details']; | |
742 | $migrationInfo['main_loc_block'] = &$rowsElementsAndInfo['main_loc_block']; | |
743 | $migrationInfo['rows'] = &$rowsElementsAndInfo['rows']; | |
744 | ||
745 | // go ahead with merge if there is no conflict | |
63ef778e | 746 | $conflicts = array(); |
747 | if (!CRM_Dedupe_Merger::skipMerge($mainId, $otherId, $migrationInfo, $mode, $conflicts)) { | |
6a488035 | 748 | CRM_Dedupe_Merger::moveAllBelongings($mainId, $otherId, $migrationInfo); |
c940014d | 749 | $resultStats['merged'][] = array('main_id' => $mainId, 'other_id' => $otherId); |
6a488035 TO |
750 | } |
751 | else { | |
c940014d | 752 | $resultStats['skipped'][] = array('main_id' => $mainId, 'other_id' => $otherId); |
6a488035 TO |
753 | } |
754 | ||
0971143c | 755 | // store any conflicts |
63ef778e | 756 | if (!empty($conflicts)) { |
fd630ef9 | 757 | foreach ($conflicts as $key => $dnc) { |
758 | $conflicts[$key] = "{$migrationInfo['rows'][$key]['title']}: '{$migrationInfo['rows'][$key]['main']}' vs. '{$migrationInfo['rows'][$key]['other']}'"; | |
759 | } | |
63ef778e | 760 | CRM_Core_BAO_PrevNextCache::markConflict($mainId, $otherId, $cacheKeyString, $conflicts); |
f931b74c | 761 | } |
762 | else { | |
63ef778e | 763 | // delete entry from PrevNextCache table so we don't consider the pair next time |
764 | // pair may have been flipped, so make sure we delete using both orders | |
765 | CRM_Core_BAO_PrevNextCache::deletePair($mainId, $otherId, $cacheKeyString, TRUE); | |
766 | } | |
6a488035 TO |
767 | |
768 | CRM_Core_DAO::freeResult(); | |
769 | unset($rowsElementsAndInfo, $migrationInfo); | |
770 | } | |
771 | ||
772 | if ($cacheKeyString && !$redirectForPerformance) { | |
773 | // retrieve next pair of dupes | |
774 | $dupePairs = CRM_Core_BAO_PrevNextCache::retrieve($cacheKeyString, | |
775 | $cacheParams['join'], | |
776 | $cacheParams['where'] | |
777 | ); | |
778 | } | |
779 | else { | |
780 | // do not proceed. Terminate the loop | |
781 | unset($dupePairs); | |
782 | } | |
783 | } | |
63ef778e | 784 | |
785 | CRM_Dedupe_Merger::updateMergeStats($cacheKeyString, $resultStats); | |
6a488035 TO |
786 | return $resultStats; |
787 | } | |
788 | ||
789 | /** | |
790 | * A function which uses various rules / algorithms for choosing which contact to bias to | |
791 | * when there's a conflict (to handle "gotchas"). Plus the safest route to merge. | |
792 | * | |
98997235 TO |
793 | * @param int $mainId |
794 | * Main contact with whom merge has to happen. | |
795 | * @param int $otherId | |
796 | * Duplicate contact which would be deleted after merge operation. | |
797 | * @param array $migrationInfo | |
798 | * Array of information about which elements to merge. | |
799 | * @param string $mode | |
800 | * Helps decide how to behave when there are conflicts. | |
13919cf8 J |
801 | * - A 'safe' value skips the merge if there are any un-resolved conflicts. |
802 | * - Does a force merge otherwise (aggressive mode). | |
6a488035 | 803 | * |
ad37ac8e | 804 | * @param array $conflicts |
805 | * | |
77b97be7 | 806 | * @return bool |
6a488035 | 807 | */ |
63ef778e | 808 | public static function skipMerge($mainId, $otherId, &$migrationInfo, $mode = 'safe', &$conflicts = array()) { |
0971143c | 809 | |
6a488035 TO |
810 | $migrationData = array( |
811 | 'old_migration_info' => $migrationInfo, | |
812 | 'mode' => $mode, | |
813 | ); | |
eb61dc07 | 814 | |
b2b0530a | 815 | $allLocationTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id'); |
6a488035 TO |
816 | |
817 | foreach ($migrationInfo as $key => $val) { | |
818 | if ($val === "null") { | |
0971143c | 819 | // Rule: Never overwrite with an empty value (in any mode) |
6a488035 TO |
820 | unset($migrationInfo[$key]); |
821 | continue; | |
822 | } | |
16254ae1 | 823 | elseif ((in_array(substr($key, 5), CRM_Dedupe_Merger::getContactFields()) or |
6a488035 | 824 | substr($key, 0, 12) == 'move_custom_' |
353ffa53 TO |
825 | ) and $val != NULL |
826 | ) { | |
0971143c J |
827 | // Rule: If both main-contact, and other-contact have a field with a |
828 | // different value, then let $mode decide if to merge it or not | |
4eea8606 J |
829 | if ( |
830 | !empty($migrationInfo['rows'][$key]['main']) | |
831 | && $migrationInfo['rows'][$key]['main'] != $migrationInfo['rows'][$key]['other'] | |
832 | ) { | |
fd630ef9 | 833 | |
834 | // note it down & lets wait for response from the hook. | |
835 | // For no response $mode will decide if to skip this merge | |
836 | $conflicts[$key] = NULL; | |
6a488035 TO |
837 | } |
838 | } | |
839 | elseif (substr($key, 0, 14) == 'move_location_' and $val != NULL) { | |
840 | $locField = explode('_', $key); | |
841 | $fieldName = $locField[2]; | |
842 | $fieldCount = $locField[3]; | |
843 | ||
53e45f60 | 844 | // Rule: resolve address conflict if any |
6a488035 | 845 | if ($fieldName == 'address') { |
abb422f9 | 846 | $mainNewLocTypeId = $migrationInfo['location_blocks'][$fieldName][$fieldCount]['locTypeId']; |
d342c43c | 847 | if (!empty($migrationInfo['main_loc_block']) && |
53e45f60 | 848 | array_key_exists("main_address_{$mainNewLocTypeId}", $migrationInfo['main_loc_block'])) { |
6a488035 | 849 | // main loc already has some address for the loc-type. Its a overwrite situation. |
6a488035 TO |
850 | // look for next available loc-type |
851 | $newTypeId = NULL; | |
852 | foreach ($allLocationTypes as $typeId => $typeLabel) { | |
53e45f60 | 853 | if (!array_key_exists("main_address_{$typeId}", $migrationInfo['main_loc_block'])) { |
6a488035 TO |
854 | $newTypeId = $typeId; |
855 | } | |
856 | } | |
857 | if ($newTypeId) { | |
858 | // try insert address at new available loc-type | |
abb422f9 | 859 | $migrationInfo['location_blocks'][$fieldName][$fieldCount]['locTypeId'] = $newTypeId; |
6a488035 | 860 | } |
fd630ef9 | 861 | else { |
6a488035 | 862 | // note it down & lets wait for response from the hook. |
fd630ef9 | 863 | // For no response $mode will decide if to skip this merge |
6a488035 TO |
864 | $conflicts[$key] = NULL; |
865 | } | |
6a488035 TO |
866 | } |
867 | } | |
868 | elseif ($migrationInfo['rows'][$key]['main'] == $migrationInfo['rows'][$key]['other']) { | |
869 | // for loc blocks other than address like email, phone .. if values are same no point in merging | |
870 | // and adding redundant value | |
871 | unset($migrationInfo[$key]); | |
872 | } | |
873 | } | |
874 | } | |
875 | ||
876 | // A hook to implement other algorithms for choosing which contact to bias to when | |
877 | // there's a conflict (to handle "gotchas"). fields_in_conflict could be modified here | |
878 | // merge happens with new values filled in here. For a particular field / row not to be merged | |
879 | // field should be unset from fields_in_conflict. | |
880 | $migrationData['fields_in_conflict'] = $conflicts; | |
fd630ef9 | 881 | $migrationData['merge_mode'] = $mode; |
6a488035 TO |
882 | CRM_Utils_Hook::merge('batch', $migrationData, $mainId, $otherId); |
883 | $conflicts = $migrationData['fields_in_conflict']; | |
63ef778e | 884 | // allow hook to override / manipulate migrationInfo as well |
885 | $migrationInfo = $migrationData['old_migration_info']; | |
6a488035 TO |
886 | |
887 | if (!empty($conflicts)) { | |
888 | foreach ($conflicts as $key => $val) { | |
889 | if ($val === NULL and $mode == 'safe') { | |
63ef778e | 890 | // un-resolved conflicts still present. Lets skip this merge after saving the conflict / reason. |
6a488035 TO |
891 | return TRUE; |
892 | } | |
893 | else { | |
894 | // copy over the resolved values | |
895 | $migrationInfo[$key] = $val; | |
896 | } | |
897 | } | |
fd630ef9 | 898 | // if there are conflicts and mode is aggressive, allow hooks to decide if to skip merges |
899 | if (array_key_exists('skip_merge', $migrationData)) { | |
900 | return (bool) $migrationData['skip_merge']; | |
901 | } | |
6a488035 TO |
902 | } |
903 | return FALSE; | |
904 | } | |
905 | ||
34917198 J |
906 | /** |
907 | * A function to build an array of information about location blocks that is | |
908 | * required when merging location fields | |
909 | * | |
910 | * @return array | |
911 | */ | |
912 | public static function getLocationBlockInfo() { | |
913 | $locationBlocks = array( | |
914 | 'address' => array( | |
915 | 'label' => 'Address', | |
916 | 'displayField' => 'display', | |
917 | 'sortString' => 'location_type_id', | |
918 | 'hasLocation' => TRUE, | |
919 | 'hasType' => FALSE, | |
920 | ), | |
921 | 'email' => array( | |
922 | 'label' => 'Email', | |
923 | 'displayField' => 'email', | |
924 | 'sortString' => 'location_type_id', | |
925 | 'hasLocation' => TRUE, | |
926 | 'hasType' => FALSE, | |
927 | ), | |
928 | 'im' => array( | |
929 | 'label' => 'IM', | |
930 | 'displayField' => 'name', | |
931 | 'sortString' => 'location_type_id,provider_id', | |
932 | 'hasLocation' => TRUE, | |
933 | 'hasType' => 'provider_id', | |
934 | ), | |
935 | 'phone' => array( | |
936 | 'label' => 'Phone', | |
937 | 'displayField' => 'phone', | |
938 | 'sortString' => 'location_type_id,phone_type_id', | |
939 | 'hasLocation' => TRUE, | |
940 | 'hasType' => 'phone_type_id', | |
941 | ), | |
942 | 'website' => array( | |
943 | 'label' => 'Website', | |
944 | 'displayField' => 'url', | |
945 | 'sortString' => 'website_type_id', | |
946 | 'hasLocation' => FALSE, | |
947 | 'hasType' => 'website_type_id', | |
948 | ), | |
949 | ); | |
950 | return $locationBlocks; | |
951 | } | |
952 | ||
6a488035 TO |
953 | /** |
954 | * A function to build an array of information required by merge function and the merge UI. | |
955 | * | |
98997235 TO |
956 | * @param int $mainId |
957 | * Main contact with whom merge has to happen. | |
958 | * @param int $otherId | |
959 | * Duplicate contact which would be deleted after merge operation. | |
6a488035 | 960 | * |
77b97be7 | 961 | * @return array|bool|int |
53e45f60 | 962 | * 'main_loc_block' => Stores all location blocks associated with the 'main' contact |
6a488035 | 963 | */ |
00be9182 | 964 | public static function getRowsElementsAndInfo($mainId, $otherId) { |
6a488035 TO |
965 | $qfZeroBug = 'e8cddb72-a257-11dc-b9cc-0016d3330ee9'; |
966 | ||
967 | // Fetch contacts | |
968 | foreach (array('main' => $mainId, 'other' => $otherId) as $moniker => $cid) { | |
353ffa53 TO |
969 | $params = array( |
970 | 'contact_id' => $cid, | |
971 | 'version' => 3, | |
c301f76e | 972 | 'return' => array_merge(array('display_name'), self::getContactFields()), |
353ffa53 | 973 | ); |
6a488035 TO |
974 | $result = civicrm_api('contact', 'get', $params); |
975 | ||
976 | if (empty($result['values'][$cid]['contact_type'])) { | |
977 | return FALSE; | |
978 | } | |
979 | $$moniker = $result['values'][$cid]; | |
980 | } | |
981 | ||
982 | static $fields = array(); | |
983 | if (empty($fields)) { | |
984 | $fields = CRM_Contact_DAO_Contact::fields(); | |
985 | CRM_Core_DAO::freeResult(); | |
986 | } | |
987 | ||
988 | // FIXME: there must be a better way | |
989 | foreach (array('main', 'other') as $moniker) { | |
990 | $contact = &$$moniker; | |
991 | $preferred_communication_method = CRM_Utils_array::value('preferred_communication_method', $contact); | |
992 | $value = empty($preferred_communication_method) ? array() : $preferred_communication_method; | |
993 | $specialValues[$moniker] = array( | |
994 | 'preferred_communication_method' => $value, | |
0e357872 | 995 | 'communication_style_id' => $value, |
6a488035 TO |
996 | ); |
997 | ||
9b873358 | 998 | if (!empty($contact['preferred_communication_method'])) { |
d58a19a1 TO |
999 | // api 3 returns pref_comm_method as an array, which breaks the lookup; so we reconstruct |
1000 | $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 |
1001 | $specialValues[$moniker]['preferred_communication_method'] = CRM_Core_DAO::VALUE_SEPARATOR . $prefCommList . CRM_Core_DAO::VALUE_SEPARATOR; |
1002 | } | |
1003 | $names = array( | |
c301f76e | 1004 | 'preferred_communication_method' => array( |
1005 | 'newName' => 'preferred_communication_method_display', | |
1006 | 'groupName' => 'preferred_communication_method', | |
1007 | ), | |
6a488035 TO |
1008 | ); |
1009 | CRM_Core_OptionGroup::lookupValues($specialValues[$moniker], $names); | |
a14df814 | 1010 | |
0e357872 C |
1011 | if (!empty($contact['communication_style'])) { |
1012 | $specialValues[$moniker]['communication_style_id_display'] = $contact['communication_style']; | |
1013 | } | |
6a488035 TO |
1014 | } |
1015 | ||
1016 | static $optionValueFields = array(); | |
1017 | if (empty($optionValueFields)) { | |
1018 | $optionValueFields = CRM_Core_OptionValue::getFields(); | |
1019 | } | |
1020 | foreach ($optionValueFields as $field => $params) { | |
1021 | $fields[$field]['title'] = $params['title']; | |
1022 | } | |
1023 | ||
4eea8606 | 1024 | $compareFields = self::retrieveFields($main, $other); |
6a488035 TO |
1025 | |
1026 | $rows = $elements = $relTableElements = $migrationInfo = array(); | |
1027 | ||
4eea8606 | 1028 | foreach ($compareFields['contact'] as $field) { |
4d5f18cc | 1029 | if ($field == 'contact_sub_type') { |
1030 | // CRM-15681 don't display sub-types in UI | |
1031 | continue; | |
1032 | } | |
6a488035 TO |
1033 | foreach (array('main', 'other') as $moniker) { |
1034 | $contact = &$$moniker; | |
1035 | $value = CRM_Utils_Array::value($field, $contact); | |
1036 | if (isset($specialValues[$moniker][$field]) && is_string($specialValues[$moniker][$field])) { | |
1037 | $value = CRM_Core_DAO::VALUE_SEPARATOR . trim($specialValues[$moniker][$field], CRM_Core_DAO::VALUE_SEPARATOR) . CRM_Core_DAO::VALUE_SEPARATOR; | |
1038 | } | |
1039 | $label = isset($specialValues[$moniker]["{$field}_display"]) ? $specialValues[$moniker]["{$field}_display"] : $value; | |
a7488080 | 1040 | if (!empty($fields[$field]['type']) && $fields[$field]['type'] == CRM_Utils_Type::T_DATE) { |
6a488035 TO |
1041 | if ($value) { |
1042 | $value = str_replace('-', '', $value); | |
1043 | $label = CRM_Utils_Date::customFormat($label); | |
1044 | } | |
1045 | else { | |
1046 | $value = "null"; | |
1047 | } | |
1048 | } | |
a7488080 | 1049 | elseif (!empty($fields[$field]['type']) && $fields[$field]['type'] == CRM_Utils_Type::T_BOOLEAN) { |
6a488035 TO |
1050 | if ($label === '0') { |
1051 | $label = ts('[ ]'); | |
1052 | } | |
1053 | if ($label === '1') { | |
1054 | $label = ts('[x]'); | |
1055 | } | |
00f3da2e BS |
1056 | } |
1057 | elseif ($field == 'individual_prefix' || $field == 'prefix_id') { | |
1058 | $label = CRM_Utils_Array::value('individual_prefix', $contact); | |
6a488035 TO |
1059 | $value = CRM_Utils_Array::value('prefix_id', $contact); |
1060 | $field = 'prefix_id'; | |
00f3da2e BS |
1061 | } |
1062 | elseif ($field == 'individual_suffix' || $field == 'suffix_id') { | |
1063 | $label = CRM_Utils_Array::value('individual_suffix', $contact); | |
6a488035 TO |
1064 | $value = CRM_Utils_Array::value('suffix_id', $contact); |
1065 | $field = 'suffix_id'; | |
1066 | } | |
4f88c9cf | 1067 | elseif ($field == 'gender_id' && !empty($value)) { |
5b28be84 J |
1068 | $genderOptions = civicrm_api3('contact', 'getoptions', array('field' => 'gender_id')); |
1069 | $label = $genderOptions['values'][$value]; | |
4f88c9cf C |
1070 | } |
1071 | elseif ($field == 'current_employer_id' && !empty($value)) { | |
1072 | $label = "$value (" . CRM_Contact_BAO_Contact::displayName($value) . ")"; | |
1073 | } | |
6a488035 TO |
1074 | $rows["move_$field"][$moniker] = $label; |
1075 | if ($moniker == 'other') { | |
7154d2a4 BS |
1076 | //CRM-14334 |
1077 | if ($value === NULL || $value == '') { | |
6a488035 TO |
1078 | $value = 'null'; |
1079 | } | |
1080 | if ($value === 0 or $value === '0') { | |
1081 | $value = $qfZeroBug; | |
1082 | } | |
8cc574cf | 1083 | if (is_array($value) && empty($value[1])) { |
6a488035 TO |
1084 | $value[1] = NULL; |
1085 | } | |
13919cf8 J |
1086 | |
1087 | // Display a checkbox to migrate, only if the values are different | |
1088 | if ($value != $main[$field]) { | |
1089 | $elements[] = array('advcheckbox', "move_$field", NULL, NULL, NULL, $value); | |
1090 | } | |
1091 | ||
6a488035 TO |
1092 | $migrationInfo["move_$field"] = $value; |
1093 | } | |
1094 | } | |
1095 | $rows["move_$field"]['title'] = $fields[$field]['title']; | |
1096 | } | |
1097 | ||
eb61dc07 J |
1098 | // Handle location blocks. |
1099 | // @todo OpenID not in API yet, so is not supported here. | |
65a35632 | 1100 | |
087f00ec | 1101 | // Set up useful information about the location blocks |
34917198 | 1102 | $locationBlocks = self::getLocationBlockInfo(); |
087f00ec J |
1103 | |
1104 | $locations = array( | |
1105 | 'main' => array(), | |
1106 | 'other' => array(), | |
13919cf8 | 1107 | ); |
b814df56 J |
1108 | |
1109 | $mainLocBlock = array(); | |
087f00ec J |
1110 | |
1111 | // @todo This could probably be defined and used earlier | |
1112 | $mergeTargets = array( | |
1113 | 'main' => $mainId, | |
1114 | 'other' => $otherId, | |
1115 | ); | |
6a488035 | 1116 | |
087f00ec | 1117 | foreach ($locationBlocks as $blockName => $blockInfo) { |
6a488035 | 1118 | |
087f00ec J |
1119 | // Collect existing fields from both 'main' and 'other' contacts first |
1120 | // This allows us to match up location/types when building the table rows | |
1121 | foreach ($mergeTargets as $moniker => $cid) { | |
6a488035 | 1122 | $cnt = 1; |
b932e89e J |
1123 | $searchParams = array( |
1124 | 'version' => 3, | |
1125 | 'contact_id' => $cid, | |
087f00ec J |
1126 | // CRM-17556 Order by field-specific criteria |
1127 | 'options' => array( | |
1128 | 'sort' => $blockInfo['sortString'], | |
1129 | ), | |
b932e89e | 1130 | ); |
b932e89e | 1131 | $values = civicrm_api($blockName, 'get', $searchParams); |
087f00ec J |
1132 | if ($values['count']) { |
1133 | $cnt = 0; | |
1134 | foreach ($values['values'] as $index => $value) { | |
1135 | $locations[$moniker][$blockName][$cnt] = $value; | |
1136 | // Fix address display | |
34917198 | 1137 | $display = ''; |
eb61dc07 | 1138 | if ($blockName == 'address') { |
087f00ec J |
1139 | CRM_Core_BAO_Address::fixAddress($value); |
1140 | $display = CRM_Utils_Address::format($value); | |
eb61dc07 | 1141 | $locations[$moniker][$blockName][$cnt]['display'] = $display; |
6a488035 | 1142 | } |
abb422f9 J |
1143 | |
1144 | // Add any 'main' contact block values to an array for the JS | |
34917198 | 1145 | // @todo The JS should just access the main_details to find this info? |
abb422f9 J |
1146 | if ($moniker == 'main') { |
1147 | if ($blockInfo['hasType']) { | |
34917198 J |
1148 | // Handle websites, no location type ID |
1149 | // @todo Remove the need for this specific 'if' | |
1150 | if ($blockName == 'website') { | |
1151 | $value['location_type_id'] = 0; | |
1152 | } | |
1153 | $mainLocBlock["main_" . $blockName . "_" . $value['location_type_id'] . "_" . $value[$blockInfo['hasType']]]['display'] = $value[$blockInfo['displayField']]; | |
1154 | $mainLocBlock["main_" . $blockName . "_" . $value['location_type_id'] . "_" . $value[$blockInfo['hasType']]]['id'] = $value['id']; | |
6a488035 TO |
1155 | } |
1156 | else { | |
34917198 J |
1157 | // Get the correct display value for addresses |
1158 | // @todo Remove the need for this if... | |
1159 | if ($blockName == 'address') { | |
1160 | $mainLocBlock["main_" . $blockName . "_" . $value['location_type_id']]['display'] = $display; | |
1161 | $mainLocBlock["main_" . $blockName . "_" . $value['location_type_id']]['id'] = $value['id']; | |
1162 | } | |
1163 | else { | |
1164 | $mainLocBlock["main_" . $blockName . "_" . $value['location_type_id']]['display'] = $value[$blockInfo['displayField']]; | |
1165 | $mainLocBlock["main_" . $blockName . "_" . $value['location_type_id']]['id'] = $value['id']; | |
1166 | } | |
6a488035 | 1167 | } |
6a488035 | 1168 | } |
abb422f9 | 1169 | |
087f00ec | 1170 | $cnt++; |
6a488035 TO |
1171 | } |
1172 | } | |
1173 | } | |
6a488035 | 1174 | |
087f00ec J |
1175 | // Now, build the table rows appropriately, based off the information on |
1176 | // the 'other' contact | |
34917198 J |
1177 | if (!empty($locations['other']) && !empty($locations['other'][$blockName])) { |
1178 | foreach ($locations['other'][$blockName] as $count => $value) { | |
6a488035 | 1179 | |
087f00ec | 1180 | $displayValue = $value[$blockInfo['displayField']]; |
65a35632 | 1181 | |
087f00ec J |
1182 | // Add this value to the table rows |
1183 | $rows["move_location_{$blockName}_{$count}"]['other'] = $displayValue; | |
65a35632 | 1184 | |
087f00ec J |
1185 | // CRM-17556 Only display 'main' contact value if it's the same location + type |
1186 | // Look it up from main values... | |
65a35632 | 1187 | |
087f00ec J |
1188 | $lookupLocation = FALSE; |
1189 | if ($blockInfo['hasLocation']) { | |
1190 | $lookupLocation = $value['location_type_id']; | |
1191 | } | |
65a35632 | 1192 | |
087f00ec J |
1193 | $lookupType = FALSE; |
1194 | if ($blockInfo['hasType']) { | |
1195 | $lookupType = $value[$blockInfo['hasType']]; | |
1196 | } | |
65a35632 | 1197 | |
34917198 J |
1198 | // Hold ID of main contact's matching block |
1199 | $mainContactBlockId = 0; | |
1200 | ||
087f00ec J |
1201 | if (!empty($locations['main'][$blockName])) { |
1202 | foreach ($locations['main'][$blockName] as $mainValueCheck) { | |
1203 | // No location/type, or matching location and type | |
1204 | if ( | |
1205 | (empty($lookupLocation) || $lookupLocation == $mainValueCheck['location_type_id']) | |
1206 | && (empty($lookupType) || $lookupType == $mainValueCheck[$blockInfo['hasType']]) | |
1207 | ) { | |
34917198 | 1208 | // Set this value as the default against the 'other' contact value |
087f00ec | 1209 | $rows["move_location_{$blockName}_{$count}"]['main'] = $mainValueCheck[$blockInfo['displayField']]; |
34917198 | 1210 | $mainContactBlockId = $mainValueCheck['id']; |
087f00ec J |
1211 | break; |
1212 | } | |
6a488035 | 1213 | } |
087f00ec | 1214 | } |
65a35632 | 1215 | |
087f00ec J |
1216 | // Add checkbox to migrate data from 'other' to 'main' |
1217 | $elements[] = array('advcheckbox', "move_location_{$blockName}_{$count}"); | |
65a35632 | 1218 | |
087f00ec J |
1219 | // Flag up this field to skipMerge function (@todo: do we need to?) |
1220 | $migrationInfo["move_location_{$blockName}_{$count}"] = 1; | |
65a35632 | 1221 | |
34917198 J |
1222 | // Add a hidden field to store the ID of the target main contact block |
1223 | $elements[] = array('hidden', "location[$blockName][$count][mainContactBlockId]", $mainContactBlockId); | |
1224 | ||
087f00ec J |
1225 | // Setup variables |
1226 | $thisTypeId = FALSE; | |
1227 | $thisLocId = FALSE; | |
65a35632 | 1228 | |
087f00ec J |
1229 | // Provide a select drop-down for the location's location type |
1230 | // eg: Home, Work... | |
65a35632 | 1231 | |
087f00ec | 1232 | $js = NULL; |
65a35632 | 1233 | |
087f00ec J |
1234 | if ($blockInfo['hasLocation']) { |
1235 | ||
5b28be84 J |
1236 | // Load the location options for this entity |
1237 | $locationOptions = civicrm_api3($blockName, 'getoptions', array('field' => 'location_type_id')); | |
1238 | ||
087f00ec J |
1239 | // JS lookup 'main' contact's location (if there are any) |
1240 | if (!empty($locations['main'][$blockName])) { | |
1241 | $js = array('onChange' => "mergeBlock('$blockName', this, $count, 'locTypeId' );"); | |
6a488035 | 1242 | } |
087f00ec J |
1243 | |
1244 | $thisLocId = $value['location_type_id']; | |
1245 | ||
1246 | // Put this field's location type at the top of the list | |
5b28be84 | 1247 | $tmpIdList = $locationOptions['values']; |
087f00ec J |
1248 | $defaultLocId = array($thisLocId => $tmpIdList[$thisLocId]); |
1249 | unset($tmpIdList[$thisLocId]); | |
1250 | ||
1251 | // Add the element | |
eb61dc07 J |
1252 | $elements[] = array( |
1253 | 'select', | |
abb422f9 | 1254 | "location[$blockName][$count][locTypeId]", |
eb61dc07 | 1255 | NULL, |
087f00ec | 1256 | $defaultLocId + $tmpIdList, |
eb61dc07 | 1257 | $js, |
6a488035 | 1258 | ); |
087f00ec J |
1259 | |
1260 | // Add the relevant information to the $migrationInfo | |
1261 | // Keep location-type-id same as that of other-contact | |
1262 | // @todo Check this logic out | |
1263 | $migrationInfo['location_blocks'][$blockName][$count]['locTypeId'] = $thisLocId; | |
abb422f9 J |
1264 | if ($blockName != 'address') { |
1265 | $elements[] = array('advcheckbox', "location[{$blockName}][$count][operation]", NULL, ts('add new')); | |
087f00ec | 1266 | // always use add operation |
abb422f9 | 1267 | $migrationInfo['location_blocks'][$blockName][$count]['operation'] = 1; |
6a488035 | 1268 | } |
087f00ec | 1269 | |
6a488035 | 1270 | } |
6a488035 | 1271 | |
087f00ec J |
1272 | // Provide a select drop-down for the location's type/provider |
1273 | // eg websites: Google+, Facebook... | |
1274 | ||
6a488035 | 1275 | $js = NULL; |
087f00ec J |
1276 | |
1277 | if ($blockInfo['hasType']) { | |
1278 | ||
5b28be84 J |
1279 | // Load the type options for this entity |
1280 | $typeOptions = civicrm_api3($blockName, 'getoptions', array('field' => $blockInfo['hasType'])); | |
1281 | ||
1282 | // CRM-17556 Set up JS lookup of 'main' contact's value by type | |
087f00ec | 1283 | if (!empty($locations['main'][$blockName])) { |
abb422f9 | 1284 | $js = array('onChange' => "mergeBlock('$blockName', this, $count, 'typeTypeId' );"); |
087f00ec J |
1285 | } |
1286 | ||
1287 | $thisTypeId = $value[$blockInfo['hasType']]; | |
1288 | ||
1289 | // Put this field's location type at the top of the list | |
5b28be84 | 1290 | $tmpIdList = $typeOptions['values']; |
087f00ec J |
1291 | $defaultTypeId = array($thisTypeId => $tmpIdList[$thisTypeId]); |
1292 | unset($tmpIdList[$thisTypeId]); | |
1293 | ||
1294 | // Add the element | |
65a35632 J |
1295 | $elements[] = array( |
1296 | 'select', | |
4f2ad1d1 | 1297 | "location[$blockName][$count][typeTypeId]", |
65a35632 | 1298 | NULL, |
087f00ec | 1299 | $defaultTypeId + $tmpIdList, |
65a35632 J |
1300 | $js, |
1301 | ); | |
65a35632 | 1302 | |
087f00ec | 1303 | // Add the information to the migrationInfo (@todo Why?) |
34917198 | 1304 | $migrationInfo['location_blocks'][$blockName][$count]['typeTypeId'] = $thisTypeId; |
65a35632 | 1305 | |
6a488035 | 1306 | } |
087f00ec J |
1307 | |
1308 | // Set the label for this row | |
34917198 J |
1309 | $rowTitle = $blockInfo['label'] . ' ' . ($count + 1); |
1310 | if (!empty($thisLocId)) { | |
5b28be84 | 1311 | $rowTitle .= ' (' . $locationOptions['values'][$thisLocId] . ')'; |
6a488035 | 1312 | } |
34917198 | 1313 | if (!empty($thisTypeId)) { |
5b28be84 | 1314 | $rowTitle .= ' (' . $typeOptions['values'][$thisTypeId] . ')'; |
34917198 J |
1315 | } |
1316 | $rows["move_location_{$blockName}_$count"]['title'] = $rowTitle; | |
65a35632 | 1317 | |
34917198 | 1318 | } // End loop through 'other' locations of this type |
087f00ec | 1319 | |
34917198 | 1320 | } // End if 'other' location for this type exists |
6a488035 | 1321 | |
34917198 | 1322 | } // End loop through each location block entity |
6a488035 TO |
1323 | |
1324 | // add the related tables and unset the ones that don't sport any of the duplicate contact's info | |
1325 | $config = CRM_Core_Config::singleton(); | |
1326 | $mainUfId = CRM_Core_BAO_UFMatch::getUFId($mainId); | |
1327 | $mainUser = NULL; | |
1328 | if ($mainUfId) { | |
1329 | // d6 compatible | |
1330 | if ($config->userSystem->is_drupal == '1' && function_exists($mainUser)) { | |
1331 | $mainUser = user_load($mainUfId); | |
1332 | } | |
1333 | elseif ($config->userFramework == 'Joomla') { | |
1334 | $mainUser = JFactory::getUser($mainUfId); | |
1335 | } | |
1336 | } | |
1337 | $otherUfId = CRM_Core_BAO_UFMatch::getUFId($otherId); | |
1338 | $otherUser = NULL; | |
1339 | if ($otherUfId) { | |
1340 | // d6 compatible | |
1341 | if ($config->userSystem->is_drupal == '1' && function_exists($mainUser)) { | |
1342 | $otherUser = user_load($otherUfId); | |
1343 | } | |
1344 | elseif ($config->userFramework == 'Joomla') { | |
1345 | $otherUser = JFactory::getUser($otherUfId); | |
1346 | } | |
1347 | } | |
1348 | ||
1349 | $relTables = CRM_Dedupe_Merger::relTables(); | |
1350 | $activeRelTables = CRM_Dedupe_Merger::getActiveRelTables($otherId); | |
1351 | $activeMainRelTables = CRM_Dedupe_Merger::getActiveRelTables($mainId); | |
1352 | foreach ($relTables as $name => $null) { | |
1353 | if (!in_array($name, $activeRelTables) && | |
1354 | !(($name == 'rel_table_users') && in_array($name, $activeMainRelTables)) | |
1355 | ) { | |
1356 | unset($relTables[$name]); | |
1357 | continue; | |
1358 | } | |
1359 | ||
1360 | $relTableElements[] = array('checkbox', "move_$name"); | |
1361 | $migrationInfo["move_$name"] = 1; | |
1362 | ||
1363 | $relTables[$name]['main_url'] = str_replace('$cid', $mainId, $relTables[$name]['url']); | |
1364 | $relTables[$name]['other_url'] = str_replace('$cid', $otherId, $relTables[$name]['url']); | |
1365 | if ($name == 'rel_table_users') { | |
1366 | $relTables[$name]['main_url'] = str_replace('%ufid', $mainUfId, $relTables[$name]['url']); | |
1367 | $relTables[$name]['other_url'] = str_replace('%ufid', $otherUfId, $relTables[$name]['url']); | |
1368 | $find = array('$ufid', '$ufname'); | |
1369 | if ($mainUser) { | |
1370 | $replace = array($mainUfId, $mainUser->name); | |
1371 | $relTables[$name]['main_title'] = str_replace($find, $replace, $relTables[$name]['title']); | |
1372 | } | |
1373 | if ($otherUser) { | |
1374 | $replace = array($otherUfId, $otherUser->name); | |
1375 | $relTables[$name]['other_title'] = str_replace($find, $replace, $relTables[$name]['title']); | |
1376 | } | |
1377 | } | |
1378 | if ($name == 'rel_table_memberships') { | |
1379 | $elements[] = array('checkbox', "operation[move_{$name}][add]", NULL, ts('add new')); | |
1380 | $migrationInfo["operation"]["move_{$name}"]['add'] = 1; | |
1381 | } | |
1382 | } | |
1383 | foreach ($relTables as $name => $null) { | |
1384 | $relTables["move_$name"] = $relTables[$name]; | |
1385 | unset($relTables[$name]); | |
1386 | } | |
1387 | ||
1388 | // handle custom fields | |
1389 | $mainTree = CRM_Core_BAO_CustomGroup::getTree($main['contact_type'], CRM_Core_DAO::$_nullObject, $mainId, -1, | |
1390 | CRM_Utils_Array::value('contact_sub_type', $main) | |
1391 | ); | |
1392 | $otherTree = CRM_Core_BAO_CustomGroup::getTree($main['contact_type'], CRM_Core_DAO::$_nullObject, $otherId, -1, | |
1393 | CRM_Utils_Array::value('contact_sub_type', $other) | |
1394 | ); | |
1395 | CRM_Core_DAO::freeResult(); | |
1396 | ||
1397 | foreach ($otherTree as $gid => $group) { | |
1398 | $foundField = FALSE; | |
1399 | if (!isset($group['fields'])) { | |
1400 | continue; | |
1401 | } | |
1402 | ||
1403 | foreach ($group['fields'] as $fid => $field) { | |
4eea8606 | 1404 | if (in_array($fid, $compareFields['custom'])) { |
6a488035 TO |
1405 | if (!$foundField) { |
1406 | $rows["custom_group_$gid"]['title'] = $group['title']; | |
1407 | $foundField = TRUE; | |
1408 | } | |
a7488080 | 1409 | if (!empty($mainTree[$gid]['fields'][$fid]['customValue'])) { |
6a488035 | 1410 | foreach ($mainTree[$gid]['fields'][$fid]['customValue'] as $valueId => $values) { |
51a3717f | 1411 | $rows["move_custom_$fid"]['main'] = CRM_Core_BAO_CustomField::displayValue($values['data'], $fid); |
6a488035 TO |
1412 | } |
1413 | } | |
1414 | $value = "null"; | |
a7488080 | 1415 | if (!empty($otherTree[$gid]['fields'][$fid]['customValue'])) { |
6a488035 | 1416 | foreach ($otherTree[$gid]['fields'][$fid]['customValue'] as $valueId => $values) { |
51a3717f | 1417 | $rows["move_custom_$fid"]['other'] = CRM_Core_BAO_CustomField::displayValue($values['data'], $fid); |
6a488035 TO |
1418 | if ($values['data'] === 0 || $values['data'] === '0') { |
1419 | $values['data'] = $qfZeroBug; | |
d58a19a1 | 1420 | } |
6a488035 | 1421 | $value = ($values['data']) ? $values['data'] : $value; |
d58a19a1 | 1422 | } |
6a488035 TO |
1423 | } |
1424 | $rows["move_custom_$fid"]['title'] = $field['label']; | |
1425 | ||
1426 | $elements[] = array('advcheckbox', "move_custom_$fid", NULL, NULL, NULL, $value); | |
1427 | $migrationInfo["move_custom_$fid"] = $value; | |
1428 | } | |
1429 | } | |
1430 | } | |
abb422f9 | 1431 | |
6a488035 TO |
1432 | $result = array( |
1433 | 'rows' => $rows, | |
1434 | 'elements' => $elements, | |
1435 | 'rel_table_elements' => $relTableElements, | |
1436 | 'main_loc_block' => $mainLocBlock, | |
1437 | 'rel_tables' => $relTables, | |
1438 | 'main_details' => $main, | |
1439 | 'other_details' => $other, | |
1440 | 'migration_info' => $migrationInfo, | |
1441 | ); | |
1442 | ||
34917198 J |
1443 | $result['main_details']['location_blocks'] = $locations['main']; |
1444 | $result['other_details']['location_blocks'] = $locations['other']; | |
6a488035 TO |
1445 | |
1446 | return $result; | |
1447 | } | |
1448 | ||
1449 | /** | |
1450 | * Based on the provided two contact_ids and a set of tables, move the belongings of the | |
1451 | * other contact to the main one - be it Location / CustomFields or Contact .. related info. | |
1452 | * A superset of moveContactBelongings() function. | |
1453 | * | |
98997235 TO |
1454 | * @param int $mainId |
1455 | * Main contact with whom merge has to happen. | |
1456 | * @param int $otherId | |
1457 | * Duplicate contact which would be deleted after merge operation. | |
77b97be7 EM |
1458 | * |
1459 | * @param $migrationInfo | |
6a488035 | 1460 | * |
77b97be7 | 1461 | * @return bool |
6a488035 | 1462 | */ |
00be9182 | 1463 | public static function moveAllBelongings($mainId, $otherId, $migrationInfo) { |
6a488035 TO |
1464 | if (empty($migrationInfo)) { |
1465 | return FALSE; | |
1466 | } | |
1467 | ||
1468 | $qfZeroBug = 'e8cddb72-a257-11dc-b9cc-0016d3330ee9'; | |
1469 | $relTables = CRM_Dedupe_Merger::relTables(); | |
1470 | $moveTables = $locBlocks = $tableOperations = array(); | |
1471 | foreach ($migrationInfo as $key => $value) { | |
1472 | if ($value == $qfZeroBug) { | |
1473 | $value = '0'; | |
1474 | } | |
7154d2a4 | 1475 | if ((in_array(substr($key, 5), CRM_Dedupe_Merger::getContactFields()) || |
353ffa53 | 1476 | substr($key, 0, 12) == 'move_custom_') && |
7154d2a4 BS |
1477 | $value != NULL |
1478 | ) { | |
6a488035 TO |
1479 | $submitted[substr($key, 5)] = $value; |
1480 | } | |
34917198 J |
1481 | |
1482 | // Set up initial information for handling migration of location blocks | |
6a488035 TO |
1483 | elseif (substr($key, 0, 14) == 'move_location_' and $value != NULL) { |
1484 | $locField = explode('_', $key); | |
1485 | $fieldName = $locField[2]; | |
1486 | $fieldCount = $locField[3]; | |
34917198 J |
1487 | |
1488 | // Set up the operation type (add/overwrite) | |
6832d4a9 | 1489 | // Ignore operation for websites |
34917198 | 1490 | // @todo Tidy this up |
6832d4a9 J |
1491 | $operation = 0; |
1492 | if ($fieldName != 'website') { | |
a50d7d84 | 1493 | $operation = CRM_Utils_Array::value('operation', $migrationInfo['location_blocks'][$fieldName][$fieldCount]); |
6832d4a9 | 1494 | } |
6a488035 TO |
1495 | // default operation is overwrite. |
1496 | if (!$operation) { | |
1497 | $operation = 2; | |
1498 | } | |
6a488035 | 1499 | $locBlocks[$fieldName][$fieldCount]['operation'] = $operation; |
0971143c | 1500 | |
6a488035 | 1501 | } |
34917198 | 1502 | |
6a488035 TO |
1503 | elseif (substr($key, 0, 15) == 'move_rel_table_' and $value == '1') { |
1504 | $moveTables = array_merge($moveTables, $relTables[substr($key, 5)]['tables']); | |
1505 | if (array_key_exists('operation', $migrationInfo)) { | |
1506 | foreach ($relTables[substr($key, 5)]['tables'] as $table) { | |
1507 | if (array_key_exists($key, $migrationInfo['operation'])) { | |
1508 | $tableOperations[$table] = $migrationInfo['operation'][$key]; | |
1509 | } | |
1510 | } | |
1511 | } | |
1512 | } | |
1513 | } | |
1514 | ||
eb61dc07 | 1515 | // **** Do location related migration. |
eb61dc07 | 1516 | // @todo Handle OpenID (not currently in API). |
6a488035 | 1517 | if (!empty($locBlocks)) { |
13919cf8 | 1518 | |
34917198 | 1519 | $locationBlocks = self::getLocationBlockInfo(); |
6a488035 TO |
1520 | |
1521 | $primaryBlockIds = CRM_Contact_BAO_Contact::getLocBlockIds($mainId, array('is_primary' => 1)); | |
1522 | $billingBlockIds = CRM_Contact_BAO_Contact::getLocBlockIds($mainId, array('is_billing' => 1)); | |
1523 | ||
1524 | foreach ($locBlocks as $name => $block) { | |
1525 | if (!is_array($block) || CRM_Utils_System::isNull($block)) { | |
1526 | continue; | |
1527 | } | |
34917198 | 1528 | $daoName = 'CRM_Core_DAO_' . $locationBlocks[$name]['label']; |
6a488035 TO |
1529 | $primaryDAOId = (array_key_exists($name, $primaryBlockIds)) ? array_pop($primaryBlockIds[$name]) : NULL; |
1530 | $billingDAOId = (array_key_exists($name, $billingBlockIds)) ? array_pop($billingBlockIds[$name]) : NULL; | |
1531 | ||
1532 | foreach ($block as $blkCount => $values) { | |
6a488035 | 1533 | |
34917198 J |
1534 | // For the block which belongs to other-contact, link the location block to main-contact |
1535 | $otherBlockDAO = new $daoName(); | |
1536 | $otherBlockDAO->contact_id = $mainId; | |
6a488035 | 1537 | |
34917198 J |
1538 | // Get the ID of this block on the 'other' contact, otherwise skip |
1539 | $otherBlockId = CRM_Utils_Array::value('id', $migrationInfo['other_details']['location_blocks'][$name][$blkCount]); | |
6a488035 TO |
1540 | if (!$otherBlockId) { |
1541 | continue; | |
1542 | } | |
6a488035 | 1543 | $otherBlockDAO->id = $otherBlockId; |
6a488035 | 1544 | |
34917198 J |
1545 | // Add/update location and type information from the form, if applicable |
1546 | if ($locationBlocks[$name]['hasLocation']) { | |
a50d7d84 | 1547 | $locTypeId = CRM_Utils_Array::value('locTypeId', $migrationInfo['location_blocks'][$name][$blkCount]); |
34917198 | 1548 | $otherBlockDAO->location_type_id = $locTypeId; |
08ef1f91 | 1549 | } |
34917198 | 1550 | if ($locationBlocks[$name]['hasType']) { |
a50d7d84 | 1551 | $typeTypeId = CRM_Utils_Array::value('typeTypeId', $migrationInfo['location_blocks'][$name][$blkCount]); |
34917198 | 1552 | $otherBlockDAO->{$locationBlocks[$name]['hasType']} = $typeTypeId; |
08ef1f91 R |
1553 | } |
1554 | ||
34917198 | 1555 | // Get main block ID |
a50d7d84 | 1556 | $mainBlockId = CRM_Utils_Array::value('mainContactBlockId', $migrationInfo['location_blocks'][$name][$blkCount], 0); |
6a488035 TO |
1557 | |
1558 | // if main contact already has primary & billing, set the flags to 0. | |
1559 | if ($primaryDAOId) { | |
1560 | $otherBlockDAO->is_primary = 0; | |
1561 | } | |
1562 | if ($billingDAOId) { | |
1563 | $otherBlockDAO->is_billing = 0; | |
1564 | } | |
1565 | ||
34917198 | 1566 | $operation = CRM_Utils_Array::value('operation', $values, 2); |
6a488035 | 1567 | // overwrite - need to delete block which belongs to main-contact. |
34917198 | 1568 | if (!empty($mainBlockId) && ($operation == 2)) { |
6a488035 TO |
1569 | $deleteDAO = new $daoName(); |
1570 | $deleteDAO->id = $mainBlockId; | |
1571 | $deleteDAO->find(TRUE); | |
1572 | ||
1573 | // if we about to delete a primary / billing block, set the flags for new block | |
1574 | // that we going to assign to main-contact | |
1575 | if ($primaryDAOId && ($primaryDAOId == $deleteDAO->id)) { | |
1576 | $otherBlockDAO->is_primary = 1; | |
1577 | } | |
1578 | if ($billingDAOId && ($billingDAOId == $deleteDAO->id)) { | |
1579 | $otherBlockDAO->is_billing = 1; | |
1580 | } | |
1581 | ||
1582 | $deleteDAO->delete(); | |
1583 | $deleteDAO->free(); | |
1584 | } | |
1585 | ||
1586 | $otherBlockDAO->update(); | |
1587 | $otherBlockDAO->free(); | |
1588 | } | |
1589 | } | |
1590 | } | |
1591 | ||
1592 | // **** Do tables related migrations | |
1593 | if (!empty($moveTables)) { | |
1594 | CRM_Dedupe_Merger::moveContactBelongings($mainId, $otherId, $moveTables, $tableOperations); | |
1595 | unset($moveTables, $tableOperations); | |
1596 | } | |
1597 | ||
1598 | // **** Do contact related migrations | |
1599 | CRM_Dedupe_Merger::moveContactBelongings($mainId, $otherId); | |
1600 | ||
1601 | // FIXME: fix gender, prefix and postfix, so they're edible by createProfileContact() | |
1602 | $names['gender'] = array('newName' => 'gender_id', 'groupName' => 'gender'); | |
1603 | $names['individual_prefix'] = array('newName' => 'prefix_id', 'groupName' => 'individual_prefix'); | |
1604 | $names['individual_suffix'] = array('newName' => 'suffix_id', 'groupName' => 'individual_suffix'); | |
aa62b355 | 1605 | $names['communication_style'] = array('newName' => 'communication_style_id', 'groupName' => 'communication_style'); |
6a488035 TO |
1606 | $names['addressee'] = array('newName' => 'addressee_id', 'groupName' => 'addressee'); |
1607 | $names['email_greeting'] = array('newName' => 'email_greeting_id', 'groupName' => 'email_greeting'); | |
1608 | $names['postal_greeting'] = array('newName' => 'postal_greeting_id', 'groupName' => 'postal_greeting'); | |
1609 | CRM_Core_OptionGroup::lookupValues($submitted, $names, TRUE); | |
1610 | ||
1611 | // fix custom fields so they're edible by createProfileContact() | |
1612 | static $treeCache = array(); | |
1613 | if (!array_key_exists($migrationInfo['main_details']['contact_type'], $treeCache)) { | |
1614 | $treeCache[$migrationInfo['main_details']['contact_type']] = CRM_Core_BAO_CustomGroup::getTree($migrationInfo['main_details']['contact_type'], | |
1615 | CRM_Core_DAO::$_nullObject, NULL, -1 | |
1616 | ); | |
1617 | } | |
1618 | $cgTree = &$treeCache[$migrationInfo['main_details']['contact_type']]; | |
1619 | ||
1620 | $cFields = array(); | |
1621 | foreach ($cgTree as $key => $group) { | |
1622 | if (!isset($group['fields'])) { | |
1623 | continue; | |
1624 | } | |
1625 | foreach ($group['fields'] as $fid => $field) { | |
1626 | $cFields[$fid]['attributes'] = $field; | |
1627 | } | |
1628 | } | |
1629 | ||
1630 | if (!isset($submitted)) { | |
1631 | $submitted = array(); | |
1632 | } | |
1633 | foreach ($submitted as $key => $value) { | |
1634 | if (substr($key, 0, 7) == 'custom_') { | |
1635 | $fid = (int) substr($key, 7); | |
0e357872 C |
1636 | if (empty($cFields[$fid])) { |
1637 | continue; | |
1638 | } | |
6a488035 TO |
1639 | $htmlType = $cFields[$fid]['attributes']['html_type']; |
1640 | switch ($htmlType) { | |
1641 | case 'File': | |
1642 | $customFiles[] = $fid; | |
1643 | unset($submitted["custom_$fid"]); | |
1644 | break; | |
1645 | ||
1646 | case 'Select Country': | |
1647 | case 'Select State/Province': | |
8cee0c70 | 1648 | $submitted[$key] = CRM_Core_BAO_CustomField::displayValue($value, $fid); |
6a488035 TO |
1649 | break; |
1650 | ||
1651 | case 'CheckBox': | |
1652 | case 'AdvMulti-Select': | |
1653 | case 'Multi-Select': | |
1654 | case 'Multi-Select Country': | |
1655 | case 'Multi-Select State/Province': | |
1656 | // Merge values from both contacts for multivalue fields, CRM-4385 | |
1657 | // get the existing custom values from db. | |
1658 | $customParams = array('entityID' => $mainId, $key => TRUE); | |
1659 | $customfieldValues = CRM_Core_BAO_CustomValueTable::getValues($customParams); | |
a7488080 | 1660 | if (!empty($customfieldValues[$key])) { |
6a488035 TO |
1661 | $existingValue = explode(CRM_Core_DAO::VALUE_SEPARATOR, $customfieldValues[$key]); |
1662 | if (is_array($existingValue) && !empty($existingValue)) { | |
1663 | $mergeValue = $submmtedCustomValue = array(); | |
1664 | if ($value) { | |
1665 | $submmtedCustomValue = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value); | |
1666 | } | |
1667 | ||
1668 | //hack to remove null and duplicate values from array. | |
1669 | foreach (array_merge($submmtedCustomValue, $existingValue) as $k => $v) { | |
1670 | if ($v != '' && !in_array($v, $mergeValue)) { | |
1671 | $mergeValue[] = $v; | |
1672 | } | |
1673 | } | |
1674 | ||
1675 | //keep state and country as array format. | |
1676 | //for checkbox and m-select format w/ VALUE_SEPARATOR | |
1677 | if (in_array($htmlType, array( | |
353ffa53 TO |
1678 | 'CheckBox', |
1679 | 'Multi-Select', | |
c301f76e | 1680 | 'AdvMulti-Select', |
353ffa53 | 1681 | ))) { |
6a488035 | 1682 | $submitted[$key] = CRM_Core_DAO::VALUE_SEPARATOR . implode(CRM_Core_DAO::VALUE_SEPARATOR, |
353ffa53 TO |
1683 | $mergeValue |
1684 | ) . CRM_Core_DAO::VALUE_SEPARATOR; | |
6a488035 TO |
1685 | } |
1686 | else { | |
1687 | $submitted[$key] = $mergeValue; | |
1688 | } | |
1689 | } | |
1690 | } | |
1691 | elseif (in_array($htmlType, array( | |
353ffa53 | 1692 | 'Multi-Select Country', |
c301f76e | 1693 | 'Multi-Select State/Province', |
353ffa53 | 1694 | ))) { |
6a488035 TO |
1695 | //we require submitted values should be in array format |
1696 | if ($value) { | |
1697 | $mergeValueArray = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value); | |
1698 | //hack to remove null values from array. | |
1699 | $mergeValue = array(); | |
1700 | foreach ($mergeValueArray as $k => $v) { | |
1701 | if ($v != '') { | |
1702 | $mergeValue[] = $v; | |
1703 | } | |
1704 | } | |
1705 | $submitted[$key] = $mergeValue; | |
1706 | } | |
1707 | } | |
1708 | break; | |
1709 | ||
1710 | default: | |
1711 | break; | |
1712 | } | |
1713 | } | |
1714 | } | |
1715 | ||
1716 | // **** Do file custom fields related migrations | |
1717 | // FIXME: move this someplace else (one of the BAOs) after discussing | |
b3fdbf3d | 1718 | // where to, and whether CRM_Core_BAO_File::deleteFileReferences() shouldn't actually, |
6a488035 TO |
1719 | // like, delete a file... |
1720 | ||
1721 | if (!isset($customFiles)) { | |
1722 | $customFiles = array(); | |
1723 | } | |
1724 | foreach ($customFiles as $customId) { | |
1725 | list($tableName, $columnName, $groupID) = CRM_Core_BAO_CustomField::getTableColumnGroup($customId); | |
1726 | ||
1727 | // get the contact_id -> file_id mapping | |
1728 | $fileIds = array(); | |
1729 | $sql = "SELECT entity_id, {$columnName} AS file_id FROM {$tableName} WHERE entity_id IN ({$mainId}, {$otherId})"; | |
9d2678f4 | 1730 | $dao = CRM_Core_DAO::executeQuery($sql); |
6a488035 TO |
1731 | while ($dao->fetch()) { |
1732 | $fileIds[$dao->entity_id] = $dao->file_id; | |
1733 | } | |
1734 | $dao->free(); | |
1735 | ||
1736 | // delete the main contact's file | |
1737 | if (!empty($fileIds[$mainId])) { | |
b3fdbf3d | 1738 | CRM_Core_BAO_File::deleteFileReferences($fileIds[$mainId], $mainId, $customId); |
6a488035 TO |
1739 | } |
1740 | ||
1741 | // move the other contact's file to main contact | |
1742 | //NYSS need to INSERT or UPDATE depending on whether main contact has an existing record | |
481a74f4 | 1743 | if (CRM_Core_DAO::singleValueQuery("SELECT id FROM {$tableName} WHERE entity_id = {$mainId}")) { |
d58a19a1 | 1744 | $sql = "UPDATE {$tableName} SET {$columnName} = {$fileIds[$otherId]} WHERE entity_id = {$mainId}"; |
6a488035 TO |
1745 | } |
1746 | else { | |
1747 | $sql = "INSERT INTO {$tableName} ( entity_id, {$columnName} ) VALUES ( {$mainId}, {$fileIds[$otherId]} )"; | |
1748 | } | |
9d2678f4 | 1749 | CRM_Core_DAO::executeQuery($sql); |
6a488035 | 1750 | |
481a74f4 | 1751 | if (CRM_Core_DAO::singleValueQuery(" |
6a488035 TO |
1752 | SELECT id |
1753 | FROM civicrm_entity_file | |
353ffa53 TO |
1754 | WHERE entity_table = '{$tableName}' AND file_id = {$fileIds[$otherId]}") |
1755 | ) { | |
6a488035 TO |
1756 | $sql = " |
1757 | UPDATE civicrm_entity_file | |
1758 | SET entity_id = {$mainId} | |
1759 | WHERE entity_table = '{$tableName}' AND file_id = {$fileIds[$otherId]}"; | |
1760 | } | |
1761 | else { | |
1762 | $sql = " | |
1763 | INSERT INTO civicrm_entity_file ( entity_table, entity_id, file_id ) | |
1764 | VALUES ( '{$tableName}', {$mainId}, {$fileIds[$otherId]} )"; | |
1765 | } | |
9d2678f4 | 1766 | CRM_Core_DAO::executeQuery($sql); |
6a488035 TO |
1767 | } |
1768 | ||
1769 | // move view only custom fields CRM-5362 | |
1770 | $viewOnlyCustomFields = array(); | |
1771 | foreach ($submitted as $key => $value) { | |
1772 | $fid = (int) substr($key, 7); | |
8cc574cf | 1773 | if (array_key_exists($fid, $cFields) && !empty($cFields[$fid]['attributes']['is_view'])) { |
6a488035 TO |
1774 | $viewOnlyCustomFields[$key] = $value; |
1775 | } | |
1776 | } | |
1777 | ||
1778 | // special case to set values for view only, CRM-5362 | |
1779 | if (!empty($viewOnlyCustomFields)) { | |
1780 | $viewOnlyCustomFields['entityID'] = $mainId; | |
1781 | CRM_Core_BAO_CustomValueTable::setValues($viewOnlyCustomFields); | |
1782 | } | |
1783 | ||
1784 | // **** Delete other contact & update prev-next caching | |
1785 | $otherParams = array( | |
1786 | 'contact_id' => $otherId, | |
1787 | 'id' => $otherId, | |
1788 | 'version' => 3, | |
1789 | ); | |
1790 | if (CRM_Core_Permission::check('merge duplicate contacts') && | |
1791 | CRM_Core_Permission::check('delete contacts') | |
1792 | ) { | |
1793 | // if ext id is submitted then set it null for contact to be deleted | |
a7488080 | 1794 | if (!empty($submitted['external_identifier'])) { |
6a488035 TO |
1795 | $query = "UPDATE civicrm_contact SET external_identifier = null WHERE id = {$otherId}"; |
1796 | CRM_Core_DAO::executeQuery($query); | |
1797 | } | |
1798 | ||
1799 | civicrm_api('contact', 'delete', $otherParams); | |
1800 | CRM_Core_BAO_PrevNextCache::deleteItem($otherId); | |
1801 | } | |
1802 | // FIXME: else part | |
1803 | /* else { */ | |
1804 | ||
1805 | /* CRM_Core_Session::setStatus( ts('Do not have sufficient permission to delete duplicate contact.') ); */ | |
1806 | ||
1807 | /* } */ | |
1808 | ||
4d5f18cc | 1809 | // CRM-15681 merge sub_types |
1810 | if ($other_sub_types = CRM_Utils_array::value('contact_sub_type', $migrationInfo['other_details'])) { | |
1811 | if ($main_sub_types = CRM_Utils_array::value('contact_sub_type', $migrationInfo['main_details'])) { | |
481a74f4 | 1812 | $submitted['contact_sub_type'] = array_unique(array_merge($main_sub_types, $other_sub_types)); |
0db6c3e1 TO |
1813 | } |
1814 | else { | |
4d5f18cc | 1815 | $submitted['contact_sub_type'] = $other_sub_types; |
1816 | } | |
1817 | } | |
1818 | ||
6a488035 TO |
1819 | // **** Update contact related info for the main contact |
1820 | if (!empty($submitted)) { | |
1821 | $submitted['contact_id'] = $mainId; | |
1822 | ||
1823 | //update current employer field | |
1824 | if ($currentEmloyerId = CRM_Utils_Array::value('current_employer_id', $submitted)) { | |
1825 | if (!CRM_Utils_System::isNull($currentEmloyerId)) { | |
1826 | $submitted['current_employer'] = $submitted['current_employer_id']; | |
0db6c3e1 TO |
1827 | } |
1828 | else { | |
6a488035 TO |
1829 | $submitted['current_employer'] = ''; |
1830 | } | |
1831 | unset($submitted['current_employer_id']); | |
1832 | } | |
1833 | ||
00f3da2e | 1834 | //CRM-14312 include prefix/suffix from mainId if not overridden for proper construction of display/sort name |
481a74f4 | 1835 | if (!isset($submitted['prefix_id']) && !empty($migrationInfo['main_details']['prefix_id'])) { |
00f3da2e BS |
1836 | $submitted['prefix_id'] = $migrationInfo['main_details']['prefix_id']; |
1837 | } | |
481a74f4 | 1838 | if (!isset($submitted['suffix_id']) && !empty($migrationInfo['main_details']['suffix_id'])) { |
00f3da2e BS |
1839 | $submitted['suffix_id'] = $migrationInfo['main_details']['suffix_id']; |
1840 | } | |
1841 | ||
6a488035 TO |
1842 | CRM_Contact_BAO_Contact::createProfileContact($submitted, CRM_Core_DAO::$_nullArray, $mainId); |
1843 | unset($submitted); | |
1844 | } | |
1845 | ||
61bc2c0f CW |
1846 | CRM_Utils_Hook::post('merge', 'Contact', $mainId, CRM_Core_DAO::$_nullObject); |
1847 | ||
6a488035 TO |
1848 | return TRUE; |
1849 | } | |
16254ae1 ARW |
1850 | |
1851 | /** | |
a6c01b45 | 1852 | * @return array |
16b10e64 | 1853 | * Array of field names which will be compared, so everything except ID. |
16254ae1 | 1854 | */ |
00be9182 | 1855 | public static function getContactFields() { |
16254ae1 | 1856 | $contactFields = CRM_Contact_DAO_Contact::fields(); |
353ffa53 TO |
1857 | $invalidFields = array( |
1858 | 'api_key', | |
1859 | 'contact_is_deleted', | |
1860 | 'created_date', | |
1861 | 'display_name', | |
1862 | 'hash', | |
1863 | 'id', | |
1864 | 'modified_date', | |
1865 | 'primary_contact_id', | |
1866 | 'sort_name', | |
c301f76e | 1867 | 'user_unique_id', |
353ffa53 | 1868 | ); |
bdd7870e RN |
1869 | foreach ($contactFields as $field => $value) { |
1870 | if (in_array($field, $invalidFields)) { | |
1871 | unset($contactFields[$field]); | |
1872 | } | |
1873 | } | |
16254ae1 ARW |
1874 | return array_keys($contactFields); |
1875 | } | |
ada104d5 AW |
1876 | |
1877 | /** | |
1878 | * Added for CRM-12695 | |
c301f76e | 1879 | * Based on the contactID provided |
ada104d5 AW |
1880 | * add/update membership(s) to related contacts |
1881 | * | |
c301f76e | 1882 | * @param int $contactID |
ada104d5 | 1883 | */ |
00be9182 | 1884 | public static function addMembershipToRealtedContacts($contactID) { |
ada104d5 AW |
1885 | $dao = new CRM_Member_DAO_Membership(); |
1886 | $dao->contact_id = $contactID; | |
1887 | $dao->is_test = 0; | |
1888 | $dao->find(); | |
1889 | ||
1890 | //checks membership of contact itself | |
1891 | while ($dao->fetch()) { | |
1892 | $relationshipTypeId = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $dao->membership_type_id, 'relationship_type_id', 'id'); | |
1893 | if ($relationshipTypeId) { | |
1894 | $membershipParams = array( | |
1895 | 'id' => $dao->id, | |
1896 | 'contact_id' => $dao->contact_id, | |
1897 | 'membership_type_id' => $dao->membership_type_id, | |
1898 | 'join_date' => CRM_Utils_Date::isoToMysql($dao->join_date), | |
1899 | 'start_date' => CRM_Utils_Date::isoToMysql($dao->start_date), | |
1900 | 'end_date' => CRM_Utils_Date::isoToMysql($dao->end_date), | |
1901 | 'source' => $dao->source, | |
21dfd5f5 | 1902 | 'status_id' => $dao->status_id, |
ada104d5 AW |
1903 | ); |
1904 | // create/update membership(s) for related contact(s) | |
1905 | CRM_Member_BAO_Membership::createRelatedMemberships($membershipParams, $dao); | |
1906 | } // end of if relationshipTypeId | |
1907 | } | |
1908 | } | |
96025800 | 1909 | |
3ae0ae3d | 1910 | /** |
1911 | * Add custom tables that extend contacts to the list of contact references. | |
1912 | * | |
1913 | * CRM_Core_BAO_CustomGroup::getAllCustomGroupsByBaseEntity seems like a safe-ish | |
1914 | * function to be sure all are retrieved & we don't miss subtypes or inactive or multiples | |
1915 | * - the down side is it is not cached. | |
1916 | * | |
1917 | * Further changes should be include tests in the CRM_Core_MergerTest class | |
1918 | * to ensure that disabled, subtype, multiple etc groups are still captured. | |
1919 | * | |
1920 | * @param array $cidRefs | |
1921 | */ | |
1922 | public static function addCustomTablesExtendingContactsToCidRefs(&$cidRefs) { | |
1923 | $customValueTables = CRM_Core_BAO_CustomGroup::getAllCustomGroupsByBaseEntity('Contact'); | |
1924 | $customValueTables->find(); | |
1925 | while ($customValueTables->fetch()) { | |
1926 | $cidRefs[$customValueTables->table_name] = array('entity_id'); | |
1927 | } | |
1928 | } | |
1929 | ||
6a488035 | 1930 | } |