lib/html.php

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