lib/html.php

   1 <?php
   2 // PukiWiki - Yet another WikiWikiWeb clone.
   3 // $Id: html.php,v 1.51 2006/04/10 13:15:15 henoheno Exp $
   4 // Copyright (C)
   5 //   2002-2006 PukiWiki Developers Team
   6 //   2001-2002 Originally written by yu-ji
   7 // License: GPL v2 or (at your option) any later version
   8 //
   9 // HTML-publishing related functions
  10
  11 // Show page-content
  12 function catbody($title, $page, $body)
  13 {
  14         global $script, $vars, $arg, $defaultpage, $whatsnew, $help_page, $hr;
  15         global $attach_link, $related_link, $cantedit, $function_freeze;
  16         global $search_word_color, $_msg_word, $foot_explain, $note_hr, $head_tags;
  17         global $trackback, $trackback_javascript, $referer, $javascript;
  18         global $nofollow;
  19         global $_LANG, $_LINK, $_IMAGE;
  20
  21         global $pkwk_dtd;     // XHTML 1.1, XHTML1.0, HTML 4.01 Transitional...
  22         global $page_title;   // Title of this site
  23         global $do_backup;    // Do backup or not
  24         global $modifier;     // Site administrator's  web page
  25         global $modifierlink; // Site administrator's name
  26
  27         if (! file_exists(SKIN_FILE) || ! is_readable(SKIN_FILE))
  28                 die_message('SKIN_FILE is not found');
  29
  30         $_LINK = $_IMAGE = array();
  31
  32         // Add JavaScript header when ...
  33         if ($trackback && $trackback_javascript) $javascript = 1; // Set something If you want
  34         if (! PKWK_ALLOW_JAVASCRIPT) unset($javascript);
  35
  36         $_page  = isset($vars['page']) ? $vars['page'] : '';
  37         $r_page = rawurlencode($_page);
  38
  39         // Set $_LINK for skin
  40         $_LINK['add']      = "$script?cmd=add&amp;page=$r_page";
  41         $_LINK['backup']   = "$script?cmd=backup&amp;page=$r_page";
  42         $_LINK['copy']     = "$script?plugin=template&amp;refer=$r_page";
  43         $_LINK['diff']     = "$script?cmd=diff&amp;page=$r_page";
  44         $_LINK['edit']     = "$script?cmd=edit&amp;page=$r_page";
  45         $_LINK['filelist'] = "$script?cmd=filelist";
  46         $_LINK['freeze']   = "$script?cmd=freeze&amp;page=$r_page";
  47         $_LINK['help']     = "$script?" . rawurlencode($help_page);
  48         $_LINK['list']     = "$script?cmd=list";
  49         $_LINK['new']      = "$script?plugin=newpage&amp;refer=$r_page";
  50         $_LINK['rdf']      = "$script?cmd=rss&amp;ver=1.0";
  51         $_LINK['recent']   = "$script?" . rawurlencode($whatsnew);
  52         $_LINK['refer']    = "$script?plugin=referer&amp;page=$r_page";
  53         $_LINK['reload']   = "$script?$r_page";
  54         $_LINK['rename']   = "$script?plugin=rename&amp;refer=$r_page";
  55         $_LINK['rss']      = "$script?cmd=rss";
  56         $_LINK['rss10']    = "$script?cmd=rss&amp;ver=1.0"; // Same as 'rdf'
  57         $_LINK['rss20']    = "$script?cmd=rss&amp;ver=2.0";
  58         $_LINK['search']   = "$script?cmd=search";
  59         $_LINK['top']      = "$script?" . rawurlencode($defaultpage);
  60         if ($trackback) {
  61                 $tb_id = tb_get_id($_page);
  62                 $_LINK['trackback'] = "$script?plugin=tb&amp;__mode=view&amp;tb_id=$tb_id";
  63         }
  64         $_LINK['unfreeze'] = "$script?cmd=unfreeze&amp;page=$r_page";
  65         $_LINK['upload']   = "$script?plugin=attach&amp;pcmd=upload&amp;page=$r_page";
  66
  67         // Compat: Skins for 1.4.4 and before
  68         $link_add       = & $_LINK['add'];
  69         $link_new       = & $_LINK['new'];      // New!
  70         $link_edit      = & $_LINK['edit'];
  71         $link_diff      = & $_LINK['diff'];
  72         $link_top       = & $_LINK['top'];
  73         $link_list      = & $_LINK['list'];
  74         $link_filelist  = & $_LINK['filelist'];
  75         $link_search    = & $_LINK['search'];
  76         $link_whatsnew  = & $_LINK['recent'];
  77         $link_backup    = & $_LINK['backup'];
  78         $link_help      = & $_LINK['help'];
  79         $link_trackback = & $_LINK['trackback'];        // New!
  80         $link_rdf       = & $_LINK['rdf'];              // New!
  81         $link_rss       = & $_LINK['rss'];
  82         $link_rss10     = & $_LINK['rss10'];            // New!
  83         $link_rss20     = & $_LINK['rss20'];            // New!
  84         $link_freeze    = & $_LINK['freeze'];
  85         $link_unfreeze  = & $_LINK['unfreeze'];
  86         $link_upload    = & $_LINK['upload'];
  87         $link_template  = & $_LINK['copy'];
  88         $link_refer     = & $_LINK['refer'];    // New!
  89         $link_rename    = & $_LINK['rename'];
  90
  91         // Init flags
  92         $is_page = (is_pagename($_page) && ! arg_check('backup') && $_page != $whatsnew);
  93         $is_read = (arg_check('read') && is_page($_page));
  94         $is_freeze = is_freeze($_page);
  95
  96         // Last modification date (string) of the page
  97         $lastmodified = $is_read ?  format_date(get_filetime($_page)) .
  98                 ' ' . get_pg_passage($_page, FALSE) : '';
  99
 100         // List of attached files to the page
 101         $attaches = ($attach_link && $is_read && exist_plugin_action('attach')) ?
 102                 attach_filelist() : '';
 103
 104         // List of related pages
 105         $related  = ($related_link && $is_read) ? make_related($_page) : '';
 106
 107         // List of footnotes
 108         ksort($foot_explain, SORT_NUMERIC);
 109         $notes = ! empty($foot_explain) ? $note_hr . join("\n", $foot_explain) : '';
 110
 111         // Tags will be inserted into <head></head>
 112         $head_tag = ! empty($head_tags) ? join("\n", $head_tags) ."\n" : '';
 113
 114         // 1.3.x compat
 115         // Last modification date (UNIX timestamp) of the page
 116         $fmt = $is_read ? get_filetime($_page) + LOCALZONE : 0;
 117
 118         // Search words
 119         if ($search_word_color && isset($vars['word'])) {
 120                 $body = '<div class="small">' . $_msg_word . htmlspecialchars($vars['word']) .
 121                         '</div>' . $hr . "\n" . $body;
 122
 123                 // BugTrack2/106: Only variables can be passed by reference from PHP 5.0.5
 124                 // with array_splice(), array_flip()
 125                 $words = preg_split('/\s+/', $vars['word'], -1, PREG_SPLIT_NO_EMPTY);
 126                 $words = array_splice($words, 0, 10); // Max: 10 words
 127                 $words = array_flip($words);
 128
 129                 $keys = array();
 130                 foreach ($words as $word=>$id) $keys[$word] = strlen($word);
 131                 arsort($keys, SORT_NUMERIC);
 132                 $keys = get_search_words(array_keys($keys), TRUE);
 133                 $id = 0;
 134                 foreach ($keys as $key=>$pattern) {
 135                         $s_key    = htmlspecialchars($key);
 136                         $pattern  = '/' .
 137                                 '<textarea[^>]*>.*?<\/textarea>' .      // Ignore textareas
 138                                 '|' . '<[^>]*>' .                       // Ignore tags
 139                                 '|' . '&[^;]+;' .                       // Ignore entities
 140                                 '|' . '(' . $pattern . ')' .            // $matches[1]: Regex for a search word
 141                                 '/s';
 142                         $decorate_Nth_word = create_function(
 143                                 '$matches',
 144                                 'return (isset($matches[1])) ? ' .
 145                                         '\'<strong class="word' .
 146                                                 $id .
 147                                         '">\' . $matches[1] . \'</strong>\' : ' .
 148                                         '$matches[0];'
 149                         );
 150                         $body  = preg_replace_callback($pattern, $decorate_Nth_word, $body);
 151                         $notes = preg_replace_callback($pattern, $decorate_Nth_word, $notes);
 152                         ++$id;
 153                 }
 154         }
 155
 156         $longtaketime = getmicrotime() - MUTIME;
 157         $taketime     = sprintf('%01.03f', $longtaketime);
 158
 159         require(SKIN_FILE);
 160 }
 161
 162 // Show 'edit' form
 163 function edit_form($page, $postdata, $digest = FALSE, $b_template = TRUE)
 164 {
 165         global $script, $vars, $rows, $cols, $hr, $function_freeze;
 166         global $_btn_preview, $_btn_repreview, $_btn_update, $_btn_cancel,
 167                 $_msg_help, $_btn_notchangetimestamp;
 168         global $whatsnew, $_btn_template, $_btn_load, $load_template_func;
 169         global $notimeupdate;
 170
 171         // Newly generate $digest or not
 172         if ($digest === FALSE) $digest = md5(join('', get_source($page)));
 173
 174         $refer = $template = '';
 175         $checked_time = isset($vars['notimestamp']) ? ' checked="checked"' : '';
 176
 177         // Add plugin
 178         $addtag = $add_top = '';
 179         if(isset($vars['add'])) {
 180                 global $_btn_addtop;
 181                 $addtag  = '<input type="hidden" name="add"    value="true" />';
 182                 $add_top = isset($vars['add_top']) ? ' checked="checked"' : '';
 183                 $add_top = '<input type="checkbox" name="add_top" ' .
 184                         'id="_edit_form_add_top" value="true"' . $add_top . ' />' . "\n" .
 185                         '  <label for="_edit_form_add_top">' .
 186                                 '<span class="small">' . $_btn_addtop . '</span>' .
 187                         '</label>';
 188         }
 189
 190         if($load_template_func && $b_template) {
 191                 $pages  = array();
 192                 foreach(get_existpages() as $_page) {
 193                         if ($_page == $whatsnew || check_non_list($_page))
 194                                 continue;
 195                         $s_page = htmlspecialchars($_page);
 196                         $pages[$_page] = '   <option value="' . $s_page . '">' .
 197                                 $s_page . '</option>';
 198                 }
 199                 ksort($pages);
 200                 $s_pages  = join("\n", $pages);
 201                 $template = <<<EOD
 202   <select name="template_page">
 203    <option value="">-- $_btn_template --</option>
 204 $s_pages
 205   </select>
 206   <input type="submit" name="template" value="$_btn_load" accesskey="r" />
 207   <br />
 208 EOD;
 209
 210                 if (isset($vars['refer']) && $vars['refer'] != '')
 211                         $refer = '[[' . strip_bracket($vars['refer']) . ']]' . "\n\n";
 212         }
 213
 214         $r_page      = rawurlencode($page);
 215         $s_page      = htmlspecialchars($page);
 216         $s_digest    = htmlspecialchars($digest);
 217         $s_postdata  = htmlspecialchars($refer . $postdata);
 218         $s_original  = isset($vars['original']) ? htmlspecialchars($vars['original']) : $s_postdata;
 219         $b_preview   = isset($vars['preview']); // TRUE when preview
 220         $btn_preview = $b_preview ? $_btn_repreview : $_btn_preview;
 221
 222         $add_notimestamp = '';
 223         if ( $notimeupdate != 0 ) {
 224                 // enable 'do not change timestamp'
 225                 $add_notimestamp = <<<EOD
 226 <input type="checkbox" name="notimestamp" id="_edit_form_notimestamp" value="true"$checked_time />
 227   <label for="_edit_form_notimestamp"><span class="small">$_btn_notchangetimestamp</span></label>
 228 EOD;
 229                 if ( $notimeupdate == 2 ) {
 230                         // enable only administrator
 231                         $add_notimestamp .= <<<EOD
 232   <input type="password" name="pass" size="12" />
 233 EOD;
 234                 }
 235                 $add_notimestamp .= '&nbsp;';
 236         }
 237
 238         $body = <<<EOD
 239 <div class="edit_form">
 240  <form action="$script" method="post">
 241 $template
 242   $addtag
 243   <input type="hidden" name="cmd"    value="edit" />
 244   <input type="hidden" name="page"   value="$s_page" />
 245   <input type="hidden" name="digest" value="$s_digest" />
 246   <textarea name="msg" rows="$rows" cols="$cols">$s_postdata</textarea>
 247   <br />
 248   <div style="float:left;">
 249    <input type="submit" name="preview" value="$btn_preview" accesskey="p" />
 250    <input type="submit" name="write"   value="$_btn_update" accesskey="s" />
 251    $add_top
 252    $add_notimestamp
 253   </div>
 254   <textarea name="original" rows="1" cols="1" style="display:none">$s_original</textarea>
 255  </form>
 256  <form action="$script" method="post">
 257   <input type="hidden" name="cmd"    value="edit" />
 258   <input type="hidden" name="page"   value="$s_page" />
 259   <input type="submit" name="cancel" value="$_btn_cancel" accesskey="c" />
 260  </form>
 261 </div>
 262 EOD;
 263
 264         if (isset($vars['help'])) {
 265                 $body .= $hr . catrule();
 266         } else {
 267                 $body .= '<ul><li><a href="' .
 268                         $script . '?cmd=edit&amp;help=true&amp;page=' . $r_page .
 269                         '">' . $_msg_help . '</a></li></ul>';
 270         }
 271
 272         return $body;
 273 }
 274
 275 // Related pages
 276 function make_related($page, $tag = '')
 277 {
 278         global $script, $vars, $rule_related_str, $related_str;
 279         global $_ul_left_margin, $_ul_margin, $_list_pad_str;
 280
 281         $links = links_get_related($page);
 282
 283         if ($tag) {
 284                 ksort($links);
 285         } else {
 286                 arsort($links);
 287         }
 288
 289         $_links = array();
 290         foreach ($links as $page=>$lastmod) {
 291                 if (check_non_list($page)) continue;
 292
 293                 $r_page   = rawurlencode($page);
 294                 $s_page   = htmlspecialchars($page);
 295                 $passage  = get_passage($lastmod);
 296                 $_links[] = $tag ?
 297                         '<a href="' . $script . '?' . $r_page . '" title="' .
 298                         $s_page . ' ' . $passage . '">' . $s_page . '</a>' :
 299                         '<a href="' . $script . '?' . $r_page . '">' .
 300                         $s_page . '</a>' . $passage;
 301         }
 302         if (empty($_links)) return ''; // Nothing
 303
 304         if ($tag == 'p') { // From the line-head
 305                 $margin = $_ul_left_margin + $_ul_margin;
 306                 $style  = sprintf($_list_pad_str, 1, $margin, $margin);
 307                 $retval =  "\n" . '<ul' . $style . '>' . "\n" .
 308                         '<li>' . join($rule_related_str, $_links) . '</li>' . "\n" .
 309                         '</ul>' . "\n";
 310         } else if ($tag) {
 311                 $retval = join($rule_related_str, $_links);
 312         } else {
 313                 $retval = join($related_str, $_links);
 314         }
 315
 316         return $retval;
 317 }
 318
 319 // User-defined rules (convert without replacing source)
 320 function make_line_rules($str)
 321 {
 322         global $line_rules;
 323         static $pattern, $replace;
 324
 325         if (! isset($pattern)) {
 326                 $pattern = array_map(create_function('$a',
 327                         'return \'/\' . $a . \'/\';'), array_keys($line_rules));
 328                 $replace = array_values($line_rules);
 329                 unset($line_rules);
 330         }
 331
 332         return preg_replace($pattern, $replace, $str);
 333 }
 334
 335 // Remove all HTML tags(or just anchor tags), and WikiName-speific decorations
 336 function strip_htmltag($str, $all = TRUE)
 337 {
 338         global $_symbol_noexists;
 339         static $noexists_pattern;
 340
 341         if (! isset($noexists_pattern))
 342                 $noexists_pattern = '#<span class="noexists">([^<]*)<a[^>]+>' .
 343                         preg_quote($_symbol_noexists, '#') . '</a></span>#';
 344
 345         // Strip Dagnling-Link decoration (Tags and "$_symbol_noexists")
 346         $str = preg_replace($noexists_pattern, '$1', $str);
 347
 348         if ($all) {
 349                 // All other HTML tags
 350                 return preg_replace('#<[^>]+>#',        '', $str);
 351         } else {
 352                 // All other anchor-tags only
 353                 return preg_replace('#<a[^>]+>|</a>#i', '', $str);
 354         }
 355 }
 356
 357 // Remove AutoLink marker with AutLink itself
 358 function strip_autolink($str)
 359 {
 360         return preg_replace('#<!--autolink--><a [^>]+>|</a><!--/autolink-->#', '', $str);
 361 }
 362
 363 // Make a backlink. searching-link of the page name, by the page name, for the page name
 364 function make_search($page)
 365 {
 366         global $script;
 367
 368         $s_page = htmlspecialchars($page);
 369         $r_page = rawurlencode($page);
 370
 371         return '<a href="' . $script . '?plugin=related&amp;page=' . $r_page .
 372                 '">' . $s_page . '</a> ';
 373 }
 374
 375 // Make heading string (remove heading-related decorations from Wiki text)
 376 function make_heading(& $str, $strip = TRUE)
 377 {
 378         global $NotePattern;
 379
 380         // Cut fixed-heading anchors
 381         $id = '';
 382         $matches = array();
 383         if (preg_match('/^(\*{0,3})(.*?)\[#([A-Za-z][\w-]+)\](.*?)$/m', $str, $matches)) {
 384                 $str = $matches[2] . $matches[4];
 385                 $id  = & $matches[3];
 386         } else {
 387                 $str = preg_replace('/^\*{0,3}/', '', $str);
 388         }
 389
 390         // Cut footnotes and tags
 391         if ($strip === TRUE)
 392                 $str = strip_htmltag(make_link(preg_replace($NotePattern, '', $str)));
 393
 394         return $id;
 395 }
 396
 397 // Separate a page-name(or URL or null string) and an anchor
 398 // (last one standing) without sharp
 399 function anchor_explode($page, $strict_editable = FALSE)
 400 {
 401         $pos = strrpos($page, '#');
 402         if ($pos === FALSE) return array($page, '', FALSE);
 403
 404         // Ignore the last sharp letter
 405         if ($pos + 1 == strlen($page)) {
 406                 $pos = strpos(substr($page, $pos + 1), '#');
 407                 if ($pos === FALSE) return array($page, '', FALSE);
 408         }
 409
 410         $s_page = substr($page, 0, $pos);
 411         $anchor = substr($page, $pos + 1);
 412
 413         if($strict_editable === TRUE &&  preg_match('/^[a-z][a-f0-9]{7}$/', $anchor)) {
 414                 return array ($s_page, $anchor, TRUE); // Seems fixed-anchor
 415         } else {
 416                 return array ($s_page, $anchor, FALSE);
 417         }
 418 }
 419
 420 // Check HTTP header()s were sent already, or
 421 // there're blank lines or something out of php blocks
 422 function pkwk_headers_sent()
 423 {
 424         if (PKWK_OPTIMISE) return;
 425
 426         $file = $line = '';
 427         if (version_compare(PHP_VERSION, '4.3.0', '>=')) {
 428                 if (headers_sent($file, $line))
 429                     die('Headers already sent at ' .
 430                         htmlspecialchars($file) .
 431                         ' line ' . $line . '.');
 432         } else {
 433                 if (headers_sent())
 434                         die('Headers already sent.');
 435         }
 436 }
 437
 438 // Output common HTTP headers
 439 function pkwk_common_headers()
 440 {
 441         if (! PKWK_OPTIMISE) pkwk_headers_sent();
 442
 443         if(defined('PKWK_ZLIB_LOADABLE_MODULE')) {
 444                 $matches = array();
 445                 if(ini_get('zlib.output_compression') &&
 446                     preg_match('/\b(gzip|deflate)\b/i', $_SERVER['HTTP_ACCEPT_ENCODING'], $matches)) {
 447                         // Bug #29350 output_compression compresses everything _without header_ as loadable module
 448                         // http://bugs.php.net/bug.php?id=29350
 449                         header('Content-Encoding: ' . $matches[1]);
 450                         header('Vary: Accept-Encoding');
 451                 }
 452         }
 453 }
 454
 455 // DTD definitions
 456 define('PKWK_DTD_XHTML_1_1',              17); // Strict only
 457 define('PKWK_DTD_XHTML_1_0',              16); // Strict
 458 define('PKWK_DTD_XHTML_1_0_STRICT',       16);
 459 define('PKWK_DTD_XHTML_1_0_TRANSITIONAL', 15);
 460 define('PKWK_DTD_XHTML_1_0_FRAMESET',     14);
 461 define('PKWK_DTD_HTML_4_01',               3); // Strict
 462 define('PKWK_DTD_HTML_4_01_STRICT',        3);
 463 define('PKWK_DTD_HTML_4_01_TRANSITIONAL',  2);
 464 define('PKWK_DTD_HTML_4_01_FRAMESET',      1);
 465
 466 define('PKWK_DTD_TYPE_XHTML',  1);
 467 define('PKWK_DTD_TYPE_HTML',   0);
 468
 469 // Output HTML DTD, <html> start tag. Return content-type.
 470 function pkwk_output_dtd($pkwk_dtd = PKWK_DTD_XHTML_1_1, $charset = CONTENT_CHARSET)
 471 {
 472         static $called;
 473         if (isset($called)) die('pkwk_output_dtd() already called. Why?');
 474         $called = TRUE;
 475
 476         $type = PKWK_DTD_TYPE_XHTML;
 477         $option = '';
 478         switch($pkwk_dtd){
 479         case PKWK_DTD_XHTML_1_1             :
 480                 $version = '1.1' ;
 481                 $dtd     = 'http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd';
 482                 break;
 483         case PKWK_DTD_XHTML_1_0_STRICT      :
 484                 $version = '1.0' ;
 485                 $option  = 'Strict';
 486                 $dtd     = 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd';
 487                 break;
 488         case PKWK_DTD_XHTML_1_0_TRANSITIONAL:
 489                 $version = '1.0' ;
 490                 $option  = 'Transitional';
 491                 $dtd     = 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd';
 492                 break;
 493
 494         case PKWK_DTD_HTML_4_01_STRICT      :
 495                 $type    = PKWK_DTD_TYPE_HTML;
 496                 $version = '4.01';
 497                 $dtd     = 'http://www.w3.org/TR/html4/strict.dtd';
 498                 break;
 499         case PKWK_DTD_HTML_4_01_TRANSITIONAL:
 500                 $type    = PKWK_DTD_TYPE_HTML;
 501                 $version = '4.01';
 502                 $option  = 'Transitional';
 503                 $dtd     = 'http://www.w3.org/TR/html4/loose.dtd';
 504                 break;
 505
 506         default: die('DTD not specified or invalid DTD');
 507                 break;
 508         }
 509
 510         $charset = htmlspecialchars($charset);
 511
 512         // Output XML or not
 513         if ($type == PKWK_DTD_TYPE_XHTML) echo '<?xml version="1.0" encoding="' . $charset . '" ?>' . "\n";
 514
 515         // Output doctype
 516         echo '<!DOCTYPE html PUBLIC "-//W3C//DTD ' .
 517                 ($type == PKWK_DTD_TYPE_XHTML ? 'XHTML' : 'HTML') . ' ' .
 518                 $version .
 519                 ($option != '' ? ' ' . $option : '') .
 520                 '//EN" "' .
 521                 $dtd .
 522                 '">' . "\n";
 523
 524         // Output <html> start tag
 525         echo '<html';
 526         if ($type == PKWK_DTD_TYPE_XHTML) {
 527                 echo ' xmlns="http://www.w3.org/1999/xhtml"'; // dir="ltr" /* LeftToRight */
 528                 echo ' xml:lang="' . LANG . '"';
 529                 if ($version == '1.0') echo ' lang="' . LANG . '"'; // Only XHTML 1.0
 530         } else {
 531                 echo ' lang="' . LANG . '"'; // HTML
 532         }
 533         echo '>' . "\n"; // <html>
 534
 535         // Return content-type (with MIME type)
 536         if ($type == PKWK_DTD_TYPE_XHTML) {
 537                 // NOTE: XHTML 1.1 browser will ignore http-equiv
 538                 return '<meta http-equiv="content-type" content="application/xhtml+xml; charset=' . $charset . '" />' . "\n";
 539         } else {
 540                 return '<meta http-equiv="content-type" content="text/html; charset=' . $charset . '" />' . "\n";
 541         }
 542 }
 543 ?>