mod_barcode_product_standard.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2004      Rodolphe Quiedeville <rodolphe@quiedeville.org>
 * Copyright (C) 2006-2014 Laurent Destailleur  <eldy@users.sourceforge.net>
 * Copyright (C) 2007-2012 Regis Houssin        <regis.houssin@inodbox.com>
 * Copyright (C) 2011      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>
 *
 * 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';
 
 
class mod_barcode_product_standard extends ModeleNumRefBarCode
{
  public $name = 'Standard'; // Model Name
 
  public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr'
 
  public $searchcode; // Search string
 
  public $numbitcounter; // Number of digits the counter
 
  public function __construct()
  {
    $this->code_null = 0;
    $this->code_modifiable = 1;
    $this->code_modifiable_invalide = 1;
    $this->code_modifiable_null = 1;
    $this->code_auto = 1;
    $this->prefixIsRequired = 0;
  }
 
 
  public function info($langs)
  {
    global $conf, $mc;
    global $form;
 
    $langs->load("products");
 
    $disabled = ((!empty($mc->sharings['referent']) && $mc->sharings['referent'] != $conf->entity) ? ' disabled' : '');
 
    $texte = $langs->trans('GenericNumRefModelDesc')."<br>\n";
    $texte .= '<form action="'.$_SERVER["PHP_SELF"].'" method="POST">';
    $texte .= '<input type="hidden" name="token" value="'.newToken().'">';
    $texte .= '<input type="hidden" name="page_y" value="">';
    $texte .= '<input type="hidden" name="action" value="setModuleOptions">';
    $texte .= '<input type="hidden" name="param1" value="BARCODE_STANDARD_PRODUCT_MASK">';
    $texte .= '<table class="nobordernopadding" width="100%">';
 
    $tooltip = $langs->trans("GenericMaskCodes", $langs->transnoentities("BarCode"), $langs->transnoentities("BarCode"));
    $tooltip .= $langs->trans("GenericMaskCodes3EAN");
    $tooltip .= '<strong>'.$langs->trans("Example").':</strong><br>';
    $tooltip .= '04{0000000000}? (for internal use)<br>';
    $tooltip .= '9771234{00000}? (example of ISSN code with prefix 1234)<br>';
    $tooltip .= '9791234{00000}? (example of ISMN code with prefix 1234)<br>';
    //$tooltip .= $langs->trans("GenericMaskCodes5");
    //$tooltip .= '<br>'.$langs->trans("GenericMaskCodes5b");
 
    // Mask parameter
    //$texte.= '<tr><td>'.$langs->trans("Mask").' ('.$langs->trans("BarCodeModel").'):</td>';
    $texte .= '<tr><td>'.$langs->trans("Mask").':</td>';
    $texte .= '<td class="right">'.$form->textwithpicto('<input type="text" class="flat minwidth175" name="value1" value="'.(getDolGlobalString('BARCODE_STANDARD_PRODUCT_MASK') ? $conf->global->BARCODE_STANDARD_PRODUCT_MASK : '').'"'.$disabled.'>', $tooltip, 1, 1).'</td>';
    $texte .= '<td class="left" rowspan="2">&nbsp; <input type="submit" class="button button-edit reposition smallpaddingimp" name="modify" value="'.$langs->trans("Modify").'"'.$disabled.'></td>';
    $texte .= '</tr>';
 
    $texte .= '</table>';
    $texte .= '</form>';
 
    return $texte;
  }
 
 
  public function getExample($langs = null, $objproduct = null)
  {
    if (!$langs instanceof Translate) {
      $langs = $GLOBALS['langs'];
      '@phan-var-force Translate $langs';
    }
    $examplebarcode = $this->getNextValue($objproduct, '');
    if (!$examplebarcode) {
      $examplebarcode = $langs->trans('NotConfigured');
    }
    if ($examplebarcode == "ErrorBadMask") {
      $langs->load("errors");
      $examplebarcode = $langs->trans($examplebarcode);
    }
 
    return $examplebarcode;
  }
  public function literalBarcodeType($db, $type = 0)
  {
    global $conf;
    $out = '';
 
    $sql = "SELECT rowid, code, libelle as label";
    $sql .= " FROM ".MAIN_DB_PREFIX."c_barcode_type";
    $sql .= " WHERE rowid = ".(int) $type;
    $sql .= " AND entity = ".((int) $conf->entity);
    $result = $db->query($sql);
    if ($result) {
      $num = $db->num_rows($result);
 
      if ($num > 0) {
        $obj = $db->fetch_object($result);
        $out .= $obj->label; //take the label corresponding to the type rowid in the database
      }
    } else {
      dol_print_error($db);
    }
 
    return $out;
  }
 
  public function getNextValue($objproduct = null, $type = '')
  {
    global $db;
 
    if (is_object($objproduct) && !$objproduct instanceof Product) {
      dol_syslog(get_class($this)."::getNextValue used on incompatible".get_class($objproduct), LOG_ERR);
      return -1;
    }
 
    require_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
    require_once DOL_DOCUMENT_ROOT.'/core/lib/barcode.lib.php'; // to be able to call function barcode_gen_ean_sum($ean)
 
    // Get barcode type configuration for products if $type not set
    if (empty($type)) {
      $type = getDolGlobalString('PRODUIT_DEFAULT_BARCODE_TYPE');
    }
 
    // Get Mask value
    $mask = getDolGlobalString('BARCODE_STANDARD_PRODUCT_MASK');
 
    if (empty($mask)) {
      $this->error = 'NotConfigured';
      return '';
    }
 
    $field = 'barcode';
    $where = '';
 
    $now = dol_now();
 
    $numFinal = get_next_value($db, $mask, 'product', $field, $where, '', $now);
    //Begin barcode with key: for barcode with key (EAN13...) calculate and substitute the last  character (* or ?) used in the mask by the key
    if ((substr($numFinal, -1) == '*') or (substr($numFinal, -1) == '?')) { // if last mask character is * or ? a joker, probably we have to calculate a key as last character (EAN13...)
      $literaltype = '';
      $literaltype = $this->literalBarcodeType($db, $type);//get literal_Barcode_Type
      switch ($literaltype) {
        case 'EAN13': //EAN13 rowid = 2
          if (strlen($numFinal) == 13) {// be sure that the mask length is correct for EAN13
            $ean = substr($numFinal, 0, 12); //take first 12 digits
            $eansum = barcode_gen_ean_sum($ean);
            $ean .= $eansum; //substitute the las character by the key
            $numFinal = $ean;
          }
          break;
          // Other barcode cases with key could be written here
        default:
          break;
      }
    }
    //End barcode with key
 
    return $numFinal;
  }
 
 
  public function verif($db, &$code, $product, $thirdparty_type, $type)
  {
    if (!$product instanceof Product) {
      dol_syslog(get_class($this)."::verif called with ".get_class($product)." Expected Product", LOG_ERR);
      return -7;
    }
 
    //var_dump($code.' '.$product->ref.' '.$thirdparty_type);exit;
 
    require_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
 
    $result = 0;
    $code = strtoupper(trim($code));
 
    if (empty($code) && $this->code_null && !getDolGlobalString('BARCODE_STANDARD_PRODUCT_MASK')) {
      $result = 0;
    } elseif (empty($code) && (!$this->code_null || getDolGlobalString('BARCODE_STANDARD_PRODUCT_MASK'))) {
      $result = -2;
    } else {
      if ($this->verif_syntax($code, $type) >= 0) {
        $is_dispo = $this->verif_dispo($db, $code, $product);
        if ($is_dispo != 0) {
          $result = -3;
        } else {
          $result = 0;
        }
      } else {
        if (dol_strlen($code) == 0) {
          $result = -2;
        } else {
          $result = -1;
        }
      }
    }
 
    dol_syslog(get_class($this)."::verif type=".$thirdparty_type." result=".$result);
    return $result;
  }
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function verif_dispo($db, $code, $product)
  {
    // phpcs:enable
    $sql = "SELECT barcode FROM ".MAIN_DB_PREFIX."product";
    $sql .= " WHERE barcode = '".$db->escape($code)."'";
    $sql .= " AND entity IN (".getEntity('product').")";
 
    if ($product->id > 0) {
      $sql .= " AND rowid <> ".$product->id;
    }
 
    $resql = $db->query($sql);
    if ($resql) {
      if ($db->num_rows($resql) == 0) {
        return 0;
      } else {
        return -1;
      }
    } else {
      return -2;
    }
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function verif_syntax($codefortest, $typefortest)
  {
    // phpcs:enable
    global $conf;
 
    $result = 0;
 
    // Get Mask value
    $mask = !getDolGlobalString('BARCODE_STANDARD_PRODUCT_MASK') ? '' : $conf->global->BARCODE_STANDARD_PRODUCT_MASK;
    if (!$mask) {
      $this->error = 'NotConfigured';
      return -1;
    }
 
    dol_syslog(get_class($this).'::verif_syntax codefortest='.$codefortest." typefortest=".$typefortest);
 
    $newcodefortest = $codefortest;
 
    // Special case, if mask is on 12 digits instead of 13, we remove last char into code to test
    if (in_array($typefortest, array('EAN13', 'ISBN'))) { // We remove the CRC char not included into mask
      if (preg_match('/\{(0+)([@\+][0-9]+)?([@\+][0-9]+)?\}/i', $mask, $reg)) {
        if (strlen($reg[1]) == 12) {
          $newcodefortest = substr($newcodefortest, 0, 12);
        }
        dol_syslog(get_class($this).'::verif_syntax newcodefortest='.$newcodefortest);
      }
    }
 
    $result = check_value($mask, $newcodefortest);
    if (is_string($result)) {
      $this->error = $result;
      return -1;
    }
 
    return $result;
  }
}