X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fmime.php;h=3563a9986074051a93211739e5bd13b5b767ebb6;hp=aee86e84971dd318d02e4a7b3606accbf7ce8b7a;hb=807e884a947a2726af34721e91a6f7cbd8dff530;hpb=15e6162eacc97158393bc75aed3afeb7b19c24a6
diff --git a/functions/mime.php b/functions/mime.php
index aee86e84..3563a998 100644
--- a/functions/mime.php
+++ b/functions/mime.php
@@ -12,1151 +12,1573 @@
* $Id$
*/
-/*****************************************************************/
-/*** THIS FILE NEEDS TO HAVE ITS FORMATTING FIXED!!! ***/
-/*** PLEASE DO SO AND REMOVE THIS COMMENT SECTION. ***/
-/*** + Base level indent should begin at left margin, as ***/
-/*** the require_once below. ***/
-/*** + All identation should consist of four space blocks ***/
-/*** + Tab characters are evil. ***/
-/*** + all comments should use "slash-star ... star-slash" ***/
-/*** style -- no pound characters, no slash-slash style ***/
-/*** + FLOW CONTROL STATEMENTS (if, while, etc) SHOULD ***/
-/*** ALWAYS USE { AND } CHARACTERS!!! ***/
-/*** + Please use ' instead of ", when possible. Note " ***/
-/*** should always be used in _( ) function calls. ***/
-/*** Thank you for your help making the SM code more readable. ***/
-/*****************************************************************/
-
require_once('../functions/imap.php');
require_once('../functions/attachment_common.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 = '';
- // var $priority = "";
-}
+/* --------------------------------------------------------------------------------- */
+/* MIME DECODING */
+/* --------------------------------------------------------------------------------- */
- 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 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, 10000);
- $bodystructure = '';
- while( substr($read, 0, $lsid) <> $ssid &&
- !feof( $imap_stream ) ) {
- $bodystructure .= $read;
- $read = fgets ($imap_stream, 10000);
- }
- $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 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 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;
- }
+function mime_structure ($bodystructure, $flags=array()) {
+
+ // isolate the body structure and remove beginning and end parenthesis
+ $read = trim(substr ($bodystructure, strpos(strtolower($bodystructure), 'bodystructure') + 13));
+ $msg = &new message();
+ $read = trim(substr ($read, 0, -1));
+ $res = $msg->parseStructure($read);
+ $msg = $res[0];
+ $msg->setEnt('0');
+ if (count($flags)) {
+ foreach ($flags as $flag) {
+ $char = strtoupper($flag{1});
+ switch ($char) {
+ case 'S':
+ if (strtolower($flag) == '\\seen') {
+ $msg->is_seen = true;
+ }
+ break;
+ case 'A':
+ if (strtolower($flag) == '\\answered') {
+ $msg->is_answered = true;
+ }
+ break;
+ case 'D':
+ if (strtolower($flag) == '\\deleted') {
+ $msg->is_deleted = true;
+ }
+ break;
+ case 'F':
+ if (strtolower($flag) == '\\flagged') {
+ $msg->is_flagged = true;
+ }
+ break;
+ case 'M':
+ if (strtolower($flag) == '$mdnsent') {
+ $msg->is_mdnsent = true;
+ }
+ break;
+ default:
+ break;
+ }
+ }
+ }
+ // listEntities($msg);
+ 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;
- }
+/* 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()
+ */
- // 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_fetch_body($imap_stream, $id, $ent_id) {
+ global $uid_support;
+ /*
+ * 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;
+ }
+ $cmd = "FETCH $id BODY[$ent_id]";
+
+ $data = sqimap_run_command ($imap_stream, $cmd, true, $response, $message, $uid_support);
+ do {
+ $topline = trim(array_shift( $data ));
+ } while( $topline && $topline[0] == '*' && !preg_match( '/\* [0-9]+ FETCH.*/i', $topline )) ;
+
+ $wholemessage = implode('', $data);
+ if (ereg('\\{([^\\}]*)\\}', $topline, $regs)) {
+
+ $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, $uid_support);
+ }
+ } else if (ereg('"([^"]*)"', $topline, $regs)) {
+ $ret = $regs[1];
+ } else {
+ global $where, $what, $mailbox, $passed_id, $startMessage;
+ $par = 'mailbox=' . urlencode($mailbox) . "&passed_id=$passed_id";
+ if (isset($where) && isset($what)) {
+ $par .= '&where='. urlencode($where) . "&what=" . urlencode($what);
+ } else {
+ $par .= "&startMessage=$startMessage&show_more=0";
+ }
+ $par .= '&response=' . urlencode($response) .
+ '&message=' . urlencode($message).
+ '&topline=' . urlencode($topline);
+
+ echo '
' .
+ '' .
+ ' ' .
+ '' .
+ _("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 " .
+ "
' . implode("\n", $body_ary) . ''; +} - // 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, - $show_html_default; - - $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 ) { +/* 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, $ent_num, $id, $mailbox='INBOX') { + // 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; + + $has_unsafe_images= 0; + $body = ''; + $urlmailbox = urlencode($mailbox); + $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 ) { + $entity_conv = array(' ' => ' ', + '>' => '>', + '<' => '<'); $body = strip_tags( $body ); - translateText($body, $wrap_at, $body_message->header->charset); + $body = strtr($body, $entity_conv); + $body = trim($body); + translateText($body, $wrap_at, + $body_message->header->getParameter('charset')); } else { - $body = MagicHTML( $body, $id ); + $body = magicHTML( $body, $id, $message, $mailbox ); } - } else { - translateText($body, $wrap_at, $body_message->header->charset); - } - - $body .= "
\n" . - _("Attachments") . ':' . - " |
---|
\n" .
- " |