.
* ---------------------------------------------------------------------
*/
if (!defined('GLPI_ROOT')) {
die("Sorry. You can't access this file directly");
}
/**
* Notification Class
**/
class Notification extends CommonDBTM {
// MAILING TYPE
//Notification to a user (sse mailing users type below)
const USER_TYPE = 1;
//Notification to users of a profile
const PROFILE_TYPE = 2;
//Notification to users of a group
const GROUP_TYPE = 3;
//Notification to the people in charge of the database synchronisation
const MAILING_TYPE = 4;
//Notification to the supervisor of a group
const SUPERVISOR_GROUP_TYPE = 5;
//Notification to all users of a group except supervisor
const GROUP_WITHOUT_SUPERVISOR_TYPE = 6;
// MAILING USERS TYPE
//Notification to the GLPI global administrator
const GLOBAL_ADMINISTRATOR = 1;
//Notification to the technicial who's assign to a ticket
const ASSIGN_TECH = 2;
//Notification to the owner of the item
const AUTHOR = 3;
//Notification to the technician previously in charge of the ticket
const OLD_TECH_IN_CHARGE = 4;
//Notification to the technician in charge of the item
const ITEM_TECH_IN_CHARGE = 5;
//Notification to the item's user
const ITEM_USER = 6;
//Notification to the ticket's recipient
const RECIPIENT = 7;
//Notificartion to the ticket's assigned supplier
const SUPPLIER = 8;
//Notification to the ticket's assigned group
const ASSIGN_GROUP = 9;
//Notification to the supervisor of the ticket's assigned group
const SUPERVISOR_ASSIGN_GROUP = 10;
//Notification to the entity administrator
const ENTITY_ADMINISTRATOR = 11;
//Notification to the supervisor of the ticket's requester group
const SUPERVISOR_REQUESTER_GROUP = 12;
//Notification to the ticket's requester group
const REQUESTER_GROUP = 13;
//Notification to the ticket's validation approver
const VALIDATION_APPROVER = 14;
//Notification to the ticket's validation requester
const VALIDATION_REQUESTER = 15;
//Notification to the task assigned user
const TASK_ASSIGN_TECH = 16;
//Notification to the task author
const TASK_AUTHOR = 17;
//Notification to the followup author
const FOLLOWUP_AUTHOR = 18;
//Notification to the user
const USER = 19;
//Notification to the ticket's observer group
const OBSERVER_GROUP = 20;
//Notification to the ticket's observer user
const OBSERVER = 21;
//Notification to the supervisor of the ticket's observer group
const SUPERVISOR_OBSERVER_GROUP = 22;
//Notification to the group of technicians in charge of the item
const ITEM_TECH_GROUP_IN_CHARGE = 23;
// Notification to the ticket's assigned group without supervisor
const ASSIGN_GROUP_WITHOUT_SUPERVISOR = 24;
//Notification to the ticket's requester group without supervisor
const REQUESTER_GROUP_WITHOUT_SUPERVISOR = 25;
//Notification to the ticket's observer group without supervisor
const OBSERVER_GROUP_WITHOUT_SUPERVISOR = 26;
// Notification to manager users
const MANAGER_USER = 27;
// Notification to manager groups
const MANAGER_GROUP = 28;
// Notification to supervisor of manager group
const MANAGER_GROUP_SUPERVISOR = 29;
// Notification to manager group without supervisor
const MANAGER_GROUP_WITHOUT_SUPERVISOR = 30;
// Notification to team users
const TEAM_USER = 31;
// Notification to team groups
const TEAM_GROUP = 32;
// Notification to supervisor of team groups
const TEAM_GROUP_SUPERVISOR = 33;
// Notification to team groups without supervisor
const TEAM_GROUP_WITHOUT_SUPERVISOR = 34;
// Notification to team contacts
const TEAM_CONTACT = 35;
// Notification to team suppliers
const TEAM_SUPPLIER = 36;
//Notification to the task assigned group
const TASK_ASSIGN_GROUP = 37;
// From CommonDBTM
public $dohistory = true;
static $rightname = 'notification';
static function getTypeName($nb = 0) {
return _n('Notification', 'Notifications', $nb);
}
/**
* @see CommonGLPI::getMenuContent()
*
* @since 0.85
**/
static function getMenuContent() {
$menu = [];
if (Notification::canView()
|| Config::canView()) {
$menu['title'] = _n('Notification', 'Notifications', Session::getPluralNumber());
$menu['page'] = '/front/setup.notification.php';
$menu['icon'] = self::getIcon();
$menu['options']['notification']['title'] = _n('Notification', 'Notifications', Session::getPluralNumber());
$menu['options']['notification']['page'] = Notification::getSearchURL(false);
$menu['options']['notification']['links']['add'] = Notification::getFormURL(false);
$menu['options']['notification']['links']['search'] = Notification::getSearchURL(false);
$menu['options']['notificationtemplate']['title']
= _n('Notification template', 'Notification templates', Session::getPluralNumber());
$menu['options']['notificationtemplate']['page']
= NotificationTemplate::getSearchURL(false);
$menu['options']['notificationtemplate']['links']['add']
= NotificationTemplate::getFormURL(false);
$menu['options']['notificationtemplate']['links']['search']
= NotificationTemplate::getSearchURL(false);
}
if (count($menu)) {
return $menu;
}
return false;
}
function defineTabs($options = []) {
$ong = [];
$this->addDefaultFormTab($ong);
$this->addImpactTab($ong, $options);
$this->addStandardTab('Notification_NotificationTemplate', $ong, $options);
$this->addStandardTab('NotificationTarget', $ong, $options);
$this->addStandardTab('Log', $ong, $options);
return $ong;
}
function showForm($ID, $options = []) {
global $CFG_GLPI;
$this->initForm($ID, $options);
$this->showFormHeader($options);
echo "| " . __('Name') . " | ";
echo "";
Html::autocompletionTextField($this, "name");
echo " | ";
echo "".__('Comments')." | ";
echo " |
";
echo "| " . __('Active') . " | ";
echo "";
Dropdown::showYesNo('is_active', $this->fields['is_active']);
echo " |
";
echo "| " . __('Allow response') . " | ";
echo "";
Dropdown::showYesNo('allow_response', $this->allowResponse());
echo " |
";
echo "| " . _n('Type', 'Types', 1) . " | ";
echo "";
if (!Session::haveRight(static::$rightname, UPDATE)) {
$itemtype = $this->fields['itemtype'];
echo $itemtype::getTypeName(1);
$rand ='';
} else if (Config::canUpdate()
&& ($this->getEntityID() == 0)) {
$rand = Dropdown::showItemTypes('itemtype', $CFG_GLPI["notificationtemplates_types"],
['value' => $this->fields['itemtype']]);
} else {
$rand = Dropdown::showItemTypes('itemtype',
array_diff($CFG_GLPI["notificationtemplates_types"],
['CronTask', 'DBConnection', 'User']),
['value' => $this->fields['itemtype']]);
}
$params = ['itemtype' => '__VALUE__'];
Ajax::updateItemOnSelectEvent("dropdown_itemtype$rand", "show_events",
$CFG_GLPI["root_doc"]."/ajax/dropdownNotificationEvent.php",
$params);
Ajax::updateItemOnSelectEvent("dropdown_itemtype$rand", "show_templates",
$CFG_GLPI["root_doc"]."/ajax/dropdownNotificationTemplate.php",
$params);
echo " |
";
echo "| " . NotificationEvent::getTypeName(1) . " | ";
echo "";
NotificationEvent::dropdownEvents($this->fields['itemtype'],
['value'=>$this->fields['event']]);
echo " |
";
$this->showFormButtons($options);
return true;
}
/**
* @since 0.84
*
* @param $field
* @param $values
* @param $options array
**/
static function getSpecificValueToDisplay($field, $values, array $options = []) {
if (!is_array($values)) {
$values = [$field => $values];
}
switch ($field) {
case 'event':
if (isset($values['itemtype']) && !empty($values['itemtype'])) {
return NotificationEvent::getEventName($values['itemtype'], $values[$field]);
}
break;
}
return parent::getSpecificValueToDisplay($field, $values, $options);
}
/**
* @since 0.84
*
* @param $field
* @param $name (default '')
* @param $values (default '')
* @param $options array
**/
static function getSpecificValueToSelect($field, $name = '', $values = '', array $options = []) {
global $CFG_GLPI;
if (!is_array($values)) {
$values = [$field => $values];
}
switch ($field) {
case 'event' :
$itemtypes = (isset($values['itemtype']) && !empty($values['itemtype']))
? $values['itemtype']
: $CFG_GLPI["notificationtemplates_types"];
$events = [];
foreach ($itemtypes as $itemtype) {
$target = NotificationTarget::getInstanceByType($itemtype);
if ($target) {
$target_events = $target->getAllEvents();
foreach ($target_events as $key => $label) {
$events[$itemtype][$itemtype . Search::SHORTSEP . $key] = $label;
}
}
}
return Dropdown::showFromArray(
$name,
$events,
[
'display' => false,
'display_emptychoice' => true,
'value' => $values[$field],
]
);
break;
}
return parent::getSpecificValueToSelect($field, $name, $values, $options);
}
function rawSearchOptions() {
$tab = [];
$tab[] = [
'id' => 'common',
'name' => __('Characteristics')
];
$tab[] = [
'id' => '1',
'table' => $this->getTable(),
'field' => 'name',
'name' => __('Name'),
'datatype' => 'itemlink',
'massiveaction' => false,
'autocomplete' => true,
];
$tab[] = [
'id' => '2',
'table' => $this->getTable(),
'field' => 'event',
'name' => _n('Event', 'Events', 1),
'massiveaction' => false,
'datatype' => 'specific',
'additionalfields' => [
'itemtype'
],
'searchtype' => [
'equals',
'notequals'
]
];
$tab[] = [
'id' => '3',
'table' => Notification_NotificationTemplate::getTable(),
'field' => 'mode',
'name' => __('Notification method'),
'massiveaction' => false,
'searchequalsonfield'=> true,
'datatype' => 'specific',
'joinparams' => [
'jointype' => 'child'
],
'searchtype' => [
'0' => 'equals',
'1' => 'notequals'
]
];
$tab[] = [
'id' => '4',
'table' => 'glpi_notificationtemplates',
'field' => 'name',
'name' => _n('Notification template', 'Notification templates', Session::getPluralNumber()),
'datatype' => 'itemlink',
'forcegroupby' => true,
'massiveaction' => false,
'joinparams' => [
'beforejoin' => [
'table' => Notification_NotificationTemplate::getTable(),
'joinparams' => [
'jointype' => 'child'
]
]
]
];
$tab[] = [
'id' => '5',
'table' => $this->getTable(),
'field' => 'itemtype',
'name' => _n('Type', 'Types', 1),
'datatype' => 'itemtypename',
'itemtype_list' => 'notificationtemplates_types',
'massiveaction' => false
];
$tab[] = [
'id' => '6',
'table' => $this->getTable(),
'field' => 'is_active',
'name' => __('Active'),
'datatype' => 'bool'
];
$tab[] = [
'id' => '16',
'table' => $this->getTable(),
'field' => 'comment',
'name' => __('Comments'),
'datatype' => 'text'
];
$tab[] = [
'id' => '80',
'table' => 'glpi_entities',
'field' => 'completename',
'name' => Entity::getTypeName(1),
'massiveaction' => false,
'datatype' => 'dropdown'
];
$tab[] = [
'id' => '86',
'table' => $this->getTable(),
'field' => 'is_recursive',
'name' => __('Child entities'),
'datatype' => 'bool'
];
return $tab;
}
/**
* Get the massive actions for this object
*
* @param object|null $checkitem
* @return array list of actions
*/
function getSpecificMassiveActions($checkitem = null) {
$isadmin = static::canUpdate();
$actions = parent::getSpecificMassiveActions($checkitem);
if ($isadmin) {
$actions[__CLASS__.MassiveAction::CLASS_ACTION_SEPARATOR.'add_template'] = _x('button', 'Add notification template');
$actions[__CLASS__.MassiveAction::CLASS_ACTION_SEPARATOR.'remove_all_template'] = _x('button', 'Remove all notification templates');
}
return $actions;
}
static function showMassiveActionsSubForm(MassiveAction $ma) {
switch ($ma->getAction()) {
case 'add_template':
$notification_notificationtemplate = new Notification_NotificationTemplate();
$notification_notificationtemplate->showFormMassiveAction($ma);
return true;
case 'remove_all_template':
//no subform
return true;
}
return false;
}
static function processMassiveActionsForOneItemtype(MassiveAction $ma, CommonDBTM $item, array $ids) {
switch ($ma->getAction()) {
case 'add_template' :
foreach ($ids as $id) {
//load notification
$notification = new Notification();
$notification->getFromDB($id);
//check if selected template
$notification_template = new NotificationTemplate();
$notification_template->getFromDB($ma->POST['notificationtemplates_id']);
if ($notification_template->fields['itemtype'] == $notification->fields['itemtype']) {
//check if already exist
$notification_notificationtemplate = new Notification_NotificationTemplate();
$data = [
'mode' => $ma->POST['mode'],
'notificationtemplates_id' => $ma->POST['notificationtemplates_id'],
'notifications_id' => $id
];
if ($notification_notificationtemplate->getFromDBByCrit($data)) {
$ma->itemDone(Notification::getType(), $ma->POST['notificationtemplates_id'], MassiveAction::ACTION_OK);
} else {
$notification_notificationtemplate->add($data);
$ma->itemDone(Notification::getType(), $ma->POST['notificationtemplates_id'], MassiveAction::ACTION_OK);
}
} else {
$ma->itemDone(Notification::getType(), 0, MassiveAction::ACTION_KO);
$ma->addMessage($notification->getErrorMessage(ERROR_COMPAT)." (".$notification_template->getLink().")");
}
}
return;
case 'remove_all_template' :
foreach ($ids as $id) {
//load notification
$notification = new Notification();
$notification->getFromDB($id);
//delete all links between notification and template
$notification_notificationtemplate = new Notification_NotificationTemplate();
$notification_notificationtemplate->deleteByCriteria(['notifications_id' => $id]);
$ma->itemDone(Notification::getType(), $id, MassiveAction::ACTION_OK);
}
return;
}
return;
}
function canViewItem() {
if ((($this->fields['itemtype'] == 'CronTask')
|| ($this->fields['itemtype'] == 'DBConnection'))
&& !Config::canView()) {
return false;
}
return Session::haveAccessToEntity($this->getEntityID(), $this->isRecursive());
}
/**
* Is the current user have right to update the current notification ?
*
* @return boolean
**/
function canCreateItem() {
if ((($this->fields['itemtype'] == 'CronTask')
|| ($this->fields['itemtype'] == 'DBConnection'))
&& !Config::canUpdate()) {
return false;
}
return Session::haveAccessToEntity($this->getEntityID());
}
function cleanDBonPurge() {
$this->deleteChildrenAndRelationsFromDb(
[
Notification_NotificationTemplate::class,
NotificationTarget::class,
]
);
}
/**
* Send notification
*
* @param array $options Options
*
* @return void
**/
static function send($options) {
$classname = Notification_NotificationTemplate::getModeClass($options['mode']);
$notif = new $classname();
$notif->sendNotification($options);
}
/**
* Get the mailing signature for the entity
*
* @param $entity
**/
static function getMailingSignature($entity) {
global $DB, $CFG_GLPI;
foreach ($DB->request('glpi_entities', ['id' => $entity]) as $data) {
if (!empty($data['mailing_signature'])) {
return $data['mailing_signature'];
}
}
return $CFG_GLPI['mailing_signature'];
}
/**
* @param string $event Event name
* @param string $itemtype Item type
* @param int $entity Restrict to entity
*
* @return ResultSet
**/
static function getNotificationsByEventAndType($event, $itemtype, $entity) {
global $DB, $CFG_GLPI;
$criteria = [
'SELECT' => [
Notification::getTable() . '.*',
Notification_NotificationTemplate::getTable() . '.mode',
Notification_NotificationTemplate::getTable() . '.notificationtemplates_id'
],
'FROM' => Notification::getTable(),
'LEFT JOIN' => [
Entity::getTable() => [
'ON' => [
Entity::getTable() => 'id',
Notification::getTable() => 'entities_id'
]
],
Notification_NotificationTemplate::getTable() => [
'ON' => [
Notification_NotificationTemplate::getTable() => 'notifications_id',
Notification::getTable() => 'id'
]
]
],
'WHERE' => [
Notification::getTable() . '.itemtype' => $itemtype,
Notification::getTable() . '.event' => $event,
Notification::getTable() . '.is_active' => 1,
] + getEntitiesRestrictCriteria(
Notification::getTable(),
'entities_id',
$entity,
true
),
'ORDER' => Entity::getTable() . '.level DESC'
];
$modes = Notification_NotificationTemplate::getModes();
$restrict_modes = [];
foreach ($modes as $mode => $conf) {
if ($CFG_GLPI['notifications_' . $mode]) {
$restrict_modes[] = $mode;
}
}
if (count($restrict_modes)) {
$criteria['WHERE'][Notification_NotificationTemplate::getTable() . '.mode'] = $restrict_modes;
}
return $DB->request($criteria);
}
function prepareInputForAdd($input) {
if (isset($input["itemtype"]) && empty($input["itemtype"])) {
$message = __('Field itemtype is mandatory');
Session::addMessageAfterRedirect($message, false, ERROR);
return false;
}
return $input;
}
function prepareInputForUpdate($input) {
if (isset($input["itemtype"]) && empty($input["itemtype"])) {
$message = __('Field itemtype is mandatory');
Session::addMessageAfterRedirect($message, false, ERROR);
return false;
}
return $input;
}
static function getIcon() {
return "fas fa-bell";
}
public function allowResponse() {
return $this->fields['allow_response'];
}
}