CRM/Contact/Form/DedupeRules.php

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