www/plugins-dist/aide/inc/aide.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  * Gestion de l'aide en ligne de SPIP
  15  *
  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.
  18  *
  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).
  22  *
  23  * Le tableau global `aider_index` donne ces repères.
  24  *
  25  * @package SPIP\Core\Aider
  26  */
  27
  28 if (!defined('_ECRIRE_INC_VERSION')) {
  29         return;
  30 }
  31
  32 include_spip('inc/filtres');
  33
  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'
  44         ),
  45
  46         'editer_breve.html' => array(
  47                 'id_parent' => 'brevesrub',
  48                 'lien_titre' => 'breveslien',
  49                 'statut' => 'brevesstatut'
  50         ),
  51
  52         'editer_groupe_mot.html' => array(
  53                 'titre' => 'motsgroupes'
  54         ),
  55
  56         'editer_mot.html' => array(
  57                 'titre' => 'mots',
  58                 'id_groupe' => 'motsgroupes'
  59         ),
  60
  61         'editer_rubrique.html' => array(
  62                 'titre' => 'arttitre',
  63                 'id_parent' => 'rubrub',
  64                 'text_area' => 'raccourcis'
  65         )
  66
  67 );
  68
  69
  70 /**
  71  * Générer un lien d'aide (icône + lien)
  72  *
  73  * @uses aider_icone()
  74  *
  75  * @param string $aide
  76  *    clé d'identification de l'aide souhaitée
  77  * @param string $skel
  78  *    Nom du squelette qui appelle ce bouton d'aide
  79  * @param array $env
  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...
  84  * @return string
  85  **/
  86 function inc_aide_dist($aide = '', $skel = '', $env = array(), $aide_spip_directe = false) {
  87
  88         if (($skel = basename($skel))
  89                 and isset($GLOBALS['aider_index'][$skel])
  90                 and isset($GLOBALS['aider_index'][$skel][$aide])
  91         ) {
  92                 $aide = $GLOBALS['aider_index'][$skel][$aide];
  93         }
  94
  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']);
 104         } else {
 105                 $args = "aide=$aide&var_lang=" . $GLOBALS['spip_lang'];
 106                 $url = generer_url_ecrire('aide', $args);
 107         }
 108
 109         return aider_icone($url);
 110 }
 111
 112 /**
 113  * Créer l'icône d'aide
 114  *
 115  * @global string $spip_lang
 116  * @global string $spip_lang_rtl
 117  *
 118  * @param string $url
 119  *         URL vers l'aide
 120  * @param string $clic
 121  *         Contenu de la balise de lien.
 122  * @return string
 123  *         Icone d'aide
 124  */
 125 function aider_icone($url, $clic = '') {
 126
 127         include_spip('inc/lang');
 128         if (!$clic) {
 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'"
 134                 );
 135         }
 136
 137         return "\n&nbsp;&nbsp;<a class='aide popin'\nhref='"
 138         . $url
 139         . "' target='_blank'>"
 140         . $clic
 141         . '</a>';
 142 }
 143
 144 /**  Les sections d'un fichier aide sont reperées ainsi. */
 145 define('_SECTIONS_AIDE', ',<h([12])(?:\s+class="spip")?' . '>([^/]+?)(?:/(.+?))?</h\1>,ism');
 146 /**
 147  * Création des fichiers de l'aide de SPIP
 148  *
 149  * @uses _DIR_AIDE
 150  * @uses _SECTIONS_AIDE
 151  *
 152  * @uses copie_locale()
 153  * @uses aide_fixe_img()
 154  * @uses aide_section()
 155  *
 156  * @param string $path
 157  * @param array $help_server
 158  * @return array
 159  */
 160 function aide_fichier($path, $help_server) {
 161
 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));
 167         $contenu = '';
 168
 169         if ($here) {
 170                 lire_fichier($fichier_aide, $contenu);
 171
 172                 return array($contenu, $lastm);
 173         }
 174
 175         // mettre en cache (tant pis si echec)
 176         sous_repertoire(_DIR_AIDE, '', '', true);
 177         $contenu = array();
 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);
 184
 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);
 193
 194                 preg_match_all(_SECTIONS_AIDE, $page, $sections, PREG_SET_ORDER);
 195                 // Fusionner les aides ayant meme nom de section
 196                 $vus = array();
 197                 foreach ($sections as $section) {
 198                         list($tout, $prof, $sujet, ) = $section;
 199                         if (in_array($sujet, $vus)) {
 200                                 continue;
 201                         }
 202                         $corps = aide_section($sujet, $page, $prof);
 203                         foreach ($contenu as $k => $s) {
 204                                 if ($sujet == $k) {
 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);
 210                                         if ($s) {
 211                                                 $vus = array_merge($vus, $s[2]);
 212                                         }
 213                                         $contenu[$k] .= $corps;
 214                                         $corps = '';
 215                                         break;
 216                                 }
 217                         }
 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
 221                         if ($corps) {
 222                                 $corps = aide_section($sujet, $page);
 223                                 $contenu[$sujet] = $tout . "\n" . $corps;
 224                         }
 225                 }
 226         }
 227
 228         $contenu = '<div>' . join('', $contenu) . '</div>';
 229
 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">',
 234                 $contenu
 235         );
 236
 237         // Correction typo dans la langue demandee
 238         #changer_typo($lang_aide);
 239         $contenu = '<body>' . $contenu . '</body>';
 240
 241         if (strlen($contenu) <= 100) {
 242                 return array(false, false);
 243         }
 244         ecrire_fichier($fichier_aide, $contenu);
 245
 246         return array($contenu, time());
 247 }
 248
 249 /**
 250  * Générer l'url des images de l'aide
 251  *
 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 )`
 256  * @return string
 257  *     URL
 258  */
 259 function generer_url_aide_img($args) {
 260         return generer_url_action('aide_img', $args, false, true);
 261 }
 262
 263
 264 /** Les aides non mises à jour ont un vieux Path à remplacer
 265  *
 266  * @note (mais ce serait bien de le faire en SQL une bonne fois)
 267  */
 268 define('_REPLACE_IMG_PACK', "@(<img([^<>]* +)?\s*src=['\"])img_pack\/@ims");
 269
 270 /**
 271  * Remplacer les URL des images par l'URL du gestionnaire de cache local
 272  *
 273  * @uses _REPLACE_IMG_PACK
 274  * @uses _DIR_IMG_PACK
 275  *
 276  * @param string $contenu
 277  * @param string $server
 278  * @return string
 279  */
 280 function aide_fixe_img($contenu, $server) {
 281         $html = '';
 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]));
 288         }
 289         $html .= $contenu;
 290
 291         // traiter les vieilles doc
 292         return preg_replace(_REPLACE_IMG_PACK, "\\1" . _DIR_IMG_PACK, $html);
 293 }
 294
 295
 296 /**
 297  * Extraire une section d'aide
 298  *
 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.
 301  *
 302  * @param string $aide
 303  *            Titre de la section d'aide
 304  * @param string $contenu
 305  * @param int $prof
 306  *            Dans quel hn doit-on mettre le titre de section
 307  * @return string
 308  */
 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";
 313
 314         if (preg_match($r, $contenu, $m)) {
 315                 return $m[1];
 316         }
 317
 318 #       spip_log("aide inconnue $r dans " . substr($contenu, 0, 150));
 319         return '';
 320 }