Happy New Year
[squirrelmail.git] / src / download.php
index 28fe5c809d957455bcb25e446ab0183fff915208..30a880c4845d6a1a5504f0e0076980f615254dd9 100644 (file)
@@ -3,65 +3,94 @@
 /**
  * download.php
  *
- * Copyright (c) 1999-2003 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-2018 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package squirrelmail
  */
 
-/* Path for SquirrelMail required files. */
-define('SM_PATH','../');
+/** This is the download page */
+define('PAGE_NAME', 'download');
+
+/**
+ * Include the SquirrelMail initialization file.
+ */
+require('../include/init.php');
 
 /* SquirrelMail required files. */
-require_once(SM_PATH . 'include/validate.php');
-require_once(SM_PATH . 'functions/imap.php');
-require_once(SM_PATH . 'functions/mime.php');
+require(SM_PATH . 'functions/imap_general.php');
+require(SM_PATH . 'functions/mailbox_display.php');
+require(SM_PATH . 'functions/mime.php');
+
+/**
+ * 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');
 
 header('Pragma: ');
 header('Cache-Control: cache');
 
 /* globals */
-
-$key = $_COOKIE['key'];
-$username = $_SESSION['username'];
-$onetimepad = $_SESSION['onetimepad'];
-$mailbox = $_GET['mailbox'];
-$passed_id = (int) $_GET['passed_id'];
-$ent_id = $_GET['ent_id'];
-$messages = $_SESSION['messages'];
-
-if (isset($_GET['absolute_dl'])) {
-   $absolute_dl = $_GET['absolute_dl'];
+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;
 }
 
-/* end globals */
-$mailbox = decodeHeader($mailbox);
+global $default_charset;
+set_my_charset();
 
-global $uid_support;
+/* end globals */
 
-$imapConnection = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
-$mbx_response =  sqimap_mailbox_select($imapConnection, $mailbox);
+global $imap_stream_options; // in case not defined in config
+$imapConnection = sqimap_login($username, false, $imapServerAddress, $imapPort, 0, $imap_stream_options);
+$aMailbox = sqm_api_mailbox_select($imapConnection, $account, $mailbox,array(),array());
 
-$message = &$messages[$mbx_response['UIDVALIDITY']]["$passed_id"];
-if (!is_object($message)) {
-    $message = sqimap_get_message($imapConnection,$passed_id, $mailbox);
+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;
 }
+
 $subject = $message->rfc822_header->subject;
-$message = &$message->getEntity($ent_id);
-$header = $message->header;
-if ($message->rfc822_header) {
-   $subject = $message->rfc822_header->subject;
-   $charset = $header->content_type->properties['charset'];
+if ($ent_id) {
+    // replace message with message part, if message part is requested.
+    $message = $message->getEntity($ent_id);
+    $header = $message->header;
+
+    if ($message->rfc822_header) {
+       $subject = $message->rfc822_header->subject;
+    } else {
+       $header = $message->header;
+    }
+    $type0 = $header->type0;
+    $type1 = $header->type1;
+    $encoding = strtolower($header->encoding);
 } else {
-   $header = $message->header;
-   $charset = $header->getParameter('charset');
+    /* raw message */
+    $type0 = 'message';
+    $type1 = 'rfc822';
+    $encoding = '7bit';
+    $header = $message->header;
 }
-$type0 = $header->type0;
-$type1 = $header->type1;
-$encoding = strtolower($header->encoding);
 
 /*
  * lets redefine message as this particular entity that we wish to display.
@@ -77,35 +106,52 @@ if (isset($override_type1)) {
 }
 $filename = '';
 if (is_object($message->header->disposition)) {
-    $filename = decodeHeader($header->disposition->getProperty('filename'));
+    $filename = $header->disposition->getProperty('filename');
     if (!$filename) {
-       $filename = decodeHeader($header->disposition->getProperty('name'));
+        $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 = $subject . '.txt';
-    } else if ($type1 == 'richtext' && $type0 == 'text') {
+    else if ($type1 == 'richtext' && $type0 == 'text')
         $suffix = 'rtf';
-       $filename = $subject . '.rtf';
-    } else if ($type1 == 'postscript' && $type0 == 'application') {
+    else if ($type1 == 'postscript' && $type0 == 'application')
         $suffix = 'ps';
-       $filename = $subject . '.ps';
-    } else if ($type1 == 'rfc822' && $type0 == 'message') {
+    else if ($type1 == 'rfc822' && $type0 == 'message')
         $suffix = 'eml';
-       $filename = $subject . '.msg';
-    } else {
+    else
         $suffix = $type1;
-    }
 
-    if (strlen($filename) < 1) {
-       $filename = 'untitled'.strip_tags($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
@@ -118,82 +164,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) {
-    DumpHeaders($type0, $type1, $filename, 1);
+    SendDownloadHeaders($type0, $type1, $filename, 1);
 } else {
-    DumpHeaders($type0, $type1, $filename, 0);
+    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);
-
-/*
- * 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 $_SERVER, $languages, $squirrelmail_language;
-    $isIE = $isIE6 = 0;
-
-    $HTTP_USER_AGENT = $_SERVER['HTTP_USER_AGENT'];
+mime_print_body_lines ($imapConnection, $passed_id, $ent_id, $encoding, 'php://stdout', $force_crlf);
 
-    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;
-    }
-
-    if (isset($languages[$squirrelmail_language]['XTRA_CODE']) &&
-        function_exists($languages[$squirrelmail_language]['XTRA_CODE'])) {
-        $filename = 
-            $languages[$squirrelmail_language]['XTRA_CODE']('downloadfilename', $filename, $HTTP_USER_AGENT);
-    } else {
-       $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 && !$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\"");
-        }
-    }
-}
-?>