3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
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
37 abstract class CRM_Member_Import_Parser
extends CRM_Import_Parser
{
51 * Seperator being used
53 protected $_seperator;
56 * Total number of lines in file
58 protected $_lineCount;
61 * Whether the file has a column header or not
65 protected $_haveColumnHeader;
68 * @param string $fileName
69 * @param string $seperator
71 * @param bool $skipColumnHeader
73 * @param int $contactType
74 * @param int $onDuplicate
79 function run($fileName,
82 $skipColumnHeader = FALSE,
83 $mode = self
::MODE_PREVIEW
,
84 $contactType = self
::CONTACT_INDIVIDUAL
,
85 $onDuplicate = self
::DUPLICATE_SKIP
87 if (!is_array($fileName)) {
88 CRM_Core_Error
::fatal();
90 $fileName = $fileName['name'];
92 switch ($contactType) {
93 case self
::CONTACT_INDIVIDUAL
:
94 $this->_contactType
= 'Individual';
97 case self
::CONTACT_HOUSEHOLD
:
98 $this->_contactType
= 'Household';
101 case self
::CONTACT_ORGANIZATION
:
102 $this->_contactType
= 'Organization';
107 $this->_haveColumnHeader
= $skipColumnHeader;
109 $this->_seperator
= $seperator;
111 $fd = fopen($fileName, "r");
116 $this->_lineCount
= $this->_warningCount
= 0;
117 $this->_invalidRowCount
= $this->_validCount
= 0;
118 $this->_totalCount
= $this->_conflictCount
= 0;
120 $this->_errors
= array();
121 $this->_warnings
= array();
122 $this->_conflicts
= array();
124 $this->_fileSize
= number_format(filesize($fileName) / 1024.0, 2);
126 if ($mode == self
::MODE_MAPFIELD
) {
127 $this->_rows
= array();
130 $this->_activeFieldCount
= count($this->_activeFields
);
136 $values = fgetcsv($fd, 8192, $seperator);
141 self
::encloseScrub($values);
143 // skip column header if we're not in mapfield mode
144 if ($mode != self
::MODE_MAPFIELD
&& $skipColumnHeader) {
145 $skipColumnHeader = FALSE;
149 /* trim whitespace around the values */
152 foreach ($values as $k => $v) {
153 $values[$k] = trim($v, " \t\r\n");
155 if (CRM_Utils_System
::isNull($values)) {
159 $this->_totalCount++
;
161 if ($mode == self
::MODE_MAPFIELD
) {
162 $returnCode = $this->mapField($values);
164 elseif ($mode == self
::MODE_PREVIEW
) {
165 $returnCode = $this->preview($values);
167 elseif ($mode == self
::MODE_SUMMARY
) {
168 $returnCode = $this->summary($values);
170 elseif ($mode == self
::MODE_IMPORT
) {
171 $returnCode = $this->import($onDuplicate, $values);
174 $returnCode = self
::ERROR
;
177 // note that a line could be valid but still produce a warning
178 if ($returnCode & self
::VALID
) {
179 $this->_validCount++
;
180 if ($mode == self
::MODE_MAPFIELD
) {
181 $this->_rows
[] = $values;
182 $this->_activeFieldCount
= max($this->_activeFieldCount
, count($values));
186 if ($returnCode & self
::WARNING
) {
187 $this->_warningCount++
;
188 if ($this->_warningCount
< $this->_maxWarningCount
) {
189 $this->_warningCount
[] = $line;
193 if ($returnCode & self
::ERROR
) {
194 $this->_invalidRowCount++
;
195 if ($this->_invalidRowCount
< $this->_maxErrorCount
) {
196 $recordNumber = $this->_lineCount
;
197 array_unshift($values, $recordNumber);
198 $this->_errors
[] = $values;
202 if ($returnCode & self
::CONFLICT
) {
203 $this->_conflictCount++
;
204 $recordNumber = $this->_lineCount
;
205 array_unshift($values, $recordNumber);
206 $this->_conflicts
[] = $values;
209 if ($returnCode & self
::DUPLICATE
) {
210 if ($returnCode & self
::MULTIPLE_DUPE
) {
211 /* TODO: multi-dupes should be counted apart from singles
212 * on non-skip action */
214 $this->_duplicateCount++
;
215 $recordNumber = $this->_lineCount
;
216 array_unshift($values, $recordNumber);
217 $this->_duplicates
[] = $values;
218 if ($onDuplicate != self
::DUPLICATE_SKIP
) {
219 $this->_validCount++
;
223 // we give the derived class a way of aborting the process
224 // note that the return code could be multiple code or'ed together
225 if ($returnCode & self
::STOP
) {
229 // if we are done processing the maxNumber of lines, break
230 if ($this->_maxLinesToProcess
> 0 && $this->_validCount
>= $this->_maxLinesToProcess
) {
237 if ($mode == self
::MODE_PREVIEW ||
$mode == self
::MODE_IMPORT
) {
238 $customHeaders = $mapper;
240 $customfields = CRM_Core_BAO_CustomField
::getFields('Membership');
241 foreach ($customHeaders as $key => $value) {
242 if ($id = CRM_Core_BAO_CustomField
::getKeyID($value)) {
243 $customHeaders[$key] = $customfields[$id][0];
246 if ($this->_invalidRowCount
) {
247 // removed view url for invlaid contacts
248 $headers = array_merge(array(ts('Line Number'),
253 $this->_errorFileName
= self
::errorFileName(self
::ERROR
);
255 self
::exportCSV($this->_errorFileName
, $headers, $this->_errors
);
257 if ($this->_conflictCount
) {
258 $headers = array_merge(array(ts('Line Number'),
263 $this->_conflictFileName
= self
::errorFileName(self
::CONFLICT
);
264 self
::exportCSV($this->_conflictFileName
, $headers, $this->_conflicts
);
266 if ($this->_duplicateCount
) {
267 $headers = array_merge(array(ts('Line Number'),
268 ts('View Membership URL'),
273 $this->_duplicateFileName
= self
::errorFileName(self
::DUPLICATE
);
274 self
::exportCSV($this->_duplicateFileName
, $headers, $this->_duplicates
);
277 return $this->fini();
281 * Given a list of the importable field keys that the user has selected
282 * set the active fields array to this list
284 * @param array mapped array of values
288 public function setActiveFields($fieldKeys) {
289 $this->_activeFieldCount
= count($fieldKeys);
290 foreach ($fieldKeys as $key) {
291 if (empty($this->_fields
[$key])) {
292 $this->_activeFields
[] = new CRM_Member_Import_Field('', ts('- do not import -'));
295 $this->_activeFields
[] = clone($this->_fields
[$key]);
301 * Format the field values for input to the api
303 * @return array (reference ) associative array of name/value pairs
305 public function &getActiveFieldParams() {
307 for ($i = 0; $i < $this->_activeFieldCount
; $i++
) {
308 if (isset($this->_activeFields
[$i]->_value
)
309 && !isset($params[$this->_activeFields
[$i]->_name
])
310 && !isset($this->_activeFields
[$i]->_related
)
313 $params[$this->_activeFields
[$i]->_name
] = $this->_activeFields
[$i]->_value
;
320 * @param string $name
323 * @param string $headerPattern
324 * @param string $dataPattern
326 public function addField($name, $title, $type = CRM_Utils_Type
::T_INT
, $headerPattern = '//', $dataPattern = '//') {
328 $this->_fields
['doNotImport'] = new CRM_Member_Import_Field($name, $title, $type, $headerPattern, $dataPattern);
332 //$tempField = CRM_Contact_BAO_Contact::importableFields('Individual', null );
333 $tempField = CRM_Contact_BAO_Contact
::importableFields('All', NULL);
334 if (!array_key_exists($name, $tempField)) {
335 $this->_fields
[$name] = new CRM_Member_Import_Field($name, $title, $type, $headerPattern, $dataPattern);
338 $this->_fields
[$name] = new CRM_Contact_Import_Field($name, $title, $type, $headerPattern, $dataPattern,
339 CRM_Utils_Array
::value('hasLocationType', $tempField[$name])
346 * Store parser values
348 * @param CRM_Core_Session $store
354 public function set($store, $mode = self
::MODE_SUMMARY
) {
355 $store->set('fileSize', $this->_fileSize
);
356 $store->set('lineCount', $this->_lineCount
);
357 $store->set('seperator', $this->_seperator
);
358 $store->set('fields', $this->getSelectValues());
359 $store->set('fieldTypes', $this->getSelectTypes());
361 $store->set('headerPatterns', $this->getHeaderPatterns());
362 $store->set('dataPatterns', $this->getDataPatterns());
363 $store->set('columnCount', $this->_activeFieldCount
);
365 $store->set('totalRowCount', $this->_totalCount
);
366 $store->set('validRowCount', $this->_validCount
);
367 $store->set('invalidRowCount', $this->_invalidRowCount
);
368 $store->set('conflictRowCount', $this->_conflictCount
);
370 switch ($this->_contactType
) {
372 $store->set('contactType', CRM_Import_Parser
::CONTACT_INDIVIDUAL
);
376 $store->set('contactType', CRM_Import_Parser
::CONTACT_HOUSEHOLD
);
380 $store->set('contactType', CRM_Import_Parser
::CONTACT_ORGANIZATION
);
383 if ($this->_invalidRowCount
) {
384 $store->set('errorsFileName', $this->_errorFileName
);
386 if ($this->_conflictCount
) {
387 $store->set('conflictsFileName', $this->_conflictFileName
);
389 if (isset($this->_rows
) && !empty($this->_rows
)) {
390 $store->set('dataValues', $this->_rows
);
393 if ($mode == self
::MODE_IMPORT
) {
394 $store->set('duplicateRowCount', $this->_duplicateCount
);
395 if ($this->_duplicateCount
) {
396 $store->set('duplicatesFileName', $this->_duplicateFileName
);
402 * Export data to a CSV file
404 * @param string $fileName
405 * @param array $header
410 public static function exportCSV($fileName, $header, $data) {
412 $fd = fopen($fileName, 'w');
414 foreach ($header as $key => $value) {
415 $header[$key] = "\"$value\"";
417 $config = CRM_Core_Config
::singleton();
418 $output[] = implode($config->fieldSeparator
, $header);
420 foreach ($data as $datum) {
421 foreach ($datum as $key => $value) {
422 if (is_array($value)) {
423 foreach ($value[0] as $k1 => $v1) {
424 if ($k1 == 'location_type_id') {
431 $datum[$key] = "\"$value\"";
434 $output[] = implode($config->fieldSeparator
, $datum);
436 fwrite($fd, implode("\n", $output));