/plugin/navi.inc.php

https://bitbucket.org/hironow/pukiwiki-skin-bootpuki · PHP · 186 lines · 125 code · 15 blank · 46 comment · 32 complexity · 99a641e90a6c140694b6204cf37bdf88 MD5 · raw file 

    

  1. <?php
    2. 

  2. // PukiWiki - Yet another WikiWikiWeb clone.
    3. 

  3. // $Id: navi.inc.php,v 1.22 2005/04/02 06:33:39 henoheno Exp $
    4. 

  4. //
    5. 

  5. // Navi plugin: Show DocBook-like navigation bar and contents
    6. 

  6. 

  7. /*
    8. 

  8.  * Usage:
    9. 

  9.  *   #navi(contents-page-name)   <for ALL child pages>
    10. 

  10.  *   #navi([contents-page-name][,reverse]) <for contents page>
    11. 

  11.  *
    12. 

  12.  * Parameter:
    13. 

  13.  *   contents-page-name - Page name of home of the navigation (default:itself)
    14. 

  14.  *   reverse            - Show contents revese
    15. 

  15.  *
    16. 

  16.  * Behaviour at contents page:
    17. 

  17.  *   Always show child-page list like 'ls' plugin
    18. 

  18.  *
    19. 

  19.  * Behaviour at child pages:
    20. 

  20.  *
    21. 

  21.  *   The first plugin call - Show a navigation bar like a DocBook header
    22. 

  22.  *
    23. 

  23.  *     Prev  <contents-page-name>  Next
    24. 

  24.  *     --------------------------------
    25. 

  25.  *
    26. 

  26.  *   The second call - Show a navigation bar like a DocBook footer
    27. 

  27.  *
    28. 

  28.  *     --------------------------------
    29. 

  29.  *     Prev          Home          Next
    30. 

  30.  *     <pagename>     Up     <pagename>
    31. 

  31.  *
    32. 

  32.  * Page-construction example:
    33. 

  33.  *   foobar    - Contents page, includes '#navi' or '#navi(foobar)'
    34. 

  34.  *   foobar/1  - One of child pages, includes one or two '#navi(foobar)'
    35. 

  35.  *   foobar/2  - One of child pages, includes one or two '#navi(foobar)'
    36. 

  36.  */
    37. 

  37. 

  38. // Exclusive regex pattern of child pages
    39. 

  39. define('PLUGIN_NAVI_EXCLUSIVE_REGEX', '');
    40. 

  40. //define('PLUGIN_NAVI_EXCLUSIVE_REGEX', '#/_#'); // Ignore 'foobar/_memo' etc.
    41. 

  41. 

  42. // Insert <link rel=... /> tags into XHTML <head></head>
    43. 

  43. define('PLUGIN_NAVI_LINK_TAGS', FALSE);	// FALSE, TRUE
    44. 

  44. 

  45. // ----
    46. 

  46. 

  47. function plugin_navi_convert()
    48. 

  48. {
    49. 

  49. 	global $vars, $script, $head_tags;
    50. 

  50. 	global $_navi_prev, $_navi_next, $_navi_up, $_navi_home;
    51. 

  51. 	static $navi = array();
    52. 

  52. 

  53. 	$current = $vars['page'];
    54. 

  54. 	$reverse = FALSE;
    55. 

  55. 	if (func_num_args()) {
    56. 

  56. 		list($home, $reverse) = array_pad(func_get_args(), 2, '');
    57. 

  57. 		// strip_bracket() is not necessary but compatible
    58. 

  58. 		$home    = get_fullname(strip_bracket($home), $current);
    59. 

  59. 		$is_home = ($home == $current);
    60. 

  60. 		if (! is_page($home)) {
    61. 

  61. 			return '#navi(contents-page-name): No such page: ' .
    62. 

  62. 				htmlspecialchars($home) . '<br />';
    63. 

  63. 		} else if (! $is_home &&
    64. 

  64. 		    ! preg_match('/^' . preg_quote($home, '/') . '/', $current)) {
    65. 

  65. 			return '#navi(' . htmlspecialchars($home) .
    66. 

  66. 				'): Not a child page like: ' .
    67. 

  67. 				htmlspecialchars($home . '/' . basename($current)) .
    68. 

  68. 				'<br />';
    69. 

  69. 		}
    70. 

  70. 		$reverse = (strtolower($reverse) == 'reverse');
    71. 

  71. 	} else {
    72. 

  72. 		$home    = $vars['page'];
    73. 

  73. 		$is_home = TRUE; // $home == $current
    74. 

  74. 	}
    75. 

  75. 

  76. 	$pages  = array();
    77. 

  77. 	$footer = isset($navi[$home]); // The first time: FALSE, the second: TRUE
    78. 

  78. 	if (! $footer) {
    79. 

  79. 		$navi[$home] = array(
    80. 

  80. 			'up'   =>'',
    81. 

  81. 			'prev' =>'',
    82. 

  82. 			'prev1'=>'',
    83. 

  83. 			'next' =>'',
    84. 

  84. 			'next1'=>'',
    85. 

  85. 			'home' =>'',
    86. 

  86. 			'home1'=>'',
    87. 

  87. 		);
    88. 

  88. 

  89. 		$pages = preg_grep('/^' . preg_quote($home, '/') .
    90. 

  90. 			'($|\/)/', get_existpages());
    91. 

  91. 		if (PLUGIN_NAVI_EXCLUSIVE_REGEX != '') {
    92. 

  92. 			// If old PHP could use preg_grep(,,PREG_GREP_INVERT)...
    93. 

  93. 			$pages = array_diff($pages,
    94. 

  94. 				preg_grep(PLUGIN_NAVI_EXCLUSIVE_REGEX, $pages));
    95. 

  95. 		}
    96. 

  96. 		$pages[] = $current; // Sentinel :)
    97. 

  97. 		$pages   = array_unique($pages);
    98. 

  98. 		natcasesort($pages);
    99. 

  99. 		if ($reverse) $pages = array_reverse($pages);
    100. 

  100. 

  101. 		$prev = $home;
    102. 

  102. 		foreach ($pages as $page) {
    103. 

  103. 			if ($page == $current) break;
    104. 

  104. 			$prev = $page;
    105. 

  105. 		}
    106. 

  106. 		$next = current($pages);
    107. 

  107. 

  108. 		$pos = strrpos($current, '/');
    109. 

  109. 		$up = '';
    110. 

  110. 		if ($pos > 0) {
    111. 

  111. 			$up = substr($current, 0, $pos);
    112. 

  112. 			$navi[$home]['up']    = make_pagelink($up, $_navi_up);
    113. 

  113. 		}
    114. 

  114. 		if (! $is_home) {
    115. 

  115. 			$navi[$home]['prev']  = make_pagelink($prev);
    116. 

  116. 			$navi[$home]['prev1'] = make_pagelink($prev, $_navi_prev);
    117. 

  117. 		}
    118. 

  118. 		if ($next != '') {
    119. 

  119. 			$navi[$home]['next']  = make_pagelink($next);
    120. 

  120. 			$navi[$home]['next1'] = make_pagelink($next, $_navi_next);
    121. 

  121. 		}
    122. 

  122. 		$navi[$home]['home']  = make_pagelink($home);
    123. 

  123. 		$navi[$home]['home1'] = make_pagelink($home, $_navi_home);
    124. 

  124. 

  125. 		// Generate <link> tag: start next prev(previous) parent(up)
    126. 

  126. 		// Not implemented: contents(toc) search first(begin) last(end)
    127. 

  127. 		if (PLUGIN_NAVI_LINK_TAGS) {
    128. 

  128. 			foreach (array('start'=>$home, 'next'=>$next,
    129. 

  129. 			    'prev'=>$prev, 'up'=>$up) as $rel=>$_page) {
    130. 

  130. 				if ($_page != '') {
    131. 

  131. 					$s_page = htmlspecialchars($_page);
    132. 

  132. 					$r_page = rawurlencode($_page);
    133. 

  133. 					$head_tags[] = ' <link rel="' .
    134. 

  134. 						$rel . '" href="' . $script .
    135. 

  135. 						'?' . $r_page . '" title="' .
    136. 

  136. 						$s_page . '" />';
    137. 

  137. 				}
    138. 

  138. 			}
    139. 

  139. 		}
    140. 

  140. 	}
    141. 

  141. 

  142. 	$ret = '';
    143. 

  143. 

  144. 	if ($is_home) {
    145. 

  145. 		// Show contents
    146. 

  146. 		$count = count($pages);
    147. 

  147. 		if ($count == 0) {
    148. 

  148. 			return '#navi(contents-page-name): You already view the result<br />';
    149. 

  149. 		} else if ($count == 1) {
    150. 

  150. 			// Sentinel only: Show usage and warning
    151. 

  151. 			$home = htmlspecialchars($home);
    152. 

  152. 			$ret .= '#navi(' . $home . '): No child page like: ' .
    153. 

  153. 				$home . '/Foo';
    154. 

  154. 		} else {
    155. 

  155. 			$ret .= '<ul>';
    156. 

  156. 			foreach ($pages as $page)
    157. 

  157. 				if ($page != $home)
    158. 

  158. 					$ret .= ' <li>' . make_pagelink($page) . '</li>';
    159. 

  159. 			$ret .= '</ul>';
    160. 

  160. 		}
    161. 

  161. 

  162. 	} else if (! $footer) {
    163. 

  163. 		// Header
    164. 

  164. 		$ret = <<<EOD
    165. 

  165. <ul class="navi">
    166. 

  166.  <li class="navi_left">{$navi[$home]['prev1']}</li>
    167. 

  167.  <li class="navi_right">{$navi[$home]['next1']}</li>
    168. 

  168.  <li class="navi_none">{$navi[$home]['home']}</li>
    169. 

  169. </ul>
    170. 

  170. <hr class="full_hr" />
    171. 

  171. EOD;
    172. 

  172. 

  173. 	} else {
    174. 

  174. 		// Footer
    175. 

  175. 		$ret = <<<EOD
    176. 

  176. <hr class="full_hr" />
    177. 

  177. <ul class="navi">
    178. 

  178.  <li class="navi_left">{$navi[$home]['prev1']}<br /><small>{$navi[$home]['prev']}</small></li>
    179. 

  179.  <li class="navi_right">{$navi[$home]['next1']}<br /><small>{$navi[$home]['next']}</small></li>
    180. 

  180.  <li class="navi_none">{$navi[$home]['home1']}<br /><small>{$navi[$home]['up']}</small></li>
    181. 

  181. </ul>
    182. 

  182. EOD;
    183. 

  183. 	}
    184. 

  184. 	return $ret;
    185. 

  185. }
    186. 

  186. ?>
    187.