2 // PukiWiki - Yet another WikiWikiWeb clone.
3 // $Id: html.php,v 1.43 2005/10/02 16:15:05 henoheno Exp $
5 // 2002-2005 PukiWiki Developers Team
6 // 2001-2002 Originally written by yu-ji
7 // License: GPL v2 or (at your option) any later version
9 // HTML-publishing related functions
12 function catbody($title, $page, $body)
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;
19 global $_LANG, $_LINK, $_IMAGE;
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
27 if (! file_exists(SKIN_FILE) || ! is_readable(SKIN_FILE))
28 die_message('SKIN_FILE is not found');
30 $_LINK = $_IMAGE = array();
32 // Add JavaScript header when ...
33 if ($trackback && $trackback_javascript) $javascript = 1; // Set something If you want
34 if (! PKWK_ALLOW_JAVASCRIPT) unset($javascript);
36 $_page = isset($vars['page']) ? $vars['page'] : '';
37 $r_page = rawurlencode($_page);
39 // Set $_LINK for skin
40 $_LINK['add'] = "$script?cmd=add&page=$r_page";
41 $_LINK['backup'] = "$script?cmd=backup&page=$r_page";
42 $_LINK['copy'] = "$script?plugin=template&refer=$r_page";
43 $_LINK['diff'] = "$script?cmd=diff&page=$r_page";
44 $_LINK['edit'] = "$script?cmd=edit&page=$r_page";
45 $_LINK['filelist'] = "$script?cmd=filelist";
46 $_LINK['freeze'] = "$script?cmd=freeze&page=$r_page";
47 $_LINK['help'] = "$script?" . rawurlencode($help_page);
48 $_LINK['list'] = "$script?cmd=list";
49 $_LINK['new'] = "$script?plugin=newpage&refer=$r_page";
50 $_LINK['rdf'] = "$script?cmd=rss&ver=1.0";
51 $_LINK['recent'] = "$script?" . rawurlencode($whatsnew);
52 $_LINK['refer'] = "$script?plugin=referer&page=$r_page";
53 $_LINK['reload'] = "$script?$r_page";
54 $_LINK['rename'] = "$script?plugin=rename&refer=$r_page";
55 $_LINK['rss'] = "$script?cmd=rss";
56 $_LINK['rss10'] = "$script?cmd=rss&ver=1.0"; // Same as 'rdf'
57 $_LINK['rss20'] = "$script?cmd=rss&ver=2.0";
58 $_LINK['search'] = "$script?cmd=search";
59 $_LINK['top'] = "$script?" . rawurlencode($defaultpage);
61 $tb_id = tb_get_id($_page);
62 $_LINK['trackback'] = "$script?plugin=tb&__mode=view&tb_id=$tb_id";
64 $_LINK['unfreeze'] = "$script?cmd=unfreeze&page=$r_page";
65 $_LINK['upload'] = "$script?plugin=attach&pcmd=upload&page=$r_page";
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'];
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);
96 // Last modification date (string) of the page
97 $lastmodified = $is_read ? format_date(get_filetime($_page)) .
98 ' ' . get_pg_passage($_page, FALSE) : '';
100 // List of attached files to the page
101 $attaches = ($attach_link && $is_read && exist_plugin_action('attach')) ?
102 attach_filelist() : '';
104 // List of related pages
105 $related = ($related_link && $is_read) ? make_related($_page) : '';
108 ksort($foot_explain, SORT_NUMERIC);
109 $notes = ! empty($foot_explain) ? $note_hr . join("\n", $foot_explain) : '';
111 // Tags will be inserted into <head></head>
112 $head_tag = ! empty($head_tags) ? join("\n", $head_tags) ."\n" : '';
115 // Last modification date (UNIX timestamp) of the page
116 $fmt = $is_read ? get_filetime($_page) + LOCALZONE : 0;
119 if ($search_word_color && isset($vars['word'])) {
120 $body = '<div class="small">' . $_msg_word . htmlspecialchars($vars['word']) .
121 '</div>' . $hr . "\n" . $body;
123 // Only variables can be passed by reference from PHP 5.0.5
124 // with array_splice()
125 $tmp_array = preg_split('/\s+/', $vars['word'], -1, PREG_SPLIT_NO_EMPTY);
127 $words = array_flip(array_splice($tmp_array, 0, 10));
129 foreach ($words as $word=>$id) $keys[$word] = strlen($word);
130 arsort($keys, SORT_NUMERIC);
131 $keys = get_search_words(array_keys($keys), TRUE);
133 foreach ($keys as $key=>$pattern) {
134 $s_key = htmlspecialchars($key);
135 $pattern = '/<[^>]*>|(' . $pattern . ')|&[^;]+;/';
136 $callback = create_function(
138 'return (count($arr) > 1) ? \'<strong class="word' .
139 $id++ . '">\' . $arr[1] . \'</strong>\' : $arr[0];'
141 $body = preg_replace_callback($pattern, $callback, $body);
142 $notes = preg_replace_callback($pattern, $callback, $notes);
146 $longtaketime = getmicrotime() - MUTIME;
147 $taketime = sprintf('%01.03f', $longtaketime);
153 function edit_form($page, $postdata, $digest = FALSE, $b_template = TRUE)
155 global $script, $vars, $rows, $cols, $hr, $function_freeze;
156 global $_btn_addtop, $_btn_preview, $_btn_repreview, $_btn_update, $_btn_cancel,
157 $_msg_help, $_btn_notchangetimestamp;
158 global $whatsnew, $_btn_template, $_btn_load, $non_list, $load_template_func;
159 global $notimeupdate;
161 // Newly generate $digest or not
162 if ($digest === FALSE) $digest = md5(join('', get_source($page)));
164 $refer = $template = $addtag = $add_top = '';
166 $checked_top = isset($vars['add_top']) ? ' checked="checked"' : '';
167 $checked_time = isset($vars['notimestamp']) ? ' checked="checked"' : '';
169 if(isset($vars['add'])) {
170 $addtag = '<input type="hidden" name="add" value="true" />';
171 $add_top = '<input type="checkbox" name="add_top" value="true"' .
172 $checked_top . ' /><span class="small">' .
173 $_btn_addtop . '</span>';
176 if($load_template_func && $b_template) {
178 $non_list_pattern = '/' . $non_list . '/';
179 foreach(get_existpages() as $_page) {
180 if ($_page == $whatsnew || preg_match($non_list_pattern, $_page))
182 $s_page = htmlspecialchars($_page);
183 $pages[$_page] = ' <option value="' . $s_page . '">' .
184 $s_page . '</option>';
187 $s_pages = join("\n", $pages);
189 <select name="template_page">
190 <option value="">-- $_btn_template --</option>
193 <input type="submit" name="template" value="$_btn_load" accesskey="r" />
197 if (isset($vars['refer']) && $vars['refer'] != '')
198 $refer = '[[' . strip_bracket($vars['refer']) . ']]' . "\n\n";
201 $r_page = rawurlencode($page);
202 $s_page = htmlspecialchars($page);
203 $s_digest = htmlspecialchars($digest);
204 $s_postdata = htmlspecialchars($refer . $postdata);
205 $s_original = isset($vars['original']) ? htmlspecialchars($vars['original']) : $s_postdata;
206 $b_preview = isset($vars['preview']); // TRUE when preview
207 $btn_preview = $b_preview ? $_btn_repreview : $_btn_preview;
209 $add_notimestamp = '';
210 if ( $notimeupdate != 0 ) {
211 // enable 'do not change timestamp'
212 $add_notimestamp = <<<EOD
213 <input type="checkbox" name="notimestamp" id="_edit_form_notimestamp" value="true"$checked_time />
214 <label for="_edit_form_notimestamp"><span class="small">$_btn_notchangetimestamp</span></label>
216 if ( $notimeupdate == 2 ) {
217 // enable only administrator
218 $add_notimestamp .= <<<EOD
219 <input type="password" name="pass" size="12" />
222 $add_notimestamp .= ' ';
226 <form action="$script" method="post">
227 <div class="edit_form">
230 <input type="hidden" name="cmd" value="edit" />
231 <input type="hidden" name="page" value="$s_page" />
232 <input type="hidden" name="digest" value="$s_digest" />
233 <textarea name="msg" rows="$rows" cols="$cols">$s_postdata</textarea>
235 <input type="submit" name="preview" value="$btn_preview" accesskey="p" />
236 <input type="submit" name="write" value="$_btn_update" accesskey="s" />
239 <input type="submit" name="cancel" value="$_btn_cancel" accesskey="c" />
240 <textarea name="original" rows="1" cols="1" style="display:none">$s_original</textarea>
245 if (isset($vars['help'])) {
246 $body .= $hr . catrule();
248 $body .= '<ul><li><a href="' .
249 $script . '?cmd=edit&help=true&page=' . $r_page .
250 '">' . $_msg_help . '</a></li></ul>';
257 function make_related($page, $tag = '')
259 global $script, $vars, $rule_related_str, $related_str, $non_list;
260 global $_ul_left_margin, $_ul_margin, $_list_pad_str;
262 $links = links_get_related($page);
271 $non_list_pattern = '/' . $non_list . '/';
272 foreach ($links as $page=>$lastmod) {
273 if (preg_match($non_list_pattern, $page)) continue;
275 $r_page = rawurlencode($page);
276 $s_page = htmlspecialchars($page);
277 $passage = get_passage($lastmod);
279 '<a href="' . $script . '?' . $r_page . '" title="' .
280 $s_page . ' ' . $passage . '">' . $s_page . '</a>' :
281 '<a href="' . $script . '?' . $r_page . '">' .
282 $s_page . '</a>' . $passage;
284 if (empty($_links)) return ''; // Nothing
286 if ($tag == 'p') { // From the line-head
287 $margin = $_ul_left_margin + $_ul_margin;
288 $style = sprintf($_list_pad_str, 1, $margin, $margin);
289 $retval = "\n" . '<ul' . $style . '>' . "\n" .
290 '<li>' . join($rule_related_str, $_links) . '</li>' . "\n" .
293 $retval = join($rule_related_str, $_links);
295 $retval = join($related_str, $_links);
301 // User-defined rules (convert without replacing source)
302 function make_line_rules($str)
305 static $pattern, $replace;
307 if (! isset($pattern)) {
308 $pattern = array_map(create_function('$a',
309 'return \'/\' . $a . \'/\';'), array_keys($line_rules));
310 $replace = array_values($line_rules);
314 return preg_replace($pattern, $replace, $str);
317 // Remove all HTML tags(or just anchor tags), and WikiName-speific decorations
318 function strip_htmltag($str, $all = TRUE)
320 global $_symbol_noexists;
321 static $noexists_pattern;
323 if (! isset($noexists_pattern))
324 $noexists_pattern = '#<span class="noexists">([^<]*)<a[^>]+>' .
325 preg_quote($_symbol_noexists, '#') . '</a></span>#';
327 // Strip Dagnling-Link decoration (Tags and "$_symbol_noexists")
328 $str = preg_replace($noexists_pattern, '$1', $str);
331 // All other HTML tags
332 return preg_replace('#<[^>]+>#', '', $str);
334 // All other anchor-tags only
335 return preg_replace('#<a[^>]+>|</a>#i', '', $str);
339 // Remove AutoLink marker with AutLink itself
340 function strip_autolink($str)
342 return preg_replace('#<!--autolink--><a [^>]+>|</a><!--/autolink-->#', '', $str);
345 // Make a backlink. searching-link of the page name, by the page name, for the page name
346 function make_search($page)
350 $s_page = htmlspecialchars($page);
351 $r_page = rawurlencode($page);
353 return '<a href="' . $script . '?plugin=related&page=' . $r_page .
354 '">' . $s_page . '</a> ';
357 // Make heading string (remove heading-related decorations from Wiki text)
358 function make_heading(& $str, $strip = TRUE)
362 // Cut fixed-heading anchors
365 if (preg_match('/^(\*{0,3})(.*?)\[#([A-Za-z][\w-]+)\](.*?)$/m', $str, $matches)) {
366 $str = $matches[2] . $matches[4];
369 $str = preg_replace('/^\*{0,3}/', '', $str);
372 // Cut footnotes and tags
374 $str = strip_htmltag(make_link(preg_replace($NotePattern, '', $str)));
379 // Separate a page-name(or URL or null string) and an anchor
380 // (last one standing) without sharp
381 function anchor_explode($page, $strict_editable = FALSE)
383 $pos = strrpos($page, '#');
384 if ($pos === FALSE) return array($page, '', FALSE);
386 // Ignore the last sharp letter
387 if ($pos + 1 == strlen($page)) {
388 $pos = strpos(substr($page, $pos + 1), '#');
389 if ($pos === FALSE) return array($page, '', FALSE);
392 $s_page = substr($page, 0, $pos);
393 $anchor = substr($page, $pos + 1);
395 if($strict_editable === TRUE && preg_match('/^[a-z][a-f0-9]{7}$/', $anchor)) {
396 return array ($s_page, $anchor, TRUE); // Seems fixed-anchor
398 return array ($s_page, $anchor, FALSE);
402 // Check HTTP header()s were sent already, or
403 // there're blank lines or something out of php blocks
404 function pkwk_headers_sent()
406 if (PKWK_OPTIMISE) return;
409 if (version_compare(PHP_VERSION, '4.3.0', '>=')) {
410 if (headers_sent($file, $line))
411 die('Headers already sent at ' .
412 htmlspecialchars($file) .
413 ' line ' . $line . '.');
416 die('Headers already sent.');
420 // Output common HTTP headers
421 function pkwk_common_headers()
423 if (! PKWK_OPTIMISE) pkwk_headers_sent();
425 if(defined('PKWK_ZLIB_LOADABLE_MODULE')) {
427 if(ini_get('zlib.output_compression') &&
428 preg_match('/\b(gzip|deflate)\b/i', $_SERVER['HTTP_ACCEPT_ENCODING'], $matches)) {
429 // Bug #29350 output_compression compresses everything _without header_ as loadable module
430 // http://bugs.php.net/bug.php?id=29350
431 header('Content-Encoding: ' . $matches[1]);
432 header('Vary: Accept-Encoding');
438 define('PKWK_DTD_XHTML_1_1', 17); // Strict only
439 define('PKWK_DTD_XHTML_1_0', 16); // Strict
440 define('PKWK_DTD_XHTML_1_0_STRICT', 16);
441 define('PKWK_DTD_XHTML_1_0_TRANSITIONAL', 15);
442 define('PKWK_DTD_XHTML_1_0_FRAMESET', 14);
443 define('PKWK_DTD_HTML_4_01', 3); // Strict
444 define('PKWK_DTD_HTML_4_01_STRICT', 3);
445 define('PKWK_DTD_HTML_4_01_TRANSITIONAL', 2);
446 define('PKWK_DTD_HTML_4_01_FRAMESET', 1);
448 define('PKWK_DTD_TYPE_XHTML', 1);
449 define('PKWK_DTD_TYPE_HTML', 0);
451 // Output HTML DTD, <html> start tag. Return content-type.
452 function pkwk_output_dtd($pkwk_dtd = PKWK_DTD_XHTML_1_1, $charset = CONTENT_CHARSET)
455 if (isset($called)) die('pkwk_output_dtd() already called. Why?');
458 $type = PKWK_DTD_TYPE_XHTML;
461 case PKWK_DTD_XHTML_1_1 :
463 $dtd = 'http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd';
465 case PKWK_DTD_XHTML_1_0_STRICT :
468 $dtd = 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd';
470 case PKWK_DTD_XHTML_1_0_TRANSITIONAL:
472 $option = 'Transitional';
473 $dtd = 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd';
476 case PKWK_DTD_HTML_4_01_STRICT :
477 $type = PKWK_DTD_TYPE_HTML;
479 $dtd = 'http://www.w3.org/TR/html4/strict.dtd';
481 case PKWK_DTD_HTML_4_01_TRANSITIONAL:
482 $type = PKWK_DTD_TYPE_HTML;
484 $option = 'Transitional';
485 $dtd = 'http://www.w3.org/TR/html4/loose.dtd';
488 default: die('DTD not specified or invalid DTD');
492 $charset = htmlspecialchars($charset);
495 if ($type == PKWK_DTD_TYPE_XHTML) echo '<?xml version="1.0" encoding="' . $charset . '" ?>' . "\n";
498 echo '<!DOCTYPE html PUBLIC "-//W3C//DTD ' .
499 ($type == PKWK_DTD_TYPE_XHTML ? 'XHTML' : 'HTML') . ' ' .
501 ($option != '' ? ' ' . $option : '') .
506 // Output <html> start tag
508 if ($type == PKWK_DTD_TYPE_XHTML) {
509 echo ' xmlns="http://www.w3.org/1999/xhtml"'; // dir="ltr" /* LeftToRight */
510 echo ' xml:lang="' . LANG . '"';
511 if ($version == '1.0') echo ' lang="' . LANG . '"'; // Only XHTML 1.0
513 echo ' lang="' . LANG . '"'; // HTML
515 echo '>' . "\n"; // <html>
517 // Return content-type (with MIME type)
518 if ($type == PKWK_DTD_TYPE_XHTML) {
519 // NOTE: XHTML 1.1 browser will ignore http-equiv
520 return '<meta http-equiv="content-type" content="application/xhtml+xml; charset=' . $charset . '" />' . "\n";
522 return '<meta http-equiv="content-type" content="text/html; charset=' . $charset . '" />' . "\n";