3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
36 require_once 'api/api.php';
39 * class to parse activity csv files
41 class CRM_Activity_Import_Parser_Activity
extends CRM_Activity_Import_Parser
{
43 protected $_mapperKeys;
45 private $_contactIdIndex;
46 private $_activityTypeIndex;
47 private $_activityLabelIndex;
48 private $_activityDateIndex;
51 * Array of successfully imported activity id's
55 protected $_newActivity;
60 function __construct(&$mapperKeys, $mapperLocType = NULL, $mapperPhoneType = NULL) {
61 parent
::__construct();
62 $this->_mapperKeys
= &$mapperKeys;
66 * the initializer code, called before the processing
72 $activityContact = CRM_Activity_BAO_ActivityContact
::import();
73 $activityTarget['target_contact_id'] = $activityContact['contact_id'];
74 $fields = array_merge(CRM_Activity_BAO_Activity
::importableFields(),
78 $fields = array_merge($fields, array(
79 'source_contact_id' => array(
80 'title' => ts('Source Contact'),
81 'headerPattern' => '/Source.Contact?/i',
83 'activity_label' => array(
84 'title' => ts('Activity Type Label'),
85 'headerPattern' => '/(activity.)?type label?/i',
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']);
96 $this->_newActivity
= array();
98 $this->setActiveFields($this->_mapperKeys
);
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;
107 foreach ($this->_mapperKeys
as $key) {
109 case 'target_contact_id':
110 case 'external_identifier':
111 $this->_contactIdIndex
= $index;
114 case 'activity_label':
115 $this->_activityLabelIndex
= $index;
118 case 'activity_type_id':
119 $this->_activityTypeIndex
= $index;
122 case 'activity_date_time':
123 $this->_activityDateIndex
= $index;
131 * handle the values in mapField mode
133 * @param array $values the array of values belonging to this line
138 function mapField(&$values) {
139 return CRM_Import_Parser
::VALID
;
143 * handle the values in preview mode
145 * @param array $values the array of values belonging to this line
147 * @return boolean the result of this processing
150 function preview(&$values) {
151 return $this->summary($values);
155 * handle the values in summary mode
157 * @param array $values the array of values belonging to this line
159 * @return boolean the result of this processing
162 function summary(&$values) {
163 $erroneousField = NULL;
164 $response = $this->setActiveFieldValues($values, $erroneousField);
166 $errorRequired = FALSE;
168 if ($this->_activityTypeIndex
> -1 && $this->_activityLabelIndex
> -1) {
169 array_unshift($values, ts('Please select either Activity Type ID OR Activity Type Label.'));
170 return CRM_Import_Parser
::ERROR
;
172 elseif ($this->_activityLabelIndex
> -1) {
173 $index = $this->_activityLabelIndex
;
175 elseif ($this->_activityTypeIndex
> -1) {
176 $index = $this->_activityTypeIndex
;
179 if ($index < 0 or $this->_activityDateIndex
< 0) {
180 $errorRequired = TRUE;
183 $errorRequired = !CRM_Utils_Array
::value($index, $values) ||
!CRM_Utils_Array
::value($this->_activityDateIndex
, $values);
186 if ($errorRequired) {
187 array_unshift($values, ts('Missing required fields'));
188 return CRM_Import_Parser
::ERROR
;
191 $params = &$this->getActiveFieldParams();
193 $errorMessage = NULL;
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');
201 foreach ($params as $key => $val) {
202 if ($key == 'activity_date_time') {
204 $dateValue = CRM_Utils_Date
::formatDate($val, $dateType);
206 $params[$key] = $dateValue;
209 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Activity date', $errorMessage);
213 elseif ($key == 'activity_engagement_level' && $val &&
214 !CRM_Utils_Rule
::positiveInteger($val)
216 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Activity Engagement Index', $errorMessage);
219 //date-Format part ends
221 //checking error in custom data
222 $params['contact_type'] = isset($this->_contactType
) ?
$this->_contactType
: 'Activity';
224 CRM_Contact_Import_Parser_Contact
::isErrorInCustomData($params, $errorMessage);
227 $tempMsg = "Invalid value for field(s) : $errorMessage";
228 array_unshift($values, $tempMsg);
229 $errorMessage = NULL;
230 return CRM_Import_Parser
::ERROR
;
233 return CRM_Import_Parser
::VALID
;
237 * handle the values in import mode
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
242 * @return boolean the result of this processing
245 function import($onDuplicate, &$values) {
246 // first make sure this is a valid line
247 $response = $this->summary($values);
249 if ($response != CRM_Import_Parser
::VALID
) {
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]));
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');
263 $formatted = array();
264 $customFields = CRM_Core_BAO_CustomField
::getFields(CRM_Utils_Array
::value('contact_type', $params));
266 foreach ($params as $key => $val) {
267 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($key)) {
269 $params[$key] = CRM_Utils_Date
::formatDate($val, $dateType);
271 elseif ($customFields[$customFieldID]['data_type'] == 'Date') {
272 CRM_Contact_Import_Parser_Contact
::formatCustomDate($params, $params, $dateType, $key);
274 elseif ($customFields[$customFieldID]['data_type'] == 'Boolean') {
275 $params[$key] = CRM_Utils_String
::strtoboolstr($val);
278 elseif ($key == 'activity_date_time') {
279 $params[$key] = CRM_Utils_Date
::formatDate($val, $dateType);
281 elseif ($key == 'activity_subject') {
282 $params['subject'] = $val;
285 //date-Format part ends
286 require_once 'CRM/Utils/DeprecatedUtils.php';
287 $formatError = _civicrm_api3_deprecated_activity_formatted_param($params, $params, TRUE);
290 array_unshift($values, $formatError['error_message']);
291 return CRM_Import_Parser
::ERROR
;
294 $params['custom'] = CRM_Core_BAO_CustomField
::postProcess($params,
295 CRM_Core_DAO
::$_nullObject,
300 if ($this->_contactIdIndex
< 0) {
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);
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');
312 return CRM_Import_Parser
::ERROR
;
315 $cid = $matchedIDs[0];
316 $params['target_contact_id'] = $cid;
317 $params['version'] = 3;
318 $newActivity = civicrm_api('activity', 'create', $params);
319 if (!empty($newActivity['is_error'])) {
320 array_unshift($values, $newActivity['error_message']);
321 return CRM_Import_Parser
::ERROR
;
324 $this->_newActivity
[] = $newActivity['id'];
325 return CRM_Import_Parser
::VALID
;
329 // Using new Dedupe rule.
331 'contact_type' => 'Individual',
332 'used' => 'Unsupervised',
334 $fieldsArray = CRM_Dedupe_BAO_Rule
::dedupeRuleFields($ruleParams);
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)] . " ";
344 $disp .= $params[trim($value)] . " ";
349 if (!empty($params['external_identifier'])) {
351 $disp .= "AND {$params['external_identifier']}";
354 $disp = $params['external_identifier'];
358 array_unshift($values, 'No matching Contact found for (' . $disp . ')');
359 return CRM_Import_Parser
::ERROR
;
363 if (!empty($params['external_identifier'])) {
364 $targetContactId = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
365 $params['external_identifier'], 'id', 'external_identifier'
368 if (!empty($params['target_contact_id']) &&
369 $params['target_contact_id'] != $targetContactId
371 array_unshift($values, 'Mismatch of External identifier :' . $params['external_identifier'] . ' and Contact Id:' . $params['target_contact_id']);
372 return CRM_Import_Parser
::ERROR
;
374 elseif ($targetContactId) {
375 $params['target_contact_id'] = $targetContactId;
378 array_unshift($values, 'No Matching Contact for External identifier :' . $params['external_identifier']);
379 return CRM_Import_Parser
::ERROR
;
383 $params['version'] = 3;
384 $newActivity = civicrm_api('activity', 'create', $params);
385 if (!empty($newActivity['is_error'])) {
386 array_unshift($values, $newActivity['error_message']);
387 return CRM_Import_Parser
::ERROR
;
390 $this->_newActivity
[] = $newActivity['id'];
391 return CRM_Import_Parser
::VALID
;
396 * the initializer code, called before the processing