[SPIP][PLUGINS] v3.0-->v3.2
[lhc/web/www.git] / www / ecrire / exec / valider_xml.php
index b6a8fbe..a74a98b 100644 (file)
@@ -3,30 +3,44 @@
 /***************************************************************************\
  *  SPIP, Systeme de publication pour l'internet                           *
  *                                                                         *
- *  Copyright (c) 2001-2016                                                *
+ *  Copyright (c) 2001-2017                                                *
  *  Arnaud Martin, Antoine Pitrou, Philippe Riviere, Emmanuel Saint-James  *
  *                                                                         *
  *  Ce programme est un logiciel libre distribue sous licence GNU/GPL.     *
  *  Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne.   *
 \***************************************************************************/
 
-if (!defined('_ECRIRE_INC_VERSION')) return;
+/**
+ * Gestion de la validation XML selon une DTD
+ *
+ * @package SPIP\Core\Valider_XML
+ */
+
+if (!defined('_ECRIRE_INC_VERSION')) {
+       return;
+}
 include_spip('inc/presentation');
 include_spip('public/debusquer');
 
-// Script de validation XML selon une DTD
-// l'argument var_url peut indiquer un fichier ou un repertoire
-// l'argument ext peut valoir "php" ou "html"
-// Si "php", le script est execute et la page valide
-// Si "html", on suppose que c'est un squelette dont on devine les args
-// en cherchant les occurrences de Pile[0].
-// Exemples:
-// ecrire?exec=valider_xml&var_url=exec&ext=php pour tester l'espace prive
-// ecrire?exec=valider_xml&var_url=../squelettes-dist&ext=html pour le public
-
-// http://doc.spip.org/@exec_valider_xml_dist
-function exec_valider_xml_dist()
-{
+
+/**
+ * Page d'affichage des résultats de validation XML selon une DTD
+ *
+ * - l'argument var_url peut indiquer un fichier ou un repertoire
+ * - l'argument ext peut valoir "php" ou "html"
+ * -- Si "php", le script est execute et la page valide
+ * -- Si "html", on suppose que c'est un squelette dont on devine les args
+ *    en cherchant les occurrences de Pile[0].
+ *
+ * @example
+ *     ```
+ *     ecrire?exec=valider_xml&var_url=exec&ext=php pour tester l'espace prive
+ *     ecrire?exec=valider_xml&var_url=../squelettes-dist&ext=html pour le public
+ *     ```
+ *
+ * @uses valider_xml_ok()
+ **/
+function exec_valider_xml_dist() {
        if (!autoriser('webmestre')) {
                include_spip('inc/minipres');
                echo minipres();
@@ -72,11 +86,27 @@ function exec_valider_xml_dist()
        }
 }
 
-// http://doc.spip.org/@valider_xml_ok
+/**
+ * Vérifie le formatage d'un xml
+ *
+ * @see valider_resultats()
+ * @see valider_dir()
+ * @see valider_pseudo_url()
+ *
+ * @param string $url
+ * @param string $req_ext
+ * @param int $limit
+ * @param array|bool $rec
+ * @param bool $process
+ *
+ **/
 function valider_xml_ok($url, $req_ext, $limit, $rec, $process = true) {
        $url = urldecode($url);
        $rec = !$rec ? false : array();
-       if (!$limit) $limit = 200;
+       $res = '';
+       if (!$limit) {
+               $limit = 200;
+       }
        $titre = _T('analyse_xml');
        if (!$url) {
                $url_aff = '';
@@ -85,17 +115,19 @@ function valider_xml_ok($url, $req_ext, $limit, $rec, $process = true) {
                include_spip('inc/distant');
 
                if (is_dir($url)) {
-                       $dir = (substr($url,-1,1) === '/') ? $url : "$url/";
+                       $dir = (substr($url, -1, 1) === '/') ? $url : "$url/";
                        $ext = !preg_match('/^[.*\w]+$/', $req_ext) ? 'php' : $req_ext;
-                       $files = preg_files($dir,  "$ext$", $limit, $rec);
-                       if (!$files AND $ext!=='html') {
+                       $files = preg_files($dir, "$ext$", $limit, $rec);
+                       if (!$files and $ext !== 'html') {
                                $files = preg_files($dir, 'html$', $limit, $rec);
-                               if ($files) $ext = 'html';
+                               if ($files) {
+                                       $ext = 'html';
+                               }
                        }
                        if ($files) {
                                $res = valider_dir($files, $ext, $url);
                                list($err, $res) = valider_resultats($res, $ext === 'html');
-                               $err = ' (' . $err . '/' . count($files) .')';
+                               $err = ' (' . $err . '/' . count($files) . ')';
                        } else {
                                $res = _T('texte_vide');
                                $err = '';
@@ -103,21 +135,25 @@ function valider_xml_ok($url, $req_ext, $limit, $rec, $process = true) {
                        $bandeau = $dir . '*' . $ext . $err;
                } else {
                        if (preg_match('@^((?:[.]/)?[^?]*)[?]([0-9a-z_]+)=([^&]*)(.*)$@', $url, $r)) {
-                         list(,$server, $dir, $script, $args) = $r;
-                               if (((!$server) OR ($server == './') 
-                                   OR strpos($server, url_de_base()) === 0)
-                                   AND is_dir($dir)) {
-                                 $url = $script;
-                                 // Pour quand le validateur saura simuler 
-                                 // une query-string...
-                                 // $args = preg_split('/&(amp;)?[a-z0-9_]+=/', $args);
-                                 $args = true;
+                               list(, $server, $dir, $script, $args) = $r;
+                               if (((!$server) or ($server == './')
+                                               or strpos($server, url_de_base()) === 0)
+                                       and is_dir($dir)
+                               ) {
+                                       $url = $script;
+                                       // Pour quand le validateur saura simuler
+                                       // une query-string...
+                                       // $args = preg_split('/&(amp;)?[a-z0-9_]+=/', $args);
+                                       $args = true;
                                }
-                       } else { $dir = 'exec'; $script = $url; $args = true;}
+                       } else {
+                               $dir = 'exec';
+                               $script = $url;
+                               $args = true;
+                       }
 
                        $url_aff = entites_html($url);
                        $bandeau = "";
-                       $res = "";
                        if ($process) {
                                $transformer_xml = charger_fonction('valider', 'xml');
                                if (preg_match(',^[a-z][0-9a-z_]*$,i', $url)) {
@@ -143,7 +179,7 @@ function valider_xml_ok($url, $req_ext, $limit, $rec, $process = true) {
        $commencer_page = charger_fonction('commencer_page', 'inc');
        $debut = $commencer_page($titre);
        $jq = http_script("", 'jquery.js');
-       
+
 
        echo str_replace('<head>', "<head>$jq", $debut);
        include_spip('inc/securiser_action');
@@ -162,32 +198,42 @@ function valider_xml_ok($url, $req_ext, $limit, $rec, $process = true) {
        $self = "<a href='$self'>$self</a>";
 
        echo "<h1 class='grostitre'>", $titre, " <small>$bandeau</small>", '</h1>',
-         "<div style='text-align: center'>", $texte, "</div>",
-         $res,
-         "<br /><br /><p><small>$self</small></p>",
-         fin_page();
+       "<div style='text-align: center'>", $texte, "</div>",
+       $res,
+       "<br /><br /><p><small>$self</small></p>",
+       fin_page();
 }
 
-// http://doc.spip.org/@valider_resultats
-function valider_resultats($res, $mode)
-{
+/**
+ *
+ * Vérifie la conformité du xml, élément par élément.
+ *
+ * @param array $res
+ * @param string $mode
+ * @return array
+ **/
+function valider_resultats($res, $mode) {
        include_spip('inc/securiser_action');
        $i = $j = 0;
        $table = '';
        rsort($res);
-       foreach($res as $l) {
+       foreach ($res as $l) {
                $i++;
-               $class = 'row_'.alterner($i, 'even', 'odd');
+               $class = 'row_' . alterner($i, 'even', 'odd');
                list($nb, $texte, $erreurs, $script, $appel, $temps) = $l;
                if ($texte < 0) {
-                       $texte = (0- $texte);
+                       $texte = (0 - $texte);
                        $color = ";color: red";
-               } else  {$color = '';}
+               } else {
+                       $color = '';
+               }
 
-               $err = (!intval($nb)) ? '' : 
-                 ($erreurs[0][0] . ' ' . _T('ligne') . ' ' .
-                  $erreurs[0][1] .($nb==1? '': '  ...'));
-               if ($err) $j++;
+               $err = (!intval($nb)) ? '' :
+                       ($erreurs[0][0] . ' ' . _T('ligne') . ' ' .
+                               $erreurs[0][1] . ($nb == 1 ? '' : '  ...'));
+               if ($err) {
+                       $j++;
+               }
                if ($mode) {
                        $h = $appel . '&var_mode=debug&var_mode_affiche=validation';
                }
@@ -197,45 +243,63 @@ function valider_resultats($res, $mode)
                }
 
                $table .= "<tr class='$class'>"
-               . "<td style='text-align: right'>$nb</td>"
-               . "<td style='text-align: right$color'>$texte</td>"
-               . "<td style='text-align: right'>$temps</td>"
-               . "<td style='text-align: left'>$err</td>"
-               . "<td>$script</td>"
-               . "<td><a href='$h'>$appel</a></td>";
+                       . "<td style='text-align: right'>$nb</td>"
+                       . "<td style='text-align: right$color'>$texte</td>"
+                       . "<td style='text-align: right'>$temps</td>"
+                       . "<td style='text-align: left'>$err</td>"
+                       . "<td>$script</td>"
+                       . "<td><a href='$h'>$appel</a></td>";
        }
-       return array($j, "<table class='spip'>"
-         . "<tr><th>" 
-         . _T('erreur_texte')
-         . "</th><th>" 
-         . _T('taille_octets', array('taille' => ' '))
-         . "</th><th>"
-         . _T('zbug_profile', array('time' =>''))
-         . "</th><th>"
-         . _T('message')
-         . "</th><th>Page</th><th>args"
-         . "</th></tr>"
-         . $table
-                    . "</table>");
+
+       return array(
+               $j,
+               "<table class='spip'>"
+               . "<tr><th>"
+               . _T('erreur_texte')
+               . "</th><th>"
+               . _T('taille_octets', array('taille' => ' '))
+               . "</th><th>"
+               . _T('zbug_profile', array('time' => ''))
+               . "</th><th>"
+               . _T('message')
+               . "</th><th>Page</th><th>args"
+               . "</th></tr>"
+               . $table
+               . "</table>"
+       );
 }
 
-// http://doc.spip.org/@valider_script
-function valider_script($transformer_xml, $script, $dir, $ext)
-{
+/**
+ * Valide l'existence d'un script ou d'une fonction
+ *
+ * @uses valider_pseudo_url()
+ *
+ * @param string $transformer_xml
+ * @param string $script
+ *  Nom de la fonction à charger
+ * @param string $dir
+ *  Nom du répertoire qui contiendrait le fichier et/ou la fonction à chercher/charger.
+ * @param string $ext
+ *  Nom de l'extension du fichier contenant la fonction à vérifier.
+ * @return array
+ */
+function valider_script($transformer_xml, $script, $dir, $ext) {
        $script = basename($script, '.php');
        $dir = basename($dir);
        $f = charger_fonction($script, $dir, true);
-// ne pas se controler soi-meme ni l'index du repertoire ni un fichier annexe
-       if ($script == _request('exec') OR $script=='index' OR !$f)
-               return array('/', 0, '', $script,''); 
+
+       // ne pas se controler soi-meme ni l'index du repertoire ni un fichier annexe
+       if ($script == _request('exec') or $script == 'index' or !$f) {
+               return array('/', 0, '', $script, '');
+       }
 
        $val = $transformer_xml($f, true);
        $appel = '';
-       
+
        // s'il y a l'attribut minipres, le test est non significatif
        // le script necessite peut-etre des arguments, on lui en donne,
        // en appelant la fonction _args associee si elle existe
-       // Si ca ne marche toujours pas, les arguments n'étaient pas bons
+       // Si ca ne marche toujours pas, les arguments n'étaient pas bons
        // ou c'est une authentification pour action d'administration;
        // tant pis, on signale le cas par un resultat negatif
 
@@ -248,33 +312,54 @@ function valider_script($transformer_xml, $script, $dir, $ext)
                        $appel = 'id_article=1&type=id_article&id=1';
                        if (strpos($val->page, "id='minipres'")) {
                                $res = 0 - strlen($val->page);
-                       } else $res = strlen($val->page);
+                       } else {
+                               $res = strlen($val->page);
+                       }
                }
-       } else $res = strlen($val->page);
+       } else {
+               $res = strlen($val->page);
+       }
 
        $appel = valider_pseudo_url($dir, $script, $appel);
        $err = $val->err;
+
        return array(count($err), $res, $err, $script, $appel);
 }
 
-// http://doc.spip.org/@valider_pseudo_url
-function valider_pseudo_url($dir, $script, $args='')
-{
-       return  ($dir == 'exec')
-       ? generer_url_ecrire($script, $args, false, true)
-       : ("./?$dir=$script" . ($args ? "&$args" : ''));
+/**
+ * Construire la bonne URL selon l'endroit où on se trouve.
+ *
+ * @param string $dir
+ *     Par défaut, on vérifie si on est sur une page `?exec=XX`
+ * @param string $script
+ * @param string $args [description]
+ * @return string
+ */
+function valider_pseudo_url($dir, $script, $args = '') {
+       return ($dir == 'exec')
+               ? generer_url_ecrire($script, $args, false, true)
+               : ("./?$dir=$script" . ($args ? "&$args" : ''));
 }
 
-// On essaye de valider un texte meme sans Doctype
-// a moins qu'un Content-Type dise clairement que ce n'est pas du XML
-// http://doc.spip.org/@valider_skel
-function valider_skel($transformer_xml, $file, $dir, $ext)
-{
-       if (!lire_fichier ($file, $text)) return array('/', '/', $file,''); 
+/**
+ * Essayer de valider un texte même sans Doctype
+ * à moins qu'un Content-Type dise clairement que ce n'est pas du XML
+ *
+ * @param string $transformer_xml
+ * @param string $file
+ * @param string $dir
+ * @param string $ext
+ * @return array
+ */
+function valider_skel($transformer_xml, $file, $dir, $ext) {
+       if (!lire_fichier($file, $text)) {
+               return array('/', '/', $file, '');
+       }
        if (!strpos($text, 'DOCTYPE')) {
                preg_match(",Content[-]Type: *\w+/(\S)+,", $text, $r);
-               if ($r[1] === 'css' OR $r[1] === 'plain')
-                       return array('/', 'DOCTYPE?', $file,'');
+               if ($r[1] === 'css' or $r[1] === 'plain') {
+                       return array('/', 'DOCTYPE?', $file, '');
+               }
        }
 
        if ($ext != 'html') {
@@ -283,79 +368,106 @@ function valider_skel($transformer_xml, $file, $dir, $ext)
                $url = url_de_base() . _DIR_RESTREINT_ABS . $file;
                $script = $file;
        } else {
-               $script = basename($file,'.html');
+               $script = basename($file, '.html');
                // pas de validation solitaire pour les squelettes internes, a revoir.
                if (substr_count($dir, '/') <= 1) {
                        $url = generer_url_public($script, $contexte);
-               } else  $url = '';
+               } else {
+                       $url = '';
+               }
                $composer = charger_fonction('composer', 'public');
                list($skel_nom, $skel_code) = $composer($text, 'html', 'html', $file);
 
-               spip_log("compilation de $file en " . strlen($skel_code) .  " octets de nom $skel_nom");
-               if (!$skel_nom) return array('/', '/', $file,''); 
+               spip_log("compilation de $file en " . strlen($skel_code) . " octets de nom $skel_nom");
+               if (!$skel_nom) {
+                       return array('/', '/', $file, '');
+               }
                $contexte = valider_contexte($skel_code, $file);
-               $page = $skel_nom(array('cache'=>''), array($contexte));
+               $page = $skel_nom(array('cache' => ''), array($contexte));
        }
        $res = $transformer_xml($page['texte']);
+
        return array(count($res->err), strlen($res->page), $res->err, $script, $url);
 }
 
-// Analyser le code pour construire un contexte plausible complet
-// i.e. ce qui est fourni par $Pile[0]
-// en eliminant les exceptions venant surtout des Inclure
-// Il faudrait trouver une typologie pour generer un contexte parfait:
-// actuellement ca produit parfois des erreurs SQL a l'appel de $skel_nom
-// http://doc.spip.org/@valider_contexte
-function valider_contexte($code, $file)
-{
+/**
+ * Analyser le code pour construire un contexte plausible complet
+ *
+ * i.e. ce qui est fourni par `$Pile[0]`
+ * en éliminant les exceptions venant surtout des Inclure
+ *
+ * Il faudrait trouver une typologie pour générer un contexte parfait:
+ * actuellement ça produit parfois des erreurs SQL à l'appel de $skel_nom
+ *
+ * @see valider_skel()
+ * @param string $code
+ * @param string $file
+ * @return array
+ */
+function valider_contexte($code, $file) {
        static $exceptions = array('action', 'doublons', 'lang');
        preg_match_all('/(\S*)[$]Pile[[]0[]][[].(\w+).[]](\S*)/', $code, $r, PREG_SET_ORDER);
        $args = array();
        // evacuer les repetitions et les faux parametres
-       foreach($r as $v) {
-               list(,$f, $nom, $suite) = $v;
+       foreach ($r as $v) {
+               list(, $f, $nom, $suite) = $v;
                if (!in_array($nom, $exceptions)
-               AND (!isset($args[$nom]) OR !$args[$nom]))
+                       and (!isset($args[$nom]) or !$args[$nom])
+               ) {
                        $args[$nom] = ((strpos($f, 'sql_quote') !== false)
-                               AND strpos($suite, "'int'") !==false);
+                               and strpos($suite, "'int'") !== false);
+               }
        }
-       $contexte= array(); // etudier l'ajout de:
+       $contexte = array(); // etudier l'ajout de:
        // 'lang' => $GLOBALS['spip_lang'],
        // 'date' => date('Y-m-d H:i:s'));
        foreach ($args as $nom => $f) {
-               if (!$f)
-                 $val = 'id_article';
-               else {
-                 // on suppose que arg numerique => primary-key d'une table
-                 // chercher laquelle et prendre un numero existant
-                 $val = 0;
-                 $type = (strpos($nom, 'id_') === 0)  ? substr($nom,3) : $nom;
-                 $trouver_table = charger_fonction('trouver_table', 'base');
-                 $table = $trouver_table(table_objet_sql($type));
-                 if ($table)
-                   $val = @sql_getfetsel($nom, $table['table'], '', '','',"0,1");
-                   // porte de sortie si ca marche pas, 
-                 if (!$val) $val = 1; 
+               if (!$f) {
+                       $val = 'id_article';
+               } else {
+                       // on suppose que arg numerique => primary-key d'une table
+                       // chercher laquelle et prendre un numero existant
+                       $val = 0;
+                       $type = (strpos($nom, 'id_') === 0) ? substr($nom, 3) : $nom;
+                       $trouver_table = charger_fonction('trouver_table', 'base');
+                       $table = $trouver_table(table_objet_sql($type));
+                       if ($table) {
+                               $val = @sql_getfetsel($nom, $table['table'], '', '', '', "0,1");
+                       }
+                       // porte de sortie si ca marche pas,
+                       if (!$val) {
+                               $val = 1;
+                       }
                }
-               $contexte[$nom] =  $val;
+               $contexte[$nom] = $val;
        }
+
        return $contexte;
 }
 
-// http://doc.spip.org/@valider_dir
-function valider_dir($files, $ext, $dir)
-{
+/**
+ * Valide la conformité XML d'une liste de fichiers dans un répertoire
+ *
+ * @param array $files
+ *     Liste des fichiers
+ * @param string $ext
+ *     Extension des fichiers
+ * @param string $dir
+ *     Chemin du répertoire
+ * @return array
+ **/
+function valider_dir($files, $ext, $dir) {
        $res = array();
        $transformer_xml = charger_fonction('valider', 'xml');
-       $valideur = $ext=='php' ? 'valider_script' : 'valider_skel' ;
-       foreach($files as $f) {
+       $valideur = $ext == 'php' ? 'valider_script' : 'valider_skel';
+       foreach ($files as $f) {
                spip_timer($f);
                $val = $valideur($transformer_xml, $f, $dir, $ext);
-               $n = spip_timer($f); 
-               $val[]= $n;
+               $n = spip_timer($f);
+               $val[] = $n;
                spip_log("validation de $f en $n secondes");
-               $res[]= $val;
+               $res[] = $val;
        }
+
        return $res;
 }
-?>