actions_ticket.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2013-2015 Jean-François FERRY <hello@librethic.io>
 * Copyright (C) 2016      Christophe Battarel <christophe@altairis.fr>
 * Copyright (C) 2024      Destailleur Laurent <eldy@users.sourceforge.net>
 * Copyright (C) 2024   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, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */
 
require_once DOL_DOCUMENT_ROOT.'/ticket/class/ticket.class.php';
require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
require_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';
require_once DOL_DOCUMENT_ROOT.'/contact/class/contact.class.php';
require_once DOL_DOCUMENT_ROOT.'/contrat/class/contrat.class.php';
require_once DOL_DOCUMENT_ROOT.'/fichinter/class/fichinter.class.php';
require_once DOL_DOCUMENT_ROOT.'/core/class/commonhookactions.class.php';
 
// TODO Only the last method emailElementlist is a hook method. Other must be moved into standard ticket.class.php
 
 
class ActionsTicket extends CommonHookActions
{
  public $db;
 
  public $dao;
 
  public $mesg;
 
  public $error;
 
  public $errors = array();
 
  public $errno = 0;
 
  public $template_dir;
  public $template;
 
  public $label;
 
  public $description;
 
  public $fk_statut;
 
  public $fk_soc;
 
 
  public function __construct($db)
  {
    $this->db = $db;
  }
 
  public function getInstanceDao()
  {
    if (!is_object($this->dao)) {
      $this->dao = new Ticket($this->db);
    }
  }
 
  public function fetch($id = 0, $ref = '', $track_id = '')
  {
    $this->getInstanceDao();
    return $this->dao->fetch($id, $ref, $track_id);
  }
 
  public function getLibStatut($mode = 0)
  {
    $this->getInstanceDao();
    $this->dao->fk_statut = $this->fk_statut;
    return $this->dao->getLibStatut($mode);
  }
 
  public function getInfo($id)
  {
    $this->getInstanceDao();
    $this->dao->fetch($id);
 
    $this->label = $this->dao->label;
    $this->description = $this->dao->description;
  }
 
  public function getTitle($action = '', $object = null)
  {
    global $langs;
 
    if ($action == 'create') {
      return $langs->trans("CreateTicket");
    } elseif ($action == 'edit') {
      return $langs->trans("EditTicket");
    } elseif ($action == 'view') {
      return $langs->trans("Ticket").(is_null($object) ? '' : ' '.$object->ref);
    } elseif ($action == 'add_message') {
      return $langs->trans("TicketAddMessage");
    } else {
      return $langs->trans("Ticket");
    }
  }
 
  public function viewTicketOriginalMessage($user, $action, $object)
  {
    dol_syslog(__METHOD__, LOG_DEBUG);
    global $langs;
 
    $closeStatuses = [Ticket::STATUS_CLOSED, Ticket::STATUS_CANCELED];
 
    $permissiontoadd = $user->hasRight('ticket', 'write');
 
    print '<!-- initial message of ticket -->'."\n";
    if ($permissiontoadd && !in_array($object->status, $closeStatuses) && $action == 'edit_message_init') {
      // MESSAGE
      print '<form action="'.$_SERVER['PHP_SELF'].'" method="post">';
      print '<input type="hidden" name="token" value="'.newToken().'">';
      print '<input type="hidden" name="track_id" value="'.$object->track_id.'">';
      print '<input type="hidden" name="action" value="set_message">';
    }
 
    // Initial message
    print '<div class="div-table-responsive-no-min">'; // You can use div-table-responsive-no-min if you don't need reserved height for your table
    print '<table class="border tableforfield centpercent margintable">';
    print '<tr class="liste_titre trforfield"><td class="nowrap titlefield">';
 
    print '<table class="nobordernopadding centpercent "><tr><td class="noborder" style="border-bottom: none !important;">';
    print $langs->trans('InitialMessage');
    if ($action != 'edit_message_init' && $permissiontoadd && !in_array($object->status, $closeStatuses)) {
      print '</td><td class="right noborder" style="border-bottom: none !important;">';
      print '<a class="editfielda" href="'.$_SERVER['PHP_SELF'].'?action=edit_message_init&token='.newToken().'&track_id='.$object->track_id.'">'.img_edit($langs->trans('Modify')).'</a>';
    }
    print '</td></tr></table>';
 
    print '</td><td>';
    if ($action == 'edit_message_init' && $permissiontoadd && !in_array($object->status, $closeStatuses)) {
      print '<input type="submit" class="button button-edit smallpaddingimp" value="'.$langs->trans('Modify').'">';
      print ' <input type="submit" class="button button-cancel smallpaddingimp" name="cancel" value="'.$langs->trans("Cancel").'">';
    }
    print '</td></tr>';
 
    print '<tr>';
    print '<td colspan="2">';
    if ($permissiontoadd && !in_array($object->status, $closeStatuses) && $action == 'edit_message_init') {
      // Message
      $msg = GETPOSTISSET('message_initial') ? GETPOST('message_initial', 'restricthtml') : $object->message;
      include_once DOL_DOCUMENT_ROOT.'/core/class/doleditor.class.php';
      $uselocalbrowser = -1;
      $ckeditorenabledforticket = (getDolGlobalString('FCKEDITOR_ENABLE_TICKET') >= 1);   // 0=no, 1=from backoffice only, 2=from backoffice+public (very dangerous)
      if (!$ckeditorenabledforticket) {
        $msg = dol_string_nohtmltag($msg, 2);
      }
      $doleditor = new DolEditor('message_initial', $msg, '100%', 250, 'dolibarr_details', 'In', true, $uselocalbrowser, $ckeditorenabledforticket, ROWS_9, '95%');
      $doleditor->Create();
    } else {
      print '<div class="longmessagecut small">';
      print dolPrintHTML($object->message);
      print '</div>';
      /*print '<div class="clear center">';
      print $langs->trans("More").'...';
      print '</div>';*/
 
      //print '<div>' . $object->message . '</div>';
    }
    print '</td>';
    print '</tr>';
    print '</table>';
    print '</div>';
 
    if ($permissiontoadd && !in_array($object->status, $closeStatuses) && $action == 'edit_message_init') {
      // MESSAGE
      print '</form>';
    }
  }
 
  public function viewTicketMessages($show_private, $show_author, $object)
  {
    global $langs, $user;
 
    // Load logs in cache
    $ret = $this->dao->loadCacheMsgsTicket();
    if ($ret < 0) {
      dol_print_error($this->dao->db);
    }
 
    $action = GETPOST('action', 'aZ09');
 
    print '<div class="ticketpublicarea ticketlargemargin" style="padding-top: 0">';
    $this->viewTicketOriginalMessage($user, $action, $object);
    print '</div>';
 
    if (is_array($this->dao->cache_msgs_ticket) && count($this->dao->cache_msgs_ticket) > 0) {
      print '<div class="ticketpublicarea ticketlargemargin">';
 
      print '<div class="div-table-responsive-no-min">';
      print '<table class="border centpercent">';
 
      print '<tr class="liste_titre">';
 
      print '<td>';
      print '<h4>';
      print $langs->trans('TicketMessagesList');
      print '</h4>';
      print '</td>';
 
      if ($show_author) {
        print '<td>';
        print '<h4>';
        print $langs->trans('Author');
        print '</h4>';
        print '</td>';
      }
      print '</tr>';
 
      $ticket_message_nr = 1;
      foreach ($this->dao->cache_msgs_ticket as $id => $arraymsgs) {
        if (!$arraymsgs['private']
          || ($arraymsgs['private'] == "1" && $show_private)
        ) {
          //print '<tr>';
          print '<tr id="ticket_message_header_'.$ticket_message_nr.'" class="oddeven nohover">';
          print '<td><strong>';
          print img_picto('', 'object_action', 'class="paddingright"').dol_print_date($arraymsgs['datep'], 'dayhour');
          print '<strong></td>';
          if ($show_author) {
            print '<td>';
            if ($arraymsgs['fk_user_author'] > 0) {
              $userstat = new User($this->db);
              $res = $userstat->fetch($arraymsgs['fk_user_author']);
              if ($res) {
                print img_picto('', 'user', 'class="pictofixedwidth"');
                print $userstat->getNomUrl(0);
              }
            } elseif (isset($arraymsgs['fk_contact_author'])) {
              $contactstat = new Contact($this->db);
              $res = $contactstat->fetch(0, null, '', $arraymsgs['fk_contact_author']);
              if ($res == 2) {
                print img_picto('', 'email', 'class="pictofixedwidth"');
                print $arraymsgs['fk_contact_author'];
              } elseif ($res) {
                print img_picto('', 'contact', 'class="pictofixedwidth"');
                print $contactstat->getNomUrl(0, 'nolink');
              } else {
                print $arraymsgs['fk_contact_author'];
              }
            } else {
              print '<span class="opacitymedium">'.$langs->trans('Unknown').'</span>';
            }
            print '</td>';
          }
          print '</tr>';
 
          print '<tr id="ticket_message_body_'.$ticket_message_nr.'" class="oddeven nohover">';
          print '<td'.($show_author ? ' colspan="2"' : '').'>';
          print $arraymsgs['message'];
 
          //attachment
 
          $documents = array();
 
          $sql = 'SELECT ecm.rowid as id, ecm.src_object_type, ecm.src_object_id, ecm.agenda_id';
          $sql .= ', ecm.filepath, ecm.filename, ecm.share';
          $sql .= ' FROM '.MAIN_DB_PREFIX.'ecm_files ecm';
          $sql .= " WHERE ecm.filepath = 'agenda/".(int) $arraymsgs['id']."'";
          $sql .= " OR (ecm.agenda_id = ".(int) $arraymsgs['id']." AND ecm.src_object_type = 'ticket' AND ecm.src_object_id = ".(int) $this->dao->id.")";
          $sql .= ' ORDER BY ecm.position ASC';
 
          $resql = $this->db->query($sql);
          if ($resql) {
            if ($this->db->num_rows($resql)) {
              while ($obj = $this->db->fetch_object($resql)) {
                $documents[$obj->id] = $obj;
              }
            }
          }
          if (!empty($documents)) {
            $isshared = 0;
            $footer = '<div class="timeline-documents-container">';
            foreach ($documents as $doc) {
              if (!empty($doc->share) || ($doc->src_object_type == 'ticket')) {
                $isshared = 1;
                $footer .= '<span id="document_'.$doc->id.'" class="timeline-documents" ';
                $footer .= ' data-id="'.$doc->id.'" ';
                $footer .= ' data-path="'.$doc->filepath.'"';
                $footer .= ' data-filename="'.dol_escape_htmltag($doc->filename).'" ';
                $footer .= '>';
 
                if (empty($doc->agenda_id)) {
                  $dir_ref = $arraymsgs['id'];
                  $modulepart = 'actions';
                } else {
                  $split_dir = explode('/', $doc->filepath);
                  $modulepart = array_shift($split_dir);
                  $dir_ref = implode('/', $split_dir);
                }
                $filePath = DOL_DATA_ROOT.'/'.$doc->filepath.'/'.$doc->filename;
                $file_relative_path = $dir_ref.'/'.$doc->filename;
                $mime = dol_mimetype($filePath);
                $doclink = '';
                if (!empty($doc->share)) {
                  $doclink = DOL_URL_ROOT.'/document.php?hashp='.urlencode($doc->share);
                } elseif ($doc->src_object_type == 'ticket') {
                  $downloadwrapper = getDolGlobalString('TICKET_URL_PUBLIC_INTERFACE') ? getDolGlobalString('TICKET_URL_PUBLIC_INTERFACE') . '/document.php' : dol_buildpath('/public/ticket/document.php', 2);
 
                  global $dolibarr_main_instance_unique_id;
                  $securekey = dol_hash('dolibarr-'.$file_relative_path.'-'.$dolibarr_main_instance_unique_id, 'sha256');
                  $doclink = $downloadwrapper.'?modulepart='.$modulepart.'&attachment=0&entity='.getEntity('ticket', 0).'&securekey='.urlencode($securekey).'&file='.urlencode($file_relative_path);
                }
 
                $mimeAttr = ' mime="'.$mime.'" ';
                $class = '';
                if (in_array($mime, array('image/png', 'image/jpeg', 'application/pdf'))) {
                  $class .= ' documentpreview';
                }
 
                $footer .= '<a href="'.$doclink.'" class="btn-link '.$class.'" target="_blank"  '.$mimeAttr.' >';
                $footer .= img_mime($filePath).' '.$doc->filename;
                $footer .= '</a>';
 
                $footer .= '</span>';
              }
            }
            $footer .= '</div>';
            if ($isshared == 1) {
              print '<br>';
              print '<br>';
              print $footer;
            }
          }
          print '</td>';
          print '</tr>';
        }
        $ticket_message_nr++;
      }
 
      print '</table>';
      print '</div>';
      print '</div>';
    } else {
      print '<div class="ticketpublicarea ticketlargemargin">';
      print '<div class="info">'.$langs->trans('NoMsgForThisTicket').'</div>';
      print '</div>';
    }
  }
 
  public function viewTicketTimelineMessages($show_private, $show_author, Ticket $object)
  {
    global $langs;
 
    // Load logs in cache
    $object->loadCacheMsgsTicket();
 
    if (is_array($object->cache_msgs_ticket) && count($object->cache_msgs_ticket) > 0) {
      print '<section id="cd-timeline">';
 
      foreach ($object->cache_msgs_ticket as $id => $arraymsgs) {
        if (!$arraymsgs['private']
          || ($arraymsgs['private'] == "1" && $show_private)
        ) {
          print '<div class="cd-timeline-block">';
          print '<div class="cd-timeline-img">';
          print '<img src="img/messages.png" alt="">';
          print '</div> <!-- cd-timeline-img -->';
 
          print '<div class="cd-timeline-content">';
          print $arraymsgs['message'];
 
          print '<span class="cd-date">';
          print dol_print_date($arraymsgs['datec'], 'dayhour');
 
          if ($show_author) {
            if ($arraymsgs['fk_user_action'] > 0) {
              $userstat = new User($this->db);
              $res = $userstat->fetch($arraymsgs['fk_user_action']);
              if ($res) {
                print '<br>';
                print $userstat->getNomUrl(1);
              }
            } else {
              print '<br>';
              print $langs->trans('Customer');
            }
          }
          print '</span>';
          print '</div> <!-- cd-timeline-content -->';
          print '</div> <!-- cd-timeline-block -->';
        }
      }
      print '</section>';
    } else {
      print '<div class="info">'.$langs->trans('NoMsgForThisTicket').'</div>';
    }
  }
 
  public function viewStatusActions(Ticket $object)
  {
    global $langs;
 
    print '<div class="div-table-responsive-no-min margintoponly navBarForStatus">';
    print '<div class="centpercent right">';
    // Exclude status which requires specific method
    $exclude_status = array(Ticket::STATUS_CLOSED, Ticket::STATUS_CANCELED);
    // Exclude actual status
    $exclude_status = array_merge($exclude_status, array((int) $object->status));
    // Exclude also the Waiting/Pending/Suspended status
    if (!getDolGlobalString('TICKET_INCLUDE_SUSPENDED_STATUS')) {
      $exclude_status[] = $object::STATUS_WAITING;
    }
 
    // Sort results to be similar to status object list
    //sort($exclude_status);
 
    foreach ($object->labelStatusShort as $status => $status_label) {
      if (!in_array($status, $exclude_status)) {
        print '<div class="inline-block center margintoponly marginbottomonly">';
 
        if ($status == 1) {
          $urlforbutton = $_SERVER['PHP_SELF'].'?track_id='.$object->track_id.'&action=set_read&token='.newToken(); // To set as read, we use a dedicated action
        } else {
          $urlforbutton = $_SERVER['PHP_SELF'].'?track_id='.$object->track_id.'&action=confirm_set_status&token='.newToken().'&new_status='.((int) $status);
        }
 
        print '<a class="butAction butStatus marginbottomonly" href="'.$urlforbutton.'">';
        print $object->LibStatut($status, 3, 1).' ';
        //print img_picto($langs->trans($object->labelStatusShort[$status]), 'statut'.$status.'.png@ticket', '', 0, 0, 0, '', 'valignmiddle').' ';
        print $langs->trans($object->labelStatusShort[$status]);
        print '</a>';
        print '</div>';
      }
    }
    print '</div>';
    print '</div>';
    print '<br>';
  }
}