Code clean up, make indentations correct and removal of tabs
[squirrelmail.git] / class / deliver / Deliver.class.php
CommitLineData
4960ec8e 1<?php
2
69298c28 3/**
4 * Deliver.class.php
5 *
76911253 6 * Copyright (c) 1999-2003 The SquirrelMail Project Team
69298c28 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
4960ec8e 15class Deliver {
16
59387d1c 17 function mail($message, $stream=false) {
78f39e78 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);
75b14a70 29
78f39e78 30 if ($stream) {
59387d1c 31 $this->preWriteToStream($header);
32 $this->writeToStream($stream, $header);
78f39e78 33 }
34 $this->writeBody($message, $stream, $raw_length, $boundary);
35 return $raw_length;
3b53d87f 36 }
78f39e78 37
3b53d87f 38 function writeBody($message, $stream, &$length_raw, $boundary='') {
1274f430 39 if ($boundary && !$message->rfc822_header) {
78f39e78 40 $s = '--'.$boundary."\r\n";
41 $s .= $this->prepareMIME_Header($message, $boundary);
42 $length_raw += strlen($s);
43 if ($stream) {
3b53d87f 44 $this->preWriteToStream($s);
78f39e78 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 }
1274f430 58 if ($boundary && $last) {
78f39e78 59 $s = "--".$boundary."--\r\n\r\n";
60 $length_raw += strlen($s);
61 if ($stream) {
3b53d87f 62 $this->preWriteToStream($s);
78f39e78 63 $this->writeToStream($stream, $s);
64 }
65 }
3b53d87f 66 }
67
68 function writeBodyPart($message, $stream, &$length) {
1274f430 69 if ($message->mime_header) {
78f39e78 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 {
78 case 'text':
79 case 'message':
80 if ($message->body_part) {
81 $body_part = $message->body_part;
82 $length += $this->clean_crlf($body_part);
83 if ($stream) {
84 $this->preWriteToStream($body_part);
85 $this->writeToStream($stream, $body_part);
86 }
87 $last = $body_part;
88 } elseif ($message->att_local_name) {
89 $filename = $message->att_local_name;
90 $file = fopen ($filename, 'rb');
91 while ($body_part = fgets($file, 4096)) {
92 $length += $this->clean_crlf($body_part);
93 if ($stream) {
94 $this->preWriteToStream($body_part);
95 $this->writeToStream($stream, $body_part);
96 }
97 $last = $body_part;
98 }
99 fclose($file);
100 }
101 break;
102 default:
103 if ($message->body_part) {
104 $body_part = $message->body_part;
105 $length += $this->clean_crlf($body_part);
106 if ($stream) {
107 $this->writeToStream($stream, $body_part);
108 }
109 } elseif ($message->att_local_name) {
110 $filename = $message->att_local_name;
111 $file = fopen ($filename, 'rb');
112 $encoded = '';
113 while ($tmp = fread($file, 570)) {
114 $body_part = chunk_split(base64_encode($tmp));
115 $length += $this->clean_crlf($body_part);
116 if ($stream) {
117 $this->writeToStream($stream, $body_part);
118 }
119 }
120 fclose($file);
3b53d87f 121 }
78f39e78 122 break;
123 }
124 $body_part_trailing = '';
125 if ($last && substr($last,-1) != "\n") {
126 $body_part_trailing = "\r\n";
127 }
128 if ($body_part_trailing) {
129 $length += strlen($body_part_trailing);
130 if ($stream) {
131 $this->preWriteToStream($body_part_trailing);
132 $this->writeToStream($stream, $body_part_trailing);
133 }
134 }
3b53d87f 135 }
78f39e78 136
69298c28 137 function clean_crlf(&$s) {
3b53d87f 138 $s = str_replace("\r\n", "\n", $s);
139 $s = str_replace("\r", "\n", $s);
140 $s = str_replace("\n", "\r\n", $s);
78f39e78 141 return strlen($s);
3b53d87f 142 }
78f39e78 143
e4f9307a 144 function strip_crlf(&$s) {
145 $s = str_replace("\r\n ", '', $s);
78f39e78 146 $s = str_replace("\r", '', $s);
147 $s = str_replace("\n", '', $s);
e4f9307a 148 }
3b53d87f 149
69298c28 150 function preWriteToStream(&$s) {
3b53d87f 151 }
78f39e78 152
3b53d87f 153 function writeToStream($stream, $data) {
78f39e78 154 fputs($stream, $data);
3b53d87f 155 }
78f39e78 156
3b53d87f 157 function initStream($message, $length=0, $host='', $port='', $user='', $pass='') {
78f39e78 158 return $stream;
3b53d87f 159 }
59387d1c 160
0dab3bfb 161 function getBcc() {
78f39e78 162 return false;
59387d1c 163 }
3b53d87f 164
165 function prepareMIME_Header($message, $boundary) {
78f39e78 166 $mime_header = $message->mime_header;
167 $rn="\r\n";
168 $header = array();
1274f430 169
78f39e78 170 $contenttype = 'Content-Type: '. $mime_header->type0 .'/'.
171 $mime_header->type1;
172 if (count($message->entities)) {
173 $contenttype .= ";\r\n " . 'boundary="'.$boundary.'"';
174 }
175 if (isset($mime_header->parameters['name'])) {
176 $contenttype .= '; name="'.
177 encodeHeader($mime_header->parameters['name']). '"';
178 }
179 if (isset($mime_header->parameters['charset'])) {
180 $charset = $mime_header->parameters['charset'];
181 $contenttype .= '; charset="'.
182 encodeHeader($charset). '"';
183 }
1274f430 184
78f39e78 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 }
4960ec8e 217
78f39e78 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 }
4960ec8e 227
75b14a70 228 function prepareRFC822_Header($rfc822_header, $reply_rfc822_header, &$raw_length) {
78f39e78 229 global $domain, $version, $username;
60a46e65 230
78f39e78 231 /* if server var SERVER_NAME not available, use $domain */
60a46e65 232 if(!sqGetGlobalVar('SERVER_NAME', $SERVER_NAME, SQ_SERVER)) {
233 $SERVER_NAME = $domain;
78f39e78 234 }
60a46e65 235
78f39e78 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);
60a46e65 241
78f39e78 242 $rn = "\r\n";
223872cb 243
78f39e78 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;
59387d1c 263 $header[] = " (SquirrelMail authenticated user $username)" . $rn;
264 $header[] = " by $SERVER_NAME with HTTP;" . $rn;
78f39e78 265 $header[] = " $date" . $rn;
59387d1c 266 /* Insert the rest of the header fields */
267 $header[] = 'Message-ID: '. $message_id . $rn;
1274f430 268 if ($reply_rfc822_header->message_id) {
78f39e78 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;
59387d1c 276 $header[] = 'Subject: '.encodeHeader($rfc822_header->subject) . $rn;
a1386fbf 277 $header[] = 'From: '. $rfc822_header->getAddr_s('from',',',true) . $rn;
78f39e78 278 /* RFC2822 if from contains more then 1 address */
59387d1c 279 if (count($rfc822_header->from) > 1) {
78f39e78 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 .'/'.
59387d1c 307 $rfc822_header->content_type->type1;
78f39e78 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 }
59387d1c 315 $header[] = $contenttype . $rn;
78f39e78 316 if ($encoding = $rfc822_header->encoding) {
bfebbda2 317 $header[] .= 'Content-Transfer-Encoding: ' . $encoding . $rn;
318 }
59387d1c 319 if ($rfc822_header->dnt) {
78f39e78 320 $dnt = $rfc822_header->getAddr_s('dnt');
321 /* Pegasus Mail */
322 $header[] = 'X-Confirm-Reading-To: '.$dnt. $rn;
323 /* RFC 2298 */
324 $header[] = 'Disposition-Notification-To: '.$dnt. $rn;
325 }
326 if ($rfc822_header->priority) {
327 $prio = $rfc822_header->priority;
328 $header[] = 'X-Priority: '.$prio. $rn;
329 switch($prio)
330 {
331 case 1: $header[] = 'Importance: High'. $rn; break;
332 case 3: $header[] = 'Importance: Normal'. $rn; break;
333 case 5: $header[] = 'Importance: Low'. $rn; break;
334 default: break;
335 }
336 }
337 /* Insert headers from the $more_headers array */
338 if(count($rfc822_header->more_headers)) {
339 reset($rfc822_header->more_headers);
340 foreach ($rfc822_header->more_headers as $k => $v) {
341 $header[] = $k.': '.$v .$rn;
342 }
343 }
344 $cnt = count($header);
345 $hdr_s = '';
5d2a7b15 346
78f39e78 347 for ($i = 0 ; $i < $cnt ; $i++) {
5d2a7b15 348 $sKey = substr($header[$i],0,strpos($header[$i],':'));
349 switch ($sKey)
350 {
351 case 'Message-ID':
352 case 'In-Reply_To':
353 $hdr_s .= $header[$i];
354 break;
355 case 'References':
356 $sRefs = substr($header[$i],12);
357 $aRefs = explode(' ',$sRefs);
358 $sLine = 'References:';
359 foreach ($aRefs as $sReference) {
360 if (strlen($sLine)+strlen($sReference) >76) {
361 $hdr_s .= $sLine;
362 $sLine = $rn . ' ' . $sReference;
363 } else {
364 $sLine .= ' '. $sReference;
365 }
366 }
367 $hdr_s .= $sLine;
368 break;
369 default: $hdr_s .= $this->foldLine($header[$i], 78, str_pad('',4)); break;
370 }
78f39e78 371 }
c422e824 372
78f39e78 373 $header = $hdr_s;
374 $header .= $rn; /* One blank line to separate header and body */
375 $raw_length += strlen($header);
376 return $header;
4960ec8e 377 }
378
379 /*
380 * function for cleanly folding of headerlines
381 */
1274f430 382 function foldLine($line, $length, $pre='') {
e4f9307a 383 $line = substr($line,0, -2);
fb1d6cb6 384 $length -= 2; /* do not fold between \r and \n */
385 $cnt = strlen($line);
386 if ($cnt > $length) { /* try folding */
387 $fold_string = "\r\n " . $pre;
388 $bFirstFold = false;
389 $aFoldLine = array();
390 while (strlen($line) > $length) {
391 $fold = false;
392 /* handle encoded parts */
223872cb 393 if (preg_match('/(=\?([^?]*)\?(Q|B)\?([^?]*)\?=)(.*)/Ui',$line,$regs)) {
fb1d6cb6 394 $fold_tmp = $regs[1];
395 $iPosEnc = strpos($line,$fold_tmp);
396 $iLengthEnc = strlen($fold_tmp);
c422e824 397 $iPosEncEnd = $iPosEnc+$iLengthEnc;
398 if ($iPosEnc < $length && (($iPosEncEnd) > $length)) {
fb1d6cb6 399 $fold = true;
400 /* fold just before the start of the encoded string */
401 $aFoldLine[] = substr($line,0,$iPosEnc);
402 $line = substr($line,$iPosEnc);
403 if (!$bFirstFold) {
404 $bFirstFold = true;
405 $length -= strlen($fold_string);
406 }
407 if ($iLengthEnc > $length) { /* place the encoded
408 string on a separate line and do not fold inside it*/
223872cb 409 /* minimize foldstring */
410 $fold_string = "\r\n ";
411 $aFoldLine[] = substr($line,0,$iLengthEnc);
412 $line = substr($line,$iLengthEnc);
413 }
c422e824 414 } else if ($iPosEnc < $length) { /* the encoded string fits into the foldlength */
fb1d6cb6 415 /*remainder */
fb1d6cb6 416 $sLineRem = substr($line,$iPosEncEnd,$length - $iPosEncEnd);
c422e824 417 if (preg_match('/^(=\?([^?]*)\?(Q|B)\?([^?]*)\?=)(.*)/Ui',$sLineRem) || !preg_match('/[=,;\s]/',$sLineRem)) {
fb1d6cb6 418 /*impossible to fold clean in the next part -> fold after the enc string */
419 $aFoldLine[] = substr($line,0,$iPosEncEnd+1);
420 $line = substr($line,$iPosEncEnd+1);
421 $fold = true;
422 if (!$bFirstFold) {
423 $bFirstFold = true;
424 $length -= strlen($fold_string);
425 }
223872cb 426 }
fb1d6cb6 427 }
428 }
429 if (!$fold) {
430 $line_tmp = substr($line,0,$length);
431 $iFoldPos = false;
432 /* try to fold at logical places */
433 switch (true)
434 {
435 case ($iFoldPos = strrpos($line_tmp,',')): break;
436 case ($iFoldPos = strrpos($line_tmp,';')): break;
437 case ($iFoldPos = strrpos($line_tmp,' ')): break;
438 case ($iFoldPos = strrpos($line_tmp,'=')): break;
439 default: break;
440 }
441
442 if (!$iFoldPos) { /* clean folding didn't work */
443 $iFoldPos = $length;
444 }
445 $aFoldLine[] = substr($line,0,$iFoldPos+1);
446 $line = substr($line,$iFoldPos+1);
447 if (!$bFirstFold) {
448 $bFirstFold = true;
449 $length -= strlen($fold_string);
450 }
451 }
452 }
453 /*$reconstruct the line */
454 if ($line) {
455 $aFoldLine[] = $line;
456 }
457 $line = implode($fold_string,$aFoldLine);
458 }
223872cb 459
fb1d6cb6 460 return $line."\r\n";
461 }
3b53d87f 462
59387d1c 463 function mimeBoundary () {
78f39e78 464 static $mimeBoundaryString;
3b53d87f 465
78f39e78 466 if ( !isset( $mimeBoundaryString ) ||
467 $mimeBoundaryString == '') {
468 $mimeBoundaryString = '----=_' . date( 'YmdHis' ) . '_' .
469 mt_rand( 10000, 99999 );
470 }
471 return $mimeBoundaryString;
3b53d87f 472 }
473
59387d1c 474 /* Time offset for correct timezone */
475 function timezone () {
78f39e78 476 global $invert_time;
477
478 $diff_second = date('Z');
479 if ($invert_time) {
480 $diff_second = - $diff_second;
481 }
482 if ($diff_second > 0) {
483 $sign = '+';
484 } else {
485 $sign = '-';
486 }
487 $diff_second = abs($diff_second);
488 $diff_hour = floor ($diff_second / 3600);
489 $diff_minute = floor (($diff_second-3600*$diff_hour) / 60);
490 $zonename = '('.strftime('%Z').')';
491 $result = sprintf ("%s%02d%02d %s", $sign, $diff_hour, $diff_minute,
3b53d87f 492 $zonename);
78f39e78 493 return ($result);
59387d1c 494 }
3b53d87f 495
1274f430 496 function calculate_references($hdr) {
497 $refer = $hdr->references;
78f39e78 498 $message_id = $hdr->message_id;
499 $in_reply_to = $hdr->in_reply_to;
500 if (strlen($refer) > 2) {
501 $refer .= ' ' . $message_id;
502 } else {
503 if ($in_reply_to) {
504 $refer .= $in_reply_to . ' ' . $message_id;
505 } else {
506 $refer .= $message_id;
507 }
508 }
509 trim($refer);
510 return $refer;
59387d1c 511 }
512}
4960ec8e 513?>