Note a bug
[squirrelmail.git] / plugins / info / options.php
index ff1febf9cf9ce029da310b7dc7a1eb762127a2f1..13328239ebf8e4bf13f5881959a73d9b75d2fdc6 100644 (file)
@@ -1,57 +1,61 @@
-<?PHP
+<?php
 
-/* options page for IMAP info plugin 
- * Copyright (c) 1999-2003 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
- *   
+/**
+ * options page for IMAP info plugin
+ *
  * This is where it all happens :)
  *
- * Written by: Jason Munro 
- * jason@stdbev.com
- * 
- * $Id$
- * 
+ * @author Jason Munro <jason at stdbev.com>
+ * @copyright 1999-2012 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package plugins
+ * @subpackage info
  */
 
-define('SM_PATH','../../');
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
+require('../../include/init.php');
 
 /* SquirrelMail required files. */
-require_once(SM_PATH . 'include/validate.php');
-require_once(SM_PATH . 'functions/page_header.php');
-require_once(SM_PATH . 'functions/imap.php');
+require_once(SM_PATH . 'functions/imap_general.php');
+require_once(SM_PATH . 'functions/forms.php');
 require_once(SM_PATH . 'plugins/info/functions.php');
 
 global $username, $color, $folder_prefix, $default_charset;
 $default_charset = strtoupper($default_charset);
-displayPageHeader($color, 'None');
+displayPageHeader($color);
 $mailbox = 'INBOX';
 
-/* GLOBALS */
-$username = $_SESSION['username'];
-$key  = $_COOKIE['key'];
-$onetimepad = $_SESSION['onetimepad'];
-
-if(isset($_POST['submit'])) {
-    $submit = $_POST['submit'];
+/**
+ * testing installation
+ *
+ * prevent use of plugin if it is not enabled
+ */
+if (! is_plugin_enabled('info')) {
+    error_box(_("Plugin is disabled."));
+    // display footer (closes html) and stop script execution
+    $oTemplate->display('footer.tpl');
+    exit;
 }
 
+/* GLOBALS */
+sqgetGlobalVar('submit', $submit, SQ_POST);
+
 for($i = 0; $i <= 9; $i++){
-    if(isset($_POST["CHECK_TEST_$i"])) {
-        $var = "CHECK_TEST_$i";
-        $$var = $_POST["CHECK_TEST_$i"];
-    }
-    if(isset($_POST["TEST_$i"])) {
-        $var = "TEST_$i";
-        $$var = $_POST["TEST_$i"];
-    }
+    $varc = 'CHECK_TEST_'.$i;
+    sqgetGlobalVar($varc, $$varc, SQ_POST);
+    $vart  = 'TEST_'.$i;
+    sqgetGlobalVar($vart, $$vart, SQ_POST);
 }
 
 /* END GLOBALS */
 
-$imap_stream = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
+$imap_stream = sqimap_login($username, false, $imapServerAddress, $imapPort, 0);
 $caps_array = get_caps($imap_stream);
-$list = array (
-               'TEST_0',
+$list = array ('TEST_0',
                'TEST_1',
                'TEST_2',
                'TEST_3',
@@ -62,29 +66,37 @@ $list = array (
                'TEST_8',
                'TEST_9');
 
-print "<BR><CENTER><B>IMAP server information</B></CENTER><BR>\n";
-print "<CENTER><TABLE BGCOLOR=".$color[3]." WIDTH=\"100%\" BORDER=1 CELLPADDING=2><TR><TD BGCOLOR=".$color[3]."><BR>\n";
-print "<CENTER><TABLE WIDTH=\"95%\" BORDER=1 BGCOLOR=".$color[3].">\n";
-print "<TR><TD BGCOLOR=".$color[4]."><B>Server Capability response:</B><BR>\n";
+echo '<br /><div style="text-align: center;"><b>'._("IMAP server information")."</b></div><br />\n".
+     '<table bgcolor="'.$color[3].'" width="100%" align="center" border="1" cellpadding="2">'.
+     '<tr><td bgcolor="'.$color[3]."\"><br />\n".
+     '<table width="95%" align="center" border="1" bgcolor="'.$color[3]."\">\n".
+     '<tr><td bgcolor="'.$color[4].'"><b>'.
+     _("Server Capability response:").
+     "</b><br />\n";
 
 foreach($caps_array[0] as $value) {
-    print $value;
+    echo sm_encode_html_special_chars($value);
 }
 
-print "</TD></TR><TR><TD>\n";
+echo "</td></tr><tr><td>\n";
 
 if (!isset($submit) || $submit == 'default') {
-    print "<BR><SMALL><FONT COLOR=".$color[6].">Select the IMAP commands you would like to run. Most commands require a selected mailbox so the select command is already setup. You can clear all the commands and test your own IMAP command strings. The commands are executed in order. The default values are simple IMAP commands using your default_charset and folder_prefix from Squirrelmail when needed.<BR><BR><B><CENTER>NOTE: These commands are live, any changes made will effect your current email account.</B></CENTER></FONT></SMALL><BR>\n";
+    echo '<br /><p><small><font color="'.$color[6].'">'.
+         _("Select the IMAP commands you would like to run. Most commands require a selected mailbox so the select command is already setup. You can clear all the commands and test your own IMAP command strings. The commands are executed in order. The default values are simple IMAP commands using your default_charset and folder_prefix from SquirrelMail when needed.").
+         "</font></small></p>\n".
+         '<p align="center"><small><b>'.
+         _("NOTE: These commands are live, any changes made will effect your current email account.").
+         "</b></small></p><br />\n";
     if (!isset($submit)) {
         $submit = '';
     }
 }
 else {
-    print "folder_prefix = $folder_prefix<BR>\n";
-    print "default_charset = $default_charset\n";
+    echo 'folder_prefix = ' . sm_encode_html_special_chars($folder_prefix)."<br />\n" .
+         'default_charset = '.sm_encode_html_special_chars($default_charset)."\n";
 }
 
-print "<BR></TD></TR></TABLE></CENTER><BR>\n";
+echo "<br /></td></tr></table><br />\n";
 
 
 if ($submit == 'submit') {
@@ -110,32 +122,36 @@ elseif (!$submit || $submit == 'default')  {
         'TEST_5' => "SORT (DATE) $default_charset ALL",
         'TEST_6' => "FETCH 1:* (FLAGS BODY[HEADER.FIELDS (FROM DATE TO)])",
         'TEST_7' => "LSUB \"$folder_prefix\" \"*%\"",
-        'TEST_8' => "LIST \"$folder_prefix*\" \"*\"",
+        'TEST_8' => "LIST \"$folder_prefix\" \"*\"",
         'TEST_9' => "");
 }
 
-print "<FORM ACTION=\"options.php\" METHOD=POST>\n";
-print "<CENTER><TABLE BORDER=1>\n";
-print "<TR><TH>Select</TH><TH>Test Name</TH><TH>IMAP command string</TH>\n";
-print "</TR><TR><TD>\n";
+echo "<form action=\"options.php\" method=\"post\">\n".
+     "<table border=\"1\" align=\"center\">\n".
+     '<tr><th>'. _("Select").
+     '</th><th>'._("Test Name").
+     '</th><th>'._("IMAP command string")."</th></tr>\n".
+     '<tr><td>';
 
 foreach($type as $index=>$value) {
-    print "</TD></TR><TR><TD WIDTH=\"10%\"><INPUT TYPE=CHECKBOX VALUE=1 NAME=CHECK_$index";
+    echo "</td></tr>\n<tr><td width=\"10%\">\n<input type=\"checkbox\" value=\"1\" name=\"CHECK_$index\"";
     if ($index == 'TEST_0' && ($submit == 'default' || $submit == '')) {
-        print " CHECKED";
+        echo ' checked="checked"';
     }
     $check = "CHECK_".$index;
     if (isset($$check) && $submit != 'clear' && $submit != 'default') {
-        print " CHECKED";
+        echo ' checked="checked"';
     }
-    print "></TD><TD WIDTH=\"30%\">$index</TD><TD WIDTH=\"60%\">\n";
-    print "<INPUT TYPE=TEXT NAME=$index VALUE='$value' SIZE=60>\n"; 
+    echo " /></td><td width=\"30%\">$index</td><td width=\"60%\">\n".
+         addInput($index, $value, 60);
 }
 
-print "</TD></TR></TABLE></CENTER><BR>\n";
-print "<CENTER><INPUT TYPE=SUBMIT NAME=submit value=submit>\n";
-print "<INPUT TYPE=SUBMIT NAME=submit value=clear>\n";
-print "<INPUT TYPE=SUBMIT NAME=submit value=default></CENTER><BR>\n";
+echo "</td></tr></table><br />\n".
+     '<div style="text-align: center;">'.
+     addSubmit('submit','submit').
+     addSubmit('clear','submit',array('id'=>'clear')).
+     addSubmit('default','submit',array('id'=>'default')).
+     "</div><br /></form>\n";
 
 $tests = array();
 
@@ -144,23 +160,49 @@ if ($submit == 'submit') {
         $check = "CHECK_".$index;
         if (isset($$check)) {
             $type[$index] = $$index;
-            array_push($tests, $index); 
+            array_push($tests, $index);
         }
     }
     for ($i=0;$i<count($tests);$i++) {
-        print "<CENTER><TABLE WIDTH=\"95%\" BORDER=0 BGCOLOR=".$color[4].">\n";
-        print "<TR><TD><B>".$tests[$i]."</B></TD><TR>";
-        print "<TR><TD><SMALL><B><FONT COLOR=".$color[7].
-              ">Request:</FONT></SMALL></B></TD></TR>\n";
+        // make sure that microtime function is available before it is called
+        if (function_exists('microtime')) {
+            list($usec, $sec) = explode(" ", microtime());
+            $starttime = (float)$sec + (float)$usec;
+        }
+
+        echo '<table width="95%" align="center" border="0" bgcolor="'.$color[4]."\">\n".
+             '<tr><td><b>'.$tests[$i]."</b></td></tr>\n".
+             '<tr><td><small><b><font color="'.$color[7].'">'.
+            _("Request:")."</font></b></small></td></tr>\n";
+        // imap_test function outputs imap command
         $response = imap_test($imap_stream, $type[$tests[$i]]);
-        print "<TR><TD><SMALL><B><FONT COLOR=".$color[7].
-              ">Response:</FONT></SMALL></B></TD></TR>\n";
-        print "<TR><TD>";
+        echo '<tr><td><small><b><font color="'.$color[7].'">'.
+             _("Response:")."</font></b></small></td></tr>\n".
+             '<tr><td>';
         print_response($response);
-        print "</TD><TR></TABLE></CENTER><BR>\n";
+        echo "</td></tr>\n";
+
+        if (function_exists('microtime')) {
+            // get script execution time
+            list($usec, $sec) = explode(" ", microtime());
+            $endtime = (float)$sec + (float)$usec;
+            // i18n: ms = short for miliseconds
+            echo '<tr><td><small><b><font color="'.$color[7].'">'.
+                _("Execution time:")."</font></b></small></td></tr>\n".
+                '<tr><td>'.sprintf(_("%s ms"),round((($endtime - $starttime)*1000),3))."</td></tr>\n";
+        }
+
+        echo "</table><br />\n";
     }
 }
-    print "</TD></TR></TABLE></CENTER></BODY></HTML>";
-    sqimap_logout($imap_stream);
-    do_hook('info_bottom');
+echo '</td></tr></table>';
+sqimap_logout($imap_stream);
+
+/**
+ * Optional hook in info plugin
+ *
+ * Hook allows attaching plugin to bottom of info plugin
+ */
+do_hook('info_bottom', $null);
 ?>
+</body></html>