4 ** This contains the functions necessary to detect and decode MIME
13 if (!isset($i18n_php))
14 include "../functions/i18n.php";
15 if (!isset($imap_php))
16 include "../functions/imap.php";
17 if (!isset($config_php))
18 include "../config/config.php";
21 /** Setting up the objects that have the structure for the message **/
24 /** msg_header contains generic variables for values that **/
25 /** could be in a header. **/
27 var $type0 = '', $type1 = '', $boundary = '', $charset = '';
28 var $encoding = '', $size = 0, $to = array(), $from = '', $date = '';
29 var $cc = array(), $bcc = array(), $reply_to = '', $subject = '';
30 var $id = 0, $mailbox = '', $description = '', $filename = '';
31 var $entity_id = 0, $message_id = 0;
35 /** message is the object that contains messages. It is a recursive
36 object in that through the $entities variable, it can contain
37 more objects of type message. See documentation in mime.txt for
38 a better description of how this works.
43 function addEntity ($msg) {
44 $this->entities
[] = $msg;
50 /* --------------------------------------------------------------------------------- */
52 /* --------------------------------------------------------------------------------- */
54 // This function gets the structure of a message and stores it in the "message" class.
55 // It will return this object for use with all relevant header information and
56 // fully parsed into the standard "message" object format.
57 function mime_structure ($imap_stream, $header) {
59 sqimap_messages_flag ($imap_stream, $header->id
, $header->id
, "Seen");
62 fputs ($imap_stream, "a001 FETCH $id BODYSTRUCTURE\r\n");
64 // This should use sqimap_read_data instead of reading it itself
66 $read = fgets ($imap_stream, 10000);
67 $response = substr($read, 0, 4);
69 while ($response != "a001") {
70 $bodystructure .= $read;
71 $read = fgets ($imap_stream, 10000);
72 $response = substr($read, 0, 4);
74 $read = $bodystructure;
76 if ($debug_mime) echo "<tt>$read</tt><br><br>\n";
77 // isolate the body structure and remove beginning and end parenthesis
78 $read = trim(substr ($read, strpos(strtolower($read), "bodystructure") +
13));
79 $read = trim(substr ($read, 0, -1));
80 $end = mime_match_parenthesis(0, $read);
81 while ($end == strlen($read)-1) {
82 $read = trim(substr ($read, 0, -1));
83 $read = trim(substr ($read, 1));
84 $end = mime_match_parenthesis(0, $read);
87 if ($debug_mime) echo "<tt>$read</tt><br><br>\n";
89 $msg = mime_parse_structure ($read, 0);
90 $msg->header
= $header;
94 // this starts the parsing of a particular structure. It is called recursively,
95 // so it can be passed different structures. It returns an object of type
97 // First, it checks to see if it is a multipart message. If it is, then it
98 // handles that as it sees is necessary. If it is just a regular entity,
99 // then it parses it and adds the necessary header information (by calling out
100 // to mime_get_elements()
101 function mime_parse_structure ($structure, $ent_id) {
103 if ($debug_mime) echo "<font color=008800><tt>START: mime_parse_structure()</tt></font><br>\n";
104 $msg = new message();
105 if (substr($structure, 0, 1) == "(") {
106 $ent_id = mime_new_element_level($ent_id);
108 if ($debug_mime) echo "<br><font color=0000aa><tt>$structure</tt></font><br>";
110 if ($debug_mime) echo "<font color=008800><tt>Found entity...</tt></font><br>";
112 $end = mime_match_parenthesis ($start, $structure);
114 $element = substr($structure, $start+
1, ($end - $start)-1);
115 $ent_id = mime_increment_id ($ent_id);
116 $newmsg = mime_parse_structure ($element, $ent_id);
117 $msg->addEntity ($newmsg);
118 } while (substr($structure, $end+
1, 1) == "(");
120 // parse the elements
121 if ($debug_mime) echo "<br><font color=0000aa><tt>$structure</tt></font><br>";
122 $msg = mime_get_element ($structure, $msg, $ent_id);
123 if ($debug_mime) echo "<br>";
126 if ($debug_mime) echo "<font color=008800><tt> END: mime_parse_structure()</tt></font><br>";
129 // Increments the element ID. An element id can look like any of
130 // the following: 1, 1.2, 4.3.2.4.1, etc. This function increments
131 // the last number of the element id, changing 1.2 to 1.3.
132 function mime_increment_id ($id) {
134 if (strpos($id, ".")) {
135 $first = substr($id, 0, strrpos($id, "."));
136 $last = substr($id, strrpos($id, ".")+
1);
138 $new = $first . "." .$last;
142 if ($debug_mime) echo "<b>INCREMENT: $new</b><br>";
146 // See comment for mime_increment_id().
147 // This adds another level on to the entity_id changing 1.3 to 1.3.0
148 // NOTE: 1.3.0 is not a valid element ID. It MUST be incremented
149 // before it can be used. I left it this way so as not to have
150 // to make a special case if it is the first entity_id. It
151 // always increments it, and that works fine.
152 function mime_new_element_level ($id) {
154 else $id = $id . ".0";
159 function mime_get_element (&$structure, $msg, $ent_id) {
162 $msg->header
= new msg_header();
163 $msg->header
->entity_id
= $ent_id;
165 while (strlen($structure) > 0) {
166 $structure = trim($structure);
167 $char = substr($structure, 0, 1);
169 if (strtolower(substr($structure, 0, 3)) == "nil") {
171 $structure = substr($structure, 3);
172 } else if ($char == "\"") {
173 // loop through until we find the matching quote, and return that as a string
175 $char = substr($structure, $pos, 1);
177 while ($char != "\"" && $pos < strlen($structure)) {
180 $char = substr($structure, $pos, 1);
182 $structure = substr($structure, strlen($text) +
2);
183 } else if ($char == "(") {
185 $end = mime_match_parenthesis (0, $structure);
186 $sub = substr($structure, 1, $end-1);
187 if (! isset($properties))
188 $properties = array();
189 $properties = mime_get_props($properties, $sub);
190 $structure = substr($structure, strlen($sub) +
2);
192 // loop through until we find a space or an end parenthesis
194 $char = substr($structure, $pos, 1);
195 while ($char != " " && $char != ")" && $pos < strlen($structure)) {
198 $char = substr($structure, $pos, 1);
200 $structure = substr($structure, strlen($text));
202 if ($debug_mime) echo "<tt>$elem_num : $text</tt><br>";
204 // This is where all the text parts get put into the header
207 $msg->header
->type0
= strtolower($text);
208 if ($debug_mime) echo "<tt>type0 = ".strtolower($text)."</tt><br>";
211 $msg->header
->type1
= strtolower($text);
212 if ($debug_mime) echo "<tt>type1 = ".strtolower($text)."</tt><br>";
215 $msg->header
->description
= $text;
216 if ($debug_mime) echo "<tt>description = $text</tt><br>";
219 $msg->header
->encoding
= strtolower($text);
220 if ($debug_mime) echo "<tt>encoding = ".strtolower($text)."</tt><br>";
223 $msg->header
->size
= $text;
224 if ($debug_mime) echo "<tt>size = $text</tt><br>";
227 if ($msg->header
->type0
== "text" && $elem_num == 8) {
228 // This is a plain text message, so lets get the number of lines
230 $msg->header
->num_lines
= $text;
231 if ($debug_mime) echo "<tt>num_lines = $text</tt><br>";
233 } else if ($msg->header
->type0
== "message" && $msg->header
->type1
== "rfc822" && $elem_num == 8) {
234 // This is an encapsulated message, so lets start all over again and
235 // parse this message adding it on to the existing one.
236 $structure = trim($structure);
237 if (substr($structure, 0, 1) == "(") {
238 $e = mime_match_parenthesis (0, $structure);
239 $structure = substr($structure, 0, $e);
240 $structure = substr($structure, 1);
241 $m = mime_parse_structure($structure, $msg->header
->entity_id
);
243 // the following conditional is there to correct a bug that wasn't
244 // incrementing the entity IDs correctly because of the special case
245 // that message/rfc822 is. This fixes it fine.
246 if (substr($structure, 1, 1) != "(")
247 $m->header
->entity_id
= mime_increment_id(mime_new_element_level($ent_id));
249 // Now we'll go through and reformat the results.
251 for ($i=0; $i < count($m->entities
); $i++
) {
252 $msg->addEntity($m->entities
[$i]);
265 // loop through the additional properties and put those in the various headers
266 if ($msg->header
->type0
!= "message") {
267 for ($i=0; $i < count($properties); $i++
) {
268 $msg->header
->{$properties[$i]["name"]} = $properties[$i]["value"];
269 if ($debug_mime) echo "<tt>".$properties[$i]["name"]." = " . $properties[$i]["value"] . "</tt><br>";
276 // I did most of the MIME stuff yesterday (June 20, 2000), but I couldn't
277 // figure out how to do this part, so I decided to go to bed. I woke up
278 // in the morning and had a flash of insight. I went to the white-board
279 // and scribbled it out, then spent a bit programming it, and this is the
280 // result. Nothing complicated, but I think my brain was fried yesterday.
281 // Funny how that happens some times.
283 // This gets properties in a nested parenthesisized list. For example,
284 // this would get passed something like: ("attachment" ("filename" "luke.tar.gz"))
285 // This returns an array called $props with all paired up properties.
286 // It ignores the "attachment" for now, maybe that should change later
287 // down the road. In this case, what is returned is:
288 // $props[0]["name"] = "filename";
289 // $props[0]["value"] = "luke.tar.gz";
290 function mime_get_props ($props, $structure) {
292 while (strlen($structure) > 0) {
293 $structure = trim($structure);
294 $char = substr($structure, 0, 1);
298 $char = substr($structure, $pos, 1);
300 while ($char != "\"" && $pos < strlen($structure)) {
303 $char = substr($structure, $pos, 1);
305 $structure = trim(substr($structure, strlen($tmp) +
2));
306 $char = substr($structure, 0, 1);
310 $char = substr($structure, $pos, 1);
312 while ($char != "\"" && $pos < strlen($structure)) {
315 $char = substr($structure, $pos, 1);
317 $structure = trim(substr($structure, strlen($tmp) +
2));
320 $props[$k]["name"] = strtolower($tmp);
321 $props[$k]["value"] = $value;
322 } else if ($char == "(") {
323 $end = mime_match_parenthesis (0, $structure);
324 $sub = substr($structure, 1, $end-1);
327 $props = mime_get_props($props, $sub);
328 $structure = substr($structure, strlen($sub) +
2);
331 } else if ($char == "(") {
332 $end = mime_match_parenthesis (0, $structure);
333 $sub = substr($structure, 1, $end-1);
334 $props = mime_get_props($props, $sub);
335 $structure = substr($structure, strlen($sub) +
2);
343 // Matches parenthesis. It will return the position of the matching
344 // parenthesis in $structure. For instance, if $structure was:
345 // ("text" "plain" ("val1name", "1") nil ... )
347 // then this would return 42 to match up those two.
348 function mime_match_parenthesis ($pos, $structure) {
349 $char = substr($structure, $pos, 1);
351 // ignore all extra characters
352 // If inside of a string, skip string -- Boundary IDs and other
353 // things can have ) in them.
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)) {
365 } else if ($char == "(") {
366 $pos = mime_match_parenthesis ($pos, $structure);
371 function mime_fetch_body ($imap_stream, $id, $ent_id) {
372 // do a bit of error correction. If we couldn't find the entity id, just guess
373 // that it is the first one. That is usually the case anyway.
374 if (!$ent_id) $ent_id = 1;
376 fputs ($imap_stream, "a010 FETCH $id BODY[$ent_id]\r\n");
377 $data = sqimap_read_data ($imap_stream, 'a010', true, $response, $message);
378 $topline = array_shift($data);
379 while (! ereg('\* [0-9]+ FETCH ', $topline) && data
)
380 $topline = array_shift($data);
381 $wholemessage = implode('', $data);
383 if (ereg('\{([^\}]*)\}', $topline, $regs)) {
384 return substr($wholemessage, 0, $regs[1]);
386 else if (ereg('"([^"]*)"', $topline, $regs)) {
390 $str = "Body retrival error. Please report this bug!\n";
391 $str .= "Response: $response\n";
392 $str .= "Message: $message\n";
393 $str .= "FETCH line: $topline";
394 $str .= "---------------\n$wholemessage";
395 foreach ($data as $d)
397 $str .= htmlspecialchars($d) . "\n";
401 return "Body retrival error, please report this bug!\n\nTop line is \"$topline\"\n";
404 function mime_print_body_lines ($imap_stream, $id, $ent_id, $encoding) {
405 // do a bit of error correction. If we couldn't find the entity id, just guess
406 // that it is the first one. That is usually the case anyway.
407 if (!$ent_id) $ent_id = 1;
409 fputs ($imap_stream, "a001 FETCH $id BODY[$ent_id]\r\n");
412 $read = fgets ($imap_stream,4096);
413 while (!ereg("^a001 (OK|BAD|NO)(.*)$", $read, $regs)) {
414 if (trim($read) == ")==") {
416 $read = fgets ($imap_stream,4096);
417 if (ereg("^a001 (OK|BAD|NO)(.*)$", $read, $regs)) {
420 echo decodeBody($read1, $encoding);
421 echo decodeBody($read, $encoding);
424 echo decodeBody($read, $encoding);
426 $read = fgets ($imap_stream,4096);
431 /* -[ END MIME DECODING ]----------------------------------------------------------- */
435 /** This is the first function called. It decides if this is a multipart
436 message or if it should be handled as a single entity
438 function decodeMime ($imap_stream, &$header) {
439 global $username, $key, $imapServerAddress, $imapPort;
440 return mime_structure ($imap_stream, $header);
443 // This is here for debugging purposese. It will print out a list
444 // of all the entity IDs that are in the $message object.
445 function listEntities ($message) {
447 if ($message->header
->entity_id
)
448 echo "<tt>" . $message->header
->entity_id
. " : " . $message->header
->type0
. "/" . $message->header
->type1
. "<br>";
449 for ($i = 0; $message->entities
[$i]; $i++
) {
450 $msg = listEntities($message->entities
[$i], $ent_id);
457 // returns a $message object for a particular entity id
458 function getEntity ($message, $ent_id) {
460 if ($message->header
->entity_id
== $ent_id && strlen($ent_id) == strlen($message->header
->entity_id
)) {
463 for ($i = 0; $message->entities
[$i]; $i++
) {
464 $msg = getEntity ($message->entities
[$i], $ent_id);
472 // figures out what entity to display and returns the $message object
474 function findDisplayEntity ($message) {
476 if ($message->header
->type0
== "text") {
477 if ($message->header
->type1
== "plain" ||
478 $message->header
->type1
== "html") {
479 if (isset($message->header
->entity_id
))
480 return $message->header
->entity_id
;
484 for ($i=0; $message->entities
[$i]; $i++
) {
485 return findDisplayEntity($message->entities
[$i]);
491 /** This returns a parsed string called $body. That string can then
492 be displayed as the actual message in the HTML. It contains
493 everything needed, including HTML Tags, Attachments at the
496 function formatBody($imap_stream, $message, $color, $wrap_at) {
497 // this if statement checks for the entity to show as the
498 // primary message. To add more of them, just put them in the
499 // order that is their priority.
500 global $startMessage, $username, $key, $imapServerAddress, $imapPort;
502 $id = $message->header
->id
;
503 $urlmailbox = urlencode($message->header
->mailbox
);
505 // Get the right entity and redefine message to be this entity
506 $ent_num = findDisplayEntity ($message);
507 $body_message = getEntity($message, $ent_num);
508 if (($body_message->header
->type0
== "text") ||
509 ($body_message->header
->type0
== "rfc822")) {
511 $body = mime_fetch_body ($imap_stream, $id, $ent_num);
512 $body = decodeBody($body, $body_message->header
->encoding
);
514 // If there are other types that shouldn't be formatted, add
516 if ($body_message->header
->type1
!= "html") {
517 translateText($body, $wrap_at, $body_message->header
->charset
);
520 $body .= "<SMALL><CENTER><A HREF=\"../src/download.php?absolute_dl=true&passed_id=$id&passed_ent_id=$ent_num&mailbox=$urlmailbox\">". _("Download this as a file") ."</A></CENTER><BR></SMALL>";
522 /** Display the ATTACHMENTS: message if there's more than one part **/
523 $body .= "</TD></TR></TABLE>";
524 if (isset($message->entities
[0])) {
525 $body .= formatAttachments ($message, $ent_num, $message->header
->mailbox
, $id);
528 $body .= formatAttachments ($message, -1, $message->header
->mailbox
, $id);
533 // A recursive function that returns a list of attachments with links
534 // to where to download these attachments
535 function formatAttachments ($message, $ent_id, $mailbox, $id) {
536 global $where, $what;
537 global $startMessage, $color;
538 static $ShownHTML = 0;
545 $body .= "<TABLE WIDTH=100% CELLSPACING=0 CELLPADDING=2 BORDER=0 BGCOLOR=\"$color[0]\"><TR>\n";
546 $body .= "<TH ALIGN=\"left\" BGCOLOR=\"$color[9]\"><B>\n";
547 $body .= _("Attachments") . ':';
548 $body .= "</B></TH></TR><TR><TD>\n";
550 $body .= "<TABLE CELLSPACING=0 CELLPADDING=1 BORDER=0>\n";
552 $body .= formatAttachments ($message, $ent_id, $mailbox, $id);
554 $body .= "</TABLE></TD></TR></TABLE>";
560 if (!$message->entities
) {
561 $type0 = strtolower($message->header
->type0
);
562 $type1 = strtolower($message->header
->type1
);
564 if ($message->header
->entity_id
!= $ent_id) {
565 $filename = decodeHeader($message->header
->filename
);
566 if (trim($filename) == "") {
567 $display_filename = "untitled-".$message->header
->entity_id
;
569 $display_filename = $filename;
572 $urlMailbox = urlencode($mailbox);
573 $ent = urlencode($message->header
->entity_id
);
576 "../src/download.php?startMessage=$startMessage&passed_id=$id&mailbox=$urlMailbox&passed_ent_id=$ent";
578 $DefaultLink .= '&where=' . urlencode($where) . '&what=' . urlencode($what);
579 $Links['download link']['text'] = _("download");
580 $Links['download link']['href'] =
581 "../src/download.php?absolute_dl=true&passed_id=$id&mailbox=$urlMailbox&passed_ent_id=$ent";
584 $HookResults = do_hook("attachment $type0/$type1", $Links,
585 $startMessage, $id, $urlMailbox, $ent, $DefaultLink,
586 $display_filename, $where, $what);
588 $Links = $HookResults[1];
589 $DefaultLink = $HookResults[6];
591 $body .= '<TR><TD> </TD><TD>';
592 $body .= "<A HREF=\"$DefaultLink\">$display_filename</A> </TD>";
593 $body .= '<TD><SMALL><b>' . show_readable_size($message->header
->size
) .
594 '</b> </small></TD>';
595 $body .= "<TD><SMALL>[ $type0/$type1 ] </SMALL></TD>";
596 $body .= '<TD><SMALL>';
597 if ($message->header
->description
)
598 $body .= '<b>' . htmlspecialchars($message->header
->description
) . '</b>';
599 $body .= '</SMALL></TD><TD><SMALL> ';
603 foreach ($Links as $Val)
611 $body .= ' | ';
613 $body .= '<a href="' . $Val['href'] . '">' . $Val['text'] . '</a>';
618 $body .= "</SMALL></TD></TR>\n";
622 for ($i = 0; $i < count($message->entities
); $i++
) {
623 $body .= formatAttachments ($message->entities
[$i], $ent_id, $mailbox, $id);
631 /** this function decodes the body depending on the encoding type. **/
632 function decodeBody($body, $encoding) {
633 $body = str_replace("\r\n", "\n", $body);
634 $encoding = strtolower($encoding);
636 if ($encoding == "quoted-printable") {
637 $body = quoted_printable_decode($body);
639 while (ereg("=\n", $body))
640 $body = ereg_replace ("=\n", "", $body);
641 } else if ($encoding == "base64") {
642 $body = base64_decode($body);
645 // All other encodings are returned raw.
650 // This functions decode strings that is encoded according to
651 // RFC1522 (MIME Part Two: Message Header Extensions for Non-ASCII Text).
652 function decodeHeader ($string) {
653 if (eregi('=\?([^?]+)\?(q|b)\?([^?]+)\?=',
655 if (ucfirst($res[2]) == "B") {
656 $replace = base64_decode($res[3]);
658 $replace = ereg_replace("_", " ", $res[3]);
659 // Convert lowercase Quoted Printable to uppercase for
660 // quoted_printable_decode to understand it.
661 while (ereg("(=([0-9][abcdef])|([abcdef][0-9])|([abcdef][abcdef]))", $replace, $res)) {
662 $replace = str_replace($res[1], strtoupper($res[1]), $replace);
664 $replace = quoted_printable_decode($replace);
667 $replace = charset_decode ($res[1], $replace);
669 $string = eregi_replace
670 ('=\?([^?]+)\?(q|b)\?([^?]+)\?=',
672 // In case there should be more encoding in the string: recurse
673 return (decodeHeader($string));
678 // Encode a string according to RFC 1522 for use in headers if it
679 // contains 8-bit characters or anything that looks like it should
681 function encodeHeader ($string) {
682 global $default_charset;
684 // Encode only if the string contains 8-bit characters or =?
685 if (ereg("([\200-\377]|=\\?)", $string)) {
686 $newstring = "=?$default_charset?Q?";
688 // First the special characters
689 $string = str_replace("=", "=3D", $string);
690 $string = str_replace("?", "=3F", $string);
691 $string = str_replace("_", "=5F", $string);
692 $string = str_replace(" ", "_", $string);
694 for ( $ch = 127 ; $ch <= 255 ; $ch++
) {
696 $insert = sprintf("=%02X", $ch);
697 $string = str_replace($replace, $insert, $string);
701 $newstring = "=?$default_charset?Q?".$string."?=";