import.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2011   Laurent Destailleur   <eldy@users.sourceforge.net>
 * Copyright (C) 2016   Raphaël Doursenaud    <rdoursenaud@gpcsolutions.fr>
 * Copyright (C) 2020   Ahmad Jamaly Rabib    <rabib@metroworks.co.jp>
 * Copyright (C) 2021-2024  Frédéric France     <frederic.france@free.fr>
 * Copyright (C) 2024-2025  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/>.
 */
 
class Import
{
  public $db;
 
  public $error = '';
 
  public $errors = array();
 
  public $errno;
 
  public $array_import_module;
 
  public $array_import_perms;
 
  public $array_import_icon;
 
  public $array_import_code;
 
  public $array_import_label;
 
  public $array_import_tables;
 
  public $array_import_tables_creator;
 
  public $array_import_fields;
 
  public $array_import_fieldshidden;
 
  public $array_import_entities;
 
  public $array_import_regex;
 
  public $array_import_updatekeys;
 
  public $array_import_preselected_updatekeys;
 
  public $array_import_examplevalues;
 
  public $array_import_convertvalue;
 
  public $array_import_run_sql_after;
 
  // To store import templates
  public $id;
  public $hexa; // List of fields in the export profile
  public $datatoimport;
 
  public $model_name;
 
  public $fk_user;
 
 
  public function __construct($db)
  {
    $this->db = $db;
  }
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function load_arrays($user, $filter = '')
  {
    // phpcs:enable
    global $langs, $conf;
 
    dol_syslog(get_class($this)."::load_arrays user=".$user->id." filter=".$filter);
 
    $i = 0;
 
    require_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
    $modulesdir = dolGetModulesDirs();
 
    // Load list of modules
    foreach ($modulesdir as $dir) {
      $handle = @opendir(dol_osencode($dir));
      if (!is_resource($handle)) {
        continue;
      }
 
      // Search module files
      while (($file = readdir($handle)) !== false) {
        // Ignore Module Builder backup files (*.php.back)
        if (preg_match('/\.back$/i', $file)) {
          continue;
        }
 
        if (!preg_match("/^(mod.*)\.class\.php/i", $file, $reg)) {
          continue;
        }
 
        $modulename = $reg[1];
 
        // Defined if module is enabled
        $enabled = true;
        $part = strtolower(preg_replace('/^mod/i', '', $modulename));
        // Adds condition for propal module
        if ($part === 'propale') {
          $part = 'propal';
        }
        if (empty($conf->$part->enabled)) {
          $enabled = false;
        }
 
        if (empty($enabled)) {
          continue;
        }
 
        // Init load class
        $file = $dir."/".$modulename.".class.php";
        $classname = $modulename;
        require_once $file;
        $module = new $classname($this->db);
        '@phan-var-force DolibarrModules $module';
 
        if (isset($module->import_code) && is_array($module->import_code)) {
          foreach ($module->import_code as $r => $value) {  // @phan-suppress-current-line PhanTypeMismatchForeach
            if ($filter && ($filter != $module->import_code[$r])) {
              continue;
            }
 
            // Test if permissions are ok
            /*$perm=$module->import_permission[$r][0];
            //print_r("$perm[0]-$perm[1]-$perm[2]<br>");
            if ($perm[2])
            {
            $bool=$user->rights->{$perm[0]}->{$perm[1]}->{$perm[2]};
            }
            else
            {
            $bool=$user->rights->{$perm[0]}->{$perm[1]};
            }
            if ($perm[0]=='user' && $user->admin) $bool=true;
            //print $bool." $perm[0]"."<br>";
            */
 
            // Load lang file
            $langtoload = $module->getLangFilesArray();
            if (is_array($langtoload)) {
              foreach ($langtoload as $key) {
                $langs->load($key);
              }
            }
 
            // Permission
            $this->array_import_perms[$i] = $user->hasRight('import', 'run');
            // Icon
            $this->array_import_icon[$i] = (isset($module->import_icon[$r]) ? $module->import_icon[$r] : $module->picto);
            // Code of dataset export
            $this->array_import_code[$i] = $module->import_code[$r];
            // Label of dataset export
            $this->array_import_label[$i] = $module->getImportDatasetLabel($r);
            // Array of tables to import (key=alias, value=tablename)
            $this->array_import_tables[$i] = $module->import_tables_array[$r];
            // Array of tables creator field to import (key=alias, value=creator field name)
            $this->array_import_tables_creator[$i] = (isset($module->import_tables_creator_array[$r]) ? $module->import_tables_creator_array[$r] : '');
            // Array of fields to import (key=field, value=label)
            $this->array_import_fields[$i] = (isset($module->import_fields_array[$r]) ? $module->import_fields_array[$r] : []);
            // Array of hidden fields to import (key=field, value=label)
            $this->array_import_fieldshidden[$i] = (isset($module->import_fieldshidden_array[$r]) ? $module->import_fieldshidden_array[$r] : '');
            // Array of entities to export (key=field, value=entity)
            $this->array_import_entities[$i] = (isset($module->import_entities_array[$r]) ? $module->import_entities_array[$r] : '');
            // Array of aliases to export (key=field, value=alias)
            $this->array_import_regex[$i] = (isset($module->import_regex_array[$r]) ? $module->import_regex_array[$r] : '');
            // Array of columns allowed as UPDATE options
            $this->array_import_updatekeys[$i] = (isset($module->import_updatekeys_array[$r]) ? $module->import_updatekeys_array[$r] : '');
            // Array of columns preselected as UPDATE options
            // import_preselected_updatekeys_array does not exist - backward compatibility ?  @phan-suppress-next-line PhanUndeclaredProperty
            $this->array_import_preselected_updatekeys[$i] = (isset($module->import_preselected_updatekeys_array[$r]) ? $module->import_preselected_updatekeys_array[$r] : '');
            // Array of examples
            $this->array_import_examplevalues[$i] = (isset($module->import_examplevalues_array[$r]) ? $module->import_examplevalues_array[$r] : '');
            // Tableau des regles de conversion d'une valeur depuis une autre source (cle=champ, valeur=tableau des regles)
            $this->array_import_convertvalue[$i] = (isset($module->import_convertvalue_array[$r]) ? $module->import_convertvalue_array[$r] : '');
            // Sql request to run after import
            $this->array_import_run_sql_after[$i] = (isset($module->import_run_sql_after_array[$r]) ? $module->import_run_sql_after_array[$r] : '');
            // Module
            $this->array_import_module[$i] = array('position_of_profile' => ($module->module_position.'-'.$module->import_code[$r]), 'module' => $module);
 
            dol_syslog("Import loaded for module ".$modulename." with index ".$i.", dataset=".$module->import_code[$r].", nb of fields=".count($module->import_fields_array[$r]));
            $i++;
          }
        }
      }
      closedir($handle);
    }
    return 1;
  }
 
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function build_example_file($model, $headerlinefields, $contentlinevalues, $datatoimport)
  {
    // phpcs:enable
    global $conf, $langs;
 
    $indice = 0;
 
    dol_syslog(get_class($this)."::build_example_file ".$model);
 
    // Create the import class for the model Import_XXX
    $dir = DOL_DOCUMENT_ROOT."/core/modules/import/";
    $file = "import_".$model.".modules.php";
    $classname = "Import".$model;
    require_once $dir.$file;
    $objmodel = new $classname($this->db, $datatoimport);
    '@phan-var-force ModeleImports $objmodel';
 
    $outputlangs = $langs; // Lang for output
    $s = '';
 
    // Genere en-tete
    $s .= $objmodel->write_header_example($outputlangs);
 
    // Genere ligne de titre
    $s .= $objmodel->write_title_example($outputlangs, $headerlinefields);
 
    // Genere ligne de titre
    $s .= $objmodel->write_record_example($outputlangs, $contentlinevalues);
 
    // Genere pied de page
    $s .= $objmodel->write_footer_example($outputlangs);
 
    return $s;
  }
 
  public function create($user)
  {
    dol_syslog("Import.class.php::create");
 
    // Check parameters
    if (empty($this->model_name)) {
      $this->error = 'ErrorWrongParameters';
      return -1;
    }
    if (empty($this->datatoimport)) {
      $this->error = 'ErrorWrongParameters';
      return -1;
    }
    if (empty($this->hexa)) {
      $this->error = 'ErrorWrongParameters';
      return -1;
    }
 
    $this->db->begin();
 
    $sql = 'INSERT INTO '.MAIN_DB_PREFIX.'import_model (';
    $sql .= 'fk_user,';
    $sql .= ' label,';
    $sql .= ' type,';
    $sql .= ' field';
    $sql .= ')';
    $sql .= " VALUES (";
    $sql .= (isset($this->fk_user) ? (int) $this->fk_user : 'null').",";
    $sql .= " '".$this->db->escape($this->model_name)."',";
    $sql .= " '".$this->db->escape($this->datatoimport)."',";
    $sql .= " '".$this->db->escape($this->hexa)."'";
    $sql .= ")";
 
    $resql = $this->db->query($sql);
    if ($resql) {
      $this->db->commit();
      return 1;
    } else {
      $this->error = $this->db->lasterror();
      $this->errno = $this->db->lasterrno();
      $this->db->rollback();
      return -1;
    }
  }
 
  public function fetch($id)
  {
    $sql = 'SELECT em.rowid, em.field, em.label, em.type';
    $sql .= ' FROM '.MAIN_DB_PREFIX.'import_model as em';
    $sql .= ' WHERE em.rowid = '.((int) $id);
 
    dol_syslog(get_class($this)."::fetch", LOG_DEBUG);
    $result = $this->db->query($sql);
    if ($result) {
      $obj = $this->db->fetch_object($result);
      if ($obj) {
        $this->id                   = $obj->rowid;
        $this->hexa                 = $obj->field;
        $this->model_name           = $obj->label;
        $this->datatoimport         = $obj->type;
        $this->fk_user              = $obj->fk_user;
        return 1;
      } else {
        $this->error = "Model not found";
        return -2;
      }
    } else {
      dol_print_error($this->db);
      return -3;
    }
  }
 
  public function delete($user, $notrigger = 0)
  {
    $error = 0;
 
    $sql = "DELETE FROM ".MAIN_DB_PREFIX."import_model";
    $sql .= " WHERE rowid=".((int) $this->id);
 
    $this->db->begin();
 
    dol_syslog(get_class($this)."::delete", LOG_DEBUG);
    $resql = $this->db->query($sql);
    if (!$resql) {
      $error++;
      $this->errors[] = "Error ".$this->db->lasterror();
    }
 
    /* Not used. This is not a business object. To convert it we must herit from CommonObject
    if (!$error) {
        // Call trigger
        $result=$this->call_trigger('IMPORT_DELETE',$user);
        if ($result < 0) $error++;
        // End call triggers
      }
    }
    */
 
    // Commit or rollback
    if ($error) {
      foreach ($this->errors as $errmsg) {
        dol_syslog(get_class($this)."::delete ".$errmsg, LOG_ERR);
        $this->error .= ($this->error ? ', '.$errmsg : $errmsg);
      }
      $this->db->rollback();
      return -1 * $error;
    } else {
      $this->db->commit();
      return 1;
    }
  }
}