lib/plugin/SqlResult.php

   1 <?php
   2
   3 /*
   4  * Copyright 2004 $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 along
  19  * with PhpWiki; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21  */
  22
  23 /**
  24  * This plugin displays results of arbitrary SQL select statements
  25  * in table form.
  26  * The database definition, the DSN, must be defined in the local file
  27  * config/SqlResult.ini
  28  *   A simple textfile with alias = dsn lines.
  29  *
  30  * Optional template file to format the result and handle some logic.
  31  * Template vars: %%where%%, %%sortby%%, %%limit%%
  32  * TODO: paging
  33  *
  34  * Usage:
  35  *   <<SqlResult alias=mysql
  36  *            SELECT 'mysql password for string "xx":',
  37  *                   PASSWORD('xx')
  38  *   >>
  39  *   <<SqlResult alias=videos template=videos
  40  *            SELECT rating,title,date
  41  *                   FROM video
  42  *                   ORDER BY rating DESC
  43  *                   LIMIT 5
  44  *   >>
  45  *   <<SqlResult alias=imdb template=imdbmovies where||="Davies, Jeremy%"
  46  *   SELECT m.title, m.date, n.name, c.role
  47  *     FROM movies as m, names as n, jobs as j, characters as c
  48  *     WHERE n.name LIKE "%%where%%"
  49  *     AND m.title_id = c.title_id
  50  *     AND n.name_id = c.name_id
  51  *     AND c.job_id = j.job_id
  52  *     AND j.description = 'Actor'
  53  *     ORDER BY m.date DESC
  54  *   >>
  55  *
  56  * @author: ReiniUrban
  57  */
  58
  59 require_once 'lib/PageList.php';
  60
  61 class WikiPlugin_SqlResult
  62     extends WikiPlugin
  63 {
  64     public $_args;
  65
  66     function getName()
  67     {
  68         return _("SqlResult");
  69     }
  70
  71     function getDescription()
  72     {
  73         return _("Display arbitrary SQL result tables.");
  74     }
  75
  76     function getDefaultArguments()
  77     {
  78         return array(
  79             'alias' => false, // DSN database specification
  80             'ordered' => false, // if to display as <ol> list: single col only without template
  81             'template' => false, // use a custom <theme>/template.tmpl
  82             'where' => false, // custom filter for the query
  83             'sortby' => false, // for paging, default none
  84             'limit' => "0,50", // for paging, default: only the first 50
  85         );
  86     }
  87
  88     function getDsn($alias)
  89     {
  90         $ini = parse_ini_file(FindFile("config/SqlResult.ini"));
  91         return $ini[$alias];
  92     }
  93
  94     /** Get the SQL statement from the rest of the lines
  95      */
  96     function handle_plugin_args_cruft($argstr, $args)
  97     {
  98         $this->_sql = str_replace("\n", " ", $argstr);
  99         return;
 100     }
 101
 102     function run($dbi, $argstr, &$request, $basepage)
 103     {
 104         global $DBParams;
 105         //$request->setArg('nocache','1');
 106         extract($this->getArgs($argstr, $request));
 107         if (!$alias)
 108             return $this->error(_("No DSN alias for SqlResult.ini specified"));
 109         $sql = $this->_sql;
 110
 111         // apply custom filters
 112         if ($where and strstr($sql, "%%where%%"))
 113             $sql = str_replace("%%where%%", $where, $sql);
 114         // TODO: use a SQL construction library?
 115         if ($limit) {
 116             $pagelist = new PageList();
 117             $limit = $pagelist->limit($limit);
 118             if (strstr($sql, "%%limit%%"))
 119                 $sql = str_replace("%%limit%%", $limit, $sql);
 120             else {
 121                 if (strstr($sql, "LIMIT"))
 122                     $sql = preg_replace("/LIMIT\s+[\d,]+\s+/m", "LIMIT " . $limit . " ", $sql);
 123             }
 124         }
 125         if (strstr($sql, "%%sortby%%")) {
 126             if (!$sortby)
 127                 $sql = preg_replace("/ORDER BY .*%%sortby%%\s/m", "", $sql);
 128             else
 129                 $sql = str_replace("%%sortby%%", $sortby, $sql);
 130         } elseif (PageList::sortby($sortby, 'db')) { // add sorting: support paging sortby links
 131             if (preg_match("/\sORDER\s/", $sql))
 132                 $sql = preg_replace("/ORDER BY\s\S+\s/m", "ORDER BY " . PageList::sortby($sortby, 'db'), $sql);
 133             else
 134                 $sql .= " ORDER BY " . PageList::sortby($sortby, 'db');
 135         }
 136
 137         $inidsn = $this->getDsn($alias);
 138         if (!$inidsn)
 139             return $this->error(sprintf(_("No DSN for alias %s in SqlResult.ini found"),
 140                 $alias));
 141         // adodb or pear? adodb as default, since we distribute per default it.
 142         // for pear there may be overrides.
 143         // TODO: native PDO support (for now we use ADODB)
 144         if ($DBParams['dbtype'] == 'SQL') {
 145             $dbh = DB::connect($inidsn);
 146             $all = $dbh->getAll($sql);
 147             if (DB::isError($all)) {
 148                 return $this->error($all->getMessage() . ' ' . $all->userinfo);
 149             }
 150         } else { // unless PearDB use the included ADODB, regardless if dba, file or PDO, ...
 151             if ($DBParams['dbtype'] != 'ADODB') {
 152                 require_once 'lib/WikiDB/backend/ADODB.php';
 153             }
 154             $parsed = parseDSN($inidsn);
 155             $dbh = &ADONewConnection($parsed['phptype']);
 156             $conn = $dbh->Connect($parsed['hostspec'], $parsed['username'],
 157                 $parsed['password'], $parsed['database']);
 158             if (!$conn)
 159                 return $this->error($dbh->errorMsg());
 160             $GLOBALS['ADODB_FETCH_MODE'] = ADODB_FETCH_ASSOC;
 161             $dbh->SetFetchMode(ADODB_FETCH_ASSOC);
 162
 163             $all = $dbh->getAll($sql);
 164
 165             $GLOBALS['ADODB_FETCH_MODE'] = ADODB_FETCH_NUM;
 166             $dbh->SetFetchMode(ADODB_FETCH_NUM);
 167             if (!$all)
 168                 return $this->error($dbh->errorMsg());
 169         }
 170         $args = array();
 171         if ($limit) { // fill paging vars (see PageList)
 172             $args = $pagelist->pagingTokens(count($all), count($all[0]), $limit);
 173             if (!$args) $args = array();
 174         }
 175
 176         if ($template) {
 177             $args = array_merge(
 178                 array('SqlResult' => $all, // the resulting array of rows
 179                     'ordered' => $ordered, // whether to display as <ul>/<dt> or <ol>
 180                     'where' => $where,
 181                     'sortby' => $sortby,
 182                     'limit' => $limit),
 183                 $args); // paging params override given params
 184             return Template($template, $args);
 185         } else {
 186             if ($ordered) {
 187                 $html = HTML::ol(array('class' => 'sqlresult'));
 188                 if ($all)
 189                     foreach ($all as $row) {
 190                         $html->pushContent(HTML::li(array('class' => $i++ % 2 ? 'evenrow' : 'oddrow'), $row[0]));
 191                     }
 192             } else {
 193                 $html = HTML::table(array('class' => 'sqlresult'));
 194                 $i = 0;
 195                 if ($all)
 196                     foreach ($all as $row) {
 197                         $tr = HTML::tr(array('class' => $i++ % 2 ? 'evenrow' : 'oddrow'));
 198                         if ($row)
 199                             foreach ($row as $col) {
 200                                 $tr->pushContent(HTML::td($col));
 201                             }
 202                         $html->pushContent($tr);
 203                     }
 204             }
 205         }
 206         // do paging via pagelink template
 207         if (!empty($args['NUMPAGES'])) {
 208             $paging = Template("pagelink", $args);
 209             $html = $table->pushContent(HTML::thead($paging),
 210                 HTML::tbody($html),
 211                 HTML::tfoot($paging));
 212         }
 213         if (0 and DEBUG) { // test deferred error/warning/notice collapsing
 214             trigger_error("test notice", E_USER_NOTICE);
 215             trigger_error("test warning", E_USER_WARNING);
 216         }
 217
 218         return $html;
 219     }
 220
 221 }
 222
 223 // Local Variables:
 224 // mode: php
 225 // tab-width: 8
 226 // c-basic-offset: 4
 227 // c-hanging-comment-ender-p: nil
 228 // indent-tabs-mode: nil
 229 // End: