api_interventions.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2015   Jean-François Ferry   <jfefe@aternatik.fr>
 * Copyright (C) 2016   Laurent Destailleur   <eldy@users.sourceforge.net>
 * Copyright (C) 2025-2026  William Mead      <william@m34d.com>
 * Copyright (C) 2025-2026  Charlene Benke      <charlene@patas-monkey.com>
 * Copyright (C) 2025       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.'/fichinter/class/fichinter.class.php';
include_once DOL_DOCUMENT_ROOT."/fichinter/class/fichinterligne.class.php";
require_once DOL_DOCUMENT_ROOT.'/core/lib/company.lib.php';
 
 
 
class Interventions extends DolibarrApi
{
  public static $FIELDS = array(
    'socid',
    'fk_project',
    'description',
  );
 
  public static $FIELDSLINE = array(
    'description',
    'date',
    'duration',
  );
 
  public $fichinter;
 
  public function __construct()
  {
    global $db;
    $this->db = $db;
    $this->fichinter = new Fichinter($this->db);
  }
 
  public function get($id, $ref = '', $ref_ext = '', $contact_list = 1)
  {
    if (!DolibarrApiAccess::$user->hasRight('ficheinter', 'lire')) {
      throw new RestException(403);
    }
 
    $result = $this->fichinter->fetch($id, $ref, $ref_ext);
    if (!$result) {
      throw new RestException(404, 'Intervention not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('fichinter', $this->fichinter->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    if ($contact_list > -1) {
      // Add external contacts ids
      $tmparray = $this->fichinter->liste_contact(-1, 'external', $contact_list);
      if (is_array($tmparray)) {
        $this->fichinter->contacts_ids = $tmparray;
      }
      $tmparray = $this->fichinter->liste_contact(-1, 'internal', $contact_list);
      if (is_array($tmparray)) {
        $this->fichinter->contacts_ids_internal = $tmparray;
      }
    }
 
    $this->fichinter->fetchObjectLinked();
 
    return $this->_cleanObjectDatas($this->fichinter);
  }
 
  public function index($sortfield = "t.rowid", $sortorder = 'ASC', $limit = 100, $page = 0, $thirdparty_ids = '', $sqlfilters = '', $properties = '', $contact_type = '', $pagination_data = false, $loadlinkedobjects = 0)
  {
    if (!DolibarrApiAccess::$user->hasRight('ficheinter', '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."fichinter AS t";
    $sql .= " INNER JOIN ".MAIN_DB_PREFIX."societe AS s ON (s.rowid = t.fk_soc)";
    $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."fichinter_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('intervention').')';
    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);
      }
    }
 
    if ($sqlfilters) {
      $parameters = array('sqlfilters' => $sqlfilters, 'apiroute' => 'interventions', 'apimethod' => __METHOD__);
      $action = 'list';
      $reshook = $hookmanager->executeHooks('printFieldListWhere', $parameters, $this->fichinter, $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 interventions 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);
        $fichinter_static = new Fichinter($this->db);
        if ($fichinter_static->fetch($obj->rowid)) {
          if ($contact_type) {
            $fichinter_static->contacts_ids = $fichinter_static->liste_contact(-1, $contact_type, 1);
          }
 
          if ($loadlinkedobjects) {
            // retrieve linked objects
            $fichinter_static->fetchObjectLinked();
          }
 
          $obj_ret[] = $this->_filterObjectProperties($this->_cleanObjectDatas($fichinter_static), $properties);
        }
        $i++;
      }
    } else {
      throw new RestException(503, 'Error when retrieve intervention 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('ficheinter', '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->fichinter->context['caller'] = sanitizeVal($request_data['caller'], 'aZ09');
        continue;
      }
 
      $this->fichinter->$field = $this->_checkValForAPI($field, $value, $this->fichinter);
    }
 
    if ($this->fichinter->create(DolibarrApiAccess::$user) < 0) {
      throw new RestException(500, "Error creating intervention", array_merge(array($this->fichinter->error), $this->fichinter->errors));
    }
 
    return $this->fichinter->id;
  }
 
  public function put($id, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->hasRight('ficheinter', 'creer')) {
      throw new RestException(403);
    }
 
    $result = $this->fichinter->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Fichinter not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('fichinter', $this->fichinter->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->fichinter->context['caller'] = sanitizeVal($request_data['caller'], 'aZ09');
        continue;
      }
      if ($field == 'array_options' && is_array($value)) {
        foreach ($value as $index => $val) {
          $this->fichinter->array_options[$index] = $this->_checkValExtrafieldsForAPI($index, $val, $this->fichinter);
        }
        continue;
      }
 
      $this->fichinter->$field = $this->_checkValForAPI($field, $value, $this->fichinter);
    }
 
    if ($this->fichinter->update(DolibarrApiAccess::$user) > 0) {
      return $this->get($id);
    } else {
      throw new RestException(500, $this->fichinter->errorsToString());
    }
  }
 
  public function getLines($id)
  {
    if (!DolibarrApiAccess::$user->hasRight('ficheinter', 'lire')) {
      throw new RestException(403);
    }
 
    $result = $this->fichinter->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Intervention not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('fichinter', $this->fichinter->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $this->fichinter->fetch_lines();
    $result = array();
    foreach ($this->fichinter->lines as $line) {
      $result[] = $this->_cleanObjectDatas($line);
    }
    return $result;
  }
 
  public function postLine($id, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->hasRight('ficheinter', 'creer')) {
      throw new RestException(403, "Insufficiant rights");
    }
    // Check mandatory fields
    $result = $this->_validateLine($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->fichinter->context['caller'] = sanitizeVal($request_data['caller'], 'aZ09');
        continue;
      }
 
      $this->fichinter->$field = $this->_checkValForAPI($field, $value, $this->fichinter);
    }
 
    if (!$result) {
      throw new RestException(404, 'Intervention not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('fichinter', $this->fichinter->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $updateRes = $this->fichinter->addLine(
      DolibarrApiAccess::$user,
      $id,
      $this->fichinter->description,
      $this->fichinter->date,
      $this->fichinter->duration
    );
 
    if ($updateRes > 0) {
      return $updateRes;
    } else {
      throw new RestException(400, $this->fichinter->errorsToString());
    }
  }
 
  public function delete($id)
  {
    if (!DolibarrApiAccess::$user->hasRight('ficheinter', 'supprimer')) {
      throw new RestException(403);
    }
    $result = $this->fichinter->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Intervention not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('fichinter', $this->fichinter->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    if (!$this->fichinter->delete(DolibarrApiAccess::$user)) {
      throw new RestException(500, 'Error when delete intervention : '.$this->fichinter->errorsToString());
    }
 
    return array(
      'success' => array(
        'code' => 200,
        'message' => 'Intervention deleted'
      )
    );
  }
 
  public function validate($id, $notrigger = 0)
  {
    if (!DolibarrApiAccess::$user->hasRight('ficheinter', 'creer')) {
      throw new RestException(403, "Insufficiant rights");
    }
    $result = $this->fichinter->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Intervention not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('fichinter', $this->fichinter->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $result = $this->fichinter->setValid(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 Intervention: '.$this->fichinter->errorsToString());
    }
 
    $this->fichinter->fetchObjectLinked();
 
    return $this->_cleanObjectDatas($this->fichinter);
  }
 
  public function close($id, $notrigger = 0)
  {
    if (!DolibarrApiAccess::$user->hasRight('ficheinter', 'creer')) {
      throw new RestException(403, "Insufficiant rights");
    }
    $result = $this->fichinter->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Intervention not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('fichinter', $this->fichinter->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $result = $this->fichinter->setClose(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 Intervention: '.$this->fichinter->errorsToString());
    }
 
    $this->fichinter->fetchObjectLinked();
 
    return $this->_cleanObjectDatas($this->fichinter);
  }
 
 
  public function deleteLine($id, $lineid)
  {
    if (!DolibarrApiAccess::$user->hasRight('ficheinter', 'creer')) {
      throw new RestException(403);
    }
 
    $result = $this->fichinter->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Intervention not found');
    }
 
    if ($this->fichinter->status != 0) {
      throw new RestException(403, 'Intervention not in draft status : '.$this->fichinter->getLibStatut(1));
    }
 
    if (!DolibarrApi::_checkAccessToResource('ficheinter', $this->fichinter->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $objectline = new FichinterLigne($this->db);
    if ($objectline->fetch($lineid) <= 0) {
      throw new RestException(404, 'Intervention line not found');
    }
    if ($objectline->fk_fichinter != $this->fichinter->id) {
      throw new RestException(403, 'Line does not belong to this intervention');
    }
 
    $updateRes = $objectline->deleteLine(DolibarrApiAccess::$user);
 
    if ($updateRes >= 0) {
      return $this->_cleanObjectDatas($this->fichinter);
    } else {
      throw new RestException(405, $this->fichinter->errorsToString());
    }
  }
 
  public function settodraft($id)
  {
    if (!DolibarrApiAccess::$user->hasRight('ficheinter', 'creer')) {
      throw new RestException(403, "Insufficiant rights");
    }
    $result = $this->fichinter->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Intervention not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('ficheinter', $this->fichinter->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $result = $this->fichinter->setDraft(DolibarrApiAccess::$user);
    if ($result == 0) {
      throw new RestException(304, 'Nothing done. . May be object is already set as draft.');
    }
    if ($result < 0) {
      throw new RestException(500, 'Error when closing intervention: '.$this->fichinter->errorsToString());
    }
 
    $this->fichinter->fetchObjectLinked();
    return $this->_cleanObjectDatas($this->fichinter);
  }
 
  public function addContact($id, $fk_socpeople, $type_contact, $source, $notrigger = 0)
  {
    if (!DolibarrApiAccess::$user->hasRight('ficheinter', 'creer')) {
      throw new RestException(403);
    }
    $result = $this->fichinter->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Interventional not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('ficheinter', $this->fichinter->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $result = $this->fichinter->add_contact($fk_socpeople, $type_contact, $source, $notrigger);
    if ($result < 0) {
      throw new RestException(500, 'Error : '.$this->fichinter->errorsToString());
    }
 
    $result = $this->fichinter->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Interventional not found');
    }
 
    return $this->_cleanObjectDatas($this->fichinter);
  }
 
  public function getContacts($id, $type = '', $source = '')
  {
    if (!DolibarrApiAccess::$user->hasRight('ficheinter', 'lire')) {
      throw new RestException(403);
    }
 
    $result = $this->fichinter->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Interventional not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('ficheinter', $this->fichinter->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    if (empty($source) || $source == 'external') {
      $contacts = $this->fichinter->liste_contact(-1, 'external', 0, $type);
    } else {
      $contacts = array();
    }
    if (empty($source) || $source == 'internal') {
      $socpeoples = $this->fichinter->liste_contact(-1, 'internal', 0, $type);
    } else {
      $socpeoples = array();
    }
 
    $contacts = array_merge($contacts, $socpeoples);
 
    return $contacts;
  }
 
 
  public function deleteContact($id, $contactid, $type)
  {
    if (!DolibarrApiAccess::$user->hasRight('ficheinter', 'creer')) {
      throw new RestException(403);
    }
 
    $result = $this->fichinter->fetch($id);
 
    if (!$result) {
      throw new RestException(404, 'Interventional not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('ficheinter', $this->fichinter->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
    foreach (array('internal', 'external') as $source) {
      $contacts = $this->fichinter->liste_contact(-1, $source);
 
      foreach ($contacts as $contact) {
        if ($contact['id'] == $contactid && $contact['code'] == $type) {
          $result = $this->fichinter->delete_contact($contact['rowid']);
          if (!$result) {
            throw new RestException(500, 'Error when deleted the contact');
          }
        }
      }
    }
    return $this->_cleanObjectDatas($this->fichinter);
  }
 
  public function putLine($id, $lineid, $request_data)
  {
    $result = $this->fichinter->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Intervention not found');
    }
 
    if ($this->fichinter->status != 0) {
      throw new RestException(403, 'Intervention not in draft status : '.$this->fichinter->getLibStatut(1));
    }
 
    if (!DolibarrApi::_checkAccessToResource('ficheinter', $this->fichinter->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $objectline = new FichinterLigne($this->db);
    if ($objectline->fetch($lineid) <= 0) {
      throw new RestException(404, 'Intervention line not found');
    }
    if ($objectline->fk_fichinter != $this->fichinter->id) {
      throw new RestException(403, 'Line does not belong to this intervention');
    }
    $request_data = (object) $request_data;
 
    if (isset($request_data->desc) || isset($request_data->description)) {
      $objectline->desc = sanitizeVal($request_data->desc ?? $request_data->description, 'restricthtml');
    }
    if (isset($request_data->date)) {
      $objectline->date = (int) sanitizeVal($request_data->date);
    }
    if (isset($request_data->duration)) {
      $objectline->duration = (int) sanitizeVal($request_data->duration);
    }
    if (isset($request_data->rang)) {
      $objectline->rang = (int) sanitizeVal($request_data->rang);
    }
 
    $updateRes = $objectline->update(DolibarrApiAccess::$user);
 
    if ($updateRes >= 0) {
      $result = $this->fichinter->fetch($id);
      if ($result > 0) {
        return $this->_cleanObjectDatas($this->fichinter);
      } else {
        throw new RestException(500, $this->fichinter->errorsToString());
      }
    } else {
      throw new RestException(500, $objectline->errorsToString());
    }
  }
 
 
  private function _validate($data)
  {
    $fichinter = array();
    foreach (Interventions::$FIELDS as $field) {
      if (!isset($data[$field])) {
        throw new RestException(400, "$field field missing");
      }
      $fichinter[$field] = $data[$field];
    }
    return $fichinter;
  }
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  protected function _cleanObjectDatas($object)
  {
    // phpcs:enable
    $object = parent::_cleanObjectDatas($object);
 
    unset($object->labelStatus);
    unset($object->labelStatusShort);
 
    return $object;
  }
 
  private function _validateLine($data)
  {
    if ($data === null) {
      $data = array();
    }
    $fichinter = array();
    foreach (Interventions::$FIELDSLINE as $field) {
      if (!isset($data[$field])) {
        throw new RestException(400, "$field field missing");
      }
      $fichinter[$field] = $data[$field];
    }
    return $fichinter;
  }
}