Subversion Repositories eFlore/Applications.del

Rev

Rev 1867 | Rev 2038 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
1020 aurelien 1
<?php
2
// declare(encoding='UTF-8');
3
/**
4
 * Le script récupère tous les commentaires et déterminations fait ce jour et envoie un mail
5
 * aux auteurs des observations récapitulant celle-ci
6
 *
1867 jpm 7
 * @category   DEL
8
 * @package    Scripts
9
 * @subpackage Commentaires
10
 * @author     Mathias CHOUET <mathias@tela-botanica.org>
11
 * @author     Jean-Pascal MILCENT <jpm@tela-botanica.org>
12
 * @author     Aurelien PERONNET <aurelien@tela-botanica.org>
13
 * @license    GPL v3 <http://www.gnu.org/licenses/gpl.txt>
14
 * @license    CECILL v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt>
15
 * @copyright  1999-2014 Tela Botanica <accueil@tela-botanica.org>
1020 aurelien 16
 */
17
class AlerteMailCommentaires {
18
 
19
	private $conteneur;
1737 jpm 20
	private $testeurCourriel = null;
21
	private $recapitulatifAdmin = [];
22
	private $messageRecapitulatif = null;
1571 jpm 23
 
1747 jpm 24
	private $dateRenvoi = null;
25
 
1020 aurelien 26
	private $observations_concernees = array();
27
	private $correspondance_id_obs_auteurs = array();
1737 jpm 28
	private 	$utilisateursInfos = array();
1571 jpm 29
 
1683 jpm 30
	public function __construct($conteneur) {
1020 aurelien 31
		$this->conteneur = $conteneur;
32
	}
1571 jpm 33
 
1020 aurelien 34
	public function executer() {
35
		try {
1737 jpm 36
			$this->verifierModeUtilisation();
1747 jpm 37
			$this->verifierDateRenvoi();
1020 aurelien 38
			$observations = $this->chargerObservationsCommentees();
1571 jpm 39
			if (!empty($observations)) {
1349 aurelien 40
				$this->formaterObservations($observations);
1683 jpm 41
				$commentaires = $this->chargerCommentairesDuJour();
1349 aurelien 42
				$this->formaterCommentaires($commentaires);
1683 jpm 43
				$this->envoyerMessageAuxDestinataires();
1349 aurelien 44
			}
1020 aurelien 45
		} catch (Exception $e) {
46
			$this->traiterErreur($e->getMessage());
47
		}
48
	}
49
 
1737 jpm 50
	private function verifierModeUtilisation() {
51
		$testeurCourriel = $this->conteneur->getParametre('t');
52
		if ($testeurCourriel) {
53
			if (filter_var($testeurCourriel, FILTER_VALIDATE_EMAIL)) {
54
				$this->testeurCourriel = $testeurCourriel;
55
			} else {
56
				$msg = "Veuillez indiquer une adresse de courriel valide à la suite du paramètre «-t».";
57
				new Exception($msg);
58
			}
59
		}
60
	}
61
 
1747 jpm 62
	private function verifierDateRenvoi() {
63
		$dateRenvoi = $this->conteneur->getParametre('d');
64
		if ($dateRenvoi) {
65
			if (preg_match('/^[0-9]{4}-[0-1][0-9]-[0-3][0-9]$/', $dateRenvoi)) {
66
				$this->dateRenvoi = $dateRenvoi;
67
			} else {
68
				$msg = "Veuillez indiquer une date au format yyyy-mm-dd valide à la suite du paramètre «-d».";
69
				new Exception($msg);
70
			}
71
		}
72
	}
73
 
1683 jpm 74
	private function chargerObservationsCommentees() {
1649 aurelien 75
		// Seuls les utilisateurs ayant explicitement refusé le mail sont ignorés
1571 jpm 76
		$preferences = $this->conteneur->getBdd()->proteger('%"mail_notification_mes_obs":"0"%');
1747 jpm 77
		$date = ($this->dateRenvoi == null) ? 'NOW()' : "'$this->dateRenvoi'";
78
 
1020 aurelien 79
		//TODO: optimiser la requête si beaucoup de mails sont envoyés
1571 jpm 80
		$requete = "SELECT * FROM del_observation AS do ".
1575 jpm 81
			"WHERE do.id_observation IN ".
82
				"( ".
1678 aurelien 83
					//TODO: essayer de factoriser cette sous requete entre ici et la fonction du dessus
1575 jpm 84
					"SELECT dc.ce_observation ".
85
					"FROM del_commentaire AS dc ".
86
					"WHERE dc.ce_observation != '0' ".
87
					"AND dc.id_commentaire NOT IN ".
1571 jpm 88
					"( ".
1575 jpm 89
					"	SELECT dc.id_commentaire ".
90
					"	FROM del_commentaire AS dc, del_observation AS dob".
91
					"	WHERE dc.nom_sel = dob.nom_sel ".
92
					"		AND dc.ce_utilisateur = dob.ce_utilisateur ".
93
					"		AND dc.ce_observation = dob.id_observation ".
94
					") ".
1747 jpm 95
					"AND TO_DAYS($date) - TO_DAYS(dc.date) IN (0, 1) ".
1575 jpm 96
				") ".
1649 aurelien 97
				"AND do.ce_utilisateur NOT IN ".
98
					"( ".
99
					"	SELECT id_utilisateur ".
100
					"	FROM del_utilisateur_infos ".
101
					"	WHERE preferences LIKE $preferences ".
102
					") ".
1575 jpm 103
			"ORDER BY do.ce_utilisateur, do.id_observation ";
1020 aurelien 104
		$observations = $this->conteneur->getBdd()->recupererTous($requete);
105
		return $observations;
106
	}
1571 jpm 107
 
1783 mathias 108
	// classe les observations concernées par id_utilisateur (ou courriel si non inscrit)
109
	// de l'auteur puis par id_observation
1683 jpm 110
	private function formaterObservations($liste_obs) {
1020 aurelien 111
		foreach ($liste_obs as $obs) {
112
			$id_obs = $obs['id_observation'];
1737 jpm 113
			$id_auteur_obs = $obs['ce_utilisateur'];
1783 mathias 114
			if (($id_auteur_obs == 0) && ($obs['courriel_utilisateur'] != '')) {
115
				$id_auteur_obs = $obs['courriel_utilisateur'];
116
			}
1737 jpm 117
 
118
			$infos = array();
119
			$infos['id'] = $id_obs;
120
			$infos['nom_sci'] = $this->formaterNomSci($obs);
121
			$infos['date'] = $this->formaterDate($obs['date_observation']);
122
			$infos['lieu'] = $this->formaterLieu($obs);
123
			$infos['lien'] = $this->obtenirLienFiche($id_obs);
124
			$infos['commentaires'] = array();
125
 
126
			$this->correspondance_id_obs_auteurs[$id_obs] = $id_auteur_obs;
127
			$this->observations_concernees[$id_auteur_obs][$id_obs] = $infos;
1020 aurelien 128
		}
129
	}
1571 jpm 130
 
1737 jpm 131
	private function formaterNomSci($obs) {
132
		$nom = 'Espèce indéterminée';
133
		if ($obs['nom_ret'] != '') {
134
			$nom = $obs['nom_ret'];
135
		} else if($obs['nom_sel'] != '') {
136
			$nom = $obs['nom_sel'];
137
		}
138
		return $nom;
1683 jpm 139
	}
140
 
1737 jpm 141
	private function formaterDate($date) {
142
		$dateFmt = '(date inconnue)';
143
		if ($date != '0000-00-00 00:00:00') {
144
			$time = strtotime($date);
145
			$dateFmt = date('d/m/Y', $time);
1348 aurelien 146
		}
1737 jpm 147
		return $dateFmt;
148
	}
149
 
150
	private function formaterLieu($obs) {
151
		$lieuInfos = [];
152
		$champsLieu = ['zone_geo', 'lieudit', 'station'];
153
		foreach ($champsLieu as $champ) {
154
			if (trim($obs[$champ]) == '') {
155
				continue;
156
			}
157
 
158
			$lieuIntitule = $obs[$champ];
159
			if ($champ == 'zone_geo') {
160
				$codeDept = $this->convertirCodeZoneGeoVersDepartement($obs['ce_zone_geo']);
161
				$lieuIntitule .= empty($codeDept) ? '' : " ($codeDept)";
162
			}
163
			$lieuInfos[] = $lieuIntitule;
1348 aurelien 164
		}
1737 jpm 165
		$lieu = (count($lieuInfos) > 0) ? implode(' > ', $lieuInfos) : '(lieu inconnu)';
166
		return $lieu;
1348 aurelien 167
	}
1571 jpm 168
 
1683 jpm 169
	private function convertirCodeZoneGeoVersDepartement($code_zone_geo) {
170
		$code_departement = '';
1752 jpm 171
		if (preg_match('/^INSEE-C:([0-9]{2})[0-9]{3}$/', $code_zone_geo, $match)) {
1737 jpm 172
			$code_departement = $match[1];
1683 jpm 173
		}
174
		return $code_departement;
175
	}
176
 
1737 jpm 177
	private function obtenirLienFiche($id_obs) {
1683 jpm 178
		return sprintf($this->conteneur->getParametre('url_fiche_observation'), $id_obs);
179
	}
180
 
181
	protected function chargerCommentairesDuJour() {
182
		$preferences = $this->conteneur->getBdd()->proteger('%"mail_notification_mes_obs":"0"%');
1747 jpm 183
		$date = ($this->dateRenvoi == null) ? 'NOW()' : "'$this->dateRenvoi'";
184
 
1683 jpm 185
		// TODO: optimiser la requête si beaucoup de mails sont envoyés
186
		$requete = "SELECT * ".
187
			"FROM del_commentaire AS dc ".
188
			"WHERE dc.ce_observation != '0' ".
189
			"AND dc.id_commentaire NOT IN ".
190
			"( ".
191
			"	SELECT dc.id_commentaire ".
192
			"	FROM del_commentaire AS dc, del_observation AS dob".
193
			"	WHERE dc.nom_sel = dob.nom_sel ".
194
			"		AND dc.ce_utilisateur = dob.ce_utilisateur ".
195
			"		AND dc.ce_observation = dob.id_observation ".
196
			") ".
197
			"AND dc.ce_utilisateur NOT IN ".
198
			"( ".
199
			"	SELECT id_utilisateur ".
200
			"	FROM del_utilisateur_infos ".
201
			"	WHERE preferences LIKE $preferences ".
202
			") ".
1747 jpm 203
			"AND TO_DAYS($date) - TO_DAYS(dc.date) IN (0, 1) ".
1683 jpm 204
			"ORDER BY dc.ce_observation";
205
		$commentaires = $this->conteneur->getBdd()->recupererTous($requete);
206
		return $commentaires;
207
	}
208
 
1020 aurelien 209
	protected function formaterCommentaires($liste_commentaires) {
210
		foreach ($liste_commentaires as $commentaire) {
211
			$id_obs = $commentaire['ce_observation'];
1737 jpm 212
			if (isset($this->correspondance_id_obs_auteurs[$id_obs])) {
213
				$id_auteur_obs = $this->correspondance_id_obs_auteurs[$id_obs];
2037 mathias 214
				// si l'auteur du commentaire est l'auteur de l'obs, on évite de lui
215
				// rappeler qu'il se parle à lui-même
216
				$id_auteur_commentaire = $commentaire['ce_utilisateur'];
217
				if ($id_auteur_commentaire == 0 || $id_auteur_commentaire == '') { // cas du commentateur non-inscrit
218
					$id_auteur_commentaire = $commentaire['utilisateur_courriel'];
219
				}
220
				if ($id_auteur_obs != $id_auteur_commentaire) {
221
					$commentaire['auteur'] = $this->formaterAuteur($commentaire);
222
					$this->observations_concernees[$id_auteur_obs][$id_obs]['commentaires'][] = $commentaire;
223
				}
1348 aurelien 224
			}
1020 aurelien 225
		}
226
	}
1571 jpm 227
 
1683 jpm 228
	private function formaterAuteur($commentaire) {
229
		return $commentaire['utilisateur_prenom'].' '.$commentaire['utilisateur_nom'];
230
	}
231
 
232
	protected function envoyerMessageAuxDestinataires() {
1737 jpm 233
		foreach ($this->observations_concernees as $auteurId => $liste_obs) {
1783 mathias 234
			$messageTxt = '';
235
			$messageHtml = '';
1737 jpm 236
			$donnees = $this->formaterDonneesPourMessage($auteurId, $liste_obs);
237
 
1784 mathias 238
			if (is_numeric($auteurId)) { // inscrits
239
				if ($auteurId != 0) {
240
					$messageTxt = $this->formaterMessageTxt($donnees, true);
241
					$messageHtml = $this->formaterMessageHtml($donnees, true);
242
					if ($this->testeurCourriel == null) {
1783 mathias 243
						$this->envoyerMessage($messageHtml, $messageTxt, $auteurId);
244
					}
1784 mathias 245
				}
246
			} else { // non-inscrits
247
				$messageTxt = $this->formaterMessageTxt($donnees, false);
248
				$messageHtml = $this->formaterMessageHtml($donnees, false);
249
				if ($this->testeurCourriel == null) {
1783 mathias 250
					$this->envoyerMessageAdresseArbitraire($messageHtml, $messageTxt, $auteurId);
251
				}
1737 jpm 252
			}
1784 mathias 253
 
1783 mathias 254
			$this->recapitulatifAdmin[$auteurId] = array('txt' => $messageTxt, 'html' => $messageHtml);
1020 aurelien 255
		}
1737 jpm 256
		if ($this->testeurCourriel == null) {
257
			$this->envoyerMessageRecap();
258
		}
259
		$this->envoyerMessagesTesteur();
1020 aurelien 260
	}
1571 jpm 261
 
1783 mathias 262
	// Envoie un message sans passer par l'annuaire, pour les utilisateurs non inscrits
263
	private function envoyerMessageAdresseArbitraire($messageHtml, $messageTxt, $adresseAuteur) {
264
		$dateFmt = $this->formaterDateCourante();
265
		$sujet = sprintf($this->conteneur->getParametre('titre_message_recapitulatif'), $dateFmt);
266
		$messagerie = $this->conteneur->getMessagerie();
267
 
268
		// envoi mixte HTML + texte
269
		$envoieStatut = $messagerie->envoyerHtml($adresseAuteur, $sujet, $messageHtml, $messageTxt);
270
		return $envoieStatut;
271
	}
272
 
273
	private function formaterMessageHtml($donnees, $inscrit=true) {
274
		if ($inscrit) {
275
			$squelette = dirname(__FILE__).DS.'squelettes'.DS.'commentaires.tpl.html';
276
		} else {
277
			$squelette = dirname(__FILE__).DS.'squelettes'.DS.'commentaires_non_inscrits.tpl.html';
278
		}
1737 jpm 279
		$squelettePhp = $this->conteneur->getSquelettePhp();
280
		$msgHtml = $squelettePhp->analyser($squelette, $donnees);
281
		return $msgHtml;
282
	}
283
 
1783 mathias 284
	private function formaterMessageTxt($donnees, $inscrit=true) {
285
		if ($inscrit) {
286
			$squelette = dirname(__FILE__).DS.'squelettes'.DS.'commentaires.tpl.txt';
287
		} else {
288
			$squelette = dirname(__FILE__).DS.'squelettes'.DS.'commentaires_non_inscrits.tpl.txt';
289
		}
1737 jpm 290
		$squelettePhp = $this->conteneur->getSquelettePhp();
291
		$msgTxt = $squelettePhp->analyser($squelette, $donnees);
292
		// Nettoyage des tabulations pour indentation du code PHP
293
		$msgTxt = str_replace("\t", '', $msgTxt);
294
		return $msgTxt;
295
	}
296
 
297
	private function formaterDonneesPourMessage($auteurId, $liste_obs) {
1020 aurelien 298
		$donnees = array();
299
		$donnees['liste_observations'] = $liste_obs;
1784 mathias 300
 
301
		if (is_numeric($auteurId)) { // inscrit
302
			$infosUtilisateur = $this->telechargerUtilisateurInfos($auteurId);
303
			$donnees['auteur_formate'] = $this->formaterIntituleUtilisateur($infosUtilisateur);
304
		} else { // non-inscrit
1786 mathias 305
			$donnees['auteur_formate'] = $auteurId;
1784 mathias 306
		}
307
 
1737 jpm 308
		return $donnees;
309
	}
1571 jpm 310
 
1737 jpm 311
	private function formaterIntituleUtilisateur($infos) {
312
		$intituleUtilisateur = isset($infos->intitule) ? $infos->intitule : '';
313
		return $intituleUtilisateur;
1020 aurelien 314
	}
1571 jpm 315
 
1783 mathias 316
	// envoie un message à un utilisateur inscrit, à l'aide de l'annuaire
1737 jpm 317
	private function envoyerMessage($messageHtml, $messageTxt, $id_destinataire) {
1783 mathias 318
 
1737 jpm 319
		$url = sprintf($this->conteneur->getParametre('url_service_messagerie'), $id_destinataire);
1747 jpm 320
		$dateFmt = $this->formaterDateCourante();
321
		$sujet = sprintf($this->conteneur->getParametre('titre_message_recapitulatif'), $dateFmt);
1737 jpm 322
		$donnees = array(
323
			'utilisateur_courriel' => $this->conteneur->getParametre('adresse_expediteur_recapitulatif'),
1789 mathias 324
			'reponse_courriel' => $this->conteneur->getParametre('adresse_reponse'),  // reply-to
1737 jpm 325
			'format' => 'html',
1747 jpm 326
			'sujet' => $sujet,
1737 jpm 327
			'message' => $messageHtml,
328
			'message_txt' => $messageTxt
1020 aurelien 329
		);
330
 
1737 jpm 331
		$clientRest = $this->conteneur->getRestClient();
332
		$clientRest->modifier($url, $donnees);
1020 aurelien 333
	}
1737 jpm 334
 
1747 jpm 335
	private function formaterDateCourante() {
336
		$date = ($this->dateRenvoi == null) ? time() : strtotime($this->dateRenvoi);
337
		$dateFmt = date('d-m-Y', $date);
338
		return $dateFmt;
339
	}
340
 
1737 jpm 341
	private function envoyerMessageRecap() {
342
		$msgRecap = $this->obtenirMessageRecap();
1747 jpm 343
		$dateFmt = $this->formaterDateCourante();
1772 jpm 344
		$sujet = "IdentiPlante : commentaires du $dateFmt";
1737 jpm 345
		$messagerie = $this->conteneur->getMessagerie();
346
		$destinataire = $this->conteneur->getParametre('email_recap');
347
		$messagerie->envoyerTxt($destinataire, $sujet, $msgRecap);
348
	}
349
 
350
	private function obtenirMessageRecap() {
351
		if ($this->messageRecapitulatif == null) {
352
			$msgRecap = '';
353
			$separateur = str_repeat('-', 50);
354
			$utilisateursIntitules = $this->obtenirInfosUtilisateurs();
355
			foreach ($this->recapitulatifAdmin as $utilisateurId => $message) {
356
				$messageTxt = $message['txt'];
357
				$intitule = $utilisateursIntitules[$utilisateurId];
358
				$msgRecap .= "Message envoyé à : $intitule\n\n$messageTxt\n$separateur\n";
359
			}
360
			$intituleRecap = implode("\n", $utilisateursIntitules);
361
 
362
			$msgTpl = "Messages envoyés aux utilisateurs suivant :\n%s\n%s\n%s";
363
			$this->messageRecapitulatif = sprintf($msgTpl, $intituleRecap, $separateur, $msgRecap);
364
		}
365
		return $this->messageRecapitulatif;
366
	}
367
 
1783 mathias 368
	// envoie au testeur une copie de chaque type de message envoyé aux utilisateurs
1737 jpm 369
	private function envoyerMessagesTesteur() {
370
		if ($this->testeurCourriel != null) {
371
			$messagerie = $this->conteneur->getMessagerie();
1747 jpm 372
			$dateFmt = $this->formaterDateCourante();
1737 jpm 373
 
1772 jpm 374
			$sujet = "TESTEUR : commentaires du $dateFmt";
1737 jpm 375
			$msgRecap = $this->obtenirMessageRecap();
376
			$messagerie->envoyerTxt($this->testeurCourriel, $sujet, $msgRecap);
377
 
1783 mathias 378
			// deux types de messages (inscrits et non inscrits)
379
			$messageInscrits = null;
380
			$messageNonInscrits = null;
381
			// méga sous optimal
382
			foreach($this->recapitulatifAdmin as $idUtil => $mess) {
383
				if ($messageInscrits != null && $messageNonInscrits != null) {
384
					break; // arrière, Satan ! (mais c'est bien pratique)
385
				}
1785 mathias 386
				if (is_numeric($idUtil) && ($idUtil != 0)) {
1783 mathias 387
					$messageInscrits = $mess;
388
				} else {
389
					$messageNonInscrits = $mess;
390
				}
391
			}
1737 jpm 392
 
1783 mathias 393
			$sujet = "TESTEUR : HTML (inscrits) - commentaire du $dateFmt";
394
			$messagerie->envoyerHtml($this->testeurCourriel, $sujet, $messageInscrits['html'], $messageInscrits['txt']);
395
 
396
			$sujet = "TESTEUR : TXT (inscrits) - commentaire du $dateFmt";
397
			$messagerie->envoyerTxt($this->testeurCourriel, $sujet, $messageInscrits['txt']);
398
 
399
			$sujet = "TESTEUR : HTML (non inscrits) - commentaire du $dateFmt";
400
			$messagerie->envoyerHtml($this->testeurCourriel, $sujet, $messageNonInscrits['html'], $messageNonInscrits['txt']);
401
 
402
			$sujet = "TESTEUR : TXT (non inscrits) - commentaire du $dateFmt";
403
			$messagerie->envoyerTxt($this->testeurCourriel, $sujet, $messageNonInscrits['txt']);
1737 jpm 404
		}
405
	}
406
 
407
	private function obtenirInfosUtilisateurs() {
408
		$idUtilisateurs = array_keys($this->recapitulatifAdmin);
409
		$utilisateursIntitules = [];
410
		foreach ($idUtilisateurs as $utilisateurId) {
1783 mathias 411
			if (is_numeric($utilisateurId)) { // inscrit
412
				$infosUtilisateur = $this->telechargerUtilisateurInfos($utilisateurId);
413
				$intitule = $this->formaterUtilisateurInfos($infosUtilisateur);
414
			} else { // non-inscrit
415
				$intitule = $utilisateurId . " - utilisateur non inscrit";
416
			}
1737 jpm 417
			$utilisateursIntitules[$utilisateurId] = $intitule;
418
		}
419
		asort($utilisateursIntitules);
420
		return $utilisateursIntitules;
421
	}
422
 
423
	private function telechargerUtilisateurInfos($utilisateurId) {
424
		if (! isset($this->utilisateursInfos[$utilisateurId])) {
425
			$urlTpl = $this->conteneur->getParametre('url_service_utilisateur');
426
			$url = sprintf($urlTpl, $utilisateurId);
427
			$clientRest = $this->conteneur->getRestClient();
428
			$json = $clientRest->consulter($url);
429
			$infos = json_decode($json);
430
			$this->utilisateursInfos[$utilisateurId] = isset($infos->id) ? $infos : $utilisateurId;
431
		}
432
		return $this->utilisateursInfos[$utilisateurId];
433
	}
434
 
435
	private function formaterUtilisateurInfos($infos) {
436
		$utilisateurId = isset($infos->id) ? $infos->id : intval($infos);
437
		if (isset($infos->courriel) && isset($infos->intitule)) {
438
			$prenomNom = $infos->nom.' '.$infos->prenom;
439
			$pseudo = empty($infos->pseudo) ? '' : '['.$infos->pseudo.'] ';
440
			$courriel = $infos->courriel;
441
			$intitule = "$prenomNom $pseudo($courriel) - id#$utilisateurId";
442
		} else {
443
			$intitule = "Utilisateur avec id $utilisateurId introuvable";
444
		}
445
		return $intitule;
446
	}
447
}