From 9870dac30de1b8d1bdeab57af3eeb7c89b21ef76 Mon Sep 17 00:00:00 2001
From: alecpl <alec@alec.pl>
Date: Sat, 14 Apr 2012 02:35:52 -0400
Subject: [PATCH] - Make some methods public (#1488428)
---
program/include/rcube_message.php | 288 ++++++++++++++++++++++++++++-----------------------------
1 files changed, 140 insertions(+), 148 deletions(-)
diff --git a/program/include/rcube_message.php b/program/include/rcube_message.php
index 790f8d9..ee17fcd 100644
--- a/program/include/rcube_message.php
+++ b/program/include/rcube_message.php
@@ -5,8 +5,11 @@
| program/include/rcube_message.php |
| |
| This file is part of the Roundcube Webmail client |
- | Copyright (C) 2008-2010, Roundcube Dev. - Switzerland |
- | Licensed under the GNU GPL |
+ | Copyright (C) 2008-2010, The Roundcube Dev Team |
+ | |
+ | Licensed under the GNU General Public License version 3 or |
+ | any later version with exceptions for skins & plugins. |
+ | See the README file for a full license statement. |
| |
| PURPOSE: |
| Logical representation of a mail message with all its data |
@@ -37,18 +40,24 @@
private $app;
/**
- * Instance of imap class
+ * Instance of storage class
*
- * @var rcube_imap
+ * @var rcube_storage
*/
- private $imap;
+ private $storage;
+
+ /**
+ * Instance of mime class
+ *
+ * @var rcube_mime
+ */
+ private $mime;
private $opt = array();
private $inline_parts = array();
private $parse_alternative = false;
public $uid = null;
public $headers;
- public $structure;
public $parts = array();
public $mime_parts = array();
public $attachments = array();
@@ -64,42 +73,41 @@
*
* @param string $uid The message UID.
*
- * @uses rcmail::get_instance()
- * @uses rcube_imap::decode_mime_string()
- * @uses self::set_safe()
- *
- * @see self::$app, self::$imap, self::$opt, self::$structure
+ * @see self::$app, self::$storage, self::$opt, self::$parts
*/
function __construct($uid)
{
- $this->app = rcmail::get_instance();
- $this->imap = $this->app->imap;
- $this->imap->get_all_headers = true;
+ $this->uid = $uid;
+ $this->app = rcube::get_instance();
+ $this->storage = $this->app->get_storage();
+ $this->storage->set_options(array('all_headers' => true));
- $this->uid = $uid;
- $this->headers = $this->imap->get_headers($uid, NULL, true, true);
+ $this->headers = $this->storage->get_message($uid);
if (!$this->headers)
return;
- $this->subject = rcube_imap::decode_mime_string(
- $this->headers->subject, $this->headers->charset);
- list(, $this->sender) = each($this->imap->decode_address_list($this->headers->from));
+ $this->mime = new rcube_mime($this->headers->charset);
+
+ $this->subject = $this->mime->decode_mime_string($this->headers->subject);
+ list(, $this->sender) = each($this->mime->decode_address_list($this->headers->from, 1));
$this->set_safe((intval($_GET['_safe']) || $_SESSION['safe_messages'][$uid]));
$this->opt = array(
'safe' => $this->is_safe,
'prefer_html' => $this->app->config->get('prefer_html'),
- 'get_url' => rcmail_url('get', array(
- '_mbox' => $this->imap->get_mailbox_name(), '_uid' => $uid))
+ 'get_url' => $this->app->url(array(
+ 'action' => 'get',
+ 'mbox' => $this->storage->get_folder(),
+ 'uid' => $uid))
);
- if ($this->structure = $this->imap->get_structure($uid, $this->headers->body_structure)) {
- $this->get_mime_numbers($this->structure);
- $this->parse_structure($this->structure);
+ if (!empty($this->headers->structure)) {
+ $this->get_mime_numbers($this->headers->structure);
+ $this->parse_structure($this->headers->structure);
}
else {
- $this->body = $this->imap->get_body($uid);
+ $this->body = $this->storage->get_body($uid);
}
// notify plugins and let them analyze this structured message object
@@ -116,12 +124,15 @@
*/
public function get_header($name, $raw = false)
{
+ if (empty($this->headers))
+ return null;
+
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);
+ return $raw ? $value : $this->mime->decode_header($value);
}
@@ -143,10 +154,10 @@
* @param string $mime_id Part MIME-ID
* @return string URL or false if part does not exist
*/
- public function get_part_url($mime_id)
+ public function get_part_url($mime_id, $embed = false)
{
if ($this->mime_parts[$mime_id])
- return $this->opt['get_url'] . '&_part=' . $mime_id;
+ return $this->opt['get_url'] . '&_part=' . $mime_id . ($embed ? '&_embed=1' : '');
else
return false;
}
@@ -155,22 +166,24 @@
/**
* Get content of a specific part of this message
*
- * @param string $mime_id Part MIME-ID
- * @param resource $fp File pointer to save the message part
+ * @param string $mime_id Part MIME-ID
+ * @param resource $fp File pointer to save the message part
+ * @param boolean $skip_charset_conv Disables charset conversion
+ *
* @return string Part content
*/
- public function get_part_content($mime_id, $fp=NULL)
+ public function get_part_content($mime_id, $fp = null, $skip_charset_conv = false)
{
if ($part = $this->mime_parts[$mime_id]) {
// stored in message structure (winmail/inline-uuencode)
- if ($part->encoding == 'stream') {
+ if (!empty($part->body) || $part->encoding == 'stream') {
if ($fp) {
fwrite($fp, $part->body);
}
return $fp ? true : $part->body;
}
// get from IMAP
- return $this->imap->get_message_part($this->uid, $mime_id, $part, NULL, $fp);
+ return $this->storage->get_message_part($this->uid, $mime_id, $part, NULL, $fp, $skip_charset_conv);
} else
return null;
}
@@ -179,15 +192,36 @@
/**
* Determine if the message contains a HTML part
*
+ * @param bool $recursive Enables checking in all levels of the structure
+ *
* @return bool True if a HTML is available, False if not
*/
- function has_html_part()
+ function has_html_part($recursive = true)
{
// check all message parts
- foreach ($this->parts as $pid => $part) {
- $mimetype = strtolower($part->ctype_primary . '/' . $part->ctype_secondary);
- if ($mimetype == 'text/html')
+ foreach ($this->parts as $part) {
+ if ($part->mimetype == 'text/html') {
+ // Level check, we'll skip e.g. HTML attachments
+ if (!$recursive) {
+ $level = explode('.', $part->mime_id);
+
+ // Level too high
+ if (count($level) > 2) {
+ continue;
+ }
+
+ // HTML part can be on the lower level, if not...
+ if (count($level) > 1) {
+ // It can be an alternative or related message part
+ $parent = $this->mime_parts[0];
+ if ($parent->mimetype != 'multipart/alternative' && $parent->mimetype != 'multipart/related') {
+ continue;
+ }
+ }
+ }
+
return true;
+ }
}
return false;
@@ -202,10 +236,9 @@
function first_html_part()
{
// check all message parts
- foreach ($this->mime_parts as $mime_id => $part) {
- $mimetype = strtolower($part->ctype_primary . '/' . $part->ctype_secondary);
- if ($mimetype == 'text/html') {
- return $this->imap->get_message_part($this->uid, $mime_id, $part);
+ foreach ($this->mime_parts as $pid => $part) {
+ if ($part->mimetype == 'text/html') {
+ return $this->get_part_content($pid);
}
}
}
@@ -225,13 +258,11 @@
// check all message parts
foreach ($this->mime_parts as $mime_id => $part) {
- $mimetype = $part->ctype_primary . '/' . $part->ctype_secondary;
-
- if ($mimetype == 'text/plain') {
- return $this->imap->get_message_part($this->uid, $mime_id, $part);
+ if ($part->mimetype == 'text/plain') {
+ return $this->get_part_content($mime_id);
}
- else if ($mimetype == 'text/html') {
- $out = $this->imap->get_message_part($this->uid, $mime_id, $part);
+ else if ($part->mimetype == 'text/html') {
+ $out = $this->get_part_content($mime_id);
// remove special chars encoding
$trans = array_flip(get_html_translation_table(HTML_ENTITIES));
@@ -249,7 +280,7 @@
/**
- * Raad the message structure returend by the IMAP server
+ * Read the message structure returend by the IMAP server
* and build flat lists of content parts and attachments
*
* @param rcube_message_part $structure Message structure node
@@ -286,7 +317,7 @@
if ($message_ctype_primary == 'text' && !$recursive) {
$structure->type = 'content';
$this->parts[] = &$structure;
-
+
// Parse simple (plain text) message body
if ($message_ctype_secondary == 'plain')
foreach ((array)$this->uu_decode($structure) as $uupart) {
@@ -299,14 +330,16 @@
$structure->type = 'content';
$this->parts[] = &$structure;
}
- // message contains alternative parts
- else if ($mimetype == 'multipart/alternative' && is_array($structure->parts)) {
+ // message contains (more than one!) alternative parts
+ else if ($mimetype == 'multipart/alternative'
+ && is_array($structure->parts) && count($structure->parts) > 1
+ ) {
// get html/plaintext parts
$plain_part = $html_part = $print_part = $related_part = null;
foreach ($structure->parts as $p => $sub_part) {
$sub_mimetype = $sub_part->mimetype;
-
+
// check if sub part is
if ($sub_mimetype == 'text/plain')
$plain_part = $p;
@@ -323,7 +356,7 @@
$this->parse_alternative = true;
$this->parse_structure($structure->parts[$related_part], true);
$this->parse_alternative = false;
-
+
// if plain part was found, we should unset it if html is preferred
if ($this->opt['prefer_html'] && count($this->parts))
$plain_part = null;
@@ -351,7 +384,8 @@
$c->type = 'content';
$c->ctype_primary = 'text';
$c->ctype_secondary = 'plain';
- $c->body = rcube_label('htmlmessage');
+ $c->mimetype = 'text/plain';
+ $c->realtype = 'text/html';
$this->parts[] = $c;
}
@@ -359,7 +393,6 @@
// add html part as attachment
if ($html_part !== null && $structure->parts[$html_part] !== $print_part) {
$html_part = &$structure->parts[$html_part];
- $html_part->filename = rcube_label('htmlmessage');
$html_part->mimetype = 'text/html';
$this->attachments[] = $html_part;
@@ -371,8 +404,10 @@
$p->type = 'content';
$p->ctype_primary = 'text';
$p->ctype_secondary = 'plain';
- $p->body = rcube_label('encryptedmessage');
- $p->size = strlen($p->body);
+ $p->mimetype = 'text/plain';
+ $p->realtype = 'multipart/encrypted';
+
+ $this->parts[] = $p;
}
// message contains multiple parts
else if (is_array($structure->parts) && !empty($structure->parts)) {
@@ -426,13 +461,13 @@
$mail_part->type = 'content';
$this->parts[] = $mail_part;
}
-
+
// list as attachment as well
if (!empty($mail_part->filename))
$this->attachments[] = $mail_part;
}
// part message/*
- else if ($primary_type=='message') {
+ else if ($primary_type == 'message') {
$this->parse_structure($mail_part, true);
// list as attachment as well (mostly .eml)
@@ -473,34 +508,64 @@
// 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 (content-type name regexp according to RFC4288.4.2)
+ // 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;
+ }
+ }
+ // attachment part as message/rfc822 (#1488026)
+ else if ($mail_part->mimetype == 'message/rfc822') {
+ $this->parse_structure($mail_part);
}
}
// 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);
+ $part_url = $this->get_part_url($inline_object->mime_id, true);
if ($inline_object->content_id)
$a_replaces['cid:'.$inline_object->content_id] = $part_url;
if ($inline_object->content_location) {
$a_replaces[$inline_object->content_location] = $part_url;
}
- // 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)
- && !empty($inline_object->filename)
- ) {
- $this->attachments[] = $inline_object;
+
+ 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?
}
}
@@ -550,7 +615,7 @@
{
// @TODO: attachment may be huge, hadle it via file
if (!isset($part->body))
- $part->body = $this->imap->get_message_part($this->uid, $part->mime_id, $part);
+ $part->body = $this->storage->get_message_part($this->uid, $part->mime_id, $part);
$parts = array();
$tnef = new tnef_decoder;
@@ -586,7 +651,7 @@
{
// @TODO: messages may be huge, hadle body via file
if (!isset($part->body))
- $part->body = $this->imap->get_message_part($this->uid, $part->mime_id, $part);
+ $part->body = $this->storage->get_message_part($this->uid, $part->mime_id, $part);
$parts = array();
// FIXME: line length is max.65?
@@ -610,7 +675,7 @@
$uupart->size = strlen($uupart->body);
$uupart->mime_id = 'uu.' . $part->mime_id . '.' . $pid;
- $ctype = rc_mime_content_type($uupart->body, $uupart->filename, 'application/octet-stream', true);
+ $ctype = rcube_mime::content_type($uupart->body, $uupart->filename, 'application/octet-stream', true);
$uupart->mimetype = $ctype;
list($uupart->ctype_primary, $uupart->ctype_secondary) = explode('/', $ctype);
@@ -624,90 +689,17 @@
/**
- * Interpret a format=flowed message body according to RFC 2646
- *
- * @param string $text Raw body formatted as flowed text
- * @return string Interpreted text with unwrapped lines and stuffed space removed
+ * Deprecated methods (to be removed)
*/
+
public static function unfold_flowed($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);
+ return rcube_mime::unfold_flowed($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)
{
- $text = preg_split('/\r?\n/', $text);
-
- 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 ");
- }
-
- $text[$idx] = $line;
- }
- }
-
- return implode("\r\n", $text);
+ return rcube_mime::format_flowed($text, $length);
}
}
--
Gitblit v1.9.1