From fbe54043cf598b19a753dc2b21a7ed558d23fd15 Mon Sep 17 00:00:00 2001
From: thomascube <thomas@roundcube.net>
Date: Thu, 18 Aug 2011 13:40:07 -0400
Subject: [PATCH] Fix folders drop-down list: descend into root folder (e.g. INBOX) even if part of the exception list
---
program/include/rcube_message.php | 288 ++++++++++++++++++++++++++++++++++++++++-----------------
1 files changed, 202 insertions(+), 86 deletions(-)
diff --git a/program/include/rcube_message.php b/program/include/rcube_message.php
index e51ab26..4f9a2f2 100644
--- a/program/include/rcube_message.php
+++ b/program/include/rcube_message.php
@@ -4,8 +4,8 @@
+-----------------------------------------------------------------------+
| program/include/rcube_message.php |
| |
- | This file is part of the RoundCube Webmail client |
- | Copyright (C) 2008-2010, RoundCube Dev. - Switzerland |
+ | This file is part of the Roundcube Webmail client |
+ | Copyright (C) 2008-2010, The Roundcube Dev Team |
| Licensed under the GNU GPL |
| |
| PURPOSE: |
@@ -29,12 +29,23 @@
*/
class rcube_message
{
+ /**
+ * Instace of rcmail.
+ *
+ * @var rcmail
+ */
private $app;
+
+ /**
+ * Instance of imap class
+ *
+ * @var rcube_imap
+ */
private $imap;
private $opt = array();
private $inline_parts = array();
private $parse_alternative = false;
-
+
public $uid = null;
public $headers;
public $structure;
@@ -44,7 +55,7 @@
public $subject = '';
public $sender = null;
public $is_safe = false;
-
+
/**
* __construct
@@ -63,6 +74,7 @@
{
$this->app = rcmail::get_instance();
$this->imap = $this->app->imap;
+ $this->imap->get_all_headers = true;
$this->uid = $uid;
$this->headers = $this->imap->get_headers($uid, NULL, true, true);
@@ -93,26 +105,30 @@
// notify plugins and let them analyze this structured message object
$this->app->plugins->exec_hook('message_load', array('object' => $this));
}
-
-
+
+
/**
* Return a (decoded) message header
*
- * @param string Header name
- * @param bool Don't mime-decode the value
+ * @param string $name Header name
+ * @param bool $row Don't mime-decode the value
* @return string Header value
*/
public function get_header($name, $raw = false)
{
- $value = $this->headers->$name;
+ if ($this->headers->$name)
+ $value = $this->headers->$name;
+ else if ($this->headers->others[$name])
+ $value = $this->headers->others[$name];
+
return $raw ? $value : $this->imap->decode_header($value);
}
-
+
/**
* Set is_safe var and session data
*
- * @param bool enable/disable
+ * @param bool $safe enable/disable
*/
public function set_safe($safe = true)
{
@@ -124,7 +140,7 @@
/**
* Compose a valid URL for getting a message part
*
- * @param string Part MIME-ID
+ * @param string $mime_id Part MIME-ID
* @return string URL or false if part does not exist
*/
public function get_part_url($mime_id)
@@ -139,8 +155,8 @@
/**
* Get content of a specific part of this message
*
- * @param string Part MIME-ID
- * @param resource File pointer to save the message part
+ * @param string $mime_id Part MIME-ID
+ * @param resource $fp File pointer to save the message part
* @return string Part content
*/
public function get_part_content($mime_id, $fp=NULL)
@@ -198,43 +214,37 @@
/**
* Return the first text part of this message
*
+ * @param rcube_message_part $part Reference to the part if found
* @return string Plain text message/part content
*/
- function first_text_part()
+ function first_text_part(&$part=null)
{
// no message structure, return complete body
if (empty($this->parts))
return $this->body;
-
- $out = null;
// check all message parts
foreach ($this->mime_parts as $mime_id => $part) {
$mimetype = $part->ctype_primary . '/' . $part->ctype_secondary;
if ($mimetype == 'text/plain') {
- $out = $this->imap->get_message_part($this->uid, $mime_id, $part);
-
- // re-format format=flowed content
- if ($part->ctype_secondary == 'plain' && $part->ctype_parameters['format'] == 'flowed')
- $out = self::unfold_flowed($out);
- break;
+ return $this->imap->get_message_part($this->uid, $mime_id, $part);
}
else if ($mimetype == 'text/html') {
- $html_part = $this->imap->get_message_part($this->uid, $mime_id, $part);
+ $out = $this->imap->get_message_part($this->uid, $mime_id, $part);
// remove special chars encoding
$trans = array_flip(get_html_translation_table(HTML_ENTITIES));
- $html_part = strtr($html_part, $trans);
+ $out = strtr($out, $trans);
// create instance of html2text class
- $txt = new html2text($html_part);
- $out = $txt->get_text();
- break;
+ $txt = new html2text($out);
+ return $txt->get_text();
}
}
- return $out;
+ $part = null;
+ return null;
}
@@ -242,22 +252,16 @@
* Raad the message structure returend by the IMAP server
* and build flat lists of content parts and attachments
*
- * @param object rcube_message_part Message structure node
- * @param bool True when called recursively
+ * @param rcube_message_part $structure Message structure node
+ * @param bool $recursive True when called recursively
*/
private function parse_structure($structure, $recursive = false)
{
- $message_ctype_primary = $structure->ctype_primary;
- $message_ctype_secondary = $structure->ctype_secondary;
- $mimetype = $structure->mimetype;
-
// real content-type of message/rfc822 part
- if ($mimetype == 'message/rfc822') {
- if ($structure->real_mimetype) {
- $mimetype = $structure->real_mimetype;
- list($message_ctype_primary, $message_ctype_secondary) = explode('/', $mimetype);
- }
- }
+ if ($structure->mimetype == 'message/rfc822' && $structure->real_mimetype)
+ $mimetype = $structure->real_mimetype;
+ else
+ $mimetype = $structure->mimetype;
// show message headers
if ($recursive && is_array($structure->headers) && isset($structure->headers['subject'])) {
@@ -266,6 +270,17 @@
$c->headers = &$structure->headers;
$this->parts[] = $c;
}
+
+ // Allow plugins to handle message parts
+ $plugin = $this->app->plugins->exec_hook('message_part_structure',
+ array('object' => $this, 'structure' => $structure,
+ 'mimetype' => $mimetype, 'recursive' => $recursive));
+
+ if ($plugin['abort'])
+ return;
+
+ $structure = $plugin['structure'];
+ list($message_ctype_primary, $message_ctype_secondary) = explode('/', $plugin['mimetype']);
// print body if message doesn't have multiple parts
if ($message_ctype_primary == 'text' && !$recursive) {
@@ -278,8 +293,6 @@
$this->mime_parts[$uupart->mime_id] = $uupart;
$this->attachments[] = $uupart;
}
-
- // @TODO: plugin hook?
}
// the same for pgp signed messages
else if ($mimetype == 'application/pgp' && !$recursive) {
@@ -360,17 +373,6 @@
$p->ctype_secondary = 'plain';
$p->body = rcube_label('encryptedmessage');
$p->size = strlen($p->body);
-
- // maybe some plugins are able to decode this encrypted message part
- $data = $this->app->plugins->exec_hook('message_part_encrypted',
- array('object' => $this, 'struct' => $structure, 'part' => $p));
-
- if (is_array($data['parts'])) {
- $this->parts = array_merge($this->parts, $data['parts']);
- }
- else if ($data['part']) {
- $this->parts[] = $p;
- }
}
// message contains multiple parts
else if (is_array($structure->parts) && !empty($structure->parts)) {
@@ -397,10 +399,25 @@
if ($part_orig_mimetype == 'message/rfc822' && !empty($mail_part->filename))
$this->attachments[] = $mail_part;
}
- // part text/[plain|html] OR message/delivery-status
+ // part text/[plain|html] or delivery status
else if ((($part_mimetype == 'text/plain' || $part_mimetype == 'text/html') && $mail_part->disposition != 'attachment') ||
- $part_mimetype == 'message/delivery-status' || $part_mimetype == 'message/disposition-notification'
+ in_array($part_mimetype, array('message/delivery-status', 'text/rfc822-headers', 'message/disposition-notification'))
) {
+ // Allow plugins to handle also this part
+ $plugin = $this->app->plugins->exec_hook('message_part_structure',
+ array('object' => $this, 'structure' => $mail_part,
+ 'mimetype' => $part_mimetype, 'recursive' => true));
+
+ if ($plugin['abort'])
+ continue;
+
+ if ($part_mimetype == 'text/html') {
+ $got_html_part = true;
+ }
+
+ $mail_part = $plugin['structure'];
+ list($primary_type, $secondary_type) = explode('/', $plugin['mimetype']);
+
// add text part if it matches the prefs
if (!$this->parse_alternative ||
($secondary_type == 'html' && $this->opt['prefer_html']) ||
@@ -409,7 +426,7 @@
$mail_part->type = 'content';
$this->parts[] = $mail_part;
}
-
+
// list as attachment as well
if (!empty($mail_part->filename))
$this->attachments[] = $mail_part;
@@ -435,7 +452,9 @@
}
// part is a file/attachment
else if (preg_match('/^(inline|attach)/', $mail_part->disposition) ||
- $mail_part->headers['content-id'] || (empty($mail_part->disposition) && $mail_part->filename)
+ $mail_part->headers['content-id'] ||
+ ($mail_part->filename &&
+ (empty($mail_part->disposition) || preg_match('/^[a-z0-9!#$&.+^_-]+$/i', $mail_part->disposition)))
) {
// skip apple resource forks
if ($message_ctype_secondary == 'appledouble' && $secondary_type == 'applefile')
@@ -454,11 +473,26 @@
// attachment encapsulated within message/rfc822 part needs further decoding (#1486743)
else if ($part_orig_mimetype == 'message/rfc822') {
$this->parse_structure($mail_part, true);
+
+ // list as attachment as well (mostly .eml)
+ if (!empty($mail_part->filename))
+ $this->attachments[] = $mail_part;
}
- // is a regular attachment
- else if (preg_match('!^[a-z0-9-.+]+/[a-z0-9-.+]+$!i', $part_mimetype)) {
+ // regular attachment with valid content type
+ // (content-type name regexp according to RFC4288.4.2)
+ else if (preg_match('/^[a-z0-9!#$&.+^_-]+\/[a-z0-9!#$&.+^_-]+$/i', $part_mimetype)) {
if (!$mail_part->filename)
$mail_part->filename = 'Part '.$mail_part->mime_id;
+
+ $this->attachments[] = $mail_part;
+ }
+ // attachment with invalid content type
+ // replace malformed content type with application/octet-stream (#1487767)
+ else if ($mail_part->filename) {
+ $mail_part->ctype_primary = 'application';
+ $mail_part->ctype_secondary = 'octet-stream';
+ $mail_part->mimetype = 'application/octet-stream';
+
$this->attachments[] = $mail_part;
}
}
@@ -467,13 +501,33 @@
// if this was a related part try to resolve references
if ($mimetype == 'multipart/related' && sizeof($this->inline_parts)) {
$a_replaces = array();
+ $img_regexp = '/^image\/(gif|jpe?g|png|tiff|bmp|svg)/';
foreach ($this->inline_parts as $inline_object) {
$part_url = $this->get_part_url($inline_object->mime_id);
if ($inline_object->content_id)
$a_replaces['cid:'.$inline_object->content_id] = $part_url;
- if ($inline_object->content_location)
+ if ($inline_object->content_location) {
$a_replaces[$inline_object->content_location] = $part_url;
+ }
+
+ if (!empty($inline_object->filename)) {
+ // MS Outlook sends sometimes non-related attachments as related
+ // In this case multipart/related message has only one text part
+ // We'll add all such attachments to the attachments list
+ if (!isset($got_html_part) && empty($inline_object->content_id)) {
+ $this->attachments[] = $inline_object;
+ }
+ // MS Outlook sometimes also adds non-image attachments as related
+ // We'll add all such attachments to the attachments list
+ // Warning: some browsers support pdf in <img/>
+ else if (!preg_match($img_regexp, $inline_object->mimetype)) {
+ $this->attachments[] = $inline_object;
+ }
+ // @TODO: we should fetch HTML body and find attachment's content-id
+ // to handle also image attachments without reference in the body
+ // @TODO: should we list all image attachments in text mode?
+ }
}
// add replace array to each content part
@@ -488,19 +542,24 @@
else if ($structure->filename) {
$this->attachments[] = $structure;
}
+ // message is a single part non-text (without filename)
+ else if (preg_match('/application\//i', $mimetype)) {
+ $structure->filename = 'Part '.$structure->mime_id;
+ $this->attachments[] = $structure;
+ }
}
/**
* Fill aflat array with references to all parts, indexed by part numbers
*
- * @param object rcube_message_part Message body structure
+ * @param rcube_message_part $part Message body structure
*/
private function get_mime_numbers(&$part)
{
if (strlen($part->mime_id))
$this->mime_parts[$part->mime_id] = &$part;
-
+
if (is_array($part->parts))
for ($i=0; $i<count($part->parts); $i++)
$this->get_mime_numbers($part->parts[$i]);
@@ -510,7 +569,8 @@
/**
* Decode a Microsoft Outlook TNEF part (winmail.dat)
*
- * @param object rcube_message_part Message part to decode
+ * @param rcube_message_part $part Message part to decode
+ * @return array
*/
function tnef_decode(&$part)
{
@@ -518,18 +578,17 @@
if (!isset($part->body))
$part->body = $this->imap->get_message_part($this->uid, $part->mime_id, $part);
- require_once('lib/tnef_decoder.inc');
-
$parts = array();
- $tnef_arr = tnef_decode($part->body);
+ $tnef = new tnef_decoder;
+ $tnef_arr = $tnef->decompress($part->body);
foreach ($tnef_arr as $pid => $winatt) {
$tpart = new rcube_message_part;
$tpart->filename = trim($winatt['name']);
$tpart->encoding = 'stream';
- $tpart->ctype_primary = trim(strtolower($winatt['type0']));
- $tpart->ctype_secondary = trim(strtolower($winatt['type1']));
+ $tpart->ctype_primary = trim(strtolower($winatt['type']));
+ $tpart->ctype_secondary = trim(strtolower($winatt['subtype']));
$tpart->mimetype = $tpart->ctype_primary . '/' . $tpart->ctype_secondary;
$tpart->mime_id = 'winmail.' . $part->mime_id . '.' . $pid;
$tpart->size = $winatt['size'];
@@ -538,7 +597,7 @@
$parts[] = $tpart;
unset($tnef_arr[$pid]);
}
-
+
return $parts;
}
@@ -546,7 +605,8 @@
/**
* Parse message body for UUencoded attachments bodies
*
- * @param object rcube_message_part Message part to decode
+ * @param rcube_message_part $part Message part to decode
+ * @return array
*/
function uu_decode(&$part)
{
@@ -584,7 +644,7 @@
unset($matches[$pid]);
}
}
-
+
return $parts;
}
@@ -592,34 +652,90 @@
/**
* Interpret a format=flowed message body according to RFC 2646
*
- * @param string Raw body formatted as flowed text
+ * @param string $text Raw body formatted as flowed text
* @return string Interpreted text with unwrapped lines and stuffed space removed
*/
public static function unfold_flowed($text)
{
- return preg_replace(
- array('/-- (\r?\n)/', '/^ /m', '/(.) \r?\n/', '/--%SIGEND%(\r?\n)/'),
- array('--%SIGEND%\\1', '', '\\1 ', '-- \\1'),
- $text);
+ $text = preg_split('/\r?\n/', $text);
+ $last = -1;
+ $q_level = 0;
+
+ foreach ($text as $idx => $line) {
+ if ($line[0] == '>' && preg_match('/^(>+\s*)/', $line, $regs)) {
+ $q = strlen(str_replace(' ', '', $regs[0]));
+ $line = substr($line, strlen($regs[0]));
+
+ if ($q == $q_level && $line
+ && isset($text[$last])
+ && $text[$last][strlen($text[$last])-1] == ' '
+ ) {
+ $text[$last] .= $line;
+ unset($text[$idx]);
+ }
+ else {
+ $last = $idx;
+ }
+ }
+ else {
+ $q = 0;
+ if ($line == '-- ') {
+ $last = $idx;
+ }
+ else {
+ // remove space-stuffing
+ $line = preg_replace('/^\s/', '', $line);
+
+ if (isset($text[$last]) && $line
+ && $text[$last] != '-- '
+ && $text[$last][strlen($text[$last])-1] == ' '
+ ) {
+ $text[$last] .= $line;
+ unset($text[$idx]);
+ }
+ else {
+ $text[$idx] = $line;
+ $last = $idx;
+ }
+ }
+ }
+ $q_level = $q;
+ }
+
+ return implode("\r\n", $text);
}
/**
* Wrap the given text to comply with RFC 2646
+ *
+ * @param string $text Text to wrap
+ * @param int $length Length
+ * @return string Wrapped text
*/
public static function format_flowed($text, $length = 72)
{
- $out = '';
-
- foreach (preg_split('/\r?\n/', trim($text)) as $line) {
- // don't wrap quoted lines (to avoid wrapping problems)
- if ($line[0] != '>')
- $line = rc_wordwrap(rtrim($line), $length - 1, " \r\n");
+ $text = preg_split('/\r?\n/', $text);
- $out .= $line . "\r\n";
+ foreach ($text as $idx => $line) {
+ if ($line != '-- ') {
+ if ($line[0] == '>' && preg_match('/^(>+)/', $line, $regs)) {
+ $prefix = $regs[0];
+ $level = strlen($prefix);
+ $line = rtrim(substr($line, $level));
+ $line = $prefix . rc_wordwrap($line, $length - $level - 2, " \r\n$prefix ");
+ }
+ else if ($line) {
+ $line = rc_wordwrap(rtrim($line), $length - 2, " \r\n");
+ // space-stuffing
+ $line = preg_replace('/(^|\r\n)(From| |>)/', '\\1 \\2', $line);
+ }
+
+ $text[$idx] = $line;
+ }
}
-
- return $out;
+
+ return implode("\r\n", $text);
}
}
--
Gitblit v1.9.1