Source for file download.php

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

Documentation generated on Sat, 07 Oct 2006 16:10:46 +0300 by phpDocumentor 1.3.0RC6