6 * Copyright (c) 2003 The SquirrelMail Project Team
7 * Licensed under the GNU GPL. For full terms see the file COPYING.
9 This contains functions needed to handle mime messages.
15 /** message is the object that contains messages. It is a recursive
16 object in that through the $entities variable, it can contain
17 more objects of type message. See documentation in mime.txt for
18 a better description of how this works.
20 var $rfc822_header = '',
28 $parent = '', $decoded_body='',
29 $is_seen = 0, $is_answered = 0, $is_deleted = 0, $is_flagged = 0,
32 $offset = 0, /* for fetching body parts out of raw messages */
33 $length = 0, /* for fetching body parts out of raw messages */
34 $att_local_name = ''; /* location where the tempory attachment
35 is stored. For future usage in smtp.php */
37 function setEnt($ent) {
38 $this->entity_id
= $ent;
41 function addEntity ($msg) {
42 $this->entities
[] = $msg;
45 function getFilename() {
47 $filename = $this->header
->getParameter('filename');
49 $filename = $this->header
->getParameter('name');
53 $filename = 'untitled-'.$this->entity_id
;
59 function addRFC822Header($read) {
60 $header = new Rfc822Header();
61 $this->rfc822_header
= $header->parseHeader($read);
64 function getEntity($ent) {
65 $cur_ent = $this->entity_id
;
67 if (($cur_ent == '') ||
($cur_ent == '0')) {
70 $cur_ent_a = explode('.', $this->entity_id
);
72 $ent_a = explode('.', $ent);
74 for ($i = 0,$entCount = count($ent_a) - 1; $i < $entCount; ++
$i) {
75 if (isset($cur_ent_a[$i]) && ($cur_ent_a[$i] != $ent_a[$i])) {
77 $cur_ent_a = explode('.', $msg->entity_id
);
79 } else if (!isset($cur_ent_a[$i])) {
80 if (isset($msg->entities
[($ent_a[$i]-1)])) {
81 $msg = $msg->entities
[($ent_a[$i]-1)];
83 $msg = $msg->entities
[0];
86 if (($msg->type0
== 'message') && ($msg->type1
== 'rfc822')) {
87 /*this is a header for a message/rfc822 entity */
88 $msg = $msg->entities
[0];
92 if (($msg->type0
== 'message') && ($msg->type1
== 'rfc822')) {
93 /*this is a header for a message/rfc822 entity */
94 $msg = $msg->entities
[0];
97 if (isset($msg->entities
[($ent_a[$entCount])-1])) {
98 if (is_object($msg->entities
[($ent_a[$entCount])-1])) {
99 $msg = $msg->entities
[($ent_a[$entCount]-1)];
106 function setBody($s) {
107 $this->body_part
= $s;
110 function clean_up() {
112 $msg->body_part
= '';
114 foreach ($msg->entities
as $m) {
119 function getMailbox() {
121 while (is_object($msg->parent
)) {
124 return $msg->mailbox
;
128 * Bodystructure parser, a recursive function for generating the
129 * entity-tree with all the mime-parts.
131 * It follows RFC2060 and stores all the described fields in the
136 * Ask for me (Marc Groot Koerkamp, stekkel@users.sourceforge.net)
139 function parseStructure($read, &$i, $sub_msg = '') {
140 $msg = Message
::parseBodyStructure($read, $i, $sub_msg);
141 if($msg) $msg->setEntIds($msg,false,0);
145 function setEntIds(&$msg,$init=false,$i=0) {
146 $iCnt = count($msg->entities
);
147 if ($init !==false) {
149 if ($msg->parent
->type0
== 'message' &&
150 $msg->parent
->type1
== 'rfc822' &&
151 $msg->type0
== 'multipart') {
155 $msg->entity_id
= "$init.$iEntSub";
157 $msg->entity_id
= $iEntSub;
164 for ($i=0;$i<$iCnt;++
$i) {
165 $msg->entities
[$i]->parent
=& $msg;
166 if (strrchr($msg->entity_id
, '.') != '.0') {
167 $msg->entities
[$i]->setEntIds($msg->entities
[$i],$msg->entity_id
,$i);
169 $msg->entities
[$i]->setEntIds($msg->entities
[$i],$msg->parent
->entity_id
,$i);
174 function parseBodyStructure($read, &$i, $sub_msg = '') {
180 $message = new Message();
183 for ($cnt = strlen($read); $i < $cnt; ++
$i) {
184 $char = strtoupper($read{$i});
190 $msg = new Message();
191 $hdr = new MessageHeader();
192 $hdr->type0
= 'text';
193 $hdr->type1
= 'plain';
194 $hdr->encoding
= 'us-ascii';
196 $msg->header
->type0
= 'multipart';
197 $msg->type0
= 'multipart';
198 while ($read{$i} == '(') {
199 $msg->addEntity($this->parseBodyStructure($read, $i, $msg));
204 /* multipart properties */
206 $arg_a[] = $this->parseProperties($read, $i);
210 if (isset($msg->type0
) && ($msg->type0
== 'multipart')) {
212 $arg_a[] = $this->parseDisposition($read, $i);
213 } else { /* properties */
214 $arg_a[] = $this->parseProperties($read, $i);
219 if (isset($msg->type0
) && ($msg->type0
== 'multipart')) {
221 $arg_a[]= $this->parseLanguage($read, $i);
224 if (($arg_a[0] == 'message') && ($arg_a[1] == 'rfc822')) {
225 $msg->header
->type0
= $arg_a[0];
226 $msg->header
->type1
= $arg_a[1];
227 $msg->type0
= $arg_a[0];
228 $msg->type1
= $arg_a[1];
229 $rfc822_hdr = new Rfc822Header();
230 $msg->rfc822_header
= $this->parseEnvelope($read, $i, $rfc822_hdr);
231 while (($i < $cnt) && ($read{$i} != '(')) {
234 $msg->addEntity($this->parseBodyStructure($read, $i,$msg));
239 $arg_a[] = $this->parseDisposition($read, $i);
244 if (($arg_a[0] == 'text') ||
(($arg_a[0] == 'message') && ($arg_a[1] == 'rfc822'))) {
245 $arg_a[] = $this->parseDisposition($read, $i);
247 $arg_a[] = $this->parseLanguage($read, $i);
252 if (($arg_a[0] == 'text') ||
(($arg_a[0] == 'message') && ($arg_a[1] == 'rfc822'))) {
254 $arg_a[] = $this->parseLanguage($read, $i);
256 $i = $this->parseParenthesis($read, $i);
257 $arg_a[] = ''; /* not yet described in rfc2060 */
262 /* unknown argument, skip this part */
263 $i = $this->parseParenthesis($read, $i);
270 /* inside an entity -> start processing */
271 $arg_s = $this->parseQuote($read, $i);
274 $arg_s = strtolower($arg_s); /* type0 and type1 */
280 /* probably NIL argument */
281 $tmpnil = strtoupper(substr($read, $i, 4));
282 if ($tmpnil == 'NIL ' ||
$tmpnil == 'NIL)') {
289 /* process the literal value */
290 $arg_a[] = $this->parseLiteral($read, $i);
294 case is_numeric($read{$i}):
295 /* process integers */
296 if ($read{$i} == ' ') { break; }
298 if (preg_match('/^([0-9]+).*/',substr($read,$i), $regs)) {
299 $i +
= strlen($regs[1])-1;
306 $multipart = (isset($msg->type0
) && ($msg->type0
== 'multipart'));
308 $shifted_args = (($arg_a[0] == 'text') ||
(($arg_a[0] == 'message') && ($arg_a[1] == 'rfc822')));
309 $hdr->type0
= $arg_a[0];
310 $hdr->type1
= $arg_a[1];
312 $msg->type0
= $arg_a[0];
313 $msg->type1
= $arg_a[1];
315 if (is_array($arr)) {
316 $hdr->parameters
= $arg_a[2];
318 $hdr->id
= str_replace('<', '', str_replace('>', '', $arg_a[3]));
319 $hdr->description
= $arg_a[4];
320 $hdr->encoding
= strtolower($arg_a[5]);
321 $hdr->entity_id
= $msg->entity_id
;
322 $hdr->size
= $arg_a[6];
324 $hdr->lines
= $arg_a[7];
329 $hdr->md5
= (isset($arg_a[7+
$s]) ?
$arg_a[7+
$s] : $hdr->md5
);
330 $hdr->disposition
= (isset($arg_a[8+
$s]) ?
$arg_a[8+
$s] : $hdr->disposition
);
331 $hdr->language
= (isset($arg_a[9+
$s]) ?
$arg_a[9+
$s] : $hdr->language
);
334 $hdr->type0
= 'multipart';
335 $hdr->type1
= $arg_a[0];
336 $msg->type0
= 'multipart';
337 $msg->type1
= $arg_a[0];
338 $hdr->parameters
= (isset($arg_a[1]) ?
$arg_a[1] : $hdr->parameters
);
339 $hdr->disposition
= (isset($arg_a[2]) ?
$arg_a[2] : $hdr->disposition
);
340 $hdr->language
= (isset($arg_a[3]) ?
$arg_a[3] : $hdr->language
);
347 } /* parsestructure */
349 function parseProperties($read, &$i) {
350 $properties = array();
353 for (; $read{$i} != ')'; ++
$i) {
355 if ($read{$i} == '"') {
356 $arg_s = $this->parseQuote($read, $i);
357 } else if ($read{$i} == '{') {
358 $arg_s = $this->parseLiteral($read, $i);
362 if ($prop_name == '') {
363 $prop_name = strtolower($arg_s);
364 $properties[$prop_name] = '';
365 } else if ($prop_name != '') {
366 $properties[$prop_name] = $arg_s;
374 function parseEnvelope($read, &$i, $hdr) {
378 for ($cnt = strlen($read); ($i < $cnt) && ($read{$i} != ')'); ++
$i) {
379 $char = strtoupper($read{$i});
382 $arg_a[] = $this->parseQuote($read, $i);
386 $arg_a[] = $this->parseLiteral($read, $i);
387 /* temp bugfix (SM 1.5 will have a working clean version)
388 too much work to implement that version right now */
393 /* probably NIL argument */
394 if (strtoupper(substr($read, $i, 3)) == 'NIL') {
401 /* Address structure (with group support)
402 * Note: Group support is useless on SMTP connections
403 * because the protocol doesn't support it
408 for (; $i < $cnt && $read{$i} != ')'; ++
$i) {
409 if ($read{$i} == '(') {
410 $addr = $this->parseAddress($read, $i);
411 if (($addr->host
== '') && ($addr->mailbox
!= '')) {
413 $group = $addr->mailbox
;
416 } else if ($group && ($addr->host
== '') && ($addr->mailbox
== '')) {
418 if ($a == ($j+
1)) { /* no group members */
419 $group_addr->group
= $group;
420 $group_addr->mailbox
= '';
421 $group_addr->personal
= "$group: Undisclosed recipients;";
422 $addr_a[] = $group_addr;
426 $addr->group
= $group;
438 if (count($arg_a) > 9) {
439 $d = strtr($arg_a[0], array(' ' => ' '));
440 $d = explode(' ', $d);
441 if (!$arg_a[1]) $arg_1[1] = _("(no subject)");
443 $hdr->date
= getTimeStamp($d); /* argument 1: date */
444 $hdr->subject
= $arg_a[1]; /* argument 2: subject */
445 $hdr->from
= is_array($arg_a[2]) ?
$arg_a[2][0] : ''; /* argument 3: from */
446 $hdr->sender
= is_array($arg_a[3]) ?
$arg_a[3][0] : ''; /* argument 4: sender */
447 $hdr->replyto
= is_array($arg_a[4]) ?
$arg_a[4][0] : ''; /* argument 5: reply-to */
448 $hdr->to
= $arg_a[5]; /* argument 6: to */
449 $hdr->cc
= $arg_a[6]; /* argument 7: cc */
450 $hdr->bcc
= $arg_a[7]; /* argument 8: bcc */
451 $hdr->inreplyto
= $arg_a[8]; /* argument 9: in-reply-to */
452 $hdr->message_id
= $arg_a[9]; /* argument 10: message-id */
457 function parseLiteral($read, &$i) {
460 $iPos = strpos($read,'}',$i);
462 $lit_cnt = substr($read, $i, $iPos - $i);
463 $i +
= strlen($lit_cnt) +
3; /* skip } + \r + \n */
464 /* Now read the literal */
465 $s = ($lit_cnt ?
substr($read,$i,$lit_cnt): '');
467 /* temp bugfix (SM 1.5 will have a working clean version)
468 too much work to implement that version right now */
470 } else { /* should never happen */
471 $i +
= 3; /* } + \r + \n */
477 function parseQuote($read, &$i) {
481 $iPos = strpos($read,'"',$iPos);
483 if ($iPos && $read{$iPos -1} != '\\') {
484 $s = substr($read,$i,($iPos-$i));
489 if ($iPos > strlen($read)) {
496 function parseAddress($read, &$i) {
498 for (; $read{$i} != ')'; ++
$i) {
499 $char = strtoupper($read{$i});
501 case '"': $arg_a[] = $this->parseQuote($read, $i); break;
502 case '{': $arg_a[] = $this->parseLiteral($read, $i); break;
505 if (strtoupper(substr($read, $i, 3)) == 'NIL') {
514 if (count($arg_a) == 4) {
515 $adr = new AddressStructure();
516 $adr->personal
= $arg_a[0];
517 $adr->adl
= $arg_a[1];
518 $adr->mailbox
= $arg_a[2];
519 $adr->host
= $arg_a[3];
526 function parseDisposition($read, &$i) {
528 for (; $read{$i} != ')'; ++
$i) {
530 case '"': $arg_a[] = $this->parseQuote($read, $i); break;
531 case '{': $arg_a[] = $this->parseLiteral($read, $i); break;
532 case '(': $arg_a[] = $this->parseProperties($read, $i); break;
537 if (isset($arg_a[0])) {
538 $disp = new Disposition($arg_a[0]);
539 if (isset($arg_a[1])) {
540 $disp->properties
= $arg_a[1];
544 return (is_object($disp) ?
$disp : '');
547 function parseLanguage($read, &$i) {
548 /* no idea how to process this one without examples */
551 for (; $read{$i} != ')'; ++
$i) {
553 case '"': $arg_a[] = $this->parseQuote($read, $i); break;
554 case '{': $arg_a[] = $this->parseLiteral($read, $i); break;
555 case '(': $arg_a[] = $this->parseProperties($read, $i); break;
560 if (isset($arg_a[0])) {
561 $lang = new Language($arg_a[0]);
562 if (isset($arg_a[1])) {
563 $lang->properties
= $arg_a[1];
567 return (is_object($lang) ?
$lang : '');
570 function parseParenthesis($read, $i) {
571 for (; $read{$i} != ')'; ++
$i) {
573 case '"': $this->parseQuote($read, $i); break;
574 case '{': $this->parseLiteral($read, $i); break;
575 case '(': $this->parseProperties($read, $i); break;
582 /* Function to fill the message structure in case the */
583 /* bodystructure is not available NOT FINISHED YET */
584 function parseMessage($read, $type0, $type1) {
587 $rfc822_header = true;
588 $mime_header = false;
591 $rfc822_header = false;
594 default: return $read;
597 for ($i = 1; $i < $count; ++
$i) {
598 $line = trim($body[$i]);
599 if (($mime_header ||
$rfc822_header) &&
600 (preg_match("/^.*boundary=\"?(.+(?=\")|.+).*/i", $line, $reg))) {
603 $bndreg = str_replace("\\", "\\\\", $bndreg);
604 $bndreg = str_replace("?", "\\?", $bndreg);
605 $bndreg = str_replace("+", "\\+", $bndreg);
606 $bndreg = str_replace(".", "\\.", $bndreg);
607 $bndreg = str_replace("/", "\\/", $bndreg);
608 $bndreg = str_replace("-", "\\-", $bndreg);
609 $bndreg = str_replace("(", "\\(", $bndreg);
610 $bndreg = str_replace(")", "\\)", $bndreg);
611 } else if ($rfc822_header && $line == '') {
612 $rfc822_header = false;
613 if ($msg->type0
== 'multipart') {
618 if ((($line{0} == '-') ||
$rfc822_header) && isset($boundaries[0])) {
619 $cnt = count($boundaries)-1;
620 $bnd = $boundaries[$cnt]['bnd'];
621 $bndreg = $boundaries[$cnt]['bndreg'];
623 $regstr = '/^--'."($bndreg)".".*".'/';
624 if (preg_match($regstr, $line, $reg)) {
625 $bndlen = strlen($reg[1]);
627 if (strlen($line) > ($bndlen +
3)) {
628 if (($line{$bndlen+
2} == '-') && ($line{$bndlen+
3} == '-')) {
633 /* calc offset and return $msg */
634 //$entStr = CalcEntity("$entStr", -1);
635 array_pop($boundaries);
641 //$entStr = CalcEntity("$entStr", 0);
651 function findDisplayEntity($entity = array(), $alt_order = array('text/plain', 'text/html'), $strict=false) {
653 if ($this->type0
== 'multipart') {
654 if($this->type1
== 'alternative') {
655 $msg = $this->findAlternativeEntity($alt_order);
656 if (count($msg->entities
) == 0) {
657 $entity[] = $msg->entity_id
;
659 $entity = $msg->findDisplayEntity($entity, $alt_order, $strict);
662 } else if ($this->type1
== 'related') { /* RFC 2387 */
663 $msgs = $this->findRelatedEntity();
664 foreach ($msgs as $msg) {
665 if (count($msg->entities
) == 0) {
666 $entity[] = $msg->entity_id
;
668 $entity = $msg->findDisplayEntity($entity, $alt_order, $strict);
671 if (count($msgs) > 0) {
674 } else { /* Treat as multipart/mixed */
675 foreach ($this->entities
as $ent) {
676 if((strtolower($ent->header
->disposition
->name
) != 'attachment') &&
677 (!isset($ent->header
->parameters
['filename'])) &&
678 (!isset($ent->header
->parameters
['name'])) &&
679 (($ent->type0
!= 'message') && ($ent->type1
!= 'rfc822'))) {
680 $entity = $ent->findDisplayEntity($entity, $alt_order, $strict);
685 } else { /* If not multipart, then just compare with each entry from $alt_order */
686 $type = $this->type0
.'/'.$this->type1
;
687 // $alt_order[] = "message/rfc822";
688 foreach ($alt_order as $alt) {
689 if( ($alt == $type) && isset($this->entity_id
) ) {
690 if ((count($this->entities
) == 0) &&
691 (!isset($ent->header
->parameters
['filename'])) &&
692 (!isset($ent->header
->parameters
['name'])) &&
693 (strtolower($this->header
->disposition
->name
) != 'attachment')) {
694 $entity[] = $this->entity_id
;
701 foreach ($this->entities
as $ent) {
702 if((strtolower($ent->header
->disposition
->name
) != 'attachment') &&
703 (($ent->type0
!= 'message') && ($ent->type1
!= 'rfc822'))) {
704 $entity = $ent->findDisplayEntity($entity, $alt_order, $strict);
709 if(!$strict && !$found) {
710 if (($this->type0
== 'text') &&
711 in_array($this->type1
, array('plain', 'html', 'message')) &&
712 isset($this->entity_id
)) {
713 if (count($this->entities
) == 0) {
714 if (strtolower($this->header
->disposition
->name
) != 'attachment') {
715 $entity[] = $this->entity_id
;
723 function findAlternativeEntity($alt_order) {
724 /* If we are dealing with alternative parts then we */
725 /* choose the best viewable message supported by SM. */
728 foreach($this->entities
as $ent) {
729 $type = $ent->header
->type0
. '/' . $ent->header
->type1
;
730 if ($type == 'multipart/related') {
731 $type = $ent->header
->getParameter('type');
732 // Mozilla bug. Mozilla does not provide the parameter type.
733 if (!$type) $type = 'text/html';
735 $altCount = count($alt_order);
736 for ($j = $best_view; $j < $altCount; ++
$j) {
737 if (($alt_order[$j] == $type) && ($j >= $best_view)) {
747 function findRelatedEntity() {
749 $related_type = $this->header
->getParameter('type');
750 // Mozilla bug. Mozilla does not provide the parameter type.
751 if (!$related_type) $related_type = 'text/html';
752 $entCount = count($this->entities
);
753 for ($i = 0; $i < $entCount; ++
$i) {
754 $type = $this->entities
[$i]->header
->type0
.'/'.$this->entities
[$i]->header
->type1
;
755 if ($related_type == $type) {
756 $msgs[] = $this->entities
[$i];
762 function getAttachments($exclude_id=array(), $result = array()) {
764 if (($this->type0 == 'message') &&
765 ($this->type1 == 'rfc822') &&
766 ($this->entity_id) ) {
767 $this = $this->entities[0];
770 if (count($this->entities
)) {
771 foreach ($this->entities
as $entity) {
773 foreach ($exclude_id as $excl) {
774 if ($entity->entity_id
=== $excl) {
780 if (($entity->type0
== 'multipart') &&
781 ($entity->type1
!= 'related')) {
782 $result = $entity->getAttachments($exclude_id, $result);
783 } else if ($entity->type0
!= 'multipart') {
790 foreach ($exclude_id as $excl) {
791 $exclude = $exclude ||
($this->entity_id
== $excl);
801 function initAttachment($type, $name, $location) {
802 $attachment = new Message();
803 $mime_header = new MessageHeader();
804 $mime_header->setParameter('name', $name);
805 $pos = strpos($type, '/');
807 $mime_header->type0
= substr($type, 0, $pos);
808 $mime_header->type1
= substr($type, $pos+
1);
810 $mime_header->type0
= $type;
812 $attachment->att_local_name
= $location;
813 $disposition = new Disposition('attachment');
814 $disposition->properties
['filename'] = $name;
815 $mime_header->disposition
= $disposition;
816 $attachment->mime_header
= $mime_header;
817 $this->entities
[]=$attachment;