3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
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)
45 var $contactIds = array();
48 * Params to dedupe against (queries against the whole contact set otherwise)
50 var $params = array();
53 * Return the SQL query for the given rule - either for finding matching
54 * pairs of contacts, or for matching against the $params variable (if set).
56 * @return string SQL query performing the search
60 (!array_key_exists($this->rule_table
, $this->params
) ||
61 !array_key_exists($this->rule_field
, $this->params
[$this->rule_table
])
64 // if params is present and doesn't have an entry for a field, don't construct the clause.
68 // we need to initialise WHERE, ON and USING here, as some table types
69 // extend them; $where is an array of required conditions, $on and
70 // $using are arrays of required field matchings (for substring and
71 // full matches, respectively)
73 $on = array("SUBSTR(t1.{$this->rule_field}, 1, {$this->rule_length}) = SUBSTR(t2.{$this->rule_field}, 1, {$this->rule_length})");
74 $using = array($this->rule_field
);
76 switch ($this->rule_table
) {
77 case 'civicrm_contact':
79 //we should restrict by contact type in the first step
80 $sql = "SELECT contact_type FROM civicrm_dedupe_rule_group WHERE id = {$this->dedupe_rule_group_id};";
81 $ct = CRM_Core_DAO
::singleValueQuery($sql);
83 $where[] = "t1.contact_type = '{$ct}'";
86 $where[] = "t1.contact_type = '{$ct}'";
87 $where[] = "t2.contact_type = '{$ct}'";
91 case 'civicrm_address':
93 $on[] = 't1.location_type_id = t2.location_type_id';
94 $using[] = 'location_type_id';
95 if ($this->params
['civicrm_address']['location_type_id']) {
96 $locTypeId = CRM_Utils_Type
::escape($this->params
['civicrm_address']['location_type_id'], 'Integer', FALSE);
98 $where[] = "t1.location_type_id = $locTypeId";
103 case 'civicrm_email':
105 case 'civicrm_openid':
106 case 'civicrm_phone':
113 $where[] = "t1.entity_table = 'civicrm_contact'";
116 $where[] = "t1.entity_table = 'civicrm_contact'";
117 $where[] = "t2.entity_table = 'civicrm_contact'";
122 // custom data tables
123 if (preg_match('/^civicrm_value_/', $this->rule_table
) ||
preg_match('/^custom_value_/', $this->rule_table
)) {
127 CRM_Core_Error
::fatal("Unsupported rule_table for civicrm_dedupe_rule.id of {$this->id}");
132 // build SELECT based on the field names containing contact ids
133 // if there are params provided, id1 should be 0
135 $select = "t1.$id id1, {$this->rule_weight} weight";
138 $select = "t1.$id id1, t2.$id id2, {$this->rule_weight} weight";
141 // build FROM (and WHERE, if it's a parametrised search)
142 // based on whether the rule is about substrings or not
144 $from = "{$this->rule_table} t1";
146 if (isset($this->params
[$this->rule_table
][$this->rule_field
])) {
147 $str = CRM_Utils_Type
::escape($this->params
[$this->rule_table
][$this->rule_field
], 'String');
149 if ($this->rule_length
) {
150 $where[] = "SUBSTR(t1.{$this->rule_field}, 1, {$this->rule_length}) = SUBSTR('$str', 1, {$this->rule_length})";
151 $where[] = "t1.{$this->rule_field} IS NOT NULL";
154 $where[] = "t1.{$this->rule_field} = '$str'";
158 if ($this->rule_length
) {
159 $from = "{$this->rule_table} t1 JOIN {$this->rule_table} t2 ON (" . implode(' AND ', $on) . ")";
162 $from = "{$this->rule_table} t1 JOIN {$this->rule_table} t2 USING (" . implode(', ', $using) . ")";
166 // finish building WHERE, also limit the results if requested
167 if (!$this->params
) {
168 $where[] = "t1.$id < t2.$id";
169 $where[] = "t1.{$this->rule_field} IS NOT NULL";
171 if ($this->contactIds
) {
173 foreach ($this->contactIds
as $cid) {
174 $cids[] = CRM_Utils_Type
::escape($cid, 'Integer');
176 if (count($cids) == 1) {
177 $where[] = "(t1.$id = {$cids[0]} OR t2.$id = {$cids[0]})";
180 $where[] = "(t1.$id IN (" . implode(',', $cids) . ") OR t2.$id IN (" . implode(',', $cids) . "))";
184 return "SELECT $select FROM $from WHERE " . implode(' AND ', $where);
188 * To find fields related to a rule group.
190 * @param array contains the rule group property to identify rule group
192 * @return rule fields array associated to rule group
195 static function dedupeRuleFields($params) {
196 $rgBao = new CRM_Dedupe_BAO_RuleGroup();
197 $rgBao->used
= $params['used'];
198 $rgBao->contact_type
= $params['contact_type'];
201 $ruleBao = new CRM_Dedupe_BAO_Rule();
202 $ruleBao->dedupe_rule_group_id
= $rgBao->id
;
204 $ruleFields = array();
205 while ($ruleBao->fetch()) {
206 $ruleFields[] = $ruleBao->rule_field
;
217 static function validateContacts($cid, $oid) {
218 if (!$cid ||
!$oid) {
221 $exception = new CRM_Dedupe_DAO_Exception();
222 $exception->contact_id1
= $cid;
223 $exception->contact_id2
= $oid;
224 //make sure contact2 > contact1.
226 $exception->contact_id1
= $oid;
227 $exception->contact_id2
= $cid;
230 return $exception->find(TRUE) ?
FALSE : TRUE;