From 5558b0d081201f92d8c1c6a8572b6d172dc06fb6 Mon Sep 17 00:00:00 2001 From: Laurent Destailleur Date: Sat, 9 Jan 2010 01:56:33 +0000 Subject: [PATCH] New: Module notification can send mail on order or proposal validation. --- ...ace_modNotification_Notification.class.php | 382 ++++++++++-------- htdocs/install/mysql/data/llx_action_def.sql | 2 + .../install/mysql/migration/2.7.0-2.8.0.sql | 3 + htdocs/langs/en_US/other.lang | 4 +- htdocs/langs/fr_FR/other.lang | 4 +- htdocs/notify.class.php | 6 +- 6 files changed, 220 insertions(+), 181 deletions(-) diff --git a/htdocs/includes/triggers/interface_modNotification_Notification.class.php b/htdocs/includes/triggers/interface_modNotification_Notification.class.php index 03e79ac2394..9c6cb026e58 100644 --- a/htdocs/includes/triggers/interface_modNotification_Notification.class.php +++ b/htdocs/includes/triggers/interface_modNotification_Notification.class.php @@ -1,176 +1,206 @@ - - * - * 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 2 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, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - */ - -/** - * \file htdocs/includes/triggers/interface_modNotification_notification.class.php - * \ingroup notification - * \brief Fichier de gestion des notifications sur evenement Dolibarr - * \version $Id$ - */ - - -/** - * \class InterfaceNotification - * \brief Classe des fonctions triggers des actions personalisees du workflow - */ -class InterfaceNotification -{ - var $db; - - /** - * \brief Constructeur. - * \param DB Handler d'acces base - */ - function InterfaceNotification($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 = 'dolibarr'; // 'experimental' or 'dolibarr' or version - } - - /** - * \brief Renvoi nom du lot de triggers - * \return string Nom du lot de triggers - */ - function getName() - { - return $this->name; - } - - /** - * \brief Renvoi descriptif du lot de triggers - * \return string Descriptif du lot de triggers - */ - function getDesc() - { - return $this->description; - } - - /** - * \brief Renvoi version du lot de triggers - * \return string Version du lot de triggers - */ - function getVersion() - { - global $langs; - $langs->load("admin"); - - if ($this->version == 'experimental') return $langs->trans("Experimental"); - elseif ($this->version == 'dolibarr') return DOL_VERSION; - elseif ($this->version) return $this->version; - else return $langs->trans("Unknown"); - } - - /** - * \brief Fonction appelee lors du declenchement d'un evenement Dolibarr. - * D'autres fonctions run_trigger peuvent etre presentes dans includes/triggers - * \param action Code de l'evenement - * \param object Objet concerne - * \param user Objet user - * \param lang Objet lang - * \param conf Objet conf - * \return int <0 si ko, 0 si aucune action faite, >0 si ok - */ - function run_trigger($action,$object,$user,$langs,$conf) - { - // Mettre ici le code a executer en reaction de l'action - // Les donnees de l'action sont stockees dans $object - - // Si module notification non actif, on ne fait rien - if (! $conf->notification->enabled) return 0; - - require_once(DOL_DOCUMENT_ROOT .'/notify.class.php'); - - if ($action == 'BILL_VALIDATE') - { - dol_syslog("Trigger '".$this->name."' for action '$action' launched by ".__FILE__.". id=".$object->id); - - $action_notify = 'NOTIFY_VAL_FAC'; - $ref = dol_sanitizeFileName($object->ref); - $filepdf = $conf->facture->dir_output . '/' . $ref . '/' . $ref . '.pdf'; - if (! file_exists($filepdf)) $filepdf=''; - $langs->load("other"); - $mesg = $langs->transnoentitiesnoconv("EMailTextInvoiceValidated",$object->ref); - - $notify = new Notify($this->db); - $notify->send($action_notify, $object->socid, $mesg, 'facture', $object->id, $filepdf); - } - - elseif ($action == 'FICHEINTER_VALIDATE') - { - dol_syslog("Trigger '".$this->name."' for action '$action' launched by ".__FILE__.". id=".$object->id); - - $action_notify = 'NOTIFY_VAL_FICHINTER'; - $ref = dol_sanitizeFileName($object->ref); - $filepdf = $conf->facture->dir_output . '/' . $ref . '/' . $ref . '.pdf'; - if (! file_exists($filepdf)) $filepdf=''; - $langs->load("other"); - $mesg = $langs->transnoentitiesnoconv("EMailTextIntervnetionValidated",$object->ref); - - $notify = new Notify($this->db); - $notify->send($action_notify, $object->socid, $mesg, 'ficheinter', $object->id, $filepdf); - } - - elseif ($action == 'ORDER_SUPPLIER_APPROVE') - { - dol_syslog("Trigger '".$this->name."' for action '$action' launched by ".__FILE__.". id=".$object->id); - - $action_notify = 'NOTIFY_APP_ORDER_SUPPLIER'; - $ref = dol_sanitizeFileName($object->ref); - $filepdf = $conf->fournisseur->dir_output . '/commande/' . $ref . '/' . $ref . '.pdf'; - if (! file_exists($filepdf)) $filepdf=''; - $mesg = $langs->transnoentitiesnoconv("Hello").",\n\n"; - $mesg.= $langs->transnoentitiesnoconv("EMailTextOrderApprovedBy",$object->ref,$user->fullname); - $mesg.= "\n\n".$langs->transnoentitiesnoconv("Sincerely").".\n\n"; - - $notify = new Notify($this->db); - $notify->send($action_notify, $object->socid, $mesg, 'order_supplier', $object->id, $filepdf); - } - - elseif ($action == 'ORDER_SUPPLIER_REFUSE') - { - dol_syslog("Trigger '".$this->name."' for action '$action' launched by ".__FILE__.". id=".$object->id); - - $action_notify = 'NOTIFY_REF_ORDER_SUPPLIER'; - $ref = dol_sanitizeFileName($object->ref); - $filepdf = $conf->fournisseur->dir_output . '/commande/' . $ref . '/' . $ref . '.pdf'; - if (! file_exists($filepdf)) $filepdf=''; - $mesg = $langs->transnoentitiesnoconv("Hello").",\n\n"; - $mesg.= $langs->transnoentitiesnoconv("EMailTextOrderRefusedBy",$object->ref,$user->fullname); - $mesg.= "\n\n".$langs->transnoentitiesnoconv("Sincerely").".\n\n"; - - $notify = new Notify($this->db); - $notify->send($action_notify, $object->socid, $mesg, 'order_supplier', $object->id, $filepdf); - } - - // If not found -/* - else - { - dol_syslog("Trigger '".$this->name."' for action '$action' was ran by ".__FILE__." but no handler found for this action."); - return -1; - } -*/ - return 0; - } - -} -?> + + * + * 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 2 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, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + */ + +/** + * \file htdocs/includes/triggers/interface_modNotification_notification.class.php + * \ingroup notification + * \brief Fichier de gestion des notifications sur evenement Dolibarr + * \version $Id$ + */ + + +/** + * \class InterfaceNotification + * \brief Classe des fonctions triggers des actions personalisees du workflow + */ +class InterfaceNotification +{ + var $db; + + /** + * \brief Constructeur. + * \param DB Handler d'acces base + */ + function InterfaceNotification($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 = 'dolibarr'; // 'experimental' or 'dolibarr' or version + } + + /** + * \brief Renvoi nom du lot de triggers + * \return string Nom du lot de triggers + */ + function getName() + { + return $this->name; + } + + /** + * \brief Renvoi descriptif du lot de triggers + * \return string Descriptif du lot de triggers + */ + function getDesc() + { + return $this->description; + } + + /** + * \brief Renvoi version du lot de triggers + * \return string Version du lot de triggers + */ + function getVersion() + { + global $langs; + $langs->load("admin"); + + if ($this->version == 'experimental') return $langs->trans("Experimental"); + elseif ($this->version == 'dolibarr') return DOL_VERSION; + elseif ($this->version) return $this->version; + else return $langs->trans("Unknown"); + } + + /** + * \brief Fonction appelee lors du declenchement d'un evenement Dolibarr. + * D'autres fonctions run_trigger peuvent etre presentes dans includes/triggers + * \param action Code de l'evenement + * \param object Objet concerne + * \param user Objet user + * \param lang Objet lang + * \param conf Objet conf + * \return int <0 si ko, 0 si aucune action faite, >0 si ok + */ + function run_trigger($action,$object,$user,$langs,$conf) + { + // Mettre ici le code a executer en reaction de l'action + // Les donnees de l'action sont stockees dans $object + + // Si module notification non actif, on ne fait rien + if (! $conf->notification->enabled) return 0; + + require_once(DOL_DOCUMENT_ROOT .'/notify.class.php'); + + if ($action == 'BILL_VALIDATE') + { + dol_syslog("Trigger '".$this->name."' for action '$action' launched by ".__FILE__.". id=".$object->id); + + $action_notify = 'NOTIFY_VAL_FAC'; + $ref = dol_sanitizeFileName($object->ref); + $filepdf = $conf->facture->dir_output . '/' . $ref . '/' . $ref . '.pdf'; + if (! file_exists($filepdf)) $filepdf=''; + $langs->load("other"); + $mesg = $langs->transnoentitiesnoconv("EMailTextInvoiceValidated",$object->ref); + + $notify = new Notify($this->db); + $notify->send($action_notify, $object->socid, $mesg, 'facture', $object->id, $filepdf); + } + + elseif ($action == 'ORDER_VALIDATE') + { + dol_syslog("Trigger '".$this->name."' for action '$action' launched by ".__FILE__.". id=".$object->id); + + $action_notify = 'NOTIFY_VAL_ORDER'; + $ref = dol_sanitizeFileName($object->ref); + $filepdf = $conf->commande->dir_output . '/' . $ref . '/' . $ref . '.pdf'; + if (! file_exists($filepdf)) $filepdf=''; + $langs->load("other"); + $mesg = $langs->transnoentitiesnoconv("EMailTextOrderValidated",$object->ref); + + $notify = new Notify($this->db); + $notify->send($action_notify, $object->socid, $mesg, 'order', $object->id, $filepdf); + } + + elseif ($action == 'PROPOSAL_VALIDATE') + { + dol_syslog("Trigger '".$this->name."' for action '$action' launched by ".__FILE__.". id=".$object->id); + + $action_notify = 'NOTIFY_VAL_PROPOSAL'; + $ref = dol_sanitizeFileName($object->ref); + $filepdf = $conf->propal->dir_output . '/' . $ref . '/' . $ref . '.pdf'; + if (! file_exists($filepdf)) $filepdf=''; + $langs->load("other"); + $mesg = $langs->transnoentitiesnoconv("EMailTextProposalValidated",$object->ref); + + $notify = new Notify($this->db); + $notify->send($action_notify, $object->socid, $mesg, 'propal', $object->id, $filepdf); + } + + elseif ($action == 'FICHEINTER_VALIDATE') + { + dol_syslog("Trigger '".$this->name."' for action '$action' launched by ".__FILE__.". id=".$object->id); + + $action_notify = 'NOTIFY_VAL_FICHINTER'; + $ref = dol_sanitizeFileName($object->ref); + $filepdf = $conf->facture->dir_output . '/' . $ref . '/' . $ref . '.pdf'; + if (! file_exists($filepdf)) $filepdf=''; + $langs->load("other"); + $mesg = $langs->transnoentitiesnoconv("EMailTextIntervnetionValidated",$object->ref); + + $notify = new Notify($this->db); + $notify->send($action_notify, $object->socid, $mesg, 'ficheinter', $object->id, $filepdf); + } + + elseif ($action == 'ORDER_SUPPLIER_APPROVE') + { + dol_syslog("Trigger '".$this->name."' for action '$action' launched by ".__FILE__.". id=".$object->id); + + $action_notify = 'NOTIFY_APP_ORDER_SUPPLIER'; + $ref = dol_sanitizeFileName($object->ref); + $filepdf = $conf->fournisseur->dir_output . '/commande/' . $ref . '/' . $ref . '.pdf'; + if (! file_exists($filepdf)) $filepdf=''; + $mesg = $langs->transnoentitiesnoconv("Hello").",\n\n"; + $mesg.= $langs->transnoentitiesnoconv("EMailTextOrderApprovedBy",$object->ref,$user->fullname); + $mesg.= "\n\n".$langs->transnoentitiesnoconv("Sincerely").".\n\n"; + + $notify = new Notify($this->db); + $notify->send($action_notify, $object->socid, $mesg, 'order_supplier', $object->id, $filepdf); + } + + elseif ($action == 'ORDER_SUPPLIER_REFUSE') + { + dol_syslog("Trigger '".$this->name."' for action '$action' launched by ".__FILE__.". id=".$object->id); + + $action_notify = 'NOTIFY_REF_ORDER_SUPPLIER'; + $ref = dol_sanitizeFileName($object->ref); + $filepdf = $conf->fournisseur->dir_output . '/commande/' . $ref . '/' . $ref . '.pdf'; + if (! file_exists($filepdf)) $filepdf=''; + $mesg = $langs->transnoentitiesnoconv("Hello").",\n\n"; + $mesg.= $langs->transnoentitiesnoconv("EMailTextOrderRefusedBy",$object->ref,$user->fullname); + $mesg.= "\n\n".$langs->transnoentitiesnoconv("Sincerely").".\n\n"; + + $notify = new Notify($this->db); + $notify->send($action_notify, $object->socid, $mesg, 'order_supplier', $object->id, $filepdf); + } + + // If not found +/* + else + { + dol_syslog("Trigger '".$this->name."' for action '$action' was ran by ".__FILE__." but no handler found for this action."); + return -1; + } +*/ + return 0; + } + +} +?> diff --git a/htdocs/install/mysql/data/llx_action_def.sql b/htdocs/install/mysql/data/llx_action_def.sql index 844b97186fc..9f347803639 100644 --- a/htdocs/install/mysql/data/llx_action_def.sql +++ b/htdocs/install/mysql/data/llx_action_def.sql @@ -36,3 +36,5 @@ insert into llx_action_def (rowid,code,titre,description,objet_type) values (1,' insert into llx_action_def (rowid,code,titre,description,objet_type) values (2,'NOTIFY_VAL_FAC','Validation facture client','Executed when a customer invoice is approved','facture'); insert into llx_action_def (rowid,code,titre,description,objet_type) values (3,'NOTIFY_APP_ORDER_SUPPLIER','Approbation commande fournisseur','Executed when a supplier order is approved','order_supplier'); insert into llx_action_def (rowid,code,titre,description,objet_type) values (4,'NOTIFY_REF_ORDER_SUPPLIER','Refus commande fournisseur','Executed when a supplier order is refused','order_supplier'); +insert into llx_action_def (rowid,code,titre,description,objet_type) values (5,'NOTIFY_VAL_ORDER','Validation commande client','Executed when a customer order is validated','order'); +insert into llx_action_def (rowid,code,titre,description,objet_type) values (6,'NOTIFY_VAL_PROPAL','Validation proposition client','Executed when a commercial proposal is validated','propal'); diff --git a/htdocs/install/mysql/migration/2.7.0-2.8.0.sql b/htdocs/install/mysql/migration/2.7.0-2.8.0.sql index 24de1ad2133..85dcb5e4e20 100755 --- a/htdocs/install/mysql/migration/2.7.0-2.8.0.sql +++ b/htdocs/install/mysql/migration/2.7.0-2.8.0.sql @@ -33,3 +33,6 @@ ALTER TABLE llx_facture_fourn_det MODIFY COLUMN qty real; ALTER TABLE llx_projet ADD COLUMN datee DATE AFTER dateo; + +insert into llx_action_def (rowid,code,titre,description,objet_type) values (5,'NOTIFY_VAL_ORDER','Validation commande client','Executed when a customer order is validated','order'); +insert into llx_action_def (rowid,code,titre,description,objet_type) values (6,'NOTIFY_VAL_PROPAL','Validation proposition client','Executed when a commercial proposal is validated','propal'); diff --git a/htdocs/langs/en_US/other.lang b/htdocs/langs/en_US/other.lang index 0dffa874465..b0342d5f2ee 100644 --- a/htdocs/langs/en_US/other.lang +++ b/htdocs/langs/en_US/other.lang @@ -26,9 +26,11 @@ DateToBirth=Date to birth BirthdayAlertOn = birthday alert active BirthdayAlertOff = birthday alert inactive Notify_NOTIFY_VAL_FICHINTER=Intervention validated -Notify_NOTIFY_VAL_FAC=Invoice validated +Notify_NOTIFY_VAL_FAC=Customer invoice validated Notify_NOTIFY_APP_ORDER_SUPPLIER=Supplier order approved Notify_NOTIFY_REF_ORDER_SUPPLIER=Supplier order refused +Notify_NOTIFY_VAL_ORDER=Customer order validated +Notify_NOTIFY_VAL_PROPAL=Customer proposal validated NbOfAttachedFiles=Number of attached files/documents TotalSizeOfAttachedFiles=Total size of attached files/documents MaxSize=Maximum size diff --git a/htdocs/langs/fr_FR/other.lang b/htdocs/langs/fr_FR/other.lang index 83577441b1c..a3aafc95967 100644 --- a/htdocs/langs/fr_FR/other.lang +++ b/htdocs/langs/fr_FR/other.lang @@ -26,9 +26,11 @@ DateToBirth=Date de naissance BirthdayAlertOn = alerte anniversaire active BirthdayAlertOff = alerte anniversaire inactive Notify_NOTIFY_VAL_FICHINTER=Validation fiche intervention -Notify_NOTIFY_VAL_FAC=Validation facture +Notify_NOTIFY_VAL_FAC=Validation facture client Notify_NOTIFY_APP_ORDER_SUPPLIER=Approbation commande fournisseur Notify_NOTIFY_REF_ORDER_SUPPLIER=Refus commande fournisseur +Notify_NOTIFY_VAL_ORDER=Validation commande client +Notify_NOTIFY_VAL_PROPAL=Validation proposition commerciale client NbOfAttachedFiles=Nombre de fichiers/documents liés TotalSizeOfAttachedFiles=Taille total fichiers/documents liés MaxSize=Taille maximum diff --git a/htdocs/notify.class.php b/htdocs/notify.class.php index 6b27223e498..facef3bae22 100644 --- a/htdocs/notify.class.php +++ b/htdocs/notify.class.php @@ -108,12 +108,12 @@ class Notify /** * \brief Check if notification are active for couple action/company. - * If yes, send mail and save trace. + * If yes, send mail and save trace into llx_notify. * \param action Code of action to check and send (list in llx_action_def) * \param socid Id of third party * \param texte Message to send - * \param objet_type Type of object notification deals on - * \param objet_id Id of object notification deals on + * \param objet_type Type of object the notification deals on (facture, order, propal, order_supplier...). Just for log in llx_notify. + * \param objet_id Id of object the notification deals on * \param file Attach a file * \return int <0 if KO or number of changes if OK */