expeditionligne.class.php

<?php
/* Copyright (C) 2003-2008  Rodolphe Quiedeville  <rodolphe@quiedeville.org>
 * Copyright (C) 2005-2012  Regis Houssin     <regis.houssin@inodbox.com>
 * Copyright (C) 2007   Franky Van Liedekerke <franky.van.liedekerke@telenet.be>
 * Copyright (C) 2006-2012  Laurent Destailleur   <eldy@users.sourceforge.net>
 * Copyright (C) 2011-2020  Juanjo Menent     <jmenent@2byte.es>
 * Copyright (C) 2013       Florian Henry       <florian.henry@open-concept.pro>
 * Copyright (C) 2014   Cedric GROSS      <c.gross@kreiz-it.fr>
 * Copyright (C) 2014-2015  Marcos García           <marcosgdf@gmail.com>
 * Copyright (C) 2014-2017  Francis Appels          <francis.appels@yahoo.com>
 * Copyright (C) 2015       Claudio Aschieri        <c.aschieri@19.coop>
 * Copyright (C) 2016-2024  Ferran Marcet     <fmarcet@2byte.es>
 * Copyright (C) 2018       Nicolas ZABOURI     <info@inovea-conseil.com>
 * Copyright (C) 2018-2025  Frédéric France         <frederic.france@free.fr>
 * Copyright (C) 2020       Lenin Rivas           <lenin@leninrivas.com>
 * Copyright (C) 2024-2026  MDW           <mdeweerd@users.noreply.github.com>
 * Copyright (C) 2025   Nick Fragoulis
 *
 * 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/class/commonobjectline.class.php";
require_once DOL_DOCUMENT_ROOT.'/expedition/class/expeditionlinebatch.class.php';
 
class ExpeditionLigne extends CommonObjectLine
{
  public $element = 'expeditiondet';
 
  public $table_element = 'expeditiondet';
 
  public $parent_element = 'expedition';
 
  public $fk_parent_attribute = 'fk_expedition';
 
  public $line_id;  // deprecated
 
  public $fk_element;
 
  public $origin_id;
 
  public $fk_elementdet;
 
  public $origin_line_id;
 
  public $fk_parent;
 
  public $element_type;
 
 
  public $fk_origin;      // Example: 'orderline'
 
  public $fk_expedition;
 
  public $db;
 
  public $qty;
 
  public $qty_shipped;
 
  public $fk_product;
 
  public $detail_batch;
 
  public $detail_children;
 
  public $details_entrepot;
 
 
  public $entrepot_id;
 
  public $fk_entrepot;
 
 
  public $qty_asked;
 
  public $ref;
 
  public $product_ref;
 
  public $libelle;
 
  public $product_label;
 
  public $desc;
 
  public $product_desc;
 
  public $product_type = 0;
 
  public $rang;
 
  public $weight;
 
  public $weight_units;
 
  public $length;
 
  public $length_units;
 
  public $width;
 
  public $width_units;
 
  public $height;
 
  public $height_units;
 
  public $surface;
 
  public $surface_units;
 
  public $volume;
 
  public $volume_units;
 
  public $stockable_product = 1;
 
  public $remise_percent;
 
  public $tva_tx;
 
  public $total_ht;
 
  public $total_ttc;
 
  public $total_tva;
 
  public $total_localtax1;
 
  public $total_localtax2;
 
 
  public function __construct($db)
  {
    $this->db = $db;
  }
 
  public function fetch($rowid)
  {
    $sql = 'SELECT ed.rowid, ed.fk_expedition, ed.fk_entrepot, ed.fk_product, ed.fk_parent, ed.description, ed.fk_unit, ed.fk_elementdet, ed.element_type, ed.qty, ed.rang, ed.extraparams';
    $sql .= ' FROM '.MAIN_DB_PREFIX.$this->table_element.' as ed';
    $sql .= ' WHERE ed.rowid = '.((int) $rowid);
    $result = $this->db->query($sql);
    if ($result) {
      $objp = $this->db->fetch_object($result);
      $this->id = $objp->rowid;
      $this->fk_expedition = $objp->fk_expedition;
      $this->entrepot_id = $objp->fk_entrepot;
      $this->fk_entrepot = $objp->fk_entrepot;
      $this->fk_product = $objp->fk_product;
      $this->fk_parent = $objp->fk_parent;
      $this->description = $objp->description;
      $this->fk_unit = $objp->fk_unit;
      $this->fk_elementdet = $objp->fk_elementdet;
      $this->element_type = $objp->element_type;
      $this->qty = $objp->qty;
      $this->rang = $objp->rang;
 
      $this->extraparams = !empty($objp->extraparams) ? (array) json_decode($objp->extraparams, true) : array();
 
      $this->db->free($result);
 
      return 1;
    } else {
      $this->errors[] = $this->db->lasterror();
      $this->error = $this->db->lasterror();
      return -1;
    }
  }
 
  public function insert($user = null, $notrigger = 0)
  {
    global $langs;
    $error = 0;
 
    $skip_check_parameters = false;
 
    // Handling parent line subtotal line
    if (!empty($this->element_type)
      && !empty($this->fk_elementdet)
      && $this->element_type == 'commande') {
      $objectsrc_line = new OrderLine($this->db);
      $objectsrc_line->fetch($this->fk_elementdet);
      $skip_check_parameters = $objectsrc_line->special_code == SUBTOTALS_SPECIAL_CODE;
    }
 
    // Check parameters
    $origin_id = $this->origin_id;
    if ($origin_id > 0) {
      if ((empty($this->fk_expedition)
        || (empty($this->fk_elementdet) && empty($this->fk_parent)) // at least origin line id of parent line id is set
        || !is_numeric($this->qty))
        && !$skip_check_parameters) {
        $langs->load('errors');
        $this->errors[] = $langs->trans('ErrorMandatoryParametersNotProvided');
        return -1;
      }
    } else {
      if (empty($this->fk_expedition) || !is_numeric($this->qty)) {
        $langs->load('errors');
        $this->errors[] = $langs->trans('ErrorMandatoryParametersNotProvided');
        return -1;
      }
    }
    $this->db->begin();
 
    if (getDolGlobalString('STOCK_EXPEDITION_NO_MORE_THAN_ORDER') && !empty($this->fk_elementdet) && !empty($this->fk_expedition)) {
      $this->checkQtyVsOrderLine($this->fk_elementdet, $this->qty, 0);
      if (!empty($this->error)) {
        $this->db->rollback();
        return -5;
      }
    }
 
    if (empty($this->rang)) {
      $this->rang = 0;
    }
 
    // Rank to use
    $ranktouse = $this->rang;
    if ($ranktouse == -1) {
      $rangmax = $this->line_max($this->fk_expedition);
      $ranktouse = $rangmax + 1;
    }
 
    $sql = "INSERT INTO ".MAIN_DB_PREFIX."expeditiondet (";
    $sql .= "fk_expedition";
    $sql .= ", fk_entrepot";
    $sql .= ", fk_elementdet";
    $sql .= ", fk_parent";
    $sql .= ", fk_product";
    $sql .= ", element_type";
    $sql .= ", qty";
    $sql .= ", fk_unit";
    $sql .= ", description";
    $sql .= ", rang";
    $sql .= ") VALUES (";
    $sql .= ((int) $this->fk_expedition);
    $sql .= ", ".(empty($this->entrepot_id) ? 'NULL' : ((int) $this->entrepot_id));
    $sql .= ", ".(empty($this->fk_elementdet) ? 'NULL' : ((int) $this->fk_elementdet));
    $sql .= ", ".(empty($this->fk_parent) ? 'NULL' : ((int) $this->fk_parent));
    $sql .= ", ".(empty($this->fk_product) ? 'NULL' : ((int) $this->fk_product));
    $sql .= ", '".(empty($this->element_type) ? 'order' : $this->db->escape($this->element_type))."'";
    $sql .= ", ".price2num($this->qty, 'MS');
    $sql .= ", ".((int) $this->fk_unit);
    $sql .= ", '".(empty($this->description) ? '' : $this->db->escape($this->description))."'";
    $sql .= ", ".((int) $ranktouse);
    $sql .= ")";
 
    dol_syslog(get_class($this)."::insert", LOG_DEBUG);
    $resql = $this->db->query($sql);
    if ($resql) {
      $this->id = $this->db->last_insert_id(MAIN_DB_PREFIX."expeditiondet");
 
      if (!$error) {
        $result = $this->insertExtraFields();
        if ($result < 0) {
          $error++;
        }
      }
 
      if (!$error && !$notrigger) {
        // Call trigger
        $result = $this->call_trigger('LINESHIPPING_INSERT', $user);
        if ($result < 0) {
          $error++;
        }
        // End call triggers
      }
 
      if ($error) {
        foreach ($this->errors as $errmsg) {
          dol_syslog(__METHOD__.' '.$errmsg, LOG_ERR);
          $this->error .= ($this->error ? ', '.$errmsg : $errmsg);
        }
      }
    } else {
      $error++;
    }
 
    if ($error) {
      $this->db->rollback();
      return -1;
    } else {
      $this->db->commit();
      return $this->id;
    }
  }
 
  public function findAllChild($line_id, &$list = array(), $mode = 0)
  {
    if ($line_id > 0) {
      // find all child
      $sql  = "SELECT ed.rowid as child_line_id";
      if ($mode == 1) {
        $sql .= ", ed.fk_product";
        $sql .= ", ed.fk_parent";
        $sql .= ", " . $this->db->ifsql('eb.rowid IS NULL', 'ed.qty', 'eb.qty') . " as qty";
        $sql .= ", " . $this->db->ifsql('eb.rowid IS NULL', 'ed.fk_entrepot', 'eb.fk_warehouse') . " as fk_warehouse";
        $sql .= ", eb.batch, eb.eatby, eb.sellby";
      }
      $sql .= " FROM " . $this->db->prefix() . $this->table_element . " as ed";
      $sql .= " LEFT JOIN " . $this->db->prefix() . "expeditiondet_batch as eb ON eb.fk_expeditiondet = " . ((int) $line_id);
      $sql .= " WHERE ed.fk_parent = " . ((int) $line_id);
      $sql .= $this->db->order('ed.fk_product,ed.rowid', 'ASC,ASC');
 
      $resql = $this->db->query($sql);
      if ($resql) {
        while ($obj = $this->db->fetch_object($resql)) {
          $child_line_id = (int) $obj->child_line_id;
          if (!isset($list[$line_id])) {
            $list[$line_id] = array();
          }
 
          if ($mode == 0) {
            $list[$line_id][] = $child_line_id;
          } elseif ($mode == 1) {
            $line_obj = new stdClass();
            $line_obj->rowid = $child_line_id;
            $line_obj->fk_product = $obj->fk_product;
            $line_obj->fk_parent = $obj->fk_parent;
            $line_obj->qty = $obj->qty;
            $line_obj->fk_warehouse = $obj->fk_warehouse;
            $line_obj->batch = $obj->batch;
            $line_obj->eatby = $obj->eatby;
            $line_obj->sellby = $obj->sellby;
            $line_obj->iskit = 0;
            $line_obj->incdec = 0;
            $list[$line_id][] = $line_obj;
          }
 
          $this->findAllChild($child_line_id, $list, $mode);
        }
        $this->db->free($resql);
      } else {
        $this->error = $this->db->lasterror();
        $this->errors[] = $this->error;
        dol_syslog(__METHOD__.' '.$this->error, LOG_ERR);
      }
    }
 
    return 1;
  }
 
  public function delete($user = null, $notrigger = 0)
  {
    $error = 0;
 
    $this->db->begin();
 
    // virtual products : delete all children and batch
    // Standalone dispatch allocations also belong to their source line.
    if ((getDolGlobalInt('PRODUIT_SOUSPRODUITS') || $this->element_type == 'shipping') && !($this->fk_parent > 0)) {
      // find all children
      $line_id_list = array();
      $result = $this->findAllChild($this->id, $line_id_list);
      if ($result) {
        $child_line_id_list = array_reverse($line_id_list, true);
        foreach ($child_line_id_list as $child_line_id_arr) {
          foreach ($child_line_id_arr as $child_line_id) {
            // delete batch expedition line
            if (isModEnabled('productbatch')) {
              $sql = "DELETE FROM " . $this->db->prefix() . "expeditiondet_batch";
              $sql .= " WHERE fk_expeditiondet = " . ((int) $child_line_id);
              if (!$this->db->query($sql)) {
                $error++;
                $this->errors[] = $this->db->lasterror() . " - sql=$sql";
              }
            }
 
            $sql = "DELETE FROM " . $this->db->prefix() . "expeditiondet";
            $sql .= " WHERE rowid = " . ((int) $child_line_id);
            if (!$this->db->query($sql)) {
              $error++;
              $this->errors[] = $this->db->lasterror() . " - sql=$sql";
            }
 
            if ($error) {
              break;
            }
          }
          if ($error) {
            break;
          }
        }
      } else {
        $error++;
      }
    }
 
    if (!$error) {
      // delete batch expedition line
      if (isModEnabled('productbatch')) {
        $sql = "DELETE FROM ".$this->db->prefix()."expeditiondet_batch";
        $sql .= " WHERE fk_expeditiondet = ".((int) $this->id);
 
        if (!$this->db->query($sql)) {
          $this->errors[] = $this->db->lasterror()." - sql=$sql";
          $error++;
        }
      }
 
      $sql = "DELETE FROM ".$this->db->prefix()."expeditiondet";
      $sql .= " WHERE rowid = ".((int) $this->id);
 
      if (!$error && $this->db->query($sql)) {
        // Remove extrafields
        if (!$error) {
          $result = $this->deleteExtraFields();
          if ($result < 0) {
            $this->errors[] = $this->error;
            $error++;
          }
        }
        if (!$error && !$notrigger) {
          // Call trigger
          $result = $this->call_trigger('LINESHIPPING_DELETE', $user);
          if ($result < 0) {
            $this->errors[] = $this->error;
            $error++;
          }
          // End call triggers
        }
      } else {
        $this->errors[] = $this->db->lasterror()." - sql=$sql";
        $error++;
      }
    }
 
    if (!$error) {
      $this->db->commit();
      return 1;
    } else {
      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;
    }
  }
 
  public function update($user = null, $notrigger = 0)
  {
    global $langs;
    $error = 0;
 
    dol_syslog(get_class($this)."::update id=$this->id, entrepot_id=$this->entrepot_id, product_id=$this->fk_product, qty=$this->qty");
 
    $this->db->begin();
 
    if (!empty($this->id) && empty($this->fk_elementdet)) {
      $sql = "SELECT fk_elementdet FROM ".MAIN_DB_PREFIX."expeditiondet";
      $sql .= " WHERE rowid = ".((int) $this->id);
      $resql = $this->db->query($sql);
      if ($resql) {
        $obj = $this->db->fetch_object($resql);
        if ($obj) {
          $this->fk_elementdet = $obj->fk_elementdet;
        }
      }
    }
 
    if (getDolGlobalString('STOCK_EXPEDITION_NO_MORE_THAN_ORDER') && !empty($this->fk_elementdet)) {
      $qty_to_check = $this->qty;
      if (!empty($this->detail_batch)) {
        if (is_array($this->detail_batch)) {
          $qty_to_check = array_sum(array_column($this->detail_batch, 'qty'));
        } else {
          $qty_to_check = $this->detail_batch->qty;
        }
      }
      $this->checkQtyVsOrderLine($this->fk_elementdet, $qty_to_check, $this->id);
      if (!empty($this->error)) {
        $this->db->rollback();
        return -5;
      }
    }
 
    // Clean parameters
    if (empty($this->qty)) {
      $this->qty = 0;
    }
    $qty = price2num($this->qty);
    $fk_unit = $this->fk_unit;
    $remainingQty = 0;
    $batch = null;
    $batch_id = 0;
    $expedition_batch_id = 0;
    $origin_id = $this->origin_id;
    if ($origin_id > 0) {
      if (is_array($this->detail_batch)) {  // array of ExpeditionLineBatch
        if (count($this->detail_batch) > 1) {
          dol_syslog(get_class($this).'::update only possible for one batch', LOG_ERR);
          $this->errors[] = 'ErrorBadParameters';
          $error++;
        } else {
          $batch = $this->detail_batch[0]->batch;
          $batch_id = $this->detail_batch[0]->fk_origin_stock;
          $expedition_batch_id = $this->detail_batch[0]->id;
          if ($this->entrepot_id != $this->detail_batch[0]->entrepot_id) {
            dol_syslog(get_class($this).'::update only possible for batch of same warehouse', LOG_ERR);
            $this->errors[] = 'ErrorBadParameters';
            $error++;
          }
          $qty = price2num($this->detail_batch[0]->qty);
        }
      } elseif (!empty($this->detail_batch)) {
        $batch = $this->detail_batch->batch;
        $batch_id = $this->detail_batch->fk_origin_stock;
        $expedition_batch_id = $this->detail_batch->id;
        if ($this->entrepot_id != $this->detail_batch->entrepot_id) {
          dol_syslog(get_class($this).'::update only possible for batch of same warehouse', LOG_ERR);
          $this->errors[] = 'ErrorBadParameters';
          $error++;
        }
        $qty = price2num($this->detail_batch->qty);
      }
 
      // check parameters
      if (!isset($this->id) || !isset($this->entrepot_id)) {
        dol_syslog(get_class($this).'::update missing line id and/or warehouse id', LOG_ERR);
        $langs->load('errors');
        $this->errors[] = $langs->trans('ErrorMandatoryParametersNotProvided');
        $error++;
        return -1;
      }
 
      // update lot
      if (!empty($batch) && isModEnabled('productbatch')) {
        $batch_id_str = $batch_id ?? 'null';
        dol_syslog(get_class($this)."::update expedition batch id=$expedition_batch_id, batch_id=$batch_id_str, batch=$batch");
 
        if (empty($batch_id) || empty($this->fk_product)) {
          dol_syslog(get_class($this).'::update missing fk_origin_stock (batch_id) and/or fk_product', LOG_ERR);
          $langs->load('errors');
          $this->errors[] = $langs->trans('ErrorMandatoryParametersNotProvided');
          $error++;
        }
 
        // fetch remaining lot qty
        $shipmentlinebatch = new ExpeditionLineBatch($this->db);
        $lotArray = $shipmentlinebatch->fetchAll($this->id);
        if (!$error && $lotArray < 0) {
          $this->errors[] = $this->db->lasterror()." - ExpeditionLineBatch::fetchAll";
          $error++;
        } else {
          // calculate new total line qty
          foreach ($lotArray as $lot) {
            if ($expedition_batch_id != $lot->id) {
              $remainingQty += $lot->qty;
            }
          }
          $qty += $remainingQty;
 
          //fetch lot details
          // fetch from product_lot
          require_once DOL_DOCUMENT_ROOT.'/product/stock/class/productlot.class.php';
          $lot = new Productlot($this->db);
          if ($lot->fetch(0, $this->fk_product, $batch) < 0) {
            $this->errors = array_merge($this->errors, $lot->errors);
            $error++;
          }
          if (!$error && !empty($expedition_batch_id)) {
            // delete lot expedition line
            $sql = "DELETE FROM ".MAIN_DB_PREFIX."expeditiondet_batch";
            $sql .= " WHERE fk_expeditiondet = ".((int) $this->id);
            $sql .= " AND rowid = ".((int) $expedition_batch_id);
 
            if (!$this->db->query($sql)) {
              $this->errors[] = $this->db->lasterror()." - sql=$sql";
              $error++;
            }
          }
          if (!$error && $this->detail_batch->qty > 0) {
            // create lot expedition line
            if (isset($lot->id)) {
              $shipmentLot = new ExpeditionLineBatch($this->db);
              $shipmentLot->batch = $lot->batch;
              $shipmentLot->eatby = $lot->eatby;
              $shipmentLot->sellby = $lot->sellby;
              $shipmentLot->fk_warehouse = $this->detail_batch->entrepot_id;
              $shipmentLot->qty = $this->detail_batch->qty;
              $shipmentLot->fk_origin_stock = (int) $batch_id;
              if ($shipmentLot->create($this->id) < 0) {
                $this->errors = $shipmentLot->errors;
                $error++;
              }
            }
          }
        }
      }
    }
    if (!$error) {
      // update line
      $sql = "UPDATE ".MAIN_DB_PREFIX.$this->table_element." SET";
      $sql .= " fk_entrepot = ".($this->entrepot_id > 0 ? ((int) $this->entrepot_id) : 'null');
      $sql .= " , qty = ".((float) price2num($qty, 'MS'));
      $sql .= " , fk_unit = ".((int) $this->fk_unit);
      $sql .= " WHERE rowid = ".((int) $this->id);
 
      if (!$this->db->query($sql)) {
        $this->errors[] = $this->db->lasterror()." - sql=$sql";
        $error++;
      }
    }
 
    if (!$error) {
      $result = $this->insertExtraFields();
      if ($result < 0) {
        $this->errors[] = $this->error;
        $error++;
      }
    }
 
    if (!$error && !$notrigger) {
      // Call trigger
      $result = $this->call_trigger('LINESHIPPING_MODIFY', $user);
      if ($result < 0) {
        $this->errors[] = $this->error;
        $error++;
      }
      // End call triggers
    }
    if (!$error) {
      $this->db->commit();
      return 1;
    } else {
      foreach ($this->errors as $errmsg) {
        dol_syslog(get_class($this)."::update ".$errmsg, LOG_ERR);
        $this->error .= ($this->error ? ', '.$errmsg : $errmsg);
      }
      $this->db->rollback();
      return -1 * $error;
    }
  }
 
  private function checkQtyVsOrderLine(int $fk_elementdet, float $qty, int $exclude_line_id): bool
  {
    global $langs;
 
    // Ordered quantity on the source order line
    require_once DOL_DOCUMENT_ROOT.'/commande/class/commande.class.php';
    $orderline = new OrderLine($this->db);
    if ($orderline->fetch($fk_elementdet) <= 0) {
      return true; // Order line not found, skip check
    }
    if ($orderline->product_type == 9) {
      return true; // Skip check for title/separator lines, they have no deliverable quantity
    }
    $qty_ordered = (float) $orderline->qty;
 
    // Quantity already shipped on other shipment lines
    $sql  = "SELECT COALESCE(SUM(ed.qty), 0) as qty_shipped";
    $sql .= " FROM ".MAIN_DB_PREFIX."expeditiondet as ed";
    $sql .= " INNER JOIN ".MAIN_DB_PREFIX."expedition as e ON e.rowid = ed.fk_expedition";
    $sql .= " WHERE ed.fk_elementdet = ".((int) $fk_elementdet);
    $sql .= " AND e.fk_statut >= 0"; // exclude only deleted ones
    if ($exclude_line_id > 0) {
      $sql .= " AND ed.rowid != ".((int) $exclude_line_id); // exclude current line being edited
    }
 
    $resql = $this->db->query($sql);
    if (!$resql) {
      return true;
    }
    $obj = $this->db->fetch_object($resql);
    $qty_already_shipped = $obj ? (float) $obj->qty_shipped : 0;
 
    $qty_remaining = $qty_ordered - $qty_already_shipped;
 
    if ($qty > $qty_remaining) {
      $langs->load('errors');
      $product_ref = !empty($orderline->product_ref) ? $orderline->product_ref : $orderline->desc;
      $this->error = $langs->trans('ErrorExpeditionQtyTooHigh', $qty, max(0, $qty_remaining), $product_ref);
      return false;
    }
 
    return true;
  }
}