| | |
| | | | program/include/rcube_message.php | |
| | | | | |
| | | | This file is part of the Roundcube Webmail client | |
| | | | Copyright (C) 2008-2010, Roundcube Dev. - Switzerland | |
| | | | Copyright (C) 2008-2010, The Roundcube Dev Team | |
| | | | Licensed under the GNU GPL | |
| | | | | |
| | | | PURPOSE: | |
| | |
| | | */ |
| | | 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; |
| | |
| | | public $subject = ''; |
| | | public $sender = null; |
| | | public $is_safe = false; |
| | | |
| | | |
| | | |
| | | /** |
| | | * __construct |
| | |
| | | { |
| | | $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); |
| | |
| | | // 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) |
| | | { |
| | |
| | | /** |
| | | * 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) |
| | |
| | | /** |
| | | * 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) |
| | |
| | | /** |
| | | * 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') { |
| | | $out = $this->imap->get_message_part($this->uid, $mime_id, $part); |
| | |
| | | |
| | | // create instance of html2text class |
| | | $txt = new html2text($out); |
| | | $out = $txt->get_text(); |
| | | return $txt->get_text(); |
| | | } |
| | | } |
| | | |
| | | return $out; |
| | | $part = null; |
| | | return null; |
| | | } |
| | | |
| | | |
| | |
| | | * 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) |
| | | { |
| | |
| | | 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', |
| | |
| | | |
| | | 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']); |
| | |
| | | $mail_part->type = 'content'; |
| | | $this->parts[] = $mail_part; |
| | | } |
| | | |
| | | |
| | | // list as attachment as well |
| | | if (!empty($mail_part->filename)) |
| | | $this->attachments[] = $mail_part; |
| | |
| | | } |
| | | // 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') |
| | |
| | | // 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; |
| | | } |
| | | } |
| | |
| | | // 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 |
| | |
| | | /** |
| | | * 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) |
| | | { |
| | |
| | | /** |
| | | * 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) |
| | | { |
| | |
| | | /** |
| | | * 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) |
| | | { |
| | |
| | | /** |
| | | * 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) |
| | |
| | | |
| | | /** |
| | | * 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) |
| | | { |
| | |
| | | $line = rtrim(substr($line, $level)); |
| | | $line = $prefix . rc_wordwrap($line, $length - $level - 2, " \r\n$prefix "); |
| | | } |
| | | else { |
| | | $line = ' ' . rc_wordwrap(rtrim($line), $length - 2, " \r\n "); |
| | | 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; |