X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fmime.php;h=a3556f0db8e115065f665bc990662d47c9eeab35;hp=3403e0726866ee9f04b1d8300c86b832caf12acd;hb=3d1c7564d321f70744f66a2bd818ad97c59d00ea;hpb=d3cdb279bd61b172926b51d41d09c8a691d6c347
diff --git a/functions/mime.php b/functions/mime.php
index 3403e072..9e0d32d6 100644
--- a/functions/mime.php
+++ b/functions/mime.php
@@ -1,208 +1,1269 @@
-
- /** mime.php
- **
- ** This contains the functions necessary to detect and decode MIME messages.
- **/
+entities[] = $msg;
+ }
+}
+
+/* --------------------------------------------------------------------------------- */
+/* 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) {
+
+ sqimap_messages_flag ($imap_stream, $header->id, $header->id, 'Seen');
+ $ssid = sqimap_session_id();
+ $lsid = strlen( $ssid );
+ $id = $header->id;
+ fputs ($imap_stream, "$ssid FETCH $id BODYSTRUCTURE\r\n");
+ //
+ // This should use sqimap_read_data instead of reading it itself
+ //
+ $read = fgets ($imap_stream, 9216);
+ $bodystructure = '';
+ while ( substr($read, 0, $lsid) <> $ssid &&
+ !feof( $imap_stream ) ) {
+ $bodystructure .= $read;
+ $read = fgets ($imap_stream, 9216);
+ }
+ $read = $bodystructure;
+
+ // 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);
+ }
+
+ $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) {
+
+ $msg = new message();
+ if ($structure{0} == '(') {
+ $ent_id = mime_new_element_level($ent_id);
+ $start = $end = -1;
+ do {
+ $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 ($structure{$end+1} == '(');
+ } else {
+ // parse the elements
+ $msg = mime_get_element ($structure, $msg, $ent_id);
+ }
+ return $msg;
+}
+
+/* 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) {
+
+ if (strpos($id, '.')) {
+ $first = substr($id, 0, strrpos($id, '.'));
+ $last = substr($id, strrpos($id, '.')+1);
+ $last++;
+ $new = $first . '.' .$last;
+ } else {
+ $new = $id + 1;
+ }
+
+ return $new;
+}
+
+/*
+ * 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 );
+}
+
+function mime_get_element (&$structure, $msg, $ent_id) {
+
+ $elem_num = 1;
+ $msg->header = new msg_header();
+ $msg->header->entity_id = $ent_id;
+ $properties = array();
+
+ while (strlen($structure) > 0) {
+ $structure = trim($structure);
+ $char = $structure{0};
+
+ 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;
+ $text = '';
+ while ( ($char = $structure{$pos} ) <> '"' && $pos < strlen($structure)) {
+ $text .= $char;
+ $pos++;
+ }
+ $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 = $structure{$pos};
+ $text = '';
+ while ($char != ' ' && $char != ')' && $pos < strlen($structure)) {
+ $text .= $char;
+ $pos++;
+ $char = $structure{$pos};
+ }
+ $structure = substr($structure, strlen($text));
+ }
+
+ // This is where all the text parts get put into the header
+ switch ($elem_num) {
+ case 1:
+ $msg->header->type0 = strtolower($text);
+ break;
+ case 2:
+ $msg->header->type1 = strtolower($text);
+ break;
+ case 4: // Id
+ // Invisimail enclose images with <>
+ $msg->header->id = str_replace( '<', '', str_replace( '>', '', $text ) );
+ break;
+ case 5:
+ $msg->header->description = $text;
+ break;
+ case 6:
+ $msg->header->encoding = strtolower($text);
+ break;
+ case 7:
+ $msg->header->size = $text;
+ 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;
+
+ } 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 ( $structure{0} == '(' ) {
+ $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'];
+ }
+ }
+
+ return $msg;
+}
+
+/*
+ * 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) {
+
+ while (strlen($structure) > 0) {
+ $structure = trim($structure);
+ $char = $structure{0};
+
+ if ($char == '"') {
+ $pos = 1;
+ $tmp = '';
+ while ( ( $char = $structure{$pos} ) != '"' &&
+ $pos < strlen($structure)) {
+ $tmp .= $char;
+ $pos++;
+ }
+ $structure = trim(substr($structure, strlen($tmp) + 2));
+ $char = $structure{0};
+
+ if ($char == '"') {
+ $pos = 1;
+ $value = '';
+ while ( ( $char = $structure{$pos} ) != '"' &&
+ $pos < strlen($structure) ) {
+ $value .= $char;
+ $pos++;
+ }
+ $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);
+ }
+ 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 {
+ return $props;
+ }
+ }
+}
- /** 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, $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);
+/*
+ * 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) {
+
+ $j = strlen( $structure );
+
+ // ignore all extra characters
+ // If inside of a string, skip string -- Boundary IDs and other
+ // things can have ) in them.
+ if ( $structure{$pos} != '(' ) {
+ return( $j );
+ }
+
+ while ( $pos < $j ) {
+ $pos++;
+ if ($structure{$pos} == ')') {
+ return $pos;
+ } elseif ($structure{$pos} == '"') {
+ $pos++;
+ while ( $structure{$pos} != '"' &&
+ $pos < $j ) {
+ if (substr($structure, $pos, 2) == '\\"') {
+ $pos++;
+ } elseif (substr($structure, $pos, 2) == '\\\\') {
+ $pos++;
}
+ $pos++;
}
- $i++;
- }
- } else {
- /** If this isn't a multipart message **/
- $j = 0;
- $entity_body = "";
- while ($j < count($body)) {
- $entity_body .= $body[$j];
- $j++;
- }
-
- $count = count($entities);
- $entities[$count] = getEntity($entity_body, $bound, $type0, $type1, $encoding, $charset, $filename);
- }
+ } elseif ( $structure{$pos} == '(' ) {
+ $pos = mime_match_parenthesis ($pos, $structure);
+ }
+ }
+ echo _("Error decoding mime structure. Report this as a bug!") . '
';
+ return( $pos );
+}
- return $entities;
- }
+function mime_fetch_body($imap_stream, $id, $ent_id ) {
- /** 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;
+ /*
+ * 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;
+ }
- $msg["BODY"] = $body;
+ $cmd = "FETCH $id BODY[$ent_id]";
+ $data = sqimap_run_command ($imap_stream, $cmd, true, $response, $message);
- return $msg;
- }
+ do {
+ $topline = array_shift( $data );
+ } while( $topline && $topline == '*' && !preg_match( '/\\* [0-9] FETCH.*/i', $topline )) ;
+ $wholemessage = implode('', $data);
+ if (ereg('\\{([^\\}]*)\\}', $topline, $regs)) {
- /** 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;
- }
-
- /** Check on type0 and type1 **/
- } else {
- if ( ($message["ENTITIES"][$i]["TYPE0"] == $type0) && ($message["ENTITIES"][$i]["TYPE1"] == $type1) ) {
- $ent_num = $i;
- return true;
- }
- }
- }
- return false;
- }
+ $ret = substr( $wholemessage, 0, $regs[1] );
+ /*
+ There is some information in the content info header that could be important
+ in order to parse html messages. Let's get them here.
+ */
+ if ( $ret{0} == '<' ) {
+ $data = sqimap_run_command ($imap_stream, "FETCH $id BODY[$ent_id.MIME]", true, $response, $message);
+ /* BASE within HTML documents is illegal (see w3 spec)
+* $base = '';
+* $k = 10;
+* foreach( $data as $d ) {
+* if ( substr( $d, 0, 13 ) == 'Content-Base:' ) {
+* $j = strlen( $d );
+* $i = 13;
+* $base = '';
+* while ( $i < $j &&
+* ( !isNoSep( $d{$i} ) || $d{$i} == '"' ) )
+* $i++;
+* while ( $i < $j ) {
+* if ( isNoSep( $d{$i} ) )
+* $base .= $d{$i};
+* $i++;
+* }
+* $k = 0;
+* } elseif ( $k == 1 && !isnosep( $d{0} ) ) {
+* $base .= substr( $d, 1 );
+* }
+* $k++;
+* }
+* if ( $base <> '' ) {
+* $ret = "
' .
+ '' .
+ ' ' .
+ '' .
+ _("Body retrieval error. The reason for this is most probably that the message is malformed. Please help us making future versions better by submitting this message to the developers knowledgebase!") .
+ "
" .
+ _("Submit message") . '
' .
+ '' . _("Command:") . " $cmd " .
+ '' . _("Response:") . " $response " .
+ '' . _("Message:") . " $message " .
+ '' . _("FETCH line:") . " $topline " .
+ "
"; - $body .= "ATTACHMENTS:"; - $body .= " |
";
- $num = 0;
+/* Shows the HTML version */
+function findDisplayEntityHTML ($message) {
- for ($i = 0; $i < count($message["ENTITIES"]); $i++) {
- /** If we've displayed this entity, go to the next one **/
- if ($ent_num == $i)
- continue;
+ 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;
+}
- $type0 = strtolower($message["ENTITIES"][$i]["TYPE0"]);
- $type1 = strtolower($message["ENTITIES"][$i]["TYPE1"]);
+/* 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,
+ $show_html_default, $has_unsafe_images, $view_unsafe_images, $sort;
- $num++;
- $filename = $message["ENTITIES"][$i]["FILENAME"];
- if (trim($filename) == "") {
- $display_filename = "untitled$i";
+ $has_unsafe_images = 0;
+
+ $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);
+ $hookResults = do_hook("message_body", $body);
+ $body = $hookResults[1];
+
+ // If there are other types that shouldn't be formatted, add
+ // them here
+ if ($body_message->header->type1 == 'html') {
+ if ( $show_html_default <> 1 ) {
+ $body = strip_tags( $body );
+ translateText($body, $wrap_at, $body_message->header->charset);
} else {
- $display_filename = $filename;
+ $body = MagicHTML( $body, $id );
}
+ } else {
+ translateText($body, $wrap_at, $body_message->header->charset);
+ }
- $urlMailbox = urlencode($message["INFO"]["MAILBOX"]);
- $id = $message["INFO"]["ID"];
- $body .= " " . $display_filename . " (TYPE: $type0/$type1) "; - } - $body .= " |
\n" . + _("Attachments") . ':' . + " |
---|
\n" .
+ " |