api_tickets.class.php

<?php
/* Copyright (C) 2016   Jean-François Ferry     <hello@librethic.io>
 * Copyright (C) 2024-2025  Frédéric France             <frederic.france@free.fr>
 * Copyright (C) 2024-2025  MDW             <mdeweerd@users.noreply.github.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.'/ticket/class/ticket.class.php';
require_once DOL_DOCUMENT_ROOT.'/core/lib/ticket.lib.php';
 
 
class Tickets extends DolibarrApi
{
  public static $FIELDS = array(
    'subject',
    'message'
  );
 
  public static $FIELDS_MESSAGES = array(
    'track_id',
    'message'
  );
 
  public $ticket;
 
  public function __construct()
  {
    global $db;
    $this->db = $db;
    $this->ticket = new Ticket($this->db);
  }
 
  public function get($id, $contact_list = 1)
  {
    return $this->getCommon($id, '', '', $contact_list);
  }
 
  public function getByTrackId($track_id, $contact_list = 1)
  {
    return $this->getCommon(0, $track_id, '', $contact_list);
  }
 
  public function getByRef($ref, $contact_list = 1)
  {
    return $this->getCommon(0, '', $ref, $contact_list);
  }
 
  private function getCommon($id = 0, $track_id = '', $ref = '', $contact_list = 1)
  {
    if (!DolibarrApiAccess::$user->hasRight('ticket', 'read')) {
      throw new RestException(403);
    }
 
    // Check parameters
    if (($id < 0) && !$track_id && !$ref) {
      throw new RestException(400, 'Wrong parameters');
    }
    if (empty($id) && empty($ref) && empty($track_id)) {
      $result = $this->ticket->initAsSpecimen();
    } else {
      $result = $this->ticket->fetch($id, $ref, $track_id);
    }
    if (!$result) {
      throw new RestException(404, 'Ticket not found');
    }
 
    // String for user assigned
    if ($this->ticket->fk_user_assign > 0) {
      $userStatic = new User($this->db);
      $userStatic->fetch($this->ticket->fk_user_assign);
      $this->ticket->fk_user_assign_string = $userStatic->firstname.' '.$userStatic->lastname;
    }
 
    // Messages of ticket
    $messages = array();
    $this->ticket->loadCacheMsgsTicket();
    if (is_array($this->ticket->cache_msgs_ticket) && count($this->ticket->cache_msgs_ticket) > 0) {
      $num = count($this->ticket->cache_msgs_ticket);
      $i = 0;
      while ($i < $num) {
        if ($this->ticket->cache_msgs_ticket[$i]['fk_user_author'] > 0) {
          $user_action = new User($this->db);
          $user_action->fetch($this->ticket->cache_msgs_ticket[$i]['fk_user_author']);
        } else {
          $user_action = null;
        }
 
        // Now define messages
        $messages[] = array(
          'id' => $this->ticket->cache_msgs_ticket[$i]['id'],
          'fk_user_action' => $this->ticket->cache_msgs_ticket[$i]['fk_user_author'],
          'fk_user_action_socid' =>  $user_action === null ? '' : $user_action->socid,
          'fk_user_action_string' => $user_action === null ? '' : dolGetFirstLastname($user_action->firstname, $user_action->lastname),
          'message' => $this->ticket->cache_msgs_ticket[$i]['message'],
          'datec' => $this->ticket->cache_msgs_ticket[$i]['datec'],
          'private' => $this->ticket->cache_msgs_ticket[$i]['private']
        );
        $i++;
      }
      $this->ticket->messages = $messages;
    }
 
    if (!DolibarrApi::_checkAccessToResource('ticket', $this->ticket->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    if ($contact_list > -1) {
      // Add external contacts ids
      $tmparray = $this->ticket->liste_contact(-1, 'external', $contact_list);
      if (is_array($tmparray)) {
        $this->ticket->contacts_ids = $tmparray;
      }
      $tmparray = $this->ticket->liste_contact(-1, 'internal', $contact_list);
      if (is_array($tmparray)) {
        $this->ticket->contacts_ids_internal = $tmparray;
      }
    }
 
    return $this->_cleanObjectDatas($this->ticket);
  }
 
  public function index($socid = 0, $sortfield = "t.rowid", $sortorder = "ASC", $limit = 100, $page = 0, $sqlfilters = '', $properties = '', $loadcontacts = 0, $pagination_data = false)
  {
    if (!DolibarrApiAccess::$user->hasRight('ticket', 'read')) {
      throw new RestException(403);
    }
 
    $obj_ret = array();
 
    $socid = DolibarrApiAccess::$user->socid ?: $socid;
 
    $search_sale = null;
    // If the internal user must only see his customers, force searching by him
    $search_sale = 0;
    if (!DolibarrApiAccess::$user->hasRight('societe', 'client', 'voir') && !$socid) {
      $search_sale = DolibarrApiAccess::$user->id;
    }
 
    $sql = "SELECT t.rowid";
    $sql .= " FROM ".MAIN_DB_PREFIX."ticket AS t";
    $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."societe AS s ON (s.rowid = t.fk_soc)";
    $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."ticket_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('ticket', 1).')';
    if ($socid > 0) {
      $sql .= " AND t.fk_soc = ".((int) $socid);
    }
    // Search on sale representative
    if ($search_sale && $search_sale != '-1') {
      if ($search_sale == -2) {
        $sql .= " AND NOT EXISTS (SELECT sc.fk_soc FROM ".MAIN_DB_PREFIX."societe_commerciaux as sc WHERE sc.fk_soc = t.fk_soc)";
      } elseif ($search_sale > 0) {
        $sql .= " AND EXISTS (SELECT sc.fk_soc FROM ".MAIN_DB_PREFIX."societe_commerciaux as sc WHERE sc.fk_soc = t.fk_soc 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);
      }
    }
 
    //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, $offset);
    }
 
    $result = $this->db->query($sql);
    if ($result) {
      $i = 0;
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      while ($i < $min) {
        $obj = $this->db->fetch_object($result);
        $ticket_static = new Ticket($this->db);
        if ($ticket_static->fetch($obj->rowid)) {
          if ($ticket_static->fk_user_assign > 0) {
            $userStatic = new User($this->db);
            $userStatic->fetch($ticket_static->fk_user_assign);
            $ticket_static->fk_user_assign_string = $userStatic->firstname.' '.$userStatic->lastname;
          }
 
          if ($loadcontacts) {
            // Add external contacts ids
            $tmparray = $ticket_static->liste_contact(-1, 'external', 1);
            if (is_array($tmparray)) {
              $ticket_static->contacts_ids = $tmparray;
            }
            $tmparray = $ticket_static->liste_contact(-1, 'internal', 1);
            if (is_array($tmparray)) {
              $ticket_static->contacts_ids_internal = $tmparray;
            }
          }
 
          $obj_ret[] = $this->_filterObjectProperties($this->_cleanObjectDatas($ticket_static), $properties);
        }
        $i++;
      }
    } else {
      throw new RestException(503, 'Error when retrieve ticket list');
    }
 
    //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)
  {
    $ticketstatic = new Ticket($this->db);
    if (!DolibarrApiAccess::$user->hasRight('ticket', 'write')) {
      throw new RestException(403);
    }
 
    // Check mandatory fields
    $this->_validate($request_data);
 
    // Check thirdparty validity
    $socid = (int) $request_data['socid'];
    if ($socid > 0) {
      $thirdpartytmp = new Societe($this->db);
      $thirdparty_result = $thirdpartytmp->fetch($socid);
      if ($thirdparty_result < 1) {
        throw new RestException(404, 'Thirdparty with id='.$socid.' not found or not allowed');
      }
      if (!DolibarrApi::_checkAccessToResource('societe', $thirdpartytmp->id)) {
        throw new RestException(404, 'Thirdparty with id='.$thirdpartytmp->id.' not found or not allowed');
      }
    }
 
    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->ticket->context['caller'] = sanitizeVal($request_data['caller'], 'aZ09');
        continue;
      }
 
      $this->ticket->$field = $this->_checkValForAPI($field, $value, $this->ticket);
    }
    if (empty($this->ticket->ref)) {
      $this->ticket->ref = $ticketstatic->getDefaultRef();
    }
    if (empty($this->ticket->track_id)) {
      $this->ticket->track_id = generate_random_id(16);
    }
 
    if ($this->ticket->create(DolibarrApiAccess::$user) < 0) {
      throw new RestException(500, "Error creating ticket", array_merge(array($this->ticket->error), $this->ticket->errors));
    }
 
    return $this->ticket->id;
  }
 
  public function postNewMessage($request_data = null)
  {
    if (!DolibarrApiAccess::$user->hasRight('ticket', 'write')) {
      throw new RestException(403);
    }
 
    // Check mandatory fields
    $result = $this->_validateMessage($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->ticket->context['caller'] = sanitizeVal($request_data['caller'], 'aZ09');
        continue;
      }
 
      $this->ticket->$field = $this->_checkValForAPI($field, $value, $this->ticket);
    }
    $ticketMessageText = $this->ticket->message;
    $result = $this->ticket->fetch(0, '', $this->ticket->track_id);
    if (!$result) {
      throw new RestException(404, 'Ticket not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('ticket', $this->ticket->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $this->ticket->message = $ticketMessageText;
    if (!$this->ticket->createTicketMessage(DolibarrApiAccess::$user)) {
      throw new RestException(500, 'Error when creating ticket');
    }
    return $this->ticket->id;
  }
 
  public function put($id, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->hasRight('ticket', 'write')) {
      throw new RestException(403);
    }
 
    $result = $this->ticket->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Ticket not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('ticket', $this->ticket->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    // Check thirdparty validity
    $socid = (int) $request_data['socid'];
    if ($socid > 0) {
      $thirdpartytmp = new Societe($this->db);
      $thirdparty_result = $thirdpartytmp->fetch($socid);
      if ($thirdparty_result < 1) {
        throw new RestException(404, 'Thirdparty with id='.$socid.' not found or not allowed');
      }
      if (!DolibarrApi::_checkAccessToResource('societe', $thirdpartytmp->id)) {
        throw new RestException(404, 'Thirdparty with id='.$thirdpartytmp->id.' not found or not allowed');
      }
    }
 
    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->ticket->context['caller'] = sanitizeVal($request_data['caller'], 'aZ09');
        continue;
      }
 
      if ($field == 'id') {
        continue;
      }
      if ($field == 'array_options' && is_array($value)) {
        foreach ($value as $index => $val) {
          $this->ticket->array_options[$index] = $this->_checkValForAPI($field, $val, $this->ticket);
        }
        continue;
      }
 
      $this->ticket->$field = $this->_checkValForAPI($field, $value, $this->ticket);
    }
 
    if ($this->ticket->update(DolibarrApiAccess::$user) > 0) {
      return $this->get($id);
    } else {
      throw new RestException(500, $this->ticket->error);
    }
  }
 
  public function delete($id)
  {
    if (!DolibarrApiAccess::$user->hasRight('ticket', 'delete')) {
      throw new RestException(403);
    }
    $result = $this->ticket->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Ticket not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('ticket', $this->ticket->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    if (!$this->ticket->delete(DolibarrApiAccess::$user)) {
      throw new RestException(500, 'Error when deleting ticket');
    }
 
    return array(
      'success' => array(
        'code' => 200,
        'message' => 'Ticket deleted'
      )
    );
  }
 
  private function _validate($data)
  {
    if ($data === null) {
      $data = array();
    }
    $ticket = array();
    foreach (Tickets::$FIELDS as $field) {
      if (!isset($data[$field])) {
        throw new RestException(400, "$field field missing");
      }
      $ticket[$field] = $data[$field];
    }
    return $ticket;
  }
 
  private function _validateMessage($data)
  {
    if ($data === null) {
      $data = array();
    }
    $ticket = array();
    foreach (Tickets::$FIELDS_MESSAGES as $field) {
      if (!isset($data[$field])) {
        throw new RestException(400, "$field field missing");
      }
      $ticket[$field] = $data[$field];
    }
    return $ticket;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  protected function _cleanObjectDatas($object)
  {
    // phpcs:enable
    $object = parent::_cleanObjectDatas($object);
 
    // Other attributes to clean
    $attr2clean = array(
      "contact",
      "contact_id",
      "ref_previous",
      "ref_next",
      "ref_ext",
      "table_element_line",
      "statut",
      "country",
      "country_id",
      "country_code",
      "barcode_type",
      "barcode_type_code",
      "barcode_type_label",
      "barcode_type_coder",
      "mode_reglement_id",
      "cond_reglement_id",
      "cond_reglement",
      "fk_delivery_address",
      "shipping_method_id",
      "modelpdf",
      "fk_account",
      "note_public",
      "note_private",
      "note",
      "total_ht",
      "total_tva",
      "total_localtax1",
      "total_localtax2",
      "total_ttc",
      "fk_incoterms",
      "label_incoterms",
      "location_incoterms",
      "name",
      "lastname",
      "firstname",
      "civility_id",
      "canvas",
      "cache_msgs_ticket",
      "cache_logs_ticket",
      "cache_types_tickets",
      "regeximgext",
      "labelStatus",
      "labelStatusShort",
      "multicurrency_code",
      "multicurrency_tx",
      "multicurrency_total_ht",
      "multicurrency_total_ttc",
      "multicurrency_total_tva",
      "multicurrency_total_localtax1",
      "multicurrency_total_localtax2"
    );
    foreach ($attr2clean as $toclean) {
      unset($object->$toclean);
    }
 
    // If object has lines, remove $db property
    if (isset($object->lines) && count($object->lines) > 0) {
      $nboflines = count($object->lines);
      for ($i = 0; $i < $nboflines; $i++) {
        $this->_cleanObjectDatas($object->lines[$i]);
      }
    }
 
    // If object has linked objects, remove $db property
    if (isset($object->linkedObjects) && count($object->linkedObjects) > 0) {
      foreach ($object->linkedObjects as $type_object => $linked_object) {
        foreach ($linked_object as $object2clean) {
          $this->_cleanObjectDatas($object2clean);
        }
      }
    }
    return $object;
  }
}