add PAGE_NAME constant to every page under src/.
[squirrelmail.git] / src / download.php
1 <?php
2
3 /**
4 * download.php
5 *
6 * Handles attachment downloads to the users computer.
7 * Also allows displaying of attachments when possible.
8 *
9 * @copyright &copy; 1999-2007 The SquirrelMail Project Team
10 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
11 * @version $Id$
12 * @package squirrelmail
13 */
14
15 /** This is the download page */
16 define('PAGE_NAME', 'download');
17
18 /**
19 * Include the SquirrelMail initialization file.
20 */
21 require('../include/init.php');
22
23 /* SquirrelMail required files. */
24 require(SM_PATH . 'functions/imap_general.php');
25 require(SM_PATH . 'functions/mailbox_display.php');
26 require(SM_PATH . 'functions/mime.php');
27
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 */
38 require(SM_PATH . 'functions/imap_messages.php');
39 require(SM_PATH . 'functions/date.php');
40
41 header('Pragma: ');
42 header('Cache-Control: cache');
43
44 /* globals */
45 sqgetGlobalVar('mailbox_cache',$mailbox_cache,SQ_SESSION);
46 sqgetGlobalVar('messages', $messages, SQ_SESSION);
47 sqgetGlobalVar('mailbox', $mailbox, SQ_GET);
48 sqgetGlobalVar('ent_id', $ent_id, SQ_GET);
49 sqgetGlobalVar('absolute_dl',$absolute_dl, SQ_GET);
50 if ( sqgetGlobalVar('passed_id', $temp, SQ_GET) ) {
51 $passed_id = (int) $temp;
52 }
53 if (!sqgetGlobalVar('account', $account, SQ_GET) ) {
54 $account = 0;
55 }
56
57 global $default_charset;
58 set_my_charset();
59
60 /* end globals */
61
62 $imapConnection = sqimap_login($username, false, $imapServerAddress, $imapPort, 0);
63 $aMailbox = sqm_api_mailbox_select($imapConnection, $account, $mailbox,array(),array());
64
65 if (isset($aMailbox['MSG_HEADERS'][$passed_id]['MESSAGE_OBJECT']) &&
66 is_object($aMailbox['MSG_HEADERS'][$passed_id]['MESSAGE_OBJECT']) ) {
67 $message = $aMailbox['MSG_HEADERS'][$passed_id]['MESSAGE_OBJECT'];
68 } else {
69 $message = sqimap_get_message($imapConnection, $passed_id, $mailbox);
70 $aMailbox['MSG_HEADERS'][$passed_id]['MESSAGE_OBJECT'] = $message;
71 }
72
73 $subject = $message->rfc822_header->subject;
74 if ($ent_id) {
75 // replace message with message part, if message part is requested.
76 $message = $message->getEntity($ent_id);
77 $header = $message->header;
78
79 if ($message->rfc822_header) {
80 $subject = $message->rfc822_header->subject;
81 } else {
82 $header = $message->header;
83 }
84 $type0 = $header->type0;
85 $type1 = $header->type1;
86 $encoding = strtolower($header->encoding);
87 } else {
88 /* raw message */
89 $type0 = 'message';
90 $type1 = 'rfc822';
91 $encoding = 'US-ASCII';
92 $header = $message->header;
93 }
94
95 /*
96 * lets redefine message as this particular entity that we wish to display.
97 * it should hold only the header for this entity. We need to fetch the body
98 * yet before we can display anything.
99 */
100
101 if (isset($override_type0)) {
102 $type0 = $override_type0;
103 }
104 if (isset($override_type1)) {
105 $type1 = $override_type1;
106 }
107 $filename = '';
108 if (is_object($message->header->disposition)) {
109 $filename = $header->disposition->getProperty('filename');
110 if (!$filename) {
111 $filename = $header->disposition->getProperty('name');
112 }
113 if (!$filename) {
114 $filename = $header->getParameter('name');
115 }
116 } else {
117 $filename = $header->getParameter('name');
118 }
119
120 $filename = decodeHeader($filename,true,false);
121 $filename = charset_encode($filename,$default_charset,false);
122
123 // If name is not set, use subject of email
124 if (strlen($filename) < 1) {
125 $filename = decodeHeader($subject, true, true);
126 $filename = charset_encode($filename,$default_charset,false);
127 if ($type1 == 'plain' && $type0 == 'text')
128 $suffix = 'txt';
129 else if ($type1 == 'richtext' && $type0 == 'text')
130 $suffix = 'rtf';
131 else if ($type1 == 'postscript' && $type0 == 'application')
132 $suffix = 'ps';
133 else if ($type1 == 'rfc822' && $type0 == 'message')
134 $suffix = 'msg';
135 else
136 $suffix = $type1;
137
138 if ($filename == '')
139 $filename = 'untitled' . strip_tags($ent_id);
140 $filename = $filename . '.' . $suffix;
141 }
142
143 /**
144 * Update mailbox_cache and close session in order to prevent
145 * script locking on larger downloads. SendDownloadHeaders() and
146 * mime_print_body_lines() don't write information to session.
147 * mime_print_body_lines() call duration depends on size of
148 * attachment and script can cause interface lockups, if session
149 * is not closed.
150 */
151 $mailbox_cache[$aMailbox['NAME']] = $aMailbox;
152 sqsession_register($mailbox_cache,'mailbox_cache');
153 session_write_close();
154
155 /*
156 * Note:
157 * The following sections display the attachment in different
158 * ways depending on how they choose. The first way will download
159 * under any circumstance. This sets the Content-type to be
160 * applicatin/octet-stream, which should be interpreted by the
161 * browser as "download me".
162 * The second method (view) is used for images or other formats
163 * that should be able to be handled by the browser. It will
164 * most likely display the attachment inline inside the browser.
165 * And finally, the third one will be used by default. If it
166 * is displayable (text or html), it will load them up in a text
167 * viewer (built in to SquirrelMail). Otherwise, it sets the
168 * content-type as application/octet-stream
169 */
170 if (isset($absolute_dl) && $absolute_dl) {
171 SendDownloadHeaders($type0, $type1, $filename, 1);
172 } else {
173 SendDownloadHeaders($type0, $type1, $filename, 0);
174 }
175 /* be aware that any warning caused by download.php will corrupt the
176 * attachment in case of ERROR reporting = E_ALL and the output is the screen */
177 mime_print_body_lines ($imapConnection, $passed_id, $ent_id, $encoding);
178