import_csv.modules.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2006-2012  Laurent Destailleur         <eldy@users.sourceforge.net>
 * Copyright (C) 2009-2012  Regis Houssin               <regis.houssin@inodbox.com>
 * Copyright (C) 2012       Christophe Battarel         <christophe.battarel@altairis.fr>
 * Copyright (C) 2012-2016  Juanjo Menent               <jmenent@2byte.es>
 * Copyright (C) 2024       Frédéric France             <frederic.france@free.fr>
 * Copyright (C) 2024       MDW                         <mdeweerd@users.noreply.github.com>
 * Copyright (C) 2026       Alexandre Spangaro          <alexandre@inovea-conseil.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 * or see https://www.gnu.org/
 */
 
require_once DOL_DOCUMENT_ROOT.'/core/modules/import/modules_import.class.php';
 
 
class ImportCsv extends ModeleImports
{
  public $db;
 
  public $id;
 
  public $version = 'dolibarr';
 
  public $label_lib;
 
  public $version_lib;
 
  public $separator;
 
  public $file; // Path of file
 
  public $handle; // File handle
 
  public $cacheconvert = array(); // Array to cache list of value found after a conversion
 
  public $cachefieldtable = array(); // Array to cache list of value found into fields@tables
 
  public $nbinsert = 0; // # of insert done during the import
 
  public $nbupdate = 0; // # of update done during the import
 
  public $charset = '';
 
  public $col;
 
 
  public function __construct($db, $datatoimport)
  {
    global $langs;
 
    parent::__construct();
    $this->db = $db;
 
    $this->separator = (GETPOST('separator') ? GETPOST('separator') : getDolGlobalString('IMPORT_CSV_SEPARATOR_TO_USE', ','));
    $this->enclosure = '"';
    $this->escape = '"';
 
    $this->id = 'csv'; // Same value then xxx in file name export_xxx.modules.php
    $this->label = 'Csv'; // Label of driver
    $this->desc = $langs->trans("CSVFormatDesc", $this->separator, $this->enclosure, $this->escape);
    $this->extension = 'csv'; // Extension for generated file by this driver
    $this->picto = 'mime/other'; // Picto
    $this->version = '1.34'; // Driver version
    $this->phpmin = array(7, 0); // Minimum version of PHP required by module
 
    require_once DOL_DOCUMENT_ROOT.'/core/lib/admin.lib.php';
    if (versioncompare($this->phpmin, versionphparray()) > 0) {
      dol_syslog("Module need a higher PHP version");
      $this->error = "Module need a higher PHP version";
      return;
    }
 
    // If driver use an external library, put its name here
    $this->label_lib = 'Dolibarr';
    $this->version_lib = DOL_VERSION;
 
    $this->datatoimport = $datatoimport;
    if (preg_match('/^societe_/', $datatoimport)) {
      $this->thirdpartyobject = new Societe($this->db);
    }
  }
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function write_header_example($outputlangs)
  {
    // phpcs:enable
    return '';
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function write_title_example($outputlangs, $headerlinefields)
  {
    // phpcs:enable
    $s = implode($this->separator, array_map('cleansep', $headerlinefields));
    return $s."\n";
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function write_record_example($outputlangs, $contentlinevalues)
  {
    // phpcs:enable
    $s = implode($this->separator, array_map('cleansep', $contentlinevalues));
    return $s."\n";
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function write_footer_example($outputlangs)
  {
    // phpcs:enable
    return '';
  }
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function import_open_file($file)
  {
    // phpcs:enable
    global $langs;
    $ret = 1;
 
    dol_syslog(get_class($this)."::open_file file=".$file);
 
    ini_set('auto_detect_line_endings', 1); // For MAC compatibility
 
    $handle = fopen(dol_osencode($file), "r");
    if (!$handle) {
      $langs->load("errors");
      $this->error = $langs->trans("ErrorFailToOpenFile", $file);
      $ret = -1;
    } else {
      $this->handle = $handle;
      $this->file = $file;
    }
 
    return $ret;
  }
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function import_get_nb_of_lines($file)
  {
    // phpcs:enable
    return dol_count_nb_of_line($file);
  }
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function import_read_header()
  {
    // phpcs:enable
    return 0;
  }
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function import_read_record()
  {
    // phpcs:enable
    $arrayres = fgetcsv($this->handle, 100000, $this->separator, $this->enclosure, $this->escape);
 
    // End of file
    if ($arrayres === false) {
      return false;
    }
 
    //var_dump($this->handle);
    //var_dump($arrayres);exit;
    $newarrayres = array();
    $key = 1; // Default value to ensure $key is declared
 
    if ($arrayres && is_array($arrayres)) {
      foreach ($arrayres as $key => $val) {
        if (getDolGlobalString('IMPORT_CSV_FORCE_CHARSET')) { // Forced charset
          if (strtolower(getDolGlobalString('IMPORT_CSV_FORCE_CHARSET')) == 'utf8') {
            $newarrayres[$key]['val'] = $val;
            $newarrayres[$key]['type'] = (dol_strlen($val) ? 1 : -1); // If empty we consider it's null
          } else {
            $newarrayres[$key]['val'] = mb_convert_encoding($val, 'UTF-8', 'ISO-8859-1');
            $newarrayres[$key]['type'] = (dol_strlen($val) ? 1 : -1); // If empty we consider it's null
          }
        } else { // Autodetect format (UTF8 or ISO)
          if (utf8_check($val)) {
            $newarrayres[$key]['val'] = $val;
            $newarrayres[$key]['type'] = (dol_strlen($val) ? 1 : -1); // If empty we consider it's null
          } else {
            $newarrayres[$key]['val'] = mb_convert_encoding($val, 'UTF-8', 'ISO-8859-1');
            $newarrayres[$key]['type'] = (dol_strlen($val) ? 1 : -1); // If empty we consider it's null
          }
        }
 
        $newarrayres[$key]['val'] = trim($newarrayres[$key]['val']);
      }
 
      $this->col = count($newarrayres);
    }
 
    return $newarrayres;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function import_close_file()
  {
    // phpcs:enable
    fclose($this->handle);
    return 0;
  }
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function import_insert($arrayrecord, $array_match_file_to_database, $objimport, $maxfields, $importid, $updatekeys)
  {
    // phpcs:enable
    return $this->commonImportInsert($arrayrecord, $array_match_file_to_database, $objimport, $maxfields, $importid, $updatekeys, 0);
  }
}
 
function cleansep($value)
{
  return str_replace(array(',', ';'), '/', $value);
}