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