Alignment fix
[squirrelmail.git] / plugins / mail_fetch / functions.php
index 6b3d9a2eee894d28040762ade85d42f11fb3e34e..1c4fcd9e75334d2802531621feafec833e770fa4 100644 (file)
@@ -1,29 +1,44 @@
 <?php
+
 /**
  * mail_fetch/functions.php
  *
- * Copyright (c) 1999-2005 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
- *
  * Functions for the mail_fetch plugin.
  *
  * Original code from LexZEUS <lexzeus@mifinca.com>
  * and josh@superfork.com (extracted from php manual)
  * Adapted for MailFetch by Philippe Mingo <mingo@rotedic.com>
  *
+ * @copyright 1999-2012 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package plugins
  * @subpackage mail_fetch
  */
 
-/** @ignore */
-if (! defined('SM_PATH')) define('SM_PATH','../../');
 
 /** pop3 class */
-include_once (SM_PATH . 'plugins/mail_fetch/class.POP3.php');
+include_once (SM_PATH . 'plugins/mail_fetch/constants.php');
+include_once (SM_PATH . 'plugins/mail_fetch/class.mail_fetch.php');
 
 /** declare plugin globals */
-global $mail_fetch_allow_unsubscribed;
+global $mail_fetch_allow_unsubscribed, $mail_fetch_allowable_ports,
+       $mail_fetch_block_server_pattern;
+
+/**
+  * Add link to menu at top of content pane
+  *
+  * @return void
+  *
+  */
+function mail_fetch_link_do() {
+
+    global $oTemplate, $nbsp;
+    $output = makeInternalLink('plugins/mail_fetch/fetch.php', _("Fetch"), '')
+            . $nbsp . $nbsp;
+    return array('menuline' => $output);
+
+}
 
 /**
  * Controls use of unsubscribed folders in plugin
@@ -41,53 +56,15 @@ if (file_exists(SM_PATH . 'config/mail_fetch_config.php')) {
 
 // hooked functions
 
-/**
- * internal function used to load user's preferences
- * @since 1.5.1
- * @private
- */
-function  mail_fetch_load_pref_function() {
-    global $data_dir;
-    global $mailfetch_server_number;
-    global $mailfetch_cypher, $mailfetch_port_;
-    global $mailfetch_server_,$mailfetch_alias_,$mailfetch_user_,$mailfetch_pass_;
-    global $mailfetch_lmos_, $mailfetch_uidl_, $mailfetch_login_, $mailfetch_fref_;
-    global $PHP_SELF;
-
-    sqgetGlobalVar('username', $username, SQ_SESSION);
-
-    if( stristr( $PHP_SELF, 'mail_fetch' ) ) {
-        $mailfetch_server_number = getPref($data_dir, $username, 'mailfetch_server_number', 0);
-        $mailfetch_cypher = getPref($data_dir, $username, 'mailfetch_cypher', 'on' );
-        if ($mailfetch_server_number<1) $mailfetch_server_number=0;
-        for ($i=0;$i<$mailfetch_server_number;$i++) {
-            $mailfetch_server_[$i] = getPref($data_dir, $username, "mailfetch_server_$i");
-            $mailfetch_port_[$i] = getPref($data_dir, $username, "mailfetch_port_$i");
-            $mailfetch_alias_[$i]  = getPref($data_dir, $username, "mailfetch_alias_$i");
-            $mailfetch_user_[$i]   = getPref($data_dir, $username, "mailfetch_user_$i");
-            $mailfetch_pass_[$i]   = getPref($data_dir, $username, "mailfetch_pass_$i");
-            $mailfetch_lmos_[$i]   = getPref($data_dir, $username, "mailfetch_lmos_$i");
-            $mailfetch_login_[$i]  = getPref($data_dir, $username, "mailfetch_login_$i");
-            $mailfetch_fref_[$i]   = getPref($data_dir, $username, "mailfetch_fref_$i");
-            $mailfetch_uidl_[$i]   = getPref($data_dir, $username, "mailfetch_uidl_$i");
-            if( $mailfetch_cypher   == 'on' ) $mailfetch_pass_[$i] =    decrypt( $mailfetch_pass_[$i] );
-        }
-    }
-}
-
 /**
  * Internal function used to fetch pop3 mails on login
  * @since 1.5.1
  * @private
  */
 function mail_fetch_login_function() {
-    include_once (SM_PATH . 'include/validate.php');
-    include_once (SM_PATH . 'functions/imap.php');
-    
-    global $data_dir, $imapServerAddress, $imapPort;
+    include_once (SM_PATH . 'functions/imap_general.php');
 
-    sqgetGlobalVar('username', $username, SQ_SESSION);
-    sqgetGlobalVar('key',      $key,      SQ_COOKIE);
+    global $username, $data_dir, $imapServerAddress, $imapPort;
 
     $mailfetch_newlog = getPref($data_dir, $username, 'mailfetch_newlog');
 
@@ -103,12 +80,14 @@ function mail_fetch_login_function() {
         $mailfetch_login_[$i_loop] = getPref($data_dir, $username, "mailfetch_login_$i_loop");
         $mailfetch_fref_[$i_loop] = getPref($data_dir, $username, "mailfetch_fref_$i_loop");
         $mailfetch_pass_[$i_loop] = getPref($data_dir, $username, "mailfetch_pass_$i_loop");
-        if( $mailfetch_cypher == 'on' )
+        if( $mailfetch_cypher == 'on' ) {
             $mailfetch_pass_[$i_loop] = decrypt( $mailfetch_pass_[$i_loop] );
+        }
 
         if( $mailfetch_pass_[$i_loop] <> '' &&          // Empty passwords no allowed
                 ( ( $mailfetch_login_[$i_loop] == 'on' &&  $mailfetch_newlog == 'on' ) || $mailfetch_fref_[$i_loop] == 'on' ) ) {
 
+            // What the heck
             $mailfetch_server_[$i_loop] = getPref($data_dir, $username, "mailfetch_server_$i_loop");
             $mailfetch_port_[$i_loop] = getPref($data_dir, $username , "mailfetch_port_$i_loop");
             $mailfetch_alias_[$i_loop] = getPref($data_dir, $username, "mailfetch_alias_$i_loop");
@@ -116,6 +95,8 @@ function mail_fetch_login_function() {
             $mailfetch_lmos_[$i_loop] = getPref($data_dir, $username, "mailfetch_lmos_$i_loop");
             $mailfetch_uidl_[$i_loop] = getPref($data_dir, $username, "mailfetch_uidl_$i_loop");
             $mailfetch_subfolder_[$i_loop] = getPref($data_dir, $username, "mailfetch_subfolder_$i_loop");
+            $mailfetch_auth_[$i_loop] = getPref($data_dir, $username, "mailfetch_auth_$i_loop",MAIL_FETCH_AUTH_USER);
+            $mailfetch_type_[$i_loop] = getPref($data_dir, $username, "mailfetch_type_$i_loop",MAIL_FETCH_USE_PLAIN);
 
             $mailfetch_server=$mailfetch_server_[$i_loop];
             $mailfetch_port=$mailfetch_port_[$i_loop];
@@ -126,66 +107,92 @@ function mail_fetch_login_function() {
             $mailfetch_login=$mailfetch_login_[$i_loop];
             $mailfetch_uidl=$mailfetch_uidl_[$i_loop];
             $mailfetch_subfolder=$mailfetch_subfolder_[$i_loop];
+            $mailfetch_auth=$mailfetch_auth_[$i_loop];
+            $mailfetch_type=$mailfetch_type_[$i_loop];
+            // end of what the heck
+
 
             // $outMsg .= "$mailfetch_alias checked<br />";
 
             // $outMsg .= "$mailfetch_alias_[$i_loop]<br />";
 
-            $pop3 = new POP3($mailfetch_server, 60);
+            // FIXME: duplicate code with different output destination.
 
-            if (!$pop3->connect($mailfetch_server,$mailfetch_port)) {
-                $outMsg .= _("Warning, ") . $pop3->ERROR;
+            $pop3 = new mail_fetch(array('host'    => $mailfetch_server,
+                                         'port'    => $mailfetch_port,
+                                         'auth'    => $mailfetch_auth,
+                                         'tls'     => $mailfetch_type,
+                                         'timeout' => 60));
+
+            if (!empty($pop3->error)) {
+                $outMsg .= _("Warning:") . ' ' . $pop3->error;
                 continue;
             }
 
-            $imap_stream = sqimap_login($username, $key, $imapServerAddress, $imapPort, 10);
+            $imap_stream = sqimap_login($username, false, $imapServerAddress, $imapPort, 10);
 
-            $Count = $pop3->login($mailfetch_user, $mailfetch_pass);
-            if (($Count == false || $Count == -1) && $pop3->ERROR != '') {
-                $outMsg .= _("Login Failed:") . $pop3->ERROR;
+            /* log into pop server*/
+            if (! $pop3->login($mailfetch_user, $mailfetch_pass)) {
+                $outMsg .= _("Login Failed:") . ' ' . $pop3->error;
                 continue;
             }
 
-            //   register_shutdown_function($pop3->quit());
+            $aMsgStat = $pop3->command_stat();
+            if (is_bool($aMsgStat)) {
+                $outMsg .= _("Can't get mailbox status:") . ' ' . htmlspecialchars($pop3->error);
+                continue;
+            }
 
-            $msglist = $pop3->uidl();
+            $Count = $aMsgStat['count'];
 
             $i = 1;
-            for ($j = 1; $j < sizeof($msglist); $j++) {
-                if ($msglist["$j"] == $mailfetch_uidl) {
-                    $i = $j+1;
-                    break;
+
+            if ($Count>0) {
+                // If we leave messages on server, try using UIDL
+                if ($mailfetch_lmos == 'on') {
+                    $msglist = $pop3->command_uidl();
+                    if (is_bool($msglist)) {
+                        $outMsg .= _("Server does not support UIDL.") . ' '.htmlspecialchars($pop3->error);
+                        // User asked to leave messages on server, but we can't do that.
+                        $pop3->command_quit();
+                        continue;
+                        // $mailfetch_lmos = 'off';
+                    } else {
+                        // calculate number of new messages
+                        for ($j = 1; $j <= sizeof($msglist); $j++) {
+                            // do strict comparison ('1111.10' should not be equal to '1111.100')
+                            if ($msglist[$j] === $mailfetch_uidl) {
+                                $i = $j+1;
+                                break;
+                            }
+                        }
+                    }
+                }
+                // fetch list of messages with LIST
+                // we can use else control, but we can also set $mailfetch_lmos 
+                // to off if server does not support UIDL.
+                if ($mailfetch_lmos != 'on') {
+                    $msglist = $pop3->command_list();
                 }
             }
 
             if ($Count < $i) {
-                $pop3->quit();
+                $pop3->command_quit();
                 continue;
             }
             if ($Count == 0) {
-                $pop3->quit();
+                $pop3->command_quit();
                 continue;
             }
 
-            // Faster to get them all at once
-            $mailfetch_uidl = $pop3->uidl();
-
-            if (! is_array($mailfetch_uidl) && $mailfetch_lmos == 'on')
-                $outMsg .= _("Server does not support UIDL.");
-
             for (; $i <= $Count; $i++) {
                 if (!ini_get('safe_mode'))
                     set_time_limit(20); // 20 seconds per message max
-                $Message = "";
-                $MessArray = $pop3->get($i);
-
-                if ( (!$MessArray) or (gettype($MessArray) != "array")) {
-                    $outMsg .= _("Warning, ") . $pop3->ERROR;
-                    continue 2;
-                }
+                $Message = $pop3->command_retr($i);
 
-                while (list($lineNum, $line) = each ($MessArray)) {
-                    $Message .= $line;
+                if (is_bool($Message)) {
+                    $outMsg .= _("Warning:") . ' ' . htmlspecialchars($pop3->error);
+                    continue;
                 }
 
                 // check if mail folder is not null and subscribed (There is possible issue with /noselect mail folders)
@@ -201,8 +208,23 @@ function mail_fetch_login_function() {
                     fputs($imap_stream, "\r\n");
                     sqimap_read_data($imap_stream, "A3$i", false, $response, $message);
 
+                    // Check results of append command
+                    $response=(implode('',$response));
+                    $message=(implode('',$message));
+                    if ($response != 'OK') {
+                        $outMsg .= _("Error Appending Message!")." ".htmlspecialchars($message);
+
+                        if ($mailfetch_lmos == 'on') {
+                            setPref($data_dir,$username,"mailfetch_uidl_$i_loop", $msglist[$i-1]);
+                        }
+                        // Destroy msg list in order to prevent UIDL update
+                        $msglist = false;
+                        // if append fails, don't download other messages
+                        break;
+                    }
+
                     if ($mailfetch_lmos != 'on') {
-                        $pop3->delete($i);
+                        $pop3->command_dele($i);
                     }
                 } else {
                     echo "$Line";
@@ -210,10 +232,10 @@ function mail_fetch_login_function() {
                 }
             }
 
-            $pop3->quit();
+            $pop3->command_quit();
             sqimap_logout($imap_stream);
-            if (is_array($mailfetch_uidl)) {
-                setPref($data_dir,$username,"mailfetch_uidl_$i_loop", array_pop($mailfetch_uidl));
+            if ($mailfetch_lmos == 'on' && is_array($msglist)) {
+                setPref($data_dir,$username,"mailfetch_uidl_$i_loop", array_pop($msglist));
             }
         }
     }
@@ -230,12 +252,8 @@ function mail_fetch_login_function() {
  * Internal function used to detect new logins
  */
 function mail_fetch_setnew_function() {
-    global $data_dir;
-
-    // FIXME: check if function is already loaded in login_verified hook
-    include_once(SM_PATH . 'functions/prefs.php');
+    global $data_dir, $username;
 
-    sqgetGlobalVar('username', $username, SQ_SESSION);
     setPref( $data_dir, $username, 'mailfetch_newlog', 'on' );
 }
 
@@ -256,7 +274,7 @@ function mailfetch_optpage_register_block_function() {
 }
 
 /**
- * Internal function used to update mail_fetch settings 
+ * Internal function used to update mail_fetch settings
  * when folders are renamed or deleted.
  * @since 1.5.1
  * @private
@@ -294,18 +312,21 @@ function mail_fetch_folderact_function($args) {
 // end of hooked functions
 
 /**
- * hex2bin - document me
+ * hex2bin - convert a hexadecimal string into binary
+ * Exists since PHP 5.4.
  */
-function hex2bin( $data ) {
+if ( ! function_exists('hex2bin') ) {
+    function hex2bin( $data ) {
 
-    /* Original code by josh@superfork.com */
+        /* Original code by josh@superfork.com */
 
-    $len = strlen($data);
-    $newdata = '';
-    for( $i=0; $i < $len; $i += 2 ) {
-        $newdata .= pack( "C", hexdec( substr( $data, $i, 2) ) );
+        $len = strlen($data);
+        $newdata = '';
+        for( $i=0; $i < $len; $i += 2 ) {
+            $newdata .= pack( "C", hexdec( substr( $data, $i, 2) ) );
+        }
+        return $newdata;
     }
-    return $newdata;
 }
 
 function mf_keyED( $txt ) {
@@ -400,4 +421,68 @@ function mail_fetch_check_noselect($imap_stream,$imap_folder) {
     }
     return false;
 }
-?>
\ No newline at end of file
+
+/**
+  * Validate a requested POP3 port number
+  *
+  * Allowable port numbers are configured in config.php
+  * (see config_example.php for an example and more
+  * rules about how the list of allowable port numbers
+  * can be specified)
+  *
+  * @param int $requested_port The port number given by the user
+  *
+  * @return string An error string is returned if the port
+  *                number is not allowable, otherwise an
+  *                empty string is returned.
+  *
+  */
+function validate_mail_fetch_port_number($requested_port) {
+    global $mail_fetch_allowable_ports;
+    if (empty($mail_fetch_allowable_ports))
+        $mail_fetch_allowable_ports = array(110, 995);
+
+    if (in_array('ALL', $mail_fetch_allowable_ports))
+        return '';
+
+    if (!in_array($requested_port, $mail_fetch_allowable_ports)) {
+        sq_change_text_domain('mail_fetch');
+        $error = _("Sorry, that port number is not allowed");
+        sq_change_text_domain('squirrelmail');
+        return $error;
+    }
+
+    return '';
+}
+
+/**
+  * Validate a requested POP3 server address
+  *
+  * Blocked server addresses are configured in config.php
+  * (see config_example.php for more details)
+  *
+  * @param int $requested_address The server address given by the user
+  *
+  * @return string An error string is returned if the server
+  *                address is not allowable, otherwise an
+  *                empty string is returned.
+  *
+  */
+function validate_mail_fetch_server_address($requested_address) {
+    global $mail_fetch_block_server_pattern;
+    if (empty($mail_fetch_block_server_pattern))
+        $mail_fetch_block_server_pattern = '/(^10\.)|(^192\.)|(^127\.)|(^localhost)/';
+
+    if ($mail_fetch_block_server_pattern == 'UNRESTRICTED')
+        return '';
+
+    if (preg_match($mail_fetch_block_server_pattern, $requested_address)) {
+        sq_change_text_domain('mail_fetch');
+        $error = _("Sorry, that server address is not allowed");
+        sq_change_text_domain('squirrelmail');
+        return $error;
+    }
+
+    return '';
+}
+