lib/PageType.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id: PageType.php,v 1.42 2005-02-02 19:36:56 rurban Exp $');
   3 /*
   4  Copyright 1999,2000,2001,2002,2003,2004,2005 $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
  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 require_once('lib/CachedMarkup.php');
  24
  25 /** A cacheable formatted wiki page.
  26  */
  27 class TransformedText extends CacheableMarkup {
  28     /** Constructor.
  29      *
  30      * @param WikiDB_Page $page
  31      * @param string $text  The packed page revision content.
  32      * @param hash $meta    The version meta-data.
  33      * @param string $type_override  For markup of page using a different
  34      *        pagetype than that specified in its version meta-data.
  35      */
  36     function TransformedText($page, $text, $meta, $type_override=false) {
  37         $pagetype = false;
  38         if ($type_override)
  39             $pagetype = $type_override;
  40         elseif (isset($meta['pagetype']))
  41             $pagetype = $meta['pagetype'];
  42         $this->_type = PageType::GetPageType($pagetype);
  43         $this->CacheableMarkup($this->_type->transform($page, $text, $meta),
  44                                $page->getName());
  45     }
  46
  47     function getType() {
  48         return $this->_type;
  49     }
  50 }
  51
  52 /**
  53  * A page type descriptor.
  54  *
  55  * Encapsulate information about page types.
  56  *
  57  * Currently the only information encapsulated is how to format
  58  * the specific page type.  In the future or capabilities may be
  59  * added, e.g. the abilities to edit different page types (differently.)
  60  * e.g. Support for the javascript htmlarea editor, which can only edit
  61  * pure HTML.
  62  *
  63  * IMPORTANT NOTE: Since the whole PageType class gets stored (serialized)
  64  * as of the cached marked-up page, it is important that the PageType classes
  65  * not have large amounts of class data.  (No class data is even better.)
  66  */
  67 class PageType {
  68     /**
  69      * Get a page type descriptor.
  70      *
  71      * This is a static member function.
  72      *
  73      * @param string $pagetype  Name of the page type.
  74      * @return PageType  An object which is a subclass of PageType.
  75      */
  76     function GetPageType ($name=false) {
  77         if (!$name)
  78             $name = 'wikitext';
  79         $class = "PageType_" . (string)$name;
  80         if (class_exists($class))
  81             return new $class;
  82         trigger_error(sprintf("PageType '%s' unknown", (string)$name),
  83                       E_USER_WARNING);
  84         return new PageType_wikitext;
  85     }
  86
  87     /**
  88      * Get the name of this page type.
  89      *
  90      * @return string  Page type name.
  91      */
  92     function getName() {
  93         if (!preg_match('/^PageType_(.+)$/i', get_class($this), $m))
  94             trigger_error("Bad class name for formatter(?)", E_USER_ERROR);
  95         return $m[1];
  96     }
  97
  98     /**
  99      * Transform page text.
 100      *
 101      * @param WikiDB_Page $page
 102      * @param string $text
 103      * @param hash $meta Version meta-data
 104      * @return XmlContent The transformed page text.
 105      */
 106     function transform(&$page, &$text, $meta) {
 107         $fmt_class = 'PageFormatter_' . $this->getName();
 108         $formatter = new $fmt_class($page, $meta);
 109         return $formatter->format($text);
 110     }
 111 }
 112
 113 class PageType_wikitext extends PageType {}
 114 class PageType_html extends PageType {}
 115 class PageType_pdf extends PageType {}
 116
 117 class PageType_wikiblog extends PageType {}
 118 class PageType_comment extends PageType {}
 119 class PageType_wikiforum extends PageType {}
 120
 121 /* To prevent from PHP5 Fatal error: Using $this when not in object context */
 122 function getInterwikiMap ($pagetext = false) {
 123     $map = new PageType_interwikimap($pagetext);
 124     return $map;
 125 }
 126
 127 class PageType_interwikimap extends PageType
 128 {
 129     function PageType_interwikimap($pagetext = false) {
 130         if (!$pagetext) {
 131             $dbi = $GLOBALS['request']->getDbh();
 132             $page = $dbi->getPage(_("InterWikiMap"));
 133             if ($page->get('locked')) {
 134                 $current = $page->getCurrentRevision();
 135                 $pagetext = $current->getPackedContent();
 136                 $intermap = $this->_getMapFromWikiText($pagetext);
 137             } elseif ($page->exists()) {
 138                 trigger_error(_("WARNING: InterWikiMap page is unlocked, so not using those links."));
 139                 $intermap = false;
 140             }
 141             else
 142                 $intermap = false;
 143         } else {
 144             $intermap = $this->_getMapFromWikiText($pagetext);
 145         }
 146         if (!$intermap && defined('INTERWIKI_MAP_FILE'))
 147             $intermap = $this->_getMapFromFile(INTERWIKI_MAP_FILE);
 148
 149         $this->_map = $this->_parseMap($intermap);
 150         $this->_regexp = $this->_getRegexp();
 151     }
 152
 153     function GetMap ($pagetext = false) {
 154         /*PHP5 Fatal error: Using $this when not in object context */
 155         if (empty($this->_map)) {
 156             $map = new PageType_interwikimap($pagetext);
 157             return $map;
 158         } else {
 159             return $this;
 160         }
 161     }
 162
 163     function getRegexp() {
 164         return $this->_regexp;
 165     }
 166
 167     function link ($link, $linktext = false) {
 168         list ($moniker, $page) = split (":", $link, 2);
 169
 170         if (!isset($this->_map[$moniker])) {
 171             return HTML::span(array('class' => 'bad-interwiki'),
 172                               $linktext ? $linktext : $link);
 173         }
 174
 175         $url = $this->_map[$moniker];
 176
 177         // Urlencode page only if it's a query arg.
 178         // FIXME: this is a somewhat broken heuristic.
 179         $page_enc = strstr($url, '?') ? rawurlencode($page) : $page;
 180
 181         if (strstr($url, '%s'))
 182             $url = sprintf($url, $page_enc);
 183         else
 184             $url .= $page_enc;
 185
 186         $link = HTML::a(array('href' => $url));
 187
 188         if (!$linktext) {
 189             $link->pushContent(PossiblyGlueIconToText('interwiki', "$moniker:"),
 190                                HTML::span(array('class' => 'wikipage'), $page));
 191             $link->setAttr('class', 'interwiki');
 192         }
 193         else {
 194             $link->pushContent(PossiblyGlueIconToText('interwiki', $linktext));
 195             $link->setAttr('class', 'named-interwiki');
 196         }
 197
 198         return $link;
 199     }
 200
 201
 202     function _parseMap ($text) {
 203         if (!preg_match_all("/^\s*(\S+)\s+(\S+)/m",
 204                             $text, $matches, PREG_SET_ORDER))
 205             return false;
 206
 207         foreach ($matches as $m) {
 208             $map[$m[1]] = $m[2];
 209         }
 210
 211         // Add virtual monikers: Upload:, Talk:, User:
 212         // Upload: Should be expanded later to user-specific upload dirs.
 213         // In the Upload plugin, not here: Upload:ReiniUrban/uploaded-file.png
 214         if (empty($map['Upload']))
 215             $map['Upload'] = getUploadDataPath();
 216         if (empty($map["Talk"])) {
 217             $pagename = $GLOBALS['request']->getArg('pagename');
 218             if (string_ends_with($pagename, SUBPAGE_SEPARATOR._("Discussion")))
 219                 $map["Talk"] = WikiURL($pagename);
 220             else
 221                 $map["Talk"] = WikiURL($pagename.SUBPAGE_SEPARATOR._("Discussion"));
 222         }
 223         // User:ReiniUrban => ReiniUrban or Users/ReiniUrban
 224         // Can be easily overriden by a customized InterWikiMap:
 225         //   User Users/%s
 226         if (empty($map["User"])) {
 227             $map["User"] = "%s";
 228         }
 229
 230         // Maybe add other monikers also (SemanticWeb link predicates?)
 231         // Should they be defined in a RDF? (strict mode)
 232         // Or should the SemanticWeb lib add it by itself?
 233         // (adding only a subset dependent on the context = model)
 234         return $map;
 235     }
 236
 237     function _getMapFromWikiText ($pagetext) {
 238         if (preg_match('|^<verbatim>\n(.*)^</verbatim>|ms', $pagetext, $m)) {
 239             return $m[1];
 240         }
 241         return false;
 242     }
 243
 244     function _getMapFromFile ($filename) {
 245         if (defined('WARN_NONPUBLIC_INTERWIKIMAP') and WARN_NONPUBLIC_INTERWIKIMAP) {
 246             $error_html = sprintf(_("Loading InterWikiMap from external file %s."), $filename);
 247             trigger_error( $error_html, E_USER_NOTICE );
 248         }
 249         if (!file_exists($filename)) {
 250             $finder = new FileFinder();
 251             $filename = $finder->findFile(INTERWIKI_MAP_FILE);
 252         }
 253         @$fd = fopen ($filename, "rb");
 254         @$data = fread ($fd, filesize($filename));
 255         @fclose ($fd);
 256
 257         return $data;
 258     }
 259
 260     function _getRegexp () {
 261         if (!$this->_map)
 262             return '(?:(?!a)a)'; //  Never matches.
 263
 264         foreach (array_keys($this->_map) as $moniker)
 265             $qkeys[] = preg_quote($moniker, '/');
 266         return "(?:" . join("|", $qkeys) . ")";
 267     }
 268 }
 269
 270
 271 /** How to transform text.
 272  */
 273 class PageFormatter {
 274     /** Constructor.
 275      *
 276      * @param WikiDB_Page $page
 277      * @param hash $meta Version meta-data.
 278      */
 279     function PageFormatter(&$page, $meta) {
 280         $this->_page = $page;
 281         $this->_meta = $meta;
 282         if (!empty($meta['markup']))
 283             $this->_markup = $meta['markup'];
 284         else
 285             $this->_markup = 1; // dump used old-markup as empty.
 286         // to be able to restore it we must keep markup 1 as default.
 287         // new policy: default = new markup (old crashes quite often)
 288     }
 289
 290     function _transform(&$text) {
 291         include_once('lib/BlockParser.php');
 292         return TransformText($text, $this->_markup);
 293     }
 294
 295     /** Transform the page text.
 296      *
 297      * @param string $text  The raw page content (e.g. wiki-text).
 298      * @return XmlContent   Transformed content.
 299      */
 300     function format($text) {
 301         trigger_error("pure virtual", E_USER_ERROR);
 302     }
 303 }
 304
 305 class PageFormatter_wikitext extends PageFormatter
 306 {
 307     function format(&$text) {
 308         return HTML::div(array('class' => 'wikitext'),
 309                          $this->_transform($text));
 310     }
 311 }
 312
 313 class PageFormatter_interwikimap extends PageFormatter
 314 {
 315     function format($text) {
 316         return HTML::div(array('class' => 'wikitext'),
 317                          $this->_transform($this->_getHeader($text)),
 318                          $this->_formatMap($text),
 319                          $this->_transform($this->_getFooter($text)));
 320     }
 321
 322     function _getHeader($text) {
 323         return preg_replace('/<verbatim>.*/s', '', $text);
 324     }
 325
 326     function _getFooter($text) {
 327         return preg_replace('@.*?(</verbatim>|\Z)@s', '', $text, 1);
 328     }
 329
 330     function _getMap($pagetext) {
 331         $map = getInterwikiMap($pagetext);
 332         return $map->_map;
 333     }
 334
 335     function _formatMap($pagetext) {
 336         $map = $this->_getMap($pagetext);
 337         if (!$map)
 338             return HTML::p("<No interwiki map found>"); // Shouldn't happen.
 339
 340         $mon_attr = array('class' => 'interwiki-moniker');
 341         $url_attr = array('class' => 'interwiki-url');
 342
 343         $thead = HTML::thead(HTML::tr(HTML::th($mon_attr, _("Moniker")),
 344                                       HTML::th($url_attr, _("InterWiki Address"))));
 345         foreach ($map as $moniker => $interurl) {
 346             $rows[] = HTML::tr(HTML::td($mon_attr, new Cached_WikiLinkIfKnown($moniker)),
 347                                HTML::td($url_attr, HTML::tt($interurl)));
 348         }
 349
 350         return HTML::table(array('class' => 'interwiki-map'),
 351                            $thead,
 352                            HTML::tbody(false, $rows));
 353     }
 354 }
 355
 356 class FakePageRevision {
 357     function FakePageRevision($meta) {
 358         $this->_meta = $meta;
 359     }
 360
 361     function get($key) {
 362         if (empty($this->_meta[$key]))
 363             return false;
 364         return $this->_meta[$key];
 365     }
 366 }
 367
 368 // abstract base class
 369 class PageFormatter_attach extends PageFormatter
 370 {
 371     var $type, $prefix;
 372
 373     // Display templated contents for wikiblog, comment and wikiforum
 374     function format($text) {
 375         if (empty($this->type))
 376             trigger_error('PageFormatter_attach->format: $type missing');
 377         include_once('lib/Template.php');
 378         global $request;
 379         $tokens['CONTENT'] = $this->_transform($text);
 380         $tokens['page'] = $this->_page;
 381         $tokens['rev'] = new FakePageRevision($this->_meta);
 382
 383         $name = new WikiPageName($this->_page->getName());
 384         $tokens[$this->prefix."_PARENT"] = $name->getParent();
 385
 386         $meta = $this->_meta[$this->type];
 387         foreach(array('ctime', 'creator', 'creator_id') as $key)
 388             $tokens[$this->prefix . "_" . strtoupper($key)] = $meta[$key];
 389
 390         return new Template($this->type, $request, $tokens);
 391     }
 392 }
 393
 394 class PageFormatter_wikiblog extends PageFormatter_attach {
 395     var $type = 'wikiblog', $prefix = "BLOG";
 396 }
 397 class PageFormatter_comment extends PageFormatter_attach {
 398     var $type = 'comment', $prefix = "COMMENT";
 399 }
 400 class PageFormatter_wikiforum extends PageFormatter_attach {
 401     var $type = 'wikiforum', $prefix = "FORUM";
 402 }
 403
 404 /** wikiabuse for htmlarea editing. not yet used.
 405  *
 406  * Warning! Once a page is edited with a htmlarea like control it is
 407  * stored in HTML and cannot be converted back to WikiText as long as
 408  * we have no HTML => WikiText or any other interim format (WikiExchangeFormat e.g. XML)
 409  * converter. See lib/HtmlParser.php for ongoing work on that.
 410  * So it has a viral effect and certain plugins will not work anymore.
 411  * But a lot of wikiusers seem to like it.
 412  */
 413 class PageFormatter_html extends PageFormatter
 414 {
 415     function _transform($text) {
 416         return $text;
 417     }
 418     function format($text) {
 419         return $text;
 420     }
 421 }
 422
 423 /**
 424  *  FIXME. not yet used
 425  */
 426 class PageFormatter_pdf extends PageFormatter
 427 {
 428
 429     function _transform($text) {
 430         include_once('lib/BlockParser.php');
 431         return TransformText($text, $this->_markup);
 432     }
 433
 434     // one page or set of pages?
 435     // here we try to format only a single page
 436     function format($text) {
 437         include_once('lib/Template.php');
 438         global $request;
 439         $tokens['page']    = $this->_page;
 440         $tokens['CONTENT'] = $this->_transform($text);
 441         $pagename = $this->_page->getName();
 442
 443         // This is a XmlElement tree, which must be converted to PDF
 444
 445         // We can make use of several pdf extensions. This one - fpdf
 446         // - is pure php and very easy, but looks quite ugly and has a
 447         // terrible interface, as terrible as most of the othes.
 448         // The closest to HTML is htmldoc which needs an external cgi
 449         // binary.
 450         // We use a custom HTML->PDF class converter from PHPWebthings
 451         // to be able to use templates for PDF.
 452         require_once('lib/fpdf.php');
 453         require_once('lib/pdf.php');
 454
 455         $pdf = new PDF();
 456         $pdf->SetTitle($pagename);
 457         $pdf->SetAuthor($this->_page->get('author'));
 458         $pdf->SetCreator(WikiURL($pagename,false,1));
 459         $pdf->AliasNbPages();
 460         $pdf->AddPage();
 461         //TODO: define fonts
 462         $pdf->SetFont('Times','',12);
 463         //$pdf->SetFont('Arial','B',16);
 464
 465         // PDF pagelayout from a special template
 466         $template = new Template('pdf', $request, $tokens);
 467         $pdf->ConvertFromHTML($template);
 468
 469         // specify filename, destination
 470         $pdf->Output($pagename.".pdf",'I'); // I for stdin or D for download
 471
 472         // Output([string name [, string dest]])
 473         return $pdf;
 474     }
 475 }
 476 // $Log: not supported by cvs2svn $
 477 // Revision 1.41  2005/02/02 19:34:09  rurban
 478 // more maps: Talk, User
 479 //
 480 // Revision 1.40  2005/01/31 12:15:08  rurban
 481 // avoid some cornercase intermap warning. Thanks to Stefan <sonstiges@bayern-mail.de>
 482 //
 483 // Revision 1.39  2005/01/25 06:59:35  rurban
 484 // fix bogus InterWikiMap warning
 485 //
 486 // Revision 1.38  2004/12/26 17:10:44  rurban
 487 // just docs or whitespace
 488 //
 489 // Revision 1.37  2004/12/06 19:49:55  rurban
 490 // enable action=remove which is undoable and seeable in RecentChanges: ADODB ony for now.
 491 // renamed delete_page to purge_page.
 492 // enable action=edit&version=-1 to force creation of a new version.
 493 // added BABYCART_PATH config
 494 // fixed magiqc in adodb.inc.php
 495 // and some more docs
 496 //
 497
 498 // Local Variables:
 499 // mode: php
 500 // tab-width: 8
 501 // c-basic-offset: 4
 502 // c-hanging-comment-ender-p: nil
 503 // indent-tabs-mode: nil
 504 // End:
 505 ?>