api_expensereports.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-2024  Frédéric France   <frederic.france@free.fr>
 * Copyright (C) 2025   MDW         <mdeweerd@users.noreply.github.com>
 * Copyright (C) 2025 William Mead      <william@m34d.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */
 
use Luracast\Restler\RestException;
 
require_once DOL_DOCUMENT_ROOT.'/expensereport/class/expensereport.class.php';
require_once DOL_DOCUMENT_ROOT.'/expensereport/class/paymentexpensereport.class.php';
 
 
class ExpenseReports extends DolibarrApi
{
  public static $FIELDS = array(
    'fk_user_author',
    'date_debut',
    'date_fin',
  );
 
  public static $FIELDSPAYMENT = array(
    "fk_typepayment",
    'datep',
    'amounts',
  );
 
  public $expensereport;
 
 
  public function __construct()
  {
    global $db;
 
    $this->db = $db;
    $this->expensereport = new ExpenseReport($this->db);
  }
 
  public function get($id)
  {
    if (!DolibarrApiAccess::$user->hasRight('expensereport', 'lire')) {
      throw new RestException(403);
    }
 
    $result = $this->expensereport->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Expense report not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('expensereport', $this->expensereport->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $this->expensereport->fetchObjectLinked();
    return $this->_cleanObjectDatas($this->expensereport);
  }
 
  public function index($sortfield = "t.rowid", $sortorder = 'ASC', $limit = 100, $page = 0, $user_ids = '', $sqlfilters = '', $properties = '', $pagination_data = false)
  {
    if (!DolibarrApiAccess::$user->hasRight('expensereport', 'lire')) {
      throw new RestException(403);
    }
 
    $obj_ret = array();
 
    // case of external user, $societe param is ignored and replaced by user's socid
    //$socid = DolibarrApiAccess::$user->socid ?: $societe;
 
    $sql = "SELECT t.rowid";
    $sql .= " FROM ".MAIN_DB_PREFIX."expensereport AS t LEFT JOIN ".MAIN_DB_PREFIX."expensereport_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('expensereport').')';
    if ($user_ids) {
      $sql .= " AND t.fk_user_author IN (".$this->db->sanitize($user_ids).")";
    }
 
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
    //this query will return total orders 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);
    }
 
    $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);
        $expensereport_static = new ExpenseReport($this->db);
        if ($expensereport_static->fetch($obj->rowid)) {
          $obj_ret[] = $this->_filterObjectProperties($this->_cleanObjectDatas($expensereport_static), $properties);
        }
        $i++;
      }
    } else {
      throw new RestException(503, 'Error when retrieve Expense Report 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('expensereport', 'creer')) {
      throw new RestException(403, "Insuffisant 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->expensereport->context['caller'] = sanitizeVal($request_data['caller'], 'aZ09');
        continue;
      }
 
      $this->expensereport->$field = $this->_checkValForAPI($field, $value, $this->expensereport);
    }
    /*if (isset($request_data["lines"])) {
      $lines = array();
      foreach ($request_data["lines"] as $line) {
      array_push($lines, (object) $line);
      }
      $this->expensereport->lines = $lines;
    }*/
    if ($this->expensereport->create(DolibarrApiAccess::$user) < 0) {
      throw new RestException(500, "Error creating expensereport", array_merge(array($this->expensereport->error), $this->expensereport->errors));
    }
 
    return $this->expensereport->id;
  }
 
  /*
  public function getLines($id)
  {
    if(! DolibarrApiAccess::$user->hasRight('expensereport', 'lire')) {
      throw new RestException(403);
    }
 
    $result = $this->expensereport->fetch($id);
    if( ! $result ) {
      throw new RestException(404, 'expensereport not found');
    }
 
    if( ! DolibarrApi::_checkAccessToResource('expensereport',$this->expensereport->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
    $this->expensereport->getLinesArray();
    $result = array();
    foreach ($this->expensereport->lines as $line) {
      array_push($result,$this->_cleanObjectDatas($line));
    }
    return $result;
  }
  */
 
  /*
  public function postLine($id, $request_data = null)
  {
    if(! DolibarrApiAccess::$user->hasRight('expensereport', 'creer')) {
        throw new RestException(403);
      }
 
    $result = $this->expensereport->fetch($id);
    if( ! $result ) {
     throw new RestException(404, 'expensereport not found');
    }
 
      if( ! DolibarrApi::_checkAccessToResource('expensereport',$this->expensereport->id)) {
        throw new RestException(403, '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->expensereport->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,
            $fk_parent_line,
            $request_data->fk_fournprice,
            $request_data->pa_ht,
            $request_data->label,
            $request_data->array_options,
            $request_data->fk_unit,
            $this->element,
            $request_data->id
    );
 
    if ($updateRes > 0) {
    return $updateRes;
 
    }
    return false;
  }
  */
 
  /*
  public function putLine($id, $lineid, $request_data = null)
  {
    if(! DolibarrApiAccess::$user->hasRight('expensereport', 'creer')) {
        throw new RestException(403);
    }
 
    $result = $this->expensereport->fetch($id);
    if( ! $result ) {
      throw new RestException(404, 'expensereport not found');
    }
 
    if( ! DolibarrApi::_checkAccessToResource('expensereport',$this->expensereport->id)) {
      throw new RestException(403, '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->expensereport->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
    );
 
    if ($updateRes > 0) {
      $result = $this->get($id);
      unset($result->line);
      return $this->_cleanObjectDatas($result);
    }
    return false;
  }
  */
 
  /*
  public function deleteLine($id, $lineid)
  {
    if(! DolibarrApiAccess::$user->hasRight('expensereport', 'creer')) {
        throw new RestException(403);
      }
 
    $result = $this->expensereport->fetch($id);
    if( ! $result ) {
     throw new RestException(404, 'expensereport not found');
    }
 
      if( ! DolibarrApi::_checkAccessToResource('expensereport',$this->expensereport->id)) {
        throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    // TODO Check the lineid $lineid is a line of object
 
    $updateRes = $this->expensereport->deleteLine($lineid);
    if ($updateRes == 1) {
    return $this->get($id);
    }
    return false;
  }
  */
 
  public function put($id, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->hasRight('expensereport', 'creer')) {
      throw new RestException(403);
    }
 
    $result = $this->expensereport->fetch($id);
    if (!$result) {
      throw new RestException(404, 'expensereport not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('expensereport', $this->expensereport->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->expensereport->context['caller'] = sanitizeVal($request_data['caller'], 'aZ09');
        continue;
      }
 
      if ($field == 'array_options' && is_array($value)) {
        foreach ($value as $index => $val) {
          $this->expensereport->array_options[$index] = $this->_checkValForAPI($field, $val, $this->expensereport);
        }
        continue;
      }
 
      $this->expensereport->$field = $this->_checkValForAPI($field, $value, $this->expensereport);
    }
 
    if ($this->expensereport->update(DolibarrApiAccess::$user) > 0) {
      return $this->get($id);
    } else {
      throw new RestException(500, $this->expensereport->error);
    }
  }
 
  public function delete($id)
  {
    if (!DolibarrApiAccess::$user->hasRight('expensereport', 'supprimer')) {
      throw new RestException(403);
    }
 
    $result = $this->expensereport->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Expense Report not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('expensereport', $this->expensereport->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    if (!$this->expensereport->delete(DolibarrApiAccess::$user)) {
      throw new RestException(500, 'Error when delete Expense Report : '.$this->expensereport->error);
    }
 
    return array(
      'success' => array(
        'code' => 200,
        'message' => 'Expense Report deleted'
      )
    );
  }
 
  public function validate($id, $notrigger = 0)
  {
    if (!DolibarrApiAccess::$user->hasRight('expensereport', 'creer')) {
      throw new RestException(403, "Insuffisant rights");
    }
    $result = $this->expensereport->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Expense report not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('expensereport', $this->expensereport->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $result = $this->expensereport->setValidate(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 expense report: '.$this->expensereport->error);
    }
 
    $this->expensereport->fetchObjectLinked();
 
    return $this->_cleanObjectDatas($this->expensereport);
  }
 
 
  public function approve($id, $notrigger = 0)
  {
    if (!DolibarrApiAccess::$user->hasRight('expensereport', 'approve')) {
      throw new RestException(403, "Insuffisant rights");
    }
    $result = $this->expensereport->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Expense report not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('expensereport', $this->expensereport->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $result = $this->expensereport->setApproved(DolibarrApiAccess::$user, $notrigger);
    if ($result == 0) {
      throw new RestException(304, 'Error nothing done. May be object is already approved');
    }
    if ($result < 0) {
      throw new RestException(500, 'Error when approving expense report: '.$this->expensereport->error);
    }
 
    $this->expensereport->fetchObjectLinked();
 
    return $this->_cleanObjectDatas($this->expensereport);
  }
 
 
  public function deny($id, $details, $notrigger = 0)
  {
    if (!DolibarrApiAccess::$user->hasRight('expensereport', 'approve')) {
      throw new RestException(403, "Insuffisant rights");
    }
    $result = $this->expensereport->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Expense report not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('expensereport', $this->expensereport->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $result = $this->expensereport->setDeny(DolibarrApiAccess::$user, $details, $notrigger);
    if ($result == 0) {
      throw new RestException(304, 'Error nothing done. May be object is already denied');
    }
    if ($result < 0) {
      throw new RestException(500, 'Error when denying expense report: '.$this->expensereport->error);
    }
 
    $this->expensereport->fetchObjectLinked();
 
    return $this->_cleanObjectDatas($this->expensereport);
  }
 
 
  public function getAllPayments($sortfield = "t.rowid", $sortorder = 'ASC', $limit = 100, $page = 0)
  {
    $list = array();
 
    if (!DolibarrApiAccess::$user->hasRight('expensereport', 'lire')) {
      throw new RestException(403);
    }
 
    $sql = "SELECT t.rowid FROM " . MAIN_DB_PREFIX . "payment_expensereport as t, ".MAIN_DB_PREFIX."expensereport as e";
    $sql .= " WHERE e.rowid = t.fk_expensereport";
    $sql .= ' AND e.entity IN ('.getEntity('expensereport').')';
 
    $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));
      for ($i = 0; $i < $min; $i++) {
        $obj = $this->db->fetch_object($result);
        $paymentExpenseReport = new PaymentExpenseReport($this->db);
        if ($paymentExpenseReport->fetch($obj->rowid) > 0) {
          $list[] = $this->_cleanObjectDatas($paymentExpenseReport);
        }
      }
    } else {
      throw new RestException(503, 'Error when retrieving list of paymentexpensereport: ' . $this->db->lasterror());
    }
 
    return $list;
  }
 
  public function getPayments($pid)
  {
    if (!DolibarrApiAccess::$user->hasRight('expensereport', 'lire')) {
      throw new RestException(403);
    }
 
    $paymentExpenseReport = new PaymentExpenseReport($this->db);
    $result = $paymentExpenseReport->fetch($pid);
    if (!$result) {
      throw new RestException(404, 'paymentExpenseReport not found');
    }
 
    return $this->_cleanObjectDatas($paymentExpenseReport);
  }
 
  public function addPayment($id, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->hasRight('expensereport', 'creer')) {
      throw new RestException(403);
    }
    // Check mandatory fields
    $result = $this->_validatepayment($request_data);
 
    if ($this->expensereport->fetch($id) <= 0) {
      throw new RestException(404, 'Expense report not found');
    }
    if (isModEnabled("bank") && !((int) ($request_data['accountid'] ?? 0) > 0)) {
      throw new RestException(400, "accountid field missing");
    }
 
    $paymentExpenseReport = new PaymentExpenseReport($this->db);
    $paymentExpenseReport->fk_expensereport = $id;
    foreach ($request_data as $field => $value) {
      $paymentExpenseReport->$field = $this->_checkValForAPI($field, $value, $paymentExpenseReport);
    }
 
    // Same sequence as expensereport/payment/payment.php: all or nothing
    $this->db->begin();
 
    if ($paymentExpenseReport->create(DolibarrApiAccess::$user) < 0) {
      $this->db->rollback();
      throw new RestException(400, 'Payment error : '.$paymentExpenseReport->errorsToString());
    }
    if (isModEnabled("bank")) {
      $result = $paymentExpenseReport->addPaymentToBank(
        DolibarrApiAccess::$user,
        'payment_expensereport',
        '(ExpenseReportPayment)',
        (int) $request_data['accountid'],
        '',
        ''
      );
      if ($result <= 0) {
        $this->db->rollback();
        throw new RestException(400, 'Add payment to bank error : '.$paymentExpenseReport->errorsToString());
      }
    }
 
    $remaintopay = price2num($this->expensereport->total_ttc - $this->expensereport->getSumPayments(), 'MT');
    if ($remaintopay == 0 && $this->expensereport->setPaid($this->expensereport->id, DolibarrApiAccess::$user) < 0) {
      $this->db->rollback();
      throw new RestException(400, 'Set paid error : '.$this->expensereport->errorsToString());
    }
 
    $this->db->commit();
 
    return $paymentExpenseReport->id;
  }
 
  public function updatePayment($id, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->hasRight('expensereport', 'creer')) {
      throw new RestException(403);
    }
 
    $paymentExpenseReport = new PaymentExpenseReport($this->db);
    $result = $paymentExpenseReport->fetch($id);
    if (!$result) {
      throw new RestException(404, 'payment of expense report not found');
    }
 
    foreach ($request_data as $field => $value) {
      if ($field == 'id') {
        continue;
      }
      $paymentExpenseReport->$field = $this->_checkValForAPI($field, $value, $paymentExpenseReport);
    }
 
    if ($paymentExpenseReport->update(DolibarrApiAccess::$user) > 0) {
      return $this->get($id);
    } else {
      throw new RestException(500, $paymentExpenseReport->error);
    }
  }
 
  /*public function delete($id)
   {
   if (!DolibarrApiAccess::$user->hasRight('expensereport', 'creer') {
   throw new RestException(403);
   }
   $paymentExpenseReport = new PaymentExpenseReport($this->db);
   $result = $paymentExpenseReport->fetch($id);
   if (!$result) {
   throw new RestException(404, 'paymentExpenseReport not found');
   }
 
   if ($paymentExpenseReport->delete(DolibarrApiAccess::$user) < 0) {
   throw new RestException(403, 'error when deleting paymentExpenseReport');
   }
 
   return array(
   'success' => array(
   'code' => 200,
   'message' => 'paymentExpenseReport deleted'
   )
   );
   }*/
 
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  protected function _cleanObjectDatas($object)
  {
    // phpcs:enable
    $object = parent::_cleanObjectDatas($object);
 
    unset($object->fk_statut);
    unset($object->statut);
    unset($object->user);
    unset($object->thirdparty);
 
    unset($object->cond_reglement);
    unset($object->shipping_method_id);
 
    unset($object->barcode_type);
    unset($object->barcode_type_code);
    unset($object->barcode_type_label);
    unset($object->barcode_type_coder);
 
    unset($object->code_paiement);
    unset($object->code_statut);
    unset($object->fk_c_paiement);
    unset($object->fk_incoterms);
    unset($object->label_incoterms);
    unset($object->location_incoterms);
    unset($object->mode_reglement_id);
    unset($object->cond_reglement_id);
 
    unset($object->name);
    unset($object->lastname);
    unset($object->firstname);
    unset($object->civility_id);
    unset($object->cond_reglement_id);
    unset($object->contact);
    unset($object->contact_id);
 
    unset($object->state);
    unset($object->state_id);
    unset($object->state_code);
    unset($object->country);
    unset($object->country_id);
    unset($object->country_code);
 
    unset($object->note); // We already use note_public and note_pricate
 
    return $object;
  }
 
  private function _validate($data)
  {
    if ($data === null) {
      $data = array();
    }
    $expensereport = array();
    foreach (ExpenseReports::$FIELDS as $field) {
      if (!isset($data[$field])) {
        throw new RestException(400, "$field field missing");
      }
      $expensereport[$field] = $data[$field];
    }
    return $expensereport;
  }
 
  private function _validatepayment($data)
  {
    if ($data === null) {
      $data = array();
    }
    $expensereport = array();
    foreach (ExpenseReports::$FIELDSPAYMENT as $field) {
      if (!isset($data[$field])) {
        throw new RestException(400, "$field field missing");
      }
      $expensereport[$field] = $data[$field];
    }
    return $expensereport;
  }
}