dolibarr 19.0.3
actions_ticket.class.php
Go to the documentation of this file.
1<?php
2/* Copyright (C) 2013-2015 Jean-François FERRY <hello@librethic.io>
3 * Copyright (C) 2016 Christophe Battarel <christophe@altairis.fr>
4 * Copyright (C) 2024 Destailleur Laurent <eldy@users.sourceforge.net>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 */
20
27require_once DOL_DOCUMENT_ROOT.'/ticket/class/ticket.class.php';
28require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
29require_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';
30require_once DOL_DOCUMENT_ROOT.'/contact/class/contact.class.php';
31require_once DOL_DOCUMENT_ROOT.'/contrat/class/contrat.class.php';
32require_once DOL_DOCUMENT_ROOT.'/fichinter/class/fichinter.class.php';
33require_once DOL_DOCUMENT_ROOT.'/core/class/commonhookactions.class.php';
34
35// TODO Only the last method emailElementlist is a hook method. Other must be moved into standard ticket.class.php
36
37
42{
46 public $db;
47
51 public $dao;
52
53 public $mesg;
54
58 public $error;
59
63 public $errors = array();
64
66 public $errno = 0;
67
68 public $template_dir;
69 public $template;
70
74 public $label;
75
79 public $description;
80
84 public $fk_statut;
85
89 public $fk_soc;
90
91
97 public function __construct($db)
98 {
99 $this->db = $db;
100 }
101
107 public function getInstanceDao()
108 {
109 if (!is_object($this->dao)) {
110 $this->dao = new Ticket($this->db);
111 }
112 }
113
122 public function fetch($id = 0, $ref = '', $track_id = '')
123 {
124 $this->getInstanceDao();
125 return $this->dao->fetch($id, $ref, $track_id);
126 }
127
134 public function getLibStatut($mode = 0)
135 {
136 $this->getInstanceDao();
137 $this->dao->fk_statut = $this->fk_statut;
138 return $this->dao->getLibStatut($mode);
139 }
140
147 public function getInfo($id)
148 {
149 $this->getInstanceDao();
150 $this->dao->fetch($id);
151
152 $this->label = $this->dao->label;
153 $this->description = $this->dao->description;
154 }
155
162 public function getTitle($action = '')
163 {
164 global $langs;
165
166 if ($action == 'create') {
167 return $langs->trans("CreateTicket");
168 } elseif ($action == 'edit') {
169 return $langs->trans("EditTicket");
170 } elseif ($action == 'view') {
171 return $langs->trans("TicketCard");
172 } elseif ($action == 'add_message') {
173 return $langs->trans("TicketAddMessage");
174 } else {
175 return $langs->trans("TicketsManagement");
176 }
177 }
178
187 public function viewTicketOriginalMessage($user, $action, $object)
188 {
189 global $conf, $langs;
190
191 print '<!-- initial message of ticket -->'."\n";
192 if ($user->hasRight('ticket', 'manage') && $action == 'edit_message_init') {
193 // MESSAGE
194 print '<form action="'.$_SERVER['PHP_SELF'].'" method="post">';
195 print '<input type="hidden" name="token" value="'.newToken().'">';
196 print '<input type="hidden" name="track_id" value="'.$object->track_id.'">';
197 print '<input type="hidden" name="action" value="set_message">';
198 }
199
200 // Initial message
201 print '<div class="div-table-responsive-no-min">'; // You can use div-table-responsive-no-min if you dont need reserved height for your table
202 print '<table class="noborder centpercent margintable margintable">';
203 print '<tr class="liste_titre trforfield"><td class="nowrap titlefield">';
204 print $langs->trans("InitialMessage");
205 print '</td><td>';
206 if ($user->hasRight("ticket", "manage")) {
207 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>';
208 }
209 print '</td></tr>';
210
211 print '<tr>';
212 print '<td colspan="2">';
213 if ($user->hasRight('ticket', 'manage') && $action == 'edit_message_init') {
214 // MESSAGE
215 $msg = GETPOSTISSET('message_initial') ? GETPOST('message_initial', 'restricthtml') : $object->message;
216 include_once DOL_DOCUMENT_ROOT.'/core/class/doleditor.class.php';
217 $uselocalbrowser = true;
218 $ckeditorenabledforticket = getDolGlobalString('FCKEDITOR_ENABLE_TICKET');
219 $doleditor = new DolEditor('message_initial', $msg, '100%', 250, 'dolibarr_details', 'In', true, $uselocalbrowser, $ckeditorenabledforticket, ROWS_9, '95%');
220 $doleditor->Create();
221 } else {
222 print '<div class="longmessagecut">';
223 //print dol_escape_htmltag(dol_htmlwithnojs(dol_string_onlythesehtmltags(dol_htmlentitiesbr($object->message), 1, 1, 1, 0)), 1, 1, 'common', 0, 1);
224 print dolPrintHTML($object->message);
225 print '</div>';
226 /*print '<div class="clear center">';
227 print $langs->trans("More").'...';
228 print '</div>';*/
229
230 //print '<div>' . $object->message . '</div>';
231 }
232 if ($user->hasRight('ticket', 'manage') && $action == 'edit_message_init') {
233 print '<div class="center">';
234 print ' <input type="submit" class="button button-edit" value="'.$langs->trans('Modify').'">';
235 print ' <input type="submit" class="button button-cancel" name="cancel" value="'.$langs->trans("Cancel").'">';
236 print '</div>';
237 }
238 print '</td>';
239 print '</tr>';
240 print '</table>';
241 print '</div>';
242
243 if ($user->hasRight('ticket', 'manage') && $action == 'edit_message_init') {
244 // MESSAGE
245 print '</form>';
246 }
247 }
248
257 public function viewTicketMessages($show_private, $show_user, $object)
258 {
259 global $langs, $user;
260
261 // Load logs in cache
262 $ret = $this->dao->loadCacheMsgsTicket();
263 if ($ret < 0) {
264 dol_print_error($this->dao->db);
265 }
266
267 $action = GETPOST('action', 'aZ09');
268
269 print '<div class="ticketpublicarea ticketlargemargin centpercent" style="padding-top: 0">';
270 $this->viewTicketOriginalMessage($user, $action, $object);
271 print '</div>';
272
273 if (is_array($this->dao->cache_msgs_ticket) && count($this->dao->cache_msgs_ticket) > 0) {
274 print '<div class="ticketpublicarea ticketlargemargin centpercent">';
275
276 print '<div class="div-table-responsive-no-min">';
277 print '<table class="border centpercent">';
278
279 print '<tr class="liste_titre">';
280
281 print '<td>';
282 print $langs->trans('TicketMessagesList');
283 print '</td>';
284
285 if ($show_user) {
286 print '<td>';
287 print $langs->trans('User');
288 print '</td>';
289 }
290 print '</tr>';
291
292 foreach ($this->dao->cache_msgs_ticket as $id => $arraymsgs) {
293 if (!$arraymsgs['private']
294 || ($arraymsgs['private'] == "1" && $show_private)
295 ) {
296 //print '<tr>';
297 print '<tr class="oddeven">';
298 print '<td><strong>';
299 print img_picto('', 'object_action', 'class="paddingright"').dol_print_date($arraymsgs['datep'], 'dayhour');
300 print '<strong></td>';
301 if ($show_user) {
302 print '<td>';
303 if ($arraymsgs['fk_user_author'] > 0) {
304 $userstat = new User($this->db);
305 $res = $userstat->fetch($arraymsgs['fk_user_author']);
306 if ($res) {
307 print $userstat->getNomUrl(0);
308 }
309 } elseif (isset($arraymsgs['fk_contact_author'])) {
310 $contactstat = new Contact($this->db);
311 $res = $contactstat->fetch(0, null, '', $arraymsgs['fk_contact_author']);
312 if ($res) {
313 print $contactstat->getNomUrl(0, 'nolink');
314 } else {
315 print $arraymsgs['fk_contact_author'];
316 }
317 } else {
318 print $langs->trans('Customer');
319 }
320 print '</td>';
321 }
322 print '</td>';
323 print '<tr class="oddeven">';
324 print '<td colspan="2">';
325 print $arraymsgs['message'];
326
327 //attachment
328
329 $documents = array();
330
331 $sql = 'SELECT ecm.rowid as id, ecm.src_object_type, ecm.src_object_id';
332 $sql .= ', ecm.filepath, ecm.filename, ecm.share';
333 $sql .= ' FROM '.MAIN_DB_PREFIX.'ecm_files ecm';
334 $sql .= " WHERE ecm.filepath = 'agenda/".$arraymsgs['id']."'";
335 $sql .= ' ORDER BY ecm.position ASC';
336
337 $resql = $this->db->query($sql);
338 if ($resql) {
339 if ($this->db->num_rows($resql)) {
340 while ($obj = $this->db->fetch_object($resql)) {
341 $documents[$obj->id] = $obj;
342 }
343 }
344 }
345 if (!empty($documents)) {
346 $isshared = 0;
347 $footer = '<div class="timeline-documents-container">';
348 foreach ($documents as $doc) {
349 if (!empty($doc->share)) {
350 $isshared = 1;
351 $footer .= '<span id="document_'.$doc->id.'" class="timeline-documents" ';
352 $footer .= ' data-id="'.$doc->id.'" ';
353 $footer .= ' data-path="'.$doc->filepath.'"';
354 $footer .= ' data-filename="'.dol_escape_htmltag($doc->filename).'" ';
355 $footer .= '>';
356
357 $filePath = DOL_DATA_ROOT.'/'.$doc->filepath.'/'.$doc->filename;
358 $mime = dol_mimetype($filePath);
359 $thumb = $arraymsgs['id'].'/thumbs/'.substr($doc->filename, 0, strrpos($doc->filename, '.')).'_mini'.substr($doc->filename, strrpos($doc->filename, '.'));
360 $doclink = DOL_URL_ROOT.'/document.php?hashp='.urlencode($doc->share);
361
362 $mimeAttr = ' mime="'.$mime.'" ';
363 $class = '';
364 if (in_array($mime, array('image/png', 'image/jpeg', 'application/pdf'))) {
365 $class .= ' documentpreview';
366 }
367
368 $footer .= '<a href="'.$doclink.'" class="btn-link '.$class.'" target="_blank" '.$mimeAttr.' >';
369 $footer .= img_mime($filePath).' '.$doc->filename;
370 $footer .= '</a>';
371
372 $footer .= '</span>';
373 }
374 }
375 $footer .= '</div>';
376 if ($isshared == 1) {
377 print '<br>';
378 print '<br>';
379 print $footer;
380 }
381 }
382 print '</td>';
383 print '</tr>';
384 }
385 }
386
387 print '</table>';
388 print '</div>';
389 print '</div>';
390 } else {
391 print '<div class="ticketpublicarea ticketlargemargin centpercent">';
392 print '<div class="info">'.$langs->trans('NoMsgForThisTicket').'</div>';
393 print '</div>';
394 }
395 }
396
405 public function viewTicketTimelineMessages($show_private, $show_user, Ticket $object)
406 {
407 global $conf, $langs, $user;
408
409 // Load logs in cache
410 $ret = $object->loadCacheMsgsTicket();
411 $action = GETPOST('action');
412
413 if (is_array($object->cache_msgs_ticket) && count($object->cache_msgs_ticket) > 0) {
414 print '<section id="cd-timeline">';
415
416 foreach ($object->cache_msgs_ticket as $id => $arraymsgs) {
417 if (!$arraymsgs['private']
418 || ($arraymsgs['private'] == "1" && $show_private)
419 ) {
420 print '<div class="cd-timeline-block">';
421 print '<div class="cd-timeline-img">';
422 print '<img src="img/messages.png" alt="">';
423 print '</div> <!-- cd-timeline-img -->';
424
425 print '<div class="cd-timeline-content">';
426 print $arraymsgs['message'];
427
428 print '<span class="cd-date">';
429 print dol_print_date($arraymsgs['datec'], 'dayhour');
430
431 if ($show_user) {
432 if ($arraymsgs['fk_user_action'] > 0) {
433 $userstat = new User($this->db);
434 $res = $userstat->fetch($arraymsgs['fk_user_action']);
435 if ($res) {
436 print '<br>';
437 print $userstat->getNomUrl(1);
438 }
439 } else {
440 print '<br>';
441 print $langs->trans('Customer');
442 }
443 }
444 print '</span>';
445 print '</div> <!-- cd-timeline-content -->';
446 print '</div> <!-- cd-timeline-block -->';
447 }
448 }
449 print '</section>';
450 } else {
451 print '<div class="info">'.$langs->trans('NoMsgForThisTicket').'</div>';
452 }
453 }
454
461 public function viewStatusActions(Ticket $object)
462 {
463 global $langs;
464
465 print '<div class="div-table-responsive-no-min margintoponly navBarForStatus">';
466 print '<div class="centpercent right">';
467 // Exclude status which requires specific method
468 $exclude_status = array(Ticket::STATUS_CLOSED, Ticket::STATUS_CANCELED);
469 // Exclude actual status
470 $exclude_status = array_merge($exclude_status, array(intval($object->fk_statut)));
471
472 // Sort results to be similar to status object list
473 //sort($exclude_status);
474
475 foreach ($object->labelStatusShort as $status => $status_label) {
476 if (!in_array($status, $exclude_status)) {
477 print '<div class="inline-block center marginbottomonly">';
478
479 if ($status == 1) {
480 $urlforbutton = $_SERVER['PHP_SELF'].'?track_id='.$object->track_id.'&action=set_read&token='.newToken(); // To set as read, we use a dedicated action
481 } else {
482 $urlforbutton = $_SERVER['PHP_SELF'].'?track_id='.$object->track_id.'&action=confirm_set_status&token='.newToken().'&new_status='.((int) $status);
483 }
484
485 print '<a class="butAction butStatus marginbottomonly" href="'.$urlforbutton.'">';
486 print $object->LibStatut($status, 3, 1).' ';
487 //print img_picto($langs->trans($object->labelStatusShort[$status]), 'statut'.$status.'.png@ticket', '', false, 0, 0, '', 'valignmiddle').' ';
488 print $langs->trans($object->labelStatusShort[$status]);
489 print '</a>';
490 print '</div>';
491 }
492 }
493 print '</div>';
494 print '</div>';
495 print '<br>';
496 }
497
507 public function emailElementlist($parameters, &$object, &$action, $hookmanager)
508 {
509 global $langs;
510
511 $error = 0;
512
513 if (in_array('admin', explode(':', $parameters['context']))) {
514 $this->results = array('ticket_send' => $langs->trans('MailToSendTicketMessage'));
515 }
516
517 if (!$error) {
518 return 0; // or return 1 to replace standard code
519 } else {
520 $this->errors[] = 'Error message';
521 return -1;
522 }
523 }
524}
Class Actions of the module ticket.
viewTicketMessages($show_private, $show_user, $object)
View html list of message for ticket.
getTitle($action='')
Get action title.
__construct($db)
Constructor.
emailElementlist($parameters, &$object, &$action, $hookmanager)
Hook to add email element template.
$errno
Numero de l'erreur.
fetch($id=0, $ref='', $track_id='')
Fetch object.
viewTicketOriginalMessage($user, $action, $object)
Show ticket original message.
viewTicketTimelineMessages($show_private, $show_user, Ticket $object)
View list of message for ticket with timeline display.
getInstanceDao()
Instantiation of DAO class.
getLibStatut($mode=0)
Print statut.
viewStatusActions(Ticket $object)
Print html navbar with link to set ticket status.
getInfo($id)
Get ticket info.
Parent class of all other hook actions classes.
Class to manage a WYSIWYG editor.
Class to manage Dolibarr users.
print $script_file $mode $langs defaultlang(is_numeric($duration_value) ? " delay=". $duration_value :"").(is_numeric($duration_value2) ? " after cd cd cd description as description
Only used if Module[ID]Desc translation string is not found.
dol_mimetype($file, $default='application/octet-stream', $mode=0)
Return MIME type of a file from its name with extension.
dolPrintHTML($s, $allowiframe=0)
Return a string ready to be output on HTML page To use text inside an attribute, you can simply use d...
dol_print_error($db='', $error='', $errors=null)
Displays error message system with all the information to facilitate the diagnosis and the escalation...
dol_print_date($time, $format='', $tzoutput='auto', $outputlangs='', $encodetooutput=false)
Output date in a string format according to outputlangs (or langs if not defined).
img_mime($file, $titlealt='', $morecss='')
Show MIME img of a file.
img_picto($titlealt, $picto, $moreatt='', $pictoisfullpath=false, $srconly=0, $notitle=0, $alt='', $morecss='', $marginleftonlyshort=2)
Show picto whatever it's its name (generic function)
GETPOST($paramname, $check='alphanohtml', $method=0, $filter=null, $options=null, $noreplace=0)
Return value of a param into GET or POST supervariable.
getDolGlobalString($key, $default='')
Return dolibarr global constant string value.
img_edit($titlealt='default', $float=0, $other='')
Show logo editer/modifier fiche.
Class to generate the form for creating a new ticket.
Contact()
Old copy.
Definition index.php:572