add PAGE_NAME constant to every page under src/.
[squirrelmail.git] / src / download.php
index 5feed3eafcf5871c56b75e7c654d38cdffebca18..77b5e040ddf4a7fc856c756cb77e113be75261ce 100644 (file)
@@ -3,53 +3,77 @@
 /**
  * download.php
  *
- * Copyright (c) 1999-2004 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
  */
 
-/** 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 */
-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;
+    $passed_id = (int) $temp;
+}
+if (!sqgetGlobalVar('account', $account, SQ_GET) ) {
+    $account = 0;
 }
 
-/* end globals */
+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);
+$imapConnection = sqimap_login($username, false, $imapServerAddress, $imapPort, 0);
+$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;
 if ($ent_id) {
-    $message = &$message->getEntity($ent_id);
+    // replace message with message part, if message part is requested.
+    $message = $message->getEntity($ent_id);
     $header = $message->header;
 
     if ($message->rfc822_header) {
@@ -93,11 +117,13 @@ if (is_object($message->header->disposition)) {
     $filename = $header->getParameter('name');
 }
 
-//$filename = decodeHeader($filename, false, false);   //Don't want html output nor utf8 because it will return html output
-$filename = decodeHeader($filename, true, false);   //Don't want html output
+$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) {
-    //$filename = decodeHeader($subject, false, false);        //Don't want html output nor utf8 because it will return html output
-    $filename = decodeHeader($subject, true, false);   //Don't want html output
+    $filename = decodeHeader($subject, true, true);
+    $filename = charset_encode($filename,$default_charset,false);
     if ($type1 == 'plain' && $type0 == 'text')
         $suffix = 'txt';
     else if ($type1 == 'richtext' && $type0 == 'text')
@@ -114,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
@@ -126,7 +164,7 @@ 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) {
@@ -138,4 +176,3 @@ if (isset($absolute_dl) && $absolute_dl) {
  * attachment in case of ERROR reporting = E_ALL and the output is the screen */
 mime_print_body_lines ($imapConnection, $passed_id, $ent_id, $encoding);
 
-?>