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
19 * This class generates form components for DedupeRules.
21 class CRM_Contact_Form_DedupeRules
extends CRM_Admin_Form
{
22 const RULES_COUNT
= 5;
23 protected $_contactType;
24 protected $_fields = [];
28 * Explicitly declare the entity api name.
30 public function getDefaultEntity() {
37 public function preProcess() {
38 // Ensure user has permission to be here
39 if (!CRM_Core_Permission
::check('administer dedupe rules')) {
40 CRM_Utils_System
::permissionDenied();
41 CRM_Utils_System
::civiExit();
43 $this->_options
= CRM_Core_SelectValues
::getDedupeRuleTypes();
44 $this->_rgid
= CRM_Utils_Request
::retrieve('id', 'Positive', $this, FALSE, 0);
46 // check if $contactType is valid
47 $contactTypes = civicrm_api3('Contact', 'getOptions', ['field' => "contact_type", 'context' => "validate"]);
48 $contactType = CRM_Utils_Request
::retrieve('contact_type', 'String', $this, FALSE, 0);
49 if (!empty($contactTypes['values'][$contactType])) {
50 $this->_contactType
= $contactType;
52 elseif (!empty($contactType)) {
53 throw new CRM_Core_Exception('Contact Type is Not valid');
56 $rgDao = new CRM_Dedupe_DAO_RuleGroup();
57 $rgDao->id
= $this->_rgid
;
60 $this->_defaults
['threshold'] = $rgDao->threshold
;
61 $this->_contactType
= $rgDao->contact_type
;
62 $this->_defaults
['used'] = $rgDao->used
;
63 $this->_defaults
['title'] = $rgDao->title
;
64 $this->_defaults
['name'] = $rgDao->name
;
65 $this->_defaults
['is_reserved'] = $rgDao->is_reserved
;
66 $this->assign('isReserved', $rgDao->is_reserved
);
67 $this->assign('ruleName', $rgDao->name
);
68 $ruleDao = new CRM_Dedupe_DAO_Rule();
69 $ruleDao->dedupe_rule_group_id
= $this->_rgid
;
72 while ($ruleDao->fetch()) {
73 $this->_defaults
["where_$count"] = "{$ruleDao->rule_table}.{$ruleDao->rule_field}";
74 $this->_defaults
["length_$count"] = $ruleDao->rule_length
;
75 $this->_defaults
["weight_$count"] = $ruleDao->rule_weight
;
79 $supported = CRM_Dedupe_BAO_RuleGroup
::supportedFields($this->_contactType
);
80 if (is_array($supported)) {
81 foreach ($supported as $table => $fields) {
82 foreach ($fields as $field => $title) {
83 $this->_fields
["$table.$field"] = $title;
87 asort($this->_fields
);
91 * Build the form object.
93 public function buildQuickForm() {
94 $this->addField('title', ['label' => ts('Rule Name')], TRUE);
95 $this->addRule('title', ts('A duplicate matching rule with this name already exists. Please select another name.'),
96 'objectExists', ['CRM_Dedupe_DAO_RuleGroup', $this->_rgid
, 'title']
99 $this->addField('used', ['label' => ts('Usage')], TRUE);
100 $reserved = $this->addField('is_reserved', ['label' => ts('Reserved?')]);
101 if (!empty($this->_defaults
['is_reserved'])) {
105 $attributes = ['class' => 'two'];
107 for ($count = 0; $count < self
::RULES_COUNT
; $count++
) {
108 $this->add('select', "where_$count", ts('Field'),
109 $this->_fields
, FALSE, ['class' => 'crm-select2', 'placeholder' => ts('Select Field')]
111 $this->addField("length_$count", ['entity' => 'Rule', 'name' => 'rule_length'] +
$attributes);
112 $this->addField("weight_$count", ['entity' => 'Rule', 'name' => 'rule_weight'] +
$attributes);
115 $this->addField('threshold', ['label' => ts("Weight Threshold to Consider Contacts 'Matching':")] +
$attributes);
117 $this->assign('contact_type', $this->_contactType
);
119 $this->addFormRule(['CRM_Contact_Form_DedupeRules', 'formRule'], $this);
121 parent
::buildQuickForm();
125 * Global validation rules for the form.
127 * @param array $fields
128 * Posted values of the form.
134 * list of errors to be posted back to the form
136 public static function formRule($fields, $files, $self) {
138 $fieldSelected = FALSE;
139 for ($count = 0; $count < self
::RULES_COUNT
; $count++
) {
140 if (!empty($fields["where_$count"]) ||
(isset($self->_defaults
['is_reserved']) && !empty($self->_defaults
["where_$count"]))) {
141 $fieldSelected = TRUE;
145 if (empty($fields['threshold'])) {
146 // CRM-20607 - Don't validate the threshold of hard-coded rules
147 if (!(CRM_Utils_Array
::value('is_reserved', $fields) &&
148 CRM_Utils_File
::isIncludable("CRM/Dedupe/BAO/QueryBuilder/{$self->_defaultValues['name']}.php"))) {
149 $errors['threshold'] = ts('Threshold weight cannot be empty or zero.');
153 if (!$fieldSelected) {
154 $errors['_qf_default'] = ts('Please select at least one field.');
157 return empty($errors) ?
TRUE : $errors;
161 * Set default values for the form. MobileProvider that in edit/view mode
162 * the default values are retrieved from the database
171 public function setDefaultValues() {
172 return $this->_defaults
;
176 * Process the form submission.
178 public function postProcess() {
179 $values = $this->exportValues();
181 //FIXME: Handle logic to replace is_default column by usage
182 // reset used column to General (since there can only
183 // be one 'Supervised' or 'Unsupervised' rule)
184 if ($values['used'] != 'General') {
186 UPDATE civicrm_dedupe_rule_group
188 WHERE contact_type = %1
191 1 => [$this->_contactType
, 'String'],
192 2 => [$values['used'], 'String'],
195 CRM_Core_DAO
::executeQuery($query, $queryParams);
198 $rgDao = new CRM_Dedupe_DAO_RuleGroup();
199 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
200 $rgDao->id
= $this->_rgid
;
203 $rgDao->title
= $values['title'];
204 $rgDao->is_reserved
= CRM_Utils_Array
::value('is_reserved', $values, FALSE);
205 $rgDao->used
= $values['used'];
206 $rgDao->contact_type
= $this->_contactType
;
207 $rgDao->threshold
= $values['threshold'];
210 // make sure name is set only during insert
211 if ($this->_action
& CRM_Core_Action
::ADD
) {
212 // generate name based on title
213 $rgDao->name
= CRM_Utils_String
::titleToVar($values['title']) . "_{$rgDao->id}";
217 // lets skip updating of fields for reserved dedupe group
218 if (!empty($this->_defaults
['is_reserved'])) {
219 CRM_Core_Session
::setStatus(ts("The rule '%1' has been saved.", [1 => $rgDao->title
]), ts('Saved'), 'success');
223 $ruleDao = new CRM_Dedupe_DAO_Rule();
224 $ruleDao->dedupe_rule_group_id
= $rgDao->id
;
229 $daoObj = new CRM_Core_DAO();
230 $database = $daoObj->database();
231 for ($count = 0; $count < self
::RULES_COUNT
; $count++
) {
232 if (empty($values["where_$count"])) {
235 list($table, $field) = explode('.', CRM_Utils_Array
::value("where_$count", $values));
236 $length = !empty($values["length_$count"]) ? CRM_Utils_Array
::value("length_$count", $values) : NULL;
237 $weight = $values["weight_$count"];
238 if ($table and $field) {
239 $ruleDao = new CRM_Dedupe_DAO_Rule();
240 $ruleDao->dedupe_rule_group_id
= $rgDao->id
;
241 $ruleDao->rule_table
= $table;
242 $ruleDao->rule_field
= $field;
243 $ruleDao->rule_length
= $length;
244 $ruleDao->rule_weight
= $weight;
247 if (!array_key_exists($table, $tables)) {
248 $tables[$table] = [];
250 $tables[$table][] = $field;
253 // CRM-6245: we must pass table/field/length triples to the createIndexes() call below
255 if (!isset($substrLenghts[$table])) {
256 $substrLenghts[$table] = [];
259 //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"
260 $schemaQuery = "SELECT * FROM INFORMATION_SCHEMA.COLUMNS
261 WHERE TABLE_SCHEMA = '{$database}' AND
262 TABLE_NAME = '{$table}' AND COLUMN_NAME = '{$field}';";
263 $dao = CRM_Core_DAO
::executeQuery($schemaQuery);
266 // set the length to null for all the fields where prefix length is not supported. eg. int,tinyint,date,enum etc dataTypes.
267 if ($dao->COLUMN_NAME
== $field && !in_array($dao->DATA_TYPE
, [
277 elseif ($dao->COLUMN_NAME
== $field && !empty($dao->CHARACTER_MAXIMUM_LENGTH
) && ($length > $dao->CHARACTER_MAXIMUM_LENGTH
)) {
278 //set the length to CHARACTER_MAXIMUM_LENGTH in case the length provided by the user is greater than the limit
279 $length = $dao->CHARACTER_MAXIMUM_LENGTH
;
282 $substrLenghts[$table][$field] = $length;
286 // also create an index for this dedupe rule
288 CRM_Utils_Hook
::dupeQuery($ruleDao, 'dedupeIndexes', $tables);
289 CRM_Core_BAO_SchemaHandler
::createIndexes($tables, 'dedupe_index', $substrLenghts);
291 //need to clear cache of deduped contacts
292 //based on the previous rule
293 $cacheKey = "merge {$this->_contactType}_{$this->_rgid}_%";
295 CRM_Core_BAO_PrevNextCache
::deleteItem(NULL, $cacheKey);
297 CRM_Core_Session
::setStatus(ts("The rule '%1' has been saved.", [1 => $rgDao->title
]), ts('Saved'), 'success');