api_orders.class.php

<?php
/* Copyright (C) 2015   Jean-François Ferry     <jfefe@aternatik.fr>
 * Copyright (C) 2016 Laurent Destailleur   <eldy@users.sourceforge.net>
 *
 * 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.'/commande/class/commande.class.php';

class Orders extends DolibarrApi
{

  static $FIELDS = array(
    'socid',
    'date'
  );

  public $commande;

  public function __construct()
  {
    global $db, $conf;
    $this->db = $db;
    $this->commande = new Commande($this->db);
  }

  public function get($id, $contact_list = 1)
  {
    return $this->_fetch($id, '', '', $contact_list);
  }

  public function getByRef($ref, $contact_list = 1)
  {
    return $this->_fetch('', $ref, '', $contact_list);
  }

  public function getByRefExt($ref_ext, $contact_list = 1)
  {
    return $this->_fetch('', '', $ref_ext, $contact_list);
  }

  private function _fetch($id, $ref = '', $ref_ext = '', $contact_list = 1)
  {
    if (!DolibarrApiAccess::$user->rights->commande->lire) {
      throw new RestException(401);
    }

    $result = $this->commande->fetch($id, $ref, $ref_ext);
    if (!$result) {
      throw new RestException(404, 'Order not found');
    }

    if (!DolibarrApi::_checkAccessToResource('commande', $this->commande->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }

    // Add external contacts ids
    $this->commande->contacts_ids = $this->commande->liste_contact(-1, 'external', $contact_list);
    $this->commande->fetchObjectLinked();
    return $this->_cleanObjectDatas($this->commande);
  }

  public function index($sortfield = "t.rowid", $sortorder = 'ASC', $limit = 100, $page = 0, $thirdparty_ids = '', $sqlfilters = '')
  {
    global $db, $conf;

    $obj_ret = array();

    // case of external user, $thirdparty_ids param is ignored and replaced by user's socid
    $socids = DolibarrApiAccess::$user->socid ? DolibarrApiAccess::$user->socid : $thirdparty_ids;

    // If the internal user must only see his customers, force searching by him
    $search_sale = 0;
    if (!DolibarrApiAccess::$user->rights->societe->client->voir && !$socids) $search_sale = DolibarrApiAccess::$user->id;

    $sql = "SELECT t.rowid";
    if ((!DolibarrApiAccess::$user->rights->societe->client->voir && !$socids) || $search_sale > 0) $sql .= ", sc.fk_soc, sc.fk_user"; // We need these fields in order to filter by sale (including the case where the user can only see his prospects)
    $sql .= " FROM ".MAIN_DB_PREFIX."commande as t";

    if ((!DolibarrApiAccess::$user->rights->societe->client->voir && !$socids) || $search_sale > 0) $sql .= ", ".MAIN_DB_PREFIX."societe_commerciaux as sc"; // We need this table joined to the select in order to filter by sale

    $sql .= ' WHERE t.entity IN ('.getEntity('commande').')';
    if ((!DolibarrApiAccess::$user->rights->societe->client->voir && !$socids) || $search_sale > 0) $sql .= " AND t.fk_soc = sc.fk_soc";
    if ($socids) $sql .= " AND t.fk_soc IN (".$socids.")";
    if ($search_sale > 0) $sql .= " AND t.rowid = sc.fk_soc"; // Join for the needed table to filter by sale
    // Insert sale filter
    if ($search_sale > 0)
    {
      $sql .= " AND sc.fk_user = ".$search_sale;
    }
    // Add sql filters
    if ($sqlfilters)
    {
      if (!DolibarrApi::_checkFilters($sqlfilters))
      {
        throw new RestException(503, 'Error when validating parameter sqlfilters '.$sqlfilters);
      }
      $regexstring = '\(([^:\'\(\)]+:[^:\'\(\)]+:[^:\(\)]+)\)';
      $sql .= " AND (".preg_replace_callback('/'.$regexstring.'/', 'DolibarrApi::_forge_criteria_callback', $sqlfilters).")";
    }

    $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);
        $commande_static = new Commande($this->db);
        if ($commande_static->fetch($obj->rowid)) {
          // Add external contacts ids
          $commande_static->contacts_ids = $commande_static->liste_contact(-1, 'external', 1);
          $obj_ret[] = $this->_cleanObjectDatas($commande_static);
        }
        $i++;
      }
    } else {
      throw new RestException(503, 'Error when retrieve commande list : '.$this->db->lasterror());
    }
    if (!count($obj_ret)) {
      throw new RestException(404, 'No order found');
    }
    return $obj_ret;
  }

  public function post($request_data = null)
  {
    if (!DolibarrApiAccess::$user->rights->commande->creer) {
      throw new RestException(401, "Insuffisant rights");
    }
    // Check mandatory fields
    $result = $this->_validate($request_data);

    foreach ($request_data as $field => $value) {
      $this->commande->$field = $value;
    }
    /*if (isset($request_data["lines"])) {
          $lines = array();
          foreach ($request_data["lines"] as $line) {
            array_push($lines, (object) $line);
          }
          $this->commande->lines = $lines;
        }*/

    if ($this->commande->create(DolibarrApiAccess::$user) < 0) {
      throw new RestException(500, "Error creating order", array_merge(array($this->commande->error), $this->commande->errors));
    }

    return $this->commande->id;
  }

  public function getLines($id)
  {
    if (!DolibarrApiAccess::$user->rights->commande->lire) {
      throw new RestException(401);
    }

    $result = $this->commande->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Order not found');
    }

    if (!DolibarrApi::_checkAccessToResource('commande', $this->commande->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
    $this->commande->getLinesArray();
    $result = array();
    foreach ($this->commande->lines as $line) {
      array_push($result, $this->_cleanObjectDatas($line));
    }
    return $result;
  }

  public function postLine($id, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->rights->commande->creer) {
      throw new RestException(401);
    }

    $result = $this->commande->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Order not found');
    }

    if (!DolibarrApi::_checkAccessToResource('commande', $this->commande->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
    $request_data = (object) $request_data;
    $updateRes = $this->commande->addline(
            $request_data->desc,
            $request_data->subprice,
            $request_data->qty,
            $request_data->tva_tx,
            $request_data->localtax1_tx,
            $request_data->localtax2_tx,
            $request_data->fk_product,
            $request_data->remise_percent,
            $request_data->info_bits,
            $request_data->fk_remise_except,
            'HT',
            0,
            $request_data->date_start,
            $request_data->date_end,
            $request_data->product_type,
            $request_data->rang,
            $request_data->special_code,
            $request_data->fk_parent_line,
            $request_data->fk_fournprice,
            $request_data->pa_ht,
            $request_data->label,
            $request_data->array_options,
            $request_data->fk_unit,
            $request_data->origin,
            $request_data->origin_id,
            $request_data->multicurrency_subprice,
            $request_data->ref_ext
    );

    if ($updateRes > 0) {
      return $updateRes;
    } else {
      throw new RestException(400, $this->commande->error);
    }
  }

  public function putLine($id, $lineid, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->rights->commande->creer) {
      throw new RestException(401);
    }

    $result = $this->commande->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Order not found');
    }

    if (!DolibarrApi::_checkAccessToResource('commande', $this->commande->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
    $request_data = (object) $request_data;
    $updateRes = $this->commande->updateline(
      $lineid,
      $request_data->desc,
      $request_data->subprice,
      $request_data->qty,
      $request_data->remise_percent,
      $request_data->tva_tx,
      $request_data->localtax1_tx,
      $request_data->localtax2_tx,
      'HT',
      $request_data->info_bits,
      $request_data->date_start,
      $request_data->date_end,
      $request_data->product_type,
      $request_data->fk_parent_line,
      0,
      $request_data->fk_fournprice,
      $request_data->pa_ht,
      $request_data->label,
      $request_data->special_code,
      $request_data->array_options,
      $request_data->fk_unit,
        $request_data->multicurrency_subprice,
      0,
        $request_data->ref_ext
    );

    if ($updateRes > 0) {
      $result = $this->get($id);
      unset($result->line);
      return $this->_cleanObjectDatas($result);
    }
    return false;
  }

  public function deleteLine($id, $lineid)
  {
    if (!DolibarrApiAccess::$user->rights->commande->creer) {
      throw new RestException(401);
    }

    $result = $this->commande->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Order not found');
    }

    if (!DolibarrApi::_checkAccessToResource('commande', $this->commande->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }

    // TODO Check the lineid $lineid is a line of ojbect

    $updateRes = $this->commande->deleteline(DolibarrApiAccess::$user, $lineid);
    if ($updateRes > 0) {
      return $this->get($id);
    } else {
      throw new RestException(405, $this->commande->error);
    }
  }

  public function getContacts($id, $type = '')
  {
    if (!DolibarrApiAccess::$user->rights->commande->lire) {
      throw new RestException(401);
    }

    $result = $this->commande->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Order not found');
    }

    if (!DolibarrApi::_checkAccessToResource('commande', $this->commande->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }

    $contacts = $this->commande->liste_contact(-1, 'external', 0, $type);

    return $this->_cleanObjectDatas($contacts);
  }

  public function postContact($id, $contactid, $type)
  {
    if (!DolibarrApiAccess::$user->rights->commande->creer) {
      throw new RestException(401);
    }

    $result = $this->commande->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Order not found');
    }

    if (!DolibarrApi::_checkAccessToResource('commande', $this->commande->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }

    $result = $this->commande->add_contact($contactid, $type, 'external');

    if ($result < 0) {
      throw new RestException(500, 'Error when added the contact');
    }

    if ($result == 0) {
      throw new RestException(304, 'contact already added');
    }

    return array(
      'success' => array(
        'code' => 200,
        'message' => 'Contact linked to the order'
      )
    );
  }

  public function deleteContact($id, $contactid, $type)
  {
    if (!DolibarrApiAccess::$user->rights->commande->creer) {
      throw new RestException(401);
    }

    $result = $this->commande->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Order not found');
    }

    if (!DolibarrApi::_checkAccessToResource('commande', $this->commande->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }

     $contacts = $this->commande->liste_contact();

    foreach ($contacts as $contact) {
      if ($contact['id'] == $contactid && $contact['code'] == $type) {
        $result = $this->commande->delete_contact($contact['rowid']);

        if (!$result) {
          throw new RestException(500, 'Error when deleted the contact');
        }
      }
    }

    return array(
      'success' => array(
        'code' => 200,
        'message' => 'Contact unlinked from order'
      )
    );
  }

  public function put($id, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->rights->commande->creer) {
      throw new RestException(401);
    }

    $result = $this->commande->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Order not found');
    }

    if (!DolibarrApi::_checkAccessToResource('commande', $this->commande->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
    foreach ($request_data as $field => $value) {
      if ($field == 'id') continue;
      $this->commande->$field = $value;
    }

    // Update availability
    if (!empty($this->commande->availability_id)) {
      if ($this->commande->availability($this->commande->availability_id) < 0)
      throw new RestException(400, 'Error while updating availability');
    }

    if ($this->commande->update(DolibarrApiAccess::$user) > 0)
    {
      return $this->get($id);
    } else {
      throw new RestException(500, $this->commande->error);
    }
  }

  public function delete($id)
  {
    if (!DolibarrApiAccess::$user->rights->commande->supprimer) {
      throw new RestException(401);
    }
    $result = $this->commande->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Order not found');
    }

    if (!DolibarrApi::_checkAccessToResource('commande', $this->commande->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }

    if (!$this->commande->delete(DolibarrApiAccess::$user)) {
      throw new RestException(500, 'Error when deleting order : '.$this->commande->error);
    }

    return array(
      'success' => array(
        'code' => 200,
        'message' => 'Order deleted'
      )
    );
  }

  public function validate($id, $idwarehouse = 0, $notrigger = 0)
  {
    if (!DolibarrApiAccess::$user->rights->commande->creer) {
      throw new RestException(401);
    }
    $result = $this->commande->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Order not found');
    }

    if (!DolibarrApi::_checkAccessToResource('commande', $this->commande->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }

    $result = $this->commande->valid(DolibarrApiAccess::$user, $idwarehouse, $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 Order: '.$this->commande->error);
    }
    $result = $this->commande->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Order not found');
    }

    if (!DolibarrApi::_checkAccessToResource('commande', $this->commande->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }

    $this->commande->fetchObjectLinked();

    return $this->_cleanObjectDatas($this->commande);
  }

  public function reopen($id)
  {

    if (!DolibarrApiAccess::$user->rights->commande->creer) {
      throw new RestException(401);
    }
    if (empty($id)) {
      throw new RestException(400, 'Order ID is mandatory');
    }
    $result = $this->commande->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Order not found');
    }

    $result = $this->commande->set_reopen(DolibarrApiAccess::$user);
    if ($result < 0) {
      throw new RestException(405, $this->commande->error);
    } elseif ($result == 0) {
      throw new RestException(304);
    }

    return $result;
  }

  public function setinvoiced($id)
  {

    if (!DolibarrApiAccess::$user->rights->commande->creer) {
      throw new RestException(401);
    }
    if (empty($id)) {
      throw new RestException(400, 'Order ID is mandatory');
    }
    $result = $this->commande->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Order not found');
    }

    $result = $this->commande->classifyBilled(DolibarrApiAccess::$user);
    if ($result < 0) {
      throw new RestException(400, $this->commande->error);
    }

    $result = $this->commande->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Order not found');
    }

    if (!DolibarrApi::_checkAccessToResource('commande', $this->commande->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }

    $this->commande->fetchObjectLinked();

    return $this->_cleanObjectDatas($this->commande);
  }

  public function close($id, $notrigger = 0)
  {
    if (!DolibarrApiAccess::$user->rights->commande->creer) {
      throw new RestException(401);
    }
    $result = $this->commande->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Order not found');
    }

    if (!DolibarrApi::_checkAccessToResource('commande', $this->commande->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }

    $result = $this->commande->cloture(DolibarrApiAccess::$user, $notrigger);
    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->commande->error);
    }

    $result = $this->commande->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Order not found');
    }

    if (!DolibarrApi::_checkAccessToResource('commande', $this->commande->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }

    $this->commande->fetchObjectLinked();

    return $this->_cleanObjectDatas($this->commande);
  }

  public function settodraft($id, $idwarehouse = -1)
  {
    if (!DolibarrApiAccess::$user->rights->commande->creer) {
      throw new RestException(401);
    }
    $result = $this->commande->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Order not found');
    }

    if (!DolibarrApi::_checkAccessToResource('commande', $this->commande->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }

    $result = $this->commande->setDraft(DolibarrApiAccess::$user, $idwarehouse);
    if ($result == 0) {
      throw new RestException(304, 'Nothing done. May be object is already closed');
    }
    if ($result < 0) {
      throw new RestException(500, 'Error when closing Order: '.$this->commande->error);
    }

    $result = $this->commande->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Order not found');
    }

    if (!DolibarrApi::_checkAccessToResource('commande', $this->commande->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }

    $this->commande->fetchObjectLinked();

    return $this->_cleanObjectDatas($this->commande);
  }


  public function createOrderFromProposal($proposalid)
  {

    require_once DOL_DOCUMENT_ROOT.'/comm/propal/class/propal.class.php';

    if (!DolibarrApiAccess::$user->rights->propal->lire) {
      throw new RestException(401);
    }
    if (!DolibarrApiAccess::$user->rights->commande->creer) {
      throw new RestException(401);
    }
    if (empty($proposalid)) {
      throw new RestException(400, 'Proposal ID is mandatory');
    }

    $propal = new Propal($this->db);
    $result = $propal->fetch($proposalid);
    if (!$result) {
      throw new RestException(404, 'Proposal not found');
    }

    $result = $this->commande->createFromProposal($propal, DolibarrApiAccess::$user);
    if ($result < 0) {
      throw new RestException(405, $this->commande->error);
    }
    $this->commande->fetchObjectLinked();

    return $this->_cleanObjectDatas($this->commande);
  }


  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  protected function _cleanObjectDatas($object)
  {
    // phpcs:enable
    $object = parent::_cleanObjectDatas($object);

    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);

    return $object;
  }

  private function _validate($data)
  {
    $commande = array();
    foreach (Orders::$FIELDS as $field) {
      if (!isset($data[$field]))
        throw new RestException(400, $field." field missing");
      $commande[$field] = $data[$field];
    }
    return $commande;
  }
}