one more identity action to process
[squirrelmail.git] / class / deliver / Deliver.class.php
index 7789740b6270832d889f8e7215114c4d78811a5b..7652bcd36923145e4b748219644adc67c5c98151 100644 (file)
@@ -2,19 +2,17 @@
 /**
  * Deliver.class.php
  *
- * Copyright (c) 1999-2003 The SquirrelMail Project Team
+ * Copyright (c) 1999-2005 The SquirrelMail Project Team
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *
  * This contains all the functions needed to send messages through
  * a delivery backend.
  *
- * $Id$
- *
+ * @version $Id$
  * @author  Marc Groot Koerkamp
  * @package squirrelmail
  */
 
-
 /**
  * Deliver Class - called to actually deliver the message
  *
@@ -36,7 +34,7 @@ class Deliver {
      * @param Message  $message  Message class to send
      * @param resource $stream   file handle to the SMTP stream
      *
-     * @returns integer $raw_length
+     * @return integer $raw_length
      */
     function mail($message, $stream=false) {
         $rfc822_header = $message->rfc822_header;
@@ -71,15 +69,24 @@ class Deliver {
      *                                as returned by mail fn
      * @param string    $boundary     custom boundary to call, usually for subparts
      *
-     * @returns void
+     * @return void
      */
     function writeBody($message, $stream, &$length_raw, $boundary='') {
         // calculate boundary in case of multidimensional mime structures
         if ($boundary && $message->entity_id && count($message->entities)) {
             if (strpos($boundary,'_part_')) {
                 $boundary = substr($boundary,0,strpos($boundary,'_part_'));
+
+            // the next four lines use strrev to reverse any nested boundaries
+            // because RFC 2046 (5.1.1) says that if a line starts with the outer
+            // boundary string (doesn't matter what the line ends with), that
+            // can be considered a match for the outer boundary; thus the nested
+            // boundary needs to be unique from the outer one
+            //
+            } else if (strpos($boundary,'_trap_')) {
+                $boundary = substr(strrev($boundary),0,strpos(strrev($boundary),'_part_'));
             }
-            $boundary_new = $boundary . '_part_'.$message->entity_id;
+            $boundary_new = strrev($boundary . '_part_'.$message->entity_id);
         } else {
             $boundary_new = $boundary;
         }
@@ -119,7 +126,7 @@ class Deliver {
      * @param integer  &$length       length of the message part
      *                                as returned by mail fn
      *
-     * @returns void
+     * @return void
      */
     function writeBodyPart($message, $stream, &$length) {
         if ($message->mime_header) {
@@ -135,6 +142,8 @@ class Deliver {
         case 'message':
             if ($message->body_part) {
                 $body_part = $message->body_part;
+                // remove NUL characters
+                $body_part = str_replace("\0",'',$body_part);
                 $length += $this->clean_crlf($body_part);
                 if ($stream) {
                     $this->preWriteToStream($body_part);
@@ -145,6 +154,8 @@ class Deliver {
                 $filename = $message->att_local_name;
                 $file = fopen ($filename, 'rb');
                 while ($body_part = fgets($file, 4096)) {
+                    // remove NUL characters
+                    $body_part = str_replace("\0",'',$body_part);
                     $length += $this->clean_crlf($body_part);
                     if ($stream) {
                         $this->preWriteToStream($body_part);
@@ -158,6 +169,8 @@ class Deliver {
         default:
             if ($message->body_part) {
                 $body_part = $message->body_part;
+                // remove NUL characters
+                $body_part = str_replace("\0",'',$body_part);
                 $length += $this->clean_crlf($body_part);
                 if ($stream) {
                     $this->writeToStream($stream, $body_part);
@@ -165,9 +178,13 @@ class Deliver {
             } elseif ($message->att_local_name) {
                 $filename = $message->att_local_name;
                 $file = fopen ($filename, 'rb');
-                $encoded = '';
                 while ($tmp = fread($file, 570)) {
-                   $body_part = chunk_split(base64_encode($tmp));
+                    $body_part = chunk_split(base64_encode($tmp));
+                    // Up to 4.3.10 chunk_split always appends a newline,
+                    // while in 4.3.11 it doesn't if the string to split
+                    // is shorter than the chunk length.
+                    if( substr($body_part, -1 , 1 ) != "\n" )
+                        $body_part .= "\n";
                     $length += $this->clean_crlf($body_part);
                     if ($stream) {
                         $this->writeToStream($stream, $body_part);
@@ -198,7 +215,7 @@ class Deliver {
      *
      * @param string &$s string to clean linefeeds on
      *
-     * @returns void
+     * @return void
      */
     function clean_crlf(&$s) {
         $s = str_replace("\r\n", "\n", $s);
@@ -215,7 +232,7 @@ class Deliver {
      *
      * @param string &$s string to clean linefeeds on
      *
-     * @returns void
+     * @return void
      */
     function strip_crlf(&$s) {
         $s = str_replace("\r\n ", '', $s);
@@ -231,7 +248,7 @@ class Deliver {
      *
      * @param string &$s string to operate on
      *
-     * @returns void
+     * @return void
      */
     function preWriteToStream(&$s) {
     }
@@ -242,7 +259,7 @@ class Deliver {
      * @param resource $stream  SMTP output stream
      * @param string   $data    string with data to send to the SMTP stream
      *
-     * @returns void
+     * @return void
      */
     function writeToStream($stream, $data) {
         fputs($stream, $data);
@@ -260,7 +277,7 @@ class Deliver {
      * @param string  $pass     password to log into the SMTP server with
      * @param integer $length
      *
-     * @returns handle $stream file handle resource to SMTP stream
+     * @return handle $stream file handle resource to SMTP stream
      */
     function initStream($message, $length=0, $host='', $port='', $user='', $pass='') {
         return $stream;
@@ -283,7 +300,7 @@ class Deliver {
      * @param Message $message  Message object to act on
      * @param string  $boundary mime boundary from fn MimeBoundary
      *
-     * @returns string $header properly formatted mime header
+     * @return string $header properly formatted mime header
      */
     function prepareMIME_Header($message, $boundary) {
         $mime_header = $message->mime_header;
@@ -293,7 +310,7 @@ class Deliver {
         $contenttype = 'Content-Type: '. $mime_header->type0 .'/'.
                         $mime_header->type1;
         if (count($message->entities)) {
-            $contenttype .= ";\r\n " . 'boundary="'.$boundary.'"';
+            $contenttype .= ';' . 'boundary="'.$boundary.'"';
         }
         if (isset($mime_header->parameters['name'])) {
             $contenttype .= '; name="'.
@@ -307,20 +324,19 @@ class Deliver {
 
         $header[] = $contenttype . $rn;
         if ($mime_header->description) {
-            $header[] .= 'Content-Description: ' . $mime_header->description . $rn;
+            $header[] = 'Content-Description: ' . $mime_header->description . $rn;
         }
         if ($mime_header->encoding) {
-            $encoding = $mime_header->encoding;
-            $header[] .= 'Content-Transfer-Encoding: ' . $mime_header->encoding . $rn;
+            $header[] = 'Content-Transfer-Encoding: ' . $mime_header->encoding . $rn;
         } else {
             if ($mime_header->type0 == 'text' || $mime_header->type0 == 'message') {
-                $header[] .= 'Content-Transfer-Encoding: 8bit' .  $rn;
+                $header[] = 'Content-Transfer-Encoding: 8bit' .  $rn;
             } else {
-                $header[] .= 'Content-Transfer-Encoding: base64' .  $rn;
+                $header[] = 'Content-Transfer-Encoding: base64' .  $rn;
             }
         }
         if ($mime_header->id) {
-            $header[] .= 'Content-ID: ' . $mime_header->id . $rn;
+            $header[] = 'Content-ID: ' . $mime_header->id . $rn;
         }
         if ($mime_header->disposition) {
             $disposition = $mime_header->disposition;
@@ -332,10 +348,10 @@ class Deliver {
             $header[] = $contentdisp . $rn;
         }
         if ($mime_header->md5) {
-            $header[] .= 'Content-MD5: ' . $mime_header->md5 . $rn;
+            $header[] = 'Content-MD5: ' . $mime_header->md5 . $rn;
         }
         if ($mime_header->language) {
-            $header[] .= 'Content-Language: ' . $mime_header->language . $rn;
+            $header[] = 'Content-Language: ' . $mime_header->language . $rn;
         }
 
         $cnt = count($header);
@@ -359,10 +375,10 @@ class Deliver {
      * @param Rfc822Header  $reply_rfc822_header
      * @param integer      &$raw_length length of the message
      *
-     * @returns
+     * @return string $header
      */
     function prepareRFC822_Header($rfc822_header, $reply_rfc822_header, &$raw_length) {
-        global $domain, $version, $username;
+        global $domain, $version, $username, $encode_header_key, $edit_identity, $hide_auth_header;
 
         /* if server var SERVER_NAME not available, use $domain */
         if(!sqGetGlobalVar('SERVER_NAME', $SERVER_NAME, SQ_SERVER)) {
@@ -380,8 +396,14 @@ class Deliver {
         /* This creates an RFC 822 date */
         $date = date('D, j M Y H:i:s ', mktime()) . $this->timezone();
         /* Create a message-id */
-        $message_id = '<' . $REMOTE_PORT . '.' . $REMOTE_ADDR . '.';
-        $message_id .= time() . '.squirrel@' . $REMOTE_ADDR .'>';
+        $message_id = '<' . $REMOTE_PORT . '.';
+        if (isset($encode_header_key) && trim($encode_header_key)!='') {
+            // use encrypted form of remote address
+            $message_id.= OneTimePadEncrypt($this->ip2hex($REMOTE_ADDR),base64_encode($encode_header_key));
+        } else {
+            $message_id.= $REMOTE_ADDR;
+        }
+        $message_id .= '.' . time() . '.squirrel@' . $SERVER_NAME .'>';
         /* Make an RFC822 Received: line */
         if (isset($REMOTE_HOST)) {
             $received_from = "$REMOTE_HOST ([$REMOTE_ADDR])";
@@ -395,13 +417,37 @@ class Deliver {
             $received_from .= " (proxying for $HTTP_X_FORWARDED_FOR)";
         }
         $header = array();
-        $header[] = "Received: from $received_from" . $rn;
-        $header[] = "        (SquirrelMail authenticated user $username);" . $rn;
-        $header[] = "        by $SERVER_NAME with HTTP;" . $rn;
-        $header[] = "        $date" . $rn;
+
+        /**
+         * SquirrelMail header
+         *
+         * This Received: header provides information that allows to track
+         * user and machine that was used to send email. Don't remove it
+         * unless you understand all possible forging issues or your
+         * webmail installation does not prevent changes in user's email address.
+         * See SquirrelMail bug tracker #847107 for more details about it.
+         */
+        if (isset($encode_header_key) && 
+            trim($encode_header_key)!='') {
+            // use encoded headers, if encryption key is set and not empty
+            $header[] = 'X-Squirrel-UserHash: '.OneTimePadEncrypt($username,base64_encode($encode_header_key)).$rn;
+            $header[] = 'X-Squirrel-FromHash: '.OneTimePadEncrypt($this->ip2hex($REMOTE_ADDR),base64_encode($encode_header_key)).$rn;
+            if (isset($HTTP_X_FORWARDED_FOR))
+                $header[] = 'X-Squirrel-ProxyHash:'.OneTimePadEncrypt($this->ip2hex($HTTP_X_FORWARDED_FOR),base64_encode($encode_header_key)).$rn;
+        } else {
+            // use default received headers
+            $header[] = "Received: from $received_from" . $rn;
+            if ($edit_identity || ! isset($hide_auth_header) || ! $hide_auth_header)
+                $header[] = "        (SquirrelMail authenticated user $username)" . $rn;
+            $header[] = "        by $SERVER_NAME with HTTP;" . $rn;
+            $header[] = "        $date" . $rn;
+        }
+
         /* Insert the rest of the header fields */
         $header[] = 'Message-ID: '. $message_id . $rn;
-        if ($reply_rfc822_header->message_id) {
+        if (is_object($reply_rfc822_header) && 
+            isset($reply_rfc822_header->message_id) &&
+            $reply_rfc822_header->message_id) {
             $rep_message_id = $reply_rfc822_header->message_id;
         //        $this->strip_crlf($message_id);
             $header[] = 'In-Reply-To: '.$rep_message_id . $rn;
@@ -410,16 +456,20 @@ class Deliver {
         }
         $header[] = "Date: $date" . $rn;
         $header[] = 'Subject: '.encodeHeader($rfc822_header->subject) . $rn;
-        $header[] = 'From: '. $rfc822_header->getAddr_s('from',',',true) . $rn;
-        /* RFC2822 if from contains more then 1 address */
+        $header[] = 'From: '. $rfc822_header->getAddr_s('from',",$rn ",true) . $rn;
+
+        // folding address list [From|To|Cc|Bcc] happens by using ",$rn<space>" as delimiter
+        // Do not use foldLine for that.
+
+        // RFC2822 if from contains more then 1 address
         if (count($rfc822_header->from) > 1) {
             $header[] = 'Sender: '. $rfc822_header->getAddr_s('sender',',',true) . $rn;
         }
         if (count($rfc822_header->to)) {
-            $header[] = 'To: '. $rfc822_header->getAddr_s('to',',',true) . $rn;
+            $header[] = 'To: '. $rfc822_header->getAddr_s('to',",$rn ",true) . $rn;
         }
         if (count($rfc822_header->cc)) {
-            $header[] = 'Cc: '. $rfc822_header->getAddr_s('cc',',',true) . $rn;
+            $header[] = 'Cc: '. $rfc822_header->getAddr_s('cc',",$rn ",true) . $rn;
         }
         if (count($rfc822_header->reply_to)) {
             $header[] = 'Reply-To: '. $rfc822_header->getAddr_s('reply_to',',',true) . $rn;
@@ -427,9 +477,8 @@ class Deliver {
         /* Sendmail should return true. Default = false */
         $bcc = $this->getBcc();
         if (count($rfc822_header->bcc)) {
-            $s = 'Bcc: '. $rfc822_header->getAddr_s('bcc',',',true) . $rn;
+            $s = 'Bcc: '. $rfc822_header->getAddr_s('bcc',",$rn ",true) . $rn;
             if (!$bcc) {
-                $s = $this->foldLine($s, 78, str_pad('',4));
                 $raw_length += strlen($s);
             } else {
                 $header[] = $s;
@@ -437,8 +486,6 @@ class Deliver {
         }
         /* Identify SquirrelMail */
         $header[] = 'User-Agent: SquirrelMail/' . $version . $rn;
-        // Spamassassin complains about no X-Mailer in combination with X-Priority
-        $header[] = 'X-Mailer: SquirrelMail/' . $version . $rn;
         /* Do the MIME-stuff */
         $header[] = 'MIME-Version: 1.0' . $rn;
         $contenttype = 'Content-Type: '. $rfc822_header->content_type->type0 .'/'.
@@ -452,7 +499,7 @@ class Deliver {
         }
         $header[] = $contenttype . $rn;
         if ($encoding = $rfc822_header->encoding) {
-            $header[] .= 'Content-Transfer-Encoding: ' . $encoding .  $rn;
+            $header[] = 'Content-Transfer-Encoding: ' . $encoding .  $rn;
         }
         if ($rfc822_header->dnt) {
             $dnt = $rfc822_header->getAddr_s('dnt');
@@ -462,13 +509,14 @@ class Deliver {
             $header[] = 'Disposition-Notification-To: '.$dnt. $rn;
         }
         if ($rfc822_header->priority) {
-            $prio = $rfc822_header->priority;
-            $header[] = 'X-Priority: '. $prio. $rn;
-            switch($prio)
+            switch($rfc822_header->priority)
             {
-            case 1: $header[] = 'Importance: High'. $rn; break;
-            case 3: $header[] = 'Importance: Normal'. $rn; break;
-            case 5: $header[] = 'Importance: Low'. $rn; break;
+            case 1:
+                $header[] = 'X-Priority: 1 (Highest)'.$rn;
+                $header[] = 'Importance: High'. $rn; break;
+            case 5:
+                $header[] = 'X-Priority: 5 (Lowest)'.$rn;
+                $header[] = 'Importance: Low'. $rn; break;
             default: break;
             }
         }
@@ -504,6 +552,12 @@ class Deliver {
                 }
                 $hdr_s .= $sLine;
                 break;
+            case 'To':
+            case 'Cc':
+            case 'Bcc':
+            case 'From':
+                $hdr_s .= $header[$i];
+                break;
             default: $hdr_s .= $this->foldLine($header[$i], 78, str_pad('',4)); break;
             }
         }
@@ -520,7 +574,7 @@ class Deliver {
      * @param   integer $length length to fold the line at
      * @param   string  $pre    prefix the line with...
      *
-     * @returns string  $line folded line with trailing CRLF
+     * @return string   $line folded line with trailing CRLF
      */
     function foldLine($line, $length, $pre='') {
         $line = substr($line,0, -2);
@@ -613,7 +667,7 @@ class Deliver {
      * This function will generate a random mime boundary base part
      * for the message if the boundary has not already been set.
      *
-     * @returns string $mimeBoundaryString random mime boundary string
+     * @return string $mimeBoundaryString random mime boundary string
      */
     function mimeBoundary () {
         static $mimeBoundaryString;
@@ -629,7 +683,7 @@ class Deliver {
     /**
      * function timezone - Time offset for correct timezone
      *
-     * @returns string $result with timezone and offset
+     * @return string $result with timezone and offset
      */
     function timezone () {
         global $invert_time;
@@ -657,7 +711,7 @@ class Deliver {
      *
      * @param   Rfc822Header $hdr    message header to calculate from
      *
-     * @returns string       $refer  concatenated and trimmed Referer string
+     * @return  string       $refer  concatenated and trimmed Referer string
      */
     function calculate_references($hdr) {
         $refer = $hdr->references;
@@ -675,5 +729,66 @@ class Deliver {
         trim($refer);
         return $refer;
     }
+
+    /**
+     * Converts ip address to hexadecimal string
+     *
+     * Function is used to convert ipv4 and ipv6 addresses to hex strings.
+     * It removes all delimiter symbols from ip addresses, converts decimal
+     * ipv4 numbers to hex and pads strings in order to present full length
+     * address. ipv4 addresses are represented as 8 byte strings, ipv6 addresses 
+     * are represented as 32 byte string.
+     *
+     * If function fails to detect address format, it returns unprocessed string.
+     * @param string $string ip address string
+     * @return string processed ip address string
+     * @since 1.5.1 and 1.4.5
+     */
+    function ip2hex($string) {
+        if (preg_match("/^(\d+)\.(\d+)\.(\d+)\.(\d+)$/",$string,$match)) {
+            // ipv4 address
+            $ret = str_pad(dechex($match[1]),2,'0',STR_PAD_LEFT)
+                . str_pad(dechex($match[2]),2,'0',STR_PAD_LEFT)
+                . str_pad(dechex($match[3]),2,'0',STR_PAD_LEFT)
+                . str_pad(dechex($match[4]),2,'0',STR_PAD_LEFT);
+        } elseif (preg_match("/^([0-9a-h]+)\:([0-9a-h]+)\:([0-9a-h]+)\:([0-9a-h]+)\:([0-9a-h]+)\:([0-9a-h]+)\:([0-9a-h]+)\:([0-9a-h]+)$/i",$string,$match)) {
+            // full ipv6 address
+            $ret = str_pad($match[1],4,'0',STR_PAD_LEFT)
+                . str_pad($match[2],4,'0',STR_PAD_LEFT)
+                . str_pad($match[3],4,'0',STR_PAD_LEFT)
+                . str_pad($match[4],4,'0',STR_PAD_LEFT)
+                . str_pad($match[5],4,'0',STR_PAD_LEFT)
+                . str_pad($match[6],4,'0',STR_PAD_LEFT)
+                . str_pad($match[7],4,'0',STR_PAD_LEFT)
+                . str_pad($match[8],4,'0',STR_PAD_LEFT);
+        } elseif (preg_match("/^\:\:([0-9a-h\:]+)$/i",$string,$match)) {
+            // short ipv6 with all starting symbols nulled
+            $aAddr=explode(':',$match[1]);
+            $ret='';
+            foreach ($aAddr as $addr) {
+                $ret.=str_pad($addr,4,'0',STR_PAD_LEFT);
+            }
+            $ret=str_pad($ret,32,'0',STR_PAD_LEFT);
+        } elseif (preg_match("/^([0-9a-h\:]+)::([0-9a-h\:]+)$/i",$string,$match)) {
+            // short ipv6 with middle part nulled
+            $aStart=explode(':',$match[1]);
+            $sStart='';
+            foreach($aStart as $addr) {
+                $sStart.=str_pad($addr,4,'0',STR_PAD_LEFT);
+            }
+            $aEnd = explode(':',$match[2]);
+            $sEnd='';
+            foreach($aEnd as $addr) {
+                $sEnd.=str_pad($addr,4,'0',STR_PAD_LEFT);
+            }
+            $ret = $sStart
+                . str_pad('',(32 - strlen($sStart . $sEnd)),'0',STR_PAD_LEFT)
+                . $sEnd;
+        } else {
+            // unknown addressing
+            $ret = $string;
+        }
+        return $ret;
+    }
 }
-?>
\ No newline at end of file
+?>