| | |
| | | +-----------------------------------------------------------------------+ |
| | | | program/include/rcube_message.php | |
| | | | | |
| | | | This file is part of the RoundCube Webmail client | |
| | | | Copyright (C) 2008, RoundCube Dev. - Switzerland | |
| | | | This file is part of the Roundcube Webmail client | |
| | | | Copyright (C) 2008-2010, Roundcube Dev. - Switzerland | |
| | | | Licensed under the GNU GPL | |
| | | | | |
| | | | PURPOSE: | |
| | |
| | | | Author: Thomas Bruederli <roundcube@gmail.com> | |
| | | +-----------------------------------------------------------------------+ |
| | | |
| | | $Id: rcube_imap.php 1344 2008-04-30 08:21:42Z thomasb $ |
| | | $Id$ |
| | | |
| | | */ |
| | | |
| | |
| | | */ |
| | | class rcube_message |
| | | { |
| | | private $app; |
| | | private $imap; |
| | | 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(); |
| | | public $subject = ''; |
| | | public $sender = null; |
| | | public $is_safe = false; |
| | | |
| | | |
| | | function __construct($uid) |
| | | { |
| | | $this->app = rcmail::get_instance(); |
| | | $this->imap = $this->app->imap; |
| | | |
| | | $this->uid = $uid; |
| | | $this->headers = $this->imap->get_headers($uid); |
| | | $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->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)) |
| | | ); |
| | | |
| | | if ($this->structure = $this->imap->get_structure($uid)) { |
| | | $this->get_mime_numbers($this->structure); |
| | | $this->parse_structure($this->structure); |
| | | } |
| | | else { |
| | | $this->body = $this->imap->get_body($uid); |
| | | } |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Return a (decoded) message header |
| | | * |
| | | * @param string Header name |
| | | * @param bool Don't mime-decode the value |
| | | * @return string Header value |
| | | */ |
| | | public function get_header($name, $raw = false) |
| | | { |
| | | $value = $this->headers->$name; |
| | | return $raw ? $value : $this->imap->decode_header($value); |
| | | } |
| | | |
| | | /** |
| | | * Set is_safe var and session data |
| | | * |
| | | * @param bool enable/disable |
| | | */ |
| | | public function set_safe($safe = true) |
| | | { |
| | | $this->is_safe = $safe; |
| | | $_SESSION['safe_messages'][$this->uid] = $this->is_safe; |
| | | } |
| | | |
| | | /** |
| | | * Compose a valid URL for getting a message part |
| | | * |
| | | * @param string Part MIME-ID |
| | | * @return string URL or false if part does not exist |
| | | */ |
| | | public function get_part_url($mime_id) |
| | | { |
| | | if ($this->mime_parts[$mime_id]) |
| | | return $this->opt['get_url'] . "&_part=" . $mime_id; |
| | | else |
| | | return false; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Get content of a specific part of this message |
| | | * |
| | | * @param string Part MIME-ID |
| | | * @param resource File pointer to save the message part |
| | | * @return string Part content |
| | | */ |
| | | public function get_part_content($mime_id, $fp=NULL) |
| | | { |
| | | if ($part = $this->mime_parts[$mime_id]) |
| | | return $this->imap->get_message_part($this->uid, $mime_id, $part, NULL, $fp); |
| | | else |
| | | return null; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Determine if the message contains a HTML part |
| | | * |
| | | * @return bool True if a HTML is available, False if not |
| | | */ |
| | | function has_html_part() |
| | | { |
| | | // check all message parts |
| | | foreach ($this->parts as $pid => $part) { |
| | | $mimetype = strtolower($part->ctype_primary . '/' . $part->ctype_secondary); |
| | | if ($mimetype == 'text/html') |
| | | return true; |
| | | } |
| | | /** |
| | | * Instace of rcmail. |
| | | * |
| | | * @var rcmail |
| | | */ |
| | | private $app; |
| | | |
| | | return false; |
| | | } |
| | | /** |
| | | * 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; |
| | | public $parts = array(); |
| | | public $mime_parts = array(); |
| | | public $attachments = array(); |
| | | public $subject = ''; |
| | | public $sender = null; |
| | | public $is_safe = false; |
| | | |
| | | |
| | | /** |
| | | * Return the first HTML part of this message |
| | | * |
| | | * @return string HTML message part content |
| | | */ |
| | | function first_html_part() |
| | | /** |
| | | * __construct |
| | | * |
| | | * Provide a uid, and parse message structure. |
| | | * |
| | | * @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 |
| | | */ |
| | | function __construct($uid) |
| | | { |
| | | $html_part = null; |
| | | $this->app = rcmail::get_instance(); |
| | | $this->imap = $this->app->imap; |
| | | |
| | | // check all message parts |
| | | foreach ($this->mime_parts as $mime_id => $part) { |
| | | $mimetype = strtolower($part->ctype_primary . '/' . $part->ctype_secondary); |
| | | if ($mimetype == 'text/html') { |
| | | $html_part = $this->imap->get_message_part($this->uid, $mime_id, $part); |
| | | } |
| | | $this->uid = $uid; |
| | | $this->headers = $this->imap->get_headers($uid, NULL, true, true); |
| | | |
| | | 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->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)) |
| | | ); |
| | | |
| | | if ($this->structure = $this->imap->get_structure($uid, $this->headers->body_structure)) { |
| | | $this->get_mime_numbers($this->structure); |
| | | $this->parse_structure($this->structure); |
| | | } |
| | | else { |
| | | $this->body = $this->imap->get_body($uid); |
| | | } |
| | | |
| | | // notify plugins and let them analyze this structured message object |
| | | $this->app->plugins->exec_hook('message_load', array('object' => $this)); |
| | | } |
| | | |
| | | return $html_part; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Return the first text part of this message |
| | | * |
| | | * @return string Plain text message/part content |
| | | */ |
| | | function first_text_part() |
| | | |
| | | |
| | | /** |
| | | * Return a (decoded) message header |
| | | * |
| | | * @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) |
| | | { |
| | | // no message structure, return complete body |
| | | if (empty($this->parts)) |
| | | return $this->body; |
| | | |
| | | $out = null; |
| | | if ($this->headers->$name) |
| | | $value = $this->headers->$name; |
| | | else if ($this->headers->others[$name]) |
| | | $value = $this->headers->others[$name]; |
| | | |
| | | // check all message parts |
| | | foreach ($this->mime_parts as $mime_id => $part) { |
| | | $mimetype = strtolower($part->ctype_primary . '/' . $part->ctype_secondary); |
| | | |
| | | if ($mimetype == 'text/plain') { |
| | | $out = $this->imap->get_message_part($this->uid, $mime_id, $part); |
| | | break; |
| | | } |
| | | else if ($mimetype == 'text/html') { |
| | | $html_part = $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); |
| | | |
| | | // create instance of html2text class |
| | | $txt = new html2text($html_part); |
| | | $out = $txt->get_text(); |
| | | break; |
| | | } |
| | | return $raw ? $value : $this->imap->decode_header($value); |
| | | } |
| | | |
| | | return $out; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * 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 |
| | | */ |
| | | private function parse_structure($structure, $recursive = false) |
| | | { |
| | | $message_ctype_primary = strtolower($structure->ctype_primary); |
| | | $message_ctype_secondary = strtolower($structure->ctype_secondary); |
| | | |
| | | // show message headers |
| | | if ($recursive && is_array($structure->headers) && isset($structure->headers['subject'])) { |
| | | $c = new stdClass; |
| | | $c->type = 'headers'; |
| | | $c->headers = &$structure->headers; |
| | | $this->parts[] = $c; |
| | | |
| | | /** |
| | | * Set is_safe var and session data |
| | | * |
| | | * @param bool $safe enable/disable |
| | | */ |
| | | public function set_safe($safe = true) |
| | | { |
| | | $this->is_safe = $safe; |
| | | $_SESSION['safe_messages'][$this->uid] = $this->is_safe; |
| | | } |
| | | |
| | | // print body if message doesn't have multiple parts |
| | | if ($message_ctype_primary == 'text' && !$recursive) { |
| | | $structure->type = 'content'; |
| | | $this->parts[] = &$structure; |
| | | } |
| | | // the same for pgp signed messages |
| | | else if ($message_ctype_primary == 'application' && $message_ctype_secondary == 'pgp' && !$recursive) { |
| | | $structure->type = 'content'; |
| | | $this->parts[] = &$structure; |
| | | } |
| | | // message contains alternative parts |
| | | else if ($message_ctype_primary == 'multipart' && ($message_ctype_secondary == 'alternative') && is_array($structure->parts)) { |
| | | // get html/plaintext parts |
| | | $plain_part = $html_part = $print_part = $related_part = null; |
| | | |
| | | foreach ($structure->parts as $p => $sub_part) { |
| | | $rel_parts = $attachmnts = null; |
| | | $sub_ctype_primary = strtolower($sub_part->ctype_primary); |
| | | $sub_ctype_secondary = strtolower($sub_part->ctype_secondary); |
| | | /** |
| | | * Compose a valid URL for getting a message part |
| | | * |
| | | * @param string $mime_id Part MIME-ID |
| | | * @return string URL or false if part does not exist |
| | | */ |
| | | public function get_part_url($mime_id) |
| | | { |
| | | if ($this->mime_parts[$mime_id]) |
| | | return $this->opt['get_url'] . '&_part=' . $mime_id; |
| | | else |
| | | return false; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * 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 |
| | | * @return string Part content |
| | | */ |
| | | public function get_part_content($mime_id, $fp=NULL) |
| | | { |
| | | if ($part = $this->mime_parts[$mime_id]) { |
| | | // stored in message structure (winmail/inline-uuencode) |
| | | if ($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); |
| | | } else |
| | | return null; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Determine if the message contains a HTML part |
| | | * |
| | | * @return bool True if a HTML is available, False if not |
| | | */ |
| | | function has_html_part() |
| | | { |
| | | // check all message parts |
| | | foreach ($this->parts as $pid => $part) { |
| | | $mimetype = strtolower($part->ctype_primary . '/' . $part->ctype_secondary); |
| | | if ($mimetype == 'text/html') |
| | | return true; |
| | | } |
| | | |
| | | return false; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Return the first HTML part of this message |
| | | * |
| | | * @return string HTML message part content |
| | | */ |
| | | 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); |
| | | } |
| | | } |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Return the first text part of this message |
| | | * |
| | | * @return string Plain text message/part content |
| | | */ |
| | | function first_text_part() |
| | | { |
| | | // 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; |
| | | } |
| | | else if ($mimetype == 'text/html') { |
| | | $out = $this->imap->get_message_part($this->uid, $mime_id, $part); |
| | | |
| | | // remove special chars encoding |
| | | $trans = array_flip(get_html_translation_table(HTML_ENTITIES)); |
| | | $out = strtr($out, $trans); |
| | | |
| | | // create instance of html2text class |
| | | $txt = new html2text($out); |
| | | $out = $txt->get_text(); |
| | | } |
| | | } |
| | | |
| | | return $out; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Raad 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 |
| | | * @param bool $recursive True when called recursively |
| | | */ |
| | | private function parse_structure($structure, $recursive = false) |
| | | { |
| | | // real content-type of message/rfc822 part |
| | | 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'])) { |
| | | $c = new stdClass; |
| | | $c->type = 'headers'; |
| | | $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) { |
| | | $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) { |
| | | $this->mime_parts[$uupart->mime_id] = $uupart; |
| | | $this->attachments[] = $uupart; |
| | | } |
| | | } |
| | | // the same for pgp signed messages |
| | | else if ($mimetype == 'application/pgp' && !$recursive) { |
| | | $structure->type = 'content'; |
| | | $this->parts[] = &$structure; |
| | | } |
| | | // message contains alternative parts |
| | | else if ($mimetype == 'multipart/alternative' && is_array($structure->parts)) { |
| | | // 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_ctype_primary=='text' && $sub_ctype_secondary=='plain') |
| | | $plain_part = $p; |
| | | else if ($sub_ctype_primary=='text' && $sub_ctype_secondary=='html') |
| | | $html_part = $p; |
| | | else if ($sub_ctype_primary=='text' && $sub_ctype_secondary=='enriched') |
| | | $enriched_part = $p; |
| | | else if ($sub_ctype_primary=='multipart' && ($sub_ctype_secondary=='related' || $sub_ctype_secondary=='mixed')) |
| | | $related_part = $p; |
| | | } |
| | | // check if sub part is |
| | | if ($sub_mimetype == 'text/plain') |
| | | $plain_part = $p; |
| | | else if ($sub_mimetype == 'text/html') |
| | | $html_part = $p; |
| | | else if ($sub_mimetype == 'text/enriched') |
| | | $enriched_part = $p; |
| | | else if (in_array($sub_mimetype, array('multipart/related', 'multipart/mixed', 'multipart/alternative'))) |
| | | $related_part = $p; |
| | | } |
| | | |
| | | // parse related part (alternative part could be in here) |
| | | if ($related_part !== null && !$this->parse_alternative) { |
| | | $this->parse_alternative = true; |
| | | $this->parse_structure($structure->parts[$related_part], true); |
| | | $this->parse_alternative = false; |
| | | // parse related part (alternative part could be in here) |
| | | if ($related_part !== null && !$this->parse_alternative) { |
| | | $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; |
| | | } |
| | | // if plain part was found, we should unset it if html is preferred |
| | | if ($this->opt['prefer_html'] && count($this->parts)) |
| | | $plain_part = null; |
| | | } |
| | | |
| | | // choose html/plain part to print |
| | | if ($html_part !== null && $this->opt['prefer_html']) { |
| | | $print_part = &$structure->parts[$html_part]; |
| | | } |
| | | else if ($enriched_part !== null) { |
| | | $print_part = &$structure->parts[$enriched_part]; |
| | | } |
| | | else if ($plain_part !== null) { |
| | | $print_part = &$structure->parts[$plain_part]; |
| | | } |
| | | // choose html/plain part to print |
| | | if ($html_part !== null && $this->opt['prefer_html']) { |
| | | $print_part = &$structure->parts[$html_part]; |
| | | } |
| | | else if ($enriched_part !== null) { |
| | | $print_part = &$structure->parts[$enriched_part]; |
| | | } |
| | | else if ($plain_part !== null) { |
| | | $print_part = &$structure->parts[$plain_part]; |
| | | } |
| | | |
| | | // add the right message body |
| | | if (is_object($print_part)) { |
| | | $print_part->type = 'content'; |
| | | $this->parts[] = $print_part; |
| | | } |
| | | // show plaintext warning |
| | | else if ($html_part !== null && empty($this->parts)) { |
| | | $c = new stdClass; |
| | | $c->type = 'content'; |
| | | $c->body = rcube_label('htmlmessage'); |
| | | $c->ctype_primary = 'text'; |
| | | $c->ctype_secondary = 'plain'; |
| | | // add the right message body |
| | | if (is_object($print_part)) { |
| | | $print_part->type = 'content'; |
| | | $this->parts[] = $print_part; |
| | | } |
| | | // show plaintext warning |
| | | else if ($html_part !== null && empty($this->parts)) { |
| | | $c = new stdClass; |
| | | $c->type = 'content'; |
| | | $c->ctype_primary = 'text'; |
| | | $c->ctype_secondary = 'plain'; |
| | | $c->body = rcube_label('htmlmessage'); |
| | | |
| | | $this->parts[] = $c; |
| | | } |
| | | $this->parts[] = $c; |
| | | } |
| | | |
| | | // 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'; |
| | | // 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; |
| | | } |
| | | } |
| | | // this is an ecrypted message -> create a plaintext body with the according message |
| | | else if ($message_ctype_primary == 'multipart' && $message_ctype_secondary == 'encrypted') { |
| | | $p = new stdClass; |
| | | $p->type = 'content'; |
| | | $p->ctype_primary = 'text'; |
| | | $p->ctype_secondary = 'plain'; |
| | | $p->body = rcube_label('encryptedmessage'); |
| | | |
| | | $this->parts[] = $p; |
| | | } |
| | | // message contains multiple parts |
| | | else if (is_array($structure->parts) && !empty($structure->parts)) { |
| | | // iterate over parts |
| | | for ($i=0; $i < count($structure->parts); $i++) { |
| | | $mail_part = &$structure->parts[$i]; |
| | | $primary_type = strtolower($mail_part->ctype_primary); |
| | | $secondary_type = strtolower($mail_part->ctype_secondary); |
| | | |
| | | // multipart/alternative |
| | | if ($primary_type=='multipart') { |
| | | $this->parse_structure($mail_part, true); |
| | | $this->attachments[] = $html_part; |
| | | } |
| | | } |
| | | // part text/[plain|html] OR message/delivery-status |
| | | else if (($primary_type == 'text' && ($secondary_type == 'plain' || $secondary_type == 'html') && $mail_part->disposition != 'attachment') || |
| | | ($primary_type == 'message' && ($secondary_type == 'delivery-status' || $secondary_type == 'disposition-notification'))) { |
| | | // this is an ecrypted message -> create a plaintext body with the according message |
| | | else if ($mimetype == 'multipart/encrypted') { |
| | | $p = new stdClass; |
| | | $p->type = 'content'; |
| | | $p->ctype_primary = 'text'; |
| | | $p->ctype_secondary = 'plain'; |
| | | $p->body = rcube_label('encryptedmessage'); |
| | | $p->size = strlen($p->body); |
| | | } |
| | | // message contains multiple parts |
| | | else if (is_array($structure->parts) && !empty($structure->parts)) { |
| | | // iterate over parts |
| | | for ($i=0; $i < count($structure->parts); $i++) { |
| | | $mail_part = &$structure->parts[$i]; |
| | | $primary_type = $mail_part->ctype_primary; |
| | | $secondary_type = $mail_part->ctype_secondary; |
| | | |
| | | // 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 = $mail_part->mimetype; |
| | | |
| | | // multipart/alternative |
| | | if ($primary_type == 'multipart') { |
| | | $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; |
| | | } |
| | | // part text/[plain|html] OR message/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' |
| | | ) { |
| | | // 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; |
| | | |
| | | $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']) || |
| | | ($secondary_type == 'plain' && !$this->opt['prefer_html']) |
| | | ) { |
| | | $mail_part->type = 'content'; |
| | | $this->parts[] = $mail_part; |
| | | } |
| | | |
| | | // add text part if we're not in alternative mode or if it matches the prefs |
| | | if (!$this->parse_alternative || |
| | | ($secondary_type == 'html' && $this->opt['prefer_html']) || |
| | | ($secondary_type == 'plain' && !$this->opt['prefer_html'])) { |
| | | $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') { |
| | | $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') |
| | | continue; |
| | | // list as attachment as well |
| | | if (!empty($mail_part->filename)) |
| | | $this->attachments[] = $mail_part; |
| | | } |
| | | // part message/* |
| | | else if ($primary_type=='message') { |
| | | $this->parse_structure($mail_part, true); |
| | | |
| | | // part is file/attachment |
| | | else if ($mail_part->disposition == 'attachment' || $mail_part->disposition == 'inline' || |
| | | $mail_part->headers['content-id'] || (empty($mail_part->disposition) && $mail_part->filename)) { |
| | | // skip apple resource forks |
| | | if ($message_ctype_secondary == 'appledouble' && $secondary_type == 'applefile') |
| | | continue; |
| | | // 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') { |
| | | continue; |
| | | } |
| | | // part is Microsoft Outlook TNEF (winmail.dat) |
| | | else if ($part_mimetype == 'application/ms-tnef') { |
| | | foreach ((array)$this->tnef_decode($mail_part) as $tpart) { |
| | | $this->mime_parts[$tpart->mime_id] = $tpart; |
| | | $this->attachments[] = $tpart; |
| | | } |
| | | } |
| | | // 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) |
| | | ) { |
| | | // skip apple resource forks |
| | | if ($message_ctype_secondary == 'appledouble' && $secondary_type == 'applefile') |
| | | continue; |
| | | |
| | | // part belongs to a related message |
| | | if ($message_ctype_secondary == 'related' && $mail_part->headers['content-id']) { |
| | | $mail_part->content_id = preg_replace(array('/^</', '/>$/'), '', $mail_part->headers['content-id']); |
| | | $this->inline_parts[] = $mail_part; |
| | | } |
| | | else if ($message_ctype_secondary == 'related' && $mail_part->headers['content-location']) { |
| | | $mail_part->content_location = $mail_part->headers['content-base'] . $mail_part->headers['content-location']; |
| | | $this->inline_parts[] = $mail_part; |
| | | } |
| | | // is regular attachment |
| | | else { |
| | | if (!$mail_part->filename) |
| | | $mail_part->filename = 'Part '.$mail_part->mime_id; |
| | | $this->attachments[] = $mail_part; |
| | | } |
| | | // part belongs to a related message and is linked |
| | | if ($mimetype == 'multipart/related' |
| | | && ($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); |
| | | } |
| | | // is a regular attachment |
| | | 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; |
| | | } |
| | | } |
| | | } |
| | | |
| | | // if this was a related part try to resolve references |
| | | if ($mimetype == 'multipart/related' && sizeof($this->inline_parts)) { |
| | | $a_replaces = array(); |
| | | |
| | | 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) |
| | | $a_replaces[$inline_object->content_location] = $part_url; |
| | | } |
| | | |
| | | // add replace array to each content part |
| | | // (will be applied later when part body is available) |
| | | foreach ($this->parts as $i => $part) { |
| | | if ($part->type == 'content') |
| | | $this->parts[$i]->replaces = $a_replaces; |
| | | } |
| | | } |
| | | } |
| | | } |
| | | |
| | | // if this was a related part try to resolve references |
| | | if ($message_ctype_secondary == 'related' && sizeof($this->inline_parts)) { |
| | | $a_replaces = array(); |
| | | |
| | | 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) |
| | | $a_replaces[$inline_object->content_location] = $part_url; |
| | | // message is a single part non-text |
| | | else if ($structure->filename) { |
| | | $this->attachments[] = $structure; |
| | | } |
| | | |
| | | // add replace array to each content part |
| | | // (will be applied later when part body is available) |
| | | foreach ($this->parts as $i => $part) { |
| | | if ($part->type == 'content') |
| | | $this->parts[$i]->replaces = $a_replaces; |
| | | // 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; |
| | | } |
| | | } |
| | | } |
| | | |
| | | // message is single part non-text |
| | | else if ($structure->filename) { |
| | | $this->attachments[] = $structure; |
| | | |
| | | /** |
| | | * Fill aflat array with references to all parts, indexed by part numbers |
| | | * |
| | | * @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]); |
| | | } |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Fill aflat array with references to all parts, indexed by part numbers |
| | | * |
| | | * @param object rcube_message_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]); |
| | | } |
| | | /** |
| | | * Decode a Microsoft Outlook TNEF part (winmail.dat) |
| | | * |
| | | * @param rcube_message_part $part Message part to decode |
| | | * @return array |
| | | */ |
| | | function tnef_decode(&$part) |
| | | { |
| | | // @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); |
| | | |
| | | $parts = array(); |
| | | $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['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']; |
| | | $tpart->body = $winatt['stream']; |
| | | |
| | | $parts[] = $tpart; |
| | | unset($tnef_arr[$pid]); |
| | | } |
| | | |
| | | return $parts; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Parse message body for UUencoded attachments bodies |
| | | * |
| | | * @param rcube_message_part $part Message part to decode |
| | | * @return array |
| | | */ |
| | | function uu_decode(&$part) |
| | | { |
| | | // @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); |
| | | |
| | | $parts = array(); |
| | | // FIXME: line length is max.65? |
| | | $uu_regexp = '/begin [0-7]{3,4} ([^\n]+)\n(([\x21-\x7E]{0,65}\n)+)`\nend/s'; |
| | | |
| | | if (preg_match_all($uu_regexp, $part->body, $matches, PREG_SET_ORDER)) { |
| | | // remove attachments bodies from the message body |
| | | $part->body = preg_replace($uu_regexp, '', $part->body); |
| | | // update message content-type |
| | | $part->ctype_primary = 'multipart'; |
| | | $part->ctype_secondary = 'mixed'; |
| | | $part->mimetype = $part->ctype_primary . '/' . $part->ctype_secondary; |
| | | |
| | | // add attachments to the structure |
| | | foreach ($matches as $pid => $att) { |
| | | $uupart = new rcube_message_part; |
| | | |
| | | $uupart->filename = trim($att[1]); |
| | | $uupart->encoding = 'stream'; |
| | | $uupart->body = convert_uudecode($att[2]); |
| | | $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); |
| | | $uupart->mimetype = $ctype; |
| | | list($uupart->ctype_primary, $uupart->ctype_secondary) = explode('/', $ctype); |
| | | |
| | | $parts[] = $uupart; |
| | | unset($matches[$pid]); |
| | | } |
| | | } |
| | | |
| | | return $parts; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * 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 |
| | | */ |
| | | 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); |
| | | } |
| | | |
| | | |
| | | /** |
| | | * 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); |
| | | } |
| | | |
| | | } |
| | | |