dolibarr  19.0.0-dev
modTicket.class.php
Go to the documentation of this file.
1 <?php
2 /* Copyright (C) - 2013-2018 Jean-François FERRY <hello@librethic.io>
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation, either version 3 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program. If not, see <https://www.gnu.org/licenses/>.
16  *
17  * Module descriptor for ticket system
18  */
19 
27 require_once DOL_DOCUMENT_ROOT."/core/modules/DolibarrModules.class.php";
28 
29 
34 {
40  public function __construct($db)
41  {
42  global $langs, $conf;
43  $langs->load("ticket");
44 
45  $this->db = $db;
46 
47  // Id for module (must be unique).
48  // Use a free id here
49  // (See in Home -> System information -> Dolibarr for list of used modules id).
50  $this->numero = 56000;
51  // Key text used to identify module (for permissions, menus, etc...)
52  $this->rights_class = 'ticket';
53 
54  // Family can be 'crm','financial','hr','projects','products','ecm','technic','other'
55  // It is used to group modules in module setup page
56  $this->family = "crm";
57  // Module position in the family
58  $this->module_position = '60';
59  // Module label (no space allowed)
60  // used if translation string 'ModuleXXXName' not found
61  // (where XXX is value of numeric property 'numero' of module)
62  $this->name = preg_replace('/^mod/i', '', get_class($this));
63  // Module description
64  // used if translation string 'ModuleXXXDesc' not found
65  // (where XXX is value of numeric property 'numero' of module)
66  $this->description = "Incident/support ticket management";
67  // Possible values for version are: 'development', 'experimental' or version
68  $this->version = 'dolibarr';
69  // Key used in llx_const table to save module status enabled/disabled
70  // (where MYMODULE is value of property name of module in uppercase)
71  $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
72  // Name of image file used for this module.
73  // If file is in theme/yourtheme/img directory under name object_pictovalue.png
74  // use this->picto='pictovalue'
75  // If file is in module/img directory under name object_pictovalue.png
76  // use this->picto='pictovalue@module'
77  $this->picto = 'ticket'; // mypicto@ticket
78  // Defined all module parts (triggers, login, substitutions, menus, css, etc...)
79  // for default path (eg: /ticket/core/xxxxx) (0=disable, 1=enable)
80  // for specific path of parts (eg: /ticket/core/modules/barcode)
81  // for specific css file (eg: /ticket/css/ticket.css.php)
82  $this->module_parts = array(
83  // Set this to 1 if module has its own trigger directory
84  'triggers' => 1,
85  );
86 
87  // Data directories to create when module is enabled.
88  // Example: this->dirs = array("/ticket/temp");
89  $this->dirs = array();
90 
91  // Config pages. Put here list of php pages
92  // stored into ticket/admin directory, used to setup module.
93  $this->config_page_url = array("ticket.php");
94 
95  // Dependencies
96  $this->hidden = false; // A condition to hide module
97  $this->depends = array('modAgenda'); // List of module class names as string that must be enabled if this module is enabled
98  $this->requiredby = array(); // List of module ids to disable if this one is disabled
99  $this->conflictwith = array(); // List of module class names as string this module is in conflict with
100  $this->phpmin = array(7, 0); // Minimum version of PHP required by module
101  $this->langfiles = array("ticket");
102 
103  // Constants
104  // List of particular constants to add when module is enabled
105  // (key, 'chaine', value, desc, visible, 'current' or 'allentities', deleteonunactive)
106  // Example:
107  $default_footer = $langs->trans('TicketMessageMailFooterText', getDolGlobalString('MAIN_INFO_SOCIETE_NOM'));
108  $this->const = array(
109  1 => array('TICKET_ENABLE_PUBLIC_INTERFACE', 'chaine', '0', 'Enable ticket public interface', 0),
110  2 => array('TICKET_ADDON', 'chaine', 'mod_ticket_simple', 'Ticket ref module', 0),
111  3 => array('TICKET_ADDON_PDF_ODT_PATH', 'chaine', 'DOL_DATA_ROOT/doctemplates/tickets', 'Ticket templates ODT/ODS directory for templates', 0),
112  4 => array('TICKET_AUTO_READ_WHEN_CREATED_FROM_BACKEND', 'chaine', 0, 'Automatically mark ticket as read when created from backend', 0),
113  5 => array('TICKET_DELAY_BEFORE_FIRST_RESPONSE', 'chaine', '0', 'Maximum wanted elapsed time before a first answer to a ticket (in hours). Display a warning in tickets list if not respected.', 0),
114  6 => array('TICKET_DELAY_SINCE_LAST_RESPONSE', 'chaine', '0', 'Maximum wanted elapsed time between two answers on the same ticket (in hours). Display a warning in tickets list if not respected.', 0),
115  7 => array('TICKET_NOTIFY_AT_CLOSING', 'chaine', '0', 'Default notify contacts when closing a module', 0),
116  8 => array('TICKET_PRODUCT_CATEGORY', 'chaine', 0, 'The category of product that is being used for ticket accounting', 0),
117  9 => array('TICKET_NOTIFICATION_EMAIL_FROM', 'chaine', getDolGlobalString('MAIN_MAIL_EMAIL_FROM'), 'Email to use by default as sender for messages sent from Dolibarr', 0),
118  10 => array('TICKET_MESSAGE_MAIL_INTRO', 'chaine', $langs->trans('TicketMessageMailIntroText'), 'Introduction text of ticket replies sent from Dolibarr', 0),
119  11 => array('TICKET_MESSAGE_MAIL_SIGNATURE', 'chaine', $default_footer, 'Signature to use by default for messages sent from Dolibarr', 0),
120  12 => array('MAIN_EMAILCOLLECTOR_MAIL_WITHOUT_HEADER', 'chaine', "1", 'Disable the rendering of headers in tickets', 0),
121  13 => array('MAIN_SECURITY_ENABLECAPTCHA_TICKET', 'chaine', getDolGlobalInt('MAIN_SECURITY_ENABLECAPTCHA_TICKET'), 'Enable captcha code by default', 0),
122  14 => array('TICKET_SHOW_COMPANY_LOGO', 'chaine', getDolGlobalInt('TICKET_SHOW_COMPANY_LOGO'), 'Enable logo header on ticket public page', 0),
123  15 => array('TICKET_SHOW_COMPANY_FOOTER', 'chaine', getDolGlobalInt('TICKET_SHOW_COMPANY_FOOTER'), 'Enable footer on ticket public page', 0)
124  );
125 
126 
127  $this->tabs = array(
128  'thirdparty:+ticket:Tickets:ticket:$user->rights->ticket->read:/ticket/list.php?socid=__ID__',
129  );
130 
131  // Dictionaries
132  if (!isset($conf->ticket->enabled)) {
133  $conf->ticket = new stdClass();
134  $conf->ticket->enabled = 0;
135  }
136  $this->dictionaries = array(
137  'langs' => 'ticket',
138  'tabname' => array(
139  "c_ticket_type",
140  "c_ticket_severity",
141  "c_ticket_category",
142  "c_ticket_resolution"
143  ),
144  'tablib' => array(
145  "TicketDictType",
146  "TicketDictSeverity",
147  "TicketDictCategory",
148  "TicketDictResolution"
149  ),
150  'tabsql' => array(
151  'SELECT f.rowid as rowid, f.code, f.pos, f.label, f.active, f.use_default FROM '.MAIN_DB_PREFIX.'c_ticket_type as f',
152  'SELECT f.rowid as rowid, f.code, f.pos, f.label, f.active, f.use_default FROM '.MAIN_DB_PREFIX.'c_ticket_severity as f',
153  'SELECT f.rowid as rowid, f.code, f.pos, f.label, f.active, f.use_default, f.public, f.fk_parent FROM '.MAIN_DB_PREFIX.'c_ticket_category as f',
154  'SELECT f.rowid as rowid, f.code, f.pos, f.label, f.active, f.use_default FROM '.MAIN_DB_PREFIX.'c_ticket_resolution as f'
155  ),
156  'tabsqlsort' => array("pos ASC", "pos ASC", "pos ASC", "pos ASC"),
157  'tabfield' => array("code,label,pos,use_default", "code,label,pos,use_default", "code,label,pos,use_default,public,fk_parent", "code,label,pos,use_default"),
158  'tabfieldvalue' => array("code,label,pos,use_default", "code,label,pos,use_default", "code,label,pos,use_default,public,fk_parent", "code,label,pos,use_default"),
159  'tabfieldinsert' => array("code,label,pos,use_default", "code,label,pos,use_default", "code,label,pos,use_default,public,fk_parent", "code,label,pos,use_default"),
160  'tabrowid' => array("rowid", "rowid", "rowid", "rowid"),
161  'tabcond' => array(isModEnabled("ticket"), isModEnabled("ticket"), isModEnabled("ticket"), isModEnabled("ticket") && getDolGlobalString('TICKET_ENABLE_RESOLUTION')),
162  'tabhelp' => array(
163  array('code'=>$langs->trans("EnterAnyCode"), 'use_default'=>$langs->trans("Enter0or1")),
164  array('code'=>$langs->trans("EnterAnyCode"), 'use_default'=>$langs->trans("Enter0or1")),
165  array('code'=>$langs->trans("EnterAnyCode"), 'use_default'=>$langs->trans("Enter0or1"), 'public'=>$langs->trans("Enter0or1").'<br>'.$langs->trans("TicketGroupIsPublicDesc"), 'fk_parent'=>$langs->trans("IfThisCategoryIsChildOfAnother")),
166  array('code'=>$langs->trans("EnterAnyCode"), 'use_default'=>$langs->trans("Enter0or1"))
167  ),
168  );
169 
170  // Boxes
171  // Add here list of php file(s) stored in core/boxes that contains class to show a box.
172  $this->boxes = array(
173  0=>array('file'=>'box_last_ticket.php', 'enabledbydefaulton'=>'Home'),
174  1=>array('file'=>'box_last_modified_ticket.php', 'enabledbydefaulton'=>'Home'),
175  2=>array('file'=>'box_ticket_by_severity.php', 'enabledbydefaulton'=>'ticketindex'),
176  3=>array('file'=>'box_graph_nb_ticket_last_x_days.php', 'enabledbydefaulton'=>'ticketindex'),
177  4=>array('file'=>'box_graph_nb_tickets_type.php', 'enabledbydefaulton'=>'ticketindex'),
178  5=>array('file'=>'box_new_vs_close_ticket.php', 'enabledbydefaulton'=>'ticketindex')
179  ); // Boxes list
180 
181  // Permissions
182  $this->rights = array(); // Permission array used by this module
183 
184  $r = 0;
185  $this->rights[$r][0] = 56001; // id de la permission
186  $this->rights[$r][1] = "Read ticket"; // libelle de la permission
187  $this->rights[$r][2] = 'r'; // type de la permission (deprecie a ce jour)
188  $this->rights[$r][3] = 0; // La permission est-elle une permission par defaut
189  $this->rights[$r][4] = 'read';
190 
191  $r++;
192  $this->rights[$r][0] = 56002; // id de la permission
193  $this->rights[$r][1] = "Create les tickets"; // libelle de la permission
194  $this->rights[$r][2] = 'w'; // type de la permission (deprecie a ce jour)
195  $this->rights[$r][3] = 0; // La permission est-elle une permission par defaut
196  $this->rights[$r][4] = 'write';
197 
198  $r++;
199  $this->rights[$r][0] = 56003; // id de la permission
200  $this->rights[$r][1] = "Delete les tickets"; // libelle de la permission
201  $this->rights[$r][2] = 'd'; // type de la permission (deprecie a ce jour)
202  $this->rights[$r][3] = 0; // La permission est-elle une permission par defaut
203  $this->rights[$r][4] = 'delete';
204 
205  $r++;
206  $this->rights[$r][0] = 56004; // id de la permission
207  $this->rights[$r][1] = "Manage tickets"; // libelle de la permission
208  //$this->rights[$r][2] = 'd'; // type de la permission (deprecie a ce jour)
209  $this->rights[$r][3] = 0; // La permission est-elle une permission par defaut
210  $this->rights[$r][4] = 'manage';
211 
212  $r++;
213  $this->rights[$r][0] = 56006; // id de la permission
214  $this->rights[$r][1] = "Export ticket"; // libelle de la permission
215  //$this->rights[$r][2] = 'd'; // type de la permission (deprecie a ce jour)
216  $this->rights[$r][3] = 0; // La permission est-elle une permission par defaut
217  $this->rights[$r][4] = 'export';
218 
219  /* Seems not used and in conflict with societe->client->voir (see all thirdparties)
220  $r++;
221  $this->rights[$r][0] = 56005; // id de la permission
222  $this->rights[$r][1] = 'See all tickets, even if not assigned to (not effective for external users, always restricted to the thirdpardy they depends on)'; // libelle de la permission
223  $this->rights[$r][2] = 'r'; // type de la permission (deprecie a ce jour)
224  $this->rights[$r][3] = 0; // La permission est-elle une permission par defaut
225  $this->rights[$r][4] = 'view';
226  $this->rights[$r][5] = 'all';
227  */
228 
229  // Main menu entries
230  $this->menu = array(); // List of menus to add
231  $r = 0;
232 
233  /*$this->menu[$r] = array('fk_menu' => 0, // Put 0 if this is a top menu
234  'type' => 'top', // This is a Top menu entry
235  'titre' => 'Ticket',
236  'prefix' => img_picto('', $this->picto, 'class="paddingright pictofixedwidth em092"'),
237  'mainmenu' => 'ticket',
238  'leftmenu' => '1', // Use 1 if you also want to add left menu entries using this descriptor.
239  'url' => '/ticket/index.php',
240  'langs' => 'ticket', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
241  'position' => 88,
242  'enabled' => 'isModEnabled("ticket")',
243  'perms' => '$user->rights->ticket->read', // Use 'perms'=>'$user->rights->ticket->level1->level2' if you want your menu with a permission rules
244  'target' => '',
245  'user' => 2); // 0=Menu for internal users, 1=external users, 2=both
246  $r++;*/
247 
248  $this->menu[$r] = array('fk_menu' => 'fk_mainmenu=ticket',
249  'type' => 'left',
250  'titre' => 'Ticket',
251  'prefix' => img_picto('', $this->picto, 'class="paddingright pictofixedwidth em092"'),
252  'mainmenu' => 'ticket',
253  'leftmenu' => 'ticket',
254  'url' => '/ticket/index.php',
255  'langs' => 'ticket',
256  'position' => 101,
257  'enabled' => 'isModEnabled("ticket")',
258  'perms' => '$user->rights->ticket->read',
259  'target' => '',
260  'user' => 2);
261  $r++;
262 
263  $this->menu[$r] = array('fk_menu' => 'fk_mainmenu=ticket,fk_leftmenu=ticket',
264  'type' => 'left',
265  'titre' => 'NewTicket',
266  'mainmenu' => 'ticket',
267  'url' => '/ticket/card.php?action=create',
268  'langs' => 'ticket',
269  'position' => 102,
270  'enabled' => 'isModEnabled("ticket")',
271  'perms' => '$user->rights->ticket->write',
272  'target' => '',
273  'user' => 2);
274  $r++;
275 
276  $this->menu[$r] = array('fk_menu' => 'fk_mainmenu=ticket,fk_leftmenu=ticket',
277  'type' => 'left',
278  'titre' => 'List',
279  'mainmenu' => 'ticket',
280  'leftmenu' => 'ticketlist',
281  'url' => '/ticket/list.php?search_fk_status=non_closed',
282  'langs' => 'ticket',
283  'position' => 103,
284  'enabled' => 'isModEnabled("ticket")',
285  'perms' => '$user->rights->ticket->read',
286  'target' => '',
287  'user' => 2);
288  $r++;
289 
290  $this->menu[$r] = array('fk_menu' => 'fk_mainmenu=ticket,fk_leftmenu=ticket',
291  'type' => 'left',
292  'titre' => 'MenuTicketMyAssign',
293  'mainmenu' => 'ticket',
294  'leftmenu' => 'ticketmy',
295  'url' => '/ticket/list.php?mode=mine&search_fk_status=non_closed',
296  'langs' => 'ticket',
297  'position' => 105,
298  'enabled' => 'isModEnabled("ticket")',
299  'perms' => '$user->rights->ticket->read',
300  'target' => '',
301  'user' => 0);
302  $r++;
303 
304  $this->menu[$r] = array('fk_menu' => 'fk_mainmenu=ticket,fk_leftmenu=ticket',
305  'type' => 'left',
306  'titre' => 'Statistics',
307  'mainmenu' => 'ticket',
308  'url' => '/ticket/stats/index.php',
309  'langs' => 'ticket',
310  'position' => 107,
311  'enabled' => 'isModEnabled("ticket")',
312  'perms' => '$user->rights->ticket->read',
313  'target' => '',
314  'user' => 0);
315  $r++;
316 
317  $this->menu[$r] = array('fk_menu' => 'fk_mainmenu=ticket,fk_leftmenu=ticket',
318  'type' => 'left',
319  'titre' => 'Categories',
320  'mainmenu' => 'ticket',
321  'url' => '/categories/index.php?type=12',
322  'langs' => 'ticket',
323  'position' => 107,
324  'enabled' => '$conf->categorie->enabled',
325  'perms' => '$user->rights->ticket->read',
326  'target' => '',
327  'user' => 0);
328  $r++;
329 
330  // Exports
331  //--------
332  $r = 1;
333 
334  // Export list of tickets and attributes
335  $langs->load("ticket");
336  $this->export_code[$r]=$this->rights_class.'_'.$r;
337  $this->export_label[$r]='ExportDataset_ticket_1'; // Translation key (used only if key ExportDataset_xxx_z not found)
338  $this->export_permission[$r] = array(array("ticket", "export"));
339  $this->export_icon[$r]='ticket';
340  $keyforclass = 'Ticket';$keyforclassfile='/ticket/class/ticket.class.php';$keyforelement='ticket';
341  include DOL_DOCUMENT_ROOT.'/core/commonfieldsinexport.inc.php';
342  $keyforselect='ticket'; $keyforaliasextra='extra'; $keyforelement='ticket';
343  include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
344  $this->export_sql_start[$r]='SELECT DISTINCT ';
345  $this->export_sql_end[$r] =' FROM '.MAIN_DB_PREFIX.'ticket as t';
346  $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'ticket_extrafields as extra on (t.rowid = extra.fk_object)';
347  $this->export_sql_end[$r] .=' WHERE 1 = 1';
348  $this->export_sql_end[$r] .=' AND t.entity IN ('.getEntity('ticket').')';
349  $r++;
350  }
351 
360  public function init($options = '')
361  {
362  global $conf, $langs;
363 
364  $result = $this->_load_tables('/install/mysql/', 'ticket');
365  if ($result < 0) {
366  return -1; // Do not activate module if error 'not allowed' returned when loading module SQL queries (the _load_table run sql with run_sql with the error allowed parameter set to 'default')
367  }
368 
369  // Permissions
370  $this->remove($options);
371 
372  //ODT template
373  $src = DOL_DOCUMENT_ROOT.'/install/doctemplates/tickets/template_ticket.odt';
374  $dirodt = DOL_DATA_ROOT.'/doctemplates/tickets';
375  $dest = $dirodt.'/template_order.odt';
376 
377  if (file_exists($src) && !file_exists($dest)) {
378  require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
379  dol_mkdir($dirodt);
380  $result = dol_copy($src, $dest, 0, 0);
381  if ($result < 0) {
382  $langs->load("errors");
383  $this->error = $langs->trans('ErrorFailToCopyFile', $src, $dest);
384  return 0;
385  }
386  }
387 
388  $sql = array(
389  array("sql" => "insert into llx_c_type_contact(rowid, element, source, code, libelle, active ) values (110120, 'ticket', 'internal', 'SUPPORTTEC', 'Utilisateur assigné au ticket', 1);", "ignoreerror" => 1),
390  array("sql" => "insert into llx_c_type_contact(rowid, element, source, code, libelle, active ) values (110121, 'ticket', 'internal', 'CONTRIBUTOR', 'Intervenant', 1);", "ignoreerror" => 1),
391  array("sql" => "insert into llx_c_type_contact(rowid, element, source, code, libelle, active ) values (110122, 'ticket', 'external', 'SUPPORTCLI', 'Contact client suivi incident', 1);", "ignoreerror" => 1),
392  array("sql" => "insert into llx_c_type_contact(rowid, element, source, code, libelle, active ) values (110123, 'ticket', 'external', 'CONTRIBUTOR', 'Intervenant', 1);", "ignoreerror" => 1),
393  "DELETE FROM ".MAIN_DB_PREFIX."document_model WHERE nom = 'TICKET_ADDON_PDF_ODT_PATH' AND type = 'ticket' AND entity = ".((int) $conf->entity),
394  "INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES('TICKET_ADDON_PDF_ODT_PATH','ticket',".((int) $conf->entity).")"
395  );
396 
397  return $this->_init($sql, $options);
398  }
399 }
Class DolibarrModules.
_init($array_sql, $options='')
Enables a module.
_load_tables($reldir, $onlywithsuffix='')
Create tables and keys required by module:
Description and activation class for module Ticket.
init($options='')
Function called when module is enabled.
__construct($db)
Constructor.
if(isModEnabled('facture') && $user->hasRight('facture', 'lire')) if((isModEnabled('fournisseur') &&empty($conf->global->MAIN_USE_NEW_SUPPLIERMOD) && $user->hasRight("fournisseur", "facture", "lire"))||(isModEnabled('supplier_invoice') && $user->hasRight("supplier_invoice", "lire"))) if(isModEnabled('don') && $user->hasRight('don', 'lire')) if(isModEnabled('tax') &&!empty($user->rights->tax->charges->lire)) if(isModEnabled('facture') &&isModEnabled('commande') && $user->hasRight("commande", "lire") &&empty($conf->global->WORKFLOW_DISABLE_CREATE_INVOICE_FROM_ORDER)) $sql
Social contributions to pay.
Definition: index.php:746
print *****$script_file(".$version.") pid cd cd cd description as description
Only used if Module[ID]Desc translation string is not found.
dol_copy($srcfile, $destfile, $newmask=0, $overwriteifexists=1, $testvirus=0, $indexdatabase=0)
Copy a file to another file.
Definition: files.lib.php:717
getDolGlobalInt($key, $default=0)
Return dolibarr global constant int value.
img_picto($titlealt, $picto, $moreatt='', $pictoisfullpath=false, $srconly=0, $notitle=0, $alt='', $morecss='', $marginleftonlyshort=2)
Show picto whatever it's its name (generic function)
getDolGlobalString($key, $default='')
Return dolibarr global constant string value.
isModEnabled($module)
Is Dolibarr module enabled.
dol_mkdir($dir, $dataroot='', $newmask='')
Creation of a directory (this can create recursive subdir)
$conf db name
Only used if Module[ID]Name translation string is not found.
Definition: repair.php:123