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 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.'/fichinter/class/fichinter.class.php';
 
 
class Interventions extends DolibarrApi
{
 
  public static $FIELDS = array(
    'socid',
    'fk_project',
    'description',
  );
 
  public static $FIELDSLINE = array(
    'description',
    'date',
    'duree',
  );
 
  public $fichinter;
 
  public function __construct()
  {
    global $db, $conf;
    $this->db = $db;
    $this->fichinter = new Fichinter($this->db);
  }
 
  public function get($id)
  {
    if (!DolibarrApiAccess::$user->rights->ficheinter->lire) {
      throw new RestException(401);
    }
 
    $result = $this->fichinter->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Intervention not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('fichinter', $this->fichinter->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $this->fichinter->fetchObjectLinked();
    return $this->_cleanObjectDatas($this->fichinter);
  }
 
  public function index($sortfield = "t.rowid", $sortorder = 'ASC', $limit = 100, $page = 0, $thirdparty_ids = '', $sqlfilters = '')
  {
    global $db, $conf;
 
    if (!DolibarrApiAccess::$user->rights->ficheinter->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."fichinter AS t 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
 
    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('intervention').')';
    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);
        $fichinter_static = new Fichinter($this->db);
        if ($fichinter_static->fetch($obj->rowid)) {
          $obj_ret[] = $this->_cleanObjectDatas($fichinter_static);
        }
        $i++;
      }
    } else {
      throw new RestException(503, 'Error when retrieve intervention list : '.$this->db->lasterror());
    }
    if (!count($obj_ret)) {
      throw new RestException(404, 'No intervention found');
    }
    return $obj_ret;
  }
 
  public function post($request_data = null)
  {
    if (!DolibarrApiAccess::$user->rights->ficheinter->creer) {
      throw new RestException(401, "Insuffisant rights");
    }
    // Check mandatory fields
    $result = $this->_validate($request_data);
    foreach ($request_data as $field => $value) {
      $this->fichinter->$field = $value;
    }
 
    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;
  }
 
 
  /* TODO
  public function getLines($id)
  {
    if(! DolibarrApiAccess::$user->rights->ficheinter->lire) {
      throw new RestException(401);
    }
 
    $result = $this->fichinter->fetch($id);
    if( ! $result ) {
      throw new RestException(404, 'Intervention not found');
    }
 
    if( ! DolibarrApi::_checkAccessToResource('fichinter',$this->fichinter->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
    $this->fichinter->getLinesArray();
    $result = array();
    foreach ($this->fichinter->lines as $line) {
      array_push($result,$this->_cleanObjectDatas($line));
    }
    return $result;
  }
  */
 
  public function postLine($id, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->rights->ficheinter->creer) {
      throw new RestException(401, "Insuffisant rights");
    }
    // Check mandatory fields
    $result = $this->_validateLine($request_data);
 
    foreach ($request_data as $field => $value) {
      $this->fichinter->$field = $value;
    }
 
    if (!$result) {
      throw new RestException(404, 'Intervention not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('fichinter', $this->fichinter->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $updateRes = $this->fichinter->addLine(
      DolibarrApiAccess::$user,
      $id,
      $this->fichinter->description,
      $this->fichinter->date,
      $this->fichinter->duree
    );
 
    if ($updateRes > 0) {
      return $updateRes;
    } else {
      throw new RestException(400, $this->fichinter->error);
    }
  }
 
  public function delete($id)
  {
    if (!DolibarrApiAccess::$user->rights->ficheinter->supprimer) {
      throw new RestException(401);
    }
    $result = $this->fichinter->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Intervention not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('fichinter', $this->fichinter->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    if (!$this->fichinter->delete(DolibarrApiAccess::$user)) {
      throw new RestException(500, 'Error when delete intervention : '.$this->fichinter->error);
    }
 
    return array(
      'success' => array(
        'code' => 200,
        'message' => 'Intervention deleted'
      )
    );
  }
 
  public function validate($id, $notrigger = 0)
  {
    if (!DolibarrApiAccess::$user->rights->ficheinter->creer) {
      throw new RestException(401, "Insuffisant 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(401, '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->commande->error);
    }
 
    $this->fichinter->fetchObjectLinked();
 
    return $this->_cleanObjectDatas($this->fichinter);
  }
 
  public function closeFichinter($id)
  {
    if (!DolibarrApiAccess::$user->rights->ficheinter->creer) {
      throw new RestException(401, "Insuffisant 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(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $result = $this->fichinter->setStatut(3);
 
    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->error);
    }
 
    $this->fichinter->fetchObjectLinked();
 
    return $this->_cleanObjectDatas($this->fichinter);
  }
 
  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->statuts_short);
    unset($object->statuts_logo);
    unset($object->statuts);
 
    return $object;
  }
 
  private function _validateLine($data)
  {
    $fichinter = array();
    foreach (Interventions::$FIELDSLINE as $field) {
      if (!isset($data[$field])) {
        throw new RestException(400, "$field field missing");
      }
      $fichinter[$field] = $data[$field];
    }
    return $fichinter;
  }
}