6 * This contains the functions necessary to detect and decode MIME
9 * @copyright © 1999-2007 The SquirrelMail Project Team
10 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
12 * @package squirrelmail
16 * dependency information
19 class/mime/Message.class.php
20 Message::parseStructure
21 functions/page_header.php
23 functions/display_messages.php
26 functions/imap_general.php
33 functions/attachment_common.php
34 functions/display_messages.php
36 magicHtml => url_parser
37 translateText => url_parser
42 /* -------------------------------------------------------------------------- */
44 /* -------------------------------------------------------------------------- */
47 * Get the MIME structure
49 * This function gets the structure of a message and stores it in the "message" class.
50 * It will return this object for use with all relevant header information and
51 * fully parsed into the standard "message" object format.
53 function mime_structure ($bodystructure, $flags=array()) {
55 /* Isolate the body structure and remove beginning and end parenthesis. */
56 $read = trim(substr ($bodystructure, strpos(strtolower($bodystructure), 'bodystructure') +
13));
57 $read = trim(substr ($read, 0, -1));
59 $msg = Message
::parseStructure($read,$i);
61 if (!is_object($msg)) {
62 global $color, $mailbox;
63 /* removed urldecode because $_GET is auto urldecoded ??? */
64 displayPageHeader( $color, $mailbox );
65 $errormessage = _("SquirrelMail could not decode the bodystructure of the message");
66 $errormessage .= '<br />'._("The bodystructure provided by your IMAP server:").'<br /><br />';
67 $errormessage .= '<pre>' . htmlspecialchars($read) . '</pre>';
68 plain_error_message( $errormessage, $color );
69 echo '</body></html>';
73 foreach ($flags as $flag) {
74 $char = strtoupper($flag{1});
77 if (strtolower($flag) == '\\seen') {
82 if (strtolower($flag) == '\\answered') {
83 $msg->is_answered
= true;
87 if (strtolower($flag) == '\\deleted') {
88 $msg->is_deleted
= true;
92 if (strtolower($flag) == '\\flagged') {
93 $msg->is_flagged
= true;
97 if (strtolower($flag) == '$mdnsent') {
98 $msg->is_mdnsent
= true;
106 // listEntities($msg);
112 /* This starts the parsing of a particular structure. It is called recursively,
113 * so it can be passed different structures. It returns an object of type
115 * First, it checks to see if it is a multipart message. If it is, then it
116 * handles that as it sees is necessary. If it is just a regular entity,
117 * then it parses it and adds the necessary header information (by calling out
118 * to mime_get_elements()
121 function mime_fetch_body($imap_stream, $id, $ent_id=1, $fetch_size=0) {
122 /* Do a bit of error correction. If we couldn't find the entity id, just guess
123 * that it is the first one. That is usually the case anyway.
127 $cmd = "FETCH $id BODY[]";
129 $cmd = "FETCH $id BODY[$ent_id]";
132 if ($fetch_size!=0) $cmd .= "<0.$fetch_size>";
134 $data = sqimap_run_command ($imap_stream, $cmd, true, $response, $message, TRUE);
136 $topline = trim(array_shift($data));
137 } while($topline && ($topline[0] == '*') && !preg_match('/\* [0-9]+ FETCH.*/i', $topline)) ;
139 $wholemessage = implode('', $data);
140 if (ereg('\\{([^\\}]*)\\}', $topline, $regs)) {
141 $ret = substr($wholemessage, 0, $regs[1]);
142 /* There is some information in the content info header that could be important
143 * in order to parse html messages. Let's get them here.
145 // if ($ret{0} == '<') {
146 // $data = sqimap_run_command ($imap_stream, "FETCH $id BODY[$ent_id.MIME]", true, $response, $message, TRUE);
148 } else if (ereg('"([^"]*)"', $topline, $regs)) {
151 global $where, $what, $mailbox, $passed_id, $startMessage;
152 $par = 'mailbox=' . urlencode($mailbox) . '&passed_id=' . $passed_id;
153 if (isset($where) && isset($what)) {
154 $par .= '&where=' . urlencode($where) . '&what=' . urlencode($what);
156 $par .= '&startMessage=' . $startMessage . '&show_more=0';
158 $par .= '&response=' . urlencode($response) .
159 '&message=' . urlencode($message) .
160 '&topline=' . urlencode($topline);
163 '<table width="80%"><tr>' .
164 '<tr><td colspan="2">' .
165 _("Body retrieval error. The reason for this is most probably that the message is malformed.") .
167 '<tr><td><b>' . _("Command:") . "</td><td>$cmd</td></tr>" .
168 '<tr><td><b>' . _("Response:") . "</td><td>$response</td></tr>" .
169 '<tr><td><b>' . _("Message:") . "</td><td>$message</td></tr>" .
170 '<tr><td><b>' . _("FETCH line:") . "</td><td>$topline</td></tr>" .
171 "</table><br /></tt></font><hr />";
173 $data = sqimap_run_command ($imap_stream, "FETCH $passed_id BODY[]", true, $response, $message, TRUE);
175 $wholemessage = implode('', $data);
177 $ret = $wholemessage;
182 function mime_print_body_lines ($imap_stream, $id, $ent_id=1, $encoding, $rStream='php://stdout') {
184 /* Don't kill the connection if the browser is over a dialup
185 * and it would take over 30 seconds to download it.
186 * Don't call set_time_limit in safe mode.
189 if (!ini_get('safe_mode')) {
192 /* in case of base64 encoded attachments, do not buffer them.
193 Instead, echo the decoded attachment directly to screen */
194 if (strtolower($encoding) == 'base64') {
196 $query = "FETCH $id BODY[]";
198 $query = "FETCH $id BODY[$ent_id]";
200 sqimap_run_command($imap_stream,$query,true,$response,$message,TRUE,'sqimap_base64_decode',$rStream,true);
202 $body = mime_fetch_body ($imap_stream, $id, $ent_id);
203 if (is_resource($rStream)) {
204 fputs($rStream,decodeBody($body,$encoding));
206 echo decodeBody($body, $encoding);
211 TODO, use the same method for quoted printable.
212 However, I assume that quoted printable attachments aren't that large
213 so the performancegain / memory usage drop will be minimal.
214 If we decide to add that then we need to adapt sqimap_fread because
215 we need to split te result on \n and fread doesn't stop at \n. That
216 means we also should provide $results from sqimap_fread (by ref) to
217 te function and set $no_return to false. The $filter function for
218 quoted printable should handle unsetting of $results.
221 TODO 2: find out how we write to the output stream php://stdout. fwrite
222 doesn't work because 'php://stdout isn't a stream.
228 /* -[ END MIME DECODING ]----------------------------------------------------------- */
230 /* This is here for debugging purposes. It will print out a list
231 * of all the entity IDs that are in the $message object.
233 function listEntities ($message) {
235 echo "<tt>" . $message->entity_id
. ' : ' . $message->type0
. '/' . $message->type1
. ' parent = '. $message->parent
->entity_id
. '<br />';
236 for ($i = 0; isset($message->entities
[$i]); $i++
) {
238 $msg = listEntities($message->entities
[$i]);
248 function getPriorityStr($priority) {
249 $priority_level = substr($priority,0,1);
251 switch($priority_level) {
252 /* Check for a higher then normal priority. */
255 $priority_string = _("High");
258 /* Check for a lower then normal priority. */
261 $priority_string = _("Low");
264 /* Check for a normal priority. */
267 $priority_level = '3';
268 $priority_string = _("Normal");
272 return $priority_string;
275 /* returns a $message object for a particular entity id */
276 function getEntity ($message, $ent_id) {
277 return $message->getEntity($ent_id);
281 * Extracted from strings.php 23/03/2002
284 function translateText(&$body, $wrap_at, $charset) {
285 global $where, $what; /* from searching */
286 global $color; /* color theme */
288 // require_once(SM_PATH . 'functions/url_parser.php');
290 $body_ary = explode("\n", $body);
291 for ($i=0; $i < count($body_ary); $i++
) {
292 $line = $body_ary[$i];
293 if (strlen($line) - 2 >= $wrap_at) {
294 sqWordWrap($line, $wrap_at, $charset);
296 $line = charset_decode($charset, $line);
297 $line = str_replace("\t", ' ', $line);
306 if ($line[$pos] == ' ') {
308 } else if (strpos($line, '>', $pos) === $pos) {
317 $line = '<span class="quote1">' . $line . '</span>';
319 $line = '<span class="quote2">' . $line . '</span>';
322 $body_ary[$i] = $line;
324 $body = '<pre>' . implode("\n", $body_ary) . '</pre>';
328 * This returns a parsed string called $body. That string can then
329 * be displayed as the actual message in the HTML. It contains
330 * everything needed, including HTML Tags, Attachments at the
333 * Since 1.2.0 function uses message_body hook.
334 * Till 1.3.0 function included output of formatAttachments().
336 * @param resource $imap_stream imap connection resource
337 * @param object $message squirrelmail message object
338 * @param array $color squirrelmail color theme array
339 * @param integer $wrap_at number of characters per line
340 * @param string $ent_num (since 1.3.0) message part id
341 * @param integer $id (since 1.3.0) message id
342 * @param string $mailbox (since 1.3.0) imap folder name
343 * @param boolean $clean (since 1.5.1) Do not output stuff that's irrelevant for the printable version.
344 * @return string html formated message text
346 function formatBody($imap_stream, $message, $color, $wrap_at, $ent_num, $id, $mailbox='INBOX', $clean=FALSE) {
347 /* This if statement checks for the entity to show as the
348 * primary message. To add more of them, just put them in the
349 * order that is their priority.
351 global $startMessage, $languages, $squirrelmail_language,
352 $show_html_default, $sort, $has_unsafe_images, $passed_ent_id,
353 $use_iframe, $iframe_height, $download_and_unsafe_link,
354 $download_href, $unsafe_image_toggle_href, $unsafe_image_toggle_text,
357 $nbsp = $oTemplate->fetch('non_breaking_space.tpl');
359 // workaround for not updated config.php
360 if (! isset($use_iframe)) $use_iframe = false;
362 if( !sqgetGlobalVar('view_unsafe_images', $view_unsafe_images, SQ_GET
) ) {
363 $view_unsafe_images = false;
367 $urlmailbox = urlencode($mailbox);
368 $body_message = getEntity($message, $ent_num);
369 if (($body_message->header
->type0
== 'text') ||
370 ($body_message->header
->type0
== 'rfc822')) {
371 $body = mime_fetch_body ($imap_stream, $id, $ent_num);
372 $body = decodeBody($body, $body_message->header
->encoding
);
374 if (isset($languages[$squirrelmail_language]['XTRA_CODE']) &&
375 function_exists($languages[$squirrelmail_language]['XTRA_CODE'] . '_decode')) {
376 if (mb_detect_encoding($body) != 'ASCII') {
377 $body = call_user_func($languages[$squirrelmail_language]['XTRA_CODE'] . '_decode',$body);
381 /* As of 1.5.2, $body is passed (and modified) by reference */
382 do_hook('message_body', $body);
384 /* If there are other types that shouldn't be formatted, add
388 if ($body_message->header
->type1
== 'html') {
389 if ($show_html_default <> 1) {
390 $entity_conv = array(' ' => ' ',
399 $body = strtr($body, $entity_conv);
400 $body = strip_tags($body);
402 translateText($body, $wrap_at,
403 $body_message->header
->getParameter('charset'));
404 } elseif ($use_iframe && ! $clean) {
405 // $clean is used to remove iframe in printable view.
408 * If we don't add html message between iframe tags,
409 * we must detect unsafe images and modify $has_unsafe_images.
411 $html_body = magicHTML($body, $id, $message, $mailbox);
412 // Convert character set in order to display html mails in different character set
413 $html_body = charset_decode($body_message->header
->getParameter('charset'),$html_body,false,true);
415 // creating iframe url
416 $iframeurl=sqm_baseuri().'src/view_html.php?'
417 . 'mailbox=' . $urlmailbox
418 . '&passed_id=' . $id
419 . '&ent_id=' . $ent_num
420 . '&view_unsafe_images=' . (int) $view_unsafe_images;
423 $oTemplate->assign('iframe_url', $iframeurl);
424 $oTemplate->assign('html_body', $html_body);
426 $body = $oTemplate->fetch('read_html_iframe.tpl');
428 // old way of html rendering
429 $body = magicHTML($body, $id, $message, $mailbox);
431 * convert character set. charset_decode does not remove html special chars
432 * applied by magicHTML functions and does not sanitize them second time if
433 * fourth argument is true.
435 $body = charset_decode($body_message->header
->getParameter('charset'),$body,false,true);
438 translateText($body, $wrap_at,
439 $body_message->header
->getParameter('charset'));
442 // if this is the clean display (i.e. printer friendly), stop here.
447 $download_and_unsafe_link = '';
449 $link = 'passed_id=' . $id . '&ent_id='.$ent_num.
450 '&mailbox=' . $urlmailbox .'&sort=' . $sort .
451 '&startMessage=' . $startMessage . '&show_more=0';
452 if (isset($passed_ent_id)) {
453 $link .= '&passed_ent_id='.$passed_ent_id;
455 $download_href = SM_PATH
. 'src/download.php?absolute_dl=true&' . $link;
456 $download_and_unsafe_link .= "$nbsp|$nbsp"
457 . create_hyperlink($download_href, _("Download this as a file"));
458 if ($view_unsafe_images) {
459 $text = _("Hide Unsafe Images");
461 if (isset($has_unsafe_images) && $has_unsafe_images) {
462 $link .= '&view_unsafe_images=1';
463 $text = _("View Unsafe Images");
469 $unsafe_image_toggle_href = SM_PATH
. 'src/read_body.php?'.$link;
470 $unsafe_image_toggle_text = $text;
471 $download_and_unsafe_link .= "$nbsp|$nbsp"
472 . create_hyperlink($unsafe_image_toggle_href, $text);
479 * Generate attachments array for passing to templates. Separated from
480 * formatAttachments() below so that the same array can be given to the
481 * print-friendly version.
484 * @param object $message SquirrelMail message object
485 * @param array $exclude_id message parts that are not attachments.
486 * @param string $mailbox mailbox name
487 * @param integer $id message id
489 function buildAttachmentArray($message, $exclude_id, $mailbox, $id) {
490 global $where, $what, $startMessage, $color, $passed_ent_id, $base_uri;
492 $att_ar = $message->getAttachments($exclude_id);
493 $urlMailbox = urlencode($mailbox);
495 $attachments = array();
496 foreach ($att_ar as $att) {
497 $ent = $att->entity_id
;
498 $header = $att->header
;
499 $type0 = strtolower($header->type0
);
500 $type1 = strtolower($header->type1
);
503 $links['download link']['text'] = _("Download");
504 $links['download link']['href'] = $base_uri .
505 "src/download.php?absolute_dl=true&passed_id=$id&mailbox=$urlMailbox&ent_id=$ent";
507 if ($type0 =='message' && $type1 == 'rfc822') {
508 $default_page = $base_uri . 'src/read_body.php';
509 $rfc822_header = $att->rfc822_header
;
510 $filename = $rfc822_header->subject
;
511 if (trim( $filename ) == '') {
512 $filename = 'untitled-[' . $ent . ']' ;
514 $from_o = $rfc822_header->from
;
515 if (is_object($from_o)) {
516 $from_name = decodeHeader($from_o->getAddress(false));
517 } elseif (is_array($from_o) && count($from_o) && is_object($from_o[0])) {
518 // something weird happens when a digest message is opened and you return to the digest
519 // now the from object is part of an array. Probably the parseHeader call overwrites the info
520 // retrieved from the bodystructure in a different way. We need to fix this later.
521 // possible starting point, do not fetch header we already have and inspect how
522 // the rfc822_header object behaves.
523 $from_name = decodeHeader($from_o[0]->getAddress(false));
525 $from_name = _("Unknown sender");
527 $description = _("From").': '.$from_name;
529 $default_page = $base_uri . 'src/download.php';
530 $filename = $att->getFilename();
531 if ($header->description
) {
532 $description = decodeHeader($header->description
);
538 $display_filename = $filename;
539 if (isset($passed_ent_id)) {
540 $passed_ent_id_link = '&passed_ent_id='.$passed_ent_id;
542 $passed_ent_id_link = '';
544 $defaultlink = $default_page . "?startMessage=$startMessage"
545 . "&passed_id=$id&mailbox=$urlMailbox"
546 . '&ent_id='.$ent.$passed_ent_id_link;
547 if ($where && $what) {
548 $defaultlink .= '&where='. urlencode($where).'&what='.urlencode($what);
550 // IE does make use of mime content sniffing. Forcing a download
551 // prohibit execution of XSS inside an application/octet-stream attachment
552 if ($type0 == 'application' && $type1 == 'octet-stream') {
553 $defaultlink .= '&absolute_dl=true';
556 /* This executes the attachment hook with a specific MIME-type.
557 * If that doesn't have results, it tries if there's a rule
558 * for a more generic type. Finally, a hook for ALL attachment
559 * types is run as well.
561 /* The API for this hook has changed as of 1.5.2 so that all plugin
562 arguments are passed in an array instead of each their own plugin
563 argument, and arguments are passed by reference, so instead of
564 returning any changes, changes should simply be made to the original
565 arguments themselves. */
566 do_hook("attachment $type0/$type1", $temp=array(&$links,
567 &$startMessage, &$id, &$urlMailbox, &$ent, &$defaultlink,
568 &$display_filename, &$where, &$what));
569 if(count($links) <= 1) {
570 /* The API for this hook has changed as of 1.5.2 so that all plugin
571 arguments are passed in an array instead of each their own plugin
572 argument, and arguments are passed by reference, so instead of
573 returning any changes, changes should simply be made to the original
574 arguments themselves. */
575 do_hook("attachment $type0/*", $temp=array(&$links,
576 &$startMessage, &$id, &$urlMailbox, &$ent, &$defaultlink,
577 &$display_filename, &$where, &$what));
579 /* The API for this hook has changed as of 1.5.2 so that all plugin
580 arguments are passed in an array instead of each their own plugin
581 argument, and arguments are passed by reference, so instead of
582 returning any changes, changes should simply be made to the original
583 arguments themselves. */
584 do_hook("attachment */*", $temp=array(&$links,
585 &$startMessage, &$id, &$urlMailbox, &$ent, &$defaultlink,
586 &$display_filename, &$where, &$what));
588 $this_attachment = array();
589 $this_attachment['Name'] = decodeHeader($display_filename);
590 $this_attachment['Description'] = $description;
591 $this_attachment['DefaultHREF'] = $defaultlink;
592 $this_attachment['DownloadHREF'] = $links['download link']['href'];
593 $this_attachment['ViewHREF'] = isset($links['attachment_common']) ?
$links['attachment_common']['href'] : '';
594 $this_attachment['Size'] = $header->size
;
595 $this_attachment['ContentType'] = htmlspecialchars($type0 .'/'. $type1);
596 $this_attachment['OtherLinks'] = array();
597 foreach ($links as $val) {
598 if ($val['text']==_("Download") ||
$val['text'] == _("View"))
600 if (empty($val['text']) && empty($val['extra']))
604 $temp['HREF'] = $val['href'];
605 $temp['Text'] = (empty($val['text']) ?
'' : $val['text']) . (empty($val['extra']) ?
'' : $val['extra']);
606 $this_attachment['OtherLinks'][] = $temp;
608 $attachments[] = $this_attachment;
617 * Displays attachment links and information
619 * Since 1.3.0 function is not included in formatBody() call.
621 * Since 1.0.2 uses attachment $type0/$type1 hook.
622 * Since 1.2.5 uses attachment $type0/* hook.
623 * Since 1.5.0 uses attachments_bottom hook.
624 * Since 1.5.2 uses templates and does *not* return a value.
626 * @param object $message SquirrelMail message object
627 * @param array $exclude_id message parts that are not attachments.
628 * @param string $mailbox mailbox name
629 * @param integer $id message id
631 function formatAttachments($message, $exclude_id, $mailbox, $id) {
634 $attach = buildAttachmentArray($message, $exclude_id, $mailbox, $id);
636 $oTemplate->assign('attachments', $attach);
637 $oTemplate->display('read_attachments.tpl');
640 function sqimap_base64_decode(&$string) {
642 // Base64 encoded data goes in pairs of 4 bytes. To achieve on the
643 // fly decoding (to reduce memory usage) you have to check if the
644 // data has incomplete pairs
646 // Remove the noise in order to check if the 4 bytes pairs are complete
647 $string = str_replace(array("\r\n","\n", "\r", " "),array('','','',''),$string);
650 $iMod = strlen($string) %
4;
652 $sStringRem = substr($string,-$iMod);
653 // Check if $sStringRem contains padding characters
654 if (substr($sStringRem,-1) != '=') {
655 $string = substr($string,0,-$iMod);
660 $string = base64_decode($string);
665 * Decodes encoded message body
667 * This function decodes the body depending on the encoding type.
668 * Currently quoted-printable and base64 encodings are supported.
669 * decode_body hook was added to this function in 1.4.2/1.5.0
670 * @param string $body encoded message body
671 * @param string $encoding used encoding
672 * @return string decoded string
675 function decodeBody($body, $encoding) {
677 $body = str_replace("\r\n", "\n", $body);
678 $encoding = strtolower($encoding);
680 $encoding_handler = do_hook('decode_body', $encoding);
683 // plugins get first shot at decoding the body
685 if (!empty($encoding_handler) && function_exists($encoding_handler)) {
686 $body = $encoding_handler('decode', $body);
688 } elseif ($encoding == 'quoted-printable' ||
689 $encoding == 'quoted_printable') {
691 * quoted_printable_decode() function is broken in older
692 * php versions. Text with \r\n decoding was fixed only
693 * in php 4.3.0. Minimal code requirement 4.0.4 +
694 * str_replace("\r\n", "\n", $body); call.
696 $body = quoted_printable_decode($body);
697 } elseif ($encoding == 'base64') {
698 $body = base64_decode($body);
701 // All other encodings are returned raw.
708 * This functions decode strings that is encoded according to
709 * RFC1522 (MIME Part Two: Message Header Extensions for Non-ASCII Text).
710 * Patched by Christian Schmidt <christian@ostenfeld.dk> 23/03/2002
712 * @param string $string header string that has to be made readable
713 * @param boolean $utfencode change message in order to be readable on user's charset. defaults to true
714 * @param boolean $htmlsave preserve spaces and sanitize html special characters. defaults to true
715 * @param boolean $decide decide if string can be utfencoded. defaults to false
716 * @return string decoded header string
718 function decodeHeader ($string, $utfencode=true,$htmlsave=true,$decide=false) {
719 global $languages, $squirrelmail_language,$default_charset;
720 if (is_array($string)) {
721 $string = implode("\n", $string);
724 if (isset($languages[$squirrelmail_language]['XTRA_CODE']) &&
725 function_exists($languages[$squirrelmail_language]['XTRA_CODE'] . '_decodeheader')) {
726 $string = call_user_func($languages[$squirrelmail_language]['XTRA_CODE'] . '_decodeheader', $string);
727 // Do we need to return at this point?
734 $aString = explode(' ',$string);
736 foreach ($aString as $chunk) {
737 if ($encoded && $chunk === '') {
739 } elseif ($chunk === '') {
744 /* if encoded words are not separated by a linear-space-white we still catch them */
747 while ($match = preg_match('/^(.*)=\?([^?]*)\?(Q|B)\?([^?]*)\?=(.*)$/Ui',$chunk,$res)) {
748 /* if the last chunk isn't an encoded string then put back the space, otherwise don't */
749 if ($iLastMatch !== $j) {
759 $ret .= htmlspecialchars($res[1]);
763 $encoding = ucfirst($res[3]);
765 /* decide about valid decoding */
766 if ($decide && is_conversion_safe($res[2])) {
768 $can_be_encoded=true;
770 $can_be_encoded=false;
775 $replace = base64_decode($res[4]);
777 if ($can_be_encoded) {
778 /* convert string to different charset,
779 * if functions asks for it (usually in compose)
781 $ret .= charset_convert($res[2],$replace,$default_charset,$htmlsave);
783 // convert string to html codes in order to display it
784 $ret .= charset_decode($res[2],$replace);
788 $replace = htmlspecialchars($replace);
794 $replace = str_replace('_', ' ', $res[4]);
795 $replace = preg_replace('/=([0-9a-f]{2})/ie', 'chr(hexdec("\1"))',
798 if ($can_be_encoded) {
799 /* convert string to different charset,
800 * if functions asks for it (usually in compose)
802 $replace = charset_convert($res[2], $replace,$default_charset,$htmlsave);
804 // convert string to html codes in order to display it
805 $replace = charset_decode($res[2], $replace);
809 $replace = htmlspecialchars($replace);
828 if (!$encoded && $htmlsave) {
829 $ret .= htmlspecialchars($chunk);
835 /* remove the first added space */
838 $ret = substr($ret,5);
840 $ret = substr($ret,1);
850 * Function uses XTRA_CODE _encodeheader function, if such function exists.
852 * Function uses Q encoding by default and encodes a string according to RFC
853 * 1522 for use in headers if it contains 8-bit characters or anything that
854 * looks like it should be encoded.
856 * Function switches to B encoding and encodeHeaderBase64() function, if
857 * string is 8bit and multibyte character set supported by mbstring extension
858 * is used. It can cause E_USER_NOTICE errors, if interface is used with
859 * multibyte character set unsupported by mbstring extension.
861 * @param string $string header string, that has to be encoded
862 * @return string quoted-printable encoded string
863 * @todo make $mb_charsets system wide constant
865 function encodeHeader ($string) {
866 global $default_charset, $languages, $squirrelmail_language;
868 if (isset($languages[$squirrelmail_language]['XTRA_CODE']) &&
869 function_exists($languages[$squirrelmail_language]['XTRA_CODE'] . '_encodeheader')) {
870 return call_user_func($languages[$squirrelmail_language]['XTRA_CODE'] . '_encodeheader', $string);
873 // Use B encoding for multibyte charsets
874 $mb_charsets = array('utf-8','big5','gb2313','euc-kr');
875 if (in_array($default_charset,$mb_charsets) &&
876 in_array($default_charset,sq_mb_list_encodings()) &&
877 sq_is8bit($string)) {
878 return encodeHeaderBase64($string,$default_charset);
879 } elseif (in_array($default_charset,$mb_charsets) &&
880 sq_is8bit($string) &&
881 ! in_array($default_charset,sq_mb_list_encodings())) {
882 // Add E_USER_NOTICE error here (can cause 'Cannot add header information' warning in compose.php)
883 // trigger_error('encodeHeader: Multibyte character set unsupported by mbstring extension.',E_USER_NOTICE);
886 // Encode only if the string contains 8-bit characters or =?
887 $j = strlen($string);
888 $max_l = 75 - strlen($default_charset) - 7;
891 $iEncStart = $enc_init = false;
892 $cur_l = $iOffset = 0;
893 for($i = 0; $i < $j; ++
$i) {
902 if ($iEncStart === false) {
906 if ($cur_l > ($max_l-2)) {
907 /* if there is an stringpart that doesn't need encoding, add it */
908 $aRet[] = substr($string,$iOffset,$iEncStart-$iOffset);
909 $aRet[] = "=?$default_charset?Q?$ret?=";
915 $ret .= sprintf("=%02X",ord($string{$i}));
920 if ($iEncStart !== false) {
921 $aRet[] = substr($string,$iOffset,$iEncStart-$iOffset);
922 $aRet[] = "=?$default_charset?Q?$ret?=";
930 if ($iEncStart !== false) {
932 if ($cur_l > $max_l) {
933 $aRet[] = substr($string,$iOffset,$iEncStart-$iOffset);
934 $aRet[] = "=?$default_charset?Q?$ret?=";
945 $k = ord($string{$i});
947 if ($iEncStart === false) {
948 // do not start encoding in the middle of a string, also take the rest of the word.
949 $sLeadString = substr($string,0,$i);
950 $aLeadString = explode(' ',$sLeadString);
951 $sToBeEncoded = array_pop($aLeadString);
952 $iEncStart = $i - strlen($sToBeEncoded);
953 $ret .= $sToBeEncoded;
954 $cur_l +
= strlen($sToBeEncoded);
957 /* first we add the encoded string that reached it's max size */
958 if ($cur_l > ($max_l-2)) {
959 $aRet[] = substr($string,$iOffset,$iEncStart-$iOffset);
960 $aRet[] = "=?$default_charset?Q?$ret?= "; /* the next part is also encoded => separate by space */
967 $ret .= sprintf("=%02X", $k);
969 if ($iEncStart !== false) {
971 if ($cur_l > $max_l) {
972 $aRet[] = substr($string,$iOffset,$iEncStart-$iOffset);
973 $aRet[] = "=?$default_charset?Q?$ret?=";
988 if ($iEncStart !== false) {
989 $aRet[] = substr($string,$iOffset,$iEncStart-$iOffset);
990 $aRet[] = "=?$default_charset?Q?$ret?=";
992 $aRet[] = substr($string,$iOffset);
994 $string = implode('',$aRet);
1000 * Encodes string according to rfc2047 B encoding header formating rules
1002 * It is recommended way to encode headers with character sets that store
1003 * symbols in more than one byte.
1005 * Function requires mbstring support. If required mbstring functions are missing,
1006 * function returns false and sets E_USER_WARNING level error message.
1008 * Minimal requirements - php 4.0.6 with mbstring extension. Please note,
1009 * that mbstring functions will generate E_WARNING errors, if unsupported
1010 * character set is used. mb_encode_mimeheader function provided by php
1011 * mbstring extension is not used in order to get better control of header
1014 * Used php code functions - function_exists(), trigger_error(), strlen()
1015 * (is used with charset names and base64 strings). Used php mbstring
1016 * functions - mb_strlen and mb_substr.
1018 * Related documents: rfc 2045 (BASE64 encoding), rfc 2047 (mime header
1019 * encoding), rfc 2822 (header folding)
1021 * @param string $string header string that must be encoded
1022 * @param string $charset character set. Must be supported by mbstring extension.
1023 * Use sq_mb_list_encodings() to detect supported charsets.
1024 * @return string string encoded according to rfc2047 B encoding formating rules
1026 * @todo First header line can be wrapped to $iMaxLength - $HeaderFieldLength - 1
1027 * @todo Do we want to control max length of header?
1028 * @todo Do we want to control EOL (end-of-line) marker?
1029 * @todo Do we want to translate error message?
1031 function encodeHeaderBase64($string,$charset) {
1033 * Check mbstring function requirements.
1035 if (! function_exists('mb_strlen') ||
1036 ! function_exists('mb_substr')) {
1037 // set E_USER_WARNING
1038 trigger_error('encodeHeaderBase64: Required mbstring functions are missing.',E_USER_WARNING
);
1043 // initial return array
1047 * header length = 75 symbols max (same as in encodeHeader)
1048 * remove $charset length
1049 * remove =? ? ?= (5 chars)
1050 * remove 2 more chars (\r\n ?)
1052 $iMaxLength = 75 - strlen($charset) - 7;
1054 // set first character position
1057 // loop through all characters. count characters and not bytes.
1058 for ($iCharNum=1; $iCharNum<=mb_strlen($string,$charset); $iCharNum++
) {
1059 // encode string from starting character to current character.
1060 $encoded_string = base64_encode(mb_substr($string,$iStartCharNum,$iCharNum-$iStartCharNum,$charset));
1062 // Check encoded string length
1063 if(strlen($encoded_string)>$iMaxLength) {
1064 // if string exceeds max length, reduce number of encoded characters and add encoded string part to array
1065 $aRet[] = base64_encode(mb_substr($string,$iStartCharNum,$iCharNum-$iStartCharNum-1,$charset));
1067 // set new starting character
1068 $iStartCharNum = $iCharNum-1;
1070 // encode last char (in case it is last character in string)
1071 $encoded_string = base64_encode(mb_substr($string,$iStartCharNum,$iCharNum-$iStartCharNum,$charset));
1072 } // if string is shorter than max length - add next character
1075 // add last encoded string to array
1076 $aRet[] = $encoded_string;
1078 // set initial return string
1081 // loop through encoded strings
1082 foreach($aRet as $string) {
1083 // TODO: Do we want to control EOL (end-of-line) marker
1084 if ($sRet!='') $sRet.= " ";
1086 // add header tags and encoded string to return string
1087 $sRet.= '=?'.$charset.'?B?'.$string.'?=';
1093 /* This function trys to locate the entity_id of a specific mime element */
1094 function find_ent_id($id, $message) {
1095 for ($i = 0, $ret = ''; $ret == '' && $i < count($message->entities
); $i++
) {
1096 if ($message->entities
[$i]->header
->type0
== 'multipart') {
1097 $ret = find_ent_id($id, $message->entities
[$i]);
1099 if (strcasecmp($message->entities
[$i]->header
->id
, $id) == 0) {
1100 // if (sq_check_save_extension($message->entities[$i])) {
1101 return $message->entities
[$i]->entity_id
;
1103 } elseif (!empty($message->entities
[$i]->header
->parameters
['name'])) {
1105 * This is part of a fix for Outlook Express 6.x generating
1106 * cid URLs without creating content-id headers
1109 if (strcasecmp($message->entities
[$i]->header
->parameters
['name'], $id) == 0) {
1110 return $message->entities
[$i]->entity_id
;
1118 function sq_check_save_extension($message) {
1119 $filename = $message->getFilename();
1120 $ext = substr($filename, strrpos($filename,'.')+
1);
1121 $save_extensions = array('jpg','jpeg','gif','png','bmp');
1122 return in_array($ext, $save_extensions);
1127 ** HTMLFILTER ROUTINES
1131 * This function checks attribute values for entity-encoded values
1132 * and returns them translated into 8-bit strings so we can run
1135 * @param $attvalue A string to run entity check against.
1136 * @return Nothing, modifies a reference value.
1138 function sq_defang(&$attvalue){
1141 * Skip this if there aren't ampersands or backslashes.
1143 if (strpos($attvalue, '&') === false
1144 && strpos($attvalue, '\\') === false){
1148 // before deent, translate the dangerous unicode characters and ... to safe values
1149 // otherwise the regular expressions do not match.
1155 $m = $m ||
sq_deent($attvalue, '/\�*(\d+);*/s');
1156 $m = $m ||
sq_deent($attvalue, '/\�*((\d|[a-f])+);*/si', true);
1157 $m = $m ||
sq_deent($attvalue, '/\\\\(\d+)/s', true);
1158 } while ($m == true);
1159 $attvalue = stripslashes($attvalue);
1163 * Kill any tabs, newlines, or carriage returns. Our friends the
1164 * makers of the browser with 95% market value decided that it'd
1165 * be funny to make "java[tab]script" be just as good as "javascript".
1167 * @param attvalue The attribute value before extraneous spaces removed.
1168 * @return attvalue Nothing, modifies a reference value.
1170 function sq_unspace(&$attvalue){
1172 if (strcspn($attvalue, "\t\r\n\0 ") != strlen($attvalue)){
1173 $attvalue = str_replace(Array("\t", "\r", "\n", "\0", " "),
1174 Array('', '', '', '', ''), $attvalue);
1179 * Translate all dangerous Unicode or Shift_JIS characters which are accepted by
1180 * IE as regular characters.
1182 * @param attvalue The attribute value before dangerous characters are translated.
1183 * @return attvalue Nothing, modifies a reference value.
1184 * @author Marc Groot Koerkamp.
1186 function sq_fixIE_idiocy(&$attvalue) {
1188 $attvalue = str_replace("\0", "", $attvalue);
1190 $attvalue = preg_replace("/(\/\*.*?\*\/)/","",$attvalue);
1192 // IE has the evil habit of accepting every possible value for the attribute expression.
1193 // The table below contains characters which are parsed by IE if they are used in the "expression"
1195 $aDangerousCharsReplacementTable = array(
1196 array('ʟ', 'ʟ' ,/* L UNICODE IPA Extension */
1197 'ʀ', 'ʀ' ,/* R UNICODE IPA Extension */
1198 'ɴ', 'ɴ' ,/* N UNICODE IPA Extension */
1199 'E', 'E' ,/* Unicode FULLWIDTH LATIN CAPITAL LETTER E */
1200 'e', 'e' ,/* Unicode FULLWIDTH LATIN SMALL LETTER E */
1201 'X', 'X',/* Unicode FULLWIDTH LATIN CAPITAL LETTER X */
1202 'x', 'x',/* Unicode FULLWIDTH LATIN SMALL LETTER X */
1203 'P', 'P',/* Unicode FULLWIDTH LATIN CAPITAL LETTER P */
1204 'p', 'p',/* Unicode FULLWIDTH LATIN SMALL LETTER P */
1205 'R', 'R',/* Unicode FULLWIDTH LATIN CAPITAL LETTER R */
1206 'r', 'r',/* Unicode FULLWIDTH LATIN SMALL LETTER R */
1207 'S', 'S',/* Unicode FULLWIDTH LATIN CAPITAL LETTER S */
1208 's', 's',/* Unicode FULLWIDTH LATIN SMALL LETTER S */
1209 'I', 'I',/* Unicode FULLWIDTH LATIN CAPITAL LETTER I */
1210 'i', 'i',/* Unicode FULLWIDTH LATIN SMALL LETTER I */
1211 'O', 'O',/* Unicode FULLWIDTH LATIN CAPITAL LETTER O */
1212 'o', 'o',/* Unicode FULLWIDTH LATIN SMALL LETTER O */
1213 'N', 'N',/* Unicode FULLWIDTH LATIN CAPITAL LETTER N */
1214 'n', 'n',/* Unicode FULLWIDTH LATIN SMALL LETTER N */
1215 'L', 'L',/* Unicode FULLWIDTH LATIN CAPITAL LETTER L */
1216 'l', 'l',/* Unicode FULLWIDTH LATIN SMALL LETTER L */
1217 'U', 'U',/* Unicode FULLWIDTH LATIN CAPITAL LETTER U */
1218 'u', 'u',/* Unicode FULLWIDTH LATIN SMALL LETTER U */
1219 'ⁿ', 'ⁿ' ,/* Unicode SUPERSCRIPT LATIN SMALL LETTER N */
1220 '艤', /* Shift JIS FULLWIDTH LATIN CAPITAL LETTER E */ // in unicode this is some Chinese char range
1221 '芅', /* Shift JIS FULLWIDTH LATIN SMALL LETTER E */
1222 '艷', /* Shift JIS FULLWIDTH LATIN CAPITAL LETTER X */
1223 '芘', /* Shift JIS FULLWIDTH LATIN SMALL LETTER X */
1224 '良', /* Shift JIS FULLWIDTH LATIN CAPITAL LETTER P */
1225 '芐', /* Shift JIS FULLWIDTH LATIN SMALL LETTER P */
1226 '艱', /* Shift JIS FULLWIDTH LATIN CAPITAL LETTER R */
1227 '芒', /* Shift JIS FULLWIDTH LATIN SMALL LETTER R */
1228 '色', /* Shift JIS FULLWIDTH LATIN CAPITAL LETTER S */
1229 '芓', /* Shift JIS FULLWIDTH LATIN SMALL LETTER S */
1230 '艨', /* Shift JIS FULLWIDTH LATIN CAPITAL LETTER I */
1231 '芉', /* Shift JIS FULLWIDTH LATIN SMALL LETTER I */
1232 '艮', /* Shift JIS FULLWIDTH LATIN CAPITAL LETTER O */
1233 '芏', /* Shift JIS FULLWIDTH LATIN SMALL LETTER O */
1234 '艭', /* Shift JIS FULLWIDTH LATIN CAPITAL LETTER N */
1235 '芎'), /* Shift JIS FULLWIDTH LATIN SMALL LETTER N */
1236 array('l', 'l', 'r','r','n','n',
1237 'E','E','e','e','X','X','x','x','P','P','p','p','S','S','s','s','I','I',
1238 'i','i','O','O','o','o','N','N','n','n','L','L','l','l','U','U','u','u','n',
1239 'E','e','X','x','P','p','S','s','I','i','O','o','N','n'));
1240 $attvalue = str_replace($aDangerousCharsReplacementTable[0],$aDangerousCharsReplacementTable[1],$attvalue);
1242 // Escapes are useful for special characters like "{}[]()'&. In other cases they are
1244 $attvalue = preg_replace("/(\\\\)([a-zA-Z]{1})/",'$2',$attvalue);
1248 * This function returns the final tag out of the tag name, an array
1249 * of attributes, and the type of the tag. This function is called by
1250 * sq_sanitize internally.
1252 * @param $tagname the name of the tag.
1253 * @param $attary the array of attributes and their values
1254 * @param $tagtype The type of the tag (see in comments).
1255 * @return a string with the final tag representation.
1257 function sq_tagprint($tagname, $attary, $tagtype){
1258 $me = 'sq_tagprint';
1261 $fulltag = '</' . $tagname . '>';
1263 $fulltag = '<' . $tagname;
1264 if (is_array($attary) && sizeof($attary)){
1266 while (list($attname, $attvalue) = each($attary)){
1267 array_push($atts, "$attname=$attvalue");
1269 $fulltag .= ' ' . join(" ", $atts);
1280 * A small helper function to use with array_walk. Modifies a by-ref
1281 * value and makes it lowercase.
1283 * @param $val a value passed by-ref.
1284 * @return void since it modifies a by-ref value.
1286 function sq_casenormalize(&$val){
1287 $val = strtolower($val);
1291 * This function skips any whitespace from the current position within
1292 * a string and to the next non-whitespace value.
1294 * @param $body the string
1295 * @param $offset the offset within the string where we should start
1296 * looking for the next non-whitespace character.
1297 * @return the location within the $body where the next
1298 * non-whitespace char is located.
1300 function sq_skipspace($body, $offset){
1301 $me = 'sq_skipspace';
1302 preg_match('/^(\s*)/s', substr($body, $offset), $matches);
1303 if (sizeof($matches{1})){
1304 $count = strlen($matches{1});
1311 * This function looks for the next character within a string. It's
1312 * really just a glorified "strpos", except it catches if failures
1315 * @param $body The string to look for needle in.
1316 * @param $offset Start looking from this position.
1317 * @param $needle The character/string to look for.
1318 * @return location of the next occurance of the needle, or
1319 * strlen($body) if needle wasn't found.
1321 function sq_findnxstr($body, $offset, $needle){
1322 $me = 'sq_findnxstr';
1323 $pos = strpos($body, $needle, $offset);
1324 if ($pos === FALSE){
1325 $pos = strlen($body);
1331 * This function takes a PCRE-style regexp and tries to match it
1332 * within the string.
1334 * @param $body The string to look for needle in.
1335 * @param $offset Start looking from here.
1336 * @param $reg A PCRE-style regex to match.
1337 * @return Returns a false if no matches found, or an array
1338 * with the following members:
1339 * - integer with the location of the match within $body
1340 * - string with whatever content between offset and the match
1341 * - string with whatever it is we matched
1343 function sq_findnxreg($body, $offset, $reg){
1344 $me = 'sq_findnxreg';
1347 preg_match("%^(.*?)($reg)%si", substr($body, $offset), $matches);
1348 if (!isset($matches{0}) ||
!$matches{0}){
1351 $retarr{0} = $offset +
strlen($matches{1});
1352 $retarr{1} = $matches{1};
1353 $retarr{2} = $matches{2};
1359 * This function looks for the next tag.
1361 * @param $body String where to look for the next tag.
1362 * @param $offset Start looking from here.
1363 * @return false if no more tags exist in the body, or
1364 * an array with the following members:
1365 * - string with the name of the tag
1366 * - array with attributes and their values
1367 * - integer with tag type (1, 2, or 3)
1368 * - integer where the tag starts (starting "<")
1369 * - integer where the tag ends (ending ">")
1370 * first three members will be false, if the tag is invalid.
1372 function sq_getnxtag($body, $offset){
1373 $me = 'sq_getnxtag';
1374 if ($offset > strlen($body)){
1377 $lt = sq_findnxstr($body, $offset, "<");
1378 if ($lt == strlen($body)){
1383 * blah blah <tag attribute="value">
1386 $pos = sq_skipspace($body, $lt+
1);
1387 if ($pos >= strlen($body)){
1388 return Array(false, false, false, $lt, strlen($body));
1391 * There are 3 kinds of tags:
1392 * 1. Opening tag, e.g.:
1394 * 2. Closing tag, e.g.:
1396 * 3. XHTML-style content-less tag, e.g.:
1397 * <img src="blah" />
1400 switch (substr($body, $pos, 1)){
1407 * A comment or an SGML declaration.
1409 if (substr($body, $pos+
1, 2) == "--"){
1410 $gt = strpos($body, "-->", $pos);
1412 $gt = strlen($body);
1416 return Array(false, false, false, $lt, $gt);
1418 $gt = sq_findnxstr($body, $pos, ">");
1419 return Array(false, false, false, $lt, $gt);
1424 * Assume tagtype 1 for now. If it's type 3, we'll switch values
1434 * Look for next [\W-_], which will indicate the end of the tag name.
1436 $regary = sq_findnxreg($body, $pos, "[^\w\-_]");
1437 if ($regary == false){
1438 return Array(false, false, false, $lt, strlen($body));
1440 list($pos, $tagname, $match) = $regary;
1441 $tagname = strtolower($tagname);
1444 * $match can be either of these:
1445 * '>' indicating the end of the tag entirely.
1446 * '\s' indicating the end of the tag name.
1447 * '/' indicating that this is type-3 xhtml tag.
1449 * Whatever else we find there indicates an invalid tag.
1454 * This is an xhtml-style tag with a closing / at the
1455 * end, like so: <img src="blah" />. Check if it's followed
1456 * by the closing bracket. If not, then this tag is invalid
1458 if (substr($body, $pos, 2) == "/>"){
1462 $gt = sq_findnxstr($body, $pos, ">");
1463 $retary = Array(false, false, false, $lt, $gt);
1467 return Array($tagname, false, $tagtype, $lt, $pos);
1471 * Check if it's whitespace
1473 if (!preg_match('/\s/', $match)){
1475 * This is an invalid tag! Look for the next closing ">".
1477 $gt = sq_findnxstr($body, $lt, ">");
1478 return Array(false, false, false, $lt, $gt);
1484 * At this point we're here:
1485 * <tagname attribute='blah'>
1488 * At this point we loop in order to find all attributes.
1494 while ($pos <= strlen($body)){
1495 $pos = sq_skipspace($body, $pos);
1496 if ($pos == strlen($body)){
1500 return Array(false, false, false, $lt, $pos);
1503 * See if we arrived at a ">" or "/>", which means that we reached
1504 * the end of the tag.
1507 if (preg_match("%^(\s*)(>|/>)%s", substr($body, $pos), $matches)) {
1511 $pos +
= strlen($matches{1});
1512 if ($matches{2} == "/>"){
1516 return Array($tagname, $attary, $tagtype, $lt, $pos);
1520 * There are several types of attributes, with optional
1521 * [:space:] between members.
1523 * attrname[:space:]=[:space:]'CDATA'
1525 * attrname[:space:]=[:space:]"CDATA"
1527 * attr[:space:]=[:space:]CDATA
1531 * We leave types 1 and 2 the same, type 3 we check for
1532 * '"' and convert to """ if needed, then wrap in
1533 * double quotes. Type 4 we convert into:
1536 $regary = sq_findnxreg($body, $pos, "[^:\w\-_]");
1537 if ($regary == false){
1539 * Looks like body ended before the end of tag.
1541 return Array(false, false, false, $lt, strlen($body));
1543 list($pos, $attname, $match) = $regary;
1544 $attname = strtolower($attname);
1546 * We arrived at the end of attribute name. Several things possible
1548 * '>' means the end of the tag and this is attribute type 4
1549 * '/' if followed by '>' means the same thing as above
1550 * '\s' means a lot of things -- look what it's followed by.
1551 * anything else means the attribute is invalid.
1556 * This is an xhtml-style tag with a closing / at the
1557 * end, like so: <img src="blah" />. Check if it's followed
1558 * by the closing bracket. If not, then this tag is invalid
1560 if (substr($body, $pos, 2) == "/>"){
1564 $gt = sq_findnxstr($body, $pos, ">");
1565 $retary = Array(false, false, false, $lt, $gt);
1569 $attary{$attname} = '"yes"';
1570 return Array($tagname, $attary, $tagtype, $lt, $pos);
1574 * Skip whitespace and see what we arrive at.
1576 $pos = sq_skipspace($body, $pos);
1577 $char = substr($body, $pos, 1);
1579 * Two things are valid here:
1580 * '=' means this is attribute type 1 2 or 3.
1581 * \w means this was attribute type 4.
1582 * anything else we ignore and re-loop. End of tag and
1583 * invalid stuff will be caught by our checks at the beginning
1588 $pos = sq_skipspace($body, $pos);
1590 * Here are 3 possibilities:
1591 * "'" attribute type 1
1592 * '"' attribute type 2
1593 * everything else is the content of tag type 3
1595 $quot = substr($body, $pos, 1);
1597 $regary = sq_findnxreg($body, $pos+
1, "\'");
1598 if ($regary == false){
1599 return Array(false, false, false, $lt, strlen($body));
1601 list($pos, $attval, $match) = $regary;
1603 $attary{$attname} = "'" . $attval . "'";
1604 } else if ($quot == '"'){
1605 $regary = sq_findnxreg($body, $pos+
1, '\"');
1606 if ($regary == false){
1607 return Array(false, false, false, $lt, strlen($body));
1609 list($pos, $attval, $match) = $regary;
1611 $attary{$attname} = '"' . $attval . '"';
1614 * These are hateful. Look for \s, or >.
1616 $regary = sq_findnxreg($body, $pos, "[\s>]");
1617 if ($regary == false){
1618 return Array(false, false, false, $lt, strlen($body));
1620 list($pos, $attval, $match) = $regary;
1622 * If it's ">" it will be caught at the top.
1624 $attval = preg_replace("/\"/s", """, $attval);
1625 $attary{$attname} = '"' . $attval . '"';
1627 } else if (preg_match("|[\w/>]|", $char)) {
1629 * That was attribute type 4.
1631 $attary{$attname} = '"yes"';
1634 * An illegal character. Find next '>' and return.
1636 $gt = sq_findnxstr($body, $pos, ">");
1637 return Array(false, false, false, $lt, $gt);
1643 * The fact that we got here indicates that the tag end was never
1644 * found. Return invalid tag indication so it gets stripped.
1646 return Array(false, false, false, $lt, strlen($body));
1650 * Translates entities into literal values so they can be checked.
1652 * @param $attvalue the by-ref value to check.
1653 * @param $regex the regular expression to check against.
1654 * @param $hex whether the entites are hexadecimal.
1655 * @return True or False depending on whether there were matches.
1657 function sq_deent(&$attvalue, $regex, $hex=false){
1661 //$attvalue = preg_replace("/(\/\*.*\*\/)/","",$attvalue);
1662 preg_match_all($regex, $attvalue, $matches);
1663 if (is_array($matches) && sizeof($matches[0]) > 0){
1665 for ($i = 0; $i < sizeof($matches[0]); $i++
){
1666 $numval = $matches[1][$i];
1668 $numval = hexdec($numval);
1670 $repl{$matches[0][$i]} = chr($numval);
1672 $attvalue = strtr($attvalue, $repl);
1680 * This function runs various checks against the attributes.
1682 * @param $tagname String with the name of the tag.
1683 * @param $attary Array with all tag attributes.
1684 * @param $rm_attnames See description for sq_sanitize
1685 * @param $bad_attvals See description for sq_sanitize
1686 * @param $add_attr_to_tag See description for sq_sanitize
1687 * @param $message message object
1688 * @param $id message id
1689 * @return Array with modified attributes.
1691 function sq_fixatts($tagname,
1701 while (list($attname, $attvalue) = each($attary)){
1703 * See if this attribute should be removed.
1705 foreach ($rm_attnames as $matchtag=>$matchattrs){
1706 if (preg_match($matchtag, $tagname)){
1707 foreach ($matchattrs as $matchattr){
1708 if (preg_match($matchattr, $attname)){
1709 unset($attary{$attname});
1716 * Workaround for IE quirks
1718 sq_fixIE_idiocy($attvalue);
1721 * Remove any backslashes, entities, and extraneous whitespace.
1724 $oldattvalue = $attvalue;
1725 sq_defang($attvalue);
1726 if ($attname == 'style' && $attvalue !== $oldattvalue) {
1727 // entities are used in the attribute value. In 99% of the cases it's there as XSS
1728 // i.e.<div style="{ left:expʀessioɴ( alert('XSS') ) }">
1729 $attvalue = "idiocy";
1730 $attary{$attname} = $attvalue;
1732 sq_unspace($attvalue);
1735 * Now let's run checks on the attvalues.
1736 * I don't expect anyone to comprehend this. If you do,
1737 * get in touch with me so I can drive to where you live and
1738 * shake your hand personally. :)
1740 foreach ($bad_attvals as $matchtag=>$matchattrs){
1741 if (preg_match($matchtag, $tagname)){
1742 foreach ($matchattrs as $matchattr=>$valary){
1743 if (preg_match($matchattr, $attname)){
1745 * There are two arrays in valary.
1747 * Second one is replacements
1749 list($valmatch, $valrepl) = $valary;
1751 preg_replace($valmatch, $valrepl, $attvalue);
1752 if ($newvalue != $attvalue){
1753 $attary{$attname} = $newvalue;
1761 * Replace empty src tags with the blank image. src is only used
1762 * for frames, images, and image inputs. Doing a replace should
1763 * not affect them working as should be, however it will stop
1764 * IE from being kicked off when src for img tags are not set
1766 if (($attname == 'src') && ($attvalue == '""')) {
1767 $attary{$attname} = '"' . SM_PATH
. 'images/blank.png"';
1771 * Turn cid: urls into http-friendly ones.
1773 if (preg_match("/^[\'\"]\s*cid:/si", $attvalue)){
1774 $attary{$attname} = sq_cid2http($message, $id, $attvalue, $mailbox);
1778 * "Hack" fix for Outlook using propriatary outbind:// protocol in img tags.
1779 * One day MS might actually make it match something useful, for now, falling
1780 * back to using cid2http, so we can grab the blank.png.
1782 if (preg_match("/^[\'\"]\s*outbind:\/\//si", $attvalue)) {
1783 $attary{$attname} = sq_cid2http($message, $id, $attvalue, $mailbox);
1788 * See if we need to append any attributes to this tag.
1790 foreach ($add_attr_to_tag as $matchtag=>$addattary){
1791 if (preg_match($matchtag, $tagname)){
1792 $attary = array_merge($attary, $addattary);
1799 * This function edits the style definition to make them friendly and
1800 * usable in SquirrelMail.
1802 * @param $message the message object
1803 * @param $id the message id
1804 * @param $content a string with whatever is between <style> and </style>
1805 * @param $mailbox the message mailbox
1806 * @return a string with edited content.
1808 function sq_fixstyle($body, $pos, $message, $id, $mailbox){
1809 global $view_unsafe_images;
1810 $me = 'sq_fixstyle';
1811 // workaround for </style> in between comments
1812 $iCurrentPos = $pos;
1817 for ($i=$pos,$iCount=strlen($body);$i<$iCount;++
$i) {
1824 if ($sToken == '<') {
1834 if (preg_match('/\<\/\s*style\s*\>/i',$sToken,$aMatch)) {
1839 $content .= $sToken;
1847 if ($sToken == '<') {
1849 if (isset($body{$i+
2}) && substr($body,$i,3) == '!--') {
1850 $i = strpos($body,'-->',$i+
3);
1851 if ($i === false) { // no end comment
1869 if ($bSucces == FALSE){
1870 return array(FALSE, strlen($body));
1876 * First look for general BODY style declaration, which would be
1878 * body {background: blah-blah}
1879 * and change it to .bodyclass so we can just assign it to a <div>
1881 $content = preg_replace("|body(\s*\{.*?\})|si", ".bodyclass\\1", $content);
1882 $secremoveimg = '../images/' . _("sec_remove_eng.png");
1884 * Fix url('blah') declarations.
1886 // $content = preg_replace("|url\s*\(\s*([\'\"])\s*\S+script\s*:.*?([\'\"])\s*\)|si",
1887 // "url(\\1$secremoveimg\\2)", $content);
1889 // IE Sucks hard. We have a special function for it.
1890 sq_fixIE_idiocy($content);
1892 // remove @import line
1893 $content = preg_replace("/^\s*(@import.*)$/mi","\n<!-- @import rules forbidden -->\n",$content);
1895 // translate ur\l and variations (IE parses that)
1896 // TODO check if the sq_fixIE_idiocy function already handles this.
1897 $content = preg_replace("/(\\\\)?u(\\\\)?r(\\\\)?l(\\\\)?/i", 'url', $content);
1898 // NB I insert NUL characters to keep to avoid an infinite loop. They are removed after the loop.
1899 while (preg_match("/url\s*\(\s*[\'\"]?([^:]+):(.*)?[\'\"]?\s*\)/si", $content, $matches)) {
1900 $sProto = strtolower($matches[1]);
1903 * Fix url('https*://.*) declarations but only if $view_unsafe_images
1908 if (!$view_unsafe_images){
1910 $sExpr = "/url\s*\(\s*[\'\"]?\s*$sProto*:.*[\'\"]?\s*\)/si";
1911 $content = preg_replace($sExpr, "u\0r\0l(\\1$secremoveimg\\2)", $content);
1914 $content = preg_replace('/url/i',"u\0r\0l",$content);
1918 * Fix urls that refer to cid:
1921 $cidurl = 'cid:'. $matches[2];
1922 $httpurl = sq_cid2http($message, $id, $cidurl, $mailbox);
1923 // escape parentheses that can modify the regular expression
1924 $cidurl = str_replace(array('(',')'),array('\\(','\\)'),$cidurl);
1925 $content = preg_replace("|url\s*\(\s*$cidurl\s*\)|si",
1926 "u\0r\0l($httpurl)", $content);
1930 * replace url with protocol other then the white list
1931 * http,https and cid by an empty string.
1933 $content = preg_replace("/url\s*\(\s*[\'\"]?([^:]+):(.*)?[\'\"]?\s*\)/si",
1939 $content = str_replace("\0", "", $content);
1941 * Remove any backslashes, entities, and extraneous whitespace.
1943 $contentTemp = $content;
1944 sq_defang($contentTemp);
1945 sq_unspace($contentTemp);
1948 * Fix stupid css declarations which lead to vulnerabilities
1951 $match = Array('/\/\*.*\*\//',
1955 '/include-source/i',
1958 $replace = Array('','idiocy', 'idiocy', 'idiocy', 'idiocy', 'idiocy', 'idiocy');
1959 $contentNew = preg_replace($match, $replace, $contentTemp);
1960 if ($contentNew !== $contentTemp) {
1961 // insecure css declarations are used. From now on we don't care
1962 // anymore if the css is destroyed by sq_deent, sq_unspace or sq_unbackslash
1963 $content = $contentNew;
1965 return array($content, $newpos);
1970 * This function converts cid: url's into the ones that can be viewed in
1973 * @param $message the message object
1974 * @param $id the message id
1975 * @param $cidurl the cid: url.
1976 * @param $mailbox the message mailbox
1977 * @return a string with a http-friendly url
1979 function sq_cid2http($message, $id, $cidurl, $mailbox){
1981 * Get rid of quotes.
1983 $quotchar = substr($cidurl, 0, 1);
1984 if ($quotchar == '"' ||
$quotchar == "'"){
1985 $cidurl = str_replace($quotchar, "", $cidurl);
1989 $cidurl = substr(trim($cidurl), 4);
1991 $match_str = '/\{.*?\}\//';
1993 $cidurl = preg_replace($match_str, $str_rep, $cidurl);
1995 $linkurl = find_ent_id($cidurl, $message);
1996 /* in case of non-save cid links $httpurl should be replaced by a sort of
1997 unsave link image */
2001 * This is part of a fix for Outlook Express 6.x generating
2002 * cid URLs without creating content-id headers. These images are
2003 * not part of the multipart/related html mail. The html contains
2004 * <img src="cid:{some_id}/image_filename.ext"> references to
2005 * attached images with as goal to render them inline although
2006 * the attachment disposition property is not inline.
2009 if (empty($linkurl)) {
2010 if (preg_match('/{.*}\//', $cidurl)) {
2011 $cidurl = preg_replace('/{.*}\//','', $cidurl);
2012 if (!empty($cidurl)) {
2013 $linkurl = find_ent_id($cidurl, $message);
2018 if (!empty($linkurl)) {
2019 $httpurl = $quotchar . SM_PATH
. 'src/download.php?absolute_dl=true&' .
2020 "passed_id=$id&mailbox=" . urlencode($mailbox) .
2021 '&ent_id=' . $linkurl . $quotchar;
2024 * If we couldn't generate a proper img url, drop in a blank image
2025 * instead of sending back empty, otherwise it causes unusual behaviour
2027 $httpurl = $quotchar . SM_PATH
. 'images/blank.png' . $quotchar;
2034 * This function changes the <body> tag into a <div> tag since we
2035 * can't really have a body-within-body.
2037 * @param $attary an array of attributes and values of <body>
2038 * @param $mailbox mailbox we're currently reading (for cid2http)
2039 * @param $message current message (for cid2http)
2040 * @param $id current message id (for cid2http)
2041 * @return a modified array of attributes to be set for <div>
2043 function sq_body2div($attary, $mailbox, $message, $id){
2044 $me = 'sq_body2div';
2045 $divattary = Array('class' => "'bodyclass'");
2047 $has_bgc_stl = $has_txt_stl = false;
2049 if (is_array($attary) && sizeof($attary) > 0){
2050 foreach ($attary as $attname=>$attvalue){
2051 $quotchar = substr($attvalue, 0, 1);
2052 $attvalue = str_replace($quotchar, "", $attvalue);
2055 $attvalue = sq_cid2http($message, $id, $attvalue, $mailbox);
2056 $styledef .= "background-image: url('$attvalue'); ";
2059 $has_bgc_stl = true;
2060 $styledef .= "background-color: $attvalue; ";
2063 $has_txt_stl = true;
2064 $styledef .= "color: $attvalue; ";
2068 // Outlook defines a white bgcolor and no text color. This can lead to
2069 // white text on a white bg with certain themes.
2070 if ($has_bgc_stl && !$has_txt_stl) {
2071 $styledef .= "color: $text; ";
2073 if (strlen($styledef) > 0){
2074 $divattary{"style"} = "\"$styledef\"";
2081 * This is the main function and the one you should actually be calling.
2082 * There are several variables you should be aware of an which need
2083 * special description.
2085 * Since the description is quite lengthy, see it here:
2086 * http://linux.duke.edu/projects/mini/htmlfilter/
2088 * @param $body the string with HTML you wish to filter
2089 * @param $tag_list see description above
2090 * @param $rm_tags_with_content see description above
2091 * @param $self_closing_tags see description above
2092 * @param $force_tag_closing see description above
2093 * @param $rm_attnames see description above
2094 * @param $bad_attvals see description above
2095 * @param $add_attr_to_tag see description above
2096 * @param $message message object
2097 * @param $id message id
2098 * @return sanitized html safe to show on your pages.
2100 function sq_sanitize($body,
2102 $rm_tags_with_content,
2112 $me = 'sq_sanitize';
2113 $rm_tags = array_shift($tag_list);
2115 * Normalize rm_tags and rm_tags_with_content.
2117 @array_walk
($tag_list, 'sq_casenormalize');
2118 @array_walk
($rm_tags_with_content, 'sq_casenormalize');
2119 @array_walk
($self_closing_tags, 'sq_casenormalize');
2121 * See if tag_list is of tags to remove or tags to allow.
2122 * false means remove these tags
2123 * true means allow these tags
2126 $open_tags = Array();
2127 $trusted = "\n<!-- begin sanitized html -->\n";
2128 $skip_content = false;
2130 * Take care of netscape's stupid javascript entities like
2133 $body = preg_replace("/&(\{.*?\};)/si", "&\\1", $body);
2135 while (($curtag = sq_getnxtag($body, $curpos)) != FALSE){
2136 list($tagname, $attary, $tagtype, $lt, $gt) = $curtag;
2137 $free_content = substr($body, $curpos, $lt-$curpos);
2139 * Take care of <style>
2141 if ($tagname == "style" && $tagtype == 1){
2142 list($free_content, $curpos) =
2143 sq_fixstyle($body, $gt+
1, $message, $id, $mailbox);
2144 if ($free_content != FALSE){
2145 $trusted .= sq_tagprint($tagname, $attary, $tagtype);
2146 $trusted .= $free_content;
2147 $trusted .= sq_tagprint($tagname, false, 2);
2151 if ($skip_content == false){
2152 $trusted .= $free_content;
2154 if ($tagname != FALSE){
2156 if ($skip_content == $tagname){
2158 * Got to the end of tag we needed to remove.
2161 $skip_content = false;
2163 if ($skip_content == false){
2164 if ($tagname == "body"){
2167 if (isset($open_tags{$tagname}) &&
2168 $open_tags{$tagname} > 0){
2169 $open_tags{$tagname}--;
2177 * $rm_tags_with_content
2179 if ($skip_content == false){
2181 * See if this is a self-closing type and change
2182 * tagtype appropriately.
2185 && in_array($tagname, $self_closing_tags)){
2189 * See if we should skip this tag and any content
2192 if ($tagtype == 1 &&
2193 in_array($tagname, $rm_tags_with_content)){
2194 $skip_content = $tagname;
2196 if (($rm_tags == false
2197 && in_array($tagname, $tag_list)) ||
2198 ($rm_tags == true &&
2199 !in_array($tagname, $tag_list))){
2203 * Convert body into div.
2205 if ($tagname == "body"){
2207 $attary = sq_body2div($attary, $mailbox,
2211 if (isset($open_tags{$tagname})){
2212 $open_tags{$tagname}++
;
2214 $open_tags{$tagname}=1;
2218 * This is where we run other checks.
2220 if (is_array($attary) && sizeof($attary) > 0){
2221 $attary = sq_fixatts($tagname,
2235 if ($tagname != false && $skip_content == false){
2236 $trusted .= sq_tagprint($tagname, $attary, $tagtype);
2241 $trusted .= substr($body, $curpos, strlen($body)-$curpos);
2242 if ($force_tag_closing == true){
2243 foreach ($open_tags as $tagname=>$opentimes){
2244 while ($opentimes > 0){
2245 $trusted .= '</' . $tagname . '>';
2251 $trusted .= "<!-- end sanitized html -->\n";
2256 * This is a wrapper function to call html sanitizing routines.
2258 * @param $body the body of the message
2259 * @param $id the id of the message
2263 * @param boolean $take_mailto_links When TRUE, converts mailto: links
2264 * into internal SM compose links
2265 * (optional; default = TRUE)
2266 * @return a string with html safe to display in the browser.
2268 function magicHTML($body, $id, $message, $mailbox = 'INBOX', $take_mailto_links =true) {
2270 // require_once(SM_PATH . 'functions/url_parser.php'); // for $MailTo_PReg_Match
2272 global $attachment_common_show_images, $view_unsafe_images,
2275 * Don't display attached images in HTML mode.
2279 $attachment_common_show_images = false;
2294 $rm_tags_with_content = Array(
2304 $self_closing_tags = Array(
2312 $force_tag_closing = true;
2314 $rm_attnames = Array(
2325 $secremoveimg = "../images/" . _("sec_remove_eng.png");
2326 $bad_attvals = Array(
2329 "/^src|background/i" =>
2332 "/^([\'\"])\s*\S+script\s*:.*([\'\"])/si",
2333 "/^([\'\"])\s*mocha\s*:*.*([\'\"])/si",
2334 "/^([\'\"])\s*about\s*:.*([\'\"])/si"
2337 "\\1$secremoveimg\\2",
2338 "\\1$secremoveimg\\2",
2339 "\\1$secremoveimg\\2",
2342 "/^href|action/i" =>
2345 "/^([\'\"])\s*\S+script\s*:.*([\'\"])/si",
2346 "/^([\'\"])\s*mocha\s*:*.*([\'\"])/si",
2347 "/^([\'\"])\s*about\s*:.*([\'\"])/si"
2362 "/include-source/i",
2363 "/position\s*:\s*absolute/i",
2364 "/(\\\\)?u(\\\\)?r(\\\\)?l(\\\\)?/i",
2365 "/url\s*\(\s*([\'\"])\s*\S+script\s*:.*([\'\"])\s*\)/si",
2366 "/url\s*\(\s*([\'\"])\s*mocha\s*:.*([\'\"])\s*\)/si",
2367 "/url\s*\(\s*([\'\"])\s*about\s*:.*([\'\"])\s*\)/si",
2368 "/(.*)\s*:\s*url\s*\(\s*([\'\"]*)\s*\S+script\s*:.*([\'\"]*)\s*\)/si"
2386 if( !sqgetGlobalVar('view_unsafe_images', $view_unsafe_images, SQ_GET
) ) {
2387 $view_unsafe_images = false;
2389 if (!$view_unsafe_images){
2391 * Remove any references to http/https if view_unsafe_images set
2394 array_push($bad_attvals{'/.*/'}{'/^src|background/i'}[0],
2395 '/^([\'\"])\s*https*:.*([\'\"])/si');
2396 array_push($bad_attvals{'/.*/'}{'/^src|background/i'}[1],
2397 "\\1$secremoveimg\\1");
2398 array_push($bad_attvals{'/.*/'}{'/^style/i'}[0],
2399 '/url\([\'\"]?https?:[^\)]*[\'\"]?\)/si');
2400 array_push($bad_attvals{'/.*/'}{'/^style/i'}[1],
2401 "url(\\1$secremoveimg\\1)");
2404 $add_attr_to_tag = Array(
2406 Array('target'=>'"_blank"',
2407 'title'=>'"'._("This external link will open in a new window").'"'
2410 $trusted = sq_sanitize($body,
2412 $rm_tags_with_content,
2422 if (preg_match("|$secremoveimg|i", $trusted)){
2423 $has_unsafe_images = true;
2426 // we want to parse mailto's in HTML output, change to SM compose links
2427 // this is a modified version of code from url_parser.php... but Marc is
2428 // right: we need a better filtering implementation; adding this randomly
2429 // here is not a great solution
2431 if ($take_mailto_links) {
2432 // parseUrl($trusted); // this even parses URLs inside of tags... too aggressive
2433 global $MailTo_PReg_Match;
2434 $MailTo_PReg_Match = '/mailto:' . substr($MailTo_PReg_Match, 1) ;
2435 if ((preg_match_all($MailTo_PReg_Match, $trusted, $regs)) && ($regs[0][0] != '')) {
2436 foreach ($regs[0] as $i => $mailto_before) {
2437 $mailto_params = $regs[10][$i];
2438 // get rid of any tailing quote since we have to add send_to to the end
2440 if (substr($mailto_before, strlen($mailto_before) - 1) == '"')
2441 $mailto_before = substr($mailto_before, 0, strlen($mailto_before) - 1);
2442 if (substr($mailto_params, strlen($mailto_params) - 1) == '"')
2443 $mailto_params = substr($mailto_params, 0, strlen($mailto_params) - 1);
2445 if ($regs[1][$i]) { //if there is an email addr before '?', we need to merge it with the params
2446 $to = 'to=' . $regs[1][$i];
2447 if (strpos($mailto_params, 'to=') > -1) //already a 'to='
2448 $mailto_params = str_replace('to=', $to . '%2C%20', $mailto_params);
2450 if ($mailto_params) //already some params, append to them
2451 $mailto_params .= '&' . $to;
2453 $mailto_params .= '?' . $to;
2457 $url_str = preg_replace(array('/to=/i', '/(?<!b)cc=/i', '/bcc=/i'), array('send_to=', 'send_to_cc=', 'send_to_bcc='), $mailto_params);
2459 // we'll already have target=_blank, no need to allow comp_in_new
2460 // here (which would be a lot more work anyway)
2462 global $compose_new_win;
2463 $temp_comp_in_new = $compose_new_win;
2464 $compose_new_win = 0;
2465 $comp_uri = makeComposeLink('src/compose.php' . $url_str, $mailto_before);
2466 $compose_new_win = $temp_comp_in_new;
2468 // remove <a href=" and anything after the next quote (we only
2469 // need the uri, not the link HTML) in compose uri
2471 $comp_uri = substr($comp_uri, 9);
2472 $comp_uri = substr($comp_uri, 0, strpos($comp_uri, '"', 1));
2473 $trusted = str_replace($mailto_before, $comp_uri, $trusted);
2482 * function SendDownloadHeaders - send file to the browser
2484 * Original Source: SM core src/download.php
2485 * moved here to make it available to other code, and separate
2486 * front end from back end functionality.
2488 * @param string $type0 first half of mime type
2489 * @param string $type1 second half of mime type
2490 * @param string $filename filename to tell the browser for downloaded file
2491 * @param boolean $force whether to force the download dialog to pop
2492 * @param optional integer $filesize send the Content-Header and length to the browser
2495 function SendDownloadHeaders($type0, $type1, $filename, $force, $filesize=0) {
2496 global $languages, $squirrelmail_language;
2497 $isIE = $isIE6plus = false;
2499 sqgetGlobalVar('HTTP_USER_AGENT', $HTTP_USER_AGENT, SQ_SERVER
);
2501 if (strstr($HTTP_USER_AGENT, 'compatible; MSIE ') !== false &&
2502 strstr($HTTP_USER_AGENT, 'Opera') === false) {
2506 if (preg_match('/compatible; MSIE ([0-9]+)/', $HTTP_USER_AGENT, $match) &&
2507 ((int)$match[1]) >= 6 && strstr($HTTP_USER_AGENT, 'Opera') === false) {
2511 if (isset($languages[$squirrelmail_language]['XTRA_CODE']) &&
2512 function_exists($languages[$squirrelmail_language]['XTRA_CODE'] . '_downloadfilename')) {
2514 call_user_func($languages[$squirrelmail_language]['XTRA_CODE'] . '_downloadfilename', $filename, $HTTP_USER_AGENT);
2516 $filename = ereg_replace('[\\/:\*\?"<>\|;]', '_', str_replace(' ', ' ', $filename));
2519 // A Pox on Microsoft and it's Internet Explorer!
2521 // IE has lots of bugs with file downloads.
2522 // It also has problems with SSL. Both of these cause problems
2523 // for us in this function.
2525 // See this article on Cache Control headers and SSL
2526 // http://support.microsoft.com/default.aspx?scid=kb;en-us;323308
2528 // The best thing you can do for IE is to upgrade to the latest
2530 //set all the Cache Control Headers for IE
2532 $filename=rawurlencode($filename);
2533 header ("Pragma: public");
2534 header ("Cache-Control: no-store, max-age=0, no-cache, must-revalidate"); // HTTP/1.1
2535 header ("Cache-Control: post-check=0, pre-check=0", false);
2536 header ("Cache-Control: private");
2538 //set the inline header for IE, we'll add the attachment header later if we need it
2539 header ("Content-Disposition: inline; filename=$filename");
2543 // Try to show in browser window
2544 header ("Content-Disposition: inline; filename=\"$filename\"");
2545 header ("Content-Type: $type0/$type1; name=\"$filename\"");
2547 // Try to pop up the "save as" box
2549 // IE makes this hard. It pops up 2 save boxes, or none.
2550 // http://support.microsoft.com/support/kb/articles/Q238/5/88.ASP
2551 // http://support.microsoft.com/default.aspx?scid=kb;EN-US;260519
2552 // But, according to Microsoft, it is "RFC compliant but doesn't
2553 // take into account some deviations that allowed within the
2554 // specification." Doesn't that mean RFC non-compliant?
2555 // http://support.microsoft.com/support/kb/articles/Q258/4/52.ASP
2557 // all browsers need the application/octet-stream header for this
2558 header ("Content-Type: application/octet-stream; name=\"$filename\"");
2560 // http://support.microsoft.com/support/kb/articles/Q182/3/15.asp
2561 // Do not have quotes around filename, but that applied to
2562 // "attachment"... does it apply to inline too?
2563 header ("Content-Disposition: attachment; filename=\"$filename\"");
2565 if ($isIE && !$isIE6plus) {
2566 // This combination seems to work mostly. IE 5.5 SP 1 has
2567 // known issues (see the Microsoft Knowledge Base)
2569 // This works for most types, but doesn't work with Word files
2570 header ("Content-Type: application/download; name=\"$filename\"");
2571 header ("Content-Type: application/force-download; name=\"$filename\"");
2572 // These are spares, just in case. :-)
2573 //header("Content-Type: $type0/$type1; name=\"$filename\"");
2574 //header("Content-Type: application/x-msdownload; name=\"$filename\"");
2575 //header("Content-Type: application/octet-stream; name=\"$filename\"");
2577 // This is to prevent IE for MIME sniffing and auto open a file in IE
2578 header ("Content-Type: application/force-download; name=\"$filename\"");
2580 // another application/octet-stream forces download for Netscape
2581 header ("Content-Type: application/octet-stream; name=\"$filename\"");
2585 //send the content-length header if the calling function provides it
2586 if ($filesize > 0) {
2587 header("Content-Length: $filesize");
2590 } // end fn SendDownloadHeaders