Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
06b69b18 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
6a488035 TO |
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 | |
06b69b18 | 31 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | ||
36 | require_once 'CRM/Utils/DeprecatedUtils.php'; | |
37 | ||
38 | /** | |
39 | * class to parse membership csv files | |
40 | */ | |
41 | class CRM_Event_Import_Parser_Participant extends CRM_Event_Import_Parser { | |
42 | protected $_mapperKeys; | |
43 | ||
44 | private $_contactIdIndex; | |
45 | ||
46 | //private $_totalAmountIndex; | |
47 | ||
48 | private $_eventIndex; | |
49 | private $_participantStatusIndex; | |
50 | private $_participantRoleIndex; | |
51 | private $_eventTitleIndex; | |
52 | ||
53 | /** | |
ceb10dc7 | 54 | * Array of successfully imported participants id's |
6a488035 TO |
55 | * |
56 | * @array | |
57 | */ | |
58 | protected $_newParticipants; | |
59 | ||
60 | /** | |
100fef9d | 61 | * Class constructor |
6a488035 | 62 | */ |
00be9182 | 63 | public function __construct(&$mapperKeys, $mapperLocType = NULL, $mapperPhoneType = NULL) { |
6a488035 TO |
64 | parent::__construct(); |
65 | $this->_mapperKeys = &$mapperKeys; | |
66 | } | |
67 | ||
68 | /** | |
100fef9d | 69 | * The initializer code, called before the processing |
6a488035 TO |
70 | * |
71 | * @return void | |
6a488035 | 72 | */ |
00be9182 | 73 | public function init() { |
6a488035 TO |
74 | $fields = CRM_Event_BAO_Participant::importableFields($this->_contactType, FALSE); |
75 | $fields['event_id']['title'] = 'Event ID'; | |
76 | $eventfields = &CRM_Event_BAO_Event::fields(); | |
77 | $fields['event_title'] = $eventfields['event_title']; | |
78 | ||
79 | foreach ($fields as $name => $field) { | |
80 | $field['type'] = CRM_Utils_Array::value('type', $field, CRM_Utils_Type::T_INT); | |
81 | $field['dataPattern'] = CRM_Utils_Array::value('dataPattern', $field, '//'); | |
82 | $field['headerPattern'] = CRM_Utils_Array::value('headerPattern', $field, '//'); | |
83 | $this->addField($name, $field['title'], $field['type'], $field['headerPattern'], $field['dataPattern']); | |
84 | } | |
85 | ||
86 | $this->_newParticipants = array(); | |
87 | $this->setActiveFields($this->_mapperKeys); | |
88 | ||
89 | // FIXME: we should do this in one place together with Form/MapField.php | |
90 | $this->_contactIdIndex = -1; | |
91 | $this->_eventIndex = -1; | |
92 | $this->_participantStatusIndex = -1; | |
93 | $this->_participantRoleIndex = -1; | |
94 | $this->_eventTitleIndex = -1; | |
95 | ||
96 | $index = 0; | |
97 | foreach ($this->_mapperKeys as $key) { | |
98 | ||
99 | switch ($key) { | |
100 | case 'participant_contact_id': | |
101 | $this->_contactIdIndex = $index; | |
102 | break; | |
103 | ||
104 | case 'event_id': | |
105 | $this->_eventIndex = $index; | |
106 | break; | |
107 | ||
108 | case 'participant_status': | |
109 | case 'participant_status_id': | |
110 | $this->_participantStatusIndex = $index; | |
111 | break; | |
112 | ||
113 | case 'participant_role_id': | |
114 | $this->_participantRoleIndex = $index; | |
115 | break; | |
116 | ||
117 | case 'event_title': | |
118 | $this->_eventTitleIndex = $index; | |
119 | break; | |
120 | } | |
121 | $index++; | |
122 | } | |
123 | } | |
124 | ||
125 | /** | |
100fef9d | 126 | * Handle the values in mapField mode |
6a488035 | 127 | * |
d4dd1e85 TO |
128 | * @param array $values |
129 | * The array of values belonging to this line. | |
6a488035 TO |
130 | * |
131 | * @return boolean | |
6a488035 | 132 | */ |
00be9182 | 133 | public function mapField(&$values) { |
a05662ef | 134 | return CRM_Import_Parser::VALID; |
6a488035 TO |
135 | } |
136 | ||
137 | /** | |
100fef9d | 138 | * Handle the values in preview mode |
6a488035 | 139 | * |
d4dd1e85 TO |
140 | * @param array $values |
141 | * The array of values belonging to this line. | |
6a488035 | 142 | * |
a6c01b45 CW |
143 | * @return boolean |
144 | * the result of this processing | |
6a488035 | 145 | */ |
00be9182 | 146 | public function preview(&$values) { |
6a488035 TO |
147 | return $this->summary($values); |
148 | } | |
149 | ||
150 | /** | |
100fef9d | 151 | * Handle the values in summary mode |
6a488035 | 152 | * |
d4dd1e85 TO |
153 | * @param array $values |
154 | * The array of values belonging to this line. | |
6a488035 | 155 | * |
a6c01b45 CW |
156 | * @return boolean |
157 | * the result of this processing | |
6a488035 | 158 | */ |
00be9182 | 159 | public function summary(&$values) { |
6a488035 TO |
160 | $erroneousField = NULL; |
161 | ||
162 | $response = $this->setActiveFieldValues($values, $erroneousField); | |
163 | $errorRequired = FALSE; | |
164 | $index = -1; | |
165 | ||
166 | if ($this->_eventIndex > -1 && $this->_eventTitleIndex > -1) { | |
167 | array_unshift($values, ts('Select either EventID OR Event Title')); | |
a05662ef | 168 | return CRM_Import_Parser::ERROR; |
6a488035 TO |
169 | } |
170 | elseif ($this->_eventTitleIndex > -1) { | |
171 | $index = $this->_eventTitleIndex; | |
172 | } | |
173 | elseif ($this->_eventIndex > -1) { | |
174 | $index = $this->_eventIndex; | |
175 | } | |
176 | $params = &$this->getActiveFieldParams(); | |
177 | ||
178 | if (!(($index < 0) || ($this->_participantStatusIndex < 0))) { | |
179 | $errorRequired = !CRM_Utils_Array::value($this->_participantStatusIndex, $values); | |
8cc574cf | 180 | if (empty($params['event_id']) && empty($params['event_title'])) { |
719a6fec | 181 | CRM_Contact_Import_Parser_Contact::addToErrorMsg('Event', $missingField); |
6a488035 | 182 | } |
a7488080 | 183 | if (empty($params['participant_status_id'])) { |
719a6fec | 184 | CRM_Contact_Import_Parser_Contact::addToErrorMsg('Participant Status', $missingField); |
6a488035 TO |
185 | } |
186 | } | |
187 | else { | |
188 | $errorRequired = TRUE; | |
189 | $missingField = NULL; | |
190 | if ($index < 0) { | |
719a6fec | 191 | CRM_Contact_Import_Parser_Contact::addToErrorMsg('Event', $missingField); |
6a488035 TO |
192 | } |
193 | if ($this->_participantStatusIndex < 0) { | |
719a6fec | 194 | CRM_Contact_Import_Parser_Contact::addToErrorMsg('Participant Status', $missingField); |
6a488035 TO |
195 | } |
196 | } | |
197 | ||
198 | if ($errorRequired) { | |
199 | array_unshift($values, ts('Missing required field(s) :') . $missingField); | |
a05662ef | 200 | return CRM_Import_Parser::ERROR; |
6a488035 TO |
201 | } |
202 | ||
203 | $errorMessage = NULL; | |
204 | ||
205 | //for date-Formats | |
206 | $session = CRM_Core_Session::singleton(); | |
207 | $dateType = $session->get('dateTypes'); | |
208 | ||
209 | foreach ($params as $key => $val) { | |
210 | if ($val && ($key == 'participant_register_date')) { | |
211 | if ($dateValue = CRM_Utils_Date::formatDate($params[$key], $dateType)) { | |
212 | $params[$key] = $dateValue; | |
213 | } | |
214 | else { | |
719a6fec | 215 | CRM_Contact_Import_Parser_Contact::addToErrorMsg('Register Date', $errorMessage); |
6a488035 TO |
216 | } |
217 | } | |
218 | elseif ($val && ($key == 'participant_role_id' || $key == 'participant_role')) { | |
219 | $roleIDs = CRM_Event_PseudoConstant::participantRole(); | |
220 | $val = explode(',', $val); | |
221 | if ($key == 'participant_role_id') { | |
222 | foreach ($val as $role) { | |
223 | if (!in_array(trim($role), array_keys($roleIDs))) { | |
719a6fec | 224 | CRM_Contact_Import_Parser_Contact::addToErrorMsg('Participant Role Id', $errorMessage); |
6a488035 TO |
225 | break; |
226 | } | |
227 | } | |
228 | } | |
229 | else { | |
230 | foreach ($val as $role) { | |
719a6fec CW |
231 | if (!CRM_Contact_Import_Parser_Contact::in_value(trim($role), $roleIDs)) { |
232 | CRM_Contact_Import_Parser_Contact::addToErrorMsg('Participant Role', $errorMessage); | |
6a488035 TO |
233 | break; |
234 | } | |
235 | } | |
236 | } | |
237 | } | |
238 | elseif ($val && (($key == 'participant_status_id') || ($key == 'participant_status'))) { | |
239 | $statusIDs = CRM_Event_PseudoConstant::participantStatus(); | |
240 | if ($key == 'participant_status_id') { | |
241 | if (!in_array(trim($val), array_keys($statusIDs))) { | |
719a6fec | 242 | CRM_Contact_Import_Parser_Contact::addToErrorMsg('Participant Status Id', $errorMessage); |
6a488035 TO |
243 | break; |
244 | } | |
245 | } | |
719a6fec CW |
246 | elseif (!CRM_Contact_Import_Parser_Contact::in_value($val, $statusIDs)) { |
247 | CRM_Contact_Import_Parser_Contact::addToErrorMsg('Participant Status', $errorMessage); | |
6a488035 TO |
248 | break; |
249 | } | |
250 | } | |
251 | } | |
252 | //date-Format part ends | |
253 | ||
254 | $params['contact_type'] = 'Participant'; | |
255 | //checking error in custom data | |
719a6fec | 256 | CRM_Contact_Import_Parser_Contact::isErrorInCustomData($params, $errorMessage); |
6a488035 TO |
257 | |
258 | if ($errorMessage) { | |
259 | $tempMsg = "Invalid value for field(s) : $errorMessage"; | |
260 | array_unshift($values, $tempMsg); | |
261 | $errorMessage = NULL; | |
a05662ef | 262 | return CRM_Import_Parser::ERROR; |
6a488035 | 263 | } |
a05662ef | 264 | return CRM_Import_Parser::VALID; |
6a488035 TO |
265 | } |
266 | ||
267 | /** | |
100fef9d | 268 | * Handle the values in import mode |
6a488035 | 269 | * |
d4dd1e85 TO |
270 | * @param int $onDuplicate |
271 | * The code for what action to take on duplicates. | |
272 | * @param array $values | |
273 | * The array of values belonging to this line. | |
6a488035 | 274 | * |
a6c01b45 CW |
275 | * @return boolean |
276 | * the result of this processing | |
6a488035 | 277 | */ |
00be9182 | 278 | public function import($onDuplicate, &$values) { |
6a488035 TO |
279 | |
280 | // first make sure this is a valid line | |
281 | $response = $this->summary($values); | |
a05662ef | 282 | if ($response != CRM_Import_Parser::VALID) { |
6a488035 TO |
283 | return $response; |
284 | } | |
285 | $params = &$this->getActiveFieldParams(); | |
286 | $session = CRM_Core_Session::singleton(); | |
287 | $dateType = $session->get('dateTypes'); | |
288 | $formatted = array('version' => 3); | |
289 | $customFields = CRM_Core_BAO_CustomField::getFields(CRM_Utils_Array::value('contact_type', $params)); | |
290 | ||
291 | // don't add to recent items, CRM-4399 | |
292 | $formatted['skipRecentView'] = TRUE; | |
293 | ||
294 | foreach ($params as $key => $val) { | |
295 | if ($val) { | |
296 | if ($customFieldID = CRM_Core_BAO_CustomField::getKeyID($key)) { | |
297 | if ($customFields[$customFieldID]['data_type'] == 'Date') { | |
719a6fec | 298 | CRM_Contact_Import_Parser_Contact::formatCustomDate($params, $formatted, $dateType, $key); |
6a488035 TO |
299 | unset($params[$key]); |
300 | } | |
301 | elseif ($customFields[$customFieldID]['data_type'] == 'Boolean') { | |
302 | $params[$key] = CRM_Utils_String::strtoboolstr($val); | |
303 | } | |
304 | } | |
22e263ad | 305 | if ($key == 'participant_register_date') { |
39d87d1e JM |
306 | CRM_Utils_Date::convertToDefaultDate($params, $dateType, 'participant_register_date'); |
307 | $formatted['participant_register_date'] = CRM_Utils_Date::processDate($params['participant_register_date']); | |
308 | } | |
6a488035 TO |
309 | } |
310 | } | |
311 | ||
8cc574cf | 312 | if (!(!empty($params['participant_role_id']) || !empty($params['participant_role']))) { |
a7488080 | 313 | if (!empty($params['event_id'])) { |
6a488035 TO |
314 | $params['participant_role_id'] = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Event', $params['event_id'], 'default_role_id'); |
315 | } | |
316 | else { | |
317 | $eventTitle = $params['event_title']; | |
318 | $qParams = array(); | |
319 | $dao = new CRM_Core_DAO(); | |
320 | $params['participant_role_id'] = $dao->singleValueQuery("SELECT default_role_id FROM civicrm_event WHERE title = '$eventTitle' ", | |
321 | $qParams | |
322 | ); | |
323 | } | |
324 | } | |
325 | ||
326 | //date-Format part ends | |
327 | static $indieFields = NULL; | |
328 | if ($indieFields == NULL) { | |
329 | $indieFields = CRM_Event_BAO_Participant::import(); | |
330 | } | |
331 | ||
332 | $formatValues = array(); | |
333 | foreach ($params as $key => $field) { | |
334 | if ($field == NULL || $field === '') { | |
335 | continue; | |
336 | } | |
337 | ||
338 | $formatValues[$key] = $field; | |
339 | } | |
340 | ||
341 | $formatError = _civicrm_api3_deprecated_participant_formatted_param($formatValues, $formatted, TRUE); | |
342 | ||
343 | if ($formatError) { | |
344 | array_unshift($values, $formatError['error_message']); | |
a05662ef | 345 | return CRM_Import_Parser::ERROR; |
6a488035 TO |
346 | } |
347 | ||
348 | if (!CRM_Utils_Rule::integer($formatted['event_id'])) { | |
349 | array_unshift($values, ts('Invalid value for Event ID')); | |
a05662ef | 350 | return CRM_Import_Parser::ERROR; |
6a488035 TO |
351 | } |
352 | ||
a05662ef | 353 | if ($onDuplicate != CRM_Import_Parser::DUPLICATE_UPDATE) { |
6a488035 TO |
354 | $formatted['custom'] = CRM_Core_BAO_CustomField::postProcess($formatted, |
355 | CRM_Core_DAO::$_nullObject, | |
356 | NULL, | |
357 | 'Participant' | |
358 | ); | |
359 | } | |
360 | else { | |
361 | if ($formatValues['participant_id']) { | |
362 | $dao = new CRM_Event_BAO_Participant(); | |
363 | $dao->id = $formatValues['participant_id']; | |
364 | ||
365 | $formatted['custom'] = CRM_Core_BAO_CustomField::postProcess($formatted, | |
366 | CRM_Core_DAO::$_nullObject, | |
367 | $formatValues['participant_id'], | |
368 | 'Participant' | |
369 | ); | |
370 | if ($dao->find(TRUE)) { | |
371 | $ids = array( | |
372 | 'participant' => $formatValues['participant_id'], | |
373 | 'userId' => $session->get('userID'), | |
374 | ); | |
375 | $participantValues = array(); | |
376 | //@todo calling api functions directly is not supported | |
377 | $newParticipant = _civicrm_api3_deprecated_participant_check_params($formatted, $participantValues, FALSE); | |
378 | if ($newParticipant['error_message']) { | |
379 | array_unshift($values, $newParticipant['error_message']); | |
a05662ef | 380 | return CRM_Import_Parser::ERROR; |
6a488035 TO |
381 | } |
382 | $newParticipant = CRM_Event_BAO_Participant::create($formatted, $ids); | |
a7488080 | 383 | if (!empty($formatted['fee_level'])) { |
6a488035 TO |
384 | $otherParams = array( |
385 | 'fee_label' => $formatted['fee_level'], | |
21dfd5f5 | 386 | 'event_id' => $newParticipant->event_id, |
6a488035 TO |
387 | ); |
388 | CRM_Price_BAO_LineItem::syncLineItems($newParticipant->id, 'civicrm_participant', $newParticipant->fee_amount, $otherParams); | |
389 | } | |
390 | ||
391 | $this->_newParticipant[] = $newParticipant->id; | |
a05662ef | 392 | return CRM_Import_Parser::VALID; |
6a488035 TO |
393 | } |
394 | else { | |
395 | array_unshift($values, 'Matching Participant record not found for Participant ID ' . $formatValues['participant_id'] . '. Row was skipped.'); | |
a05662ef | 396 | return CRM_Import_Parser::ERROR; |
6a488035 TO |
397 | } |
398 | } | |
399 | } | |
400 | ||
401 | if ($this->_contactIdIndex < 0) { | |
402 | ||
403 | //retrieve contact id using contact dedupe rule | |
404 | $formatValues['contact_type'] = $this->_contactType; | |
405 | $formatValues['version'] = 3; | |
406 | $error = _civicrm_api3_deprecated_check_contact_dedupe($formatValues); | |
407 | ||
408 | if (CRM_Core_Error::isAPIError($error, CRM_Core_ERROR::DUPLICATE_CONTACT)) { | |
409 | $matchedIDs = explode(',', $error['error_message']['params'][0]); | |
410 | if (count($matchedIDs) >= 1) { | |
411 | foreach ($matchedIDs as $contactId) { | |
412 | $formatted['contact_id'] = $contactId; | |
413 | $formatted['version'] = 3; | |
414 | $newParticipant = _civicrm_api3_deprecated_create_participant_formatted($formatted, $onDuplicate); | |
415 | } | |
416 | } | |
417 | } | |
418 | else { | |
419 | // Using new Dedupe rule. | |
420 | $ruleParams = array( | |
421 | 'contact_type' => $this->_contactType, | |
422 | 'used' => 'Unsupervised', | |
423 | ); | |
424 | $fieldsArray = CRM_Dedupe_BAO_Rule::dedupeRuleFields($ruleParams); | |
425 | ||
426 | $disp = ''; | |
427 | foreach ($fieldsArray as $value) { | |
428 | if (array_key_exists(trim($value), $params)) { | |
429 | $paramValue = $params[trim($value)]; | |
430 | if (is_array($paramValue)) { | |
431 | $disp .= $params[trim($value)][0][trim($value)] . " "; | |
432 | } | |
433 | else { | |
434 | $disp .= $params[trim($value)] . " "; | |
435 | } | |
436 | } | |
437 | } | |
438 | ||
a7488080 | 439 | if (!empty($params['external_identifier'])) { |
6a488035 TO |
440 | if ($disp) { |
441 | $disp .= "AND {$params['external_identifier']}"; | |
442 | } | |
443 | else { | |
444 | $disp = $params['external_identifier']; | |
445 | } | |
446 | } | |
447 | ||
448 | array_unshift($values, 'No matching Contact found for (' . $disp . ')'); | |
a05662ef | 449 | return CRM_Import_Parser::ERROR; |
6a488035 TO |
450 | } |
451 | } | |
452 | else { | |
a7488080 | 453 | if (!empty($formatValues['external_identifier'])) { |
6a488035 TO |
454 | $checkCid = new CRM_Contact_DAO_Contact(); |
455 | $checkCid->external_identifier = $formatValues['external_identifier']; | |
456 | $checkCid->find(TRUE); | |
457 | if ($checkCid->id != $formatted['contact_id']) { | |
458 | array_unshift($values, 'Mismatch of External identifier :' . $formatValues['external_identifier'] . ' and Contact Id:' . $formatted['contact_id']); | |
a05662ef | 459 | return CRM_Import_Parser::ERROR; |
6a488035 TO |
460 | } |
461 | } | |
462 | ||
463 | $newParticipant = _civicrm_api3_deprecated_create_participant_formatted($formatted, $onDuplicate); | |
464 | } | |
465 | ||
466 | if (is_array($newParticipant) && civicrm_error($newParticipant)) { | |
a05662ef | 467 | if ($onDuplicate == CRM_Import_Parser::DUPLICATE_SKIP) { |
6a488035 TO |
468 | |
469 | $contactID = CRM_Utils_Array::value('contactID', $newParticipant); | |
470 | $participantID = CRM_Utils_Array::value('participantID', $newParticipant); | |
471 | $url = CRM_Utils_System::url('civicrm/contact/view/participant', | |
472 | "reset=1&id={$participantID}&cid={$contactID}&action=view", TRUE | |
473 | ); | |
474 | if (is_array($newParticipant['error_message']) && | |
475 | ($participantID == $newParticipant['error_message']['params'][0]) | |
476 | ) { | |
477 | array_unshift($values, $url); | |
a05662ef | 478 | return CRM_Import_Parser::DUPLICATE; |
6a488035 TO |
479 | } |
480 | elseif ($newParticipant['error_message']) { | |
481 | array_unshift($values, $newParticipant['error_message']); | |
a05662ef | 482 | return CRM_Import_Parser::ERROR; |
6a488035 | 483 | } |
a05662ef | 484 | return CRM_Import_Parser::ERROR; |
6a488035 TO |
485 | } |
486 | } | |
487 | ||
488 | if (!(is_array($newParticipant) && civicrm_error($newParticipant))) { | |
489 | $this->_newParticipants[] = CRM_Utils_Array::value('id', $newParticipant); | |
490 | } | |
491 | ||
a05662ef | 492 | return CRM_Import_Parser::VALID; |
6a488035 TO |
493 | } |
494 | ||
495 | /** | |
ceb10dc7 | 496 | * Get the array of successfully imported Participation ids |
6a488035 TO |
497 | * |
498 | * @return array | |
6a488035 | 499 | */ |
00be9182 | 500 | public function &getImportedParticipations() { |
6a488035 TO |
501 | return $this->_newParticipants; |
502 | } | |
503 | ||
504 | /** | |
100fef9d | 505 | * The initializer code, called before the processing |
6a488035 TO |
506 | * |
507 | * @return void | |
6a488035 | 508 | */ |
6ea503d4 TO |
509 | public function fini() { |
510 | } | |
6a488035 | 511 | } |