File: //proc/self/cwd/guiaweb/htdocs/core/triggers/interface_50_modNotification_Notification.class.php
<?php
/* Copyright (C) 2006-2011 Laurent Destailleur <eldy@users.sourceforge.net>
* Copyright (C) 2011 Regis Houssin <regis.houssin@inodbox.com>
* Copyright (C) 2013-2014 Marcos GarcĂa <marcosgdf@gmail.com>
* Copyright (C) 2022 Anthony Berton <anthony.berton@bb2a.fr>
* Copyright (C) 2024 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, see <https://www.gnu.org/licenses/>.
*/
/**
* \file htdocs/core/triggers/interface_50_modNotification_Notification.class.php
* \ingroup notification
* \brief File of class of triggers for notification module
*/
require_once DOL_DOCUMENT_ROOT.'/core/triggers/dolibarrtriggers.class.php';
include_once DOL_DOCUMENT_ROOT.'/core/class/notify.class.php';
/**
* Class of triggers for notification module
*/
class InterfaceNotification extends DolibarrTriggers
{
/**
* @var string[]
*/
public $listofmanagedevents = array();
/**
* Constructor
*
* @param DoliDB $db Database handler
*/
public function __construct($db)
{
$this->db = $db;
$this->name = preg_replace('/^Interface/i', '', get_class($this));
$this->family = "notification";
$this->description = "Triggers of this module send Email notifications according to Notification module setup.";
$this->version = self::VERSIONS['prod'];
$this->picto = 'email';
$this->listofmanagedevents = Notify::$arrayofnotifsupported;
}
/**
* Function called when a Dolibarr business event is done.
* All functions "runTrigger" are triggered if file is inside directory htdocs/core/triggers or htdocs/module/code/triggers (and declared)
*
* @param string $action Event action code
* @param Object $object Object
* @param User $user Object user
* @param Translate $langs Object langs
* @param conf $conf Object conf
* @return int Return integer <0 if KO, 0 if no triggered ran, >0 if OK
*/
public function runTrigger($action, $object, User $user, Translate $langs, Conf $conf)
{
global $hookmanager;
if (empty($conf->notification) || !isModEnabled('notification')) {
return 0; // Module not active, we do nothing
}
if (!is_object($hookmanager)) {
include_once DOL_DOCUMENT_ROOT.'/core/class/hookmanager.class.php';
$hookmanager = new HookManager($this->db);
}
$hookmanager->initHooks(array('notification'));
$parameters = array();
$reshook = $hookmanager->executeHooks('notifsupported', $parameters, $object, $action);
if (empty($reshook)) {
if (!empty($hookmanager->resArray['arrayofnotifsupported'])) {
$this->listofmanagedevents = array_merge($this->listofmanagedevents, $hookmanager->resArray['arrayofnotifsupported']);
}
}
// If the trigger code is not managed by the Notification module
if (!in_array($action, $this->listofmanagedevents)) {
return 0;
}
dol_syslog("Trigger '".$this->name."' for action '".$action."' launched by ".__FILE__.". id=".$object->id);
$notify = new Notify($this->db);
$resultSend = $notify->send($action, $object);
if ($resultSend < 0) {
$this->errors = array_merge(empty($this->errors) ? array() : $this->errors, $notify->errors);
return $resultSend;
}
return 1;
}
/**
* Return list of events managed by notification module
*
* @return array<array{rowid:int,code:string,contexts:string,label:string,description:string,elementtype:string}> Array of events managed by notification module
*/
public function getListOfManagedEvents()
{
global $conf, $action;
global $hookmanager;
if (!is_object($hookmanager)) {
include_once DOL_DOCUMENT_ROOT.'/core/class/hookmanager.class.php';
$hookmanager = new HookManager($this->db);
}
$hookmanager->initHooks(array('notification'));
$parameters = array();
$object = new stdClass();
$reshook = $hookmanager->executeHooks('notifsupported', $parameters, $object, $action);
if (empty($reshook)) {
if (!empty($hookmanager->resArray['arrayofnotifsupported'])) {
$this->listofmanagedevents = array_merge($this->listofmanagedevents, $hookmanager->resArray['arrayofnotifsupported']);
}
}
$ret = array();
$sql = "SELECT rowid, code, contexts, label, description, elementtype";
$sql .= " FROM ".MAIN_DB_PREFIX."c_action_trigger";
$sql .= $this->db->order("rang, elementtype, code");
dol_syslog("getListOfManagedEvents Get list of notifications", LOG_DEBUG);
$resql = $this->db->query($sql);
if ($resql) {
$num = $this->db->num_rows($resql);
$i = 0;
while ($i < $num) {
$obj = $this->db->fetch_object($resql);
$qualified = 0;
// Check is this event is supported by notification module
if (in_array($obj->code, $this->listofmanagedevents)) {
$qualified = 1;
}
// Check if module for this event is active
if ($qualified) {
//print 'xx'.$obj->code.' '.$obj->elementtype.'<br>';
$element = $obj->elementtype;
// Exclude events if related module is disabled
if ($element == 'order_supplier' && !isModEnabled('supplier_order')) {
$qualified = 0;
} elseif ($element == 'invoice_supplier' && !isModEnabled('supplier_invoice')) {
$qualified = 0;
} elseif ($element == 'withdraw' && !isModEnabled('prelevement')) {
$qualified = 0;
} elseif ($element == 'shipping' && !isModEnabled('shipping')) {
$qualified = 0;
} elseif ($element == 'member' && !isModEnabled('member')) {
$qualified = 0;
} elseif (($element == 'expense_report' || $element == 'expensereport') && !isModEnabled('expensereport')) {
$qualified = 0;
} elseif (!in_array($element, array('order_supplier', 'invoice_supplier', 'withdraw', 'shipping', 'member', 'expense_report', 'expensereport')) && empty($conf->$element->enabled)) {
$qualified = 0;
}
}
if ($qualified) {
$ret[] = array('rowid' => $obj->rowid, 'code' => $obj->code, 'contexts' => $obj->contexts, 'label' => $obj->label, 'description' => $obj->description, 'elementtype' => $obj->elementtype);
}
$i++;
}
} else {
dol_print_error($this->db);
}
return $ret;
}
}