lib/plugin/MediawikiTable.php

   1 <?php // -*-php-*-
   2 // rcs_id('$Id$');
   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
  21  * along with PhpWiki; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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 = preg_split('/\n/', $argstr);
  79         $table = HTML::table();
  80
  81         // We always generate an Id for the table.
  82         // This is convenient for tables of class "sortable".
  83         // If user provides an Id, the generated Id will be overwritten below.
  84         $table->setAttr("id", GenerateId("MediawikiTable"));
  85
  86         if (substr($lines[0],0,2) == "{|") {
  87             // Start of table
  88             $lines[0] = substr($lines[0],2);
  89         }
  90         if (($lines[0][0] != '|') and ($lines[0][0] != '!')) {
  91             $line = array_shift($lines);
  92             $attrs = parse_attributes($line);
  93             foreach ($attrs as $key => $value) {
  94                 if (in_array ($key, array("id", "class", "title", "style",
  95                                           "bgcolor", "frame", "rules", "border",
  96                                           "cellspacing", "cellpadding",
  97                                           "summary", "align", "width"))) {
  98                     $table->setAttr($key, $value);
  99                 }
 100             }
 101         }
 102
 103         if (count($lines) == 1) { // empty table, we only have closing "|}" line
 104             return HTML::raw('');
 105         }
 106
 107         foreach ($lines as $line){
 108             if (substr($line,0,2) == "|}") {
 109                 // End of table
 110                 continue;
 111             }
 112             if (substr($line,0,2) == "|-") {
 113                 if (isset($row)) {
 114                     if (isset($cell)) {
 115                         if (isset($content)) {
 116                             if (is_numeric(trim($content))) {
 117                                 $cell->pushContent(HTML::p(array('style' => "text-align:right"), trim($content)));
 118                             } else {
 119                                 $cell->pushContent(TransformText(trim($content), $markup, $basepage));
 120                             }
 121                             unset($content);
 122                         }
 123                         $row->pushContent($cell);
 124                         unset($cell);
 125                     }
 126                     if (!empty($row->_content)) {
 127                         if (isset($thead)) {
 128                             $thead->pushContent($row);
 129                             $table->pushContent($thead);
 130                             unset($thead);
 131                             $tbody = HTML::tbody();
 132                         } else {
 133                             $tbody->pushContent($row);
 134                         }
 135                     }
 136                 }
 137                 $row = HTML::tr();
 138                 $attrs = parse_attributes(substr($line,2));
 139                 foreach ($attrs as $key => $value) {
 140                     if (in_array ($key, array("id", "class", "title", "style",
 141                                               "bgcolor", "align", "valign"))) {
 142                         $row->setAttr($key, $value);
 143                     }
 144                 }
 145                 continue;
 146             }
 147
 148             // Table summary
 149             if (substr($line,0,2) == "|=") {
 150                 $line = substr($line,2);
 151                 $table->setAttr("summary", trim($line));
 152             }
 153
 154             // Table caption
 155             if (substr($line,0,2) == "|+") {
 156
 157                 $caption = HTML::caption();
 158                 $line = substr($line,2);
 159                 $pospipe = strpos($line, "|");
 160                 $posbracket = strpos($line, "[");
 161                 if (($pospipe !== false) && (($posbracket === false) || ($posbracket > $pospipe))) {
 162                     $attrs = parse_attributes(substr($line, 0, $pospipe));
 163                     foreach ($attrs as $key => $value) {
 164                         if (in_array ($key, array("id", "class", "title", "style",
 165                                                   "align", "lang"))) {
 166                             $caption->setAttr($key, $value);
 167                         }
 168                     }
 169                     $line=substr($line, $pospipe+1);
 170                 }
 171
 172                 $caption->pushContent(trim($line));
 173                 $table->pushContent($caption);
 174             }
 175
 176             if (((substr($line,0,1) == "|") or (substr($line,0,1) == "!")) and isset($row)) {
 177                 if (isset($cell)) {
 178                     if (isset ($content)) {
 179                         if (is_numeric(trim($content))) {
 180                             $cell->pushContent(HTML::p(array('style' => "text-align:right"), trim($content)));
 181                         } else {
 182                             $cell->pushContent(TransformText(trim($content), $markup, $basepage));
 183                         }
 184                         unset($content);
 185                     }
 186                     $row->pushContent($cell);
 187                 }
 188                 if (substr($line,0,1) == "!") {
 189                     $cell = HTML::th();   // Header
 190                     $thead = HTML::thead();
 191                 } else {
 192                     $cell = HTML::td();
 193                     if (!isset($tbody)) $tbody = HTML::tbody();
 194                 }
 195                 $line = substr($line, 1);
 196
 197                 // If there is a "|" in the line, the start of line
 198                 // (before the "|") is made of attributes.
 199                 // The end of the line (after the "|") is the cell content
 200                 // This is not true if the pipe is inside [], {{}} or {{{}}}
 201                 // | [foo|bar]
 202                 // The following cases must work:
 203                 // | foo
 204                 // | [foo|bar]
 205                 // | class="xxx" | foo
 206                 // | class="xxx" | [foo|bar]
 207                 // | {{tmpl|arg=val}}
 208                 // | {{image.png|alt}}
 209                 // | {{{ xxx | yyy }}}
 210                 $pospipe = strpos($line, "|");
 211                 $posbracket = strpos($line, "[");
 212                 $poscurly = strpos($line, "{");
 213                 if (($pospipe !== false) && (($posbracket === false) || ($posbracket > $pospipe)) && (($poscurly === false) || ($poscurly > $pospipe))) {
 214                     $attrs = parse_attributes(substr($line, 0, $pospipe));
 215                     foreach ($attrs as $key => $value) {
 216                         if (in_array ($key, array("id", "class", "title", "style",
 217                                                   "colspan", "rowspan", "width", "height",
 218                                                   "bgcolor", "align", "valign"))) {
 219                             $cell->setAttr($key, $value);
 220                         }
 221                     }
 222                     $line=substr($line, $pospipe+1);
 223                     if (is_numeric(trim($line))) {
 224                         $cell->pushContent(HTML::p(array('style' => "text-align:right"), trim($line)));
 225                     } else {
 226                         $cell->pushContent(TransformText(trim($line), $markup, $basepage));
 227                     }
 228                     continue;
 229                 }
 230             }
 231             if (isset($row) and isset($cell)) {
 232                 $line = str_replace("?\>", "?>", $line);
 233                 $line = str_replace("\~", "~", $line);
 234                 if (empty($content)) $content = '';
 235                 $content .= $line . "\n";
 236             }
 237         }
 238         if (isset($row)) {
 239             if (isset($cell)) {
 240                 if (isset($content)) {
 241                     if (is_numeric(trim($content))) {
 242                         $cell->pushContent(HTML::p(array('style' => "text-align:right"), trim($content)));
 243                     } else {
 244                         $cell->pushContent(TransformText(trim($content), $markup, $basepage));
 245                     }
 246
 247                 }
 248                 $row->pushContent($cell);
 249             }
 250             // If user put and extra "|-" without cells just before "|}"
 251             // we ignore it to get valid XHTML code
 252             if (!empty($row->_content)) {
 253                 $tbody->pushContent($row);
 254             }
 255             if (isset($tbody) && !empty($tbody->_content)) {
 256                 $table->pushContent($tbody);
 257             }
 258         }
 259         if (isset($table) && !empty($table->_content)) {
 260             return $table;
 261         } else {
 262             return HTML::raw('');
 263         }
 264     }
 265 }
 266
 267 // Local Variables:
 268 // mode: php
 269 // tab-width: 8
 270 // c-basic-offset: 4
 271 // c-hanging-comment-ender-p: nil
 272 // indent-tabs-mode: nil
 273 // End:
 274 ?>