phpbarcode.modules.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2005-2013 Laurent Destailleur  <eldy@users.sourceforge.net>
 * Copyright (C) 2005      Regis Houssin        <regis.houssin@inodbox.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/>.
 * or see https://www.gnu.org/
 */
 
require_once DOL_DOCUMENT_ROOT.'/core/modules/barcode/modules_barcode.class.php';
require_once DOL_DOCUMENT_ROOT.'/core/lib/barcode.lib.php'; // This is to include def like $genbarcode_loc and $font_loc
 
 
class modPhpbarcode extends ModeleBarCode
{
  public $version = 'dolibarr';
 
  public $error = '';
 
 
  public function isEnabled()
  {
    return true;
  }
 
 
  public function info($langs)
  {
    global $langs;
 
    $key = 'BarcodeInternalEngine';
    $trans = $langs->trans('BarcodeInternalEngine');
 
    return ($trans != $key) ? $trans : 'Internal engine';
  }
 
  public function canBeActivated($object)
  {
    global $langs;
 
    return true;
  }
 
 
  public function encodingIsSupported($encoding)
  {
    global $genbarcode_loc;
    //print 'genbarcode_loc='.$genbarcode_loc.' encoding='.$encoding;exit;
 
    $supported = 0;
    if ($encoding == 'EAN13') {
      $supported = 1;
    }
    if ($encoding == 'ISBN') {
      $supported = 1;
    }
    if ($encoding == 'UPC') {
      $supported = 1;
    }
    // Formats that hangs on Windows (when genbarcode.exe for Windows is called, so they are not
    // activated on Windows)
    if (file_exists($genbarcode_loc) && empty($_SERVER["WINDIR"])) {
      if ($encoding == 'EAN8') {
        $supported = 1;
      }
      if ($encoding == 'C39') {
        $supported = 1;
      }
      if ($encoding == 'C128') {
        $supported = 1;
      }
    }
    return $supported;
  }
 
  public function buildBarCode($code, $encoding, $readable = 'Y', $scale = 1, $nooutputiferror = 0)
  {
    if (!$this->encodingIsSupported($encoding)) {
      return -1;
    }
 
    if ($encoding == 'EAN8' || $encoding == 'EAN13') {
      $encoding = 'EAN';
    }
    if ($encoding == 'C39' || $encoding == 'C128') {
      $encoding = substr($encoding, 1);
    }
 
    $mode = 'png';
 
    $_GET["code"] = $code;
    $_GET["encoding"] = $encoding;
    $_GET["scale"] = $scale;
    $_GET["mode"] = $mode;
 
    global $filebarcode;  // Retrieve variable where to store filename
    if (empty($filebarcode)) {
      $filebarcode = '';
    }
 
    $result = "No barcode ($code) to print";
    dol_syslog(get_class($this)."::buildBarCode $code,$encoding,$scale,$mode,$filebarcode");
    if ($code) {
      $result = barcode_print($code, $encoding, $scale, $mode, $filebarcode);
    }
 
    if (!is_array($result)) {
      $this->error = $result;
      if (empty($nooutputiferror)) {
        print dol_escape_htmltag($this->error);
      }
      return -1;
    }
 
    return 1;
  }
 
  public function writeBarCode($code, $encoding, $readable = 'Y', $scale = 1, $nooutputiferror = 0)
  {
    global $conf, $langs;
 
    dol_mkdir($conf->barcode->dir_temp);
    if (!is_writable($conf->barcode->dir_temp)) {
      if ($langs instanceof Translate) {
        $this->error = $langs->transnoentities("ErrorFailedToWriteInTempDirectory", $conf->barcode->dir_temp);
      } else {
        $this->error = "ErrorFailedToWriteInTempDirectory ".$conf->barcode->dir_temp;
      }
      dol_syslog('Error in write_file: ' . $this->error, LOG_ERR);
      return -1;
    }
 
    $newcode = $code;
    if (!preg_match('/^\w+$/', $code) || dol_strlen($code) > 32) {
      $newcode = dol_hash($newcode, 'md5'); // No need for security here, we can use md5
    }
 
    global $filebarcode;
    $filebarcode = $conf->barcode->dir_temp . '/barcode_' . $newcode . '_' . $encoding . '.png';
 
    $result = $this->buildBarCode($code, $encoding, $readable, $scale, $nooutputiferror);
 
    return $result;
  }
}