CRM/Contact/Form/DedupeRules.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.4                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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-2013
  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 {
  41   CONST RULES_COUNT = 5;
  42   protected $_contactType;
  43   protected $_defaults = array();
  44   protected $_fields = array();
  45   protected $_rgid;
  46
  47   /**
  48    * Function to pre processing
  49    *
  50    * @return void
  51    * @access public
  52    */
  53   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 = array(ts('Unsupervised'), ts('Supervised'), ts('General'));
  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    * Function to build the form
  99    *
 100    * @return void
 101    * @access public
 102    */
 103   public function buildQuickForm() {
 104     $foo = CRM_Core_DAO::getAttribute('CRM_Dedupe_DAO_Rule', 'title');
 105
 106     $this->add('text', 'title', ts('Rule Name'), array('maxlength' => 255, 'class' => 'huge'), TRUE);
 107     $this->addRule('title', ts('A duplicate matching rule with this name already exists. Please select another name.'),
 108       'objectExists', array('CRM_Dedupe_DAO_RuleGroup', $this->_rgid, 'title')
 109     );
 110
 111     $this->addRadio('used', ts('Usage'), $this->_options, NULL, NULL, TRUE);
 112
 113     $disabled = array();
 114     $reserved = $this->add('checkbox', 'is_reserved', ts('Reserved?'));
 115     if (!empty($this->_defaults['is_reserved'])) {
 116       $reserved->freeze();
 117       $disabled = array('disabled' => TRUE);
 118     }
 119
 120     $attributes = array('class' => 'two');
 121     if (!empty($disabled)) {
 122       $attributes = array_merge($attributes, $disabled);
 123     }
 124
 125     for ($count = 0; $count < self::RULES_COUNT; $count++) {
 126       $this->add('select', "where_$count", ts('Field'),
 127         array(
 128           NULL => ts('- none -')
 129         ) + $this->_fields, FALSE, $disabled
 130       );
 131       $this->add('text', "length_$count", ts('Length'), $attributes);
 132       $this->add('text', "weight_$count", ts('Weight'), $attributes);
 133     }
 134
 135     $this->add('text', 'threshold', ts("Weight Threshold to Consider Contacts 'Matching':"), $attributes);
 136     $this->addButtons(array(
 137       array('type' => 'next', 'name' => ts('Save'), 'isDefault' => TRUE),
 138       array('type' => 'cancel', 'name' => ts('Cancel')),
 139     ));
 140
 141     $this->assign('contact_type', $this->_contactType);
 142
 143     $this->addFormRule(array('CRM_Contact_Form_DedupeRules', 'formRule'), $this);
 144   }
 145
 146   /**
 147    * global validation rules for the form
 148    *
 149    * @param array $fields posted values of the form
 150    *
 151    * @return array list of errors to be posted back to the form
 152    * @static
 153    * @access public
 154    */
 155   static function formRule($fields, $files, $self) {
 156     $errors = array();
 157     if (!empty($fields['is_reserved'])) {
 158       return TRUE;
 159     }
 160
 161     $fieldSelected = FALSE;
 162     for ($count = 0; $count < self::RULES_COUNT; $count++) {
 163       if (!empty($fields["where_$count"])) {
 164         $fieldSelected = TRUE;
 165         break;
 166       }
 167     }
 168
 169     if (!$fieldSelected) {
 170       $errors['_qf_default'] = ts('Please select at least one field.');
 171     }
 172
 173     return empty($errors) ? TRUE : $errors;
 174   }
 175
 176   function setDefaultValues() {
 177     return $this->_defaults;
 178   }
 179
 180   /**
 181    * Function to process the form
 182    *
 183    * @access public
 184    *
 185    * @return void
 186    */
 187   public function postProcess() {
 188     $values = $this->exportValues();
 189
 190     //FIXME: Handle logic to replace is_default column by usage
 191     $used = CRM_Utils_Array::value('used', $values, FALSE);
 192     // reset used column to General (since there can only
 193     // be one 'Supervised' or 'Unsupervised' rule)
 194     if ($this->_options[$used] != 'General') {
 195       $query = "
 196 UPDATE civicrm_dedupe_rule_group
 197    SET used = 'General'
 198  WHERE contact_type = %1
 199    AND used = %2";
 200       $queryParams = array(1 => array($this->_contactType, 'String'),
 201         2 => array($this->_options[$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         = $this->_options[$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('char', 'varchar', 'binary', 'varbinary', 'text', 'blob'))) {
 280             $length = NULL;
 281           }
 282           elseif ($dao->COLUMN_NAME == $field && !empty($dao->CHARACTER_MAXIMUM_LENGTH) && ($length > $dao->CHARACTER_MAXIMUM_LENGTH)) {
 283             //set the length to CHARACTER_MAXIMUM_LENGTH in case the length provided by the user is greater than the limit
 284             $length = $dao->CHARACTER_MAXIMUM_LENGTH;
 285           }
 286         }
 287         $substrLenghts[$table][$field] = $length;
 288       }
 289     }
 290
 291     // also create an index for this dedupe rule
 292     // CRM-3837
 293     CRM_Core_BAO_SchemaHandler::createIndexes($tables, 'dedupe_index', $substrLenghts);
 294
 295     //need to clear cache of deduped contacts
 296     //based on the previous rule
 297     $cacheKey = "merge {$this->_contactType}_{$this->_rgid}_%";
 298
 299     CRM_Core_BAO_PrevNextCache::deleteItem(NULL, $cacheKey);
 300
 301     CRM_Core_Session::setStatus(ts("The rule '%1' has been saved.", array(1 => $rgDao->title)), ts('Saved'), 'success');
 302   }
 303 }
 304