lib/plugin/MediawikiTable.php

   1 <?php // -*-php-*-
   2
   3 /*
   4  * Copyright (C) 2003 Sameer D. Sahasrabuddhe
   5  * Copyright (C) 2005 $ThePhpWikiProgrammingTeam
   6  * Copyright (C) 2008-2010 Marc-Etienne Vargenau, Alcatel-Lucent
   7  *
   8  * This file is part of PhpWiki.
   9  *
  10  * PhpWiki is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * PhpWiki is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License along
  21  * with PhpWiki; if not, write to the Free Software Foundation, Inc.,
  22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  23 */
  24
  25 /*
  26  * Standard Alcatel-Lucent disclaimer for contributing to open source
  27  *
  28  * "The MediawikiTablePlugin ("Contribution") has not been tested and/or
  29  * validated for release as or in products, combinations with products or
  30  * other commercial use. Any use of the Contribution is entirely made at
  31  * the user's own responsibility and the user can not rely on any features,
  32  * functionalities or performances Alcatel-Lucent has attributed to the
  33  * Contribution.
  34  *
  35  * THE CONTRIBUTION BY ALCATEL-LUCENT IS PROVIDED AS IS, WITHOUT WARRANTY
  36  * OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  37  * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, COMPLIANCE,
  38  * NON-INTERFERENCE AND/OR INTERWORKING WITH THE SOFTWARE TO WHICH THE
  39  * CONTRIBUTION HAS BEEN MADE, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL
  40  * ALCATEL-LUCENT BE LIABLE FOR ANY DAMAGES OR OTHER LIABLITY, WHETHER IN
  41  * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  42  * CONTRIBUTION OR THE USE OR OTHER DEALINGS IN THE CONTRIBUTION, WHETHER
  43  * TOGETHER WITH THE SOFTWARE TO WHICH THE CONTRIBUTION RELATES OR ON A STAND
  44  * ALONE BASIS."
  45  */
  46
  47 /**
  48  * MediawikiTablePlugin
  49  * A PhpWiki plugin that allows insertion of tables using a Mediawiki-like
  50  * syntax.
  51 */
  52 class WikiPlugin_MediawikiTable
  53 extends WikiPlugin
  54 {
  55     function getName() {
  56         return _("MediawikiTable");
  57     }
  58
  59     function getDescription() {
  60       return _("Layout tables using a Mediawiki-like markup style.");
  61     }
  62
  63     function getDefaultArguments() {
  64         return array();
  65     }
  66
  67     function run($dbi, $argstr, &$request, $basepage) {
  68         include_once 'lib/BlockParser.php';
  69         // MediawikiTablePlugin markup is new.
  70         $markup = 2.0;
  71
  72         // We allow the compact Mediawiki syntax with:
  73         // - multiple cells on the same line (separated by "||"),
  74         // - multiple header cells on the same line (separated by "!!").
  75         $argstr = str_replace("||", "\n| ", $argstr);
  76         $argstr = str_replace("!!", "\n! ", $argstr);
  77
  78         $lines = explode("\n", $argstr);
  79
  80         $table = HTML::table();
  81         $caption = HTML::caption();
  82         $thead = HTML::thead();
  83         $tbody = HTML::tbody();
  84
  85         // Do we need a <thead>?
  86         // 0 = unknown
  87         // 1 = inside (parsing cells)
  88         // 2 = false (no thead, only tbody)
  89         // 3 = true (there is a thead)
  90         $theadstatus = 0;
  91
  92         // We always generate an Id for the table.
  93         // This is convenient for tables of class "sortable".
  94         // If user provides an Id, the generated Id will be overwritten below.
  95         $table->setAttr("id", GenerateId("MediawikiTable"));
  96
  97         if (substr($lines[0],0,2) == "{|") {
  98             // Start of table
  99             $lines[0] = substr($lines[0],2);
 100         }
 101         if (($lines[0][0] != '|') and ($lines[0][0] != '!')) {
 102             $line = array_shift($lines);
 103             $attrs = parse_attributes($line);
 104             foreach ($attrs as $key => $value) {
 105                 if (in_array ($key, array("id", "class", "title", "style",
 106                                           "bgcolor", "frame", "rules", "border",
 107                                           "cellspacing", "cellpadding",
 108                                           "summary", "align", "width"))) {
 109                     $table->setAttr($key, $value);
 110                 }
 111             }
 112         }
 113
 114         if (count($lines) == 1) { // empty table, we only have closing "|}" line
 115             return HTML::raw('');
 116         }
 117
 118         foreach ($lines as $line) {
 119             if (substr($line,0,2) == "|}") {
 120                 // End of table
 121                 continue;
 122             }
 123             if (substr($line,0,2) == "|-") {
 124                 if (isset($row)) {
 125                     if (isset($cell)) {
 126                         if (isset($content)) {
 127                             if (is_numeric(trim($content))) {
 128                                 $cell->pushContent(HTML::p(array('style' => "text-align:right"), trim($content)));
 129                             } else {
 130                                 $cell->pushContent(TransformText(trim($content), $markup, $basepage));
 131                             }
 132                             unset($content);
 133                         }
 134                         $row->pushContent($cell);
 135                         unset($cell);
 136                     }
 137                     if (!empty($row->_content)) {
 138                         if ($theadstatus == 1) { // inside
 139                             $theadstatus = 3; // true
 140                             $thead->pushContent($row);
 141                         } else {
 142                             $tbody->pushContent($row);
 143                         }
 144                     }
 145                 }
 146                 $row = HTML::tr();
 147                 $attrs = parse_attributes(substr($line,2));
 148                 foreach ($attrs as $key => $value) {
 149                     if (in_array ($key, array("id", "class", "title", "style",
 150                                               "bgcolor", "align", "valign"))) {
 151                         $row->setAttr($key, $value);
 152                     }
 153                 }
 154                 continue;
 155             }
 156
 157             // Table summary
 158             if (substr($line,0,2) == "|=") {
 159                 $line = substr($line,2);
 160                 $table->setAttr("summary", trim($line));
 161             }
 162
 163             // Table caption
 164             if (substr($line,0,2) == "|+") {
 165
 166                 $line = substr($line,2);
 167                 $pospipe = strpos($line, "|");
 168                 $posbracket = strpos($line, "[");
 169                 if (($pospipe !== false) && (($posbracket === false) || ($posbracket > $pospipe))) {
 170                     $attrs = parse_attributes(substr($line, 0, $pospipe));
 171                     foreach ($attrs as $key => $value) {
 172                         if (in_array ($key, array("id", "class", "title", "style",
 173                                                   "align", "lang"))) {
 174                             $caption->setAttr($key, $value);
 175                         }
 176                     }
 177                     $line=substr($line, $pospipe+1);
 178                 }
 179
 180                 $caption->setContent(TransformInline(trim($line)));
 181             }
 182
 183             if (((substr($line,0,1) == "|") or (substr($line,0,1) == "!")) and isset($row)) {
 184                 if (isset($cell)) {
 185                     if (isset ($content)) {
 186                         if (is_numeric(trim($content))) {
 187                             $cell->pushContent(HTML::p(array('style' => "text-align:right"), trim($content)));
 188                         } else {
 189                             $cell->pushContent(TransformText(trim($content), $markup, $basepage));
 190                         }
 191                         unset($content);
 192                     }
 193                     $row->pushContent($cell);
 194                 }
 195                 if (substr($line,0,1) == "!") {
 196                     if ($theadstatus == 0) { // unknown
 197                         $theadstatus = 1; // inside
 198                     }
 199                     $cell = HTML::th();   // Header
 200                 } else {
 201                     if ($theadstatus == 1) { // inside
 202                         $theadstatus = 2; // false
 203                     }
 204                     $cell = HTML::td();
 205                 }
 206                 $line = substr($line, 1);
 207
 208                 // If there is a "|" in the line, the start of line
 209                 // (before the "|") is made of attributes.
 210                 // The end of the line (after the "|") is the cell content
 211                 // This is not true if the pipe is inside [], {{}} or {{{}}}
 212                 // | [foo|bar]
 213                 // The following cases must work:
 214                 // | foo
 215                 // | [foo|bar]
 216                 // | class="xxx" | foo
 217                 // | class="xxx" | [foo|bar]
 218                 // | {{tmpl|arg=val}}
 219                 // | {{image.png|alt}}
 220                 // | {{{ xxx | yyy }}}
 221                 $pospipe = strpos($line, "|");
 222                 $posbracket = strpos($line, "[");
 223                 $poscurly = strpos($line, "{");
 224                 if (($pospipe !== false) && (($posbracket === false) || ($posbracket > $pospipe)) && (($poscurly === false) || ($poscurly > $pospipe))) {
 225                     $attrs = parse_attributes(substr($line, 0, $pospipe));
 226                     foreach ($attrs as $key => $value) {
 227                         if (in_array ($key, array("id", "class", "title", "style", "scope",
 228                                                   "colspan", "rowspan", "width", "height",
 229                                                   "bgcolor", "align", "valign"))) {
 230                             $cell->setAttr($key, $value);
 231                         }
 232                     }
 233                     $line=substr($line, $pospipe+1);
 234                     if (is_numeric(trim($line))) {
 235                         $cell->pushContent(HTML::p(array('style' => "text-align:right"), trim($line)));
 236                     } else {
 237                         $cell->pushContent(TransformText(trim($line), $markup, $basepage));
 238                     }
 239                     continue;
 240                 }
 241             }
 242             if (isset($row) and isset($cell)) {
 243                 $line = str_replace("?\>", "?>", $line);
 244                 $line = str_replace("\~", "~", $line);
 245                 if (empty($content)) $content = '';
 246                 $content .= $line . "\n";
 247             }
 248         }
 249         if (isset($row)) {
 250             if (isset($cell)) {
 251                 if (isset($content)) {
 252                     if (is_numeric(trim($content))) {
 253                         $cell->pushContent(HTML::p(array('style' => "text-align:right"), trim($content)));
 254                     } else {
 255                         $cell->pushContent(TransformText(trim($content), $markup, $basepage));
 256                     }
 257
 258                 }
 259                 $row->pushContent($cell);
 260             }
 261             // If user put and extra "|-" without cells just before "|}"
 262             // we ignore it to get valid XHTML code
 263             if (!empty($row->_content)) {
 264                 $tbody->pushContent($row);
 265             }
 266         }
 267         if (!empty($caption->_content)) {
 268             $table->pushContent($caption);
 269         }
 270         if (!empty($thead->_content)) {
 271             $table->pushContent($thead);
 272         }
 273         if (!empty($tbody->_content)) {
 274             $table->pushContent($tbody);
 275         }
 276         if (!empty($table->_content)) {
 277             return $table;
 278         } else {
 279             return HTML::raw('');
 280         }
 281     }
 282 }
 283
 284 // Local Variables:
 285 // mode: php
 286 // tab-width: 8
 287 // c-basic-offset: 4
 288 // c-hanging-comment-ender-p: nil
 289 // indent-tabs-mode: nil
 290 // End: