2 // PukiWiki - Yet another WikiWikiWeb clone.
5 // 2002-2017 PukiWiki Development Team
6 // 2002 panda http://home.arino.jp/?ls2.inc.php
7 // 2002 Y.MASUI GPL2 http://masui.net/pukiwiki/ masui@masui.net (ls.inc.php)
8 // License: GPL version 2
13 * 配下のページや、その見出し(*,**,***)の一覧を表示する
15 * #ls2(pattern[,title|include|link|reverse|compact, ...],heading title)
17 * pattern : 省略するときもカンマが必要
18 * 'title' : 見出しの一覧を表示する
19 * 'include': インクルードしているページの見出しを再帰的に列挙する
20 * 'link ': actionプラグインを呼び出すリンクを表示
21 * 'reverse': ページの並び順を反転し、降順にする
22 * 'compact': 見出しレベルを調整する
23 * PLUGIN_LS2_LIST_COMPACTがTRUEの時は無効(変化しない)
24 * heading title: 見出しのタイトルを指定する (linkを指定した時のみ)
28 define('PLUGIN_LS2_ANCHOR_PREFIX', '#content_1_');
31 define('PLUGIN_LS2_ANCHOR_ORIGIN', 0);
33 // 見出しレベルを調整する(デフォルト値)
34 define('PLUGIN_LS2_LIST_COMPACT', FALSE);
36 function plugin_ls2_action()
38 global $vars, $_ls2_msg_title;
41 $keys = array('title', 'include', 'reverse');
42 foreach ($keys as $key)
43 $params[$key] = isset($vars[$key]);
45 $prefix = isset($vars['prefix']) ? $vars['prefix'] : '';
46 $body = plugin_ls2_show_lists($prefix, $params);
48 return array('body'=>$body,
49 'msg'=>str_replace('$1', htmlsc($prefix), $_ls2_msg_title));
52 function plugin_ls2_convert()
54 global $vars, $_ls2_msg_title;
61 'compact' => PLUGIN_LS2_LIST_COMPACT,
68 if (func_num_args()) {
69 $args = func_get_args();
70 $prefix = array_shift($args);
72 if ($prefix == '') $prefix = strip_bracket($vars['page']) . '/';
74 foreach ($args as $arg)
75 plugin_ls2_check_arg($arg, $params);
77 $title = (! empty($params['_args'])) ? join(',', $params['_args']) : // Manual
78 str_replace('$1', htmlsc($prefix), $_ls2_msg_title); // Auto
80 if (! $params['link'])
81 return plugin_ls2_show_lists($prefix, $params);
84 $tmp[] = 'plugin=ls2&prefix=' . rawurlencode($prefix);
85 if (isset($params['title'])) $tmp[] = 'title=1';
86 if (isset($params['include'])) $tmp[] = 'include=1';
88 return '<p><a href="' . get_base_uri() . '?' . join('&', $tmp) . '">' .
89 $title . '</a></p>' . "\n";
92 function plugin_ls2_show_lists($prefix, & $params)
94 global $_ls2_err_nopages;
98 foreach (get_existpages() as $_page)
99 if (strpos($_page, $prefix) === 0)
102 $pages = get_existpages();
106 if ($params['reverse']) $pages = array_reverse($pages);
108 foreach ($pages as $page) $params['page_ ' . $page] = 0;
111 return str_replace('$1', htmlsc($prefix), $_ls2_err_nopages);
113 $params['result'] = $params['saved'] = array();
114 foreach ($pages as $page)
115 plugin_ls2_get_headings($page, $params, 1);
116 return join("\n", $params['result']) . join("\n", $params['saved']);
120 function plugin_ls2_get_headings($page, & $params, $level, $include = FALSE)
122 static $_ls2_anchor = 0;
125 $is_done = (isset($params["page_$page"]) && $params["page_$page"] > 0);
126 if (! $is_done) $params["page_$page"] = ++$_ls2_anchor;
128 $s_page = htmlsc($page);
129 $title = $s_page . ' ' . get_pg_passage($page, FALSE);
130 $href = get_page_uri($page);
132 plugin_ls2_list_push($params, $level);
133 $ret = $include ? '<li>include ' : '<li>';
135 if ($params['title'] && $is_done) {
136 $ret .= '<a href="' . $href . '" title="' . $title . '">' . $s_page . '</a> ';
137 $ret .= '<a href="#list_' . $params["page_$page"] . '"><sup>↑</sup></a>';
138 array_push($params['result'], $ret);
142 $ret .= '<a id="list_' . $params["page_$page"] . '" href="' . $href .
143 '" title="' . $title . '">' . $s_page . '</a>';
144 array_push($params['result'], $ret);
146 $anchor = PLUGIN_LS2_ANCHOR_ORIGIN;
148 foreach (get_source($page) as $line) {
149 if ($params['title'] && preg_match('/^(\*{1,3})/', $line, $matches)) {
150 $id = make_heading($line);
151 $level = strlen($matches[1]);
152 $id = PLUGIN_LS2_ANCHOR_PREFIX . $anchor++;
153 plugin_ls2_list_push($params, $level + strlen($level));
154 array_push($params['result'],
155 '<li><a href="' . $href . $id . '">' . $line . '</a>');
156 } else if ($params['include'] &&
157 preg_match('/^#include\((.+)\)/', $line, $matches) &&
158 is_page($matches[1]))
160 plugin_ls2_get_headings($matches[1], $params, $level + 1, TRUE);
166 function plugin_ls2_list_push(& $params, $level)
168 $result = & $params['result'];
169 $saved = & $params['saved'];
172 $close = '</li></ul>';
174 while (count($saved) > $level || (! empty($saved) && $saved[0] != $close))
175 array_push($result, array_shift($saved));
177 $margin = $level - count($saved);
180 while (count($saved) < ($level - 1)) array_unshift($saved, '');
182 if (count($saved) < $level) {
184 array_unshift($saved, $close);
187 if ($params['compact']) {
188 $left = 1; // マージンを固定
189 $level -= ($margin - 1); // レベルを修正
193 $str = sprintf(pkwk_list_attrs_template(), $level, $left);
194 array_push($result, sprintf($open, $str));
197 if ($cont) array_push($result, '</li>');
201 function plugin_ls2_check_arg($value, & $params)
204 $params['_done'] = TRUE;
208 if (! $params['_done']) {
209 foreach (array_keys($params) as $param) {
210 if (strtolower($value) == $param &&
211 preg_match('/^[a-z]/', $param)) {
212 $params[$param] = TRUE;
216 $params['_done'] = TRUE;
219 $params['_args'][] = htmlsc($value); // Link title