CRM/Member/Import/Form/MapField.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.3                                                |
   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 gets the name of the file to upload
  38  */
  39 class CRM_Member_Import_Form_MapField extends CRM_Import_Form_MapField {
  40
  41
  42
  43   /**
  44    * to store contactType
  45    *
  46    * @var int
  47    * @static
  48    */
  49   static $_contactType = NULL;
  50
  51
  52   /**
  53    * Function to set variables up before form is built
  54    *
  55    * @return void
  56    * @access public
  57    */
  58   public function preProcess() {
  59     $this->_mapperFields = $this->get('fields');
  60     asort($this->_mapperFields);
  61
  62     $this->_columnCount = $this->get('columnCount');
  63     $this->assign('columnCount', $this->_columnCount);
  64     $this->_dataValues = $this->get('dataValues');
  65     $this->assign('dataValues', $this->_dataValues);
  66
  67     $skipColumnHeader = $this->controller->exportValue('UploadFile', 'skipColumnHeader');
  68     $this->_onDuplicate = $this->get('onDuplicate', isset($onDuplicate) ? $onDuplicate : "");
  69
  70     $highlightedFields = array();
  71     if ($skipColumnHeader) {
  72       $this->assign('skipColumnHeader', $skipColumnHeader);
  73       $this->assign('rowDisplayCount', 3);
  74       /* if we had a column header to skip, stash it for later */
  75
  76       $this->_columnHeaders = $this->_dataValues[0];
  77     }
  78     else {
  79       $this->assign('rowDisplayCount', 2);
  80     }
  81
  82     //CRM-2219 removing other required fields since for updation only
  83     //membership id is required.
  84     if ($this->_onDuplicate == CRM_Import_Parser::DUPLICATE_UPDATE) {
  85       $remove = array('membership_contact_id', 'email', 'first_name', 'last_name', 'external_identifier');
  86       foreach ($remove as $value) {
  87         unset($this->_mapperFields[$value]);
  88       }
  89       $highlightedFieldsArray = array('membership_id', 'membership_start_date', 'membership_type_id');
  90       foreach ($highlightedFieldsArray as $name) {
  91         $highlightedFields[] = $name;
  92       }
  93     }
  94     elseif ($this->_onDuplicate == CRM_Import_Parser::DUPLICATE_SKIP) {
  95       unset($this->_mapperFields['membership_id']);
  96       $highlightedFieldsArray = array('membership_contact_id', 'email', 'external_identifier', 'membership_start_date', 'membership_type_id');
  97       foreach ($highlightedFieldsArray as $name) {
  98         $highlightedFields[] = $name;
  99       }
 100     }
 101
 102     // modify field title
 103     $this->_mapperFields['status_id'] = ts('Membership Status');
 104     $this->_mapperFields['membership_type_id'] = ts('Membership Type');
 105
 106     self::$_contactType = $this->get('contactType');
 107     $this->assign('highlightedFields', $highlightedFields);
 108   }
 109
 110   /**
 111    * Function to actually build the form
 112    *
 113    * @return void
 114    * @access public
 115    */
 116   public function buildQuickForm() {
 117     //to save the current mappings
 118     if (!$this->get('savedMapping')) {
 119       $saveDetailsName = ts('Save this field mapping');
 120       $this->applyFilter('saveMappingName', 'trim');
 121       $this->add('text', 'saveMappingName', ts('Name'));
 122       $this->add('text', 'saveMappingDesc', ts('Description'));
 123     }
 124     else {
 125       $savedMapping = $this->get('savedMapping');
 126
 127       list($mappingName, $mappingContactType, $mappingLocation, $mappingPhoneType, $mappingRelation) = CRM_Core_BAO_Mapping::getMappingFields($savedMapping);
 128
 129       $mappingName        = $mappingName[1];
 130       $mappingContactType = $mappingContactType[1];
 131       $mappingLocation    = CRM_Utils_Array::value('1', $mappingLocation);
 132       $mappingPhoneType   = CRM_Utils_Array::value('1', $mappingPhoneType);
 133       $mappingRelation    = CRM_Utils_Array::value('1', $mappingRelation);
 134
 135       //mapping is to be loaded from database
 136
 137       $params         = array('id' => $savedMapping);
 138       $temp           = array();
 139       $mappingDetails = CRM_Core_BAO_Mapping::retrieve($params, $temp);
 140
 141       $this->assign('loadedMapping', $mappingDetails->name);
 142       $this->set('loadedMapping', $savedMapping);
 143
 144       $getMappingName = new CRM_Core_DAO_Mapping();
 145       $getMappingName->id = $savedMapping;
 146       $getMappingName->mapping_type = 'Import Memberships';
 147       $getMappingName->find();
 148       while ($getMappingName->fetch()) {
 149         $mapperName = $getMappingName->name;
 150       }
 151
 152       $this->assign('savedName', $mapperName);
 153
 154       $this->add('hidden', 'mappingId', $savedMapping);
 155
 156       $this->addElement('checkbox', 'updateMapping', ts('Update this field mapping'), NULL);
 157       $saveDetailsName = ts('Save as a new field mapping');
 158       $this->add('text', 'saveMappingName', ts('Name'));
 159       $this->add('text', 'saveMappingDesc', ts('Description'));
 160     }
 161
 162     $this->addElement('checkbox', 'saveMapping', $saveDetailsName, NULL, array('onclick' => "showSaveDetails(this)"));
 163
 164     $this->addFormRule(array('CRM_Member_Import_Form_MapField', 'formRule'), $this);
 165
 166     //-------- end of saved mapping stuff ---------
 167
 168     $defaults         = array();
 169     $mapperKeys       = array_keys($this->_mapperFields);
 170     $hasHeaders       = !empty($this->_columnHeaders);
 171     $headerPatterns   = $this->get('headerPatterns');
 172     $dataPatterns     = $this->get('dataPatterns');
 173     $hasLocationTypes = $this->get('fieldTypes');
 174
 175
 176     /* Initialize all field usages to false */
 177
 178     foreach ($mapperKeys as $key) {
 179       $this->_fieldUsed[$key] = FALSE;
 180     }
 181     $this->_location_types = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id');
 182     $sel1 = $this->_mapperFields;
 183     if (!$this->get('onDuplicate')) {
 184       unset($sel1['id']);
 185       unset($sel1['membership_id']);
 186     }
 187
 188     $sel2[''] = NULL;
 189
 190     $js = "<script type='text/javascript'>\n";
 191     $formName = 'document.forms.' . $this->_name;
 192
 193     //used to warn for mismatch column count or mismatch mapping
 194     $warning = 0;
 195
 196     for ($i = 0; $i < $this->_columnCount; $i++) {
 197       $sel = &$this->addElement('hierselect', "mapper[$i]", ts('Mapper for Field %1', array(1 => $i)), NULL);
 198       $jsSet = FALSE;
 199       if ($this->get('savedMapping')) {
 200         if (isset($mappingName[$i])) {
 201           if ($mappingName[$i] != ts('- do not import -')) {
 202
 203             $mappingHeader = array_keys($this->_mapperFields, $mappingName[$i]);
 204
 205             //When locationType is not set
 206             $js .= "{$formName}['mapper[$i][1]'].style.display = 'none';\n";
 207
 208             //When phoneType is not set
 209             $js .= "{$formName}['mapper[$i][2]'].style.display = 'none';\n";
 210
 211             $js .= "{$formName}['mapper[$i][3]'].style.display = 'none';\n";
 212
 213             $defaults["mapper[$i]"] = array($mappingHeader[0]);
 214             $jsSet = TRUE;
 215           }
 216           else {
 217             $defaults["mapper[$i]"] = array();
 218           }
 219           if (!$jsSet) {
 220             for ($k = 1; $k < 4; $k++) {
 221               $js .= "{$formName}['mapper[$i][$k]'].style.display = 'none';\n";
 222             }
 223           }
 224         }
 225         else {
 226           // this load section to help mapping if we ran out of saved columns when doing Load Mapping
 227           $js .= "swapOptions($formName, 'mapper[$i]', 0, 3, 'hs_mapper_" . $i . "_');\n";
 228
 229           if ($hasHeaders) {
 230             $defaults["mapper[$i]"] = array($this->defaultFromHeader($this->_columnHeaders[$i], $headerPatterns));
 231           }
 232           else {
 233             $defaults["mapper[$i]"] = array($this->defaultFromData($dataPatterns, $i));
 234           }
 235         }
 236         //end of load mapping
 237       }
 238       else {
 239         $js .= "swapOptions($formName, 'mapper[$i]', 0, 3, 'hs_mapper_" . $i . "_');\n";
 240         if ($hasHeaders) {
 241           // Infer the default from the skipped headers if we have them
 242           $defaults["mapper[$i]"] = array(
 243             $this->defaultFromHeader($this->_columnHeaders[$i],
 244               $headerPatterns
 245             ),
 246             //                     $defaultLocationType->id
 247             0,
 248           );
 249         }
 250         else {
 251           // Otherwise guess the default from the form of the data
 252           $defaults["mapper[$i]"] = array(
 253             $this->defaultFromData($dataPatterns, $i),
 254             //                     $defaultLocationType->id
 255             0,
 256           );
 257         }
 258       }
 259       $sel->setOptions(array($sel1, $sel2, (isset($sel3)) ? $sel3 : "", (isset($sel4)) ? $sel4 : ""));
 260     }
 261     $js .= "</script>\n";
 262     $this->assign('initHideBoxes', $js);
 263
 264     //set warning if mismatch in more than
 265     if (isset($mappingName)) {
 266       if (($this->_columnCount != count($mappingName))) {
 267         $warning++;
 268       }
 269     }
 270     if ($warning != 0 && $this->get('savedMapping')) {
 271       $session = CRM_Core_Session::singleton();
 272       $session->setStatus(ts('The data columns in this import file appear to be different from the saved mapping. Please verify that you have selected the correct saved mapping before continuing.'));
 273     }
 274     else {
 275       $session = CRM_Core_Session::singleton();
 276       $session->setStatus(NULL);
 277     }
 278
 279     $this->setDefaults($defaults);
 280
 281     $this->addButtons(array(
 282         array(
 283           'type' => 'back',
 284           'name' => ts('<< Previous'),
 285         ),
 286         array(
 287           'type' => 'next',
 288           'name' => ts('Continue >>'),
 289           'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 290           'isDefault' => TRUE,
 291         ),
 292         array(
 293           'type' => 'cancel',
 294           'name' => ts('Cancel'),
 295         ),
 296       )
 297     );
 298   }
 299
 300   /**
 301    * global validation rules for the form
 302    *
 303    * @param array $fields posted values of the form
 304    *
 305    * @return array list of errors to be posted back to the form
 306    * @static
 307    * @access public
 308    */
 309   static function formRule($fields, $files, $self) {
 310     $errors = array();
 311
 312     if (!array_key_exists('savedMapping', $fields)) {
 313       $importKeys = array();
 314       foreach ($fields['mapper'] as $mapperPart) {
 315         $importKeys[] = $mapperPart[0];
 316       }
 317       // FIXME: should use the schema titles, not redeclare them
 318       $requiredFields = array(
 319         'membership_contact_id' => ts('Contact ID'),
 320         'membership_type_id' => ts('Membership Type'),
 321         'membership_start_date' => ts('Membership Start Date'),
 322       );
 323
 324       $contactTypeId = $self->get('contactType');
 325       $contactTypes = array(
 326         CRM_Import_Parser::CONTACT_INDIVIDUAL => 'Individual',
 327         CRM_Import_Parser::CONTACT_HOUSEHOLD => 'Household',
 328         CRM_Import_Parser::CONTACT_ORGANIZATION => 'Organization',
 329       );
 330       $params = array(
 331         'used'         => 'Unsupervised',
 332         'contact_type' => $contactTypes[$contactTypeId],
 333       );
 334       list($ruleFields, $threshold) = CRM_Dedupe_BAO_RuleGroup::dedupeRuleFieldsWeight($params);
 335       $weightSum = 0;
 336       foreach ($importKeys as $key => $val) {
 337         if (array_key_exists($val, $ruleFields)) {
 338           $weightSum += $ruleFields[$val];
 339         }
 340       }
 341       $fieldMessage = '';
 342       foreach ($ruleFields as $field => $weight) {
 343         $fieldMessage .= ' ' . $field . '(weight ' . $weight . ')';
 344       }
 345
 346       foreach ($requiredFields as $field => $title) {
 347         if (!in_array($field, $importKeys)) {
 348           if ($field == 'membership_contact_id') {
 349             if ((($weightSum >= $threshold || in_array('external_identifier', $importKeys)) &&
 350                 $self->_onDuplicate != CRM_Import_Parser::DUPLICATE_UPDATE
 351               ) ||
 352               in_array('membership_id', $importKeys)
 353             ) {
 354               continue;
 355             }
 356             else {
 357               if (!isset($errors['_qf_default'])) {
 358                 $errors['_qf_default'] = '';
 359               }
 360               $errors['_qf_default'] .= ts('Missing required contact matching fields.') . " $fieldMessage " . ts('(Sum of all weights should be greater than or equal to threshold: %1).', array(
 361                 1 => $threshold)) . ' ' . ts('(OR Membership ID if update mode.)') . '<br />';
 362             }
 363           }
 364           else {
 365             if (!isset($errors['_qf_default'])) {
 366               $errors['_qf_default'] = '';
 367             }
 368             $errors['_qf_default'] .= ts('Missing required field: %1', array(
 369               1 => $title)) . '<br />';
 370           }
 371         }
 372       }
 373     }
 374
 375
 376     if (CRM_Utils_Array::value('saveMapping', $fields)) {
 377       $nameField = CRM_Utils_Array::value('saveMappingName', $fields);
 378       if (empty($nameField)) {
 379         $errors['saveMappingName'] = ts('Name is required to save Import Mapping');
 380       }
 381       else {
 382         $mappingTypeId = CRM_Core_OptionGroup::getValue('mapping_type', 'Import Membership', 'name');
 383
 384         if (CRM_Core_BAO_Mapping::checkMapping($nameField, $mappingTypeId)) {
 385           $errors['saveMappingName'] = ts('Duplicate Import Membership Mapping Name');
 386         }
 387       }
 388     }
 389
 390     if (!empty($errors)) {
 391       if (!empty($errors['saveMappingName'])) {
 392         $_flag = 1;
 393         $assignError = new CRM_Core_Page();
 394         $assignError->assign('mappingDetailsError', $_flag);
 395       }
 396       return $errors;
 397     }
 398
 399     return TRUE;
 400   }
 401
 402   /**
 403    * Process the mapped fields and map it into the uploaded file
 404    * preview the file and extract some summary statistics
 405    *
 406    * @return void
 407    * @access public
 408    */
 409   public function postProcess() {
 410     $params = $this->controller->exportValues('MapField');
 411     //reload the mapfield if load mapping is pressed
 412     if (!empty($params['savedMapping'])) {
 413       $this->set('savedMapping', $params['savedMapping']);
 414       $this->controller->resetPage($this->_name);
 415       return;
 416     }
 417
 418     $fileName = $this->controller->exportValue('UploadFile', 'uploadFile');
 419     $skipColumnHeader = $this->controller->exportValue('UploadFile', 'skipColumnHeader');
 420
 421     $config = CRM_Core_Config::singleton();
 422     $seperator = $config->fieldSeparator;
 423
 424     $mapperKeys      = array();
 425     $mapper          = array();
 426     $mapperKeys      = $this->controller->exportValue($this->_name, 'mapper');
 427     $mapperKeysMain  = array();
 428     $mapperLocType   = array();
 429     $mapperPhoneType = array();
 430
 431     for ($i = 0; $i < $this->_columnCount; $i++) {
 432       $mapper[$i] = $this->_mapperFields[$mapperKeys[$i][0]];
 433       $mapperKeysMain[$i] = $mapperKeys[$i][0];
 434
 435       if (CRM_Utils_Array::value(1, $mapperKeys[$i]) && is_numeric($mapperKeys[$i][1])) {
 436         $mapperLocType[$i] = $mapperKeys[$i][1];
 437       }
 438       else {
 439         $mapperLocType[$i] = NULL;
 440       }
 441
 442       if (CRM_Utils_Array::value(2, $mapperKeys[$i]) && (!is_numeric($mapperKeys[$i][2]))) {
 443         $mapperPhoneType[$i] = $mapperKeys[$i][2];
 444       }
 445       else {
 446         $mapperPhoneType[$i] = NULL;
 447       }
 448     }
 449
 450     $this->set('mapper', $mapper);
 451
 452     // store mapping Id to display it in the preview page
 453     if (CRM_Utils_Array::value('mappingId', $params)) {
 454       $this->set('loadMappingId', $params['mappingId']);
 455     }
 456     //Updating Mapping Records
 457     if (CRM_Utils_Array::value('updateMapping', $params)) {
 458       $mappingFields = new CRM_Core_DAO_MappingField();
 459       $mappingFields->mapping_id = $params['mappingId'];
 460       $mappingFields->find();
 461
 462       $mappingFieldsId = array();
 463       while ($mappingFields->fetch()) {
 464         if ($mappingFields->id) {
 465           $mappingFieldsId[$mappingFields->column_number] = $mappingFields->id;
 466         }
 467       }
 468
 469       for ($i = 0; $i < $this->_columnCount; $i++) {
 470         $updateMappingFields = new CRM_Core_DAO_MappingField();
 471         $updateMappingFields->id = $mappingFieldsId[$i];
 472         $updateMappingFields->mapping_id = $params['mappingId'];
 473         $updateMappingFields->column_number = $i;
 474
 475         $mapperKeyParts = explode('_', $mapperKeys[$i][0], 3);
 476         $id = isset($mapperKeyParts[0]) ? $mapperKeyParts[0] : NULL;
 477         $first = isset($mapperKeyParts[1]) ? $mapperKeyParts[1] : NULL;
 478         $second = isset($mapperKeyParts[2]) ? $mapperKeyParts[2] : NULL;
 479         $updateMappingFields->name = $mapper[$i];
 480         $updateMappingFields->save();
 481       }
 482     }
 483
 484     //Saving Mapping Details and Records
 485     if (CRM_Utils_Array::value('saveMapping', $params)) {
 486       $mappingParams = array(
 487         'name' => $params['saveMappingName'],
 488         'description' => $params['saveMappingDesc'],
 489         'mapping_type_id' => CRM_Core_OptionGroup::getValue('mapping_type',
 490           'Import Membership',
 491           'name'
 492         ),
 493       );
 494       $saveMapping = CRM_Core_BAO_Mapping::add($mappingParams);
 495
 496       for ($i = 0; $i < $this->_columnCount; $i++) {
 497
 498         $saveMappingFields = new CRM_Core_DAO_MappingField();
 499         $saveMappingFields->mapping_id = $saveMapping->id;
 500         $saveMappingFields->column_number = $i;
 501
 502         $mapperKeyParts = explode('_', $mapperKeys[$i][0], 3);
 503         $id = isset($mapperKeyParts[0]) ? $mapperKeyParts[0] : NULL;
 504         $first = isset($mapperKeyParts[1]) ? $mapperKeyParts[1] : NULL;
 505         $second = isset($mapperKeyParts[2]) ? $mapperKeyParts[2] : NULL;
 506         $saveMappingFields->name = $mapper[$i];
 507         $saveMappingFields->save();
 508       }
 509       $this->set('savedMapping', $saveMappingFields->mapping_id);
 510     }
 511
 512     $parser = new CRM_Member_Import_Parser_Membership($mapperKeysMain, $mapperLocType, $mapperPhoneType);
 513     $parser->run($fileName, $seperator, $mapper, $skipColumnHeader,
 514       CRM_Import_Parser::MODE_PREVIEW, $this->get('contactType')
 515     );
 516     // add all the necessary variables to the form
 517     $parser->set($this);
 518   }
 519 }
 520