api_salaries.class.php

<?php
/*
 * Copyright (C) 2023 Marc Chenebaux <marc.chenebaux@maj44.com>
 * Copyright (C) 2025-2026  MDW     <mdeweerd@users.noreply.github.com>
 * Copyright (C) 2025-2026  Frédéric France         <frederic.france@free.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.'/salaries/class/salary.class.php';
require_once DOL_DOCUMENT_ROOT.'/salaries/class/paymentsalary.class.php';
 
 
class Salaries extends DolibarrApi
{
  public static $FIELDS = array(
    'fk_user',
    'label',
    'amount',
  );
 
  public static $FIELDSPAYMENT = array(
    "paiementtype",
    'datepaye',
    'chid',
    'amounts',
  );
 
 
  public function __construct()
  {
    global $db;
    $this->db = $db;
  }
 
  public function index($sortfield = "t.rowid", $sortorder = 'ASC', $limit = 100, $page = 0, $sqlfilters = '')
  {
    $list = array();
 
    if (!DolibarrApiAccess::$user->hasRight('salaries', 'read')
      && !DolibarrApiAccess::$user->hasRight('salaries', 'readchild')
      && !DolibarrApiAccess::$user->hasRight('salaries', 'readall')) {
      throw new RestException(403);
    }
 
    $sql = "SELECT rowid FROM " . MAIN_DB_PREFIX . "salary as t";
    $sql .= ' WHERE t.entity IN ('.getEntity('user').')';
    if (!DolibarrApiAccess::$user->hasRight('salaries', 'readall')) {
      if (!DolibarrApiAccess::$user->hasRight('salaries', 'readchild')) {
        $sql .= ' AND t.fk_user = '.((int) DolibarrApiAccess::$user->id);
      } else {
        $childids = DolibarrApiAccess::$user->getAllChildIds(1);
        $sql .= ' AND t.fk_user IN ('.$this->db->sanitize(implode(',', $childids)).')';
      }
    }
 
    // 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));
      for ($i = 0; $i < $min; $i++) {
        $obj = $this->db->fetch_object($result);
        $salary = new Salary($this->db);
        if ($salary->fetch($obj->rowid) > 0) {
          $list[] = $this->_cleanObjectDatas($salary);
        }
      }
    } else {
      throw new RestException(503, 'Error when retrieving list of salaries: ' . $this->db->lasterror());
    }
 
    return $list;
  }
 
  public function get($id)
  {
    if (!DolibarrApiAccess::$user->hasRight('salaries', 'read')
      && !DolibarrApiAccess::$user->hasRight('salaries', 'readchild')
      && !DolibarrApiAccess::$user->hasRight('salaries', 'readall')) {
      throw new RestException(403);
    }
 
    $salary = new Salary($this->db);
    $result = $salary->fetch($id);
    if (!$result) {
      throw new RestException(404, 'salary not found');
    }
 
    if (!DolibarrApiAccess::$user->hasRight('salaries', 'readall')) {
      if (!DolibarrApiAccess::$user->hasRight('salaries', 'readchild')) {
        if ($salary->fk_user != DolibarrApiAccess::$user->id) {
          throw new RestException(404, 'salary not found');
        }
      } else {
        $childids = DolibarrApiAccess::$user->getAllChildIds(1);
        if (!in_array($salary->fk_user, $childids)) {
          throw new RestException(404, 'salary not found');
        }
      }
    }
 
    return $this->_cleanObjectDatas($salary);
  }
 
  public function post($request_data = null)
  {
    if (!DolibarrApiAccess::$user->hasRight('salaries', 'write')) {
      throw new RestException(403);
    }
    // Check mandatory fields
    $result = $this->_validate($request_data);
 
    $salary = new Salary($this->db);
    foreach ($request_data as $field => $value) {
      $salary->$field = $this->_checkValForAPI($field, $value, $salary);
    }
 
    if ($salary->create(DolibarrApiAccess::$user) < 0) {
      throw new RestException(500, 'Error creating salary', array_merge(array($salary->error), $salary->errors));
    }
    return $salary->id;
  }
 
  public function put($id, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->hasRight('salaries', 'write')) {
      throw new RestException(403);
    }
 
    $salary = new Salary($this->db);
    $result = $salary->fetch($id);
    if (!$result) {
      throw new RestException(404, 'salary not found');
    }
 
    foreach ($request_data as $field => $value) {
      if ($field == 'id') {
        continue;
      }
      $salary->$field = $this->_checkValForAPI($field, $value, $salary);
    }
 
    if ($salary->update(DolibarrApiAccess::$user) > 0) {
      return $this->get($id);
    } else {
      throw new RestException(500, $salary->errorsToString());
    }
  }
 
  /*public function delete($id)
  {
    if (!DolibarrApiAccess::$user->hasRight('salaries', 'delete')) {
      throw new RestException(403);
    }
    $salary = new Salary($this->db);
    $result = $salary->fetch($id);
    if (!$result) {
      throw new RestException(404, 'salary not found');
    }
 
    if ($salary->delete(DolibarrApiAccess::$user) < 0) {
      throw new RestException(500, 'error when deleting salary');
    }
 
    return array(
      'success' => array(
        'code' => 200,
        'message' => 'salary deleted'
      )
    );
  }*/
 
 
  public function getAllPayments($sortfield = "t.rowid", $sortorder = 'ASC', $limit = 100, $page = 0)
  {
    $list = array();
 
    if (!DolibarrApiAccess::$user->hasRight('salaries', 'read')
      && !DolibarrApiAccess::$user->hasRight('salaries', 'readchild')
      && !DolibarrApiAccess::$user->hasRight('salaries', 'readall')) {
      throw new RestException(403);
    }
 
    $sql = "SELECT t.rowid FROM " . MAIN_DB_PREFIX . "payment_salary as t, ".MAIN_DB_PREFIX."salary as s";
    $sql .= ' WHERE s.rowid = t.fk_salary AND t.entity IN ('.getEntity('salary').')';
    if (!DolibarrApiAccess::$user->hasRight('salaries', 'readall')) {
      if (!DolibarrApiAccess::$user->hasRight('salaries', 'readchild')) {
        $sql .= ' AND s.fk_user = '.((int) DolibarrApiAccess::$user->id).')';
      } else {
        $childids = DolibarrApiAccess::$user->getAllChildIds(1);
        $sql .= ' AND s.fk_user IN ('.$this->db->sanitize(implode(',', $childids)).')';
      }
    }
 
    $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);
        $paymentsalary = new PaymentSalary($this->db);
        if ($paymentsalary->fetch($obj->rowid) > 0) {
          $list[] = $this->_cleanObjectDatas($paymentsalary);
        }
      }
    } else {
      throw new RestException(503, 'Error when retrieving list of paymentsalaries: ' . $this->db->lasterror());
    }
 
    return $list;
  }
 
  public function getPayments($pid)
  {
    // A payment of salary can be done on different salaries of different users, so only users with permission
    // to read all area allowed.
    // TODO To support read or readchild case, the get must be done with a SQL that include the paid user with
    // a where on current user and childids of current user.
    if (!DolibarrApiAccess::$user->hasRight('salaries', 'readall')) {
      throw new RestException(403);
    }
 
    $paymentsalary = new PaymentSalary($this->db);
    $result = $paymentsalary->fetch($pid);
    if (!$result) {
      throw new RestException(404, 'paymentsalary not found');
    }
 
    return $this->_cleanObjectDatas($paymentsalary);
  }
 
  public function addPayment($id, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->hasRight('salaries', 'write')) {
      throw new RestException(403);
    }
    // Check mandatory fields
    $result = $this->_validatepayments($request_data);
 
    $salary = new Salary($this->db);
    if ($salary->fetch($id) <= 0 || empty($salary->id)) {
      throw new RestException(404, 'Salary not found');
    }
    // create() pays the salaries that are the keys of amounts, not {id}
    if (!is_array($request_data['amounts']) || array_diff(array_keys($request_data['amounts']), array($salary->id))) {
      throw new RestException(400, 'amounts must be keyed by the salary id '.$salary->id);
    }
 
    $paymentsalary = new PaymentSalary($this->db);
    $paymentsalary->fk_salary = $id;
    foreach ($request_data as $field => $value) {
      $paymentsalary->$field = $this->_checkValForAPI($field, $value, $paymentsalary);
    }
    // create() and addPaymentToBank() read fk_typepayment, the mandatory field is paiementtype
    if (empty($paymentsalary->fk_typepayment)) {
      $paymentsalary->fk_typepayment = (int) $request_data['paiementtype'];
    }
 
    // Payment and bank line are written together, or not at all
    $this->db->begin();
 
    if ($paymentsalary->create(DolibarrApiAccess::$user, 1) < 0) {
      $this->db->rollback();
      throw new RestException(400, 'Payment error : '.$paymentsalary->errorsToString());
    }
    if (isModEnabled("bank")) {
      $result = $paymentsalary->addPaymentToBank(
        DolibarrApiAccess::$user,
        'payment_salary',
        '(SalaryPayment)',
        (int) $request_data['accountid'],
        '',
        ''
      );
      if ($result <= 0) {
        $this->db->rollback();
        throw new RestException(400, 'Add payment to bank error : '.$paymentsalary->errorsToString());
      }
    }
 
    $this->db->commit();
 
    return $paymentsalary->id;
  }
 
  public function updatePayment($id, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->hasRight('salaries', 'write')) {
      throw new RestException(403);
    }
 
    $paymentsalary = new PaymentSalary($this->db);
    $result = $paymentsalary->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Payment salary not found');
    }
 
    foreach ($request_data as $field => $value) {
      if ($field == 'id') {
        continue;
      }
      $paymentsalary->$field = $this->_checkValForAPI($field, $value, $paymentsalary);
    }
 
    if ($paymentsalary->update(DolibarrApiAccess::$user) > 0) {
      return $this->get($id);
    } else {
      throw new RestException(500, $paymentsalary->errorsToString());
    }
  }
 
  /*public function delete($id)
   {
   if (!DolibarrApiAccess::$user->hasRight('salaries', 'delete')) {
   throw new RestException(403);
   }
   $paymentsalary = new PaymentSalary($this->db);
   $result = $paymentsalary->fetch($id);
   if (!$result) {
   throw new RestException(404, 'paymentsalary not found');
   }
 
   if ($paymentsalary->delete(DolibarrApiAccess::$user) < 0) {
   throw new RestException(500, 'error when deleting paymentsalary');
   }
 
   return array(
   'success' => array(
   'code' => 200,
   'message' => 'paymentsalary deleted'
   )
   );
   }*/
 
 
  private function _validate($data)
  {
    if ($data === null) {
      $data = array();
    }
    $salary = array();
    foreach (Salaries::$FIELDS as $field) {
      if (!isset($data[$field])) {
        throw new RestException(400, "$field field missing");
      }
      $salary[$field] = $data[$field];
    }
    return $salary;
  }
 
  private function _validatepayments($data)
  {
    if ($data === null) {
      $data = array();
    }
    $paymentsalary = array();
    $fields = Salaries::$FIELDSPAYMENT;
    if (isModEnabled("bank")) {
      array_push($fields, "accountid");
    }
    foreach ($fields as $field) {
      if (!isset($data[$field])) {
        throw new RestException(400, "$field field missing");
      }
      $paymentsalary[$field] = $data[$field];
    }
    return $paymentsalary;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  protected function _cleanObjectDatas($object)
  {
    // phpcs:enable
    $object = parent::_cleanObjectDatas($object);
 
    unset($object->rowid);
 
    return $object;
  }
}