CRM/Activity/Import/Form/MapField.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17
  18 /**
  19  * This class gets the name of the file to upload.
  20  */
  21 class CRM_Activity_Import_Form_MapField extends CRM_Import_Form_MapField {
  22
  23   /**
  24    * @var bool
  25    */
  26   public $submitOnce = TRUE;
  27
  28   /**
  29    * Set variables up before form is built.
  30    */
  31   public function preProcess() {
  32     $this->_mapperFields = $this->get('fields');
  33     unset($this->_mapperFields['id']);
  34     asort($this->_mapperFields);
  35
  36     $this->_columnCount = $this->get('columnCount');
  37     $this->assign('columnCount', $this->_columnCount);
  38     $this->_dataValues = $this->get('dataValues');
  39     $this->assign('dataValues', $this->_dataValues);
  40
  41     $skipColumnHeader = $this->controller->exportValue('DataSource', 'skipColumnHeader');
  42
  43     if ($skipColumnHeader) {
  44       $this->assign('skipColumnHeader', $skipColumnHeader);
  45       $this->assign('rowDisplayCount', 3);
  46       // If we had a column header to skip, stash it for later.
  47
  48       $this->_columnHeaders = $this->_dataValues[0];
  49     }
  50     else {
  51       $this->assign('rowDisplayCount', 2);
  52     }
  53     $highlightedFields = [];
  54     $requiredFields = [
  55       'activity_date_time',
  56       'activity_type_id',
  57       'activity_label',
  58       'target_contact_id',
  59       'activity_subject',
  60     ];
  61     foreach ($requiredFields as $val) {
  62       $highlightedFields[] = $val;
  63     }
  64     $this->assign('highlightedFields', $highlightedFields);
  65   }
  66
  67   /**
  68    * Build the form object.
  69    *
  70    * @throws \CiviCRM_API3_Exception
  71    */
  72   public function buildQuickForm() {
  73     // To save the current mappings.
  74     if (!$this->get('savedMapping')) {
  75       $saveDetailsName = ts('Save this field mapping');
  76       $this->applyFilter('saveMappingName', 'trim');
  77       $this->add('text', 'saveMappingName', ts('Name'));
  78       $this->add('text', 'saveMappingDesc', ts('Description'));
  79     }
  80     else {
  81       $savedMapping = $this->get('savedMapping');
  82       // Mapping is to be loaded from database.
  83
  84       // Get an array of the name values for mapping fields associated with this mapping_id.
  85       $mappingName = CRM_Core_BAO_Mapping::getMappingFieldValues($savedMapping, 'name');
  86
  87       $this->set('loadedMapping', $savedMapping);
  88
  89       $params = ['id' => $savedMapping];
  90       $temp = [];
  91       $mappingDetails = CRM_Core_BAO_Mapping::retrieve($params, $temp);
  92
  93       $this->assign('savedMappingName', $mappingDetails->name);
  94
  95       $this->add('hidden', 'mappingId', $savedMapping);
  96
  97       $this->addElement('checkbox', 'updateMapping', ts('Update this field mapping'), NULL);
  98       $saveDetailsName = ts('Save as a new field mapping');
  99       $this->add('text', 'saveMappingName', ts('Name'));
 100       $this->add('text', 'saveMappingDesc', ts('Description'));
 101     }
 102
 103     $this->addElement('checkbox', 'saveMapping', $saveDetailsName, NULL, ['onclick' => "showSaveDetails(this)"]);
 104
 105     $this->addFormRule(['CRM_Activity_Import_Form_MapField', 'formRule']);
 106
 107     //-------- end of saved mapping stuff ---------
 108
 109     $defaults = [];
 110     $mapperKeys = array_keys($this->_mapperFields);
 111
 112     $hasHeaders = !empty($this->_columnHeaders);
 113     $headerPatterns = $this->get('headerPatterns');
 114     $dataPatterns = $this->get('dataPatterns');
 115
 116     // Initialize all field usages to false.
 117
 118     foreach ($mapperKeys as $key) {
 119       $this->_fieldUsed[$key] = FALSE;
 120     }
 121     $sel1 = $this->_mapperFields;
 122
 123     $js = "<script type='text/javascript'>\n";
 124     $formName = 'document.forms.' . $this->_name;
 125
 126     // Used to warn for mismatch column count or mismatch mapping.
 127     $warning = 0;
 128
 129     for ($i = 0; $i < $this->_columnCount; $i++) {
 130       $sel = &$this->addElement('hierselect', "mapper[$i]", ts('Mapper for Field %1', [1 => $i]), NULL);
 131       $jsSet = FALSE;
 132       if ($this->get('savedMapping')) {
 133         if (isset($mappingName[$i])) {
 134           if ($mappingName[$i] != ts('- do not import -')) {
 135
 136             $mappingHeader = array_keys($this->_mapperFields, $mappingName[$i]);
 137
 138             $js .= "{$formName}['mapper[$i][3]'].style.display = 'none';\n";
 139             $defaults["mapper[$i]"] = [
 140               $mappingHeader[0],
 141               '',
 142               '',
 143             ];
 144             $jsSet = TRUE;
 145           }
 146           else {
 147             $defaults["mapper[$i]"] = [];
 148           }
 149           if (!$jsSet) {
 150             for ($k = 1; $k < 4; $k++) {
 151               $js .= "{$formName}['mapper[$i][$k]'].style.display = 'none';\n";
 152             }
 153           }
 154         }
 155         else {
 156           // this load section to help mapping if we ran out of saved columns when doing Load Mapping
 157           $js .= "swapOptions($formName, 'mapper[$i]', 0, 3, 'hs_mapper_" . $i . "_');\n";
 158
 159           if ($hasHeaders) {
 160             $defaults["mapper[$i]"] = [$this->defaultFromHeader($this->_columnHeaders[$i], $headerPatterns)];
 161           }
 162           else {
 163             $defaults["mapper[$i]"] = [$this->defaultFromData($dataPatterns, $i)];
 164           }
 165         }
 166         // End of load mapping.
 167       }
 168       else {
 169         $js .= "swapOptions($formName, 'mapper[$i]', 0, 3, 'hs_mapper_" . $i . "_');\n";
 170         if ($hasHeaders) {
 171           // Infer the default from the skipped headers if we have them
 172           $defaults["mapper[$i]"] = [
 173             $this->defaultFromHeader($this->_columnHeaders[$i], $headerPatterns),
 174             0,
 175           ];
 176         }
 177         else {
 178           // Otherwise guess the default from the form of the data
 179           $defaults["mapper[$i]"] = [$this->defaultFromData($dataPatterns, $i), 0];
 180         }
 181       }
 182
 183       $sel->setOptions([
 184         $sel1,
 185         ['' => NULL],
 186         '',
 187         '',
 188       ]);
 189     }
 190     $js .= "</script>\n";
 191     $this->assign('initHideBoxes', $js);
 192
 193     // Set warning if mismatch in more than.
 194     if (isset($mappingName)) {
 195       if (($this->_columnCount != count($mappingName))) {
 196         $warning++;
 197       }
 198     }
 199     if ($warning != 0 && $this->get('savedMapping')) {
 200       CRM_Core_Session::singleton()->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.'));
 201     }
 202     else {
 203       CRM_Core_Session::singleton()->setStatus(NULL);
 204     }
 205
 206     $this->setDefaults($defaults);
 207
 208     $this->addButtons([
 209         [
 210           'type' => 'back',
 211           'name' => ts('Previous'),
 212         ],
 213         [
 214           'type' => 'next',
 215           'name' => ts('Continue'),
 216           'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 217           'isDefault' => TRUE,
 218         ],
 219         [
 220           'type' => 'cancel',
 221           'name' => ts('Cancel'),
 222         ],
 223     ]
 224     );
 225   }
 226
 227   /**
 228    * Global validation rules for the form.
 229    *
 230    * @param array $fields
 231    *   Posted values of the form.
 232    *
 233    * @return array
 234    *   list of errors to be posted back to the form
 235    */
 236   public static function formRule($fields) {
 237     $errors = [];
 238     // define so we avoid notices below
 239     $errors['_qf_default'] = '';
 240
 241     $fieldMessage = NULL;
 242     if (!array_key_exists('savedMapping', $fields)) {
 243       $importKeys = [];
 244       foreach ($fields['mapper'] as $mapperPart) {
 245         $importKeys[] = $mapperPart[0];
 246       }
 247       // FIXME: should use the schema titles, not redeclare them
 248       $requiredFields = [
 249         'target_contact_id' => ts('Contact ID'),
 250         'activity_date_time' => ts('Activity Date'),
 251         'activity_subject' => ts('Activity Subject'),
 252         'activity_type_id' => ts('Activity Type ID'),
 253       ];
 254
 255       $contactFieldsBelowWeightMessage = self::validateRequiredContactMatchFields('Individual', $importKeys);
 256       foreach ($requiredFields as $field => $title) {
 257         if (!in_array($field, $importKeys)) {
 258           if ($field === 'target_contact_id') {
 259             if (!$contactFieldsBelowWeightMessage || in_array('external_identifier', $importKeys)) {
 260               continue;
 261             }
 262             else {
 263               $errors['_qf_default'] .= ts('Missing required contact matching fields.')
 264                 . $contactFieldsBelowWeightMessage
 265                 . '<br />';
 266             }
 267           }
 268           elseif ($field === 'activity_type_id') {
 269             if (in_array('activity_label', $importKeys)) {
 270               continue;
 271             }
 272             else {
 273               $errors['_qf_default'] .= ts('Missing required field: Provide %1 or %2',
 274                   [
 275                     1 => $title,
 276                     2 => 'Activity Type Label',
 277                   ]) . '<br />';
 278             }
 279           }
 280           else {
 281             $errors['_qf_default'] .= ts('Missing required field: %1', [1 => $title]) . '<br />';
 282           }
 283         }
 284       }
 285     }
 286
 287     if (!empty($fields['saveMapping'])) {
 288       $nameField = $fields['saveMappingName'] ?? NULL;
 289       if (empty($nameField)) {
 290         $errors['saveMappingName'] = ts('Name is required to save Import Mapping');
 291       }
 292       else {
 293         if (CRM_Core_BAO_Mapping::checkMapping($nameField, CRM_Core_PseudoConstant::getKey('CRM_Core_BAO_Mapping', 'mapping_type_id', 'Import Activity'))) {
 294           $errors['saveMappingName'] = ts('Duplicate Import Mapping Name');
 295         }
 296       }
 297     }
 298
 299     if (empty($errors['_qf_default'])) {
 300       unset($errors['_qf_default']);
 301     }
 302     if (!empty($errors)) {
 303       if (!empty($errors['saveMappingName'])) {
 304         $_flag = 1;
 305         $assignError = new CRM_Core_Page();
 306         $assignError->assign('mappingDetailsError', $_flag);
 307       }
 308       return $errors;
 309     }
 310
 311     return TRUE;
 312   }
 313
 314   /**
 315    * Process the mapped fields and map it into the uploaded file.
 316    *
 317    * Preview the file and extract some summary statistics
 318    */
 319   public function postProcess() {
 320     $params = $this->controller->exportValues('MapField');
 321     // Reload the mapfield if load mapping is pressed.
 322     if (!empty($params['savedMapping'])) {
 323       $this->set('savedMapping', $params['savedMapping']);
 324       $this->controller->resetPage($this->_name);
 325       return;
 326     }
 327     $this->updateUserJobMetadata('submitted_values', $this->getSubmittedValues());
 328
 329     $mapper = [];
 330     $mapperKeys = $this->controller->exportValue($this->_name, 'mapper');
 331     $mapperKeysMain = [];
 332
 333     for ($i = 0; $i < $this->_columnCount; $i++) {
 334       $mapper[$i] = $this->_mapperFields[$mapperKeys[$i][0]];
 335       $mapperKeysMain[$i] = $mapperKeys[$i][0];
 336     }
 337
 338     $this->set('mapper', $mapper);
 339     // store mapping Id to display it in the preview page
 340     if (!empty($params['mappingId'])) {
 341       $this->set('loadMappingId', $params['mappingId']);
 342     }
 343
 344     // Updating Mapping Records.
 345     if (!empty($params['updateMapping'])) {
 346
 347       $mappingFields = new CRM_Core_DAO_MappingField();
 348       $mappingFields->mapping_id = $params['mappingId'];
 349       $mappingFields->find();
 350
 351       $mappingFieldsId = [];
 352       while ($mappingFields->fetch()) {
 353         if ($mappingFields->id) {
 354           $mappingFieldsId[$mappingFields->column_number] = $mappingFields->id;
 355         }
 356       }
 357
 358       for ($i = 0; $i < $this->_columnCount; $i++) {
 359         $updateMappingFields = new CRM_Core_DAO_MappingField();
 360         $updateMappingFields->id = $mappingFieldsId[$i];
 361         $updateMappingFields->mapping_id = $params['mappingId'];
 362         $updateMappingFields->column_number = $i;
 363
 364         $updateMappingFields->name = $mapper[$i];
 365         $updateMappingFields->save();
 366       }
 367     }
 368
 369     // Saving Mapping Details and Records.
 370     if (!empty($params['saveMapping'])) {
 371       $mappingParams = [
 372         'name' => $params['saveMappingName'],
 373         'description' => $params['saveMappingDesc'],
 374         'mapping_type_id' => CRM_Core_PseudoConstant::getKey('CRM_Core_BAO_Mapping', 'mapping_type_id', 'Import Activity'),
 375       ];
 376       $saveMapping = CRM_Core_BAO_Mapping::add($mappingParams);
 377
 378       for ($i = 0; $i < $this->_columnCount; $i++) {
 379         $saveMappingFields = new CRM_Core_DAO_MappingField();
 380         $saveMappingFields->mapping_id = $saveMapping->id;
 381         $saveMappingFields->column_number = $i;
 382
 383         $saveMappingFields->name = $mapper[$i];
 384         $saveMappingFields->save();
 385       }
 386       $this->set('savedMapping', $saveMappingFields->mapping_id);
 387     }
 388
 389     $parser = new CRM_Activity_Import_Parser_Activity($mapperKeysMain);
 390     $parser->setUserJobID($this->getUserJobID());
 391     $parser->run($this->getSubmittedValue('uploadFile'), $this->getSubmittedValue('fieldSeparator'), $mapper, $this->getSubmittedValue('skipColumnHeader'),
 392       CRM_Import_Parser::MODE_PREVIEW
 393     );
 394
 395     // add all the necessary variables to the form
 396     $parser->set($this);
 397   }
 398
 399   /**
 400    * @return CRM_Activity_Import_Parser_Activity
 401    */
 402   protected function getParser(): CRM_Activity_Import_Parser_Activity {
 403     if (!$this->parser) {
 404       $this->parser = new CRM_Activity_Import_Parser_Activity();
 405       $this->parser->setUserJobID($this->getUserJobID());
 406       $this->parser->init();
 407     }
 408     return $this->parser;
 409   }
 410
 411 }