3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2020 |
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-2020
35 * This class generates form components for DedupeRules.
37 class CRM_Contact_Form_DedupeRules
extends CRM_Admin_Form
{
38 const RULES_COUNT
= 5;
39 protected $_contactType;
40 protected $_fields = [];
44 * Explicitly declare the entity api name.
46 public function getDefaultEntity() {
53 public function preProcess() {
54 // Ensure user has permission to be here
55 if (!CRM_Core_Permission
::check('administer dedupe rules')) {
56 CRM_Utils_System
::permissionDenied();
57 CRM_Utils_System
::civiExit();
59 $this->_options
= CRM_Core_SelectValues
::getDedupeRuleTypes();
60 $this->_rgid
= CRM_Utils_Request
::retrieve('id', 'Positive', $this, FALSE, 0);
62 // check if $contactType is valid
63 $contactTypes = civicrm_api3('Contact', 'getOptions', ['field' => "contact_type", 'context' => "validate"]);
64 $contactType = CRM_Utils_Request
::retrieve('contact_type', 'String', $this, FALSE, 0);
65 if (!empty($contactTypes['values'][$contactType])) {
66 $this->_contactType
= $contactType;
68 elseif (!empty($contactType)) {
69 throw new CRM_Core_Exception('Contact Type is Not valid');
72 $rgDao = new CRM_Dedupe_DAO_RuleGroup();
73 $rgDao->id
= $this->_rgid
;
76 $this->_defaults
['threshold'] = $rgDao->threshold
;
77 $this->_contactType
= $rgDao->contact_type
;
78 $this->_defaults
['used'] = $rgDao->used
;
79 $this->_defaults
['title'] = $rgDao->title
;
80 $this->_defaults
['name'] = $rgDao->name
;
81 $this->_defaults
['is_reserved'] = $rgDao->is_reserved
;
82 $this->assign('isReserved', $rgDao->is_reserved
);
83 $this->assign('ruleName', $rgDao->name
);
84 $ruleDao = new CRM_Dedupe_DAO_Rule();
85 $ruleDao->dedupe_rule_group_id
= $this->_rgid
;
88 while ($ruleDao->fetch()) {
89 $this->_defaults
["where_$count"] = "{$ruleDao->rule_table}.{$ruleDao->rule_field}";
90 $this->_defaults
["length_$count"] = $ruleDao->rule_length
;
91 $this->_defaults
["weight_$count"] = $ruleDao->rule_weight
;
95 $supported = CRM_Dedupe_BAO_RuleGroup
::supportedFields($this->_contactType
);
96 if (is_array($supported)) {
97 foreach ($supported as $table => $fields) {
98 foreach ($fields as $field => $title) {
99 $this->_fields
["$table.$field"] = $title;
103 asort($this->_fields
);
107 * Build the form object.
109 public function buildQuickForm() {
110 $this->addField('title', ['label' => ts('Rule Name')], TRUE);
111 $this->addRule('title', ts('A duplicate matching rule with this name already exists. Please select another name.'),
112 'objectExists', ['CRM_Dedupe_DAO_RuleGroup', $this->_rgid
, 'title']
115 $this->addField('used', ['label' => ts('Usage')], TRUE);
116 $reserved = $this->addField('is_reserved', ['label' => ts('Reserved?')]);
117 if (!empty($this->_defaults
['is_reserved'])) {
121 $attributes = ['class' => 'two'];
123 for ($count = 0; $count < self
::RULES_COUNT
; $count++
) {
124 $this->add('select', "where_$count", ts('Field'),
125 $this->_fields
, FALSE, ['class' => 'crm-select2', 'placeholder' => ts('Select Field')]
127 $this->addField("length_$count", ['entity' => 'Rule', 'name' => 'rule_length'] +
$attributes);
128 $this->addField("weight_$count", ['entity' => 'Rule', 'name' => 'rule_weight'] +
$attributes);
131 $this->addField('threshold', ['label' => ts("Weight Threshold to Consider Contacts 'Matching':")] +
$attributes);
133 $this->assign('contact_type', $this->_contactType
);
135 $this->addFormRule(['CRM_Contact_Form_DedupeRules', 'formRule'], $this);
137 parent
::buildQuickForm();
141 * Global validation rules for the form.
143 * @param array $fields
144 * Posted values of the form.
150 * list of errors to be posted back to the form
152 public static function formRule($fields, $files, $self) {
154 $fieldSelected = FALSE;
155 for ($count = 0; $count < self
::RULES_COUNT
; $count++
) {
156 if (!empty($fields["where_$count"]) ||
(isset($self->_defaults
['is_reserved']) && !empty($self->_defaults
["where_$count"]))) {
157 $fieldSelected = TRUE;
161 if (empty($fields['threshold'])) {
162 // CRM-20607 - Don't validate the threshold of hard-coded rules
163 if (!(CRM_Utils_Array
::value('is_reserved', $fields) &&
164 CRM_Utils_File
::isIncludable("CRM/Dedupe/BAO/QueryBuilder/{$self->_defaultValues['name']}.php"))) {
165 $errors['threshold'] = ts('Threshold weight cannot be empty or zero.');
169 if (!$fieldSelected) {
170 $errors['_qf_default'] = ts('Please select at least one field.');
173 return empty($errors) ?
TRUE : $errors;
177 * Set default values for the form. MobileProvider that in edit/view mode
178 * the default values are retrieved from the database
187 public function setDefaultValues() {
188 return $this->_defaults
;
192 * Process the form submission.
194 public function postProcess() {
195 $values = $this->exportValues();
197 //FIXME: Handle logic to replace is_default column by usage
198 // reset used column to General (since there can only
199 // be one 'Supervised' or 'Unsupervised' rule)
200 if ($values['used'] != 'General') {
202 UPDATE civicrm_dedupe_rule_group
204 WHERE contact_type = %1
207 1 => [$this->_contactType
, 'String'],
208 2 => [$values['used'], 'String'],
211 CRM_Core_DAO
::executeQuery($query, $queryParams);
214 $rgDao = new CRM_Dedupe_DAO_RuleGroup();
215 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
216 $rgDao->id
= $this->_rgid
;
219 $rgDao->title
= $values['title'];
220 $rgDao->is_reserved
= CRM_Utils_Array
::value('is_reserved', $values, FALSE);
221 $rgDao->used
= $values['used'];
222 $rgDao->contact_type
= $this->_contactType
;
223 $rgDao->threshold
= $values['threshold'];
226 // make sure name is set only during insert
227 if ($this->_action
& CRM_Core_Action
::ADD
) {
228 // generate name based on title
229 $rgDao->name
= CRM_Utils_String
::titleToVar($values['title']) . "_{$rgDao->id}";
233 // lets skip updating of fields for reserved dedupe group
234 if (CRM_Utils_Array
::value('is_reserved', $this->_defaults
)) {
235 CRM_Core_Session
::setStatus(ts("The rule '%1' has been saved.", [1 => $rgDao->title
]), ts('Saved'), 'success');
239 $ruleDao = new CRM_Dedupe_DAO_Rule();
240 $ruleDao->dedupe_rule_group_id
= $rgDao->id
;
245 $daoObj = new CRM_Core_DAO();
246 $database = $daoObj->database();
247 for ($count = 0; $count < self
::RULES_COUNT
; $count++
) {
248 if (empty($values["where_$count"])) {
251 list($table, $field) = explode('.', CRM_Utils_Array
::value("where_$count", $values));
252 $length = !empty($values["length_$count"]) ? CRM_Utils_Array
::value("length_$count", $values) : NULL;
253 $weight = $values["weight_$count"];
254 if ($table and $field) {
255 $ruleDao = new CRM_Dedupe_DAO_Rule();
256 $ruleDao->dedupe_rule_group_id
= $rgDao->id
;
257 $ruleDao->rule_table
= $table;
258 $ruleDao->rule_field
= $field;
259 $ruleDao->rule_length
= $length;
260 $ruleDao->rule_weight
= $weight;
263 if (!array_key_exists($table, $tables)) {
264 $tables[$table] = [];
266 $tables[$table][] = $field;
269 // CRM-6245: we must pass table/field/length triples to the createIndexes() call below
271 if (!isset($substrLenghts[$table])) {
272 $substrLenghts[$table] = [];
275 //CRM-13417 to avoid fatal error "Incorrect prefix key; the used key part isn't a string, the used length is longer than the key part, or the storage engine doesn't support unique prefix keys, 1089"
276 $schemaQuery = "SELECT * FROM INFORMATION_SCHEMA.COLUMNS
277 WHERE TABLE_SCHEMA = '{$database}' AND
278 TABLE_NAME = '{$table}' AND COLUMN_NAME = '{$field}';";
279 $dao = CRM_Core_DAO
::executeQuery($schemaQuery);
282 // set the length to null for all the fields where prefix length is not supported. eg. int,tinyint,date,enum etc dataTypes.
283 if ($dao->COLUMN_NAME
== $field && !in_array($dao->DATA_TYPE
, [
293 elseif ($dao->COLUMN_NAME
== $field && !empty($dao->CHARACTER_MAXIMUM_LENGTH
) && ($length > $dao->CHARACTER_MAXIMUM_LENGTH
)) {
294 //set the length to CHARACTER_MAXIMUM_LENGTH in case the length provided by the user is greater than the limit
295 $length = $dao->CHARACTER_MAXIMUM_LENGTH
;
298 $substrLenghts[$table][$field] = $length;
302 // also create an index for this dedupe rule
304 CRM_Utils_Hook
::dupeQuery($ruleDao, 'dedupeIndexes', $tables);
305 CRM_Core_BAO_SchemaHandler
::createIndexes($tables, 'dedupe_index', $substrLenghts);
307 //need to clear cache of deduped contacts
308 //based on the previous rule
309 $cacheKey = "merge {$this->_contactType}_{$this->_rgid}_%";
311 CRM_Core_BAO_PrevNextCache
::deleteItem(NULL, $cacheKey);
313 CRM_Core_Session
::setStatus(ts("The rule '%1' has been saved.", [1 => $rgDao->title
]), ts('Saved'), 'success');