lib/csvlib.class.php

   1 <?php
   2 // This file is part of Moodle - http://moodle.org/
   3 //
   4 // Moodle is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU General Public License as published by
   6 // the Free Software Foundation, either version 3 of the License, or
   7 // (at your option) any later version.
   8 //
   9 // Moodle is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU General Public License
  15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 /**
  18  * This is a one-line short description of the file
  19  *
  20  * You can have a rather longer description of the file as well,
  21  * if you like, and it can span multiple lines.
  22  *
  23  * @package    core
  24  * @subpackage lib
  25  * @copyright  Petr Skoda
  26  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  27  */
  28
  29 defined('MOODLE_INTERNAL') || die();
  30
  31 /**
  32  * Utitily class for importing of CSV files.
  33  * @copyright Petr Skoda
  34  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35  * @package   moodlecore
  36  */
  37 class csv_import_reader {
  38     /**
  39      * @var int import identifier
  40      */
  41     var $_iid;
  42     /**
  43      * @var string which script imports?
  44      */
  45     var $_type;
  46     /**
  47      * @var string|null Null if ok, error msg otherwise
  48      */
  49     var $_error;
  50     /**
  51      * @var array cached columns
  52      */
  53     var $_columns;
  54     /**
  55      * @var object file handle used during import
  56      */
  57     var $_fp;
  58
  59     /**
  60      * Contructor
  61      *
  62      * @param int $iid import identifier
  63      * @param string $type which script imports?
  64      */
  65     function csv_import_reader($iid, $type) {
  66         $this->_iid  = $iid;
  67         $this->_type = $type;
  68     }
  69
  70     /**
  71      * Parse this content
  72      *
  73      * @global object
  74      * @global object
  75      * @param string $content passed by ref for memory reasons, unset after return
  76      * @param string $encoding content encoding
  77      * @param string $delimiter_name separator (comma, semicolon, colon, cfg)
  78      * @param string $column_validation name of function for columns validation, must have one param $columns
  79      * @return bool false if error, count of data lines if ok; use get_error() to get error string
  80      */
  81     function load_csv_content(&$content, $encoding, $delimiter_name, $column_validation=null) {
  82         global $USER, $CFG;
  83
  84         $this->close();
  85         $this->_error = null;
  86
  87         $content = textlib::convert($content, $encoding, 'utf-8');
  88         // remove Unicode BOM from first line
  89         $content = textlib::trim_utf8_bom($content);
  90         // Fix mac/dos newlines
  91         $content = preg_replace('!\r\n?!', "\n", $content);
  92         // is there anyting in file?
  93         $columns = strtok($content, "\n");
  94         if ($columns === false) {
  95             $this->_error = get_string('csvemptyfile', 'error');
  96             return false;
  97         }
  98         $csv_delimiter = csv_import_reader::get_delimiter($delimiter_name);
  99         $csv_encode    = csv_import_reader::get_encoded_delimiter($delimiter_name);
 100
 101         // process header - list of columns
 102         $columns   = explode($csv_delimiter, $columns);
 103         $col_count = count($columns);
 104         if ($col_count === 0) {
 105             $this->_error = get_string('csvemptyfile', 'error');
 106             return false;
 107         }
 108
 109         foreach ($columns as $key=>$value) {
 110             $columns[$key] = str_replace($csv_encode, $csv_delimiter, trim($value));
 111         }
 112         if ($column_validation) {
 113             $result = $column_validation($columns);
 114             if ($result !== true) {
 115                 $this->_error = $result;
 116                 return false;
 117             }
 118         }
 119         $this->_columns = $columns; // cached columns
 120
 121         // open file for writing
 122         $filename = $CFG->tempdir.'/csvimport/'.$this->_type.'/'.$USER->id.'/'.$this->_iid;
 123         $fp = fopen($filename, "w");
 124         fwrite($fp, serialize($columns)."\n");
 125
 126         // again - do we have any data for processing?
 127         $line = strtok("\n");
 128         $data_count = 0;
 129         while ($line !== false) {
 130             $line = explode($csv_delimiter, $line);
 131             foreach ($line as $key=>$value) {
 132                 $line[$key] = str_replace($csv_encode, $csv_delimiter, trim($value));
 133             }
 134             if (count($line) !== $col_count) {
 135                 // this is critical!!
 136                 $this->_error = get_string('csvweirdcolumns', 'error');
 137                 fclose($fp);
 138                 $this->cleanup();
 139                 return false;
 140             }
 141             fwrite($fp, serialize($line)."\n");
 142             $data_count++;
 143             $line = strtok("\n");
 144         }
 145
 146         fclose($fp);
 147         return $data_count;
 148     }
 149
 150     /**
 151      * Returns list of columns
 152      *
 153      * @return array
 154      */
 155     function get_columns() {
 156         if (isset($this->_columns)) {
 157             return $this->_columns;
 158         }
 159
 160         global $USER, $CFG;
 161
 162         $filename = $CFG->tempdir.'/csvimport/'.$this->_type.'/'.$USER->id.'/'.$this->_iid;
 163         if (!file_exists($filename)) {
 164             return false;
 165         }
 166         $fp = fopen($filename, "r");
 167         $line = fgets($fp);
 168         fclose($fp);
 169         if ($line === false) {
 170             return false;
 171         }
 172         $this->_columns = unserialize($line);
 173         return $this->_columns;
 174     }
 175
 176     /**
 177      * Init iterator.
 178      *
 179      * @global object
 180      * @global object
 181      * @return bool Success
 182      */
 183     function init() {
 184         global $CFG, $USER;
 185
 186         if (!empty($this->_fp)) {
 187             $this->close();
 188         }
 189         $filename = $CFG->tempdir.'/csvimport/'.$this->_type.'/'.$USER->id.'/'.$this->_iid;
 190         if (!file_exists($filename)) {
 191             return false;
 192         }
 193         if (!$this->_fp = fopen($filename, "r")) {
 194             return false;
 195         }
 196         //skip header
 197         return (fgets($this->_fp) !== false);
 198     }
 199
 200     /**
 201      * Get next line
 202      *
 203      * @return mixed false, or an array of values
 204      */
 205     function next() {
 206         if (empty($this->_fp) or feof($this->_fp)) {
 207             return false;
 208         }
 209         if ($ser = fgets($this->_fp)) {
 210             return unserialize($ser);
 211         } else {
 212             return false;
 213         }
 214     }
 215
 216     /**
 217      * Release iteration related resources
 218      *
 219      * @return void
 220      */
 221     function close() {
 222         if (!empty($this->_fp)) {
 223             fclose($this->_fp);
 224             $this->_fp = null;
 225         }
 226     }
 227
 228     /**
 229      * Get last error
 230      *
 231      * @return string error text of null if none
 232      */
 233     function get_error() {
 234         return $this->_error;
 235     }
 236
 237     /**
 238      * Cleanup temporary data
 239      *
 240      * @global object
 241      * @global object
 242      * @param boolean $full true means do a full cleanup - all sessions for current user, false only the active iid
 243      */
 244     function cleanup($full=false) {
 245         global $USER, $CFG;
 246
 247         if ($full) {
 248             @remove_dir($CFG->tempdir.'/csvimport/'.$this->_type.'/'.$USER->id);
 249         } else {
 250             @unlink($CFG->tempdir.'/csvimport/'.$this->_type.'/'.$USER->id.'/'.$this->_iid);
 251         }
 252     }
 253
 254     /**
 255      * Get list of cvs delimiters
 256      *
 257      * @return array suitable for selection box
 258      */
 259     static function get_delimiter_list() {
 260         global $CFG;
 261         $delimiters = array('comma'=>',', 'semicolon'=>';', 'colon'=>':', 'tab'=>'\\t');
 262         if (isset($CFG->CSV_DELIMITER) and strlen($CFG->CSV_DELIMITER) === 1 and !in_array($CFG->CSV_DELIMITER, $delimiters)) {
 263             $delimiters['cfg'] = $CFG->CSV_DELIMITER;
 264         }
 265         return $delimiters;
 266     }
 267
 268     /**
 269      * Get delimiter character
 270      *
 271      * @param string separator name
 272      * @return string delimiter char
 273      */
 274     static function get_delimiter($delimiter_name) {
 275         global $CFG;
 276         switch ($delimiter_name) {
 277             case 'colon':     return ':';
 278             case 'semicolon': return ';';
 279             case 'tab':       return "\t";
 280             case 'cfg':       if (isset($CFG->CSV_DELIMITER)) { return $CFG->CSV_DELIMITER; } // no break; fall back to comma
 281             case 'comma':     return ',';
 282         }
 283     }
 284
 285     /**
 286      * Get encoded delimiter character
 287      *
 288      * @global object
 289      * @param string separator name
 290      * @return string encoded delimiter char
 291      */
 292     static function get_encoded_delimiter($delimiter_name) {
 293         global $CFG;
 294         if ($delimiter_name == 'cfg' and isset($CFG->CSV_ENCODE)) {
 295             return $CFG->CSV_ENCODE;
 296         }
 297         $delimiter = csv_import_reader::get_delimiter($delimiter_name);
 298         return '&#'.ord($delimiter);
 299     }
 300
 301     /**
 302      * Create new import id
 303      *
 304      * @global object
 305      * @param string who imports?
 306      * @return int iid
 307      */
 308     static function get_new_iid($type) {
 309         global $USER;
 310
 311         $filename = make_temp_directory('csvimport/'.$type.'/'.$USER->id);
 312
 313         // use current (non-conflicting) time stamp
 314         $iiid = time();
 315         while (file_exists($filename.'/'.$iiid)) {
 316             $iiid--;
 317         }
 318
 319         return $iiid;
 320     }
 321 }