6 * Copyright (c) 1999-2003 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
13 * @package squirrelmail
16 /** The typical includes... */
17 require_once(SM_PATH
. 'functions/imap.php');
18 require_once(SM_PATH
. 'functions/attachment_common.php');
20 /* -------------------------------------------------------------------------- */
22 /* -------------------------------------------------------------------------- */
25 * Get the MIME structure
27 * This function gets the structure of a message and stores it in the "message" class.
28 * It will return this object for use with all relevant header information and
29 * fully parsed into the standard "message" object format.
31 function mime_structure ($bodystructure, $flags=array()) {
33 /* Isolate the body structure and remove beginning and end parenthesis. */
34 $read = trim(substr ($bodystructure, strpos(strtolower($bodystructure), 'bodystructure') +
13));
35 $read = trim(substr ($read, 0, -1));
37 $msg = Message
::parseStructure($read,$i);
38 if (!is_object($msg)) {
39 include_once(SM_PATH
. 'functions/display_messages.php');
40 global $color, $mailbox;
41 /* removed urldecode because $_GET is auto urldecoded ??? */
42 displayPageHeader( $color, $mailbox );
43 $errormessage = _("SquirrelMail could not decode the bodystructure of the message");
44 $errormessage .= '<BR>'._("the provided bodystructure by your imap-server").':<BR><BR>';
45 $errormessage .= '<pre>' . htmlspecialchars($read) . '</pre>';
46 plain_error_message( $errormessage, $color );
47 echo '</body></html>';
51 foreach ($flags as $flag) {
52 $char = strtoupper($flag{1});
55 if (strtolower($flag) == '\\seen') {
60 if (strtolower($flag) == '\\answered') {
61 $msg->is_answered
= true;
65 if (strtolower($flag) == '\\deleted') {
66 $msg->is_deleted
= true;
70 if (strtolower($flag) == '\\flagged') {
71 $msg->is_flagged
= true;
75 if (strtolower($flag) == '$mdnsent') {
76 $msg->is_mdnsent
= true;
84 // listEntities($msg);
90 /* This starts the parsing of a particular structure. It is called recursively,
91 * so it can be passed different structures. It returns an object of type
93 * First, it checks to see if it is a multipart message. If it is, then it
94 * handles that as it sees is necessary. If it is just a regular entity,
95 * then it parses it and adds the necessary header information (by calling out
96 * to mime_get_elements()
99 function mime_fetch_body($imap_stream, $id, $ent_id=1, $fetch_size=0) {
101 /* Do a bit of error correction. If we couldn't find the entity id, just guess
102 * that it is the first one. That is usually the case anyway.
106 $cmd = "FETCH $id BODY[]";
108 $cmd = "FETCH $id BODY[$ent_id]";
111 if ($fetch_size!=0) $cmd .= "<0.$fetch_size>";
113 $data = sqimap_run_command ($imap_stream, $cmd, true, $response, $message, $uid_support);
115 $topline = trim(array_shift($data));
116 } while($topline && ($topline[0] == '*') && !preg_match('/\* [0-9]+ FETCH.*/i', $topline)) ;
118 $wholemessage = implode('', $data);
119 if (ereg('\\{([^\\}]*)\\}', $topline, $regs)) {
120 $ret = substr($wholemessage, 0, $regs[1]);
121 /* There is some information in the content info header that could be important
122 * in order to parse html messages. Let's get them here.
124 // if ($ret{0} == '<') {
125 // $data = sqimap_run_command ($imap_stream, "FETCH $id BODY[$ent_id.MIME]", true, $response, $message, $uid_support);
127 } else if (ereg('"([^"]*)"', $topline, $regs)) {
130 global $where, $what, $mailbox, $passed_id, $startMessage;
131 $par = 'mailbox=' . urlencode($mailbox) . '&passed_id=' . $passed_id;
132 if (isset($where) && isset($what)) {
133 $par .= '&where=' . urlencode($where) . '&what=' . urlencode($what);
135 $par .= '&startMessage=' . $startMessage . '&show_more=0';
137 $par .= '&response=' . urlencode($response) .
138 '&message=' . urlencode($message) .
139 '&topline=' . urlencode($topline);
142 '<table width="80%"><tr>' .
143 '<tr><td colspan=2>' .
144 _("Body retrieval error. The reason for this is most probably that the message is malformed.") .
146 '<tr><td><b>' . _("Command:") . "</td><td>$cmd</td></tr>" .
147 '<tr><td><b>' . _("Response:") . "</td><td>$response</td></tr>" .
148 '<tr><td><b>' . _("Message:") . "</td><td>$message</td></tr>" .
149 '<tr><td><b>' . _("FETCH line:") . "</td><td>$topline</td></tr>" .
150 "</table><BR></tt></font><hr>";
152 $data = sqimap_run_command ($imap_stream, "FETCH $passed_id BODY[]", true, $response, $message, $uid_support);
154 $wholemessage = implode('', $data);
156 $ret = $wholemessage;
161 function mime_print_body_lines ($imap_stream, $id, $ent_id=1, $encoding) {
164 /* Don't kill the connection if the browser is over a dialup
165 * and it would take over 30 seconds to download it.
166 * Dont call set_time_limit in safe mode.
169 if (!ini_get('safe_mode')) {
172 /* in case of base64 encoded attachments, do not buffer them.
173 Instead, echo the decoded attachment directly to screen */
174 if (strtolower($encoding) == 'base64') {
176 $query = "FETCH $id BODY[]";
178 $query = "FETCH $id BODY[$ent_id]";
180 sqimap_run_command($imap_stream,$query,true,$response,$message,$uid_support,'sqimap_base64_decode','php://stdout',true);
182 $body = mime_fetch_body ($imap_stream, $id, $ent_id);
183 echo decodeBody($body, $encoding);
187 TODO, use the same method for quoted printable.
188 However, I assume that quoted printable attachments aren't that large
189 so the performancegain / memory usage drop will be minimal.
190 If we decide to add that then we need to adapt sqimap_fread because
191 we need to split te result on \n and fread doesn't stop at \n. That
192 means we also should provide $results from sqimap_fread (by ref) to
193 te function and set $no_return to false. The $filter function for
194 quoted printable should handle unsetting of $results.
197 TODO 2: find out how we write to the output stream php://stdout. fwrite
198 doesn't work because 'php://stdout isn't a stream.
203 fputs ($imap_stream, "$sid FETCH $id BODY[$ent_id]\r\n");
206 $read = fgets ($imap_stream,8192);
209 // This could be bad -- if the section has sqimap_session_id() . ' OK'
210 // or similar, it will kill the download.
211 while (!ereg("^".$sid_s." (OK|BAD|NO)(.*)$", $read, $regs)) {
212 if (trim($read) == ')==') {
214 $read = fgets ($imap_stream,4096);
215 if (ereg("^".$sid." (OK|BAD|NO)(.*)$", $read, $regs)) {
218 echo decodeBody($read1, $encoding) .
219 decodeBody($read, $encoding);
222 echo decodeBody($read, $encoding);
224 $read = fgets ($imap_stream,4096);
231 /* -[ END MIME DECODING ]----------------------------------------------------------- */
233 /* This is here for debugging purposes. It will print out a list
234 * of all the entity IDs that are in the $message object.
236 function listEntities ($message) {
238 echo "<tt>" . $message->entity_id
. ' : ' . $message->type0
. '/' . $message->type1
. ' parent = '. $message->parent
->entity_id
. '<br>';
239 for ($i = 0; isset($message->entities
[$i]); $i++
) {
241 $msg = listEntities($message->entities
[$i]);
251 function getPriorityStr($priority) {
252 $priority_level = substr($priority,0,1);
254 switch($priority_level) {
255 /* Check for a higher then normal priority. */
258 $priority_string = _("High");
261 /* Check for a lower then normal priority. */
264 $priority_string = _("Low");
267 /* Check for a normal priority. */
270 $priority_level = '3';
271 $priority_string = _("Normal");
275 return $priority_string;
278 /* returns a $message object for a particular entity id */
279 function getEntity ($message, $ent_id) {
280 return $message->getEntity($ent_id);
284 * Extracted from strings.php 23/03/2002
287 function translateText(&$body, $wrap_at, $charset) {
288 global $where, $what; /* from searching */
289 global $color; /* color theme */
291 require_once(SM_PATH
. 'functions/url_parser.php');
293 $body_ary = explode("\n", $body);
294 for ($i=0; $i < count($body_ary); $i++
) {
295 $line = $body_ary[$i];
296 if (strlen($line) - 2 >= $wrap_at) {
297 sqWordWrap($line, $wrap_at);
299 $line = charset_decode($charset, $line);
300 $line = str_replace("\t", ' ', $line);
309 if ($line[$pos] == ' ') {
311 } else if (strpos($line, '>', $pos) === $pos) {
320 if (!isset($color[13])) {
321 $color[13] = '#800000';
323 $line = '<font color="' . $color[13] . '">' . $line . '</font>';
325 if (!isset($color[14])) {
326 $color[14] = '#FF0000';
328 $line = '<font color="' . $color[14] . '">' . $line . '</font>';
331 $body_ary[$i] = $line;
333 $body = '<pre>' . implode("\n", $body_ary) . '</pre>';
336 /* This returns a parsed string called $body. That string can then
337 * be displayed as the actual message in the HTML. It contains
338 * everything needed, including HTML Tags, Attachments at the
341 function formatBody($imap_stream, $message, $color, $wrap_at, $ent_num, $id, $mailbox='INBOX') {
342 /* This if statement checks for the entity to show as the
343 * primary message. To add more of them, just put them in the
344 * order that is their priority.
346 global $startMessage, $username, $key, $imapServerAddress, $imapPort,
347 $show_html_default, $sort, $has_unsafe_images, $passed_ent_id;
348 global $languages, $squirrelmail_language;
350 if( !sqgetGlobalVar('view_unsafe_images', $view_unsafe_images, SQ_GET
) ) {
351 $view_unsafe_images = false;
355 $urlmailbox = urlencode($mailbox);
356 $body_message = getEntity($message, $ent_num);
357 if (($body_message->header
->type0
== 'text') ||
358 ($body_message->header
->type0
== 'rfc822')) {
359 $body = mime_fetch_body ($imap_stream, $id, $ent_num);
360 $body = decodeBody($body, $body_message->header
->encoding
);
362 if (isset($languages[$squirrelmail_language]['XTRA_CODE']) &&
363 function_exists($languages[$squirrelmail_language]['XTRA_CODE'])) {
364 if (mb_detect_encoding($body) != 'ASCII') {
365 $body = $languages[$squirrelmail_language]['XTRA_CODE']('decode', $body);
368 $hookResults = do_hook("message_body", $body);
369 $body = $hookResults[1];
371 /* If there are other types that shouldn't be formatted, add
375 if ($body_message->header
->type1
== 'html') {
376 if ($show_html_default <> 1) {
377 $entity_conv = array(' ' => ' ',
384 $body = strtr($body, $entity_conv);
385 $body = strip_tags($body);
387 translateText($body, $wrap_at,
388 $body_message->header
->getParameter('charset'));
390 $body = magicHTML($body, $id, $message, $mailbox);
393 translateText($body, $wrap_at,
394 $body_message->header
->getParameter('charset'));
396 $link = 'passed_id=' . $id . '&ent_id='.$ent_num.
397 '&mailbox=' . $urlmailbox .'&sort=' . $sort .
398 '&startMessage=' . $startMessage . '&show_more=0';
399 if (isset($passed_ent_id)) {
400 $link .= '&passed_ent_id='.$passed_ent_id;
402 $body .= '<center><small><a href="download.php?absolute_dl=true&' .
403 $link . '">' . _("Download this as a file") . '</a>';
404 if ($view_unsafe_images) {
405 $text = _("Hide Unsafe Images");
407 if (isset($has_unsafe_images) && $has_unsafe_images) {
408 $link .= '&view_unsafe_images=1';
409 $text = _("View Unsafe Images");
415 $body .= ' | <a href="read_body.php?' . $link . '">' . $text . '</a>';
417 $body .= '</small></center><br>' . "\n";
423 function formatAttachments($message, $exclude_id, $mailbox, $id) {
424 global $where, $what, $startMessage, $color;
425 static $ShownHTML = 0;
427 $att_ar = $message->getAttachments($exclude_id);
429 if (!count($att_ar)) return '';
433 $urlMailbox = urlencode($mailbox);
435 foreach ($att_ar as $att) {
436 $ent = $att->entity_id
;
437 $header = $att->header
;
438 $type0 = strtolower($header->type0
);
439 $type1 = strtolower($header->type1
);
441 $links['download link']['text'] = _("download");
442 $links['download link']['href'] = SM_PATH
.
443 "src/download.php?absolute_dl=true&passed_id=$id&mailbox=$urlMailbox&ent_id=$ent";
445 if ($type0 =='message' && $type1 == 'rfc822') {
446 $default_page = SM_PATH
. 'src/read_body.php';
447 $rfc822_header = $att->rfc822_header
;
448 $filename = $rfc822_header->subject
;
449 if (trim( $filename ) == '') {
450 $filename = 'untitled-[' . $ent . ']' ;
452 $from_o = $rfc822_header->from
;
453 if (is_object($from_o)) {
454 $from_name = decodeHeader($from_o->getAddress(false));
456 $from_name = _("Unknown sender");
458 $description = $from_name;
460 $default_page = SM_PATH
. 'src/download.php';
461 if (is_object($header->disposition
)) {
462 $filename = $header->disposition
->getProperty('filename');
463 if (trim($filename) == '') {
464 $name = decodeHeader($header->disposition
->getProperty('name'));
465 if (trim($name) == '') {
466 $name = $header->getParameter('name');
467 if(trim($name) == '') {
468 if (trim( $header->id
) == '') {
469 $filename = 'untitled-[' . $ent . ']' ;
471 $filename = 'cid: ' . $header->id
;
481 $filename = $header->getParameter('name');
482 if (!trim($filename)) {
483 if (trim( $header->id
) == '') {
484 $filename = 'untitled-[' . $ent . ']' ;
486 $filename = 'cid: ' . $header->id
;
490 if ($header->description
) {
491 $description = decodeHeader($header->description
);
497 $display_filename = $filename;
498 if (isset($passed_ent_id)) {
499 $passed_ent_id_link = '&passed_ent_id='.$passed_ent_id;
501 $passed_ent_id_link = '';
503 $defaultlink = $default_page . "?startMessage=$startMessage"
504 . "&passed_id=$id&mailbox=$urlMailbox"
505 . '&ent_id='.$ent.$passed_ent_id_link;
506 if ($where && $what) {
507 $defaultlink .= '&where='. urlencode($where).'&what='.urlencode($what);
509 /* This executes the attachment hook with a specific MIME-type.
510 * If that doesn't have results, it tries if there's a rule
511 * for a more generic type.
513 $hookresults = do_hook("attachment $type0/$type1", $links,
514 $startMessage, $id, $urlMailbox, $ent, $defaultlink,
515 $display_filename, $where, $what);
516 if(count($hookresults[1]) <= 1) {
517 $hookresults = do_hook("attachment $type0/*", $links,
518 $startMessage, $id, $urlMailbox, $ent, $defaultlink,
519 $display_filename, $where, $what);
522 $links = $hookresults[1];
523 $defaultlink = $hookresults[6];
525 $attachments .= '<TR><TD>' .
526 '<A HREF="'.$defaultlink.'">'.decodeHeader($display_filename).'</A> </TD>' .
527 '<TD><SMALL><b>' . show_readable_size($header->size
) .
528 '</b> </small></TD>' .
529 "<TD><SMALL>[ $type0/$type1 ] </SMALL></TD>" .
531 $attachments .= '<b>' . $description . '</b>';
532 $attachments .= '</SMALL></TD><TD><SMALL> ';
535 foreach ($links as $val) {
539 $attachments .= ' | ';
541 $attachments .= '<a href="' . $val['href'] . '">' . $val['text'] . '</a>';
544 $attachments .= "</TD></TR>\n";
546 $attachmentadd = do_hook_function('attachments_bottom',$attachments);
547 if ($attachmentadd != '')
548 $attachments = $attachmentadd;
552 function sqimap_base64_decode(&$string) {
553 $string = str_replace("\r\n", "\n", $string);
554 $string = base64_decode($string);
557 /* This function decodes the body depending on the encoding type. */
558 function decodeBody($body, $encoding) {
559 global $show_html_default;
561 $body = str_replace("\r\n", "\n", $body);
562 $encoding = strtolower($encoding);
564 $encoding_handler = do_hook_function('decode_body', $encoding);
567 // plugins get first shot at decoding the body
569 if (!empty($encoding_handler) && function_exists($encoding_handler)) {
570 $body = $encoding_handler('decode', $body);
572 } else if ($encoding == 'quoted-printable' ||
573 $encoding == 'quoted_printable') {
574 $body = quoted_printable_decode($body);
576 while (ereg("=\n", $body)) {
577 $body = ereg_replace ("=\n", '', $body);
580 } else if ($encoding == 'base64') {
581 $body = base64_decode($body);
584 // All other encodings are returned raw.
589 * This functions decode strings that is encoded according to
590 * RFC1522 (MIME Part Two: Message Header Extensions for Non-ASCII Text).
591 * Patched by Christian Schmidt <christian@ostenfeld.dk> 23/03/2002
593 function decodeHeader ($string, $utfencode=true,$htmlsave=true) {
594 global $languages, $squirrelmail_language;
595 if (is_array($string)) {
596 $string = implode("\n", $string);
599 if (isset($languages[$squirrelmail_language]['XTRA_CODE']) &&
600 function_exists($languages[$squirrelmail_language]['XTRA_CODE'])) {
601 $string = $languages[$squirrelmail_language]['XTRA_CODE']('decodeheader', $string);
602 // Do we need to return at this point?
609 $aString = explode(' ',$string);
611 foreach ($aString as $chunk) {
612 if ($encoded && $chunk === '') {
614 } elseif ($chunk === '') {
619 /* if encoded words are not separated by a linear-space-white we still catch them */
622 while ($match = preg_match('/^(.*)=\?([^?]*)\?(Q|B)\?([^?]*)\?=(.*)$/Ui',$chunk,$res)) {
623 /* if the last chunk isn't an encoded string then put back the space, otherwise don't */
624 if ($iLastMatch !== $j) {
634 $encoding = ucfirst($res[3]);
638 $replace = base64_decode($res[4]);
639 $ret .= charset_decode($res[2],$replace);
642 $replace = str_replace('_', ' ', $res[4]);
643 $replace = preg_replace('/=([0-9a-f]{2})/ie', 'chr(hexdec("\1"))',
645 /* Only encode into entities by default. Some places
646 * don't need the encoding, like the compose form.
649 $replace = charset_decode($res[2], $replace);
652 $replace = htmlspecialchars($replace);
664 if (!$encoded && $htmlsave) {
665 $ret .= htmlspecialchars($chunk);
684 * Encode a string according to RFC 1522 for use in headers if it
685 * contains 8-bit characters or anything that looks like it should
688 function encodeHeader ($string) {
689 global $default_charset, $languages, $squirrelmail_language;
691 if (isset($languages[$squirrelmail_language]['XTRA_CODE']) &&
692 function_exists($languages[$squirrelmail_language]['XTRA_CODE'])) {
693 return $languages[$squirrelmail_language]['XTRA_CODE']('encodeheader', $string);
695 if (strtolower($default_charset) == 'iso-8859-1') {
696 $string = str_replace("\240",' ',$string);
699 // Encode only if the string contains 8-bit characters or =?
700 $j = strlen($string);
701 $max_l = 75 - strlen($default_charset) - 7;
704 $iEncStart = $enc_init = false;
705 $cur_l = $iOffset = 0;
706 for($i = 0; $i < $j; ++
$i) {
715 if ($iEncStart === false) {
719 if ($cur_l > ($max_l-2)) {
720 /* if there is an stringpart that doesn't need encoding, add it */
721 $aRet[] = substr($string,$iOffset,$iEncStart-$iOffset);
722 $aRet[] = "=?$default_charset?Q?$ret?=";
728 $ret .= sprintf("=%02X",ord($string{$i}));
733 if ($iEncStart !== false) {
734 $aRet[] = substr($string,$iOffset,$iEncStart-$iOffset);
735 $aRet[] = "=?$default_charset?Q?$ret?=";
743 if ($iEncStart !== false) {
745 if ($cur_l > $max_l) {
746 $aRet[] = substr($string,$iOffset,$iEncStart-$iOffset);
747 $aRet[] = "=?$default_charset?Q?$ret?=";
758 $k = ord($string{$i});
760 if ($iEncStart === false) {
761 // do not start encoding in the middle of a string, also take the rest of the word.
762 $sLeadString = substr($string,0,$i);
763 $aLeadString = explode(' ',$sLeadString);
764 $sToBeEncoded = array_pop($aLeadString);
765 $iEncStart = $i - strlen($sToBeEncoded);
766 $ret .= $sToBeEncoded;
767 $cur_l +
= strlen($sToBeEncoded);
770 /* first we add the encoded string that reached it's max size */
771 if ($cur_l > ($max_l-2)) {
772 $aRet[] = substr($string,$iOffset,$iEncStart-$iOffset);
773 $aRet[] = "=?$default_charset?Q?$ret?= "; /* the next part is also encoded => separate by space */
780 $ret .= sprintf("=%02X", $k);
782 if ($iEncStart !== false) {
784 if ($cur_l > $max_l) {
785 $aRet[] = substr($string,$iOffset,$iEncStart-$iOffset);
786 $aRet[] = "=?$default_charset?Q?$ret?=";
801 if ($iEncStart !== false) {
802 $aRet[] = substr($string,$iOffset,$iEncStart-$iOffset);
803 $aRet[] = "=?$default_charset?Q?$ret?=";
805 $aRet[] = substr($string,$iOffset);
807 $string = implode('',$aRet);
812 /* This function trys to locate the entity_id of a specific mime element */
813 function find_ent_id($id, $message) {
814 for ($i = 0, $ret = ''; $ret == '' && $i < count($message->entities
); $i++
) {
815 if ($message->entities
[$i]->header
->type0
== 'multipart') {
816 $ret = find_ent_id($id, $message->entities
[$i]);
818 if (strcasecmp($message->entities
[$i]->header
->id
, $id) == 0) {
819 // if (sq_check_save_extension($message->entities[$i])) {
820 return $message->entities
[$i]->entity_id
;
828 function sq_check_save_extension($message) {
829 $filename = $message->getFilename();
830 $ext = substr($filename, strrpos($filename,'.')+
1);
831 $save_extensions = array('jpg','jpeg','gif','png','bmp');
832 return in_array($ext, $save_extensions);
837 ** HTMLFILTER ROUTINES
841 * This function is more or less a wrapper around stripslashes. Apparently
842 * Explorer is stupid enough to just remove the backslashes and then
843 * execute the content of the attribute as if nothing happened.
846 * @param attvalue The value of the attribute
847 * @return attvalue The value of the attribute stripslashed.
849 function sq_unbackslash($attvalue){
851 * Remove any backslashes. See if there are any first.
854 if (strstr($attvalue, '\\') !== false){
855 $attvalue = stripslashes($attvalue);
861 * Kill any tabs, newlines, or carriage returns. Our friends the
862 * makers of the browser with 95% market value decided that it'd
863 * be funny to make "java[tab]script" be just as good as "javascript".
865 * @param attvalue The attribute value before extraneous spaces removed.
866 * @return attvalue The attribute value after extraneous spaces removed.
868 function sq_unspace($attvalue){
869 if (strcspn($attvalue, "\t\r\n") != strlen($attvalue)){
870 $attvalue = str_replace(Array("\t", "\r", "\n"), Array('', '', ''),
877 * This function returns the final tag out of the tag name, an array
878 * of attributes, and the type of the tag. This function is called by
879 * sq_sanitize internally.
881 * @param $tagname the name of the tag.
882 * @param $attary the array of attributes and their values
883 * @param $tagtype The type of the tag (see in comments).
884 * @return a string with the final tag representation.
886 function sq_tagprint($tagname, $attary, $tagtype){
890 $fulltag = '</' . $tagname . '>';
892 $fulltag = '<' . $tagname;
893 if (is_array($attary) && sizeof($attary)){
895 while (list($attname, $attvalue) = each($attary)){
896 array_push($atts, "$attname=$attvalue");
898 $fulltag .= ' ' . join(" ", $atts);
909 * A small helper function to use with array_walk. Modifies a by-ref
910 * value and makes it lowercase.
912 * @param $val a value passed by-ref.
913 * @return void since it modifies a by-ref value.
915 function sq_casenormalize(&$val){
916 $val = strtolower($val);
920 * This function skips any whitespace from the current position within
921 * a string and to the next non-whitespace value.
923 * @param $body the string
924 * @param $offset the offset within the string where we should start
925 * looking for the next non-whitespace character.
926 * @return the location within the $body where the next
927 * non-whitespace char is located.
929 function sq_skipspace($body, $offset){
930 $me = 'sq_skipspace';
931 preg_match('/^(\s*)/s', substr($body, $offset), $matches);
932 if (sizeof($matches{1})){
933 $count = strlen($matches{1});
940 * This function looks for the next character within a string. It's
941 * really just a glorified "strpos", except it catches if failures
944 * @param $body The string to look for needle in.
945 * @param $offset Start looking from this position.
946 * @param $needle The character/string to look for.
947 * @return location of the next occurance of the needle, or
948 * strlen($body) if needle wasn't found.
950 function sq_findnxstr($body, $offset, $needle){
951 $me = 'sq_findnxstr';
952 $pos = strpos($body, $needle, $offset);
954 $pos = strlen($body);
960 * This function takes a PCRE-style regexp and tries to match it
963 * @param $body The string to look for needle in.
964 * @param $offset Start looking from here.
965 * @param $reg A PCRE-style regex to match.
966 * @return Returns a false if no matches found, or an array
967 * with the following members:
968 * - integer with the location of the match within $body
969 * - string with whatever content between offset and the match
970 * - string with whatever it is we matched
972 function sq_findnxreg($body, $offset, $reg){
973 $me = 'sq_findnxreg';
976 preg_match("%^(.*?)($reg)%si", substr($body, $offset), $matches);
977 if (!isset($matches{0}) ||
!$matches{0}){
980 $retarr{0} = $offset +
strlen($matches{1});
981 $retarr{1} = $matches{1};
982 $retarr{2} = $matches{2};
988 * This function looks for the next tag.
990 * @param $body String where to look for the next tag.
991 * @param $offset Start looking from here.
992 * @return false if no more tags exist in the body, or
993 * an array with the following members:
994 * - string with the name of the tag
995 * - array with attributes and their values
996 * - integer with tag type (1, 2, or 3)
997 * - integer where the tag starts (starting "<")
998 * - integer where the tag ends (ending ">")
999 * first three members will be false, if the tag is invalid.
1001 function sq_getnxtag($body, $offset){
1002 $me = 'sq_getnxtag';
1003 if ($offset > strlen($body)){
1006 $lt = sq_findnxstr($body, $offset, "<");
1007 if ($lt == strlen($body)){
1012 * blah blah <tag attribute="value">
1015 $pos = sq_skipspace($body, $lt+
1);
1016 if ($pos >= strlen($body)){
1017 return Array(false, false, false, $lt, strlen($body));
1020 * There are 3 kinds of tags:
1021 * 1. Opening tag, e.g.:
1023 * 2. Closing tag, e.g.:
1025 * 3. XHTML-style content-less tag, e.g.:
1029 switch (substr($body, $pos, 1)){
1036 * A comment or an SGML declaration.
1038 if (substr($body, $pos+
1, 2) == "--"){
1039 $gt = strpos($body, "-->", $pos);
1041 $gt = strlen($body);
1045 return Array(false, false, false, $lt, $gt);
1047 $gt = sq_findnxstr($body, $pos, ">");
1048 return Array(false, false, false, $lt, $gt);
1053 * Assume tagtype 1 for now. If it's type 3, we'll switch values
1063 * Look for next [\W-_], which will indicate the end of the tag name.
1065 $regary = sq_findnxreg($body, $pos, "[^\w\-_]");
1066 if ($regary == false){
1067 return Array(false, false, false, $lt, strlen($body));
1069 list($pos, $tagname, $match) = $regary;
1070 $tagname = strtolower($tagname);
1073 * $match can be either of these:
1074 * '>' indicating the end of the tag entirely.
1075 * '\s' indicating the end of the tag name.
1076 * '/' indicating that this is type-3 xhtml tag.
1078 * Whatever else we find there indicates an invalid tag.
1083 * This is an xhtml-style tag with a closing / at the
1084 * end, like so: <img src="blah"/>. Check if it's followed
1085 * by the closing bracket. If not, then this tag is invalid
1087 if (substr($body, $pos, 2) == "/>"){
1091 $gt = sq_findnxstr($body, $pos, ">");
1092 $retary = Array(false, false, false, $lt, $gt);
1096 return Array($tagname, false, $tagtype, $lt, $pos);
1100 * Check if it's whitespace
1102 if (!preg_match('/\s/', $match)){
1104 * This is an invalid tag! Look for the next closing ">".
1106 $gt = sq_findnxstr($body, $lt, ">");
1107 return Array(false, false, false, $lt, $gt);
1113 * At this point we're here:
1114 * <tagname attribute='blah'>
1117 * At this point we loop in order to find all attributes.
1123 while ($pos <= strlen($body)){
1124 $pos = sq_skipspace($body, $pos);
1125 if ($pos == strlen($body)){
1129 return Array(false, false, false, $lt, $pos);
1132 * See if we arrived at a ">" or "/>", which means that we reached
1133 * the end of the tag.
1136 if (preg_match("%^(\s*)(>|/>)%s", substr($body, $pos), $matches)) {
1140 $pos +
= strlen($matches{1});
1141 if ($matches{2} == "/>"){
1145 return Array($tagname, $attary, $tagtype, $lt, $pos);
1149 * There are several types of attributes, with optional
1150 * [:space:] between members.
1152 * attrname[:space:]=[:space:]'CDATA'
1154 * attrname[:space:]=[:space:]"CDATA"
1156 * attr[:space:]=[:space:]CDATA
1160 * We leave types 1 and 2 the same, type 3 we check for
1161 * '"' and convert to """ if needed, then wrap in
1162 * double quotes. Type 4 we convert into:
1165 $regary = sq_findnxreg($body, $pos, "[^:\w\-_]");
1166 if ($regary == false){
1168 * Looks like body ended before the end of tag.
1170 return Array(false, false, false, $lt, strlen($body));
1172 list($pos, $attname, $match) = $regary;
1173 $attname = strtolower($attname);
1175 * We arrived at the end of attribute name. Several things possible
1177 * '>' means the end of the tag and this is attribute type 4
1178 * '/' if followed by '>' means the same thing as above
1179 * '\s' means a lot of things -- look what it's followed by.
1180 * anything else means the attribute is invalid.
1185 * This is an xhtml-style tag with a closing / at the
1186 * end, like so: <img src="blah"/>. Check if it's followed
1187 * by the closing bracket. If not, then this tag is invalid
1189 if (substr($body, $pos, 2) == "/>"){
1193 $gt = sq_findnxstr($body, $pos, ">");
1194 $retary = Array(false, false, false, $lt, $gt);
1198 $attary{$attname} = '"yes"';
1199 return Array($tagname, $attary, $tagtype, $lt, $pos);
1203 * Skip whitespace and see what we arrive at.
1205 $pos = sq_skipspace($body, $pos);
1206 $char = substr($body, $pos, 1);
1208 * Two things are valid here:
1209 * '=' means this is attribute type 1 2 or 3.
1210 * \w means this was attribute type 4.
1211 * anything else we ignore and re-loop. End of tag and
1212 * invalid stuff will be caught by our checks at the beginning
1217 $pos = sq_skipspace($body, $pos);
1219 * Here are 3 possibilities:
1220 * "'" attribute type 1
1221 * '"' attribute type 2
1222 * everything else is the content of tag type 3
1224 $quot = substr($body, $pos, 1);
1226 $regary = sq_findnxreg($body, $pos+
1, "\'");
1227 if ($regary == false){
1228 return Array(false, false, false, $lt, strlen($body));
1230 list($pos, $attval, $match) = $regary;
1232 $attary{$attname} = "'" . $attval . "'";
1233 } else if ($quot == '"'){
1234 $regary = sq_findnxreg($body, $pos+
1, '\"');
1235 if ($regary == false){
1236 return Array(false, false, false, $lt, strlen($body));
1238 list($pos, $attval, $match) = $regary;
1240 $attary{$attname} = '"' . $attval . '"';
1243 * These are hateful. Look for \s, or >.
1245 $regary = sq_findnxreg($body, $pos, "[\s>]");
1246 if ($regary == false){
1247 return Array(false, false, false, $lt, strlen($body));
1249 list($pos, $attval, $match) = $regary;
1251 * If it's ">" it will be caught at the top.
1253 $attval = preg_replace("/\"/s", """, $attval);
1254 $attary{$attname} = '"' . $attval . '"';
1256 } else if (preg_match("|[\w/>]|", $char)) {
1258 * That was attribute type 4.
1260 $attary{$attname} = '"yes"';
1263 * An illegal character. Find next '>' and return.
1265 $gt = sq_findnxstr($body, $pos, ">");
1266 return Array(false, false, false, $lt, $gt);
1272 * The fact that we got here indicates that the tag end was never
1273 * found. Return invalid tag indication so it gets stripped.
1275 return Array(false, false, false, $lt, strlen($body));
1279 * This function checks attribute values for entity-encoded values
1280 * and returns them translated into 8-bit strings so we can run
1283 * @param $attvalue A string to run entity check against.
1284 * @return Translated value.
1287 function sq_deent($attvalue){
1290 * See if we have to run the checks first. All entities must start
1293 if (strpos($attvalue, '&') === false){
1297 * Check named entities first.
1299 $trans = get_html_translation_table(HTML_ENTITIES
);
1301 * Leave " in, as it can mess us up.
1303 $trans = array_flip($trans);
1304 unset($trans{'"'});
1305 while (list($ent, $val) = each($trans)){
1306 $attvalue = preg_replace('/' . $ent . '*/si', $val, $attvalue);
1309 * Now translate numbered entities from 1 to 255 if needed.
1311 if (strpos($attvalue, '#') !== false){
1312 $omit = Array(34, 39);
1313 for ($asc = 256; $asc >= 0; $asc--){
1314 if (!in_array($asc, $omit)){
1316 $octrule = '/\�*' . $asc . ';*/si';
1317 $hexrule = '/\�*' . dechex($asc) . ';*/si';
1318 $attvalue = preg_replace($octrule, $chr, $attvalue);
1319 $attvalue = preg_replace($hexrule, $chr, $attvalue);
1327 * This function runs various checks against the attributes.
1329 * @param $tagname String with the name of the tag.
1330 * @param $attary Array with all tag attributes.
1331 * @param $rm_attnames See description for sq_sanitize
1332 * @param $bad_attvals See description for sq_sanitize
1333 * @param $add_attr_to_tag See description for sq_sanitize
1334 * @param $message message object
1335 * @param $id message id
1336 * @return Array with modified attributes.
1338 function sq_fixatts($tagname,
1348 while (list($attname, $attvalue) = each($attary)){
1350 * See if this attribute should be removed.
1352 foreach ($rm_attnames as $matchtag=>$matchattrs){
1353 if (preg_match($matchtag, $tagname)){
1354 foreach ($matchattrs as $matchattr){
1355 if (preg_match($matchattr, $attname)){
1356 unset($attary{$attname});
1363 * Remove any backslashes, entities, and extraneous whitespace.
1365 $attvalue = sq_unbackslash($attvalue);
1366 $attvalue = sq_deent($attvalue);
1367 $attvalue = sq_unspace($attvalue);
1370 * Now let's run checks on the attvalues.
1371 * I don't expect anyone to comprehend this. If you do,
1372 * get in touch with me so I can drive to where you live and
1373 * shake your hand personally. :)
1375 foreach ($bad_attvals as $matchtag=>$matchattrs){
1376 if (preg_match($matchtag, $tagname)){
1377 foreach ($matchattrs as $matchattr=>$valary){
1378 if (preg_match($matchattr, $attname)){
1380 * There are two arrays in valary.
1382 * Second one is replacements
1384 list($valmatch, $valrepl) = $valary;
1386 preg_replace($valmatch, $valrepl, $attvalue);
1387 if ($newvalue != $attvalue){
1388 $attary{$attname} = $newvalue;
1395 * Turn cid: urls into http-friendly ones.
1397 if (preg_match("/^[\'\"]\s*cid:/si", $attvalue)){
1398 $attary{$attname} = sq_cid2http($message, $id, $attvalue, $mailbox);
1402 * See if we need to append any attributes to this tag.
1404 foreach ($add_attr_to_tag as $matchtag=>$addattary){
1405 if (preg_match($matchtag, $tagname)){
1406 $attary = array_merge($attary, $addattary);
1413 * This function edits the style definition to make them friendly and
1414 * usable in squirrelmail.
1416 * @param $message the message object
1417 * @param $id the message id
1418 * @param $content a string with whatever is between <style> and </style>
1419 * @param $mailbox the message mailbox
1420 * @return a string with edited content.
1422 function sq_fixstyle($body, $pos, $message, $id, $mailbox){
1423 global $view_unsafe_images;
1424 $me = 'sq_fixstyle';
1425 $ret = sq_findnxreg($body, $pos, '</\s*style\s*>');
1427 return array(FALSE, strlen($body));
1429 $newpos = $ret[0] +
strlen($ret[2]);
1432 * First look for general BODY style declaration, which would be
1434 * body {background: blah-blah}
1435 * and change it to .bodyclass so we can just assign it to a <div>
1437 $content = preg_replace("|body(\s*\{.*?\})|si", ".bodyclass\\1", $content);
1438 $secremoveimg = '../images/' . _("sec_remove_eng.png");
1440 * Fix url('blah') declarations.
1442 $content = preg_replace("|url\s*\(\s*([\'\"])\s*\S+script\s*:.*?([\'\"])\s*\)|si",
1443 "url(\\1$secremoveimg\\2)", $content);
1445 * Fix url('https*://.*) declarations but only if $view_unsafe_images
1448 if (!$view_unsafe_images){
1449 $content = preg_replace("|url\s*\(\s*([\'\"])\s*https*:.*?([\'\"])\s*\)|si",
1450 "url(\\1$secremoveimg\\2)", $content);
1454 * Fix urls that refer to cid:
1456 while (preg_match("|url\s*\(\s*([\'\"]\s*cid:.*?[\'\"])\s*\)|si",
1457 $content, $matches)){
1458 $cidurl = $matches{1};
1459 $httpurl = sq_cid2http($message, $id, $cidurl, $mailbox);
1460 $content = preg_replace("|url\s*\(\s*$cidurl\s*\)|si",
1461 "url($httpurl)", $content);
1465 * Fix stupid css declarations which lead to vulnerabilities
1468 $match = Array('/expression/i',
1471 '/include-source/i');
1472 $replace = Array('idiocy', 'idiocy', 'idiocy', 'idiocy');
1473 $content = preg_replace($match, $replace, $content);
1474 return array($content, $newpos);
1478 * This function converts cid: url's into the ones that can be viewed in
1481 * @param $message the message object
1482 * @param $id the message id
1483 * @param $cidurl the cid: url.
1484 * @param $mailbox the message mailbox
1485 * @return a string with a http-friendly url
1487 function sq_cid2http($message, $id, $cidurl, $mailbox){
1489 * Get rid of quotes.
1491 $quotchar = substr($cidurl, 0, 1);
1492 if ($quotchar == '"' ||
$quotchar == "'"){
1493 $cidurl = str_replace($quotchar, "", $cidurl);
1497 $cidurl = substr(trim($cidurl), 4);
1498 $linkurl = find_ent_id($cidurl, $message);
1499 /* in case of non-save cid links $httpurl should be replaced by a sort of
1500 unsave link image */
1503 $httpurl = $quotchar . SM_PATH
. 'src/download.php?absolute_dl=true&' .
1504 "passed_id=$id&mailbox=" . urlencode($mailbox) .
1505 '&ent_id=' . $linkurl . $quotchar;
1511 * This function changes the <body> tag into a <div> tag since we
1512 * can't really have a body-within-body.
1514 * @param $attary an array of attributes and values of <body>
1515 * @param $mailbox mailbox we're currently reading (for cid2http)
1516 * @param $message current message (for cid2http)
1517 * @param $id current message id (for cid2http)
1518 * @return a modified array of attributes to be set for <div>
1520 function sq_body2div($attary, $mailbox, $message, $id){
1521 $me = 'sq_body2div';
1522 $divattary = Array('class' => "'bodyclass'");
1523 $bgcolor = '#ffffff';
1525 $has_bgc_stl = $has_txt_stl = false;
1527 if (is_array($attary) && sizeof($attary) > 0){
1528 foreach ($attary as $attname=>$attvalue){
1529 $quotchar = substr($attvalue, 0, 1);
1530 $attvalue = str_replace($quotchar, "", $attvalue);
1533 $attvalue = sq_cid2http($message, $id,
1534 $attvalue, $mailbox);
1535 $styledef .= "background-image: url('$attvalue'); ";
1538 $has_bgc_stl = true;
1539 $styledef .= "background-color: $attvalue; ";
1542 $has_txt_stl = true;
1543 $styledef .= "color: $attvalue; ";
1547 // Outlook defines a white bgcolor and no text color. This can lead to
1548 // white text on a white bg with certain themes.
1549 if ($has_bgc_stl && !$has_txt_stl) {
1550 $styledef .= "color: $text; ";
1552 if (strlen($styledef) > 0){
1553 $divattary{"style"} = "\"$styledef\"";
1560 * This is the main function and the one you should actually be calling.
1561 * There are several variables you should be aware of an which need
1562 * special description.
1564 * Since the description is quite lengthy, see it here:
1565 * http://www.mricon.com/html/phpfilter.html
1567 * @param $body the string with HTML you wish to filter
1568 * @param $tag_list see description above
1569 * @param $rm_tags_with_content see description above
1570 * @param $self_closing_tags see description above
1571 * @param $force_tag_closing see description above
1572 * @param $rm_attnames see description above
1573 * @param $bad_attvals see description above
1574 * @param $add_attr_to_tag see description above
1575 * @param $message message object
1576 * @param $id message id
1577 * @return sanitized html safe to show on your pages.
1579 function sq_sanitize($body,
1581 $rm_tags_with_content,
1591 $me = 'sq_sanitize';
1592 $rm_tags = array_shift($tag_list);
1594 * Normalize rm_tags and rm_tags_with_content.
1596 @array_walk
($tag_list, 'sq_casenormalize');
1597 @array_walk
($rm_tags_with_content, 'sq_casenormalize');
1598 @array_walk
($self_closing_tags, 'sq_casenormalize');
1600 * See if tag_list is of tags to remove or tags to allow.
1601 * false means remove these tags
1602 * true means allow these tags
1605 $open_tags = Array();
1606 $trusted = "\n<!-- begin sanitized html -->\n";
1607 $skip_content = false;
1609 * Take care of netscape's stupid javascript entities like
1612 $body = preg_replace("/&(\{.*?\};)/si", "&\\1", $body);
1614 while (($curtag = sq_getnxtag($body, $curpos)) != FALSE){
1615 list($tagname, $attary, $tagtype, $lt, $gt) = $curtag;
1616 $free_content = substr($body, $curpos, $lt-$curpos);
1618 * Take care of <style>
1620 if ($tagname == "style" && $tagtype == 1){
1621 list($free_content, $curpos) =
1622 sq_fixstyle($body, $gt+
1, $message, $id, $mailbox);
1623 if ($free_content != FALSE){
1624 $trusted .= sq_tagprint($tagname, $attary, $tagtype);
1625 $trusted .= $free_content;
1626 $trusted .= sq_tagprint($tagname, false, 2);
1630 if ($skip_content == false){
1631 $trusted .= $free_content;
1633 if ($tagname != FALSE){
1635 if ($skip_content == $tagname){
1637 * Got to the end of tag we needed to remove.
1640 $skip_content = false;
1642 if ($skip_content == false){
1643 if ($tagname == "body"){
1646 if (isset($open_tags{$tagname}) &&
1647 $open_tags{$tagname} > 0){
1648 $open_tags{$tagname}--;
1656 * $rm_tags_with_content
1658 if ($skip_content == false){
1660 * See if this is a self-closing type and change
1661 * tagtype appropriately.
1664 && in_array($tagname, $self_closing_tags)){
1668 * See if we should skip this tag and any content
1671 if ($tagtype == 1 &&
1672 in_array($tagname, $rm_tags_with_content)){
1673 $skip_content = $tagname;
1675 if (($rm_tags == false
1676 && in_array($tagname, $tag_list)) ||
1677 ($rm_tags == true &&
1678 !in_array($tagname, $tag_list))){
1682 * Convert body into div.
1684 if ($tagname == "body"){
1686 $attary = sq_body2div($attary, $mailbox,
1690 if (isset($open_tags{$tagname})){
1691 $open_tags{$tagname}++
;
1693 $open_tags{$tagname}=1;
1697 * This is where we run other checks.
1699 if (is_array($attary) && sizeof($attary) > 0){
1700 $attary = sq_fixatts($tagname,
1714 if ($tagname != false && $skip_content == false){
1715 $trusted .= sq_tagprint($tagname, $attary, $tagtype);
1720 $trusted .= substr($body, $curpos, strlen($body)-$curpos);
1721 if ($force_tag_closing == true){
1722 foreach ($open_tags as $tagname=>$opentimes){
1723 while ($opentimes > 0){
1724 $trusted .= '</' . $tagname . '>';
1730 $trusted .= "<!-- end sanitized html -->\n";
1735 * This is a wrapper function to call html sanitizing routines.
1737 * @param $body the body of the message
1738 * @param $id the id of the message
1739 * @return a string with html safe to display in the browser.
1741 function magicHTML($body, $id, $message, $mailbox = 'INBOX') {
1742 global $attachment_common_show_images, $view_unsafe_images,
1745 * Don't display attached images in HTML mode.
1747 $attachment_common_show_images = false;
1762 $rm_tags_with_content = Array(
1771 $self_closing_tags = Array(
1778 $force_tag_closing = true;
1780 $rm_attnames = Array(
1791 $secremoveimg = "../images/" . _("sec_remove_eng.png");
1792 $bad_attvals = Array(
1795 "/^src|background/i" =>
1798 "/^([\'\"])\s*\S+script\s*:.*([\'\"])/si",
1799 "/^([\'\"])\s*mocha\s*:*.*([\'\"])/si",
1800 "/^([\'\"])\s*about\s*:.*([\'\"])/si"
1803 "\\1$secremoveimg\\2",
1804 "\\1$secremoveimg\\2",
1805 "\\1$secremoveimg\\2",
1806 "\\1$secremoveimg\\2"
1809 "/^href|action/i" =>
1812 "/^([\'\"])\s*\S+script\s*:.*([\'\"])/si",
1813 "/^([\'\"])\s*mocha\s*:*.*([\'\"])/si",
1814 "/^([\'\"])\s*about\s*:.*([\'\"])/si"
1829 "/include-source/i",
1830 "/url\s*\(\s*([\'\"])\s*\S+script\s*:.*([\'\"])\s*\)/si",
1831 "/url\s*\(\s*([\'\"])\s*mocha\s*:.*([\'\"])\s*\)/si",
1832 "/url\s*\(\s*([\'\"])\s*about\s*:.*([\'\"])\s*\)/si"
1847 if( !sqgetGlobalVar('view_unsafe_images', $view_unsafe_images, SQ_GET
) ) {
1848 $view_unsafe_images = false;
1850 if (!$view_unsafe_images){
1852 * Remove any references to http/https if view_unsafe_images set
1855 array_push($bad_attvals{'/.*/'}{'/^src|background/i'}[0],
1856 '/^([\'\"])\s*https*:.*([\'\"])/si');
1857 array_push($bad_attvals{'/.*/'}{'/^src|background/i'}[1],
1858 "\\1$secremoveimg\\1");
1859 array_push($bad_attvals{'/.*/'}{'/^style/i'}[0],
1860 '/url\(([\'\"])\s*https*:.*([\'\"])\)/si');
1861 array_push($bad_attvals{'/.*/'}{'/^style/i'}[1],
1862 "url(\\1$secremoveimg\\1)");
1865 $add_attr_to_tag = Array(
1867 Array('target'=>'"_new"',
1868 'title'=>'"'._("This external link will open in a new window").'"'
1871 $trusted = sq_sanitize($body,
1873 $rm_tags_with_content,
1883 if (preg_match("|$secremoveimg|i", $trusted)){
1884 $has_unsafe_images = true;
1890 * function SendDownloadHeaders - send file to the browser
1892 * Original Source: SM core src/download.php
1893 * moved here to make it available to other code, and separate
1894 * front end from back end functionality.
1896 * @param string $type0 first half of mime type
1897 * @param string $type1 second half of mime type
1898 * @param string $filename filename to tell the browser for downloaded file
1899 * @param boolean $force whether to force the download dialog to pop
1900 * @param integer $filesize optional, send the Content-Header and length to the browser
1903 function SendDownloadHeaders($type0, $type1, $filename, $force, $filesize=0) {
1904 global $languages, $squirrelmail_language;
1907 sqgetGlobalVar('HTTP_USER_AGENT', $HTTP_USER_AGENT, SQ_SERVER
);
1909 if (strstr($HTTP_USER_AGENT, 'compatible; MSIE ') !== false &&
1910 strstr($HTTP_USER_AGENT, 'Opera') === false) {
1914 if (strstr($HTTP_USER_AGENT, 'compatible; MSIE 6') !== false &&
1915 strstr($HTTP_USER_AGENT, 'Opera') === false) {
1919 if (isset($languages[$squirrelmail_language]['XTRA_CODE']) &&
1920 function_exists($languages[$squirrelmail_language]['XTRA_CODE'])) {
1922 $languages[$squirrelmail_language]['XTRA_CODE']('downloadfilename', $filename, $HTTP_USER_AGENT);
1924 $filename = ereg_replace('[\\/:\*\?"<>\|;]', '_', str_replace(' ', ' ', $filename));
1927 // A Pox on Microsoft and it's Office!
1929 // Try to show in browser window
1930 header("Content-Disposition: inline; filename=\"$filename\"");
1931 header("Content-Type: $type0/$type1; name=\"$filename\"");
1933 // Try to pop up the "save as" box
1934 // IE makes this hard. It pops up 2 save boxes, or none.
1935 // http://support.microsoft.com/support/kb/articles/Q238/5/88.ASP
1936 // But, accordint to Microsoft, it is "RFC compliant but doesn't
1937 // take into account some deviations that allowed within the
1938 // specification." Doesn't that mean RFC non-compliant?
1939 // http://support.microsoft.com/support/kb/articles/Q258/4/52.ASP
1941 // The best thing you can do for IE is to upgrade to the latest
1943 if ($isIE && !$isIE6) {
1944 // http://support.microsoft.com/support/kb/articles/Q182/3/15.asp
1945 // Do not have quotes around filename, but that applied to
1946 // "attachment"... does it apply to inline too?
1948 // This combination seems to work mostly. IE 5.5 SP 1 has
1949 // known issues (see the Microsoft Knowledge Base)
1950 header("Content-Disposition: inline; filename=$filename");
1951 // This works for most types, but doesn't work with Word files
1952 header("Content-Type: application/download; name=\"$filename\"");
1954 // These are spares, just in case. :-)
1955 //header("Content-Type: $type0/$type1; name=\"$filename\"");
1956 //header("Content-Type: application/x-msdownload; name=\"$filename\"");
1957 //header("Content-Type: application/octet-stream; name=\"$filename\"");
1959 header("Content-Disposition: attachment; filename=\"$filename\"");
1960 // application/octet-stream forces download for Netscape
1961 header("Content-Type: application/octet-stream; name=\"$filename\"");
1965 //send the content-length header if the calling function provides it
1966 if ($filesize > 0) {
1967 header("Content-Length: $filesize");
1970 } // end fn SendDownlaodHeaders