Minor cleanup in comments
[squirrelmail.git] / functions / mime.php
index 7433d7c8b49a3c3c7f5e4b14d777e04d72582771..7bacc8625658c2136a934e44a7b2fef7d467dc3e 100644 (file)
@@ -9,7 +9,7 @@
  * 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>';
@@ -97,7 +97,6 @@ function mime_structure ($bodystructure, $flags=array()) {
  */
 
 function mime_fetch_body($imap_stream, $id, $ent_id=1, $fetch_size=0) {
-    global $uid_support;
     /* Do a bit of error correction.  If we couldn't find the entity id, just guess
      * that it is the first one.  That is usually the case anyway.
      */
@@ -110,7 +109,7 @@ function mime_fetch_body($imap_stream, $id, $ent_id=1, $fetch_size=0) {
 
     if ($fetch_size!=0) $cmd .= "<0.$fetch_size>";
 
-    $data = sqimap_run_command ($imap_stream, $cmd, true, $response, $message, $uid_support);
+    $data = sqimap_run_command ($imap_stream, $cmd, true, $response, $message, TRUE);
     do {
         $topline = trim(array_shift($data));
     } while($topline && ($topline[0] == '*') && !preg_match('/\* [0-9]+ FETCH.*/i', $topline)) ;
@@ -122,7 +121,7 @@ function mime_fetch_body($imap_stream, $id, $ent_id=1, $fetch_size=0) {
          * in order to parse html messages. Let's get them here.
          */
 //        if ($ret{0} == '<') {
-//            $data = sqimap_run_command ($imap_stream, "FETCH $id BODY[$ent_id.MIME]", true, $response, $message, $uid_support);
+//            $data = sqimap_run_command ($imap_stream, "FETCH $id BODY[$ent_id.MIME]", true, $response, $message, TRUE);
 //        }
     } else if (ereg('"([^"]*)"', $topline, $regs)) {
         $ret = $regs[1];
@@ -138,18 +137,18 @@ 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, $uid_support);
+        $data = sqimap_run_command ($imap_stream, "FETCH $passed_id BODY[]", true, $response, $message, TRUE);
         array_shift($data);
         $wholemessage = implode('', $data);
 
@@ -159,11 +158,10 @@ function mime_fetch_body($imap_stream, $id, $ent_id=1, $fetch_size=0) {
 }
 
 function mime_print_body_lines ($imap_stream, $id, $ent_id=1, $encoding) {
-    global $uid_support;
 
     /* 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')) {
@@ -177,7 +175,7 @@ function mime_print_body_lines ($imap_stream, $id, $ent_id=1, $encoding) {
         } else {
            $query = "FETCH $id BODY[$ent_id]";
         }
-        sqimap_run_command($imap_stream,$query,true,$response,$message,$uid_support,'sqimap_base64_decode','php://stdout',true);
+        sqimap_run_command($imap_stream,$query,true,$response,$message,TRUE,'sqimap_base64_decode','php://stdout',true);
     } else {
        $body = mime_fetch_body ($imap_stream, $id, $ent_id);
        echo decodeBody($body, $encoding);
@@ -235,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]);
@@ -360,9 +358,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);
@@ -376,9 +374,11 @@ function formatBody($imap_stream, $message, $color, $wrap_at, $ent_num, $id, $ma
             if ($show_html_default <> 1) {
                 $entity_conv = array('&nbsp;' => ' ',
                                      '<p>'    => "\n",
-                                     '<br>'   => "\n",
                                      '<P>'    => "\n",
+                                     '<br>'   => "\n",
                                      '<BR>'   => "\n",
+                                     '<br />' => "\n",
+                                     '<BR />' => "\n",
                                      '&gt;'   => '>',
                                      '&lt;'   => '<');
                 $body = strtr($body, $entity_conv);
@@ -399,7 +399,7 @@ function formatBody($imap_stream, $message, $color, $wrap_at, $ent_num, $id, $ma
         if (isset($passed_ent_id)) {
             $link .= '&amp;passed_ent_id='.$passed_ent_id;
         }
-        $body .= '<center><small><a href="download.php?absolute_dl=true&amp;' . 
+        $body .= '<center><small><a href="download.php?absolute_dl=true&amp;' .
                  $link . '">' . _("Download this as a file") .  '</a>';
         if ($view_unsafe_images) {
             $text = _("Hide Unsafe Images");
@@ -414,7 +414,7 @@ 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;
 }
@@ -438,7 +438,7 @@ 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 = '';
@@ -506,6 +506,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 +523,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 +542,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 != '')
@@ -550,10 +551,30 @@ function formatAttachments($message, $exclude_id, $mailbox, $id) {
 }
 
 function sqimap_base64_decode(&$string) {
-    $string = str_replace("\r\n", "\n", $string);
+
+    // 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
+    $string = str_replace(array("\r\n","\n", "\r", " "),array('','','',''),$string);
+
+    $sStringRem = '';
+    $iMod = strlen($string) % 4;
+    if ($iMod) {
+        $sStringRem = substr($string,-$iMod);
+        // Check if $sStringRem contains padding characters
+        if (substr($sStringRem,-1) != '=') {
+            $string = substr($string,0,-$iMod);
+        } else {
+            $sStringRem = '';
+        }
+    }
     $string = base64_decode($string);
+    return $sStringRem;
 }
 
+
 /* This function decodes the body depending on the encoding type. */
 function decodeBody($body, $encoding) {
     global $show_html_default;
@@ -599,14 +620,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;
     }
@@ -640,28 +661,42 @@ function decodeHeader ($string, $utfencode=true,$htmlsave=true,$decide=false) {
             $j = $i;
             $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 ($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);
+                }
                 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);
@@ -716,13 +751,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);
@@ -1051,7 +1082,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)){
@@ -1109,7 +1140,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) == "/>"){
@@ -1211,7 +1242,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) == "/>"){
@@ -1397,7 +1428,7 @@ function sq_fixatts($tagname,
         /**
          * Remove \r \n \t \0 " " "\\"
          */
-        $attvalue = str_replace(Array("\r", "\n", "\t", "\0", " ", "\\"), 
+        $attvalue = str_replace(Array("\r", "\n", "\t", "\0", " ", "\\"),
                         Array('', '','','','',''), $attvalue);
 
         /**
@@ -1596,7 +1627,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
@@ -1933,7 +1964,7 @@ function magicHTML($body, $id, $message, $mailbox = 'INBOX') {
  * @param string $type1 second half of mime type
  * @param string $filename filename to tell the browser for downloaded file
  * @param boolean $force whether to force the download dialog to pop
- * @param integer $filesize optional, send the Content-Header and length to the browser
+ * @param optional integer $filesize send the Content-Header and length to the browser
  * @return void
  */
  function SendDownloadHeaders($type0, $type1, $filename, $force, $filesize=0) {
@@ -1953,56 +1984,81 @@ 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));
+         $filename = ereg_replace('[\\/:\*\?"<>\|;]', '_', str_replace('&nbsp;', ' ', $filename));
+     }
+
+     // A Pox on Microsoft and it's Internet Explorer!
+     //
+     // IE has lots of bugs with file downloads.
+     // It also has problems with SSL.  Both of these cause problems
+     // for us in this function.
+     //
+     // See this article on Cache Control headers and SSL
+     // http://support.microsoft.com/default.aspx?scid=kb;en-us;323308
+     //
+     // The best thing you can do for IE is to upgrade to the latest
+     // version
+     //set all the Cache Control Headers for IE
+     if ($isIE) {
+         $filename=urlencode($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);
+         header ("Cache-control: private");
+
+         //set the inline header for IE, we'll add the attachment header later if we need it
+         header ("Content-Disposition: inline; filename=$filename");
      }
 
-     // A Pox on Microsoft and it's Office!
      if (!$force) {
          // Try to show in browser window
-         header("Content-Disposition: inline; filename=\"$filename\"");
-         header("Content-Type: $type0/$type1; name=\"$filename\"");
+         header ("Content-Disposition: inline; filename=\"$filename\"");
+         header ("Content-Type: $type0/$type1; name=\"$filename\"");
      } else {
          // Try to pop up the "save as" box
+
          // IE makes this hard.  It pops up 2 save boxes, or none.
          // http://support.microsoft.com/support/kb/articles/Q238/5/88.ASP
-         // But, accordint to Microsoft, it is "RFC compliant but doesn't
+         // http://support.microsoft.com/default.aspx?scid=kb;EN-US;260519
+         // But, according to Microsoft, it is "RFC compliant but doesn't
          // take into account some deviations that allowed within the
          // specification."  Doesn't that mean RFC non-compliant?
          // http://support.microsoft.com/support/kb/articles/Q258/4/52.ASP
-         //
-         // The best thing you can do for IE is to upgrade to the latest
-         // version
+
+         // all browsers need the application/octet-stream header for this
+         header ("Content-Type: application/octet-stream; name=\"$filename\"");
+
+         // http://support.microsoft.com/support/kb/articles/Q182/3/15.asp
+         // Do not have quotes around filename, but that applied to
+         // "attachment"... does it apply to inline too?
+         header ("Content-Disposition: attachment; filename=\"$filename\"");
+
          if ($isIE && !$isIE6) {
-             // http://support.microsoft.com/support/kb/articles/Q182/3/15.asp
-             // Do not have quotes around filename, but that applied to
-             // "attachment"... does it apply to inline too?
-             //
              // This combination seems to work mostly.  IE 5.5 SP 1 has
              // known issues (see the Microsoft Knowledge Base)
-             header("Content-Disposition: inline; filename=$filename");
+
              // This works for most types, but doesn't work with Word files
-             header("Content-Type: application/download; name=\"$filename\"");
+             header ("Content-Type: application/download; name=\"$filename\"");
 
              // These are spares, just in case.  :-)
              //header("Content-Type: $type0/$type1; name=\"$filename\"");
              //header("Content-Type: application/x-msdownload; name=\"$filename\"");
              //header("Content-Type: application/octet-stream; name=\"$filename\"");
          } else {
-             header("Content-Disposition: attachment; filename=\"$filename\"");
-             // application/octet-stream forces download for Netscape
-             header("Content-Type: application/octet-stream; name=\"$filename\"");
+             // another application/octet-stream forces download for Netscape
+             header ("Content-Type: application/octet-stream; name=\"$filename\"");
          }
      }
 
      //send the content-length header if the calling function provides it
      if ($filesize > 0) {
-        header("Content-Length: $filesize");
+         header("Content-Length: $filesize");
      }
 
- }  // end fn SendDownlaodHeaders
+}  // end fn SendDownloadHeaders
 
-?>
+?>
\ No newline at end of file