modules_mailings.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2003-2004 Rodolphe Quiedeville <rodolphe@quiedeville.org>
 * Copyright (C) 2004-2008 Laurent Destailleur  <eldy@users.sourceforge.net>
 * Copyright (C) 2004      Eric Seigne          <eric.seigne@ryxeo.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/>.
 * or see https://www.gnu.org/
 */

require_once DOL_DOCUMENT_ROOT.'/core/lib/functions.lib.php';


class MailingTargets // This can't be abstract as it is used for some method
{
  public $db;

  public $error = '';

  public $tooltip = '';


  public function __construct($db)
  {
    $this->db = $db;
  }

  public function getDesc()
  {
    global $langs, $form;

    $langs->load("mails");
    $transstring = "MailingModuleDesc".$this->name;
    $s = '';

    if ($langs->trans($this->name) != $this->name) $s = $langs->trans($this->name);
    elseif ($langs->trans($transstring) != $transstring) $s = $langs->trans($transstring);
    else $s = $this->desc;

    if ($this->tooltip && is_object($form)) $s .= ' '.$form->textwithpicto('', $langs->trans($this->tooltip), 1, 1);
    return $s;
  }

  public function getNbOfRecords()
  {
    return 0;
  }

  public function getNbOfRecipients($sql)
  {
    $result = $this->db->query($sql);
    if ($result)
    {
      $obj = $this->db->fetch_object($result);
      return $obj->nb;
    } else {
      $this->error = $this->db->lasterror();
      return -1;
    }
  }

  public function formFilter()
  {
    return '';
  }

  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function update_nb($mailing_id)
  {
    // phpcs:enable
    // Mise a jour nombre de destinataire dans table des mailings
    $sql = "SELECT COUNT(*) nb FROM ".MAIN_DB_PREFIX."mailing_cibles";
    $sql .= " WHERE fk_mailing = ".$mailing_id;
    $result = $this->db->query($sql);
    if ($result)
    {
      $obj = $this->db->fetch_object($result);
      $nb = $obj->nb;

      $sql = "UPDATE ".MAIN_DB_PREFIX."mailing";
      $sql .= " SET nbemail = ".$nb." WHERE rowid = ".$mailing_id;
      if (!$this->db->query($sql))
      {
        dol_syslog($this->db->error());
        $this->error = $this->db->error();
        return -1;
      }
    } else {
      return -1;
    }
    return $nb;
  }

  public function addTargetsToDatabase($mailing_id, $cibles)
  {
    global $conf;
    global $dolibarr_main_instance_unique_id;

    $this->db->begin();

    // Insert emailing targets from array into database
    $j = 0;
    $num = count($cibles);
    foreach ($cibles as $targetarray)
    {
      if (!empty($targetarray['email'])) // avoid empty email address
      {
        $sql = "INSERT INTO ".MAIN_DB_PREFIX."mailing_cibles";
        $sql .= " (fk_mailing,";
        $sql .= " fk_contact,";
        $sql .= " lastname, firstname, email, other, source_url, source_id,";
          $sql .= " tag,";
        $sql .= " source_type)";
        $sql .= " VALUES (".$mailing_id.",";
        $sql .= (empty($targetarray['fk_contact']) ? '0' : "'".$this->db->escape($targetarray['fk_contact'])."'").",";
        $sql .= "'".$this->db->escape($targetarray['lastname'])."',";
        $sql .= "'".$this->db->escape($targetarray['firstname'])."',";
        $sql .= "'".$this->db->escape($targetarray['email'])."',";
        $sql .= "'".$this->db->escape($targetarray['other'])."',";
        $sql .= "'".$this->db->escape($targetarray['source_url'])."',";
        $sql .= (empty($targetarray['source_id']) ? 'null' : "'".$this->db->escape($targetarray['source_id'])."'").",";
        $sql .= "'".$this->db->escape(dol_hash($dolibarr_main_instance_unique_id.';'.$targetarray['email'].';'.$targetarray['lastname'].';'.$mailing_id.';'.$conf->global->MAILING_EMAIL_UNSUBSCRIBE_KEY), 'md5')."',";
        $sql .= "'".$this->db->escape($targetarray['source_type'])."')";
        dol_syslog(__METHOD__, LOG_DEBUG);
        $result = $this->db->query($sql);
        if ($result)
        {
          $j++;
        } else {
          if ($this->db->errno() != 'DB_ERROR_RECORD_ALREADY_EXISTS')
          {
            // Si erreur autre que doublon
            dol_syslog($this->db->error().' : '.$targetarray['email']);
            $this->error = $this->db->error().' : '.$targetarray['email'];
            $this->db->rollback();
            return -1;
          }
        }
      }
    }

    dol_syslog(__METHOD__.": mailing ".$j." targets added");

    /*
        //Update the status to show thirdparty mail that don't want to be contacted anymore'
        $sql = "UPDATE ".MAIN_DB_PREFIX."mailing_cibles";
        $sql .= " SET statut=3";
        $sql .= " WHERE fk_mailing=".$mailing_id." AND email in (SELECT email FROM ".MAIN_DB_PREFIX."societe where fk_stcomm=-1)";
        $sql .= " AND source_type='thirdparty'";
        dol_syslog(__METHOD__.": mailing update status to display thirdparty mail that do not want to be contacted");
        $result=$this->db->query($sql);

        //Update the status to show contact mail that don't want to be contacted anymore'
        $sql = "UPDATE ".MAIN_DB_PREFIX."mailing_cibles";
        $sql .= " SET statut=3";
        $sql .= " WHERE fk_mailing=".$mailing_id." AND source_type='contact' AND (email in (SELECT sc.email FROM ".MAIN_DB_PREFIX."socpeople AS sc ";
        $sql .= " INNER JOIN ".MAIN_DB_PREFIX."societe s ON s.rowid=sc.fk_soc WHERE s.fk_stcomm=-1 OR no_email=1))";
        dol_syslog(__METHOD__.": mailing update status to display contact mail that do not want to be contacted",LOG_DEBUG);
        $result=$this->db->query($sql);
    */

    $sql = "UPDATE ".MAIN_DB_PREFIX."mailing_cibles";
    $sql .= " SET statut=3";
    $sql .= " WHERE fk_mailing=".$mailing_id." AND email IN (SELECT mu.email FROM ".MAIN_DB_PREFIX."mailing_unsubscribe AS mu WHERE mu.entity IN ('".getEntity('mailing')."'))";

    dol_syslog(__METHOD__.":mailing update status to display emails that do not want to be contacted anymore", LOG_DEBUG);
    $result = $this->db->query($sql);
    if (!$result)
    {
      dol_print_error($this->db);
    }

    $this->update_nb($mailing_id);

    $this->db->commit();

    return $j;
  }

  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function clear_target($mailing_id)
  {
    // phpcs:enable
    $sql = "DELETE FROM ".MAIN_DB_PREFIX."mailing_cibles";
    $sql .= " WHERE fk_mailing = ".$mailing_id;

    if (!$this->db->query($sql))
    {
      dol_syslog($this->db->error());
    }

    $this->update_nb($mailing_id);
  }
}