Some reworking of help.php

git-svn-id: https://svn.code.sf.net/p/squirrelmail/code/trunk/squirrelmail@4031 7612ce4b-ef26-0410-bec9-ea0150e637f0

diff --git a/src/help.php b/src/help.php
index 2da48edf7fddf715a05d1a38254791a6bcacecbf..513db530ea0ee9d1b34748ce30895fdf7f62adc3 100644 (file)
--- a/src/help.php
+++ b/src/help.php
@@ -17,8 +17,6 @@ define('SM_PATH','../');
 /* 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');
 
 displayPageHeader($color, 'None' );
 
@@ -42,10 +40,13 @@ $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])) == '<chapter>'
             || trim(strtolower($doc[$n])) == '<section>') {
-            for ($n++;$n < count($doc) 
+            for ($n++; $n < $cntdoc 
                  && (trim(strtolower($doc[$n])) != '</section>') 
                  && (trim(strtolower($doc[$n])) != '</chapter>'); $n++) {
                 if (trim(strtolower($doc[$n])) == '<title>') {
@@ -54,7 +55,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,7 +63,7 @@ function get_info($doc, $pos) {
                 }
                 if (trim(strtolower($doc[$n])) == '<summary>') {
                     $ary[2] = '';
-                    for ($n++; $n < count($doc) 
+                    for ($n++; $n < $cntdoc 
                          && (trim(strtolower($doc[$n])) != '</summary>'); 
                          $n++) {
                         $ary[2] .= $doc[$n];
@@ -94,143 +95,115 @@ function get_info($doc, $pos) {
 /**************[ END HELP FUNCTIONS ]******************/
 
 
-
 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");
+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>';
     $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( _("Some or all of the help documents are not present!"), $color );
     exit;
 }
 
-if ($help_exists == true) {
-    if (!isset($context)){
-        $context = '';
+
+/* take the chapternumber from the GET-vars,
+ * else see if we can get a relevant chapter from the referer */
+$chapter = 0;
+
+if ( isset( $_GET['chapter'] ) )
+{
+    $chapter = intval( $_GET['chapter']);
+}
+elseif (isset($_SERVER['HTTP_REFERER']))
+{
+    $ref = strtolower($_SERVER['HTTP_REFERER']);
+
+    $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 ($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']);
+}
+
+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, $cnt = count($helpdir); $i < $cnt; $i++) {
+        $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>';
     } else {
-       $chapter = 0;
+        echo ' | <a href="../src/help.php?chapter=' . ($chapter+1)
+             . '">' . _("Next") . '</a>';
     }
+    echo '</center></small><br>';
 
-    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++) {
-            $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>';
+    echo '<font size="5"><b>' . $chapter . ' - ' . $help_info[0]
+         . '</b></font><br><br>';
+
+    if (isset($help_info[1]) && $help_info[1]) {
+        echo $help_info[1];
     } 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>';
-        } else {
-            echo ' | <a href="../src/help.php?chapter=' . ($chapter+1)
-                 . '">' . _("Next") . '</a>';
-        }
-        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' );
-        }
+        echo html_tag( 'p', $help_info[2], 'left' );
+    }
              
-        $section = 0;
-        for ($n = $help_info[3]; $n < count($doc); $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];
-        }
-
-        echo '<br><center><a href="#pagetop">' . _("Top") . '</a></center>';
+    $section = 0;
+    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];
     }
+
+    echo '<br><center><a href="#pagetop">' . _("Top") . '</a></center>';
 }
+
 do_hook('help_bottom');
 
 echo html_tag( 'tr',