api_proposals.class.php

<?php
/* Copyright (C) 2015       Jean-François Ferry     <jfefe@aternatik.fr>
 * Copyright (C) 2016       Laurent Destailleur     <eldy@users.sourceforge.net>
 * Copyright (C) 2020       Thibault FOUCART        <support@ptibogxiv.net>
 * Copyright (C) 2022       ATM Consulting          <contact@atm-consulting.fr>
 * Copyright (C) 2022       OpenDSI                 <support@open-dsi.fr>
 *
 * 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.'/comm/propal/class/propal.class.php';
 
 
class Proposals extends DolibarrApi
{
  static $FIELDS = array(
    'socid'
  );
 
  public $propal;
 
  public function __construct()
  {
    global $db;
    $this->db = $db;
    $this->propal = new Propal($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->hasRight('propal', 'lire')) {
      throw new RestException(401);
    }
 
    $result = $this->propal->fetch($id, $ref, $ref_ext);
    if (!$result) {
      throw new RestException(404, 'Commercial Proposal not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('propal', $this->propal->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    // Add external contacts ids.
    $tmparray = $this->propal->liste_contact(-1, 'external', $contact_list);
    if (is_array($tmparray)) {
      $this->propal->contacts_ids = $tmparray;
    }
 
    $this->propal->fetchObjectLinked();
 
    return $this->_cleanObjectDatas($this->propal);
  }
 
  public function index($sortfield = "t.rowid", $sortorder = 'ASC', $limit = 100, $page = 0, $thirdparty_ids = '', $sqlfilters = '')
  {
    global $db, $conf;
 
    if (!DolibarrApiAccess::$user->hasRight('propal', 'lire')) {
      throw new RestException(401);
    }
 
    $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."propal AS t LEFT JOIN ".MAIN_DB_PREFIX."propal_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
 
 
    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('propal').')';
    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 (".$this->db->sanitize($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 = ".((int) $search_sale);
    }
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
    $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);
        $proposal_static = new Propal($this->db);
        if ($proposal_static->fetch($obj->rowid)) {
          // Add external contacts ids
          $tmparray = $proposal_static->liste_contact(-1, 'external', 1);
          if (is_array($tmparray)) {
            $proposal_static->contacts_ids = $tmparray;
          }
          $obj_ret[] = $this->_cleanObjectDatas($proposal_static);
        }
        $i++;
      }
    } else {
      throw new RestException(503, 'Error when retrieve propal list : '.$this->db->lasterror());
    }
    if (!count($obj_ret)) {
      throw new RestException(404, 'No proposal found');
    }
    return $obj_ret;
  }
 
  public function post($request_data = null)
  {
    if (!DolibarrApiAccess::$user->rights->propal->creer) {
      throw new RestException(401, "Insuffisant rights");
    }
    // Check mandatory fields
    $result = $this->_validate($request_data);
 
    foreach ($request_data as $field => $value) {
      $this->propal->$field = $value;
    }
    /*if (isset($request_data["lines"])) {
      $lines = array();
      foreach ($request_data["lines"] as $line) {
      array_push($lines, (object) $line);
      }
      $this->propal->lines = $lines;
    }*/
    if ($this->propal->create(DolibarrApiAccess::$user) < 0) {
      throw new RestException(500, "Error creating order", array_merge(array($this->propal->error), $this->propal->errors));
    }
 
    return ((int) $this->propal->id);
  }
 
  public function getLines($id, $sqlfilters = '')
  {
    if (!DolibarrApiAccess::$user->hasRight('propal', 'lire')) {
      throw new RestException(401);
    }
 
    $result = $this->propal->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Commercial Proposal not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('propal', $this->propal->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $sql = '';
    if (!empty($sqlfilters)) {
      $errormessage = '';
      $sql = forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
    $this->propal->getLinesArray($sql);
    $result = array();
    foreach ($this->propal->lines as $line) {
      array_push($result, $this->_cleanObjectDatas($line));
    }
    return $result;
  }
 
  public function postLine($id, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->rights->propal->creer) {
      throw new RestException(401);
    }
 
    $result = $this->propal->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Commercial Proposal not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('propal', $this->propal->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $request_data = (object) $request_data;
 
    $request_data->desc = sanitizeVal($request_data->desc, 'restricthtml');
    $request_data->label = sanitizeVal($request_data->label);
 
    $updateRes = $this->propal->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->price_base_type ? $request_data->price_base_type : 'HT',
      $request_data->subprice,
      $request_data->info_bits,
      $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->date_start,
      $request_data->date_end,
      $request_data->array_options,
      $request_data->fk_unit,
      $request_data->origin,
      $request_data->origin_id,
      $request_data->multicurrency_subprice,
      $request_data->fk_remise_except
    );
 
    if ($updateRes > 0) {
      return $updateRes;
    } else {
      throw new RestException(400, $this->propal->error);
    }
  }
 
  public function postLines($id, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->rights->propal->creer) {
      throw new RestException(401);
    }
 
    $result = $this->propal->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Commercial Proposal not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('propal', $this->propal->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $errors = [];
    $this->db->begin();
 
    foreach ($request_data as $TData) {
      if (empty($TData[0])) $TData = array($TData);
 
      foreach ($TData as $lineData) {
        $line = (object) $lineData;
 
        $updateRes = $this->propal->addline(
          $line->desc,
          $line->subprice,
          $line->qty,
          $line->tva_tx,
          $line->localtax1_tx,
          $line->localtax2_tx,
          $line->fk_product,
          $line->remise_percent,
          'HT',
          0,
          $line->info_bits,
          $line->product_type,
          $line->rang,
          $line->special_code,
          $line->fk_parent_line,
          $line->fk_fournprice,
          $line->pa_ht,
          $line->label,
          $line->date_start,
          $line->date_end,
          $line->array_options,
          $line->fk_unit,
          $line->origin,
          $line->origin_id,
          $line->multicurrency_subprice,
          $line->fk_remise_except
        );
 
        if ($updateRes < 0) {
          $errors['lineLabel'] = $line->label;
          $errors['msg'] = $this->propal->errors;
        }
      }
    }
    if (empty($errors)) {
      $this->db->commit();
      return $updateRes;
    } else {
      $this->db->rollback();
      throw new RestException(400, implode(", ", $errors));
    }
  }
 
  public function putLine($id, $lineid, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->rights->propal->creer) {
      throw new RestException(401);
    }
 
    $result = $this->propal->fetch($id);
    if ($result <= 0) {
      throw new RestException(404, 'Proposal not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('propal', $this->propal->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $request_data = (object) $request_data;
 
    if (isset($request_data->desc)) {
      $request_data->desc = sanitizeVal($request_data->desc, 'restricthtml');
    }
    if (isset($request_data->label)) {
      $request_data->label = sanitizeVal($request_data->label);
    }
 
    $propalline = new PropaleLigne($this->db);
    $result = $propalline->fetch($lineid);
    if ($result <= 0) {
      throw new RestException(404, 'Proposal line not found');
    }
 
    $updateRes = $this->propal->updateline(
      $lineid,
      isset($request_data->subprice) ? $request_data->subprice : $propalline->subprice,
      isset($request_data->qty) ? $request_data->qty : $propalline->qty,
      isset($request_data->remise_percent) ? $request_data->remise_percent : $propalline->remise_percent,
      isset($request_data->tva_tx) ? $request_data->tva_tx : $propalline->tva_tx,
      isset($request_data->localtax1_tx) ? $request_data->localtax1_tx : $propalline->localtax1_tx,
      isset($request_data->localtax2_tx) ? $request_data->localtax2_tx : $propalline->localtax2_tx,
      isset($request_data->desc) ? $request_data->desc : $propalline->desc,
      isset($request_data->price_base_type) ? $request_data->price_base_type : 'HT',
      isset($request_data->info_bits) ? $request_data->info_bits : $propalline->info_bits,
      isset($request_data->special_code) ? $request_data->special_code : $propalline->special_code,
      isset($request_data->fk_parent_line) ? $request_data->fk_parent_line : $propalline->fk_parent_line,
      0,
      isset($request_data->fk_fournprice) ? $request_data->fk_fournprice : $propalline->fk_fournprice,
      isset($request_data->pa_ht) ? $request_data->pa_ht : $propalline->pa_ht,
      isset($request_data->label) ? $request_data->label : $propalline->label,
      isset($request_data->product_type) ? $request_data->product_type : $propalline->product_type,
      isset($request_data->date_start) ? $request_data->date_start : $propalline->date_start,
      isset($request_data->date_end) ? $request_data->date_end : $propalline->date_end,
      isset($request_data->array_options) ? $request_data->array_options : $propalline->array_options,
      isset($request_data->fk_unit) ? $request_data->fk_unit : $propalline->fk_unit,
      isset($request_data->multicurrency_subprice) ? $request_data->multicurrency_subprice : $propalline->subprice,
      0,
      isset($request_data->rang) ? $request_data->rang : $propalline->rang
    );
 
    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->propal->creer) {
      throw new RestException(401);
    }
 
    $result = $this->propal->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Proposal not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('propal', $this->propal->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $updateRes = $this->propal->deleteline($lineid, $id);
    if ($updateRes > 0) {
      return $this->get($id);
    } else {
      throw new RestException(405, $this->propal->error);
    }
  }
 
  public function postContact($id, $contactid, $type)
  {
    if (!DolibarrApiAccess::$user->rights->propal->creer) {
      throw new RestException(401);
    }
 
    $result = $this->propal->fetch($id);
 
    if (!$result) {
      throw new RestException(404, 'Proposal not found');
    }
 
    if (!in_array($type, array('BILLING', 'SHIPPING', 'CUSTOMER'), true)) {
      throw new RestException(500, 'Availables types: BILLING, SHIPPING OR CUSTOMER');
    }
 
    if (!DolibarrApi::_checkAccessToResource('propal', $this->propal->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $result = $this->propal->add_contact($contactid, $type, 'external');
 
    if (!$result) {
      throw new RestException(500, 'Error when added the contact');
    }
 
    return array(
      'success' => array(
        'code' => 200,
        'message' => 'Contact linked to the proposal'
      )
    );
  }
 
  public function deleteContact($id, $contactid, $type)
  {
    if (!DolibarrApiAccess::$user->rights->propal->creer) {
      throw new RestException(401);
    }
 
    $result = $this->propal->fetch($id);
 
    if (!$result) {
      throw new RestException(404, 'Proposal not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('propal', $this->propal->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $contacts = $this->propal->liste_contact();
 
    foreach ($contacts as $contact) {
      if ($contact['id'] == $contactid && $contact['code'] == $type) {
        $result = $this->propal->delete_contact($contact['rowid']);
 
        if (!$result) {
          throw new RestException(500, 'Error when deleted the contact');
        }
      }
    }
 
    return $this->_cleanObjectDatas($this->propal);
  }
 
  public function put($id, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->rights->propal->creer) {
      throw new RestException(401);
    }
 
    $result = $this->propal->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Proposal not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('propal', $this->propal->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
    foreach ($request_data as $field => $value) {
      if ($field == 'id') {
        continue;
      }
      $this->propal->$field = $value;
    }
 
    // update end of validity date
    if (empty($this->propal->fin_validite) && !empty($this->propal->duree_validite) && !empty($this->propal->date_creation)) {
      $this->propal->fin_validite = $this->propal->date_creation + ($this->propal->duree_validite * 24 * 3600);
    }
    if (!empty($this->propal->fin_validite)) {
      if ($this->propal->set_echeance(DolibarrApiAccess::$user, $this->propal->fin_validite) < 0) {
        throw new RestException(500, $this->propal->error);
      }
    }
 
    if ($this->propal->update(DolibarrApiAccess::$user) > 0) {
      return $this->get($id);
    } else {
      throw new RestException(500, $this->propal->error);
    }
  }
 
  public function delete($id)
  {
    if (!DolibarrApiAccess::$user->rights->propal->supprimer) {
      throw new RestException(401);
    }
    $result = $this->propal->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Commercial Proposal not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('propal', $this->propal->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    if (!$this->propal->delete(DolibarrApiAccess::$user)) {
      throw new RestException(500, 'Error when delete Commercial Proposal : '.$this->propal->error);
    }
 
    return array(
      'success' => array(
        'code' => 200,
        'message' => 'Commercial Proposal deleted'
      )
    );
  }
 
  public function settodraft($id)
  {
    if (!DolibarrApiAccess::$user->rights->propal->creer) {
      throw new RestException(401);
    }
    $result = $this->propal->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Proposal not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('propal', $this->propal->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $result = $this->propal->setDraft(DolibarrApiAccess::$user);
    if ($result == 0) {
      throw new RestException(304, 'Nothing done. May be object is already draft');
    }
    if ($result < 0) {
      throw new RestException(500, 'Error : '.$this->propal->error);
    }
 
    $result = $this->propal->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Proposal not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('propal', $this->propal->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $this->propal->fetchObjectLinked();
 
    return $this->_cleanObjectDatas($this->propal);
  }
 
 
  public function validate($id, $notrigger = 0)
  {
    if (!DolibarrApiAccess::$user->rights->propal->creer) {
      throw new RestException(401);
    }
    $result = $this->propal->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Commercial Proposal not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('propal', $this->propal->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $result = $this->propal->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 Commercial Proposal: '.$this->propal->error);
    }
 
    $result = $this->propal->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Commercial Proposal not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('propal', $this->propal->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $this->propal->fetchObjectLinked();
 
    return $this->_cleanObjectDatas($this->propal);
  }
 
  public function close($id, $status, $note_private = '', $notrigger = 0)
  {
    if (!DolibarrApiAccess::$user->rights->propal->creer) {
      throw new RestException(401);
    }
    $result = $this->propal->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Commercial Proposal not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('propal', $this->propal->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $result = $this->propal->closeProposal(DolibarrApiAccess::$user, $status, $note_private, $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 Commercial Proposal: '.$this->propal->error);
    }
 
    $result = $this->propal->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Proposal not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('propal', $this->propal->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $this->propal->fetchObjectLinked();
 
    return $this->_cleanObjectDatas($this->propal);
  }
 
  public function setinvoiced($id)
  {
    if (!DolibarrApiAccess::$user->rights->propal->creer) {
      throw new RestException(401);
    }
    $result = $this->propal->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Commercial Proposal not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('propal', $this->propal->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $result = $this->propal->classifyBilled(DolibarrApiAccess::$user);
    if ($result < 0) {
      throw new RestException(500, 'Error : '.$this->propal->error);
    }
 
    $result = $this->propal->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Proposal not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('propal', $this->propal->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $this->propal->fetchObjectLinked();
 
    return $this->_cleanObjectDatas($this->propal);
  }
 
 
  private function _validate($data)
  {
    $propal = array();
    foreach (Proposals::$FIELDS as $field) {
      if (!isset($data[$field])) {
        throw new RestException(400, "$field field missing");
      }
      $propal[$field] = $data[$field];
    }
    return $propal;
  }
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  protected function _cleanObjectDatas($object)
  {
    // phpcs:enable
    $object = parent::_cleanObjectDatas($object);
 
    unset($object->note);
    unset($object->name);
    unset($object->lastname);
    unset($object->firstname);
    unset($object->civility_id);
    unset($object->address);
 
    return $object;
  }
}