source: github/program/include/rcube_message.php @ 8bac7e9

HEADcourier-fixdev-browser-capabilitiespdorelease-0.6release-0.7release-0.8
Last change on this file since 8bac7e9 was 8bac7e9, checked in by alecpl <alec@…>, 3 years ago
  • Allow underline in content-type name, per comments in #1487051
  • Property mode set to 100644
File size: 25.4 KB
Line 
1<?php
2
3/*
4 +-----------------------------------------------------------------------+
5 | program/include/rcube_message.php                                     |
6 |                                                                       |
7 | This file is part of the Roundcube Webmail client                     |
8 | Copyright (C) 2008-2010, Roundcube Dev. - Switzerland                 |
9 | Licensed under the GNU GPL                                            |
10 |                                                                       |
11 | PURPOSE:                                                              |
12 |   Logical representation of a mail message with all its data          |
13 |   and related functions                                               |
14 +-----------------------------------------------------------------------+
15 | Author: Thomas Bruederli <roundcube@gmail.com>                        |
16 +-----------------------------------------------------------------------+
17
18 $Id$
19
20*/
21
22
23/**
24 * Logical representation of a mail message with all its data
25 * and related functions
26 *
27 * @package    Mail
28 * @author     Thomas Bruederli <roundcube@gmail.com>
29 */
30class rcube_message
31{
32    /**
33     * Instace of rcmail.
34     *
35     * @var rcmail
36     */
37    private $app;
38
39    /**
40     * Instance of imap class
41     *
42     * @var rcube_imap
43     */
44    private $imap;
45    private $opt = array();
46    private $inline_parts = array();
47    private $parse_alternative = false;
48 
49    public $uid = null;
50    public $headers;
51    public $structure;
52    public $parts = array();
53    public $mime_parts = array();
54    public $attachments = array();
55    public $subject = '';
56    public $sender = null;
57    public $is_safe = false;
58 
59
60    /**
61     * __construct
62     *
63     * Provide a uid, and parse message structure.
64     *
65     * @param string $uid The message UID.
66     *
67     * @uses rcmail::get_instance()
68     * @uses rcube_imap::decode_mime_string()
69     * @uses self::set_safe()
70     *
71     * @see self::$app, self::$imap, self::$opt, self::$structure
72     */
73    function __construct($uid)
74    {
75        $this->app = rcmail::get_instance();
76        $this->imap = $this->app->imap;
77        $this->imap->get_all_headers = true;
78
79        $this->uid = $uid;
80        $this->headers = $this->imap->get_headers($uid, NULL, true, true);
81
82        if (!$this->headers)
83            return;
84
85        $this->subject = rcube_imap::decode_mime_string(
86            $this->headers->subject, $this->headers->charset);
87        list(, $this->sender) = each($this->imap->decode_address_list($this->headers->from));
88
89        $this->set_safe((intval($_GET['_safe']) || $_SESSION['safe_messages'][$uid]));
90        $this->opt = array(
91            'safe' => $this->is_safe,
92            'prefer_html' => $this->app->config->get('prefer_html'),
93            'get_url' => rcmail_url('get', array(
94                '_mbox' => $this->imap->get_mailbox_name(), '_uid' => $uid))
95        );
96
97        if ($this->structure = $this->imap->get_structure($uid, $this->headers->body_structure)) {
98            $this->get_mime_numbers($this->structure);
99            $this->parse_structure($this->structure);
100        }
101        else {
102            $this->body = $this->imap->get_body($uid);
103        }
104
105        // notify plugins and let them analyze this structured message object
106        $this->app->plugins->exec_hook('message_load', array('object' => $this));
107    }
108 
109 
110    /**
111     * Return a (decoded) message header
112     *
113     * @param string $name Header name
114     * @param bool   $row  Don't mime-decode the value
115     * @return string Header value
116     */
117    public function get_header($name, $raw = false)
118    {
119        if ($this->headers->$name)
120            $value = $this->headers->$name;
121        else if ($this->headers->others[$name])
122            $value = $this->headers->others[$name];
123
124        return $raw ? $value : $this->imap->decode_header($value);
125    }
126
127 
128    /**
129     * Set is_safe var and session data
130     *
131     * @param bool $safe enable/disable
132     */
133    public function set_safe($safe = true)
134    {
135        $this->is_safe = $safe;
136        $_SESSION['safe_messages'][$this->uid] = $this->is_safe;
137    }
138
139
140    /**
141     * Compose a valid URL for getting a message part
142     *
143     * @param string $mime_id Part MIME-ID
144     * @return string URL or false if part does not exist
145     */
146    public function get_part_url($mime_id)
147    {
148        if ($this->mime_parts[$mime_id])
149            return $this->opt['get_url'] . '&_part=' . $mime_id;
150        else
151            return false;
152    }
153
154
155    /**
156     * Get content of a specific part of this message
157     *
158     * @param string $mime_id Part MIME-ID
159     * @param resource $fp File pointer to save the message part
160     * @return string Part content
161     */
162    public function get_part_content($mime_id, $fp=NULL)
163    {
164        if ($part = $this->mime_parts[$mime_id]) {
165            // stored in message structure (winmail/inline-uuencode)
166            if ($part->encoding == 'stream') {
167                if ($fp) {
168                    fwrite($fp, $part->body);
169                }
170                return $fp ? true : $part->body;
171            }
172            // get from IMAP
173            return $this->imap->get_message_part($this->uid, $mime_id, $part, NULL, $fp);
174        } else
175            return null;
176    }
177
178
179    /**
180     * Determine if the message contains a HTML part
181     *
182     * @return bool True if a HTML is available, False if not
183     */
184    function has_html_part()
185    {
186        // check all message parts
187        foreach ($this->parts as $pid => $part) {
188            $mimetype = strtolower($part->ctype_primary . '/' . $part->ctype_secondary);
189            if ($mimetype == 'text/html')
190                return true;
191        }
192
193        return false;
194    }
195
196
197    /**
198     * Return the first HTML part of this message
199     *
200     * @return string HTML message part content
201     */
202    function first_html_part()
203    {
204        // check all message parts
205        foreach ($this->mime_parts as $mime_id => $part) {
206            $mimetype = strtolower($part->ctype_primary . '/' . $part->ctype_secondary);
207            if ($mimetype == 'text/html') {
208                return $this->imap->get_message_part($this->uid, $mime_id, $part);
209            }
210        }
211    }
212
213
214    /**
215     * Return the first text part of this message
216     *
217     * @param rcube_message_part $part Reference to the part if found
218     * @return string Plain text message/part content
219     */
220    function first_text_part(&$part=null)
221    {
222        // no message structure, return complete body
223        if (empty($this->parts))
224            return $this->body;
225
226        // check all message parts
227        foreach ($this->mime_parts as $mime_id => $part) {
228            $mimetype = $part->ctype_primary . '/' . $part->ctype_secondary;
229
230            if ($mimetype == 'text/plain') {
231                return $this->imap->get_message_part($this->uid, $mime_id, $part);
232            }
233            else if ($mimetype == 'text/html') {
234                $out = $this->imap->get_message_part($this->uid, $mime_id, $part);
235
236                // remove special chars encoding
237                $trans = array_flip(get_html_translation_table(HTML_ENTITIES));
238                $out = strtr($out, $trans);
239
240                // create instance of html2text class
241                $txt = new html2text($out);
242                return $txt->get_text();
243            }
244        }
245
246        $part = null;
247        return null;
248    }
249
250
251    /**
252     * Raad the message structure returend by the IMAP server
253     * and build flat lists of content parts and attachments
254     *
255     * @param rcube_message_part $structure Message structure node
256     * @param bool               $recursive True when called recursively
257     */
258    private function parse_structure($structure, $recursive = false)
259    {
260        // real content-type of message/rfc822 part
261        if ($structure->mimetype == 'message/rfc822' && $structure->real_mimetype)
262            $mimetype = $structure->real_mimetype;
263        else
264            $mimetype = $structure->mimetype;
265
266        // show message headers
267        if ($recursive && is_array($structure->headers) && isset($structure->headers['subject'])) {
268            $c = new stdClass;
269            $c->type = 'headers';
270            $c->headers = &$structure->headers;
271            $this->parts[] = $c;
272        }
273
274        // Allow plugins to handle message parts
275        $plugin = $this->app->plugins->exec_hook('message_part_structure',
276            array('object' => $this, 'structure' => $structure,
277                'mimetype' => $mimetype, 'recursive' => $recursive));
278
279        if ($plugin['abort'])
280            return;
281
282        $structure = $plugin['structure'];
283        list($message_ctype_primary, $message_ctype_secondary) = explode('/', $plugin['mimetype']);
284
285        // print body if message doesn't have multiple parts
286        if ($message_ctype_primary == 'text' && !$recursive) {
287            $structure->type = 'content';
288            $this->parts[] = &$structure;
289           
290            // Parse simple (plain text) message body
291            if ($message_ctype_secondary == 'plain')
292                foreach ((array)$this->uu_decode($structure) as $uupart) {
293                    $this->mime_parts[$uupart->mime_id] = $uupart;
294                    $this->attachments[] = $uupart;
295                }
296        }
297        // the same for pgp signed messages
298        else if ($mimetype == 'application/pgp' && !$recursive) {
299            $structure->type = 'content';
300            $this->parts[] = &$structure;
301        }
302        // message contains alternative parts
303        else if ($mimetype == 'multipart/alternative' && is_array($structure->parts)) {
304            // get html/plaintext parts
305            $plain_part = $html_part = $print_part = $related_part = null;
306
307            foreach ($structure->parts as $p => $sub_part) {
308                $sub_mimetype = $sub_part->mimetype;
309       
310                // check if sub part is
311                if ($sub_mimetype == 'text/plain')
312                    $plain_part = $p;
313                else if ($sub_mimetype == 'text/html')
314                    $html_part = $p;
315                else if ($sub_mimetype == 'text/enriched')
316                    $enriched_part = $p;
317                else if (in_array($sub_mimetype, array('multipart/related', 'multipart/mixed', 'multipart/alternative')))
318                    $related_part = $p;
319            }
320
321            // parse related part (alternative part could be in here)
322            if ($related_part !== null && !$this->parse_alternative) {
323                $this->parse_alternative = true;
324                $this->parse_structure($structure->parts[$related_part], true);
325                $this->parse_alternative = false;
326       
327                // if plain part was found, we should unset it if html is preferred
328                if ($this->opt['prefer_html'] && count($this->parts))
329                    $plain_part = null;
330            }
331
332            // choose html/plain part to print
333            if ($html_part !== null && $this->opt['prefer_html']) {
334                $print_part = &$structure->parts[$html_part];
335            }
336            else if ($enriched_part !== null) {
337                $print_part = &$structure->parts[$enriched_part];
338            }
339            else if ($plain_part !== null) {
340                $print_part = &$structure->parts[$plain_part];
341            }
342
343            // add the right message body
344            if (is_object($print_part)) {
345                $print_part->type = 'content';
346                $this->parts[] = $print_part;
347            }
348            // show plaintext warning
349            else if ($html_part !== null && empty($this->parts)) {
350                $c = new stdClass;
351                $c->type            = 'content';
352                $c->ctype_primary   = 'text';
353                $c->ctype_secondary = 'plain';
354                $c->body            = rcube_label('htmlmessage');
355
356                $this->parts[] = $c;
357            }
358
359            // add html part as attachment
360            if ($html_part !== null && $structure->parts[$html_part] !== $print_part) {
361                $html_part = &$structure->parts[$html_part];
362                $html_part->filename = rcube_label('htmlmessage');
363                $html_part->mimetype = 'text/html';
364
365                $this->attachments[] = $html_part;
366            }
367        }
368        // this is an ecrypted message -> create a plaintext body with the according message
369        else if ($mimetype == 'multipart/encrypted') {
370            $p = new stdClass;
371            $p->type            = 'content';
372            $p->ctype_primary   = 'text';
373            $p->ctype_secondary = 'plain';
374            $p->body            = rcube_label('encryptedmessage');
375            $p->size            = strlen($p->body);
376        }
377        // message contains multiple parts
378        else if (is_array($structure->parts) && !empty($structure->parts)) {
379            // iterate over parts
380            for ($i=0; $i < count($structure->parts); $i++) {
381                $mail_part      = &$structure->parts[$i];
382                $primary_type   = $mail_part->ctype_primary;
383                $secondary_type = $mail_part->ctype_secondary;
384
385                // real content-type of message/rfc822
386                if ($mail_part->real_mimetype) {
387                    $part_orig_mimetype = $mail_part->mimetype;
388                    $part_mimetype = $mail_part->real_mimetype;
389                    list($primary_type, $secondary_type) = explode('/', $part_mimetype);
390                }
391                else
392                    $part_mimetype = $mail_part->mimetype;
393
394                // multipart/alternative
395                if ($primary_type == 'multipart') {
396                    $this->parse_structure($mail_part, true);
397
398                    // list message/rfc822 as attachment as well (mostly .eml)
399                    if ($part_orig_mimetype == 'message/rfc822' && !empty($mail_part->filename))
400                        $this->attachments[] = $mail_part;
401                }
402                // part text/[plain|html] or delivery status
403                else if ((($part_mimetype == 'text/plain' || $part_mimetype == 'text/html') && $mail_part->disposition != 'attachment') ||
404                    in_array($part_mimetype, array('message/delivery-status', 'text/rfc822-headers', 'message/disposition-notification'))
405                ) {
406                    // Allow plugins to handle also this part
407                    $plugin = $this->app->plugins->exec_hook('message_part_structure',
408                        array('object' => $this, 'structure' => $mail_part,
409                            'mimetype' => $part_mimetype, 'recursive' => true));
410
411                    if ($plugin['abort'])
412                        continue;
413
414                    $mail_part = $plugin['structure'];
415                    list($primary_type, $secondary_type) = explode('/', $plugin['mimetype']);
416
417                    // add text part if it matches the prefs
418                    if (!$this->parse_alternative ||
419                        ($secondary_type == 'html' && $this->opt['prefer_html']) ||
420                        ($secondary_type == 'plain' && !$this->opt['prefer_html'])
421                    ) {
422                        $mail_part->type = 'content';
423                        $this->parts[] = $mail_part;
424                    }
425         
426                    // list as attachment as well
427                    if (!empty($mail_part->filename))
428                        $this->attachments[] = $mail_part;
429                }
430                // part message/*
431                else if ($primary_type=='message') {
432                    $this->parse_structure($mail_part, true);
433
434                    // list as attachment as well (mostly .eml)
435                    if (!empty($mail_part->filename))
436                        $this->attachments[] = $mail_part;
437                }
438                // ignore "virtual" protocol parts
439                else if ($primary_type == 'protocol') {
440                    continue;
441                }
442                // part is Microsoft Outlook TNEF (winmail.dat)
443                else if ($part_mimetype == 'application/ms-tnef') {
444                    foreach ((array)$this->tnef_decode($mail_part) as $tpart) {
445                        $this->mime_parts[$tpart->mime_id] = $tpart;
446                        $this->attachments[] = $tpart;
447                    }
448                }
449                // part is a file/attachment
450                else if (preg_match('/^(inline|attach)/', $mail_part->disposition) ||
451                    $mail_part->headers['content-id'] || (empty($mail_part->disposition) && $mail_part->filename)
452                ) {
453                    // skip apple resource forks
454                    if ($message_ctype_secondary == 'appledouble' && $secondary_type == 'applefile')
455                        continue;
456
457                    // part belongs to a related message and is linked
458                    if ($mimetype == 'multipart/related'
459                        && ($mail_part->headers['content-id'] || $mail_part->headers['content-location'])) {
460                        if ($mail_part->headers['content-id'])
461                            $mail_part->content_id = preg_replace(array('/^</', '/>$/'), '', $mail_part->headers['content-id']);
462                        if ($mail_part->headers['content-location'])
463                            $mail_part->content_location = $mail_part->headers['content-base'] . $mail_part->headers['content-location'];
464
465                        $this->inline_parts[] = $mail_part;
466                    }
467                    // attachment encapsulated within message/rfc822 part needs further decoding (#1486743)
468                    else if ($part_orig_mimetype == 'message/rfc822') {
469                        $this->parse_structure($mail_part, true);
470                    }
471                    // is a regular attachment
472                    else if (preg_match('!^[a-z0-9-.+_]+/[a-z0-9-.+_]+$!i', $part_mimetype)) {
473                        if (!$mail_part->filename)
474                            $mail_part->filename = 'Part '.$mail_part->mime_id;
475                        $this->attachments[] = $mail_part;
476                    }
477                }
478            }
479
480            // if this was a related part try to resolve references
481            if ($mimetype == 'multipart/related' && sizeof($this->inline_parts)) {
482                $a_replaces = array();
483
484                foreach ($this->inline_parts as $inline_object) {
485                    $part_url = $this->get_part_url($inline_object->mime_id);
486                    if ($inline_object->content_id)
487                        $a_replaces['cid:'.$inline_object->content_id] = $part_url;
488                    if ($inline_object->content_location)
489                        $a_replaces[$inline_object->content_location] = $part_url;
490                }
491
492                // add replace array to each content part
493                // (will be applied later when part body is available)
494                foreach ($this->parts as $i => $part) {
495                    if ($part->type == 'content')
496                        $this->parts[$i]->replaces = $a_replaces;
497                }
498            }
499        }
500        // message is a single part non-text
501        else if ($structure->filename) {
502            $this->attachments[] = $structure;
503        }
504        // message is a single part non-text (without filename)
505        else if (preg_match('/application\//i', $mimetype)) {
506            $structure->filename = 'Part '.$structure->mime_id;
507            $this->attachments[] = $structure;
508        }
509    }
510
511
512    /**
513     * Fill aflat array with references to all parts, indexed by part numbers
514     *
515     * @param rcube_message_part $part Message body structure
516     */
517    private function get_mime_numbers(&$part)
518    {
519        if (strlen($part->mime_id))
520            $this->mime_parts[$part->mime_id] = &$part;
521
522        if (is_array($part->parts))
523            for ($i=0; $i<count($part->parts); $i++)
524                $this->get_mime_numbers($part->parts[$i]);
525    }
526
527
528    /**
529     * Decode a Microsoft Outlook TNEF part (winmail.dat)
530     *
531     * @param rcube_message_part $part Message part to decode
532     * @return array
533     */
534    function tnef_decode(&$part)
535    {
536        // @TODO: attachment may be huge, hadle it via file
537        if (!isset($part->body))
538            $part->body = $this->imap->get_message_part($this->uid, $part->mime_id, $part);
539
540        $parts = array();
541        $tnef = new tnef_decoder;
542        $tnef_arr = $tnef->decompress($part->body);
543
544        foreach ($tnef_arr as $pid => $winatt) {
545            $tpart = new rcube_message_part;
546
547            $tpart->filename        = trim($winatt['name']);
548            $tpart->encoding        = 'stream';
549            $tpart->ctype_primary   = trim(strtolower($winatt['type']));
550            $tpart->ctype_secondary = trim(strtolower($winatt['subtype']));
551            $tpart->mimetype        = $tpart->ctype_primary . '/' . $tpart->ctype_secondary;
552            $tpart->mime_id         = 'winmail.' . $part->mime_id . '.' . $pid;
553            $tpart->size            = $winatt['size'];
554            $tpart->body            = $winatt['stream'];
555
556            $parts[] = $tpart;
557            unset($tnef_arr[$pid]);
558        }
559
560        return $parts;
561    }
562
563
564    /**
565     * Parse message body for UUencoded attachments bodies
566     *
567     * @param rcube_message_part $part Message part to decode
568     * @return array
569     */
570    function uu_decode(&$part)
571    {
572        // @TODO: messages may be huge, hadle body via file
573        if (!isset($part->body))
574            $part->body = $this->imap->get_message_part($this->uid, $part->mime_id, $part);
575
576        $parts = array();
577        // FIXME: line length is max.65?
578        $uu_regexp = '/begin [0-7]{3,4} ([^\n]+)\n(([\x21-\x7E]{0,65}\n)+)`\nend/s';
579
580        if (preg_match_all($uu_regexp, $part->body, $matches, PREG_SET_ORDER)) {
581            // remove attachments bodies from the message body
582            $part->body = preg_replace($uu_regexp, '', $part->body);
583            // update message content-type
584            $part->ctype_primary   = 'multipart';
585            $part->ctype_secondary = 'mixed';
586            $part->mimetype        = $part->ctype_primary . '/' . $part->ctype_secondary;
587
588            // add attachments to the structure
589            foreach ($matches as $pid => $att) {
590                $uupart = new rcube_message_part;
591
592                $uupart->filename = trim($att[1]);
593                $uupart->encoding = 'stream';
594                $uupart->body     = convert_uudecode($att[2]);
595                $uupart->size     = strlen($uupart->body);
596                $uupart->mime_id  = 'uu.' . $part->mime_id . '.' . $pid;
597
598                $ctype = rc_mime_content_type($uupart->body, $uupart->filename, 'application/octet-stream', true);
599                $uupart->mimetype = $ctype;
600                list($uupart->ctype_primary, $uupart->ctype_secondary) = explode('/', $ctype);
601
602                $parts[] = $uupart;
603                unset($matches[$pid]);
604            }
605        }
606
607        return $parts;
608    }
609
610
611    /**
612     * Interpret a format=flowed message body according to RFC 2646
613     *
614     * @param string  $text Raw body formatted as flowed text
615     * @return string Interpreted text with unwrapped lines and stuffed space removed
616     */
617    public static function unfold_flowed($text)
618    {
619        $text = preg_split('/\r?\n/', $text);
620        $last = -1;
621        $q_level = 0;
622
623        foreach ($text as $idx => $line) {
624            if ($line[0] == '>' && preg_match('/^(>+\s*)/', $line, $regs)) {
625                $q = strlen(str_replace(' ', '', $regs[0]));
626                $line = substr($line, strlen($regs[0]));
627
628                if ($q == $q_level && $line
629                    && isset($text[$last])
630                    && $text[$last][strlen($text[$last])-1] == ' '
631                ) {
632                    $text[$last] .= $line;
633                    unset($text[$idx]);
634                }
635                else {
636                    $last = $idx;
637                }
638            }
639            else {
640                $q = 0;
641                if ($line == '-- ') {
642                    $last = $idx;
643                }
644                else {
645                    // remove space-stuffing
646                    $line = preg_replace('/^\s/', '', $line);
647
648                    if (isset($text[$last]) && $line
649                        && $text[$last] != '-- '
650                        && $text[$last][strlen($text[$last])-1] == ' '
651                    ) {
652                        $text[$last] .= $line;
653                        unset($text[$idx]);
654                    }
655                    else {
656                        $text[$idx] = $line;
657                        $last = $idx;
658                    }
659                }
660            }
661            $q_level = $q;
662        }
663
664        return implode("\r\n", $text);
665    }
666
667
668    /**
669     * Wrap the given text to comply with RFC 2646
670     *
671     * @param string $text Text to wrap
672     * @param int $length Length
673     * @return string Wrapped text
674     */
675    public static function format_flowed($text, $length = 72)
676    {
677        $text = preg_split('/\r?\n/', $text);
678
679        foreach ($text as $idx => $line) {
680            if ($line != '-- ') {
681                if ($line[0] == '>' && preg_match('/^(>+)/', $line, $regs)) {
682                    $prefix = $regs[0];
683                    $level = strlen($prefix);
684                    $line  = rtrim(substr($line, $level));
685                    $line  = $prefix . rc_wordwrap($line, $length - $level - 2, " \r\n$prefix ");
686                }
687                else if ($line) {
688                    $line = ' ' . rc_wordwrap(rtrim($line), $length - 2, " \r\n ");
689                }
690
691                $text[$idx] = $line;
692            }
693        }
694
695        return implode("\r\n", $text);
696    }
697
698}
Note: See TracBrowser for help on using the repository browser.