Add compatibility with Dovecot's bigint UIDs
[squirrelmail.git] / src / download.php
index 0b7ba61394f2b720877b6a49cfdec208ffce76e0..65a56dd88c24372df4a6a82ea9aeaaf190686778 100644 (file)
 /**
  * download.php
  *
- * Copyright (c) 1999-2002 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
- *
  * Handles attachment downloads to the users computer.
  * Also allows displaying of attachments when possible.
  *
- * $Id$
+ * @copyright © 1999-2007 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package squirrelmail
  */
 
-require_once('../src/validate.php');
-require_once('../functions/imap.php');
-require_once('../functions/mime.php');
-require_once('../functions/date.php');
-
-header('Pragma: ');
-header('Cache-Control: cache');
-
-
-function viewText($color, $body, $id, $entid, $mailbox, $type1, $wrap_at, $imapConnection) {
-    global $where, $what, $charset;
-    global $startMessage;
+/** This is the download page */
+define('PAGE_NAME', 'download');
 
-    displayPageHeader($color, 'None');
-    echo "<BR><TABLE WIDTH=\"100%\" BORDER=0 CELLSPACING=0 CELLPADDING=2 ALIGN=CENTER><TR><TD BGCOLOR=\"$color[0]\">".
-         "<B><CENTER>".
-         _("Viewing a text attachment") . " - ";
-    if ($where && $what) {
-        // from a search
-        echo "<a href=\"read_body.php?mailbox=".urlencode($mailbox)."&passed_id=$id&where=".urlencode($where)."&what=".urlencode($what)."\">". _("View message") . "</a>";
-    } else {
-        echo "<a href=\"read_body.php?mailbox=".urlencode($mailbox)."&passed_id=$id&startMessage=$startMessage&show_more=0\">". _("View message") . "</a>";
-    }
+/**
+ * Include the SquirrelMail initialization file.
+ */
+require('../include/init.php');
 
-    $urlmailbox = urlencode($mailbox);
-    echo "</b></td><tr><tr><td><CENTER><A HREF=\"../src/download.php?absolute_dl=true&passed_id=$id&passed_ent_id=$entid&mailbox=$urlmailbox\">".
-         _("Download this as a file").
-         "</A></CENTER><BR>".
-         "</CENTER></B>".
-         "</TD></TR></TABLE>".
-         "<TABLE WIDTH=\"98%\" BORDER=0 CELLSPACING=0 CELLPADDING=2 ALIGN=CENTER><TR><TD BGCOLOR=\"$color[0]\">".
-         "<TR><TD BGCOLOR=\"$color[4]\"><TT>";
+/* SquirrelMail required files. */
+require(SM_PATH . 'functions/imap_general.php');
+require(SM_PATH . 'functions/mailbox_display.php');
+require(SM_PATH . 'functions/mime.php');
 
-    if ($type1 == 'html') {
-        $msg  = sqimap_get_message($imapConnection, $id, $mailbox);    
-       $msg = $msg->getEntity($entid);
-        $body = MagicHTML( $body, $id, $msg );
-    } else {
-        translateText($body, $wrap_at, $charset);
-    }
+/**
+ * If a message is viewed from the search page, $aMailbox[$passed_id]['MESSAGE_OBJECT']
+ * is not initialized, which makes this page error out on line 65 with an 
+ * undefined function.  We need to include some additional files in case the
+ * object has not been initialized.
+ * 
+ * TODO: Determine why the object in question is not initialized when coming from
+ *       a search page and correct.  Once that is done, we can remove these
+ *       includes.
+ */
+require(SM_PATH . 'functions/imap_messages.php');
+require(SM_PATH . 'functions/date.php');
 
-    flush();
-    echo $body .
-         "</TT></TD></TR></TABLE>";
-}
+header('Pragma: ');
+header('Cache-Control: cache');
 
-function get_extract_to_target_list($imapConnection) {
-    $boxes = sqimap_mailbox_list($imapConnection);
-    for ($i = 0; $i < count($boxes); $i++) {  
-        if (!in_array('noselect', $boxes[$i]['flags'])) {
-            $box = $boxes[$i]['unformatted'];
-            $box2 = str_replace(' ', '&nbsp;', $boxes[$i]['unformatted-disp']);
-            if ( $box2 == 'INBOX' ) {
-                $box2 = _("INBOX");
-            }
-            echo "<option value=\"$box\">$box2</option>\n";
-        }
-    }
+/* globals */
+sqgetGlobalVar('mailbox_cache',$mailbox_cache,SQ_SESSION);
+sqgetGlobalVar('messages',   $messages,     SQ_SESSION);
+sqgetGlobalVar('mailbox',    $mailbox,      SQ_GET);
+sqgetGlobalVar('ent_id',     $ent_id,       SQ_GET);
+sqgetGlobalVar('absolute_dl',$absolute_dl,  SQ_GET);
+sqgetGlobalVar('force_crlf', $force_crlf,   SQ_GET);
+sqgetGlobalVar('passed_id', $passed_id, SQ_GET, NULL, SQ_TYPE_BIGINT);
+if (!sqgetGlobalVar('account', $account, SQ_GET) ) {
+    $account = 0;
 }
-$mailbox = decodeHeader($mailbox);
-
-global $messages, $uid_support;
-
-
-
-$imapConnection = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
-$mbx_response =  sqimap_mailbox_select($imapConnection, $mailbox);
-
-$message = &$messages[$mbx_response['UIDVALIDITY']]["$passed_id"];
-$message = &$message->getEntity($passed_ent_id);
 
-$header = $message->header;
-$charset = $header->charset;
-$type0 = $header->type0;
-$type1 = $header->type1;
-$encoding = strtolower($header->encoding);
+global $default_charset;
+set_my_charset();
 
+/* end globals */
 
+$imapConnection = sqimap_login($username, false, $imapServerAddress, $imapPort, 0);
+$aMailbox = sqm_api_mailbox_select($imapConnection, $account, $mailbox,array(),array());
 
+if (isset($aMailbox['MSG_HEADERS'][$passed_id]['MESSAGE_OBJECT']) &&
+    is_object($aMailbox['MSG_HEADERS'][$passed_id]['MESSAGE_OBJECT']) ) {
+    $message = $aMailbox['MSG_HEADERS'][$passed_id]['MESSAGE_OBJECT'];
+} else {
+    $message = sqimap_get_message($imapConnection, $passed_id, $mailbox);
+    $aMailbox['MSG_HEADERS'][$passed_id]['MESSAGE_OBJECT'] = $message;
+}
 
-/*
-$extracted = false;
-if (isset($extract_message) && $extract_message) {
-  $cmd = "FETCH $passed_id BODY[$passed_ent_id]";
-  $read = sqimap_run_command ($imapConnection, $cmd, true, $response, $message, $uid_support);
-  $cnt = count($read);
-  $body = '';
-  $length = 0;
-  for ($i=1;$i<$cnt;$i++) {
-      $length = $length + strlen($read[$i]);
-      $body .= $read[$i];
-  }
-  if (isset($targetMailbox) && $length>0) {
-      sqimap_append ($imapConnection, $targetMailbox, $length);
-      fputs($imapConnection,$body);
-      sqimap_append_done ($imapConnection);
-      $extracted = true;
-  }
-}   
+$subject = $message->rfc822_header->subject;
+if ($ent_id) {
+    // replace message with message part, if message part is requested.
+    $message = $message->getEntity($ent_id);
+    $header = $message->header;
 
-if (isset($showHeaders)) {
-  $top_header = sqimap_get_message_header ($imapConnection, $passed_id, $mailbox);
+    if ($message->rfc822_header) {
+       $subject = $message->rfc822_header->subject;
+    } else {
+       $header = $message->header;
+    }
+    $type0 = $header->type0;
+    $type1 = $header->type1;
+    $encoding = strtolower($header->encoding);
+} else {
+    /* raw message */
+    $type0 = 'message';
+    $type1 = 'rfc822';
+    $encoding = 'US-ASCII';
+    $header = $message->header;
 }
 
-*/
 /*
  * lets redefine message as this particular entity that we wish to display.
  * it should hold only the header for this entity.  We need to fetch the body
@@ -129,37 +103,54 @@ if (isset($override_type0)) {
 if (isset($override_type1)) {
     $type1 = $override_type1;
 }
-
-$filename = decodeHeader($message->header->filename);
-
-if (!$filename) {
-    $filename = decodeHeader($message->header->name);
+$filename = '';
+if (is_object($message->header->disposition)) {
+    $filename = $header->disposition->getProperty('filename');
+    if (!$filename) {
+        $filename = $header->disposition->getProperty('name');
+    }
+    if (!$filename) {
+        $filename = $header->getParameter('name');
+    }
+} else {
+    $filename = $header->getParameter('name');
 }
 
+$filename = decodeHeader($filename,true,false);
+$filename = charset_encode($filename,$default_charset,false);
+
+// If name is not set, use subject of email
 if (strlen($filename) < 1) {
-    if ($type1 == 'plain' && $type0 == 'text') {
+    $filename = decodeHeader($subject, true, true);
+    $filename = charset_encode($filename,$default_charset,false);
+    if ($type1 == 'plain' && $type0 == 'text')
         $suffix = 'txt';
-       $filename = $header->subject . '.txt';
-    } else if ($type1 == 'richtext' && $type0 == 'text') {
+    else if ($type1 == 'richtext' && $type0 == 'text')
         $suffix = 'rtf';
-       $filename = $header->subject . '.rtf';
-    } else if ($type1 == 'postscript' && $type0 == 'application') {
+    else if ($type1 == 'postscript' && $type0 == 'application')
         $suffix = 'ps';
-       $filename = $header->subject . '.ps';
-    } else if ($type1 == 'rfc822' && $type0 == 'message') {
+    else if ($type1 == 'rfc822' && $type0 == 'message')
         $suffix = 'eml';
-       $filename = $header->subject . '.msg';
-    } else {
+    else
         $suffix = $type1;
-    }
 
-    if (strlen($filename) < 1) {
-    $filename = "untitled$passed_ent_id.$suffix";
-    } else {
-    $filename = "$filename.$suffix";
-    }
+    if ($filename == '')
+        $filename = 'untitled' . strip_tags($ent_id);
+    $filename = $filename . '.' . $suffix;
 }
 
+/**
+ * Update mailbox_cache and close session in order to prevent
+ * script locking on larger downloads. SendDownloadHeaders() and 
+ * mime_print_body_lines() don't write information to session.
+ * mime_print_body_lines() call duration depends on size of 
+ * attachment and script can cause interface lockups, if session 
+ * is not closed.
+ */
+$mailbox_cache[$aMailbox['NAME']] = $aMailbox;
+sqsession_register($mailbox_cache,'mailbox_cache');
+session_write_close();
+
 /*
  * Note:
  *    The following sections display the attachment in different
@@ -172,130 +163,15 @@ if (strlen($filename) < 1) {
  *    most likely display the attachment inline inside the browser.
  *      And finally, the third one will be used by default.  If it
  *    is displayable (text or html), it will load them up in a text
- *    viewer (built in to squirrelmail).  Otherwise, it sets the
+ *    viewer (built in to SquirrelMail).  Otherwise, it sets the
  *    content-type as application/octet-stream
  */
-if (isset($absolute_dl) && $absolute_dl == 'true') {
-    switch($type0) {
-    case 'text':
-        DumpHeaders($type0, $type1, $filename, 1);
-        $body = mime_fetch_body($imapConnection, $passed_id, $passed_ent_id);
-        $body = decodeBody($body, $encoding);
-        if ($type1 == 'plain' && isset($showHeaders)) {
-            echo _("Subject") . ": " . decodeHeader($top_header->subject) . "\n".
-                 "   " . _("From") . ": " . decodeHeader($top_header->from) . "\n".
-                 "     " . _("To") . ": " . decodeHeader(getLineOfAddrs($top_header->to)) . "\n".
-                 "   " . _("Date") . ": " . getLongDateString($top_header->date) . "\n\n";
-        } elseif ($type1 == 'html' && isset($showHeaders)) {
-            echo '<table><tr><th align=right>' . _("Subject").
-                 ':</th><td>' . decodeHeader($top_header->subject).
-                 "</td></tr>\n<tr><th align=right>" . _("From").
-                 ':</th><td>' . decodeHeader($top_header->from).
-                 "</td></tr>\n<tr><th align=right>" . _("To").
-                 ':</th><td>' . decodeHeader(getLineOfAddrs($top_header->to)).
-                 "</td></tr>\n<tr><th align=right>" . _("Date").
-                 ':</th><td>' . getLongDateString($top_header->date).
-                 "</td></tr>\n</table>\n<hr>\n";
-        } 
-        echo $body;
-        break;
-    default:
-        DumpHeaders($type0, $type1, $filename, 1);
-//     if ($message->decoded_body == '') {
-//            $message->setBody(mime_print_body_lines ($imapConnection, $passed_id, $passed_ent_id, $encoding));
-//     }
-//     echo $message->decoded_body;
-
-        mime_print_body_lines ($imapConnection, $passed_id, $passed_ent_id, $encoding);
-        break;
-    }
+if (isset($absolute_dl) && $absolute_dl) {
+    SendDownloadHeaders($type0, $type1, $filename, 1);
 } else {
-    switch ($type0) {
-    case 'text':
-        if ($type1 == 'plain' || $type1 == 'html') {
-            $body = mime_fetch_body($imapConnection, $passed_id, $passed_ent_id);
-            $body = decodeBody($body, $encoding);
-            viewText($color, $body, $passed_id, $passed_ent_id, $mailbox, $type1, $wrap_at, $imapConnection);
-        } else {
-            DumpHeaders($type0, $type1, $filename, 0);
-            $body = mime_fetch_body($imapConnection, $passed_id, $passed_ent_id);
-            $body = decodeBody($body, $encoding);
-            echo $body;
-        }
-        break;
-    default:
-        DumpHeaders($type0, $type1, $filename, 0);
-//     if ($message->decoded_body == '') {
-//            $message->setBody(mime_print_body_lines ($imapConnection, $passed_id, $passed_ent_id, $encoding));
-//
-//     } 
-//     echo $message->decoded_body;
-        mime_print_body_lines ($imapConnection, $passed_id, $passed_ent_id, $encoding);
-        break;
-    }
+    SendDownloadHeaders($type0, $type1, $filename, 0);
 }
+/* be aware that any warning caused by download.php will corrupt the
+ * attachment in case of ERROR reporting = E_ALL and the output is the screen */
+mime_print_body_lines ($imapConnection, $passed_id, $ent_id, $encoding, 'php://stdout', $force_crlf);
 
-$message = &$message->getEntity('');
-$messages[$mbx_response['UIDVALIDITY']]["$passed_id"] = &$message;
-
-/*
- * This function is verified to work with Netscape and the *very latest*
- * version of IE.  I don't know if it works with Opera, but it should now.
- */
-function DumpHeaders($type0, $type1, $filename, $force) {
-    global $HTTP_USER_AGENT;
-    $isIE = 0;
-
-
-    if (strstr($HTTP_USER_AGENT, 'compatible; MSIE ') !== false &&
-        strstr($HTTP_USER_AGENT, 'Opera') === false) {
-        $isIE = 1;
-    }
-
-    if (strstr($HTTP_USER_AGENT, 'compatible; MSIE 6') !== false &&
-        strstr($HTTP_USER_AGENT, 'Opera') === false) {
-        $isIE6 = 1;
-    }
-
-    $filename = ereg_replace('[^-a-zA-Z0-9\.]', '_', $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\"");
-    } 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
-        // 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
-        if ($isIE && !isset($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\"");
-
-            // 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\"");
-        }
-    }
-}
-?>