phpDocumentor updates
[squirrelmail.git] / src / download.php
index 8103994eba74bd5e63373ea8c739df58be692c8f..bb9dd9a0e7264db65a54114c1e5367a21de430f8 100644 (file)
 <?php
-   /**
-    **  download.php
-    **
-    **  Copyright (c) 1999-2000 The SquirrelMail development 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$
-    **/
-
-   define('download_php', true);  // Used for preferences
-
-   require_once('../src/validate.php');
-   require_once('../functions/imap.php');
-   require_once('../functions/mime.php');
-   require_once('../functions/date.php');
-
-   header("Pragma: ");
-   header("Cache-Control: cache");
-
-   function viewText($color, $body, $id, $entid, $mailbox, $type1, $wrap_at) {
-      global $where, $what, $charset;
-      global $startMessage;
-      
-      displayPageHeader($color, "None");
-
-      echo "<BR><TABLE WIDTH=100% BORDER=0 CELLSPACING=0 CELLPADDING=2 ALIGN=CENTER><TR><TD BGCOLOR=\"$color[0]\">";
-      echo "<B><CENTER>";
-      echo _("Viewing a text attachment") . " - ";
-      if ($where && $what) {
-         // from a search
-         echo "<a href=\"read_body.php?mailbox=".urlencode($mailbox)."&passed_id=$id&where=".urlencode($where)."&what=".urlencode($what)."\">". _("View message") . "</a>";
-      } else {   
-         echo "<a href=\"read_body.php?mailbox=".urlencode($mailbox)."&passed_id=$id&startMessage=$startMessage&show_more=0\">". _("View message") . "</a>";
-      }   
-
-      $urlmailbox = urlencode($mailbox);
-      echo "</b></td><tr><tr><td><CENTER><A HREF=\"../src/download.php?absolute_dl=true&passed_id=$id&passed_ent_id=$entid&mailbox=$urlmailbox\">";
-      echo _("Download this as a file");
-      echo "</A></CENTER><BR>";
-      echo "</CENTER></B>";
-      echo "</TD></TR></TABLE>";
-
-      echo "<TABLE WIDTH=98% BORDER=0 CELLSPACING=0 CELLPADDING=2 ALIGN=CENTER><TR><TD BGCOLOR=\"$color[0]\">";
-      echo "<TR><TD BGCOLOR=\"$color[4]\"><TT>";
-
-      if ($type1 != "html")
-         translateText($body, $wrap_at, $charset);
-      
-      echo $body;
-
-      echo "</TT></TD></TR></TABLE>";
-   }
-
-   $imapConnection = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
-   sqimap_mailbox_select($imapConnection, $mailbox);
-
-   // $message contains all information about the message
-   // including header and body
+
+/**
+ * download.php
+ *
+ * Handles attachment downloads to the users computer.
+ * Also allows displaying of attachments when possible.
+ *
+ * @copyright &copy; 1999-2005 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package squirrelmail
+ */
+
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
+define('SM_PATH','../');
+
+/* SquirrelMail required files. */
+require_once(SM_PATH . 'include/validate.php');
+require_once(SM_PATH . 'functions/imap.php');
+require_once(SM_PATH . 'functions/mime.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;
+}
+if (!sqgetGlobalVar('account', $account, SQ_GET) ) {
+    $account = 0;
+}
+
+global $default_charset;
+set_my_charset();
+
+/* end globals */
+
+$imapConnection = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
+$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);
-   $top_header = $message->header;
-
-   // lets redefine message as this particular entity that we wish to display.
-   // it should hold only the header for this entity.  We need to fetch the body
-   // yet before we can display anything.
-   $message = getEntity($message, $passed_ent_id);
-
-   $header = $message->header;
-
-   $charset = $header->charset;
-   $type0 = $header->type0;
-   $type1 = $header->type1;
-   if (isset($override_type0))
-       $type0 = $override_type0;
-   if (isset($override_type1))
-       $type1 = $override_type1;
-   $filename = decodeHeader($header->filename);
-   if (!$filename) {
-      $filename = decodeHeader($header->name);
-   }
-
-   if (strlen($filename) < 1) {
-      if ($type1 == "plain" && $type0 == "text")                  $suffix = "txt";
-      else if ($type1 == "richtext" && $type0 == "text")          $suffix = "rtf";
-      else if ($type1 == "postscript" && $type0 == "application") $suffix = "ps";
-      else if ($type1 == "message" && $type0 == "rfc822")         $suffix = "msg";
-      else $suffix = $type1;
-
-      $filename = "untitled$passed_ent_id.$suffix";
-   }
-
-   // Note:
-   //    The following sections display the attachment in different
-   //    ways depending on how they choose.  The first way will download
-   //    under any circumstance.  This sets the Content-type to be
-   //    applicatin/octet-stream, which should be interpreted by the
-   //    browser as "download me".
-   //      The second method (view) is used for images or other formats
-   //    that should be able to be handled by the browser.  It will
-   //    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
-   //    content-type as application/octet-stream
-   
-   if (isset($absolute_dl) && $absolute_dl == "true") {
-      switch($type0) {
-         case "text":
-           DumpHeaders($type0, $type1, $filename, 1);
-            $body = mime_fetch_body($imapConnection, $passed_id, $passed_ent_id);
-            $body = decodeBody($body, $header->encoding);
-            if ($type1 == "plain" && isset($showHeaders)) {
-               echo _("Subject") . ": " . decodeHeader($top_header->subject) . "\n";
-               echo "   " . _("From") . ": " . decodeHeader($top_header->from) . "\n";
-               echo "     " . _("To") . ": " . decodeHeader(getLineOfAddrs($top_header->to)) . "\n";
-               echo "   " . _("Date") . ": " . getLongDateString($top_header->date) . "\n\n";
-            }
-           elseif ($type1 == "html" && isset($showHeaders)) {
-              echo '<table><tr><th align=right>' . _("Subject");
-              echo ':</th><td>' . decodeHeader($top_header->subject);
-              echo "</td></tr>\n<tr><th align=right>" . _("From");
-              echo ':</th><td>' . decodeHeader($top_header->from);
-              echo "</td></tr>\n<tr><th align=right>" . _("To");
-              echo ':</th><td>' . decodeHeader(getLineOfAddrs($top_header->to));
-              echo "</td></tr>\n<tr><th align=right>" . _("Date");
-              echo ':</th><td>' . getLongDateString($top_header->date);
-              echo "</td></tr>\n</table>\n<hr>\n";
-           }
-            echo $body;
-            break;
-         default:
-           DumpHeaders($type0, $type1, $filename, 1);
-            mime_print_body_lines ($imapConnection, $passed_id, $passed_ent_id, $header->encoding);
-            break;
-      }
-   } else {
-      switch ($type0) {
-         case "text":
-            if ($type1 == "plain" || $type1 == "html") {
-                $body = mime_fetch_body($imapConnection, $passed_id, $passed_ent_id);
-                $body = decodeBody($body, $header->encoding);
-                viewText($color, $body, $passed_id, $passed_ent_id, $mailbox, $type1, $wrap_at);
-            } else {
-               DumpHeaders($type0, $type1, $filename, 0);
-                $body = mime_fetch_body($imapConnection, $passed_id, $passed_ent_id);
-                $body = decodeBody($body, $header->encoding);
-                echo $body;
-            }
-            break;
-         case "message":
-            $body = mime_fetch_body($imapConnection, $passed_id, $passed_ent_id);
-            $body = decodeBody($body, $header->encoding);
-            viewText($color, $body, $passed_id, $passed_ent_id, $mailbox, $type1, $wrap_at);
-            break;
-         default:
-           DumpHeaders($type0, $type1, $filename, 0);
-            mime_print_body_lines ($imapConnection, $passed_id, $passed_ent_id, $header->encoding);
-            break;
-      }
-   }
-   
-   
-   // This function is verified to work with Netscape and the *very latest*
-   // version of IE.  I don't know if it works with Opera, but it should now.
-   function DumpHeaders($type0, $type1, $filename, $force)
-   {
-      global $HTTP_USER_AGENT;
-      
-      $isIE = 0;
-      if (strstr($HTTP_USER_AGENT, 'compatible; MSIE ') !== false &&
-          strstr($HTTP_USER_AGENT, 'Opera') === false) {
-        $isIE = 1;
-      }
-      
-      $filename = ereg_replace('[^-a-zA-Z0-9\.]', '_', $filename);
-      
-      // A Pox on Microsoft and it's Office!
-      if (! $force)
-      {
-          // Try to show in browser window
-          header("Content-Disposition: inline; filename=\"$filename\"");
-         header("Content-Type: $type0/$type1; name=\"$filename\"");
-      }
-      else
-      {
-          // Try to pop up the "save as" box
-         // IE makes this hard.  It pops up 2 save boxes, or none.
-         // http://support.microsoft.com/support/kb/articles/Q238/5/88.ASP
-         // But, accordint to Microsoft, it is "RFC compliant but doesn't
-         // take into account some deviations that allowed within the
-         // specification."  Doesn't that mean RFC non-compliant?
-         // http://support.microsoft.com/support/kb/articles/Q258/4/52.ASP
-         //
-         // The best thing you can do for IE is to upgrade to the latest
-         // version
-          if ($isIE) {
-            // http://support.microsoft.com/support/kb/articles/Q182/3/15.asp
-            // Do not have quotes around filename, but that applied to
-            // "attachment"... does it apply to inline too?
-            //
-            // This combination seems to work mostly.  IE 5.5 SP 1 has
-            // known issues (see the Microsoft Knowledge Base)
-             header("Content-Disposition: inline; filename=$filename");
-             
-            // This works for most types, but doesn't work with Word files
-             header("Content-Type: application/download; name=\"$filename\"");
-
-             // These are spares, just in case.  :-)
-             //header("Content-Type: $type0/$type1; name=\"$filename\"");
-             //header("Content-Type: application/x-msdownload; name=\"$filename\"");
-             //header("Content-Type: application/octet-stream; name=\"$filename\"");
-         } else {
-             header("Content-Disposition: attachment; filename=\"$filename\"");
-            // application/octet-stream forces download for Netscape
-             header("Content-Type: application/octet-stream; name=\"$filename\"");
-         }
-      }
-   }
+   $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.
+    $message = $message->getEntity($ent_id);
+    $header = $message->header;
+
+    if ($message->rfc822_header) {
+       $subject = $message->rfc822_header->subject;
+    } else {
+       $header = $message->header;
+    }
+    $type0 = $header->type0;
+    $type1 = $header->type1;
+    $encoding = strtolower($header->encoding);
+} else {
+    /* raw message */
+    $type0 = 'message';
+    $type1 = 'rfc822';
+    $encoding = 'US-ASCII';
+    $header = $message->header;
+}
+
+/*
+ * lets redefine message as this particular entity that we wish to display.
+ * it should hold only the header for this entity.  We need to fetch the body
+ * yet before we can display anything.
+ */
+
+if (isset($override_type0)) {
+    $type0 = $override_type0;
+}
+if (isset($override_type1)) {
+    $type1 = $override_type1;
+}
+$filename = '';
+if (is_object($message->header->disposition)) {
+    $filename = $header->disposition->getProperty('filename');
+    if (!$filename) {
+        $filename = $header->disposition->getProperty('name');
+    }
+    if (!$filename) {
+        $filename = $header->getParameter('name');
+    }
+} else {
+    $filename = $header->getParameter('name');
+}
+
+$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, true, true);
+    $filename = charset_encode($filename,$default_charset,false);
+    if ($type1 == 'plain' && $type0 == 'text')
+        $suffix = 'txt';
+    else if ($type1 == 'richtext' && $type0 == 'text')
+        $suffix = 'rtf';
+    else if ($type1 == 'postscript' && $type0 == 'application')
+        $suffix = 'ps';
+    else if ($type1 == 'rfc822' && $type0 == 'message')
+        $suffix = 'msg';
+    else
+        $suffix = $type1;
+
+    if ($filename == '')
+        $filename = 'untitled' . strip_tags($ent_id);
+    $filename = $filename . '.' . $suffix;
+}
+
+/*
+ * Note:
+ *    The following sections display the attachment in different
+ *    ways depending on how they choose.  The first way will download
+ *    under any circumstance.  This sets the Content-type to be
+ *    applicatin/octet-stream, which should be interpreted by the
+ *    browser as "download me".
+ *      The second method (view) is used for images or other formats
+ *    that should be able to be handled by the browser.  It will
+ *    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
+ *    content-type as application/octet-stream
+ */
+if (isset($absolute_dl) && $absolute_dl) {
+    SendDownloadHeaders($type0, $type1, $filename, 1);
+} else {
+    SendDownloadHeaders($type0, $type1, $filename, 0);
+}
+/* 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');
+
 ?>
\ No newline at end of file