Happy New Year
[squirrelmail.git] / src / download.php
index 5a69181009560609f99e378856583360cae35667..86d3c1af1c6a054543e48dfc52f741659cbebd39 100644 (file)
@@ -6,38 +6,49 @@
  * Handles attachment downloads to the users computer.
  * Also allows displaying of attachments when possible.
  *
- * @copyright © 1999-2006 The SquirrelMail Project Team
+ * @copyright 1999-2020 The SquirrelMail Project Team
  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package squirrelmail
  */
 
+/** This is the download page */
+define('PAGE_NAME', 'download');
+
 /**
- * Path for SquirrelMail required files.
- * @ignore
+ * Include the SquirrelMail initialization file.
  */
-define('SM_PATH','../');
+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 */
-sqgetGlobalVar('key',        $key,          SQ_COOKIE);
-sqgetGlobalVar('username',   $username,     SQ_SESSION);
-sqgetGlobalVar('onetimepad', $onetimepad,   SQ_SESSION);
 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);
-if ( sqgetGlobalVar('passed_id', $temp, SQ_GET) ) {
-    $passed_id = (int) $temp;
-}
+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;
 }
@@ -47,23 +58,18 @@ set_my_charset();
 
 /* end globals */
 
-$imapConnection = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
+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());
 
 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;
+    $message = sqimap_get_message($imapConnection, $passed_id, $mailbox);
+    $aMailbox['MSG_HEADERS'][$passed_id]['MESSAGE_OBJECT'] = $message;
 }
 
-//$mbx_response =  sqimap_mailbox_select($imapConnection, $mailbox);
-
-//$message = &$messages[$mbx_response['UIDVALIDITY']]["$passed_id"];
-//if (!is_object($message)) {
-//    $message = sqimap_get_message($imapConnection,$passed_id, $mailbox);
-//}
 $subject = $message->rfc822_header->subject;
 if ($ent_id) {
     // replace message with message part, if message part is requested.
@@ -82,7 +88,7 @@ if ($ent_id) {
     /* raw message */
     $type0 = 'message';
     $type1 = 'rfc822';
-    $encoding = 'US-ASCII';
+    $encoding = '7bit';
     $header = $message->header;
 }
 
@@ -125,7 +131,7 @@ if (strlen($filename) < 1) {
     else if ($type1 == 'postscript' && $type0 == 'application')
         $suffix = 'ps';
     else if ($type1 == 'rfc822' && $type0 == 'message')
-        $suffix = 'msg';
+        $suffix = 'eml';
     else
         $suffix = $type1;
 
@@ -134,6 +140,18 @@ if (strlen($filename) < 1) {
     $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
@@ -156,8 +174,5 @@ if (isset($absolute_dl) && $absolute_dl) {
 }
 /* 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);
-$mailbox_cache[$aMailbox['NAME']] = $aMailbox;
-sqsession_register($mailbox_cache,'mailbox_cache');
+mime_print_body_lines ($imapConnection, $passed_id, $ent_id, $encoding, 'php://stdout', $force_crlf);
 
-?>
\ No newline at end of file