| | |
| | | | | |
| | | | This file is part of the Roundcube Webmail client | |
| | | | Copyright (C) 2008-2010, The Roundcube Dev Team | |
| | | | Licensed under the GNU GPL | |
| | | | | |
| | | | 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 | |
| | |
| | | class rcube_message |
| | | { |
| | | /** |
| | | * Instace of rcmail. |
| | | * Instace of framework class. |
| | | * |
| | | * @var rcmail |
| | | * @var rcube |
| | | */ |
| | | 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; |
| | |
| | | * |
| | | * @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_message($uid); |
| | | $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 (!empty($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 |
| | |
| | | */ |
| | | 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); |
| | | } |
| | | |
| | | |
| | |
| | | * @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; |
| | | } |
| | |
| | | /** |
| | | * 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; |
| | | } |
| | |
| | | /** |
| | | * 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; |
| | |
| | | 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); |
| | | } |
| | | } |
| | | } |
| | |
| | | |
| | | // 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)); |
| | |
| | | |
| | | |
| | | /** |
| | | * 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 |
| | |
| | | $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; |
| | | } |
| | |
| | | // 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; |
| | |
| | | $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; |
| | | } |
| | |
| | | $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) { |
| | |
| | | { |
| | | // @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; |
| | |
| | | { |
| | | // @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? |
| | |
| | | $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); |
| | | |
| | |
| | | |
| | | |
| | | /** |
| | | * 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"); |
| | | // space-stuffing |
| | | $line = preg_replace('/(^|\r\n)(From| |>)/', '\\1 \\2', $line); |
| | | } |
| | | |
| | | $text[$idx] = $line; |
| | | } |
| | | } |
| | | |
| | | return implode("\r\n", $text); |
| | | return rcube_mime::format_flowed($text, $length); |
| | | } |
| | | |
| | | } |