[SPIP] ~v3.2.4-->v3.2.5
[lhc/web/www.git] / www / ecrire / inc / filtres.php
1 <?php
2
3 /***************************************************************************\
4 * SPIP, Systeme de publication pour l'internet *
5 * *
6 * Copyright (c) 2001-2019 *
7 * Arnaud Martin, Antoine Pitrou, Philippe Riviere, Emmanuel Saint-James *
8 * *
9 * Ce programme est un logiciel libre distribue sous licence GNU/GPL. *
10 * Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne. *
11 \***************************************************************************/
12
13 /**
14 * Déclaration de filtres pour les squelettes
15 *
16 * @package SPIP\Core\Filtres
17 **/
18 if (!defined('_ECRIRE_INC_VERSION')) {
19 return;
20 }
21
22 include_spip('inc/charsets');
23 include_spip('inc/filtres_mini');
24 include_spip('inc/filtres_dates');
25 include_spip('inc/filtres_selecteur_generique');
26 include_spip('base/objets');
27 include_spip('public/parametrer'); // charger les fichiers fonctions
28
29 /**
30 * Charger un filtre depuis le php
31 *
32 * - on inclue tous les fichiers fonctions des plugins et du skel
33 * - on appelle chercher_filtre
34 *
35 * Pour éviter de perdre le texte si le filtre demandé est introuvable,
36 * on transmet `filtre_identite_dist` en filtre par défaut.
37 *
38 * @uses filtre_identite_dist() Comme fonction par défaut
39 *
40 * @param string $fonc Nom du filtre
41 * @param string $default Filtre par défaut
42 * @return string Fonction PHP correspondante du filtre
43 */
44 function charger_filtre($fonc, $default = 'filtre_identite_dist') {
45 include_spip('public/parametrer'); // inclure les fichiers fonctions
46 return chercher_filtre($fonc, $default);
47 }
48
49 /**
50 * Retourne le texte tel quel
51 *
52 * @param string $texte Texte
53 * @return string Texte
54 **/
55 function filtre_identite_dist($texte) { return $texte; }
56
57 /**
58 * Cherche un filtre
59 *
60 * Pour une filtre `F` retourne la première fonction trouvée parmis :
61 *
62 * - filtre_F
63 * - filtre_F_dist
64 * - F
65 *
66 * Peut gérer des appels par des fonctions statiques de classes tel que `Foo::Bar`
67 *
68 * En absence de fonction trouvée, retourne la fonction par défaut indiquée.
69 *
70 * @param string $fonc
71 * Nom du filtre
72 * @param null $default
73 * Nom du filtre appliqué par défaut si celui demandé n'est pas trouvé
74 * @return string
75 * Fonction PHP correspondante du filtre demandé
76 */
77 function chercher_filtre($fonc, $default = null) {
78 if (!$fonc) {
79 return $default;
80 }
81 // Cas des types mime, sans confondre avec les appels de fonction de classe
82 // Foo::Bar
83 // qui peuvent etre avec un namespace : space\Foo::Bar
84 if (preg_match(',^[\w]+/,', $fonc)) {
85 $nom = preg_replace(',\W,', '_', $fonc);
86 $f = chercher_filtre($nom);
87 // cas du sous-type MIME sans filtre associe, passer au type:
88 // si filtre_text_plain pas defini, passe a filtre_text
89 if (!$f and $nom !== $fonc) {
90 $f = chercher_filtre(preg_replace(',\W.*$,', '', $fonc));
91 }
92
93 return $f;
94 }
95 foreach (array('filtre_' . $fonc, 'filtre_' . $fonc . '_dist', $fonc) as $f) {
96 trouver_filtre_matrice($f); // charge des fichiers spécifiques éventuels
97 // fonction ou name\space\fonction
98 if (is_callable($f)) {
99 return $f;
100 }
101 // méthode statique d'une classe Classe::methode ou name\space\Classe::methode
102 elseif (false === strpos($f, '::') and is_callable(array($f))) {
103 return $f;
104 }
105 }
106
107 return $default;
108 }
109
110 /**
111 * Applique un filtre
112 *
113 * Fonction générique qui prend en argument l’objet (texte, etc) à modifier
114 * et le nom du filtre. Retrouve les arguments du filtre demandé dans les arguments
115 * transmis à cette fonction, via func_get_args().
116 *
117 * @see filtrer() Assez proche
118 *
119 * @param mixed $arg
120 * Texte (le plus souvent) sur lequel appliquer le filtre
121 * @param string $filtre
122 * Nom du filtre à appliquer
123 * @param bool $force
124 * La fonction doit-elle retourner le texte ou rien si le filtre est absent ?
125 * @return string
126 * Texte traité par le filtre si le filtre existe,
127 * Texte d'origine si le filtre est introuvable et si $force à `true`
128 * Chaîne vide sinon (filtre introuvable).
129 **/
130 function appliquer_filtre($arg, $filtre, $force = null) {
131 $f = chercher_filtre($filtre);
132 if (!$f) {
133 if (!$force) {
134 return '';
135 } else {
136 return $arg;
137 }
138 }
139
140 $args = func_get_args();
141 array_shift($args); // enlever $arg
142 array_shift($args); // enlever $filtre
143 array_unshift($args, $arg); // remettre $arg
144 return call_user_func_array($f, $args);
145 }
146
147 /**
148 * Retourne la version de SPIP
149 *
150 * Si l'on retrouve un numéro de révision SVN, il est ajouté entre crochets.
151 * Si effectivement le SPIP est installé par SVN, 'SVN' est ajouté avant sa révision.
152 *
153 * @global spip_version_affichee Contient la version de SPIP
154 * @uses version_svn_courante() Pour trouver le numéro de révision SVN
155 *
156 * @return string
157 * Version de SPIP
158 **/
159 function spip_version() {
160 $version = $GLOBALS['spip_version_affichee'];
161 if ($svn_revision = version_svn_courante(_DIR_RACINE)) {
162 $version .= ($svn_revision < 0 ? ' SVN' : '') . ' [' . abs($svn_revision) . ']';
163 }
164
165 return $version;
166 }
167
168
169 /**
170 * Retrouve un numéro de révision SVN d'un répertoire
171 *
172 * Mention de la révision SVN courante d'un répertoire
173 * Retourne un nombre négatif si on est sur .svn, et positif si on utilise svn.revision
174 *
175 * @param string $dir Chemin du répertoire
176 * @return int
177 *
178 * - 0 si aucune info trouvée
179 * - NN (entier) si info trouvée par svn.revision (créé par le générateur de paquet Zip)
180 * - -NN (entier) si info trouvée par .svn/entries
181 *
182 **/
183 function version_svn_courante($dir) {
184 if (!$dir) {
185 $dir = '.';
186 }
187
188 // version installee par paquet ZIP
189 if (lire_fichier($dir . '/svn.revision', $c)
190 and preg_match(',Revision: (\d+),', $c, $d)
191 ) {
192 return intval($d[1]);
193 }
194
195 // version installee par SVN
196 if (file_exists($dir . '/.svn/wc.db') && class_exists('SQLite3')) {
197 $db = new SQLite3($dir . '/.svn/wc.db');
198 $result = $db->query('SELECT changed_revision FROM nodes WHERE local_relpath = "" LIMIT 1');
199 if ($result) {
200 $row = $result->fetchArray();
201 if ($row['changed_revision'] != "") {
202 return -$row['changed_revision'];
203 }
204 }
205 } else if (lire_fichier($dir . '/.svn/entries', $c)
206 and (
207 (preg_match_all(
208 ',committed-rev="([0-9]+)",', $c, $r1, PREG_PATTERN_ORDER)
209 and $v = max($r1[1])
210 )
211 or
212 (preg_match(',^\d.*dir[\r\n]+(\d+),ms', $c, $r1) # svn >= 1.4
213 and $v = $r1[1]
214 ))
215 ) {
216 return -$v;
217 }
218
219 // Bug ou paquet fait main
220 return 0;
221 }
222
223 // La matrice est necessaire pour ne filtrer _que_ des fonctions definies dans filtres_images
224 // et laisser passer les fonctions personnelles baptisees image_...
225 $GLOBALS['spip_matrice']['image_graver'] = true;//'inc/filtres_images_mini.php';
226 $GLOBALS['spip_matrice']['image_select'] = true;//'inc/filtres_images_mini.php';
227 $GLOBALS['spip_matrice']['image_reduire'] = true;//'inc/filtres_images_mini.php';
228 $GLOBALS['spip_matrice']['image_reduire_par'] = true;//'inc/filtres_images_mini.php';
229 $GLOBALS['spip_matrice']['image_passe_partout'] = true;//'inc/filtres_images_mini.php';
230
231 $GLOBALS['spip_matrice']['couleur_html_to_hex'] = 'inc/filtres_images_mini.php';
232 $GLOBALS['spip_matrice']['couleur_foncer'] = 'inc/filtres_images_mini.php';
233 $GLOBALS['spip_matrice']['couleur_eclaircir'] = 'inc/filtres_images_mini.php';
234
235 // ou pour inclure un script au moment ou l'on cherche le filtre
236 $GLOBALS['spip_matrice']['filtre_image_dist'] = 'inc/filtres_mime.php';
237 $GLOBALS['spip_matrice']['filtre_audio_dist'] = 'inc/filtres_mime.php';
238 $GLOBALS['spip_matrice']['filtre_video_dist'] = 'inc/filtres_mime.php';
239 $GLOBALS['spip_matrice']['filtre_application_dist'] = 'inc/filtres_mime.php';
240 $GLOBALS['spip_matrice']['filtre_message_dist'] = 'inc/filtres_mime.php';
241 $GLOBALS['spip_matrice']['filtre_multipart_dist'] = 'inc/filtres_mime.php';
242 $GLOBALS['spip_matrice']['filtre_text_dist'] = 'inc/filtres_mime.php';
243 $GLOBALS['spip_matrice']['filtre_text_csv_dist'] = 'inc/filtres_mime.php';
244 $GLOBALS['spip_matrice']['filtre_text_html_dist'] = 'inc/filtres_mime.php';
245 $GLOBALS['spip_matrice']['filtre_audio_x_pn_realaudio'] = 'inc/filtres_mime.php';
246
247
248 /**
249 * Charge et exécute un filtre (graphique ou non)
250 *
251 * Recherche la fonction prévue pour un filtre (qui peut être un filtre graphique `image_*`)
252 * et l'exécute avec les arguments transmis à la fonction, obtenus avec `func_get_args()`
253 *
254 * @api
255 * @uses image_filtrer() Pour un filtre image
256 * @uses chercher_filtre() Pour un autre filtre
257 *
258 * @param string $filtre
259 * Nom du filtre à appliquer
260 * @return string
261 * Code HTML retourné par le filtre
262 **/
263 function filtrer($filtre) {
264 $tous = func_get_args();
265 if (trouver_filtre_matrice($filtre) and substr($filtre, 0, 6) == 'image_') {
266 return image_filtrer($tous);
267 } elseif ($f = chercher_filtre($filtre)) {
268 array_shift($tous);
269 return call_user_func_array($f, $tous);
270 } else {
271 // le filtre n'existe pas, on provoque une erreur
272 $msg = array('zbug_erreur_filtre', array('filtre' => texte_script($filtre)));
273 erreur_squelette($msg);
274 return '';
275 }
276 }
277
278 /**
279 * Cherche un filtre spécial indiqué dans la globale `spip_matrice`
280 * et charge le fichier éventuellement associé contenant le filtre.
281 *
282 * Les filtres d'images par exemple sont déclarés de la sorte, tel que :
283 * ```
284 * $GLOBALS['spip_matrice']['image_reduire'] = true;
285 * $GLOBALS['spip_matrice']['image_monochrome'] = 'filtres/images_complements.php';
286 * ```
287 *
288 * @param string $filtre
289 * @return bool true si on trouve le filtre dans la matrice, false sinon.
290 */
291 function trouver_filtre_matrice($filtre) {
292 if (isset($GLOBALS['spip_matrice'][$filtre]) and is_string($f = $GLOBALS['spip_matrice'][$filtre])) {
293 find_in_path($f, '', true);
294 $GLOBALS['spip_matrice'][$filtre] = true;
295 }
296 return !empty($GLOBALS['spip_matrice'][$filtre]);
297 }
298
299
300 /**
301 * Filtre `set` qui sauve la valeur en entrée dans une variable
302 *
303 * La valeur pourra être retrouvée avec `#GET{variable}`.
304 *
305 * @example
306 * `[(#CALCUL|set{toto})]` enregistre le résultat de `#CALCUL`
307 * dans la variable `toto` et renvoie vide.
308 * C'est équivalent à `[(#SET{toto, #CALCUL})]` dans ce cas.
309 * `#GET{toto}` retourne la valeur sauvegardée.
310 *
311 * @example
312 * `[(#CALCUL|set{toto,1})]` enregistre le résultat de `#CALCUL`
313 * dans la variable toto et renvoie la valeur. Cela permet d'utiliser
314 * d'autres filtres ensuite. `#GET{toto}` retourne la valeur.
315 *
316 * @filtre
317 * @param array $Pile Pile de données
318 * @param mixed $val Valeur à sauver
319 * @param string $key Clé d'enregistrement
320 * @param bool $continue True pour retourner la valeur
321 * @return mixed
322 */
323 function filtre_set(&$Pile, $val, $key, $continue = null) {
324 $Pile['vars'][$key] = $val;
325 return $continue ? $val : '';
326 }
327
328 /**
329 * Filtre `setenv` qui enregistre une valeur dans l'environnement du squelette
330 *
331 * La valeur pourra être retrouvée avec `#ENV{variable}`.
332 *
333 * @example
334 * `[(#CALCUL|setenv{toto})]` enregistre le résultat de `#CALCUL`
335 * dans l'environnement toto et renvoie vide.
336 * `#ENV{toto}` retourne la valeur.
337 *
338 * `[(#CALCUL|setenv{toto,1})]` enregistre le résultat de `#CALCUL`
339 * dans l'environnement toto et renvoie la valeur.
340 * `#ENV{toto}` retourne la valeur.
341 *
342 * @filtre
343 *
344 * @param array $Pile
345 * @param mixed $val Valeur à enregistrer
346 * @param mixed $key Nom de la variable
347 * @param null|mixed $continue Si présent, retourne la valeur en sortie
348 * @return string|mixed Retourne `$val` si `$continue` présent, sinon ''.
349 */
350 function filtre_setenv(&$Pile, $val, $key, $continue = null) {
351 $Pile[0][$key] = $val;
352 return $continue ? $val : '';
353 }
354
355 /**
356 * Filtre `debug` qui affiche un debug de la valeur en entrée
357 *
358 * Log la valeur dans `debug.log` et l'affiche si on est webmestre.
359 *
360 * @example
361 * `[(#TRUC|debug)]` affiche et log la valeur de `#TRUC`
362 * @example
363 * `[(#TRUC|debug{avant}|calcul|debug{apres}|etc)]`
364 * affiche la valeur de `#TRUC` avant et après le calcul,
365 * en précisant "avant" et "apres".
366 *
367 * @filtre
368 * @link http://www.spip.net/5695
369 * @param mixed $val La valeur à debugguer
370 * @param mixed|null $key Clé pour s'y retrouver
371 * @return mixed Retourne la valeur (sans la modifier).
372 */
373 function filtre_debug($val, $key = null) {
374 $debug = (
375 is_null($key) ? '' : (var_export($key, true) . " = ")
376 ) . var_export($val, true);
377
378 include_spip('inc/autoriser');
379 if (autoriser('webmestre')) {
380 echo "<div class='spip_debug'>\n", $debug, "</div>\n";
381 }
382
383 spip_log($debug, 'debug');
384
385 return $val;
386 }
387
388
389 /**
390 * Exécute un filtre image
391 *
392 * Fonction générique d'entrée des filtres images.
393 * Accepte en entrée :
394 *
395 * - un texte complet,
396 * - un img-log (produit par #LOGO_XX),
397 * - un tag `<img ...>` complet,
398 * - un nom de fichier *local* (passer le filtre `|copie_locale` si on veut
399 * l'appliquer à un document distant).
400 *
401 * Applique le filtre demande à chacune des occurrences
402 *
403 * @param array $args
404 * Liste des arguments :
405 *
406 * - le premier est le nom du filtre image à appliquer
407 * - le second est le texte sur lequel on applique le filtre
408 * - les suivants sont les arguments du filtre image souhaité.
409 * @return string
410 * Texte qui a reçu les filtres
411 **/
412 function image_filtrer($args) {
413 $filtre = array_shift($args); # enlever $filtre
414 $texte = array_shift($args);
415 if (!strlen($texte)) {
416 return;
417 }
418 find_in_path('filtres_images_mini.php', 'inc/', true);
419 statut_effacer_images_temporaires(true); // activer la suppression des images temporaires car le compilo finit la chaine par un image_graver
420 // Cas du nom de fichier local
421 if (strpos(substr($texte, strlen(_DIR_RACINE)), '..') === false
422 and !preg_match(',^/|[<>]|\s,S', $texte)
423 and (
424 file_exists(preg_replace(',[?].*$,', '', $texte))
425 or tester_url_absolue($texte)
426 )
427 ) {
428 array_unshift($args, "<img src='$texte' />");
429 $res = call_user_func_array($filtre, $args);
430 statut_effacer_images_temporaires(false); // desactiver pour les appels hors compilo
431 return $res;
432 }
433
434 // Cas general : trier toutes les images, avec eventuellement leur <span>
435 if (preg_match_all(
436 ',(<([a-z]+) [^<>]*spip_documents[^<>]*>)?\s*(<img\s.*>),UimsS',
437 $texte, $tags, PREG_SET_ORDER)) {
438 foreach ($tags as $tag) {
439 $class = extraire_attribut($tag[3], 'class');
440 if (!$class or
441 (strpos($class, 'filtre_inactif') === false
442 // compat historique a virer en 3.2
443 and strpos($class, 'no_image_filtrer') === false)
444 ) {
445 array_unshift($args, $tag[3]);
446 if ($reduit = call_user_func_array($filtre, $args)) {
447 // En cas de span spip_documents, modifier le style=...width:
448 if ($tag[1]) {
449 $w = extraire_attribut($reduit, 'width');
450 if (!$w and preg_match(",width:\s*(\d+)px,S", extraire_attribut($reduit, 'style'), $regs)) {
451 $w = $regs[1];
452 }
453 if ($w and ($style = extraire_attribut($tag[1], 'style'))) {
454 $style = preg_replace(",width:\s*\d+px,S", "width:${w}px", $style);
455 $replace = inserer_attribut($tag[1], 'style', $style);
456 $texte = str_replace($tag[1], $replace, $texte);
457 }
458 }
459 // traiter aussi un eventuel mouseover
460 if ($mouseover = extraire_attribut($reduit, 'onmouseover')) {
461 if (preg_match(",this[.]src=['\"]([^'\"]+)['\"],ims", $mouseover, $match)) {
462 $srcover = $match[1];
463 array_shift($args);
464 array_unshift($args, "<img src='" . $match[1] . "' />");
465 $srcover_filter = call_user_func_array($filtre, $args);
466 $srcover_filter = extraire_attribut($srcover_filter, 'src');
467 $reduit = str_replace($srcover, $srcover_filter, $reduit);
468 }
469 }
470 $texte = str_replace($tag[3], $reduit, $texte);
471 }
472 array_shift($args);
473 }
474 }
475 }
476 statut_effacer_images_temporaires(false); // desactiver pour les appels hors compilo
477 return $texte;
478 }
479
480
481 /**
482 * Retourne les tailles d'une image
483 *
484 * Pour les filtres `largeur` et `hauteur`
485 *
486 * @param string $img
487 * Balise HTML `<img ... />` ou chemin de l'image (qui peut être une URL distante).
488 * @return array
489 * Liste (hauteur, largeur) en pixels
490 **/
491 function taille_image($img) {
492
493 static $largeur_img = array(), $hauteur_img = array();
494 $srcWidth = 0;
495 $srcHeight = 0;
496
497 $logo = extraire_attribut($img, 'src');
498
499 if (!$logo) {
500 $logo = $img;
501 } else {
502 $srcWidth = extraire_attribut($img, 'width');
503 $srcHeight = extraire_attribut($img, 'height');
504 }
505
506 // ne jamais operer directement sur une image distante pour des raisons de perfo
507 // la copie locale a toutes les chances d'etre la ou de resservir
508 if (tester_url_absolue($logo)) {
509 include_spip('inc/distant');
510 $fichier = copie_locale($logo);
511 $logo = $fichier ? _DIR_RACINE . $fichier : $logo;
512 }
513 if (($p = strpos($logo, '?')) !== false) {
514 $logo = substr($logo, 0, $p);
515 }
516
517 $srcsize = false;
518 if (isset($largeur_img[$logo])) {
519 $srcWidth = $largeur_img[$logo];
520 }
521 if (isset($hauteur_img[$logo])) {
522 $srcHeight = $hauteur_img[$logo];
523 }
524 if (!$srcWidth or !$srcHeight) {
525 if (file_exists($logo)
526 and $srcsize = @getimagesize($logo)
527 ) {
528 if (!$srcWidth) {
529 $largeur_img[$logo] = $srcWidth = $srcsize[0];
530 }
531 if (!$srcHeight) {
532 $hauteur_img[$logo] = $srcHeight = $srcsize[1];
533 }
534 }
535 // $logo peut etre une reference a une image temporaire dont a n'a que le log .src
536 // on s'y refere, l'image sera reconstruite en temps utile si necessaire
537 elseif (@file_exists($f = "$logo.src")
538 and lire_fichier($f, $valeurs)
539 and $valeurs = unserialize($valeurs)
540 ) {
541 if (!$srcWidth) {
542 $largeur_img[$logo] = $srcWidth = $valeurs["largeur_dest"];
543 }
544 if (!$srcHeight) {
545 $hauteur_img[$logo] = $srcHeight = $valeurs["hauteur_dest"];
546 }
547 }
548 }
549
550 return array($srcHeight, $srcWidth);
551 }
552
553
554 /**
555 * Retourne la largeur d'une image
556 *
557 * @filtre
558 * @link http://www.spip.net/4296
559 * @uses taille_image()
560 * @see hauteur()
561 *
562 * @param string $img
563 * Balise HTML `<img ... />` ou chemin de l'image (qui peut être une URL distante).
564 * @return int|null
565 * Largeur en pixels, NULL ou 0 si aucune image.
566 **/
567 function largeur($img) {
568 if (!$img) {
569 return;
570 }
571 list($h, $l) = taille_image($img);
572
573 return $l;
574 }
575
576 /**
577 * Retourne la hauteur d'une image
578 *
579 * @filtre
580 * @link http://www.spip.net/4291
581 * @uses taille_image()
582 * @see largeur()
583 *
584 * @param string $img
585 * Balise HTML `<img ... />` ou chemin de l'image (qui peut être une URL distante).
586 * @return int|null
587 * Hauteur en pixels, NULL ou 0 si aucune image.
588 **/
589 function hauteur($img) {
590 if (!$img) {
591 return;
592 }
593 list($h, $l) = taille_image($img);
594
595 return $h;
596 }
597
598
599 /**
600 * Échappement des entités HTML avec correction des entités « brutes »
601 *
602 * Ces entités peuvent être générées par les butineurs lorsqu'on rentre des
603 * caractères n'appartenant pas au charset de la page [iso-8859-1 par défaut]
604 *
605 * Attention on limite cette correction aux caracteres « hauts » (en fait > 99
606 * pour aller plus vite que le > 127 qui serait logique), de manière à
607 * préserver des eéhappements de caractères « bas » (par exemple `[` ou `"`)
608 * et au cas particulier de `&amp;` qui devient `&amp;amp;` dans les URL
609 *
610 * @see corriger_toutes_entites_html()
611 * @param string $texte
612 * @return string
613 **/
614 function corriger_entites_html($texte) {
615 if (strpos($texte, '&amp;') === false) {
616 return $texte;
617 }
618
619 return preg_replace(',&amp;(#[0-9][0-9][0-9]+;|amp;),iS', '&\1', $texte);
620 }
621
622 /**
623 * Échappement des entités HTML avec correction des entités « brutes » ainsi
624 * que les `&amp;eacute;` en `&eacute;`
625 *
626 * Identique à `corriger_entites_html()` en corrigeant aussi les
627 * `&amp;eacute;` en `&eacute;`
628 *
629 * @see corriger_entites_html()
630 * @param string $texte
631 * @return string
632 **/
633 function corriger_toutes_entites_html($texte) {
634 if (strpos($texte, '&amp;') === false) {
635 return $texte;
636 }
637
638 return preg_replace(',&amp;(#?[a-z0-9]+;),iS', '&\1', $texte);
639 }
640
641 /**
642 * Échappe les `&` en `&amp;`
643 *
644 * @param string $texte
645 * @return string
646 **/
647 function proteger_amp($texte) {
648 return str_replace('&', '&amp;', $texte);
649 }
650
651
652 /**
653 * Échappe en entités HTML certains caractères d'un texte
654 *
655 * Traduira un code HTML en transformant en entités HTML les caractères
656 * en dehors du charset de la page ainsi que les `"`, `<` et `>`.
657 *
658 * Ceci permet d’insérer le texte d’une balise dans un `<textarea> </textarea>`
659 * sans dommages.
660 *
661 * @filtre
662 * @link http://www.spip.net/4280
663 *
664 * @uses echappe_html()
665 * @uses echappe_retour()
666 * @uses proteger_amp()
667 * @uses corriger_entites_html()
668 * @uses corriger_toutes_entites_html()
669 *
670 * @param string $texte
671 * chaine a echapper
672 * @param bool $tout
673 * corriger toutes les `&amp;xx;` en `&xx;`
674 * @param bool $quote
675 * Échapper aussi les simples quotes en `&#039;`
676 * @return mixed|string
677 */
678 function entites_html($texte, $tout = false, $quote = true) {
679 if (!is_string($texte) or !$texte
680 or strpbrk($texte, "&\"'<>") == false
681 ) {
682 return $texte;
683 }
684 include_spip('inc/texte');
685 $flags = ($quote ? ENT_QUOTES : ENT_NOQUOTES);
686 if (defined('ENT_HTML401')) {
687 $flags |= ENT_HTML401;
688 }
689 $texte = spip_htmlspecialchars(echappe_retour(echappe_html($texte, '', true), '', 'proteger_amp'), $flags);
690 if ($tout) {
691 return corriger_toutes_entites_html($texte);
692 } else {
693 return corriger_entites_html($texte);
694 }
695 }
696
697 /**
698 * Convertit les caractères spéciaux HTML dans le charset du site.
699 *
700 * @exemple
701 * Si le charset de votre site est `utf-8`, `&eacute;` ou `&#233;`
702 * sera transformé en `é`
703 *
704 * @filtre
705 * @link http://www.spip.net/5513
706 *
707 * @param string $texte
708 * Texte à convertir
709 * @return string
710 * Texte converti
711 **/
712 function filtrer_entites($texte) {
713 if (strpos($texte, '&') === false) {
714 return $texte;
715 }
716 // filtrer
717 $texte = html2unicode($texte);
718 // remettre le tout dans le charset cible
719 $texte = unicode2charset($texte);
720 // cas particulier des " et ' qu'il faut filtrer aussi
721 // (on le faisait deja avec un &quot;)
722 if (strpos($texte, "&#") !== false) {
723 $texte = str_replace(array("&#039;", "&#39;", "&#034;", "&#34;"), array("'", "'", '"', '"'), $texte);
724 }
725
726 return $texte;
727 }
728
729
730 if (!function_exists('filtre_filtrer_entites_dist')) {
731 /**
732 * Version sécurisée de filtrer_entites
733 *
734 * @uses interdire_scripts()
735 * @uses filtrer_entites()
736 *
737 * @param string $t
738 * @return string
739 */
740 function filtre_filtrer_entites_dist($t) {
741 include_spip('inc/texte');
742 return interdire_scripts(filtrer_entites($t));
743 }
744 }
745
746
747 /**
748 * Supprime des caractères illégaux
749 *
750 * Remplace les caractères de controle par le caractère `-`
751 *
752 * @link http://www.w3.org/TR/REC-xml/#charsets
753 *
754 * @param string|array $texte
755 * @return string|array
756 **/
757 function supprimer_caracteres_illegaux($texte) {
758 static $from = "\x0\x1\x2\x3\x4\x5\x6\x7\x8\xB\xC\xE\xF\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1A\x1B\x1C\x1D\x1E\x1F";
759 static $to = null;
760
761 if (is_array($texte)) {
762 return array_map('supprimer_caracteres_illegaux', $texte);
763 }
764
765 if (!$to) {
766 $to = str_repeat('-', strlen($from));
767 }
768
769 return strtr($texte, $from, $to);
770 }
771
772 /**
773 * Correction de caractères
774 *
775 * Supprimer les caracteres windows non conformes et les caracteres de controle illégaux
776 *
777 * @param string|array $texte
778 * @return string|array
779 **/
780 function corriger_caracteres($texte) {
781 $texte = corriger_caracteres_windows($texte);
782 $texte = supprimer_caracteres_illegaux($texte);
783
784 return $texte;
785 }
786
787 /**
788 * Encode du HTML pour transmission XML notamment dans les flux RSS
789 *
790 * Ce filtre transforme les liens en liens absolus, importe les entitées html et échappe les tags html.
791 *
792 * @filtre
793 * @link http://www.spip.net/4287
794 *
795 * @param string $texte
796 * Texte à transformer
797 * @return string
798 * Texte encodé pour XML
799 */
800 function texte_backend($texte) {
801
802 static $apostrophe = array("&#8217;", "'"); # n'allouer qu'une fois
803
804 // si on a des liens ou des images, les passer en absolu
805 $texte = liens_absolus($texte);
806
807 // echapper les tags &gt; &lt;
808 $texte = preg_replace(',&(gt|lt);,S', '&amp;\1;', $texte);
809
810 // importer les &eacute;
811 $texte = filtrer_entites($texte);
812
813 // " -> &quot; et tout ce genre de choses
814 $u = $GLOBALS['meta']['pcre_u'];
815 $texte = str_replace("&nbsp;", " ", $texte);
816 $texte = preg_replace('/\s{2,}/S' . $u, " ", $texte);
817 // ne pas echapper les sinqle quotes car certains outils de syndication gerent mal
818 $texte = entites_html($texte, false, false);
819 // mais bien echapper les double quotes !
820 $texte = str_replace('"', '&#034;', $texte);
821
822 // verifier le charset
823 $texte = charset2unicode($texte);
824
825 // Caracteres problematiques en iso-latin 1
826 if (isset($GLOBALS['meta']['charset']) and $GLOBALS['meta']['charset'] == 'iso-8859-1') {
827 $texte = str_replace(chr(156), '&#156;', $texte);
828 $texte = str_replace(chr(140), '&#140;', $texte);
829 $texte = str_replace(chr(159), '&#159;', $texte);
830 }
831
832 // l'apostrophe curly pose probleme a certains lecteure de RSS
833 // et le caractere apostrophe alourdit les squelettes avec PHP
834 // ==> on les remplace par l'entite HTML
835 return str_replace($apostrophe, "'", $texte);
836 }
837
838 /**
839 * Encode et quote du HTML pour transmission XML notamment dans les flux RSS
840 *
841 * Comme texte_backend(), mais avec addslashes final pour squelettes avec PHP (rss)
842 *
843 * @uses texte_backend()
844 * @filtre
845 *
846 * @param string $texte
847 * Texte à transformer
848 * @return string
849 * Texte encodé et quote pour XML
850 */
851 function texte_backendq($texte) {
852 return addslashes(texte_backend($texte));
853 }
854
855
856 /**
857 * Enlève un numéro préfixant un texte
858 *
859 * Supprime `10. ` dans la chaine `10. Titre`
860 *
861 * @filtre
862 * @link http://www.spip.net/4314
863 * @see recuperer_numero() Pour obtenir le numéro
864 * @example
865 * ```
866 * [<h1>(#TITRE|supprimer_numero)</h1>]
867 * ```
868 *
869 * @param string $texte
870 * Texte
871 * @return int|string
872 * Numéro de titre, sinon chaîne vide
873 **/
874 function supprimer_numero($texte) {
875 return preg_replace(
876 ",^[[:space:]]*([0-9]+)([.)]|" . chr(194) . '?' . chr(176) . ")[[:space:]]+,S",
877 "", $texte);
878 }
879
880 /**
881 * Récupère un numéro préfixant un texte
882 *
883 * Récupère le numéro `10` dans la chaine `10. Titre`
884 *
885 * @filtre
886 * @link http://www.spip.net/5514
887 * @see supprimer_numero() Pour supprimer le numéro
888 * @see balise_RANG_dist() Pour obtenir un numéro de titre
889 * @example
890 * ```
891 * [(#TITRE|recuperer_numero)]
892 * ```
893 *
894 * @param string $texte
895 * Texte
896 * @return int|string
897 * Numéro de titre, sinon chaîne vide
898 **/
899 function recuperer_numero($texte) {
900 if (preg_match(
901 ",^[[:space:]]*([0-9]+)([.)]|" . chr(194) . '?' . chr(176) . ")[[:space:]]+,S",
902 $texte, $regs)) {
903 return strval($regs[1]);
904 } else {
905 return '';
906 }
907 }
908
909 /**
910 * Suppression basique et brutale de tous les tags
911 *
912 * Supprime tous les tags `<...>`.
913 * Utilisé fréquemment pour écrire des RSS.
914 *
915 * @filtre
916 * @link http://www.spip.net/4315
917 * @example
918 * ```
919 * <title>[(#TITRE|supprimer_tags|texte_backend)]</title>
920 * ```
921 *
922 * @note
923 * Ce filtre supprime aussi les signes inférieurs `<` rencontrés.
924 *
925 * @param string $texte
926 * Texte à échapper
927 * @param string $rempl
928 * Inutilisé.
929 * @return string
930 * Texte converti
931 **/
932 function supprimer_tags($texte, $rempl = "") {
933 $texte = preg_replace(",<(!--|\w|/)[^>]*>,US", $rempl, $texte);
934 // ne pas oublier un < final non ferme car coupe
935 $texte = preg_replace(",<(!--|\w|/).*$,US", $rempl, $texte);
936 // mais qui peut aussi etre un simple signe plus petit que
937 $texte = str_replace('<', '&lt;', $texte);
938
939 return $texte;
940 }
941
942 /**
943 * Convertit les chevrons de tag en version lisible en HTML
944 *
945 * Transforme les chevrons de tag `<...>` en entité HTML.
946 *
947 * @filtre
948 * @link http://www.spip.net/5515
949 * @example
950 * ```
951 * <pre>[(#TEXTE|echapper_tags)]</pre>
952 * ```
953 *
954 * @param string $texte
955 * Texte à échapper
956 * @param string $rempl
957 * Inutilisé.
958 * @return string
959 * Texte converti
960 **/
961 function echapper_tags($texte, $rempl = "") {
962 $texte = preg_replace("/<([^>]*)>/", "&lt;\\1&gt;", $texte);
963
964 return $texte;
965 }
966
967 /**
968 * Convertit un texte HTML en texte brut
969 *
970 * Enlève les tags d'un code HTML, élimine les doubles espaces.
971 *
972 * @filtre
973 * @link http://www.spip.net/4317
974 * @example
975 * ```
976 * <title>[(#TITRE|textebrut) - ][(#NOM_SITE_SPIP|textebrut)]</title>
977 * ```
978 *
979 * @param string $texte
980 * Texte à convertir
981 * @return string
982 * Texte converti
983 **/
984 function textebrut($texte) {
985 $u = $GLOBALS['meta']['pcre_u'];
986 $texte = preg_replace('/\s+/S' . $u, " ", $texte);
987 $texte = preg_replace("/<(p|br)( [^>]*)?" . ">/iS", "\n\n", $texte);
988 $texte = preg_replace("/^\n+/", "", $texte);
989 $texte = preg_replace("/\n+$/", "", $texte);
990 $texte = preg_replace("/\n +/", "\n", $texte);
991 $texte = supprimer_tags($texte);
992 $texte = preg_replace("/(&nbsp;| )+/S", " ", $texte);
993 // nettoyer l'apostrophe curly qui pose probleme a certains rss-readers, lecteurs de mail...
994 $texte = str_replace("&#8217;", "'", $texte);
995
996 return $texte;
997 }
998
999
1000 /**
1001 * Remplace les liens SPIP en liens ouvrant dans une nouvelle fenetre (target=blank)
1002 *
1003 * @filtre
1004 * @link http://www.spip.net/4297
1005 *
1006 * @param string $texte
1007 * Texte avec des liens
1008 * @return string
1009 * Texte avec liens ouvrants
1010 **/
1011 function liens_ouvrants($texte) {
1012 if (preg_match_all(",(<a\s+[^>]*https?://[^>]*class=[\"']spip_(out|url)\b[^>]+>),imsS",
1013 $texte, $liens, PREG_PATTERN_ORDER)) {
1014 foreach ($liens[0] as $a) {
1015 $rel = 'noopener noreferrer ' . extraire_attribut($a, 'rel');
1016 $ablank = inserer_attribut($a, 'rel', $rel);
1017 $ablank = inserer_attribut($ablank, 'target', '_blank');
1018 $texte = str_replace($a, $ablank, $texte);
1019 }
1020 }
1021
1022 return $texte;
1023 }
1024
1025 /**
1026 * Ajouter un attribut rel="nofollow" sur tous les liens d'un texte
1027 *
1028 * @param string $texte
1029 * @return string
1030 */
1031 function liens_nofollow($texte) {
1032 if (stripos($texte, "<a") === false) {
1033 return $texte;
1034 }
1035
1036 if (preg_match_all(",<a\b[^>]*>,UimsS", $texte, $regs, PREG_PATTERN_ORDER)) {
1037 foreach ($regs[0] as $a) {
1038 $rel = extraire_attribut($a, "rel");
1039 if (strpos($rel, "nofollow") === false) {
1040 $rel = "nofollow" . ($rel ? " $rel" : "");
1041 $anofollow = inserer_attribut($a, "rel", $rel);
1042 $texte = str_replace($a, $anofollow, $texte);
1043 }
1044 }
1045 }
1046
1047 return $texte;
1048 }
1049
1050 /**
1051 * Transforme les sauts de paragraphe HTML `p` en simples passages à la ligne `br`
1052 *
1053 * @filtre
1054 * @link http://www.spip.net/4308
1055 * @example
1056 * ```
1057 * [<div>(#DESCRIPTIF|PtoBR)[(#NOTES|PtoBR)]</div>]
1058 * ```
1059 *
1060 * @param string $texte
1061 * Texte à transformer
1062 * @return string
1063 * Texte sans paraghaphes
1064 **/
1065 function PtoBR($texte) {
1066 $u = $GLOBALS['meta']['pcre_u'];
1067 $texte = preg_replace("@</p>@iS", "\n", $texte);
1068 $texte = preg_replace("@<p\b.*>@UiS", "<br />", $texte);
1069 $texte = preg_replace("@^\s*<br />@S" . $u, "", $texte);
1070
1071 return $texte;
1072 }
1073
1074
1075 /**
1076 * Assure qu'un texte ne vas pas déborder d'un bloc
1077 * par la faute d'un mot trop long (souvent des URLs)
1078 *
1079 * Ne devrait plus être utilisé et fait directement en CSS par un style
1080 * `word-wrap:break-word;`
1081 *
1082 * @note
1083 * Pour assurer la compatibilité du filtre, on encapsule le contenu par
1084 * un `div` ou `span` portant ce style CSS inline.
1085 *
1086 * @filtre
1087 * @link http://www.spip.net/4298
1088 * @link http://www.alsacreations.com/tuto/lire/1038-gerer-debordement-contenu-css.html
1089 * @deprecated Utiliser le style CSS `word-wrap:break-word;`
1090 *
1091 * @param string $texte Texte
1092 * @return string Texte encadré du style CSS
1093 */
1094 function lignes_longues($texte) {
1095 if (!strlen(trim($texte))) {
1096 return $texte;
1097 }
1098 include_spip('inc/texte');
1099 $tag = preg_match(',</?(' . _BALISES_BLOCS . ')[>[:space:]],iS', $texte) ?
1100 'div' : 'span';
1101
1102 return "<$tag style='word-wrap:break-word;'>$texte</$tag>";
1103 }
1104
1105 /**
1106 * Passe un texte en majuscules, y compris les accents, en HTML
1107 *
1108 * Encadre le texte du style CSS `text-transform: uppercase;`.
1109 * Le cas spécifique du i turc est géré.
1110 *
1111 * @filtre
1112 * @example
1113 * ```
1114 * [(#EXTENSION|majuscules)]
1115 * ```
1116 *
1117 * @param string $texte Texte
1118 * @return string Texte en majuscule
1119 */
1120 function majuscules($texte) {
1121 if (!strlen($texte)) {
1122 return '';
1123 }
1124
1125 // Cas du turc
1126 if ($GLOBALS['spip_lang'] == 'tr') {
1127 # remplacer hors des tags et des entites
1128 if (preg_match_all(',<[^<>]+>|&[^;]+;,S', $texte, $regs, PREG_SET_ORDER)) {
1129 foreach ($regs as $n => $match) {
1130 $texte = str_replace($match[0], "@@SPIP_TURC$n@@", $texte);
1131 }
1132 }
1133
1134 $texte = str_replace('i', '&#304;', $texte);
1135
1136 if ($regs) {
1137 foreach ($regs as $n => $match) {
1138 $texte = str_replace("@@SPIP_TURC$n@@", $match[0], $texte);
1139 }
1140 }
1141 }
1142
1143 // Cas general
1144 return "<span style='text-transform: uppercase;'>$texte</span>";
1145 }
1146
1147 /**
1148 * Retourne une taille en octets humainement lisible
1149 *
1150 * Tel que "127.4 ko" ou "3.1 Mo"
1151 *
1152 * @example
1153 * - `[(#TAILLE|taille_en_octets)]`
1154 * - `[(#VAL{123456789}|taille_en_octets)]` affiche `117.7 Mo`
1155 *
1156 * @filtre
1157 * @link http://www.spip.net/4316
1158 * @param int $taille
1159 * @return string
1160 **/
1161 function taille_en_octets($taille) {
1162 if (!defined('_KILOBYTE')) {
1163 /**
1164 * Définit le nombre d'octets dans un Kilobyte
1165 *
1166 * @var int
1167 **/
1168 define('_KILOBYTE', 1024);
1169 }
1170
1171 if ($taille < 1) {
1172 return '';
1173 }
1174 if ($taille < _KILOBYTE) {
1175 $taille = _T('taille_octets', array('taille' => $taille));
1176 } elseif ($taille < _KILOBYTE * _KILOBYTE) {
1177 $taille = _T('taille_ko', array('taille' => round($taille / _KILOBYTE, 1)));
1178 } elseif ($taille < _KILOBYTE * _KILOBYTE * _KILOBYTE) {
1179 $taille = _T('taille_mo', array('taille' => round($taille / _KILOBYTE / _KILOBYTE, 1)));
1180 } else {
1181 $taille = _T('taille_go', array('taille' => round($taille / _KILOBYTE / _KILOBYTE / _KILOBYTE, 2)));
1182 }
1183
1184 return $taille;
1185 }
1186
1187
1188 /**
1189 * Rend une chaine utilisable sans dommage comme attribut HTML
1190 *
1191 * @example `<a href="#URL_ARTICLE" title="[(#TITRE|attribut_html)]">#TITRE</a>`
1192 *
1193 * @filtre
1194 * @link http://www.spip.net/4282
1195 * @uses textebrut()
1196 * @uses texte_backend()
1197 *
1198 * @param string $texte
1199 * Texte à mettre en attribut
1200 * @param bool $textebrut
1201 * Passe le texte en texte brut (enlève les balises html) ?
1202 * @return string
1203 * Texte prêt pour être utilisé en attribut HTML
1204 **/
1205 function attribut_html($texte, $textebrut = true) {
1206 $u = $GLOBALS['meta']['pcre_u'];
1207 if ($textebrut) {
1208 $texte = preg_replace(array(",\n,", ",\s(?=\s),msS" . $u), array(" ", ""), textebrut($texte));
1209 }
1210 $texte = texte_backend($texte);
1211 $texte = str_replace(array("'", '"'), array('&#039;', '&#034;'), $texte);
1212
1213 return preg_replace(array("/&(amp;|#38;)/", "/&(?![A-Za-z]{0,4}\w{2,3};|#[0-9]{2,5};)/"), array("&", "&#38;"),
1214 $texte);
1215 }
1216
1217
1218 /**
1219 * Vider les URL nulles
1220 *
1221 * - Vide les URL vides comme `http://` ou `mailto:` (sans rien d'autre)
1222 * - échappe les entités et gère les `&amp;`
1223 *
1224 * @uses entites_html()
1225 *
1226 * @param string $url
1227 * URL à vérifier et échapper
1228 * @param bool $entites
1229 * `true` pour échapper les entités HTML.
1230 * @return string
1231 * URL ou chaîne vide
1232 **/
1233 function vider_url($url, $entites = true) {
1234 # un message pour abs_url
1235 $GLOBALS['mode_abs_url'] = 'url';
1236 $url = trim($url);
1237 $r = ",^(?:" . _PROTOCOLES_STD . '):?/?/?$,iS';
1238
1239 return preg_match($r, $url) ? '' : ($entites ? entites_html($url) : $url);
1240 }
1241
1242
1243 /**
1244 * Maquiller une adresse e-mail
1245 *
1246 * Remplace `@` par 3 caractères aléatoires.
1247 *
1248 * @uses creer_pass_aleatoire()
1249 *
1250 * @param string $texte Adresse email
1251 * @return string Adresse email maquillée
1252 **/
1253 function antispam($texte) {
1254 include_spip('inc/acces');
1255 $masque = creer_pass_aleatoire(3);
1256
1257 return preg_replace("/@/", " $masque ", $texte);
1258 }
1259
1260 /**
1261 * Vérifie un accès à faible sécurité
1262 *
1263 * Vérifie qu'un visiteur peut accéder à la page demandée,
1264 * qui est protégée par une clé, calculée à partir du low_sec de l'auteur,
1265 * et des paramètres le composant l'appel (op, args)
1266 *
1267 * @example
1268 * `[(#ID_AUTEUR|securiser_acces{#ENV{cle}, rss, #ENV{op}, #ENV{args}}|sinon_interdire_acces)]`
1269 *
1270 * @see bouton_spip_rss() pour générer un lien de faible sécurité pour les RSS privés
1271 * @see afficher_low_sec() pour calculer une clé valide
1272 * @uses verifier_low_sec()
1273 *
1274 * @filtre
1275 * @param int $id_auteur
1276 * L'auteur qui demande la page
1277 * @param string $cle
1278 * La clé à tester
1279 * @param string $dir
1280 * Un type d'accès (nom du répertoire dans lequel sont rangés les squelettes demandés, tel que 'rss')
1281 * @param string $op
1282 * Nom de l'opération éventuelle
1283 * @param string $args
1284 * Nom de l'argument calculé
1285 * @return bool
1286 * True si on a le droit d'accès, false sinon.
1287 **/
1288 function securiser_acces($id_auteur, $cle, $dir, $op = '', $args = '') {
1289 include_spip('inc/acces');
1290 if ($op) {
1291 $dir .= " $op $args";
1292 }
1293
1294 return verifier_low_sec($id_auteur, $cle, $dir);
1295 }
1296
1297 /**
1298 * Retourne le second paramètre lorsque
1299 * le premier est considere vide, sinon retourne le premier paramètre.
1300 *
1301 * En php `sinon($a, 'rien')` retourne `$a`, ou `'rien'` si `$a` est vide.
1302 * En filtre SPIP `|sinon{#TEXTE, rien}` : affiche `#TEXTE` ou `rien` si `#TEXTE` est vide,
1303 *
1304 * @filtre
1305 * @see filtre_logique() pour la compilation du filtre dans un squelette
1306 * @link http://www.spip.net/4313
1307 * @note
1308 * L'utilisation de `|sinon` en tant que filtre de squelette
1309 * est directement compilé dans `public/references` par la fonction `filtre_logique()`
1310 *
1311 * @param mixed $texte
1312 * Contenu de reference a tester
1313 * @param mixed $sinon
1314 * Contenu a retourner si le contenu de reference est vide
1315 * @return mixed
1316 * Retourne $texte, sinon $sinon.
1317 **/
1318 function sinon($texte, $sinon = '') {
1319 if ($texte or (!is_array($texte) and strlen($texte))) {
1320 return $texte;
1321 } else {
1322 return $sinon;
1323 }
1324 }
1325
1326 /**
1327 * Filtre `|choixsivide{vide, pas vide}` alias de `|?{si oui, si non}` avec les arguments inversés
1328 *
1329 * @example
1330 * `[(#TEXTE|choixsivide{vide, plein})]` affiche vide si le `#TEXTE`
1331 * est considéré vide par PHP (chaîne vide, false, 0, tableau vide, etc…).
1332 * C'est l'équivalent de `[(#TEXTE|?{plein, vide})]`
1333 *
1334 * @filtre
1335 * @see choixsiegal()
1336 * @link http://www.spip.net/4189
1337 *
1338 * @param mixed $a
1339 * La valeur à tester
1340 * @param mixed $vide
1341 * Ce qui est retourné si `$a` est considéré vide
1342 * @param mixed $pasvide
1343 * Ce qui est retourné sinon
1344 * @return mixed
1345 **/
1346 function choixsivide($a, $vide, $pasvide) {
1347 return $a ? $pasvide : $vide;
1348 }
1349
1350 /**
1351 * Filtre `|choixsiegal{valeur, sioui, sinon}`
1352 *
1353 * @example
1354 * `#LANG_DIR|choixsiegal{ltr,left,right}` retourne `left` si
1355 * `#LANG_DIR` vaut `ltr` et `right` sinon.
1356 *
1357 * @filtre
1358 * @link http://www.spip.net/4148
1359 *
1360 * @param mixed $a1
1361 * La valeur à tester
1362 * @param mixed $a2
1363 * La valeur de comparaison
1364 * @param mixed $v
1365 * Ce qui est retourné si la comparaison est vraie
1366 * @param mixed $f
1367 * Ce qui est retourné sinon
1368 * @return mixed
1369 **/
1370 function choixsiegal($a1, $a2, $v, $f) {
1371 return ($a1 == $a2) ? $v : $f;
1372 }
1373
1374 /**
1375 * Alignements en HTML (Old-style, préférer CSS)
1376 *
1377 * Cette fonction ne crée pas de paragraphe
1378 *
1379 * @deprecated Utiliser CSS
1380 * @param string $letexte
1381 * @param string $justif
1382 * @return string
1383 */
1384 function aligner($letexte, $justif = '') {
1385 $letexte = trim($letexte);
1386 if (!strlen($letexte)) {
1387 return '';
1388 }
1389
1390 // Paragrapher rapidement
1391 $letexte = "<div style='text-align:$justif'>"
1392 . $letexte
1393 . "</div>";
1394
1395 return $letexte;
1396 }
1397
1398 /**
1399 * Justifie en HTML (Old-style, préférer CSS)
1400 *
1401 * @deprecated Utiliser CSS
1402 * @uses aligner()
1403 * @param string $letexte
1404 * @return string
1405 */
1406 function justifier($letexte) { return aligner($letexte, 'justify'); }
1407
1408 /**
1409 * Aligne à droite en HTML (Old-style, préférer CSS)
1410 *
1411 * @deprecated Utiliser CSS
1412 * @uses aligner()
1413 * @param string $letexte
1414 * @return string
1415 */
1416 function aligner_droite($letexte) { return aligner($letexte, 'right'); }
1417
1418 /**
1419 * Aligne à gauche en HTML (Old-style, préférer CSS)
1420 *
1421 * @deprecated Utiliser CSS
1422 * @uses aligner()
1423 * @param string $letexte
1424 * @return string
1425 */
1426 function aligner_gauche($letexte) { return aligner($letexte, 'left'); }
1427
1428 /**
1429 * Centre en HTML (Old-style, préférer CSS)
1430 *
1431 * @deprecated Utiliser CSS
1432 * @uses aligner()
1433 * @param string $letexte
1434 * @return string
1435 */
1436 function centrer($letexte) { return aligner($letexte, 'center'); }
1437
1438 /**
1439 * Retourne un texte de style CSS aligné sur la langue en cours
1440 *
1441 * @deprecated
1442 * @param mixed $bof Inutilisé
1443 * @return string Style CSS
1444 **/
1445 function style_align($bof) {
1446
1447 return "text-align: " . $GLOBALS['spip_lang_left'];
1448 }
1449
1450 //
1451 // Export iCal
1452 //
1453
1454 /**
1455 * Adapte un texte pour être inséré dans une valeur d'un export ICAL
1456 *
1457 * Passe le texte en utf8, enlève les sauts de lignes et échappe les virgules.
1458 *
1459 * @example `SUMMARY:[(#TITRE|filtrer_ical)]`
1460 * @filtre
1461 *
1462 * @param string $texte
1463 * @return string
1464 **/
1465 function filtrer_ical($texte) {
1466 #include_spip('inc/charsets');
1467 $texte = html2unicode($texte);
1468 $texte = unicode2charset(charset2unicode($texte, $GLOBALS['meta']['charset'], 1), 'utf-8');
1469 $texte = preg_replace("/\n/", " ", $texte);
1470 $texte = preg_replace("/,/", "\,", $texte);
1471
1472 return $texte;
1473 }
1474
1475
1476 /**
1477 * Transforme les sauts de ligne simples en sauts forcés avec `_ `
1478 *
1479 * Ne modifie pas les sauts de paragraphe (2 sauts consécutifs au moins),
1480 * ou les retours à l'intérieur de modèles ou de certaines balises html.
1481 *
1482 * @note
1483 * Cette fonction pouvait être utilisée pour forcer les alinéas,
1484 * (retours à la ligne sans saut de paragraphe), mais ce traitement
1485 * est maintenant automatique.
1486 * Cf. plugin Textwheel et la constante _AUTOBR
1487 *
1488 * @uses echappe_html()
1489 * @uses echappe_retour()
1490 *
1491 * @param string $texte
1492 * @param string $delim
1493 * Ce par quoi sont remplacés les sauts
1494 * @return string
1495 **/
1496 function post_autobr($texte, $delim = "\n_ ") {
1497 if (!function_exists('echappe_html')) {
1498 include_spip('inc/texte_mini');
1499 }
1500 $texte = str_replace("\r\n", "\r", $texte);
1501 $texte = str_replace("\r", "\n", $texte);
1502
1503 if (preg_match(",\n+$,", $texte, $fin)) {
1504 $texte = substr($texte, 0, -strlen($fin = $fin[0]));
1505 } else {
1506 $fin = '';
1507 }
1508
1509 $texte = echappe_html($texte, '', true);
1510
1511 // echapper les modeles
1512 if (strpos($texte, "<") !== false) {
1513 include_spip('inc/lien');
1514 if (defined('_PREG_MODELE')) {
1515 $preg_modeles = "@" . _PREG_MODELE . "@imsS";
1516 $texte = echappe_html($texte, '', true, $preg_modeles);
1517 }
1518 }
1519
1520 $debut = '';
1521 $suite = $texte;
1522 while ($t = strpos('-' . $suite, "\n", 1)) {
1523 $debut .= substr($suite, 0, $t - 1);
1524 $suite = substr($suite, $t);
1525 $car = substr($suite, 0, 1);
1526 if (($car <> '-') and ($car <> '_') and ($car <> "\n") and ($car <> "|") and ($car <> "}")
1527 and !preg_match(',^\s*(\n|</?(quote|div|dl|dt|dd)|$),S', ($suite))
1528 and !preg_match(',</?(quote|div|dl|dt|dd)> *$,iS', $debut)
1529 ) {
1530 $debut .= $delim;
1531 } else {
1532 $debut .= "\n";
1533 }
1534 if (preg_match(",^\n+,", $suite, $regs)) {
1535 $debut .= $regs[0];
1536 $suite = substr($suite, strlen($regs[0]));
1537 }
1538 }
1539 $texte = $debut . $suite;
1540
1541 $texte = echappe_retour($texte);
1542
1543 return $texte . $fin;
1544 }
1545
1546
1547 /**
1548 * Expression régulière pour obtenir le contenu des extraits idiomes `<:module:cle:>`
1549 *
1550 * @var string
1551 */
1552 define('_EXTRAIRE_IDIOME', '@<:(?:([a-z0-9_]+):)?([a-z0-9_]+):>@isS');
1553
1554 /**
1555 * Extrait une langue des extraits idiomes (`<:module:cle_de_langue:>`)
1556 *
1557 * Retrouve les balises `<:cle_de_langue:>` d'un texte et remplace son contenu
1558 * par l'extrait correspondant à la langue demandée (si possible), sinon dans la
1559 * langue par défaut du site.
1560 *
1561 * Ne pas mettre de span@lang=fr si on est déjà en fr.
1562 *
1563 * @filtre
1564 * @uses inc_traduire_dist()
1565 * @uses code_echappement()
1566 * @uses echappe_retour()
1567 *
1568 * @param string $letexte
1569 * @param string $lang
1570 * Langue à retrouver (si vide, utilise la langue en cours).
1571 * @param array $options Options {
1572 * @type bool $echappe_span
1573 * True pour échapper les balises span (false par défaut)
1574 * @type string $lang_defaut
1575 * Code de langue : permet de définir la langue utilisée par défaut,
1576 * en cas d'absence de traduction dans la langue demandée.
1577 * Par défaut la langue du site.
1578 * Indiquer 'aucune' pour ne pas retourner de texte si la langue
1579 * exacte n'a pas été trouvée.
1580 * }
1581 * @return string
1582 **/
1583 function extraire_idiome($letexte, $lang = null, $options = array()) {
1584 static $traduire = false;
1585 if ($letexte
1586 and preg_match_all(_EXTRAIRE_IDIOME, $letexte, $regs, PREG_SET_ORDER)
1587 ) {
1588 if (!$traduire) {
1589 $traduire = charger_fonction('traduire', 'inc');
1590 include_spip('inc/lang');
1591 }
1592 if (!$lang) {
1593 $lang = $GLOBALS['spip_lang'];
1594 }
1595 // Compatibilité avec le prototype de fonction précédente qui utilisait un boolean
1596 if (is_bool($options)) {
1597 $options = array('echappe_span' => $options);
1598 }
1599 if (!isset($options['echappe_span'])) {
1600 $options = array_merge($options, array('echappe_span' => false));
1601 }
1602
1603 foreach ($regs as $reg) {
1604 $cle = ($reg[1] ? $reg[1] . ':' : '') . $reg[2];
1605 $desc = $traduire($cle, $lang, true);
1606 $l = $desc->langue;
1607 // si pas de traduction, on laissera l'écriture de l'idiome entier dans le texte.
1608 if (strlen($desc->texte)) {
1609 $trad = code_echappement($desc->texte, 'idiome', false);
1610 if ($l !== $lang) {
1611 $trad = str_replace("'", '"', inserer_attribut($trad, 'lang', $l));
1612 }
1613 if (lang_dir($l) !== lang_dir($lang)) {
1614 $trad = str_replace("'", '"', inserer_attribut($trad, 'dir', lang_dir($l)));
1615 }
1616 if (!$options['echappe_span']) {
1617 $trad = echappe_retour($trad, 'idiome');
1618 }
1619 $letexte = str_replace($reg[0], $trad, $letexte);
1620 }
1621 }
1622 }
1623 return $letexte;
1624 }
1625
1626 /**
1627 * Expression régulière pour obtenir le contenu des extraits polyglottes `<multi>`
1628 *
1629 * @var string
1630 */
1631 define('_EXTRAIRE_MULTI', "@<multi>(.*?)</multi>@sS");
1632
1633
1634 /**
1635 * Extrait une langue des extraits polyglottes (`<multi>`)
1636 *
1637 * Retrouve les balises `<multi>` d'un texte et remplace son contenu
1638 * par l'extrait correspondant à la langue demandée.
1639 *
1640 * Si la langue demandée n'est pas trouvée dans le multi, ni une langue
1641 * approchante (exemple `fr` si on demande `fr_TU`), on retourne l'extrait
1642 * correspondant à la langue par défaut (option 'lang_defaut'), qui est
1643 * par défaut la langue du site. Et si l'extrait n'existe toujours pas
1644 * dans cette langue, ça utilisera la première langue utilisée
1645 * dans la balise `<multi>`.
1646 *
1647 * Ne pas mettre de span@lang=fr si on est déjà en fr.
1648 *
1649 * @filtre
1650 * @link http://www.spip.net/5332
1651 *
1652 * @uses extraire_trads()
1653 * @uses approcher_langue()
1654 * @uses lang_typo()
1655 * @uses code_echappement()
1656 * @uses echappe_retour()
1657 *
1658 * @param string $letexte
1659 * @param string $lang
1660 * Langue à retrouver (si vide, utilise la langue en cours).
1661 * @param array $options Options {
1662 * @type bool $echappe_span
1663 * True pour échapper les balises span (false par défaut)
1664 * @type string $lang_defaut
1665 * Code de langue : permet de définir la langue utilisée par défaut,
1666 * en cas d'absence de traduction dans la langue demandée.
1667 * Par défaut la langue du site.
1668 * Indiquer 'aucune' pour ne pas retourner de texte si la langue
1669 * exacte n'a pas été trouvée.
1670 * }
1671 * @return string
1672 **/
1673 function extraire_multi($letexte, $lang = null, $options = array()) {
1674
1675 if ($letexte
1676 and preg_match_all(_EXTRAIRE_MULTI, $letexte, $regs, PREG_SET_ORDER)
1677 ) {
1678 if (!$lang) {
1679 $lang = $GLOBALS['spip_lang'];
1680 }
1681
1682 // Compatibilité avec le prototype de fonction précédente qui utilisait un boolean
1683 if (is_bool($options)) {
1684 $options = array('echappe_span' => $options, 'lang_defaut' => _LANGUE_PAR_DEFAUT);
1685 }
1686 if (!isset($options['echappe_span'])) {
1687 $options = array_merge($options, array('echappe_span' => false));
1688 }
1689 if (!isset($options['lang_defaut'])) {
1690 $options = array_merge($options, array('lang_defaut' => _LANGUE_PAR_DEFAUT));
1691 }
1692
1693 include_spip('inc/lang');
1694 foreach ($regs as $reg) {
1695 // chercher la version de la langue courante
1696 $trads = extraire_trads($reg[1]);
1697 if ($l = approcher_langue($trads, $lang)) {
1698 $trad = $trads[$l];
1699 } else {
1700 if ($options['lang_defaut'] == 'aucune') {
1701 $trad = '';
1702 } else {
1703 // langue absente, prendre le fr ou une langue précisée (meme comportement que inc/traduire.php)
1704 // ou la premiere dispo
1705 // mais typographier le texte selon les regles de celle-ci
1706 // Attention aux blocs multi sur plusieurs lignes
1707 if (!$l = approcher_langue($trads, $options['lang_defaut'])) {
1708 $l = key($trads);
1709 }
1710 $trad = $trads[$l];
1711 $typographie = charger_fonction(lang_typo($l), 'typographie');
1712 $trad = $typographie($trad);
1713 // Tester si on echappe en span ou en div
1714 // il ne faut pas echapper en div si propre produit un seul paragraphe
1715 include_spip('inc/texte');
1716 $trad_propre = preg_replace(",(^<p[^>]*>|</p>$),Uims", "", propre($trad));
1717 $mode = preg_match(',</?(' . _BALISES_BLOCS . ')[>[:space:]],iS', $trad_propre) ? 'div' : 'span';
1718 $trad = code_echappement($trad, 'multi', false, $mode);
1719 $trad = str_replace("'", '"', inserer_attribut($trad, 'lang', $l));
1720 if (lang_dir($l) !== lang_dir($lang)) {
1721 $trad = str_replace("'", '"', inserer_attribut($trad, 'dir', lang_dir($l)));
1722 }
1723 if (!$options['echappe_span']) {
1724 $trad = echappe_retour($trad, 'multi');
1725 }
1726 }
1727 }
1728 $letexte = str_replace($reg[0], $trad, $letexte);
1729 }
1730 }
1731
1732 return $letexte;
1733 }
1734
1735 /**
1736 * Convertit le contenu d'une balise `<multi>` en un tableau
1737 *
1738 * Exemple de blocs.
1739 * - `texte par défaut [fr] en français [en] en anglais`
1740 * - `[fr] en français [en] en anglais`
1741 *
1742 * @param string $bloc
1743 * Le contenu intérieur d'un bloc multi
1744 * @return array [code de langue => texte]
1745 * Peut retourner un code de langue vide, lorsqu'un texte par défaut est indiqué.
1746 **/
1747 function extraire_trads($bloc) {
1748 $lang = '';
1749 // ce reg fait planter l'analyse multi s'il y a de l'{italique} dans le champ
1750 // while (preg_match("/^(.*?)[{\[]([a-z_]+)[}\]]/siS", $bloc, $regs)) {
1751 while (preg_match("/^(.*?)[\[]([a-z_]+)[\]]/siS", $bloc, $regs)) {
1752 $texte = trim($regs[1]);
1753 if ($texte or $lang) {
1754 $trads[$lang] = $texte;
1755 }
1756 $bloc = substr($bloc, strlen($regs[0]));
1757 $lang = $regs[2];
1758 }
1759 $trads[$lang] = $bloc;
1760
1761 return $trads;
1762 }
1763
1764
1765 /**
1766 * Calculer l'initiale d'un nom
1767 *
1768 * @param string $nom
1769 * @return string L'initiale en majuscule
1770 */
1771 function filtre_initiale($nom) {
1772 return spip_substr(trim(strtoupper(extraire_multi($nom))), 0, 1);
1773 }
1774
1775
1776 /**
1777 * Retourne la donnée si c'est la première fois qu'il la voit
1778 *
1779 * Il est possible de gérer différentes "familles" de données avec
1780 * le second paramètre.
1781 *
1782 * @filtre
1783 * @link http://www.spip.net/4320
1784 * @example
1785 * ```
1786 * [(#ID_SECTEUR|unique)]
1787 * [(#ID_SECTEUR|unique{tete})] n'a pas d'incidence sur
1788 * [(#ID_SECTEUR|unique{pied})]
1789 * [(#ID_SECTEUR|unique{pied,1})] affiche le nombre d'éléments.
1790 * Préférer totefois #TOTAL_UNIQUE{pied}
1791 * ```
1792 *
1793 * @todo
1794 * Ameliorations possibles :
1795 *
1796 * 1) si la donnée est grosse, mettre son md5 comme clé
1797 * 2) purger $mem quand on change de squelette (sinon bug inclusions)
1798 *
1799 * @param string $donnee
1800 * Donnée que l'on souhaite unique
1801 * @param string $famille
1802 * Famille de stockage (1 unique donnée par famille)
1803 *
1804 * - _spip_raz_ : (interne) Vide la pile de mémoire et la retourne
1805 * - _spip_set_ : (interne) Affecte la pile de mémoire avec la donnée
1806 * @param bool $cpt
1807 * True pour obtenir le nombre d'éléments différents stockés
1808 * @return string|int|array|null|void
1809 *
1810 * - string : Donnée si c'est la première fois qu'elle est vue
1811 * - void : si la donnée a déjà été vue
1812 * - int : si l'on demande le nombre d'éléments
1813 * - array (interne) : si on dépile
1814 * - null (interne) : si on empile
1815 **/
1816 function unique($donnee, $famille = '', $cpt = false) {
1817 static $mem = array();
1818 // permettre de vider la pile et de la restaurer
1819 // pour le calcul de introduction...
1820 if ($famille == '_spip_raz_') {
1821 $tmp = $mem;
1822 $mem = array();
1823
1824 return $tmp;
1825 } elseif ($famille == '_spip_set_') {
1826 $mem = $donnee;
1827
1828 return;
1829 }
1830 // eviter une notice
1831 if (!isset($mem[$famille])) {
1832 $mem[$famille] = array();
1833 }
1834 if ($cpt) {
1835 return count($mem[$famille]);
1836 }
1837 // eviter une notice
1838 if (!isset($mem[$famille][$donnee])) {
1839 $mem[$famille][$donnee] = 0;
1840 }
1841 if (!($mem[$famille][$donnee]++)) {
1842 return $donnee;
1843 }
1844 }
1845
1846
1847 /**
1848 * Filtre qui alterne des valeurs en fonction d'un compteur
1849 *
1850 * Affiche à tour de rôle et dans l'ordre, un des arguments transmis
1851 * à chaque incrément du compteur.
1852 *
1853 * S'il n'y a qu'un seul argument, et que c'est un tableau,
1854 * l'alternance se fait sur les valeurs du tableau.
1855 *
1856 * Souvent appliqué à l'intérieur d'une boucle, avec le compteur `#COMPTEUR_BOUCLE`
1857 *
1858 * @example
1859 * - `[(#COMPTEUR_BOUCLE|alterner{bleu,vert,rouge})]`
1860 * - `[(#COMPTEUR_BOUCLE|alterner{#LISTE{bleu,vert,rouge}})]`
1861 *
1862 * @filtre
1863 * @link http://www.spip.net/4145
1864 *
1865 * @param int $i
1866 * Le compteur
1867 * @return mixed
1868 * Une des valeurs en fonction du compteur.
1869 **/
1870 function alterner($i) {
1871 // recuperer les arguments (attention fonctions un peu space)
1872 $num = func_num_args();
1873 $args = func_get_args();
1874
1875 if ($num == 2 && is_array($args[1])) {
1876 $args = $args[1];
1877 array_unshift($args, '');
1878 $num = count($args);
1879 }
1880
1881 // renvoyer le i-ieme argument, modulo le nombre d'arguments
1882 return $args[(intval($i) - 1) % ($num - 1) + 1];
1883 }
1884
1885
1886 /**
1887 * Récupérer un attribut d'une balise HTML
1888 *
1889 * la regexp est mortelle : cf. `tests/unit/filtres/extraire_attribut.php`
1890 * Si on a passé un tableau de balises, renvoyer un tableau de résultats
1891 * (dans ce cas l'option `$complet` n'est pas disponible)
1892 *
1893 * @param string|array $balise
1894 * Texte ou liste de textes dont on veut extraire des balises
1895 * @param string $attribut
1896 * Nom de l'attribut désiré
1897 * @param bool $complet
1898 * True pour retourner un tableau avec
1899 * - le texte de la balise
1900 * - l'ensemble des résultats de la regexp ($r)
1901 * @return string|array
1902 * - Texte de l'attribut retourné, ou tableau des texte d'attributs
1903 * (si 1er argument tableau)
1904 * - Tableau complet (si 2e argument)
1905 **/
1906 function extraire_attribut($balise, $attribut, $complet = false) {
1907 if (is_array($balise)) {
1908 array_walk($balise,
1909 create_function('&$a,$key,$t',
1910 '$a = extraire_attribut($a,$t);'
1911 ),
1912 $attribut);
1913
1914 return $balise;
1915 }
1916 if (preg_match(
1917 ',(^.*?<(?:(?>\s*)(?>[\w:.-]+)(?>(?:=(?:"[^"]*"|\'[^\']*\'|[^\'"]\S*))?))*?)(\s+'
1918 . $attribut
1919 . '(?:=\s*("[^"]*"|\'[^\']*\'|[^\'"]\S*))?)()((?:[\s/][^>]*)?>.*),isS',
1920
1921 $balise, $r)) {
1922 if (isset($r[3][0]) and ($r[3][0] == '"' || $r[3][0] == "'")) {
1923 $r[4] = substr($r[3], 1, -1);
1924 $r[3] = $r[3][0];
1925 } elseif ($r[3] !== '') {
1926 $r[4] = $r[3];
1927 $r[3] = '';
1928 } else {
1929 $r[4] = trim($r[2]);
1930 }
1931 $att = $r[4];
1932 if (strpos($att, "&#") !== false) {
1933 $att = str_replace(array("&#039;", "&#39;", "&#034;", "&#34;"), array("'", "'", '"', '"'), $att);
1934 }
1935 $att = filtrer_entites($att);
1936 } else {
1937 $att = null;
1938 }
1939
1940 if ($complet) {
1941 return array($att, $r);
1942 } else {
1943 return $att;
1944 }
1945 }
1946
1947 /**
1948 * Insérer (ou modifier) un attribut html dans une balise
1949 *
1950 * @example
1951 * - `[(#LOGO_ARTICLE|inserer_attribut{class, logo article})]`
1952 * - `[(#LOGO_ARTICLE|inserer_attribut{alt, #TTTRE|attribut_html|couper{60}})]`
1953 * - `[(#FICHIER|image_reduire{40}|inserer_attribut{data-description, #DESCRIPTIF})]`
1954 * Laissera les balises HTML de la valeur (ici `#DESCRIPTIF`) si on n'applique pas le
1955 * filtre `attribut_html` dessus.
1956 *
1957 * @filtre
1958 * @link http://www.spip.net/4294
1959 * @uses attribut_html()
1960 * @uses extraire_attribut()
1961 *
1962 * @param string $balise
1963 * Code html de la balise (ou contenant une balise)
1964 * @param string $attribut
1965 * Nom de l'attribut html à modifier
1966 * @param string $val
1967 * Valeur de l'attribut à appliquer
1968 * @param bool $proteger
1969 * Prépare la valeur en tant qu'attribut de balise (mais conserve les balises html).
1970 * @param bool $vider
1971 * True pour vider l'attribut. Une chaîne vide pour `$val` fera pareil.
1972 * @return string
1973 * Code html modifié
1974 **/
1975 function inserer_attribut($balise, $attribut, $val, $proteger = true, $vider = false) {
1976 // preparer l'attribut
1977 // supprimer les &nbsp; etc mais pas les balises html
1978 // qui ont un sens dans un attribut value d'un input
1979 if ($proteger) {
1980 $val = attribut_html($val, false);
1981 }
1982
1983 // echapper les ' pour eviter tout bug
1984 $val = str_replace("'", "&#039;", $val);
1985 if ($vider and strlen($val) == 0) {
1986 $insert = '';
1987 } else {
1988 $insert = " $attribut='$val'";
1989 }
1990
1991 list($old, $r) = extraire_attribut($balise, $attribut, true);
1992
1993 if ($old !== null) {
1994 // Remplacer l'ancien attribut du meme nom
1995 $balise = $r[1] . $insert . $r[5];
1996 } else {
1997 // preferer une balise " />" (comme <img />)
1998 if (preg_match(',/>,', $balise)) {
1999 $balise = preg_replace(",\s?/>,S", $insert . " />", $balise, 1);
2000 } // sinon une balise <a ...> ... </a>
2001 else {
2002 $balise = preg_replace(",\s?>,S", $insert . ">", $balise, 1);
2003 }
2004 }
2005
2006 return $balise;
2007 }
2008
2009 /**
2010 * Supprime un attribut HTML
2011 *
2012 * @example `[(#LOGO_ARTICLE|vider_attribut{class})]`
2013 *
2014 * @filtre
2015 * @link http://www.spip.net/4142
2016 * @uses inserer_attribut()
2017 * @see extraire_attribut()
2018 *
2019 * @param string $balise Code HTML de l'élément
2020 * @param string $attribut Nom de l'attribut à enlever
2021 * @return string Code HTML sans l'attribut
2022 **/
2023 function vider_attribut($balise, $attribut) {
2024 return inserer_attribut($balise, $attribut, '', false, true);
2025 }
2026
2027
2028 /**
2029 * Un filtre pour déterminer le nom du statut des inscrits
2030 *
2031 * @param void|int $id
2032 * @param string $mode
2033 * @return string
2034 */
2035 function tester_config($id, $mode = '') {
2036 include_spip('action/inscrire_auteur');
2037
2038 return tester_statut_inscription($mode, $id);
2039 }
2040
2041 //
2042 // Quelques fonctions de calcul arithmetique
2043 //
2044 function floatstr($a) { return str_replace(',','.',(string)floatval($a)); }
2045 function strize($f, $a, $b) { return floatstr($f(floatstr($a),floatstr($b))); }
2046
2047 /**
2048 * Additionne 2 nombres
2049 *
2050 * @filtre
2051 * @link http://www.spip.net/4307
2052 * @see moins()
2053 * @example
2054 * ```
2055 * [(#VAL{28}|plus{14})]
2056 * ```
2057 *
2058 * @param int $a
2059 * @param int $b
2060 * @return int $a+$b
2061 **/
2062 function plus($a, $b) {
2063 return $a + $b;
2064 }
2065 function strplus($a, $b) {return strize('plus', $a, $b);}
2066 /**
2067 * Soustrait 2 nombres
2068 *
2069 * @filtre
2070 * @link http://www.spip.net/4302
2071 * @see plus()
2072 * @example
2073 * ```
2074 * [(#VAL{28}|moins{14})]
2075 * ```
2076 *
2077 * @param int $a
2078 * @param int $b
2079 * @return int $a-$b
2080 **/
2081 function moins($a, $b) {
2082 return $a - $b;
2083 }
2084 function strmoins($a, $b) {return strize('moins', $a, $b);}
2085
2086 /**
2087 * Multiplie 2 nombres
2088 *
2089 * @filtre
2090 * @link http://www.spip.net/4304
2091 * @see div()
2092 * @see modulo()
2093 * @example
2094 * ```
2095 * [(#VAL{28}|mult{14})]
2096 * ```
2097 *
2098 * @param int $a
2099 * @param int $b
2100 * @return int $a*$b
2101 **/
2102 function mult($a, $b) {
2103 return $a * $b;
2104 }
2105 function strmult($a, $b) {return strize('mult', $a, $b);}
2106
2107 /**
2108 * Divise 2 nombres
2109 *
2110 * @filtre
2111 * @link http://www.spip.net/4279
2112 * @see mult()
2113 * @see modulo()
2114 * @example
2115 * ```
2116 * [(#VAL{28}|div{14})]
2117 * ```
2118 *
2119 * @param int $a
2120 * @param int $b
2121 * @return int $a/$b (ou 0 si $b est nul)
2122 **/
2123 function div($a, $b) {
2124 return $b ? $a / $b : 0;
2125 }
2126 function strdiv($a, $b) {return strize('div', $a, $b);}
2127
2128 /**
2129 * Retourne le modulo 2 nombres
2130 *
2131 * @filtre
2132 * @link http://www.spip.net/4301
2133 * @see mult()
2134 * @see div()
2135 * @example
2136 * ```
2137 * [(#VAL{28}|modulo{14})]
2138 * ```
2139 *
2140 * @param int $nb
2141 * @param int $mod
2142 * @param int $add
2143 * @return int ($nb % $mod) + $add
2144 **/
2145 function modulo($nb, $mod, $add = 0) {
2146 return ($mod ? $nb % $mod : 0) + $add;
2147 }
2148
2149
2150 /**
2151 * Vérifie qu'un nom (d'auteur) ne comporte pas d'autres tags que <multi>
2152 * et ceux volontairement spécifiés dans la constante
2153 *
2154 * @param string $nom
2155 * Nom (signature) proposé
2156 * @return bool
2157 * - false si pas conforme,
2158 * - true sinon
2159 **/
2160 function nom_acceptable($nom) {
2161 if (!is_string($nom)) {
2162 return false;
2163 }
2164 if (!defined('_TAGS_NOM_AUTEUR')) {
2165 define('_TAGS_NOM_AUTEUR', '');
2166 }
2167 $tags_acceptes = array_unique(explode(',', 'multi,' . _TAGS_NOM_AUTEUR));
2168 foreach ($tags_acceptes as $tag) {
2169 if (strlen($tag)) {
2170 $remp1[] = '<' . trim($tag) . '>';
2171 $remp1[] = '</' . trim($tag) . '>';
2172 $remp2[] = '\x60' . trim($tag) . '\x61';
2173 $remp2[] = '\x60/' . trim($tag) . '\x61';
2174 }
2175 }
2176 $v_nom = str_replace($remp2, $remp1, supprimer_tags(str_replace($remp1, $remp2, $nom)));
2177
2178 return str_replace('&lt;', '<', $v_nom) == $nom;
2179 }
2180
2181
2182 /**
2183 * Vérifier la conformité d'une ou plusieurs adresses email (suivant RFC 822)
2184 *
2185 * @param string $adresses
2186 * Adresse ou liste d'adresse
2187 * @return bool|string
2188 * - false si pas conforme,
2189 * - la normalisation de la dernière adresse donnée sinon
2190 **/
2191 function email_valide($adresses) {
2192 // eviter d'injecter n'importe quoi dans preg_match
2193 if (!is_string($adresses)) {
2194 return false;
2195 }
2196
2197 // Si c'est un spammeur autant arreter tout de suite
2198 if (preg_match(",[\n\r].*(MIME|multipart|Content-),i", $adresses)) {
2199 spip_log("Tentative d'injection de mail : $adresses");
2200
2201 return false;
2202 }
2203
2204 foreach (explode(',', $adresses) as $v) {
2205 // nettoyer certains formats
2206 // "Marie Toto <Marie@toto.com>"
2207 $adresse = trim(preg_replace(",^[^<>\"]*<([^<>\"]+)>$,i", "\\1", $v));
2208 // RFC 822
2209 if (!preg_match('#^[^()<>@,;:\\"/[:space:]]+(@([-_0-9a-z]+\.)*[-_0-9a-z]+)$#i', $adresse)) {
2210 return false;
2211 }
2212 }
2213
2214 return $adresse;
2215 }
2216
2217 /**
2218 * Permet d'afficher un symbole à côté des liens pointant vers les
2219 * documents attachés d'un article (liens ayant `rel=enclosure`).
2220 *
2221 * @filtre
2222 * @link http://www.spip.net/4134
2223 *
2224 * @param string $tags Texte
2225 * @return string Texte
2226 **/
2227 function afficher_enclosures($tags) {
2228 $s = array();
2229 foreach (extraire_balises($tags, 'a') as $tag) {
2230 if (extraire_attribut($tag, 'rel') == 'enclosure'
2231 and $t = extraire_attribut($tag, 'href')
2232 ) {
2233 $s[] = preg_replace(',>[^<]+</a>,S',
2234 '>'
2235 . http_img_pack('attachment-16.png', $t,
2236 'title="' . attribut_html($t) . '"')
2237 . '</a>', $tag);
2238 }
2239 }
2240
2241 return join('&nbsp;', $s);
2242 }
2243
2244 /**
2245 * Filtre des liens HTML `<a>` selon la valeur de leur attribut `rel`
2246 * et ne retourne que ceux là.
2247 *
2248 * @filtre
2249 * @link http://www.spip.net/4187
2250 *
2251 * @param string $tags Texte
2252 * @param string $rels Attribut `rel` à capturer (ou plusieurs séparés par des virgules)
2253 * @return string Liens trouvés
2254 **/
2255 function afficher_tags($tags, $rels = 'tag,directory') {
2256 $s = array();
2257 foreach (extraire_balises($tags, 'a') as $tag) {
2258 $rel = extraire_attribut($tag, 'rel');
2259 if (strstr(",$rels,", ",$rel,")) {
2260 $s[] = $tag;
2261 }
2262 }
2263
2264 return join(', ', $s);
2265 }
2266
2267
2268 /**
2269 * Convertir les médias fournis par un flux RSS (podcasts)
2270 * en liens conformes aux microformats
2271 *
2272 * Passe un `<enclosure url="fichier" length="5588242" type="audio/mpeg"/>`
2273 * au format microformat `<a rel="enclosure" href="fichier" ...>fichier</a>`.
2274 *
2275 * Peut recevoir un `<link` ou un `<media:content` parfois.
2276 *
2277 * Attention : `length="zz"` devient `title="zz"`, pour rester conforme.
2278 *
2279 * @filtre
2280 * @see microformat2enclosure() Pour l'inverse
2281 *
2282 * @param string $e Tag RSS `<enclosure>`
2283 * @return string Tag HTML `<a>` avec microformat.
2284 **/
2285 function enclosure2microformat($e) {
2286 if (!$url = filtrer_entites(extraire_attribut($e, 'url'))) {
2287 $url = filtrer_entites(extraire_attribut($e, 'href'));
2288 }
2289 $type = extraire_attribut($e, 'type');
2290 if (!$length = extraire_attribut($e, 'length')) {
2291 # <media:content : longeur dans fileSize. On tente.
2292 $length = extraire_attribut($e, 'fileSize');
2293 }
2294 $fichier = basename($url);
2295
2296 return '<a rel="enclosure"'
2297 . ($url ? ' href="' . spip_htmlspecialchars($url) . '"' : '')
2298 . ($type ? ' type="' . spip_htmlspecialchars($type) . '"' : '')
2299 . ($length ? ' title="' . spip_htmlspecialchars($length) . '"' : '')
2300 . '>' . $fichier . '</a>';
2301 }
2302
2303 /**
2304 * Convertir les liens conformes aux microformats en médias pour flux RSS,
2305 * par exemple pour les podcasts
2306 *
2307 * Passe un texte ayant des liens avec microformat
2308 * `<a rel="enclosure" href="fichier" ...>fichier</a>`
2309 * au format RSS `<enclosure url="fichier" ... />`.
2310 *
2311 * @filtre
2312 * @see enclosure2microformat() Pour l'inverse
2313 *
2314 * @param string $tags Texte HTML ayant des tag `<a>` avec microformat
2315 * @return string Tags RSS `<enclosure>`.
2316 **/
2317 function microformat2enclosure($tags) {
2318 $enclosures = array();
2319 foreach (extraire_balises($tags, 'a') as $e) {
2320 if (extraire_attribut($e, 'rel') == 'enclosure') {
2321 $url = filtrer_entites(extraire_attribut($e, 'href'));
2322 $type = extraire_attribut($e, 'type');
2323 if (!$length = intval(extraire_attribut($e, 'title'))) {
2324 $length = intval(extraire_attribut($e, 'length'));
2325 } # vieux data
2326 $fichier = basename($url);
2327 $enclosures[] = '<enclosure'
2328 . ($url ? ' url="' . spip_htmlspecialchars($url) . '"' : '')
2329 . ($type ? ' type="' . spip_htmlspecialchars($type) . '"' : '')
2330 . ($length ? ' length="' . $length . '"' : '')
2331 . ' />';
2332 }
2333 }
2334
2335 return join("\n", $enclosures);
2336 }
2337
2338
2339 /**
2340 * Créer les éléments ATOM `<dc:subject>` à partir des tags
2341 *
2342 * Convertit les liens avec attribut `rel="tag"`
2343 * en balise `<dc:subject></dc:subject>` pour les flux RSS au format Atom.
2344 *
2345 * @filtre
2346 *
2347 * @param string $tags Texte
2348 * @return string Tags RSS Atom `<dc:subject>`.
2349 **/
2350 function tags2dcsubject($tags) {
2351 $subjects = '';
2352 foreach (extraire_balises($tags, 'a') as $e) {
2353 if (extraire_attribut($e, rel) == 'tag') {
2354 $subjects .= '<dc:subject>'
2355 . texte_backend(textebrut($e))
2356 . '</dc:subject>' . "\n";
2357 }
2358 }
2359
2360 return $subjects;
2361 }
2362
2363 /**
2364 * Retourne la premiere balise html du type demandé
2365 *
2366 * Retourne le contenu d'une balise jusqu'à la première fermeture rencontrée
2367 * du même type.
2368 * Si on a passe un tableau de textes, retourne un tableau de resultats.
2369 *
2370 * @example `[(#DESCRIPTIF|extraire_balise{img})]`
2371 *
2372 * @filtre
2373 * @link http://www.spip.net/4289
2374 * @see extraire_balises()
2375 * @note
2376 * Attention : les résultats peuvent être incohérents sur des balises imbricables,
2377 * tel que demander à extraire `div` dans le texte `<div> un <div> mot </div> absent </div>`,
2378 * ce qui retournerait `<div> un <div> mot </div>` donc.
2379 *
2380 * @param string|array $texte
2381 * Texte(s) dont on souhaite extraire une balise html
2382 * @param string $tag
2383 * Nom de la balise html à extraire
2384 * @return void|string|array
2385 * - Code html de la balise, sinon rien
2386 * - Tableau de résultats, si tableau en entrée.
2387 **/
2388 function extraire_balise($texte, $tag = 'a') {
2389 if (is_array($texte)) {
2390 array_walk(
2391 $texte,
2392 create_function('&$a,$key,$t', '$a = extraire_balise($a,$t);'),
2393 $tag
2394 );
2395
2396 return $texte;
2397 }
2398
2399 if (preg_match(
2400 ",<$tag\b[^>]*(/>|>.*</$tag\b[^>]*>|>),UimsS",
2401 $texte, $regs)) {
2402 return $regs[0];
2403 }
2404 }
2405
2406 /**
2407 * Extrait toutes les balises html du type demandé
2408 *
2409 * Retourne dans un tableau le contenu de chaque balise jusqu'à la première
2410 * fermeture rencontrée du même type.
2411 * Si on a passe un tableau de textes, retourne un tableau de resultats.
2412 *
2413 * @example `[(#TEXTE|extraire_balises{img}|implode{" - "})]`
2414 *
2415 * @filtre
2416 * @link http://www.spip.net/5618
2417 * @see extraire_balise()
2418 * @note
2419 * Attention : les résultats peuvent être incohérents sur des balises imbricables,
2420 * tel que demander à extraire `div` dans un texte.
2421 *
2422 * @param string|array $texte
2423 * Texte(s) dont on souhaite extraire une balise html
2424 * @param string $tag
2425 * Nom de la balise html à extraire
2426 * @return array
2427 * - Liste des codes html des occurrences de la balise, sinon tableau vide
2428 * - Tableau de résultats, si tableau en entrée.
2429 **/
2430 function extraire_balises($texte, $tag = 'a') {
2431 if (is_array($texte)) {
2432 array_walk(
2433 $texte,
2434 create_function('&$a,$key,$t', '$a = extraire_balises($a,$t);'),
2435 $tag
2436 );
2437
2438 return $texte;
2439 }
2440
2441 if (preg_match_all(
2442 ",<${tag}\b[^>]*(/>|>.*</${tag}\b[^>]*>|>),UimsS",
2443 $texte, $regs, PREG_PATTERN_ORDER)) {
2444 return $regs[0];
2445 } else {
2446 return array();
2447 }
2448 }
2449
2450 /**
2451 * Indique si le premier argument est contenu dans le second
2452 *
2453 * Cette fonction est proche de `in_array()` en PHP avec comme principale
2454 * différence qu'elle ne crée pas d'erreur si le second argument n'est pas
2455 * un tableau (dans ce cas elle tentera de le désérialiser, et sinon retournera
2456 * la valeur par défaut transmise).
2457 *
2458 * @example `[(#VAL{deux}|in_any{#LISTE{un,deux,trois}}|oui) ... ]`
2459 *
2460 * @filtre
2461 * @see filtre_find() Assez proche, avec les arguments valeur et tableau inversés.
2462 *
2463 * @param string $val
2464 * Valeur à chercher dans le tableau
2465 * @param array|string $vals
2466 * Tableau des valeurs. S'il ce n'est pas un tableau qui est transmis,
2467 * la fonction tente de la désérialiser.
2468 * @param string $def
2469 * Valeur par défaut retournée si `$vals` n'est pas un tableau.
2470 * @return string
2471 * - ' ' si la valeur cherchée est dans le tableau
2472 * - '' si la valeur n'est pas dans le tableau
2473 * - `$def` si on n'a pas transmis de tableau
2474 **/
2475 function in_any($val, $vals, $def = '') {
2476 if (!is_array($vals) and $v = unserialize($vals)) {
2477 $vals = $v;
2478 }
2479
2480 return (!is_array($vals) ? $def : (in_array($val, $vals) ? ' ' : ''));
2481 }
2482
2483
2484 /**
2485 * Retourne le résultat d'une expression mathématique simple
2486 *
2487 * N'accepte que les *, + et - (à ameliorer si on l'utilise vraiment).
2488 *
2489 * @filtre
2490 * @example
2491 * ```
2492 * valeur_numerique("3*2") retourne 6
2493 * ```
2494 *
2495 * @param string $expr
2496 * Expression mathématique `nombre operateur nombre` comme `3*2`
2497 * @return int
2498 * Résultat du calcul
2499 **/
2500 function valeur_numerique($expr) {
2501 $a = 0;
2502 if (preg_match(',^[0-9]+(\s*[+*-]\s*[0-9]+)*$,S', trim($expr))) {
2503 eval("\$a = $expr;");
2504 }
2505
2506 return intval($a);
2507 }
2508
2509 /**
2510 * Retourne un calcul de règle de trois
2511 *
2512 * @filtre
2513 * @example
2514 * ```
2515 * [(#VAL{6}|regledetrois{4,3})] retourne 8
2516 * ```
2517 *
2518 * @param int $a
2519 * @param int $b
2520 * @param int $c
2521 * @return int
2522 * Retourne `$a*$b/$c`
2523 **/
2524 function regledetrois($a, $b, $c) {
2525 return round($a * $b / $c);
2526 }
2527
2528
2529 /**
2530 * Crée des tags HTML input hidden pour chaque paramètre et valeur d'une URL
2531 *
2532 * Fournit la suite de Input-Hidden correspondant aux paramètres de
2533 * l'URL donnée en argument, compatible avec les types_urls
2534 *
2535 * @filtre
2536 * @link http://www.spip.net/4286
2537 * @see balise_ACTION_FORMULAIRE()
2538 * Également pour transmettre les actions à un formulaire
2539 * @example
2540 * ```
2541 * [(#ENV{action}|form_hidden)] dans un formulaire
2542 * ```
2543 *
2544 * @param string $action URL
2545 * @return string Suite de champs input hidden
2546 **/
2547 function form_hidden($action) {
2548
2549 $contexte = array();
2550 include_spip('inc/urls');
2551 if ($p = urls_decoder_url($action, '')
2552 and reset($p)
2553 ) {
2554 $fond = array_shift($p);
2555 if ($fond != '404') {
2556 $contexte = array_shift($p);
2557 $contexte['page'] = $fond;
2558 $action = preg_replace('/([?]' . preg_quote($fond) . '[^&=]*[0-9]+)(&|$)/', '?&', $action);
2559 }
2560 }
2561 // defaire ce qu'a injecte urls_decoder_url : a revoir en modifiant la signature de urls_decoder_url
2562 if (defined('_DEFINIR_CONTEXTE_TYPE') and _DEFINIR_CONTEXTE_TYPE) {
2563 unset($contexte['type']);
2564 }
2565 if (defined('_DEFINIR_CONTEXTE_TYPE_PAGE') and _DEFINIR_CONTEXTE_TYPE_PAGE) {
2566 unset($contexte['type-page']);
2567 }
2568
2569 // on va remplir un tableau de valeurs en prenant bien soin de ne pas
2570 // ecraser les elements de la forme mots[]=1&mots[]=2
2571 $values = array();
2572
2573 // d'abord avec celles de l'url
2574 if (false !== ($p = strpos($action, '?'))) {
2575 foreach (preg_split('/&(amp;)?/S', substr($action, $p + 1)) as $c) {
2576 $c = explode('=', $c, 2);
2577 $var = array_shift($c);
2578 $val = array_shift($c);
2579 if ($var) {
2580 $val = rawurldecode($val);
2581 $var = rawurldecode($var); // decoder les [] eventuels
2582 if (preg_match(',\[\]$,S', $var)) {
2583 $values[] = array($var, $val);
2584 } else {
2585 if (!isset($values[$var])) {
2586 $values[$var] = array($var, $val);
2587 }
2588 }
2589 }
2590 }
2591 }
2592
2593 // ensuite avec celles du contexte, sans doublonner !
2594 foreach ($contexte as $var => $val) {
2595 if (preg_match(',\[\]$,S', $var)) {
2596 $values[] = array($var, $val);
2597 } else {
2598 if (!isset($values[$var])) {
2599 $values[$var] = array($var, $val);
2600 }
2601 }
2602 }
2603
2604 // puis on rassemble le tout
2605 $hidden = array();
2606 foreach ($values as $value) {
2607 list($var, $val) = $value;
2608 $hidden[] = '<input name="'
2609 . entites_html($var)
2610 . '"'
2611 . (is_null($val)
2612 ? ''
2613 : ' value="' . entites_html($val) . '"'
2614 )
2615 . ' type="hidden"' . "\n/>";
2616 }
2617
2618 return join("", $hidden);
2619 }
2620
2621 /**
2622 * Calcule les bornes d'une pagination
2623 *
2624 * @filtre
2625 *
2626 * @param int $courante
2627 * Page courante
2628 * @param int $nombre
2629 * Nombre de pages
2630 * @param int $max
2631 * Nombre d'éléments par page
2632 * @return int[]
2633 * Liste (première page, dernière page).
2634 **/
2635 function filtre_bornes_pagination_dist($courante, $nombre, $max = 10) {
2636 if ($max <= 0 or $max >= $nombre) {
2637 return array(1, $nombre);
2638 }
2639
2640 $premiere = max(1, $courante - floor(($max - 1) / 2));
2641 $derniere = min($nombre, $premiere + $max - 2);
2642 $premiere = $derniere == $nombre ? $derniere - $max + 1 : $premiere;
2643
2644 return array($premiere, $derniere);
2645 }
2646
2647
2648 /**
2649 * Retourne la première valeur d'un tableau
2650 *
2651 * Plus précisément déplace le pointeur du tableau sur la première valeur et la retourne.
2652 *
2653 * @example `[(#LISTE{un,deux,trois}|reset)]` retourne 'un'
2654 *
2655 * @filtre
2656 * @link http://php.net/manual/fr/function.reset.php
2657 * @see filtre_end()
2658 *
2659 * @param array $array
2660 * @return mixed|null|false
2661 * - null si $array n'est pas un tableau,
2662 * - false si le tableau est vide
2663 * - la première valeur du tableau sinon.
2664 **/
2665 function filtre_reset($array) {
2666 return !is_array($array) ? null : reset($array);
2667 }
2668
2669 /**
2670 * Retourne la dernière valeur d'un tableau
2671 *
2672 * Plus précisément déplace le pointeur du tableau sur la dernière valeur et la retourne.
2673 *
2674 * @example `[(#LISTE{un,deux,trois}|end)]` retourne 'trois'
2675 *
2676 * @filtre
2677 * @link http://php.net/manual/fr/function.end.php
2678 * @see filtre_reset()
2679 *
2680 * @param array $array
2681 * @return mixed|null|false
2682 * - null si $array n'est pas un tableau,
2683 * - false si le tableau est vide
2684 * - la dernière valeur du tableau sinon.
2685 **/
2686 function filtre_end($array) {
2687 return !is_array($array) ? null : end($array);
2688 }
2689
2690 /**
2691 * Empile une valeur à la fin d'un tableau
2692 *
2693 * @example `[(#LISTE{un,deux,trois}|push{quatre}|print)]`
2694 *
2695 * @filtre
2696 * @link http://www.spip.net/4571
2697 * @link http://php.net/manual/fr/function.array-push.php
2698 *
2699 * @param array $array
2700 * @param mixed $val
2701 * @return array|string
2702 * - '' si $array n'est pas un tableau ou si echec.
2703 * - le tableau complété de la valeur sinon.
2704 *
2705 **/
2706 function filtre_push($array, $val) {
2707 if (!is_array($array) or !array_push($array, $val)) {
2708 return '';
2709 }
2710
2711 return $array;
2712 }
2713
2714 /**
2715 * Indique si une valeur est contenue dans un tableau
2716 *
2717 * @example `[(#LISTE{un,deux,trois}|find{quatre}|oui) ... ]`
2718 *
2719 * @filtre
2720 * @link http://www.spip.net/4575
2721 * @see in_any() Assez proche, avec les paramètres tableau et valeur inversés.
2722 *
2723 * @param array $array
2724 * @param mixed $val
2725 * @return bool
2726 * - `false` si `$array` n'est pas un tableau
2727 * - `true` si la valeur existe dans le tableau, `false` sinon.
2728 **/
2729 function filtre_find($array, $val) {
2730 return (is_array($array) and in_array($val, $array));
2731 }
2732
2733
2734 /**
2735 * Filtre calculant une pagination, utilisé par la balise `#PAGINATION`
2736 *
2737 * Le filtre cherche le modèle `pagination.html` par défaut, mais peut
2738 * chercher un modèle de pagination particulier avec l'argument `$modele`.
2739 * S'il `$modele='prive'`, le filtre cherchera le modèle `pagination_prive.html`.
2740 *
2741 * @filtre
2742 * @see balise_PAGINATION_dist()
2743 *
2744 * @param int $total
2745 * Nombre total d'éléments
2746 * @param string $nom
2747 * Nom identifiant la pagination
2748 * @param int $position
2749 * Page à afficher (tel que la 3è page)
2750 * @param int $pas
2751 * Nombre d'éléments par page
2752 * @param bool $liste
2753 * - True pour afficher toute la liste des éléments,
2754 * - False pour n'afficher que l'ancre
2755 * @param string $modele
2756 * Nom spécifique du modèle de pagination
2757 * @param string $connect
2758 * Nom du connecteur à la base de données
2759 * @param array $env
2760 * Environnement à transmettre au modèle
2761 * @return string
2762 * Code HTML de la pagination
2763 **/
2764 function filtre_pagination_dist(
2765 $total,
2766 $nom,
2767 $position,
2768 $pas,
2769 $liste = true,
2770 $modele = '',
2771 $connect = '',
2772 $env = array()
2773 ) {
2774 static $ancres = array();
2775 if ($pas < 1) {
2776 return '';
2777 }
2778 $ancre = 'pagination' . $nom; // #pagination_articles
2779 $debut = 'debut' . $nom; // 'debut_articles'
2780
2781 // n'afficher l'ancre qu'une fois
2782 if (!isset($ancres[$ancre])) {
2783 $bloc_ancre = $ancres[$ancre] = "<a name='" . $ancre . "' id='" . $ancre . "'></a>";
2784 } else {
2785 $bloc_ancre = '';
2786 }
2787 // liste = false : on ne veut que l'ancre
2788 if (!$liste) {
2789 return $ancres[$ancre];
2790 }
2791
2792 $pagination = array(
2793 'debut' => $debut,
2794 'url' => parametre_url(self(), 'fragment', ''), // nettoyer l'id ahah eventuel
2795 'total' => $total,
2796 'position' => intval($position),
2797 'pas' => $pas,
2798 'nombre_pages' => floor(($total - 1) / $pas) + 1,
2799 'page_courante' => floor(intval($position) / $pas) + 1,
2800 'ancre' => $ancre,
2801 'bloc_ancre' => $bloc_ancre
2802 );
2803 if (is_array($env)) {
2804 $pagination = array_merge($env, $pagination);
2805 }
2806
2807 // Pas de pagination
2808 if ($pagination['nombre_pages'] <= 1) {
2809 return '';
2810 }
2811
2812 if ($modele) {
2813 $modele = '_' . $modele;
2814 }
2815
2816 return recuperer_fond("modeles/pagination$modele", $pagination, array('trim' => true), $connect);
2817 }
2818
2819
2820 /**
2821 * Passer les url relatives à la css d'origine en url absolues
2822 *
2823 * @uses suivre_lien()
2824 *
2825 * @param string $contenu
2826 * Contenu du fichier CSS
2827 * @param string $source
2828 * Chemin du fichier CSS
2829 * @return string
2830 * Contenu avec urls en absolus
2831 **/
2832 function urls_absolues_css($contenu, $source) {
2833 $path = suivre_lien(url_absolue($source), './');
2834
2835 return preg_replace_callback(
2836 ",url\s*\(\s*['\"]?([^'\"/#\s][^:]*)['\"]?\s*\),Uims",
2837 create_function('$x',
2838 'return "url(\'".suivre_lien(\'' . $path . '\',$x[1])."\')";'
2839 ), $contenu);
2840 }
2841
2842
2843 /**
2844 * Inverse le code CSS (left <--> right) d'une feuille de style CSS
2845 *
2846 * Récupère le chemin d'une CSS existante et :
2847 *
2848 * 1. regarde si une CSS inversée droite-gauche existe dans le meme répertoire
2849 * 2. sinon la crée (ou la recrée) dans `_DIR_VAR/cache_css/`
2850 *
2851 * Si on lui donne à manger une feuille nommée `*_rtl.css` il va faire l'inverse.
2852 *
2853 * @filtre
2854 * @example
2855 * ```
2856 * [<link rel="stylesheet" href="(#CHEMIN{css/perso.css}|direction_css)" type="text/css" />]
2857 * ```
2858 * @param string $css
2859 * Chemin vers le fichier CSS
2860 * @param string $voulue
2861 * Permet de forcer le sens voulu (en indiquant `ltr`, `rtl` ou un
2862 * code de langue). En absence, prend le sens de la langue en cours.
2863 *
2864 * @return string
2865 * Chemin du fichier CSS inversé
2866 **/
2867 function direction_css($css, $voulue = '') {
2868 if (!preg_match(',(_rtl)?\.css$,i', $css, $r)) {
2869 return $css;
2870 }
2871
2872 // si on a precise le sens voulu en argument, le prendre en compte
2873 if ($voulue = strtolower($voulue)) {
2874 if ($voulue != 'rtl' and $voulue != 'ltr') {
2875 $voulue = lang_dir($voulue);
2876 }
2877 } else {
2878 $voulue = lang_dir();
2879 }
2880
2881 $r = count($r) > 1;
2882 $right = $r ? 'left' : 'right'; // 'right' de la css lue en entree
2883 $dir = $r ? 'rtl' : 'ltr';
2884 $ndir = $r ? 'ltr' : 'rtl';
2885
2886 if ($voulue == $dir) {
2887 return $css;
2888 }
2889
2890 if (
2891 // url absolue
2892 preg_match(",^http:,i", $css)
2893 // ou qui contient un ?
2894 or (($p = strpos($css, '?')) !== false)
2895 ) {
2896 $distant = true;
2897 $cssf = parse_url($css);
2898 $cssf = $cssf['path'] . ($cssf['query'] ? "?" . $cssf['query'] : "");
2899 $cssf = preg_replace(',[?:&=],', "_", $cssf);
2900 } else {
2901 $distant = false;
2902 $cssf = $css;
2903 // 1. regarder d'abord si un fichier avec la bonne direction n'est pas aussi
2904 //propose (rien a faire dans ce cas)
2905 $f = preg_replace(',(_rtl)?\.css$,i', '_' . $ndir . '.css', $css);
2906 if (@file_exists($f)) {
2907 return $f;
2908 }
2909 }
2910
2911 // 2.
2912 $dir_var = sous_repertoire(_DIR_VAR, 'cache-css');
2913 $f = $dir_var
2914 . preg_replace(',.*/(.*?)(_rtl)?\.css,', '\1', $cssf)
2915 . '.' . substr(md5($cssf), 0, 4) . '_' . $ndir . '.css';
2916
2917 // la css peut etre distante (url absolue !)
2918 if ($distant) {
2919 include_spip('inc/distant');
2920 $contenu = recuperer_page($css);
2921 if (!$contenu) {
2922 return $css;
2923 }
2924 } else {
2925 if ((@filemtime($f) > @filemtime($css))
2926 and (_VAR_MODE != 'recalcul')
2927 ) {
2928 return $f;
2929 }
2930 if (!lire_fichier($css, $contenu)) {
2931 return $css;
2932 }
2933 }
2934
2935 $contenu = str_replace(
2936 array('right', 'left', '@@@@L E F T@@@@'),
2937 array('@@@@L E F T@@@@', 'right', 'left'),
2938 $contenu);
2939
2940 // reperer les @import auxquels il faut propager le direction_css
2941 preg_match_all(",\@import\s*url\s*\(\s*['\"]?([^'\"/][^:]*)['\"]?\s*\),Uims", $contenu, $regs);
2942 $src = array();
2943 $src_direction_css = array();
2944 $src_faux_abs = array();
2945 $d = dirname($css);
2946 foreach ($regs[1] as $k => $import_css) {
2947 $css_direction = direction_css("$d/$import_css", $voulue);
2948 // si la css_direction est dans le meme path que la css d'origine, on tronque le path, elle sera passee en absolue
2949 if (substr($css_direction, 0, strlen($d) + 1) == "$d/") {
2950 $css_direction = substr($css_direction, strlen($d) + 1);
2951 } // si la css_direction commence par $dir_var on la fait passer pour une absolue
2952 elseif (substr($css_direction, 0, strlen($dir_var)) == $dir_var) {
2953 $css_direction = substr($css_direction, strlen($dir_var));
2954 $src_faux_abs["/@@@@@@/" . $css_direction] = $css_direction;
2955 $css_direction = "/@@@@@@/" . $css_direction;
2956 }
2957 $src[] = $regs[0][$k];
2958 $src_direction_css[] = str_replace($import_css, $css_direction, $regs[0][$k]);
2959 }
2960 $contenu = str_replace($src, $src_direction_css, $contenu);
2961
2962 $contenu = urls_absolues_css($contenu, $css);
2963
2964 // virer les fausses url absolues que l'on a mis dans les import
2965 if (count($src_faux_abs)) {
2966 $contenu = str_replace(array_keys($src_faux_abs), $src_faux_abs, $contenu);
2967 }
2968
2969 if (!ecrire_fichier($f, $contenu)) {
2970 return $css;
2971 }
2972
2973 return $f;
2974 }
2975
2976
2977 /**
2978 * Transforme les urls relatives d'un fichier CSS en absolues
2979 *
2980 * Récupère le chemin d'une css existante et crée (ou recrée) dans `_DIR_VAR/cache_css/`
2981 * une css dont les url relatives sont passées en url absolues
2982 *
2983 * Le calcul n'est pas refait si le fichier cache existe déjà et que
2984 * la source n'a pas été modifiée depuis.
2985 *
2986 * @uses recuperer_page() si l'URL source n'est pas sur le même site
2987 * @uses urls_absolues_css()
2988 *
2989 * @param string $css
2990 * Chemin ou URL du fichier CSS source
2991 * @return string
2992 * - Chemin du fichier CSS transformé (si source lisible et mise en cache réussie)
2993 * - Chemin ou URL du fichier CSS source sinon.
2994 **/
2995 function url_absolue_css($css) {
2996 if (!preg_match(',\.css$,i', $css, $r)) {
2997 return $css;
2998 }
2999
3000 $url_absolue_css = url_absolue($css);
3001
3002 $f = basename($css, '.css');
3003 $f = sous_repertoire(_DIR_VAR, 'cache-css')
3004 . preg_replace(",(.*?)(_rtl|_ltr)?$,", "\\1-urlabs-" . substr(md5("$css-urlabs"), 0, 4) . "\\2", $f)
3005 . '.css';
3006
3007 if ((@filemtime($f) > @filemtime($css)) and (_VAR_MODE != 'recalcul')) {
3008 return $f;
3009 }
3010
3011 if ($url_absolue_css == $css) {
3012 if (strncmp($GLOBALS['meta']['adresse_site'], $css, $l = strlen($GLOBALS['meta']['adresse_site'])) != 0
3013 or !lire_fichier(_DIR_RACINE . substr($css, $l), $contenu)
3014 ) {
3015 include_spip('inc/distant');
3016 if (!$contenu = recuperer_page($css)) {
3017 return $css;
3018 }
3019 }
3020 } elseif (!lire_fichier($css, $contenu)) {
3021 return $css;
3022 }
3023
3024 // passer les url relatives a la css d'origine en url absolues
3025 $contenu = urls_absolues_css($contenu, $css);
3026
3027 // ecrire la css
3028 if (!ecrire_fichier($f, $contenu)) {
3029 return $css;
3030 }
3031
3032 return $f;
3033 }
3034
3035
3036 /**
3037 * Récupère la valeur d'une clé donnée
3038 * dans un tableau (ou un objet).
3039 *
3040 * @filtre
3041 * @link http://www.spip.net/4572
3042 * @example
3043 * ```
3044 * [(#VALEUR|table_valeur{cle/sous/element})]
3045 * ```
3046 *
3047 * @param mixed $table
3048 * Tableau ou objet PHP
3049 * (ou chaîne serialisée de tableau, ce qui permet d'enchaîner le filtre)
3050 * @param string $cle
3051 * Clé du tableau (ou paramètre public de l'objet)
3052 * Cette clé peut contenir des caractères / pour sélectionner
3053 * des sous éléments dans le tableau, tel que `sous/element/ici`
3054 * pour obtenir la valeur de `$tableau['sous']['element']['ici']`
3055 * @param mixed $defaut
3056 * Valeur par defaut retournée si la clé demandée n'existe pas
3057 * @param bool $conserver_null
3058 * Permet de forcer la fonction à renvoyer la valeur null d'un index
3059 * et non pas $defaut comme cela est fait naturellement par la fonction
3060 * isset. On utilise alors array_key_exists() à la place de isset().
3061 *
3062 * @return mixed
3063 * Valeur trouvée ou valeur par défaut.
3064 **/
3065 function table_valeur($table, $cle, $defaut = '', $conserver_null = false) {
3066 foreach (explode('/', $cle) as $k) {
3067
3068 $table = is_string($table) ? @unserialize($table) : $table;
3069
3070 if (is_object($table)) {
3071 $table = (($k !== "") and isset($table->$k)) ? $table->$k : $defaut;
3072 } elseif (is_array($table)) {
3073 if ($conserver_null) {
3074 $table = array_key_exists($k, $table) ? $table[$k] : $defaut;
3075 } else {
3076 $table = isset($table[$k]) ? $table[$k] : $defaut;
3077 }
3078 } else {
3079 $table = $defaut;
3080 }
3081 }
3082
3083 return $table;
3084 }
3085
3086 /**
3087 * Retrouve un motif dans un texte à partir d'une expression régulière
3088 *
3089 * S'appuie sur la fonction `preg_match()` en PHP
3090 *
3091 * @example
3092 * - `[(#TITRE|match{toto})]`
3093 * - `[(#TEXTE|match{^ceci$,Uims})]`
3094 * - `[(#TEXTE|match{truc(...)$, UimsS, 1})]` Capture de la parenthèse indiquée
3095 * - `[(#TEXTE|match{truc(...)$, 1})]` Équivalent, sans indiquer les modificateurs
3096 *
3097 * @filtre
3098 * @link http://www.spip.net/4299
3099 * @link http://php.net/manual/fr/function.preg-match.php Pour des infos sur `preg_match()`
3100 *
3101 * @param string $texte
3102 * Texte dans lequel chercher
3103 * @param string|int $expression
3104 * Expression régulière de recherche, sans le délimiteur
3105 * @param string $modif
3106 * - string : Modificateurs de l'expression régulière
3107 * - int : Numéro de parenthèse capturante
3108 * @param int $capte
3109 * Numéro de parenthèse capturante
3110 * @return bool|string
3111 * - false : l'expression n'a pas été trouvée
3112 * - true : expression trouvée, mais pas la parenthèse capturante
3113 * - string : expression trouvée.
3114 **/
3115 function match($texte, $expression, $modif = "UimsS", $capte = 0) {
3116 if (intval($modif) and $capte == 0) {
3117 $capte = $modif;
3118 $modif = "UimsS";
3119 }
3120 $expression = str_replace("\/", "/", $expression);
3121 $expression = str_replace("/", "\/", $expression);
3122
3123 if (preg_match('/' . $expression . '/' . $modif, $texte, $r)) {
3124 if (isset($r[$capte])) {
3125 return $r[$capte];
3126 } else {
3127 return true;
3128 }
3129 }
3130
3131 return false;
3132 }
3133
3134
3135 /**
3136 * Remplacement de texte à base d'expression régulière
3137 *
3138 * @filtre
3139 * @link http://www.spip.net/4309
3140 * @see match()
3141 * @example
3142 * ```
3143 * [(#TEXTE|replace{^ceci$,cela,UimsS})]
3144 * ```
3145 *
3146 * @param string $texte
3147 * Texte
3148 * @param string $expression
3149 * Expression régulière
3150 * @param string $replace
3151 * Texte de substitution des éléments trouvés
3152 * @param string $modif
3153 * Modificateurs pour l'expression régulière.
3154 * @return string
3155 * Texte
3156 **/
3157 function replace($texte, $expression, $replace = '', $modif = "UimsS") {
3158 $expression = str_replace("\/", "/", $expression);
3159 $expression = str_replace("/", "\/", $expression);
3160
3161 return preg_replace('/' . $expression . '/' . $modif, $replace, $texte);
3162 }
3163
3164
3165 /**
3166 * Cherche les documents numerotés dans un texte traite par `propre()`
3167 *
3168 * Affecte la liste des doublons['documents']
3169 *
3170 * @param array $doublons
3171 * Liste des doublons
3172 * @param string $letexte
3173 * Le texte
3174 * @return string
3175 * Le texte
3176 **/
3177 function traiter_doublons_documents(&$doublons, $letexte) {
3178
3179 // Verifier dans le texte & les notes (pas beau, helas)
3180 $t = $letexte . $GLOBALS['les_notes'];
3181
3182 if (strstr($t, 'spip_document_') // evite le preg_match_all si inutile
3183 and preg_match_all(
3184 ',<[^>]+\sclass=["\']spip_document_([0-9]+)[\s"\'],imsS',
3185 $t, $matches, PREG_PATTERN_ORDER)
3186 ) {
3187 if (!isset($doublons['documents'])) {
3188 $doublons['documents'] = "";
3189 }
3190 $doublons['documents'] .= "," . join(',', $matches[1]);
3191 }
3192
3193 return $letexte;
3194 }
3195
3196 /**
3197 * Filtre vide qui ne renvoie rien
3198 *
3199 * @example
3200 * `[(#CALCUL|vide)]` n'affichera pas le résultat du calcul
3201 * @filtre
3202 *
3203 * @param mixed $texte
3204 * @return string Chaîne vide
3205 **/
3206 function vide($texte) {
3207 return "";
3208 }
3209
3210 //
3211 // Filtres pour le modele/emb (embed document)
3212 //
3213
3214 /**
3215 * Écrit des balises HTML `<param...>` à partir d'un tableau de données tel que `#ENV`
3216 *
3217 * Permet d'écrire les balises `<param>` à indiquer dans un `<object>`
3218 * en prenant toutes les valeurs du tableau transmis.
3219 *
3220 * Certaines clés spécifiques à SPIP et aux modèles embed sont omises :
3221 * id, lang, id_document, date, date_redac, align, fond, recurs, emb, dir_racine
3222 *
3223 * @example `[(#ENV*|env_to_params)]`
3224 *
3225 * @filtre
3226 * @link http://www.spip.net/4005
3227 *
3228 * @param array|string $env
3229 * Tableau cle => valeur des paramètres à écrire, ou chaine sérialisée de ce tableau
3230 * @param array $ignore_params
3231 * Permet de compléter les clés ignorées du tableau.
3232 * @return string
3233 * Code HTML résultant
3234 **/
3235 function env_to_params($env, $ignore_params = array()) {
3236 $ignore_params = array_merge(
3237 array('id', 'lang', 'id_document', 'date', 'date_redac', 'align', 'fond', '', 'recurs', 'emb', 'dir_racine'),
3238 $ignore_params
3239 );
3240 if (!is_array($env)) {
3241 $env = unserialize($env);
3242 }
3243 $texte = "";
3244 if ($env) {
3245 foreach ($env as $i => $j) {
3246 if (is_string($j) and !in_array($i, $ignore_params)) {
3247 $texte .= "<param name='" . $i . "'\n\tvalue='" . $j . "' />";
3248 }
3249 }
3250 }
3251
3252 return $texte;
3253 }
3254
3255 /**
3256 * Écrit des attributs HTML à partir d'un tableau de données tel que `#ENV`
3257 *
3258 * Permet d'écrire des attributs d'une balise HTML en utilisant les données du tableau transmis.
3259 * Chaque clé deviendra le nom de l'attribut (et la valeur, sa valeur)
3260 *
3261 * Certaines clés spécifiques à SPIP et aux modèles embed sont omises :
3262 * id, lang, id_document, date, date_redac, align, fond, recurs, emb, dir_racine
3263 *
3264 * @example `<embed src='#URL_DOCUMENT' [(#ENV*|env_to_attributs)] width='#GET{largeur}' height='#GET{hauteur}'></embed>`
3265 * @filtre
3266 *
3267 * @param array|string $env
3268 * Tableau cle => valeur des attributs à écrire, ou chaine sérialisée de ce tableau
3269 * @param array $ignore_params
3270 * Permet de compléter les clés ignorées du tableau.
3271 * @return string
3272 * Code HTML résultant
3273 **/
3274 function env_to_attributs($env, $ignore_params = array()) {
3275 $ignore_params = array_merge(
3276 array('id', 'lang', 'id_document', 'date', 'date_redac', 'align', 'fond', '', 'recurs', 'emb', 'dir_racine'),
3277 $ignore_params
3278 );
3279 if (!is_array($env)) {
3280 $env = unserialize($env);
3281 }
3282 $texte = "";
3283 if ($env) {
3284 foreach ($env as $i => $j) {
3285 if (is_string($j) and !in_array($i, $ignore_params)) {
3286 $texte .= $i . "='" . $j . "' ";
3287 }
3288 }
3289 }
3290
3291 return $texte;
3292 }
3293
3294
3295 /**
3296 * Concatène des chaînes
3297 *
3298 * @filtre
3299 * @link http://www.spip.net/4150
3300 * @example
3301 * ```
3302 * #TEXTE|concat{texte1,texte2,...}
3303 * ```
3304 *
3305 * @return string Chaînes concaténés
3306 **/
3307 function concat() {
3308 $args = func_get_args();
3309
3310 return join('', $args);
3311 }
3312
3313
3314 /**
3315 * Retourne le contenu d'un ou plusieurs fichiers
3316 *
3317 * Les chemins sont cherchés dans le path de SPIP
3318 *
3319 * @see balise_INCLURE_dist() La balise `#INCLURE` peut appeler cette fonction
3320 *
3321 * @param array|string $files
3322 * - array : Liste de fichiers
3323 * - string : fichier ou fichiers séparés par `|`
3324 * @param bool $script
3325 * - si true, considère que c'est un fichier js à chercher `javascript/`
3326 * @return string
3327 * Contenu du ou des fichiers, concaténé
3328 **/
3329 function charge_scripts($files, $script = true) {
3330 $flux = "";
3331 foreach (is_array($files) ? $files : explode("|", $files) as $file) {
3332 if (!is_string($file)) {
3333 continue;
3334 }
3335 if ($script) {
3336 $file = preg_match(",^\w+$,", $file) ? "javascript/$file.js" : '';
3337 }
3338 if ($file) {
3339 $path = find_in_path($file);
3340 if ($path) {
3341 $flux .= spip_file_get_contents($path);
3342 }
3343 }
3344 }
3345
3346 return $flux;
3347 }
3348
3349
3350 /**
3351 * Produit une balise img avec un champ alt d'office si vide
3352 *
3353 * Attention le htmlentities et la traduction doivent être appliqués avant.
3354 *
3355 * @param string $img
3356 * @param string $alt
3357 * @param string $atts
3358 * @param string $title
3359 * @param array $options
3360 * chemin_image : utiliser chemin_image sur $img fourni, ou non (oui par dafaut)
3361 * utiliser_suffixe_size : utiliser ou non le suffixe de taille dans le nom de fichier de l'image
3362 * sous forme -xx.png (pour les icones essentiellement) (oui par defaut)
3363 * @return string
3364 */
3365 function http_img_pack($img, $alt, $atts = '', $title = '', $options = array()) {
3366 if (!isset($options['chemin_image']) or $options['chemin_image'] == true) {
3367 $img = chemin_image($img);
3368 }
3369 if (stripos($atts, 'width') === false && !preg_match(',\.svg$,', $img)) {
3370 // utiliser directement l'info de taille presente dans le nom
3371 if ((!isset($options['utiliser_suffixe_size']) or $options['utiliser_suffixe_size'] == true)
3372 and preg_match(',-([0-9]+)[.](png|gif)$,', $img, $regs)
3373 ) {
3374 $largeur = $hauteur = intval($regs[1]);
3375 } else {
3376 $taille = taille_image($img);
3377 list($hauteur, $largeur) = $taille;
3378 if (!$hauteur or !$largeur) {
3379 return "";
3380 }
3381 }
3382 $atts .= " width='" . $largeur . "' height='" . $hauteur . "'";
3383 }
3384
3385 return "<img src='$img' alt='" . attribut_html($alt ? $alt : $title) . "'"
3386 . ($title ? ' title="' . attribut_html($title) . '"' : '')
3387 . " " . ltrim($atts)
3388 . " />";
3389 }
3390
3391 /**
3392 * Générer une directive `style='background:url()'` à partir d'un fichier image
3393 *
3394 * @param string $img
3395 * @param string $att
3396 * @return string
3397 */
3398 function http_style_background($img, $att = '') {
3399 return " style='background" . ($att ? "" : "-image") . ": url(\"" . chemin_image($img) . "\")" . ($att ? (' ' . $att) : '') . ";'";
3400 }
3401
3402 /**
3403 * Générer une balise HTML `img` à partir d'un nom de fichier
3404 *
3405 * @uses http_img_pack()
3406 *
3407 * @param string $img
3408 * @param string $alt
3409 * @param string $class
3410 * @return string
3411 * Code HTML de la balise IMG
3412 */
3413 function filtre_balise_img_dist($img, $alt = "", $class = "") {
3414 return http_img_pack($img, $alt, $class ? " class='" . attribut_html($class) . "'" : '', '',
3415 array('chemin_image' => false, 'utiliser_suffixe_size' => false));
3416 }
3417
3418
3419 /**
3420 * Inserer un svg inline
3421 * http://www.accede-web.com/notices/html-css-javascript/6-images-icones/6-2-svg-images-vectorielles/
3422 *
3423 * pour l'inserer avec une balise <img>, utiliser le filtre |balise_img
3424 *
3425 * @param string $img
3426 * @param string $alt
3427 * @param string $class
3428 * @return string
3429 */
3430 function filtre_balise_svg_dist($img, $alt = "", $class = "") {
3431 if (!$file = find_in_path($img)
3432 or !$svg = file_get_contents($file)) {
3433 return '';
3434 }
3435
3436 if (!preg_match(",<svg\b[^>]*>,UimsS", $svg, $match)) {
3437 return '';
3438 }
3439 $balise_svg = $match[0];
3440 $balise_svg_source = $balise_svg;
3441 // IE est toujours mon ami
3442 $balise_svg = inserer_attribut($balise_svg, 'focusable', 'false');
3443 if ($class) {
3444 $balise_svg = inserer_attribut($balise_svg, 'class', $class);
3445 }
3446 if ($alt){
3447 $balise_svg = inserer_attribut($balise_svg, 'role', 'img');
3448 $id = "img-svg-title-" . substr(md5("$file:$svg:$alt"),0,4);
3449 $balise_svg = inserer_attribut($balise_svg, 'aria-labelledby', $id);
3450 $title = "<title id=\"$id\">" . entites_html($alt)."</title>\n";
3451 $balise_svg .= $title;
3452 }
3453 else {
3454 $balise_svg = inserer_attribut($balise_svg, 'aria-hidden', 'true');
3455 }
3456 $svg = str_replace($balise_svg_source, $balise_svg, $svg);
3457
3458 return $svg;
3459 }
3460
3461
3462
3463 /**
3464 * Affiche chaque valeur d'un tableau associatif en utilisant un modèle
3465 *
3466 * @example
3467 * - `[(#ENV*|unserialize|foreach)]`
3468 * - `[(#ARRAY{a,un,b,deux}|foreach)]`
3469 *
3470 * @filtre
3471 * @link http://www.spip.net/4248
3472 *
3473 * @param array $tableau
3474 * Tableau de données à afficher
3475 * @param string $modele
3476 * Nom du modèle à utiliser
3477 * @return string
3478 * Code HTML résultant
3479 **/
3480 function filtre_foreach_dist($tableau, $modele = 'foreach') {
3481 $texte = '';
3482 if (is_array($tableau)) {
3483 foreach ($tableau as $k => $v) {
3484 $res = recuperer_fond('modeles/' . $modele,
3485 array_merge(array('cle' => $k), (is_array($v) ? $v : array('valeur' => $v)))
3486 );
3487 $texte .= $res;
3488 }
3489 }
3490
3491 return $texte;
3492 }
3493
3494
3495 /**
3496 * Obtient des informations sur les plugins actifs
3497 *
3498 * @filtre
3499 * @uses liste_plugin_actifs() pour connaître les informations affichables
3500 *
3501 * @param string $plugin
3502 * Préfixe du plugin ou chaîne vide
3503 * @param string $type_info
3504 * Type d'info demandée
3505 * @param bool $reload
3506 * true (à éviter) pour forcer le recalcul du cache des informations des plugins.
3507 * @return array|string|bool
3508 *
3509 * - Liste sérialisée des préfixes de plugins actifs (si $plugin = '')
3510 * - Suivant $type_info, avec $plugin un préfixe
3511 * - est_actif : renvoie true s'il est actif, false sinon
3512 * - x : retourne l'information x du plugin si présente (et plugin actif)
3513 * - tout : retourne toutes les informations du plugin actif
3514 **/
3515 function filtre_info_plugin_dist($plugin, $type_info, $reload = false) {
3516 include_spip('inc/plugin');
3517 $plugin = strtoupper($plugin);
3518 $plugins_actifs = liste_plugin_actifs();
3519
3520 if (!$plugin) {
3521 return serialize(array_keys($plugins_actifs));
3522 } elseif (empty($plugins_actifs[$plugin]) and !$reload) {
3523 return '';
3524 } elseif (($type_info == 'est_actif') and !$reload) {
3525 return $plugins_actifs[$plugin] ? 1 : 0;
3526 } elseif (isset($plugins_actifs[$plugin][$type_info]) and !$reload) {
3527 return $plugins_actifs[$plugin][$type_info];
3528 } else {
3529 $get_infos = charger_fonction('get_infos', 'plugins');
3530 // On prend en compte les extensions
3531 if (!is_dir($plugins_actifs[$plugin]['dir_type'])) {
3532 $dir_plugins = constant($plugins_actifs[$plugin]['dir_type']);
3533 } else {
3534 $dir_plugins = $plugins_actifs[$plugin]['dir_type'];
3535 }
3536 if (!$infos = $get_infos($plugins_actifs[$plugin]['dir'], $reload, $dir_plugins)) {
3537 return '';
3538 }
3539 if ($type_info == 'tout') {
3540 return $infos;
3541 } elseif ($type_info == 'est_actif') {
3542 return $infos ? 1 : 0;
3543 } else {
3544 return strval($infos[$type_info]);
3545 }
3546 }
3547 }
3548
3549
3550 /**
3551 * Affiche la puce statut d'un objet, avec un menu rapide pour changer
3552 * de statut si possibilité de l'avoir
3553 *
3554 * @see inc_puce_statut_dist()
3555 *
3556 * @filtre
3557 *
3558 * @param int $id_objet
3559 * Identifiant de l'objet
3560 * @param string $statut
3561 * Statut actuel de l'objet
3562 * @param int $id_rubrique
3563 * Identifiant du parent
3564 * @param string $type
3565 * Type d'objet
3566 * @param bool $ajax
3567 * Indique s'il ne faut renvoyer que le coeur du menu car on est
3568 * dans une requete ajax suite à un post de changement rapide
3569 * @return string
3570 * Code HTML de l'image de puce de statut à insérer (et du menu de changement si présent)
3571 */
3572 function puce_changement_statut($id_objet, $statut, $id_rubrique, $type, $ajax = false) {
3573 $puce_statut = charger_fonction('puce_statut', 'inc');
3574
3575 return $puce_statut($id_objet, $statut, $id_rubrique, $type, $ajax);
3576 }
3577
3578
3579 /**
3580 * Affiche la puce statut d'un objet, avec un menu rapide pour changer
3581 * de statut si possibilité de l'avoir
3582 *
3583 * Utilisable sur tout objet qui a declaré ses statuts
3584 *
3585 * @example
3586 * [(#STATUT|puce_statut{article})] affiche une puce passive
3587 * [(#STATUT|puce_statut{article,#ID_ARTICLE,#ID_RUBRIQUE})] affiche une puce avec changement rapide
3588 *
3589 * @see inc_puce_statut_dist()
3590 *
3591 * @filtre
3592 *
3593 * @param string $statut
3594 * Statut actuel de l'objet
3595 * @param string $objet
3596 * Type d'objet
3597 * @param int $id_objet
3598 * Identifiant de l'objet
3599 * @param int $id_parent
3600 * Identifiant du parent
3601 * @return string
3602 * Code HTML de l'image de puce de statut à insérer (et du menu de changement si présent)
3603 */
3604 function filtre_puce_statut_dist($statut, $objet, $id_objet = 0, $id_parent = 0) {
3605 static $puce_statut = null;
3606 if (!$puce_statut) {
3607 $puce_statut = charger_fonction('puce_statut', 'inc');
3608 }
3609
3610 return $puce_statut($id_objet, $statut, $id_parent, $objet, false,
3611 objet_info($objet, 'editable') ? _ACTIVER_PUCE_RAPIDE : false);
3612 }
3613
3614
3615 /**
3616 * Encoder un contexte pour l'ajax
3617 *
3618 * Encoder le contexte, le signer avec une clé, le crypter
3619 * avec le secret du site, le gziper si possible.
3620 *
3621 * L'entrée peut-être sérialisée (le `#ENV**` des fonds ajax et ajax_stat)
3622 *
3623 * @see decoder_contexte_ajax()
3624 * @uses calculer_cle_action()
3625 *
3626 * @param string|array $c
3627 * contexte, peut etre un tableau serialize
3628 * @param string $form
3629 * nom du formulaire eventuel
3630 * @param string $emboite
3631 * contenu a emboiter dans le conteneur ajax
3632 * @param string $ajaxid
3633 * ajaxid pour cibler le bloc et forcer sa mise a jour
3634 * @return string
3635 * hash du contexte
3636 */
3637 function encoder_contexte_ajax($c, $form = '', $emboite = null, $ajaxid = '') {
3638 if (is_string($c)
3639 and @unserialize($c) !== false
3640 ) {
3641 $c = unserialize($c);
3642 }
3643
3644 // supprimer les parametres debut_x
3645 // pour que la pagination ajax ne soit pas plantee
3646 // si on charge la page &debut_x=1 : car alors en cliquant sur l'item 0,
3647 // le debut_x=0 n'existe pas, et on resterait sur 1
3648 if (is_array($c)) {
3649 foreach ($c as $k => $v) {
3650 if (strpos($k, 'debut_') === 0) {
3651 unset($c[$k]);
3652 }
3653 }
3654 }
3655
3656 if (!function_exists('calculer_cle_action')) {
3657 include_spip("inc/securiser_action");
3658 }
3659
3660 $c = serialize($c);
3661 $cle = calculer_cle_action($form . $c);
3662 $c = "$cle:$c";
3663
3664 // on ne stocke pas les contextes dans des fichiers caches
3665 // par defaut, sauf si cette configuration a ete forcee
3666 // OU que la longueur de l''argument generee est plus long
3667 // que ce que telere Suhosin.
3668 $cache_contextes_ajax = (defined('_CACHE_CONTEXTES_AJAX') and _CACHE_CONTEXTES_AJAX);
3669 if (!$cache_contextes_ajax) {
3670 $env = $c;
3671 if (function_exists('gzdeflate') && function_exists('gzinflate')) {
3672 $env = gzdeflate($env);
3673 // http://core.spip.net/issues/2667 | https://bugs.php.net/bug.php?id=61287
3674 if ((PHP_VERSION_ID == 50400) and !@gzinflate($env)) {
3675 $cache_contextes_ajax = true;
3676 spip_log("Contextes AJAX forces en fichiers ! Erreur PHP 5.4.0", _LOG_AVERTISSEMENT);
3677 }
3678 }
3679 $env = _xor($env);
3680 $env = base64_encode($env);
3681 // tester Suhosin et la valeur maximale des variables en GET...
3682 if ($max_len = @ini_get('suhosin.get.max_value_length')
3683 and $max_len < ($len = strlen($env))
3684 ) {
3685 $cache_contextes_ajax = true;
3686 spip_log("Contextes AJAX forces en fichiers !"
3687 . " Cela arrive lorsque la valeur du contexte"
3688 . " depasse la longueur maximale autorisee par Suhosin"
3689 . " ($max_len) dans 'suhosin.get.max_value_length'. Ici : $len."
3690 . " Vous devriez modifier les parametres de Suhosin"
3691 . " pour accepter au moins 1024 caracteres.", _LOG_AVERTISSEMENT);
3692 }
3693 }
3694
3695 if ($cache_contextes_ajax) {
3696 $dir = sous_repertoire(_DIR_CACHE, 'contextes');
3697 // stocker les contextes sur disque et ne passer qu'un hash dans l'url
3698 $md5 = md5($c);
3699 ecrire_fichier("$dir/c$md5", $c);
3700 $env = $md5;
3701 }
3702
3703 if ($emboite === null) {
3704 return $env;
3705 }
3706 if (!trim($emboite)) {
3707 return "";
3708 }
3709 // toujours encoder l'url source dans le bloc ajax
3710 $r = self();
3711 $r = ' data-origin="' . $r . '"';
3712 $class = 'ajaxbloc';
3713 if ($ajaxid and is_string($ajaxid)) {
3714 // ajaxid est normalement conforme a un nom de classe css
3715 // on ne verifie pas la conformite, mais on passe entites_html par dessus par precaution
3716 $class .= ' ajax-id-' . entites_html($ajaxid);
3717 }
3718
3719 return "<div class='$class' " . "data-ajax-env='$env'$r>\n$emboite</div><!--ajaxbloc-->\n";
3720 }
3721
3722 /**
3723 * Décoder un hash de contexte pour l'ajax
3724 *
3725 * Précude inverse de `encoder_contexte_ajax()`
3726 *
3727 * @see encoder_contexte_ajax()
3728 * @uses calculer_cle_action()
3729 *
3730 * @param string $c
3731 * hash du contexte
3732 * @param string $form
3733 * nom du formulaire eventuel
3734 * @return array|string|bool
3735 * - array|string : contexte d'environnement, possiblement sérialisé
3736 * - false : erreur de décodage
3737 */
3738 function decoder_contexte_ajax($c, $form = '') {
3739 if (!function_exists('calculer_cle_action')) {
3740 include_spip("inc/securiser_action");
3741 }
3742 if (((defined('_CACHE_CONTEXTES_AJAX') and _CACHE_CONTEXTES_AJAX) or strlen($c) == 32)
3743 and $dir = sous_repertoire(_DIR_CACHE, 'contextes')
3744 and lire_fichier("$dir/c$c", $contexte)
3745 ) {
3746 $c = $contexte;
3747 } else {
3748 $c = @base64_decode($c);
3749 $c = _xor($c);
3750 if (function_exists('gzdeflate') && function_exists('gzinflate')) {
3751 $c = @gzinflate($c);
3752 }
3753 }
3754
3755 // extraire la signature en debut de contexte
3756 // et la verifier avant de deserializer
3757 // format : signature:donneesserializees
3758 if ($p = strpos($c,":")){
3759 $cle = substr($c,0,$p);
3760 $c = substr($c,$p+1);
3761
3762 if ($cle == calculer_cle_action($form . $c)) {
3763 $env = @unserialize($c);
3764 return $env;
3765 }
3766 }
3767
3768 return false;
3769 }
3770
3771
3772 /**
3773 * Encrypte ou décrypte un message
3774 *
3775 * @link http://www.php.net/manual/fr/language.operators.bitwise.php#81358
3776 *
3777 * @param string $message
3778 * Message à encrypter ou décrypter
3779 * @param null|string $key
3780 * Clé de cryptage / décryptage.
3781 * Une clé sera calculée si non transmise
3782 * @return string
3783 * Message décrypté ou encrypté
3784 **/
3785 function _xor($message, $key = null) {
3786 if (is_null($key)) {
3787 if (!function_exists('calculer_cle_action')) {
3788 include_spip("inc/securiser_action");
3789 }
3790 $key = pack("H*", calculer_cle_action('_xor'));
3791 }
3792
3793 $keylen = strlen($key);
3794 $messagelen = strlen($message);
3795 for ($i = 0; $i < $messagelen; $i++) {
3796 $message[$i] = ~($message[$i] ^ $key[$i % $keylen]);
3797 }
3798
3799 return $message;
3800 }
3801
3802 /**
3803 * Retourne une URL de réponse de forum (aucune action ici)
3804 *
3805 * @see filtre_url_reponse_forum() du plugin forum (prioritaire)
3806 * @note
3807 * La vraie fonction est dans le plugin forum,
3808 * mais on évite ici une erreur du compilateur en absence du plugin
3809 * @param string $texte
3810 * @return string
3811 */
3812 function url_reponse_forum($texte) { return $texte; }
3813
3814 /**
3815 * retourne une URL de suivi rss d'un forum (aucune action ici)
3816 *
3817 * @see filtre_url_rss_forum() du plugin forum (prioritaire)
3818 * @note
3819 * La vraie fonction est dans le plugin forum,
3820 * mais on évite ici une erreur du compilateur en absence du plugin
3821 * @param string $texte
3822 * @return string
3823 */
3824 function url_rss_forum($texte) { return $texte; }
3825
3826
3827 /**
3828 * Génère des menus avec liens ou `<strong class='on'>` non clicable lorsque
3829 * l'item est sélectionné
3830 *
3831 * @filtre
3832 * @link http://www.spip.net/4004
3833 * @example
3834 * ```
3835 * [(#URL_RUBRIQUE|lien_ou_expose{#TITRE, #ENV{test}|=={en_cours}})]
3836 * ```
3837 *
3838 * @param string $url
3839 * URL du lien
3840 * @param string $libelle
3841 * Texte du lien
3842 * @param bool $on
3843 * État exposé (génère un strong) ou non (génère un lien)
3844 * @param string $class
3845 * Classes CSS ajoutées au lien
3846 * @param string $title
3847 * Title ajouté au lien
3848 * @param string $rel
3849 * Attribut `rel` ajouté au lien
3850 * @param string $evt
3851 * Complement à la balise `a` pour gérer un événement javascript,
3852 * de la forme ` onclick='...'`
3853 * @return string
3854 * Code HTML
3855 */
3856 function lien_ou_expose($url, $libelle = null, $on = false, $class = "", $title = "", $rel = "", $evt = '') {
3857 if ($on) {
3858 $bal = "strong";
3859 $att = "class='on'";
3860 } else {
3861 $bal = 'a';
3862 $att = "href='$url'"
3863 . ($title ? " title='" . attribut_html($title) . "'" : '')
3864 . ($class ? " class='" . attribut_html($class) . "'" : '')
3865 . ($rel ? " rel='" . attribut_html($rel) . "'" : '')
3866 . $evt;
3867 }
3868 if ($libelle === null) {
3869 $libelle = $url;
3870 }
3871
3872 return "<$bal $att>$libelle</$bal>";
3873 }
3874
3875
3876 /**
3877 * Afficher un message "un truc"/"N trucs"
3878 * Les items sont à indiquer comme pour la fonction _T() sous la forme :
3879 * "module:chaine"
3880 *
3881 * @param int $nb : le nombre
3882 * @param string $chaine_un : l'item de langue si $nb vaut un
3883 * @param string $chaine_plusieurs : l'item de lanque si $nb > 1
3884 * @param string $var : La variable à remplacer par $nb dans l'item de langue (facultatif, défaut "nb")
3885 * @param array $vars : Les autres variables nécessaires aux chaines de langues (facultatif)
3886 * @return string : la chaine de langue finale en utilisant la fonction _T()
3887 */
3888 function singulier_ou_pluriel($nb, $chaine_un, $chaine_plusieurs, $var = 'nb', $vars = array()) {
3889 if (!$nb = intval($nb)) {
3890 return "";
3891 }
3892 if (!is_array($vars)) {
3893 return "";
3894 }
3895 $vars[$var] = $nb;
3896 if ($nb > 1) {
3897 return _T($chaine_plusieurs, $vars);
3898 } else {
3899 return _T($chaine_un, $vars);
3900 }
3901 }
3902
3903
3904 /**
3905 * Fonction de base pour une icone dans un squelette
3906 * structure html : `<span><a><img><b>texte</b></span>`
3907 *
3908 * @param string $type
3909 * 'lien' ou 'bouton'
3910 * @param string $lien
3911 * url
3912 * @param string $texte
3913 * texte du lien / alt de l'image
3914 * @param string $fond
3915 * objet avec ou sans son extension et sa taille (article, article-24, article-24.png)
3916 * @param string $fonction
3917 * new/del/edit
3918 * @param string $class
3919 * classe supplementaire (horizontale, verticale, ajax ...)
3920 * @param string $javascript
3921 * "onclick='...'" par exemple
3922 * @return string
3923 */
3924 function prepare_icone_base($type, $lien, $texte, $fond, $fonction = "", $class = "", $javascript = "") {
3925 if (in_array($fonction, array("del", "supprimer.gif"))) {
3926 $class .= ' danger';
3927 } elseif ($fonction == "rien.gif") {
3928 $fonction = "";
3929 } elseif ($fonction == "delsafe") {
3930 $fonction = "del";
3931 }
3932
3933 // remappage des icone : article-24.png+new => article-new-24.png
3934 if ($icone_renommer = charger_fonction('icone_renommer', 'inc', true)) {
3935 list($fond, $fonction) = $icone_renommer($fond, $fonction);
3936 }
3937
3938 // ajouter le type d'objet dans la class de l'icone
3939 $class .= " " . substr(basename($fond), 0, -4);
3940
3941 $alt = attribut_html($texte);
3942 $title = " title=\"$alt\""; // est-ce pertinent de doubler le alt par un title ?
3943
3944 $ajax = "";
3945 if (strpos($class, "ajax") !== false) {
3946 $ajax = "ajax";
3947 if (strpos($class, "preload") !== false) {
3948 $ajax .= " preload";
3949 }
3950 if (strpos($class, "nocache") !== false) {
3951 $ajax .= " nocache";
3952 }
3953 $ajax = " class='$ajax'";
3954 }
3955
3956 $size = 24;
3957 if (preg_match("/-([0-9]{1,3})[.](gif|png)$/i", $fond, $match)) {
3958 $size = $match[1];
3959 }
3960
3961 if ($fonction) {
3962 // 2 images pour composer l'icone : le fond (article) en background,
3963 // la fonction (new) en image
3964 $icone = http_img_pack($fonction, $alt, "width='$size' height='$size'\n" .
3965 http_style_background($fond));
3966 } else {
3967 $icone = http_img_pack($fond, $alt, "width='$size' height='$size'");
3968 }
3969
3970 if ($type == 'lien') {
3971 return "<span class='icone s$size $class'>"
3972 . "<a href='$lien'$title$ajax$javascript>"
3973 . $icone
3974 . "<b>$texte</b>"
3975 . "</a></span>\n";
3976 } else {
3977 return bouton_action("$icone<b>$texte</b>", $lien, "icone s$size $class", $javascript, $alt);
3978 }
3979 }
3980
3981 /**
3982 * Crée un lien ayant une icone
3983 *
3984 * @uses prepare_icone_base()
3985 *
3986 * @param string $lien
3987 * URL du lien
3988 * @param string $texte
3989 * Texte du lien
3990 * @param string $fond
3991 * Objet avec ou sans son extension et sa taille (article, article-24, article-24.png)
3992 * @param string $fonction
3993 * Fonction du lien (`edit`, `new`, `del`)
3994 * @param string $class
3995 * Classe CSS, tel que `left`, `right` pour définir un alignement
3996 * @param string $javascript
3997 * Javascript ajouté sur le lien
3998 * @return string
3999 * Code HTML du lien
4000 **/
4001 function icone_base($lien, $texte, $fond, $fonction = "", $class = "", $javascript = "") {
4002 return prepare_icone_base('lien', $lien, $texte, $fond, $fonction, $class, $javascript);
4003 }
4004
4005 /**
4006 * Crée un lien précédé d'une icone au dessus du texte
4007 *
4008 * @uses icone_base()
4009 * @see icone_verticale() Pour un usage dans un code PHP.
4010 *
4011 * @filtre
4012 * @example
4013 * ```
4014 * [(#AUTORISER{voir,groupemots,#ID_GROUPE})
4015 * [(#URL_ECRIRE{groupe_mots,id_groupe=#ID_GROUPE}
4016 * |icone_verticale{<:mots:icone_voir_groupe_mots:>,groupe_mots-24.png,'',left})]
4017 * ]
4018 * ```
4019 *
4020 * @param string $lien
4021 * URL du lien
4022 * @param string $texte
4023 * Texte du lien
4024 * @param string $fond
4025 * Objet avec ou sans son extension et sa taille (article, article-24, article-24.png)
4026 * @param string $fonction
4027 * Fonction du lien (`edit`, `new`, `del`)
4028 * @param string $class
4029 * Classe CSS à ajouter, tel que `left`, `right`, `center` pour définir un alignement.
4030 * Il peut y en avoir plusieurs : `left ajax`
4031 * @param string $javascript
4032 * Javascript ajouté sur le lien
4033 * @return string
4034 * Code HTML du lien
4035 **/
4036 function filtre_icone_verticale_dist($lien, $texte, $fond, $fonction = "", $class = "", $javascript = "") {
4037 return icone_base($lien, $texte, $fond, $fonction, "verticale $class", $javascript);
4038 }
4039
4040 /**
4041 * Crée un lien précédé d'une icone horizontale
4042 *
4043 * @uses icone_base()
4044 * @see icone_horizontale() Pour un usage dans un code PHP.
4045 *
4046 * @filtre
4047 * @example
4048 * En tant que filtre dans un squelettes :
4049 * ```
4050 * [(#URL_ECRIRE{sites}|icone_horizontale{<:sites:icone_voir_sites_references:>,site-24.png})]
4051 *
4052 * [(#AUTORISER{supprimer,groupemots,#ID_GROUPE}|oui)
4053 * [(#URL_ACTION_AUTEUR{supprimer_groupe_mots,#ID_GROUPE,#URL_ECRIRE{mots}}
4054 * |icone_horizontale{<:mots:icone_supprimer_groupe_mots:>,groupe_mots,del})]
4055 * ]
4056 * ```
4057 *
4058 * En tant que filtre dans un code php :
4059 * ```
4060 * $icone_horizontale=chercher_filtre('icone_horizontale');
4061 * $icone = $icone_horizontale(generer_url_ecrire("stats_visites","id_article=$id_article"),
4062 * _T('statistiques:icone_evolution_visites', array('visites' => $visites)),
4063 * "statistique-24.png");
4064 * ```
4065 *
4066 * @param string $lien
4067 * URL du lien
4068 * @param string $texte
4069 * Texte du lien
4070 * @param string $fond
4071 * Objet avec ou sans son extension et sa taille (article, article-24, article-24.png)
4072 * @param string $fonction
4073 * Fonction du lien (`edit`, `new`, `del`)
4074 * @param string $class
4075 * Classe CSS à ajouter
4076 * @param string $javascript
4077 * Javascript ajouté sur le lien
4078 * @return string
4079 * Code HTML du lien
4080 **/
4081 function filtre_icone_horizontale_dist($lien, $texte, $fond, $fonction = "", $class = "", $javascript = "") {
4082 return icone_base($lien, $texte, $fond, $fonction, "horizontale $class", $javascript);
4083 }
4084
4085 /**
4086 * Crée un bouton d'action intégrant une icone horizontale
4087 *
4088 * @uses prepare_icone_base()
4089 *
4090 * @filtre
4091 * @example
4092 * ```
4093 * [(#URL_ACTION_AUTEUR{supprimer_mot, #ID_MOT, #URL_ECRIRE{groupe_mots,id_groupe=#ID_GROUPE}}
4094 * |bouton_action_horizontal{<:mots:info_supprimer_mot:>,mot-24.png,del})]
4095 * ```
4096 *
4097 * @param string $lien
4098 * URL de l'action
4099 * @param string $texte
4100 * Texte du bouton
4101 * @param string $fond
4102 * Objet avec ou sans son extension et sa taille (article, article-24, article-24.png)
4103 * @param string $fonction
4104 * Fonction du bouton (`edit`, `new`, `del`)
4105 * @param string $class
4106 * Classe CSS à ajouter
4107 * @param string $confirm
4108 * Message de confirmation à ajouter en javascript sur le bouton
4109 * @return string
4110 * Code HTML du lien
4111 **/
4112 function filtre_bouton_action_horizontal_dist($lien, $texte, $fond, $fonction = "", $class = "", $confirm = "") {
4113 return prepare_icone_base('bouton', $lien, $texte, $fond, $fonction, "horizontale $class", $confirm);
4114 }
4115
4116 /**
4117 * Filtre `icone` pour compatibilité mappé sur `icone_base`
4118 *
4119 * @uses icone_base()
4120 * @see filtre_icone_verticale_dist()
4121 *
4122 * @filtre
4123 * @deprecated Utiliser le filtre `icone_verticale`
4124 *
4125 * @param string $lien
4126 * URL du lien
4127 * @param string $texte
4128 * Texte du lien
4129 * @param string $fond
4130 * Nom de l'image utilisée
4131 * @param string $align
4132 * Classe CSS d'alignement (`left`, `right`, `center`)
4133 * @param string $fonction
4134 * Fonction du lien (`edit`, `new`, `del`)
4135 * @param string $class
4136 * Classe CSS à ajouter
4137 * @param string $javascript
4138 * Javascript ajouté sur le lien
4139 * @return string
4140 * Code HTML du lien
4141 */
4142 function filtre_icone_dist($lien, $texte, $fond, $align = "", $fonction = "", $class = "", $javascript = "") {
4143 return icone_base($lien, $texte, $fond, $fonction, "verticale $align $class", $javascript);
4144 }
4145
4146
4147 /**
4148 * Explose un texte en tableau suivant un séparateur
4149 *
4150 * @note
4151 * Inverse l'écriture de la fonction PHP de même nom
4152 * pour que le filtre soit plus pratique dans les squelettes
4153 *
4154 * @filtre
4155 * @example
4156 * ```
4157 * [(#GET{truc}|explode{-})]
4158 * ```
4159 *
4160 * @param string $a Texte
4161 * @param string $b Séparateur
4162 * @return array Liste des éléments
4163 */
4164 function filtre_explode_dist($a, $b) { return explode($b, $a); }
4165
4166 /**
4167 * Implose un tableau en chaine en liant avec un séparateur
4168 *
4169 * @note
4170 * Inverse l'écriture de la fonction PHP de même nom
4171 * pour que le filtre soit plus pratique dans les squelettes
4172 *
4173 * @filtre
4174 * @example
4175 * ```
4176 * [(#GET{truc}|implode{-})]
4177 * ```
4178 *
4179 * @param array $a Tableau
4180 * @param string $b Séparateur
4181 * @return string Texte
4182 */
4183 function filtre_implode_dist($a, $b) { return is_array($a) ? implode($b, $a) : $a; }
4184
4185 /**
4186 * Produire les styles privés qui associent item de menu avec icone en background
4187 *
4188 * @return string Code CSS
4189 */
4190 function bando_images_background() {
4191 include_spip('inc/bandeau');
4192 // recuperer tous les boutons et leurs images
4193 $boutons = definir_barre_boutons(definir_barre_contexte(), true, false);
4194
4195 $res = "";
4196 foreach ($boutons as $page => $detail) {
4197 if ($detail->icone and strlen(trim($detail->icone))) {
4198 $res .= "\n.navigation_avec_icones #bando1_$page {background-image:url(" . $detail->icone . ");}";
4199 }
4200 $selecteur = (in_array($page, array('outils_rapides', 'outils_collaboratifs')) ? "" : ".navigation_avec_icones ");
4201 if (is_array($detail->sousmenu)) {
4202 foreach ($detail->sousmenu as $souspage => $sousdetail) {
4203 if ($sousdetail->icone and strlen(trim($sousdetail->icone))) {
4204 $res .= "\n$selecteur.bando2_$souspage {background-image:url(" . $sousdetail->icone . ");}";
4205 }
4206 }
4207 }
4208 }
4209
4210 return $res;
4211 }
4212
4213 /**
4214 * Generer un bouton_action
4215 * utilise par #BOUTON_ACTION
4216 *
4217 * @param string $libelle
4218 * @param string $url
4219 * @param string $class
4220 * @param string $confirm
4221 * message de confirmation oui/non avant l'action
4222 * @param string $title
4223 * @param string $callback
4224 * callback js a appeler lors de l'evenement action (apres confirmation eventuelle si $confirm est non vide)
4225 * et avant execution de l'action. Si la callback renvoie false, elle annule le declenchement de l'action
4226 * @return string
4227 */
4228 function bouton_action($libelle, $url, $class = "", $confirm = "", $title = "", $callback = "") {
4229 if ($confirm) {
4230 $confirm = "confirm(\"" . attribut_html($confirm) . "\")";
4231 if ($callback) {
4232 $callback = "$confirm?($callback):false";
4233 } else {
4234 $callback = $confirm;
4235 }
4236 }
4237 $onclick = $callback ? " onclick='return " . addcslashes($callback, "'") . "'" : "";
4238 $title = $title ? " title='$title'" : "";
4239
4240 return "<form class='bouton_action_post $class' method='post' action='$url'><div>" . form_hidden($url)
4241 . "<button type='submit' class='submit'$title$onclick>$libelle</button></div></form>";
4242 }
4243
4244
4245 /**
4246 * Proteger les champs passes dans l'url et utiliser dans {tri ...}
4247 * preserver l'espace pour interpreter ensuite num xxx et multi xxx
4248 *
4249 * @param string $t
4250 * @return string
4251 */
4252 function tri_protege_champ($t) {
4253 return preg_replace(',[^\s\w.+],', '', $t);
4254 }
4255
4256 /**
4257 * Interpreter les multi xxx et num xxx utilise comme tri
4258 * pour la clause order
4259 * 'multi xxx' devient simplement 'multi' qui est calcule dans le select
4260 *
4261 * @param string $t
4262 * @param array $from
4263 * @return string
4264 */
4265 function tri_champ_order($t, $from = null) {
4266 if (strncmp($t, 'multi ', 6) == 0) {
4267 return "multi";
4268 }
4269
4270 $champ = $t;
4271
4272 if (strncmp($t, 'num ', 4) == 0) {
4273 $champ = substr($t, 4);
4274 }
4275 // enlever les autres espaces non evacues par tri_protege_champ
4276 $champ = preg_replace(',\s,', '', $champ);
4277
4278 if (is_array($from)) {
4279 $trouver_table = charger_fonction('trouver_table', 'base');
4280 foreach ($from as $idt => $table_sql) {
4281 if ($desc = $trouver_table($table_sql)
4282 and isset($desc['field'][$champ])
4283 ) {
4284 $champ = "$idt.$champ";
4285 break;
4286 }
4287 }
4288 }
4289 if (strncmp($t, 'num ', 4) == 0) {
4290 return "0+$champ";
4291 } else {
4292 return $champ;
4293 }
4294 }
4295
4296 /**
4297 * Interpreter les multi xxx et num xxx utilise comme tri
4298 * pour la clause select
4299 * 'multi xxx' devient select "...." as multi
4300 * les autres cas ne produisent qu'une chaine vide '' en select
4301 * 'hasard' devient 'rand() AS hasard' dans le select
4302 *
4303 * @param string $t
4304 * @return string
4305 */
4306 function tri_champ_select($t) {
4307 if (strncmp($t, 'multi ', 6) == 0) {
4308 $t = substr($t, 6);
4309 $t = preg_replace(',\s,', '', $t);
4310 $t = sql_multi($t, $GLOBALS['spip_lang']);
4311
4312 return $t;
4313 }
4314 if (trim($t) == 'hasard') {
4315 return 'rand() AS hasard';
4316 }
4317
4318 return "''";
4319 }
4320
4321
4322 /**
4323 * Donner n'importe quelle information sur un objet de maniere generique.
4324 *
4325 * La fonction va gerer en interne deux cas particuliers les plus utilises :
4326 * l'URL et le titre (qui n'est pas forcemment le champ SQL "titre").
4327 *
4328 * On peut ensuite personnaliser les autres infos en creant une fonction
4329 * generer_<nom_info>_entite($id_objet, $type_objet, $ligne).
4330 * $ligne correspond a la ligne SQL de tous les champs de l'objet, les fonctions
4331 * de personnalisation n'ont donc pas a refaire de requete.
4332 *
4333 * @param int $id_objet
4334 * @param string $type_objet
4335 * @param string $info
4336 * @param string $etoile
4337 * @return string
4338 */
4339 function generer_info_entite($id_objet, $type_objet, $info, $etoile = "") {
4340 static $trouver_table = null;
4341 static $objets;
4342
4343 // On verifie qu'on a tout ce qu'il faut
4344 $id_objet = intval($id_objet);
4345 if (!($id_objet and $type_objet and $info)) {
4346 return '';
4347 }
4348
4349 // si on a deja note que l'objet n'existe pas, ne pas aller plus loin
4350 if (isset($objets[$type_objet]) and $objets[$type_objet] === false) {
4351 return '';
4352 }
4353
4354 // Si on demande l'url, on retourne direct la fonction
4355 if ($info == 'url') {
4356 return generer_url_entite($id_objet, $type_objet);
4357 }
4358
4359 // Sinon on va tout chercher dans la table et on garde en memoire
4360 $demande_titre = ($info == 'titre');
4361
4362 // On ne fait la requete que si on a pas deja l'objet ou si on demande le titre mais qu'on ne l'a pas encore
4363 if (!isset($objets[$type_objet][$id_objet])
4364 or
4365 ($demande_titre and !isset($objets[$type_objet][$id_objet]['titre']))
4366 ) {
4367 if (!$trouver_table) {
4368 $trouver_table = charger_fonction('trouver_table', 'base');
4369 }
4370 $desc = $trouver_table(table_objet_sql($type_objet));
4371 if (!$desc) {
4372 return $objets[$type_objet] = false;
4373 }
4374
4375 // Si on demande le titre, on le gere en interne
4376 $champ_titre = "";
4377 if ($demande_titre) {
4378 // si pas de titre declare mais champ titre, il sera peuple par le select *
4379 $champ_titre = (!empty($desc['titre'])) ? ', ' . $desc['titre'] : '';
4380 }
4381 include_spip('base/abstract_sql');
4382 include_spip('base/connect_sql');
4383 $objets[$type_objet][$id_objet] = sql_fetsel(
4384 '*' . $champ_titre,
4385 $desc['table_sql'],
4386 id_table_objet($type_objet) . ' = ' . intval($id_objet)
4387 );
4388 }
4389
4390 // Si la fonction generer_TRUC_TYPE existe, on l'utilise pour formater $info_generee
4391 if ($generer = charger_fonction("generer_${info}_${type_objet}", '', true)) {
4392 $info_generee = $generer($id_objet, $objets[$type_objet][$id_objet]);
4393 } // Si la fonction generer_TRUC_entite existe, on l'utilise pour formater $info_generee
4394 else {
4395 if ($generer = charger_fonction("generer_${info}_entite", '', true)) {
4396 $info_generee = $generer($id_objet, $type_objet, $objets[$type_objet][$id_objet]);
4397 } // Sinon on prend directement le champ SQL tel quel
4398 else {
4399 $info_generee = (isset($objets[$type_objet][$id_objet][$info]) ? $objets[$type_objet][$id_objet][$info] : '');
4400 }
4401 }
4402
4403 // On va ensuite appliquer les traitements automatiques si besoin
4404 if (!$etoile) {
4405 // FIXME: on fournit un ENV minimum avec id et type et connect=''
4406 // mais ce fonctionnement est a ameliorer !
4407 $info_generee = appliquer_traitement_champ($info_generee, $info, table_objet($type_objet),
4408 array('id_objet' => $id_objet, 'objet' => $type_objet, ''));
4409 }
4410
4411 return $info_generee;
4412 }
4413
4414 /**
4415 * Appliquer a un champ SQL le traitement qui est configure pour la balise homonyme dans les squelettes
4416 *
4417 * @param string $texte
4418 * @param string $champ
4419 * @param string $table_objet
4420 * @param array $env
4421 * @param string $connect
4422 * @return string
4423 */
4424 function appliquer_traitement_champ($texte, $champ, $table_objet = '', $env = array(), $connect = '') {
4425 if (!$champ) {
4426 return $texte;
4427 }
4428
4429 // On charge toujours les filtres de texte car la majorité des traitements les utilisent
4430 // et il ne faut pas partir du principe que c'est déjà chargé (form ajax, etc)
4431 include_spip('inc/texte');
4432
4433 $champ = strtoupper($champ);
4434 $traitements = isset($GLOBALS['table_des_traitements'][$champ]) ? $GLOBALS['table_des_traitements'][$champ] : false;
4435 if (!$traitements or !is_array($traitements)) {
4436 return $texte;
4437 }
4438
4439 $traitement = '';
4440 if ($table_objet and (!isset($traitements[0]) or count($traitements) > 1)) {
4441 // necessaire pour prendre en charge les vieux appels avec un table_objet_sql en 3e arg
4442 $table_objet = table_objet($table_objet);
4443 if (isset($traitements[$table_objet])) {
4444 $traitement = $traitements[$table_objet];
4445 }
4446 }
4447 if (!$traitement and isset($traitements[0])) {
4448 $traitement = $traitements[0];
4449 }
4450 // (sinon prendre le premier de la liste par defaut ?)
4451
4452 if (!$traitement) {
4453 return $texte;
4454 }
4455
4456 $traitement = str_replace('%s', "'" . texte_script($texte) . "'", $traitement);
4457
4458 // Fournir $connect et $Pile[0] au traitement si besoin
4459 $Pile = array(0 => $env);
4460 eval("\$texte = $traitement;");
4461
4462 return $texte;
4463 }
4464
4465
4466 /**
4467 * Generer un lien (titre clicable vers url) vers un objet
4468 *
4469 * @param int $id_objet
4470 * @param $objet
4471 * @param int $longueur
4472 * @param null|string $connect
4473 * @return string
4474 */
4475 function generer_lien_entite($id_objet, $objet, $longueur = 80, $connect = null) {
4476 include_spip('inc/liens');
4477 $titre = traiter_raccourci_titre($id_objet, $objet, $connect);
4478 // lorsque l'objet n'est plus declare (plugin desactive par exemple)
4479 // le raccourcis n'est plus valide
4480 $titre = isset($titre['titre']) ? typo($titre['titre']) : '';
4481 // on essaye avec generer_info_entite ?
4482 if (!strlen($titre) and !$connect) {
4483 $titre = generer_info_entite($id_objet, $objet, 'titre');
4484 }
4485 if (!strlen($titre)) {
4486 $titre = _T('info_sans_titre');
4487 }
4488 $url = generer_url_entite($id_objet, $objet, '', '', $connect);
4489
4490 return "<a href='$url' class='$objet'>" . couper($titre, $longueur) . "</a>";
4491 }
4492
4493
4494 /**
4495 * Englobe (Wrap) un texte avec des balises
4496 *
4497 * @example `wrap('mot','<b>')` donne `<b>mot</b>'`
4498 *
4499 * @filtre
4500 * @uses extraire_balises()
4501 *
4502 * @param string $texte
4503 * @param string $wrap
4504 * @return string
4505 */
4506 function wrap($texte, $wrap) {
4507 $balises = extraire_balises($wrap);
4508 if (preg_match_all(",<([a-z]\w*)\b[^>]*>,UimsS", $wrap, $regs, PREG_PATTERN_ORDER)) {
4509 $texte = $wrap . $texte;
4510 $regs = array_reverse($regs[1]);
4511 $wrap = "</" . implode("></", $regs) . ">";
4512 $texte = $texte . $wrap;
4513 }
4514
4515 return $texte;
4516 }
4517
4518
4519 /**
4520 * afficher proprement n'importe quoi
4521 * On affiche in fine un pseudo-yaml qui premet de lire humainement les tableaux et de s'y reperer
4522 *
4523 * Les textes sont retournes avec simplement mise en forme typo
4524 *
4525 * le $join sert a separer les items d'un tableau, c'est en general un \n ou <br /> selon si on fait du html ou du texte
4526 * les tableaux-listes (qui n'ont que des cles numeriques), sont affiches sous forme de liste separee par des virgules :
4527 * c'est VOULU !
4528 *
4529 * @param $u
4530 * @param string $join
4531 * @param int $indent
4532 * @return array|mixed|string
4533 */
4534 function filtre_print_dist($u, $join = "<br />", $indent = 0) {
4535 if (is_string($u)) {
4536 $u = typo($u);
4537
4538 return $u;
4539 }
4540
4541 // caster $u en array si besoin
4542 if (is_object($u)) {
4543 $u = (array)$u;
4544 }
4545
4546 if (is_array($u)) {
4547 $out = "";
4548 // toutes les cles sont numeriques ?
4549 // et aucun enfant n'est un tableau
4550 // liste simple separee par des virgules
4551 $numeric_keys = array_map('is_numeric', array_keys($u));
4552 $array_values = array_map('is_array', $u);
4553 $object_values = array_map('is_object', $u);
4554 if (array_sum($numeric_keys) == count($numeric_keys)
4555 and !array_sum($array_values)
4556 and !array_sum($object_values)
4557 ) {
4558 return join(", ", array_map('filtre_print_dist', $u));
4559 }
4560
4561 // sinon on passe a la ligne et on indente
4562 $i_str = str_pad("", $indent, " ");
4563 foreach ($u as $k => $v) {
4564 $out .= $join . $i_str . "$k: " . filtre_print_dist($v, $join, $indent + 2);
4565 }
4566
4567 return $out;
4568 }
4569
4570 // on sait pas quoi faire...
4571 return $u;
4572 }
4573
4574
4575 /**
4576 * Renvoyer l'info d'un objet
4577 * telles que definies dans declarer_tables_objets_sql
4578 *
4579 * @param string $objet
4580 * @param string $info
4581 * @return string
4582 */
4583 function objet_info($objet, $info) {
4584 $table = table_objet_sql($objet);
4585 $infos = lister_tables_objets_sql($table);
4586
4587 return (isset($infos[$info]) ? $infos[$info] : '');
4588 }
4589
4590 /**
4591 * Filtre pour afficher 'Aucun truc' ou '1 truc' ou 'N trucs'
4592 * avec la bonne chaîne de langue en fonction de l'objet utilisé
4593 *
4594 * @param int $nb
4595 * Nombre d'éléments
4596 * @param string $objet
4597 * Objet
4598 * @return mixed|string
4599 * Texte traduit du comptage, tel que '3 articles'
4600 */
4601 function objet_afficher_nb($nb, $objet) {
4602 if (!$nb) {
4603 return _T(objet_info($objet, 'info_aucun_objet'));
4604 } else {
4605 return _T(objet_info($objet, $nb == 1 ? 'info_1_objet' : 'info_nb_objets'), array('nb' => $nb));
4606 }
4607 }
4608
4609 /**
4610 * Filtre pour afficher l'img icone d'un objet
4611 *
4612 * @param string $objet
4613 * @param int $taille
4614 * @return string
4615 */
4616 function objet_icone($objet, $taille = 24) {
4617 $icone = objet_info($objet, 'icone_objet') . "-" . $taille . ".png";
4618 $icone = chemin_image($icone);
4619 $balise_img = charger_filtre('balise_img');
4620
4621 return $icone ? $balise_img($icone, _T(objet_info($objet, 'texte_objet'))) : '';
4622 }
4623
4624 /**
4625 * Renvoyer une traduction d'une chaine de langue contextuelle à un objet si elle existe,
4626 * la traduction de la chaine generique
4627 *
4628 * Ex : [(#ENV{objet}|objet_label{trad_reference})]
4629 * va chercher si une chaine objet:trad_reference existe et renvoyer sa trad le cas echeant
4630 * sinon renvoie la trad de la chaine trad_reference
4631 * Si la chaine fournie contient un prefixe il est remplacé par celui de l'objet pour chercher la chaine contextuelle
4632 *
4633 * Les arguments $args et $options sont ceux de la fonction _T
4634 *
4635 * @param string $objet
4636 * @param string $chaine
4637 * @param array $args
4638 * @param array $options
4639 * @return string
4640 */
4641 function objet_T($objet, $chaine, $args = array(), $options = array()){
4642 $chaine = explode(':',$chaine);
4643 if ($t = _T($objet . ':' . end($chaine), $args, array_merge($options, array('force'=>false)))) {
4644 return $t;
4645 }
4646 $chaine = implode(':',$chaine);
4647 return _T($chaine, $args, $options);
4648 }
4649
4650 /**
4651 * Fonction de secours pour inserer le head_css de facon conditionnelle
4652 *
4653 * Appelée en filtre sur le squelette qui contient #INSERT_HEAD,
4654 * elle vérifie l'absence éventuelle de #INSERT_HEAD_CSS et y suplée si besoin
4655 * pour assurer la compat avec les squelettes qui n'utilisent pas.
4656 *
4657 * @param string $flux Code HTML
4658 * @return string Code HTML
4659 */
4660 function insert_head_css_conditionnel($flux) {
4661 if (strpos($flux, '<!-- insert_head_css -->') === false
4662 and $p = strpos($flux, '<!-- insert_head -->')
4663 ) {
4664 // plutot avant le premier js externe (jquery) pour etre non bloquant
4665 if ($p1 = stripos($flux, '<script src=') and $p1 < $p) {
4666 $p = $p1;
4667 }
4668 $flux = substr_replace($flux, pipeline('insert_head_css', '<!-- insert_head_css -->'), $p, 0);
4669 }
4670
4671 return $flux;
4672 }
4673
4674 /**
4675 * Produire un fichier statique à partir d'un squelette dynamique
4676 *
4677 * Permet ensuite à Apache de le servir en statique sans repasser
4678 * par spip.php à chaque hit sur le fichier.
4679 *
4680 * Si le format (css ou js) est passe dans `contexte['format']`, on l'utilise
4681 * sinon on regarde si le fond finit par .css ou .js, sinon on utilie "html"
4682 *
4683 * @uses urls_absolues_css()
4684 *
4685 * @param string $fond
4686 * @param array $contexte
4687 * @param array $options
4688 * @param string $connect
4689 * @return string
4690 */
4691 function produire_fond_statique($fond, $contexte = array(), $options = array(), $connect = '') {
4692 if (isset($contexte['format'])) {
4693 $extension = $contexte['format'];
4694 unset($contexte['format']);
4695 } else {
4696 $extension = "html";
4697 if (preg_match(',[.](css|js|json)$,', $fond, $m)) {
4698 $extension = $m[1];
4699 }
4700 }
4701 // recuperer le contenu produit par le squelette
4702 $options['raw'] = true;
4703 $cache = recuperer_fond($fond, $contexte, $options, $connect);
4704
4705 // calculer le nom de la css
4706 $dir_var = sous_repertoire(_DIR_VAR, 'cache-' . $extension);
4707 $nom_safe = preg_replace(",\W,", '_', str_replace('.', '_', $fond));
4708 $contexte_implicite = calculer_contexte_implicite();
4709 $filename = $dir_var . $extension . "dyn-$nom_safe-"
4710 . substr(md5($fond . serialize($contexte_implicite) . serialize($contexte) . $connect), 0, 8)
4711 . ".$extension";
4712
4713 // mettre a jour le fichier si il n'existe pas
4714 // ou trop ancien
4715 // le dernier fichier produit est toujours suffixe par .last
4716 // et recopie sur le fichier cible uniquement si il change
4717 if (!file_exists($filename)
4718 or !file_exists($filename . ".last")
4719 or (isset($cache['lastmodified']) and $cache['lastmodified'] and filemtime($filename . ".last") < $cache['lastmodified'])
4720 or (defined('_VAR_MODE') and _VAR_MODE == 'recalcul')
4721 ) {
4722 $contenu = $cache['texte'];
4723 // passer les urls en absolu si c'est une css
4724 if ($extension == "css") {
4725 $contenu = urls_absolues_css($contenu,
4726 test_espace_prive() ? generer_url_ecrire('accueil') : generer_url_public($fond));
4727 }
4728
4729 $comment = '';
4730 // ne pas insérer de commentaire si c'est du json
4731 if ($extension != "json") {
4732 $comment = "/* #PRODUIRE{fond=$fond";
4733 foreach ($contexte as $k => $v) {
4734 $comment .= ",$k=$v";
4735 }
4736 // pas de date dans le commentaire car sinon ca invalide le md5 et force la maj
4737 // mais on peut mettre un md5 du contenu, ce qui donne un aperu rapide si la feuille a change ou non
4738 $comment .= "}\n md5:" . md5($contenu) . " */\n";
4739 }
4740 // et ecrire le fichier
4741 ecrire_fichier($filename . ".last", $comment . $contenu);
4742 // regarder si on recopie
4743 if (!file_exists($filename)
4744 or md5_file($filename) !== md5_file($filename . ".last")
4745 ) {
4746 @copy($filename . ".last", $filename);
4747 clearstatcache(true, $filename); // eviter que PHP ne reserve le vieux timestamp
4748 }
4749 }
4750
4751 return timestamp($filename);
4752 }
4753
4754 /**
4755 * Ajouter un timestamp a une url de fichier
4756 * [(#CHEMIN{monfichier}|timestamp)]
4757 *
4758 * @param string $fichier
4759 * Le chemin du fichier sur lequel on souhaite ajouter le timestamp
4760 * @return string
4761 * $fichier auquel on a ajouté le timestamp
4762 */
4763 function timestamp($fichier) {
4764 if (!$fichier
4765 or !file_exists($fichier)
4766 or !$m = filemtime($fichier)
4767 ) {
4768 return $fichier;
4769 }
4770
4771 return "$fichier?$m";
4772 }
4773
4774 /**
4775 * Supprimer le timestamp d'une url
4776 *
4777 * @param string $url
4778 * @return string
4779 */
4780 function supprimer_timestamp($url) {
4781 if (strpos($url, "?") === false) {
4782 return $url;
4783 }
4784
4785 return preg_replace(",\?[[:digit:]]+$,", "", $url);
4786 }
4787
4788 /**
4789 * Nettoyer le titre d'un email
4790 *
4791 * Éviter une erreur lorsqu'on utilise `|nettoyer_titre_email` dans un squelette de mail
4792 *
4793 * @filtre
4794 * @uses nettoyer_titre_email()
4795 *
4796 * @param string $titre
4797 * @return string
4798 */
4799 function filtre_nettoyer_titre_email_dist($titre) {
4800 include_spip('inc/envoyer_mail');
4801
4802 return nettoyer_titre_email($titre);
4803 }
4804
4805 /**
4806 * Afficher le sélecteur de rubrique
4807 *
4808 * Il permet de placer un objet dans la hiérarchie des rubriques de SPIP
4809 *
4810 * @uses chercher_rubrique()
4811 *
4812 * @param string $titre
4813 * @param int $id_objet
4814 * @param int $id_parent
4815 * @param string $objet
4816 * @param int $id_secteur
4817 * @param bool $restreint
4818 * @param bool $actionable
4819 * true : fournit le selecteur dans un form directement postable
4820 * @param bool $retour_sans_cadre
4821 * @return string
4822 */
4823 function filtre_chercher_rubrique_dist(
4824 $titre,
4825 $id_objet,
4826 $id_parent,
4827 $objet,
4828 $id_secteur,
4829 $restreint,
4830 $actionable = false,
4831 $retour_sans_cadre = false
4832 ) {
4833 include_spip('inc/filtres_ecrire');
4834
4835 return chercher_rubrique($titre, $id_objet, $id_parent, $objet, $id_secteur, $restreint, $actionable,
4836 $retour_sans_cadre);
4837 }
4838
4839 /**
4840 * Rediriger une page suivant une autorisation,
4841 * et ce, n'importe où dans un squelette, même dans les inclusions.
4842 *
4843 * En l'absence de redirection indiquée, la fonction redirige par défaut
4844 * sur une 403 dans l'espace privé et 404 dans l'espace public.
4845 *
4846 * @example
4847 * ```
4848 * [(#AUTORISER{non}|sinon_interdire_acces)]
4849 * [(#AUTORISER{non}|sinon_interdire_acces{#URL_PAGE{login}, 401})]
4850 * ```
4851 *
4852 * @filtre
4853 * @param bool $ok
4854 * Indique si l'on doit rediriger ou pas
4855 * @param string $url
4856 * Adresse eventuelle vers laquelle rediriger
4857 * @param int $statut
4858 * Statut HTML avec lequel on redirigera
4859 * @param string $message
4860 * message d'erreur
4861 * @return string|void
4862 * Chaîne vide si l'accès est autorisé
4863 */
4864 function sinon_interdire_acces($ok = false, $url = '', $statut = 0, $message = null) {
4865 if ($ok) {
4866 return '';
4867 }
4868
4869 // Vider tous les tampons
4870 $level = @ob_get_level();
4871 while ($level--) {
4872 @ob_end_clean();
4873 }
4874
4875 include_spip('inc/headers');
4876
4877 // S'il y a une URL, on redirige (si pas de statut, la fonction mettra 302 par défaut)
4878 if ($url) {
4879 redirige_par_entete($url, '', $statut);
4880 }
4881
4882 // ecriture simplifiee avec message en 3eme argument (= statut 403)
4883 if (!is_numeric($statut) and is_null($message)) {
4884 $message = $statut;
4885 $statut = 0;
4886 }
4887 if (!$message) {
4888 $message = '';
4889 }
4890 $statut = intval($statut);
4891
4892 // Si on est dans l'espace privé, on génère du 403 Forbidden par defaut ou du 404
4893 if (test_espace_prive()) {
4894 if (!$statut or !in_array($statut, array(404, 403))) {
4895 $statut = 403;
4896 }
4897 http_status(403);
4898 $echec = charger_fonction('403', 'exec');
4899 $echec($message);
4900 } else {
4901 // Sinon dans l'espace public on redirige vers une 404 par défaut, car elle toujours présente normalement
4902 if (!$statut) {
4903 $statut = 404;
4904 }
4905 // Dans tous les cas on modifie l'entité avec ce qui est demandé
4906 http_status($statut);
4907 // Si le statut est une erreur et qu'il n'y a pas de redirection on va chercher le squelette du même nom
4908 if ($statut >= 400) {
4909 echo recuperer_fond("$statut", array('erreur' => $message));
4910 }
4911 }
4912
4913
4914 exit;
4915 }
4916
4917 /**
4918 * Assurer le fonctionnement de |compacte meme sans l'extension compresseur
4919 *
4920 * @param string $source
4921 * @param null|string $format
4922 * @return string
4923 */
4924 function filtre_compacte_dist($source, $format = null) {
4925 if (function_exists('compacte')) {
4926 return compacte($source, $format);
4927 }
4928
4929 return $source;
4930 }