X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=src%2Fhelp.php;h=ca7987eb53a2a7fcbaffaa4b1c227663e00ad9de;hb=d04cab4213efb37756cced1d8dcbb8bd22280ac2;hp=e9b3c3167ba6cf5034eb859f8e479c12f5b2be59;hpb=08185f2a7631c3a12cb1ac085fec3be471b56b00;p=squirrelmail.git
diff --git a/src/help.php b/src/help.php
index e9b3c316..ca7987eb 100644
--- a/src/help.php
+++ b/src/help.php
@@ -3,22 +3,25 @@
/**
* help.php
*
- * Copyright (c) 1999-2002 The SquirrelMail Project Team
+ * Copyright (c) 1999-2005 The SquirrelMail Project Team
* Licensed under the GNU GPL. For full terms see the file COPYING.
*
* Displays help for the user
*
- * $Id$
+ * @version $Id$
+ * @package squirrelmail
*/
-/* Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
define('SM_PATH','../');
/* SquirrelMail required files. */
require_once(SM_PATH . 'include/validate.php');
+require_once(SM_PATH . 'functions/global.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' );
@@ -41,11 +44,15 @@ $helpdir[8] = 'FAQ.hlp';
*/
function get_info($doc, $pos) {
- for ($n=$pos; $n < count($doc); $n++) {
+ $ary = array(0,0,0);
+
+ $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++;
@@ -53,7 +60,7 @@ function get_info($doc, $pos) {
}
if (trim(strtolower($doc[$n])) == '') {
$ary[1] = '';
- for ($n++;$n < count($doc)
+ for ($n++;$n < $cntdoc
&& (trim(strtolower($doc[$n])) != '');
$n++) {
$ary[1] .= $doc[$n];
@@ -61,8 +68,8 @@ function get_info($doc, $pos) {
}
if (trim(strtolower($doc[$n])) == '') {
$ary[2] = '';
- for ($n++; $n < count($doc)
- && (trim(strtolower($doc[$n])) != '');
+ for ($n++; $n < $cntdoc
+ && (trim(strtolower($doc[$n])) != '');
$n++) {
$ary[2] .= $doc[$n];
}
@@ -70,160 +77,139 @@ function get_info($doc, $pos) {
}
if (isset($ary)) {
$ary[3] = $n;
- return $ary;
} else {
- $ary[0] = 'ERROR: Help files are not in the right format!';
- $ary[1] = 'ERROR: Help files are not in the right format!';
- $ary[2] = 'ERROR: Help files are not in the right format!';
- return $ary;
+ $ary[0] = _("ERROR: Help files are not in the right format!");
+ $ary[1] = $ary[0];
+ $ary[2] = $ary[0];
}
+ return( $ary );
+ } else if (!trim(strtolower($doc[$n]))) {
+ $ary[0] = '';
+ $ary[1] = '';
+ $ary[2] = '';
+ $ary[3] = $n;
}
}
- $ary[0] = 'ERROR: Help files are not in the right format!';
- $ary[1] = 'ERROR: Help files are not in the right format!';
- return $ary;
+ $ary[0] = _("ERROR: Help files are not in the right format!");
+ $ary[1] = $ary[0];
+ $ary[2] = $ary[0];
+ $ary[3] = $n;
+ return( $ary );
}
/**************[ END HELP FUNCTIONS ]******************/
-
echo html_tag( 'table',
html_tag( 'tr',
html_tag( 'td','' . _("Help") .'', '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($HTTP_REFERER)) {
- $ref = strtolower($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 "";
- printf (_("The help has not been translated to %s. It will be displayed in English instead."), $languages[$squirrelmail_language]['NAME']);
- echo '
';
+ printf (_("The help has not been translated to %s. It will be displayed in English instead."), $languages[$squirrelmail_language]['NAME']);
+ echo '
';
$user_language = 'en_US';
} else {
- $help_exists = false;
- echo "
" .
- _("Some or all of the help documents are not present!").
- ''.
- '';
- /* 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 ( 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] ) ) {
+ 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] );
+ }
+ do_hook('help_chapter');
+ echo '';
+} else {
+ $doc = file("../help/$user_language/" . $helpdir[$chapter-1]);
+ $help_info = get_info($doc, 0);
+ echo '';
+ if ($chapter <= 1){
+ echo '' . _("Previous")
+ . ' | ';
+ } else {
+ echo '' . _("Previous") . ' | ';
}
- 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;
+ echo '' . _("Table of Contents") . '';
+ if ($chapter >= count($helpdir)){
+ echo ' | ' . _("Next") . '';
+ } else {
+ echo ' | ' . _("Next") . '';
}
+ echo '
';
- if (!isset($chapter)) {
- echo html_tag( 'table', '', 'center', '', 'cellpadding="0" cellspacing="0" border="0"' );
- html_tag( 'tr' ) .
- html_tag( 'td' ) .
- '' . _("Table of Contents") . '
';
- 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 '' . $help_info[0] . '' .
- html_tag( 'ul', $help_info[2] );
- }
- echo '';
+ echo '' . $chapter . ' - ' . $help_info[0]
+ . '
';
+
+ 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 '';
- if ($chapter <= 1){
- echo '' . _("Previous")
- . ' | ';
- } else {
- echo '' . _("Previous") . ' | ';
- }
- echo '' . _("Table of Contents") . '';
- if ($chapter >= count($helpdir)){
- echo ' | ' . _("Next") . '';
- } else {
- echo ' | ' . _("Next") . '';
- }
- echo '
';
-
- echo '' . $chapter . ' - ' . $help_info[0]
- . '
';
- if (isset($help_info[1])){
- echo $help_info[1];
- } else {
- 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 "$chapter.$section - $help_info[0]" .
- html_tag( 'ul', $help_info[1] );
- $n = $help_info[3];
- }
+ echo html_tag( 'p', $help_info[2], 'left' );
+ }
- echo '
' . _("Top") . '';
+ $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") . '';
}
+
do_hook('help_bottom');
echo html_tag( 'tr',
html_tag( 'td', ' ', 'left', $color[0] )
- ).
- '