From 386c7b5475f02b7d08f19521dabe7c2ac9216355 Mon Sep 17 00:00:00 2001 From: jervfors Date: Mon, 1 May 2006 20:27:07 +0000 Subject: [PATCH] Adding more tests and fallbacks for errors in help pages. git-svn-id: https://svn.code.sf.net/p/squirrelmail/code/trunk/squirrelmail@11105 7612ce4b-ef26-0410-bec9-ea0150e637f0 --- ChangeLog | 1 + src/help.php | 108 +++++++++++++++++++++++++++++++++++++-------------- 2 files changed, 80 insertions(+), 29 deletions(-) diff --git a/ChangeLog b/ChangeLog index 12006910..1d7466e0 100644 --- a/ChangeLog +++ b/ChangeLog @@ -46,6 +46,7 @@ Version 1.5.2 - CVS - Added workaround for broken OpenBSD 3.8+ setlocale() function (#1427512). - Fixed session lockups on large attachment downloads. - Added configtest hook in src/configtest.php. + - Improved error handling for the help pages. Version 1.5.1 (branched on 2006-02-12) -------------------------------------- diff --git a/src/help.php b/src/help.php index 389e8bad..f9d07b51 100644 --- a/src/help.php +++ b/src/help.php @@ -92,7 +92,6 @@ function get_info($doc, $pos) { /**************[ END HELP FUNCTIONS ]******************/ - echo html_tag( 'table', html_tag( 'tr', html_tag( 'td','
' . _("Help") .'
', 'center', $color[0] ) @@ -112,12 +111,11 @@ if (!isset($squirrelmail_language)) { if (file_exists("../help/$squirrelmail_language")) { $user_language = $squirrelmail_language; } else if (file_exists('../help/en_US')) { - echo "
" - ._("The help has not been translated to the selected language. It will be displayed in English instead."); - echo '

'; + error_box(_("Help is not available in the selected language. It will be displayed in English instead."), $color); + echo '
'; $user_language = 'en_US'; } else { - error_box( _("Some or all of the help documents are not present!"), $color ); + error_box( _("Help is not available. Please contact your system administrator for assistance."), $color ); exit; } @@ -144,23 +142,67 @@ if ( sqgetGlobalVar('chapter', $temp, SQ_GET) ) { } if ( $chapter == 0 || !isset( $helpdir[$chapter-1] ) ) { + // Initialise the needed variables. + $toc = array(); + + // 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); + $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.") . + '
' . $help_info[2]); + } else { + // 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)); + } + } + + // Write the TOC header echo html_tag( 'table', '', 'center', '', 'cellpadding="0" cellspacing="0" border="0"' ) . html_tag( 'tr' ) . html_tag( 'td' ) . '
' . _("Table of Contents") . '

'; echo html_tag( 'ol' ); - for ($i=0, $cnt = count($helpdir); $i < $cnt; $i++) { - $doc = file("../help/$user_language/$helpdir[$i]"); - $help_info = get_info($doc, 0); - echo '
  • ' . $help_info[0] . '' . - html_tag( 'ul', $help_info[2] ); + + // Write the TOC chapters. + for ($i=0, $cnt = count($toc); $i < $cnt; $i++) { + echo '
  • ' . + $toc[$i][1] . '' . html_tag( 'ul', $toc[$i][2] ); } + + // Provide hook for external help scripts. do_hook('help_chapter'); + + // Write the TOC footer. echo ''; } else { - $doc = file("../help/$user_language/" . $helpdir[$chapter-1]); - $help_info = get_info($doc, 0); + // 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 in not available in the selected language. It will be displayed in English instead."), $color); + echo '
    '; + } else { + // If English can't be found, the chapter went MIA. + $display_chapter = FALSE; + } + + // Write the chpater header. echo '
    '; if ($chapter <= 1){ echo '' . _("Previous") @@ -178,25 +220,33 @@ if ( $chapter == 0 || !isset( $helpdir[$chapter-1] ) ) { } echo '

    '; - echo '' . $chapter . ' - ' . $help_info[0] - . '

    '; + // Write the chapter. + if ($display_chapter) { + // If there is a valid chapter, display it. + $help_info = get_info($doc, 0); + echo '' . $chapter . ' - ' . $help_info[0] + . '

    '; - if (isset($help_info[1]) && $help_info[1]) { - echo $help_info[1]; - } else { - echo html_tag( 'p', $help_info[2], 'left' ); - } + if (isset($help_info[1]) && $help_info[1]) { + echo $help_info[1]; + } else { + echo html_tag( 'p', $help_info[2], 'left' ); + } - $section = 0; - for ($n = $help_info[3], $cnt = count($doc); $n < $cnt; $n++) { - $section++; - $help_info = get_info($doc, $n); - echo "$chapter.$section - $help_info[0]" . - html_tag( 'ul', $help_info[1] ); - $n = $help_info[3]; - } + $section = 0; + for ($n = $help_info[3], $cnt = count($doc); $n < $cnt; $n++) { + $section++; + $help_info = get_info($doc, $n); + echo "$chapter.$section - $help_info[0]" . + html_tag( 'ul', $help_info[1] ); + $n = $help_info[3]; + } - echo '
    ' . _("Top") . '
    '; + echo '
    ' . _("Top") . '
    '; + } else { + // If the help file went MIA, display an error message. + error_box(sprintf(_("For some reason, chapter %s is not available."), $chapter), $color); + } } do_hook('help_bottom'); -- 2.25.1