advthirdparties.modules.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2005-2010  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       Frédéric France         <frederic.france@free.fr>
*
* This file is an example to follow to add your own email selector inside
* the Dolibarr email tool.
* Follow instructions given in README file to know what to change to build
* your own emailing list selector.
* Code that need to be changed in this file are marked by "CHANGE THIS" tag.
*/
 
include_once DOL_DOCUMENT_ROOT.'/core/modules/mailings/modules_mailings.php';
include_once DOL_DOCUMENT_ROOT.'/societe/class/societe.class.php';
include_once DOL_DOCUMENT_ROOT.'/contact/class/contact.class.php';
 
 
class mailing_advthirdparties extends MailingTargets
{
  public $name = 'ThirdPartyAdvancedTargeting';
 
  public $desc = "Third parties";
 
  public $require_admin = 0;
 
  public $require_module = array("none"); // This module should not be displayed as Selector in mailing
 
  public $picto = 'company';
 
  public $enabled = 'isModEnabled("societe")';
 
 
  public function __construct($db)
  {
    $this->db = $db;
  }
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function add_to_target_spec($mailing_id, $socid, $type_of_target, $contactid)
  {
    // phpcs:enable
    global $conf;
 
    dol_syslog(get_class($this)."::add_to_target_spec socid=".formatLogObject($socid).' contactid='.formatLogObject($contactid));
 
    $cibles = array();
 
    if (($type_of_target == 1) || ($type_of_target == 3)) {
      // Select the third parties from category
      if (count($socid) > 0) {
        $sql = "SELECT s.rowid as id, s.email as email, s.nom as name, null as fk_contact";
        $sql .= " FROM ".MAIN_DB_PREFIX."societe as s LEFT JOIN ".MAIN_DB_PREFIX."societe_extrafields se ON se.fk_object=s.rowid";
        $sql .= " WHERE s.entity IN (".getEntity('societe').")";
        $sql .= " AND s.rowid IN (".$this->db->sanitize(implode(',', $socid)).")";
        if (empty($this->evenunsubscribe)) {
          $sql .= " AND NOT EXISTS (SELECT rowid FROM ".MAIN_DB_PREFIX."mailing_unsubscribe as mu WHERE mu.email = s.email and mu.entity = ".((int) $conf->entity).")";
        }
        $sql .= " ORDER BY email";
 
        // Stock recipients emails into targets table
        $result = $this->db->query($sql);
        if ($result) {
          $num = $this->db->num_rows($result);
          $i = 0;
 
          dol_syslog(get_class($this)."::add_to_target_spec mailing ".$num." targets found", LOG_DEBUG);
 
          while ($i < $num) {
            $obj = $this->db->fetch_object($result);
 
            if (!empty($obj->email) && filter_var($obj->email, FILTER_VALIDATE_EMAIL)) {
              if (!array_key_exists($obj->email, $cibles)) {
                $cibles[$obj->email] = array(
                  'email' => $obj->email,
                  'fk_contact' => (int) $obj->fk_contact,
                  'name' => $obj->name,
                  'firstname' => $obj->firstname,
                  'other' => '',
                  'source_url' => $this->url($obj->id, 'thirdparty'),
                  'source_id' => (int) $obj->id,
                  'source_type' => 'thirdparty'
                );
              }
            }
 
            $i++;
          }
        } else {
          dol_syslog($this->db->error());
          $this->error = $this->db->error();
          return -1;
        }
      }
    }
 
    if (($type_of_target == 1) || ($type_of_target == 2) || ($type_of_target == 4)) {
      // Select the third parties from category
      if (count($socid) > 0 || count($contactid) > 0) {
        $sql = "SELECT socp.rowid as id, socp.email as email, socp.lastname as lastname, socp.firstname as firstname";
        $sql .= " FROM ".MAIN_DB_PREFIX."socpeople as socp";
        $sql .= " WHERE socp.entity IN (".getEntity('contact').")";
        if (count($contactid) > 0) {
          $sql .= " AND socp.rowid IN (".$this->db->sanitize(implode(',', $contactid)).")";
        }
        if (count($socid) > 0) {
          $sql .= " AND socp.fk_soc IN (".$this->db->sanitize(implode(',', $socid)).")";
        }
        if (empty($this->evenunsubscribe)) {
          $sql .= " AND NOT EXISTS (SELECT rowid FROM ".MAIN_DB_PREFIX."mailing_unsubscribe as mu WHERE mu.email = socp.email and mu.entity = ".((int) $conf->entity).")";
        }
        $sql .= " ORDER BY email";
 
        // Stock recipients emails into targets table
        $result = $this->db->query($sql);
        if ($result) {
          $num = $this->db->num_rows($result);
          $i = 0;
 
          dol_syslog(get_class($this)."::add_to_target_spec mailing ".$num." targets found");
 
          while ($i < $num) {
            $obj = $this->db->fetch_object($result);
 
            if (!empty($obj->email) && filter_var($obj->email, FILTER_VALIDATE_EMAIL)) {
              if (!array_key_exists($obj->email, $cibles)) {
                $cibles[$obj->email] = array(
                  'email' => $obj->email,
                  'fk_contact' => (int) $obj->id,
                  'lastname' => $obj->lastname,
                  'firstname' => $obj->firstname,
                  'other' => '',
                  'source_url' => $this->url($obj->id, 'contact'),
                  'source_id' => (int) $obj->id,
                  'source_type' => 'contact'
                );
              }
            }
 
            $i++;
          }
        } else {
          dol_syslog($this->db->error());
          $this->error = $this->db->error();
          return -1;
        }
      }
    }
 
    dol_syslog(get_class($this)."::add_to_target_spec mailing cibles=".formatLogObject($cibles), LOG_DEBUG);
 
    return parent::addTargetsToDatabase($mailing_id, $cibles);
  }
 
 
  public function getSqlArrayForStats()
  {
    // CHANGE THIS: Optional
 
    //var $statssql=array();
    //$this->statssql[0]="SELECT field1 as label, count(distinct(email)) as nb FROM mytable WHERE email IS NOT NULL";
    return array();
  }
 
 
  public function getNbOfRecipients($sql = '')
  {
    global $conf;
 
    $sql = "SELECT count(distinct(s.email)) as nb";
    $sql .= " FROM ".MAIN_DB_PREFIX."societe as s";
    $sql .= " WHERE s.email != ''";
    $sql .= " AND s.entity IN (".getEntity('societe').")";
    if (empty($this->evenunsubscribe)) {
      $sql .= " AND NOT EXISTS (SELECT rowid FROM ".MAIN_DB_PREFIX."mailing_unsubscribe as mu WHERE mu.email = s.email and mu.entity = ".((int) $conf->entity).")";
    }
 
    // La requete doit retourner un champ "nb" pour etre comprise par parent::getNbOfRecipients
    return parent::getNbOfRecipients($sql);
  }
 
  public function formFilter()
  {
    global $conf, $langs;
 
    $langs->load("companies");
 
    $s = '';
    $s .= '<select name="filter" class="flat">';
 
    // Show categories
    $sql = "SELECT rowid, label, type, visible";
    $sql .= " FROM ".MAIN_DB_PREFIX."categorie";
    $sql .= " WHERE type in (1,2)"; // We keep only categories for suppliers and customers/prospects
    // $sql.= " AND visible > 0"; // We ignore the property visible because third party's categories does not use this property (only products categories use it).
    $sql .= " AND entity = ".((int) $conf->entity);
    $sql .= " ORDER BY label";
 
    //print $sql;
    $resql = $this->db->query($sql);
    if ($resql) {
      $num = $this->db->num_rows($resql);
 
      if (!isModEnabled("category")) {
        $num = 0; // Force empty list if category module is not enabled
      }
 
      if ($num) {
        $s .= '<option value="0">&nbsp;</option>';
      } else {
        $s .= '<option value="0">'.$langs->trans("ContactsAllShort").'</option>';
      }
 
      $i = 0;
      while ($i < $num) {
        $obj = $this->db->fetch_object($resql);
 
        $type = '';
        if ($obj->type == 1) {
          $type = $langs->trans("Supplier");
        }
        if ($obj->type == 2) {
          $type = $langs->trans("Customer");
        }
        $s .= '<option value="'.$obj->rowid.'">'.dol_trunc($obj->label, 38, 'middle');
        if ($type) {
          $s .= ' ('.$type.')';
        }
        $s .= '</option>';
        $i++;
      }
    } else {
      dol_print_error($this->db);
    }
 
    $s .= '</select>';
    return $s;
  }
 
 
  public function url($id, $type)
  {
    $s = "";
    if ($type == 'thirdparty') {
      $companystatic = new Societe($this->db);
      $companystatic->fetch($id);
      $s = $companystatic->getNomUrl(0, 'nolink', 32, 1, 0);
    } elseif ($type == 'contact') {
      $contactstatic = new Contact($this->db);
      $contactstatic->fetch($id);
      $s = $contactstatic->getNomUrl(0, 'nolink', 1, '', 0, 32);
    }
 
    // When link is too long (for example because of hook in getNomUrl that complete the url), we return empty string.
    // Link is still possible with new source_id and source_type in db llx_mailing_cibles.
    if (strlen($s) > 255) {
      $s = "";
    }
 
    return $s;
  }
}