www/ecrire/inc/aider.php

   1 <?php
   2
   3 /***************************************************************************\
   4  *  SPIP, Systeme de publication pour l'internet                           *
   5  *                                                                         *
   6  *  Copyright (c) 2001-2012                                                *
   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 if (!defined('_ECRIRE_INC_VERSION')) return;
  14
  15 include_spip('inc/filtres');
  16
  17 // L'aide en ligne de SPIP est disponible sous forme d'articles de www.spip.net
  18 // qui ont des reperes nommes arrtitre, artdesc etc.
  19 // La fonction inc_aider(_dist) recoit soit ces reperes,
  20 // soit le nom du champ de saisie, le nom du squelette le contenant et enfin
  21 // l'environnement d'execution du squelette (inutilise pour le moment).
  22 // Le tableau ci-dessous donne le repere correspondant a ces informations.
  23
  24 $GLOBALS['aider_index'] = array(
  25         'editer_article.html' => array (
  26                 'surtitre' => 'arttitre',
  27                 'titre' => 'arttitre',
  28                 'soustitre' => 'arttitre',
  29                 'id_parent' => 'artrub',
  30                 'descriptif' => 'artdesc',
  31                 'virtuel' => 'artvirt',
  32                 'chapo' => 'arttitre',
  33                 'text_area' => 'arttexte'),
  34
  35         'editer_breve.html' => array(
  36                 'id_parent' => 'brevesrub',
  37                 'lien_titre' => 'breveslien',
  38                 'statut' => 'brevesstatut'),
  39
  40         'editer_groupe_mot.html' => array(
  41                 'titre' => 'motsgroupes'),
  42
  43         'editer_mot.html' => array(
  44                 'titre' => 'mots',
  45                 'id_groupe' => 'motsgroupes'),
  46
  47         'editer_rubrique.html' => array(
  48                 'titre' => 'arttitre',
  49                 'id_parent' => 'rubrub',
  50                 'text_area' => 'raccourcis')
  51
  52                                 );
  53
  54
  55
  56 /**
  57  * Generer un lien d'aide (icone + lien)
  58  *
  59  * @param string $aide
  60  *              cle d'identification de l'aide souhaitee
  61  * @param strink $skel
  62  *              Nom du squelette qui appelle ce bouton d'aide
  63  * @param array $env
  64  *              Environnement du squelette
  65  * @param bool $aide_spip_directe
  66  *              false : Le lien genere est relatif a notre site (par defaut)
  67  *              true : Le lien est realise sur spip.net/aide/ directement ...
  68  * @return
  69 **/
  70 function inc_aider_dist($aide='', $skel='', $env=array(), $aide_spip_directe = false) {
  71         global $spip_lang, $aider_index;
  72
  73         if (($skel = basename($skel))
  74         AND isset($aider_index[$skel])
  75         AND isset($aider_index[$skel][$aide]))
  76                 $aide = $aider_index[$skel][$aide];
  77
  78         if ($aide_spip_directe) {
  79                 // on suppose que spip.net est le premier present
  80                 // dans la liste des serveurs. C'est forcement le cas
  81                 // a l'installation tout du moins
  82                 $help_server = $GLOBALS['help_server'];
  83                 $url = array_shift($help_server) . '/';
  84                 $url = parametre_url($url, 'exec', 'aide');
  85                 $url = parametre_url($url, 'aide', $aide);
  86                 $url = parametre_url($url, 'var_lang', $spip_lang);
  87         } else {
  88                 $args = "aide=$aide&var_lang=$spip_lang";
  89                 $url = generer_url_ecrire("aide", $args);
  90         }
  91
  92         return aider_icone($url);
  93 }
  94
  95 function aider_icone($url)
  96 {
  97         global $spip_lang, $spip_lang_rtl;
  98
  99         $t = _T('titre_image_aide');
 100
 101         return "\n&nbsp;&nbsp;<a class='aide popin'\nhref='"
 102         .  $url
 103         . "' target='_blank'>"
 104         . http_img_pack("aide".aide_lang_dir($spip_lang,$spip_lang_rtl)."-16.png",
 105                         _T('info_image_aide'),
 106                         " title=\"$t\" class='aide'")
 107         . "</a>";
 108 }
 109
 110 // en hebreu le ? ne doit pas etre inverse
 111 // http://doc.spip.org/@aide_lang_dir
 112 function aide_lang_dir($spip_lang,$spip_lang_rtl) {
 113         return ($spip_lang<>'he') ? $spip_lang_rtl : '';
 114 }
 115
 116 // Les sections d'un fichier aide sont reperees ainsi:
 117 define('_SECTIONS_AIDE', ',<h([12])(?:\s+class="spip")?'. '>([^/]+?)(?:/(.+?))?</h\1>,ism');
 118
 119 function aide_fichier($path, $help_server) {
 120
 121         $md5 = md5(serialize($help_server));
 122         $fichier_aide = _DIR_AIDE . substr($md5,0,16) . "-" . $path;
 123         $lastm = @filemtime($fichier_aide);
 124         $lastversion = @filemtime(_DIR_RESTREINT . 'inc_version.php');
 125         $here = @(is_readable($fichier_aide) AND ($lastm >= $lastversion));
 126         $contenu = '';
 127
 128         if ($here) {
 129                 lire_fichier($fichier_aide, $contenu);
 130                 return array($contenu, $lastm);
 131         }
 132
 133         // mettre en cache (tant pis si echec)
 134         sous_repertoire(_DIR_AIDE,'','',true);
 135         $contenu = array();
 136         include_spip('inc/distant');
 137         foreach ($help_server as $k => $server) {
 138                 // Remplacer les liens aux images par leur gestionnaire de cache
 139                 $url = "$server/$path";
 140                 $local = _DIR_AIDE.substr(md5($url),0,8)."-".preg_replace(",[^\w.]+,i","_",$url);
 141                 $local = _DIR_RACINE . copie_locale($url, 'modif', $local);
 142
 143                 lire_fichier($local,$page);
 144                 $page = aide_fixe_img($page,$server);
 145                 // les liens internes ne doivent pas etre deguises en externes
 146                 $url = parse_url($url);
 147                 $re = '@(<a\b[^>]*\s+href=["\'])' .
 148                   '(?:' . $url['scheme'] . '://' . $url['host'] . ')?' .
 149                   $url['path'] . '([^"\']*)@ims';
 150                 $page = preg_replace($re,'\\1\\2', $page);
 151
 152                 preg_match_all(_SECTIONS_AIDE, $page, $sections, PREG_SET_ORDER);
 153                 // Fusionner les aides ayant meme nom de section
 154                 $vus = array();
 155                 foreach ($sections as $section) {
 156                         list($tout,$prof, $sujet,) = $section;
 157                         if (in_array($sujet, $vus)) continue;
 158                         $corps = aide_section($sujet, $page, $prof);
 159                         foreach ($contenu as $k => $s) {
 160                           if ($sujet == $k) {
 161                             // Section deja vue qu'il faut completer
 162                             // Si le complement a des sous-sections,
 163                             // ne pas en tenir compte quand on les rencontrera
 164                             // lors des prochains passages dans la boucle
 165                             preg_match_all(_SECTIONS_AIDE, $corps, $s, PREG_PATTERN_ORDER);
 166                             if ($s) {$vus = array_merge($vus, $s[2]);}
 167                             $contenu[$k] .= $corps;
 168                             $corps = '';
 169                             break;
 170                           }
 171                         }
 172                         // Si totalement nouveau, inserer le titre
 173                         // mais pas le corps s'il contient des sous-sections:
 174                         // elles vont venir dans les passages suivants
 175                         if ($corps) {
 176                           $corps = aide_section($sujet, $page);
 177                           $contenu[$sujet] = $tout . "\n" . $corps;
 178                         }
 179                 }
 180         }
 181
 182         $contenu = '<div>' . join('',$contenu) . '</div>';
 183
 184         // Renvoyer les liens vraiment externes dans une autre fenetre
 185         $contenu = preg_replace('@<a href="(http://[^"]+)"([^>]*)>@',
 186                                 '<a href="\\1"\\2 target="_blank">',
 187                                 $contenu);
 188
 189         // Correction typo dans la langue demandee
 190         #changer_typo($lang_aide);
 191         $contenu = '<body>' . $contenu . '</body>';
 192
 193         if (strlen($contenu) <= 100) return array(false, false);
 194         ecrire_fichier ($fichier_aide, $contenu);
 195         return array($contenu, time());
 196 }
 197
 198 function generer_url_aide_img($args){
 199         return generer_url_action('aide_img', $args, false, true);
 200 }
 201
 202
 203 // Les aides non mises a jour ont un vieux Path a remplacer
 204 // (mais ce serait bien de le faire en SQL une bonne fois)
 205 define('_REPLACE_IMG_PACK', "@(<img([^<>]* +)?\s*src=['\"])img_pack\/@ims");
 206
 207 // Remplacer les URL des images par l'URL du gestionnaire de cache local
 208 function aide_fixe_img($contenu, $server){
 209         $html = "";
 210         $re = "@(<img([^<>]* +)?\s*src=['\"])((AIDE|IMG|local)/([-_a-zA-Z0-9]*/?)([^'\"<>]*))@imsS";
 211         while (preg_match($re, $contenu, $r)) {
 212                 $p = strpos($contenu, $r[0]);
 213                 $i = $server . '/' . $r[3];
 214                 $html .= substr($contenu, 0, $p) .  $r[1] . $i;
 215                 $contenu = substr($contenu, $p + strlen($r[0]));
 216         }
 217         $html .= $contenu;
 218
 219         // traiter les vieilles doc
 220         return  preg_replace(_REPLACE_IMG_PACK,"\\1"._DIR_IMG_PACK, $html);
 221 }
 222
 223
 224 // Extraire la seule section demandee,
 225 // qui commence par son nom entouree d'une balise h2
 226 // et se termine par la prochaine balise h2 ou h1 ou le /body final.
 227
 228 function aide_section($aide, $contenu, $prof=2){
 229         $maxprof = ($prof >=2) ? "12" : "1";
 230         $r = "@<h$prof" . '(?: class="spip")?' . '>\s*' . $aide
 231           ."\s*(?:/.+?)?</h$prof>(.*?)<(?:(?:h[$maxprof])|/body)@ism";
 232
 233         if (preg_match($r, $contenu, $m))
 234           return $m[1];
 235 #       spip_log("aide inconnue $r dans " . substr($contenu, 0, 150));
 236         return '';
 237 }
 238
 239
 240 ?>