X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=src%2Fhelp.php;h=4d6586072a5fe32efcd5040aaaeaaef9bf60538f;hp=2da48edf7fddf715a05d1a38254791a6bcacecbf;hb=c4faef335b2362c81b8ebf026d4066c12d70536c;hpb=143c7a822202ae2c1a5b31dcbdb2e072763a4a24
diff --git a/src/help.php b/src/help.php
index 2da48edf..4d658607 100644
--- a/src/help.php
+++ b/src/help.php
@@ -3,24 +3,23 @@
/**
* help.php
*
- * Copyright (c) 1999-2002 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
- *
* Displays help for the user
*
- * $Id$
+ * @copyright 1999-2020 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package squirrelmail
*/
-/* Path for SquirrelMail required files. */
-define('SM_PATH','../');
+/** This is the help page */
+define('PAGE_NAME', 'help');
-/* SquirrelMail required files. */
-require_once(SM_PATH . 'include/validate.php');
-require_once(SM_PATH . 'functions/display_messages.php');
-require_once(SM_PATH . 'functions/imap.php');
-require_once(SM_PATH . 'functions/array.php');
+/**
+ * Include the SquirrelMail initialization file.
+ */
+require('../include/init.php');
-displayPageHeader($color, 'None' );
+displayPageHeader($color);
$helpdir[0] = 'basic.hlp';
$helpdir[1] = 'main_folder.hlp';
@@ -42,11 +41,14 @@ $helpdir[8] = 'FAQ.hlp';
function get_info($doc, $pos) {
$ary = array(0,0,0);
- for ($n=$pos; $n < count($doc); $n++) {
+
+ $cntdoc = count($doc);
+
+ for ($n=$pos; $n < $cntdoc; $n++) {
if (trim(strtolower($doc[$n])) == ''
|| trim(strtolower($doc[$n])) == '') {
- for ($n++;$n < count($doc)
- && (trim(strtolower($doc[$n])) != '')
+ for ($n++; $n < $cntdoc
+ && (trim(strtolower($doc[$n])) != '')
&& (trim(strtolower($doc[$n])) != ''); $n++) {
if (trim(strtolower($doc[$n])) == '') {
$n++;
@@ -54,7 +56,7 @@ function get_info($doc, $pos) {
}
if (trim(strtolower($doc[$n])) == '<description>') {
$ary[1] = '';
- for ($n++;$n < count($doc)
+ for ($n++;$n < $cntdoc
&& (trim(strtolower($doc[$n])) != '</description>');
$n++) {
$ary[1] .= $doc[$n];
@@ -62,8 +64,8 @@ function get_info($doc, $pos) {
}
if (trim(strtolower($doc[$n])) == '<summary>') {
$ary[2] = '';
- for ($n++; $n < count($doc)
- && (trim(strtolower($doc[$n])) != '</summary>');
+ for ($n++; $n < $cntdoc
+ && (trim(strtolower($doc[$n])) != '</summary>');
$n++) {
$ary[2] .= $doc[$n];
}
@@ -76,13 +78,13 @@ function get_info($doc, $pos) {
$ary[1] = $ary[0];
$ary[2] = $ary[0];
}
- return( $ary );
+ return( $ary );
} else if (!trim(strtolower($doc[$n]))) {
- $ary[0] = '';
- $ary[1] = '';
- $ary[2] = '';
- $ary[3] = $n;
- }
+ $ary[0] = '';
+ $ary[1] = '';
+ $ary[2] = '';
+ $ary[3] = $n;
+ }
}
$ary[0] = _("ERROR: Help files are not in the right format!");
$ary[1] = $ary[0];
@@ -93,148 +95,148 @@ function get_info($doc, $pos) {
/**************[ END HELP FUNCTIONS ]******************/
+do_hook('help_top', $null);
-
-echo html_tag( 'table',
- html_tag( 'tr',
- html_tag( 'td','<center><b>' . _("Help") .'</b></center>', 'center', $color[0] )
- ) ,
- 'center', '', 'width="95%" cellpadding="1" cellspacing="2" border="0"' );
-
-do_hook("help_top");
-
-echo html_tag( 'table', '', 'center', '', 'width="90%" cellpadding="0" cellspacing="10" border="0"' ) .
- html_tag( 'tr' ) .
- html_tag( 'td' );
-
-if (isset($_SERVER['HTTP_REFERER'])) {
- $ref = strtolower($_SERVER['HTTP_REFERER']);
- if (strpos($ref, 'src/compose')){
- $context = 'compose';
- } else if (strpos($ref, 'src/addr')){
- $context = 'address';
- } else if (strpos($ref, 'src/folders')){
- $context = 'folders';
- } else if (strpos($ref, 'src/options')){
- $context = 'options';
- } else if (strpos($ref, 'src/right_main')){
- $context = 'index';
- } else if (strpos($ref, 'src/read_body')){
- $context = 'read';
- } else if (strpos($ref, 'src/search')){
- $context = 'search';
- }
-}
-
if (!isset($squirrelmail_language)) {
$squirrelmail_language = 'en_US';
}
if (file_exists("../help/$squirrelmail_language")) {
- $help_exists = true;
$user_language = $squirrelmail_language;
} else if (file_exists('../help/en_US')) {
- $help_exists = true;
- echo "<center><font color=\"$color[2]\">";
- printf (_("The help has not been translated to %s. It will be displayed in English instead."), $languages[$squirrelmail_language]['NAME']);
- echo '</font></center><br>';
+ error_box(_("Help is not available in the selected language. It will be displayed in English instead."));
+ echo '<br />';
$user_language = 'en_US';
} else {
- $help_exists = false;
- echo "<br><center><font color=\"$color[2]\">" .
- _("Some or all of the help documents are not present!").
- '</font></center>'.
- '</td></tr></table></body></html>';
- /* this is really silly, because there may be some
- * footers. What about them.
- * TODO: Fix this so it's not just "exit".
- */
+ error_box( _("Help is not available. Please contact your system administrator for assistance."));
+ echo '</td></tr></table>';
+ // Display footer (closes HTML tags) and stop script execution.
+ $oTemplate->display('footer.tpl');
exit;
}
-if ($help_exists == true) {
- if (!isset($context)){
- $context = '';
- }
- if ($context == 'compose'){
- $chapter = 4;
- } else if ($context == 'address'){
- $chapter = 5;
- } else if ($context == 'folders'){
- $chapter = 6;
- } else if ($context == 'options'){
- $chapter = 7;
- } else if ($context == 'index'){
- $chapter = 2;
- } else if ($context == 'read'){
- $chapter = 3;
- } else if ($context == 'search'){
- $chapter = 8;
- } else if ( isset( $_GET['chapter'] ) ) {
- $chapter = intval( $_GET['chapter']);
- } else {
- $chapter = 0;
+
+/* take the chapternumber from the GET-vars,
+ * else see if we can get a relevant chapter from the referer */
+$chapter = 0;
+
+if ( sqgetGlobalVar('chapter', $temp, SQ_GET) ) {
+ $chapter = (int) $temp;
+} elseif ( sqgetGlobalVar('HTTP_REFERER', $temp, SQ_SERVER) ) {
+ $ref = strtolower($temp);
+
+ $contexts = array ( 'src/compose' => 4, 'src/addr' => 5,
+ 'src/folders' => 6, 'src/options' => 7, 'src/right_main' => 2,
+ 'src/read_body' => 3, 'src/search' => 8 );
+
+ foreach($contexts as $path => $chap) {
+ if(strpos($ref, $path)) {
+ $chapter = $chap;
+ break;
+ }
}
+}
+
+if ( $chapter == 0 || !isset( $helpdir[$chapter-1] ) ) {
+ // Initialise the needed variables.
+ $toc = array();
- if ( $chapter == 0 || !isset( $helpdir[$chapter-1] ) ) {
- echo html_tag( 'table', '', 'center', '', 'cellpadding="0" cellspacing="0" border="0"' );
- html_tag( 'tr' ) .
- html_tag( 'td' ) .
- '<b><center>' . _("Table of Contents") . '</center></b><br>';
- do_hook('help_chapter');
- echo html_tag( 'ol' );
- for ($i=0; $i < count($helpdir); $i++) {
+ // Get the chapter numbers, title and decriptions.
+ for ($i=0, $cnt = count($helpdir); $i < $cnt; $i++) {
+ if (file_exists("../help/$user_language/$helpdir[$i]")) {
+ // First try the selected language.
$doc = file("../help/$user_language/$helpdir[$i]");
$help_info = get_info($doc, 0);
- echo '<li><a href="../src/help.php?chapter=' . ($i+1)
- . '">' . $help_info[0] . '</a>' .
- html_tag( 'ul', $help_info[2] );
- }
- echo '</ol></td></tr></table>';
- } else {
- $doc = file("../help/$user_language/" . $helpdir[$chapter-1]);
- $help_info = get_info($doc, 0);
- echo '<small><center>';
- if ($chapter <= 1){
- echo '<font color="' . $color[9] . '">' . _("Previous")
- . '</font> | ';
- } else {
- echo '<a href="../src/help.php?chapter=' . ($chapter-1)
- . '">' . _("Previous") . '</a> | ';
- }
- echo '<a href="../src/help.php">' . _("Table of Contents") . '</a>';
- if ($chapter >= count($helpdir)){
- echo ' | <font color="' . $color[9] . '">' . _("Next") . '</font>';
+ $toc[] = array($i+1, $help_info[0], $help_info[2]);
+ } elseif (file_exists("../help/en_US/$helpdir[$i]")) {
+ // If the selected language can't be found, try English.
+ $doc = file("../help/en_US/$helpdir[$i]");
+ $help_info = get_info($doc, 0);
+ $toc[] = array($i+1, $help_info[0],
+ _("This chapter is not available in the selected language. It will be displayed in English instead.") .
+ '<br />' . $help_info[2]);
} else {
- echo ' | <a href="../src/help.php?chapter=' . ($chapter+1)
- . '">' . _("Next") . '</a>';
+ // If English can't be found, the chapter went MIA.
+ $toc[] = array($i+1, _("This chapter is missing"),
+ sprintf(_("For some reason, chapter %s is not available."), $i+1));
}
- echo '</center></small><br>';
+ }
- echo '<font size="5"><b>' . $chapter . ' - ' . $help_info[0]
- . '</b></font><br><br>';
- if (isset($help_info[1])){
- echo $help_info[1];
- } else {
- echo html_tag( 'p', $help_info[2], 'left' );
- }
-
+ // Provide hook for external help scripts.
+ do_hook('help_chapter', $null);
+
+ $new_toc = array();
+ foreach ($toc as $ch) {
+ $a = array();
+ $a['Chapter'] = $ch[0];
+ $a['Title'] = $ch[1];
+ $a['Summary'] = trim($ch[2]);
+ $new_toc[] = $a;
+ }
+
+ $oTemplate->assign('toc', $new_toc);
+
+ $oTemplate->display('help_toc.tpl');
+} else {
+ // Initialise the needed variables.
+ $display_chapter = TRUE;
+
+ // Get the chapter.
+ if (file_exists("../help/$user_language/" . $helpdir[$chapter-1])) {
+ // First try the selected language.
+ $doc = file("../help/$user_language/" . $helpdir[$chapter-1]);
+ } elseif (file_exists("../help/en_US/" . $helpdir[$chapter-1])) {
+ // If the selected language can't be found, try English.
+ $doc = file("../help/en_US/" . $helpdir[$chapter-1]);
+ error_box(_("This chapter is not available in the selected language. It will be displayed in English instead."));
+ echo '<br />';
+ } else {
+ // If English can't be found, the chapter went MIA.
+ $display_chapter = FALSE;
+ }
+
+ // Write the chapter.
+ if ($display_chapter) {
+ // If there is a valid chapter, display it.
+ $help_info = get_info($doc, 0);
+ $ch = array();
+ $ch['Chapter'] = $chapter;
+ $ch['Title'] = $help_info[0];
+ $ch['Summary'] = isset($help_info[1]) && $help_info[1] ? trim($help_info[1]) : $help_info[2];
+ $ch['Sections'] = array();
$section = 0;
- for ($n = $help_info[3]; $n < count($doc); $n++) {
+ for ($n = $help_info[3], $cnt = count($doc); $n < $cnt; $n++) {
$section++;
$help_info = get_info($doc, $n);
- echo "<b>$chapter.$section - $help_info[0]</b>" .
- html_tag( 'ul', $help_info[1] );
- $n = $help_info[3];
+ $n = $help_info[3];
+
+ $a = array();
+ $a['SectionNumber'] = $section;
+ $a['SectionTitle'] = $help_info[0];
+ $a['SectionText'] = isset($help_info[1]) ? trim($help_info[1]) : '';;
+
+ $ch['Sections'][] = $a;
}
-
- echo '<br><center><a href="#pagetop">' . _("Top") . '</a></center>';
+
+ $oTemplate->assign('chapter_number', $chapter);
+ $oTemplate->assign('chapter_count', count($helpdir));
+ $oTemplate->assign('chapter_title', $ch['Title']);
+ $oTemplate->assign('chapter_summary', $ch['Summary']);
+ $oTemplate->assign('sections', $ch['Sections']);
+ $oTemplate->assign('error_msg', NULL);
+ } else {
+ // If the help file went MIA, trigger an error message.
+ $oTemplate->assign('chapter_number', $chapter);
+ $oTemplate->assign('chapter_count', count($helpdir));
+ $oTemplate->assign('chapter_title', '');
+ $oTemplate->assign('chapter_summary', '');
+ $oTemplate->assign('sections', array());
+ $oTemplate->assign('error_msg', sprintf(_("For some reason, chapter %s is not available."), $chapter));
}
+
+ $oTemplate->display('help_chapter.tpl');
}
-do_hook('help_bottom');
-echo html_tag( 'tr',
- html_tag( 'td', ' ', 'left', $color[0] )
- ).
- '</table></body></html>';
-?>
+do_hook('help_bottom', $null);
+
+$oTemplate->display('footer.tpl');