From 323fa20bc89edcd683bef1a170445f681305fc5c Mon Sep 17 00:00:00 2001
From: Aleksander Machniak <alec@alec.pl>
Date: Wed, 23 Mar 2016 11:54:31 -0400
Subject: [PATCH] Message/rfc822 attachment preview (#5054)
---
program/lib/Roundcube/rcube_message.php | 296 +++++++++++++++++++++++++++++++++-------------------------
1 files changed, 168 insertions(+), 128 deletions(-)
diff --git a/program/lib/Roundcube/rcube_message.php b/program/lib/Roundcube/rcube_message.php
index 26248a5..c5c436f 100644
--- a/program/lib/Roundcube/rcube_message.php
+++ b/program/lib/Roundcube/rcube_message.php
@@ -1,6 +1,6 @@
<?php
-/*
+/**
+-----------------------------------------------------------------------+
| This file is part of the Roundcube Webmail client |
| Copyright (C) 2008-2014, The Roundcube Dev Team |
@@ -54,6 +54,7 @@
public $folder;
public $headers;
public $sender;
+ public $context;
public $parts = array();
public $mime_parts = array();
public $inline_parts = array();
@@ -69,26 +70,33 @@
*
* Provide a uid, and parse message structure.
*
- * @param string $uid The message UID.
- * @param string $folder Folder name
+ * @param string $uid The message UID.
+ * @param string $folder Folder name
+ * @param bool $is_safe Security flag
*
* @see self::$app, self::$storage, self::$opt, self::$parts
*/
- function __construct($uid, $folder = null)
+ function __construct($uid, $folder = null, $is_safe = false)
{
// decode combined UID-folder identifier
- if (preg_match('/^\d+-.+/', $uid)) {
+ if (preg_match('/^[0-9.]+-.+/', $uid)) {
list($uid, $folder) = explode('-', $uid, 2);
}
- $this->uid = $uid;
- $this->app = rcube::get_instance();
+ if (preg_match('/^([0-9]+)\.([0-9.]+)$/', $uid, $matches)) {
+ $uid = $matches[1];
+ $context = $matches[2];
+ }
+
+ $this->uid = $uid;
+ $this->context = $context;
+ $this->app = rcube::get_instance();
$this->storage = $this->app->get_storage();
$this->folder = strlen($folder) ? $folder : $this->storage->get_folder();
- $this->storage->set_options(array('all_headers' => true));
// Set current folder
$this->storage->set_folder($this->folder);
+ $this->storage->set_options(array('all_headers' => true));
$this->headers = $this->storage->get_message($uid);
@@ -96,33 +104,32 @@
return;
}
- $this->mime = new rcube_mime($this->headers->charset);
-
- $this->subject = $this->headers->get('subject');
- list(, $this->sender) = each($this->mime->decode_address_list($this->headers->from, 1));
-
- $this->set_safe((intval($_GET['_safe']) || $_SESSION['safe_messages'][$this->folder.':'.$uid]));
+ $this->set_safe($is_safe || $_SESSION['safe_messages'][$this->folder.':'.$uid]);
$this->opt = array(
- 'safe' => $this->is_safe,
+ 'safe' => $this->is_safe,
'prefer_html' => $this->app->config->get('prefer_html'),
- 'get_url' => $this->app->url(array(
- 'action' => 'get',
- 'mbox' => $this->storage->get_folder(),
- 'uid' => $uid))
+ 'get_url' => $this->app->url(array(
+ 'action' => 'get',
+ 'mbox' => $this->folder,
+ 'uid' => $uid),
+ false, false, true)
);
if (!empty($this->headers->structure)) {
$this->get_mime_numbers($this->headers->structure);
$this->parse_structure($this->headers->structure);
}
- else {
+ else if ($this->context === null) {
$this->body = $this->storage->get_body($uid);
}
+
+ $this->mime = new rcube_mime($this->headers->charset);
+ $this->subject = $this->headers->get('subject');
+ list(, $this->sender) = each($this->mime->decode_address_list($this->headers->from, 1));
// 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
@@ -140,7 +147,6 @@
return $this->headers->get($name, !$raw);
}
-
/**
* Set is_safe var and session data
*
@@ -150,7 +156,6 @@
{
$_SESSION['safe_messages'][$this->folder.':'.$this->uid] = $this->is_safe = $safe;
}
-
/**
* Compose a valid URL for getting a message part
@@ -166,7 +171,6 @@
else
return false;
}
-
/**
* Get content of a specific part of this message
@@ -198,7 +202,6 @@
NULL, $fp, $skip_charset_conv, $max_bytes, $formatted);
}
}
-
/**
* Get content of a specific part of this message
@@ -283,7 +286,6 @@
return $body;
}
-
/**
* Format text message part for display
*
@@ -324,19 +326,23 @@
return $body;
}
-
/**
* Determine if the message contains a HTML part. This must to be
* a real part not an attachment (or its part)
*
- * @param bool $enriched Enables checking for text/enriched parts too
+ * @param bool $enriched Enables checking for text/enriched parts too
+ * @param rcube_message_part &$part Reference to the part if found
*
* @return bool True if a HTML is available, False if not
*/
- function has_html_part($enriched = false)
+ public function has_html_part($enriched = false, &$part = null)
{
// check all message parts
foreach ($this->mime_parts as $part) {
+ if (!$this->check_context($part)) {
+ continue;
+ }
+
if ($part->mimetype == 'text/html' || ($enriched && $part->mimetype == 'text/enriched')) {
// Skip if part is an attachment, don't use is_attachment() here
if ($part->filename) {
@@ -345,6 +351,7 @@
$level = explode('.', $part->mime_id);
$depth = count($level);
+ $last = '';
// Check if the part belongs to higher-level's multipart part
// this can be alternative/related/signed/encrypted or mixed
@@ -354,9 +361,12 @@
return true;
}
- $parent = $this->mime_parts[join('.', $level)];
+ $parent = $this->mime_parts[join('.', $level)];
+ $max_delta = $depth - (1 + ($last == 'multipart/alternative' ? 1 : 0));
+ $last = $parent->mimetype;
+
if (!preg_match('/^multipart\/(alternative|related|signed|encrypted|mixed)$/', $parent->mimetype)
- || ($parent->mimetype == 'multipart/mixed' && $parent_depth < $depth - 1)) {
+ || ($parent->mimetype == 'multipart/mixed' && $parent_depth < $max_delta)) {
continue 2;
}
}
@@ -367,23 +377,30 @@
}
}
+ $part = null;
+
return false;
}
-
/**
* Determine if the message contains a text/plain part. This must to be
* a real part not an attachment (or its part)
*
+ * @param rcube_message_part &$part Reference to the part if found
+ *
* @return bool True if a plain text part is available, False if not
*/
- function has_text_part()
+ public function has_text_part(&$part = null)
{
// check all message parts
foreach ($this->mime_parts as $part) {
if ($part->mimetype == 'text/plain') {
// Skip if part is an attachment, don't use is_attachment() here
if ($part->filename) {
+ continue;
+ }
+
+ if (!$this->check_context($part)) {
continue;
}
@@ -407,56 +424,59 @@
}
}
+ $part = null;
+
return false;
}
-
/**
* Return the first HTML part of this message
*
+ * @param rcube_message_part &$part Reference to the part if found
+ * @param bool $enriched Enables checking for text/enriched parts too
+ *
* @return string HTML message part content
*/
- function first_html_part()
+ public function first_html_part(&$part = null, $enriched = false)
{
- // check all message parts
- foreach ($this->mime_parts as $pid => $part) {
- if ($part->mimetype == 'text/html') {
- return $this->get_part_body($pid, true);
+ if ($this->has_html_part($enriched, $part)) {
+ $body = $this->get_part_body($part->mime_id, true);
+
+ if ($part->mimetype == 'text/enriched') {
+ $body = rcube_enriched::to_html($body);
}
+
+ return $body;
}
}
-
/**
- * Return the first text part of this message
+ * Return the first text part of this message.
+ * If there's no text/plain part but $strict=true and text/html part
+ * exists, it will be returned in text/plain format.
*
- * @param rcube_message_part $part Reference to the part if found
+ * @param rcube_message_part &$part Reference to the part if found
+ * @param bool $strict Check only text/plain parts
+ *
* @return string Plain text message/part content
*/
- function first_text_part(&$part=null)
+ public function first_text_part(&$part = null, $strict = false)
{
// no message structure, return complete body
- if (empty($this->parts))
+ if (empty($this->parts)) {
return $this->body;
-
- // check all message parts
- foreach ($this->mime_parts as $mime_id => $part) {
- if ($part->mimetype == 'text/plain') {
- return $this->get_part_body($mime_id, true);
- }
- else if ($part->mimetype == 'text/html') {
- $out = $this->get_part_body($mime_id, true);
-
- // create instance of html2text class
- $txt = new rcube_html2text($out);
- return $txt->get_text();
- }
}
- $part = null;
- return null;
- }
+ if ($this->has_text_part($part)) {
+ return $this->get_part_body($part->mime_id, true);
+ }
+ if (!$strict && ($body = $this->first_html_part($part, true))) {
+ // create instance of html2text class
+ $h2t = new rcube_html2text($body);
+ return $h2t->get_text();
+ }
+ }
/**
* Checks if part of the message is an attachment (or part of it)
@@ -483,6 +503,27 @@
return false;
}
+ /**
+ * In a multipart/encrypted encrypted message,
+ * find the encrypted message payload part.
+ *
+ * @return rcube_message_part
+ */
+ public function get_multipart_encrypted_part()
+ {
+ foreach ($this->mime_parts as $mime_id => $mpart) {
+ if ($mpart->mimetype == 'multipart/encrypted') {
+ $this->pgp_mime = true;
+ }
+ if ($this->pgp_mime && ($mpart->mimetype == 'application/octet-stream' ||
+ (!empty($mpart->filename) && $mpart->filename != 'version.txt'))) {
+ $this->encrypted_part = $mime_id;
+ return $mpart;
+ }
+ }
+
+ return false;
+ }
/**
* Read the message structure returend by the IMAP server
@@ -501,6 +542,10 @@
if (!isset($structure->headers['subject']) && !isset($structure->headers['from'])) {
list($headers, ) = explode("\r\n\r\n", $this->get_part_body($structure->mime_id, false, 32768));
$structure->headers = rcube_mime::parse_headers($headers);
+
+ if ($this->context == $structure->mime_id) {
+ $this->headers = rcube_message_header::from_array($structure->headers);
+ }
}
}
else {
@@ -509,11 +554,12 @@
// show message headers
if ($recursive && is_array($structure->headers) &&
- (isset($structure->headers['subject']) || $structure->headers['from'] || $structure->headers['to'])) {
+ (isset($structure->headers['subject']) || $structure->headers['from'] || $structure->headers['to'])
+ ) {
$c = new stdClass;
$c->type = 'headers';
$c->headers = $structure->headers;
- $this->parts[] = $c;
+ $this->add_part($c);
}
// Allow plugins to handle message parts
@@ -535,25 +581,25 @@
if ($message_ctype_primary == 'text' && !$recursive) {
// parts with unsupported type add to attachments list
if (!in_array($message_ctype_secondary, array('plain', 'html', 'enriched'))) {
- $this->attachments[] = $structure;
+ $this->add_part($structure, 'attachment');
return;
}
$structure->type = 'content';
- $this->parts[] = $structure;
+ $this->add_part($structure);
// Parse simple (plain text) message body
if ($message_ctype_secondary == 'plain') {
foreach ((array)$this->uu_decode($structure) as $uupart) {
$this->mime_parts[$uupart->mime_id] = $uupart;
- $this->attachments[] = $uupart;
+ $this->add_part($uupart, 'attachment');
}
}
}
// the same for pgp signed messages
else if ($mimetype == 'application/pgp' && !$recursive) {
$structure->type = 'content';
- $this->parts[] = $structure;
+ $this->add_part($structure);
}
// message contains (more than one!) alternative parts
else if ($mimetype == 'multipart/alternative'
@@ -579,13 +625,15 @@
$related_part = $p;
else if ($sub_mimetype == 'text/plain' && !$plain_part)
$plain_part = $p;
- else if ($sub_mimetype == 'text/html' && !$html_part)
+ else if ($sub_mimetype == 'text/html' && !$html_part) {
$html_part = $p;
+ $this->got_html_part = true;
+ }
else if ($sub_mimetype == 'text/enriched' && !$enriched_part)
$enriched_part = $p;
else {
// add unsupported/unrecognized parts to attachments list
- $this->attachments[] = $sub_part;
+ $this->add_part($sub_part, 'attachment');
}
}
@@ -614,7 +662,7 @@
// add the right message body
if (is_object($print_part)) {
$print_part->type = 'content';
- $this->parts[] = $print_part;
+ $this->add_part($print_part);
}
// show plaintext warning
else if ($html_part !== null && empty($this->parts)) {
@@ -625,7 +673,7 @@
$c->mimetype = 'text/plain';
$c->realtype = 'text/html';
- $this->parts[] = $c;
+ $this->add_part($c);
}
}
// this is an ecrypted message -> create a plaintext body with the according message
@@ -638,14 +686,14 @@
$p->realtype = 'multipart/encrypted';
$p->mime_id = $structure->mime_id;
- $this->parts[] = $p;
+ $this->add_part($p);
// add encrypted payload part as attachment
if (is_array($structure->parts)) {
for ($i=0; $i < count($structure->parts); $i++) {
$subpart = $structure->parts[$i];
if ($subpart->mimetype == 'application/octet-stream' || !empty($subpart->filename)) {
- $this->attachments[] = $subpart;
+ $this->add_part($subpart, 'attachment');
}
}
}
@@ -660,10 +708,10 @@
$p->realtype = 'application/pkcs7-mime';
$p->mime_id = $structure->mime_id;
- $this->parts[] = $p;
+ $this->add_part($p);
if (!empty($structure->filename)) {
- $this->attachments[] = $structure;
+ $this->add_part($structure, 'attachment');
}
}
// message contains multiple parts
@@ -673,24 +721,16 @@
$mail_part = &$structure->parts[$i];
$primary_type = $mail_part->ctype_primary;
$secondary_type = $mail_part->ctype_secondary;
+ $part_mimetype = $mail_part->mimetype;
- // real content-type of message/rfc822
- if ($mail_part->real_mimetype) {
- $part_orig_mimetype = $mail_part->mimetype;
- $part_mimetype = $mail_part->real_mimetype;
- list($primary_type, $secondary_type) = explode('/', $part_mimetype);
- }
- else {
- $part_mimetype = $part_orig_mimetype = $mail_part->mimetype;
- }
-
- // multipart/alternative
- if ($primary_type == 'multipart') {
+ // multipart/alternative or message/rfc822
+ if ($primary_type == 'multipart' || $part_mimetype == 'message/rfc822') {
$this->parse_structure($mail_part, true);
// list message/rfc822 as attachment as well (mostly .eml)
- if ($part_orig_mimetype == 'message/rfc822' && !empty($mail_part->filename))
- $this->attachments[] = $mail_part;
+ if ($primary_type == 'message' && !empty($mail_part->filename)) {
+ $this->add_part($mail_part, 'attachment');
+ }
}
// part text/[plain|html] or delivery status
else if ((($part_mimetype == 'text/plain' || $part_mimetype == 'text/html') && $mail_part->disposition != 'attachment') ||
@@ -701,11 +741,12 @@
array('object' => $this, 'structure' => $mail_part,
'mimetype' => $part_mimetype, 'recursive' => true));
- if ($plugin['abort'])
+ if ($plugin['abort']) {
continue;
+ }
if ($part_mimetype == 'text/html' && $mail_part->size) {
- $got_html_part = true;
+ $this->got_html_part = true;
}
$mail_part = $plugin['structure'];
@@ -717,21 +758,13 @@
($secondary_type == 'plain' && !$this->opt['prefer_html'])
) {
$mail_part->type = 'content';
- $this->parts[] = $mail_part;
+ $this->add_part($mail_part);
}
// list as attachment as well
if (!empty($mail_part->filename)) {
- $this->attachments[] = $mail_part;
+ $this->add_part($mail_part, 'attachment');
}
- }
- // part message/*
- else if ($primary_type == 'message') {
- $this->parse_structure($mail_part, true);
-
- // list as attachment as well (mostly .eml)
- if (!empty($mail_part->filename))
- $this->attachments[] = $mail_part;
}
// ignore "virtual" protocol parts
else if ($primary_type == 'protocol') {
@@ -742,13 +775,13 @@
$tnef_parts = (array) $this->tnef_decode($mail_part);
foreach ($tnef_parts as $tpart) {
$this->mime_parts[$tpart->mime_id] = $tpart;
- $this->attachments[] = $tpart;
+ $this->add_part($tpart, 'attachment');
}
// add winmail.dat to the list if it's content is unknown
if (empty($tnef_parts) && !empty($mail_part->filename)) {
$this->mime_parts[$mail_part->mime_id] = $mail_part;
- $this->attachments[] = $mail_part;
+ $this->add_part($mail_part, 'attachment');
}
}
// part is a file/attachment
@@ -763,26 +796,19 @@
// part belongs to a related message and is linked
if (preg_match('/^multipart\/(related|relative)/', $mimetype)
- && ($mail_part->headers['content-id'] || $mail_part->headers['content-location'])) {
+ && ($mail_part->headers['content-id'] || $mail_part->headers['content-location'])
+ ) {
if ($mail_part->headers['content-id'])
$mail_part->content_id = preg_replace(array('/^</', '/>$/'), '', $mail_part->headers['content-id']);
if ($mail_part->headers['content-location'])
$mail_part->content_location = $mail_part->headers['content-base'] . $mail_part->headers['content-location'];
- $this->inline_parts[] = $mail_part;
- }
- // 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;
+ $this->add_part($mail_part, 'inline');
}
// 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)) {
- $this->attachments[] = $mail_part;
+ $this->add_part($mail_part, 'attachment');
}
// attachment with invalid content type
// replace malformed content type with application/octet-stream (#1487767)
@@ -791,12 +817,8 @@
$mail_part->ctype_secondary = 'octet-stream';
$mail_part->mimetype = 'application/octet-stream';
- $this->attachments[] = $mail_part;
+ $this->add_part($mail_part, 'attachment');
}
- }
- // attachment part as message/rfc822 (#1488026)
- else if ($mail_part->mimetype == 'message/rfc822') {
- $this->parse_structure($mail_part);
}
// calendar part not marked as attachment (#1490325)
else if ($part_mimetype == 'text/calendar') {
@@ -804,7 +826,7 @@
$mail_part->filename = 'calendar.ics';
}
- $this->attachments[] = $mail_part;
+ $this->add_part($mail_part, 'attachment');
}
}
@@ -825,14 +847,14 @@
// 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;
+ if (!isset($this->got_html_part)) {
+ $this->add_part($inline_object, 'attachment');
}
// 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;
+ $this->add_part($inline_object, 'attachment');
}
// @TODO: we should fetch HTML body and find attachment's content-id
// to handle also image attachments without reference in the body
@@ -850,17 +872,16 @@
}
// message is a single part non-text
else if ($structure->filename) {
- $this->attachments[] = $structure;
+ $this->add_part($structure, $attachment);
}
// message is a single part non-text (without filename)
else if (preg_match('/application\//i', $mimetype)) {
- $this->attachments[] = $structure;
+ $this->add_part($structure, 'attachment');
}
}
-
/**
- * Fill aflat array with references to all parts, indexed by part numbers
+ * Fill a flat array with references to all parts, indexed by part numbers
*
* @param rcube_message_part $part Message body structure
*/
@@ -874,6 +895,27 @@
$this->get_mime_numbers($part->parts[$i]);
}
+ /**
+ * Add a part to object parts array(s) (with context check)
+ */
+ private function add_part($part, $type = null)
+ {
+ if ($this->check_context($part)) {
+ switch ($type) {
+ case 'inline': $this->inline_parts[] = $part; break;
+ case 'attachment': $this->attachments[] = $part; break;
+ default: $this->parts[] = $part; break;
+ }
+ }
+ }
+
+ /**
+ * Check if specified part belongs to the current context
+ */
+ private function check_context($part)
+ {
+ return $this->context === null || strpos($part->mime_id, $this->context . '.') === 0;
+ }
/**
* Decode a Microsoft Outlook TNEF part (winmail.dat)
@@ -909,7 +951,6 @@
return $parts;
}
-
/**
* Parse message body for UUencoded attachments bodies
@@ -1036,5 +1077,4 @@
{
return rcube_mime::format_flowed($text, $length);
}
-
}
--
Gitblit v1.9.1