While getting data from a stream it is possible to reach the end, so we should check...
[squirrelmail.git] / functions / mime.php
index e60bcb62e878b2d3fcaead6bb33f88ccdd8388e0..52a452ea6cd11ba6c8381a3971db604f0ba5d849 100644 (file)
@@ -4,18 +4,17 @@
     ** This contains the functions necessary to detect and decode MIME
     ** messages.
     **
+    ** $Id$
     **/
+    
+   if (defined('mime_php'))
+      return;
+   define('mime_php', true);
 
+   global $debug_mime;
    $debug_mime = false;
-   $mime_php = true;
-
-   if (!isset($i18n_php))
-      include "../functions/i18n.php";
-   if (!isset($imap_php))
-      include "../functions/imap.php";
-   if (!isset($config_php))
-      include "../config/config.php";
-
+   
+   require_once('../functions/imap.php');
 
    /** Setting up the objects that have the structure for the message **/
 
       /** msg_header contains generic variables for values that **/
       /** could be in a header.                                 **/
       
-      var $type0, $type1, $boundary, $charset, $encoding, $size;
-      var $to, $from, $date, $cc, $bcc, $reply_to, $subject;
-      var $id, $mailbox, $description;
-      var $entity_id, $message_id, $charset;
+      var $type0 = '', $type1 = '', $boundary = '', $charset = '';
+      var $encoding = '', $size = 0, $to = array(), $from = '', $date = '';
+      var $cc = array(), $bcc = array(), $reply_to = '', $subject = '';
+      var $id = 0, $mailbox = '', $description = '', $filename = '';
+      var $entity_id = 0, $message_id = 0, $name = '';
    }
    
    class message {
           more objects of type message.  See documentation in mime.txt for
           a better description of how this works.
        **/   
-      var $header;
-      var $entities;
+      var $header = '';
+      var $entities = array();
       
       function addEntity ($msg) {
-         $this->entities[count($this->entities)] = $msg;
+         $this->entities[] = $msg;
       }
    }
 
       
       $id = $header->id;
       fputs ($imap_stream, "a001 FETCH $id BODYSTRUCTURE\r\n");
+      //
+      // This should use sqimap_read_data instead of reading it itself
+      //
       $read = fgets ($imap_stream, 10000);
       $response = substr($read, 0, 4);
-      while ($response != "a001") {
+      $bodystructure = "";
+      while ($response != 'a001' ) && !feof( $imap_stream ) {
          $bodystructure .= $read;
          $read = fgets ($imap_stream, 10000);
          $response = substr($read, 0, 4);
       }
-   //   $read = strtolower($bodystructure);
       $read = $bodystructure;
 
       if ($debug_mime) echo "<tt>$read</tt><br><br>\n";
       } else {
          // parse the elements
          if ($debug_mime) echo "<br><font color=0000aa><tt>$structure</tt></font><br>";
-         $msg = mime_get_element (&$structure, $msg, $ent_id);
+         $msg = mime_get_element ($structure, $msg, $ent_id);
          if ($debug_mime) echo "<br>";
       }
-      return $msg;
       if ($debug_mime) echo "<font color=008800><tt>&nbsp;&nbsp;END: mime_parse_structure()</tt></font><br>";
+      return $msg;
    }
 
    // Increments the element ID.  An element id can look like any of
       $elem_num = 1;
       $msg->header = new msg_header();
       $msg->header->entity_id = $ent_id;
+      $properties = array();
       
       while (strlen($structure) > 0) {
          $structure = trim($structure);
             // loop through until we find the matching quote, and return that as a string
             $pos = 1;
             $char = substr($structure, $pos, 1);
+           $text = "";
             while ($char != "\"" && $pos < strlen($structure)) {
                $text .= $char;
                $pos++;
             // loop through until we find a space or an end parenthesis
             $pos = 0;
             $char = substr($structure, $pos, 1);
+            $text = "";
             while ($char != " " && $char != ")" && $pos < strlen($structure)) {
                $text .= $char;
                $pos++;
          if ($char == "\"") {
             $pos = 1;
             $char = substr($structure, $pos, 1);
+           $tmp = "";
             while ($char != "\"" && $pos < strlen($structure)) {
                $tmp .= $char;
                $pos++;
             if ($char == "\"") {
                $pos = 1;
                $char = substr($structure, $pos, 1);
+              $value = "";
                while ($char != "\"" && $pos < strlen($structure)) {
                   $value .= $char;
                   $pos++;
             } else if ($char == "(") {
                $end = mime_match_parenthesis (0, $structure);
                $sub = substr($structure, 1, $end-1);
+              if (! isset($props))
+                  $props = array();
                $props = mime_get_props($props, $sub);
                $structure = substr($structure, strlen($sub) + 2);
             }
       // ignore all extra characters
       // If inside of a string, skip string -- Boundary IDs and other
       // things can have ) in them.
+      if ($char != '(')
+          return strlen($structure);
       while ($pos < strlen($structure)) {
          $pos++;
          $char = substr($structure, $pos, 1); 
             $pos ++;
             while (substr($structure, $pos, 1) != '"' && 
                $pos < strlen($structure)) {
+              if (substr($structure, $pos, 2) == '\\"')
+                  $pos ++;
+              elseif (substr($structure, $pos, 2) == '\\\\')
+                  $pos ++;
                $pos ++;
             }
          } else if ($char == "(") {
             $pos = mime_match_parenthesis ($pos, $structure);
          }
       }
+      echo "Error decoding mime structure.  Report this as a bug!<br>\n";
+      return $pos;
    }
 
    function mime_fetch_body ($imap_stream, $id, $ent_id) {
       // that it is the first one.  That is usually the case anyway.
       if (!$ent_id) $ent_id = 1;
 
-      fputs ($imap_stream, "a001 FETCH $id BODY[$ent_id]\r\n");
-      $topline = fgets ($imap_stream, 1024);
-      if (ereg('\{([^\}]*)\}', $topline, $regs)) {
-         return fread ($imap_stream, $regs[1]);
+      fputs ($imap_stream, "a010 FETCH $id BODY[$ent_id]\r\n");
+      $data = sqimap_read_data ($imap_stream, 'a010', true, $response, $message);
+      $topline = array_shift($data);
+      while (! ereg('\\* [0-9]+ FETCH ', $topline) && $data)
+          $topline = array_shift($data);
+      $wholemessage = implode('', $data);
+
+      if (ereg('\\{([^\\}]*)\\}', $topline, $regs)) {
+         return substr($wholemessage, 0, $regs[1]);
       }
       else if (ereg('"([^"]*)"', $topline, $regs)) {
          return $regs[1];
       }
-      return "Body retrival error, please report this bug!\n\nTop line is \"$topline\"\n";
+      
+      $str = "Body retrieval error.  Please report this bug!\n";
+      $str .= "Response:  $response\n";
+      $str .= "Message:  $message\n";
+      $str .= "FETCH line:  $topline";
+      $str .= "---------------\n$wholemessage";
+      foreach ($data as $d)
+      {
+          $str .= htmlspecialchars($d) . "\n";
+      }
+      return $str;
+   }
+
+   function mime_print_body_lines ($imap_stream, $id, $ent_id, $encoding) {
+      // 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.
+      if (!$ent_id) $ent_id = 1;
+
+      // Don't kill the connection if the browser is over a dialup
+      // and it would take over 30 seconds to download it.
+      set_time_limit(0);
+      
+      fputs ($imap_stream, "a001 FETCH $id BODY[$ent_id]\r\n");
+         $cnt = 0;
+         $continue = true;
+               $read = fgets ($imap_stream,4096);
+               // This could be bad -- if the section has 'a001 OK'
+               // or similar, it will kill the download.
+               while (!ereg("^a001 (OK|BAD|NO)(.*)$", $read, $regs)) {
+                       if (trim($read) == ")==") {
+                               $read1 = $read;
+                               $read = fgets ($imap_stream,4096);
+                               if (ereg("^a001 (OK|BAD|NO)(.*)$", $read, $regs)) {
+                                       return;
+                               } else {
+                                       echo decodeBody($read1, $encoding);
+                                       echo decodeBody($read, $encoding);
+                               }
+                       } else if ($cnt) {
+                               echo decodeBody($read, $encoding);
+                       }
+                       $read = fgets ($imap_stream,4096);
+                       $cnt++;
+               }
    }
 
    /* -[ END MIME DECODING ]----------------------------------------------------------- */
    /** This is the first function called.  It decides if this is a multipart
        message or if it should be handled as a single entity
     **/
-   function decodeMime ($imap_stream, $body, $header) {
+   function decodeMime ($imap_stream, &$header) {
       global $username, $key, $imapServerAddress, $imapPort;
       return mime_structure ($imap_stream, $header);
    }
          if ($message->header->entity_id == $ent_id && strlen($ent_id) == strlen($message->header->entity_id)) {
             return $message;
          } else {
-            for ($i = 0; $message->entities[$i]; $i++) {
+            for ($i = 0; isset($message->entities[$i]); $i++) {
                $msg = getEntity ($message->entities[$i], $ent_id);
                if ($msg)
                   return $msg;
 
    // figures out what entity to display and returns the $message object
    // for that entity.
-   function findDisplayEntity ($message) {
-      if ($message) {
-         if ($message->header->type0 == "text") {
-            if ($message->header->type1 == "plain" ||
-                $message->header->type1 == "html") {
-               return $message->header->entity_id; 
-            }
-         } else {
-            for ($i=0; $message->entities[$i]; $i++) {
-               return findDisplayEntity($message->entities[$i]);
-            }   
-         }   
+   function findDisplayEntity ($message, $textOnly = 1)
+   {
+      global $show_html_default;
+      
+      if (! $message)
+       return 0;
+
+      if ($message->header->type0 == "multipart" &&
+          $message->header->type1 == "alternative" &&
+         $show_html_default && ! $textOnly) {
+        $entity = findDisplayEntityHTML($message);
+        if ($entity != 0)
+           return $entity;
+      }
+        
+      // Show text/plain or text/html -- the first one we find.
+      if ($message->header->type0 == 'text' && 
+         ($message->header->type1 == 'plain' ||
+          $message->header->type1 == 'html') && 
+         isset($message->header->entity_id))
+        return $message->header->entity_id;
+
+      for ($i=0; isset($message->entities[$i]); $i++) {
+         $entity = findDisplayEntity($message->entities[$i], $textOnly);
+         if ($entity != 0)
+            return $entity;
+      }
+      
+      return 0;
+   }
+   
+   // Shows the HTML version
+   function findDisplayEntityHTML ($message) {
+      if ($message->header->type0 == 'text' && 
+          $message->header->type1 == 'html' &&
+         isset($message->header->entity_id))
+        return $message->header->entity_id;
+      for ($i = 0; isset($message->entities[$i]); $i ++) {
+         $entity = findDisplayEntityHTML($message->entities[$i]);
+        if ($entity != 0)
+           return $entity;
       }
+      return 0;
    }
 
    /** This returns a parsed string called $body. That string can then
       // 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, $username, $key, $imapServerAddress, $imapPort,
+          $show_html_default;
 
       $id = $message->header->id;
       $urlmailbox = urlencode($message->header->mailbox);
 
       // Get the right entity and redefine message to be this entity
-      $ent_num = findDisplayEntity ($message);
+      // Pass the 0 to mean that we want the 'best' viewable one
+      $ent_num = findDisplayEntity ($message, 0);
       $body_message = getEntity($message, $ent_num);
       if (($body_message->header->type0 == "text") || 
           ($body_message->header->type0 == "rfc822")) {
    
-         $body = mime_fetch_body ($imap_stream, $id, $ent_num); 
+         $body = mime_fetch_body ($imap_stream, $id, $ent_num);
          $body = decodeBody($body, $body_message->header->encoding);
    
          // If there are other types that shouldn't be formatted, add
          // them here 
-         if ($message->header->type1 != "html") {   
+         if ($body_message->header->type1 != "html" || ! $show_html_default) {
             translateText($body, $wrap_at, $body_message->header->charset);
          }   
    
-         $body .= "<SMALL><CENTER><A HREF=\"../src/download.php?absolute_dl=true&passed_id=$id&passed_ent_id=$ent_num&mailbox=$urlmailbox\">". _("Download this as a file") ."</A></CENTER><BR></SMALL>";
+         $body .= "<SMALL><CENTER><A HREF=\"../src/download.php?absolute_dl=true&passed_id=$id&passed_ent_id=$ent_num&mailbox=$urlmailbox&showHeaders=1\">". _("Download this as a file") ."</A></CENTER><BR></SMALL>";
    
          /** Display the ATTACHMENTS: message if there's more than one part **/
          $body .= "</TD></TR></TABLE>";
-         if ($message->entities) {
+         if (isset($message->entities[0])) {
             $body .= formatAttachments ($message, $ent_num, $message->header->mailbox, $id);
          }
+            $body .= "</TD></TR></TABLE>";
       } else {
-         $body .= formatAttachments ($message, -1, $message->header->mailbox, $id);
+         $body = formatAttachments ($message, -1, $message->header->mailbox, $id);
       }
       return $body;
    }
    function formatAttachments ($message, $ent_id, $mailbox, $id) {
       global $where, $what;
       global $startMessage, $color;
-      static $ShownHTML;
+      static $ShownHTML = 0;
       
+         $body = "";
       if ($ShownHTML == 0)
       {
             $ShownHTML = 1;
             
             $body .= "<TABLE WIDTH=100% CELLSPACING=0 CELLPADDING=2 BORDER=0 BGCOLOR=\"$color[0]\"><TR>\n";
             $body .= "<TH ALIGN=\"left\" BGCOLOR=\"$color[9]\"><B>\n";
-            $body .= _('Attachments') . ':';
+            $body .= _("Attachments") . ':';
             $body .= "</B></TH></TR><TR><TD>\n";
             
             $body .= "<TABLE CELLSPACING=0 CELLPADDING=1 BORDER=0>\n";
          if (!$message->entities) {
             $type0 = strtolower($message->header->type0);
             $type1 = strtolower($message->header->type1);
+            $name = decodeHeader($message->header->name);
             
             if ($message->header->entity_id != $ent_id) {
                $filename = decodeHeader($message->header->filename);
                if (trim($filename) == "") {
-                  $display_filename = "untitled-".$message->header->entity_id;
+                  if (trim($name) == "") { 
+                     $display_filename = "untitled-".$message->header->entity_id; 
+                  } else { 
+                     $display_filename = $name; 
+                     $filename = $name; 
+                  } 
                } else {
                   $display_filename = $filename;
                }
                   "../src/download.php?startMessage=$startMessage&passed_id=$id&mailbox=$urlMailbox&passed_ent_id=$ent";
                if ($where && $what)
                   $DefaultLink .= '&where=' . urlencode($where) . '&what=' . urlencode($what);
-               $Links['download link']['text'] = _('download');
+               $Links['download link']['text'] = _("download");
                $Links['download link']['href'] = 
                    "../src/download.php?absolute_dl=true&passed_id=$id&mailbox=$urlMailbox&passed_ent_id=$ent";
                $ImageURL = '';
       $body = str_replace("\r\n", "\n", $body);
       $encoding = strtolower($encoding);
 
+      global $show_html_default;
+
       if ($encoding == "quoted-printable") {
          $body = quoted_printable_decode($body);
 
       } else if ($encoding == "base64") {
          $body = base64_decode($body);
       }
-
+     
       // All other encodings are returned raw.
       return $body;
    }
    // This functions decode strings that is encoded according to 
    // RFC1522 (MIME Part Two: Message Header Extensions for Non-ASCII Text).
    function decodeHeader ($string) {
-      if (eregi('=\?([^?]+)\?(q|b)\?([^?]+)\?=', 
+      if (eregi('=\\?([^?]+)\\?(q|b)\\?([^?]+)\\?=', 
                 $string, $res)) {
          if (ucfirst($res[2]) == "B") {
             $replace = base64_decode($res[3]);
             $replace = ereg_replace("_", " ", $res[3]);
            // Convert lowercase Quoted Printable to uppercase for
            // quoted_printable_decode to understand it.
-           while (ereg("(=([0-9][a-f])|([a-f][0-9])|([a-f][0-9]))", $replace, $res)) {
+           while (ereg("(=(([0-9][abcdef])|([abcdef][0-9])|([abcdef][abcdef])))", $replace, $res)) {
               $replace = str_replace($res[1], strtoupper($res[1]), $replace);
            }
             $replace = quoted_printable_decode($replace);
 
          $replace = charset_decode ($res[1], $replace);
 
-         $string = eregi_replace
-            ('=\?([^?]+)\?(q|b)\?([^?]+)\?=',
+         // Remove the name of the character set.
+         $string = eregi_replace ('=\\?([^?]+)\\?(q|b)\\?([^?]+)\\?=',
              $replace, $string);
+
          // In case there should be more encoding in the string: recurse
          return (decodeHeader($string));
       } else         
    // be encoded.
    function encodeHeader ($string) {
       global $default_charset;
-
-      // Encode only if the string contains 8-bit characters or =?
-      if (ereg("([\200-\377]|=\\?)", $string)) {
-         $newstring = "=?$default_charset?Q?";
-         
-         // First the special characters
-         $string = str_replace("=", "=3D", $string);
-         $string = str_replace("?", "=3F", $string);
-         $string = str_replace("_", "=5F", $string);
-         $string = str_replace(" ", "_", $string);
-
-
-         while (ereg("([\200-\377])", $string, $regs)) {
-            $replace = $regs[1];
-            $insert = "=" . strtoupper(bin2hex($replace));
-            $string = str_replace($replace, $insert, $string);
-         }
-
-         $newstring = "=?$default_charset?Q?".$string."?=";
-         
-         return $newstring;
-      }
-
-      return $string;
-   }
+  
+     // Encode only if the string contains 8-bit characters or =?
+     $j = strlen( $string  );
+     $l = FALSE;                             // Must be encoded ?
+     $ret = '';
+     for( $i=0; $i < $j; ++$i) {
+        switch( $string{$i} ) {
+           case '=':
+             $ret .= '=3D';
+             break;
+          case '?':
+             $l = TRUE;
+             $ret .= '=3F';
+             break;
+          case '_':
+             $ret .= '=5F';
+             break;
+          case ' ':
+             $ret .= '_';
+             break;
+         default:
+             $k = ord( $string{$i} );
+             if( $k > 126 ) {
+                $ret .= sprintf("=%02X", $k);
+                $l = TRUE;
+             } else 
+                $ret .= $string{$i};
+        }
+     }
+  
+     if( $l )
+        $string = "=?$default_charset?Q?$ret?=";
+           
+     return( $string );
+ }
 
 ?>