X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=functions%2Fmime.php;h=4ed4435af077628e1115cbc08e2c889baa7edfa0;hb=2ef37ed49077a9a0064e15b79cd319f486cde113;hp=e46b0e922d9aa774a6bdb3ac54081018bf92f287;hpb=e79bed1beca14cc40a0743eee920d1003d6a3e6e;p=squirrelmail.git diff --git a/functions/mime.php b/functions/mime.php index e46b0e92..4ed4435a 100644 --- a/functions/mime.php +++ b/functions/mime.php @@ -17,16 +17,16 @@ include "../config/config.php"; - /** Setting up the object that has the structure for the message **/ + /** 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, $encoding; + var $type0, $type1, $boundary, $charset, $encoding, $size; var $to, $from, $date, $cc, $bcc, $reply_to, $subject; - var $id, $mailbox; - var $entity_id; + var $id, $mailbox, $description; + var $entity_id, $message_id, $charset; } class message { @@ -49,10 +49,9 @@ /* 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. - **/ + // 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"); @@ -60,44 +59,62 @@ $id = $header->id; fputs ($imap_stream, "a001 FETCH $id BODYSTRUCTURE\r\n"); $read = fgets ($imap_stream, 10000); - $read = strtolower($read); + $response = substr($read, 0, 4); + while ($response != "a001") { + $bodystructure .= $read; + $read = fgets ($imap_stream, 10000); + $response = substr($read, 0, 4); + } + // $read = strtolower($bodystructure); + $read = $bodystructure; - if ($debug_mime) echo "$read

"; + if ($debug_mime) echo "$read

\n"; // isolate the body structure and remove beginning and end parenthesis - $read = trim(substr ($read, strpos($read, "bodystructure") + 13)); - $read = trim(substr ($read, 0, -2)); - $read = trim(substr ($read, 1)); + $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 "$read

"; + if ($debug_mime) echo "$read

\n"; - $msg = mime_parse_structure ($read); + $msg = mime_parse_structure ($read, 0); $msg->header = $header; return $msg; } + // 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 "START: mime_parse_structure()
"; + if ($debug_mime) echo "START: mime_parse_structure()
\n"; $msg = new message(); if (substr($structure, 0, 1) == "(") { $ent_id = mime_new_element_level($ent_id); $start = $end = -1; + if ($debug_mime) echo "
$structure
"; do { if ($debug_mime) echo "Found entity...
"; $start = $end+1; $end = mime_match_parenthesis ($start, $structure); $element = substr($structure, $start+1, ($end - $start)-1); - $ent_id = mime_increment_id($ent_id); + $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 "
$structure
"; - $msg->header = new msg_header(); - $msg->header = mime_get_element (&$structure, $header); - $msg->header->entity_id = $ent_id; + $msg = mime_get_element (&$structure, $msg, $ent_id); if ($debug_mime) echo "
"; } return $msg; @@ -108,14 +125,16 @@ // 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, strlen($id) - strlen($first)); + $last = substr($id, strrpos($id, ".")+1); $last++; - $new = $first . $last; + $new = $first . "." .$last; } else { $new = $id + 1; } + if ($debug_mime) echo "INCREMENT: $new
"; return $new; } @@ -126,22 +145,23 @@ // 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 . ".0"; + if (!$id) $id = 0; + else $id = $id . ".0"; + return $id; } - function mime_get_element (&$structure, $header) { + 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; while (strlen($structure) > 0) { $structure = trim($structure); $char = substr($structure, 0, 1); - if (substr($structure, 0, 3) == "nil") { + if (strtolower(substr($structure, 0, 3)) == "nil") { $text = ""; $structure = substr($structure, 3); } else if ($char == "\"") { @@ -176,25 +196,58 @@ // This is where all the text parts get put into the header switch ($elem_num) { case 1: - $header->type0 = $text; - if ($debug_mime) echo "type0 = $text
"; + $msg->header->type0 = strtolower($text); + if ($debug_mime) echo "type0 = ".strtolower($text)."
"; break; case 2: - $header->type1 = $text; - if ($debug_mime) echo "type1 = $text
"; + $msg->header->type1 = strtolower($text); + if ($debug_mime) echo "type1 = ".strtolower($text)."
"; + break; + case 5: + $msg->header->description = $text; + if ($debug_mime) echo "description = $text
"; break; case 6: - $header->encoding = $text; - if ($debug_mime) echo "encoding = $text
"; + $msg->header->encoding = strtolower($text); + if ($debug_mime) echo "encoding = ".strtolower($text)."
"; break; case 7: - $header->size = $text; + $msg->header->size = $text; if ($debug_mime) echo "size = $text
"; break; default: - if ($header->type0 == "text" && $elem_num == 8) { - $header->num_lines = $text; + 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 "num_lines = $text
"; + + } 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; } @@ -202,11 +255,14 @@ $text = ""; } // loop through the additional properties and put those in the various headers - for ($i=0; $i < count($properties); $i++) { - $header->{$properties[$i]["name"]} = $properties[$i]["value"]; - if ($debug_mime) echo "".$properties[$i]["name"]." = " . $properties[$i]["value"] . "
"; + if ($msg->header->type0 != "message") { + for ($i=0; $i < count($properties); $i++) { + $msg->header->{$properties[$i]["name"]} = $properties[$i]["value"]; + if ($debug_mime) echo "".$properties[$i]["name"]." = " . $properties[$i]["value"] . "
"; + } } - return $header; + + return $msg; } // I did most of the MIME stuff yesterday (June 20, 2000), but I couldn't @@ -214,6 +270,7 @@ // 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")) @@ -250,7 +307,7 @@ $structure = trim(substr($structure, strlen($tmp) + 2)); $k = count($props); - $props[$k]["name"] = $tmp; + $props[$k]["name"] = strtolower($tmp); $props[$k]["value"] = $value; } else if ($char == "(") { $end = mime_match_parenthesis (0, $structure); @@ -264,6 +321,7 @@ $sub = substr($structure, 1, $end-1); $props = mime_get_props($props, $sub); $structure = substr($structure, strlen($sub) + 2); + return $props; } else { return $props; } @@ -279,11 +337,19 @@ $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. 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)) { + $pos ++; + } } else if ($char == "(") { $pos = mime_match_parenthesis ($pos, $structure); } @@ -295,12 +361,59 @@ // 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]); + } + 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; + + return "Body retrival error, please report this bug!\n\nTop line is \"$topline\"\n"; + } + + 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; + fputs ($imap_stream, "a001 FETCH $id BODY[$ent_id]\r\n"); - $topline = fgets ($imap_stream, 1024); - $size = substr ($topline, strpos($topline, "{")+1); - $size = substr ($size, 0, strpos($size, "}")); - $read = fread ($imap_stream, $size); - return $read; + $cnt = 0; + $continue = true; + $read = fgets ($imap_stream,4096); + 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 ]----------------------------------------------------------- */ @@ -310,17 +423,29 @@ /** 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, $header) { + function decodeMime ($imap_stream, $body, $header) { global $username, $key, $imapServerAddress, $imapPort; - $imap_stream = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0); - sqimap_mailbox_select($imap_stream, $header->mailbox); - return mime_structure ($imap_stream, $header); } + // 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 "" . $message->header->entity_id . " : " . $message->header->type0 . "/" . $message->header->type1 . "
"; + for ($i = 0; $message->entities[$i]; $i++) { + $msg = listEntities($message->entities[$i], $ent_id); + if ($msg) + return $msg; + } + } + } + + // returns a $message object for a particular entity id function getEntity ($message, $ent_id) { if ($message) { - if ($message->header->entity_id == $ent_id) { + if ($message->header->entity_id == $ent_id && strlen($ent_id) == strlen($message->header->entity_id)) { return $message; } else { for ($i = 0; $message->entities[$i]; $i++) { @@ -332,6 +457,8 @@ } } + // figures out what entity to display and returns the $message object + // for that entity. function findDisplayEntity ($message) { if ($message) { if ($message->header->type0 == "text") { @@ -352,41 +479,39 @@ 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. - **/ - global $username, $key, $imapServerAddress, $imapPort; - + 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); - $imap_stream = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0); - sqimap_mailbox_select($imap_stream, $message->header->mailbox); - + // Get the right entity and redefine message to be this entity $ent_num = findDisplayEntity ($message); - $body = mime_fetch_body ($imap_stream, $id, $ent_num); - - /** If there are other types that shouldn't be formatted, add - them here **/ - //if ($->type1 != "html") { - $body = translateText($body, $wrap_at, $charset); - //} - - $body .= "
". _("Download this as a file") ."

"; - - /** Display the ATTACHMENTS: message if there's more than one part **/ - if ($message->entities) { - $body .= "
"; - $body .= "ATTACHMENTS:"; - $body .= "
"; - $num = 0; - - /** make this recurisve at some point **/ - $body .= formatAttachments ($message, $ent_num, $message->header->mailbox, $id); + $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 .= "
". _("Download this as a file") ."

"; + + /** Display the ATTACHMENTS: message if there's more than one part **/ $body .= "
"; + if ($message->entities) { + $body .= formatAttachments ($message, $ent_num, $message->header->mailbox, $id); + } + } else { + $body .= formatAttachments ($message, -1, $message->header->mailbox, $id); } return $body; } @@ -394,23 +519,88 @@ // 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; + + if ($ShownHTML == 0) + { + $ShownHTML = 1; + + $body .= "\n"; + $body .= "
\n"; + $body .= _('Attachments') . ':'; + $body .= "
\n"; + + $body .= "\n"; + + $body .= formatAttachments ($message, $ent_id, $mailbox, $id); + + $body .= "
"; + + return $body; + } + if ($message) { if (!$message->entities) { $type0 = strtolower($message->header->type0); $type1 = strtolower($message->header->type1); if ($message->header->entity_id != $ent_id) { - $filename = $message->header->filename; + $filename = decodeHeader($message->header->filename); if (trim($filename) == "") { - $display_filename = "untitled-$ent_id"; + $display_filename = "untitled-".$message->header->entity_id; } else { $display_filename = $filename; } $urlMailbox = urlencode($mailbox); $ent = urlencode($message->header->entity_id); - $body .= "   " . $display_filename . "  (TYPE: $type0/$type1)
"; - $num++; + + $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 .= '  '; + $body .= "$display_filename "; + $body .= '' . show_readable_size($message->header->size) . + '  '; + $body .= "[ $type0/$type1 ] "; + $body .= ''; + if ($message->header->description) + $body .= '' . htmlspecialchars($message->header->description) . ''; + $body .= ' '; + + + $SkipSpaces = 1; + foreach ($Links as $Val) + { + if ($SkipSpaces) + { + $SkipSpaces = 0; + } + else + { + $body .= '  |  '; + } + $body .= '' . $Val['text'] . ''; + } + + unset($Links); + + $body .= "\n"; } return $body; } else { @@ -425,6 +615,7 @@ /** 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") { @@ -450,6 +641,11 @@ $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); } @@ -465,23 +661,30 @@ } // 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)) { + // Encode only if the string contains 8-bit characters or =? + if (ereg("([\200-\377]|=\\?)", $string)) { $newstring = "=?$default_charset?Q?"; - $newstring .= str_replace(" ", "_", $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); + $ch++; } - $newstring .= "?="; - + $newstring = "=?$default_charset?Q?".$string."?="; + return $newstring; }