-<?
+<?php
/** mime.php
**
** This contains the functions necessary to detect and decode MIME
** messages.
**
+ ** $Id$
**/
+
+ if (defined('mime_php'))
+ return;
+ define('mime_php', true);
+
+ global $debug_mime;
+ $debug_mime = false;
+
+ include "../functions/imap.php";
+
+ /** Setting up the objects that have the structure for the message **/
+
+ class msg_header {
+ /** msg_header contains generic variables for values that **/
+ /** could be in a header. **/
+
+ var $type0 = '', $type1 = '', $boundary = '', $charset = '';
+ var $encoding = '', $size = 0, $to = array(), $from = '', $date = '';
+ var $cc = array(), $bcc = array(), $reply_to = '', $subject = '';
+ var $id = 0, $mailbox = '', $description = '', $filename = '';
+ var $entity_id = 0, $message_id = 0, $name = '';
+ }
+
+ class message {
+ /** message is the object that contains messages. It is a recursive
+ object in that through the $entities variable, it can contain
+ more objects of type message. See documentation in mime.txt for
+ a better description of how this works.
+ **/
+ var $header = '';
+ var $entities = array();
+
+ function addEntity ($msg) {
+ $this->entities[] = $msg;
+ }
+ }
- $mime_php = true;
- if (!isset($i18n_php))
- include "../functions/i18n.php";
- /** This is the first function called. It decides if this is a multipart
- message or if it should be handled as a single entity
- **/
- function decodeMime($body, $bound, $type0, $type1, $encoding, $charset, &$entities) {
- if ($type0 == "multipart") {
- $bound = trim($bound);
- $i = 0;
- while (($i < count($body)) && (substr($body[$i], 0, strlen("--$bound--")) != "--$bound--")) {
- if (trim($body[$i]) == "--$bound") {
- $j = $i+1;
- $p = 0;
-
- /** Lets find the header for this entity **/
- /** If the first line after the boundary is blank, we
- use default values **/
- if (trim($body[$j]) == "") {
- $ent_type0 = "text";
- $ent_type1 = "plain";
- $charset = "us-ascii";
- $j++;
- /** If the first line ISNT blank, read in the header
- for this entity **/
- } else {
- while ((substr(trim($body[$j]), 0, strlen("--$bound")) != "--$bound") && (trim($body[$j]) != "")) {
- $entity_header[$p] = $body[$j];
- $j++;
- $p++;
- }
- /** All of these values are getting passed back to us **/
- sqimap_get_entity_header($imapConnection, $entity_header, $ent_type0, $ent_type1, $ent_bound, $encoding, $charset, $filename);
- }
+ /* --------------------------------------------------------------------------------- */
+ /* MIME DECODING */
+ /* --------------------------------------------------------------------------------- */
+
+ // This function gets the structure of a message and stores it in the "message" class.
+ // It will return this object for use with all relevant header information and
+ // fully parsed into the standard "message" object format.
+ function mime_structure ($imap_stream, $header) {
+ global $debug_mime;
+ sqimap_messages_flag ($imap_stream, $header->id, $header->id, "Seen");
+
+ $id = $header->id;
+ fputs ($imap_stream, "a001 FETCH $id BODYSTRUCTURE\r\n");
+ //
+ // This should use sqimap_read_data instead of reading it itself
+ //
+ $read = fgets ($imap_stream, 10000);
+ $response = substr($read, 0, 4);
+ $bodystructure = "";
+ while ($response != "a001") {
+ $bodystructure .= $read;
+ $read = fgets ($imap_stream, 10000);
+ $response = substr($read, 0, 4);
+ }
+ $read = $bodystructure;
+
+ if ($debug_mime) echo "<tt>$read</tt><br><br>\n";
+ // isolate the body structure and remove beginning and end parenthesis
+ $read = trim(substr ($read, strpos(strtolower($read), "bodystructure") + 13));
+ $read = trim(substr ($read, 0, -1));
+ $end = mime_match_parenthesis(0, $read);
+ while ($end == strlen($read)-1) {
+ $read = trim(substr ($read, 0, -1));
+ $read = trim(substr ($read, 1));
+ $end = mime_match_parenthesis(0, $read);
+ }
+ if ($debug_mime) echo "<tt>$read</tt><br><br>\n";
- /** OK, we have the header information, now lets decide
- what to do with it **/
- if ($ent_type0 == "multipart") {
- $y = 0;
- while (substr($body[$j], 0, strlen("--$bound--")) != "--$bound--") {
- $ent_body[$y] = $body[$j];
- $y++;
- $j++;
- }
- $ent = decodeMime($ent_body, $ent_bound, $ent_type0, $ent_type1, $charset, $entities);
- $entities = $ent;
- } else {
- $j++;
- $entity_body = "";
- while (substr(trim($body[$j]), 0, strlen("--$bound")) != "--$bound") {
- $entity_body .= $body[$j];
- $j++;
- }
- $count = count($entities);
- $entities[$count] = getEntity($entity_body, $ent_bound, $ent_type0, $ent_type1, $encoding, $charset, $filename);
- }
- }
- $i++;
- }
- } else {
- /** If this isn't a multipart message **/
- $j = 0;
- $entity_body = "";
- while ($j < count($body)) {
- $entity_body .= $body[$j];
- $j++;
- }
+ $msg = mime_parse_structure ($read, 0);
+ $msg->header = $header;
+ return $msg;
+ }
- $count = count($entities);
- $entities[$count] = getEntity($entity_body, $bound, $type0, $type1, $encoding, $charset, $filename);
+ // this starts the parsing of a particular structure. It is called recursively,
+ // so it can be passed different structures. It returns an object of type
+ // $message.
+ // First, it checks to see if it is a multipart message. If it is, then it
+ // handles that as it sees is necessary. If it is just a regular entity,
+ // then it parses it and adds the necessary header information (by calling out
+ // to mime_get_elements()
+ function mime_parse_structure ($structure, $ent_id) {
+ global $debug_mime;
+ if ($debug_mime) echo "<font color=008800><tt>START: mime_parse_structure()</tt></font><br>\n";
+ $msg = new message();
+ if (substr($structure, 0, 1) == "(") {
+ $ent_id = mime_new_element_level($ent_id);
+ $start = $end = -1;
+ if ($debug_mime) echo "<br><font color=0000aa><tt>$structure</tt></font><br>";
+ do {
+ if ($debug_mime) echo "<font color=008800><tt>Found entity...</tt></font><br>";
+ $start = $end+1;
+ $end = mime_match_parenthesis ($start, $structure);
+
+ $element = substr($structure, $start+1, ($end - $start)-1);
+ $ent_id = mime_increment_id ($ent_id);
+ $newmsg = mime_parse_structure ($element, $ent_id);
+ $msg->addEntity ($newmsg);
+ } while (substr($structure, $end+1, 1) == "(");
+ } else {
+ // parse the elements
+ if ($debug_mime) echo "<br><font color=0000aa><tt>$structure</tt></font><br>";
+ $msg = mime_get_element ($structure, $msg, $ent_id);
+ if ($debug_mime) echo "<br>";
}
+ if ($debug_mime) echo "<font color=008800><tt> END: mime_parse_structure()</tt></font><br>";
+ return $msg;
+ }
- return $entities;
+ // Increments the element ID. An element id can look like any of
+ // the following: 1, 1.2, 4.3.2.4.1, etc. This function increments
+ // the last number of the element id, changing 1.2 to 1.3.
+ function mime_increment_id ($id) {
+ global $debug_mime;
+ if (strpos($id, ".")) {
+ $first = substr($id, 0, strrpos($id, "."));
+ $last = substr($id, strrpos($id, ".")+1);
+ $last++;
+ $new = $first . "." .$last;
+ } else {
+ $new = $id + 1;
+ }
+ if ($debug_mime) echo "<b>INCREMENT: $new</b><br>";
+ return $new;
}
- /** This gets one entity's properties **/
- function getEntity($body, $bound, $type0, $type1, $encoding, $charset, $filename) {
- $msg["TYPE0"] = $type0;
- $msg["TYPE1"] = $type1;
- $msg["ENCODING"] = $encoding;
- $msg["CHARSET"] = $charset;
- $msg["FILENAME"] = $filename;
+ // See comment for mime_increment_id().
+ // This adds another level on to the entity_id changing 1.3 to 1.3.0
+ // NOTE: 1.3.0 is not a valid element ID. It MUST be incremented
+ // before it can be used. I left it this way so as not to have
+ // to make a special case if it is the first entity_id. It
+ // always increments it, and that works fine.
+ function mime_new_element_level ($id) {
+ if (!$id) $id = 0;
+ else $id = $id . ".0";
+
+ return $id;
+ }
- $msg["BODY"] = $body;
+ function mime_get_element (&$structure, $msg, $ent_id) {
+ global $debug_mime;
+ $elem_num = 1;
+ $msg->header = new msg_header();
+ $msg->header->entity_id = $ent_id;
+ $properties = array();
+
+ while (strlen($structure) > 0) {
+ $structure = trim($structure);
+ $char = substr($structure, 0, 1);
+
+ if (strtolower(substr($structure, 0, 3)) == "nil") {
+ $text = "";
+ $structure = substr($structure, 3);
+ } else if ($char == "\"") {
+ // loop through until we find the matching quote, and return that as a string
+ $pos = 1;
+ $char = substr($structure, $pos, 1);
+ $text = "";
+ while ($char != "\"" && $pos < strlen($structure)) {
+ $text .= $char;
+ $pos++;
+ $char = substr($structure, $pos, 1);
+ }
+ $structure = substr($structure, strlen($text) + 2);
+ } else if ($char == "(") {
+ // comment me
+ $end = mime_match_parenthesis (0, $structure);
+ $sub = substr($structure, 1, $end-1);
+ $properties = mime_get_props($properties, $sub);
+ $structure = substr($structure, strlen($sub) + 2);
+ } else {
+ // loop through until we find a space or an end parenthesis
+ $pos = 0;
+ $char = substr($structure, $pos, 1);
+ $text = "";
+ while ($char != " " && $char != ")" && $pos < strlen($structure)) {
+ $text .= $char;
+ $pos++;
+ $char = substr($structure, $pos, 1);
+ }
+ $structure = substr($structure, strlen($text));
+ }
+ if ($debug_mime) echo "<tt>$elem_num : $text</tt><br>";
+
+ // This is where all the text parts get put into the header
+ switch ($elem_num) {
+ case 1:
+ $msg->header->type0 = strtolower($text);
+ if ($debug_mime) echo "<tt>type0 = ".strtolower($text)."</tt><br>";
+ break;
+ case 2:
+ $msg->header->type1 = strtolower($text);
+ if ($debug_mime) echo "<tt>type1 = ".strtolower($text)."</tt><br>";
+ break;
+ case 5:
+ $msg->header->description = $text;
+ if ($debug_mime) echo "<tt>description = $text</tt><br>";
+ break;
+ case 6:
+ $msg->header->encoding = strtolower($text);
+ if ($debug_mime) echo "<tt>encoding = ".strtolower($text)."</tt><br>";
+ break;
+ case 7:
+ $msg->header->size = $text;
+ if ($debug_mime) echo "<tt>size = $text</tt><br>";
+ break;
+ default:
+ if ($msg->header->type0 == "text" && $elem_num == 8) {
+ // This is a plain text message, so lets get the number of lines
+ // that it contains.
+ $msg->header->num_lines = $text;
+ if ($debug_mime) echo "<tt>num_lines = $text</tt><br>";
+
+ } else if ($msg->header->type0 == "message" && $msg->header->type1 == "rfc822" && $elem_num == 8) {
+ // This is an encapsulated message, so lets start all over again and
+ // parse this message adding it on to the existing one.
+ $structure = trim($structure);
+ if (substr($structure, 0, 1) == "(") {
+ $e = mime_match_parenthesis (0, $structure);
+ $structure = substr($structure, 0, $e);
+ $structure = substr($structure, 1);
+ $m = mime_parse_structure($structure, $msg->header->entity_id);
+
+ // the following conditional is there to correct a bug that wasn't
+ // incrementing the entity IDs correctly because of the special case
+ // that message/rfc822 is. This fixes it fine.
+ if (substr($structure, 1, 1) != "(")
+ $m->header->entity_id = mime_increment_id(mime_new_element_level($ent_id));
+
+ // Now we'll go through and reformat the results.
+ if ($m->entities) {
+ for ($i=0; $i < count($m->entities); $i++) {
+ $msg->addEntity($m->entities[$i]);
+ }
+ } else {
+ $msg->addEntity($m);
+ }
+ $structure = "";
+ }
+ }
+ break;
+ }
+ $elem_num++;
+ $text = "";
+ }
+ // loop through the additional properties and put those in the various headers
+ if ($msg->header->type0 != "message") {
+ for ($i=0; $i < count($properties); $i++) {
+ $msg->header->{$properties[$i]["name"]} = $properties[$i]["value"];
+ if ($debug_mime) echo "<tt>".$properties[$i]["name"]." = " . $properties[$i]["value"] . "</tt><br>";
+ }
+ }
return $msg;
}
- /** This will check whether or not the message contains a certain type. It
- searches through all the entities for a match.
- **/
- function containsType($message, $type0, $type1, &$ent_num) {
- $type0 = strtolower($type0);
- $type1 = strtolower($type1);
- for ($i = 0; $i < count($message["ENTITIES"]); $i++) {
- /** Check only on type0 **/
- if ( $type1 == "any_type" ) {
- if ( ($message["ENTITIES"][$i]["TYPE0"] == $type0) ) {
- $ent_num = $i;
- return true;
+ // I did most of the MIME stuff yesterday (June 20, 2000), but I couldn't
+ // figure out how to do this part, so I decided to go to bed. I woke up
+ // in the morning and had a flash of insight. I went to the white-board
+ // and scribbled it out, then spent a bit programming it, and this is the
+ // result. Nothing complicated, but I think my brain was fried yesterday.
+ // Funny how that happens some times.
+ //
+ // This gets properties in a nested parenthesisized list. For example,
+ // this would get passed something like: ("attachment" ("filename" "luke.tar.gz"))
+ // This returns an array called $props with all paired up properties.
+ // It ignores the "attachment" for now, maybe that should change later
+ // down the road. In this case, what is returned is:
+ // $props[0]["name"] = "filename";
+ // $props[0]["value"] = "luke.tar.gz";
+ function mime_get_props ($props, $structure) {
+ global $debug_mime;
+ while (strlen($structure) > 0) {
+ $structure = trim($structure);
+ $char = substr($structure, 0, 1);
+
+ if ($char == "\"") {
+ $pos = 1;
+ $char = substr($structure, $pos, 1);
+ $tmp = "";
+ while ($char != "\"" && $pos < strlen($structure)) {
+ $tmp .= $char;
+ $pos++;
+ $char = substr($structure, $pos, 1);
+ }
+ $structure = trim(substr($structure, strlen($tmp) + 2));
+ $char = substr($structure, 0, 1);
+
+ if ($char == "\"") {
+ $pos = 1;
+ $char = substr($structure, $pos, 1);
+ $value = "";
+ while ($char != "\"" && $pos < strlen($structure)) {
+ $value .= $char;
+ $pos++;
+ $char = substr($structure, $pos, 1);
+ }
+ $structure = trim(substr($structure, strlen($tmp) + 2));
+
+ $k = count($props);
+ $props[$k]["name"] = strtolower($tmp);
+ $props[$k]["value"] = $value;
+ } else if ($char == "(") {
+ $end = mime_match_parenthesis (0, $structure);
+ $sub = substr($structure, 1, $end-1);
+ if (! isset($props))
+ $props = array();
+ $props = mime_get_props($props, $sub);
+ $structure = substr($structure, strlen($sub) + 2);
}
-
- /** Check on type0 and type1 **/
+ return $props;
+ } else if ($char == "(") {
+ $end = mime_match_parenthesis (0, $structure);
+ $sub = substr($structure, 1, $end-1);
+ $props = mime_get_props($props, $sub);
+ $structure = substr($structure, strlen($sub) + 2);
+ return $props;
} else {
- if ( ($message["ENTITIES"][$i]["TYPE0"] == $type0) && ($message["ENTITIES"][$i]["TYPE1"] == $type1) ) {
- $ent_num = $i;
- return true;
+ return $props;
+ }
+ }
+ }
+
+ // Matches parenthesis. It will return the position of the matching
+ // parenthesis in $structure. For instance, if $structure was:
+ // ("text" "plain" ("val1name", "1") nil ... )
+ // x x
+ // then this would return 42 to match up those two.
+ function mime_match_parenthesis ($pos, $structure) {
+ $char = substr($structure, $pos, 1);
+
+ // ignore all extra characters
+ // If inside of a string, skip string -- Boundary IDs and other
+ // things can have ) in them.
+ if ($char != '(')
+ return strlen($structure);
+ while ($pos < strlen($structure)) {
+ $pos++;
+ $char = substr($structure, $pos, 1);
+ if ($char == ")") {
+ return $pos;
+ } else if ($char == '"') {
+ $pos ++;
+ while (substr($structure, $pos, 1) != '"' &&
+ $pos < strlen($structure)) {
+ if (substr($structure, $pos, 2) == '\\"')
+ $pos ++;
+ elseif (substr($structure, $pos, 2) == '\\\\')
+ $pos ++;
+ $pos ++;
}
+ } else if ($char == "(") {
+ $pos = mime_match_parenthesis ($pos, $structure);
}
}
- return false;
+ echo "Error decoding mime structure. Report this as a bug!<br>\n";
+ return $pos;
}
- /** This returns a parsed string called $body. That string can then
- be displayed as the actual message in the HTML. It contains
- everything needed, including HTML Tags, Attachments at the
- bottom, etc.
- **/
- function formatBody($message, $color, $wrap_at) {
-
- /** this if statement checks for the entity to show as the
- primary message. To add more of them, just put them in the
- order that is their priority.
- **/
- $id = $message["INFO"]["ID"];
- $urlmailbox = urlencode($message["INFO"]["MAILBOX"]);
-
- if (containsType($message, "text", "html", $ent_num)) {
- $body = decodeBody($message["ENTITIES"][$ent_num]["BODY"], $message["ENTITIES"][$ent_num]["ENCODING"]);
- $charset = $message["ENTITIES"][$ent_num]["CHARSET"];
- } else if (containsType($message, "text", "plain", $ent_num)) {
- $body = decodeBody($message["ENTITIES"][$ent_num]["BODY"], $message["ENTITIES"][$ent_num]["ENCODING"]);
- $charset = $message["ENTITIES"][$ent_num]["CHARSET"];
+ function mime_fetch_body ($imap_stream, $id, $ent_id) {
+ // do a bit of error correction. If we couldn't find the entity id, just guess
+ // that it is the first one. That is usually the case anyway.
+ if (!$ent_id) $ent_id = 1;
+
+ fputs ($imap_stream, "a010 FETCH $id BODY[$ent_id]\r\n");
+ $data = sqimap_read_data ($imap_stream, 'a010', true, $response, $message);
+ $topline = array_shift($data);
+ while (! ereg('\\* [0-9]+ FETCH ', $topline) && $data)
+ $topline = array_shift($data);
+ $wholemessage = implode('', $data);
+
+ if (ereg('\\{([^\\}]*)\\}', $topline, $regs)) {
+ return substr($wholemessage, 0, $regs[1]);
}
- // add other primary displaying message types here
- else {
- // find any type that's displayable
- if (containsType($message, "text", "any_type", $ent_num)) {
- $body = decodeBody($message["ENTITIES"][$ent_num]["BODY"], $message["ENTITIES"][$ent_num]["ENCODING"]);
- $charset = $message["ENTITIES"][$ent_num]["CHARSET"];
- } else if (containsType($message, "message", "any_type", $ent_num)) {
- $body = decodeBody($message["ENTITIES"][$ent_num]["BODY"], $message["ENTITIES"][$ent_num]["ENCODING"]);
- $charset = $message["ENTITIES"][$ent_num]["CHARSET"];
- }
+ else if (ereg('"([^"]*)"', $topline, $regs)) {
+ return $regs[1];
+ }
+
+ $str = "Body retrival error. Please report this bug!\n";
+ $str .= "Response: $response\n";
+ $str .= "Message: $message\n";
+ $str .= "FETCH line: $topline";
+ $str .= "---------------\n$wholemessage";
+ foreach ($data as $d)
+ {
+ $str .= htmlspecialchars($d) . "\n";
}
+ return $str;
+ }
- /** If there are other types that shouldn't be formatted, add
- them here **/
- if ($message["ENTITIES"][$ent_num]["TYPE1"] != "html")
- $body = translateText($body, $wrap_at, $charset);
+ function mime_print_body_lines ($imap_stream, $id, $ent_id, $encoding) {
+ // do a bit of error correction. If we couldn't find the entity id, just guess
+ // that it is the first one. That is usually the case anyway.
+ if (!$ent_id) $ent_id = 1;
+
+ // Don't kill the connection if the browser is over a dialup
+ // and it would take over 30 seconds to download it.
+ set_time_limit(0);
+
+ fputs ($imap_stream, "a001 FETCH $id BODY[$ent_id]\r\n");
+ $cnt = 0;
+ $continue = true;
+ $read = fgets ($imap_stream,4096);
+ // This could be bad -- if the section has 'a001 OK'
+ // or similar, it will kill the download.
+ while (!ereg("^a001 (OK|BAD|NO)(.*)$", $read, $regs)) {
+ if (trim($read) == ")==") {
+ $read1 = $read;
+ $read = fgets ($imap_stream,4096);
+ if (ereg("^a001 (OK|BAD|NO)(.*)$", $read, $regs)) {
+ return;
+ } else {
+ echo decodeBody($read1, $encoding);
+ echo decodeBody($read, $encoding);
+ }
+ } else if ($cnt) {
+ echo decodeBody($read, $encoding);
+ }
+ $read = fgets ($imap_stream,4096);
+ $cnt++;
+ }
+ }
+ /* -[ END MIME DECODING ]----------------------------------------------------------- */
- $body .= "<BR><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>";
- /** Display the ATTACHMENTS: message if there's more than one part **/
- if (count($message["ENTITIES"]) > 1) {
- $body .= "<TABLE WIDTH=100% CELLSPACING=0 CELLPADDING=4 BORDER=0><TR><TD BGCOLOR=\"$color[0]\">";
- $body .= "<TT><B>ATTACHMENTS:</B></TT>";
- $body .= "</TD></TR><TR><TD BGCOLOR=\"$color[0]\">";
- $num = 0;
- for ($i = 0; $i < count($message["ENTITIES"]); $i++) {
- /** If we've displayed this entity, go to the next one **/
- if ($ent_num == $i)
- continue;
+ /** This is the first function called. It decides if this is a multipart
+ message or if it should be handled as a single entity
+ **/
+ function decodeMime ($imap_stream, &$header) {
+ global $username, $key, $imapServerAddress, $imapPort;
+ return mime_structure ($imap_stream, $header);
+ }
- $type0 = strtolower($message["ENTITIES"][$i]["TYPE0"]);
- $type1 = strtolower($message["ENTITIES"][$i]["TYPE1"]);
+ // This is here for debugging purposese. It will print out a list
+ // of all the entity IDs that are in the $message object.
+ function listEntities ($message) {
+ if ($message) {
+ if ($message->header->entity_id)
+ echo "<tt>" . $message->header->entity_id . " : " . $message->header->type0 . "/" . $message->header->type1 . "<br>";
+ for ($i = 0; $message->entities[$i]; $i++) {
+ $msg = listEntities($message->entities[$i], $ent_id);
+ if ($msg)
+ return $msg;
+ }
+ }
+ }
- $num++;
- $filename = $message["ENTITIES"][$i]["FILENAME"];
- if (trim($filename) == "") {
- $display_filename = "untitled$i";
- } else {
- $display_filename = $filename;
+ // returns a $message object for a particular entity id
+ function getEntity ($message, $ent_id) {
+ if ($message) {
+ if ($message->header->entity_id == $ent_id && strlen($ent_id) == strlen($message->header->entity_id)) {
+ return $message;
+ } else {
+ for ($i = 0; isset($message->entities[$i]); $i++) {
+ $msg = getEntity ($message->entities[$i], $ent_id);
+ if ($msg)
+ return $msg;
}
+ }
+ }
+ }
- $urlMailbox = urlencode($message["INFO"]["MAILBOX"]);
- $id = $message["INFO"]["ID"];
- $body .= "<TT> <A HREF=\"../src/download.php?passed_id=$id&mailbox=$urlMailbox&passed_ent_id=$i\">" . $display_filename . "</A> <SMALL>(TYPE: $type0/$type1)</SMALL></TT><BR>";
- }
+ // figures out what entity to display and returns the $message object
+ // for that entity.
+ function findDisplayEntity ($message, $textOnly = 1)
+ {
+ global $show_html_default;
+
+ if (! $message)
+ return 0;
+
+ if ($message->header->type0 == "multipart" &&
+ $message->header->type1 == "alternative" &&
+ $show_html_default && ! $textOnly) {
+ $entity = findDisplayEntityHTML($message);
+ if ($entity != 0)
+ return $entity;
+ }
+
+ // Show text/plain or text/html -- the first one we find.
+ if ($message->header->type0 == 'text' &&
+ ($message->header->type1 == 'plain' ||
+ $message->header->type1 == 'html') &&
+ isset($message->header->entity_id))
+ return $message->header->entity_id;
+
+ for ($i=0; isset($message->entities[$i]); $i++) {
+ $entity = findDisplayEntity($message->entities[$i], $textOnly);
+ if ($entity != 0)
+ return $entity;
+ }
+
+ return 0;
+ }
+
+ // Shows the HTML version
+ function findDisplayEntityHTML ($message) {
+ if ($message->header->type0 == 'text' &&
+ $message->header->type1 == 'html' &&
+ isset($message->header->entity_id))
+ return $message->header->entity_id;
+ for ($i = 0; isset($message->entities[$i]); $i ++) {
+ $entity = findDisplayEntityHTML($message->entities[$i]);
+ if ($entity != 0)
+ return $entity;
+ }
+ return 0;
+ }
+
+ /** This returns a parsed string called $body. That string can then
+ be displayed as the actual message in the HTML. It contains
+ everything needed, including HTML Tags, Attachments at the
+ bottom, etc.
+ **/
+ function formatBody($imap_stream, $message, $color, $wrap_at) {
+ // this if statement checks for the entity to show as the
+ // primary message. To add more of them, just put them in the
+ // order that is their priority.
+ global $startMessage, $username, $key, $imapServerAddress, $imapPort;
+
+ $id = $message->header->id;
+ $urlmailbox = urlencode($message->header->mailbox);
+
+ // Get the right entity and redefine message to be this entity
+ // Pass the 0 to mean that we want the 'best' viewable one
+ $ent_num = findDisplayEntity ($message, 0);
+ $body_message = getEntity($message, $ent_num);
+ if (($body_message->header->type0 == "text") ||
+ ($body_message->header->type0 == "rfc822")) {
+
+ $body = mime_fetch_body ($imap_stream, $id, $ent_num);
+ $body = decodeBody($body, $body_message->header->encoding);
+
+ // If there are other types that shouldn't be formatted, add
+ // them here
+ if ($body_message->header->type1 != "html") {
+ translateText($body, $wrap_at, $body_message->header->charset);
+ }
+
+ $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>";
+
+ /** Display the ATTACHMENTS: message if there's more than one part **/
$body .= "</TD></TR></TABLE>";
+ if (isset($message->entities[0])) {
+ $body .= formatAttachments ($message, $ent_num, $message->header->mailbox, $id);
+ }
+ $body .= "</TD></TR></TABLE>";
+ } else {
+ $body = formatAttachments ($message, -1, $message->header->mailbox, $id);
}
return $body;
}
+ // A recursive function that returns a list of attachments with links
+ // to where to download these attachments
+ function formatAttachments ($message, $ent_id, $mailbox, $id) {
+ global $where, $what;
+ global $startMessage, $color;
+ static $ShownHTML = 0;
+
+ $body = "";
+ if ($ShownHTML == 0)
+ {
+ $ShownHTML = 1;
+
+ $body .= "<TABLE WIDTH=100% CELLSPACING=0 CELLPADDING=2 BORDER=0 BGCOLOR=\"$color[0]\"><TR>\n";
+ $body .= "<TH ALIGN=\"left\" BGCOLOR=\"$color[9]\"><B>\n";
+ $body .= _("Attachments") . ':';
+ $body .= "</B></TH></TR><TR><TD>\n";
+
+ $body .= "<TABLE CELLSPACING=0 CELLPADDING=1 BORDER=0>\n";
+
+ $body .= formatAttachments ($message, $ent_id, $mailbox, $id);
+
+ $body .= "</TABLE></TD></TR></TABLE>";
+
+ return $body;
+ }
+
+ if ($message) {
+ if (!$message->entities) {
+ $type0 = strtolower($message->header->type0);
+ $type1 = strtolower($message->header->type1);
+ $name = decodeHeader($message->header->name);
+
+ if ($message->header->entity_id != $ent_id) {
+ $filename = decodeHeader($message->header->filename);
+ if (trim($filename) == "") {
+ if (trim($name) == "") {
+ $display_filename = "untitled-".$message->header->entity_id;
+ } else {
+ $display_filename = $name;
+ $filename = $name;
+ }
+ } else {
+ $display_filename = $filename;
+ }
+
+ $urlMailbox = urlencode($mailbox);
+ $ent = urlencode($message->header->entity_id);
+
+ $DefaultLink =
+ "../src/download.php?startMessage=$startMessage&passed_id=$id&mailbox=$urlMailbox&passed_ent_id=$ent";
+ if ($where && $what)
+ $DefaultLink .= '&where=' . urlencode($where) . '&what=' . urlencode($what);
+ $Links['download link']['text'] = _("download");
+ $Links['download link']['href'] =
+ "../src/download.php?absolute_dl=true&passed_id=$id&mailbox=$urlMailbox&passed_ent_id=$ent";
+ $ImageURL = '';
+
+ $HookResults = do_hook("attachment $type0/$type1", $Links,
+ $startMessage, $id, $urlMailbox, $ent, $DefaultLink,
+ $display_filename, $where, $what);
+
+ $Links = $HookResults[1];
+ $DefaultLink = $HookResults[6];
+
+ $body .= '<TR><TD> </TD><TD>';
+ $body .= "<A HREF=\"$DefaultLink\">$display_filename</A> </TD>";
+ $body .= '<TD><SMALL><b>' . show_readable_size($message->header->size) .
+ '</b> </small></TD>';
+ $body .= "<TD><SMALL>[ $type0/$type1 ] </SMALL></TD>";
+ $body .= '<TD><SMALL>';
+ if ($message->header->description)
+ $body .= '<b>' . htmlspecialchars($message->header->description) . '</b>';
+ $body .= '</SMALL></TD><TD><SMALL> ';
+
+
+ $SkipSpaces = 1;
+ foreach ($Links as $Val)
+ {
+ if ($SkipSpaces)
+ {
+ $SkipSpaces = 0;
+ }
+ else
+ {
+ $body .= ' | ';
+ }
+ $body .= '<a href="' . $Val['href'] . '">' . $Val['text'] . '</a>';
+ }
+
+ unset($Links);
+
+ $body .= "</SMALL></TD></TR>\n";
+ }
+ return $body;
+ } else {
+ for ($i = 0; $i < count($message->entities); $i++) {
+ $body .= formatAttachments ($message->entities[$i], $ent_id, $mailbox, $id);
+ }
+ return $body;
+ }
+ }
+ }
/** this function decodes the body depending on the encoding type. **/
function decodeBody($body, $encoding) {
+ $body = str_replace("\r\n", "\n", $body);
$encoding = strtolower($encoding);
if ($encoding == "quoted-printable") {
// This functions decode strings that is encoded according to
// RFC1522 (MIME Part Two: Message Header Extensions for Non-ASCII Text).
function decodeHeader ($string) {
- if (eregi('=\?([^?]+)\?(q|b)\?([^?]+)\?=',
+ if (eregi('=\\?([^?]+)\\?(q|b)\\?([^?]+)\\?=',
$string, $res)) {
if (ucfirst($res[2]) == "B") {
$replace = base64_decode($res[3]);
} else {
$replace = ereg_replace("_", " ", $res[3]);
+ // Convert lowercase Quoted Printable to uppercase for
+ // quoted_printable_decode to understand it.
+ while (ereg("(=(([0-9][abcdef])|([abcdef][0-9])|([abcdef][abcdef])))", $replace, $res)) {
+ $replace = str_replace($res[1], strtoupper($res[1]), $replace);
+ }
$replace = quoted_printable_decode($replace);
}
$replace = charset_decode ($res[1], $replace);
- $string = eregi_replace
- ('=\?([^?]+)\?(q|b)\?([^?]+)\?=',
+ // Remove the name of the character set.
+ $string = eregi_replace ('=\\?([^?]+)\\?(q|b)\\?([^?]+)\\?=',
$replace, $string);
+
// In case there should be more encoding in the string: recurse
return (decodeHeader($string));
} else
}
// Encode a string according to RFC 1522 for use in headers if it
- // contains 8-bit characters
+ // contains 8-bit characters or anything that looks like it should
+ // be encoded.
function encodeHeader ($string) {
global $default_charset;
- // Encode only if the string contains 8-bit characters
- if (ereg("[\200-\377]", $string)) {
- $newstring = "=?$default_charset?Q?";
- $newstring .= str_replace(" ", "_", $string);
+ // Encode only if the string contains 8-bit characters or =?
+ if (ereg("([\\200-\\377]|=\\?)", $string)) {
- while (ereg("([\200-\377])", $newstring, $regs)) {
- $replace = $regs[1];
- $insert = "=" . bin2hex($replace);
- $newstring = str_replace($replace, $insert, $newstring);
+ // First the special characters
+ $string = str_replace("=", "=3D", $string);
+ $string = str_replace("?", "=3F", $string);
+ $string = str_replace("_", "=5F", $string);
+ $string = str_replace(" ", "_", $string);
+
+ for ( $ch = 127 ; $ch <= 255 ; $ch++ ) {
+ $replace = chr($ch);
+ $insert = sprintf("=%02X", $ch);
+ $string = str_replace($replace, $insert, $string);
}
- $newstring .= "?=";
-
+ $newstring = "=?$default_charset?Q?".$string."?=";
+
return $newstring;
}
projects / squirrelmail.git / blobdiff