3 /***************************************************************************\
4 * SPIP, Systeme de publication pour l'internet *
6 * Copyright (c) 2001-2014 *
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 \***************************************************************************/
13 if (!defined('_ECRIRE_INC_VERSION')) return;
15 include_spip('public/decompiler');
17 // Le debusqueur repose sur la globale debug_objets,
18 // affectee par le compilateur et le code produit par celui-ci.
19 // Cette globale est un tableau avec comme index:
20 // 'boucle' : tableau des arbres de syntaxe abstraite des boucles
21 // 'contexte' : tableau des contextes des squelettes assembles
22 // 'principal' : nom du squelette principal
23 // 'profile' : tableau des temps de calcul des squelettes
24 // 'resultat' : tableau des resultats envoyes (tableau de tableaux pour les boucles)
25 // 'sequence' : tableau de sous-tableaux resultat/source/numero-de-ligne
26 // 'sourcefile' : tableau des noms des squelettes inclus
27 // 'squelette' : tableau des sources de squelettes
28 // 'validation' : resultat final a passer a l'analyseur XML au besoin
31 * Definir le nombre maximal d'erreur possible dans les squelettes
32 * au dela, l'affichage est arrete et les erreurs sont affichees.
33 * Definir a zero permet de ne jamais bloquer,
34 * mais il faut etre tres prudent avec cette utilisation
36 * Sert pour les tests unitaires
38 define('_DEBUG_MAX_SQUELETTE_ERREURS', 9);
41 // Point d'entree general,
42 // pour les appels involontaires ($message non vide => erreur)
43 // et volontaires (var_mode et var_profile)
44 // Si pas d'autorisation, les erreurs ne sont pas affichees
45 // (mais seront dans les logs)
46 // Si l'erreur vient de SPIP, en parler sur spip@rezo.net
48 function public_debusquer_dist($message='', $lieu='') {
49 global $visiteur_session;
51 static $tableau_des_erreurs = array();
53 // Erreur ou appel final ?
55 $message = debusquer_compose_message($message);
56 $tableau_des_erreurs[] = array($message, $lieu);
57 set_request('var_mode', 'debug');
58 $GLOBALS['bouton_admin_debug'] = true;
59 // Permettre a la compil de continuer
60 if (is_object($lieu) AND !$lieu->code
)
62 // forcer l'appel au debusqueur en cas de boucles infernales
63 $urgence = (_DEBUG_MAX_SQUELETTE_ERREURS
AND count($tableau_des_erreurs) > _DEBUG_MAX_SQUELETTE_ERREURS
);
64 if (!$urgence) return;
66 if (empty($debug_objets['principal']))
67 $debug_objets['principal'] = $GLOBALS['fond'];
69 include_spip('inc/autoriser');
70 if (!autoriser('debug')) return;
71 include_spip('inc/headers');
72 include_spip('inc/filtres');
74 // en cas de squelette inclus, virer le code de l'incluant:
75 // - il contient souvent une Div restreignant la largeur a 3 fois rien
76 // - ca fait 2 headers !
77 // sauf si l'on se trouve deja dans un flux compresse (plugin compresseur
81 !in_array('ob_gzhandler', ob_get_status())) {
85 lang_select($visiteur_session['lang']);
86 $fonc = _request('var_mode_objet');
87 $mode = _request('var_mode_affiche');
88 $self = str_replace("\\'", ''', self());
89 $self = parametre_url($self,'var_mode', 'debug');
91 $res = debusquer_bandeau($tableau_des_erreurs)
93 . debusquer_squelette($fonc, $mode, $self);
95 if (!_DIR_RESTREINT
OR headers_sent()) return $res;
96 if ($tableau_des_erreurs) http_status(503);
99 if (isset($_GET['var_profile'])) {
100 $titre = parametre_url($GLOBALS['REQUEST_URI'], 'var_profile', '');
101 $titre = parametre_url($titre, 'var_mode', '');
103 if (!$fonc) $fonc = $debug_objets['principal'];
104 $titre = !$mode ?
$fonc : ($mode . ' ' . $debug_objets['sourcefile'][$fonc]);
106 if ($message===false) {
108 return debusquer_entete($titre, $res);
111 echo debusquer_entete($titre, $res);
115 function debusquer_compose_message($msg)
117 if (is_array($msg)) {
118 if (!is_numeric($msg[0]))
119 // message avec argument: instancier
120 $msg = _T($msg[0], $msg[1], 'spip-debug-arg');
122 // message SQL: interpreter
123 $msg = debusquer_requete($msg);
125 spip_log("Debug: " . $msg . " (" . $GLOBALS['fond'] .")" );
129 function debusquer_bandeau($erreurs) {
131 if (!empty($erreurs)) {
132 $n = count($erreurs) . ' ' . _T('zbug_erreur_squelette');
133 return debusquer_navigation($erreurs, $n);
134 } elseif (!empty($GLOBALS['tableau_des_temps'])) {
135 include_spip('public/tracer');
136 list($temps, $nav) = chrono_requete($GLOBALS['tableau_des_temps']);
137 return debusquer_navigation($temps, $nav, 'debug-profile');
141 function debusquer_contexte($env) {
143 if (is_array($env_tab = @unserialize
($env))) $env = $env_tab;
145 if (!$env) return '';
147 foreach ($env as $nom => $valeur) {
148 if (is_array($valeur))
149 $valeur = '(' . count($valeur) .' items) [' . join(',', $valeur) . ']';
150 $res .= "\n<tr><td><strong>".nl2br(entites_html($nom))
151 . "</strong></td><td>: ".nl2br(entites_html($valeur))
155 return "<div class='spip-env'><fieldset><legend>#ENV</legend>\n<div><table>$res</table></div></fieldset></div>\n";
158 // Affichage du tableau des erreurs ou des temps de calcul
159 // Cliquer sur les numeros en premiere colonne permet de voir le code
161 function debusquer_navigation($tableau, $caption='', $id='debug-nav') {
163 if (_request('exec')=='valider_xml') return '';
164 $GLOBALS['bouton_admin_debug'] = true;
166 $href = quote_amp(parametre_url($GLOBALS['REQUEST_URI'], 'var_mode', 'debug'));
167 foreach ($tableau as $i => $err) {
168 $boucle = $ligne = $skel = '';
169 list($msg, $lieu) = $err;
170 if (is_object($lieu)) {
171 $ligne = $lieu->ligne
;
172 $boucle = $lieu->id_boucle ?
$lieu->id_boucle
: '';
173 if (isset($lieu->descr
['nom'])) {
174 $nom_code = $lieu->descr
['nom'];
175 $skel = $lieu->descr
['sourcefile'];
176 $h2 = parametre_url($href, 'var_mode_objet', $nom_code);
177 $h3 = parametre_url($h2, 'var_mode_affiche', 'squelette') . '#L' . $ligne;
178 $skel = "<a href='$h3'><b>$skel</b></a>";
180 $h3 = parametre_url($h2.$boucle, 'var_mode_affiche', 'boucle');
181 $boucle = "<a href='$h3'><b>$boucle</b></a>";
187 $res .= "<tr id='req$j'><td style='text-align: right'>"
189 . " </td><td style='text-align: left'>"
191 . "</td><td style='text-align: left'>"
192 . ($skel ?
$skel : " / ")
193 . "</td><td class='spip-debug-arg' style='text-align: left'>"
194 . ($boucle ?
$boucle : " / ")
195 . "</td><td style='text-align: right'>"
201 return "\n<table id='$id'>"
204 ## aide locale courte a ecrire, avec lien vers une grosse page de documentation
205 # aide('erreur_compilation'),
223 // Si une boucle cree des soucis, on peut afficher la requete fautive
224 // avec son code d'erreur
227 function debusquer_requete($message) {
228 list($errno, $msg, $query) = $message;
229 if (preg_match(',err(no|code):?[[:space:]]*([0-9]+),i', $msg, $regs))
233 } else if (($errno == 1030 OR $errno <= 1026)
234 AND preg_match(',[^[:alnum:]]([0-9]+)[^[:alnum:]],', $msg, $regs))
238 if ($errno > 0 AND $errno < 200) {
239 $retour = "<tt><br /><br /><blink>"
240 . _T('info_erreur_systeme', array('errsys'=>$errno))
241 . "</blink><br />\n<b>"
242 . _T('info_erreur_systeme2',
243 array('script' => generer_url_ecrire('admin_repair')))
245 spip_log("Erreur systeme $errno");
246 return array($retour,'');
250 $err = "<b>"._T('avis_erreur_mysql')." $errno</b><br /><tt>\n"
251 . htmlspecialchars($msg)
252 . "\n<br /><span style='color: red'><b>"
253 . htmlspecialchars($query)
254 . "</b></span></tt><br />"
255 ;//. aide('erreur_mysql');
260 // http://doc.spip.org/@trouve_boucle_debug
261 function trouve_boucle_debug($n, $nom, $debut=0, $boucle = "")
263 global $debug_objets;
265 $id = $nom . $boucle;
266 if (is_array($debug_objets['sequence'][$id])) {
267 foreach($debug_objets['sequence'][$id] as $v) {
269 if (!preg_match('/^(.*)(<\?.*\?>)(.*)$/s', $v[0],$r))
270 $y = substr_count($v[0], "\n");
274 $incl = $debug_objets['resultat'][$v[2]];
277 $incl = $debug_objets['squelette'][trouve_squelette_inclus($v[0])];
278 $y = substr_count($incl, "\n")
279 +
substr_count($r[1], "\n")
280 +
substr_count($r[3], "\n");
282 if ($n <= ($y +
$debut)) {
284 return trouve_boucle_debug($n, $nom, $debut, substr($v[1],1));
285 elseif ($v[1][0] == '!') {
286 if ($incl = trouve_squelette_inclus($v[1]))
287 return trouve_boucle_debug($n, $incl, $debut);
289 return array($nom, $boucle, $v[2] -1 +
$n - $debut );
294 return array($nom, $boucle, $n-$debut);
297 // http://doc.spip.org/@trouve_squelette_inclus
298 function trouve_squelette_inclus($script)
300 global $debug_objets;
301 preg_match('/include\(.(.*).php3?.\);/', $script, $reg);
302 // si le script X.php n'est pas ecrire/public.php
303 // on suppose qu'il prend le squelette X.html (pas sur, mais y a pas mieux)
304 if ($reg[1] == 'ecrire/public')
305 // si c'est bien ecrire/public on cherche le param 'fond'
306 if (!preg_match("/'fond' => '([^']*)'/", $script, $reg))
307 // a defaut on cherche le param 'page'
308 if (!preg_match("/'param' => '([^']*)'/", $script, $reg))
310 $incl = $reg[1] . '.' . _EXTENSION_SQUELETTES
. '$';
312 foreach($debug_objets['sourcefile'] as $k => $v) {
313 if (preg_match(",$incl,",$v)) return $k;
318 // http://doc.spip.org/@reference_boucle_debug
319 function reference_boucle_debug($n, $nom, $self)
321 list($skel, $boucle, $ligne) = trouve_boucle_debug($n, $nom);
324 return !$ligne ?
"" :
326 (($nom != $skel) ?
_T('squelette_inclus_ligne') :
327 _T('squelette_ligne')) .
328 " <a href='$self&var_mode_objet=$skel&var_mode_affiche=squelette&var_mode_ligne=$ligne#L$ligne'>$ligne</a>)");
330 $self .= "&var_mode_objet=$skel$boucle&var_mode_affiche=boucle";
332 return !$ligne ?
" (boucle\n<a href='$self#$skel$boucle'>$boucle</a>)" :
333 " (boucle $boucle ligne\n<a href='$self&var_mode_ligne=$ligne#L$ligne'>$ligne</a>)";
337 // affiche un texte avec numero de ligne et ancre.
339 // http://doc.spip.org/@ancre_texte
340 function ancre_texte($texte, $fautifs=array(), $nocpt=false)
342 $var_mode_ligne = _request('var_mode_ligne');
343 if ($var_mode_ligne) $fautifs[]= array($var_mode_ligne);
346 $s = highlight_string(str_replace('</script>','</@@@@@>',$texte),true);
348 $s = str_replace('/@@@@@','/script', // bug de highlight_string
349 str_replace('</font>','</span>',
350 str_replace('<font color="','<span style="color: ', $s)));
351 if (substr($s,0,6) == '<code>') { $s=substr($s,6); $res = '<code>';}
353 $s = preg_replace(',<(\w[^<>]*)>([^<]*)<br />([^<]*)</\1>,',
354 '<\1>\2</\1><br />' . "\n" . '<\1>\3</\1>',
358 $tableau = explode("<br />", $s);
360 $format = "<span style='float:left;display:block;width:50px;height:1px'><a id='L%d' style='background-color: white; visibility: " . ($nocpt ?
'hidden' : 'visible') . ";%s' href='#T%s' title=\"%s\">%0" . strval(@strlen
(count($tableau))). "d</a></span> %s<br />\n";
362 $format10=str_replace('white','lightgrey',$format);
363 $formaterr="color: red;";
367 foreach ($fautifs as $lc)
369 $l = array_shift($lc);
371 } else $flignes[$lc] = $loc;
373 $ancre = md5($texte);
374 foreach ($tableau as $ligne) {
375 if (isset($flignes[$i])) {
376 $ligne = str_replace(' ',' ', $ligne);
377 $indexmesg = $flignes[$i][1];
378 $err = textebrut($flignes[$i][2]);
379 // tentative de pointer sur la colonne fautive;
380 // marche pas car highlight_string rajoute des entites. A revoir.
381 // $m = $flignes[$i][0];
382 // $ligne = substr($ligne, 0, $m-1) .
383 // sprintf($formaterr, substr($ligne,$m));
385 } else {$indexmesg = $ancre; $err= $bg='';}
386 $res .= sprintf((($i%10
) ?
$format :$format10), $i, $bg, $indexmesg, $err, $i, $ligne);
390 return "<div id='T$ancre'>"
391 .'<div onclick="javascript:'
392 . "\$(this).parent().find('a').toggle();"
394 . _T('masquer_colonne')
396 . ($nocpt ?
'' : _T('info_numero_abbreviation'))
401 // l'environnement graphique du debuggueur
403 function debusquer_squelette ($fonc, $mode, $self) {
404 global $debug_objets;
406 if ($mode !== 'validation') {
407 if ($debug_objets['sourcefile']) {
408 $res = "<div id='spip-boucles'>\n"
409 . debusquer_navigation_squelettes($self)
414 if (!empty($GLOBALS['debug_objets'][$mode][$fonc])) {
415 list($legend, $texte, $res2) = debusquer_source($fonc, $mode);
417 } elseif (!empty($debug_objets[$mode][$fonc . 'tout'])) {
418 $legend = _T('zbug_' . $mode);
419 $texte = $debug_objets[$mode][$fonc . 'tout'];
420 $texte = ancre_texte($texte, array('',''));
422 } else return strlen(trim($res))
423 ?
"<div id='spip-debug'>$res</div>"
424 // cas de l'appel sur erreur: montre la page
425 : $GLOBALS['debug_objets']['resultat']['tout'];
427 $valider = charger_fonction('valider', 'xml');
428 $val = $valider($debug_objets['validation'][$fonc . 'tout']);
429 // Si erreur, signaler leur nombre dans le formulaire admin
430 $debug_objets['validation'] = $val[1] ?
count($val[1]):'';
431 list($texte, $err) = emboite_texte($val, $fonc, $self);
433 $err = _T('impossible');
434 elseif ($err === true)
435 $err = _T('correcte');
436 else $err = ": $err";
437 $legend = _T('validation') . ' ' . $err;
440 return !trim($texte) ?
'' : (
441 "<div id='spip-debug'>$res"
442 . "<div id='debug_boucle'><fieldset$id><legend>"
446 . "</fieldset></div>"
450 function debusquer_navigation_squelettes($self)
452 global $debug_objets, $spip_lang_right;
455 $boucles = !empty($debug_objets['boucle']) ?
$debug_objets['boucle']:'';
456 $contexte = $debug_objets['contexte'];
457 $t_skel = _T('squelette');
458 foreach ($debug_objets['sourcefile'] as $nom => $sourcefile) {
459 $self2 = parametre_url($self,'var_mode_objet', $nom);
460 $nav = !$boucles ?
'' : debusquer_navigation_boucles($boucles, $nom, $self);
461 $temps = !isset($debug_objets['profile'][$sourcefile]) ?
'' : _T('zbug_profile', array('time'=>$debug_objets['profile'][$sourcefile]));
463 $res .= "<fieldset><legend>"
467 ." :\n<a href='$self2&var_mode_affiche=squelette#$nom'>"
469 . "</a>\n<a href='$self2&var_mode_affiche=resultat#$nom'>"
470 . _T('zbug_resultat')
471 . "</a>\n<a href='$self2&var_mode_affiche=code#$nom'>"
474 . str_replace('var_mode=debug', 'var_profile=1&var_mode=recalcul', $self)
478 . (!$temps ?
'' : ("\n<span style='display:block;float:$spip_lang_right'>$temps</span><br />"))
479 . debusquer_contexte($contexte[$sourcefile])
480 . (!$nav ?
'' : ("<table width='100%'>\n$nav</table>\n"))
486 function debusquer_navigation_boucles($boucles, $nom_skel, $self)
490 $var_mode_objet = _request('var_mode_objet');
491 foreach ($boucles as $objet => $boucle) {
492 if (substr($objet, 0, strlen($nom_skel)) == $nom_skel) {
494 $nom = $boucle->id_boucle
;
495 $req = $boucle->type_requete
;
496 $crit = decompiler_criteres($boucle->param
, $boucle->criteres
);
497 $self2 = $self . "&var_mode_objet=" . $objet;
499 $res .= "\n<tr style='background-color: " .
500 ($i%2 ?
'#e0e0f0' : '#f8f8ff') .
501 "'><td align='right'>$i</td><td>\n" .
502 "<a class='debug_link_boucle' href='" .
504 "&var_mode_affiche=boucle#$nom_skel$nom'>" .
506 "</a></td><td>\n<a class='debug_link_boucle' href='" .
508 "&var_mode_affiche=resultat#$nom_skel$nom'>" .
509 _T('zbug_resultat') .
510 "</a></td><td>\n<a class='debug_link_resultat' href='" .
512 "&var_mode_affiche=code#$nom_skel$nom'>" .
514 "</a></td><td>\n<a class='debug_link_resultat' href='" .
515 str_replace('var_mode=','var_profile=', $self2) .
519 (($var_mode_objet == $objet) ?
"<b>$nom</b>" : $nom) .
530 function debusquer_source($objet, $affiche)
532 $quoi = $GLOBALS['debug_objets'][$affiche][$objet];
533 $nom = $GLOBALS['debug_objets']['boucle'][$objet]->id_boucle
;
536 if ($affiche == 'resultat') {
538 $req = $GLOBALS['debug_objets']['requete'][$objet];
539 if (function_exists('traite_query')) {
540 $c = strtolower(_request('connect'));
541 $c = $GLOBALS['connexions'][$c ?
$c : 0]['prefixe'];
542 $req = traite_query($req,'', $c);
544 // permettre le copier/coller facile
545 // $res = ancre_texte($req, array(), true);
546 $res = "<div id='T".md5($req)."'>\n<pre>\n" . $req . "</pre>\n</div>\n";
547 // formatage et affichage des resultats bruts de la requete
548 $ress_req = spip_query($req);
551 // eviter l'affichage de milliers de lignes
552 // personnalisation possible dans mes_options
553 $max_aff = defined('_MAX_DEBUG_AFF') ? _MAX_DEBUG_AFF
: 50;
554 while ($retours_sql = sql_fetch($ress_req)) {
555 if ($num <= $max_aff) {
556 $brut_sql .= "<h3>" .($num == 1 ?
$num. " sur " .sql_count($ress_req):$num). "</h3>";
558 foreach ($retours_sql as $key => $val) {
559 $brut_sql .= "<strong>" .$key. "</strong> => " .htmlspecialchars(couper($val, 150)). "<br />\n";
565 $res2 = interdire_scripts($brut_sql);
566 foreach ($quoi as $view) {
567 // ne pas afficher les $contexte_inclus
568 $view = preg_replace(",<\?php.+\?[>],Uims", "", $view);
570 $res2 .= "\n<br /><fieldset>" .interdire_scripts($view). "</fieldset>";
574 } else if ($affiche == 'code') {
576 $res = ancre_texte("<"."?php\n".$quoi."\n?".">");
577 } else if ($affiche == 'boucle') {
578 $legend = _T('boucle') . ' ' . $nom;
579 $res = ancre_texte(decompiler_boucle($quoi));
580 } else if ($affiche == 'squelette') {
581 $legend = $GLOBALS['debug_objets']['sourcefile'][$objet];
582 $res = ancre_texte($GLOBALS['debug_objets']['squelette'][$objet]);
585 return array($legend, $res, $res2);
588 // http://doc.spip.org/@debusquer_entete
589 function debusquer_entete($titre, $corps)
591 global $debug_objets;
592 include_spip('balise/formulaire_admin');
593 include_spip('public/assembler'); // pour inclure_balise_dynamique
594 include_spip('inc/texte'); // pour corriger_typo
596 return _DOCTYPE_ECRIRE
.
597 html_lang_attributes() .
599 ('SPIP ' . $GLOBALS['spip_version_affichee'] . ' ' .
600 _T('admin_debug') . ' ' . $titre . ' (' .
601 supprimer_tags(corriger_typo($GLOBALS['meta']['nom_site']))) .
603 "<meta http-equiv='Content-Type' content='text/html" .
604 (($c = $GLOBALS['meta']['charset']) ?
"; charset=$c" : '') .
606 http_script('', 'jquery.js')
607 . "<link rel='stylesheet' href='".url_absolue(find_in_path('spip_admin.css'))
608 . "' type='text/css' />" .
610 "<body style='margin:0 10px;'>\n" .
611 "<div id='spip-debug' style='position: absolute; top: 22px; z-index: 1000;height:97%;left:10px;right:10px;'>" .
613 inclure_balise_dynamique(balise_FORMULAIRE_ADMIN_dyn('spip-admin-float', $debug_objets), false) .
614 '</div></body></html>';