src/help.php

   1 <?php
   2
   3 /**
   4  * help.php
   5  *
   6  * Copyright (c) 1999-2003 The SquirrelMail Project Team
   7  * Licensed under the GNU GPL. For full terms see the file COPYING.
   8  *
   9  * Displays help for the user
  10  *
  11  * $Id$
  12  */
  13
  14 /* Path for SquirrelMail required files. */
  15 define('SM_PATH','../');
  16
  17 /* SquirrelMail required files. */
  18 require_once(SM_PATH . 'include/validate.php');
  19 require_once(SM_PATH . 'functions/display_messages.php');
  20
  21 displayPageHeader($color, 'None' );
  22
  23 $helpdir[0] = 'basic.hlp';
  24 $helpdir[1] = 'main_folder.hlp';
  25 $helpdir[2] = 'read_mail.hlp';
  26 $helpdir[3] = 'compose.hlp';
  27 $helpdir[4] = 'addresses.hlp';
  28 $helpdir[5] = 'folders.hlp';
  29 $helpdir[6] = 'options.hlp';
  30 $helpdir[7] = 'search.hlp';
  31 $helpdir[8] = 'FAQ.hlp';
  32
  33 /****************[ HELP FUNCTIONS ]********************/
  34
  35 /**
  36  * parses through and gets the information from the different documents.
  37  * this returns one section at a time.  You must keep track of the position
  38  * so that it knows where to start to look for the next section.
  39  */
  40
  41 function get_info($doc, $pos) {
  42     $ary = array(0,0,0);
  43
  44     $cntdoc = count($doc);
  45
  46     for ($n=$pos; $n < $cntdoc; $n++) {
  47         if (trim(strtolower($doc[$n])) == '<chapter>'
  48             || trim(strtolower($doc[$n])) == '<section>') {
  49             for ($n++; $n < $cntdoc
  50                  && (trim(strtolower($doc[$n])) != '</section>')
  51                  && (trim(strtolower($doc[$n])) != '</chapter>'); $n++) {
  52                 if (trim(strtolower($doc[$n])) == '<title>') {
  53                     $n++;
  54                     $ary[0] = trim($doc[$n]);
  55                 }
  56                 if (trim(strtolower($doc[$n])) == '<description>') {
  57                     $ary[1] = '';
  58                     for ($n++;$n < $cntdoc
  59                          && (trim(strtolower($doc[$n])) != '</description>');
  60                          $n++) {
  61                         $ary[1] .= $doc[$n];
  62                     }
  63                 }
  64                 if (trim(strtolower($doc[$n])) == '<summary>') {
  65                     $ary[2] = '';
  66                     for ($n++; $n < $cntdoc
  67                          && (trim(strtolower($doc[$n])) != '</summary>');
  68                          $n++) {
  69                         $ary[2] .= $doc[$n];
  70                     }
  71                 }
  72             }
  73             if (isset($ary)) {
  74                 $ary[3] = $n;
  75             } else {
  76                 $ary[0] = _("ERROR: Help files are not in the right format!");
  77                 $ary[1] = $ary[0];
  78                 $ary[2] = $ary[0];
  79             }
  80             return( $ary );
  81         } else if (!trim(strtolower($doc[$n]))) {
  82              $ary[0] = '';
  83              $ary[1] = '';
  84              $ary[2] = '';
  85              $ary[3] = $n;
  86         }
  87     }
  88     $ary[0] = _("ERROR: Help files are not in the right format!");
  89     $ary[1] = $ary[0];
  90     $ary[2] = $ary[0];
  91     $ary[3] = $n;
  92     return( $ary );
  93 }
  94
  95 /**************[ END HELP FUNCTIONS ]******************/
  96
  97
  98 echo html_tag( 'table',
  99         html_tag( 'tr',
 100             html_tag( 'td','<center><b>' . _("Help") .'</b></center>', 'center', $color[0] )
 101         ) ,
 102     'center', '', 'width="95%" cellpadding="1" cellspacing="2" border="0"' );
 103
 104 do_hook('help_top');
 105
 106 echo html_tag( 'table', '', 'center', '', 'width="90%" cellpadding="0" cellspacing="10" border="0"' ) .
 107         html_tag( 'tr' ) .
 108             html_tag( 'td' );
 109
 110 if (!isset($squirrelmail_language)) {
 111     $squirrelmail_language = 'en_US';
 112 }
 113
 114 if (file_exists("../help/$squirrelmail_language")) {
 115     $user_language = $squirrelmail_language;
 116 } else if (file_exists('../help/en_US')) {
 117     echo "<center><font color=\"$color[2]\">";
 118     printf (_("The help has not been translated to %s.  It will be displayed in English instead."), $languages[$squirrelmail_language]['NAME']);
 119     echo '</font></center><br>';
 120     $user_language = 'en_US';
 121 } else {
 122     error_box( _("Some or all of the help documents are not present!"), $color );
 123     exit;
 124 }
 125
 126
 127 /* take the chapternumber from the GET-vars,
 128  * else see if we can get a relevant chapter from the referer */
 129 $chapter = 0;
 130
 131 if ( sqgetGlobalVar('chapter', $temp, SQ_GET) ) {
 132     $chapter = (int) $temp;
 133 } elseif ( sqgetGlobalVar('HTTP_REFERER', $temp, SQ_SERVER) ) {
 134     $ref = strtolower($temp);
 135
 136     $contexts = array ( 'src/compose' => 4, 'src/addr' => 5,
 137         'src/folders' => 6, 'src/options' => 7, 'src/right_main' => 2,
 138         'src/read_body' => 3, 'src/search' => 8 );
 139
 140     foreach($contexts as $path => $chap) {
 141         if(strpos($ref, $path)) {
 142             $chapter = $chap;
 143             break;
 144         }
 145     }
 146 }
 147
 148 if ( $chapter == 0 || !isset( $helpdir[$chapter-1] ) ) {
 149     echo html_tag( 'table', '', 'center', '', 'cellpadding="0" cellspacing="0" border="0"' );
 150                 html_tag( 'tr' ) .
 151                     html_tag( 'td' ) .
 152                          '<b><center>' . _("Table of Contents") . '</center></b><br>';
 153     do_hook('help_chapter');
 154     echo html_tag( 'ol' );
 155     for ($i=0, $cnt = count($helpdir); $i < $cnt; $i++) {
 156         $doc = file("../help/$user_language/$helpdir[$i]");
 157         $help_info = get_info($doc, 0);
 158         echo '<li><a href="../src/help.php?chapter=' . ($i+1)
 159              . '">' . $help_info[0] . '</a>' .
 160              html_tag( 'ul', $help_info[2] );
 161     }
 162     echo '</ol></td></tr></table>';
 163 } else {
 164     $doc = file("../help/$user_language/" . $helpdir[$chapter-1]);
 165     $help_info = get_info($doc, 0);
 166     echo '<small><center>';
 167     if ($chapter <= 1){
 168         echo '<font color="' . $color[9] . '">' . _("Previous")
 169              . '</font> | ';
 170     } else {
 171         echo '<a href="../src/help.php?chapter=' . ($chapter-1)
 172              . '">' . _("Previous") . '</a> | ';
 173     }
 174     echo '<a href="../src/help.php">' . _("Table of Contents") . '</a>';
 175     if ($chapter >= count($helpdir)){
 176         echo ' | <font color="' . $color[9] . '">' . _("Next") . '</font>';
 177     } else {
 178         echo ' | <a href="../src/help.php?chapter=' . ($chapter+1)
 179              . '">' . _("Next") . '</a>';
 180     }
 181     echo '</center></small><br>';
 182
 183     echo '<font size="5"><b>' . $chapter . ' - ' . $help_info[0]
 184          . '</b></font><br><br>';
 185
 186     if (isset($help_info[1]) && $help_info[1]) {
 187         echo $help_info[1];
 188     } else {
 189         echo html_tag( 'p', $help_info[2], 'left' );
 190     }
 191
 192     $section = 0;
 193     for ($n = $help_info[3], $cnt = count($doc); $n < $cnt; $n++) {
 194         $section++;
 195         $help_info = get_info($doc, $n);
 196         echo "<b>$chapter.$section - $help_info[0]</b>" .
 197             html_tag( 'ul', $help_info[1] );
 198         $n = $help_info[3];
 199     }
 200
 201     echo '<br><center><a href="#pagetop">' . _("Top") . '</a></center>';
 202 }
 203
 204 do_hook('help_bottom');
 205
 206 echo html_tag( 'tr',
 207             html_tag( 'td', '&nbsp;', 'left', $color[0] )
 208         ).
 209        '</table></body></html>';
 210 ?>