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
37 * This class gets the name of the file to upload
39 class CRM_Member_Import_Form_MapField
extends CRM_Import_Form_MapField
{
47 public static $_contactType = NULL;
50 * Set variables up before form is built.
54 public function preProcess() {
55 $this->_mapperFields
= $this->get('fields');
56 asort($this->_mapperFields
);
58 $this->_columnCount
= $this->get('columnCount');
59 $this->assign('columnCount', $this->_columnCount
);
60 $this->_dataValues
= $this->get('dataValues');
61 $this->assign('dataValues', $this->_dataValues
);
63 $skipColumnHeader = $this->controller
->exportValue('DataSource', 'skipColumnHeader');
64 $this->_onDuplicate
= $this->get('onDuplicate', isset($onDuplicate) ?
$onDuplicate : "");
66 $highlightedFields = array();
67 if ($skipColumnHeader) {
68 $this->assign('skipColumnHeader', $skipColumnHeader);
69 $this->assign('rowDisplayCount', 3);
70 /* if we had a column header to skip, stash it for later */
72 $this->_columnHeaders
= $this->_dataValues
[0];
75 $this->assign('rowDisplayCount', 2);
78 //CRM-2219 removing other required fields since for updation only
79 //membership id is required.
80 if ($this->_onDuplicate
== CRM_Import_Parser
::DUPLICATE_UPDATE
) {
81 $remove = array('membership_contact_id', 'email', 'first_name', 'last_name', 'external_identifier');
82 foreach ($remove as $value) {
83 unset($this->_mapperFields
[$value]);
85 $highlightedFieldsArray = array('membership_id', 'membership_start_date', 'membership_type_id');
86 foreach ($highlightedFieldsArray as $name) {
87 $highlightedFields[] = $name;
90 elseif ($this->_onDuplicate
== CRM_Import_Parser
::DUPLICATE_SKIP
) {
91 unset($this->_mapperFields
['membership_id']);
92 $highlightedFieldsArray = array(
93 'membership_contact_id',
95 'external_identifier',
96 'membership_start_date',
99 foreach ($highlightedFieldsArray as $name) {
100 $highlightedFields[] = $name;
104 // modify field title
105 $this->_mapperFields
['status_id'] = ts('Membership Status');
106 $this->_mapperFields
['membership_type_id'] = ts('Membership Type');
108 self
::$_contactType = $this->get('contactType');
109 $this->assign('highlightedFields', $highlightedFields);
113 * Build the form object.
117 public function buildQuickForm() {
118 //to save the current mappings
119 if (!$this->get('savedMapping')) {
120 $saveDetailsName = ts('Save this field mapping');
121 $this->applyFilter('saveMappingName', 'trim');
122 $this->add('text', 'saveMappingName', ts('Name'));
123 $this->add('text', 'saveMappingDesc', ts('Description'));
126 $savedMapping = $this->get('savedMapping');
128 list($mappingName, $mappingContactType, $mappingLocation, $mappingPhoneType, $mappingRelation) = CRM_Core_BAO_Mapping
::getMappingFields($savedMapping);
130 $mappingName = $mappingName[1];
131 $mappingContactType = $mappingContactType[1];
132 $mappingLocation = CRM_Utils_Array
::value('1', $mappingLocation);
133 $mappingPhoneType = CRM_Utils_Array
::value('1', $mappingPhoneType);
134 $mappingRelation = CRM_Utils_Array
::value('1', $mappingRelation);
136 //mapping is to be loaded from database
138 $params = array('id' => $savedMapping);
140 $mappingDetails = CRM_Core_BAO_Mapping
::retrieve($params, $temp);
142 $this->assign('loadedMapping', $mappingDetails->name
);
143 $this->set('loadedMapping', $savedMapping);
145 $getMappingName = new CRM_Core_DAO_Mapping();
146 $getMappingName->id
= $savedMapping;
147 $getMappingName->mapping_type
= 'Import Memberships';
148 $getMappingName->find();
149 while ($getMappingName->fetch()) {
150 $mapperName = $getMappingName->name
;
153 $this->assign('savedName', $mapperName);
155 $this->add('hidden', 'mappingId', $savedMapping);
157 $this->addElement('checkbox', 'updateMapping', ts('Update this field mapping'), NULL);
158 $saveDetailsName = ts('Save as a new field mapping');
159 $this->add('text', 'saveMappingName', ts('Name'));
160 $this->add('text', 'saveMappingDesc', ts('Description'));
163 $this->addElement('checkbox', 'saveMapping', $saveDetailsName, NULL, array('onclick' => "showSaveDetails(this)"));
165 $this->addFormRule(array('CRM_Member_Import_Form_MapField', 'formRule'), $this);
167 //-------- end of saved mapping stuff ---------
170 $mapperKeys = array_keys($this->_mapperFields
);
171 $hasHeaders = !empty($this->_columnHeaders
);
172 $headerPatterns = $this->get('headerPatterns');
173 $dataPatterns = $this->get('dataPatterns');
174 $hasLocationTypes = $this->get('fieldTypes');
176 /* Initialize all field usages to false */
178 foreach ($mapperKeys as $key) {
179 $this->_fieldUsed
[$key] = FALSE;
181 $this->_location_types
= CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
182 $sel1 = $this->_mapperFields
;
183 if (!$this->get('onDuplicate')) {
185 unset($sel1['membership_id']);
190 $js = "<script type='text/javascript'>\n";
191 $formName = 'document.forms.' . $this->_name
;
193 //used to warn for mismatch column count or mismatch mapping
196 for ($i = 0; $i < $this->_columnCount
; $i++
) {
197 $sel = &$this->addElement('hierselect', "mapper[$i]", ts('Mapper for Field %1', array(1 => $i)), NULL);
199 if ($this->get('savedMapping')) {
200 if (isset($mappingName[$i])) {
201 if ($mappingName[$i] != ts('- do not import -')) {
203 $mappingHeader = array_keys($this->_mapperFields
, $mappingName[$i]);
205 //When locationType is not set
206 $js .= "{$formName}['mapper[$i][1]'].style.display = 'none';\n";
208 //When phoneType is not set
209 $js .= "{$formName}['mapper[$i][2]'].style.display = 'none';\n";
211 $js .= "{$formName}['mapper[$i][3]'].style.display = 'none';\n";
213 $defaults["mapper[$i]"] = array($mappingHeader[0]);
217 $defaults["mapper[$i]"] = array();
220 for ($k = 1; $k < 4; $k++
) {
221 $js .= "{$formName}['mapper[$i][$k]'].style.display = 'none';\n";
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";
230 $defaults["mapper[$i]"] = array($this->defaultFromHeader($this->_columnHeaders
[$i], $headerPatterns));
233 $defaults["mapper[$i]"] = array($this->defaultFromData($dataPatterns, $i));
236 //end of load mapping
239 $js .= "swapOptions($formName, 'mapper[$i]', 0, 3, 'hs_mapper_" . $i . "_');\n";
241 // Infer the default from the skipped headers if we have them
242 $defaults["mapper[$i]"] = array(
243 $this->defaultFromHeader($this->_columnHeaders
[$i],
246 // $defaultLocationType->id
251 // Otherwise guess the default from the form of the data
252 $defaults["mapper[$i]"] = array(
253 $this->defaultFromData($dataPatterns, $i),
254 // $defaultLocationType->id
259 $sel->setOptions(array($sel1, $sel2, (isset($sel3)) ?
$sel3 : "", (isset($sel4)) ?
$sel4 : ""));
261 $js .= "</script>\n";
262 $this->assign('initHideBoxes', $js);
264 //set warning if mismatch in more than
265 if (isset($mappingName)) {
266 if (($this->_columnCount
!= count($mappingName))) {
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.'));
275 $session = CRM_Core_Session
::singleton();
276 $session->setStatus(NULL);
279 $this->setDefaults($defaults);
281 $this->addButtons(array(
284 'name' => ts('Previous'),
288 'name' => ts('Continue'),
289 'spacing' => ' ',
294 'name' => ts('Cancel'),
300 * Global validation rules for the form.
302 * @param array $fields
303 * Posted values of the form.
309 * list of errors to be posted back to the form
311 public static function formRule($fields, $files, $self) {
314 if (!array_key_exists('savedMapping', $fields)) {
315 $importKeys = array();
316 foreach ($fields['mapper'] as $mapperPart) {
317 $importKeys[] = $mapperPart[0];
319 // FIXME: should use the schema titles, not redeclare them
320 $requiredFields = array(
321 'membership_contact_id' => ts('Contact ID'),
322 'membership_type_id' => ts('Membership Type'),
323 'membership_start_date' => ts('Membership Start Date'),
326 $contactTypeId = $self->get('contactType');
327 $contactTypes = array(
328 CRM_Import_Parser
::CONTACT_INDIVIDUAL
=> 'Individual',
329 CRM_Import_Parser
::CONTACT_HOUSEHOLD
=> 'Household',
330 CRM_Import_Parser
::CONTACT_ORGANIZATION
=> 'Organization',
333 'used' => 'Unsupervised',
334 'contact_type' => $contactTypes[$contactTypeId],
336 list($ruleFields, $threshold) = CRM_Dedupe_BAO_RuleGroup
::dedupeRuleFieldsWeight($params);
338 foreach ($importKeys as $key => $val) {
339 if (array_key_exists($val, $ruleFields)) {
340 $weightSum +
= $ruleFields[$val];
344 foreach ($ruleFields as $field => $weight) {
345 $fieldMessage .= ' ' . $field . '(weight ' . $weight . ')';
348 foreach ($requiredFields as $field => $title) {
349 if (!in_array($field, $importKeys)) {
350 if ($field == 'membership_contact_id') {
351 if ((($weightSum >= $threshold ||
in_array('external_identifier', $importKeys)) &&
352 $self->_onDuplicate
!= CRM_Import_Parser
::DUPLICATE_UPDATE
354 in_array('membership_id', $importKeys)
359 if (!isset($errors['_qf_default'])) {
360 $errors['_qf_default'] = '';
362 $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(
364 )) . ' ' . ts('(OR Membership ID if update mode.)') . '<br />';
368 if (!isset($errors['_qf_default'])) {
369 $errors['_qf_default'] = '';
371 $errors['_qf_default'] .= ts('Missing required field: %1', array(
379 if (!empty($fields['saveMapping'])) {
380 $nameField = CRM_Utils_Array
::value('saveMappingName', $fields);
381 if (empty($nameField)) {
382 $errors['saveMappingName'] = ts('Name is required to save Import Mapping');
385 if (CRM_Core_BAO_Mapping
::checkMapping($nameField, CRM_Core_PseudoConstant
::getKey('CRM_Core_BAO_Mapping', 'mapping_type_id', 'Import Membership'))) {
386 $errors['saveMappingName'] = ts('Duplicate Import Membership Mapping Name');
391 if (!empty($errors)) {
392 if (!empty($errors['saveMappingName'])) {
394 $assignError = new CRM_Core_Page();
395 $assignError->assign('mappingDetailsError', $_flag);
404 * Process the mapped fields and map it into the uploaded file
405 * preview the file and extract some summary statistics
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
);
418 $fileName = $this->controller
->exportValue('DataSource', 'uploadFile');
419 $seperator = $this->controller
->exportValue('DataSource', 'fieldSeparator');
420 $skipColumnHeader = $this->controller
->exportValue('DataSource', 'skipColumnHeader');
422 $mapperKeys = array();
424 $mapperKeys = $this->controller
->exportValue($this->_name
, 'mapper');
425 $mapperKeysMain = array();
426 $mapperLocType = array();
427 $mapperPhoneType = array();
429 for ($i = 0; $i < $this->_columnCount
; $i++
) {
430 $mapper[$i] = $this->_mapperFields
[$mapperKeys[$i][0]];
431 $mapperKeysMain[$i] = $mapperKeys[$i][0];
433 if (!empty($mapperKeys[$i][1]) && is_numeric($mapperKeys[$i][1])) {
434 $mapperLocType[$i] = $mapperKeys[$i][1];
437 $mapperLocType[$i] = NULL;
440 if (!empty($mapperKeys[$i][2]) && (!is_numeric($mapperKeys[$i][2]))) {
441 $mapperPhoneType[$i] = $mapperKeys[$i][2];
444 $mapperPhoneType[$i] = NULL;
448 $this->set('mapper', $mapper);
450 // store mapping Id to display it in the preview page
451 if (!empty($params['mappingId'])) {
452 $this->set('loadMappingId', $params['mappingId']);
454 //Updating Mapping Records
455 if (!empty($params['updateMapping'])) {
456 $mappingFields = new CRM_Core_DAO_MappingField();
457 $mappingFields->mapping_id
= $params['mappingId'];
458 $mappingFields->find();
460 $mappingFieldsId = array();
461 while ($mappingFields->fetch()) {
462 if ($mappingFields->id
) {
463 $mappingFieldsId[$mappingFields->column_number
] = $mappingFields->id
;
467 for ($i = 0; $i < $this->_columnCount
; $i++
) {
468 $updateMappingFields = new CRM_Core_DAO_MappingField();
469 $updateMappingFields->id
= $mappingFieldsId[$i];
470 $updateMappingFields->mapping_id
= $params['mappingId'];
471 $updateMappingFields->column_number
= $i;
473 $mapperKeyParts = explode('_', $mapperKeys[$i][0], 3);
474 $id = isset($mapperKeyParts[0]) ?
$mapperKeyParts[0] : NULL;
475 $first = isset($mapperKeyParts[1]) ?
$mapperKeyParts[1] : NULL;
476 $second = isset($mapperKeyParts[2]) ?
$mapperKeyParts[2] : NULL;
477 $updateMappingFields->name
= $mapper[$i];
478 $updateMappingFields->save();
482 //Saving Mapping Details and Records
483 if (!empty($params['saveMapping'])) {
484 $mappingParams = array(
485 'name' => $params['saveMappingName'],
486 'description' => $params['saveMappingDesc'],
487 'mapping_type_id' => CRM_Core_PseudoConstant
::getKey('CRM_Core_BAO_Mapping', 'mapping_type_id', 'Import Membership'),
489 $saveMapping = CRM_Core_BAO_Mapping
::add($mappingParams);
491 for ($i = 0; $i < $this->_columnCount
; $i++
) {
493 $saveMappingFields = new CRM_Core_DAO_MappingField();
494 $saveMappingFields->mapping_id
= $saveMapping->id
;
495 $saveMappingFields->column_number
= $i;
497 $mapperKeyParts = explode('_', $mapperKeys[$i][0], 3);
498 $id = isset($mapperKeyParts[0]) ?
$mapperKeyParts[0] : NULL;
499 $first = isset($mapperKeyParts[1]) ?
$mapperKeyParts[1] : NULL;
500 $second = isset($mapperKeyParts[2]) ?
$mapperKeyParts[2] : NULL;
501 $saveMappingFields->name
= $mapper[$i];
502 $saveMappingFields->save();
504 $this->set('savedMapping', $saveMappingFields->mapping_id
);
507 $parser = new CRM_Member_Import_Parser_Membership($mapperKeysMain, $mapperLocType, $mapperPhoneType);
508 $parser->run($fileName, $seperator, $mapper, $skipColumnHeader,
509 CRM_Import_Parser
::MODE_PREVIEW
, $this->get('contactType')
511 // add all the necessary variables to the form