/***************************************************************************\
* SPIP, Systeme de publication pour l'internet *
* *
- * Copyright (c) 2001-2016 *
+ * Copyright (c) 2001-2017 *
* Arnaud Martin, Antoine Pitrou, Philippe Riviere, Emmanuel Saint-James *
* *
* Ce programme est un logiciel libre distribue sous licence GNU/GPL. *
* Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne. *
\***************************************************************************/
-if (!defined('_ECRIRE_INC_VERSION')) return;
+/**
+ * Gestion des notifications
+ *
+ * @package SPIP\Core\Notifications
+ **/
+if (!defined('_ECRIRE_INC_VERSION')) {
+ return;
+}
/**
* La fonction de notification de base, qui dispatche le travail
- * http://doc.spip.org/@inc_notifications_dist
*
+ * @api
* @param string $quoi
- * evenement de notification
+ * Événement de notification
* @param int $id
- * id de l'objet en relation avec l'evenement
+ * id de l'objet en relation avec l'événement
* @param array $options
- * options de notification, interpretees en fonction de la notification
+ * Options de notification, interprétées en fonction de la notification
*/
-function inc_notifications_dist($quoi, $id=0, $options=array()) {
+function inc_notifications_dist($quoi, $id = 0, $options = array()) {
// charger les fichiers qui veulent ajouter des definitions
// ou faire des trucs aussi dans le pipeline, ca fait deux api pour le prix d'une ...
- pipeline('notifications',array('args'=>array('quoi'=>$quoi,'id'=>$id,'options'=>$options)));
+ pipeline('notifications', array('args' => array('quoi' => $quoi, 'id' => $id, 'options' => $options)));
- if ($notification = charger_fonction($quoi,'notifications',true)) {
+ if ($notification = charger_fonction($quoi, 'notifications', true)) {
spip_log("$notification($quoi,$id"
- .($options?",".serialize($options):"")
- .")",'notifications');
+ . ($options ? "," . serialize($options) : "")
+ . ")", 'notifications');
$notification($quoi, $id, $options);
}
}
/**
- * Nettoyage des emails avant un envoi
- * on passe par reference pour la perf
+ * Néttoyage des emails avant un envoi
*
- * les emails liste par $eclure seront exclus de la liste
+ * On passe par référence pour la perf
+ *
+ * les emails liste par $exclure seront exclus de la liste
*
* @param array $emails
* @param array $exclure
*/
-function notifications_nettoyer_emails(&$emails, $exclure = array()){
+function notifications_nettoyer_emails(&$emails, $exclure = array()) {
// filtrer et unifier
- include_spip('inc/filtres');
- $emails = array_unique(array_filter(array_map('email_valide',array_map('trim', $emails))));
- if ($exclure AND count($exclure)){
+ $emails = array_unique(array_filter(array_map('email_valide', array_map('trim', $emails))));
+ if ($exclure and count($exclure)) {
// nettoyer les exclusions d'abord
notifications_nettoyer_emails($exclure);
// faire un diff
- $emails = array_diff($emails,$exclure);
+ $emails = array_diff($emails, $exclure);
}
}
/**
* Envoyer un email de notification
- * Le sujet peut etre vide, dans ce cas il reprendra la premiere ligne non vide du texte
*
- * @param array/string $emails
+ * Le sujet peut être vide, dans ce cas il reprendra la première ligne non vide du texte
+ *
+ * @param array|string $emails
* @param string $texte
* @param string $sujet
* @param string $from
* @param string $headers
*/
-function notifications_envoyer_mails($emails, $texte, $sujet="", $from = "", $headers = ""){
+function notifications_envoyer_mails($emails, $texte, $sujet = "", $from = "", $headers = "") {
// rien a faire si pas de texte !
- if (!strlen($texte))
+ if (!strlen($texte)) {
return;
+ }
// si on ne specifie qu'un email, le mettre dans un tableau
- if (!is_array($emails))
- $emails = explode(',',$emails);
+ if (!is_array($emails)) {
+ $emails = explode(',', $emails);
+ }
notifications_nettoyer_emails($emails);
// tester si le mail est deja en html
- if (strpos($texte,"<")!==false // eviter les tests suivants si possible
- AND $ttrim = trim($texte)
- AND substr($ttrim,0,1)=="<"
- AND substr($ttrim,-1,1)==">"
- AND stripos($ttrim,"</html>")!==false){
-
- if(!strlen($sujet)){
+ if (strpos($texte, "<") !== false // eviter les tests suivants si possible
+ and $ttrim = trim($texte)
+ and substr($ttrim, 0, 1) == "<"
+ and substr($ttrim, -1, 1) == ">"
+ and stripos($ttrim, "</html>") !== false
+ ) {
+
+ if (!strlen($sujet)) {
// dans ce cas on ruse un peu : extraire le sujet du title
- if (preg_match(",<title>(.*)</title>,Uims",$texte,$m))
+ if (preg_match(",<title>(.*)</title>,Uims", $texte, $m)) {
$sujet = $m[1];
- else {
+ } else {
// fallback, on prend le body si on le trouve
- if (preg_match(",<body[^>]*>(.*)</body>,Uims",$texte,$m))
+ if (preg_match(",<body[^>]*>(.*)</body>,Uims", $texte, $m)) {
$ttrim = $m[1];
+ }
// et on extrait la premiere ligne de vrai texte...
// nettoyer le html et les retours chariots
$ttrim = str_replace("\r\n", "\r", $ttrim);
$ttrim = str_replace("\r", "\n", $ttrim);
// decouper
- $ttrim = explode("\n",trim($ttrim));
+ $ttrim = explode("\n", trim($ttrim));
// extraire la premiere ligne de texte brut
$sujet = array_shift($ttrim);
}
}
// si besoin on ajoute le content-type dans les headers
- if (stripos($headers,"Content-Type")===false)
+ if (stripos($headers, "Content-Type") === false) {
$headers .= "Content-Type: text/html\n";
+ }
}
// si le sujet est vide, extraire la premiere ligne du corps
// du mail qui est donc du texte
- if (!strlen($sujet)){
+ if (!strlen($sujet)) {
// nettoyer un peu les retours chariots
$texte = str_replace("\r\n", "\r", $texte);
$texte = str_replace("\r", "\n", $texte);
// decouper
- $texte = explode("\n",trim($texte));
+ $texte = explode("\n", trim($texte));
// extraire la premiere ligne
$sujet = array_shift($texte);
- $texte = trim(implode("\n",$texte));
+ $texte = trim(implode("\n", $texte));
}
- $envoyer_mail = charger_fonction('envoyer_mail','inc');
- foreach($emails as $email){
+ $envoyer_mail = charger_fonction('envoyer_mail', 'inc');
+ foreach ($emails as $email) {
// passer dans un pipeline qui permet un ajout eventuel
// (url de suivi des notifications par exemple)
- $envoi = pipeline('notifications_envoyer_mails',array('email'=>$email,'sujet'=>$sujet,'texte'=>$texte));
+ $envoi = pipeline('notifications_envoyer_mails', array('email' => $email, 'sujet' => $sujet, 'texte' => $texte));
$email = $envoi['email'];
- job_queue_add('envoyer_mail', ">$email : ".$envoi['sujet'], array($email, $envoi['sujet'], $envoi['texte'], $from, $headers), 'inc/');
+ job_queue_add('envoyer_mail', ">$email : " . $envoi['sujet'],
+ array($email, $envoi['sujet'], $envoi['texte'], $from, $headers), 'inc/');
}
}
/**
- * Notifier un evenement sur un objet
- * recupere le fond designe dans $modele,
- * prend la premiere ligne comme sujet
- * et l'interprete pour envoyer l'email
+ * Notifier un événement sur un objet
+ *
+ * Récupère le fond désigné dans $modele,
+ * prend la première ligne comme sujet
+ * et l'interprète pour envoyer l'email
*
* @param int $id_objet
* @param string $type_objet
* @return string
*/
function email_notification_objet($id_objet, $type_objet, $modele) {
- $envoyer_mail = charger_fonction('envoyer_mail','inc'); // pour nettoyer_titre_email
+ $envoyer_mail = charger_fonction('envoyer_mail', 'inc'); // pour nettoyer_titre_email
$id_type = id_table_objet($type_objet);
- return recuperer_fond($modele,array($id_type=>$id_objet,"id"=>$id_objet));
+
+ return recuperer_fond($modele, array($id_type => $id_objet, "id" => $id_objet));
}
/**
- * Notifier un evenement sur un article
- * recupere le fond designe dans $modele,
- * prend la premiere ligne comme sujet
- * et l'interprete pour envoyer l'email
+ * Notifier un événement sur un article
+ *
+ * Récupère le fond désigné dans $modele,
+ * prend la première ligne comme sujet
+ * et l'interprète pour envoyer l'email
*
* @param int $id_article
* @param string $modele
* @return string
*/
function email_notification_article($id_article, $modele) {
- $envoyer_mail = charger_fonction('envoyer_mail','inc'); // pour nettoyer_titre_email
+ $envoyer_mail = charger_fonction('envoyer_mail', 'inc'); // pour nettoyer_titre_email
- return recuperer_fond($modele,array('id_article'=>$id_article));
+ return recuperer_fond($modele, array('id_article' => $id_article));
}
-// Compatibilite, ne plus utiliser
-// http://doc.spip.org/@notifier_publication_article
+/**
+ * Notifier la publication d'un article
+ *
+ * @deprecated Ne plus utiliser
+ * @param int $id_article
+ **/
function notifier_publication_article($id_article) {
if ($GLOBALS['meta']["suivi_edito"] == "oui") {
$adresse_suivi = $GLOBALS['meta']["adresse_suivi"];
}
}
-// Compatibilite, ne plus utiliser
-// http://doc.spip.org/@notifier_proposition_article
+/**
+ * Notifier la proposition d'un article
+ *
+ * @deprecated Ne plus utiliser
+ * @param int $id_article
+ **/
function notifier_proposition_article($id_article) {
if ($GLOBALS['meta']["suivi_edito"] == "oui") {
$adresse_suivi = $GLOBALS['meta']["adresse_suivi"];
notifications_envoyer_mails($adresse_suivi, $texte);
}
}
-
-?>
dépôts / lhc / web / www.git / blobdiff