pomme.modules.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2005-2011 Laurent Destailleur <eldy@users.sourceforge.net>
 * Copyright (C) 2005-2009 Regis Houssin       <regis.houssin@inodbox.com>
 * Copyright (C) 2024-2026  MDW             <mdeweerd@users.noreply.github.com>
 * Copyright (C) 2024-2026  Frédéric France         <frederic.france@free.fr>
 *
 * 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/>.
 * or see https://www.gnu.org/
 */
 
include_once DOL_DOCUMENT_ROOT.'/core/modules/mailings/modules_mailings.php';
 
 
class mailing_pomme extends MailingTargets
{
  public $name = 'DolibarrUsers';
 
  public $desc = 'Dolibarr users with emails'; // Label used if no translation found for MailingModuleDescXXX or XXX=name
 
  public $require_module = array();
 
  public $require_admin = 1;
 
  public $picto = 'user';
 
 
  public function __construct($db)
  {
    $this->db = $db;
  }
 
 
  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,".((int) $conf->entity).")";
 
    $statssql[0] = $sql;
 
    return $statssql;
  }
 
 
  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,".((int) $conf->entity).")";
    $sql .= $this->getSqlToExcludeUnsubscribed('u.email');
 
    // The query must return a field "nb" to be understood by parent::getNbOfRecipients
    return parent::getNbOfRecipients($sql);
  }
 
 
  public function formFilter()
  {
    global $langs;
 
    $langs->load("users");
 
    $s = '';
    $s .= '<select id="filter_pomme"" name="filter" class="flat minwidth100">';
    $s .= '<option value="-1">'.$langs->trans("Status").'</option>';
    $s .= '<option value="1">'.$langs->trans("Enabled").'</option>';
    $s .= '<option value="0">'.$langs->trans("Disabled").'</option>';
    $s .= '</select>';
    $s .= ajax_combobox("filter_pomme");
 
    $s .= ' ';
    $s .= '<select id="filteremployee_pomme" name="filteremployee" class="flat minwidth100">';
    $s .= '<option value="-1">'.$langs->trans("Employee").'</option>';
    $s .= '<option value="1">'.$langs->trans("Yes").'</option>';
    $s .= '<option value="0">'.$langs->trans("No").'</option>';
    $s .= '</select>';
    $s .= ajax_combobox("filteremployee_pomme");
 
    return $s;
  }
 
 
  public function url($id)
  {
    return '<a href="'.DOL_URL_ROOT.'/user/card.php?id='.$id.'">'.img_object('', "user").'</a>';
  }
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function add_to_target($mailing_id)
  {
    // phpcs:enable
    global $conf, $langs;
    $langs->load("companies");
 
    $cibles = array();
 
    // The query must return: 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,".((int) $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";
    }
    $sql .= $this->getSqlToExcludeUnsubscribed('u.email');
    $sql .= " ORDER BY u.email";
 
    // Store recipients into targets
    $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' => (int) $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' => (int) $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);
  }
}