Add compatibility with Dovecot's bigint UIDs
[squirrelmail.git] / src / download.php
CommitLineData
59177427 1<?php
895905c0 2
35586184 3/**
4 * download.php
5 *
35586184 6 * Handles attachment downloads to the users computer.
7 * Also allows displaying of attachments when possible.
8 *
4b5049de 9 * @copyright &copy; 1999-2007 The SquirrelMail Project Team
4b4abf93 10 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
30967a1e 11 * @version $Id$
2b646597 12 * @package squirrelmail
35586184 13 */
14
ebd2391c 15/** This is the download page */
16define('PAGE_NAME', 'download');
17
30967a1e 18/**
202bcbcc 19 * Include the SquirrelMail initialization file.
30967a1e 20 */
202bcbcc 21require('../include/init.php');
86725763 22
23/* SquirrelMail required files. */
202bcbcc 24require(SM_PATH . 'functions/imap_general.php');
25require(SM_PATH . 'functions/mailbox_display.php');
26require(SM_PATH . 'functions/mime.php');
6b96544a 27
2b82cab1 28/**
29 * If a message is viewed from the search page, $aMailbox[$passed_id]['MESSAGE_OBJECT']
30 * is not initialized, which makes this page error out on line 65 with an
31 * undefined function. We need to include some additional files in case the
32 * object has not been initialized.
33 *
34 * TODO: Determine why the object in question is not initialized when coming from
35 * a search page and correct. Once that is done, we can remove these
36 * includes.
37 */
38require(SM_PATH . 'functions/imap_messages.php');
39require(SM_PATH . 'functions/date.php');
40
65c3ec94 41header('Pragma: ');
42header('Cache-Control: cache');
43
0b97a708 44/* globals */
324ac3c5 45sqgetGlobalVar('mailbox_cache',$mailbox_cache,SQ_SESSION);
1e12d1ff 46sqgetGlobalVar('messages', $messages, SQ_SESSION);
47sqgetGlobalVar('mailbox', $mailbox, SQ_GET);
48sqgetGlobalVar('ent_id', $ent_id, SQ_GET);
49sqgetGlobalVar('absolute_dl',$absolute_dl, SQ_GET);
fa26ab45 50sqgetGlobalVar('force_crlf', $force_crlf, SQ_GET);
51bbe8fa 51sqgetGlobalVar('passed_id', $passed_id, SQ_GET, NULL, SQ_TYPE_BIGINT);
91c27aee 52if (!sqgetGlobalVar('account', $account, SQ_GET) ) {
53 $account = 0;
54}
1075eaf1 55
fa7ba04e 56global $default_charset;
57set_my_charset();
58
0b97a708 59/* end globals */
97d7da3b 60
906f7e9f 61$imapConnection = sqimap_login($username, false, $imapServerAddress, $imapPort, 0);
91c27aee 62$aMailbox = sqm_api_mailbox_select($imapConnection, $account, $mailbox,array(),array());
97d7da3b 63
324ac3c5 64if (isset($aMailbox['MSG_HEADERS'][$passed_id]['MESSAGE_OBJECT']) &&
65 is_object($aMailbox['MSG_HEADERS'][$passed_id]['MESSAGE_OBJECT']) ) {
66 $message = $aMailbox['MSG_HEADERS'][$passed_id]['MESSAGE_OBJECT'];
67} else {
2b82cab1 68 $message = sqimap_get_message($imapConnection, $passed_id, $mailbox);
69 $aMailbox['MSG_HEADERS'][$passed_id]['MESSAGE_OBJECT'] = $message;
5a1c48cd 70}
324ac3c5 71
ff9d4297 72$subject = $message->rfc822_header->subject;
6914aa18 73if ($ent_id) {
5813f2b7 74 // replace message with message part, if message part is requested.
75 $message = $message->getEntity($ent_id);
6914aa18 76 $header = $message->header;
da2415c1 77
6914aa18 78 if ($message->rfc822_header) {
79 $subject = $message->rfc822_header->subject;
6914aa18 80 } else {
81 $header = $message->header;
6914aa18 82 }
83 $type0 = $header->type0;
84 $type1 = $header->type1;
85 $encoding = strtolower($header->encoding);
ff9d4297 86} else {
6914aa18 87 /* raw message */
88 $type0 = 'message';
89 $type1 = 'rfc822';
bc5ff7c9 90 $encoding = 'US-ASCII';
5d39ca4d 91 $header = $message->header;
ff9d4297 92}
97d7da3b 93
1e606225 94/*
65c3ec94 95 * lets redefine message as this particular entity that we wish to display.
96 * it should hold only the header for this entity. We need to fetch the body
97 * yet before we can display anything.
98 */
65c3ec94 99
65c3ec94 100if (isset($override_type0)) {
101 $type0 = $override_type0;
102}
103if (isset($override_type1)) {
104 $type1 = $override_type1;
105}
ff9d4297 106$filename = '';
107if (is_object($message->header->disposition)) {
a91189d6 108 $filename = $header->disposition->getProperty('filename');
ff9d4297 109 if (!$filename) {
708ea172 110 $filename = $header->disposition->getProperty('name');
ff9d4297 111 }
6914aa18 112 if (!$filename) {
a91189d6 113 $filename = $header->getParameter('name');
da2415c1 114 }
cf22004d 115} else {
5d39ca4d 116 $filename = $header->getParameter('name');
65c3ec94 117}
bc5ff7c9 118
765470db 119$filename = decodeHeader($filename,true,false);
fa7ba04e 120$filename = charset_encode($filename,$default_charset,false);
121
122// If name is not set, use subject of email
65c3ec94 123if (strlen($filename) < 1) {
fa7ba04e 124 $filename = decodeHeader($subject, true, true);
125 $filename = charset_encode($filename,$default_charset,false);
89c7fc5a 126 if ($type1 == 'plain' && $type0 == 'text')
65c3ec94 127 $suffix = 'txt';
89c7fc5a 128 else if ($type1 == 'richtext' && $type0 == 'text')
65c3ec94 129 $suffix = 'rtf';
89c7fc5a 130 else if ($type1 == 'postscript' && $type0 == 'application')
65c3ec94 131 $suffix = 'ps';
89c7fc5a 132 else if ($type1 == 'rfc822' && $type0 == 'message')
675c2a6f 133 $suffix = 'eml';
8e73da2b 134 else
65c3ec94 135 $suffix = $type1;
8e73da2b 136
137 if ($filename == '')
138 $filename = 'untitled' . strip_tags($ent_id);
89c7fc5a 139 $filename = $filename . '.' . $suffix;
65c3ec94 140}
141
e4baf0ee 142/**
143 * Update mailbox_cache and close session in order to prevent
144 * script locking on larger downloads. SendDownloadHeaders() and
145 * mime_print_body_lines() don't write information to session.
146 * mime_print_body_lines() call duration depends on size of
147 * attachment and script can cause interface lockups, if session
148 * is not closed.
149 */
150$mailbox_cache[$aMailbox['NAME']] = $aMailbox;
151sqsession_register($mailbox_cache,'mailbox_cache');
152session_write_close();
153
65c3ec94 154/*
155 * Note:
156 * The following sections display the attachment in different
157 * ways depending on how they choose. The first way will download
158 * under any circumstance. This sets the Content-type to be
159 * applicatin/octet-stream, which should be interpreted by the
160 * browser as "download me".
161 * The second method (view) is used for images or other formats
162 * that should be able to be handled by the browser. It will
163 * most likely display the attachment inline inside the browser.
164 * And finally, the third one will be used by default. If it
165 * is displayable (text or html), it will load them up in a text
598294a7 166 * viewer (built in to SquirrelMail). Otherwise, it sets the
65c3ec94 167 * content-type as application/octet-stream
168 */
88d916ee 169if (isset($absolute_dl) && $absolute_dl) {
da2415c1 170 SendDownloadHeaders($type0, $type1, $filename, 1);
65c3ec94 171} else {
da2415c1 172 SendDownloadHeaders($type0, $type1, $filename, 0);
65c3ec94 173}
38bca81c 174/* be aware that any warning caused by download.php will corrupt the
175 * attachment in case of ERROR reporting = E_ALL and the output is the screen */
d671df04 176mime_print_body_lines ($imapConnection, $passed_id, $ent_id, $encoding, 'php://stdout', $force_crlf);
a2b193bc 177