export_tsv.modules.php

<?php
/* Copyright (C) 2006-2008 Laurent Destailleur  <eldy@users.sourceforge.net>
 * Copyright (C) 2012      Marcos García        <marcosgdf@gmail.com>
 * Copyright (C) 2024-2025  MDW             <mdeweerd@users.noreply.github.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/>.
*/
 
require_once DOL_DOCUMENT_ROOT.'/core/modules/export/modules_export.php';
 
// avoid timeout for big export
set_time_limit(0);
 
class ExportTsv extends ModeleExports
{
  public $label;
 
  public $extension;
 
  public $version = 'dolibarr';
 
  public $label_lib;
 
  public $version_lib;
 
  public $separator = "\t";
 
  public $handle;
 
 
  public function __construct($db)
  {
    global $langs;
    $this->db = $db;
 
    $this->id = 'tsv'; // Same value then xxx in file name export_xxx.modules.php
    $this->label = 'TSV'; // Label of driver
    $this->desc = $langs->trans('TsvFormatDesc');
    $this->extension = 'tsv'; // Extension for generated file by this driver
    $this->picto = 'mime/other'; // Picto
    $this->version = '1.15'; // Driver version
 
    // If driver use an external library, put its name here
    $this->label_lib = 'Dolibarr';
    $this->version_lib = DOL_VERSION;
  }
 
  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;
  }
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function open_file($file, $outputlangs)
  {
    // phpcs:enable
    global $langs;
 
    dol_syslog("ExportTsv::open_file file=".$file);
 
    $ret = 1;
 
    $outputlangs->load("exports");
    $this->handle = fopen($file, "wt");
    if (!$this->handle) {
      $langs->load("errors");
      $this->error = $langs->trans("ErrorFailToCreateFile", $file);
      $ret = -1;
    }
 
    return $ret;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function write_header($outputlangs)
  {
    // phpcs:enable
    return 0;
  }
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function write_title($array_export_fields_label, $array_selected_sorted, $outputlangs, $array_types)
  {
    // phpcs:enable
    $selectlabel = array();
    foreach ($array_selected_sorted as $code => $value) {
      if (strpos($code, ' as ') == 0) {
        $alias = str_replace(array('.', '-', '(', ')'), '_', $code);
      } else {
        $alias = substr($code, strpos($code, ' as ') + 4);
      }
      if (empty($alias)) {
        dol_syslog('Bad value for field with code='.$code.'. Try to redefine export.', LOG_WARNING);
        continue;
      }
 
      $newvalue = $array_export_fields_label[$code];
      if ($newvalue) {
        $newvalue = $outputlangs->transnoentitiesnoconv($newvalue);
      }
 
      $newvalue = $this->tsv_clean($newvalue, getDolGlobalString('EXPORT_TSV_FORCE_CHARSET'));
 
      fwrite($this->handle, $newvalue.$this->separator);
      $typefield = isset($array_types[$code]) ? $array_types[$code] : '';
 
      if (preg_match('/^Select:/i', $typefield) && $typefield = substr($typefield, 7)) {
        $selectlabel[$code."_label"] = $newvalue."_label";
      }
    }
    foreach ($selectlabel as $key => $value) {
      fwrite($this->handle, $value.$this->separator);
    }
    fwrite($this->handle, "\n");
    return 0;
  }
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function write_record($array_selected_sorted, $objp, $outputlangs, $array_types)
  {
    // phpcs:enable
 
    $outputlangs->charset_output = getDolGlobalString('EXPORT_TSV_FORCE_CHARSET');
 
    $this->col = 0;
 
    $reg = array();
    $selectlabelvalues = array();
    foreach ($array_selected_sorted as $code => $value) {
      if (strpos($code, ' as ') == 0) {
        $alias = str_replace(array('.', '-', '(', ')'), '_', $code);
      } else {
        $alias = substr($code, strpos($code, ' as ') + 4);
      }
      if (empty($alias)) {
        dol_syslog('Bad value for field with code='.$code.'. Try to redefine export.', LOG_WARNING);
        continue;
      }
 
      $newvalue = $outputlangs->convToOutputCharset($objp->$alias); // objp->$alias must be utf8 encoded as any var in memory // newvalue is now $outputlangs->charset_output encoded
      $typefield = isset($array_types[$code]) ? $array_types[$code] : '';
 
      // Translation newvalue
      if (preg_match('/^\‍((.*)\‍)$/i', $newvalue, $reg)) {
        $newvalue = $outputlangs->transnoentities($reg[1]);
      }
 
      $newvalue = $this->tsv_clean($newvalue, $outputlangs->charset_output);
 
      if (preg_match('/^Select:/i', $typefield) && $typefield = substr($typefield, 7)) {
        $array = jsonOrUnserialize($typefield);
        if (is_array($array) && !empty($newvalue)) {
          $array = $array['options'];
          $selectlabelvalues[$code."_label"] = $array[$newvalue];
        } else {
          $selectlabelvalues[$code."_label"] = "";
        }
      }
 
      fwrite($this->handle, $newvalue.$this->separator);
      $this->col++;
    }
    foreach ($selectlabelvalues as $key => $value) {
      fwrite($this->handle, $value.$this->separator);
      $this->col++;
    }
 
    fwrite($this->handle, "\n");
    return 0;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function write_footer($outputlangs)
  {
    // phpcs:enable
    return 0;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function close_file()
  {
    // phpcs:enable
    fclose($this->handle);
    return 0;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function tsv_clean($newvalue, $charset = '')
  {
    // phpcs:enable
    global $langs;
 
    if (empty($charset)) {
      $charset = getDolGlobalString('EXPORT_TSV_FORCE_CHARSET');
    }
 
    $newvalue = $langs->convToOutputCharset($newvalue, 'UTF-8', $charset); // newvalue is now encoded into $charset
 
 
    // Rule Dolibarr: No HTML
    $newvalue = dol_string_nohtmltag($newvalue, 1, $charset);
 
    // Rule 1 TSV: No CR, LF in cells
    $newvalue = str_replace("\r", '', $newvalue);
    $newvalue = str_replace("\n", '\n', $newvalue);
 
    // Rule 2 TSV: If value contains tab, we must replace by space
    if (preg_match('/'.$this->separator.'/', $newvalue)) {
      $newvalue = str_replace("\t", " ", $newvalue);
    }
 
    return $newvalue;
  }
}