api_shipments.class.php

<?php
/* Copyright (C) 2015       Jean-François Ferry     <jfefe@aternatik.fr>
 * Copyright (C) 2016       Laurent Destailleur     <eldy@users.sourceforge.net>
 * Copyright (C) 2025   MDW           <mdeweerd@users.noreply.github.com>
 * Copyright (C) 2025   Charlene Benke      <charlene@patas-monkey.com>
 * Copyright (C) 2025       Frédéric France         <frederic.france@free.fr>
 * 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/>.
 */
 
use Luracast\Restler\RestException;
 
require_once DOL_DOCUMENT_ROOT.'/expedition/class/expedition.class.php';
require_once DOL_DOCUMENT_ROOT.'/core/lib/company.lib.php';
 
class Shipments extends DolibarrApi
{
  public static $FIELDS = array(
    'socid',
    'origin_id',
    'origin_type',
  );
 
  public $shipment;
 
  public function __construct()
  {
    global $db;
    $this->db = $db;
    $this->shipment = new Expedition($this->db);
  }
 
  public function get($id)
  {
    if (!DolibarrApiAccess::$user->hasRight('expedition', 'lire')) {
      throw new RestException(403);
    }
 
    $result = $this->shipment->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Shipment not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('expedition', $this->shipment->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $this->shipment->fetchObjectLinked();
    return $this->_cleanObjectDatas($this->shipment);
  }
 
 
 
  public function index($sortfield = "t.rowid", $sortorder = 'ASC', $limit = 100, $page = 0, $thirdparty_ids = '', $sqlfilters = '', $properties = '', $pagination_data = false)
  {
    if (!DolibarrApiAccess::$user->hasRight('expedition', 'lire')) {
      throw new RestException(403);
    }
 
    global $hookmanager;
 
    $obj_ret = array();
 
    // case of external user, $thirdparty_ids param is ignored and replaced by user's socid
    $socids = DolibarrApiAccess::$user->socid ?: $thirdparty_ids;
 
    // If the internal user must only see his customers, force searching by him
    $search_sale = 0;
    if (!DolibarrApiAccess::$user->hasRight('societe', 'client', 'voir') && !$socids) {
      $search_sale = DolibarrApiAccess::$user->id;
    }
 
    $sql = "SELECT t.rowid";
    $sql .= " FROM ".MAIN_DB_PREFIX."expedition AS t";
    $sql .= " INNER JOIN ".MAIN_DB_PREFIX."societe AS s ON (s.rowid = t.fk_soc)";
    $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."expedition_extrafields AS ef ON (ef.fk_object = t.rowid)"; // Modification VMR Global Solutions to include extrafields as search parameters in the API GET call, so we will be able to filter on extrafields
    $sql .= ' WHERE t.entity IN ('.getEntity('expedition').')';
    if ($socids) {
      $sql .= " AND t.fk_soc IN (".$this->db->sanitize($socids).")";
    }
    // Search on sale representative
    if ($search_sale && $search_sale != '-1') {
      if ($search_sale == -2) {
        $sql .= " AND ".getSalesRepresentativeSqlFilter('t.fk_soc', 0, 1);
      } elseif ($search_sale > 0) {
        $sql .= " AND ".getSalesRepresentativeSqlFilter('t.fk_soc', (int) $search_sale);
      }
    }
    // Add sql filters
    if ($sqlfilters) {
      $parameters = array('sqlfilters' => $sqlfilters, 'apiroute' => 'shipments', 'apimethod' => 'index');
      $object = new stdClass();
      $action = 'list';
      $reshook = $hookmanager->executeHooks('printFieldListWhere', $parameters, $object, $action); // Note that $action and $object may have been modified by hook
      if ($reshook > 0) {
        $sql = $hookmanager->resPrint;
      } elseif ($reshook == 0) {
        $sql .= $hookmanager->resPrint;
      }
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
    //this query will return total shipments with the filters given
    $sqlTotals = str_replace('SELECT t.rowid', 'SELECT count(t.rowid) as total', $sql);
 
    $sql .= $this->db->order($sortfield, $sortorder);
    if ($limit) {
      if ($page < 0) {
        $page = 0;
      }
      $offset = $limit * $page;
 
      $sql .= $this->db->plimit($limit + 1, $offset);
    }
 
    dol_syslog("API Rest request");
    $result = $this->db->query($sql);
 
    if ($result) {
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      $i = 0;
      while ($i < $min) {
        $obj = $this->db->fetch_object($result);
        $shipment_static = new Expedition($this->db);
        if ($shipment_static->fetch($obj->rowid)) {
          $obj_ret[] = $this->_filterObjectProperties($this->_cleanObjectDatas($shipment_static), $properties);
        }
        $i++;
      }
    } else {
      throw new RestException(503, 'Error when retrieve commande list : '.$this->db->lasterror());
    }
 
    //if $pagination_data is true the response will contain element data with all values and element pagination with pagination data(total,page,limit)
    if ($pagination_data) {
      $totalsResult = $this->db->query($sqlTotals);
      $total = $this->db->fetch_object($totalsResult)->total;
 
      $tmp = $obj_ret;
      $obj_ret = [];
 
      $obj_ret['data'] = $tmp;
      $obj_ret['pagination'] = [
        'total' => (int) $total,
        'page' => $page, //count starts from 0
        'page_count' => ceil((int) $total / $limit),
        'limit' => $limit
      ];
    }
 
    return $obj_ret;
  }
 
  public function post($request_data = null)
  {
    if (!DolibarrApiAccess::$user->hasRight('expedition', 'creer')) {
      throw new RestException(403, "Insufficiant rights");
    }
    // Check mandatory fields
    $result = $this->_validate($request_data);
 
    foreach ($request_data as $field => $value) {
      if ($field === 'caller') {
        // Add a mention of caller so on trigger called after action, we can filter to avoid a loop if we try to sync back again with the caller
        $this->shipment->context['caller'] = sanitizeVal($request_data['caller'], 'aZ09');
        continue;
      }
 
      $this->shipment->$field = $this->_checkValForAPI($field, $value, $this->shipment);
    }
    if (isset($request_data["lines"])) {
      $lines = array();
      foreach ($request_data["lines"] as $line) {
        $shipmentline = new ExpeditionLigne($this->db);
 
        $shipmentline->entrepot_id = (int) $line['entrepot_id'];
        $shipmentline->fk_element = (int) ($line['fk_element'] ?? $line['origin_id']);        // example: order id.  this->origin is 'commande'
        $shipmentline->origin_line_id = (int) ($line['fk_elementdet'] ?? $line['origin_line_id']);  // example: order id
        $shipmentline->fk_elementdet = (int) ($line['fk_elementdet'] ?? $line['origin_line_id']); // example: order line id
        $shipmentline->origin_type = $line['element_type'] ?? $line['origin_type'];     // example 'commande' or 'order'
        $shipmentline->element_type = $line['element_type'] ?? $line['origin_type'];    // example 'commande' or 'order'
        $shipmentline->qty = (float) $line['qty'];
        $shipmentline->rang = (int) $line['rang'];
        $array_options = $line['array_options'];
        if (is_array($array_options)) {
          $shipmentline->array_options = $array_options;
        }
        $detail_batch = $line['detail_batch'];
        if (is_array($detail_batch) || is_object($detail_batch)) {
          $shipmentline->detail_batch = $detail_batch;
        }
        $lines[] = $shipmentline;
      }
      $this->shipment->lines = $lines;
    }
 
    if ($this->shipment->create(DolibarrApiAccess::$user) < 0) {
      throw new RestException(500, "Error creating shipment", array_merge(array($this->shipment->error), $this->shipment->errors));
    }
 
    return $this->shipment->id;
  }
 
  public function getLines($id)
  {
    if (!DolibarrApiAccess::$user->hasRight('expedition', 'lire')) {
      throw new RestException(403);
    }
 
    $result = $this->shipment->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Shipment not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('expedition', $this->shipment->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
    $this->shipment->getLinesArray();
    $result = array();
    foreach ($this->shipment->lines as $line) {
      array_push($result, $this->_cleanObjectDatas($line));
    }
    return $result;
  }
 
  public function postLine($id, $fk_origin_line = 0, $qty = 0, $warehouse_id = 0, $fk_product = 0)
  {
    if (!DolibarrApiAccess::$user->hasRight('expedition', 'creer')) {
      throw new RestException(403);
    }
 
    $result = $this->shipment->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Shipment not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('expedition', $this->shipment->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    // A line can only be added while the shipment is a draft (no stock movement yet).
    if ((int) $this->shipment->status != Expedition::STATUS_DRAFT) {
      throw new RestException(405, 'Lines can only be added to a draft shipment');
    }
 
    $fk_origin_line = (int) $fk_origin_line;
    if ($fk_origin_line <= 0) {
      throw new RestException(400, 'Field fk_origin_line is mandatory');
    }
 
    $qty = (float) $qty;
    if ($qty <= 0) {
      throw new RestException(400, 'Field qty is mandatory and must be greater than 0');
    }
 
    require_once DOL_DOCUMENT_ROOT.'/commande/class/commande.class.php';
    $orderline = new OrderLine($this->db);
    $resorderline = $orderline->fetch($fk_origin_line);
    if ($resorderline <= 0) {
      throw new RestException(404, 'Origin order line '.$fk_origin_line.' not found');
    }
    if (isModEnabled('productbatch') && !empty($orderline->product_tobatch)) {
      throw new RestException(405, 'Adding a batch/lot managed shipment line is not supported through this endpoint. Use the dedicated dispatch flow instead.');
    }
 
    // addline() stacks the line in memory and runs native validation
    // (warehouse requirement, stock availability, batch rejection).
    $addResult = $this->shipment->addline((int) $warehouse_id, $fk_origin_line, $qty, array(), (int) $fk_product);
    if ($addResult <= 0) {
      $msg = $this->shipment->errorsToString() ? $this->shipment->errorsToString() : 'Error while adding shipment line';
      // -1 missing warehouse, -3 not enough stock, -4 batch product: bad request from the caller.
      if (in_array((int) $addResult, array(-1, -3, -4), true)) {
        throw new RestException(400, $msg);
      }
      throw new RestException(500, $msg);
    }
 
    // addline() only fills $this->shipment->lines; persist the line just stacked.
    $line = end($this->shipment->lines);
    $line->fk_expedition = $this->shipment->id;
 
    $insertRes = $line->insert(DolibarrApiAccess::$user);
    if ($insertRes > 0) {
      return $insertRes;
    }
 
    throw new RestException(500, $line->errorsToString());
  }
 
  public function putLine($id, $lineid, $qty = 0, $warehouse_id = 0)
  {
    if (!DolibarrApiAccess::$user->hasRight('expedition', 'creer')) {
      throw new RestException(403);
    }
 
    $result = $this->shipment->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Shipment not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('expedition', $this->shipment->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    // A line can only be edited while the shipment is a draft (no stock movement yet).
    if ((int) $this->shipment->status != Expedition::STATUS_DRAFT) {
      throw new RestException(405, 'Only draft shipment lines can be updated');
    }
 
    $qty = (float) $qty;
    if ($qty <= 0) {
      throw new RestException(400, 'Field qty is mandatory and must be greater than 0');
    }
 
    $line = new ExpeditionLigne($this->db);
    $resline = $line->fetch($lineid);
    if ($resline <= 0) {
      throw new RestException(404, 'Shipment line not found');
    }
    if ((int) $line->fk_expedition != (int) $this->shipment->id) {
      throw new RestException(404, 'Line '.((int) $lineid).' is not a line of shipment '.((int) $id));
    }
 
    require_once DOL_DOCUMENT_ROOT.'/expedition/class/expeditionlinebatch.class.php';
    $linebatch = new ExpeditionLineBatch($this->db);
    $lots = $linebatch->fetchAll($line->id);
    if (is_array($lots) && count($lots) > 0) {
      throw new RestException(405, 'Update of a batch/lot managed shipment line is not supported. Delete and recreate the line instead.');
    }
 
    $line->qty = $qty;
    if ($warehouse_id > 0) {
      $line->entrepot_id = (int) $warehouse_id;
    }
 
    $updateRes = $line->update(DolibarrApiAccess::$user);
    if ($updateRes > 0) {
      return $this->get($id);
    }
 
    throw new RestException(500, $line->errorsToString() ? $line->errorsToString() : $this->shipment->errorsToString());
  }
 
  public function deleteLine($id, $lineid)
  {
    if (!DolibarrApiAccess::$user->hasRight('expedition', 'creer')) {
      throw new RestException(403);
    }
 
    $result = $this->shipment->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Shipment not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('expedition', $this->shipment->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    // A line can only be deleted while the shipment is a draft (no stock movement yet).
    if ((int) $this->shipment->status != Expedition::STATUS_DRAFT) {
      throw new RestException(405, 'Only draft shipment lines can be deleted');
    }
 
    $line = new ExpeditionLigne($this->db);
    $resline = $line->fetch($lineid);
    if ($resline <= 0) {
      throw new RestException(404, 'Shipment line not found');
    }
    if ((int) $line->fk_expedition != (int) $this->shipment->id) {
      throw new RestException(404, 'Line '.((int) $lineid).' is not a line of shipment '.((int) $id));
    }
 
    $deleteRes = $this->shipment->deleteLine(DolibarrApiAccess::$user, $lineid);
    if ($deleteRes > 0) {
      return $this->get($id);
    }
 
    throw new RestException(500, $this->shipment->errorsToString() ? $this->shipment->errorsToString() : 'Error while deleting shipment line');
  }
 
  public function put($id, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->hasRight('expedition', 'creer')) {
      throw new RestException(403);
    }
 
    $result = $this->shipment->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Shipment not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('expedition', $this->shipment->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
    foreach ($request_data as $field => $value) {
      if ($field == 'id') {
        continue;
      }
      if ($field === 'caller') {
        // Add a mention of caller so on trigger called after action, we can filter to avoid a loop if we try to sync back again with the caller
        $this->shipment->context['caller'] = sanitizeVal($request_data['caller'], 'aZ09');
        continue;
      }
 
      if ($field == 'array_options' && is_array($value)) {
        foreach ($value as $index => $val) {
          $this->shipment->array_options[$index] = $this->_checkValExtrafieldsForAPI($index, $val, $this->shipment);
        }
        continue;
      }
      $this->shipment->$field = $this->_checkValForAPI($field, $value, $this->shipment);
    }
 
    if ($this->shipment->update(DolibarrApiAccess::$user) > 0) {
      return $this->get($id);
    } else {
      throw new RestException(500, $this->shipment->errorsToString());
    }
  }
 
  public function delete($id)
  {
    if (!DolibarrApiAccess::$user->hasRight('expedition', 'supprimer')) {
      throw new RestException(403);
    }
    $result = $this->shipment->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Shipment not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('expedition', $this->shipment->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    if (!$this->shipment->delete(DolibarrApiAccess::$user)) {
      throw new RestException(500, 'Error when deleting shipment : '.$this->shipment->errorsToString());
    }
 
    return array(
    'success' => array(
      'code' => 200,
      'message' => 'Shipment deleted'
    )
    );
  }
 
  public function validate($id, $notrigger = 0)
  {
    if (!DolibarrApiAccess::$user->hasRight('expedition', 'creer')) {
      throw new RestException(403);
    }
    $result = $this->shipment->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Shipment not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('expedition', $this->shipment->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $result = $this->shipment->valid(DolibarrApiAccess::$user, $notrigger);
    if ($result == 0) {
      throw new RestException(304, 'Error nothing done. May be object is already validated');
    }
    if ($result < 0) {
      throw new RestException(500, 'Error when validating Shipment: '.$this->shipment->errorsToString());
    }
 
    // Reload shipment
    $result = $this->shipment->fetch($id);
 
    $this->shipment->fetchObjectLinked();
    return $this->_cleanObjectDatas($this->shipment);
  }
 
 
  // /**
  //  *  Classify the shipment as invoiced
  //  *
  //  * @param int   $id           Id of the shipment
  //  *
  //  * @url     POST {id}/setinvoiced
  //  *
  //  * @return int
  //  *
  //  * @throws RestException 400
  //  * @throws RestException 401
  //  * @throws RestException 404
  //  * @throws RestException 405
  //  */
  /*
  public function setinvoiced($id)
  {
 
  if(! DolibarrApiAccess::$user->hasRight('expedition', 'creer')) {
      throw new RestException(403);
  }
  if(empty($id)) {
      throw new RestException(400, 'Shipment ID is mandatory');
  }
  $result = $this->shipment->fetch($id);
  if( ! $result ) {
      throw new RestException(404, 'Shipment not found');
  }
 
  $result = $this->shipment->classifyBilled(DolibarrApiAccess::$user);
  if( $result < 0) {
      throw new RestException(400, $this->shipment->errorsToString());
  }
  return $result;
  }
  */
 
 
  //  /**
  //  * Create a shipment using an existing order.
  //  *
  //  * @param int   $orderid    Id of the order
  //  *
  //  * @url     POST /createfromorder/{orderid}
  //  *
  //  * @return int
  //  * @throws RestException 400
  //  * @throws RestException 401
  //  * @throws RestException 404
  //  * @throws RestException 405
  //  */
  /*
  public function createShipmentFromOrder($orderid)
  {
 
  require_once DOL_DOCUMENT_ROOT . '/commande/class/commande.class.php';
 
  if(! DolibarrApiAccess::$user->hasRight('expedition', 'lire')) {
      throw new RestException(403);
  }
  if(! DolibarrApiAccess::$user->hasRight('expedition', 'creer')) {
      throw new RestException(403);
  }
  if(empty($proposalid)) {
      throw new RestException(400, 'Order ID is mandatory');
  }
 
  $order = new Commande($this->db);
  $result = $order->fetch($proposalid);
  if( ! $result ) {
      throw new RestException(404, 'Order not found');
  }
 
  $result = $this->shipment->createFromOrder($order, DolibarrApiAccess::$user);
  if( $result < 0) {
      throw new RestException(405, $this->shipment->errorsToString());
  }
  $this->shipment->fetchObjectLinked();
  return $this->_cleanObjectDatas($this->shipment);
  }
  */
 
  public function close($id, $notrigger = 0)
  {
    if (!DolibarrApiAccess::$user->hasRight('expedition', 'creer')) {
      throw new RestException(403);
    }
 
    $result = $this->shipment->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Shipment not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('expedition', $this->shipment->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $result = $this->shipment->setClosed();
    if ($result == 0) {
      throw new RestException(304, 'Error nothing done. May be object is already closed');
    }
    if ($result < 0) {
      throw new RestException(500, 'Error when closing Order: '.$this->shipment->errorsToString());
    }
 
    // Reload shipment
    $result = $this->shipment->fetch($id);
 
    $this->shipment->fetchObjectLinked();
 
    return $this->_cleanObjectDatas($this->shipment);
  }
 
  public function setToDraft($id)
  {
    if (!DolibarrApiAccess::$user->hasRight('expedition', 'creer')) {
      throw new RestException(403);
    }
 
    $result = $this->shipment->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Shipment not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('expedition', $this->shipment->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $result = $this->shipment->setDraft(DolibarrApiAccess::$user);
    if ($result == 0) {
      throw new RestException(304, 'Error nothing done. May be object is already draft');
    }
    if ($result < 0) {
      throw new RestException(500, 'Error when setting shipment back to draft: '.$this->shipment->errorsToString());
    }
 
    // Reload shipment
    $result = $this->shipment->fetch($id);
 
    $this->shipment->fetchObjectLinked();
 
    return $this->_cleanObjectDatas($this->shipment);
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  protected function _cleanObjectDatas($object)
  {
    // phpcs:enable
    $object = parent::_cleanObjectDatas($object);
 
    unset($object->canvas);
 
    unset($object->thirdparty); // id already returned
 
    unset($object->note);
    unset($object->address);
    unset($object->barcode_type);
    unset($object->barcode_type_code);
    unset($object->barcode_type_label);
    unset($object->barcode_type_coder);
 
    if (!empty($object->lines) && is_array($object->lines)) {
      foreach ($object->lines as $line) {
        if (is_array($line->detail_batch)) {
          foreach ($line->detail_batch as $keytmp2 => $valtmp2) {
            unset($line->detail_batch[$keytmp2]->db);
          }
        }
        unset($line->canvas);
 
        unset($line->tva_tx);
        unset($line->vat_src_code);
        unset($line->total_ht);
        unset($line->total_ttc);
        unset($line->total_tva);
        unset($line->total_localtax1);
        unset($line->total_localtax2);
        unset($line->remise_percent);
      }
    }
 
    return $object;
  }
 
  private function _validate($data)
  {
    if ($data === null) {
      $data = array();
    }
    $shipment = array();
    // A standalone shipment carries no source document, exactly as the card
    // allows when SHIPMENT_STANDALONE is enabled: do not demand an origin the
    // user is entitled to omit.
    $mandatory = Shipments::$FIELDS;
    if (getDolGlobalString('SHIPMENT_STANDALONE') && !isset($data['origin_id']) && !isset($data['origin_type'])) {
      $mandatory = array_values(array_diff($mandatory, array('origin_id', 'origin_type')));
    }
    foreach ($mandatory as $field) {
      if (!isset($data[$field])) {
        throw new RestException(400, "$field field missing");
      }
      $shipment[$field] = $data[$field];
    }
    return $shipment;
  }
}