replacing urlencode with rawurlencode. It is possible that I've missed space
[squirrelmail.git] / functions / mime.php
index 07cfe443d988e09c0e762165b743dc408ee58d3c..09fc552c27b548e64a306f19efd3afe2a1949bcc 100644 (file)
@@ -3,13 +3,13 @@
 /**
  * mime.php
  *
- * Copyright (c) 1999-2004 The SquirrelMail Project Team
+ * Copyright (c) 1999-2005 The SquirrelMail Project Team
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *
  * This contains the functions necessary to detect and decode MIME
  * messages.
  *
- * $Id$
+ * @version $Id$
  * @package squirrelmail
  */
 
@@ -41,7 +41,7 @@ function mime_structure ($bodystructure, $flags=array()) {
         /* removed urldecode because $_GET is auto urldecoded ??? */
         displayPageHeader( $color, $mailbox );
         $errormessage  = _("SquirrelMail could not decode the bodystructure of the message");
-        $errormessage .= '<BR>'._("the provided bodystructure by your imap-server").':<BR><BR>';
+        $errormessage .= '<br />'._("the provided bodystructure by your imap-server").':<br /><br />';
         $errormessage .= '<pre>' . htmlspecialchars($read) . '</pre>';
         plain_error_message( $errormessage, $color );
         echo '</body></html>';
@@ -137,16 +137,16 @@ function mime_fetch_body($imap_stream, $id, $ent_id=1, $fetch_size=0) {
                 '&amp;message='  . urlencode($message)  .
                 '&amp;topline='  . urlencode($topline);
 
-        echo   '<tt><br>' .
+        echo   '<tt><br />' .
                '<table width="80%"><tr>' .
-               '<tr><td colspan=2>' .
+               '<tr><td colspan="2">' .
                _("Body retrieval error. The reason for this is most probably that the message is malformed.") .
                '</td></tr>' .
                '<tr><td><b>' . _("Command:") . "</td><td>$cmd</td></tr>" .
                '<tr><td><b>' . _("Response:") . "</td><td>$response</td></tr>" .
                '<tr><td><b>' . _("Message:") . "</td><td>$message</td></tr>" .
                '<tr><td><b>' . _("FETCH line:") . "</td><td>$topline</td></tr>" .
-               "</table><BR></tt></font><hr>";
+               "</table><br /></tt></font><hr />";
 
         $data = sqimap_run_command ($imap_stream, "FETCH $passed_id BODY[]", true, $response, $message, TRUE);
         array_shift($data);
@@ -161,7 +161,7 @@ function mime_print_body_lines ($imap_stream, $id, $ent_id=1, $encoding) {
 
     /* Don't kill the connection if the browser is over a dialup
      * and it would take over 30 seconds to download it.
-     * Dont call set_time_limit in safe mode.
+     * Don't call set_time_limit in safe mode.
      */
 
     if (!ini_get('safe_mode')) {
@@ -233,7 +233,7 @@ function mime_print_body_lines ($imap_stream, $id, $ent_id=1, $encoding) {
  */
 function listEntities ($message) {
     if ($message) {
-        echo "<tt>" . $message->entity_id . ' : ' . $message->type0 . '/' . $message->type1 . ' parent = '. $message->parent->entity_id. '<br>';
+        echo "<tt>" . $message->entity_id . ' : ' . $message->type0 . '/' . $message->type1 . ' parent = '. $message->parent->entity_id. '<br />';
         for ($i = 0; isset($message->entities[$i]); $i++) {
             echo "$i : ";
             $msg = listEntities($message->entities[$i]);
@@ -331,19 +331,20 @@ function translateText(&$body, $wrap_at, $charset) {
     $body = '<pre>' . implode("\n", $body_ary) . '</pre>';
 }
 
-/* This returns a parsed string called $body. That string can then
+/**
+ * This returns a parsed string called $body. That string can then
  * be displayed as the actual message in the HTML. It contains
  * everything needed, including HTML Tags, Attachments at the
  * bottom, etc.
+ * @param clean Do not output stuff that's irrelevant for the printable version.
  */
-function formatBody($imap_stream, $message, $color, $wrap_at, $ent_num, $id, $mailbox='INBOX') {
+function formatBody($imap_stream, $message, $color, $wrap_at, $ent_num, $id, $mailbox='INBOX', $clean=FALSE) {
     /* This if statement checks for the entity to show as the
      * primary message. To add more of them, just put them in the
      * order that is their priority.
      */
-    global $startMessage, $username, $key, $imapServerAddress, $imapPort,
+    global $startMessage, $languages, $squirrelmail_language,
            $show_html_default, $sort, $has_unsafe_images, $passed_ent_id;
-    global $languages, $squirrelmail_language;
 
     if( !sqgetGlobalVar('view_unsafe_images', $view_unsafe_images, SQ_GET) ) {
         $view_unsafe_images = false;
@@ -358,9 +359,9 @@ function formatBody($imap_stream, $message, $color, $wrap_at, $ent_num, $id, $ma
         $body = decodeBody($body, $body_message->header->encoding);
 
         if (isset($languages[$squirrelmail_language]['XTRA_CODE']) &&
-            function_exists($languages[$squirrelmail_language]['XTRA_CODE'])) {
+            function_exists($languages[$squirrelmail_language]['XTRA_CODE'] . '_decode')) {
             if (mb_detect_encoding($body) != 'ASCII') {
-                $body = $languages[$squirrelmail_language]['XTRA_CODE']('decode', $body);
+                $body = call_user_func($languages[$squirrelmail_language]['XTRA_CODE'] . '_decode',$body);
             }
         }
         $hookResults = do_hook("message_body", $body);
@@ -393,6 +394,12 @@ function formatBody($imap_stream, $message, $color, $wrap_at, $ent_num, $id, $ma
             translateText($body, $wrap_at,
                           $body_message->header->getParameter('charset'));
         }
+
+        // if this is the clean display (i.e. printer friendly), stop here.
+        if ( $clean ) {
+            return $body;
+        }
+
         $link = 'passed_id=' . $id . '&amp;ent_id='.$ent_num.
                 '&amp;mailbox=' . $urlmailbox .'&amp;sort=' . $sort .
                 '&amp;startMessage=' . $startMessage . '&amp;show_more=0';
@@ -414,15 +421,14 @@ function formatBody($imap_stream, $message, $color, $wrap_at, $ent_num, $id, $ma
         if($text != '') {
             $body .= '&nbsp;|&nbsp;<a href="read_body.php?' . $link . '">' . $text . '</a>';
         }
-        $body .= '</small></center><br>' . "\n";
+        $body .= '</small></center><br />' . "\n";
     }
     return $body;
 }
 
 
 function formatAttachments($message, $exclude_id, $mailbox, $id) {
-    global $where, $what, $startMessage, $color;
-    static $ShownHTML = 0;
+    global $where, $what, $startMessage, $color, $passed_ent_id;
 
     $att_ar = $message->getAttachments($exclude_id);
 
@@ -438,10 +444,9 @@ function formatAttachments($message, $exclude_id, $mailbox, $id) {
         $type0 = strtolower($header->type0);
         $type1 = strtolower($header->type1);
         $name = '';
-        $links['download link']['text'] = _("download");
+        $links['download link']['text'] = _("Download");
         $links['download link']['href'] = SM_PATH .
                 "src/download.php?absolute_dl=true&amp;passed_id=$id&amp;mailbox=$urlMailbox&amp;ent_id=$ent";
-        $ImageURL = '';
         if ($type0 =='message' && $type1 == 'rfc822') {
             $default_page = SM_PATH . 'src/read_body.php';
             $rfc822_header = $att->rfc822_header;
@@ -506,6 +511,7 @@ function formatAttachments($message, $exclude_id, $mailbox, $id) {
         if ($where && $what) {
            $defaultlink .= '&amp;where='. urlencode($where).'&amp;what='.urlencode($what);
         }
+
         /* This executes the attachment hook with a specific MIME-type.
          * If that doesn't have results, it tries if there's a rule
          * for a more generic type.
@@ -522,14 +528,14 @@ function formatAttachments($message, $exclude_id, $mailbox, $id) {
         $links = $hookresults[1];
         $defaultlink = $hookresults[6];
 
-        $attachments .= '<TR><TD>' .
-                        '<A HREF="'.$defaultlink.'">'.decodeHeader($display_filename).'</A>&nbsp;</TD>' .
-                        '<TD><SMALL><b>' . show_readable_size($header->size) .
-                        '</b>&nbsp;&nbsp;</small></TD>' .
-                        "<TD><SMALL>[ $type0/$type1 ]&nbsp;</SMALL></TD>" .
-                        '<TD><SMALL>';
+        $attachments .= '<tr><td>' .
+                        '<a href="'.$defaultlink.'">'.decodeHeader($display_filename).'</a>&nbsp;</td>' .
+                        '<td><small><b>' . show_readable_size($header->size) .
+                        '</b>&nbsp;&nbsp;</small></td>' .
+                        '<td><small>[ '.htmlspecialchars($type0).'/'.htmlspecialchars($type1).' ]&nbsp;</small></td>' .
+                        '<td><small>';
         $attachments .= '<b>' . $description . '</b>';
-        $attachments .= '</SMALL></TD><TD><SMALL>&nbsp;';
+        $attachments .= '</small></td><td><small>&nbsp;';
 
         $skipspaces = 1;
         foreach ($links as $val) {
@@ -541,7 +547,7 @@ function formatAttachments($message, $exclude_id, $mailbox, $id) {
             $attachments .= '<a href="' . $val['href'] . '">' .  $val['text'] . '</a>';
         }
         unset($links);
-        $attachments .= "</TD></TR>\n";
+        $attachments .= "</td></tr>\n";
     }
     $attachmentadd = do_hook_function('attachments_bottom',$attachments);
     if ($attachmentadd != '')
@@ -551,18 +557,18 @@ function formatAttachments($message, $exclude_id, $mailbox, $id) {
 
 function sqimap_base64_decode(&$string) {
 
-    // base64 enoded data goes in pairs of 4 bytes. To achieve on the
+    // Base64 encoded data goes in pairs of 4 bytes. To achieve on the
     // fly decoding (to reduce memory usage) you have to check if the
     // data has incomplete pairs
 
-    // remove the noise in order to check if the 4 bytes pairs are complete
+    // Remove the noise in order to check if the 4 bytes pairs are complete
     $string = str_replace(array("\r\n","\n", "\r", " "),array('','','',''),$string);
 
-    $sStringRem = '';    
+    $sStringRem = '';
     $iMod = strlen($string) % 4;
     if ($iMod) {
         $sStringRem = substr($string,-$iMod);
-        // check if $sStringRem contains padding characters
+        // Check if $sStringRem contains padding characters
         if (substr($sStringRem,-1) != '=') {
             $string = substr($string,0,-$iMod);
         } else {
@@ -619,14 +625,14 @@ function decodeBody($body, $encoding) {
  * @return string decoded header string
  */
 function decodeHeader ($string, $utfencode=true,$htmlsave=true,$decide=false) {
-    global $languages, $squirrelmail_language;
+    global $languages, $squirrelmail_language,$default_charset;
     if (is_array($string)) {
         $string = implode("\n", $string);
     }
 
     if (isset($languages[$squirrelmail_language]['XTRA_CODE']) &&
-        function_exists($languages[$squirrelmail_language]['XTRA_CODE'])) {
-        $string = $languages[$squirrelmail_language]['XTRA_CODE']('decodeheader', $string);
+        function_exists($languages[$squirrelmail_language]['XTRA_CODE'] . '_decodeheader')) {
+        $string = call_user_func($languages[$squirrelmail_language]['XTRA_CODE'] . '_decodeheader', $string);
         // Do we need to return at this point?
         // return $string;
     }
@@ -658,30 +664,55 @@ function decodeHeader ($string, $utfencode=true,$htmlsave=true,$decide=false) {
             }
             $iLastMatch = $i;
             $j = $i;
-            $ret .= $res[1];
+            if ($htmlsave) {
+                $ret .= htmlspecialchars($res[1]);
+            } else {
+                $ret .= $res[1];
+            }
             $encoding = ucfirst($res[3]);
+
+            /* decide about valid decoding */
+            if ($decide && is_conversion_safe($res[2])) {
+              $utfencode=true;
+              $can_be_encoded=true;
+            } else {
+              $can_be_encoded=false;
+            }
             switch ($encoding)
             {
             case 'B':
                 $replace = base64_decode($res[4]);
-                $ret .= charset_decode($res[2],$replace);
+                if ($utfencode) {
+                    if ($can_be_encoded) {
+                        /* convert string to different charset,
+                         * if functions asks for it (usually in compose)
+                         */
+                        $ret .= charset_convert($res[2],$replace,$default_charset);
+                    } else {
+                        // convert string to html codes in order to display it
+                        $ret .= charset_decode($res[2],$replace);
+                    }
+                } else {
+                    if ($htmlsave) {
+                        $replace = htmlspecialchars($replace);
+                    }
+                    $ret.= $replace;
+                }
                 break;
             case 'Q':
                 $replace = str_replace('_', ' ', $res[4]);
                 $replace = preg_replace('/=([0-9a-f]{2})/ie', 'chr(hexdec("\1"))',
                                     $replace);
-        /* decide about valid decoding */
-        if ($decide && is_conversion_safe($res[2])) {
-          $utfencode=true;
-          $can_be_decoded=true;
-        } else {
-          $can_be_decoded=false;
-        }
-                /* Only encode into entities by default. Some places
-                 * don't need the encoding, like the compose form.
-                 */
                 if ($utfencode) {
+                  if ($can_be_encoded) {
+                    /* convert string to different charset,
+                     * if functions asks for it (usually in compose)
+                     */
+                    $replace = charset_convert($res[2], $replace,$default_charset);
+                  } else {
+                    // convert string to html codes in order to display it
                     $replace = charset_decode($res[2], $replace);
+                  }
                 } else {
                     if ($htmlsave) {
                         $replace = htmlspecialchars($replace);
@@ -736,13 +767,9 @@ function encodeHeader ($string) {
     global $default_charset, $languages, $squirrelmail_language;
 
     if (isset($languages[$squirrelmail_language]['XTRA_CODE']) &&
-        function_exists($languages[$squirrelmail_language]['XTRA_CODE'])) {
-        return  $languages[$squirrelmail_language]['XTRA_CODE']('encodeheader', $string);
+        function_exists($languages[$squirrelmail_language]['XTRA_CODE'] . '_encodeheader')) {
+        return  call_user_func($languages[$squirrelmail_language]['XTRA_CODE'] . '_encodeheader', $string);
     }
-    // instead of removing nbsp here, we don't add it in decodeHeader
-    //    if (strtolower($default_charset) == 'iso-8859-1') {
-    //    $string = str_replace("\240",' ',$string);
-    //}
 
     // Encode only if the string contains 8-bit characters or =?
     $j = strlen($string);
@@ -1071,7 +1098,7 @@ function sq_getnxtag($body, $offset){
      * 2. Closing tag, e.g.:
      *    </a>
      * 3. XHTML-style content-less tag, e.g.:
-     *    <img src="blah"/>
+     *    <img src="blah" />
      */
     $tagtype = false;
     switch (substr($body, $pos, 1)){
@@ -1105,7 +1132,6 @@ function sq_getnxtag($body, $offset){
             break;
     }
 
-    $tag_start = $pos;
     $tagname = '';
     /**
      * Look for next [\W-_], which will indicate the end of the tag name.
@@ -1129,7 +1155,7 @@ function sq_getnxtag($body, $offset){
         case '/':
             /**
              * This is an xhtml-style tag with a closing / at the
-             * end, like so: <img src="blah"/>. Check if it's followed
+             * end, like so: <img src="blah" />. Check if it's followed
              * by the closing bracket. If not, then this tag is invalid
              */
             if (substr($body, $pos, 2) == "/>"){
@@ -1165,7 +1191,6 @@ function sq_getnxtag($body, $offset){
      * At this point we loop in order to find all attributes.
      */
     $attname = '';
-    $atttype = false;
     $attary = Array();
 
     while ($pos <= strlen($body)){
@@ -1231,7 +1256,7 @@ function sq_getnxtag($body, $offset){
             case '/':
                 /**
                  * This is an xhtml-style tag with a closing / at the
-                 * end, like so: <img src="blah"/>. Check if it's followed
+                 * end, like so: <img src="blah" />. Check if it's followed
                  * by the closing bracket. If not, then this tag is invalid
                  */
                 if (substr($body, $pos, 2) == "/>"){
@@ -1465,7 +1490,7 @@ function sq_fixatts($tagname,
 
 /**
  * This function edits the style definition to make them friendly and
- * usable in squirrelmail.
+ * usable in SquirrelMail.
  *
  * @param  $message  the message object
  * @param  $id       the message id
@@ -1574,7 +1599,6 @@ function sq_cid2http($message, $id, $cidurl, $mailbox){
 function sq_body2div($attary, $mailbox, $message, $id){
     $me = 'sq_body2div';
     $divattary = Array('class' => "'bodyclass'");
-    $bgcolor = '#ffffff';
     $text = '#000000';
     $has_bgc_stl = $has_txt_stl = false;
     $styledef = '';
@@ -1616,7 +1640,7 @@ function sq_body2div($attary, $mailbox, $message, $id){
  * special description.
  *
  * Since the description is quite lengthy, see it here:
- * http://www.mricon.com/html/phpfilter.html
+ * http://linux.duke.edu/projects/mini/htmlfilter/
  *
  * @param $body                 the string with HTML you wish to filter
  * @param $tag_list             see description above
@@ -1973,9 +1997,9 @@ function magicHTML($body, $id, $message, $mailbox = 'INBOX') {
      }
 
      if (isset($languages[$squirrelmail_language]['XTRA_CODE']) &&
-         function_exists($languages[$squirrelmail_language]['XTRA_CODE'])) {
+         function_exists($languages[$squirrelmail_language]['XTRA_CODE'] . '_downloadfilename')) {
          $filename =
-         $languages[$squirrelmail_language]['XTRA_CODE']('downloadfilename', $filename, $HTTP_USER_AGENT);
+         call_user_func($languages[$squirrelmail_language]['XTRA_CODE'] . '_downloadfilename', $filename, $HTTP_USER_AGENT);
      } else {
          $filename = ereg_replace('[\\/:\*\?"<>\|;]', '_', str_replace('&nbsp;', ' ', $filename));
      }
@@ -1993,6 +2017,7 @@ function magicHTML($body, $id, $message, $mailbox = 'INBOX') {
      // version
      //set all the Cache Control Headers for IE
      if ($isIE) {
+         $filename=rawurlencode($filename);
          header ("Pragma: public");
          header ("Cache-Control: no-store, max-age=0, no-cache, must-revalidate"); # HTTP/1.1
          header ("Cache-Control: post-check=0, pre-check=0", false);
@@ -2049,4 +2074,4 @@ function magicHTML($body, $id, $message, $mailbox = 'INBOX') {
 
 }  // end fn SendDownloadHeaders
 
-?>
+?>
\ No newline at end of file