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 'api/api.php'; | |
37 | ||
38 | /** | |
39 | * class to parse activity csv files | |
40 | */ | |
41 | class CRM_Activity_Import_Parser_Activity extends CRM_Activity_Import_Parser { | |
42 | ||
43 | protected $_mapperKeys; | |
44 | ||
45 | private $_contactIdIndex; | |
46 | private $_activityTypeIndex; | |
47 | private $_activityLabelIndex; | |
48 | private $_activityDateIndex; | |
49 | ||
50 | /** | |
ceb10dc7 | 51 | * Array of successfully imported activity id's |
6a488035 TO |
52 | * |
53 | * @array | |
54 | */ | |
55 | protected $_newActivity; | |
56 | ||
57 | /** | |
100fef9d | 58 | * Class constructor |
6a488035 TO |
59 | */ |
60 | function __construct(&$mapperKeys, $mapperLocType = NULL, $mapperPhoneType = NULL) { | |
61 | parent::__construct(); | |
62 | $this->_mapperKeys = &$mapperKeys; | |
63 | } | |
64 | ||
65 | /** | |
100fef9d | 66 | * The initializer code, called before the processing |
6a488035 TO |
67 | * |
68 | * @return void | |
69 | * @access public | |
70 | */ | |
71 | function init() { | |
cc6f3942 | 72 | $activityContact = CRM_Activity_BAO_ActivityContact::import(); |
73 | $activityTarget['target_contact_id'] = $activityContact['contact_id']; | |
6a488035 | 74 | $fields = array_merge(CRM_Activity_BAO_Activity::importableFields(), |
cc6f3942 | 75 | $activityTarget |
6a488035 TO |
76 | ); |
77 | ||
cc6f3942 | 78 | $fields = array_merge($fields, array( |
4039effc JP |
79 | 'source_contact_id' => array( |
80 | 'title' => ts('Source Contact'), | |
81 | 'headerPattern' => '/Source.Contact?/i', | |
82 | ), | |
cc6f3942 | 83 | 'activity_label' => array( |
84 | 'title' => ts('Activity Type Label'), | |
85 | 'headerPattern' => '/(activity.)?type label?/i', | |
86 | ) | |
87 | )); | |
6a488035 TO |
88 | |
89 | foreach ($fields as $name => $field) { | |
90 | $field['type'] = CRM_Utils_Array::value('type', $field, CRM_Utils_Type::T_INT); | |
91 | $field['dataPattern'] = CRM_Utils_Array::value('dataPattern', $field, '//'); | |
92 | $field['headerPattern'] = CRM_Utils_Array::value('headerPattern', $field, '//'); | |
93 | $this->addField($name, $field['title'], $field['type'], $field['headerPattern'], $field['dataPattern']); | |
94 | } | |
95 | ||
96 | $this->_newActivity = array(); | |
97 | ||
98 | $this->setActiveFields($this->_mapperKeys); | |
99 | ||
100 | // FIXME: we should do this in one place together with Form/MapField.php | |
101 | $this->_contactIdIndex = -1; | |
102 | $this->_activityTypeIndex = -1; | |
103 | $this->_activityLabelIndex = -1; | |
104 | $this->_activityDateIndex = -1; | |
105 | ||
106 | $index = 0; | |
107 | foreach ($this->_mapperKeys as $key) { | |
108 | switch ($key) { | |
109 | case 'target_contact_id': | |
110 | case 'external_identifier': | |
111 | $this->_contactIdIndex = $index; | |
112 | break; | |
113 | ||
114 | case 'activity_label': | |
115 | $this->_activityLabelIndex = $index; | |
116 | break; | |
117 | ||
118 | case 'activity_type_id': | |
119 | $this->_activityTypeIndex = $index; | |
120 | break; | |
121 | ||
122 | case 'activity_date_time': | |
123 | $this->_activityDateIndex = $index; | |
124 | break; | |
125 | } | |
126 | $index++; | |
127 | } | |
128 | } | |
129 | ||
130 | /** | |
100fef9d | 131 | * Handle the values in mapField mode |
6a488035 TO |
132 | * |
133 | * @param array $values the array of values belonging to this line | |
134 | * | |
135 | * @return boolean | |
136 | * @access public | |
137 | */ | |
138 | function mapField(&$values) { | |
a05662ef | 139 | return CRM_Import_Parser::VALID; |
6a488035 TO |
140 | } |
141 | ||
142 | /** | |
100fef9d | 143 | * Handle the values in preview mode |
6a488035 TO |
144 | * |
145 | * @param array $values the array of values belonging to this line | |
146 | * | |
147 | * @return boolean the result of this processing | |
148 | * @access public | |
149 | */ | |
150 | function preview(&$values) { | |
151 | return $this->summary($values); | |
152 | } | |
153 | ||
154 | /** | |
100fef9d | 155 | * Handle the values in summary mode |
6a488035 TO |
156 | * |
157 | * @param array $values the array of values belonging to this line | |
158 | * | |
159 | * @return boolean the result of this processing | |
160 | * @access public | |
161 | */ | |
162 | function summary(&$values) { | |
163 | $erroneousField = NULL; | |
164 | $response = $this->setActiveFieldValues($values, $erroneousField); | |
165 | $index = -1; | |
166 | $errorRequired = FALSE; | |
167 | ||
168 | if ($this->_activityTypeIndex > -1 && $this->_activityLabelIndex > -1) { | |
169 | array_unshift($values, ts('Please select either Activity Type ID OR Activity Type Label.')); | |
a05662ef | 170 | return CRM_Import_Parser::ERROR; |
6a488035 TO |
171 | } |
172 | elseif ($this->_activityLabelIndex > -1) { | |
173 | $index = $this->_activityLabelIndex; | |
174 | } | |
175 | elseif ($this->_activityTypeIndex > -1) { | |
176 | $index = $this->_activityTypeIndex; | |
177 | } | |
178 | ||
179 | if ($index < 0 or $this->_activityDateIndex < 0) { | |
180 | $errorRequired = TRUE; | |
181 | } | |
182 | else { | |
183 | $errorRequired = !CRM_Utils_Array::value($index, $values) || !CRM_Utils_Array::value($this->_activityDateIndex, $values); | |
184 | } | |
185 | ||
186 | if ($errorRequired) { | |
187 | array_unshift($values, ts('Missing required fields')); | |
a05662ef | 188 | return CRM_Import_Parser::ERROR; |
6a488035 TO |
189 | } |
190 | ||
191 | $params = &$this->getActiveFieldParams(); | |
192 | ||
193 | $errorMessage = NULL; | |
194 | ||
195 | //for date-Formats | |
196 | $session = CRM_Core_Session::singleton(); | |
197 | $dateType = $session->get('dateTypes'); | |
198 | if (!isset($params['source_contact_id'])) { | |
199 | $params['source_contact_id'] = $session->get('userID'); | |
200 | } | |
201 | foreach ($params as $key => $val) { | |
202 | if ($key == 'activity_date_time') { | |
203 | if ($val) { | |
204 | $dateValue = CRM_Utils_Date::formatDate($val, $dateType); | |
205 | if ($dateValue) { | |
206 | $params[$key] = $dateValue; | |
207 | } | |
208 | else { | |
719a6fec | 209 | CRM_Contact_Import_Parser_Contact::addToErrorMsg('Activity date', $errorMessage); |
6a488035 TO |
210 | } |
211 | } | |
212 | } | |
213 | elseif ($key == 'activity_engagement_level' && $val && | |
214 | !CRM_Utils_Rule::positiveInteger($val) | |
215 | ) { | |
719a6fec | 216 | CRM_Contact_Import_Parser_Contact::addToErrorMsg('Activity Engagement Index', $errorMessage); |
6a488035 TO |
217 | } |
218 | } | |
219 | //date-Format part ends | |
220 | ||
221 | //checking error in custom data | |
222 | $params['contact_type'] = isset($this->_contactType) ? $this->_contactType : 'Activity'; | |
223 | ||
719a6fec | 224 | CRM_Contact_Import_Parser_Contact::isErrorInCustomData($params, $errorMessage); |
6a488035 TO |
225 | |
226 | if ($errorMessage) { | |
227 | $tempMsg = "Invalid value for field(s) : $errorMessage"; | |
228 | array_unshift($values, $tempMsg); | |
229 | $errorMessage = NULL; | |
a05662ef | 230 | return CRM_Import_Parser::ERROR; |
6a488035 TO |
231 | } |
232 | ||
a05662ef | 233 | return CRM_Import_Parser::VALID; |
6a488035 TO |
234 | } |
235 | ||
236 | /** | |
100fef9d | 237 | * Handle the values in import mode |
6a488035 TO |
238 | * |
239 | * @param int $onDuplicate the code for what action to take on duplicates | |
240 | * @param array $values the array of values belonging to this line | |
241 | * | |
242 | * @return boolean the result of this processing | |
243 | * @access public | |
244 | */ | |
245 | function import($onDuplicate, &$values) { | |
246 | // first make sure this is a valid line | |
247 | $response = $this->summary($values); | |
248 | ||
a05662ef | 249 | if ($response != CRM_Import_Parser::VALID) { |
6a488035 TO |
250 | return $response; |
251 | } | |
252 | $params = &$this->getActiveFieldParams(); | |
253 | $activityLabel = array_search('activity_label', $this->_mapperKeys); | |
254 | if ($activityLabel) { | |
255 | $params = array_merge($params, array('activity_label' => $values[$activityLabel])); | |
256 | } | |
257 | //for date-Formats | |
258 | $session = CRM_Core_Session::singleton(); | |
259 | $dateType = $session->get('dateTypes'); | |
260 | if (!isset($params['source_contact_id'])) { | |
261 | $params['source_contact_id'] = $session->get('userID'); | |
262 | } | |
263 | $formatted = array(); | |
264 | $customFields = CRM_Core_BAO_CustomField::getFields(CRM_Utils_Array::value('contact_type', $params)); | |
265 | ||
266 | foreach ($params as $key => $val) { | |
267 | if ($customFieldID = CRM_Core_BAO_CustomField::getKeyID($key)) { | |
8bc84e3c | 268 | if ($key == 'activity_date_time' && $val) { |
2272a067 BS |
269 | $params[$key] = CRM_Utils_Date::formatDate($val, $dateType); |
270 | } | |
8bc84e3c | 271 | elseif (!empty($customFields[$customFieldID]) && $customFields[$customFieldID]['data_type'] == 'Date') { |
719a6fec | 272 | CRM_Contact_Import_Parser_Contact::formatCustomDate($params, $params, $dateType, $key); |
6a488035 | 273 | } |
8bc84e3c | 274 | elseif (!empty($customFields[$customFieldID]) && $customFields[$customFieldID]['data_type'] == 'Boolean') { |
6a488035 TO |
275 | $params[$key] = CRM_Utils_String::strtoboolstr($val); |
276 | } | |
277 | } | |
7cad3e54 C |
278 | elseif ($key == 'activity_date_time') { |
279 | $params[$key] = CRM_Utils_Date::formatDate($val, $dateType); | |
280 | } | |
6a488035 TO |
281 | elseif ($key == 'activity_subject') { |
282 | $params['subject'] = $val; | |
283 | } | |
284 | } | |
285 | //date-Format part ends | |
286 | require_once 'CRM/Utils/DeprecatedUtils.php'; | |
287 | $formatError = _civicrm_api3_deprecated_activity_formatted_param($params, $params, TRUE); | |
288 | ||
289 | if ($formatError) { | |
290 | array_unshift($values, $formatError['error_message']); | |
a05662ef | 291 | return CRM_Import_Parser::ERROR; |
6a488035 TO |
292 | } |
293 | ||
294 | $params['custom'] = CRM_Core_BAO_CustomField::postProcess($params, | |
295 | CRM_Core_DAO::$_nullObject, | |
296 | NULL, | |
297 | 'Activity' | |
298 | ); | |
299 | ||
300 | if ($this->_contactIdIndex < 0) { | |
301 | ||
302 | //retrieve contact id using contact dedupe rule. | |
303 | //since we are support only individual's activity import. | |
304 | $params['contact_type'] = 'Individual'; | |
305 | $params['version'] = 3; | |
306 | $error = _civicrm_api3_deprecated_duplicate_formatted_contact($params); | |
307 | ||
308 | if (CRM_Core_Error::isAPIError($error, CRM_Core_ERROR::DUPLICATE_CONTACT)) { | |
309 | $matchedIDs = explode(',', $error['error_message']['params'][0]); | |
310 | if (count($matchedIDs) > 1) { | |
311 | array_unshift($values, 'Multiple matching contact records detected for this row. The activity was not imported'); | |
a05662ef | 312 | return CRM_Import_Parser::ERROR; |
6a488035 TO |
313 | } |
314 | else { | |
315 | $cid = $matchedIDs[0]; | |
316 | $params['target_contact_id'] = $cid; | |
317 | $params['version'] = 3; | |
318 | $newActivity = civicrm_api('activity', 'create', $params); | |
a7488080 | 319 | if (!empty($newActivity['is_error'])) { |
6a488035 | 320 | array_unshift($values, $newActivity['error_message']); |
a05662ef | 321 | return CRM_Import_Parser::ERROR; |
6a488035 TO |
322 | } |
323 | ||
324 | $this->_newActivity[] = $newActivity['id']; | |
a05662ef | 325 | return CRM_Import_Parser::VALID; |
6a488035 TO |
326 | } |
327 | } | |
328 | else { | |
329 | // Using new Dedupe rule. | |
330 | $ruleParams = array( | |
331 | 'contact_type' => 'Individual', | |
332 | 'used' => 'Unsupervised', | |
333 | ); | |
334 | $fieldsArray = CRM_Dedupe_BAO_Rule::dedupeRuleFields($ruleParams); | |
335 | ||
336 | $disp = NULL; | |
337 | foreach ($fieldsArray as $value) { | |
338 | if (array_key_exists(trim($value), $params)) { | |
339 | $paramValue = $params[trim($value)]; | |
340 | if (is_array($paramValue)) { | |
341 | $disp .= $params[trim($value)][0][trim($value)] . " "; | |
342 | } | |
343 | else { | |
344 | $disp .= $params[trim($value)] . " "; | |
345 | } | |
346 | } | |
347 | } | |
348 | ||
a7488080 | 349 | if (!empty($params['external_identifier'])) { |
6a488035 TO |
350 | if ($disp) { |
351 | $disp .= "AND {$params['external_identifier']}"; | |
352 | } | |
353 | else { | |
354 | $disp = $params['external_identifier']; | |
355 | } | |
356 | } | |
357 | ||
358 | array_unshift($values, 'No matching Contact found for (' . $disp . ')'); | |
a05662ef | 359 | return CRM_Import_Parser::ERROR; |
6a488035 TO |
360 | } |
361 | } | |
362 | else { | |
a7488080 | 363 | if (!empty($params['external_identifier'])) { |
6a488035 TO |
364 | $targetContactId = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', |
365 | $params['external_identifier'], 'id', 'external_identifier' | |
366 | ); | |
367 | ||
a7488080 | 368 | if (!empty($params['target_contact_id']) && |
6a488035 TO |
369 | $params['target_contact_id'] != $targetContactId |
370 | ) { | |
371 | array_unshift($values, 'Mismatch of External identifier :' . $params['external_identifier'] . ' and Contact Id:' . $params['target_contact_id']); | |
a05662ef | 372 | return CRM_Import_Parser::ERROR; |
6a488035 TO |
373 | } |
374 | elseif ($targetContactId) { | |
375 | $params['target_contact_id'] = $targetContactId; | |
376 | } | |
377 | else { | |
378 | array_unshift($values, 'No Matching Contact for External identifier :' . $params['external_identifier']); | |
a05662ef | 379 | return CRM_Import_Parser::ERROR; |
6a488035 TO |
380 | } |
381 | } | |
382 | ||
383 | $params['version'] = 3; | |
384 | $newActivity = civicrm_api('activity', 'create', $params); | |
a7488080 | 385 | if (!empty($newActivity['is_error'])) { |
6a488035 | 386 | array_unshift($values, $newActivity['error_message']); |
a05662ef | 387 | return CRM_Import_Parser::ERROR; |
6a488035 TO |
388 | } |
389 | ||
390 | $this->_newActivity[] = $newActivity['id']; | |
a05662ef | 391 | return CRM_Import_Parser::VALID; |
6a488035 TO |
392 | } |
393 | } | |
394 | ||
395 | /** | |
100fef9d | 396 | * The initializer code, called before the processing |
6a488035 TO |
397 | * |
398 | * @return void | |
399 | * @access public | |
400 | */ | |
401 | function fini() {} | |
402 | ||
403 | } | |
404 |