3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
21 * The CiviCRM duplicate discovery engine is based on an
22 * algorithm designed by David Strauss <david@fourkitchens.com>.
24 class CRM_Dedupe_BAO_Rule
extends CRM_Dedupe_DAO_Rule
{
27 * Ids of the contacts to limit the SQL queries (whole-database queries otherwise)
30 public $contactIds = [];
33 * Params to dedupe against (queries against the whole contact set otherwise)
39 * Return the SQL query for the given rule - either for finding matching
40 * pairs of contacts, or for matching against the $params variable (if set).
43 * SQL query performing the search
45 * @throws \CRM_Core_Exception
46 * @throws \CiviCRM_API3_Exception
48 public function sql() {
50 (!array_key_exists($this->rule_table
, $this->params
) ||
51 !array_key_exists($this->rule_field
, $this->params
[$this->rule_table
])
54 // if params is present and doesn't have an entry for a field, don't construct the clause.
58 // we need to initialise WHERE, ON and USING here, as some table types
59 // extend them; $where is an array of required conditions, $on and
60 // $using are arrays of required field matchings (for substring and
61 // full matches, respectively)
63 $on = ["SUBSTR(t1.{$this->rule_field}, 1, {$this->rule_length}) = SUBSTR(t2.{$this->rule_field}, 1, {$this->rule_length})"];
66 "t1.{$this->rule_field} IS NOT NULL",
67 "t2.{$this->rule_field} IS NOT NULL",
68 "t1.{$this->rule_field} = t2.{$this->rule_field}",
70 if ($this->getFieldType($this->rule_field
) === CRM_Utils_Type
::T_DATE
) {
71 $innerJoinClauses[] = "t1.{$this->rule_field} > '1000-01-01'";
72 $innerJoinClauses[] = "t2.{$this->rule_field} > '1000-01-01'";
75 $innerJoinClauses[] = "t1.{$this->rule_field} <> ''";
76 $innerJoinClauses[] = "t2.{$this->rule_field} <> ''";
79 switch ($this->rule_table
) {
80 case 'civicrm_contact':
82 //we should restrict by contact type in the first step
83 $sql = "SELECT contact_type FROM civicrm_dedupe_rule_group WHERE id = {$this->dedupe_rule_group_id};";
84 $ct = CRM_Core_DAO
::singleValueQuery($sql);
86 $where[] = "t1.contact_type = '{$ct}'";
89 $where[] = "t1.contact_type = '{$ct}'";
90 $where[] = "t2.contact_type = '{$ct}'";
94 case 'civicrm_address':
97 case 'civicrm_openid':
105 $where[] = "t1.entity_table = 'civicrm_contact'";
108 $where[] = "t1.entity_table = 'civicrm_contact'";
109 $where[] = "t2.entity_table = 'civicrm_contact'";
114 // custom data tables
115 if (preg_match('/^civicrm_value_/', $this->rule_table
) ||
preg_match('/^custom_value_/', $this->rule_table
)) {
119 throw new CRM_Core_Exception("Unsupported rule_table for civicrm_dedupe_rule.id of {$this->id}");
124 // build SELECT based on the field names containing contact ids
125 // if there are params provided, id1 should be 0
127 $select = "t1.$id id1, {$this->rule_weight} weight";
128 $subSelect = 'id1, weight';
131 $select = "t1.$id id1, t2.$id id2, {$this->rule_weight} weight";
132 $subSelect = 'id1, id2, weight';
135 // build FROM (and WHERE, if it's a parametrised search)
136 // based on whether the rule is about substrings or not
138 $from = "{$this->rule_table} t1";
140 if (isset($this->params
[$this->rule_table
][$this->rule_field
])) {
141 $str = CRM_Utils_Type
::escape($this->params
[$this->rule_table
][$this->rule_field
], 'String');
143 if ($this->rule_length
) {
144 $where[] = "SUBSTR(t1.{$this->rule_field}, 1, {$this->rule_length}) = SUBSTR('$str', 1, {$this->rule_length})";
145 $where[] = "t1.{$this->rule_field} IS NOT NULL";
148 $where[] = "t1.{$this->rule_field} = '$str'";
152 if ($this->rule_length
) {
153 $from = "{$this->rule_table} t1 JOIN {$this->rule_table} t2 ON (" . implode(' AND ', $on) . ")";
156 $from = "{$this->rule_table} t1 INNER JOIN {$this->rule_table} t2 ON (" . implode(' AND ', $innerJoinClauses) . ")";
160 // finish building WHERE, also limit the results if requested
161 if (!$this->params
) {
162 $where[] = "t1.$id < t2.$id";
164 $query = "SELECT $select FROM $from WHERE " . implode(' AND ', $where);
165 if ($this->contactIds
) {
167 foreach ($this->contactIds
as $cid) {
168 $cids[] = CRM_Utils_Type
::escape($cid, 'Integer');
170 if (count($cids) == 1) {
171 $query .= " AND (t1.$id = {$cids[0]}) UNION $query AND t2.$id = {$cids[0]}";
174 $query .= " AND t1.$id IN (" . implode(',', $cids) . ")
175 UNION $query AND t2.$id IN (" . implode(',', $cids) . ")";
177 // The `weight` is ambiguous in the context of the union; put the whole
178 // thing in a subquery.
179 $query = "SELECT $subSelect FROM ($query) subunion";
186 * find fields related to a rule group.
188 * @param array $params contains the rule group property to identify rule group
191 * rule fields array associated to rule group
193 public static function dedupeRuleFields($params) {
194 $rgBao = new CRM_Dedupe_BAO_RuleGroup();
195 $rgBao->used
= $params['used'];
196 $rgBao->contact_type
= $params['contact_type'];
199 $ruleBao = new CRM_Dedupe_BAO_Rule();
200 $ruleBao->dedupe_rule_group_id
= $rgBao->id
;
203 while ($ruleBao->fetch()) {
204 $field_name = $ruleBao->rule_field
;
205 if ($field_name == 'phone_numeric') {
206 $field_name = 'phone';
208 $ruleFields[] = $field_name;
219 public static function validateContacts($cid, $oid) {
220 if (!$cid ||
!$oid) {
223 $exception = new CRM_Dedupe_DAO_Exception();
224 $exception->contact_id1
= $cid;
225 $exception->contact_id2
= $oid;
226 //make sure contact2 > contact1.
228 $exception->contact_id1
= $oid;
229 $exception->contact_id2
= $cid;
232 return !$exception->find(TRUE);
236 * Get the specification for the given field.
238 * @param string $fieldName
241 * @throws \CiviCRM_API3_Exception
243 public function getFieldType($fieldName) {
244 $entity = CRM_Core_DAO_AllCoreTables
::getBriefName(CRM_Core_DAO_AllCoreTables
::getClassForTable($this->rule_table
));
246 // This means we have stored a custom field rather than an entity name in rule_table, figure out the entity.
247 $entity = civicrm_api3('CustomGroup', 'getvalue', ['table_name' => $this->rule_table
, 'return' => 'extends']);
248 if (in_array($entity, ['Individual', 'Household', 'Organization'])) {
251 $fieldName = 'custom_' . civicrm_api3('CustomField', 'getvalue', ['column_name' => $fieldName, 'return' => 'id']);
253 $fields = civicrm_api3($entity, 'getfields', ['action' => 'create'])['values'];
254 return $fields[$fieldName]['type'];