source: spip-zone/_plugins_/couteau_suisse/outils/glossaire_fonctions.php @ 60201

Last change on this file since 60201 was 60201, checked in by patfr@…, 8 years ago

Glossaire interne : possibilité d'ignorer ou non les balises <abbr> et <acronym>
+ Meilleure compatibilité avec le plugin "Acronymes"
+ Meilleure accessibilité

File size: 14.7 KB
Line 
1<?php
2
3// Outils GLOSSAIRE - 26 mai 2007
4// Serieuse refonte et integration au Couteau Suisse : Patrice Vanneufville
5// Doc : http://www.spip-contrib.net/?article2206
6
7include_spip('inc/charsets');
8
9// liste des accents (sans casse)
10define('_GLOSSAIRE_ACCENTS', '#(19[2-9]|2[023][0-9]|21[0-46-9]|24[0-689]|25[0-4]|33[89]|35[23]|376)|a(?:acute|circ|elig|grave|ring|tilde|uml)|ccedil|e(?:acute|circ|grave|th|uml)|i(?:acute|circ|grave|uml)|ntilde|o(?:acute|circ|elig|grave|slash|tilde|uml)|s(?:caron|zlig)|thorn|u(?:acute|circ|grave|uml)|y(?:acute|uml)');
11
12// on calcule ici la constante _GLOSSAIRE_QUERY, surchargeable dans config/mes_options.php
13function glossaire_groupes() {
14        $groupes = trim($GLOBALS['glossaire_groupes']);
15        if(!strlen($groupes)) return _q('Glossaire');
16                else {
17                        $groupes = explode(':', $groupes);
18                        foreach($groupes as $i=>$g) $groupes[$i] = _q(trim($g));
19                        return join(" OR type=", $groupes);
20                }
21}
22
23// Separateur des titres de mots stockes en base
24if(!defined('_GLOSSAIRE_TITRE_BASE_SEP')) define('_GLOSSAIRE_TITRE_BASE_SEP', '/');
25// Separateur utilise pour fabriquer le titre de la fenetre de glossaire (fichiers fonds/glossaire_xx.html).
26if(!defined('_GLOSSAIRE_TITRE_SEP')) define('_GLOSSAIRE_TITRE_SEP', '<br />');
27// Balises a echapper avant le traitement du glossaire
28if(!defined('_GLOSSAIRE_ECHAPPER')) define('_GLOSSAIRE_ECHAPPER', 'html|code|cadre|frame|script|cite|acronym|abbr|a');
29// chaine pour interroger la base (SPIP <= 1.92)
30if(!defined('_SPIP19300'))
31        @define('_GLOSSAIRE_QUERY', 'SELECT id_mot, titre, texte, descriptif FROM spip_mots WHERE type=' . glossaire_groupes() . ' ORDER BY id_mot ASC');
32               
33// surcharge possible de cette fonction glossaire_generer_url_dist par : glossaire_generer_url($id_mot, $titre_mot)
34// si elle existe, elle sera utilisee pour generer l'url cliquable des mots trouves
35//   exemple pour annuler le clic : function glossaire_generer_url($id_mot, $titre_mot) { return 'javascript:;'; }
36function glossaire_generer_url_dist($id_mot, $titre_mot) {
37        if(defined('_SPIP19300')) 
38                return generer_url_entite($id_mot, 'mot'); // depuis SPIP 2.0
39                else { charger_generer_url(); return generer_url_mot($id_mot); } // avant SPIP 2.0
40}
41
42// surcharge possible de cette fonction glossaire_generer_mot_dist par : glossaire_generer_mot($id_mot, $mot)
43// si elle existe, elle sera utilisee pour remplacer le mot detecte dans la phrase
44/* exemple pour utiliser un fond personnalise, mettre une couleur de groupe ou inserer un logo par exemple :
45        function glossaire_generer_mot($id_mot, $mot) {
46                return recuperer_fond('/fonds/mon_glossaire', array('id_mot'=>$id_mot, 'mot'=>$mot));
47        }*/
48function glossaire_generer_mot_dist($id_mot, $mot) {
49        return $mot;
50}
51
52/* surcharge possible de cette fonction glossaire_attributs_lien_dist par : glossaire_attributs_lien($lien, $titre, $gloss_id)
53 si elle existe, elle sera utilisee pour les attributs (sauf class et name) du <a> place autour du mot detecte.
54 $lien : lien du mot - $titre : titre brut du mot - $les_titres : array() des differents titres possibles du mot
55 Exemple :
56        function glossaire_attributs_lien($id_mot, $lien, $titre, $les_titres) {
57                return "href='$lien' title=\"" . attribut_html($les_titres[0]). '"';
58        } */
59function glossaire_attributs_lien_dist($id_mot, $lien, $titre, $les_titres) {
60        return "href='$lien'";
61}
62
63
64// traitement pour #TITRE/mots : retrait des expressions regulieres
65function cs_glossaire_titres($titre) {
66        if(strpos($titre, ',')===false) return $titre;
67        list(,,$mots) = glossaire_parse($titre);
68        return $mots;
69}
70
71// Cette fonction retire du texte les boites de definition et les liens du glossaire
72function cs_retire_glossaire($texte) {
73        $texte = preg_replace(',<span class="gl_(jst?|d[td])".*?</span>,s', '', $texte);
74        if(!defined('_GLOSSAIRE_JS')) $texte = preg_replace(',<span class="gl_dl">.*?</span>,s', '', $texte);
75        return preg_replace(',<a [^>]+class=\'cs_glossaire\'><span class=\'gl_mot\'>(.*?)</span></a>,s', '$1', $texte);
76}
77$GLOBALS['cs_introduire'][] = 'cs_retire_glossaire';
78
79// remplace les accents unicode par l'equivalent charset/unicode/html
80function glossaire_accents($regexpr) {
81        if (strpos($regexpr, '&')===false) return $regexpr;
82        return preg_replace_callback(",&#([0-9]+);,", 'glossaire_accents_callback', str_replace('& ','&amp; ',$regexpr));
83}
84
85// $matches est un caractere unicode sous forme &#XXX;
86// ici on cherche toutes les formes de ce caractere, minuscule ou majuscule : unicode, charset et html
87function glossaire_accents_callback($matches) {
88        $u = unicode2charset($matches[0]);      // charset
89        $u2 = init_mb_string()?mb_strtoupper($u):strtoupper($u);        // charset majuscule
90        $u3 = htmlentities($u2, ENT_QUOTES, $GLOBALS['meta']['charset']);       // html majuscule
91        $u4 = html2unicode($u3); // unicode majuscule
92        $a = array_unique(array($u, $u2, htmlentities($u, ENT_QUOTES, $GLOBALS['meta']['charset']), $u3, $matches[0], $u4));
93//      $a = array_unique(array($u, htmlentities($u, ENT_QUOTES, $GLOBALS['meta']['charset']), $matches[0]));
94        return '(?:'.join('|', $a).')';
95}
96function glossaire_echappe_balises_callback($matches) {
97 global $gloss_ech, $gloss_ech_id;
98 $gloss_ech[] = $matches[0];
99 return '@@E'.$gloss_ech_id++.'@@';
100}
101function glossaire_echappe_mot_callback($matches) {
102 global $gloss_mots, $gloss_mots_id, $gloss_id;
103 $gloss_mots[] = $matches[0];
104 return '@@M'.$gloss_mots_id++.'#'.$gloss_id.'@@';
105}
106
107function glossaire_safe($texte) {
108        // on retire les notes avant propre()
109        return safehtml(cs_propre(preg_replace(', *\[\[(.*?)\]\],msS', '', nl2br(trim($texte)))));
110}
111
112// renvoie le tableau des mots du glossaire
113function glossaire_query_tab() {
114        // interrogation personnalisee de la base
115        if(defined('_GLOSSAIRE_QUERY')) {
116                $res = array();
117                $fetch = function_exists('sql_fetch')?'sql_fetch':'spip_fetch_array';
118                $query = spip_query(_GLOSSAIRE_QUERY);
119                while($r = $fetch($query)) $res[] = $r;
120                return $res;
121        }
122        return sql_allfetsel('id_mot,titre,texte,descriptif', 'spip_mots', 'type='.glossaire_groupes(), '', 'id_mot ASC');
123}
124
125// parse toutes les formes du titre d'un mot-cle du glossaire
126// prendre en compte les formes du mot : architrave/architraves
127function glossaire_parse($titre) {
128        $mots = $regs = $titres = array();
129        foreach(explode(_GLOSSAIRE_TITRE_BASE_SEP, str_replace('</','@@tag@@',$titre)) as $m) {
130                // interpretation des expressions regulieres grace aux virgules : ,un +mot,i
131                $m = trim(str_replace('@@tag@@','</',$m));
132                if(strncmp($m,',',1)===0) $regs[] = $m;
133                else {
134                        $mots[] = charset2unicode($m);
135                        $titres[] = $m;
136                }
137        }
138        if(count($titres))
139                $titres = join(_GLOSSAIRE_TITRE_SEP, $titres);
140        elseif(count($regs)) {
141                preg_match('/^,(.*),\w*$/', $regs[0], $rr);
142                if (strpos($titres = $rr[1], '\\')!==false) {
143                        $titres = preg_replace('@\\\\([\.\\\+\*\?\[\^\]\$\(\)\{\}\=\!\<\>\|:,-])@', '$1', $titres);
144                        $titres = preg_replace(',\\\\[bswd],i', '', $titres);
145                }
146        } else
147                $titres = '??';
148        if(count($mots)) {
149                $mots = array_unique($mots);
150                array_walk($mots, 'cs_preg_quote');
151                $mots = glossaire_accents(join('|', $mots));
152        } else $mots = '';
153        return array($mots, $regs, $titres);
154}
155
156function glossaire_gogogo($texte, $mots, $limit, &$unicode) {
157        // prudence 2 : on protege TOUTES les balises HTML comprenant le mot
158        if (strpos($texte, '<')!==false)
159                $texte = preg_replace_callback(",<[^>]*(?:$mots)[^>]*>,Ui", 'glossaire_echappe_balises_callback', $texte);
160        // prudence 3 : en iso-8859-1, (\W) comprend les accents, mais pas en utf-8... Donc on passe en unicode
161        if(($GLOBALS['meta']['charset'] != 'iso-8859-1') && !$unicode) 
162                { $texte = charset2unicode($texte); $unicode = true; }
163        // prudence 4 : on neutralise le mot si on trouve un accent (HTML ou unicode) juste avant ou apres
164        if (strpos($texte, '&')!==false) {
165                $texte = preg_replace_callback(',&(?:'._GLOSSAIRE_ACCENTS.");(?:$mots),i", 'glossaire_echappe_balises_callback', $texte);
166                $texte = preg_replace_callback(",(?:$mots)&(?:"._GLOSSAIRE_ACCENTS.');,i', 'glossaire_echappe_balises_callback', $texte);
167        }
168        // a chaque mot reconnu, on pose une balise temporaire cryptee
169        return trim(preg_replace_callback(",(?<=\W)(?:$mots)(?=\W),i", "glossaire_echappe_mot_callback", " $texte ", $limit));
170}
171
172// cette fonction n'est pas appelee dans les balises html : html|code|cadre|frame|script|acronym|cite|abbr|a
173// si $liste=true alors la fonction renvoie la liste des mots trouves
174// chaque element du tableau renvoye est array('mot trouve', id_mot, 'lien mot', 'titre mot');
175function cs_rempl_glossaire($texte, $liste=false) {
176        global $gloss_id, $gloss_mots, $gloss_mots_id, $gloss_ech, $gloss_ech_id;
177        // si [!glossaire] est trouve on sort
178        if(strpos($texte, _CS_SANS_GLOSSAIRE)!==false)
179                return $liste?array():str_replace(_CS_SANS_GLOSSAIRE, '', $texte);
180        // mise en static de la table des mots pour eviter d'interrroger la base a chaque fois
181        // attention aux besoins de memoire...
182        static $limit, $glossaire_generer_url, $glossaire_generer_mot, $glossaire_array = NULL;
183        if(!isset($glossaire_array)) {
184                $glossaire_array = glossaire_query_tab();
185                $glossaire_generer_url = function_exists('glossaire_generer_url')?'glossaire_generer_url':'glossaire_generer_url_dist';
186                $limit = defined('_GLOSSAIRE_LIMITE')?_GLOSSAIRE_LIMITE:-1;
187                $glossaire_generer_mot = function_exists('glossaire_generer_mot')
188                        ?'glossaire_generer_mot(\'\\2\', $GLOBALS[\'gloss_mots\'][\\1])':'$GLOBALS[\'gloss_mots\'][\\1]'; // 'glossaire_generer_mot_dist(\'\\2\', $GLOBALS[\'gloss_mots\'][\\1])';
189                $glossaire_generer_mot = '"<a $table1[\\2]_".$GLOBALS["gl_i"]++."\' class=\'cs_glossaire\'><span class=\'gl_mot\'>".'.$glossaire_generer_mot.'."</span>$table2[\\2]</a>"';
190        }
191        $unicode = false;
192        // initialisation des globales d'echappement
193        $gloss_ech = $gloss_mots = array();
194        $gloss_ech_id = $gloss_mots_id = 0;
195        // prudence 1 : protection des liens SPIP
196        if(strpos($texte, '[') !== false) 
197                $texte = preg_replace_callback(',\[[^][]*->>?[^]]*\],msS', 'glossaire_echappe_balises_callback', $texte);
198        // parcours de tous les mots, sauf celui qui peut faire partie du contexte (par ex : /spip.php?mot5)
199        $mot_contexte=$GLOBALS['contexte']['id_mot']?$GLOBALS['contexte']['id_mot']:_request('id_mot');
200        foreach ($glossaire_array as $mot) if (($gloss_id = $mot['id_mot']) <> $mot_contexte) {
201                // parser le mot-cle du glossaire
202                // contexte de langue a prendre en compte ici
203                list($les_mots, $les_regexp, $les_titres) = glossaire_parse($titre = extraire_multi($mot['titre']));
204                $mot_present = false;
205                if(count($les_regexp)) {
206                        // a chaque expression reconnue, on pose une balise temporaire cryptee
207                        // ce remplacement est puissant, attention aux balises HTML ; par exemple, eviter : ,div,i
208                        $texte = preg_replace_callback($les_regexp, "glossaire_echappe_mot_callback", $texte, $limit);
209                        // TODO 1 : sous PHP 5.0, un parametre &$count permet de savoir si un remplacement a eu lieu
210                        // et s'il faut construire la fenetre de glossaire.
211                        // TODO 2 : decrementer le parametre $limit pour $les_mots, si &$count est renseigne.
212                        // en attendant, construisons qd meme la fenetre...
213                        $mot_present = true;
214                }
215                if($les_mots) {
216                        if(preg_match(",\W(?:$les_mots)\W,i", " $texte ")) {
217                                $texte = glossaire_gogogo($texte, $les_mots, $limit, $unicode);
218                                $mot_present = true;
219                        }
220                }
221                // si un mot est trouve, on construit la fenetre de glossaire
222                if($mot_present) {
223                        $lien = $glossaire_generer_url($gloss_id, $titre);
224                        // $definition =strlen($mot['descriptif'])?$mot['descriptif']:$mot['texte'];
225                        if($liste)
226                                // on ne renvoie que la liste des mots trouves
227                                $table1[$gloss_id] = array($gloss_id, $lien, $les_titres);
228                        else {
229                                // l'attribut 'name' en fin de chaine est complete plus tard pour eviter les doublons :
230                                $table1[$gloss_id] = (function_exists('glossaire_attributs_lien')
231                                        ?glossaire_attributs_lien($gloss_id, $lien, $titre, explode(_GLOSSAIRE_TITRE_SEP, $les_titres))
232                                        :"href='$lien'") . " name='mot$gloss_id";
233                                $table2[$gloss_id] = defined('_CS_PRINT')?'':recuperer_fond(
234                                        defined('_GLOSSAIRE_JS')?'fonds/glossaire_js':'fonds/glossaire_css', 
235                                        array('id_mot' => $gloss_id, 'titre' => $les_titres, 
236                                                'texte' => glossaire_safe($mot['texte']), 
237                                                'descriptif' => glossaire_safe($mot['descriptif'])));
238                        }
239                }
240        }
241        $GLOBALS['gl_i'] = 0;
242        if($liste) $texte = (preg_match_all(',@@M(\d+)#(\d+)@@,', $texte, $reg, PREG_SET_ORDER) 
243                        && array_walk($reg,
244                create_function('&$v,$k,&$t1', '$v=array_merge(array($GLOBALS[\'gloss_mots\'][$v[1]]),$t1[$v[2]]);'), $table1)
245                )?$reg:array();
246        else {
247                // remplacement des echappements
248                $texte = preg_replace(',@@E(\d+)@@,e', '$GLOBALS[\'gloss_ech\'][\\1]', $texte);
249                // remplacement final des balises posees ci-dessus
250                $texte = preg_replace(',@@M(\d+)#(\d+)@@,e', $glossaire_generer_mot, $texte);
251        }
252        // nettoyage
253        unset($gloss_id, $gloss_mots, $gloss_mots_id, $gloss_ech, $gloss_ech_id);
254        // ordre correct des balises en cas d'acronyme ou d'abreviation
255        if(strpos($texte, '</span></a></a')!==false)
256                $texte = preg_replace(',(<a(bbr|cronym) [^>]+>)(<a [^>]+class=\'cs_glossaire\'><span class=\'gl_mot\'>)(.*?)</span>(<span class="gl_.*?</span>)</a></a\\2>,smS', '$3$1$4</a$2></span>$5</a>', $texte);
257        return $texte;
258}
259
260// filtre appliquant l'insertion du glossaire
261function cs_glossaire($texte) {
262        return cs_echappe_balises(_GLOSSAIRE_ECHAPPER, 'cs_rempl_glossaire', $texte);
263}
264
265// filtre renvoyant la liste des mots trouves dans le texte
266function cs_mots_glossaire($texte, $type='', $sep='') {
267        if(strpos($texte, "<span class='gl_mot'>")!==false && preg_match_all(",'gl_mot'>(.*?)</span>,", $texte, $reg))
268                // glossaire deja present, on simplifie donc le texte
269                $texte = join('  ', $reg[1]);
270        $mots = cs_echappe_balises(_GLOSSAIRE_ECHAPPER, 'cs_rempl_glossaire', $texte, true);
271        if(!count($mots)) return strlen($sep)?'':$mots;
272        $lien = '$v="<a href=\"$v[2]\"';
273        $titre = strpos($type,'_unique')===false?'str_replace("<br />"," / ", $v[3])':'array_shift(explode(_GLOSSAIRE_TITRE_SEP, $v[3]))';
274        switch($type) {
275                case '':return $mots;
276                case 'id_mot':
277                        array_walk($mots, create_function('&$v', '$v=$v[1];'));
278                        break;
279                case 'mot':
280                        array_walk($mots, create_function('&$v', '$v=$v[0];'));
281                        break;
282                case 'titre': case 'titre_unique':
283                        array_walk($mots, create_function('&$v', "\$v=$titre;"));
284                        break;
285                case 'lien_mot':
286                        array_walk($mots, create_function('&$v', $lien.'>$v[0]</a>";'));
287                        break;
288                case 'lien_titre': case 'lien_titre_unique':
289                        array_walk($mots, create_function('&$v', $lien.'>".'.$titre.'."</a>";'));
290                        break;
291                case 'nuage': case 'nuage_unique':
292                        $stats = array(); $min = 999999; $max = 0;
293                        foreach($mots as $m) $stats[$m[1]]++;
294                        $m = min($stats); $d = max($stats) - $m;
295                        array_walk($stats, create_function('&$v',  $d?"\$v=round((\$v-$m)*9/$d)+1;":'$v=1;')); // valeurs de 1 a 10
296                        array_walk($mots, create_function('&$v,$k,&$s', $lien.' class=\"nuage".$s[$v[1]]."\">".'.$titre.'."</a>";'), $stats);
297                        break;
298                default:return "#GLOSSAIRE/$type?";
299        }
300        $mots = array_unique($mots);
301        return strlen($sep)?join($sep, $mots):$mots;
302}
303
304?>
Note: See TracBrowser for help on using the repository browser.