lib/html.php

   1 <?php
   2 // PukiWiki - Yet another WikiWikiWeb clone.
   3 // html.php
   4 // Copyright
   5 //   2002-2018 PukiWiki Development 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 $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 $javascript, $nofollow;
  18         global $_LANG, $_LINK, $_IMAGE;
  19         global $auth_type, $auth_user;
  20         global $html_meta_referrer_policy;
  21
  22         global $pkwk_dtd;     // XHTML 1.1, XHTML1.0, HTML 4.01 Transitional...
  23         global $page_title;   // Title of this site
  24         global $do_backup;    // Do backup or not
  25         global $modifier;     // Site administrator's  web page
  26         global $modifierlink; // Site administrator's name
  27
  28         $script = get_base_uri();
  29         $enable_login = false;
  30         $enable_logout = false;
  31         if (AUTH_TYPE_FORM === $auth_type || AUTH_TYPE_EXTERNAL === $auth_type ||
  32                 AUTH_TYPE_SAML === $auth_type) {
  33                 if ($auth_user) {
  34                         $enable_logout = true;
  35                 } else {
  36                         $enable_login = true;
  37                 }
  38         } else if (AUTH_TYPE_BASIC === $auth_type) {
  39                 if ($auth_user) {
  40                         $enable_logout = true;
  41                 }
  42         }
  43         if (! file_exists(SKIN_FILE) || ! is_readable(SKIN_FILE))
  44                 die_message('SKIN_FILE is not found');
  45
  46         $_LINK = $_IMAGE = array();
  47
  48         $_page  = isset($vars['page']) ? $vars['page'] : '';
  49         $r_page = pagename_urlencode($_page);
  50         $is_edit_preview = isset($vars['preview']);
  51         // Canonical URL
  52         $canonical_url = get_page_uri($_page, PKWK_URI_ABSOLUTE);
  53
  54         // Set $_LINK for skin
  55         $_LINK['add']      = "$script?cmd=add&amp;page=$r_page";
  56         $_LINK['backup']   = "$script?cmd=backup&amp;page=$r_page";
  57         $_LINK['copy']     = "$script?plugin=template&amp;refer=$r_page";
  58         $_LINK['diff']     = "$script?cmd=diff&amp;page=$r_page";
  59         $_LINK['edit']     = "$script?cmd=edit&amp;page=$r_page";
  60         $_LINK['filelist'] = "$script?cmd=filelist";
  61         $_LINK['freeze']   = "$script?cmd=freeze&amp;page=$r_page";
  62         $_LINK['help']     = get_page_uri($help_page);
  63         $_LINK['list']     = "$script?cmd=list";
  64         $_LINK['new']      = "$script?plugin=newpage&amp;refer=$r_page";
  65         $_LINK['rdf']      = "$script?cmd=rss&amp;ver=1.0";
  66         $_LINK['recent']   = get_page_uri($whatsnew);
  67         $_LINK['reload']   = get_page_uri($_page);
  68         $_LINK['rename']   = "$script?plugin=rename&amp;refer=$r_page";
  69         $_LINK['rss']      = "$script?cmd=rss";
  70         $_LINK['rss10']    = "$script?cmd=rss&amp;ver=1.0"; // Same as 'rdf'
  71         $_LINK['rss20']    = "$script?cmd=rss&amp;ver=2.0";
  72         $_LINK['search']   = "$script?cmd=search";
  73         $_LINK['top']      = get_page_uri($defaultpage);
  74         $_LINK['unfreeze'] = "$script?cmd=unfreeze&amp;page=$r_page";
  75         $_LINK['upload']   = "$script?plugin=attach&amp;pcmd=upload&amp;page=$r_page";
  76         $_LINK['canonical_url'] = $canonical_url;
  77         $login_link = "#LOGIN_ERROR"; // dummy link that is not used
  78         switch ($auth_type) {
  79                 case AUTH_TYPE_FORM:
  80                         $login_link = "$script?plugin=loginform&pcmd=login&page=$r_page";
  81                         break;
  82                 case AUTH_TYPE_EXTERNAL:
  83                 case AUTH_TYPE_SAML:
  84                         $login_link = get_auth_external_login_url($_page,
  85                                 get_page_uri($_page, PKWK_URI_ROOT));
  86                         break;
  87         }
  88         $_LINK['login']    = htmlsc($login_link);
  89         $_LINK['logout']   = "$script?plugin=loginform&amp;pcmd=logout&amp;page=$r_page";
  90
  91         // Compat: Skins for 1.4.4 and before
  92         $link_add       = & $_LINK['add'];
  93         $link_new       = & $_LINK['new'];      // New!
  94         $link_edit      = & $_LINK['edit'];
  95         $link_diff      = & $_LINK['diff'];
  96         $link_top       = & $_LINK['top'];
  97         $link_list      = & $_LINK['list'];
  98         $link_filelist  = & $_LINK['filelist'];
  99         $link_search    = & $_LINK['search'];
 100         $link_whatsnew  = & $_LINK['recent'];
 101         $link_backup    = & $_LINK['backup'];
 102         $link_help      = & $_LINK['help'];
 103         $link_trackback = ''; // Removed (compat)
 104         $link_rdf       = & $_LINK['rdf'];              // New!
 105         $link_rss       = & $_LINK['rss'];
 106         $link_rss10     = & $_LINK['rss10'];            // New!
 107         $link_rss20     = & $_LINK['rss20'];            // New!
 108         $link_freeze    = & $_LINK['freeze'];
 109         $link_unfreeze  = & $_LINK['unfreeze'];
 110         $link_upload    = & $_LINK['upload'];
 111         $link_template  = & $_LINK['copy'];
 112         $link_refer     = ''; // Removed (compat)
 113         $link_rename    = & $_LINK['rename'];
 114
 115         // Init flags
 116         $is_page = (is_pagename($_page) && ! arg_check('backup') && $_page != $whatsnew);
 117         $is_read = (arg_check('read') && is_page($_page));
 118         $is_freeze = is_freeze($_page);
 119
 120         // Last modification date (string) of the page
 121         $lastmodified = $is_read ?  format_date(get_filetime($_page)) .
 122                 get_passage_html_span($_page) : '';
 123
 124         // List of attached files to the page
 125         $show_attaches = $is_read || arg_check('edit');
 126         $attaches = ($attach_link && $show_attaches && exist_plugin_action('attach')) ?
 127                 attach_filelist() : '';
 128
 129         // List of related pages
 130         $related  = ($related_link && $is_read) ? make_related($_page) : '';
 131
 132         // List of footnotes
 133         ksort($foot_explain, SORT_NUMERIC);
 134         $notes = ! empty($foot_explain) ? $note_hr . join("\n", $foot_explain) : '';
 135
 136         // Tags will be inserted into <head></head>
 137         $head_tag = ! empty($head_tags) ? join("\n", $head_tags) ."\n" : '';
 138
 139         // 1.3.x compat
 140         // Last modification date (UNIX timestamp) of the page
 141         $fmt = $is_read ? get_filetime($_page) + LOCALZONE : 0;
 142
 143         // Output nofollow / noindex regardless os skin file
 144         if (!$is_read || $nofollow) {
 145                 if (!headers_sent()) {
 146                         header("X-Robots-Tag: noindex,nofollow");
 147                 }
 148         }
 149
 150         // Send Canonical URL for Search Engine Optimization
 151         if ($is_read && !headers_sent()) {
 152                 header("Link: <$canonical_url>; rel=\"canonical\"");
 153         }
 154
 155         // Search words
 156         if ($search_word_color && isset($vars['word'])) {
 157                 $body = '<div class="small">' . $_msg_word . htmlsc($vars['word']) .
 158                         '</div>' . $hr . "\n" . $body;
 159
 160                 // BugTrack2/106: Only variables can be passed by reference from PHP 5.0.5
 161                 // with array_splice(), array_flip()
 162                 $words = preg_split('/\s+/', $vars['word'], -1, PREG_SPLIT_NO_EMPTY);
 163                 $words = array_splice($words, 0, 10); // Max: 10 words
 164                 $words = array_flip($words);
 165
 166                 $keys = array();
 167                 foreach ($words as $word=>$id) $keys[$word] = strlen($word);
 168                 arsort($keys, SORT_NUMERIC);
 169                 $keys = get_search_words(array_keys($keys), TRUE);
 170                 $id = 0;
 171                 $patterns = '';
 172                 foreach ($keys as $key=>$pattern) {
 173                         if (strlen($patterns) > 0) {
 174                                 $patterns .= '|';
 175                         }
 176                         $patterns .= '(' . $pattern . ')';
 177                 }
 178                 if ($pattern) {
 179                         $whole_pattern  = '/' .
 180                                 '<textarea[^>]*>.*?<\/textarea>' .      // Ignore textareas
 181                                 '|' . '<[^>]*>' .                       // Ignore tags
 182                                 '|' . '&[^;]+;' .                       // Ignore entities
 183                                 '|' . '(' . $patterns . ')' .           // $matches[1]: Regex for a search word
 184                                 '/sS';
 185                         $body  = preg_replace_callback($whole_pattern, '_decorate_Nth_word', $body);
 186                         $notes = preg_replace_callback($whole_pattern, '_decorate_Nth_word', $notes);
 187                 }
 188         }
 189         // Embed Scripting data
 190         $html_scripting_data = get_html_scripting_data($_page, $is_edit_preview);
 191
 192         // Compat: 'HTML convert time' without time about MenuBar and skin
 193         $taketime = elapsedtime();
 194
 195         require(SKIN_FILE);
 196 }
 197
 198 function _decorate_Nth_word($matches)
 199 {
 200         // $matches[0]: including both words to skip and to decorate
 201         // $matches[1]: word to decorate
 202         // $matches[2+]: indicates which keyword to decorate
 203         $index = -1;
 204         for ($i = 2; $i < count($matches); $i++) {
 205                 if (isset($matches[$i]) && $matches[$i]) {
 206                         $index = $i - 2;
 207                         break;
 208                 }
 209         }
 210         if (isset($matches[1])) {
 211                 // wordN highlight class: N=0...n
 212                 return '<strong class="word' . $index . '">' .
 213                         $matches[0] . '</strong>';
 214         }
 215         return $matches[0];
 216 }
 217
 218 /**
 219  * Get data used by JavaScript modules
 220  *
 221  * @param $page page name
 222  * @param $in_editing true if preview in editing
 223  */
 224 function get_html_scripting_data($page, $in_editing)
 225 {
 226         global $ticket_link_sites, $plugin;
 227         global $external_link_cushion_page, $external_link_cushion;
 228         global $topicpath_title;
 229         global $ticket_jira_default_site;
 230         if (!isset($ticket_link_sites) || !is_array($ticket_link_sites)) {
 231                 return '';
 232         }
 233         $is_utf8 = (bool)defined('PKWK_UTF8_ENABLE');
 234         // Require: PHP 5.4+
 235         $json_enabled = defined('JSON_UNESCAPED_UNICODE');
 236         if (!$json_enabled) {
 237                 $empty_data = <<<EOS
 238 <div id="pukiwiki-site-properties" style="display:none;">
 239 </div>
 240 EOS;
 241                 return $empty_data;
 242         }
 243         // Site basic Properties
 244         $props = array(
 245                 'is_utf8' => $is_utf8,
 246                 'json_enabled' => $json_enabled,
 247                 'base_uri_pathname' => get_base_uri(PKWK_URI_ROOT),
 248                 'base_uri_absolute' => get_base_uri(PKWK_URI_ABSOLUTE)
 249         );
 250         $h_props = htmlsc_json($props);
 251         $site_props = <<<EOS
 252 <input type="hidden" class="site-props" value="$h_props" />
 253 EOS;
 254         $h_plugin = htmlsc($plugin);
 255         $plugin_prop = <<<EOS
 256 <input type="hidden" class="plugin-name" value="$h_plugin" />
 257 EOS;
 258         // Page name
 259         $h_page_name = htmlsc($page);
 260         $page_name_data = <<<EOS
 261 <input type="hidden" class="page-name" value="$h_page_name" />
 262 EOS;
 263         // Page is editing (preview)
 264         $in_editing_value = ($plugin === 'edit' && $in_editing) ? 'true' : 'false';
 265         $page_edit_data = <<<EOS
 266 <input type="hidden" class="page-in-edit" value="$in_editing_value" />
 267 EOS;
 268         // AutoTicketLink
 269         $filtered_ticket_link_sites = array();
 270         foreach ($ticket_link_sites as $s) {
 271                 if (!preg_match('/^([a-zA-Z0-9]+)([\.\-][a-zA-Z0-9]+)*$/', $s['key'])) {
 272                         continue;
 273                 }
 274                 array_push($filtered_ticket_link_sites, $s);
 275         }
 276         $h_ticket_link_sites = htmlsc_json($filtered_ticket_link_sites);
 277         $ticketlink_data = <<<EOS
 278 <input type="hidden" class="ticketlink-def" value="$h_ticket_link_sites" />
 279 EOS;
 280         // AutoTicketLink - JIRA
 281         $ticket_jira_projects = get_ticketlink_jira_projects();
 282         $ticketlink_jira_data = '';
 283         if (count($ticket_jira_projects) > 0) {
 284                 $h_ticket_jira_projects = htmlsc_json($ticket_jira_projects);
 285                 $ticketlink_jira_data = <<<EOS
 286 <input type="hidden" class="ticketlink-jira-def" value="$h_ticket_jira_projects" />
 287 EOS;
 288         }
 289         $ticketlink_jira_default_data = '';
 290         if (isset($ticket_jira_default_site) && is_array($ticket_jira_default_site)) {
 291                 $h_ticket_jira_default_site = htmlsc_json($ticket_jira_default_site);
 292                 $ticketlink_jira_default_data = <<<EOS
 293 <input type="hidden" class="ticketlink-jira-default-def" value="$h_ticket_jira_default_site" />
 294 EOS;
 295         }
 296         // External link cushion page
 297         $external_link_cushion_data = '';
 298         if ($external_link_cushion_page) {
 299                 $h_cushion = htmlsc_json($external_link_cushion);
 300                 $external_link_cushion_data = <<<EOS
 301 <input type="hidden" class="external-link-cushion" value="$h_cushion" />
 302 EOS;
 303         }
 304         // Topicpath title
 305         $topicpath_data = '';
 306         if ($topicpath_title && exist_plugin('topicpath')) {
 307                 $parents = plugin_topicpath_parent_links($page);
 308                 $h_topicpath = htmlsc(json_encode($parents,
 309                 JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES));
 310                 $topicpath_data = <<<EOS
 311 <input type="hidden" class="topicpath-links" value="$h_topicpath" />
 312 EOS;
 313         }
 314         $data = <<<EOS
 315 <div id="pukiwiki-site-properties" style="display:none;">
 316 $site_props
 317 $plugin_prop
 318 $page_name_data
 319 $page_edit_data
 320 $ticketlink_data
 321 $ticketlink_jira_data
 322 $ticketlink_jira_default_data
 323 $external_link_cushion_data
 324 $topicpath_data
 325 </div>
 326 EOS;
 327         return $data;
 328 }
 329
 330 // Show 'edit' form
 331 function edit_form($page, $postdata, $digest = FALSE, $b_template = TRUE)
 332 {
 333         global $vars, $rows, $cols;
 334         global $_btn_preview, $_btn_repreview, $_btn_update, $_btn_cancel, $_msg_help;
 335         global $_btn_template, $_btn_load, $load_template_func;
 336         global $notimeupdate;
 337         global $_msg_edit_cancel_confirm, $_msg_edit_unloadbefore_message;
 338         global $rule_page;
 339
 340         $script = get_base_uri();
 341         // Newly generate $digest or not
 342         if ($digest === FALSE) $digest = md5(join('', get_source($page)));
 343         $refer = $template = '';
 344         // Add plugin
 345         $addtag = $add_top = '';
 346         if(isset($vars['add'])) {
 347                 global $_btn_addtop;
 348                 $addtag  = '<input type="hidden" name="add"    value="true" />';
 349                 $add_top = isset($vars['add_top']) ? ' checked="checked"' : '';
 350                 $add_top = '<input type="checkbox" name="add_top" ' .
 351                         'id="_edit_form_add_top" value="true"' . $add_top . ' />' . "\n" .
 352                         '  <label for="_edit_form_add_top">' .
 353                                 '<span class="small">' . $_btn_addtop . '</span>' .
 354                         '</label>';
 355         }
 356         if($load_template_func && $b_template) {
 357                 $template_page_list = get_template_page_list();
 358                 $tpages = array(); // Template pages
 359                 foreach($template_page_list as $p) {
 360                         $ps = htmlsc($p);
 361                         $tpages[] = '   <option value="' . $ps . '">' . $ps . '</option>';
 362                 }
 363                 if (count($template_page_list) > 0) {
 364                         $s_tpages = join("\n", $tpages);
 365                 } else {
 366                         $s_tpages = '   <option value="">(no template pages)</option>';
 367                 }
 368                 $template = <<<EOD
 369   <select name="template_page">
 370    <option value="">-- $_btn_template --</option>
 371 $s_tpages
 372   </select>
 373   <input type="submit" name="template" value="$_btn_load" accesskey="r" />
 374   <br />
 375 EOD;
 376
 377                 if (isset($vars['refer']) && $vars['refer'] != '')
 378                         $refer = '[[' . strip_bracket($vars['refer']) . ']]' . "\n\n";
 379         }
 380
 381         $r_page      = rawurlencode($page);
 382         $s_page      = htmlsc($page);
 383         $s_digest    = htmlsc($digest);
 384         $s_postdata  = htmlsc($refer . $postdata);
 385         $s_original  = isset($vars['original']) ? htmlsc($vars['original']) : $s_postdata;
 386         $b_preview   = isset($vars['preview']); // TRUE when preview
 387         $btn_preview = $b_preview ? $_btn_repreview : $_btn_preview;
 388
 389         // Checkbox 'do not change timestamp'
 390         $add_notimestamp = '';
 391         if ($notimeupdate != 0) {
 392                 global $_btn_notchangetimestamp;
 393                 $checked_time = isset($vars['notimestamp']) ? ' checked="checked"' : '';
 394                 // Only for administrator
 395                 if ($notimeupdate == 2) {
 396                         $add_notimestamp = '   ' .
 397                                 '<input type="password" name="pass" size="12" />' . "\n";
 398                 }
 399                 $add_notimestamp = '<input type="checkbox" name="notimestamp" ' .
 400                         'id="_edit_form_notimestamp" value="true"' . $checked_time . ' />' . "\n" .
 401                         '   ' . '<label for="_edit_form_notimestamp"><span class="small">' .
 402                         $_btn_notchangetimestamp . '</span></label>' . "\n" .
 403                         $add_notimestamp .
 404                         '&nbsp;';
 405         }
 406
 407         // 'margin-bottom', 'float:left', and 'margin-top'
 408         // are for layout of 'cancel button'
 409         $h_msg_edit_cancel_confirm = htmlsc($_msg_edit_cancel_confirm);
 410         $h_msg_edit_unloadbefore_message = htmlsc($_msg_edit_unloadbefore_message);
 411         $body = <<<EOD
 412 <div class="edit_form">
 413  <form action="$script" method="post" class="_plugin_edit_edit_form" style="margin-bottom:0px;">
 414 $template
 415   $addtag
 416   <input type="hidden" name="cmd"    value="edit" />
 417   <input type="hidden" name="page"   value="$s_page" />
 418   <input type="hidden" name="digest" value="$s_digest" />
 419   <input type="hidden" id="_msg_edit_cancel_confirm" value="$h_msg_edit_cancel_confirm" />
 420   <input type="hidden" id="_msg_edit_unloadbefore_message" value="$h_msg_edit_unloadbefore_message" />
 421   <textarea name="msg" rows="$rows" cols="$cols">$s_postdata</textarea>
 422   <br />
 423   <div style="float:left;">
 424    <input type="submit" name="preview" value="$btn_preview" accesskey="p" />
 425    <input type="submit" name="write"   value="$_btn_update" accesskey="s" />
 426    $add_top
 427    $add_notimestamp
 428   </div>
 429   <textarea name="original" rows="1" cols="1" style="display:none">$s_original</textarea>
 430  </form>
 431  <form action="$script" method="post" class="_plugin_edit_cancel" style="margin-top:0px;">
 432   <input type="hidden" name="cmd"    value="edit" />
 433   <input type="hidden" name="page"   value="$s_page" />
 434   <input type="submit" name="cancel" value="$_btn_cancel" accesskey="c" />
 435  </form>
 436 </div>
 437 EOD;
 438
 439         $body .= '<ul><li><a href="' .
 440                 get_page_uri($rule_page) .
 441                 '" target="_blank">' . $_msg_help . '</a></li></ul>';
 442         return $body;
 443 }
 444
 445 /**
 446  * Get template page list.
 447  */
 448 function get_template_page_list()
 449 {
 450         global $whatsnew;
 451         $tpage_names = array(); // Pages marked as template
 452         $template_page = ':config/Templates';
 453         $page_max = 100;
 454         foreach(get_source($template_page) as $_templates) {
 455                 $m = array();
 456                 if (! preg_match('#\-\s*\[\[([^\[\]]+)\]\]#', $_templates, $m)) continue;
 457                 $tpage = preg_replace('#^./#', "$template_page/", $m[1]);
 458                 if (! is_page($tpage)) continue;
 459                 $tpage_names[] = $tpage;
 460         }
 461         $page_names = array();
 462         $page_list = get_existpages();
 463         if (count($page_list) > $page_max) {
 464                 // Extract only template name pages
 465                 $target_pages = array();
 466                 foreach ($page_list as $_page) {
 467                         if (preg_match('/template/i', $_page)) {
 468                                 $target_pages[] = $_page;
 469                         }
 470                 }
 471         } else {
 472                 $target_pages = $page_list;
 473         }
 474         foreach ($target_pages as $_page) {
 475                 if ($_page == $whatsnew || check_non_list($_page) ||
 476                         !is_page_readable($_page)) {
 477                         continue;
 478                 }
 479                 $tpage_names[] = $_page;
 480         }
 481         $tempalte_page_list = array_values(array_unique($tpage_names));
 482         natcasesort($tempalte_page_list);
 483         return $tempalte_page_list;
 484 }
 485
 486 // Related pages
 487 function make_related($page, $tag = '')
 488 {
 489         global $vars, $rule_related_str, $related_str;
 490
 491         $script = get_base_uri();
 492         prepare_links_related($page);
 493         $links = links_get_related($page);
 494
 495         if ($tag) {
 496                 ksort($links, SORT_STRING);             // Page name, alphabetical order
 497         } else {
 498                 arsort($links, SORT_NUMERIC);   // Last modified date, newer
 499         }
 500
 501         $_links = array();
 502         foreach ($links as $page=>$lastmod) {
 503                 if (check_non_list($page)) continue;
 504                 $page_uri = get_page_uri($page);
 505                 $s_page   = htmlsc($page);
 506                 if ($tag) {
 507                         $attrs = get_page_link_a_attrs($page);
 508                         $_links[] = '<a href="' . $page_uri . '" class="' .
 509                                 $attrs['class'] . '" data-mtime="' . $attrs['data_mtime'] .
 510                                 '">' . $s_page . '</a>';
 511                 } else {
 512                         $mtime_span = get_passage_mtime_html_span($lastmod + LOCALZONE);
 513                         $_links[] = '<a href="' . $page_uri . '">' .
 514                         $s_page . '</a>' . $mtime_span;
 515                 }
 516         }
 517         if (empty($_links)) return ''; // Nothing
 518
 519         if ($tag == 'p') { // From the line-head
 520                 $style  = sprintf(pkwk_list_attrs_template(), 1, 1);
 521                 $retval =  "\n" . '<ul' . $style . '>' . "\n" .
 522                         '<li>' . join($rule_related_str, $_links) . '</li>' . "\n" .
 523                         '</ul>' . "\n";
 524         } else if ($tag) {
 525                 $retval = join($rule_related_str, $_links);
 526         } else {
 527                 $retval = join($related_str, $_links);
 528         }
 529
 530         return $retval;
 531 }
 532
 533 function _convert_line_rule_to_regex($a)
 534 {
 535         return '/' . $a . '/';
 536 }
 537
 538 // User-defined rules (convert without replacing source)
 539 function make_line_rules($str)
 540 {
 541         global $line_rules;
 542         static $pattern, $replace;
 543
 544         if (! isset($pattern)) {
 545                 $pattern = array_map('_convert_line_rule_to_regex', array_keys($line_rules));
 546                 $replace = array_values($line_rules);
 547                 unset($line_rules);
 548         }
 549
 550         return preg_replace($pattern, $replace, $str);
 551 }
 552
 553 // Remove all HTML tags(or just anchor tags), and WikiName-speific decorations
 554 function strip_htmltag($str, $all = TRUE)
 555 {
 556         global $_symbol_noexists;
 557         static $noexists_pattern;
 558
 559         if (! isset($noexists_pattern))
 560                 $noexists_pattern = '#<span class="noexists">([^<]*)<a[^>]+>' .
 561                         preg_quote($_symbol_noexists, '#') . '</a></span>#';
 562
 563         // Strip Dagnling-Link decoration (Tags and "$_symbol_noexists")
 564         $str = preg_replace($noexists_pattern, '$1', $str);
 565
 566         if ($all) {
 567                 // All other HTML tags
 568                 return preg_replace('#<[^>]+>#',        '', $str);
 569         } else {
 570                 // All other anchor-tags only
 571                 return preg_replace('#<a[^>]+>|</a>#i', '', $str);
 572         }
 573 }
 574
 575 // Remove AutoLink marker with AutLink itself
 576 function strip_autolink($str)
 577 {
 578         return preg_replace('#<!--autolink--><a [^>]+>|</a><!--/autolink-->#', '', $str);
 579 }
 580
 581 // Make a backlink. searching-link of the page name, by the page name, for the page name
 582 function make_search($page)
 583 {
 584         $s_page = htmlsc($page);
 585         $r_page = rawurlencode($page);
 586         return '<a href="' . get_base_uri() . '?plugin=related&amp;page=' . $r_page .
 587                 '">' . $s_page . '</a> ';
 588 }
 589
 590 // Make heading string (remove heading-related decorations from Wiki text)
 591 function make_heading(& $str, $strip = TRUE)
 592 {
 593         global $NotePattern;
 594
 595         // Cut fixed-heading anchors
 596         $id = '';
 597         $matches = array();
 598         if (preg_match('/^(\*{0,3})(.*?)\[#([A-Za-z][\w-]+)\](.*?)$/m', $str, $matches)) {
 599                 $str = $matches[2] . $matches[4];
 600                 $id  = & $matches[3];
 601         } else {
 602                 $str = preg_replace('/^\*{0,3}/', '', $str);
 603         }
 604
 605         // Cut footnotes and tags
 606         if ($strip === TRUE)
 607                 $str = strip_htmltag(make_link(preg_replace($NotePattern, '', $str)));
 608
 609         return $id;
 610 }
 611
 612 // Separate a page-name(or URL or null string) and an anchor
 613 // (last one standing) without sharp
 614 function anchor_explode($page, $strict_editable = FALSE)
 615 {
 616         $pos = strrpos($page, '#');
 617         if ($pos === FALSE) return array($page, '', FALSE);
 618
 619         // Ignore the last sharp letter
 620         if ($pos + 1 == strlen($page)) {
 621                 $pos = strpos(substr($page, $pos + 1), '#');
 622                 if ($pos === FALSE) return array($page, '', FALSE);
 623         }
 624
 625         $s_page = substr($page, 0, $pos);
 626         $anchor = substr($page, $pos + 1);
 627
 628         if($strict_editable === TRUE &&  preg_match('/^[a-z][a-f0-9]{7}$/', $anchor)) {
 629                 return array ($s_page, $anchor, TRUE); // Seems fixed-anchor
 630         } else {
 631                 return array ($s_page, $anchor, FALSE);
 632         }
 633 }
 634
 635 // Check HTTP header()s were sent already, or
 636 // there're blank lines or something out of php blocks
 637 function pkwk_headers_sent()
 638 {
 639         if (PKWK_OPTIMISE) return;
 640
 641         $file = $line = '';
 642         if (version_compare(PHP_VERSION, '4.3.0', '>=')) {
 643                 if (headers_sent($file, $line))
 644                     die('Headers already sent at ' .
 645                         htmlsc($file) .
 646                         ' line ' . $line . '.');
 647         } else {
 648                 if (headers_sent())
 649                         die('Headers already sent.');
 650         }
 651 }
 652
 653 // Output common HTTP headers
 654 function pkwk_common_headers()
 655 {
 656         global $http_response_custom_headers;
 657         if (! PKWK_OPTIMISE) pkwk_headers_sent();
 658         foreach ($http_response_custom_headers as $header) {
 659                 header($header);
 660         }
 661         if(defined('PKWK_ZLIB_LOADABLE_MODULE')) {
 662                 $matches = array();
 663                 if(ini_get('zlib.output_compression') &&
 664                     preg_match('/\b(gzip|deflate)\b/i', $_SERVER['HTTP_ACCEPT_ENCODING'], $matches)) {
 665                         // Bug #29350 output_compression compresses everything _without header_ as loadable module
 666                         // http://bugs.php.net/bug.php?id=29350
 667                         header('Content-Encoding: ' . $matches[1]);
 668                         header('Vary: Accept-Encoding');
 669                 }
 670         }
 671 }
 672
 673 // DTD definitions
 674 define('PKWK_DTD_XHTML_1_1',              17); // Strict only
 675 define('PKWK_DTD_XHTML_1_0',              16); // Strict
 676 define('PKWK_DTD_XHTML_1_0_STRICT',       16);
 677 define('PKWK_DTD_XHTML_1_0_TRANSITIONAL', 15);
 678 define('PKWK_DTD_XHTML_1_0_FRAMESET',     14);
 679 define('PKWK_DTD_HTML_4_01',               3); // Strict
 680 define('PKWK_DTD_HTML_4_01_STRICT',        3);
 681 define('PKWK_DTD_HTML_4_01_TRANSITIONAL',  2);
 682 define('PKWK_DTD_HTML_4_01_FRAMESET',      1);
 683
 684 define('PKWK_DTD_TYPE_XHTML',  1);
 685 define('PKWK_DTD_TYPE_HTML',   0);
 686
 687 // Output HTML DTD, <html> start tag. Return content-type.
 688 function pkwk_output_dtd($pkwk_dtd = PKWK_DTD_XHTML_1_1, $charset = CONTENT_CHARSET)
 689 {
 690         static $called;
 691         if (isset($called)) die('pkwk_output_dtd() already called. Why?');
 692         $called = TRUE;
 693
 694         $type = PKWK_DTD_TYPE_XHTML;
 695         $option = '';
 696         switch($pkwk_dtd){
 697         case PKWK_DTD_XHTML_1_1             :
 698                 $version = '1.1' ;
 699                 $dtd     = 'http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd';
 700                 break;
 701         case PKWK_DTD_XHTML_1_0_STRICT      :
 702                 $version = '1.0' ;
 703                 $option  = 'Strict';
 704                 $dtd     = 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd';
 705                 break;
 706         case PKWK_DTD_XHTML_1_0_TRANSITIONAL:
 707                 $version = '1.0' ;
 708                 $option  = 'Transitional';
 709                 $dtd     = 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd';
 710                 break;
 711
 712         case PKWK_DTD_HTML_4_01_STRICT      :
 713                 $type    = PKWK_DTD_TYPE_HTML;
 714                 $version = '4.01';
 715                 $dtd     = 'http://www.w3.org/TR/html4/strict.dtd';
 716                 break;
 717         case PKWK_DTD_HTML_4_01_TRANSITIONAL:
 718                 $type    = PKWK_DTD_TYPE_HTML;
 719                 $version = '4.01';
 720                 $option  = 'Transitional';
 721                 $dtd     = 'http://www.w3.org/TR/html4/loose.dtd';
 722                 break;
 723
 724         default: die('DTD not specified or invalid DTD');
 725                 break;
 726         }
 727
 728         $charset = htmlsc($charset);
 729
 730         // Output XML or not
 731         if ($type == PKWK_DTD_TYPE_XHTML) echo '<?xml version="1.0" encoding="' . $charset . '" ?>' . "\n";
 732
 733         // Output doctype
 734         echo '<!DOCTYPE html PUBLIC "-//W3C//DTD ' .
 735                 ($type == PKWK_DTD_TYPE_XHTML ? 'XHTML' : 'HTML') . ' ' .
 736                 $version .
 737                 ($option != '' ? ' ' . $option : '') .
 738                 '//EN" "' .
 739                 $dtd .
 740                 '">' . "\n";
 741
 742         // Output <html> start tag
 743         echo '<html';
 744         if ($type == PKWK_DTD_TYPE_XHTML) {
 745                 echo ' xmlns="http://www.w3.org/1999/xhtml"'; // dir="ltr" /* LeftToRight */
 746                 echo ' xml:lang="' . LANG . '"';
 747                 if ($version == '1.0') echo ' lang="' . LANG . '"'; // Only XHTML 1.0
 748         } else {
 749                 echo ' lang="' . LANG . '"'; // HTML
 750         }
 751         echo '>' . "\n"; // <html>
 752
 753         // Return content-type (with MIME type)
 754         if ($type == PKWK_DTD_TYPE_XHTML) {
 755                 // NOTE: XHTML 1.1 browser will ignore http-equiv
 756                 return '<meta http-equiv="content-type" content="application/xhtml+xml; charset=' . $charset . '" />' . "\n";
 757         } else {
 758                 return '<meta http-equiv="content-type" content="text/html; charset=' . $charset . '" />' . "\n";
 759         }
 760 }
 761
 762 /**
 763  * Get template of List (ul, ol, dl) attributes
 764  */
 765 function pkwk_list_attrs_template() {
 766         return ' class="list%d list-indent%d"';
 767 }