3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
17 class CRM_Import_DataSource_CSV
extends CRM_Import_DataSource
{
19 NUM_ROWS_TO_INSERT
= 100;
22 * Form fields declared for this datasource.
26 protected $submittableFields = ['skipColumnHeader', 'uploadField'];
29 * Provides information about the data source.
32 * collection of info about this data source
34 public function getInfo(): array {
35 return ['title' => ts('Comma-Separated Values (CSV)')];
39 * This is function is called by the form object to get the DataSource's form snippet.
41 * It should add all fields necessary to get the data
42 * uploaded to the temporary table in the DB.
44 * @param CRM_Core_Form $form
46 * @throws \CRM_Core_Exception
48 public function buildQuickForm(&$form) {
49 $form->add('hidden', 'hidden_dataSource', 'CRM_Import_DataSource_CSV');
51 $uploadFileSize = CRM_Utils_Number
::formatUnitSize(Civi
::settings()->get('maxFileSize') . 'm', TRUE);
52 //Fetch uploadFileSize from php_ini when $config->maxFileSize is set to "no limit".
53 if (empty($uploadFileSize)) {
54 $uploadFileSize = CRM_Utils_Number
::formatUnitSize(ini_get('upload_max_filesize'), TRUE);
56 $uploadSize = round(($uploadFileSize / (1024 * 1024)), 2);
57 $form->assign('uploadSize', $uploadSize);
58 $form->add('File', 'uploadFile', ts('Import Data File'), NULL, TRUE);
59 $form->setMaxFileSize($uploadFileSize);
60 $form->addRule('uploadFile', ts('File size should be less than %1 MBytes (%2 bytes)', [
63 ]), 'maxfilesize', $uploadFileSize);
64 $form->addRule('uploadFile', ts('Input file must be in CSV format'), 'utf8File');
65 $form->addRule('uploadFile', ts('A valid file must be uploaded.'), 'uploadedfile');
67 $form->addElement('checkbox', 'skipColumnHeader', ts('First row contains column headers'));
71 * Process the form submission.
73 * @param array $params
75 * @param \CRM_Core_Form $form
77 * @throws \API_Exception
78 * @throws \CRM_Core_Exception
79 * @throws \API_Exception
81 public function postProcess(&$params, &$db, &$form) {
82 $result = self
::_CsvToTable(
83 $this->getSubmittedValue('uploadFile')['name'],
84 $this->getSubmittedValue('skipColumnHeader'),
85 $this->getSubmittedValue('fieldSeparator') ??
','
87 $this->addTrackingFieldsToTable($result['import_table_name']);
89 $this->updateUserJobMetadata('DataSource', [
90 'table_name' => $result['import_table_name'],
91 'column_headers' => $this->getSubmittedValue('skipColumnHeader') ?
$result['column_headers'] : [],
92 'number_of_columns' => $result['number_of_columns'],
97 * Create a table that matches the CSV file and populate it with the file's contents
101 * @param bool $headers
102 * Whether the first row contains headers.
103 * @param string $fieldSeparator
104 * Character that separates the various columns in the file.
107 * name of the created table
108 * @throws \CRM_Core_Exception
110 private static function _CsvToTable(
113 $fieldSeparator = ','
116 $fd = fopen($file, 'r');
118 throw new CRM_Core_Exception("Could not read $file");
120 if (filesize($file) == 0) {
121 throw new CRM_Core_Exception("$file is empty. Please upload a valid file.");
124 // support tab separated
125 if (strtolower($fieldSeparator) === 'tab' ||
126 strtolower($fieldSeparator) === '\t'
128 $fieldSeparator = "\t";
131 $firstrow = fgetcsv($fd, 0, $fieldSeparator);
133 // create the column names from the CSV header or as col_0, col_1, etc.
135 //need to get original headers.
136 $result['column_headers'] = $firstrow;
138 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
139 $columns = array_map($strtolower, $firstrow);
140 $columns = str_replace(' ', '_', $columns);
141 $columns = preg_replace('/[^a-z_]/', '', $columns);
143 // need to take care of null as well as duplicate col names.
144 $duplicateColName = FALSE;
145 if (count($columns) != count(array_unique($columns))) {
146 $duplicateColName = TRUE;
149 // need to truncate values per mysql field name length limits
150 // mysql allows 64, but we need to account for appending colKey
152 foreach ($columns as $colKey => & $colName) {
153 if (strlen($colName) > 58) {
154 $colName = substr($colName, 0, 58);
158 if (in_array('', $columns) ||
$duplicateColName) {
159 foreach ($columns as $colKey => & $colName) {
161 $colName = "col_$colKey";
163 elseif ($duplicateColName) {
164 $colName .= "_$colKey";
169 // CRM-4881: we need to quote column names, as they may be MySQL reserved words
170 foreach ($columns as & $column) {
171 $column = "`$column`";
176 foreach ($firstrow as $i => $_) {
177 $columns[] = "col_$i";
181 $table = CRM_Utils_SQL_TempTable
::build()->setDurable();
182 $tableName = $table->getName();
183 CRM_Core_DAO
::executeQuery("DROP TABLE IF EXISTS $tableName");
184 $table->createWithColumns(implode(' text, ', $columns) . ' text');
186 $numColumns = count($columns);
188 // the proper approach, but some MySQL installs do not have this enabled
189 // $load = "LOAD DATA LOCAL INFILE '$file' INTO TABLE $table FIELDS TERMINATED BY '$fieldSeparator' OPTIONALLY ENCLOSED BY '\"'";
190 // if ($headers) { $load .= ' IGNORE 1 LINES'; }
191 // $db->query($load);
193 // parse the CSV line by line and build one big INSERT (while MySQL-escaping the CSV contents)
201 while ($row = fgetcsv($fd, 0, $fieldSeparator)) {
202 // skip rows that dont match column count, else we get a sql error
203 if (count($row) != $numColumns) {
206 // A blank line will be array(0 => NULL)
207 if ($row === [NULL]) {
217 // CRM-17859 Trim non-breaking spaces from columns.
218 $row = array_map(['CRM_Import_DataSource_CSV', 'trimNonBreakingSpaces'], $row);
219 $row = array_map(['CRM_Core_DAO', 'escapeString'], $row);
220 $sql .= "('" . implode("', '", $row) . "')";
223 if ($count >= self
::NUM_ROWS_TO_INSERT
&& !empty($sql)) {
224 CRM_Core_DAO
::executeQuery("INSERT IGNORE INTO $tableName VALUES $sql");
233 CRM_Core_DAO
::executeQuery("INSERT IGNORE INTO $tableName VALUES $sql");
238 //get the import tmp table name.
239 $result['import_table_name'] = $tableName;
240 $result['number_of_columns'] = $numColumns;
245 * Trim non-breaking spaces in a multibyte-safe way.
246 * See also dev/core#2127 - avoid breaking strings ending in à or any other
247 * unicode character sharing the same 0xA0 byte as a non-breaking space.
249 * @param string $string
250 * @return string The trimmed string
252 public static function trimNonBreakingSpaces(string $string): string {
253 $encoding = mb_detect_encoding($string, NULL, TRUE);
254 if ($encoding === FALSE) {
255 // This could mean a couple things. One is that the string is
256 // ASCII-encoded but contains a non-breaking space, which causes
257 // php to fail to detect the encoding. So let's just do what we
258 // did before which works in that situation and is at least no
259 // worse in other situations.
260 return trim($string, chr(0xC2) . chr(0xA0));
262 elseif ($encoding !== 'UTF-8') {
263 $string = mb_convert_encoding($string, 'UTF-8', [$encoding]);
265 return preg_replace("/^(\u{a0})+|(\u{a0})+$/", '', $string);