* Copyright (C) 2005-2009 Regis Houssin * Copyright (C) 2024 MDW * * 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 . * or see https://www.gnu.org/ */ /** * \file htdocs/core/modules/mailings/pomme.modules.php * \ingroup mailing * \brief File of class to offer a selector of emailing targets of users. */ include_once DOL_DOCUMENT_ROOT.'/core/modules/mailings/modules_mailings.php'; /** * Class to offer a selector of emailing targets with Rule 'Pomme'. */ class mailing_pomme extends MailingTargets { public $name = 'DolibarrUsers'; // Identifiant du module mailing // This label is used if no translation is found for key XXX neither MailingModuleDescXXX where XXX=name is found public $desc = 'Dolibarr users with emails'; // Libelle utilise si aucune traduction pour MailingModuleDescXXX ou XXX=name trouv�e public $require_module = array(); // Module mailing actif si modules require_module actifs public $require_admin = 1; // Module mailing actif pour user admin ou non /** * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png */ public $picto = 'user'; /** * Constructor * * @param DoliDB $db Database handler */ public function __construct($db) { $this->db = $db; } /** * On the main mailing area, there is a box with statistics. * If you want to add a line in this report you must provide an * array of SQL request that returns two field: * One called "label", One called "nb". * * @return string[] Array with SQL requests */ public function getSqlArrayForStats() { global $conf, $langs; $langs->load("users"); $statssql = array(); $sql = "SELECT '".$this->db->escape($langs->trans("DolibarrUsers"))."' as label,"; $sql .= " count(distinct(u.email)) as nb"; $sql .= " FROM ".MAIN_DB_PREFIX."user as u"; $sql .= " WHERE u.email != ''"; // u.email IS NOT NULL est implicit dans ce test $sql .= " AND u.entity IN (0,".$conf->entity.")"; $statssql[0] = $sql; return $statssql; } /** * Return here number of distinct emails returned by your selector. * For example if this selector is used to extract 500 different * emails from a text file, this function must return 500. * * @param string $sql SQL request to use to count * @return int|string Nb of recipient, or <0 if error, or '' if NA */ public function getNbOfRecipients($sql = '') { global $conf; $sql = "SELECT count(distinct(u.email)) as nb"; $sql .= " FROM ".MAIN_DB_PREFIX."user as u"; $sql .= " WHERE u.email != ''"; // u.email IS NOT NULL est implicit dans ce test $sql .= " AND u.entity IN (0,".$conf->entity.")"; if (empty($this->evenunsubscribe)) { $sql .= " AND NOT EXISTS (SELECT rowid FROM ".MAIN_DB_PREFIX."mailing_unsubscribe as mu WHERE mu.email = u.email and mu.entity = ".((int) $conf->entity).")"; } // La requete doit retourner un champ "nb" pour etre comprise par parent::getNbOfRecipients return parent::getNbOfRecipients($sql); } /** * Affiche formulaire de filtre qui apparait dans page de selection des destinataires de mailings * * @return string Retourne zone select */ public function formFilter() { global $langs; $langs->load("users"); $s = ''; $s .= ''; $s .= ajax_combobox("filter_pomme"); $s .= ' '; $s .= ''; $s .= ajax_combobox("filteremployee_pomme"); return $s; } /** * Provide the URL to the car of the source information of the recipient for the mailing * * @param int $id ID * @return string URL link */ public function url($id) { return ''.img_object('', "user").''; } // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps /** * Ajoute destinataires dans table des cibles * * @param int $mailing_id Id of emailing * @return int Return integer < 0 si erreur, nb ajout si ok */ public function add_to_target($mailing_id) { // phpcs:enable global $conf, $langs; $langs->load("companies"); $cibles = array(); // La requete doit retourner: id, email, fk_contact, lastname, firstname $sql = "SELECT u.rowid as id, u.email as email, null as fk_contact,"; $sql .= " u.lastname, u.firstname as firstname, u.civility as civility_id, u.login, u.office_phone"; $sql .= " FROM ".MAIN_DB_PREFIX."user as u"; $sql .= " WHERE u.email <> ''"; // u.email IS NOT NULL est implicit dans ce test $sql .= " AND u.entity IN (0,".$conf->entity.")"; $sql .= " AND u.email NOT IN (SELECT email FROM ".MAIN_DB_PREFIX."mailing_cibles WHERE fk_mailing=".((int) $mailing_id).")"; if (GETPOSTISSET("filter") && GETPOST("filter") == '1') { $sql .= " AND u.statut=1"; } if (GETPOSTISSET("filter") && GETPOST("filter") == '0') { $sql .= " AND u.statut=0"; } if (GETPOSTISSET("filteremployee") && GETPOST("filteremployee") == '1') { $sql .= " AND u.employee=1"; } if (GETPOSTISSET("filteremployee") && GETPOST("filteremployee") == '0') { $sql .= " AND u.employee=0"; } if (empty($this->evenunsubscribe)) { $sql .= " AND NOT EXISTS (SELECT rowid FROM ".MAIN_DB_PREFIX."mailing_unsubscribe as mu WHERE mu.email = u.email and mu.entity = ".((int) $conf->entity).")"; } $sql .= " ORDER BY u.email"; // Stocke destinataires dans cibles $result = $this->db->query($sql); if ($result) { $num = $this->db->num_rows($result); $i = 0; $j = 0; dol_syslog(get_class($this)."::add_to_target mailing ".$num." targets found"); $old = ''; while ($i < $num) { $obj = $this->db->fetch_object($result); if ($old != $obj->email) { $cibles[$j] = array( 'email' => $obj->email, 'fk_contact' => $obj->fk_contact, 'lastname' => $obj->lastname, 'firstname' => $obj->firstname, 'other' => ($langs->transnoentities("Login").'='.$obj->login).';'. ($langs->transnoentities("UserTitle").'='.$obj->civility_id).';'. ($langs->transnoentities("PhonePro").'='.$obj->office_phone), 'source_url' => $this->url($obj->id), 'source_id' => $obj->id, 'source_type' => 'user' ); $old = $obj->email; $j++; } $i++; } } else { dol_syslog($this->db->error()); $this->error = $this->db->error(); return -1; } return parent::addTargetsToDatabase($mailing_id, $cibles); } }