4 ** This contains the functions necessary to detect and decode MIME
10 if (defined('mime_php'))
12 define('mime_php', true);
17 require_once('../functions/imap.php');
19 /** Setting up the objects that have the structure for the message **/
22 /** msg_header contains generic variables for values that **/
23 /** could be in a header. **/
25 var $type0 = '', $type1 = '', $boundary = '', $charset = '';
26 var $encoding = '', $size = 0, $to = array(), $from = '', $date = '';
27 var $cc = array(), $bcc = array(), $reply_to = '', $subject = '';
28 var $id = 0, $mailbox = '', $description = '', $filename = '';
29 var $entity_id = 0, $message_id = 0, $name = '';
33 /** message is the object that contains messages. It is a recursive
34 object in that through the $entities variable, it can contain
35 more objects of type message. See documentation in mime.txt for
36 a better description of how this works.
39 var $entities = array();
41 function addEntity ($msg) {
42 $this->entities
[] = $msg;
48 /* --------------------------------------------------------------------------------- */
50 /* --------------------------------------------------------------------------------- */
52 // This function gets the structure of a message and stores it in the "message" class.
53 // It will return this object for use with all relevant header information and
54 // fully parsed into the standard "message" object format.
55 function mime_structure ($imap_stream, $header) {
57 sqimap_messages_flag ($imap_stream, $header->id
, $header->id
, "Seen");
60 fputs ($imap_stream, sqimap_session_id() . " FETCH $id BODYSTRUCTURE\r\n");
62 // This should use sqimap_read_data instead of reading it itself
64 $sid = sqimap_session_id();
65 $lsid = strlen( $sid );
66 $read = fgets ($imap_stream, 10000);
68 while( substr($read, 0, $lsid) <> $sid && !feof( $imap_stream ) ) {
69 $bodystructure .= $read;
70 $read = fgets ($imap_stream, 10000);
72 $read = $bodystructure;
74 if ($debug_mime) echo "<tt>$read</tt><br><br>\n";
75 // isolate the body structure and remove beginning and end parenthesis
76 $read = trim(substr ($read, strpos(strtolower($read), "bodystructure") +
13));
77 $read = trim(substr ($read, 0, -1));
78 $end = mime_match_parenthesis(0, $read);
79 while ($end == strlen($read)-1) {
80 $read = trim(substr ($read, 0, -1));
81 $read = trim(substr ($read, 1));
82 $end = mime_match_parenthesis(0, $read);
85 if ($debug_mime) echo "<tt>$read</tt><br><br>\n";
87 $msg = mime_parse_structure ($read, 0);
88 $msg->header
= $header;
92 // this starts the parsing of a particular structure. It is called recursively,
93 // so it can be passed different structures. It returns an object of type
95 // First, it checks to see if it is a multipart message. If it is, then it
96 // handles that as it sees is necessary. If it is just a regular entity,
97 // then it parses it and adds the necessary header information (by calling out
98 // to mime_get_elements()
99 function mime_parse_structure ($structure, $ent_id) {
101 if ($debug_mime) echo "<font color=008800><tt>START: mime_parse_structure()</tt></font><br>\n";
102 $msg = new message();
103 if (substr($structure, 0, 1) == "(") {
104 $ent_id = mime_new_element_level($ent_id);
106 if ($debug_mime) echo "<br><font color=0000aa><tt>$structure</tt></font><br>";
108 if ($debug_mime) echo "<font color=008800><tt>Found entity...</tt></font><br>";
110 $end = mime_match_parenthesis ($start, $structure);
112 $element = substr($structure, $start+
1, ($end - $start)-1);
113 $ent_id = mime_increment_id ($ent_id);
114 $newmsg = mime_parse_structure ($element, $ent_id);
115 $msg->addEntity ($newmsg);
116 } while (substr($structure, $end+
1, 1) == "(");
118 // parse the elements
119 if ($debug_mime) echo "<br><font color=0000aa><tt>$structure</tt></font><br>";
120 $msg = mime_get_element ($structure, $msg, $ent_id);
121 if ($debug_mime) echo "<br>";
123 if ($debug_mime) echo "<font color=008800><tt> END: mime_parse_structure()</tt></font><br>";
127 // Increments the element ID. An element id can look like any of
128 // the following: 1, 1.2, 4.3.2.4.1, etc. This function increments
129 // the last number of the element id, changing 1.2 to 1.3.
130 function mime_increment_id ($id) {
132 if (strpos($id, ".")) {
133 $first = substr($id, 0, strrpos($id, "."));
134 $last = substr($id, strrpos($id, ".")+
1);
136 $new = $first . "." .$last;
140 if ($debug_mime) echo "<b>INCREMENT: $new</b><br>";
144 // See comment for mime_increment_id().
145 // This adds another level on to the entity_id changing 1.3 to 1.3.0
146 // NOTE: 1.3.0 is not a valid element ID. It MUST be incremented
147 // before it can be used. I left it this way so as not to have
148 // to make a special case if it is the first entity_id. It
149 // always increments it, and that works fine.
150 function mime_new_element_level ($id) {
152 else $id = $id . ".0";
157 function mime_get_element (&$structure, $msg, $ent_id) {
160 $msg->header
= new msg_header();
161 $msg->header
->entity_id
= $ent_id;
162 $properties = array();
164 while (strlen($structure) > 0) {
165 $structure = trim($structure);
166 $char = substr($structure, 0, 1);
168 if (strtolower(substr($structure, 0, 3)) == "nil") {
170 $structure = substr($structure, 3);
171 } else if ($char == "\"") {
172 // loop through until we find the matching quote, and return that as a string
174 $char = substr($structure, $pos, 1);
176 while ($char != "\"" && $pos < strlen($structure)) {
179 $char = substr($structure, $pos, 1);
181 $structure = substr($structure, strlen($text) +
2);
182 } else if ($char == "(") {
184 $end = mime_match_parenthesis (0, $structure);
185 $sub = substr($structure, 1, $end-1);
186 $properties = mime_get_props($properties, $sub);
187 $structure = substr($structure, strlen($sub) +
2);
189 // loop through until we find a space or an end parenthesis
191 $char = substr($structure, $pos, 1);
193 while ($char != " " && $char != ")" && $pos < strlen($structure)) {
196 $char = substr($structure, $pos, 1);
198 $structure = substr($structure, strlen($text));
200 if ($debug_mime) echo "<tt>$elem_num : $text</tt><br>";
202 // This is where all the text parts get put into the header
205 $msg->header
->type0
= strtolower($text);
206 if ($debug_mime) echo "<tt>type0 = ".strtolower($text)."</tt><br>";
209 $msg->header
->type1
= strtolower($text);
210 if ($debug_mime) echo "<tt>type1 = ".strtolower($text)."</tt><br>";
213 $msg->header
->description
= $text;
214 if ($debug_mime) echo "<tt>description = $text</tt><br>";
217 $msg->header
->encoding
= strtolower($text);
218 if ($debug_mime) echo "<tt>encoding = ".strtolower($text)."</tt><br>";
221 $msg->header
->size
= $text;
222 if ($debug_mime) echo "<tt>size = $text</tt><br>";
225 if ($msg->header
->type0
== "text" && $elem_num == 8) {
226 // This is a plain text message, so lets get the number of lines
228 $msg->header
->num_lines
= $text;
229 if ($debug_mime) echo "<tt>num_lines = $text</tt><br>";
231 } else if ($msg->header
->type0
== "message" && $msg->header
->type1
== "rfc822" && $elem_num == 8) {
232 // This is an encapsulated message, so lets start all over again and
233 // parse this message adding it on to the existing one.
234 $structure = trim($structure);
235 if (substr($structure, 0, 1) == "(") {
236 $e = mime_match_parenthesis (0, $structure);
237 $structure = substr($structure, 0, $e);
238 $structure = substr($structure, 1);
239 $m = mime_parse_structure($structure, $msg->header
->entity_id
);
241 // the following conditional is there to correct a bug that wasn't
242 // incrementing the entity IDs correctly because of the special case
243 // that message/rfc822 is. This fixes it fine.
244 if (substr($structure, 1, 1) != "(")
245 $m->header
->entity_id
= mime_increment_id(mime_new_element_level($ent_id));
247 // Now we'll go through and reformat the results.
249 for ($i=0; $i < count($m->entities
); $i++
) {
250 $msg->addEntity($m->entities
[$i]);
263 // loop through the additional properties and put those in the various headers
264 if ($msg->header
->type0
!= "message") {
265 for ($i=0; $i < count($properties); $i++
) {
266 $msg->header
->{$properties[$i]["name"]} = $properties[$i]["value"];
267 if ($debug_mime) echo "<tt>".$properties[$i]["name"]." = " . $properties[$i]["value"] . "</tt><br>";
274 // I did most of the MIME stuff yesterday (June 20, 2000), but I couldn't
275 // figure out how to do this part, so I decided to go to bed. I woke up
276 // in the morning and had a flash of insight. I went to the white-board
277 // and scribbled it out, then spent a bit programming it, and this is the
278 // result. Nothing complicated, but I think my brain was fried yesterday.
279 // Funny how that happens some times.
281 // This gets properties in a nested parenthesisized list. For example,
282 // this would get passed something like: ("attachment" ("filename" "luke.tar.gz"))
283 // This returns an array called $props with all paired up properties.
284 // It ignores the "attachment" for now, maybe that should change later
285 // down the road. In this case, what is returned is:
286 // $props[0]["name"] = "filename";
287 // $props[0]["value"] = "luke.tar.gz";
288 function mime_get_props ($props, $structure) {
290 while (strlen($structure) > 0) {
291 $structure = trim($structure);
292 $char = substr($structure, 0, 1);
296 $char = substr($structure, $pos, 1);
298 while ($char != "\"" && $pos < strlen($structure)) {
301 $char = substr($structure, $pos, 1);
303 $structure = trim(substr($structure, strlen($tmp) +
2));
304 $char = substr($structure, 0, 1);
308 $char = substr($structure, $pos, 1);
310 while ($char != "\"" && $pos < strlen($structure)) {
313 $char = substr($structure, $pos, 1);
315 $structure = trim(substr($structure, strlen($tmp) +
2));
318 $props[$k]["name"] = strtolower($tmp);
319 $props[$k]["value"] = $value;
320 } else if ($char == "(") {
321 $end = mime_match_parenthesis (0, $structure);
322 $sub = substr($structure, 1, $end-1);
325 $props = mime_get_props($props, $sub);
326 $structure = substr($structure, strlen($sub) +
2);
329 } else if ($char == "(") {
330 $end = mime_match_parenthesis (0, $structure);
331 $sub = substr($structure, 1, $end-1);
332 $props = mime_get_props($props, $sub);
333 $structure = substr($structure, strlen($sub) +
2);
341 // Matches parenthesis. It will return the position of the matching
342 // parenthesis in $structure. For instance, if $structure was:
343 // ("text" "plain" ("val1name", "1") nil ... )
345 // then this would return 42 to match up those two.
346 function mime_match_parenthesis ($pos, $structure) {
347 $char = substr($structure, $pos, 1);
349 // ignore all extra characters
350 // If inside of a string, skip string -- Boundary IDs and other
351 // things can have ) in them.
353 return strlen($structure);
354 while ($pos < strlen($structure)) {
356 $char = substr($structure, $pos, 1);
359 } else if ($char == '"') {
361 while (substr($structure, $pos, 1) != '"' &&
362 $pos < strlen($structure)) {
363 if (substr($structure, $pos, 2) == '\\"')
365 elseif (substr($structure, $pos, 2) == '\\\\')
369 } else if ($char == "(") {
370 $pos = mime_match_parenthesis ($pos, $structure);
373 echo "Error decoding mime structure. Report this as a bug!<br>\n";
377 function mime_fetch_body ($imap_stream, $id, $ent_id) {
378 // do a bit of error correction. If we couldn't find the entity id, just guess
379 // that it is the first one. That is usually the case anyway.
380 if (!$ent_id) $ent_id = 1;
382 fputs ($imap_stream, sqimap_session_id() . " FETCH $id BODY[$ent_id]\r\n");
383 $data = sqimap_read_data ($imap_stream, sqimap_session_id(), true, $response, $message);
384 $topline = array_shift($data);
385 while (! ereg('\\* [0-9]+ FETCH ', $topline) && $data)
386 $topline = array_shift($data);
387 $wholemessage = implode('', $data);
389 if (ereg('\\{([^\\}]*)\\}', $topline, $regs)) {
390 return substr($wholemessage, 0, $regs[1]);
392 else if (ereg('"([^"]*)"', $topline, $regs)) {
396 $str = "Body retrieval error. Please report this bug!\n" .
397 "Response: $response\n" .
398 "Message: $message\n" .
399 "FETCH line: $topline" .
400 "---------------\n$wholemessage";
401 foreach ($data as $d) {
402 $str .= htmlspecialchars($d) . "\n";
407 function mime_print_body_lines ($imap_stream, $id, $ent_id, $encoding) {
408 // do a bit of error correction. If we couldn't find the entity id, just guess
409 // that it is the first one. That is usually the case anyway.
410 if (!$ent_id) $ent_id = 1;
412 // Don't kill the connection if the browser is over a dialup
413 // and it would take over 30 seconds to download it.
416 fputs ($imap_stream, sqimap_session_id() . " FETCH $id BODY[$ent_id]\r\n");
419 $read = fgets ($imap_stream,4096);
420 // This could be bad -- if the section has sqimap_session_id() . ' OK'
421 // or similar, it will kill the download.
422 while (!ereg("^" . sqimap_session_id() . " (OK|BAD|NO)(.*)$", $read, $regs)) {
423 if (trim($read) == ")==") {
425 $read = fgets ($imap_stream,4096);
426 if (ereg("^" . sqimap_session_id() . " (OK|BAD|NO)(.*)$", $read, $regs)) {
429 echo decodeBody($read1, $encoding) .
430 decodeBody($read, $encoding);
433 echo decodeBody($read, $encoding);
435 $read = fgets ($imap_stream,4096);
440 /* -[ END MIME DECODING ]----------------------------------------------------------- */
444 /** This is the first function called. It decides if this is a multipart
445 message or if it should be handled as a single entity
447 function decodeMime ($imap_stream, &$header) {
448 global $username, $key, $imapServerAddress, $imapPort;
449 return mime_structure ($imap_stream, $header);
452 // This is here for debugging purposese. It will print out a list
453 // of all the entity IDs that are in the $message object.
454 function listEntities ($message) {
456 if ($message->header
->entity_id
)
457 echo "<tt>" . $message->header
->entity_id
. " : " . $message->header
->type0
. "/" . $message->header
->type1
. "<br>";
458 for ($i = 0; $message->entities
[$i]; $i++
) {
459 $msg = listEntities($message->entities
[$i], $ent_id);
466 // returns a $message object for a particular entity id
467 function getEntity ($message, $ent_id) {
469 if ($message->header
->entity_id
== $ent_id && strlen($ent_id) == strlen($message->header
->entity_id
)) {
472 for ($i = 0; isset($message->entities
[$i]); $i++
) {
473 $msg = getEntity ($message->entities
[$i], $ent_id);
481 // figures out what entity to display and returns the $message object
483 function findDisplayEntity ($message, $textOnly = 1)
485 global $show_html_default;
490 if ($message->header
->type0
== "multipart" &&
491 $message->header
->type1
== "alternative" &&
492 $show_html_default && ! $textOnly) {
493 $entity = findDisplayEntityHTML($message);
498 // Show text/plain or text/html -- the first one we find.
499 if ($message->header
->type0
== 'text' &&
500 ($message->header
->type1
== 'plain' ||
501 $message->header
->type1
== 'html') &&
502 isset($message->header
->entity_id
))
503 return $message->header
->entity_id
;
505 for ($i=0; isset($message->entities
[$i]); $i++
) {
506 $entity = findDisplayEntity($message->entities
[$i], $textOnly);
514 // Shows the HTML version
515 function findDisplayEntityHTML ($message) {
516 if ($message->header
->type0
== 'text' &&
517 $message->header
->type1
== 'html' &&
518 isset($message->header
->entity_id
))
519 return $message->header
->entity_id
;
520 for ($i = 0; isset($message->entities
[$i]); $i ++
) {
521 $entity = findDisplayEntityHTML($message->entities
[$i]);
528 /** This returns a parsed string called $body. That string can then
529 be displayed as the actual message in the HTML. It contains
530 everything needed, including HTML Tags, Attachments at the
533 function formatBody($imap_stream, $message, $color, $wrap_at) {
534 // this if statement checks for the entity to show as the
535 // primary message. To add more of them, just put them in the
536 // order that is their priority.
537 global $startMessage, $username, $key, $imapServerAddress, $imapPort,
540 $id = $message->header
->id
;
541 $urlmailbox = urlencode($message->header
->mailbox
);
543 // Get the right entity and redefine message to be this entity
544 // Pass the 0 to mean that we want the 'best' viewable one
545 $ent_num = findDisplayEntity ($message, 0);
546 $body_message = getEntity($message, $ent_num);
547 if (($body_message->header
->type0
== "text") ||
548 ($body_message->header
->type0
== "rfc822")) {
550 $body = mime_fetch_body ($imap_stream, $id, $ent_num);
551 $body = decodeBody($body, $body_message->header
->encoding
);
552 $hookResults = do_hook("message_body", $body);
553 $body = $hookResults[1];
555 // If there are other types that shouldn't be formatted, add
557 if ($body_message->header
->type1
!= "html" ||
! $show_html_default) {
558 translateText($body, $wrap_at, $body_message->header
->charset
);
561 $body .= "<SMALL><CENTER><A HREF=\"../src/download.php?absolute_dl=true&passed_id=$id&passed_ent_id=$ent_num&mailbox=$urlmailbox&showHeaders=1\">". _("Download this as a file") ."</A></CENTER><BR></SMALL>";
563 /** Display the ATTACHMENTS: message if there's more than one part **/
564 $body .= "</TD></TR></TABLE>";
565 if (isset($message->entities
[0])) {
566 $body .= formatAttachments ($message, $ent_num, $message->header
->mailbox
, $id);
568 $body .= "</TD></TR></TABLE>";
570 $body = formatAttachments ($message, -1, $message->header
->mailbox
, $id);
575 // A recursive function that returns a list of attachments with links
576 // to where to download these attachments
577 function formatAttachments ($message, $ent_id, $mailbox, $id) {
578 global $where, $what;
579 global $startMessage, $color;
580 static $ShownHTML = 0;
587 $body .= "<TABLE WIDTH=100% CELLSPACING=0 CELLPADDING=2 BORDER=0 BGCOLOR=\"$color[0]\"><TR>\n";
588 $body .= "<TH ALIGN=\"left\" BGCOLOR=\"$color[9]\"><B>\n";
589 $body .= _("Attachments") . ':';
590 $body .= "</B></TH></TR><TR><TD>\n";
592 $body .= "<TABLE CELLSPACING=0 CELLPADDING=1 BORDER=0>\n";
594 $body .= formatAttachments ($message, $ent_id, $mailbox, $id);
596 $body .= "</TABLE></TD></TR></TABLE>";
602 if (!$message->entities
) {
603 $type0 = strtolower($message->header
->type0
);
604 $type1 = strtolower($message->header
->type1
);
605 $name = decodeHeader($message->header
->name
);
607 if ($message->header
->entity_id
!= $ent_id) {
608 $filename = decodeHeader($message->header
->filename
);
609 if (trim($filename) == "") {
610 if (trim($name) == "") {
611 $display_filename = "untitled-".$message->header
->entity_id
;
613 $display_filename = $name;
617 $display_filename = $filename;
620 $urlMailbox = urlencode($mailbox);
621 $ent = urlencode($message->header
->entity_id
);
624 "../src/download.php?startMessage=$startMessage&passed_id=$id&mailbox=$urlMailbox&passed_ent_id=$ent";
626 $DefaultLink .= '&where=' . urlencode($where) . '&what=' . urlencode($what);
627 $Links['download link']['text'] = _("download");
628 $Links['download link']['href'] =
629 "../src/download.php?absolute_dl=true&passed_id=$id&mailbox=$urlMailbox&passed_ent_id=$ent";
632 $HookResults = do_hook("attachment $type0/$type1", $Links,
633 $startMessage, $id, $urlMailbox, $ent, $DefaultLink,
634 $display_filename, $where, $what);
636 $Links = $HookResults[1];
637 $DefaultLink = $HookResults[6];
639 $body .= '<TR><TD> </TD><TD>';
640 $body .= "<A HREF=\"$DefaultLink\">$display_filename</A> </TD>";
641 $body .= '<TD><SMALL><b>' . show_readable_size($message->header
->size
) .
642 '</b> </small></TD>';
643 $body .= "<TD><SMALL>[ $type0/$type1 ] </SMALL></TD>";
644 $body .= '<TD><SMALL>';
645 if ($message->header
->description
)
646 $body .= '<b>' . htmlspecialchars($message->header
->description
) . '</b>';
647 $body .= '</SMALL></TD><TD><SMALL> ';
651 foreach ($Links as $Val)
659 $body .= ' | ';
661 $body .= '<a href="' . $Val['href'] . '">' . $Val['text'] . '</a>';
666 $body .= "</SMALL></TD></TR>\n";
670 for ($i = 0; $i < count($message->entities
); $i++
) {
671 $body .= formatAttachments ($message->entities
[$i], $ent_id, $mailbox, $id);
679 /** this function decodes the body depending on the encoding type. **/
680 function decodeBody($body, $encoding) {
681 $body = str_replace("\r\n", "\n", $body);
682 $encoding = strtolower($encoding);
684 global $show_html_default;
686 if ($encoding == "quoted-printable") {
687 $body = quoted_printable_decode($body);
689 while (ereg("=\n", $body))
690 $body = ereg_replace ("=\n", "", $body);
691 } else if ($encoding == "base64") {
692 $body = base64_decode($body);
695 // All other encodings are returned raw.
700 // This functions decode strings that is encoded according to
701 // RFC1522 (MIME Part Two: Message Header Extensions for Non-ASCII Text).
702 function decodeHeader ($string) {
703 if (eregi('=\\?([^?]+)\\?(q|b)\\?([^?]+)\\?=',
705 if (ucfirst($res[2]) == "B") {
706 $replace = base64_decode($res[3]);
708 $replace = ereg_replace("_", " ", $res[3]);
709 // Convert lowercase Quoted Printable to uppercase for
710 // quoted_printable_decode to understand it.
711 while (ereg("(=(([0-9][abcdef])|([abcdef][0-9])|([abcdef][abcdef])))", $replace, $res)) {
712 $replace = str_replace($res[1], strtoupper($res[1]), $replace);
714 $replace = quoted_printable_decode($replace);
717 $replace = charset_decode ($res[1], $replace);
719 // Remove the name of the character set.
720 $string = eregi_replace ('=\\?([^?]+)\\?(q|b)\\?([^?]+)\\?=',
723 // In case there should be more encoding in the string: recurse
724 return (decodeHeader($string));
729 // Encode a string according to RFC 1522 for use in headers if it
730 // contains 8-bit characters or anything that looks like it should
732 function encodeHeader ($string) {
733 global $default_charset;
735 // Encode only if the string contains 8-bit characters or =?
736 $j = strlen( $string );
737 $l = FALSE; // Must be encoded ?
739 for( $i=0; $i < $j; ++
$i) {
740 switch( $string{$i} ) {
755 $k = ord( $string{$i} );
757 $ret .= sprintf("=%02X", $k);
765 $string = "=?$default_charset?Q?$ret?=";