modules_import.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2005-2012  Laurent Destailleur <eldy@users.sourceforge.net>
 * Copyright (C) 2005-2012  Regis Houssin   <regis.houssin@inodbox.com>
 * Copyright (C) 2024   MDW             <mdeweerd@users.noreply.github.com>
 * Copyright (C) 2024       Frédéric France             <frederic.france@free.fr>
 *
 * 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/lib/functions.lib.php';
 
 
class ModeleImports
{
  public $db;
 
  public $datatoimport;
 
  public $error = '';
 
  public $errors = array();
 
  public $warnings = array();
 
  public $id;
 
  public $label;
 
  public $extension;
 
  public $version = 'dolibarr';
 
  public $phpmin = array(7, 0);
 
  public $label_lib;
 
  public $version_lib;
 
  // Array of all drivers
  public $driverlabel = array();
 
  public $driverdesc = array();
 
  public $driverversion = array();
 
  public $drivererror = array();
 
  public $liblabel = array();
 
  public $libversion = array();
 
  public $charset;
 
  public $picto;
 
  public $desc;
 
  public $escape;
 
  public $enclosure;
 
  public $thirdpartyobject;
 
  public static $mapTableToElement = MODULE_MAPPING;
 
  public function __construct()
  {
    global $hookmanager;
 
    if (is_object($hookmanager)) {
      $hookmanager->initHooks(array('import'));
      $parameters = array();
      $reshook = $hookmanager->executeHooks('constructModeleImports', $parameters, $this);
      if ($reshook >= 0 && !empty($hookmanager->resArray)) {
        foreach ($hookmanager->resArray as $mapList) {
          self::$mapTableToElement[$mapList['table']] = $mapList['element'];
        }
      }
    }
  }
 
  public function getDriverId()
  {
    return $this->id;
  }
 
  public function getDriverLabel()
  {
    return $this->label;
  }
 
  public function getDriverDesc()
  {
    return $this->desc;
  }
 
  public function getDriverExtension()
  {
    return $this->extension;
  }
 
  public function getDriverVersion()
  {
    return $this->version;
  }
 
  public function getLibLabel()
  {
    return $this->label_lib;
  }
 
  public function getLibVersion()
  {
    return $this->version_lib;
  }
 
 
  public function listOfAvailableImportFormat($db, $maxfilenamelength = 0)
  {
    dol_syslog(get_class($this)."::listOfAvailableImportFormat");
 
    $dir = DOL_DOCUMENT_ROOT."/core/modules/import/";
    $handle = opendir($dir);
 
    // Search list ov drivers available and qualified
    if (is_resource($handle)) {
      while (($file = readdir($handle)) !== false) {
        $reg = array();
        if (preg_match("/^import_(.*)\.modules\.php/i", $file, $reg)) {
          $moduleid = $reg[1];
 
          // Loading Class
          $file = $dir."/import_".$moduleid.".modules.php";
          $classname = "Import".ucfirst($moduleid);
 
          require_once  $file;
          $module = new $classname($db, '');
          '@phan-var-force ModeleImports $module';
 
          // Picto
          $this->picto[$module->id] = $module->picto;
          // Driver properties
          $this->driverlabel[$module->id] = $module->getDriverLabel();
          $this->driverdesc[$module->id] = $module->getDriverDesc();
          $this->driverversion[$module->id] = $module->getDriverVersion();
          $this->drivererror[$module->id] = $module->error ? $module->error : '';
          // If use an external lib
          $this->liblabel[$module->id] = ($module->error ? '<span class="error">'.$module->error.'</span>' : $module->getLibLabel());
          $this->libversion[$module->id] = $module->getLibVersion();
        }
      }
    }
 
    return array_keys($this->driverlabel);
  }
 
 
  public function getPictoForKey($key)
  {
    return  $this->picto[$key];
  }
 
  public function getDriverLabelForKey($key)
  {
    return  $this->driverlabel[$key];
  }
 
  public function getDriverDescForKey($key)
  {
    return  $this->driverdesc[$key];
  }
 
  public function getDriverVersionForKey($key)
  {
    return  $this->driverversion[$key];
  }
 
  public function getLibLabelForKey($key)
  {
    return  $this->liblabel[$key];
  }
 
  public function getLibVersionForKey($key)
  {
    return  $this->libversion[$key];
  }
 
  public function getElementFromTableWithPrefix($tableNameWithPrefix)
  {
    $tableElement = preg_replace('/^'.preg_quote($this->db->prefix(), '/').'/', '', $tableNameWithPrefix);
    $element = $tableElement;
 
    if (isset(self::$mapTableToElement[$tableElement])) {
      $element = self::$mapTableToElement[$tableElement];
    }
 
    return  $element;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function import_open_file($file)
  {
    // phpcs:enable
    $msg = get_class($this)."::".__FUNCTION__." not implemented";
    dol_syslog($msg, LOG_ERR);
    $this->errors[] = $msg;
    $this->error = $msg;
    return -1;
  }
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function import_get_nb_of_lines($file)
  {
    // phpcs:enable
    $msg = get_class($this)."::".__FUNCTION__." not implemented";
    dol_syslog($msg, LOG_ERR);
    $this->errors[] = $msg;
    $this->error = $msg;
    return -1;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function import_read_header()
  {
    // phpcs:enable
    $msg = get_class($this)."::".__FUNCTION__." not implemented";
    dol_syslog($msg, LOG_ERR);
    $this->errors[] = $msg;
    $this->error = $msg;
    return -1;
  }
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function import_read_record()
  {
    // phpcs:enable
    $msg = get_class($this)."::".__FUNCTION__." not implemented";
    dol_syslog($msg, LOG_ERR);
    $this->errors[] = $msg;
    $this->error = $msg;
    return array();
  }
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function import_close_file()
  {
    // phpcs:enable
    $msg = get_class($this)."::".__FUNCTION__." not implemented";
    dol_syslog($msg, LOG_ERR);
    $this->errors[] = $msg;
    $this->error = $msg;
    return -1;
  }
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function import_insert($arrayrecord, $array_match_file_to_database, $objimport, $maxfields, $importid, $updatekeys)
  {
    // phpcs:enable
    $msg = get_class($this)."::".__FUNCTION__." not implemented";
    dol_syslog($msg, LOG_ERR);
    $this->errors[] = $msg;
    $this->error = $msg;
    return -1;
  }
}