Changeset 3261 in subversion

Timestamp:

Feb 9, 2010 8:10:12 AM (3 years ago)

Author:

alec

Message:

• Fix attachment excessive memory use, support messages of any size (#1484660)

Location:

trunk/roundcubemail

Files:

• CHANGELOG (modified) (1 diff)
• INSTALL (modified) (1 diff)
• program/include/rcube_imap.php (modified) (1 diff)
• program/include/rcube_mail_mime.php (deleted)
• program/include/rcube_smtp.php (modified) (2 diffs)
• program/lib/imap.inc (modified) (4 diffs)
• program/steps/mail/attachments.inc (modified) (2 diffs)
• program/steps/mail/func.inc (modified) (6 diffs)
• program/steps/mail/sendmail.inc (modified) (11 diffs)

trunk/roundcubemail/CHANGELOG

@@ -2 +2 @@
 ===========================
 
+- Fix attachment excessive memory use, support messages of any size (#1484660)
 - Fix setting task name according to auth state
 - Password: fix vpopmaild driver (#1486478)

trunk/roundcubemail/INSTALL

@@ -16 +16 @@
    - libiconv (recommended)
    - mbstring, fileinfo, mcrypt (optional)
+* PEAR packages distributed with Roundcube or external:
+   - MDB2 2.5.0 or newer
+   - Mail_Mime 1.6.0 or newer
+   - Net_SMTP 1.4.1 or newer
 * php.ini options (see .htaccess file):
    - error_reporting E_ALL & ~E_NOTICE (or lower)

trunk/roundcubemail/program/include/rcube_imap.php

@@ -1700 +1700 @@
    * Append a mail message (source) to a specific mailbox
    *
-   * @param string Target mailbox
-   * @param string Message source
+   * @param string   Target mailbox
+   * @param string   The message source string or filename
+   * @param string   Headers string if $message contains only the body
+   * @param boolean  True if $message is a filename
+   *
    * @return boolean True on success, False on error
    */
-  function save_message($mbox_name, &$message)
+  function save_message($mbox_name, &$message, $headers='', $is_file=false)
     {
     $mailbox = $this->mod_mailbox($mbox_name);
 
     // make sure mailbox exists
-    if (($mailbox == 'INBOX') || in_array($mailbox, $this->_list_mailboxes()))
-      $saved = iil_C_Append($this->conn, $mailbox, $message);
+    if (($mailbox == 'INBOX') || in_array($mailbox, $this->_list_mailboxes())) {
+      if ($is_file) {
+        $separator = rcmail::get_instance()->config->header_delimiter();
+        $saved = iil_C_AppendFromFile($this->conn, $mailbox, $message,
+          $headers, $separator.$separator);
+        }
+      else
+        $saved = iil_C_Append($this->conn, $mailbox, $message);
+      }
 
     if ($saved)

trunk/roundcubemail/program/include/rcube_smtp.php

@@ -142 +142 @@
    *               formatted string
    *
-   * @param string The full text of the message body, including any Mime parts, etc.
+   * @param mixed  The full text of the message body, including any Mime parts
+   *               or file handle
    *
    * @return bool  Returns true on success, or false on error
@@ -207 +208 @@
     }
 
-    // Concatenate headers and body so it can be passed by reference to SMTP_CONN->data
-    // so preg_replace in SMTP_CONN->quotedata will store a reference instead of a copy. 
-    // We are still forced to make another copy here for a couple ticks so we don't really 
-    // get to save a copy in the method call.
-    $data = $text_headers . "\r\n" . $body;
-
-    // unset old vars to save data and so we can pass into SMTP_CONN->data by reference.
-    unset($text_headers, $body);
-   
+    if (is_resource($body))
+    {
+      // file handle
+      $data = $body;
+      $text_headers = preg_replace('/[\r\n]+$/', '', $text_headers);
+    } else {
+      // Concatenate headers and body so it can be passed by reference to SMTP_CONN->data
+      // so preg_replace in SMTP_CONN->quotedata will store a reference instead of a copy. 
+      // We are still forced to make another copy here for a couple ticks so we don't really 
+      // get to save a copy in the method call.
+      $data = $text_headers . "\r\n" . $body;
+
+      // unset old vars to save data and so we can pass into SMTP_CONN->data by reference.
+      unset($text_headers, $body);
+    }
+
     // Send the message's headers and the body as SMTP data.
-    if (PEAR::isError($result = $this->conn->data($data)))
+    if (PEAR::isError($result = $this->conn->data($data, $text_headers)))
     {
       $this->error = array('label' => 'smtperror', 'vars' => array('msg' => $result->getMessage()));

trunk/roundcubemail/program/lib/imap.inc

@@ -2419 +2419 @@
 }
 
-function iil_C_AppendFromFile(&$conn, $folder, $path) {
+function iil_C_AppendFromFile(&$conn, $folder, $path, $headers=null, $separator="\n\n") {
         if (!$folder) {
             return false;
@@ -2439 +2439 @@
                 return false;
         }
-    
+
+        if ($headers) {
+                $headers = preg_replace('/[\r\n]+$/', '', $headers);
+                $len += strlen($headers) + strlen($separator);
+        }
+
         //send APPEND command
         $request    = 'a APPEND "' . iil_Escape($folder) . '" (\\Seen) {' . $len . '}';
@@ -2451 +2456 @@
                 }
 
-                //send file
+                // send headers with body separator
+                if ($headers) {
+                        iil_PutLine($fp, $headers . $separator, false);
+                }
+
+                // send file
                 while (!feof($in_fp)) {
-                        $buffer      = fgets($in_fp, 4096);
+                        $buffer = fgets($in_fp, 4096);
                         iil_PutLine($fp, $buffer, false);
                 }
@@ -2460 +2470 @@
                 iil_PutLine($fp, ''); // \r\n
 
-                //read response
+                // read response
                 do {
                         $line = iil_ReadLine($fp);

trunk/roundcubemail/program/steps/mail/attachments.inc

@@ -54 +54 @@
     
   if ($attachment['status']) {
-    $size = $attachment['data'] ? strlen($attachment['data']) : @filesize($attachment['path']);
+    if (empty($attachment['size']))
+      $attachment['size'] = $attachment['data'] ? strlen($attachment['data']) : @filesize($attachment['path']);
+
     header('Content-Type: ' . $attachment['mimetype']);
-    header('Content-Length: ' . $size);
+    header('Content-Length: ' . $attachment['size']);
     
     if ($attachment['data'])
@@ -81 +83 @@
     $attachment = array(
       'path' => $filepath,
+      'size' => $_FILES['_attachments']['size'][$i],
       'name' => $_FILES['_attachments']['name'][$i],
       'mimetype' => rc_mime_content_type($filepath, $_FILES['_attachments']['name'][$i], $_FILES['_attachments']['type'][$i])

trunk/roundcubemail/program/steps/mail/func.inc

@@ -1333 +1333 @@
 
 /**
- * Send the given message compose object using the configured method
- */
-function rcmail_deliver_message(&$message, $from, $mailto, &$smtp_error)
+ * Send the given message using the configured method
+ *
+ * @param object $message    Reference to Mail_MIME object
+ * @param string $from       Sender address string
+ * @param array  $mailto     Array of recipient address strings
+ * @param array  $smtp_error SMTP error array (reference)
+ * @param string $body_file  Location of file with saved message body (reference)
+ *
+ * @return boolean Send status.
+ */
+function rcmail_deliver_message(&$message, $from, $mailto, &$smtp_error, &$body_file)
 {
   global $CONFIG, $RCMAIL;
 
-  $msg_body = $message->get();
   $headers = $message->headers();
 
@@ -1358 +1365 @@
     unset($message->_headers['Bcc']);
 
+    $smtp_headers = $message->txtHeaders($send_headers, true);
+
+    if ($message->getParam('delay_file_io')) {
+      // use common temp dir
+      $temp_dir = $RCMAIL->config->get('temp_dir');
+      $body_file = tempnam($temp_dir, 'rcmMsg');
+      if (PEAR::isError($mime_result = $message->saveMessageBody($body_file))) {
+        raise_error(array('code' => 600, 'type' => 'php',
+            'file' => __FILE__, 'line' => __LINE__,
+            'message' => "Could not create message: ".$mime_result->getMessage()),
+            TRUE, FALSE);
+        return false;
+      }
+      $msg_body = fopen($body_file, 'r');
+    } else {
+      $msg_body = $message->get();
+    }
+
     // send message
     if (!is_object($RCMAIL->smtp))
       $RCMAIL->smtp_init(true);
      
-    $sent = $RCMAIL->smtp->send_mail($from, $a_recipients, ($foo = $message->txtHeaders($send_headers, true)), $msg_body);
+    $sent = $RCMAIL->smtp->send_mail($from, $a_recipients, $smtp_headers, $msg_body);
     $smtp_response = $RCMAIL->smtp->get_response();
     $smtp_error = $RCMAIL->smtp->get_error();
+
+    if (is_resource($msg_body)) {
+      fclose($msg_body);
+    }
 
     // log error
@@ -1388 +1417 @@
         }
       }
-       
-    if (ini_get('safe_mode'))
+    
+    $msg_body = $message->get();
+
+    if (PEAR::isError($msg_body))
+      raise_error(array('code' => 600, 'type' => 'php',
+            'file' => __FILE__, 'line' => __LINE__,
+            'message' => "Could not create message: ".$msg_body->getMessage()),
+            TRUE, FALSE);
+    else if (ini_get('safe_mode'))
       $sent = mail($headers_enc['To'], $headers_enc['Subject'], $msg_body, $header_str);
     else
@@ -1409 +1445 @@
     }
   }
-  
+
   $message->_headers = array();
   $message->headers($headers);
@@ -1431 +1467 @@
     $mailto = $recipient['mailto'];
 
-    $compose = new rcube_mail_mime($RCMAIL->config->header_delimiter());
-    $compose->setParam(array(
-      'text_encoding' => 'quoted-printable',
-      'html_encoding' => 'quoted-printable',
-      'head_encoding' => 'quoted-printable',
-      'head_charset'  => RCMAIL_CHARSET,
-      'html_charset'  => RCMAIL_CHARSET,
-      'text_charset'  => RCMAIL_CHARSET,
-    ));
+    $compose = new Mail_mime($RCMAIL->config->header_delimiter());
+
+    $compose->setParam('text_encoding', 'quoted-printable');
+    $compose->setParam('html_encoding', 'quoted-printable');
+    $compose->setParam('head_encoding', 'quoted-printable');
+    $compose->setParam('head_charset', RCMAIL_CHARSET);
+    $compose->setParam('html_charset', RCMAIL_CHARSET);
+    $compose->setParam('text_charset', RCMAIL_CHARSET);
     
     // compose headers array
@@ -1475 +1510 @@
     $compose->addAttachment($report, 'message/disposition-notification', 'MDNPart2.txt', false, '7bit', 'inline');
 
-    $sent = rcmail_deliver_message($compose, $identity['email'], $mailto, $smtp_error);
+    $sent = rcmail_deliver_message($compose, $identity['email'], $mailto, $smtp_error, $body_file);
 
     if ($sent)

trunk/roundcubemail/program/steps/mail/sendmail.inc

@@ -21 +21 @@
 */
 
-
 // remove all scripts and act as called in frame
 $OUTPUT->reset();
@@ -112 +111 @@
   global $CONFIG;
 
-  $body = $mime_message->getHtmlBody();
+  $body = $mime_message->getHTMLBody();
 
   // remove any null-byte characters before parsing
@@ -135 +134 @@
         if (! in_array($image_name, $included_images)) {
           // add the image to the MIME message
-          if(! $mime_message->addHTMLImage($img_file, 'image/gif', '', true, $image_name))
+          if (! $mime_message->addHTMLImage($img_file, 'image/gif', '', true, $image_name))
             $OUTPUT->show_message("emoticonerror", 'error');
           array_push($included_images, $image_name);
@@ -361 +360 @@
 $LINE_LENGTH = $RCMAIL->config->get('line_length', 75);
 
-// create extended PEAR::Mail_mime instance
-$MAIL_MIME = new rcube_mail_mime($RCMAIL->config->header_delimiter());
+// Since we can handle big messages with disk usage, we need more time to work
+@set_time_limit(0);
+
+// create PEAR::Mail_mime instance
+$MAIL_MIME = new Mail_mime($RCMAIL->config->header_delimiter());
+
+// Check if we have enough memory to handle the message in it
+// It's faster than using files, so we'll do this if we only can
+if (is_array($_SESSION['compose']['attachments']) && $CONFIG['smtp_server']
+  && ($mem_limit = parse_bytes(ini_get('memory_limit'))))
+{
+  $memory = function_exists('memory_get_usage') ? memory_get_usage() : 16*1024*1024; // safe value: 16MB
+
+  foreach ($_SESSION['compose']['attachments'] as $id => $attachment)
+    $memory += $attachment['size'];
+
+  // Yeah, Net_SMTP needs up to 12x more memory, 1.33 is for base64
+  if ($memory * 1.33 * 12 > $mem_limit)
+    $MAIL_MIME->setParam('delay_file_io', true);
+}
 
 // For HTML-formatted messages, construct the MIME message with both
@@ -404 +421 @@
 
 // add stored attachments, if any
-if (is_array($_SESSION['compose']['attachments'])) {
+if (is_array($_SESSION['compose']['attachments']))
+{
   foreach ($_SESSION['compose']['attachments'] as $id => $attachment) {
     // This hook retrieves the attachment contents from the file storage backend
@@ -439 +457 @@
 }
 
-// add submitted attachments
-if (is_array($_FILES['_attachments']['tmp_name'])) {
-  foreach ($_FILES['_attachments']['tmp_name'] as $i => $filepath) {
-    $ctype = $files['type'][$i];
-    $ctype = str_replace('image/pjpeg', 'image/jpeg', $ctype); // #1484914
-    
-    $MAIL_MIME->addAttachment($filepath, $ctype, $files['name'][$i], true,
-      $ctype == 'message/rfc822' ? $transfer_encoding : 'base64',
-      'attachment', $message_charset, '', '', 
-      $CONFIG['mime_param_folding'] ? 'quoted-printable' : NULL,
-      $CONFIG['mime_param_folding'] == 2 ? 'quoted-printable' : NULL
-    );
-  }
-}
-
 // encoding settings for mail composing
-$MAIL_MIME->setParam(array(
-  'text_encoding' => $transfer_encoding,
-  'html_encoding' => 'quoted-printable',
-  'head_encoding' => 'quoted-printable',
-  'head_charset'  => $message_charset,
-  'html_charset'  => $message_charset,
-  'text_charset'  => $message_charset,
-));
+$MAIL_MIME->setParam('text_encoding', $transfer_encoding);
+$MAIL_MIME->setParam('html_encoding', 'quoted-printable');
+$MAIL_MIME->setParam('head_encoding', 'quoted-printable');
+$MAIL_MIME->setParam('head_charset', $message_charset);
+$MAIL_MIME->setParam('html_charset', $message_charset);
+$MAIL_MIME->setParam('text_charset', $message_charset);
 
 $data = $RCMAIL->plugins->exec_hook('outgoing_message_headers', array('headers' => $headers));
@@ -488 +489 @@
   }
 
-  $sent = rcmail_deliver_message($MAIL_MIME, $from, $mailto, $smtp_error);
-  
+  $sent = rcmail_deliver_message($MAIL_MIME, $from, $mailto, $smtp_error, $mailbody_file);
+
   // return to compose page if sending failed
   if (!$sent)
     {
+    // remove temp file
+    if ($mailbody_file) {
+      unlink($mailbody_file);
+      }
+
     if ($smtp_error)
       $OUTPUT->show_message($smtp_error['label'], 'error', $smtp_error['vars']); 
@@ -513 +519 @@
 
 
-
 // Determine which folder to save message
 if ($savedraft)
@@ -523 +528 @@
   {
   // check if mailbox exists
-  if (!in_array_nocase($store_target, $IMAP->list_mailboxes()))
+  if (!in_array($store_target, $IMAP->list_mailboxes()))
     {
       // folder may be existing but not subscribed (#1485241)
-      if (!in_array_nocase($store_target, $IMAP->list_unsubscribed()))
+      if (!in_array($store_target, $IMAP->list_unsubscribed()))
         $store_folder = $IMAP->create_mailbox($store_target, TRUE);
       else if ($IMAP->subscribe($store_target))
@@ -533 +538 @@
   else
     $store_folder = TRUE;
-  
+
   // append message to sent box
-  if ($store_folder)
-    $saved = $IMAP->save_message($store_target, $MAIL_MIME->getMessage());
-
-  // raise error if saving failed
-  if (!$saved)
-    {
-    raise_error(array('code' => 800, 'type' => 'imap',
+  if ($store_folder) {
+
+    // message body in file
+    if ($mailbody_file || $MAIL_MIME->getParam('delay_file_io')) {
+      $headers = $MAIL_MIME->txtHeaders();
+      
+      // file already created
+      if ($mailbody_file)
+        $msg = $mailbody_file;
+      else {
+        $temp_dir = $RCMAIL->config->get('temp_dir');
+        $mailbody_file = tempnam($temp_dir, 'rcmMsg');
+        if (!PEAR::isError($msg = $MAIL_MIME->saveMessageBody($mailbody_file)))
+          $msg = $mailbody_file;
+        }
+      }
+    else {
+      $msg = $MAIL_MIME->getMessage();
+      $headers = '';
+      }
+
+    if (PEAR::isError($msg))
+      raise_error(array('code' => 600, 'type' => 'php',
+            'file' => __FILE__, 'line' => __LINE__,
+            'message' => "Could not create message: ".$msg->getMessage()),
+            TRUE, FALSE);
+    else {
+      $saved = $IMAP->save_message($store_target, $msg, $headers, $mailbody_file ? true : false);
+      }
+
+    if ($mailbody_file) {
+      unlink($mailbody_file);
+      $mailbody_file = null;
+      }
+
+    // raise error if saving failed
+    if (!$saved) {
+      raise_error(array('code' => 800, 'type' => 'imap',
             'file' => __FILE__, 'line' => __LINE__,
             'message' => "Could not save message in $store_target"), TRUE, FALSE);
     
-    if ($savedraft) {
-      $OUTPUT->show_message('errorsaving', 'error');
-      $OUTPUT->send('iframe');
+      if ($savedraft) {
+        $OUTPUT->show_message('errorsaving', 'error');
+        $OUTPUT->send('iframe');
+        }
       }
     }
@@ -565 +602 @@
     }
   }
+// remove temp file
+else if ($mailbody_file) {
+  unlink($mailbody_file);
+  }
+
 
 if ($savedraft)