source: spip-zone/_plugins_/facteur/trunk/inc/envoyer_mail.php @ 118867

Last change on this file since 118867 was 118867, checked in by Cerdic, 8 months ago

brancher inc/envoyer_mail sur facteur_factory() et donc utiliser la nouvelle implementation de SPIP\Facteur\FacteurXXXX

File size: 12.5 KB
Line 
1<?php
2/**
3 * Plugin Facteur 4
4 * (c) 2009-2019 Collectif SPIP
5 * Distribue sous licence GPL
6 *
7 * @package SPIP\Facteur\Inc\Envoyer_mails
8 */
9
10if (!defined("_ECRIRE_INC_VERSION")) return;
11
12if (!defined('_LOG_FACTEUR')) {
13        define('_LOG_FACTEUR',_LOG_INFO);
14}
15
16include_spip('classes/facteur');
17// inclure le fichier natif de SPIP, pour les fonctions annexes
18include_once _DIR_RESTREINT."inc/envoyer_mail.php";
19
20/**
21 * @param string $destinataire
22 * @param string $sujet
23 * @param string|array $corps
24 *   au format string, c'est un corps d'email au format texte, comme supporte nativement par le core
25 *   au format array, c'est un corps etendu qui peut contenir
26 *     string texte : le corps d'email au format texte
27 *     string html : le corps d'email au format html
28 *     string from : email de l'envoyeur (prioritaire sur argument $from de premier niveau, deprecie)
29 *     string nom_envoyeur : un nom d'envoyeur pour completer l'email from
30 *     string cc : destinataires en copie conforme
31 *     string bcc : destinataires en copie conforme cachee
32 *     string|array repondre_a : une ou plusieurs adresses à qui répondre.
33 *       On peut aussi donner une liste de tableaux du type :
34 *         array('email' => 'test@exemple.com', 'nom' => 'Adresse de test')
35 *       pour spécifier un nom d'envoyeur pour chaque adresse.
36 *     string nom_repondre_a : le nom d'envoyeur pour compléter l'email repondre_a
37 *     string adresse_erreur : addresse de retour en cas d'erreur d'envoi
38 *     array pieces_jointes : listes de pieces a embarquer dans l'email, chacune au format array :
39 *       string chemin : chemin file system pour trouver le fichier a embarquer
40 *       string nom : nom du document tel qu'apparaissant dans l'email
41 *       string encodage : encodage a utiliser, parmi 'base64', '7bit', '8bit', 'binary', 'quoted-printable'
42 *       string mime : mime type du document
43 *     array headers : tableau d'en-tetes personalises, une entree par ligne d'en-tete
44 *     bool exceptions : lancer une exception en cas d'erreur (false par defaut)
45 * @param string $from (deprecie, utiliser l'entree from de $corps)
46 * @param string $headers (deprecie, utiliser l'entree headers de $corps)
47 * @return bool
48 */
49function inc_envoyer_mail($destinataire, $sujet, $corps, $from = "", $headers = "") {
50        $message_html   = '';
51        $message_texte  = '';
52        $nom_envoyeur = $cc = $bcc = $repondre_a = '';
53        $pieces_jointes = array();
54
55        // si $corps est un tableau -> fonctionnalites etendues
56        // avec entrees possible : html, texte, pieces_jointes, nom_envoyeur, ...
57        if (is_array($corps)) {
58                $message_html   = isset($corps['html']) ? $corps['html'] : "";
59                $message_texte  = isset($corps['texte']) ? nettoyer_caracteres_mail($corps['texte']) : "";
60                $pieces_jointes = isset($corps['pieces_jointes']) ? $corps['pieces_jointes'] : array();
61                $nom_envoyeur   = isset($corps['nom_envoyeur']) ? $corps['nom_envoyeur'] : "";
62                $from = isset($corps['from']) ? $corps['from']: $from;
63                $cc   = isset($corps['cc']) ? $corps['cc'] : "";
64                $bcc  = isset($corps['bcc']) ? $corps['bcc'] : "";
65                $repondre_a = isset($corps['repondre_a']) ? $corps['repondre_a'] : "";
66                $nom_repondre_a = isset($corps['nom_repondre_a']) ? $corps['nom_repondre_a'] : '';
67                $adresse_erreur = isset($corps['adresse_erreur']) ? $corps['adresse_erreur'] : "";
68                $headers = isset($corps['headers']) ? $corps['headers'] : $headers;
69                if (is_string($headers)){
70                        $headers = array_map('trim',explode("\n",$headers));
71                        $headers = array_filter($headers);
72                }
73        }
74        // si $corps est une chaine -> compat avec la fonction native SPIP
75        // gerer le cas ou le corps est du html avec un Content-Type: text/html dans les headers
76        else {
77                if (preg_match(',Content-Type:\s*text/html,ims',$headers)){
78                        $message_html   = $corps;
79                }
80                else {
81                        // Autodetection : tester si le mail est en HTML
82                        if (strpos($headers,"Content-Type:")===false
83                                AND strpos($corps,"<")!==false // eviter les tests suivants si possible
84                                AND $ttrim = trim($corps)
85                                AND substr($ttrim,0,1)=="<"
86                                AND substr($ttrim,-1,1)==">"
87                                AND stripos($ttrim,"</html>")!==false){
88
89                                if(!strlen($sujet)){
90                                        // dans ce cas on ruse un peu : extraire le sujet du title
91                                        if (preg_match(",<title>(.*)</title>,Uims",$corps,$m))
92                                                $sujet = $m[1];
93                                        else {
94                                                // fallback, on prend le body si on le trouve
95                                                if (preg_match(",<body[^>]*>(.*)</body>,Uims",$corps,$m))
96                                                        $ttrim = $m[1];
97
98                                                // et on extrait la premiere ligne de vrai texte...
99                                                // nettoyer le html et les retours chariots
100                                                $ttrim = textebrut($ttrim);
101                                                $ttrim = str_replace("\r\n", "\r", $ttrim);
102                                                $ttrim = str_replace("\r", "\n", $ttrim);
103                                                // decouper
104                                                $ttrim = explode("\n",trim($ttrim));
105                                                // extraire la premiere ligne de texte brut
106                                                $sujet = array_shift($ttrim);
107                                        }
108                                }
109                                $message_html   = $corps;
110                        }
111                        // c'est vraiment un message texte
112                        else
113                                $message_texte  = nettoyer_caracteres_mail($corps);
114                }
115                $headers = array_map('trim',explode("\n",$headers));
116                $headers = array_filter($headers);
117        }
118        $sujet = nettoyer_titre_email($sujet);
119
120        // si le mail est en texte brut, on l'encapsule dans un modele surchargeable
121        // pour garder le texte brut, il suffit de faire un modele qui renvoie uniquement #ENV*{texte}
122        if ($message_texte AND ! $message_html){
123                $message_html = recuperer_fond("emails/texte",array('texte'=>$message_texte,'sujet'=>$sujet));
124        }
125        // si le mail est en HTML sans alternative, la generer
126        if ($message_html AND !$message_texte){
127                $message_texte = facteur_mail_html2text($message_html);
128        }
129
130        $exceptions = false;
131        if (is_array($corps) AND isset($corps['exceptions'])){
132                $exceptions = $corps['exceptions'];
133        }
134
135        // mode TEST : forcer l'email
136        if (defined('_TEST_EMAIL_DEST')) {
137                if (!_TEST_EMAIL_DEST){
138                        spip_log($e=_T('facteur:erreur_envoi_bloque_constante'), 'mail.' . _LOG_ERREUR);
139                        if ($exceptions) {
140                                throw new Exception($e);
141                        }
142                        return false;
143                }
144                else
145                        $destinataire = _TEST_EMAIL_DEST;
146        }
147
148        // plusieurs destinataires peuvent etre fournis separes par des virgules
149        // c'est un format standard dans l'envoi de mail
150        // les passer au format array pour phpMailer
151        // mais ne pas casser si on a deja un array en entree
152        // si pas destinataire du courriel on renvoie false (eviter les warning PHP : ligne 464 de phpmailer-php5/class.phpmailer.php
153        // suppression des adresses de courriels invalides, si aucune valide, renvoyer false (eviter un warning PHP : ligne 464 de phpmailer-php5/class.phpmailer.php)
154        if (is_array($destinataire))
155                $destinataire = implode(", ",$destinataire);
156
157        if(strlen($destinataire) > 0){
158                $destinataire = array_map('trim',explode(",",$destinataire));
159                foreach ($destinataire as $key => $value) {
160                        if(!email_valide($value))
161                                unset($destinataire[$key]);
162                }
163                if(count($destinataire) == 0) {
164                        spip_log($e="Aucune adresse email de destination valable pour l'envoi du courriel.", 'mail.' . _LOG_ERREUR);
165                        if ($exceptions) {
166                                throw new Exception($e);
167                        }
168                        return false;
169                }
170        }
171        else {
172                if ($bcc) {
173                        // On peut envoyer de mail que en bcc
174                        $destinataire = '';
175                } else {
176                        spip_log($e="Aucune adresse email de destination valable pour l'envoi du courriel.", 'mail.' . _LOG_ERREUR);
177                        if ($exceptions) {
178                                throw new Exception($e);
179                        }
180                        return false;
181                }
182        }
183
184        // On crée l'objet Facteur (PHPMailer) pour le manipuler ensuite
185        $options = array();
186        if (is_array($corps) AND !empty($corps['exceptions'])){
187                $options['exceptions'] = $corps['exceptions'];
188        }
189        include_spip('inc/facteur');
190        $facteur = facteur_factory($options);
191        $facteur->setDest($destinataire);
192        $facteur->setObjet($sujet);
193        $facteur->setMessage($message_html, $message_texte);
194
195        // On ajoute le courriel de l'envoyeur s'il est fournit par la fonction
196        if (empty($from) AND empty($facteur->From)) {
197                $from = $GLOBALS['meta']["email_envoi"];
198                if (empty($from) OR !email_valide($from)) {
199                        spip_log("Meta email_envoi invalide. Le mail sera probablement vu comme spam.", 'mail.' . _LOG_ERREUR);
200                        if(is_array($destinataire) && count($destinataire) > 0)
201                                $from = $destinataire[0];
202                        else
203                                $from = $destinataire;
204                }
205        }
206
207        // "Marie Toto <Marie@toto.com>"
208        if (preg_match(",^([^<>\"]*)<([^<>\"]+)>$,i",$from,$m)){
209                $nom_envoyeur = trim($m[1]);
210                $from = trim($m[2]);
211        }
212        if (!empty($from)){
213                $facteur->From = $from;
214                // la valeur par défaut de la config n'est probablement pas valable pour ce mail,
215                // on l'écrase pour cet envoi
216                $facteur->FromName = $from;
217        }
218
219        // On ajoute le nom de l'envoyeur s'il fait partie des options
220        if ($nom_envoyeur)
221                $facteur->FromName = $nom_envoyeur;
222
223        // Si plusieurs emails dans le from, pas de Name !
224        if (strpos($facteur->From,",")!==false){
225                $facteur->FromName = "";
226        }
227
228        // S'il y a des copies à envoyer
229        if ($cc){
230                if (is_array($cc))
231                        foreach ($cc as $courriel)
232                                $facteur->AddCC($courriel);
233                else
234                        $facteur->AddCC($cc);
235        }
236
237        // S'il y a des copies cachées à envoyer
238        if ($bcc){
239                if (is_array($bcc))
240                        foreach ($bcc as $courriel)
241                                $facteur->AddBCC($courriel);
242                else
243                        $facteur->AddBCC($bcc);
244        }
245
246        // S'il y a une adresse de reply-to
247        if ($repondre_a) {
248                if (is_array($repondre_a)) {
249                        foreach ($repondre_a as $courriel) {
250                                if (is_array($courriel)) {
251                                        $facteur->AddReplyTo($courriel['email'], $courriel['nom']);
252                                } else {
253                                        $facteur->AddReplyTo($courriel);
254                                }
255                        }
256                } elseif ($nom_repondre_a) {
257                        $facteur->AddReplyTo($repondre_a, $nom_repondre_a);
258                } else {
259                        $facteur->AddReplyTo($repondre_a);
260                }
261        }
262
263        // S'il y a des pièces jointes on les ajoute proprement
264        if (count($pieces_jointes)) {
265                foreach ($pieces_jointes as $piece) {
266                        $facteur->AddAttachment(
267                                $piece['chemin'],
268                                isset($piece['nom']) ? $piece['nom']:'',
269                                (isset($piece['encodage']) AND in_array($piece['encodage'],array('base64', '7bit', '8bit', 'binary', 'quoted-printable'))) ? $piece['encodage']:'base64',
270                                isset($piece['mime']) ? $piece['mime']:Facteur::_mime_types(pathinfo($piece['chemin'], PATHINFO_EXTENSION))
271                        );
272                }
273        }
274
275        // Si une adresse email a été spécifiée pour les retours en erreur, on l'ajoute
276        if (!empty($adresse_erreur))
277                $facteur->Sender = $adresse_erreur;
278
279        // si entetes personalises : les ajouter
280        // attention aux collisions : si on utilise l'option cc de $corps
281        // et qu'on envoie en meme temps un header Cc: xxx, yyy
282        // on aura 2 lignes Cc: dans les headers
283        if (!empty($headers)) {
284                foreach($headers as $h){
285                        // verifions le format correct : il faut au moins un ":" dans le header
286                        // et on filtre le Content-Type: qui sera de toute facon fourni par facteur
287                        if (strpos($h,":")!==false
288                          AND strncmp($h,"Content-Type:",13)!==0)
289                                $facteur->AddCustomHeader($h);
290                }
291        }
292
293        // On passe dans un pipeline pour modifier tout le facteur avant l'envoi
294        $facteur = pipeline('facteur_pre_envoi', $facteur);
295
296        // On génère les headers
297        $head = $facteur->CreateHeader();
298
299        // Et c'est parti on envoie enfin
300        $backtrace = facteur_backtrace();
301        $trace = trim($head);
302        // si c'est un envoi par mail() on a pas le sujet dans le head, ce qui rend le debug complique, on l'ajoute manuellement
303        if (strpos($trace, 'Subject:') === false) {
304                $trace .= "\nSubject: $sujet";
305        }
306        $trace .= ($destinataire ? "\nDestinataire: " . implode(', ', $destinataire): '');
307        spip_log("mail via facteur\n$trace",'mail'._LOG_FACTEUR);
308        spip_log("mail\n$backtrace\n$trace",'facteur'._LOG_FACTEUR);
309        $retour = $facteur->Send();
310
311        if (!$retour){
312                spip_log("Erreur Envoi mail via Facteur : ".print_r($facteur->ErrorInfo,true),'mail.'._LOG_ERREUR);
313        }
314
315        return $retour ;
316}
317
318/**
319 * Retourne la pile de fonctions utilisée pour envoyer un mail
320 *
321 * @note
322 *     Ignore les fonctions `include_once`, `include_spip`, `find_in_path`
323 * @return array|string
324 *     pile d'appel
325 **/
326function facteur_backtrace($limit=10) {
327        $trace = debug_backtrace();
328        $caller = array_shift($trace);
329        while (count($trace) and (empty($trace[0]['file']) or $trace[0]['file'] === $caller['file'] or $trace[0]['file'] === __FILE__)) {
330                array_shift($trace);
331        }
332
333        $message = count($trace) ? $trace[0]['file'] . " L" . $trace[0]['line'] : "";
334        $f = array();
335        while (count($trace) and $t = array_shift($trace) and count($f)<$limit) {
336                if (in_array($t['function'], array('include_once', 'include_spip', 'find_in_path'))) {
337                        break;
338                }
339                $f[] = $t['function'];
340        }
341        if (count($f)) {
342                $message .= " [" . implode("(),", $f) . "()]";
343        }
344
345        return $message;
346}
Note: See TracBrowser for help on using the repository browser.