e222c290 |
1 | <?php |
895905c0 |
2 | |
35586184 |
3 | /** |
4 | * help.php |
5 | * |
35586184 |
6 | * Displays help for the user |
7 | * |
47ccfad4 |
8 | * @copyright © 1999-2006 The SquirrelMail Project Team |
4b4abf93 |
9 | * @license http://opensource.org/licenses/gpl-license.php GNU Public License |
30967a1e |
10 | * @version $Id$ |
8f6f9ba5 |
11 | * @package squirrelmail |
35586184 |
12 | */ |
13 | |
30967a1e |
14 | /** |
202bcbcc |
15 | * Include the SquirrelMail initialization file. |
30967a1e |
16 | */ |
202bcbcc |
17 | require('../include/init.php'); |
390372b4 |
18 | |
cd08020d |
19 | displayPageHeader($color, 'None' ); |
20 | |
21 | $helpdir[0] = 'basic.hlp'; |
22 | $helpdir[1] = 'main_folder.hlp'; |
23 | $helpdir[2] = 'read_mail.hlp'; |
24 | $helpdir[3] = 'compose.hlp'; |
25 | $helpdir[4] = 'addresses.hlp'; |
26 | $helpdir[5] = 'folders.hlp'; |
27 | $helpdir[6] = 'options.hlp'; |
28 | $helpdir[7] = 'search.hlp'; |
29 | $helpdir[8] = 'FAQ.hlp'; |
30 | |
31 | /****************[ HELP FUNCTIONS ]********************/ |
390372b4 |
32 | |
cd08020d |
33 | /** |
34 | * parses through and gets the information from the different documents. |
35 | * this returns one section at a time. You must keep track of the position |
36 | * so that it knows where to start to look for the next section. |
37 | */ |
38 | |
39 | function get_info($doc, $pos) { |
143c7a82 |
40 | $ary = array(0,0,0); |
7ea33e5b |
41 | |
42 | $cntdoc = count($doc); |
43 | |
44 | for ($n=$pos; $n < $cntdoc; $n++) { |
cd08020d |
45 | if (trim(strtolower($doc[$n])) == '<chapter>' |
46 | || trim(strtolower($doc[$n])) == '<section>') { |
91e0dccc |
47 | for ($n++; $n < $cntdoc |
48 | && (trim(strtolower($doc[$n])) != '</section>') |
cd08020d |
49 | && (trim(strtolower($doc[$n])) != '</chapter>'); $n++) { |
50 | if (trim(strtolower($doc[$n])) == '<title>') { |
51 | $n++; |
52 | $ary[0] = trim($doc[$n]); |
53 | } |
54 | if (trim(strtolower($doc[$n])) == '<description>') { |
55 | $ary[1] = ''; |
91e0dccc |
56 | for ($n++;$n < $cntdoc |
cd08020d |
57 | && (trim(strtolower($doc[$n])) != '</description>'); |
58 | $n++) { |
59 | $ary[1] .= $doc[$n]; |
60 | } |
61 | } |
62 | if (trim(strtolower($doc[$n])) == '<summary>') { |
63 | $ary[2] = ''; |
91e0dccc |
64 | for ($n++; $n < $cntdoc |
65 | && (trim(strtolower($doc[$n])) != '</summary>'); |
cd08020d |
66 | $n++) { |
67 | $ary[2] .= $doc[$n]; |
68 | } |
69 | } |
2d367c68 |
70 | } |
1863670d |
71 | if (isset($ary)) { |
cd08020d |
72 | $ary[3] = $n; |
390372b4 |
73 | } else { |
0120b304 |
74 | $ary[0] = _("ERROR: Help files are not in the right format!"); |
75 | $ary[1] = $ary[0]; |
76 | $ary[2] = $ary[0]; |
2d367c68 |
77 | } |
134e4174 |
78 | return( $ary ); |
143c7a82 |
79 | } else if (!trim(strtolower($doc[$n]))) { |
134e4174 |
80 | $ary[0] = ''; |
81 | $ary[1] = ''; |
82 | $ary[2] = ''; |
83 | $ary[3] = $n; |
84 | } |
cd08020d |
85 | } |
0120b304 |
86 | $ary[0] = _("ERROR: Help files are not in the right format!"); |
87 | $ary[1] = $ary[0]; |
143c7a82 |
88 | $ary[2] = $ary[0]; |
89 | $ary[3] = $n; |
0120b304 |
90 | return( $ary ); |
cd08020d |
91 | } |
2d367c68 |
92 | |
cd08020d |
93 | /**************[ END HELP FUNCTIONS ]******************/ |
390372b4 |
94 | |
6206f6c4 |
95 | echo html_tag( 'table', |
3530b83b |
96 | html_tag( 'tr', |
f265009a |
97 | html_tag( 'td','<div style="text-align: center;"><b>' . _("Help") .'</b></div>', 'center', $color[0] ) |
3530b83b |
98 | ) , |
6206f6c4 |
99 | 'center', '', 'width="95%" cellpadding="1" cellspacing="2" border="0"' ); |
3530b83b |
100 | |
7ea33e5b |
101 | do_hook('help_top'); |
3530b83b |
102 | |
103 | echo html_tag( 'table', '', 'center', '', 'width="90%" cellpadding="0" cellspacing="10" border="0"' ) . |
104 | html_tag( 'tr' ) . |
105 | html_tag( 'td' ); |
106 | |
cd08020d |
107 | if (!isset($squirrelmail_language)) { |
e5916f84 |
108 | $squirrelmail_language = 'en_US'; |
cd08020d |
109 | } |
110 | |
cd08020d |
111 | if (file_exists("../help/$squirrelmail_language")) { |
cd08020d |
112 | $user_language = $squirrelmail_language; |
e5916f84 |
113 | } else if (file_exists('../help/en_US')) { |
1b858d86 |
114 | error_box(_("Help is not available in the selected language. It will be displayed in English instead.")); |
386c7b54 |
115 | echo '<br />'; |
e5916f84 |
116 | $user_language = 'en_US'; |
cd08020d |
117 | } else { |
1b858d86 |
118 | error_box( _("Help is not available. Please contact your system administrator for assistance.")); |
1ce76674 |
119 | echo '</td></tr></table>'; |
120 | // Display footer (closes HTML tags) and stop script execution. |
1b858d86 |
121 | $oTemplate->display('footer.tpl'); |
1ce76674 |
122 | exit; |
cd08020d |
123 | } |
124 | |
7ea33e5b |
125 | |
126 | /* take the chapternumber from the GET-vars, |
127 | * else see if we can get a relevant chapter from the referer */ |
128 | $chapter = 0; |
129 | |
1e12d1ff |
130 | if ( sqgetGlobalVar('chapter', $temp, SQ_GET) ) { |
131 | $chapter = (int) $temp; |
132 | } elseif ( sqgetGlobalVar('HTTP_REFERER', $temp, SQ_SERVER) ) { |
133 | $ref = strtolower($temp); |
7ea33e5b |
134 | |
135 | $contexts = array ( 'src/compose' => 4, 'src/addr' => 5, |
136 | 'src/folders' => 6, 'src/options' => 7, 'src/right_main' => 2, |
137 | 'src/read_body' => 3, 'src/search' => 8 ); |
138 | |
139 | foreach($contexts as $path => $chap) { |
140 | if(strpos($ref, $path)) { |
141 | $chapter = $chap; |
142 | break; |
143 | } |
cd08020d |
144 | } |
7ea33e5b |
145 | } |
146 | |
147 | if ( $chapter == 0 || !isset( $helpdir[$chapter-1] ) ) { |
386c7b54 |
148 | // Initialise the needed variables. |
149 | $toc = array(); |
150 | |
151 | // Get the chapter numbers, title and decriptions. |
152 | for ($i=0, $cnt = count($helpdir); $i < $cnt; $i++) { |
153 | if (file_exists("../help/$user_language/$helpdir[$i]")) { |
154 | // First try the selected language. |
155 | $doc = file("../help/$user_language/$helpdir[$i]"); |
156 | $help_info = get_info($doc, 0); |
157 | $toc[] = array($i+1, $help_info[0], $help_info[2]); |
158 | } elseif (file_exists("../help/en_US/$helpdir[$i]")) { |
159 | // If the selected language can't be found, try English. |
160 | $doc = file("../help/en_US/$helpdir[$i]"); |
161 | $help_info = get_info($doc, 0); |
162 | $toc[] = array($i+1, $help_info[0], |
163 | _("This chapter is not available in the selected language. It will be displayed in English instead.") . |
164 | '<br />' . $help_info[2]); |
165 | } else { |
166 | // If English can't be found, the chapter went MIA. |
167 | $toc[] = array($i+1, _("This chapter is missing"), |
168 | sprintf(_("For some reason, chapter %s is not available."), $i+1)); |
169 | } |
170 | } |
171 | |
172 | // Write the TOC header |
81c064ac |
173 | echo html_tag( 'table', '', 'center', '', 'cellpadding="0" cellspacing="0" border="0"' ) . |
134e4174 |
174 | html_tag( 'tr' ) . |
175 | html_tag( 'td' ) . |
f265009a |
176 | '<div style="text-align: center;"><b>' . _("Table of Contents") . '</b></div><br />'; |
7ea33e5b |
177 | echo html_tag( 'ol' ); |
386c7b54 |
178 | |
179 | // Write the TOC chapters. |
1ce76674 |
180 | // FIXME: HTML code is not compliant. |
386c7b54 |
181 | for ($i=0, $cnt = count($toc); $i < $cnt; $i++) { |
182 | echo '<li><a href="../src/help.php?chapter=' . $toc[$i][0]. '">' . |
183 | $toc[$i][1] . '</a>' . html_tag( 'ul', $toc[$i][2] ); |
7ea33e5b |
184 | } |
386c7b54 |
185 | |
186 | // Provide hook for external help scripts. |
6575fe45 |
187 | do_hook('help_chapter'); |
386c7b54 |
188 | |
189 | // Write the TOC footer. |
7ea33e5b |
190 | echo '</ol></td></tr></table>'; |
191 | } else { |
386c7b54 |
192 | // Initialise the needed variables. |
193 | $display_chapter = TRUE; |
194 | |
195 | // Get the chapter. |
196 | if (file_exists("../help/$user_language/" . $helpdir[$chapter-1])) { |
197 | // First try the selected language. |
198 | $doc = file("../help/$user_language/" . $helpdir[$chapter-1]); |
199 | } elseif (file_exists("../help/en_US/" . $helpdir[$chapter-1])) { |
200 | // If the selected language can't be found, try English. |
201 | $doc = file("../help/en_US/" . $helpdir[$chapter-1]); |
e7c3f032 |
202 | error_box(_("This chapter is not available in the selected language. It will be displayed in English instead.")); |
386c7b54 |
203 | echo '<br />'; |
204 | } else { |
205 | // If English can't be found, the chapter went MIA. |
206 | $display_chapter = FALSE; |
207 | } |
208 | |
209 | // Write the chpater header. |
f265009a |
210 | echo '<div style="text-align: center;"><small>'; |
7ea33e5b |
211 | if ($chapter <= 1){ |
212 | echo '<font color="' . $color[9] . '">' . _("Previous") |
213 | . '</font> | '; |
214 | } else { |
215 | echo '<a href="../src/help.php?chapter=' . ($chapter-1) |
216 | . '">' . _("Previous") . '</a> | '; |
217 | } |
218 | echo '<a href="../src/help.php">' . _("Table of Contents") . '</a>'; |
219 | if ($chapter >= count($helpdir)){ |
220 | echo ' | <font color="' . $color[9] . '">' . _("Next") . '</font>'; |
0120b304 |
221 | } else { |
7ea33e5b |
222 | echo ' | <a href="../src/help.php?chapter=' . ($chapter+1) |
223 | . '">' . _("Next") . '</a>'; |
cd08020d |
224 | } |
f265009a |
225 | echo '</small></div><br />'; |
cd08020d |
226 | |
386c7b54 |
227 | // Write the chapter. |
228 | if ($display_chapter) { |
229 | // If there is a valid chapter, display it. |
230 | $help_info = get_info($doc, 0); |
231 | echo '<font size="5"><b>' . $chapter . ' - ' . $help_info[0] |
232 | . '</b></font><br /><br />'; |
7ea33e5b |
233 | |
386c7b54 |
234 | if (isset($help_info[1]) && $help_info[1]) { |
235 | echo $help_info[1]; |
236 | } else { |
237 | echo html_tag( 'p', $help_info[2], 'left' ); |
238 | } |
91e0dccc |
239 | |
386c7b54 |
240 | $section = 0; |
241 | for ($n = $help_info[3], $cnt = count($doc); $n < $cnt; $n++) { |
242 | $section++; |
243 | $help_info = get_info($doc, $n); |
244 | echo "<b>$chapter.$section - $help_info[0]</b>" . |
1ce76674 |
245 | $help_info[1]; |
386c7b54 |
246 | $n = $help_info[3]; |
247 | } |
7ea33e5b |
248 | |
386c7b54 |
249 | echo '<br /><div style="text-align: center;"><a href="#pagetop">' . _("Top") . '</a></div>'; |
250 | } else { |
251 | // If the help file went MIA, display an error message. |
1b858d86 |
252 | error_box(sprintf(_("For some reason, chapter %s is not available."), $chapter)); |
386c7b54 |
253 | } |
cd08020d |
254 | } |
7ea33e5b |
255 | |
cd08020d |
256 | do_hook('help_bottom'); |
3530b83b |
257 | |
258 | echo html_tag( 'tr', |
259 | html_tag( 'td', ' ', 'left', $color[0] ) |
134e4174 |
260 | ); |
a2b193bc |
261 | |
134e4174 |
262 | ?> |
5c4ff7bf |
263 | </table> |
264 | <?php |
265 | $oTemplate->display('footer.tpl'); |
266 | ?> |