code reuse. moving generic function from plugin to function/plugins.php

[squirrelmail.git] / plugins / info / functions.php

diff --git a/plugins/info/functions.php b/plugins/info/functions.php
index 415123958b71930b2d8e64a8894af672290b0dd9..5357bf6ca882e0f17f0b7338aa48373d991cc06e 100644 (file)
--- a/plugins/info/functions.php
+++ b/plugins/info/functions.php
@@ -1,43 +1,62 @@
-<?PHP
-
-/* functions for info plugin
- * Copyright (c) 1999-2003 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
+<?php
+/**
+ * functions for info plugin
  *
  * Here are two functions for the info plugin
  * The first gets the CAPABILITY response from your IMAP server.
- * The second runs the passed IMAP test and returns the results 
+ * The second runs the passed IMAP test and returns the results
  * The third prints the results of the IMAP command
  * to options.php.
- * by: Jason Munro jason@stdbev.com
- *
- * $Id$ 
  *
+ * @copyright (c) 1999-2005 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @author Jason Munro jason@stdbev.com
+ * @version $Id$
+ * @package plugins
+ * @subpackage info
  */
 
+/**
+ * Get the IMAP capabilities
+ *
+ * @param mixed $imap_stream
+ * @return array
+ * @access private
+ */
 function get_caps($imap_stream) {
     return sqimap_run_command_list($imap_stream, 'CAPABILITY',false, $responses, $message,false);
 }
 
+/**
+ * Run an IMAP test and return the results
+ *
+ * @param mixed $imap_stream
+ * @param string $string imap command
+ * @return array Response from the IMAP server
+ * @access private
+ */
 function imap_test($imap_stream, $string) {
-    global $default_charset;
-    print "<TR><TD>".$string."</TD></TR>";
+    print "<tr><td>".htmlspecialchars($string)."</td></tr>";
     $response = sqimap_run_command_list($imap_stream, trim($string),false, $responses, $message,false);
     array_push($response, $responses . ' ' .$message);
     return $response;
 }
 
+/**
+ * Print the IMAP response to options.php
+ *
+ * @param array $response results of imap command
+ * @access private
+ */
 function print_response($response) {
     foreach($response as $index=>$value) {
         if (is_array($value)) {
             print_response($value);
         }
         else {
-            $value = preg_replace("/</", "&lt;", $value);
-            $value = preg_replace("/>/", "&gt;", $value);
-            print $value."<BR>\n";
+            print htmlspecialchars($value)."<br />\n";
         }
     }
 }
-                                                                                        
-?>
+
+?>
\ No newline at end of file