6 * Copyright (c) 1999-2002 The SquirrelMail Project Team
7 * Licensed under the GNU GPL. For full terms see the file COPYING.
9 * This contains the functions necessary to detect and decode MIME
15 require_once('../functions/imap.php');
16 require_once('../functions/attachment_common.php');
18 /** Setting up the objects that have the structure for the message **/
20 /** msg_header contains generic variables for values that **/
21 /** could be in a header. **/
23 var $type0 = '', $type1 = '', $boundary = '', $charset = '',
24 $encoding = '', $size = 0, $to = array(), $from = '', $date = '',
25 $cc = array(), $bcc = array(), $reply_to = '', $subject = '',
26 $id = 0, $mailbox = '', $description = '', $filename = '',
27 $entity_id = 0, $message_id = 0, $name = '', $priority = 3;
31 /** message is the object that contains messages. It is a recursive
32 object in that through the $entities variable, it can contain
33 more objects of type message. See documentation in mime.txt for
34 a better description of how this works.
36 var $header = '', $entities = array();
38 function addEntity ($msg) {
39 $this->entities
[] = $msg;
43 /* --------------------------------------------------------------------------------- */
45 /* --------------------------------------------------------------------------------- */
47 /* This function gets the structure of a message and stores it in the "message" class.
48 * It will return this object for use with all relevant header information and
49 * fully parsed into the standard "message" object format.
51 function mime_structure ($imap_stream, $header) {
53 sqimap_messages_flag ($imap_stream, $header->id
, $header->id
, 'Seen');
54 $ssid = sqimap_session_id();
55 $lsid = strlen( $ssid );
57 fputs ($imap_stream, "$ssid FETCH $id BODYSTRUCTURE\r\n");
59 // This should use sqimap_read_data instead of reading it itself
61 $read = fgets ($imap_stream, 9216);
63 while ( substr($read, 0, $lsid) <> $ssid &&
64 !feof( $imap_stream ) ) {
65 $bodystructure .= $read;
66 $read = fgets ($imap_stream, 9216);
68 $read = $bodystructure;
70 // isolate the body structure and remove beginning and end parenthesis
71 $read = trim(substr ($read, strpos(strtolower($read), 'bodystructure') +
13));
72 $read = trim(substr ($read, 0, -1));
73 $end = mime_match_parenthesis(0, $read);
74 while ($end == strlen($read)-1) {
75 $read = trim(substr ($read, 0, -1));
76 $read = trim(substr ($read, 1));
77 $end = mime_match_parenthesis(0, $read);
80 $msg = mime_parse_structure ($read, 0);
81 $msg->header
= $header;
86 /* this starts the parsing of a particular structure. It is called recursively,
87 * so it can be passed different structures. It returns an object of type
89 * First, it checks to see if it is a multipart message. If it is, then it
90 * handles that as it sees is necessary. If it is just a regular entity,
91 * then it parses it and adds the necessary header information (by calling out
92 * to mime_get_elements()
94 function mime_parse_structure ($structure, $ent_id) {
97 if ($structure{0} == '(') {
98 $ent_id = mime_new_element_level($ent_id);
102 $end = mime_match_parenthesis ($start, $structure);
104 $element = substr($structure, $start+
1, ($end - $start)-1);
105 $ent_id = mime_increment_id ($ent_id);
106 $newmsg = mime_parse_structure ($element, $ent_id);
107 $msg->addEntity ($newmsg);
108 } while ($structure{$end+
1} == '(');
110 // parse the elements
111 $msg = mime_get_element ($structure, $msg, $ent_id);
116 /* Increments the element ID. An element id can look like any of
117 * the following: 1, 1.2, 4.3.2.4.1, etc. This function increments
118 * the last number of the element id, changing 1.2 to 1.3.
120 function mime_increment_id ($id) {
122 if (strpos($id, '.')) {
123 $first = substr($id, 0, strrpos($id, '.'));
124 $last = substr($id, strrpos($id, '.')+
1);
126 $new = $first . '.' .$last;
135 * See comment for mime_increment_id().
136 * This adds another level on to the entity_id changing 1.3 to 1.3.0
137 * NOTE: 1.3.0 is not a valid element ID. It MUST be incremented
138 * before it can be used. I left it this way so as not to have
139 * to make a special case if it is the first entity_id. It
140 * always increments it, and that works fine.
142 function mime_new_element_level ($id) {
153 function mime_get_element (&$structure, $msg, $ent_id) {
156 $msg->header
= new msg_header();
157 $msg->header
->entity_id
= $ent_id;
158 $properties = array();
160 while (strlen($structure) > 0) {
161 $structure = trim($structure);
162 $char = $structure{0};
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
171 while ( ($char = $structure{$pos} ) <> '"' && $pos < strlen($structure)) {
175 $structure = substr($structure, strlen($text) +
2);
176 } else if ($char == '(') {
178 $end = mime_match_parenthesis (0, $structure);
179 $sub = substr($structure, 1, $end-1);
180 $properties = mime_get_props($properties, $sub);
181 $structure = substr($structure, strlen($sub) +
2);
183 // loop through until we find a space or an end parenthesis
185 $char = $structure{$pos};
187 while ($char != ' ' && $char != ')' && $pos < strlen($structure)) {
190 $char = $structure{$pos};
192 $structure = substr($structure, strlen($text));
195 // This is where all the text parts get put into the header
198 $msg->header
->type0
= strtolower($text);
201 $msg->header
->type1
= strtolower($text);
204 // Invisimail enclose images with <>
205 $msg->header
->id
= str_replace( '<', '', str_replace( '>', '', $text ) );
208 $msg->header
->description
= $text;
211 $msg->header
->encoding
= strtolower($text);
214 $msg->header
->size
= $text;
217 if ($msg->header
->type0
== 'text' && $elem_num == 8) {
218 // This is a plain text message, so lets get the number of lines
220 $msg->header
->num_lines
= $text;
222 } else if ($msg->header
->type0
== 'message' && $msg->header
->type1
== 'rfc822' && $elem_num == 8) {
223 // This is an encapsulated message, so lets start all over again and
224 // parse this message adding it on to the existing one.
225 $structure = trim($structure);
226 if ( $structure{0} == '(' ) {
227 $e = mime_match_parenthesis (0, $structure);
228 $structure = substr($structure, 0, $e);
229 $structure = substr($structure, 1);
230 $m = mime_parse_structure($structure, $msg->header
->entity_id
);
232 // the following conditional is there to correct a bug that wasn't
233 // incrementing the entity IDs correctly because of the special case
234 // that message/rfc822 is. This fixes it fine.
235 if (substr($structure, 1, 1) != '(')
236 $m->header
->entity_id
= mime_increment_id(mime_new_element_level($ent_id));
238 // Now we'll go through and reformat the results.
240 for ($i=0; $i < count($m->entities
); $i++
) {
241 $msg->addEntity($m->entities
[$i]);
254 // loop through the additional properties and put those in the various headers
255 if ($msg->header
->type0
!= 'message') {
256 for ($i=0; $i < count($properties); $i++
) {
257 $msg->header
->{$properties[$i]['name']} = $properties[$i]['value'];
265 * I did most of the MIME stuff yesterday (June 20, 2000), but I couldn't
266 * figure out how to do this part, so I decided to go to bed. I woke up
267 * in the morning and had a flash of insight. I went to the white-board
268 * and scribbled it out, then spent a bit programming it, and this is the
269 * result. Nothing complicated, but I think my brain was fried yesterday.
270 * Funny how that happens some times.
272 * This gets properties in a nested parenthesisized list. For example,
273 * this would get passed something like: ("attachment" ("filename" "luke.tar.gz"))
274 * This returns an array called $props with all paired up properties.
275 * It ignores the "attachment" for now, maybe that should change later
276 * down the road. In this case, what is returned is:
277 * $props[0]["name"] = "filename";
278 * $props[0]["value"] = "luke.tar.gz";
280 function mime_get_props ($props, $structure) {
282 while (strlen($structure) > 0) {
283 $structure = trim($structure);
284 $char = $structure{0};
289 while ( ( $char = $structure{$pos} ) != '"' &&
290 $pos < strlen($structure)) {
294 $structure = trim(substr($structure, strlen($tmp) +
2));
295 $char = $structure{0};
300 while ( ( $char = $structure{$pos} ) != '"' &&
301 $pos < strlen($structure) ) {
305 $structure = trim(substr($structure, strlen($tmp) +
2));
308 $props[$k]['name'] = strtolower($tmp);
309 $props[$k]['value'] = $value;
310 } else if ($char == '(') {
311 $end = mime_match_parenthesis (0, $structure);
312 $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);
332 * Matches parenthesis. It will return the position of the matching
333 * parenthesis in $structure. For instance, if $structure was:
334 * ("text" "plain" ("val1name", "1") nil ... )
336 * then this would return 42 to match up those two.
338 function mime_match_parenthesis ($pos, $structure) {
340 $j = strlen( $structure );
342 // ignore all extra characters
343 // If inside of a string, skip string -- Boundary IDs and other
344 // things can have ) in them.
345 if ( $structure{$pos} != '(' ) {
349 while ( $pos < $j ) {
351 if ($structure{$pos} == ')') {
353 } elseif ($structure{$pos} == '"') {
355 while ( $structure{$pos} != '"' &&
357 if (substr($structure, $pos, 2) == '\\"') {
359 } elseif (substr($structure, $pos, 2) == '\\\\') {
364 } elseif ( $structure{$pos} == '(' ) {
365 $pos = mime_match_parenthesis ($pos, $structure);
368 echo _("Error decoding mime structure. Report this as a bug!") . '<br>';
372 function mime_fetch_body($imap_stream, $id, $ent_id ) {
375 * do a bit of error correction. If we couldn't find the entity id, just guess
376 * that it is the first one. That is usually the case anyway.
382 $cmd = "FETCH $id BODY[$ent_id]";
383 $data = sqimap_run_command ($imap_stream, $cmd, true, $response, $message);
386 $topline = array_shift( $data );
387 } while( $topline && $topline == '*' && !preg_match( '/\\* [0-9] FETCH.*/i', $topline )) ;
388 $wholemessage = implode('', $data);
389 if (ereg('\\{([^\\}]*)\\}', $topline, $regs)) {
391 $ret = substr( $wholemessage, 0, $regs[1] );
393 There is some information in the content info header that could be important
394 in order to parse html messages. Let's get them here.
396 if ( $ret{0} == '<' ) {
397 $data = sqimap_run_command ($imap_stream, "FETCH $id BODY[$ent_id.MIME]", true, $response, $message);
398 /* BASE within HTML documents is illegal (see w3 spec)
401 * foreach( $data as $d ) {
402 * if ( substr( $d, 0, 13 ) == 'Content-Base:' ) {
407 * ( !isNoSep( $d{$i} ) || $d{$i} == '"' ) )
409 * while ( $i < $j ) {
410 * if ( isNoSep( $d{$i} ) )
415 * } elseif ( $k == 1 && !isnosep( $d{0} ) ) {
416 * $base .= substr( $d, 1 );
420 * if ( $base <> '' ) {
421 * $ret = "<base href=\"$base\">" . $ret;
425 } else if (ereg('"([^"]*)"', $topline, $regs)) {
428 global $where, $what, $mailbox, $passed_id, $startMessage;
429 $par = 'mailbox=' . urlencode($mailbox) . "&passed_id=$passed_id";
430 if (isset($where) && isset($what)) {
431 $par .= '&where='. urlencode($where) . "&what=" . urlencode($what);
433 $par .= "&startMessage=$startMessage&show_more=0";
435 $par .= '&response=' . urlencode($response) .
436 '&message=' . urlencode($message).
437 '&topline=' . urlencode($topline);
440 '<table width="80%"><tr>' .
441 '<tr><td colspan=2>' .
442 _("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!") .
443 " <A HREF=\"../src/retrievalerror.php?$par\"><br>" .
444 _("Submit message") . '</A><BR> ' .
446 '<td><b>' . _("Command:") . "</td><td>$cmd</td></tr>" .
447 '<td><b>' . _("Response:") . "</td><td>$response</td></tr>" .
448 '<td><b>' . _("Message:") . "</td><td>$message</td></tr>" .
449 '<td><b>' . _("FETCH line:") . "</td><td>$topline</td></tr>" .
450 "</table><BR></tt></font><hr>";
452 $data = sqimap_run_command ($imap_stream, "FETCH $passed_id BODY[]", true, $response, $message);
454 $wholemessage = implode('', $data);
456 $ret = $wholemessage;
461 function mime_print_body_lines ($imap_stream, $id, $ent_id, $encoding) {
462 // do a bit of error correction. If we couldn't find the entity id, just guess
463 // that it is the first one. That is usually the case anyway.
467 $sid = sqimap_session_id();
468 // Don't kill the connection if the browser is over a dialup
469 // and it would take over 30 seconds to download it.
471 // don´t call set_time_limit in safe mode.
472 if (!ini_get("safe_mode")) {
476 fputs ($imap_stream, "$sid FETCH $id BODY[$ent_id]\r\n");
479 $read = fgets ($imap_stream,4096);
480 // This could be bad -- if the section has sqimap_session_id() . ' OK'
481 // or similar, it will kill the download.
482 while (!ereg("^".$sid." (OK|BAD|NO)(.*)$", $read, $regs)) {
483 if (trim($read) == ')==') {
485 $read = fgets ($imap_stream,4096);
486 if (ereg("^".$sid." (OK|BAD|NO)(.*)$", $read, $regs)) {
489 echo decodeBody($read1, $encoding) .
490 decodeBody($read, $encoding);
493 echo decodeBody($read, $encoding);
495 $read = fgets ($imap_stream,4096);
500 /* -[ END MIME DECODING ]----------------------------------------------------------- */
504 /* This is the first function called. It decides if this is a multipart
505 message or if it should be handled as a single entity
507 function decodeMime ($imap_stream, &$header) {
508 global $username, $key, $imapServerAddress, $imapPort;
509 return mime_structure ($imap_stream, $header);
512 // This is here for debugging purposese. It will print out a list
513 // of all the entity IDs that are in the $message object.
515 function listEntities ($message) {
517 if ($message->header->entity_id)
518 echo "<tt>" . $message->header->entity_id . ' : ' . $message->header->type0 . '/' . $message->header->type1 . '<br>';
519 for ($i = 0; $message->entities[$i]; $i++) {
520 $msg = listEntities($message->entities[$i], $ent_id);
528 /* returns a $message object for a particular entity id */
529 function getEntity ($message, $ent_id) {
531 if ($message->header
->entity_id
== $ent_id && strlen($ent_id) == strlen($message->header
->entity_id
)) {
534 for ($i = 0; isset($message->entities
[$i]); $i++
) {
535 $msg = getEntity ($message->entities
[$i], $ent_id);
545 * figures out what entity to display and returns the $message object
548 function findDisplayEntity ($message, $textOnly = 1) {
549 global $show_html_default;
554 if ( $message->header
->type0
== 'multipart' &&
555 ( $message->header
->type1
== 'alternative' ||
556 $message->header
->type1
== 'related' ) &&
557 $show_html_default && ! $textOnly ) {
558 $entity = findDisplayEntityHTML($message);
561 // Show text/plain or text/html -- the first one we find.
563 $message->header
->type0
== 'text' &&
564 ( $message->header
->type1
== 'plain' ||
565 $message->header
->type1
== 'html' ) &&
566 isset($message->header
->entity_id
) ) {
567 $entity = $message->header
->entity_id
;
571 while ($entity == 0 && isset($message->entities
[$i]) ) {
572 $entity = findDisplayEntity($message->entities
[$i], $textOnly);
580 /* Shows the HTML version */
581 function findDisplayEntityHTML ($message) {
583 if ( $message->header
->type0
== 'text' &&
584 $message->header
->type1
== 'html' &&
585 isset($message->header
->entity_id
)) {
586 return $message->header
->entity_id
;
588 for ($i = 0; isset($message->entities
[$i]); $i ++
) {
589 $entity = findDisplayEntityHTML($message->entities
[$i]);
598 /* This returns a parsed string called $body. That string can then
599 be displayed as the actual message in the HTML. It contains
600 everything needed, including HTML Tags, Attachments at the
603 function formatBody($imap_stream, $message, $color, $wrap_at) {
604 // this if statement checks for the entity to show as the
605 // primary message. To add more of them, just put them in the
606 // order that is their priority.
607 global $startMessage, $username, $key, $imapServerAddress, $imapPort,
608 $show_html_default, $has_unsafe_images, $view_unsafe_images, $sort;
610 $has_unsafe_images = 0;
612 $id = $message->header
->id
;
613 $urlmailbox = urlencode($message->header
->mailbox
);
615 // Get the right entity and redefine message to be this entity
616 // Pass the 0 to mean that we want the 'best' viewable one
617 $ent_num = findDisplayEntity ($message, 0);
618 $body_message = getEntity($message, $ent_num);
619 if (($body_message->header
->type0
== 'text') ||
620 ($body_message->header
->type0
== 'rfc822')) {
622 $body = mime_fetch_body ($imap_stream, $id, $ent_num);
623 $body = decodeBody($body, $body_message->header
->encoding
);
624 $hookResults = do_hook("message_body", $body);
625 $body = $hookResults[1];
627 // If there are other types that shouldn't be formatted, add
629 if ($body_message->header
->type1
== 'html') {
630 if ( $show_html_default <> 1 ) {
631 $body = strip_tags( $body );
632 translateText($body, $wrap_at, $body_message->header
->charset
);
634 $body = MagicHTML( $body, $id );
637 translateText($body, $wrap_at, $body_message->header
->charset
);
640 $body .= "<CENTER><SMALL><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></SMALL></CENTER><BR>";
641 if ($has_unsafe_images) {
642 if ($view_unsafe_images) {
643 $body .= "<CENTER><SMALL><A HREF=\"read_body.php?passed_id=$id&mailbox=$urlmailbox&sort=$sort&startMessage=$startMessage&show_more=0\">". _("Hide Unsafe Images") ."</A></SMALL></CENTER><BR>\n";
645 $body .= "<CENTER><SMALL><A HREF=\"read_body.php?passed_id=$id&mailbox=$urlmailbox&sort=$sort&startMessage=$startMessage&show_more=0&view_unsafe_images=1\">". _("View Unsafe Images") ."</A></SMALL></CENTER><BR>\n";
649 /** Display the ATTACHMENTS: message if there's more than one part **/
650 if (isset($message->entities
[0])) {
651 $body .= formatAttachments ($message, $ent_num, $message->header
->mailbox
, $id);
654 $body = formatAttachments ($message, -1, $message->header
->mailbox
, $id);
660 * A recursive function that returns a list of attachments with links
661 * to where to download these attachments
663 function formatAttachments($message, $ent_id, $mailbox, $id) {
664 global $where, $what;
665 global $startMessage, $color;
666 static $ShownHTML = 0;
669 if ($ShownHTML == 0) {
672 $body .= "<TABLE WIDTH=\"100%\" CELLSPACING=0 CELLPADDING=2 BORDER=0 BGCOLOR=\"$color[0]\"><TR>\n" .
673 "<TH ALIGN=\"left\" BGCOLOR=\"$color[9]\"><B>\n" .
674 _("Attachments") . ':' .
675 "</B></TH></TR><TR><TD>\n" .
676 "<TABLE CELLSPACING=0 CELLPADDING=1 BORDER=0>\n" .
677 formatAttachments($message, $ent_id, $mailbox, $id) .
678 "</TABLE></TD></TR></TABLE>";
680 } else if ($message) {
682 if (!$message->entities
) {
684 $type0 = strtolower($message->header
->type0
);
685 $type1 = strtolower($message->header
->type1
);
686 $name = decodeHeader($message->header
->name
);
688 if ($message->header
->entity_id
!= $ent_id) {
689 $filename = decodeHeader($message->header
->filename
);
690 if (trim($filename) == '') {
691 if (trim($name) == '') {
692 if ( trim( $message->header
->id
) == '' )
693 $display_filename = 'untitled-[' . $message->header
->entity_id
. ']' ;
695 $display_filename = 'cid: ' . $message->header
->id
;
696 // $display_filename = 'untitled-[' . $message->header->entity_id . ']' ;
698 $display_filename = $name;
702 $display_filename = $filename;
705 $urlMailbox = urlencode($mailbox);
706 $ent = urlencode($message->header
->entity_id
);
709 "../src/download.php?startMessage=$startMessage&passed_id=$id&mailbox=$urlMailbox&passed_ent_id=$ent";
710 if ($where && $what) {
711 $DefaultLink .= '&where=' . urlencode($where) . '&what=' . urlencode($what);
713 $Links['download link']['text'] = _("download");
714 $Links['download link']['href'] =
715 "../src/download.php?absolute_dl=true&passed_id=$id&mailbox=$urlMailbox&passed_ent_id=$ent";
718 /* this executes the attachment hook with a specific MIME-type.
719 * if that doens't have results, it tries if there's a rule
720 * for a more generic type. */
721 $HookResults = do_hook("attachment $type0/$type1", $Links,
722 $startMessage, $id, $urlMailbox, $ent, $DefaultLink,
723 $display_filename, $where, $what);
724 if(count($HookResults[1]) <= 1) {
725 $HookResults = do_hook("attachment $type0/*", $Links,
726 $startMessage, $id, $urlMailbox, $ent, $DefaultLink,
727 $display_filename, $where, $what);
730 $Links = $HookResults[1];
731 $DefaultLink = $HookResults[6];
733 $body .= '<TR><TD> </TD><TD>' .
734 "<A HREF=\"$DefaultLink\">$display_filename</A> </TD>" .
735 '<TD><SMALL><b>' . show_readable_size($message->header
->size
) .
736 '</b> </small></TD>' .
737 "<TD><SMALL>[ $type0/$type1 ] </SMALL></TD>" .
739 if ($message->header
->description
) {
740 $body .= '<b>' . htmlspecialchars(_($message->header
->description
)) . '</b>';
742 $body .= '</SMALL></TD><TD><SMALL> ';
746 foreach ($Links as $Val) {
750 $body .= ' | ';
752 $body .= '<a href="' . $Val['href'] . '">' . $Val['text'] . '</a>';
757 $body .= "</SMALL></TD></TR>\n";
760 for ($i = 0; $i < count($message->entities
); $i++
) {
761 $body .= formatAttachments($message->entities
[$i], $ent_id, $mailbox, $id);
769 /** this function decodes the body depending on the encoding type. **/
770 function decodeBody($body, $encoding) {
771 $body = str_replace("\r\n", "\n", $body);
772 $encoding = strtolower($encoding);
774 global $show_html_default;
776 if ($encoding == 'quoted-printable') {
777 $body = quoted_printable_decode($body);
780 while (ereg("=\n", $body))
781 $body = ereg_replace ("=\n", "", $body);
783 } else if ($encoding == 'base64') {
784 $body = base64_decode($body);
787 // All other encodings are returned raw.
792 * This functions decode strings that is encoded according to
793 * RFC1522 (MIME Part Two: Message Header Extensions for Non-ASCII Text).
795 function decodeHeader ($string, $utfencode=true) {
797 if ( is_array( $string ) ) {
798 $string = implode("\n", $string );
801 if (eregi('=\\?([^?]+)\\?(q|b)\\?([^?]+)\\?=',
803 if (ucfirst($res[2]) == 'B') {
804 $replace = base64_decode($res[3]);
806 $replace = str_replace('_', ' ', $res[3]);
807 // Convert lowercase Quoted Printable to uppercase for
808 // quoted_printable_decode to understand it.
809 while (ereg("(=(([0-9][abcdef])|([abcdef][0-9])|([abcdef][abcdef])))",
811 $replace = str_replace($res[1], strtoupper($res[1]), $replace);
813 $replace = quoted_printable_decode($replace);
815 /* Only encode into entities by default. Some places
816 don't need the encoding, like the compose form. */
818 $replace = charset_decode ($res[1], $replace);
821 // Remove the name of the character set.
822 $string = eregi_replace ('=\\?([^?]+)\\?(q|b)\\?([^?]+)\\?=',
825 // In case there should be more encoding in the string: recurse
826 $string = decodeHeader($string);
833 * Encode a string according to RFC 1522 for use in headers if it
834 * contains 8-bit characters or anything that looks like it should
837 function encodeHeader ($string) {
838 global $default_charset;
840 // Encode only if the string contains 8-bit characters or =?
841 $j = strlen( $string );
842 $l = strstr($string, '=?'); // Must be encoded ?
844 for( $i=0; $i < $j; ++
$i) {
845 switch( $string{$i} ) {
859 $k = ord( $string{$i} );
861 $ret .= sprintf("=%02X", $k);
869 $string = "=?$default_charset?Q?$ret?=";
876 Strips dangerous tags from html messages.
878 function MagicHTML( $body, $id ) {
880 global $message, $HTTP_SERVER_VARS,
881 $attachment_common_show_images;
883 $attachment_common_show_images =
884 FALSE; // Don't display attached images in HTML mode
885 $j = strlen( $body ); // Legnth of the HTML
886 $ret = ''; // Returned string
887 $bgcolor = '#ffffff'; // Background style color (defaults to white)
888 $textcolor = '#000000'; // Foreground style color (defaults to black)
889 $leftmargin = ''; // Left margin style
890 $title = ''; // HTML title if any
894 if ( $body{$i} == '<' ) {
897 while ($body{$pos} == ' ' ||
$body{$pos} == "\t" ||
898 $body{$pos} == "\n" ) {
901 while (strlen($tag) < 4 && $body{$pos} != ' ' &&
902 $body{$pos} != "\t" && $body{$pos} != "\n" &&
907 switch( strtoupper( $tag ) ) {
908 // Strips the entire tag and contents
915 while ( $body{$i+
1}.$body{$i+
2}.$body{$i+
3}.$body{$i+
4}.$body{$i+
5} <> $etg &&
917 while ( $i < $j && $body{++
$i} <> '>' );
918 // $ret .= "<!-- $tag removed -->";
923 while ( $body{$i} <> '>' && // </title>
928 while ( $body{$i} <> '<' && // </title>
935 // Destroy these tags
946 while ( $body{$i} <> '>' &&
953 while ( $body{$i} <> '>' && // </title>
957 // We parse the style to look for interesting stuff
959 while ( $body{$i} <> '>' &&
961 // First we get the name of the style
963 while ( $body{$i} <> '>' &&
967 if ( isnoSep( $body{$i} ) )
971 stripComments( $i, $j, $body );
972 $style = strtoupper( trim( $style ) );
973 if ( $style == 'BODY' ) {
974 // Next we look into the definitions of the body style
975 while ( $body{$i} <> '>' &&
978 // We look for the background color if any.
979 if ( substr( $body, $i, 17 ) == 'BACKGROUND-COLOR:' ) {
981 $bgcolor = getStyleData( $i, $j, $body );
982 } elseif ( substr( $body, $i, 12 ) == 'MARGIN-LEFT:' ) {
984 $leftmargin = getStyleData( $i, $j, $body );
989 // Other style are mantained
990 $styleblk .= "$style ";
991 while ( $body{$i} <> '>' &&
995 $styleblk .= $body{$i};
998 $styleblk .= $body{$i};
1000 stripComments( $i, $j, $body );
1001 if ( $body{$i} <> '>' )
1004 if ( $styleblk <> '' )
1005 $ret .= "<style>$styleblk";
1009 $ret .= '<b>' . _("Title:") . " </b>$title<br>\n";
1012 if (! isset($base)) {
1015 $ret .= stripEvent( $i, $j, $body, $id, $base );
1016 $ret .= " bgcolor=$bgcolor width=\"100%\"><tr>";
1017 if ( $leftmargin <> '' )
1018 $ret .= "<td width=$leftmargin> </td>";
1020 if (strtolower($bgcolor) == 'ffffff' ||
1021 strtolower($bgcolor) == '#ffffff')
1022 $ret .= '<font color=#000000>';
1027 while ( !isNoSep( $body{$i} ) &&
1031 if ( strcasecmp( substr( $base, 0, 4 ), 'href' ) ) {
1033 while ( !isNoSep( $body{$i} ) &&
1037 while ( $body{$i} <> '>' &&
1039 if ( $body{$i} <> '"' ) {
1044 // Debuging $ret .= "<!-- base == $base -->";
1045 if ( strcasecmp( substr( $base, 0, 4 ), 'file' ) <> 0 ) {
1046 $ret .= "\n<BASE HREF=\"$base\">\n";
1051 $ret .= '</font></td></tr></TABLE>';
1055 // Following tags can contain some event handler, lets search it
1056 stripComments( $i, $j, $body );
1057 if (! isset($base)) {
1060 $ret .= stripEvent( $i, $j, $body, $id, $base ) . '>';
1061 // $ret .= "<!-- $tag detected -->";
1069 return( "\n\n<!-- HTML Output ahead -->\n" .
1071 /* Base is illegal within HTML
1072 "\n<!-- END of HTML Output --><base href=\"".
1073 get_location() . '/'.
1076 "\n<!-- END of HTML Output -->\n\n" );
1079 function isNoSep( $char ) {
1097 The following function is usefull to remove extra data that can cause
1098 html not to display properly. Especialy with MS stuff.
1101 function stripComments( &$i, $j, &$body ) {
1103 while ( $body{$i}.$body{$i+
1}.$body{$i+
2}.$body{$i+
3} == '<!--' &&
1106 while ( $body{$i-2}.$body{$i-1}.$body{$i} <> '-->' &&
1116 /* Gets the style data of a specific style */
1118 function getStyleData( &$i, $j, &$body ) {
1121 while ( $body{$i} <> '>' && !isNoSep( $body{$i} ) &&
1125 // And get the color
1127 while ( isNoSep( $body{$i} ) &&
1137 Private function for strip_dangerous_tag. Look for event based coded and "remove" it
1138 change on with no (onload -> noload)
1141 function stripEvent( &$i, $j, &$body, $id, $base ) {
1143 global $message, $base_uri, $has_unsafe_images, $view_unsafe_images;
1147 while ( $body{$i} <> '>' &&
1149 $etg = strtolower($body{$i}.$body{$i+
1}.$body{$i+
2});
1152 // This is probably a src specification
1154 while( !isNoSep( $body{$k} )) {
1157 if ( $body{$k} == '=' ) {
1160 while( !isNoSep( $body{$k} ) &&
1165 while ( $body{$k} <> '>' && isNoSep( $body{$k} ) &&
1170 while( !isNoSep( $body{$k} ) &&
1174 if ( strtolower( substr( $src, 0, 4 ) ) == 'cid:' ) {
1175 $src = substr( $src, 4 );
1176 $src = "../src/download.php?absolute_dl=true&passed_id=$id&mailbox=" .
1177 urlencode( $message->header
->mailbox
) .
1178 "&passed_ent_id=" . find_ent_id( $src, $message );
1179 } else if ( strtolower( substr( $src, 0, 4 ) ) <> 'http' ||
1180 stristr( $src, $base_uri ) ) {
1181 /* Javascript and local urls goes out */
1182 if (!$view_unsafe_images) {
1183 $src = '../images/' . _("sec_remove_eng.png");
1185 $has_unsafe_images = 1;
1187 $ret .= 'src="' . $src . '" ';
1196 // Retrolinks are not allowed without a base because they mess with SM security
1197 if ( $base == '' ) {
1206 if ( $body{$i+
3} == ':') {
1209 while ( isNoSep( $body{$i} ) &&
1211 $name .= $body{$i++
};
1213 if ( $name <> '' ) {
1214 $ret .= "../src/download.php?absolute_dl=true&passed_id=$id&mailbox=" .
1215 urlencode( $message->header
->mailbox
) .
1216 "&passed_ent_id=" . find_ent_id( $name, $message );
1217 if ( $body{$k} == '"' )
1222 if ( $body{$i} == '>' )
1234 if ( strcasecmp( $body{$i-4}.$body{$i-3}.$body{$i-2}.$body{$i-1}.$body{$i}.$body{$i+
1}.$body{$i+
2}, 'script:') == 0 ) {
1250 /* This function trys to locate the entity_id of a specific mime element */
1252 function find_ent_id( $id, $message ) {
1255 for ($i=0; $ret == '' && $i < count($message->entities
); $i++
) {
1257 if ( $message->entities
[$i]->header
->entity_id
== '' ) {
1258 $ret = find_ent_id( $id, $message->entities
[$i] );
1260 if ( strcasecmp( $message->entities
[$i]->header
->id
, $id ) == 0 )
1261 $ret = $message->entities
[$i]->header
->entity_id
;