776ae55d4f02ea05b6cbf78451a2adbb812449ab
3 /***************************************************************************\
4 * SPIP, Systeme de publication pour l'internet *
6 * Copyright (c) 2001-2016 *
7 * Arnaud Martin, Antoine Pitrou, Philippe Riviere, Emmanuel Saint-James *
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 \***************************************************************************/
14 * Gestion de l'aide en ligne de SPIP
16 * L'aide en ligne de SPIP est disponible sous forme d'articles de www.spip.net
17 * qui ont des repères nommés arttitre, artdesc etc.
19 * La fonction `inc_aider_dist` reçoit soit ces repères,
20 * soit le nom du champ de saisie, le nom du squelette le contenant et enfin
21 * l'environnement d'exécution du squelette (inutilisé pour le moment).
23 * Le tableau global `aider_index` donne ces repères.
25 * @package SPIP\Core\Aider
28 if (!defined('_ECRIRE_INC_VERSION')) {
32 include_spip('inc/filtres');
34 $GLOBALS['aider_index'] = array(
35 'editer_article.html' => array(
36 'surtitre' => 'arttitre',
37 'titre' => 'arttitre',
38 'soustitre' => 'arttitre',
39 'id_parent' => 'artrub',
40 'descriptif' => 'artdesc',
41 'virtuel' => 'artvirt',
42 'chapo' => 'arttitre',
43 'text_area' => 'arttexte'
46 'editer_breve.html' => array(
47 'id_parent' => 'brevesrub',
48 'lien_titre' => 'breveslien',
49 'statut' => 'brevesstatut'
52 'editer_groupe_mot.html' => array(
53 'titre' => 'motsgroupes'
56 'editer_mot.html' => array(
58 'id_groupe' => 'motsgroupes'
61 'editer_rubrique.html' => array(
62 'titre' => 'arttitre',
63 'id_parent' => 'rubrub',
64 'text_area' => 'raccourcis'
71 * Générer un lien d'aide (icône + lien)
76 * clé d'identification de l'aide souhaitée
78 * Nom du squelette qui appelle ce bouton d'aide
80 * Environnement du squelette
81 * @param bool $aide_spip_directe
82 * false : Le lien généré est relatif à notre site (par défaut)
83 * true : Le lien est réalisé sur spip.net/aide/ directement...
86 function inc_aide_dist($aide = '', $skel = '', $env = array(), $aide_spip_directe = false) {
88 if (($skel = basename($skel))
89 and isset($GLOBALS['aider_index'][$skel])
90 and isset($GLOBALS['aider_index'][$skel][$aide])
92 $aide = $GLOBALS['aider_index'][$skel][$aide];
95 if ($aide_spip_directe) {
96 // on suppose que spip.net est le premier present
97 // dans la liste des serveurs. C'est forcement le cas
98 // a l'installation tout du moins
99 $help_server = $GLOBALS['help_server'];
100 $url = array_shift($help_server) . '/';
101 $url = parametre_url($url, 'exec', 'aide');
102 $url = parametre_url($url, 'aide', $aide);
103 $url = parametre_url($url, 'var_lang', $GLOBALS['spip_lang']);
105 $args = "aide=$aide&var_lang=" . $GLOBALS['spip_lang'];
106 $url = generer_url_ecrire('aide', $args);
109 return aider_icone($url);
113 * Créer l'icône d'aide
115 * @global string $spip_lang
116 * @global string $spip_lang_rtl
120 * @param string $clic
121 * Contenu de la balise de lien.
125 function aider_icone($url, $clic = '') {
127 include_spip('inc/lang');
129 $t = _T('titre_image_aide');
130 $clic = http_img_pack(
131 'aide' . aide_lang_dir($GLOBALS['spip_lang'], $GLOBALS['spip_lang_rtl']) . '-16.png',
132 _T('info_image_aide'),
133 " title=\"$t\" class='aide'"
137 return "\n <a class='aide popin'\nhref='"
139 . "' target='_blank'>"
144 /** Les sections d'un fichier aide sont reperées ainsi. */
145 define('_SECTIONS_AIDE', ',<h([12])(?:\s+class="spip")?' . '>([^/]+?)(?:/(.+?))?</h\1>,ism');
147 * Création des fichiers de l'aide de SPIP
150 * @uses _SECTIONS_AIDE
152 * @uses copie_locale()
153 * @uses aide_fixe_img()
154 * @uses aide_section()
156 * @param string $path
157 * @param array $help_server
160 function aide_fichier($path, $help_server) {
162 $md5 = md5(serialize($help_server));
163 $fichier_aide = _DIR_AIDE
. substr($md5, 0, 16) . '-' . $path;
164 $lastm = @filemtime
($fichier_aide);
165 $lastversion = @filemtime
(_DIR_RESTREINT
. 'inc_version.php');
166 $here = @(is_readable($fichier_aide) and ($lastm >= $lastversion));
170 lire_fichier($fichier_aide, $contenu);
172 return array($contenu, $lastm);
175 // mettre en cache (tant pis si echec)
176 sous_repertoire(_DIR_AIDE
, '', '', true);
178 include_spip('inc/distant');
179 foreach ($help_server as $k => $server) {
180 // Remplacer les liens aux images par leur gestionnaire de cache
181 $url = "$server/$path";
182 $local = _DIR_AIDE
. substr(md5($url), 0, 8) . '-' . preg_replace(',[^\w.]+,i', '_', $url);
183 $local = _DIR_RACINE
. copie_locale($url, 'modif', $local);
185 lire_fichier($local, $page);
186 $page = aide_fixe_img($page, $server);
187 // les liens internes ne doivent pas etre deguises en externes
188 $url = parse_url($url);
189 $re = '@(<a\b[^>]*\s+href=["\'])' .
190 '(?:' . $url['scheme'] . '://' . $url['host'] . ')?' .
191 $url['path'] . '([^"\']*)@ims';
192 $page = preg_replace($re, '\\1\\2', $page);
194 preg_match_all(_SECTIONS_AIDE
, $page, $sections, PREG_SET_ORDER
);
195 // Fusionner les aides ayant meme nom de section
197 foreach ($sections as $section) {
198 list($tout, $prof, $sujet, ) = $section;
199 if (in_array($sujet, $vus)) {
202 $corps = aide_section($sujet, $page, $prof);
203 foreach ($contenu as $k => $s) {
205 // Section deja vue qu'il faut completer
206 // Si le complement a des sous-sections,
207 // ne pas en tenir compte quand on les rencontrera
208 // lors des prochains passages dans la boucle
209 preg_match_all(_SECTIONS_AIDE
, $corps, $s, PREG_PATTERN_ORDER
);
211 $vus = array_merge($vus, $s[2]);
213 $contenu[$k] .= $corps;
218 // Si totalement nouveau, inserer le titre
219 // mais pas le corps s'il contient des sous-sections:
220 // elles vont venir dans les passages suivants
222 $corps = aide_section($sujet, $page);
223 $contenu[$sujet] = $tout . "\n" . $corps;
228 $contenu = '<div>' . join('', $contenu) . '</div>';
230 // Renvoyer les liens vraiment externes dans une autre fenetre
231 $contenu = preg_replace(
232 '@<a href="(http://[^"]+)"([^>]*)>@',
233 '<a href="\\1"\\2 target="_blank">',
237 // Correction typo dans la langue demandee
238 #changer_typo($lang_aide);
239 $contenu = '<body>' . $contenu . '</body>';
241 if (strlen($contenu) <= 100) {
242 return array(false, false);
244 ecrire_fichier($fichier_aide, $contenu);
246 return array($contenu, time());
250 * Générer l'url des images de l'aide
252 * @param string|array $args
253 * Arguments à transmettre à l'URL :
254 * - string : tel que `arg1=yy&arg2=zz`
255 * - array : tel que `array( arg1 => yy, arg2 => zz )`
259 function generer_url_aide_img($args) {
260 return generer_url_action('aide_img', $args, false, true);
264 /** Les aides non mises à jour ont un vieux Path à remplacer
266 * @note (mais ce serait bien de le faire en SQL une bonne fois)
268 define('_REPLACE_IMG_PACK', "@(<img([^<>]* +)?\s*src=['\"])img_pack\/@ims");
271 * Remplacer les URL des images par l'URL du gestionnaire de cache local
273 * @uses _REPLACE_IMG_PACK
274 * @uses _DIR_IMG_PACK
276 * @param string $contenu
277 * @param string $server
280 function aide_fixe_img($contenu, $server) {
282 $re = "@(<img([^<>]* +)?\s*src=['\"])((AIDE|IMG|local)/([-_a-zA-Z0-9]*/?)([^'\"<>]*))@imsS";
283 while (preg_match($re, $contenu, $r)) {
284 $p = strpos($contenu, $r[0]);
285 $i = $server . '/' . $r[3];
286 $html .= substr($contenu, 0, $p) . $r[1] . $i;
287 $contenu = substr($contenu, $p +
strlen($r[0]));
291 // traiter les vieilles doc
292 return preg_replace(_REPLACE_IMG_PACK
, "\\1" . _DIR_IMG_PACK
, $html);
297 * Extraire une section d'aide
299 * Extraire la seule section demandée, qui commence par son nom entourée d'une
300 * balise h2 et se termine par la prochaine balise h2 ou h1 ou le /body final.
302 * @param string $aide
303 * Titre de la section d'aide
304 * @param string $contenu
306 * Dans quel hn doit-on mettre le titre de section
309 function aide_section($aide, $contenu, $prof = 2) {
310 $maxprof = ($prof >= 2) ?
'12' : '1';
311 $r = "@<h$prof" . '(?: class="spip")?' . '>\s*' . $aide
312 . "\s*(?:/.+?)?</h$prof>(.*?)<(?:(?:h[$maxprof])|/body)@ism";
314 if (preg_match($r, $contenu, $m)) {
318 # spip_log("aide inconnue $r dans " . substr($contenu, 0, 150));