Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
06b69b18 | 4 | | CiviCRM version 4.5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
06b69b18 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * | |
30 | * @package CRM | |
06b69b18 | 31 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | ||
36 | /** | |
37 | * The CiviCRM duplicate discovery engine is based on an | |
38 | * algorithm designed by David Strauss <david@fourkitchens.com>. | |
39 | */ | |
40 | class CRM_Dedupe_BAO_RuleGroup extends CRM_Dedupe_DAO_RuleGroup { | |
41 | ||
42 | /** | |
43 | * ids of the contacts to limit the SQL queries (whole-database queries otherwise) | |
44 | */ | |
45 | var $contactIds = array(); | |
46 | ||
47 | /** | |
48 | * params to dedupe against (queries against the whole contact set otherwise) | |
49 | */ | |
50 | var $params = array(); | |
51 | ||
52 | /** | |
53 | * if there are no rules in rule group | |
54 | */ | |
55 | var $noRules = FALSE; | |
56 | ||
57 | /** | |
58 | * Return a structure holding the supported tables, fields and their titles | |
59 | * | |
60 | * @param string $requestedType the requested contact type | |
61 | * | |
62 | * @return array a table-keyed array of field-keyed arrays holding supported fields' titles | |
63 | */ | |
64 | static function &supportedFields($requestedType) { | |
65 | static $fields = NULL; | |
66 | if (!$fields) { | |
67 | // this is needed, as we're piggy-backing importableFields() below | |
68 | $replacements = array( | |
69 | 'civicrm_country.name' => 'civicrm_address.country_id', | |
70 | 'civicrm_county.name' => 'civicrm_address.county_id', | |
71 | 'civicrm_state_province.name' => 'civicrm_address.state_province_id', | |
72 | 'gender.label' => 'civicrm_contact.gender_id', | |
73 | 'individual_prefix.label' => 'civicrm_contact.prefix_id', | |
74 | 'individual_suffix.label' => 'civicrm_contact.suffix_id', | |
75 | 'addressee.label' => 'civicrm_contact.addressee_id', | |
76 | 'email_greeting.label' => 'civicrm_contact.email_greeting_id', | |
77 | 'postal_greeting.label' => 'civicrm_contact.postal_greeting_id', | |
78 | ); | |
79 | // the table names we support in dedupe rules - a filter for importableFields() | |
80 | $supportedTables = array( | |
81 | 'civicrm_address', 'civicrm_contact', 'civicrm_email', | |
82 | 'civicrm_im', 'civicrm_note', 'civicrm_openid', 'civicrm_phone', | |
83 | ); | |
84 | ||
309a09df | 85 | foreach (array('Individual', 'Organization', 'Household') as $ctype) { |
6a488035 TO |
86 | // take the table.field pairs and their titles from importableFields() if the table is supported |
87 | foreach (CRM_Contact_BAO_Contact::importableFields($ctype) as $iField) { | |
88 | if (isset($iField['where'])) { | |
89 | $where = $iField['where']; | |
90 | if (isset($replacements[$where])) { | |
91 | $where = $replacements[$where]; | |
92 | } | |
93 | list($table, $field) = explode('.', $where); | |
94 | if (!in_array($table, $supportedTables)) { | |
95 | continue; | |
96 | } | |
97 | $fields[$ctype][$table][$field] = $iField['title']; | |
98 | } | |
99 | } | |
100 | // add custom data fields | |
101 | foreach (CRM_Core_BAO_CustomGroup::getTree($ctype, CRM_Core_DAO::$_nullObject, NULL, -1) as $key => $cg) { | |
102 | if (!is_int($key)) { | |
103 | continue; | |
104 | } | |
105 | foreach ($cg['fields'] as $cf) { | |
106 | $fields[$ctype][$cg['table_name']][$cf['column_name']] = $cf['label']; | |
107 | } | |
108 | } | |
109 | } | |
110 | } | |
1cf05c3e | 111 | CRM_Utils_Hook::dupeQuery(CRM_Core_DAO::$_nullObject, 'supportedFields', $fields); |
6a488035 TO |
112 | return $fields[$requestedType]; |
113 | } | |
114 | ||
115 | /** | |
116 | * Return the SQL query for dropping the temporary table. | |
117 | */ | |
118 | function tableDropQuery() { | |
119 | return 'DROP TEMPORARY TABLE IF EXISTS dedupe'; | |
120 | } | |
121 | ||
122 | /** | |
123 | * Return a set of SQL queries whose cummulative weights will mark matched | |
124 | * records for the RuleGroup::threasholdQuery() to retrieve. | |
125 | */ | |
126 | function tableQuery() { | |
127 | // make sure we've got a fetched dbrecord, not sure if this is enforced | |
128 | if (!$this->name == NULL || $this->is_reserved == NULL) { | |
129 | $this->find(TRUE); | |
130 | } | |
131 | ||
132 | // Reserved Rule Groups can optionally get special treatment by | |
133 | // implementing an optimization class and returning a query array. | |
134 | if ($this->is_reserved && | |
135 | CRM_Utils_File::isIncludable("CRM/Dedupe/BAO/QueryBuilder/{$this->name}.php") | |
136 | ) { | |
137 | include_once "CRM/Dedupe/BAO/QueryBuilder/{$this->name}.php"; | |
138 | $class = "CRM_Dedupe_BAO_QueryBuilder_{$this->name}"; | |
139 | $command = empty($this->params) ? 'internal' : 'record'; | |
140 | $queries = call_user_func(array($class, $command), $this); | |
141 | } | |
142 | else { | |
143 | // All other rule groups have queries generated by the member dedupe | |
144 | // rules defined in the administrative interface. | |
145 | ||
146 | // Find all rules contained by this script sorted by weight so that | |
147 | // their execution can be short circuited on RuleGroup::fillTable() | |
148 | $bao = new CRM_Dedupe_BAO_Rule(); | |
149 | $bao->dedupe_rule_group_id = $this->id; | |
150 | $bao->orderBy('rule_weight DESC'); | |
151 | $bao->find(); | |
152 | ||
153 | // Generate a SQL query for each rule in the rule group that is | |
154 | // tailored to respect the param and contactId options provided. | |
155 | $queries = array(); | |
156 | while ($bao->fetch()) { | |
157 | $bao->contactIds = $this->contactIds; | |
158 | $bao->params = $this->params; | |
159 | ||
160 | // Skipping empty rules? Empty rules shouldn't exist; why check? | |
161 | if ($query = $bao->sql()) { | |
162 | $queries["{$bao->rule_table}.{$bao->rule_field}.{$bao->rule_weight}"] = $query; | |
163 | } | |
164 | } | |
165 | } | |
166 | ||
167 | // if there are no rules in this rule group | |
168 | // add an empty query fulfilling the pattern | |
169 | if (!$queries) { | |
170 | $queries = array('SELECT 0 id1, 0 id2, 0 weight LIMIT 0'); | |
171 | $this->noRules = TRUE; | |
172 | } | |
173 | ||
174 | return $queries; | |
175 | } | |
176 | ||
177 | function fillTable() { | |
178 | // get the list of queries handy | |
179 | $tableQueries = $this->tableQuery(); | |
180 | ||
181 | if ($this->params && !$this->noRules) { | |
182 | $tempTableQuery = "CREATE TEMPORARY TABLE dedupe (id1 int, weight int, UNIQUE UI_id1 (id1)) ENGINE=MyISAM"; | |
183 | $insertClause = "INSERT INTO dedupe (id1, weight)"; | |
184 | $groupByClause = "GROUP BY id1"; | |
185 | $dupeCopyJoin = " JOIN dedupe_copy ON dedupe_copy.id1 = t1.column WHERE "; | |
186 | } | |
187 | else { | |
188 | $tempTableQuery = "CREATE TEMPORARY TABLE dedupe (id1 int, id2 int, weight int, UNIQUE UI_id1_id2 (id1, id2)) ENGINE=MyISAM"; | |
189 | $insertClause = "INSERT INTO dedupe (id1, id2, weight)"; | |
190 | $groupByClause = "GROUP BY id1, id2"; | |
191 | $dupeCopyJoin = " JOIN dedupe_copy ON dedupe_copy.id1 = t1.column AND dedupe_copy.id2 = t2.column WHERE "; | |
192 | } | |
193 | $patternColumn = '/t1.(\w+)/'; | |
194 | $exclWeightSum = array(); | |
195 | ||
196 | // create temp table | |
197 | $dao = new CRM_Core_DAO(); | |
198 | $dao->query($tempTableQuery); | |
199 | ||
200 | ||
201 | CRM_Utils_Hook::dupeQuery($this, 'table', $tableQueries); | |
202 | ||
203 | while (!empty($tableQueries)) { | |
204 | list($isInclusive, $isDie) = self::isQuerySetInclusive($tableQueries, $this->threshold, $exclWeightSum); | |
205 | ||
206 | if ($isInclusive) { | |
207 | // order queries by table count | |
208 | self::orderByTableCount($tableQueries); | |
209 | ||
210 | $weightSum = array_sum($exclWeightSum); | |
211 | $searchWithinDupes = !empty($exclWeightSum) ? 1 : 0; | |
212 | ||
213 | while (!empty($tableQueries)) { | |
214 | // extract the next query ( and weight ) to be executed | |
215 | $fieldWeight = array_keys($tableQueries); | |
216 | $fieldWeight = $fieldWeight[0]; | |
217 | $query = array_shift($tableQueries); | |
218 | ||
219 | if ($searchWithinDupes) { | |
220 | // get prepared to search within already found dupes if $searchWithinDupes flag is set | |
221 | $dao->query("DROP TEMPORARY TABLE IF EXISTS dedupe_copy"); | |
222 | $dao->query("CREATE TEMPORARY TABLE dedupe_copy SELECT * FROM dedupe WHERE weight >= {$weightSum}"); | |
223 | $dao->free(); | |
224 | ||
225 | preg_match($patternColumn, $query, $matches); | |
226 | $query = str_replace(' WHERE ', str_replace('column', $matches[1], $dupeCopyJoin), $query); | |
227 | } | |
228 | $searchWithinDupes = 1; | |
229 | ||
230 | // construct and execute the intermediate query | |
231 | $query = "{$insertClause} {$query} {$groupByClause} ON DUPLICATE KEY UPDATE weight = weight + VALUES(weight)"; | |
232 | $dao->query($query); | |
233 | ||
234 | // FIXME: we need to be more acurate with affected rows, especially for insert vs duplicate insert. | |
235 | // And that will help optimize further. | |
236 | $affectedRows = $dao->affectedRows(); | |
237 | $dao->free(); | |
238 | ||
239 | // In an inclusive situation, failure of any query means no further processing - | |
240 | if ($affectedRows == 0) { | |
241 | // reset to make sure no further execution is done. | |
242 | $tableQueries = array(); | |
243 | break; | |
244 | } | |
245 | $weightSum = substr($fieldWeight, strrpos($fieldWeight, '.') + 1) + $weightSum; | |
246 | } | |
247 | // An exclusive situation - | |
248 | } | |
249 | elseif (!$isDie) { | |
250 | // since queries are already sorted by weights, we can continue as is | |
251 | $fieldWeight = array_keys($tableQueries); | |
252 | $fieldWeight = $fieldWeight[0]; | |
253 | $query = array_shift($tableQueries); | |
254 | $query = "{$insertClause} {$query} {$groupByClause} ON DUPLICATE KEY UPDATE weight = weight + VALUES(weight)"; | |
255 | $dao->query($query); | |
256 | if ($dao->affectedRows() >= 1) { | |
257 | $exclWeightSum[] = substr($fieldWeight, strrpos($fieldWeight, '.') + 1); | |
258 | } | |
259 | $dao->free(); | |
260 | } | |
261 | else { | |
262 | // its a die situation | |
263 | break; | |
264 | } | |
265 | } | |
266 | } | |
267 | ||
268 | // Function to determine if a given query set contains inclusive or exclusive set of weights. | |
269 | // The function assumes that the query set is already ordered by weight in desc order. | |
e0ef6999 EM |
270 | /** |
271 | * @param $tableQueries | |
272 | * @param $threshold | |
273 | * @param array $exclWeightSum | |
274 | * | |
275 | * @return array | |
276 | */ | |
6a488035 TO |
277 | static function isQuerySetInclusive($tableQueries, $threshold, $exclWeightSum = array( |
278 | )) { | |
279 | $input = array(); | |
280 | foreach ($tableQueries as $key => $query) { | |
281 | $input[] = substr($key, strrpos($key, '.') + 1); | |
282 | } | |
283 | ||
284 | if (!empty($exclWeightSum)) { | |
285 | $input = array_merge($input, $exclWeightSum); | |
286 | rsort($input); | |
287 | } | |
288 | ||
289 | if (count($input) == 1) { | |
290 | return array(FALSE, $input[0] < $threshold); | |
291 | } | |
292 | ||
293 | $totalCombinations = 0; | |
294 | for ($i = 0; $i < count($input); $i++) { | |
295 | $combination = array($input[$i]); | |
296 | if (array_sum($combination) >= $threshold) { | |
297 | $totalCombinations++; | |
298 | continue; | |
299 | } | |
300 | for ($j = $i + 1; $j < count($input); $j++) { | |
301 | $combination[] = $input[$j]; | |
302 | if (array_sum($combination) >= $threshold) { | |
303 | $totalCombinations++; | |
304 | } | |
305 | } | |
306 | } | |
307 | return array($totalCombinations == 1, $totalCombinations <= 0); | |
308 | } | |
309 | ||
310 | // sort queries by number of records for the table associated with them | |
e0ef6999 EM |
311 | /** |
312 | * @param $tableQueries | |
313 | */ | |
6a488035 TO |
314 | static function orderByTableCount(&$tableQueries) { |
315 | static $tableCount = array(); | |
316 | ||
317 | $tempArray = array(); | |
318 | foreach ($tableQueries as $key => $query) { | |
319 | $table = explode(".", $key); | |
320 | $table = $table[0]; | |
321 | if (!array_key_exists($table, $tableCount)) { | |
322 | $query = "SELECT COUNT(*) FROM {$table}"; | |
323 | $tableCount[$table] = CRM_Core_DAO::singleValueQuery($query); | |
324 | } | |
325 | $tempArray[$key] = $tableCount[$table]; | |
326 | } | |
327 | ||
328 | asort($tempArray); | |
329 | foreach ($tempArray as $key => $count) { | |
330 | $tempArray[$key] = $tableQueries[$key]; | |
331 | } | |
332 | $tableQueries = $tempArray; | |
333 | } | |
334 | ||
335 | /** | |
336 | * Return the SQL query for getting only the interesting results out of the dedupe table. | |
337 | * | |
338 | * @$checkPermission boolean $params a flag to indicate if permission should be considered. | |
339 | * default is to always check permissioning but public pages for example might not want | |
340 | * permission to be checked for anonymous users. Refer CRM-6211. We might be beaking | |
341 | * Multi-Site dedupe for public pages. | |
342 | * | |
343 | */ | |
344 | function thresholdQuery($checkPermission = TRUE) { | |
345 | $this->_aclFrom = ''; | |
346 | // CRM-6603: anonymous dupechecks side-step ACLs | |
347 | $this->_aclWhere = ' AND is_deleted = 0 '; | |
348 | ||
349 | if ($this->params && !$this->noRules) { | |
350 | if ($checkPermission) { | |
351 | list($this->_aclFrom, $this->_aclWhere) = CRM_Contact_BAO_Contact_Permission::cacheClause('civicrm_contact'); | |
352 | $this->_aclWhere = $this->_aclWhere ? "AND {$this->_aclWhere}" : ''; | |
353 | } | |
354 | $query = "SELECT dedupe.id1 as id | |
355 | FROM dedupe JOIN civicrm_contact ON dedupe.id1 = civicrm_contact.id {$this->_aclFrom} | |
356 | WHERE contact_type = '{$this->contact_type}' {$this->_aclWhere} | |
357 | AND weight >= {$this->threshold}"; | |
358 | } | |
359 | else { | |
360 | $this->_aclWhere = ' AND c1.is_deleted = 0 AND c2.is_deleted = 0'; | |
361 | if ($checkPermission) { | |
362 | list($this->_aclFrom, $this->_aclWhere) = CRM_Contact_BAO_Contact_Permission::cacheClause(array('c1', 'c2')); | |
363 | $this->_aclWhere = $this->_aclWhere ? "AND {$this->_aclWhere}" : ''; | |
364 | } | |
365 | $query = "SELECT dedupe.id1, dedupe.id2, dedupe.weight | |
d4c8a770 | 366 | FROM dedupe JOIN civicrm_contact c1 ON dedupe.id1 = c1.id |
6a488035 TO |
367 | JOIN civicrm_contact c2 ON dedupe.id2 = c2.id {$this->_aclFrom} |
368 | LEFT JOIN civicrm_dedupe_exception exc ON dedupe.id1 = exc.contact_id1 AND dedupe.id2 = exc.contact_id2 | |
d4c8a770 | 369 | WHERE c1.contact_type = '{$this->contact_type}' AND |
6a488035 TO |
370 | c2.contact_type = '{$this->contact_type}' {$this->_aclWhere} |
371 | AND weight >= {$this->threshold} AND exc.contact_id1 IS NULL"; | |
372 | } | |
373 | ||
374 | CRM_Utils_Hook::dupeQuery($this, 'threshold', $query); | |
375 | return $query; | |
376 | } | |
377 | ||
378 | /** | |
379 | * To find fields related to a rule group. | |
380 | * | |
77b97be7 | 381 | * @param $params |
6a488035 | 382 | * |
77b97be7 EM |
383 | * @internal param \contains $array the rule group property to identify rule group |
384 | * | |
385 | * @return array (rule field => weight) array and threshold associated to rule group@access public | |
6a488035 | 386 | */ |
d4c8a770 | 387 | static function dedupeRuleFieldsWeight($params) { |
6a488035 | 388 | $rgBao = new CRM_Dedupe_BAO_RuleGroup(); |
6a488035 | 389 | $rgBao->contact_type = $params['contact_type']; |
03390e26 | 390 | if (CRM_Utils_Array::value('id', $params)) { |
391 | // accept an ID if provided | |
392 | $rgBao->id = $params['id']; | |
393 | } | |
394 | else { | |
395 | $rgBao->used = $params['used']; | |
396 | } | |
6a488035 TO |
397 | $rgBao->find(TRUE); |
398 | ||
399 | $ruleBao = new CRM_Dedupe_BAO_Rule(); | |
400 | $ruleBao->dedupe_rule_group_id = $rgBao->id; | |
401 | $ruleBao->find(); | |
402 | $ruleFields = array(); | |
403 | while ($ruleBao->fetch()) { | |
404 | $ruleFields[$ruleBao->rule_field] = $ruleBao->rule_weight; | |
405 | } | |
406 | ||
407 | return array($ruleFields, $rgBao->threshold); | |
408 | } | |
409 | ||
03390e26 | 410 | /** |
411 | * Get all of the combinations of fields that would work with a rule | |
412 | */ | |
413 | ||
414 | static function combos($rgFields, $threshold, &$combos, $running = array()) { | |
415 | foreach ($rgFields as $rgField => $weight) { | |
416 | unset($rgFields[$rgField]); | |
417 | $diff = $threshold - $weight; | |
418 | $runningnow = $running; | |
419 | $runningnow[] = $rgField; | |
420 | if ($diff > 0) { | |
421 | self::combos($rgFields, $diff, $combos, $runningnow); | |
422 | } | |
423 | else { | |
424 | $combos[] = $runningnow; | |
425 | } | |
426 | } | |
427 | } | |
428 | ||
6a488035 TO |
429 | /** |
430 | * Get an array of rule group id to rule group name | |
431 | * for all th groups for that contactType. If contactType | |
432 | * not specified, do it for all | |
433 | * | |
434 | * @param string $contactType Individual, Household or Organization | |
435 | * | |
436 | * @static | |
437 | * | |
438 | * @return array id => "nice name" of rule group | |
439 | */ | |
440 | static function getByType($contactType = NULL) { | |
441 | $dao = new CRM_Dedupe_DAO_RuleGroup(); | |
442 | ||
443 | if ($contactType) { | |
444 | $dao->contact_type = $contactType; | |
445 | } | |
446 | ||
447 | $dao->find(); | |
448 | $result = array(); | |
449 | while ($dao->fetch()) { | |
01a93ecd DL |
450 | $title = |
451 | !empty($dao->title) ? $dao->title : | |
452 | (!empty($dao->name) ? $dao->name : $dao->contact_type); | |
453 | ||
454 | $name = "$title - {$dao->used}"; | |
6a488035 TO |
455 | $result[$dao->id] = $name; |
456 | } | |
457 | return $result; | |
458 | } | |
459 | } | |
460 |