3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2019
35 * This class gets the name of the file to upload.
37 class CRM_Activity_Import_Form_MapField
extends CRM_Import_Form_MapField
{
41 * Set variables up before form is built.
43 public function preProcess() {
44 $this->_mapperFields
= $this->get('fields');
45 unset($this->_mapperFields
['id']);
46 asort($this->_mapperFields
);
48 $this->_columnCount
= $this->get('columnCount');
49 $this->assign('columnCount', $this->_columnCount
);
50 $this->_dataValues
= $this->get('dataValues');
51 $this->assign('dataValues', $this->_dataValues
);
53 $skipColumnHeader = $this->controller
->exportValue('DataSource', 'skipColumnHeader');
55 if ($skipColumnHeader) {
56 $this->assign('skipColumnHeader', $skipColumnHeader);
57 $this->assign('rowDisplayCount', 3);
58 // If we had a column header to skip, stash it for later.
60 $this->_columnHeaders
= $this->_dataValues
[0];
63 $this->assign('rowDisplayCount', 2);
65 $highlightedFields = array();
66 $requiredFields = array(
73 foreach ($requiredFields as $val) {
74 $highlightedFields[] = $val;
76 $this->assign('highlightedFields', $highlightedFields);
80 * Build the form object.
82 public function buildQuickForm() {
83 // To save the current mappings.
84 if (!$this->get('savedMapping')) {
85 $saveDetailsName = ts('Save this field mapping');
86 $this->applyFilter('saveMappingName', 'trim');
87 $this->add('text', 'saveMappingName', ts('Name'));
88 $this->add('text', 'saveMappingDesc', ts('Description'));
91 $savedMapping = $this->get('savedMapping');
92 // Mapping is to be loaded from database.
94 list($mappingName, $mappingContactType, $mappingLocation, $mappingPhoneType, $mappingRelation) = CRM_Core_BAO_Mapping
::getMappingFields($savedMapping);
96 // Get loaded Mapping Fields.
97 $mappingName = CRM_Utils_Array
::value('1', $mappingName);
98 $mappingContactType = CRM_Utils_Array
::value('1', $mappingContactType);
99 $mappingLocation = CRM_Utils_Array
::value('1', $mappingLocation);
100 $mappingPhoneType = CRM_Utils_Array
::value('1', $mappingPhoneType);
101 $mappingRelation = CRM_Utils_Array
::value('1', $mappingRelation);
103 $this->assign('loadedMapping', $savedMapping);
104 $this->set('loadedMapping', $savedMapping);
106 $params = array('id' => $savedMapping);
108 $mappingDetails = CRM_Core_BAO_Mapping
::retrieve($params, $temp);
110 $this->assign('savedName', $mappingDetails->name
);
112 $this->add('hidden', 'mappingId', $savedMapping);
114 $this->addElement('checkbox', 'updateMapping', ts('Update this field mapping'), NULL);
115 $saveDetailsName = ts('Save as a new field mapping');
116 $this->add('text', 'saveMappingName', ts('Name'));
117 $this->add('text', 'saveMappingDesc', ts('Description'));
120 $this->addElement('checkbox', 'saveMapping', $saveDetailsName, NULL, array('onclick' => "showSaveDetails(this)"));
122 $this->addFormRule(array('CRM_Activity_Import_Form_MapField', 'formRule'));
124 //-------- end of saved mapping stuff ---------
127 $mapperKeys = array_keys($this->_mapperFields
);
129 $hasHeaders = !empty($this->_columnHeaders
);
130 $headerPatterns = $this->get('headerPatterns');
131 $dataPatterns = $this->get('dataPatterns');
132 $hasLocationTypes = $this->get('fieldTypes');
134 // Initialize all field usages to false.
136 foreach ($mapperKeys as $key) {
137 $this->_fieldUsed
[$key] = FALSE;
139 $this->_location_types
= CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
140 $sel1 = $this->_mapperFields
;
144 $js = "<script type='text/javascript'>\n";
145 $formName = 'document.forms.' . $this->_name
;
147 // Used to warn for mismatch column count or mismatch mapping.
150 for ($i = 0; $i < $this->_columnCount
; $i++
) {
151 $sel = &$this->addElement('hierselect', "mapper[$i]", ts('Mapper for Field %1', array(1 => $i)), NULL);
153 if ($this->get('savedMapping')) {
154 if (isset($mappingName[$i])) {
155 if ($mappingName[$i] != ts('- do not import -')) {
157 $mappingHeader = array_keys($this->_mapperFields
, $mappingName[$i]);
159 if (!isset($locationId) ||
!$locationId) {
160 $js .= "{$formName}['mapper[$i][1]'].style.display = 'none';\n";
163 if (!isset($phoneType) ||
!$phoneType) {
164 $js .= "{$formName}['mapper[$i][2]'].style.display = 'none';\n";
167 $js .= "{$formName}['mapper[$i][3]'].style.display = 'none';\n";
168 $defaults["mapper[$i]"] = array(
170 (isset($locationId)) ?
$locationId : "",
171 (isset($phoneType)) ?
$phoneType : "",
176 $defaults["mapper[$i]"] = array();
179 for ($k = 1; $k < 4; $k++
) {
180 $js .= "{$formName}['mapper[$i][$k]'].style.display = 'none';\n";
185 // this load section to help mapping if we ran out of saved columns when doing Load Mapping
186 $js .= "swapOptions($formName, 'mapper[$i]', 0, 3, 'hs_mapper_" . $i . "_');\n";
189 $defaults["mapper[$i]"] = array(
190 $this->defaultFromHeader($this->_columnHeaders
[$i],
196 $defaults["mapper[$i]"] = array($this->defaultFromData($dataPatterns, $i));
199 // End of load mapping.
202 $js .= "swapOptions($formName, 'mapper[$i]', 0, 3, 'hs_mapper_" . $i . "_');\n";
204 // Infer the default from the skipped headers if we have them
205 $defaults["mapper[$i]"] = array(
206 $this->defaultFromHeader($this->_columnHeaders
[$i],
213 // Otherwise guess the default from the form of the data
214 $defaults["mapper[$i]"] = array(
215 $this->defaultFromData($dataPatterns, $i),
221 $sel->setOptions(array($sel1, $sel2, (isset($sel3)) ?
$sel3 : "", (isset($sel4)) ?
$sel4 : ""));
223 $js .= "</script>\n";
224 $this->assign('initHideBoxes', $js);
226 // Set warning if mismatch in more than.
227 if (isset($mappingName)) {
228 if (($this->_columnCount
!= count($mappingName))) {
232 if ($warning != 0 && $this->get('savedMapping')) {
233 $session = CRM_Core_Session
::singleton();
234 $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.'));
237 $session = CRM_Core_Session
::singleton();
238 $session->setStatus(NULL);
241 $this->setDefaults($defaults);
243 $this->addButtons(array(
246 'name' => ts('Previous'),
250 'name' => ts('Continue'),
251 'spacing' => ' ',
256 'name' => ts('Cancel'),
263 * Global validation rules for the form.
265 * @param array $fields
266 * Posted values of the form.
269 * list of errors to be posted back to the form
271 public static function formRule($fields) {
273 // define so we avoid notices below
274 $errors['_qf_default'] = '';
276 $fieldMessage = NULL;
277 if (!array_key_exists('savedMapping', $fields)) {
278 $importKeys = array();
279 foreach ($fields['mapper'] as $mapperPart) {
280 $importKeys[] = $mapperPart[0];
282 // FIXME: should use the schema titles, not redeclare them
283 $requiredFields = array(
284 'target_contact_id' => ts('Contact ID'),
285 'activity_date_time' => ts('Activity Date'),
286 'activity_subject' => ts('Activity Subject'),
287 'activity_type_id' => ts('Activity Type ID'),
291 'used' => 'Unsupervised',
292 'contact_type' => 'Individual',
294 list($ruleFields, $threshold) = CRM_Dedupe_BAO_RuleGroup
::dedupeRuleFieldsWeight($params);
296 foreach ($importKeys as $key => $val) {
297 if (array_key_exists($val, $ruleFields)) {
298 $weightSum +
= $ruleFields[$val];
301 foreach ($ruleFields as $field => $weight) {
302 $fieldMessage .= ' ' . $field . '(weight ' . $weight . ')';
304 foreach ($requiredFields as $field => $title) {
305 if (!in_array($field, $importKeys)) {
306 if ($field == 'target_contact_id') {
307 if ($weightSum >= $threshold ||
in_array('external_identifier', $importKeys)) {
311 $errors['_qf_default'] .= ts('Missing required contact matching fields.')
312 . $fieldMessage . ' '
313 . ts('(Sum of all weights should be greater than or equal to threshold: %1).', array(1 => $threshold))
317 elseif ($field == 'activity_type_id') {
318 if (in_array('activity_label', $importKeys)) {
322 $errors['_qf_default'] .= ts('Missing required field: Provide %1 or %2',
325 2 => 'Activity Type Label',
330 $errors['_qf_default'] .= ts('Missing required field: %1', array(1 => $title)) . '<br />';
336 if (!empty($fields['saveMapping'])) {
337 $nameField = CRM_Utils_Array
::value('saveMappingName', $fields);
338 if (empty($nameField)) {
339 $errors['saveMappingName'] = ts('Name is required to save Import Mapping');
342 if (CRM_Core_BAO_Mapping
::checkMapping($nameField, CRM_Core_PseudoConstant
::getKey('CRM_Core_BAO_Mapping', 'mapping_type_id', 'Import Activity'))) {
343 $errors['saveMappingName'] = ts('Duplicate Import Mapping Name');
348 if (empty($errors['_qf_default'])) {
349 unset($errors['_qf_default']);
351 if (!empty($errors)) {
352 if (!empty($errors['saveMappingName'])) {
354 $assignError = new CRM_Core_Page();
355 $assignError->assign('mappingDetailsError', $_flag);
364 * Process the mapped fields and map it into the uploaded file.
366 * Preview the file and extract some summary statistics
368 public function postProcess() {
369 $params = $this->controller
->exportValues('MapField');
370 // Reload the mapfield if load mapping is pressed.
371 if (!empty($params['savedMapping'])) {
372 $this->set('savedMapping', $params['savedMapping']);
373 $this->controller
->resetPage($this->_name
);
377 $fileName = $this->controller
->exportValue('DataSource', 'uploadFile');
378 $seperator = $this->controller
->exportValue('DataSource', 'fieldSeparator');
379 $skipColumnHeader = $this->controller
->exportValue('DataSource', 'skipColumnHeader');
381 $mapperKeys = array();
383 $mapperKeys = $this->controller
->exportValue($this->_name
, 'mapper');
384 $mapperKeysMain = array();
385 $mapperLocType = array();
386 $mapperPhoneType = array();
388 for ($i = 0; $i < $this->_columnCount
; $i++
) {
389 $mapper[$i] = $this->_mapperFields
[$mapperKeys[$i][0]];
390 $mapperKeysMain[$i] = $mapperKeys[$i][0];
392 if ((CRM_Utils_Array
::value(1, $mapperKeys[$i])) && (is_numeric($mapperKeys[$i][1]))) {
393 $mapperLocType[$i] = $mapperKeys[$i][1];
396 $mapperLocType[$i] = NULL;
399 if ((CRM_Utils_Array
::value(2, $mapperKeys[$i])) && (!is_numeric($mapperKeys[$i][2]))) {
400 $mapperPhoneType[$i] = $mapperKeys[$i][2];
403 $mapperPhoneType[$i] = NULL;
407 $this->set('mapper', $mapper);
408 // store mapping Id to display it in the preview page
409 if (!empty($params['mappingId'])) {
410 $this->set('loadMappingId', $params['mappingId']);
413 // Updating Mapping Records.
414 if (!empty($params['updateMapping'])) {
416 $mappingFields = new CRM_Core_DAO_MappingField();
417 $mappingFields->mapping_id
= $params['mappingId'];
418 $mappingFields->find();
420 $mappingFieldsId = array();
421 while ($mappingFields->fetch()) {
422 if ($mappingFields->id
) {
423 $mappingFieldsId[$mappingFields->column_number
] = $mappingFields->id
;
427 for ($i = 0; $i < $this->_columnCount
; $i++
) {
428 $updateMappingFields = new CRM_Core_DAO_MappingField();
429 $updateMappingFields->id
= $mappingFieldsId[$i];
430 $updateMappingFields->mapping_id
= $params['mappingId'];
431 $updateMappingFields->column_number
= $i;
433 $updateMappingFields->name
= $mapper[$i];
434 $updateMappingFields->save();
438 // Saving Mapping Details and Records.
439 if (!empty($params['saveMapping'])) {
440 $mappingParams = array(
441 'name' => $params['saveMappingName'],
442 'description' => $params['saveMappingDesc'],
443 'mapping_type_id' => CRM_Core_PseudoConstant
::getKey('CRM_Core_BAO_Mapping', 'mapping_type_id', 'Import Activity'),
445 $saveMapping = CRM_Core_BAO_Mapping
::add($mappingParams);
447 for ($i = 0; $i < $this->_columnCount
; $i++
) {
448 $saveMappingFields = new CRM_Core_DAO_MappingField();
449 $saveMappingFields->mapping_id
= $saveMapping->id
;
450 $saveMappingFields->column_number
= $i;
452 $saveMappingFields->name
= $mapper[$i];
453 $saveMappingFields->save();
455 $this->set('savedMapping', $saveMappingFields->mapping_id
);
458 $parser = new CRM_Activity_Import_Parser_Activity($mapperKeysMain, $mapperLocType, $mapperPhoneType);
459 $parser->run($fileName, $seperator, $mapper, $skipColumnHeader,
460 CRM_Import_Parser
::MODE_PREVIEW
463 // add all the necessary variables to the form