class/deliver/Deliver.class.php

   1 <?php
   2
   3 /**
   4  * Deliver.class.php
   5  *
   6  * Copyright (c) 1999-2003 The SquirrelMail Project Team
   7  * Licensed under the GNU GPL. For full terms see the file COPYING.
   8  *
   9  * This contains all the functions needed to send messages through
  10  * a delivery backend.
  11  *
  12  * $Id$
  13  */
  14
  15 class Deliver {
  16
  17     function mail($message, $stream=false) {
  18        $rfc822_header = $message->rfc822_header;
  19        if (count($message->entities)) {
  20           $boundary = $this->mimeBoundary();
  21           $rfc822_header->content_type->properties['boundary']='"'.$boundary.'"';
  22        } else {
  23           $boundary='';
  24        }
  25        $raw_length = 0;
  26        $reply_rfc822_header = (isset($message->reply_rfc822_header)
  27                              ? $message->reply_rfc822_header : '');
  28        $header = $this->prepareRFC822_Header($rfc822_header, $reply_rfc822_header, $raw_length);
  29
  30        if ($stream) {
  31             $this->preWriteToStream($header);
  32             $this->writeToStream($stream, $header);
  33        }
  34        $this->writeBody($message, $stream, $raw_length, $boundary);
  35        return $raw_length;
  36     }
  37
  38     function writeBody($message, $stream, &$length_raw, $boundary='') {
  39         if ($boundary && !$message->rfc822_header) {
  40             $s = '--'.$boundary."\r\n";
  41             $s .= $this->prepareMIME_Header($message, $boundary);
  42             $length_raw += strlen($s);
  43             if ($stream) {
  44                 $this->preWriteToStream($s);
  45                 $this->writeToStream($stream, $s);
  46             }
  47         }
  48         $this->writeBodyPart($message, $stream, $length_raw);
  49         $boundary_depth = substr_count($message->entity_id,'.');
  50         if ($boundary_depth) {
  51            $boundary .= '_part'.$boundary_depth;
  52         }
  53         $last = false;
  54         for ($i=0, $entCount=count($message->entities);$i<$entCount;$i++) {
  55             $msg = $this->writeBody($message->entities[$i], $stream, $length_raw, $boundary);
  56             if ($i == $entCount-1) $last = true;
  57         }
  58         if ($boundary && $last) {
  59             $s = "--".$boundary."--\r\n\r\n";
  60             $length_raw += strlen($s);
  61             if ($stream) {
  62                 $this->preWriteToStream($s);
  63                 $this->writeToStream($stream, $s);
  64             }
  65         }
  66     }
  67
  68     function writeBodyPart($message, $stream, &$length) {
  69         if ($message->mime_header) {
  70            $type0 = $message->mime_header->type0;
  71         } else {
  72            $type0 = $message->rfc822_header->content_type->type0;
  73         }
  74
  75         $body_part_trailing = $last = '';
  76         switch ($type0) {
  77         case 'text':
  78         case 'message':
  79             if ($message->body_part) {
  80                $body_part = $message->body_part;
  81                $length += $this->clean_crlf($body_part);
  82                if ($stream) {
  83                   $this->preWriteToStream($body_part);
  84                   $this->writeToStream($stream, $body_part);
  85                }
  86                $last = $body_part;
  87             } elseif ($message->att_local_name) {
  88                 $filename = $message->att_local_name;
  89                 $file = fopen ($filename, 'rb');
  90                 while ($body_part = fgets($file, 4096)) {
  91                    $length += $this->clean_crlf($body_part);
  92                    if ($stream) {
  93                       $this->preWriteToStream($body_part);
  94                       $this->writeToStream($stream, $body_part);
  95                    }
  96                    $last = $body_part;
  97                 }
  98                 fclose($file);
  99             }
 100             break;
 101         default:
 102             if ($message->body_part) {
 103                $body_part = $message->body_part;
 104                $length += $this->clean_crlf($body_part);
 105                if ($stream) {
 106                   $this->writeToStream($stream, $body_part);
 107                }
 108             } elseif ($message->att_local_name) {
 109                 $filename = $message->att_local_name;
 110                 $file = fopen ($filename, 'rb');
 111                 $encoded = '';
 112                 while ($tmp = fread($file, 570)) {
 113                    $body_part = chunk_split(base64_encode($tmp));
 114                    $length += $this->clean_crlf($body_part);
 115                    if ($stream) {
 116                       $this->writeToStream($stream, $body_part);
 117                    }
 118                 }
 119                 fclose($file);
 120             }
 121             break;
 122         }
 123         $body_part_trailing = '';
 124         if ($last && substr($last,-1) != "\n") {
 125            $body_part_trailing = "\r\n";
 126         }
 127         if ($body_part_trailing) {
 128             $length += strlen($body_part_trailing);
 129             if ($stream) {
 130                 $this->preWriteToStream($body_part_trailing);
 131                 $this->writeToStream($stream, $body_part_trailing);
 132             }
 133         }
 134     }
 135
 136     function clean_crlf(&$s) {
 137         $s = str_replace("\r\n", "\n", $s);
 138         $s = str_replace("\r", "\n", $s);
 139         $s = str_replace("\n", "\r\n", $s);
 140         return strlen($s);
 141     }
 142
 143     function strip_crlf(&$s) {
 144         $s = str_replace("\r\n ", '', $s);
 145         $s = str_replace("\r", '', $s);
 146         $s = str_replace("\n", '', $s);
 147     }
 148
 149     function preWriteToStream(&$s) {
 150     }
 151
 152     function writeToStream($stream, $data) {
 153        fputs($stream, $data);
 154     }
 155
 156     function initStream($message, $length=0, $host='', $port='', $user='', $pass='') {
 157        return $stream;
 158     }
 159
 160     function getBcc() {
 161        return false;
 162     }
 163
 164     function prepareMIME_Header($message, $boundary) {
 165         $mime_header = $message->mime_header;
 166         $rn="\r\n";
 167         $header = array();
 168
 169         $contenttype = 'Content-Type: '. $mime_header->type0 .'/'.
 170                        $mime_header->type1;
 171         if (count($message->entities)) {
 172             $contenttype .= ";\r\n " . 'boundary="'.$boundary.'"';
 173         }
 174         if (isset($mime_header->parameters['name'])) {
 175             $contenttype .= '; name="'.
 176                 encodeHeader($mime_header->parameters['name']). '"';
 177         }
 178         if (isset($mime_header->parameters['charset'])) {
 179             $charset = $mime_header->parameters['charset'];
 180             $contenttype .= '; charset="'.
 181                 encodeHeader($charset). '"';
 182         }
 183
 184
 185         $header[] = $contenttype . $rn;
 186         if ($mime_header->description) {
 187             $header[] .= 'Content-Description: ' . $mime_header->description . $rn;
 188         }
 189         if ($mime_header->encoding) {
 190             $encoding = $mime_header->encoding;
 191             $header[] .= 'Content-Transfer-Encoding: ' . $mime_header->encoding . $rn;
 192         } else {
 193             if ($mime_header->type0 == 'text' || $mime_header->type0 == 'message') {
 194                 $header[] .= 'Content-Transfer-Encoding: 8bit' .  $rn;
 195             } else {
 196                 $header[] .= 'Content-Transfer-Encoding: base64' .  $rn;
 197             }
 198         }
 199         if ($mime_header->id) {
 200             $header[] .= 'Content-ID: ' . $mime_header->id . $rn;
 201         }
 202         if ($mime_header->disposition) {
 203             $disposition = $mime_header->disposition;
 204             $contentdisp = 'Content-Disposition: ' . $disposition->name;
 205             if ($disposition->getProperty('filename')) {
 206                 $contentdisp .= '; filename="'.
 207                     encodeHeader($disposition->getProperty('filename')). '"';
 208             }
 209             $header[] = $contentdisp . $rn;
 210         }
 211         if ($mime_header->md5) {
 212             $header[] .= 'Content-MD5: ' . $mime_header->md5 . $rn;
 213         }
 214         if ($mime_header->language) {
 215             $header[] .= 'Content-Language: ' . $mime_header->language . $rn;
 216         }
 217
 218         $cnt = count($header);
 219         $hdr_s = '';
 220         for ($i = 0 ; $i < $cnt ; $i++) {
 221             $hdr_s .= $this->foldLine($header[$i], 78,str_pad('',4));
 222         }
 223         $header = $hdr_s;
 224         $header .= $rn; /* One blank line to separate mimeheader and body-entity */
 225         return $header;
 226     }
 227
 228     function prepareRFC822_Header($rfc822_header, $reply_rfc822_header, &$raw_length) {
 229         global $domain, $version, $username;
 230
 231         /* if server var SERVER_NAME not available, use $domain */
 232         if(!sqGetGlobalVar('SERVER_NAME', $SERVER_NAME, SQ_SERVER)) {
 233             $SERVER_NAME = $domain;
 234         }
 235
 236         sqGetGlobalVar('REMOTE_ADDR', $REMOTE_ADDR, SQ_SERVER);
 237         sqGetGlobalVar('REMOTE_PORT', $REMOTE_PORT, SQ_SERVER);
 238         sqGetGlobalVar('REMOTE_HOST', $REMOTE_HOST, SQ_SERVER);
 239         sqGetGlobalVar('HTTP_VIA',    $HTTP_VIA,    SQ_SERVER);
 240         sqGetGlobalVar('HTTP_X_FORWARDED_FOR', $HTTP_X_FORWARDED_FOR, SQ_SERVER);
 241
 242         $rn = "\r\n";
 243
 244         /* This creates an RFC 822 date */
 245         $date = date('D, j M Y H:i:s ', mktime()) . $this->timezone();
 246         /* Create a message-id */
 247         $message_id = '<' . $REMOTE_PORT . '.' . $REMOTE_ADDR . '.';
 248         $message_id .= time() . '.squirrel@' . $SERVER_NAME .'>';
 249         /* Make an RFC822 Received: line */
 250         if (isset($REMOTE_HOST)) {
 251             $received_from = "$REMOTE_HOST ([$REMOTE_ADDR])";
 252         } else {
 253             $received_from = $REMOTE_ADDR;
 254         }
 255         if (isset($HTTP_VIA) || isset ($HTTP_X_FORWARDED_FOR)) {
 256             if (!isset($HTTP_X_FORWARDED_FOR) || $HTTP_X_FORWARDED_FOR == '') {
 257                 $HTTP_X_FORWARDED_FOR = 'unknown';
 258             }
 259             $received_from .= " (proxying for $HTTP_X_FORWARDED_FOR)";
 260         }
 261         $header = array();
 262         $header[] = "Received: from $received_from" . $rn;
 263         $header[] = "        (SquirrelMail authenticated user $username)" . $rn;
 264         $header[] = "        by $SERVER_NAME with HTTP;" . $rn;
 265         $header[] = "        $date" . $rn;
 266         /* Insert the rest of the header fields */
 267         $header[] = 'Message-ID: '. $message_id . $rn;
 268         if ($reply_rfc822_header->message_id) {
 269             $rep_message_id = $reply_rfc822_header->message_id;
 270 //          $this->strip_crlf($message_id);
 271             $header[] = 'In-Reply-To: '.$rep_message_id . $rn;
 272             $references = $this->calculate_references($reply_rfc822_header);
 273             $header[] = 'References: '.$references . $rn;
 274         }
 275         $header[] = "Date: $date" . $rn;
 276         $header[] = 'Subject: '.encodeHeader($rfc822_header->subject) . $rn;
 277         $header[] = 'From: '. $rfc822_header->getAddr_s('from',',',true) . $rn;
 278         /* RFC2822 if from contains more then 1 address */
 279         if (count($rfc822_header->from) > 1) {
 280             $header[] = 'Sender: '. $rfc822_header->getAddr_s('sender',',',true) . $rn;
 281         }
 282         if (count($rfc822_header->to)) {
 283             $header[] = 'To: '. $rfc822_header->getAddr_s('to',',',true) . $rn;
 284         }
 285         if (count($rfc822_header->cc)) {
 286             $header[] = 'Cc: '. $rfc822_header->getAddr_s('cc',',',true) . $rn;
 287         }
 288         if (count($rfc822_header->reply_to)) {
 289             $header[] = 'Reply-To: '. $rfc822_header->getAddr_s('reply_to',',',true) . $rn;
 290         }
 291         /* Sendmail should return true. Default = false */
 292         $bcc = $this->getBcc();
 293         if (count($rfc822_header->bcc)) {
 294             $s = 'Bcc: '. $rfc822_header->getAddr_s('bcc',',',true) . $rn;
 295             if (!$bcc) {
 296                $s = $this->foldLine($s, 78, str_pad('',4));
 297                $raw_length += strlen($s);
 298             } else {
 299                $header[] = $s;
 300             }
 301         }
 302         /* Identify SquirrelMail */
 303         $header[] = 'User-Agent: SquirrelMail/' . $version . $rn;
 304         /* Do the MIME-stuff */
 305         $header[] = 'MIME-Version: 1.0' . $rn;
 306         $contenttype = 'Content-Type: '. $rfc822_header->content_type->type0 .'/'.
 307                                          $rfc822_header->content_type->type1;
 308         if (count($rfc822_header->content_type->properties)) {
 309             foreach ($rfc822_header->content_type->properties as $k => $v) {
 310                 if ($k && $v) {
 311                     $contenttype .= ';' .$k.'='.$v;
 312                 }
 313             }
 314         }
 315         $header[] = $contenttype . $rn;
 316         if ($rfc822_header->dnt) {
 317             $dnt = $rfc822_header->getAddr_s('dnt');
 318             /* Pegasus Mail */
 319             $header[] = 'X-Confirm-Reading-To: '.$dnt. $rn;
 320             /* RFC 2298 */
 321             $header[] = 'Disposition-Notification-To: '.$dnt. $rn;
 322         }
 323         if ($rfc822_header->priority) {
 324             $prio = $rfc822_header->priority;
 325             $header[] = 'X-Priority: '.$prio. $rn;
 326             switch($prio) {
 327               case 1: $header[] = 'Importance: High'. $rn; break;
 328               case 3: $header[] = 'Importance: Normal'. $rn; break;
 329               case 5: $header[] = 'Importance: Low'. $rn; break;
 330               default: break;
 331             }
 332         }
 333         /* Insert headers from the $more_headers array */
 334         if(count($rfc822_header->more_headers)) {
 335             reset($rfc822_header->more_headers);
 336             foreach ($rfc822_header->more_headers as $k => $v) {
 337                 $header[] = $k.': '.$v .$rn;
 338             }
 339         }
 340         $cnt = count($header);
 341         $hdr_s = '';
 342
 343         for ($i = 0 ; $i < $cnt ; $i++) {
 344             $sKey = substr($header[$i],0,strpos($header[$i],':'));
 345             switch ($sKey)
 346             {
 347             case 'Message-ID':
 348             case 'In-Reply_To':
 349                 $hdr_s .= $header[$i];
 350                 break;
 351             case 'References':
 352                 $sRefs = substr($header[$i],12);
 353                 $aRefs = explode(' ',$sRefs);
 354                 $sLine = 'References:';
 355                 foreach ($aRefs as $sReference) {
 356                     if (strlen($sLine)+strlen($sReference) >76) {
 357                         $hdr_s .= $sLine;
 358                         $sLine = $rn . '    ' . $sReference;
 359                     } else {
 360                         $sLine .= ' '. $sReference;
 361                     }
 362                 }
 363                 $hdr_s .= $sLine;
 364                 break;
 365             default: $hdr_s .= $this->foldLine($header[$i], 78, str_pad('',4)); break;
 366             }
 367         }
 368
 369         $header = $hdr_s;
 370         $header .= $rn; /* One blank line to separate header and body */
 371         $raw_length += strlen($header);
 372         return $header;
 373     }
 374
 375     /*
 376     * function for cleanly folding of headerlines
 377     */
 378     function foldLine($line, $length, $pre='') {
 379         $line = substr($line,0, -2);
 380         $length -= 2; /* do not fold between \r and \n */
 381         $cnt = strlen($line);
 382         if ($cnt > $length) { /* try folding */
 383             $fold_string = "\r\n " . $pre;
 384             $bFirstFold = false;
 385             $aFoldLine = array();
 386             while (strlen($line) > $length) {
 387                 $fold = false;
 388                 /* handle encoded parts */
 389                 if (preg_match('/(=\?([^?]*)\?(Q|B)\?([^?]*)\?=)(.*)/Ui',$line,$regs)) {
 390                     $fold_tmp = $regs[1];
 391                     $iPosEnc = strpos($line,$fold_tmp);
 392                     $iLengthEnc = strlen($fold_tmp);
 393                     $iPosEncEnd = $iPosEnc+$iLengthEnc;
 394                     if ($iPosEnc < $length && (($iPosEncEnd) > $length)) {
 395                         $fold = true;
 396                         /* fold just before the start of the encoded string */
 397                         $aFoldLine[] = substr($line,0,$iPosEnc);
 398                         $line = substr($line,$iPosEnc);
 399                         if (!$bFirstFold) {
 400                             $bFirstFold = true;
 401                             $length -= strlen($fold_string);
 402                         }
 403                         if ($iLengthEnc > $length) { /* place the encoded
 404                             string on a separate line and do not fold inside it*/
 405                             /* minimize foldstring */
 406                             $fold_string = "\r\n ";
 407                             $aFoldLine[] = substr($line,0,$iLengthEnc);
 408                             $line = substr($line,$iLengthEnc);
 409                         }
 410                     } else if ($iPosEnc < $length) { /* the encoded string fits into the foldlength */
 411                         /*remainder */
 412                         $sLineRem = substr($line,$iPosEncEnd,$length - $iPosEncEnd);
 413                         if (preg_match('/^(=\?([^?]*)\?(Q|B)\?([^?]*)\?=)(.*)/Ui',$sLineRem) || !preg_match('/[=,;\s]/',$sLineRem)) {
 414                             /*impossible to fold clean in the next part -> fold after the enc string */
 415                             $aFoldLine[] = substr($line,0,$iPosEncEnd+1);
 416                             $line = substr($line,$iPosEncEnd+1);
 417                             $fold = true;
 418                             if (!$bFirstFold) {
 419                                 $bFirstFold = true;
 420                                 $length -= strlen($fold_string);
 421                             }
 422                         }
 423                     }
 424                 }
 425                 if (!$fold) {
 426                     $line_tmp = substr($line,0,$length);
 427                     $iFoldPos = false;
 428                     /* try to fold at logical places */
 429                     switch (true)
 430                     {
 431                     case ($iFoldPos = strrpos($line_tmp,',')): break;
 432                     case ($iFoldPos = strrpos($line_tmp,';')): break;
 433                     case ($iFoldPos = strrpos($line_tmp,' ')): break;
 434                     case ($iFoldPos = strrpos($line_tmp,'=')): break;
 435                     default: break;
 436                     }
 437
 438                     if (!$iFoldPos) { /* clean folding didn't work */
 439                         $iFoldPos = $length;
 440                     }
 441                     $aFoldLine[] = substr($line,0,$iFoldPos+1);
 442                     $line = substr($line,$iFoldPos+1);
 443                     if (!$bFirstFold) {
 444                         $bFirstFold = true;
 445                         $length -= strlen($fold_string);
 446                     }
 447                 }
 448             }
 449             /*$reconstruct the line */
 450             if ($line) {
 451                 $aFoldLine[] = $line;
 452             }
 453             $line = implode($fold_string,$aFoldLine);
 454         }
 455
 456         return $line."\r\n";
 457     }
 458
 459     function mimeBoundary () {
 460         static $mimeBoundaryString;
 461
 462         if ( !isset( $mimeBoundaryString ) ||
 463             $mimeBoundaryString == '') {
 464             $mimeBoundaryString = '----=_' . date( 'YmdHis' ) . '_' .
 465                 mt_rand( 10000, 99999 );
 466         }
 467         return $mimeBoundaryString;
 468     }
 469
 470     /* Time offset for correct timezone */
 471     function timezone () {
 472         global $invert_time;
 473
 474         $diff_second = date('Z');
 475         if ($invert_time) {
 476             $diff_second = - $diff_second;
 477         }
 478         if ($diff_second > 0) {
 479             $sign = '+';
 480         } else {
 481             $sign = '-';
 482         }
 483         $diff_second = abs($diff_second);
 484         $diff_hour = floor ($diff_second / 3600);
 485         $diff_minute = floor (($diff_second-3600*$diff_hour) / 60);
 486         $zonename = '('.strftime('%Z').')';
 487         $result = sprintf ("%s%02d%02d %s", $sign, $diff_hour, $diff_minute,
 488                        $zonename);
 489         return ($result);
 490     }
 491
 492     function calculate_references($hdr) {
 493         $refer = $hdr->references;
 494         $message_id = $hdr->message_id;
 495         $in_reply_to = $hdr->in_reply_to;
 496         if (strlen($refer) > 2) {
 497             $refer .= ' ' . $message_id;
 498         } else {
 499             if ($in_reply_to) {
 500                 $refer .= $in_reply_to . ' ' . $message_id;
 501             } else {
 502                 $refer .= $message_id;
 503             }
 504         }
 505         trim($refer);
 506         return $refer;
 507     }
 508 }
 509 ?>