Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
e7112fa7 | 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
6a488035 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
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. | | |
13 | | | | |
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. | | |
18 | | | | |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
e7112fa7 | 31 | * @copyright CiviCRM LLC (c) 2004-2015 |
6a488035 TO |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | ||
36 | /** | |
37 | * This class generates form components for DedupeRules | |
38 | * | |
39 | */ | |
40 | class CRM_Contact_Form_DedupeRules extends CRM_Admin_Form { | |
7da04cde | 41 | const RULES_COUNT = 5; |
6a488035 TO |
42 | protected $_contactType; |
43 | protected $_defaults = array(); | |
44 | protected $_fields = array(); | |
45 | protected $_rgid; | |
46 | ||
a4969aee TM |
47 | /** |
48 | * Explicitly declare the entity api name. | |
49 | */ | |
50 | public function getDefaultEntity() { | |
51 | return 'RuleGroup'; | |
52 | } | |
53 | ||
6a488035 | 54 | /** |
fe482240 | 55 | * Pre processing. |
6a488035 | 56 | * |
355ba699 | 57 | * @return void |
8ef12e64 | 58 | */ |
00be9182 | 59 | public function preProcess() { |
6a488035 TO |
60 | // Ensure user has permission to be here |
61 | if (!CRM_Core_Permission::check('administer dedupe rules')) { | |
62 | CRM_Utils_System::permissionDenied(); | |
63 | CRM_Utils_System::civiExit(); | |
64 | } | |
77d0b1f8 | 65 | $this->_options = CRM_Core_SelectValues::getDedupeRuleTypes(); |
6a488035 TO |
66 | $this->_rgid = CRM_Utils_Request::retrieve('id', 'Positive', $this, FALSE, 0); |
67 | $this->_contactType = CRM_Utils_Request::retrieve('contact_type', 'String', $this, FALSE, 0); | |
68 | if ($this->_rgid) { | |
69 | $rgDao = new CRM_Dedupe_DAO_RuleGroup(); | |
70 | $rgDao->id = $this->_rgid; | |
71 | $rgDao->find(TRUE); | |
72 | ||
73 | $this->_defaults['threshold'] = $rgDao->threshold; | |
74 | $this->_contactType = $rgDao->contact_type; | |
75 | $this->_defaults['used'] = CRM_Utils_Array::key($rgDao->used, $this->_options); | |
76 | $this->_defaults['title'] = $rgDao->title; | |
77 | $this->_defaults['name'] = $rgDao->name; | |
78 | $this->_defaults['is_reserved'] = $rgDao->is_reserved; | |
79 | $this->assign('isReserved', $rgDao->is_reserved); | |
80 | $this->assign('ruleName', $rgDao->name); | |
81 | $ruleDao = new CRM_Dedupe_DAO_Rule(); | |
82 | $ruleDao->dedupe_rule_group_id = $this->_rgid; | |
83 | $ruleDao->find(); | |
84 | $count = 0; | |
85 | while ($ruleDao->fetch()) { | |
86 | $this->_defaults["where_$count"] = "{$ruleDao->rule_table}.{$ruleDao->rule_field}"; | |
87 | $this->_defaults["length_$count"] = $ruleDao->rule_length; | |
88 | $this->_defaults["weight_$count"] = $ruleDao->rule_weight; | |
89 | $count++; | |
90 | } | |
91 | } | |
92 | $supported = CRM_Dedupe_BAO_RuleGroup::supportedFields($this->_contactType); | |
93 | if (is_array($supported)) { | |
94 | foreach ($supported as $table => $fields) { | |
95 | foreach ($fields as $field => $title) { | |
96 | $this->_fields["$table.$field"] = $title; | |
97 | } | |
98 | } | |
99 | } | |
100 | asort($this->_fields); | |
101 | } | |
102 | ||
103 | /** | |
fe482240 | 104 | * Build the form object. |
6a488035 | 105 | * |
355ba699 | 106 | * @return void |
6a488035 TO |
107 | */ |
108 | public function buildQuickForm() { | |
a4969aee | 109 | $this->addField('title', array('label' => ts('Rule Name')), TRUE); |
6a488035 TO |
110 | $this->addRule('title', ts('A duplicate matching rule with this name already exists. Please select another name.'), |
111 | 'objectExists', array('CRM_Dedupe_DAO_RuleGroup', $this->_rgid, 'title') | |
112 | ); | |
113 | ||
72c010fd | 114 | $this->addField('used', array('label' => ts('Usage')), TRUE); |
6a488035 | 115 | $disabled = array(); |
a4969aee | 116 | $reserved = $this->addField('is_reserved', array('label' => ts('Reserved?'))); |
a7488080 | 117 | if (!empty($this->_defaults['is_reserved'])) { |
bff3913a | 118 | //$reserved->freeze(); |
6a488035 TO |
119 | $disabled = array('disabled' => TRUE); |
120 | } | |
121 | ||
122 | $attributes = array('class' => 'two'); | |
123 | if (!empty($disabled)) { | |
124 | $attributes = array_merge($attributes, $disabled); | |
125 | } | |
126 | ||
127 | for ($count = 0; $count < self::RULES_COUNT; $count++) { | |
128 | $this->add('select', "where_$count", ts('Field'), | |
129 | array( | |
21dfd5f5 | 130 | NULL => ts('- none -'), |
6432bd67 | 131 | ) + $this->_fields, FALSE, $disabled |
6a488035 | 132 | ); |
9f645101 TM |
133 | $this->addField("length_$count", array('entity' => 'Rule', 'name' => 'rule_length') + $attributes); |
134 | $this->addField("weight_$count", array('entity' => 'Rule', 'name' => 'rule_weight') + $attributes); | |
6a488035 TO |
135 | } |
136 | ||
a4969aee | 137 | $this->addField('threshold', array('label' => ts("Weight Threshold to Consider Contacts 'Matching':")) + $attributes); |
6a488035 TO |
138 | |
139 | $this->assign('contact_type', $this->_contactType); | |
140 | ||
141 | $this->addFormRule(array('CRM_Contact_Form_DedupeRules', 'formRule'), $this); | |
a1f552a9 CW |
142 | |
143 | parent::buildQuickForm(); | |
6a488035 TO |
144 | } |
145 | ||
146 | /** | |
fe482240 | 147 | * Global validation rules for the form. |
6a488035 | 148 | * |
77c5b619 TO |
149 | * @param array $fields |
150 | * Posted values of the form. | |
6a488035 | 151 | * |
da6b46f4 EM |
152 | * @param $files |
153 | * @param $self | |
154 | * | |
a6c01b45 CW |
155 | * @return array |
156 | * list of errors to be posted back to the form | |
6a488035 | 157 | */ |
00be9182 | 158 | public static function formRule($fields, $files, $self) { |
6a488035 | 159 | $errors = array(); |
a7488080 | 160 | if (!empty($fields['is_reserved'])) { |
6a488035 TO |
161 | return TRUE; |
162 | } | |
163 | ||
164 | $fieldSelected = FALSE; | |
165 | for ($count = 0; $count < self::RULES_COUNT; $count++) { | |
a7488080 | 166 | if (!empty($fields["where_$count"])) { |
6a488035 TO |
167 | $fieldSelected = TRUE; |
168 | break; | |
169 | } | |
170 | } | |
171 | ||
172 | if (!$fieldSelected) { | |
173 | $errors['_qf_default'] = ts('Please select at least one field.'); | |
174 | } | |
175 | ||
176 | return empty($errors) ? TRUE : $errors; | |
177 | } | |
178 | ||
86538308 | 179 | /** |
c490a46a | 180 | * Set default values for the form. MobileProvider that in edit/view mode |
86538308 EM |
181 | * the default values are retrieved from the database |
182 | * | |
86538308 EM |
183 | * |
184 | * @return array | |
185 | */ | |
186 | /** | |
187 | * @return array | |
188 | */ | |
00be9182 | 189 | public function setDefaultValues() { |
6a488035 TO |
190 | return $this->_defaults; |
191 | } | |
192 | ||
193 | /** | |
fe482240 | 194 | * Process the form submission. |
6a488035 | 195 | * |
6a488035 | 196 | * |
355ba699 | 197 | * @return void |
6a488035 TO |
198 | */ |
199 | public function postProcess() { | |
200 | $values = $this->exportValues(); | |
8ef12e64 | 201 | |
6a488035 | 202 | //FIXME: Handle logic to replace is_default column by usage |
6a488035 TO |
203 | // reset used column to General (since there can only |
204 | // be one 'Supervised' or 'Unsupervised' rule) | |
77d0b1f8 | 205 | if ($values['used'] != 'General') { |
6a488035 | 206 | $query = " |
8ef12e64 | 207 | UPDATE civicrm_dedupe_rule_group |
6a488035 | 208 | SET used = 'General' |
8ef12e64 | 209 | WHERE contact_type = %1 |
6a488035 | 210 | AND used = %2"; |
77d0b1f8 | 211 | $queryParams = array( |
212 | 1 => array($this->_contactType, 'String'), | |
03390e26 | 213 | 2 => array($values['used'], 'String'), |
6a488035 TO |
214 | ); |
215 | ||
216 | CRM_Core_DAO::executeQuery($query, $queryParams); | |
217 | } | |
218 | ||
219 | $rgDao = new CRM_Dedupe_DAO_RuleGroup(); | |
220 | if ($this->_action & CRM_Core_Action::UPDATE) { | |
221 | $rgDao->id = $this->_rgid; | |
222 | } | |
223 | ||
353ffa53 TO |
224 | $rgDao->title = $values['title']; |
225 | $rgDao->is_reserved = CRM_Utils_Array::value('is_reserved', $values, FALSE); | |
226 | $rgDao->used = $values['used']; | |
6a488035 | 227 | $rgDao->contact_type = $this->_contactType; |
353ffa53 | 228 | $rgDao->threshold = $values['threshold']; |
6a488035 TO |
229 | $rgDao->save(); |
230 | ||
231 | // make sure name is set only during insert | |
232 | if ($this->_action & CRM_Core_Action::ADD) { | |
233 | // generate name based on title | |
234 | $rgDao->name = CRM_Utils_String::titleToVar($values['title']) . "_{$rgDao->id}"; | |
235 | $rgDao->save(); | |
236 | } | |
237 | ||
238 | // lets skip updating of fields for reserved dedupe group | |
239 | if ($rgDao->is_reserved) { | |
240 | CRM_Core_Session::setStatus(ts("The rule '%1' has been saved.", array(1 => $rgDao->title)), ts('Saved'), 'success'); | |
241 | return; | |
242 | } | |
243 | ||
244 | $ruleDao = new CRM_Dedupe_DAO_Rule(); | |
245 | $ruleDao->dedupe_rule_group_id = $rgDao->id; | |
246 | $ruleDao->delete(); | |
247 | $ruleDao->free(); | |
248 | ||
249 | $substrLenghts = array(); | |
250 | ||
251 | $tables = array(); | |
b0c27559 RN |
252 | $daoObj = new CRM_Core_DAO(); |
253 | $database = $daoObj->database(); | |
6a488035 | 254 | for ($count = 0; $count < self::RULES_COUNT; $count++) { |
a7488080 | 255 | if (empty($values["where_$count"])) { |
6a488035 TO |
256 | continue; |
257 | } | |
258 | list($table, $field) = explode('.', CRM_Utils_Array::value("where_$count", $values)); | |
0d8afee2 | 259 | $length = !empty($values["length_$count"]) ? CRM_Utils_Array::value("length_$count", $values) : NULL; |
6a488035 TO |
260 | $weight = $values["weight_$count"]; |
261 | if ($table and $field) { | |
262 | $ruleDao = new CRM_Dedupe_DAO_Rule(); | |
263 | $ruleDao->dedupe_rule_group_id = $rgDao->id; | |
264 | $ruleDao->rule_table = $table; | |
265 | $ruleDao->rule_field = $field; | |
266 | $ruleDao->rule_length = $length; | |
267 | $ruleDao->rule_weight = $weight; | |
268 | $ruleDao->save(); | |
269 | $ruleDao->free(); | |
270 | ||
271 | if (!array_key_exists($table, $tables)) { | |
272 | $tables[$table] = array(); | |
273 | } | |
274 | $tables[$table][] = $field; | |
275 | } | |
276 | ||
277 | // CRM-6245: we must pass table/field/length triples to the createIndexes() call below | |
278 | if ($length) { | |
279 | if (!isset($substrLenghts[$table])) { | |
280 | $substrLenghts[$table] = array(); | |
281 | } | |
f41b3f7e RN |
282 | |
283 | //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" | |
f41b3f7e RN |
284 | $schemaQuery = "SELECT * FROM INFORMATION_SCHEMA.COLUMNS |
285 | WHERE TABLE_SCHEMA = '{$database}' AND | |
286 | TABLE_NAME = '{$table}' AND COLUMN_NAME = '{$field}';"; | |
287 | $dao = CRM_Core_DAO::executeQuery($schemaQuery); | |
288 | ||
b0c27559 | 289 | if ($dao->fetch()) { |
f41b3f7e | 290 | // set the length to null for all the fields where prefix length is not supported. eg. int,tinyint,date,enum etc dataTypes. |
353ffa53 TO |
291 | if ($dao->COLUMN_NAME == $field && !in_array($dao->DATA_TYPE, array( |
292 | 'char', | |
293 | 'varchar', | |
294 | 'binary', | |
295 | 'varbinary', | |
296 | 'text', | |
af9b09df | 297 | 'blob', |
353ffa53 TO |
298 | )) |
299 | ) { | |
f41b3f7e RN |
300 | $length = NULL; |
301 | } | |
302 | elseif ($dao->COLUMN_NAME == $field && !empty($dao->CHARACTER_MAXIMUM_LENGTH) && ($length > $dao->CHARACTER_MAXIMUM_LENGTH)) { | |
303 | //set the length to CHARACTER_MAXIMUM_LENGTH in case the length provided by the user is greater than the limit | |
304 | $length = $dao->CHARACTER_MAXIMUM_LENGTH; | |
305 | } | |
306 | } | |
6a488035 TO |
307 | $substrLenghts[$table][$field] = $length; |
308 | } | |
309 | } | |
310 | ||
311 | // also create an index for this dedupe rule | |
312 | // CRM-3837 | |
1cf05c3e | 313 | CRM_Utils_Hook::dupeQuery($ruleDao, 'dedupeIndexes', $tables); |
6a488035 TO |
314 | CRM_Core_BAO_SchemaHandler::createIndexes($tables, 'dedupe_index', $substrLenghts); |
315 | ||
316 | //need to clear cache of deduped contacts | |
317 | //based on the previous rule | |
318 | $cacheKey = "merge {$this->_contactType}_{$this->_rgid}_%"; | |
319 | ||
320 | CRM_Core_BAO_PrevNextCache::deleteItem(NULL, $cacheKey); | |
321 | ||
322 | CRM_Core_Session::setStatus(ts("The rule '%1' has been saved.", array(1 => $rgDao->title)), ts('Saved'), 'success'); | |
323 | } | |
96025800 | 324 | |
6a488035 | 325 | } |