- Exclude MIME functionality from rcube_imap class into rcube_mime class

alecpl

2012-01-05 1c4f23d6e58e12f93d8de2c3ae416df575e8ad85

 program/include/rcube_message.php

@@ -4,8 +4,8 @@
 +-----------------------------------------------------------------------+
 | program/include/rcube_message.php                                     |
 |                                                                       |
 | This file is part of the RoundCube Webmail client                     |
 | Copyright (C) 2008-2010, RoundCube Dev. - Switzerland                 |
 | This file is part of the Roundcube Webmail client                     |
 | Copyright (C) 2008-2010, The Roundcube Dev Team                       |
 | Licensed under the GNU GPL                                            |
 |                                                                       |
 | PURPOSE:                                                              |
@@ -29,22 +29,39 @@
 */
class rcube_message
{
    /**
     * Instace of rcmail.
     *
     * @var rcmail
     */
    private $app;

    /**
     * Instance of imap class
     *
     * @var rcube_imap
     */
    private $imap;

    /**
     * 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();
    public $subject = '';
    public $sender = null;
    public $is_safe = false;
  


    /**
     * __construct
@@ -53,26 +70,24 @@
     *
     * @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)
    {
        $this->app = rcmail::get_instance();
        $this->uid  = $uid;
        $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);
        $this->headers = $this->imap->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(
@@ -82,9 +97,9 @@
                '_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);
        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);
@@ -93,26 +108,33 @@
        // 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;
        return $raw ? $value : $this->imap->decode_header($value);
        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->mime->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)
    {
@@ -124,13 +146,13 @@
    /**
     * 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)
    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;
    }
@@ -139,8 +161,8 @@
    /**
     * 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)
@@ -198,43 +220,37 @@
    /**
     * 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') {
                $html_part = $this->imap->get_message_part($this->uid, $mime_id, $part);
                $out = $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);
                $out = strtr($out, $trans);

                // create instance of html2text class
                $txt = new html2text($html_part);
                $out = $txt->get_text();
                break;
                $txt = new html2text($out);
                return $txt->get_text();
            }
        }

        return $out;
        $part = null;
        return null;
    }


@@ -242,8 +258,8 @@
     * 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)
    {
@@ -276,7 +292,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) {
@@ -289,14 +305,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;
@@ -313,7 +331,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;
@@ -363,6 +381,8 @@
            $p->ctype_secondary = 'plain';
            $p->body            = rcube_label('encryptedmessage');
            $p->size            = strlen($p->body);

            $this->parts[] = $p;
        }
        // message contains multiple parts
        else if (is_array($structure->parts) && !empty($structure->parts)) {
@@ -389,9 +409,9 @@
                    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',
@@ -400,6 +420,10 @@

                    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']);
@@ -412,13 +436,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)
@@ -438,7 +462,9 @@
                }
                // 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')
@@ -457,26 +483,65 @@
                    // 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;
                    }
                }
                // 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)
                    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
@@ -502,7 +567,7 @@
    /**
     * 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)
    {
@@ -518,7 +583,8 @@
    /**
     * 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)
    {
@@ -553,7 +619,8 @@
    /**
     * 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)
    {
@@ -594,39 +661,4 @@

        return $parts;
    }


    /**
     * Interpret a format=flowed message body according to RFC 2646
     *
     * @param string  Raw body formatted as flowed text
     * @return string Interpreted text with unwrapped lines and stuffed space removed
     */
    public static function unfold_flowed($text)
    {
        return preg_replace(
            array('/-- (\r?\n)/',   '/^ /m',  '/(.) \r?\n/',  '/--%SIGEND%(\r?\n)/'),
            array('--%SIGEND%\\1',  '',       '\\1 ',         '-- \\1'),
            $text);
    }


    /**
     * Wrap the given text to comply with RFC 2646
     */
    public static function format_flowed($text, $length = 72)
    {
        $out = '';
    
        foreach (preg_split('/\r?\n/', trim($text)) as $line) {
            // don't wrap quoted lines (to avoid wrapping problems)
            if ($line[0] != '>')
                $line = rc_wordwrap(rtrim($line, "\r\n"), $length - 1, " \r\n");

            $out .= $line . "\r\n";
        }
    
        return $out;
    }

}