lib/plugin/WikicreoleTable.php

   1 <?php // -*-php-*-
   2 // $Id$
   3 /*
   4  * Copyright (C) 2008-2009, 2011 Marc-Etienne Vargenau, Alcatel-Lucent
   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 /*
  24  * Standard Alcatel-Lucent disclaimer for contributing to open source
  25  *
  26  * "The WikicreoleTablePlugin ("Contribution") has not been tested and/or
  27  * validated for release as or in products, combinations with products or
  28  * other commercial use. Any use of the Contribution is entirely made at
  29  * the user's own responsibility and the user can not rely on any features,
  30  * functionalities or performances Alcatel-Lucent has attributed to the
  31  * Contribution.
  32  *
  33  * THE CONTRIBUTION BY ALCATEL-LUCENT IS PROVIDED AS IS, WITHOUT WARRANTY
  34  * OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  35  * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, COMPLIANCE,
  36  * NON-INTERFERENCE AND/OR INTERWORKING WITH THE SOFTWARE TO WHICH THE
  37  * CONTRIBUTION HAS BEEN MADE, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL
  38  * ALCATEL-LUCENT BE LIABLE FOR ANY DAMAGES OR OTHER LIABLITY, WHETHER IN
  39  * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  40  * CONTRIBUTION OR THE USE OR OTHER DEALINGS IN THE CONTRIBUTION, WHETHER
  41  * TOGETHER WITH THE SOFTWARE TO WHICH THE CONTRIBUTION RELATES OR ON A STAND
  42  * ALONE BASIS."
  43  */
  44
  45 /**
  46  * WikicreoleTablePlugin
  47  * A PhpWiki plugin that allows insertion of tables using the Wikicreole
  48  * syntax.
  49  */
  50
  51 class WikiPlugin_WikicreoleTable
  52 extends WikiPlugin
  53 {
  54     function getName() {
  55         return _("WikicreoleTable");
  56     }
  57
  58     function getDescription() {
  59       return _("Layout tables using the Wikicreole syntax.");
  60     }
  61
  62     function getDefaultArguments() {
  63         return array();
  64     }
  65
  66     function handle_plugin_args_cruft($argstr, $args) {
  67         return;
  68     }
  69
  70     function run($dbi, $argstr, &$request, $basepage) {
  71         global $WikiTheme;
  72         include_once('lib/InlineParser.php');
  73
  74         $table = array();
  75
  76         $lines = preg_split('/\s*?\n\s*/', $argstr);
  77
  78         foreach ($lines as $line) {
  79             if (!$line) {
  80                 continue;
  81             }
  82             $line = trim($line);
  83             // If line ends with a '|', remove it
  84             if ($line[strlen($line)-1] == '|') {
  85                 $line = substr($line, 0, -1);
  86             }
  87             if ($line[0] == '|') {
  88                 $table[] = $this->_parse_row($line, $basepage);
  89             }
  90         }
  91
  92         $nbrows = sizeof($table);
  93         // If table is empty, do not generate table markup
  94         if ($nbrows == 0) {
  95             return HTML::raw('');
  96         }
  97         $nbcols = sizeof($table[0]);
  98
  99         for ($i=0; $i<$nbrows; $i++) {
 100             for ($j=0; $j<$nbcols; $j++) {
 101                 if (preg_match('/@@/', $table[$i][$j])) {
 102                     $table[$i][$j] = compute_tablecell($table, $i, $j, $nbrows, $nbcols);
 103                 }
 104             }
 105         }
 106
 107         $htmltable = HTML::table(array('class' => "bordered"));
 108         foreach ($table as $row) {
 109             $htmlrow = HTML::tr();
 110             foreach ($row as $cell) {
 111                 if ($cell && $cell[0] == '=') {
 112                     $cell = trim(substr($cell, 1));
 113                     $htmlrow->pushContent(HTML::th(TransformInline($cell, 2.0, $basepage)));
 114                 } else {
 115                     if (is_numeric($cell)) {
 116                         $htmlrow->pushContent(HTML::td(array('style' => "text-align:right"), $cell));
 117                     } else {
 118                         $htmlrow->pushContent(HTML::td(TransformInline($cell, 2.0, $basepage)));
 119                     }
 120                 }
 121             }
 122             $htmltable->pushContent($htmlrow);
 123         }
 124         return $htmltable;
 125     }
 126
 127     function _parse_row ($line, $basepage) {
 128         $brkt_link = "\\[ .*? [^]\s] .*? \\]";
 129         $cell_content  = "(?: [^[] | ".ESCAPE_CHAR."\\[ | $brkt_link )*?";
 130
 131         preg_match_all("/(\\|+) \s* ($cell_content) \s* (?=\\||\$)/x",
 132                        $line, $matches, PREG_SET_ORDER);
 133
 134         $row = array();
 135
 136         foreach ($matches as $m) {
 137             $cell = $m[2];
 138             $row[]= $cell;
 139         }
 140         return $row;
 141     }
 142
 143 }
 144
 145 // Local Variables:
 146 // mode: php
 147 // tab-width: 8
 148 // c-basic-offset: 4
 149 // c-hanging-comment-ender-p: nil
 150 // indent-tabs-mode: nil
 151 // End:
 152 ?>