3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License 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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2019
37 * The CiviCRM duplicate discovery engine is based on an
38 * algorithm designed by David Strauss <david@fourkitchens.com>.
40 class CRM_Dedupe_BAO_Rule
extends CRM_Dedupe_DAO_Rule
{
43 * Ids of the contacts to limit the SQL queries (whole-database queries otherwise)
46 public $contactIds = [];
49 * Params to dedupe against (queries against the whole contact set otherwise)
55 * Return the SQL query for the given rule - either for finding matching
56 * pairs of contacts, or for matching against the $params variable (if set).
59 * SQL query performing the search
61 public function sql() {
63 (!array_key_exists($this->rule_table
, $this->params
) ||
64 !array_key_exists($this->rule_field
, $this->params
[$this->rule_table
])
67 // if params is present and doesn't have an entry for a field, don't construct the clause.
71 // we need to initialise WHERE, ON and USING here, as some table types
72 // extend them; $where is an array of required conditions, $on and
73 // $using are arrays of required field matchings (for substring and
74 // full matches, respectively)
76 $on = ["SUBSTR(t1.{$this->rule_field}, 1, {$this->rule_length}) = SUBSTR(t2.{$this->rule_field}, 1, {$this->rule_length})"];
77 $entity = CRM_Core_DAO_AllCoreTables
::getBriefName(CRM_Core_DAO_AllCoreTables
::getClassForTable($this->rule_table
));
78 $fields = civicrm_api3($entity, 'getfields', ['action' => 'create'])['values'];
81 "t1.{$this->rule_field} IS NOT NULL",
82 "t2.{$this->rule_field} IS NOT NULL",
83 "t1.{$this->rule_field} = t2.{$this->rule_field}",
85 if ($fields[$this->rule_field
]['type'] === CRM_Utils_Type
::T_DATE
) {
86 $innerJoinClauses[] = "t1.{$this->rule_field} > '1000-01-01'";
87 $innerJoinClauses[] = "t2.{$this->rule_field} > '1000-01-01'";
90 $innerJoinClauses[] = "t1.{$this->rule_field} <> ''";
91 $innerJoinClauses[] = "t2.{$this->rule_field} <> ''";
94 switch ($this->rule_table
) {
95 case 'civicrm_contact':
97 //we should restrict by contact type in the first step
98 $sql = "SELECT contact_type FROM civicrm_dedupe_rule_group WHERE id = {$this->dedupe_rule_group_id};";
99 $ct = CRM_Core_DAO
::singleValueQuery($sql);
101 $where[] = "t1.contact_type = '{$ct}'";
104 $where[] = "t1.contact_type = '{$ct}'";
105 $where[] = "t2.contact_type = '{$ct}'";
109 case 'civicrm_address':
111 $on[] = 't1.location_type_id = t2.location_type_id';
112 $innerJoinClauses[] = 't1.location_type_id = t2.location_type_id';
113 if (!empty($this->params
['civicrm_address']['location_type_id'])) {
114 $locTypeId = CRM_Utils_Type
::escape($this->params
['civicrm_address']['location_type_id'], 'Integer', FALSE);
116 $where[] = "t1.location_type_id = $locTypeId";
121 case 'civicrm_email':
123 case 'civicrm_openid':
124 case 'civicrm_phone':
131 $where[] = "t1.entity_table = 'civicrm_contact'";
134 $where[] = "t1.entity_table = 'civicrm_contact'";
135 $where[] = "t2.entity_table = 'civicrm_contact'";
140 // custom data tables
141 if (preg_match('/^civicrm_value_/', $this->rule_table
) ||
preg_match('/^custom_value_/', $this->rule_table
)) {
145 CRM_Core_Error
::fatal("Unsupported rule_table for civicrm_dedupe_rule.id of {$this->id}");
150 // build SELECT based on the field names containing contact ids
151 // if there are params provided, id1 should be 0
153 $select = "t1.$id id1, {$this->rule_weight} weight";
154 $subSelect = 'id1, weight';
157 $select = "t1.$id id1, t2.$id id2, {$this->rule_weight} weight";
158 $subSelect = 'id1, id2, weight';
161 // build FROM (and WHERE, if it's a parametrised search)
162 // based on whether the rule is about substrings or not
164 $from = "{$this->rule_table} t1";
166 if (isset($this->params
[$this->rule_table
][$this->rule_field
])) {
167 $str = CRM_Utils_Type
::escape($this->params
[$this->rule_table
][$this->rule_field
], 'String');
169 if ($this->rule_length
) {
170 $where[] = "SUBSTR(t1.{$this->rule_field}, 1, {$this->rule_length}) = SUBSTR('$str', 1, {$this->rule_length})";
171 $where[] = "t1.{$this->rule_field} IS NOT NULL";
174 $where[] = "t1.{$this->rule_field} = '$str'";
178 if ($this->rule_length
) {
179 $from = "{$this->rule_table} t1 JOIN {$this->rule_table} t2 ON (" . implode(' AND ', $on) . ")";
182 $from = "{$this->rule_table} t1 INNER JOIN {$this->rule_table} t2 ON (" . implode(' AND ', $innerJoinClauses) . ")";
186 // finish building WHERE, also limit the results if requested
187 if (!$this->params
) {
188 $where[] = "t1.$id < t2.$id";
190 $query = "SELECT $select FROM $from WHERE " . implode(' AND ', $where);
191 if ($this->contactIds
) {
193 foreach ($this->contactIds
as $cid) {
194 $cids[] = CRM_Utils_Type
::escape($cid, 'Integer');
196 if (count($cids) == 1) {
197 $query .= " AND (t1.$id = {$cids[0]}) UNION $query AND t2.$id = {$cids[0]}";
200 $query .= " AND t1.$id IN (" . implode(',', $cids) . ")
201 UNION $query AND t2.$id IN (" . implode(',', $cids) . ")";
203 // The `weight` is ambiguous in the context of the union; put the whole
204 // thing in a subquery.
205 $query = "SELECT $subSelect FROM ($query) subunion";
212 * find fields related to a rule group.
214 * @param array $params contains the rule group property to identify rule group
217 * rule fields array associated to rule group
219 public static function dedupeRuleFields($params) {
220 $rgBao = new CRM_Dedupe_BAO_RuleGroup();
221 $rgBao->used
= $params['used'];
222 $rgBao->contact_type
= $params['contact_type'];
225 $ruleBao = new CRM_Dedupe_BAO_Rule();
226 $ruleBao->dedupe_rule_group_id
= $rgBao->id
;
229 while ($ruleBao->fetch()) {
230 $ruleFields[] = $ruleBao->rule_field
;
241 public static function validateContacts($cid, $oid) {
242 if (!$cid ||
!$oid) {
245 $exception = new CRM_Dedupe_DAO_Exception();
246 $exception->contact_id1
= $cid;
247 $exception->contact_id2
= $oid;
248 //make sure contact2 > contact1.
250 $exception->contact_id1
= $oid;
251 $exception->contact_id2
= $cid;
254 return $exception->find(TRUE) ?
FALSE : TRUE;