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

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

reset() n'accepte que des tableaux purs et durs

File size: 16.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://contrib.spip.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(strpos($titre_mot, '=')!==false) {
38                list(, $lien) = glossaire_redirection($titre_mot);
39                if($lien) return calculer_url($lien);
40        }
41        if(defined('_SPIP19300')) 
42                return generer_url_entite($id_mot, 'mot');
43        // avant SPIP 2.0 :
44        charger_generer_url(); return generer_url_mot($id_mot);
45}
46
47// surcharge possible de cette fonction glossaire_generer_mot_dist par : glossaire_generer_mot($id_mot, $mot)
48// si elle existe, elle sera utilisee pour remplacer le mot detecte dans la phrase
49/* exemple pour utiliser un fond personnalise, mettre une couleur de groupe ou inserer un logo par exemple :
50        function glossaire_generer_mot($id_mot, $mot) {
51                return recuperer_fond('/fonds/mon_glossaire', array('id_mot'=>$id_mot, 'mot'=>$mot));
52        }*/
53function glossaire_generer_mot_dist($id_mot, $mot) {
54        return $mot;
55}
56
57/* surcharge possible de cette fonction glossaire_attributs_lien_dist par : glossaire_attributs_lien($lien, $titre, $gloss_id)
58 si elle existe, elle sera utilisee pour les attributs (sauf class et name) du <a> place autour du mot detecte.
59 $lien : lien du mot - $titre : titre brut du mot - $les_titres : array() des differents titres possibles du mot
60 Exemple :
61        function glossaire_attributs_lien($id_mot, $lien, $titre, $les_titres) {
62                return "href='$lien' title=\"" . attribut_html($les_titres[0]). '"';
63        } */
64function glossaire_attributs_lien_dist($id_mot, $lien, $titre, $les_titres) {
65        return "href='$lien'";
66}
67
68
69// traitement pour #TITRE/mots : retrait des expressions regulieres
70function cs_glossaire_titres($titre) {
71        if(strpos($titre, ',')===false && strpos($titre, '=')===false) return $titre;
72        list(,,$mots) = glossaire_parse($titre);
73        return $mots;
74}
75
76// Cette fonction retire du texte les boites de definition et les liens du glossaire
77function cs_retire_glossaire($texte) {
78        $texte = preg_replace(',<span class="gl_(jst?|d[td])".*?</span>,s', '', $texte);
79        if(!defined('_GLOSSAIRE_JS')) $texte = preg_replace(',<span class="gl_dl">.*?</span>,s', '', $texte);
80        return preg_replace(',<a [^>]+class=\'cs_glossaire\'><span class=\'gl_mot\'>(.*?)</span></a>,s', '$1', $texte);
81}
82$GLOBALS['cs_introduire'][] = 'cs_retire_glossaire';
83
84// remplace les accents unicode par l'equivalent charset/unicode/html
85function glossaire_accents($regexpr) {
86        if (strpos($regexpr, '&')===false) return $regexpr;
87        return preg_replace_callback(",&#([0-9]+);,", 'glossaire_accents_callback', str_replace('& ','&amp; ',$regexpr));
88}
89
90// $matches est un caractere unicode sous forme &#XXX;
91// ici on cherche toutes les formes de ce caractere, minuscule ou majuscule : unicode, charset et html
92function glossaire_accents_callback($matches) {
93        $u = unicode2charset($matches[0]);      // charset
94        $u2 = init_mb_string()?mb_strtoupper($u):strtoupper($u);        // charset majuscule
95        $u3 = htmlentities($u2, ENT_QUOTES, $GLOBALS['meta']['charset']);       // html majuscule
96        $u4 = html2unicode($u3); // unicode majuscule
97        $a = array_unique(array($u, $u2, htmlentities($u, ENT_QUOTES, $GLOBALS['meta']['charset']), $u3, $matches[0], $u4));
98//      $a = array_unique(array($u, htmlentities($u, ENT_QUOTES, $GLOBALS['meta']['charset']), $matches[0]));
99        return '(?:'.join('|', $a).')';
100}
101function glossaire_echappe_balises_callback($matches) {
102 global $gloss_ech, $gloss_ech_id;
103 $gloss_ech[] = $matches[0];
104 return '@@E'.$gloss_ech_id++.'@@';
105}
106function glossaire_echappe_mot_callback($matches) {
107 global $gloss_mots, $gloss_mots_id, $gloss_id;
108 $gloss_mots[] = $matches[0];
109 return '@@M'.$gloss_mots_id++.'#'.$gloss_id.'@@';
110}
111
112function glossaire_safe($texte) {
113        // on retire les notes avant propre()
114        return safehtml(cs_propre(preg_replace(', *\[\[(.*?)\]\],msS', '', nl2br(trim($texte)))));
115}
116
117// renvoie le tableau des mots du glossaire
118function glossaire_query_tab() {
119        // interrogation personnalisee de la base
120        if(defined('_GLOSSAIRE_QUERY')) {
121                $res = array();
122                $fetch = function_exists('sql_fetch')?'sql_fetch':'spip_fetch_array';
123                $query = spip_query(_GLOSSAIRE_QUERY);
124                while($r = $fetch($query)) $res[] = $r;
125                return $res;
126        }
127        return sql_allfetsel('id_mot,titre,texte,descriptif', 'spip_mots', 'type='.glossaire_groupes(), '', 'id_mot ASC');
128}
129
130function glossaire_redirection($titre) {
131        $titre = preg_split(','.preg_quote(_GLOSSAIRE_TITRE_BASE_SEP,',').'\s*=,', $titre, 2);
132        return array(trim($titre[0]), isset($titre[1])?trim($titre[1]):'');
133}
134
135// parse toutes les formes du titre d'un mot-cle du glossaire
136// prendre en compte les formes du mot : architrave/architraves
137function glossaire_parse($titre) {
138        $mots = $regs = $titres = array(); $ok_mots = true;
139        // cas d'une redirection
140        if(strpos($titre, '=')!==false) list($titre) = glossaire_redirection($titre);
141        foreach(explode(_GLOSSAIRE_TITRE_BASE_SEP, str_replace('</','@@tag@@',$titre)) as $m) {
142                // interpretation des expressions regulieres grace aux virgules : ,un +mot,i
143                $m = trim(str_replace('@@tag@@','</',$m));
144                if(strncmp($m,',',1)===0)
145                        $ok_mots &= !preg_match('/^,\w{1,3},$/', $regs[] = $m);
146                else {
147                        $mots[] = charset2unicode($m);
148                        $titres[] = $m;
149                        $ok_mots &= mb_strlen($m)>3;
150                }
151        }
152        if(count($titres))
153                $titres = join(_GLOSSAIRE_TITRE_SEP, $titres);
154        elseif(count($regs)) {
155                preg_match('/^,(.*),\w*$/', $regs[0], $rr);
156                if (strpos($titres = $rr[1], '\\')!==false) {
157                        $titres = preg_replace('@\\\\([\.\\\+\*\?\[\^\]\$\(\)\{\}\=\!\<\>\|:,-])@', '$1', $titres);
158                        $titres = preg_replace(',\\\\[bswd],i', '', $titres);
159                }
160        } else
161                $titres = '??';
162        if(count($mots)) {
163                $mots = array_unique($mots);
164                array_walk($mots, 'cs_preg_quote');
165                // expliciter l'apostrophe et les accents
166                $mots = str_replace("'", "(?:'|&#8217;)", glossaire_accents(join('|', $mots)));
167        } else $mots = '';
168        $ok_regexp = count($regs)?preg_replace($regs, 't', 'test', 1)!==null:true;
169        return array($mots, $ok_regexp?$regs:array(), $titres, $ok_regexp, $ok_mots);
170}
171
172function glossaire_gogogo($texte, $mots, $limit, &$unicode) {
173        // prudence 2 : on protege TOUTES les balises HTML comprenant le mot
174        if (strpos($texte, '<')!==false)
175                $texte = preg_replace_callback(",<[^>]*(?:$mots)[^>]*>,Ui", 'glossaire_echappe_balises_callback', $texte);
176        // prudence 3 : en iso-8859-1, (\W) comprend les accents, mais pas en utf-8... Donc on passe en unicode
177        if(($GLOBALS['meta']['charset'] != 'iso-8859-1') && !$unicode) 
178                { $texte = charset2unicode($texte); $unicode = true; }
179        // prudence 4 : on neutralise le mot si on trouve un accent (HTML ou unicode) juste avant ou apres
180        if (strpos($texte, '&')!==false) {
181                $texte = preg_replace_callback(',&(?:'._GLOSSAIRE_ACCENTS.");(?:$mots),i", 'glossaire_echappe_balises_callback', $texte);
182                $texte = preg_replace_callback(",(?:$mots)&(?:"._GLOSSAIRE_ACCENTS.');,i', 'glossaire_echappe_balises_callback', $texte);
183        }
184        // a chaque mot reconnu, on pose une balise temporaire cryptee
185        return trim(preg_replace_callback(",(?<=\W)(?:$mots)(?=\W),i", 'glossaire_echappe_mot_callback', " $texte ", $limit));
186}
187
188// cette fonction n'est pas appelee dans les balises html : html|code|cadre|frame|script|acronym|cite|abbr|a
189// si $liste=true alors la fonction renvoie la liste des mots trouves
190// chaque element du tableau renvoye est array('mot trouve', id_mot, 'lien mot', 'titre mot');
191function cs_rempl_glossaire($texte, $liste=false) {
192        global $gloss_tab1, $gloss_tab2, $gloss_id, $gloss_mots, $gloss_mots_id, $gloss_ech, $gloss_ech_id;
193        // si [!glossaire] est trouve on sort
194        if(strpos($texte, _CS_SANS_GLOSSAIRE)!==false)
195                return $liste?array():str_replace(_CS_SANS_GLOSSAIRE, '', $texte);
196        // mise en static de la table des mots pour eviter d'interrroger la base a chaque fois
197        // attention aux besoins de memoire...
198        static $limit, $glossaire_generer_url, $glossaire_generer_mot, $glossaire_echappements, $glossaire_array = NULL;
199        if(!isset($glossaire_array)) {
200                $glossaire_array = glossaire_query_tab();
201                $glossaire_generer_url = function_exists('glossaire_generer_url')?'glossaire_generer_url':'glossaire_generer_url_dist';
202                $limit = defined('_GLOSSAIRE_LIMITE')?_GLOSSAIRE_LIMITE:-1;
203                $glossaire_generer_mot = function_exists('glossaire_generer_mot')
204                        ?'glossaire_generer_mot($m[2], $GLOBALS[\'gloss_mots\'][$m[1]])':'$GLOBALS[\'gloss_mots\'][$m[1]]';
205                $glossaire_generer_mot = 'return "<a ".$GLOBALS["gloss_tab1"][$m[2]]."_".$GLOBALS["gl_i"]++."\' class=\'cs_glossaire\'><span class=\'gl_mot\'>".'.$glossaire_generer_mot.'."</span>".$GLOBALS["gloss_tab2"][$m[2]]."</a>";';
206                $glossaire_generer_mot = create_function('$m', $glossaire_generer_mot);
207                $glossaire_echappements = create_function('$m','return $GLOBALS[\'gloss_ech\'][$m[1]];');
208        }
209        $unicode = false;
210        // initialisation des globales d'echappement
211        $gloss_ech = $gloss_mots = array();
212        $gloss_ech_id = $gloss_mots_id = 0;
213        // prudence 1 : protection des liens SPIP
214        if(strpos($texte, '[') !== false) 
215                $texte = preg_replace_callback(',\[[^][]*->>?[^]]*\],msS', 'glossaire_echappe_balises_callback', $texte);
216        // parcours de tous les mots, sauf celui qui peut faire partie du contexte (par ex : /spip.php?mot5)
217        $mot_contexte = (isset($GLOBALS['contexte']['id_mot']) && $GLOBALS['contexte']['id_mot'])
218                ?$GLOBALS['contexte']['id_mot']:_request('id_mot');
219        foreach ($glossaire_array as $mot) if (($gloss_id = $mot['id_mot']) <> $mot_contexte) {
220                // parser le mot-cle du glossaire
221                // contexte de langue a prendre en compte ici
222                list($les_mots, $les_regexp, $les_titres, $ok_regexp, $ok_mots) = glossaire_parse($titre = extraire_multi($mot['titre']));
223                $mot_present = false;
224                if(!$ok_regexp) 
225                        spip_log(couteauprive_T('glossaire:nom').'. '.couteauprive_T('erreur_syntaxe').$titre);
226                elseif(count($les_regexp)) {
227                        // a chaque expression reconnue, on pose une balise temporaire cryptee
228                        // ce remplacement est puissant, attention aux balises HTML ; par exemple, eviter : ,div,i
229                        $texte = preg_replace_callback($les_regexp, 'glossaire_echappe_mot_callback', $texte, $limit);
230                        // TODO 1 : sous PHP 5.0, un parametre &$count permet de savoir si un remplacement a eu lieu
231                        // et s'il faut construire la fenetre de glossaire.
232                        // TODO 2 : decrementer le parametre $limit pour $les_mots, si &$count est renseigne.
233                        // en attendant, construisons qd meme la fenetre...
234                        $mot_present = true;
235                }
236                if($les_mots && preg_match(",\W(?:$les_mots)\W,i", " $texte ")) {
237                        $texte = glossaire_gogogo($texte, $les_mots, $limit, $unicode);
238                        $mot_present = true;
239                }
240                // si un mot est trouve, on construit la fenetre de glossaire
241                if($mot_present) {
242                        $lien = $glossaire_generer_url($gloss_id, $titre);
243                        // $definition = strlen($mot['descriptif'])?$mot['descriptif']:$mot['texte'];
244                        if($liste)
245                                // on ne renvoie que la liste des mots trouves
246                                $gloss_tab1[$gloss_id] = array($gloss_id, $lien, $les_titres);
247                        else {
248                                // l'attribut 'name' en fin de chaine est complete plus tard pour eviter les doublons :
249                                $gloss_tab1[$gloss_id] = (function_exists('glossaire_attributs_lien')
250                                        ?glossaire_attributs_lien($gloss_id, $lien, $titre, explode(_GLOSSAIRE_TITRE_SEP, $les_titres))
251                                        :"href='$lien'") . " name='mot$gloss_id";
252                                $gloss_tab2[$gloss_id] = defined('_CS_PRINT')?'':recuperer_fond(
253                                        defined('_GLOSSAIRE_JS')?'fonds/glossaire_js':'fonds/glossaire_css', 
254                                        array('id_mot' => $gloss_id, 'titre' => $les_titres, 
255                                                'texte' => glossaire_safe($mot['texte']), 
256                                                'descriptif' => glossaire_safe($mot['descriptif'])));
257                        }
258                }
259        }
260        $GLOBALS['gl_i'] = 0;
261        if($liste) $texte = (preg_match_all(',@@M(\d+)#(\d+)@@,', $texte, $reg, PREG_SET_ORDER) 
262                        && array_walk($reg,
263                create_function('&$v,$k', '$v=array_merge(array($GLOBALS[\'gloss_mots\'][$v[1]]),$GLOBALS[\'gloss_tab1\'][$v[2]]);'))
264                )?$reg:array();
265        else {
266                // remplacement des echappements
267                $texte = preg_replace_callback(',@@E(\d+)@@,', $glossaire_echappements, $texte);
268                // remplacement final des balises posees ci-dessus
269                $texte = preg_replace_callback(',@@M(\d+)#(\d+)@@,', $glossaire_generer_mot, $texte);
270        }
271        // nettoyage
272        unset($gloss_tab1, $gloss_tab2, $gloss_id, $gloss_mots, $gloss_mots_id, $gloss_ech, $gloss_ech_id);
273        // ordre correct des balises en cas d'acronyme ou d'abreviation
274        if(strpos($texte, '</span></a></a')!==false)
275                $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);
276        return $texte;
277}
278
279// filtre appliquant l'insertion du glossaire
280function cs_glossaire($texte) {
281        return cs_echappe_balises(_GLOSSAIRE_ECHAPPER, 'cs_rempl_glossaire', $texte);
282}
283
284// filtre renvoyant la liste des mots trouves dans le texte
285function cs_mots_glossaire($texte, $type='', $sep='') {
286        if(strpos($texte, "<span class='gl_mot'>")!==false && preg_match_all(",'gl_mot'>(.*?)</span>,", $texte, $reg))
287                // glossaire deja present, on simplifie donc le texte
288                $texte = join('  ', $reg[1]);
289        $mots = cs_echappe_balises(_GLOSSAIRE_ECHAPPER, 'cs_rempl_glossaire', $texte, true);
290        if(!count($mots)) return strlen($sep)?'':$mots;
291        $lien = '$v="<a href=\"$v[2]\"';
292        $titre = strpos($type,'_unique')===false?'str_replace("<br />"," / ", $v[3])':'reset($ttt=explode(_GLOSSAIRE_TITRE_SEP, $v[3]))';
293        switch($type) {
294                case '':return $mots;
295                case 'id_mot':
296                        array_walk($mots, create_function('&$v', '$v=$v[1];'));
297                        break;
298                case 'mot':
299                        array_walk($mots, create_function('&$v', '$v=$v[0];'));
300                        break;
301                case 'titre': case 'titre_unique':
302                        array_walk($mots, create_function('&$v', "\$v=$titre;"));
303                        break;
304                case 'lien_mot':
305                        array_walk($mots, create_function('&$v', $lien.'>$v[0]</a>";'));
306                        break;
307                case 'lien_titre': case 'lien_titre_unique':
308                        array_walk($mots, create_function('&$v', $lien.'>".'.$titre.'."</a>";'));
309                        break;
310                case 'nuage': case 'nuage_unique':
311                        $stats = array(); $min = 999999; $max = 0;
312                        foreach($mots as $m) $stats[$m[1]]++;
313                        $m = min($stats); $d = max($stats) - $m;
314                        array_walk($stats, create_function('&$v',  $d?"\$v=round((\$v-$m)*9/$d)+1;":'$v=1;')); // valeurs de 1 a 10
315                        array_walk($mots, create_function('&$v,$k,&$s', $lien.' class=\"nuage".$s[$v[1]]."\">".'.$titre.'."</a>";'), $stats);
316                        break;
317                default: return "#GLOSSAIRE/$type?";
318        }
319        $mots = array_unique($mots);
320        return strlen($sep)?join($sep, $mots):$mots;
321}
322
323// fonction pipeline SPIP>=3.0
324function glossaire_affiche_milieu($flux) {
325        if($flux['args']['exec']=='mot') {
326                $titre = sql_getfetsel('titre', 'spip_mots', '(id_mot='.intval($flux['args']['id_mot']).') AND (type='.glossaire_groupes().')');
327                if(!$titre) return $flux; // Ce n'est pas un mot du glossaire
328                $flux['data'] .= debut_cadre_relief(cs_icone(24), true).'<b>'
329                        . cs_lien(generer_url_ecrire('admin_couteau_suisse', 'cmd=descrip&outil=glossaire#cs_infos'), couteauprive_T('glossaire:nom')).'</b>'
330                        . '<br/>&nbsp; > <b>'._T('info_titre').'</b> '.htmlentities($titre, ENT_QUOTES, $GLOBALS['meta']['charset']);
331                list(,$lien) = glossaire_redirection($titre);
332                if($lien && $lien = calculer_url($lien, '', 'tout')) 
333                        $flux['data'] .= '<br/>&nbsp; > <b>'._T('info_lien_hypertexte').'</b> '.cs_lien($lien['url'], $lien['titre']);
334                $flux['data'] .= fin_cadre_relief(true);
335        }
336        return $flux;
337}
338?>
Note: See TracBrowser for help on using the repository browser.