forked from Wavyzz/dolibarr
325 lines
16 KiB
PHP
325 lines
16 KiB
PHP
<?php
|
|
/* Copyright (C) - 2013-2018 Jean-François FERRY <hello@librethic.io>
|
|
*
|
|
* 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 <http://www.gnu.org/licenses/>.
|
|
*
|
|
* Module descriptor for ticket system
|
|
*/
|
|
|
|
/**
|
|
* \defgroup ticketsup Ticketsup module
|
|
* \brief Ticketsup module descriptor.
|
|
* \file core/modules/modTicketsup.class.php
|
|
* \ingroup ticketsup
|
|
* \brief Description and activation file for module Ticketsup
|
|
*/
|
|
require_once DOL_DOCUMENT_ROOT . "/core/modules/DolibarrModules.class.php";
|
|
|
|
|
|
/**
|
|
* Description and activation class for module Ticketsup
|
|
*/
|
|
class modTicketsup extends DolibarrModules
|
|
{
|
|
|
|
/**
|
|
* Constructor. Define names, constants, directories, boxes, permissions
|
|
*
|
|
* @param DoliDB $db Database handler
|
|
*/
|
|
public function __construct($db)
|
|
{
|
|
global $langs, $conf;
|
|
|
|
$this->db = $db;
|
|
|
|
// Id for module (must be unique).
|
|
// Use a free id here
|
|
// (See in Home -> System information -> Dolibarr for list of used modules id).
|
|
$this->numero = 56000;
|
|
// Key text used to identify module (for permissions, menus, etc...)
|
|
$this->rights_class = 'ticketsup';
|
|
|
|
// Family can be 'crm','financial','hr','projects','products','ecm','technic','other'
|
|
// It is used to group modules in module setup page
|
|
$this->family = "crm";
|
|
// Module position in the family
|
|
$this->module_position = 500;
|
|
// Module label (no space allowed)
|
|
// used if translation string 'ModuleXXXName' not found
|
|
// (where XXX is value of numeric property 'numero' of module)
|
|
$this->name = preg_replace('/^mod/i', '', get_class($this));
|
|
// Module description
|
|
// used if translation string 'ModuleXXXDesc' not found
|
|
// (where XXX is value of numeric property 'numero' of module)
|
|
$this->description = "Incident/support ticket management";
|
|
// Possible values for version are: 'development', 'experimental' or version
|
|
$this->version = 'experimental';
|
|
// Key used in llx_const table to save module status enabled/disabled
|
|
// (where MYMODULE is value of property name of module in uppercase)
|
|
$this->const_name = 'MAIN_MODULE_' . strtoupper($this->name);
|
|
// Name of image file used for this module.
|
|
// If file is in theme/yourtheme/img directory under name object_pictovalue.png
|
|
// use this->picto='pictovalue'
|
|
// If file is in module/img directory under name object_pictovalue.png
|
|
// use this->picto='pictovalue@module'
|
|
$this->picto = 'ticketsup'; // mypicto@ticketsup
|
|
// Defined all module parts (triggers, login, substitutions, menus, css, etc...)
|
|
// for default path (eg: /ticketsup/core/xxxxx) (0=disable, 1=enable)
|
|
// for specific path of parts (eg: /ticketsup/core/modules/barcode)
|
|
// for specific css file (eg: /ticketsup/css/ticketsup.css.php)
|
|
$this->module_parts = array(
|
|
// Set this to 1 if module has its own trigger directory
|
|
'triggers' => 1,
|
|
// Set this to 1 if module has its own login method directory
|
|
//'login' => 0,
|
|
// Set this to 1 if module has its own substitution function file
|
|
//'substitutions' => 0,
|
|
// Set this to 1 if module has its own menus handler directory
|
|
//'menus' => 0,
|
|
// Set this to 1 if module has its own barcode directory
|
|
//'barcode' => 0,
|
|
// Set this to 1 if module has its own models directory
|
|
'models' => 1,
|
|
// Set this to relative path of css if module has its own css file
|
|
'css' => '/ticketsup/css/ticketsup.css',
|
|
// Set here all hooks context managed by module
|
|
'hooks' => array('admin')
|
|
// Set here all workflow context managed by module
|
|
//'workflow' => array('order' => array('WORKFLOW_ORDER_AUTOCREATE_INVOICE'))
|
|
);
|
|
|
|
// Data directories to create when module is enabled.
|
|
// Example: this->dirs = array("/ticketsup/temp");
|
|
$this->dirs = array();
|
|
|
|
// Config pages. Put here list of php pages
|
|
// stored into ticketsup/admin directory, used to setup module.
|
|
$this->config_page_url = array("ticketsup.php");
|
|
|
|
// Dependencies
|
|
// List of modules id that must be enabled if this module is enabled
|
|
$this->depends = array();
|
|
// List of modules id to disable if this one is disabled
|
|
$this->requiredby = array();
|
|
// Minimum version of PHP required by module
|
|
$this->phpmin = array(5, 3);
|
|
$this->langfiles = array("ticketsup");
|
|
// Constants
|
|
// List of particular constants to add when module is enabled
|
|
// (key, 'chaine', value, desc, visible, 'current' or 'allentities', deleteonunactive)
|
|
// Example:
|
|
$this->const = array();
|
|
$this->const[1] = array('TICKETS_ENABLE_PUBLIC_INTERFACE', 'chaine', '1', 'Enable ticket public interface');
|
|
$this->const[2] = array('TICKETSUP_ADDON', 'chaine', 'mod_ticketsup_simple', 'Ticketsup ref module');
|
|
|
|
$this->tabs = array(
|
|
'thirdparty:+ticketsup:Tickets:@ticketsup:$user->rights->ticketsup->read:/ticketsup/list.php?socid=__ID__',
|
|
'project:+ticketsup:Tickets:@ticketsup:$user->rights->ticketsup->read:/ticketsup/list.php?projectid=__ID__',
|
|
);
|
|
|
|
// Dictionnaries
|
|
if (! isset($conf->ticketsup->enabled)) {
|
|
$conf->ticketsup=new stdClass();
|
|
$conf->ticketsup->enabled=0;
|
|
}
|
|
$this->dictionaries = array(
|
|
'langs' => 'ticketsup',
|
|
'tabname' => array(MAIN_DB_PREFIX . "c_ticketsup_type", MAIN_DB_PREFIX . "c_ticketsup_category", MAIN_DB_PREFIX . "c_ticketsup_severity"),
|
|
'tablib' => array("TicketsupDictType", "TicketsupDictCategory", "TicketsupDictSeverity"),
|
|
'tabsql' => array('SELECT f.rowid as rowid, f.code, f.pos, f.label, f.active, f.use_default FROM ' . MAIN_DB_PREFIX . 'c_ticketsup_type as f', 'SELECT f.rowid as rowid, f.code, f.pos, f.label, f.active, f.use_default FROM ' . MAIN_DB_PREFIX . 'c_ticketsup_category as f', 'SELECT f.rowid as rowid, f.code, f.pos, f.label, f.active, f.use_default FROM ' . MAIN_DB_PREFIX . 'c_ticketsup_severity as f'),
|
|
'tabsqlsort' => array("pos ASC", "pos ASC", "pos ASC"),
|
|
'tabfield' => array("pos,code,label,use_default", "pos,code,label,use_default", "pos,code,label,use_default"),
|
|
'tabfieldvalue' => array("pos,code,label,use_default", "pos,code,label,use_default", "pos,code,label,use_default"),
|
|
'tabfieldinsert' => array("pos,code,label,use_default", "pos,code,label,use_default", "pos,code,label,use_default"),
|
|
'tabrowid' => array("rowid", "rowid", "rowid"),
|
|
'tabcond' => array($conf->ticketsup->enabled, $conf->ticketsup->enabled, $conf->ticketsup->enabled),
|
|
);
|
|
|
|
// Boxes
|
|
// Add here list of php file(s) stored in core/boxes that contains class to show a box.
|
|
$this->boxes = array(); // Boxes list
|
|
$r = 0;
|
|
// Example:
|
|
|
|
$this->boxes[$r][1] = "box_last_ticketsup";
|
|
$r++;
|
|
|
|
$this->boxes[$r][1] = "box_last_modified_ticketsup";
|
|
$r++;
|
|
|
|
// Permissions
|
|
$this->rights = array(); // Permission array used by this module
|
|
|
|
$r=0;
|
|
$this->rights[$r][0] = 56001; // id de la permission
|
|
$this->rights[$r][1] = "Read ticket"; // libelle de la permission
|
|
$this->rights[$r][2] = 'r'; // type de la permission (deprecie a ce jour)
|
|
$this->rights[$r][3] = 1; // La permission est-elle une permission par defaut
|
|
$this->rights[$r][4] = 'read';
|
|
|
|
$r++;
|
|
$this->rights[$r][0] = 56002; // id de la permission
|
|
$this->rights[$r][1] = "Create les tickets"; // libelle de la permission
|
|
$this->rights[$r][2] = 'w'; // type de la permission (deprecie a ce jour)
|
|
$this->rights[$r][3] = 0; // La permission est-elle une permission par defaut
|
|
$this->rights[$r][4] = 'write';
|
|
|
|
$r++;
|
|
$this->rights[$r][0] = 56003; // id de la permission
|
|
$this->rights[$r][1] = "Delete les tickets"; // libelle de la permission
|
|
$this->rights[$r][2] = 'd'; // type de la permission (deprecie a ce jour)
|
|
$this->rights[$r][3] = 0; // La permission est-elle une permission par defaut
|
|
$this->rights[$r][4] = 'delete';
|
|
|
|
$r++;
|
|
$this->rights[$r][0] = 56004; // id de la permission
|
|
$this->rights[$r][1] = "Manage tickets"; // libelle de la permission
|
|
//$this->rights[$r][2] = 'd'; // type de la permission (deprecie a ce jour)
|
|
$this->rights[$r][3] = 0; // La permission est-elle une permission par defaut
|
|
$this->rights[$r][4] = 'manage';
|
|
|
|
$r++;
|
|
$this->rights[$r][0] = 56005; // id de la permission
|
|
$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
|
|
$this->rights[$r][2] = 'r'; // type de la permission (deprecie a ce jour)
|
|
$this->rights[$r][3] = 0; // La permission est-elle une permission par defaut
|
|
$this->rights[$r][4] = 'view';
|
|
$this->rights[$r][5] = 'all';
|
|
|
|
// Main menu entries
|
|
$this->menus = array(); // List of menus to add
|
|
$r = 0;
|
|
|
|
$this->menu[$r] = array('fk_menu' => 0, // Put 0 if this is a top menu
|
|
'type' => 'top', // This is a Top menu entry
|
|
'titre' => 'Ticket',
|
|
'mainmenu' => 'ticketsup',
|
|
'leftmenu' => '1', // Use 1 if you also want to add left menu entries using this descriptor.
|
|
'url' => '/ticketsup/index.php',
|
|
'langs' => 'ticketsup', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
|
|
'position' => 100,
|
|
'enabled' => '$conf->ticketsup->enabled', // Define condition to show or hide menu entry. Use '$conf->ticketsup->enabled' if entry must be visible if module is enabled.
|
|
'perms' => '$user->rights->ticketsup->read', // Use 'perms'=>'$user->rights->ticketsup->level1->level2' if you want your menu with a permission rules
|
|
'target' => '',
|
|
'user' => 2); // 0=Menu for internal users, 1=external users, 2=both
|
|
$r++;
|
|
|
|
$this->menu[$r] = array('fk_menu' => 'fk_mainmenu=ticketsup',
|
|
'type' => 'left',
|
|
'titre' => 'Ticket',
|
|
'mainmenu' => 'ticketsup',
|
|
'leftmenu' => 'ticketsup',
|
|
'url' => '/ticketsup/index.php',
|
|
'langs' => 'ticketsup',
|
|
'position' => 101,
|
|
'enabled' => '$conf->ticketsup->enabled',
|
|
'perms' => '$user->rights->ticketsup->read',
|
|
'target' => '',
|
|
'user' => 2);
|
|
$r++;
|
|
|
|
$this->menu[$r] = array('fk_menu' => 'fk_mainmenu=ticketsup,fk_leftmenu=ticketsup',
|
|
'type' => 'left',
|
|
'titre' => 'NewTicket',
|
|
'mainmenu' => 'ticketsup',
|
|
'url' => '/ticketsup/new.php?action=create_ticket',
|
|
'langs' => 'ticketsup',
|
|
'position' => 102,
|
|
'enabled' => '$conf->ticketsup->enabled',
|
|
'perms' => '$user->rights->ticketsup->write',
|
|
'target' => '',
|
|
'user' => 2);
|
|
$r++;
|
|
|
|
$this->menu[$r] = array('fk_menu' => 'fk_mainmenu=ticketsup,fk_leftmenu=ticketsup',
|
|
'type' => 'left',
|
|
'titre' => 'List',
|
|
'mainmenu' => 'ticketsup',
|
|
'leftmenu' => 'ticketsuplist',
|
|
'url' => '/ticketsup/list.php',
|
|
'langs' => 'ticketsup',
|
|
'position' => 103,
|
|
'enabled' => '$conf->ticketsup->enabled',
|
|
'perms' => '$user->rights->ticketsup->read',
|
|
'target' => '',
|
|
'user' => 2);
|
|
$r++;
|
|
|
|
$this->menu[$r] = array('fk_menu' => 'fk_mainmenu=ticketsup,fk_leftmenu=ticketsuplist',
|
|
'type' => 'left',
|
|
'titre' => 'MenuListNonClosed',
|
|
'mainmenu' => 'ticketsup',
|
|
'leftmenu' => 'ticketsuplist',
|
|
'url' => '/ticketsup/list.php?search_fk_status=non_closed',
|
|
'langs' => 'ticketsup',
|
|
'position' => 104,
|
|
'enabled' => '$conf->ticketsup->enabled',
|
|
'perms' => '$user->rights->ticketsup->read',
|
|
'target' => '',
|
|
'user' => 2);
|
|
$r++;
|
|
|
|
$this->menu[$r] = array('fk_menu' => 'fk_mainmenu=ticketsup,fk_leftmenu=ticketsup',
|
|
'type' => 'left',
|
|
'titre' => 'MenuTicketsupMyAssign',
|
|
'mainmenu' => 'ticketsup',
|
|
'leftmenu' => 'ticketsupmy',
|
|
'url' => '/ticketsup/list.php?mode=my_assign',
|
|
'langs' => 'ticketsup',
|
|
'position' => 105,
|
|
'enabled' => '$conf->ticketsup->enabled',
|
|
'perms' => '$user->rights->ticketsup->read',
|
|
'target' => '',
|
|
'user' => 0);
|
|
$r++;
|
|
|
|
$this->menu[$r] = array('fk_menu' => 'fk_mainmenu=ticketsup,fk_leftmenu=ticketsupmy',
|
|
'type' => 'left',
|
|
'titre' => 'MenuTicketsupMyAssignNonClosed',
|
|
'mainmenu' => 'ticketsup',
|
|
'url' => '/ticketsup/list.php?mode=my_assign&search_fk_status=non_closed',
|
|
'langs' => 'ticketsup',
|
|
'position' => 106,
|
|
'enabled' => '$conf->ticketsup->enabled',
|
|
'perms' => '$user->rights->ticketsup->read',
|
|
'target' => '',
|
|
'user' => 0);
|
|
$r++;
|
|
}
|
|
|
|
/**
|
|
* Function called when module is enabled.
|
|
* The init function add constants, boxes, permissions and menus (defined in constructor) into Dolibarr database.
|
|
* It also creates data directories
|
|
*
|
|
* @param string $options Options when enabling module ('', 'noboxes')
|
|
* @return int 1 if OK, 0 if KO
|
|
*/
|
|
public function init($options = '')
|
|
{
|
|
|
|
$sql = array(
|
|
array("sql" => "insert into llx_c_type_contact(rowid, element, source, code, libelle, active ) values (110120, 'ticketsup', 'internal', 'SUPPORTTEC', 'Utilisateur assigné au ticket', 1);", "ignoreerror" => 1),
|
|
array("sql" => "insert into llx_c_type_contact(rowid, element, source, code, libelle, active ) values (110121, 'ticketsup', 'internal', 'CONTRIBUTOR', 'Intervenant', 1);", "ignoreerror" => 1),
|
|
array("sql" => "insert into llx_c_type_contact(rowid, element, source, code, libelle, active ) values (110122, 'ticketsup', 'external', 'SUPPORTCLI', 'Contact client suivi incident', 1);", "ignoreerror" => 1),
|
|
array("sql" => "insert into llx_c_type_contact(rowid, element, source, code, libelle, active ) values (110123, 'ticketsup', 'external', 'CONTRIBUTOR', 'Intervenant', 1);", "ignoreerror" => 1),
|
|
array("sql" => "insert into llx_c_action_trigger (rowid,code,label,description,elementtype,rang) values ('','TICKETMESSAGE_SENTBYMAIL','Send email for ticket','Executed when a response is made on a ticket','ticketsup','');", "ignoreerror" => 1),
|
|
);
|
|
|
|
return $this->_init($sql, $options);
|
|
}
|
|
|
|
}
|