lib/plugin/_BackendInfo.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id: _BackendInfo.php,v 1.25 2006-09-06 06:02:36 rurban Exp $');
   3 /**
   4  Copyright 1999,2000,2001,2002,2006 $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.25 $");
  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         $linkdata = $backend->get_links($page, false);
  83         if ($linkdata->count())
  84             $table->pushContent($this->_showhash("get_links('$page')", $linkdata->asArray()));
  85         $relations = $backend->get_links($page, false, false, false, false,  false, true);
  86         if ($relations->count()) {
  87             $table->pushContent($this->_showhash("get_relations('$page')", array()));
  88             while ($rel = $relations->next())
  89                 $table->pushContent($this->_showhash(false, $rel));
  90         }
  91         $linkdata = $backend->get_links($page, true);
  92         if ($linkdata->count())
  93             $table->pushContent($this->_showhash("get_backlinks('$page')", $linkdata->asArray()));
  94
  95         $html->pushContent($table);
  96         return $html;
  97     }
  98
  99     /**
 100      * Really should have a _fixupPagedata and _fixupVersiondata, but this works.
 101      */
 102     function _fixupData(&$data) {
 103         global $request;
 104         $user = $request->getUser();
 105
 106         foreach ($data as $key => $val) {
 107             if (is_integer($key)) {
 108                 ;
 109             } elseif ($key == 'passwd' and !$user->isAdmin()) {
 110                 $data[$key] = $val ? _("<not displayed>") : _("<empty>");
 111             } elseif ($key and $key == '_cached_html') {
 112                 $val = TransformedText::unpack($val);
 113                 ob_start();
 114                 print_r($val);
 115                 $data[$key] = HTML::pre(ob_get_contents());
 116                 ob_end_clean();
 117             }
 118             elseif (is_bool($val)) {
 119                 $data[$key] = $val ? "<true>" : "<false>";
 120             }
 121             elseif (is_string($val) && (substr($val, 0, 2) == 'a:')) {
 122                 // how to indent this table?
 123                 $val = unserialize($val);
 124                 $this->_fixupData($val);
 125                 $data[$key] = HTML::table(array('border' => 1,
 126                                                 'cellpadding' => 2,
 127                                                 'cellspacing' => 0),
 128                                           $this->_showhash(false, $val));
 129             }
 130             elseif (is_array($val)) {
 131                 // how to indent this table?
 132                 $this->_fixupData($val);
 133                 $data[$key] = HTML::table(array('border' => 1,
 134                                                 'cellpadding' => 2,
 135                                                 'cellspacing' => 0),
 136                                           $this->_showhash(false, $val));
 137             }
 138             elseif ($key and $key == '%content') {
 139                 if ($val === true)
 140                     $val = '<true>';
 141                 elseif (strlen($val) > 40)
 142                     $val = substr($val,0,40) . " ...";
 143                 $data[$key] = $val;
 144             }
 145         }
 146         unset($data['%pagedata']); // problem in backend
 147     }
 148
 149     function _showhash ($heading, $hash, $pagename = '') {
 150         $rows = array();
 151         if ($heading)
 152             $rows[] = HTML::tr(array('bgcolor' => '#ffcccc',
 153                                      'style' => 'color:#000000'),
 154                                HTML::td(array('colspan' => 2,
 155                                               'style' => 'color:#000000'),
 156                                         $heading));
 157         ksort($hash);
 158         foreach ($hash as $key => $val) {
 159             $rows[] = HTML::tr(HTML::td(array('align' => 'right',
 160                                               'bgcolor' => '#cccccc',
 161                                               'style' => 'color:#000000'),
 162                                         HTML(HTML::raw('&nbsp;'), $key,
 163                                              HTML::raw('&nbsp;'))),
 164                                HTML::td(array('bgcolor' => '#ffffff',
 165                                               'style' => 'color:#000000'),
 166                                         $val ? $val : HTML::raw('&nbsp;'))
 167                                );
 168         }
 169         return $rows;
 170     }
 171 };
 172
 173 // $Log: not supported by cvs2svn $
 174 // Revision 1.24  2005/01/29 19:47:43  rurban
 175 // support bool
 176 //
 177 // Revision 1.23  2005/01/21 14:13:23  rurban
 178 // stabilize on numeric keys (strange php problem)
 179 //
 180 // Revision 1.22  2004/02/17 12:11:36  rurban
 181 // 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, ...)
 182 //
 183 // Revision 1.21  2003/02/21 04:22:28  dairiki
 184 // Make this work for array-valued data.  Make display of cached markup
 185 // readable.  Some code cleanups.  (This still needs more work.)
 186 //
 187 // Revision 1.20  2003/01/18 21:19:24  carstenklapp
 188 // Code cleanup:
 189 // Reformatting; added copyleft, getVersion, getDescription
 190 //
 191
 192 // (c-file-style: "gnu")
 193 // Local Variables:
 194 // mode: php
 195 // tab-width: 8
 196 // c-basic-offset: 4
 197 // c-hanging-comment-ender-p: nil
 198 // indent-tabs-mode: nil
 199 // End:
 200 ?>