4 ** This contains the functions necessary to detect and decode MIME
12 if (!isset($i18n_php))
13 include "../functions/i18n.php";
14 if (!isset($imap_php))
15 include "../functions/imap.php";
16 if (!isset($config_php))
17 include "../config/config.php";
20 /** Setting up the objects that have the structure for the message **/
23 /** msg_header contains generic variables for values that **/
24 /** could be in a header. **/
26 var $type0, $type1, $boundary, $charset, $encoding, $size;
27 var $to, $from, $date, $cc, $bcc, $reply_to, $subject;
28 var $id, $mailbox, $description;
29 var $entity_id, $message_id, $charset;
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.
41 function addEntity ($msg) {
42 $this->entities
[count($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, "a001 FETCH $id BODYSTRUCTURE\r\n");
61 $read = fgets ($imap_stream, 10000);
62 $response = substr($read, 0, 4);
63 while ($response != "a001") {
64 $bodystructure .= $read;
65 $read = fgets ($imap_stream, 10000);
66 $response = substr($read, 0, 4);
68 // $read = strtolower($bodystructure);
69 $read = $bodystructure;
71 if ($debug_mime) echo "<tt>$read</tt><br><br>\n";
72 // isolate the body structure and remove beginning and end parenthesis
73 $read = trim(substr ($read, strpos(strtolower($read), "bodystructure") +
13));
74 $read = trim(substr ($read, 0, -1));
75 $end = mime_match_parenthesis(0, $read);
76 while ($end == strlen($read)-1) {
77 $read = trim(substr ($read, 0, -1));
78 $read = trim(substr ($read, 1));
79 $end = mime_match_parenthesis(0, $read);
82 if ($debug_mime) echo "<tt>$read</tt><br><br>\n";
84 $msg = mime_parse_structure ($read, 0);
85 $msg->header
= $header;
89 // this starts the parsing of a particular structure. It is called recursively,
90 // so it can be passed different structures. It returns an object of type
92 // First, it checks to see if it is a multipart message. If it is, then it
93 // handles that as it sees is necessary. If it is just a regular entity,
94 // then it parses it and adds the necessary header information (by calling out
95 // to mime_get_elements()
96 function mime_parse_structure ($structure, $ent_id) {
98 if ($debug_mime) echo "<font color=008800><tt>START: mime_parse_structure()</tt></font><br>\n";
100 if (substr($structure, 0, 1) == "(") {
101 $ent_id = mime_new_element_level($ent_id);
103 if ($debug_mime) echo "<br><font color=0000aa><tt>$structure</tt></font><br>";
105 if ($debug_mime) echo "<font color=008800><tt>Found entity...</tt></font><br>";
107 $end = mime_match_parenthesis ($start, $structure);
109 $element = substr($structure, $start+
1, ($end - $start)-1);
110 $ent_id = mime_increment_id ($ent_id);
111 $newmsg = mime_parse_structure ($element, $ent_id);
112 $msg->addEntity ($newmsg);
113 } while (substr($structure, $end+
1, 1) == "(");
115 // parse the elements
116 if ($debug_mime) echo "<br><font color=0000aa><tt>$structure</tt></font><br>";
117 $msg = mime_get_element (&$structure, $msg, $ent_id);
118 if ($debug_mime) echo "<br>";
121 if ($debug_mime) echo "<font color=008800><tt> END: mime_parse_structure()</tt></font><br>";
124 // Increments the element ID. An element id can look like any of
125 // the following: 1, 1.2, 4.3.2.4.1, etc. This function increments
126 // the last number of the element id, changing 1.2 to 1.3.
127 function mime_increment_id ($id) {
129 if (strpos($id, ".")) {
130 $first = substr($id, 0, strrpos($id, "."));
131 $last = substr($id, strrpos($id, ".")+
1);
133 $new = $first . "." .$last;
137 if ($debug_mime) echo "<b>INCREMENT: $new</b><br>";
141 // See comment for mime_increment_id().
142 // This adds another level on to the entity_id changing 1.3 to 1.3.0
143 // NOTE: 1.3.0 is not a valid element ID. It MUST be incremented
144 // before it can be used. I left it this way so as not to have
145 // to make a special case if it is the first entity_id. It
146 // always increments it, and that works fine.
147 function mime_new_element_level ($id) {
149 else $id = $id . ".0";
154 function mime_get_element (&$structure, $msg, $ent_id) {
157 $msg->header
= new msg_header();
158 $msg->header
->entity_id
= $ent_id;
160 while (strlen($structure) > 0) {
161 $structure = trim($structure);
162 $char = substr($structure, 0, 1);
164 if (strtolower(substr($structure, 0, 3)) == "nil") {
166 $structure = substr($structure, 3);
167 } else if ($char == "\"") {
168 // loop through until we find the matching quote, and return that as a string
170 $char = substr($structure, $pos, 1);
171 while ($char != "\"" && $pos < strlen($structure)) {
174 $char = substr($structure, $pos, 1);
176 $structure = substr($structure, strlen($text) +
2);
177 } else if ($char == "(") {
179 $end = mime_match_parenthesis (0, $structure);
180 $sub = substr($structure, 1, $end-1);
181 $properties = mime_get_props($properties, $sub);
182 $structure = substr($structure, strlen($sub) +
2);
184 // loop through until we find a space or an end parenthesis
186 $char = substr($structure, $pos, 1);
187 while ($char != " " && $char != ")" && $pos < strlen($structure)) {
190 $char = substr($structure, $pos, 1);
192 $structure = substr($structure, strlen($text));
194 if ($debug_mime) echo "<tt>$elem_num : $text</tt><br>";
196 // This is where all the text parts get put into the header
199 $msg->header
->type0
= strtolower($text);
200 if ($debug_mime) echo "<tt>type0 = ".strtolower($text)."</tt><br>";
203 $msg->header
->type1
= strtolower($text);
204 if ($debug_mime) echo "<tt>type1 = ".strtolower($text)."</tt><br>";
207 $msg->header
->description
= $text;
208 if ($debug_mime) echo "<tt>description = $text</tt><br>";
211 $msg->header
->encoding
= strtolower($text);
212 if ($debug_mime) echo "<tt>encoding = ".strtolower($text)."</tt><br>";
215 $msg->header
->size
= $text;
216 if ($debug_mime) echo "<tt>size = $text</tt><br>";
219 if ($msg->header
->type0
== "text" && $elem_num == 8) {
220 // This is a plain text message, so lets get the number of lines
222 $msg->header
->num_lines
= $text;
223 if ($debug_mime) echo "<tt>num_lines = $text</tt><br>";
225 } else if ($msg->header
->type0
== "message" && $msg->header
->type1
== "rfc822" && $elem_num == 8) {
226 // This is an encapsulated message, so lets start all over again and
227 // parse this message adding it on to the existing one.
228 $structure = trim($structure);
229 if (substr($structure, 0, 1) == "(") {
230 $e = mime_match_parenthesis (0, $structure);
231 $structure = substr($structure, 0, $e);
232 $structure = substr($structure, 1);
233 $m = mime_parse_structure($structure, $msg->header
->entity_id
);
235 // the following conditional is there to correct a bug that wasn't
236 // incrementing the entity IDs correctly because of the special case
237 // that message/rfc822 is. This fixes it fine.
238 if (substr($structure, 1, 1) != "(")
239 $m->header
->entity_id
= mime_increment_id(mime_new_element_level($ent_id));
241 // Now we'll go through and reformat the results.
243 for ($i=0; $i < count($m->entities
); $i++
) {
244 $msg->addEntity($m->entities
[$i]);
257 // loop through the additional properties and put those in the various headers
258 if ($msg->header
->type0
!= "message") {
259 for ($i=0; $i < count($properties); $i++
) {
260 $msg->header
->{$properties[$i]["name"]} = $properties[$i]["value"];
261 if ($debug_mime) echo "<tt>".$properties[$i]["name"]." = " . $properties[$i]["value"] . "</tt><br>";
268 // I did most of the MIME stuff yesterday (June 20, 2000), but I couldn't
269 // figure out how to do this part, so I decided to go to bed. I woke up
270 // in the morning and had a flash of insight. I went to the white-board
271 // and scribbled it out, then spent a bit programming it, and this is the
272 // result. Nothing complicated, but I think my brain was fried yesterday.
273 // Funny how that happens some times.
275 // This gets properties in a nested parenthesisized list. For example,
276 // this would get passed something like: ("attachment" ("filename" "luke.tar.gz"))
277 // This returns an array called $props with all paired up properties.
278 // It ignores the "attachment" for now, maybe that should change later
279 // down the road. In this case, what is returned is:
280 // $props[0]["name"] = "filename";
281 // $props[0]["value"] = "luke.tar.gz";
282 function mime_get_props ($props, $structure) {
284 while (strlen($structure) > 0) {
285 $structure = trim($structure);
286 $char = substr($structure, 0, 1);
290 $char = substr($structure, $pos, 1);
291 while ($char != "\"" && $pos < strlen($structure)) {
294 $char = substr($structure, $pos, 1);
296 $structure = trim(substr($structure, strlen($tmp) +
2));
297 $char = substr($structure, 0, 1);
301 $char = substr($structure, $pos, 1);
302 while ($char != "\"" && $pos < strlen($structure)) {
305 $char = substr($structure, $pos, 1);
307 $structure = trim(substr($structure, strlen($tmp) +
2));
310 $props[$k]["name"] = strtolower($tmp);
311 $props[$k]["value"] = $value;
312 } else if ($char == "(") {
313 $end = mime_match_parenthesis (0, $structure);
314 $sub = substr($structure, 1, $end-1);
315 $props = mime_get_props($props, $sub);
316 $structure = substr($structure, strlen($sub) +
2);
319 } else if ($char == "(") {
320 $end = mime_match_parenthesis (0, $structure);
321 $sub = substr($structure, 1, $end-1);
322 $props = mime_get_props($props, $sub);
323 $structure = substr($structure, strlen($sub) +
2);
331 // Matches parenthesis. It will return the position of the matching
332 // parenthesis in $structure. For instance, if $structure was:
333 // ("text" "plain" ("val1name", "1") nil ... )
335 // then this would return 42 to match up those two.
336 function mime_match_parenthesis ($pos, $structure) {
337 $char = substr($structure, $pos, 1);
339 // ignore all extra characters
340 // If inside of a string, skip string -- Boundary IDs and other
341 // things can have ) in them.
342 while ($pos < strlen($structure)) {
344 $char = substr($structure, $pos, 1);
347 } else if ($char == '"') {
349 while (substr($structure, $pos, 1) != '"' &&
350 $pos < strlen($structure)) {
353 } else if ($char == "(") {
354 $pos = mime_match_parenthesis ($pos, $structure);
359 function mime_fetch_body ($imap_stream, $id, $ent_id) {
360 // do a bit of error correction. If we couldn't find the entity id, just guess
361 // that it is the first one. That is usually the case anyway.
362 if (!$ent_id) $ent_id = 1;
364 fputs ($imap_stream, "a001 FETCH $id BODY[$ent_id]\r\n");
365 $topline = fgets ($imap_stream, 1024);
366 if (ereg('\{([^\}]*)\}', $topline, $regs)) {
367 return fread ($imap_stream, $regs[1]);
369 else if (ereg('"([^"]*)"', $topline, $regs)) {
372 return "Body retrival error, please report this bug!\n\nTop line is \"$topline\"\n";
375 /* -[ END MIME DECODING ]----------------------------------------------------------- */
379 /** This is the first function called. It decides if this is a multipart
380 message or if it should be handled as a single entity
382 function decodeMime ($imap_stream, $body, $header) {
383 global $username, $key, $imapServerAddress, $imapPort;
384 return mime_structure ($imap_stream, $header);
387 // This is here for debugging purposese. It will print out a list
388 // of all the entity IDs that are in the $message object.
389 function listEntities ($message) {
391 if ($message->header
->entity_id
)
392 echo "<tt>" . $message->header
->entity_id
. " : " . $message->header
->type0
. "/" . $message->header
->type1
. "<br>";
393 for ($i = 0; $message->entities
[$i]; $i++
) {
394 $msg = listEntities($message->entities
[$i], $ent_id);
401 // returns a $message object for a particular entity id
402 function getEntity ($message, $ent_id) {
404 if ($message->header
->entity_id
== $ent_id && strlen($ent_id) == strlen($message->header
->entity_id
)) {
407 for ($i = 0; $message->entities
[$i]; $i++
) {
408 $msg = getEntity ($message->entities
[$i], $ent_id);
416 // figures out what entity to display and returns the $message object
418 function findDisplayEntity ($message) {
420 if ($message->header
->type0
== "text") {
421 if ($message->header
->type1
== "plain" ||
422 $message->header
->type1
== "html") {
423 return $message->header
->entity_id
;
426 for ($i=0; $message->entities
[$i]; $i++
) {
427 return findDisplayEntity($message->entities
[$i]);
433 /** This returns a parsed string called $body. That string can then
434 be displayed as the actual message in the HTML. It contains
435 everything needed, including HTML Tags, Attachments at the
438 function formatBody($imap_stream, $message, $color, $wrap_at) {
439 // this if statement checks for the entity to show as the
440 // primary message. To add more of them, just put them in the
441 // order that is their priority.
442 global $startMessage, $username, $key, $imapServerAddress, $imapPort;
444 $id = $message->header
->id
;
445 $urlmailbox = urlencode($message->header
->mailbox
);
447 // Get the right entity and redefine message to be this entity
448 $ent_num = findDisplayEntity ($message);
449 $body_message = getEntity($message, $ent_num);
450 if (($body_message->header
->type0
== "text") ||
451 ($body_message->header
->type0
== "rfc822")) {
453 $body = mime_fetch_body ($imap_stream, $id, $ent_num);
454 $body = decodeBody($body, $body_message->header
->encoding
);
456 // If there are other types that shouldn't be formatted, add
458 if ($body_message->header
->type1
!= "html") {
459 translateText($body, $wrap_at, $body_message->header
->charset
);
462 $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>";
464 /** Display the ATTACHMENTS: message if there's more than one part **/
465 $body .= "</TD></TR></TABLE>";
466 if ($message->entities
) {
467 $body .= formatAttachments ($message, $ent_num, $message->header
->mailbox
, $id);
470 $body .= formatAttachments ($message, -1, $message->header
->mailbox
, $id);
475 // A recursive function that returns a list of attachments with links
476 // to where to download these attachments
477 function formatAttachments ($message, $ent_id, $mailbox, $id) {
478 global $where, $what;
479 global $startMessage, $color;
486 $body .= "<TABLE WIDTH=100% CELLSPACING=0 CELLPADDING=2 BORDER=0 BGCOLOR=\"$color[0]\"><TR>\n";
487 $body .= "<TH ALIGN=\"left\" BGCOLOR=\"$color[9]\"><B>\n";
488 $body .= _('Attachments') . ':';
489 $body .= "</B></TH></TR><TR><TD>\n";
491 $body .= "<TABLE CELLSPACING=0 CELLPADDING=1 BORDER=0>\n";
493 $body .= formatAttachments ($message, $ent_id, $mailbox, $id);
495 $body .= "</TABLE></TD></TR></TABLE>";
501 if (!$message->entities
) {
502 $type0 = strtolower($message->header
->type0
);
503 $type1 = strtolower($message->header
->type1
);
505 if ($message->header
->entity_id
!= $ent_id) {
506 $filename = decodeHeader($message->header
->filename
);
507 if (trim($filename) == "") {
508 $display_filename = "untitled-".$message->header
->entity_id
;
510 $display_filename = $filename;
513 $urlMailbox = urlencode($mailbox);
514 $ent = urlencode($message->header
->entity_id
);
517 "../src/download.php?startMessage=$startMessage&passed_id=$id&mailbox=$urlMailbox&passed_ent_id=$ent";
519 $DefaultLink .= '&where=' . urlencode($where) . '&what=' . urlencode($what);
520 $Links['download link']['text'] = _('download');
521 $Links['download link']['href'] =
522 "../src/download.php?absolute_dl=true&passed_id=$id&mailbox=$urlMailbox&passed_ent_id=$ent";
525 $HookResults = do_hook("attachment $type0/$type1", $Links,
526 $startMessage, $id, $urlMailbox, $ent, $DefaultLink,
527 $display_filename, $where, $what);
529 $Links = $HookResults[1];
530 $DefaultLink = $HookResults[6];
532 $body .= '<TR><TD> </TD><TD>';
533 $body .= "<A HREF=\"$DefaultLink\">$display_filename</A> </TD>";
534 $body .= '<TD><SMALL><b>' . show_readable_size($message->header
->size
) .
535 '</b> </small></TD>';
536 $body .= "<TD><SMALL>[ $type0/$type1 ] </SMALL></TD>";
537 $body .= '<TD><SMALL>';
538 if ($message->header
->description
)
539 $body .= '<b>' . htmlspecialchars($message->header
->description
) . '</b>';
540 $body .= '</SMALL></TD><TD><SMALL> ';
544 foreach ($Links as $Val)
552 $body .= ' | ';
554 $body .= '<a href="' . $Val['href'] . '">' . $Val['text'] . '</a>';
559 $body .= "</SMALL></TD></TR>\n";
563 for ($i = 0; $i < count($message->entities
); $i++
) {
564 $body .= formatAttachments ($message->entities
[$i], $ent_id, $mailbox, $id);
572 /** this function decodes the body depending on the encoding type. **/
573 function decodeBody($body, $encoding) {
574 $body = str_replace("\r\n", "\n", $body);
575 $encoding = strtolower($encoding);
577 if ($encoding == "quoted-printable") {
578 $body = quoted_printable_decode($body);
580 while (ereg("=\n", $body))
581 $body = ereg_replace ("=\n", "", $body);
582 } else if ($encoding == "base64") {
583 $body = base64_decode($body);
586 // All other encodings are returned raw.
591 // This functions decode strings that is encoded according to
592 // RFC1522 (MIME Part Two: Message Header Extensions for Non-ASCII Text).
593 function decodeHeader ($string) {
594 if (eregi('=\?([^?]+)\?(q|b)\?([^?]+)\?=',
596 if (ucfirst($res[2]) == "B") {
597 $replace = base64_decode($res[3]);
599 $replace = ereg_replace("_", " ", $res[3]);
600 // Convert lowercase Quoted Printable to uppercase for
601 // quoted_printable_decode to understand it.
602 while (ereg("(=([0-9][a-f])|([a-f][0-9])|([a-f][0-9]))", $replace, $res)) {
603 $replace = str_replace($res[1], strtoupper($res[1]), $replace);
605 $replace = quoted_printable_decode($replace);
608 $replace = charset_decode ($res[1], $replace);
610 $string = eregi_replace
611 ('=\?([^?]+)\?(q|b)\?([^?]+)\?=',
613 // In case there should be more encoding in the string: recurse
614 return (decodeHeader($string));
619 // Encode a string according to RFC 1522 for use in headers if it
620 // contains 8-bit characters or anything that looks like it should
622 function encodeHeader ($string) {
623 global $default_charset;
625 // Encode only if the string contains 8-bit characters or =?
626 if (ereg("([\200-\377]|=\\?)", $string)) {
627 $newstring = "=?$default_charset?Q?";
629 // First the special characters
630 $string = str_replace("=", "=3D", $string);
631 $string = str_replace("?", "=3F", $string);
632 $string = str_replace("_", "=5F", $string);
633 $string = str_replace(" ", "_", $string);
636 while (ereg("([\200-\377])", $string, $regs)) {
638 $insert = "=" . strtoupper(bin2hex($replace));
639 $string = str_replace($replace, $insert, $string);
642 $newstring = "=?$default_charset?Q?".$string."?=";