lib/plugin/MediawikiTable.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id: MediawikiTable.php,v 1.3 2008-08-06 09:28:42 vargenau Exp $');
   3 /**
   4   MediawikiTablePlugin
   5   A PhpWiki plugin that allows insertion of tables using a Mediawiki-like
   6   syntax.
   7 */
   8 /*
   9  * Copyright (C) 2003 Sameer D. Sahasrabuddhe
  10  * Copyright (C) 2005 $ThePhpWikiProgrammingTeam
  11  * Copyright (C) 2008 Alcatel-Lucent
  12  *
  13  * This file is part of PhpWiki.
  14  *
  15  * PhpWiki is free software; you can redistribute it and/or modify
  16  * it under the terms of the GNU General Public License as published by
  17  * the Free Software Foundation; either version 2 of the License, or
  18  * (at your option) any later version.
  19  *
  20  * PhpWiki is distributed in the hope that it will be useful,
  21  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23  * GNU General Public License for more details.
  24  *
  25  * You should have received a copy of the GNU General Public License
  26  * along with PhpWiki; if not, write to the Free Software
  27  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  28 */
  29
  30 /*
  31  * Standard Alcatel-Lucent disclaimer for contributing to open source
  32  *
  33  * "The MediawikiTablePlugin ("Contribution") has not been tested and/or
  34  * validated for release as or in products, combinations with products or
  35  * other commercial use. Any use of the Contribution is entirely made at
  36  * the user's own responsibility and the user can not rely on any features,
  37  * functionalities or performances Alcatel-Lucent has attributed to the
  38  * Contribution.
  39  *
  40  * THE CONTRIBUTION BY ALCATEL-LUCENT IS PROVIDED AS IS, WITHOUT WARRANTY
  41  * OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  42  * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, COMPLIANCE,
  43  * NON-INTERFERENCE AND/OR INTERWORKING WITH THE SOFTWARE TO WHICH THE
  44  * CONTRIBUTION HAS BEEN MADE, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL
  45  * ALCATEL-LUCENT BE LIABLE FOR ANY DAMAGES OR OTHER LIABLITY, WHETHER IN
  46  * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  47  * CONTRIBUTION OR THE USE OR OTHER DEALINGS IN THE CONTRIBUTION, WHETHER
  48  * TOGETHER WITH THE SOFTWARE TO WHICH THE CONTRIBUTION RELATES OR ON A STAND
  49  * ALONE BASIS."
  50  */
  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 getVersion() {
  68         return preg_replace("/[Revision: $]/", '',
  69                             "\$Revision: 1.3 $");
  70     }
  71
  72     function run($dbi, $argstr, &$request, $basepage) {
  73         global $WikiTheme;
  74         include_once("lib/BlockParser.php");
  75         // MediawikiTablePlugin markup is new.
  76         $markup = 2.0;
  77
  78         // We allow the compact Mediawiki syntax with:
  79         // - multiple cells on the same line (separated by "||"),
  80         // - multiple header cells on the same line (separated by "!!").
  81         $argstr = str_replace("||", "\n|", $argstr);
  82         $argstr = str_replace("!!", "\n!", $argstr);
  83
  84         $lines = preg_split('/\n/', $argstr);
  85         $table = HTML::table();
  86
  87         if (substr($lines[0],0,2) == "{|") {
  88             // Start of table
  89             $lines[0] = substr($lines[0],2);
  90         }
  91         if (($lines[0][0] != '|') and ($lines[0][0] != '!')) {
  92             $line = array_shift($lines);
  93             $attrs = $this->_parse_attr($line);
  94             foreach ($attrs as $key => $value) {
  95                 if (in_array ($key, array("id", "class", "title", "style",
  96                                           "bgcolor", "frame", "rules", "border",
  97                                           "cellspacing", "cellpadding",
  98                                           "summary", "align", "width"))) {
  99                     $table->setAttr($key, $value);
 100                 }
 101             }
 102         }
 103
 104         foreach ($lines as $line){
 105             if (substr($line,0,2) == "|}") {
 106                 // End of table
 107                 continue;
 108             }
 109             if (substr($line,0,2) == "|-") {
 110                 if (isset($row)) {
 111                     if (isset($cell)) {
 112                         if (isset($content)) {
 113                             $cell->pushContent(TransformText(trim($content), $markup, $basepage));
 114                             unset($content);
 115                         }
 116                         $row->pushContent($cell);
 117                         unset($cell);
 118                     }
 119                     $tbody->pushContent($row);
 120                     $table->pushContent($tbody);
 121                     $tbody = HTML::tbody();
 122                 }
 123                 $row = HTML::tr();
 124                 $attrs = $this->_parse_attr(substr($line,2));
 125                 foreach ($attrs as $key => $value) {
 126                     if (in_array ($key, array("id", "class", "title", "style",
 127                                               "bgcolor", "align", "valign"))) {
 128                         $row->setAttr($key, $value);
 129                     }
 130                 }
 131                 continue;
 132             }
 133
 134             // Table caption
 135             if (substr($line,0,2) == "|+") {
 136
 137                 $caption = HTML::caption();
 138                 $line = substr($line,2);
 139                 $pospipe = strpos($line, "|");
 140                 $posbracket = strpos($line, "[");
 141                 if (($pospipe) && ((!$posbracket) || ($posbracket > $pospipe))) {
 142                     $attrs = $this->_parse_attr(substr($line, 0, $pospipe));
 143                     foreach ($attrs as $key => $value) {
 144                         if (in_array ($key, array("id", "class", "title", "style",
 145                                                   "align", "lang"))) {
 146                             $caption->setAttr($key, $value);
 147                         }
 148                     }
 149                     $line=substr($line, $pospipe+1);
 150                 }
 151
 152                 $caption->pushContent(trim($line));
 153                 $table->pushContent($caption);
 154             }
 155
 156             if (((substr($line,0,1) == "|") or (substr($line,0,1) == "!")) and isset($row)) {
 157                 if (isset($cell)) {
 158                     if (isset ($content)) {
 159                         $cell->pushContent(TransformText(trim($content), $markup, $basepage));
 160                         unset($content);
 161                     }
 162                     $row->pushContent($cell);
 163                 }
 164                 if (substr($line,0,1) == "!") {
 165                     $cell = HTML::th();   // Header
 166                     $tbody = HTML::thead();
 167                 } else {
 168                     $cell = HTML::td();
 169                     $tbody = HTML::tbody();
 170                 }
 171                 $line = substr($line, 1);
 172
 173                 // If there is a "|" in the line, the start of line
 174                 // (before the "|") is made of attributes.
 175                 // The end of the line (after the "|") is the cell content
 176                 // This is not true if the pipe is inside []
 177                 // | [foo|bar]
 178                 // The following cases must work:
 179                 // | foo
 180                 // | [foo|bar]
 181                 // | class="xxx" | foo
 182                 // | class="xxx" | [foo|bar]
 183                 $pospipe = strpos($line, "|");
 184                 $posbracket = strpos($line, "[");
 185                 if (($pospipe) && ((!$posbracket) || ($posbracket > $pospipe))) {
 186                     $attrs = $this->_parse_attr(substr($line, 0, $pospipe));
 187                     foreach ($attrs as $key => $value) {
 188                         if (in_array ($key, array("id", "class", "title", "style",
 189                                                   "colspan", "rowspan", "width", "height",
 190                                                   "bgcolor", "align", "valign"))) {
 191                             $cell->setAttr($key, $value);
 192                         }
 193                     }
 194                     $line=substr($line, $pospipe+1);
 195                     $cell->pushContent(TransformText(trim($line), $markup, $basepage));
 196                     continue;
 197                 }
 198             }
 199             if (isset($row) and isset($cell)) {
 200                 $line = str_replace("?\>", "?>", $line);
 201                 $line = str_replace("\~", "~", $line);
 202                 if (empty($content)) $content = '';
 203                 $content .= $line . "\n";
 204             }
 205         }
 206         if (isset($row)) {
 207             if (isset($cell)) {
 208                 if (isset($content))
 209                     $cell->pushContent(TransformText(trim($content)));
 210                 $row->pushContent($cell);
 211             }
 212             $tbody->pushContent($row);
 213             $table->pushContent($tbody);
 214         }
 215         return $table;
 216     }
 217
 218     function _parse_attr($line) {
 219         // We allow attributes with or without quotes (")
 220         // border=1, cellpadding="5"
 221         // style="font-family: sans-serif; border-top:1px solid #dddddd;"
 222         // What will not work is style with comma inside, e. g.
 223         // style="font-family: Verdana, Arial, Helvetica, sans-serif"
 224         $attr_chunks = preg_split("/\s*,\s*/", strtolower($line));
 225         $options = array();
 226         foreach ($attr_chunks as $attr_pair) {
 227             if (empty($attr_pair)) continue;
 228             $key_val = preg_split("/\s*=\s*/", $attr_pair);
 229             if (!empty($key_val[1]))
 230                 $options[trim($key_val[0])] = trim(str_replace("\"", "", $key_val[1]));
 231         }
 232         return $options;
 233     }
 234 }
 235
 236 // $Log: not supported by cvs2svn $
 237 // Revision 1.2  2008/04/04 18:13:49  vargenau
 238 // Add tbody to table
 239 //
 240 // Revision 1.1  2008/01/31 20:40:10  vargenau
 241 // Implemented Mediawiki-like syntax for tables
 242 //
 243 //
 244
 245 // For emacs users
 246 // Local Variables:
 247 // mode: php
 248 // tab-width: 8
 249 // c-basic-offset: 4
 250 // c-hanging-comment-ender-p: nil
 251 // indent-tabs-mode: nil
 252 // End:
 253 ?>