/usr/share/php/Horde/Data/Csv.php is in php-horde-data 2.1.4-3ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 | <?php
/**
* @category Horde
* @package Data
*/
/**
* Horde_Data implementation for comma-separated data (CSV).
*
* Copyright 1999-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you
* did not receive this file, see http://www.horde.org/licenses/lgpl21.
*
* @author Jan Schneider <jan@horde.org>
* @author Chuck Hagenbuch <chuck@horde.org>
* @category Horde
* @package Data
*/
class Horde_Data_Csv extends Horde_Data_Base
{
/**
* MIME content type.
*
* @var string
*/
protected $_contentType = 'application/csv';
/**
* File extension.
*
* @var string
*/
protected $_extension = 'csv';
/**
* Imports and parses a CSV file.
*
* @param string $filename The name of the file to parse.
* @param boolean $header Does the first line contain the field/column
* names?
* @param string $sep The field/column separator.
* @param string $quote The quoting character.
* @param integer $fields The number or fields/columns.
* @param string $charset The file's charset.
* @param string $crlf The file's linefeed characters.
*
* @return array A two-dimensional array of all imported data rows. If
* $header was true the rows are associative arrays with the
* field/column names as the keys.
* @throws Horde_Data_Exception
*/
public function importFile($filename, $header = false, $sep = ',',
$quote = '', $fields = null,
$import_mapping = array(), $charset = null,
$crlf = null)
{
if (empty($fields)) {
return array();
}
$conf = array(
'length' => $fields,
'quote' => $quote,
'separator' => $sep
);
$fp = @fopen($filename, 'r');
if (!$fp) {
throw new Horde_Data_Exception(Horde_Data_Translation::t("Cannot open file."));
}
/* Strip and keep the first line if it contains the field names. */
if ($header) {
$head = self::getCsv($fp, $conf);
if (!$head) {
return array();
}
if (!empty($charset)) {
$head = Horde_String::convertCharset($head, $charset, 'UTF-8');
}
}
$data = array();
while ($line = self::getCsv($fp, $conf)) {
if (!empty($charset)) {
$line = Horde_String::convertCharset($line, $charset, 'UTF-8');
}
if (!isset($head)) {
$data[] = $line;
} else {
$newline = array();
for ($i = 0; $i < count($head); $i++) {
if (isset($import_mapping[$head[$i]])) {
$head[$i] = $import_mapping[$head[$i]];
}
$cell = $line[$i];
$cell = preg_replace("/\"\"/", "\"", $cell);
$newline[$head[$i]] = empty($cell) ? '' : $cell;
}
$data[] = $newline;
}
}
return $data;
}
/**
* Builds a CSV file from a given data structure and returns it as a
* string.
*
* @param array $data A two-dimensional array containing the data set.
* @param boolean $header If true, the rows of $data are associative
* arrays with field names as their keys.
*
* @return string The CSV data.
*/
public function exportData($data, $header = false,
$export_mapping = array())
{
if (!is_array($data) || count($data) == 0) {
return '';
}
$export = '';
$eol = "\n";
$head = array_keys(current($data));
if ($header) {
foreach ($head as $key) {
if (!empty($key)) {
if (isset($export_mapping[$key])) {
$key = $export_mapping[$key];
}
$export .= '"' . str_replace('"', '\\"', $key) . '"';
}
$export .= ',';
}
$export = substr($export, 0, -1) . $eol;
}
foreach ($data as $row) {
foreach ($head as $key) {
$cell = $row[$key];
if (!empty($cell) || $cell === 0) {
$export .= '"' . str_replace('"', '\\"', $cell) . '"';
}
$export .= ',';
}
$export = substr($export, 0, -1) . $eol;
}
return $export;
}
/**
* Builds a CSV file from a given data structure and triggers its
* download. It DOES NOT exit the current script but only outputs the
* correct headers and data.
*
* @param string $filename The name of the file to be downloaded.
* @param array $data A two-dimensional array containing the data
* set.
* @param boolean $header If true, the rows of $data are associative
* arrays with field names as their keys.
*/
public function exportFile($filename, $data, $header = false,
$export_mapping = array())
{
if (!isset($this->_browser)) {
throw new LogicException('Missing browser parameter.');
}
$export = $this->exportData($data, $header, $export_mapping);
$this->_browser->downloadHeaders($filename, 'application/csv', false, strlen($export));
echo $export;
}
/**
* Takes all necessary actions for the given import step, parameters and
* form values and returns the next necessary step.
*
* @param integer $action The current step. One of the IMPORT_* constants.
* @param array $param An associative array containing needed
* parameters for the current step. Keys for this
* driver:
* - check_charset: (boolean) Do some checks to see if the correct
* charset has been provided. Throws charset exception
* on error.
* - import_mapping: TODO
*
* @return mixed Either the next step as an integer constant or imported
* data set after the final step.
* @throws Horde_Data_Exception
* @throws Horde_Data_Exception_Charset
*/
public function nextStep($action, array $param = array())
{
switch ($action) {
case Horde_Data::IMPORT_FILE:
parent::nextStep($action, $param);
/* Move uploaded file so that we can read it again in the next
step after the user gave some format details. */
$file_name = $_FILES['import_file']['tmp_name'];
if (($file_data = file_get_contents($file_name)) === false) {
throw new Horde_Data_Exception(Horde_Data_Translation::t("The uploaded file could not be saved."));
}
/* Do charset checking now, if requested. */
if (isset($param['check_charset'])) {
$charset = isset($this->_vars->charset)
? Horde_String::lower($this->_vars->charset)
: 'utf-8';
switch ($charset) {
case 'utf-8':
$error = !Horde_String::validUtf8($file_data);
break;
default:
$error = ($file_data != Horde_String::convertCharset(Horde_String::convertCharset($file_data, $charset, 'UTF-8'), 'UTF-8', $charset));
break;
}
if ($error) {
$e = new Horde_Data_Exception_Charset(Horde_Data_Translation::t("Incorrect charset given for the data."));
$e->badCharset = $charset;
throw $e;
}
}
$this->storage->set('charset', $this->_vars->charset);
$this->storage->set('file_data', $file_data);
/* Read the file's first two lines to show them to the user. */
$first_lines = '';
if ($fp = @fopen($file_name, 'r')) {
for ($line_no = 1, $line = fgets($fp);
$line_no <= 3 && $line;
$line_no++, $line = fgets($fp)) {
$line = Horde_String::convertCharset($line, $this->_vars->charset, 'UTF-8');
$first_lines .= Horde_String::truncate($line);
if (Horde_String::length($line) > 100) {
$first_lines .= "\n";
}
}
}
$this->storage->set('first_lines', $first_lines);
/* Import the first line to guess the number of fields. */
if ($first_lines) {
rewind($fp);
$line = self::getCsv($fp);
if ($line) {
$this->storage->set('fields', count($line));
}
}
return Horde_Data::IMPORT_CSV;
case Horde_Data::IMPORT_CSV:
$this->storage->set('header', $this->_vars->header);
$import_mapping = array();
if (isset($param['import_mapping'])) {
$import_mapping = $param['import_mapping'];
}
$file_name = Horde_Util::getTempFile('import');
file_put_contents($file_name, $this->storage->get('file_data'));
$this->storage->set('data', $this->importFile(
$file_name,
$this->_vars->header,
$this->_vars->sep,
$this->_vars->quote,
$this->_vars->fields,
$import_mapping,
$this->storage->get('charset'),
$this->storage->get('crlf')
));
$this->storage->set('map');
return Horde_Data::IMPORT_MAPPED;
default:
return parent::nextStep($action, $param);
}
}
/* Static utility method. */
/**
* Wrapper around fgetcsv().
*
* Empty lines will be skipped. If the 'length' parameter is provided, all
* rows are filled up with empty strings up to this length, or stripped
* down to this length.
*
* @param resource $file A file pointer.
* @param array $params Optional parameters. Possible values:
* - escape: The escape character.
* - length: The expected number of fields.
* - quote: The quote character.
* - separator: The field delimiter.
*
* @return array|boolean A row from the CSV file or false on error or end
* of file.
*/
public static function getCsv($file, array $params = array())
{
$params += array(
'escape' => '\\',
'quote' => '"',
'separator' => ','
);
// fgetcsv() throws a warning if the quote character is empty.
if (!strlen($params['quote']) && ($params['escape'] != '\\')) {
$params['quote'] = '"';
}
// Detect Mac line endings.
$old = ini_get('auto_detect_line_endings');
ini_set('auto_detect_line_endings', 1);
do {
$row = strlen($params['quote'])
? fgetcsv($file, 0, $params['separator'], $params['quote'], $params['escape'])
: fgetcsv($file, 0, $params['separator']);
} while ($row && is_null($row[0]));
ini_set('auto_detect_line_endings', $old);
if ($row) {
$row = (strlen($params['quote']) && strlen($params['escape']))
? array_map(
function ($a) use ($params) {
return str_replace(
str_replace(
'\'',
'\\\'',
$params['escape'] . $params['quote']
),
str_replace('\'', '\\\'', $params['quote']),
$a
);
},
$row
)
: array_map('trim', $row);
if (!empty($params['length'])) {
$length = count($row);
if ($length < $params['length']) {
$row += array_fill($length, $params['length'] - $length, '');
} elseif ($length > $params['length']) {
array_splice($row, $params['length']);
}
}
}
return $row;
}
}
|