lib/plugin/_BackendInfo.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id: _BackendInfo.php,v 1.24 2005-01-29 19:47:43 rurban Exp $');
   3 /**
   4  Copyright 1999, 2000, 2001, 2002 $ThePhpWikiProgrammingTeam
   5
   6  This file is part of PhpWiki.
   7
   8  PhpWiki is free software; you can redistribute it and/or modify
   9  it under the terms of the GNU General Public License as published by
  10  the Free Software Foundation; either version 2 of the License, or
  11  (at your option) any later version.
  12
  13  PhpWiki is distributed in the hope that it will be useful,
  14  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  GNU General Public License for more details.
  17
  18  You should have received a copy of the GNU General Public License
  19  along with PhpWiki; if not, write to the Free Software
  20  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 require_once('lib/Template.php');
  24 /**
  25  */
  26 class WikiPlugin__BackendInfo
  27 extends WikiPlugin
  28 {
  29     function getName () {
  30         return _("DebugInfo");
  31     }
  32
  33     function getDescription () {
  34         return sprintf(_("Get debugging information for %s."), '[pagename]');
  35     }
  36
  37     function getVersion() {
  38         return preg_replace("/[Revision: $]/", '',
  39                             "\$Revision: 1.24 $");
  40     }
  41
  42     function getDefaultArguments() {
  43         return array('page' => '[pagename]');
  44     }
  45
  46     function run($dbi, $argstr, &$request, $basepage) {
  47         $args = $this->getArgs($argstr, $request);
  48         extract($args);
  49         if (empty($page))
  50             return '';
  51
  52         $backend = &$dbi->_backend;
  53
  54         $html = HTML(HTML::h3(fmt("Querying backend directly for '%s'",
  55                                   $page)));
  56
  57
  58         $table = HTML::table(array('border' => 1,
  59                                    'cellpadding' => 2,
  60                                    'cellspacing' => 0));
  61         $pagedata = $backend->get_pagedata($page);
  62         if (!$pagedata) {
  63             // FIXME: invalid HTML
  64             $html->pushContent(HTML::p(fmt("No pagedata for %s", $page)));
  65         }
  66         else {
  67             $this->_fixupData($pagedata);
  68             $table->pushContent($this->_showhash("get_pagedata('$page')", $pagedata));
  69         }
  70
  71         for ($version = $backend->get_latest_version($page);
  72              $version;
  73              $version = $backend->get_previous_version($page, $version))
  74             {
  75                 $vdata = $backend->get_versiondata($page, $version, true);
  76                 $this->_fixupData($vdata);
  77                 $table->pushContent(HTML::tr(HTML::td(array('colspan' => 2))));
  78                 $table->pushContent($this->_showhash("get_versiondata('$page',$version)",
  79                                                      $vdata));
  80             }
  81
  82         $html->pushContent($table);
  83         return $html;
  84     }
  85
  86     /**
  87      * Really should have a _fixupPagedata and _fixupVersiondata, but this works.
  88      */
  89     function _fixupData(&$data) {
  90         global $request;
  91         $user = $request->getUser();
  92
  93         foreach ($data as $key => $val) {
  94             if (is_integer($key)) {
  95                 ;
  96             } elseif ($key == 'passwd' and !$user->isAdmin()) {
  97                 $data[$key] = $val ? _("<not displayed>") : _("<empty>");
  98             } elseif ($key and $key == '_cached_html') {
  99                 $val = TransformedText::unpack($val);
 100                 ob_start();
 101                 print_r($val);
 102                 $data[$key] = HTML::pre(ob_get_contents());
 103                 ob_end_clean();
 104             }
 105             elseif (is_bool($val)) {
 106                 $data[$key] = $val ? "<true>" : "<false>";
 107             }
 108             elseif (is_string($val) && (substr($val, 0, 2) == 'a:')) {
 109                 // how to indent this table?
 110                 $val = unserialize($val);
 111                 $this->_fixupData($val);
 112                 $data[$key] = HTML::table(array('border' => 1,
 113                                                 'cellpadding' => 2,
 114                                                 'cellspacing' => 0),
 115                                           $this->_showhash(false, $val));
 116             }
 117             elseif (is_array($val)) {
 118                 // how to indent this table?
 119                 $this->_fixupData($val);
 120                 $data[$key] = HTML::table(array('border' => 1,
 121                                                 'cellpadding' => 2,
 122                                                 'cellspacing' => 0),
 123                                           $this->_showhash(false, $val));
 124             }
 125             elseif ($key and $key == '%content') {
 126                 if ($val === true)
 127                     $val = '<true>';
 128                 elseif (strlen($val) > 40)
 129                     $val = substr($val,0,40) . " ...";
 130                 $data[$key] = $val;
 131             }
 132         }
 133         unset($data['%pagedata']); // problem in backend
 134     }
 135
 136     function _showhash ($heading, $hash, $pagename = '') {
 137         $rows = array();
 138         if ($heading)
 139             $rows[] = HTML::tr(array('bgcolor' => '#ffcccc',
 140                                      'style' => 'color:#000000'),
 141                                HTML::td(array('colspan' => 2,
 142                                               'style' => 'color:#000000'),
 143                                         $heading));
 144         ksort($hash);
 145         foreach ($hash as $key => $val) {
 146             $rows[] = HTML::tr(HTML::td(array('align' => 'right',
 147                                               'bgcolor' => '#cccccc',
 148                                               'style' => 'color:#000000'),
 149                                         HTML(HTML::raw('&nbsp;'), $key,
 150                                              HTML::raw('&nbsp;'))),
 151                                HTML::td(array('bgcolor' => '#ffffff',
 152                                               'style' => 'color:#000000'),
 153                                         $val ? $val : HTML::raw('&nbsp;'))
 154                                );
 155         }
 156         return $rows;
 157     }
 158 };
 159
 160 // $Log: not supported by cvs2svn $
 161 // Revision 1.23  2005/01/21 14:13:23  rurban
 162 // stabilize on numeric keys (strange php problem)
 163 //
 164 // Revision 1.22  2004/02/17 12:11:36  rurban
 165 // added missing 4th basepage arg at plugin->run() to almost all plugins. This caused no harm so far, because it was silently dropped on normal usage. However on plugin internal ->run invocations it failed. (InterWikiSearch, IncludeSiteMap, ...)
 166 //
 167 // Revision 1.21  2003/02/21 04:22:28  dairiki
 168 // Make this work for array-valued data.  Make display of cached markup
 169 // readable.  Some code cleanups.  (This still needs more work.)
 170 //
 171 // Revision 1.20  2003/01/18 21:19:24  carstenklapp
 172 // Code cleanup:
 173 // Reformatting; added copyleft, getVersion, getDescription
 174 //
 175
 176 // (c-file-style: "gnu")
 177 // Local Variables:
 178 // mode: php
 179 // tab-width: 8
 180 // c-basic-offset: 4
 181 // c-hanging-comment-ender-p: nil
 182 // indent-tabs-mode: nil
 183 // End:
 184 ?>