| commit | author | age | ||
| 8fa58e | 1 | <?php |
| T | 2 | |
| 3 | /* | |
| 4 | +-----------------------------------------------------------------------+ | |
| e019f2 | 5 | | This file is part of the Roundcube Webmail client | |
| f5e7b3 | 6 | | Copyright (C) 2008-2010, The Roundcube Dev Team | |
| 7fe381 | 7 | | | |
| T | 8 | | Licensed under the GNU General Public License version 3 or | |
| 9 | | any later version with exceptions for skins & plugins. | | |
| 10 | | See the README file for a full license statement. | | |
| 8fa58e | 11 | | | |
| T | 12 | | PURPOSE: | |
| 13 | | Logical representation of a mail message with all its data | | |
| 14 | | and related functions | | |
| 15 | +-----------------------------------------------------------------------+ | |
| 16 | | Author: Thomas Bruederli <roundcube@gmail.com> | | |
| 17 | +-----------------------------------------------------------------------+ | |
| 18 | */ | |
| 19 | ||
| 20 | /** | |
| 45f56c | 21 | * Logical representation of a mail message with all its data |
| T | 22 | * and related functions |
| 8fa58e | 23 | * |
| 9ab346 | 24 | * @package Framework |
| AM | 25 | * @subpackage Storage |
| 8fa58e | 26 | * @author Thomas Bruederli <roundcube@gmail.com> |
| T | 27 | */ |
| 28 | class rcube_message | |
| 29 | { | |
| 5c461b | 30 | /** |
| be98df | 31 | * Instace of framework class. |
| 5c461b | 32 | * |
| be98df | 33 | * @var rcube |
| 5c461b | 34 | */ |
| d311d8 | 35 | private $app; |
| 5c461b | 36 | |
| A | 37 | /** |
| 8b92d2 | 38 | * Instance of storage class |
| 5c461b | 39 | * |
| 8b92d2 | 40 | * @var rcube_storage |
| 5c461b | 41 | */ |
| 8b92d2 | 42 | private $storage; |
| 1c4f23 | 43 | |
| A | 44 | /** |
| 45 | * Instance of mime class | |
| 46 | * | |
| 47 | * @var rcube_mime | |
| 48 | */ | |
| 49 | private $mime; | |
| d311d8 | 50 | private $opt = array(); |
| A | 51 | private $parse_alternative = false; |
| 2ae58f | 52 | |
| 10562d | 53 | public $uid; |
| AM | 54 | public $folder; |
| d311d8 | 55 | public $headers; |
| A | 56 | public $parts = array(); |
| 57 | public $mime_parts = array(); | |
| 287eff | 58 | public $inline_parts = array(); |
| d311d8 | 59 | public $attachments = array(); |
| A | 60 | public $subject = ''; |
| 61 | public $sender = null; | |
| 62 | public $is_safe = false; | |
| 2ae58f | 63 | |
| 193fb4 | 64 | |
| d311d8 | 65 | /** |
| A | 66 | * __construct |
| 67 | * | |
| 68 | * Provide a uid, and parse message structure. | |
| 69 | * | |
| 10562d | 70 | * @param string $uid The message UID. |
| AM | 71 | * @param string $folder Folder name |
| d311d8 | 72 | * |
| 8b92d2 | 73 | * @see self::$app, self::$storage, self::$opt, self::$parts |
| d311d8 | 74 | */ |
| 10562d | 75 | function __construct($uid, $folder = null) |
| 8fa58e | 76 | { |
| 1c4f23 | 77 | $this->uid = $uid; |
| 0c2596 | 78 | $this->app = rcube::get_instance(); |
| c321a9 | 79 | $this->storage = $this->app->get_storage(); |
| 10562d | 80 | $this->folder = strlen($folder) ? $folder : $this->storage->get_folder(); |
| c321a9 | 81 | $this->storage->set_options(array('all_headers' => true)); |
| 10562d | 82 | |
| AM | 83 | // Set current folder |
| 84 | $this->storage->set_folder($this->folder); | |
| 64e3e8 | 85 | |
| c321a9 | 86 | $this->headers = $this->storage->get_message($uid); |
| 64e3e8 | 87 | |
| 4fdaa0 | 88 | if (!$this->headers) { |
| 64e3e8 | 89 | return; |
| 4fdaa0 | 90 | } |
| 8fa58e | 91 | |
| 1c4f23 | 92 | $this->mime = new rcube_mime($this->headers->charset); |
| A | 93 | |
| 4fdaa0 | 94 | $this->subject = $this->headers->get('subject'); |
| 1c4f23 | 95 | list(, $this->sender) = each($this->mime->decode_address_list($this->headers->from, 1)); |
| 64e3e8 | 96 | |
| f11142 | 97 | $this->set_safe((intval($_GET['_safe']) || $_SESSION['safe_messages'][$this->folder.':'.$uid])); |
| d311d8 | 98 | $this->opt = array( |
| A | 99 | 'safe' => $this->is_safe, |
| 100 | 'prefer_html' => $this->app->config->get('prefer_html'), | |
| 0c2596 | 101 | 'get_url' => $this->app->url(array( |
| A | 102 | 'action' => 'get', |
| 103 | 'mbox' => $this->storage->get_folder(), | |
| 104 | 'uid' => $uid)) | |
| d311d8 | 105 | ); |
| 8fa58e | 106 | |
| 80152b | 107 | if (!empty($this->headers->structure)) { |
| A | 108 | $this->get_mime_numbers($this->headers->structure); |
| 109 | $this->parse_structure($this->headers->structure); | |
| aa16b4 | 110 | } |
| d311d8 | 111 | else { |
| c321a9 | 112 | $this->body = $this->storage->get_body($uid); |
| d311d8 | 113 | } |
| A | 114 | |
| 115 | // notify plugins and let them analyze this structured message object | |
| 116 | $this->app->plugins->exec_hook('message_load', array('object' => $this)); | |
| 117 | } | |
| 2ae58f | 118 | |
| A | 119 | |
| d311d8 | 120 | /** |
| A | 121 | * Return a (decoded) message header |
| 122 | * | |
| 5c461b | 123 | * @param string $name Header name |
| A | 124 | * @param bool $row Don't mime-decode the value |
| d311d8 | 125 | * @return string Header value |
| A | 126 | */ |
| 127 | public function get_header($name, $raw = false) | |
| 128 | { | |
| 4fdaa0 | 129 | if (empty($this->headers)) { |
| 1c4f23 | 130 | return null; |
| 4fdaa0 | 131 | } |
| 1c4f23 | 132 | |
| 4fdaa0 | 133 | return $this->headers->get($name, !$raw); |
| d311d8 | 134 | } |
| A | 135 | |
| 2ae58f | 136 | |
| d311d8 | 137 | /** |
| A | 138 | * Set is_safe var and session data |
| 139 | * | |
| 5c461b | 140 | * @param bool $safe enable/disable |
| d311d8 | 141 | */ |
| A | 142 | public function set_safe($safe = true) |
| 143 | { | |
| f11142 | 144 | $_SESSION['safe_messages'][$this->folder.':'.$this->uid] = $this->is_safe = $safe; |
| d311d8 | 145 | } |
| A | 146 | |
| 147 | ||
| 148 | /** | |
| 149 | * Compose a valid URL for getting a message part | |
| 150 | * | |
| 5c461b | 151 | * @param string $mime_id Part MIME-ID |
| a021d6 | 152 | * @param mixed $embed Mimetype class for parts to be embedded |
| d311d8 | 153 | * @return string URL or false if part does not exist |
| A | 154 | */ |
| 57486f | 155 | public function get_part_url($mime_id, $embed = false) |
| d311d8 | 156 | { |
| A | 157 | if ($this->mime_parts[$mime_id]) |
| a021d6 | 158 | return $this->opt['get_url'] . '&_part=' . $mime_id . ($embed ? '&_embed=1&_mimeclass=' . $embed : ''); |
| aa16b4 | 159 | else |
| d311d8 | 160 | return false; |
| 8fa58e | 161 | } |
| T | 162 | |
| d311d8 | 163 | |
| A | 164 | /** |
| 165 | * Get content of a specific part of this message | |
| 166 | * | |
| 71950d | 167 | * @param string $mime_id Part MIME-ID |
| A | 168 | * @param resource $fp File pointer to save the message part |
| 169 | * @param boolean $skip_charset_conv Disables charset conversion | |
| dff2c7 | 170 | * @param int $max_bytes Only read this number of bytes |
| 71950d | 171 | * |
| d311d8 | 172 | * @return string Part content |
| A | 173 | */ |
| dff2c7 | 174 | public function get_part_content($mime_id, $fp = null, $skip_charset_conv = false, $max_bytes = 0) |
| d311d8 | 175 | { |
| A | 176 | if ($part = $this->mime_parts[$mime_id]) { |
| 177 | // stored in message structure (winmail/inline-uuencode) | |
| 8b92d2 | 178 | if (!empty($part->body) || $part->encoding == 'stream') { |
| d311d8 | 179 | if ($fp) { |
| A | 180 | fwrite($fp, $part->body); |
| 181 | } | |
| 182 | return $fp ? true : $part->body; | |
| 183 | } | |
| 10562d | 184 | |
| d311d8 | 185 | // get from IMAP |
| 10562d | 186 | $this->storage->set_folder($this->folder); |
| AM | 187 | |
| dff2c7 | 188 | return $this->storage->get_message_part($this->uid, $mime_id, $part, NULL, $fp, $skip_charset_conv, $max_bytes); |
| 10562d | 189 | } |
| 8fa58e | 190 | } |
| T | 191 | |
| 192 | ||
| d311d8 | 193 | /** |
| 5c26bd | 194 | * Determine if the message contains a HTML part. This must to be |
| AM | 195 | * a real part not an attachment (or its part) |
| 196 | * This must to be | |
| 197 | * a real part not an attachment (or its part) | |
| d311d8 | 198 | * |
| 5c26bd | 199 | * @param bool $enriched Enables checking for text/enriched parts too |
| 33423a | 200 | * |
| d311d8 | 201 | * @return bool True if a HTML is available, False if not |
| A | 202 | */ |
| 5c26bd | 203 | function has_html_part($enriched = false) |
| d311d8 | 204 | { |
| A | 205 | // check all message parts |
| 574928 | 206 | foreach ($this->mime_parts as $part) { |
| 52d0d9 | 207 | if ($part->mimetype == 'text/html' || ($enriched && $part->mimetype == 'text/enriched')) { |
| 0ef894 | 208 | // Skip if part is an attachment, don't use is_attachment() here |
| AM | 209 | if ($part->filename) { |
| 5c26bd | 210 | continue; |
| AM | 211 | } |
| 33423a | 212 | |
| 5c26bd | 213 | $level = explode('.', $part->mime_id); |
| AM | 214 | |
| 215 | // Check if the part belongs to higher-level's alternative/related | |
| 216 | while (array_pop($level) !== null) { | |
| 217 | if (!count($level)) { | |
| 218 | return true; | |
| 33423a | 219 | } |
| A | 220 | |
| 5c26bd | 221 | $parent = $this->mime_parts[join('.', $level)]; |
| AM | 222 | if ($parent->mimetype != 'multipart/alternative' && $parent->mimetype != 'multipart/related') { |
| 223 | continue 2; | |
| 33423a | 224 | } |
| A | 225 | } |
| 226 | ||
| 5c26bd | 227 | if ($part->size) { |
| AM | 228 | return true; |
| 229 | } | |
| 230 | } | |
| 231 | } | |
| 232 | ||
| 233 | return false; | |
| 234 | } | |
| 235 | ||
| 236 | ||
| 237 | /** | |
| 238 | * Determine if the message contains a text/plain part. This must to be | |
| 239 | * a real part not an attachment (or its part) | |
| 240 | * | |
| 241 | * @return bool True if a plain text part is available, False if not | |
| 242 | */ | |
| 243 | function has_text_part() | |
| 244 | { | |
| 245 | // check all message parts | |
| 574928 | 246 | foreach ($this->mime_parts as $part) { |
| 5c26bd | 247 | if ($part->mimetype == 'text/plain') { |
| 0ef894 | 248 | // Skip if part is an attachment, don't use is_attachment() here |
| AM | 249 | if ($part->filename) { |
| 5c26bd | 250 | continue; |
| AM | 251 | } |
| 252 | ||
| 253 | $level = explode('.', $part->mime_id); | |
| 254 | ||
| 255 | // Check if the part belongs to higher-level's alternative/related | |
| 256 | while (array_pop($level) !== null) { | |
| 257 | if (!count($level)) { | |
| 258 | return true; | |
| 259 | } | |
| 260 | ||
| 261 | $parent = $this->mime_parts[join('.', $level)]; | |
| 262 | if ($parent->mimetype != 'multipart/alternative' && $parent->mimetype != 'multipart/related') { | |
| 263 | continue 2; | |
| 264 | } | |
| 265 | } | |
| 266 | ||
| 267 | if ($part->size) { | |
| 268 | return true; | |
| 269 | } | |
| 33423a | 270 | } |
| d311d8 | 271 | } |
| A | 272 | |
| 273 | return false; | |
| 274 | } | |
| 275 | ||
| 276 | ||
| 277 | /** | |
| 278 | * Return the first HTML part of this message | |
| 279 | * | |
| 280 | * @return string HTML message part content | |
| 281 | */ | |
| 282 | function first_html_part() | |
| 283 | { | |
| 284 | // check all message parts | |
| 33423a | 285 | foreach ($this->mime_parts as $pid => $part) { |
| A | 286 | if ($part->mimetype == 'text/html') { |
| 287 | return $this->get_part_content($pid); | |
| d311d8 | 288 | } |
| A | 289 | } |
| 290 | } | |
| 291 | ||
| 292 | ||
| 293 | /** | |
| 294 | * Return the first text part of this message | |
| 295 | * | |
| 868deb | 296 | * @param rcube_message_part $part Reference to the part if found |
| d311d8 | 297 | * @return string Plain text message/part content |
| A | 298 | */ |
| 868deb | 299 | function first_text_part(&$part=null) |
| d311d8 | 300 | { |
| A | 301 | // no message structure, return complete body |
| 302 | if (empty($this->parts)) | |
| 303 | return $this->body; | |
| 304 | ||
| 305 | // check all message parts | |
| 306 | foreach ($this->mime_parts as $mime_id => $part) { | |
| 33423a | 307 | if ($part->mimetype == 'text/plain') { |
| 8b92d2 | 308 | return $this->get_part_content($mime_id); |
| d311d8 | 309 | } |
| 33423a | 310 | else if ($part->mimetype == 'text/html') { |
| 8b92d2 | 311 | $out = $this->get_part_content($mime_id); |
| d311d8 | 312 | |
| A | 313 | // create instance of html2text class |
| 66afd7 | 314 | $txt = new rcube_html2text($out); |
| 868deb | 315 | return $txt->get_text(); |
| d311d8 | 316 | } |
| A | 317 | } |
| 318 | ||
| 868deb | 319 | $part = null; |
| A | 320 | return null; |
| d311d8 | 321 | } |
| A | 322 | |
| 323 | ||
| 324 | /** | |
| 3efc74 | 325 | * Checks if part of the message is an attachment (or part of it) |
| AM | 326 | * |
| 327 | * @param rcube_message_part $part Message part | |
| 328 | * | |
| 329 | * @return bool True if the part is an attachment part | |
| 330 | */ | |
| 331 | public function is_attachment($part) | |
| 332 | { | |
| 333 | foreach ($this->attachments as $att_part) { | |
| 334 | if ($att_part->mime_id == $part->mime_id) { | |
| 335 | return true; | |
| 336 | } | |
| 337 | ||
| 338 | // check if the part is a subpart of another attachment part (message/rfc822) | |
| 339 | if ($att_part->mimetype == 'message/rfc822') { | |
| 340 | if (in_array($part, (array)$att_part->parts)) { | |
| 341 | return true; | |
| 342 | } | |
| 343 | } | |
| 344 | } | |
| 345 | ||
| 346 | return false; | |
| 347 | } | |
| 348 | ||
| 349 | ||
| 350 | /** | |
| 8b92d2 | 351 | * Read the message structure returend by the IMAP server |
| d311d8 | 352 | * and build flat lists of content parts and attachments |
| A | 353 | * |
| 5c461b | 354 | * @param rcube_message_part $structure Message structure node |
| A | 355 | * @param bool $recursive True when called recursively |
| d311d8 | 356 | */ |
| A | 357 | private function parse_structure($structure, $recursive = false) |
| 358 | { | |
| 359 | // real content-type of message/rfc822 part | |
| a8a72e | 360 | if ($structure->mimetype == 'message/rfc822' && $structure->real_mimetype) { |
| 5ced9c | 361 | $mimetype = $structure->real_mimetype; |
| a8a72e | 362 | |
| TB | 363 | // parse headers from message/rfc822 part |
| 7ae7cd | 364 | if (!isset($structure->headers['subject']) && !isset($structure->headers['from'])) { |
| 4f9edb | 365 | list($headers, $dump) = explode("\r\n\r\n", $this->get_part_content($structure->mime_id, null, true, 8192)); |
| a8a72e | 366 | $structure->headers = rcube_mime::parse_headers($headers); |
| TB | 367 | } |
| 368 | } | |
| 5ced9c | 369 | else |
| A | 370 | $mimetype = $structure->mimetype; |
| d311d8 | 371 | |
| A | 372 | // show message headers |
| 7ae7cd | 373 | if ($recursive && is_array($structure->headers) && (isset($structure->headers['subject']) || isset($structure->headers['from']))) { |
| d311d8 | 374 | $c = new stdClass; |
| A | 375 | $c->type = 'headers'; |
| c5d7c9 | 376 | $c->headers = $structure->headers; |
| d311d8 | 377 | $this->parts[] = $c; |
| A | 378 | } |
| 5ced9c | 379 | |
| A | 380 | // Allow plugins to handle message parts |
| 381 | $plugin = $this->app->plugins->exec_hook('message_part_structure', | |
| 382 | array('object' => $this, 'structure' => $structure, | |
| 383 | 'mimetype' => $mimetype, 'recursive' => $recursive)); | |
| 384 | ||
| 385 | if ($plugin['abort']) | |
| 386 | return; | |
| 387 | ||
| 388 | $structure = $plugin['structure']; | |
| 389 | list($message_ctype_primary, $message_ctype_secondary) = explode('/', $plugin['mimetype']); | |
| d311d8 | 390 | |
| A | 391 | // print body if message doesn't have multiple parts |
| 392 | if ($message_ctype_primary == 'text' && !$recursive) { | |
| c23dc8 | 393 | // parts with unsupported type add to attachments list |
| AM | 394 | if (!in_array($message_ctype_secondary, array('plain', 'html', 'enriched'))) { |
| 395 | $this->attachments[] = $structure; | |
| 396 | return; | |
| 397 | } | |
| 398 | ||
| d311d8 | 399 | $structure->type = 'content'; |
| c5d7c9 | 400 | $this->parts[] = $structure; |
| 8757f5 | 401 | |
| d311d8 | 402 | // Parse simple (plain text) message body |
| c23dc8 | 403 | if ($message_ctype_secondary == 'plain') { |
| d311d8 | 404 | foreach ((array)$this->uu_decode($structure) as $uupart) { |
| A | 405 | $this->mime_parts[$uupart->mime_id] = $uupart; |
| 406 | $this->attachments[] = $uupart; | |
| 407 | } | |
| c23dc8 | 408 | } |
| d311d8 | 409 | } |
| A | 410 | // the same for pgp signed messages |
| 411 | else if ($mimetype == 'application/pgp' && !$recursive) { | |
| 412 | $structure->type = 'content'; | |
| c5d7c9 | 413 | $this->parts[] = $structure; |
| d311d8 | 414 | } |
| e730cd | 415 | // message contains (more than one!) alternative parts |
| A | 416 | else if ($mimetype == 'multipart/alternative' |
| 417 | && is_array($structure->parts) && count($structure->parts) > 1 | |
| 418 | ) { | |
| c5d7c9 | 419 | $plain_part = null; |
| AM | 420 | $html_part = null; |
| 421 | $print_part = null; | |
| 422 | $related_part = null; | |
| 423 | $attach_part = null; | |
| d311d8 | 424 | |
| c5d7c9 | 425 | // get html/plaintext parts, other add to attachments list |
| d311d8 | 426 | foreach ($structure->parts as $p => $sub_part) { |
| A | 427 | $sub_mimetype = $sub_part->mimetype; |
| cb0f03 | 428 | $is_multipart = preg_match('/^multipart\/(related|relative|mixed|alternative)/', $sub_mimetype); |
| 8757f5 | 429 | |
| 5fbfde | 430 | // skip empty text parts |
| c5d7c9 | 431 | if (!$sub_part->size && !$is_multipart) { |
| 5f4095 | 432 | continue; |
| 5fbfde | 433 | } |
| 5f4095 | 434 | |
| d311d8 | 435 | // check if sub part is |
| c5d7c9 | 436 | if ($is_multipart) |
| AM | 437 | $related_part = $p; |
| 438 | else if ($sub_mimetype == 'text/plain') | |
| d311d8 | 439 | $plain_part = $p; |
| A | 440 | else if ($sub_mimetype == 'text/html') |
| 441 | $html_part = $p; | |
| 442 | else if ($sub_mimetype == 'text/enriched') | |
| 443 | $enriched_part = $p; | |
| c5d7c9 | 444 | else |
| AM | 445 | $attach_part = $p; |
| d311d8 | 446 | } |
| A | 447 | |
| 448 | // parse related part (alternative part could be in here) | |
| 449 | if ($related_part !== null && !$this->parse_alternative) { | |
| 450 | $this->parse_alternative = true; | |
| 451 | $this->parse_structure($structure->parts[$related_part], true); | |
| 452 | $this->parse_alternative = false; | |
| 8757f5 | 453 | |
| d311d8 | 454 | // if plain part was found, we should unset it if html is preferred |
| A | 455 | if ($this->opt['prefer_html'] && count($this->parts)) |
| 456 | $plain_part = null; | |
| 457 | } | |
| 458 | ||
| 459 | // choose html/plain part to print | |
| 460 | if ($html_part !== null && $this->opt['prefer_html']) { | |
| c5d7c9 | 461 | $print_part = $structure->parts[$html_part]; |
| d311d8 | 462 | } |
| A | 463 | else if ($enriched_part !== null) { |
| c5d7c9 | 464 | $print_part = $structure->parts[$enriched_part]; |
| d311d8 | 465 | } |
| A | 466 | else if ($plain_part !== null) { |
| c5d7c9 | 467 | $print_part = $structure->parts[$plain_part]; |
| d311d8 | 468 | } |
| A | 469 | |
| 470 | // add the right message body | |
| 471 | if (is_object($print_part)) { | |
| 472 | $print_part->type = 'content'; | |
| 473 | $this->parts[] = $print_part; | |
| 474 | } | |
| 475 | // show plaintext warning | |
| 476 | else if ($html_part !== null && empty($this->parts)) { | |
| 477 | $c = new stdClass; | |
| 478 | $c->type = 'content'; | |
| 479 | $c->ctype_primary = 'text'; | |
| 480 | $c->ctype_secondary = 'plain'; | |
| 0c2596 | 481 | $c->mimetype = 'text/plain'; |
| A | 482 | $c->realtype = 'text/html'; |
| d311d8 | 483 | |
| A | 484 | $this->parts[] = $c; |
| 485 | } | |
| 486 | ||
| c5d7c9 | 487 | // add unsupported/unrecognized parts to attachments list |
| AM | 488 | if ($attach_part) { |
| 489 | $this->attachments[] = $structure->parts[$attach_part]; | |
| d311d8 | 490 | } |
| A | 491 | } |
| 492 | // this is an ecrypted message -> create a plaintext body with the according message | |
| 493 | else if ($mimetype == 'multipart/encrypted') { | |
| 494 | $p = new stdClass; | |
| 495 | $p->type = 'content'; | |
| 496 | $p->ctype_primary = 'text'; | |
| 497 | $p->ctype_secondary = 'plain'; | |
| 0c2596 | 498 | $p->mimetype = 'text/plain'; |
| A | 499 | $p->realtype = 'multipart/encrypted'; |
| c054ec | 500 | |
| A | 501 | $this->parts[] = $p; |
| d311d8 | 502 | } |
| ee89c6 | 503 | // this is an S/MIME ecrypted message -> create a plaintext body with the according message |
| AM | 504 | else if ($mimetype == 'application/pkcs7-mime') { |
| 505 | $p = new stdClass; | |
| 506 | $p->type = 'content'; | |
| 507 | $p->ctype_primary = 'text'; | |
| 508 | $p->ctype_secondary = 'plain'; | |
| 509 | $p->mimetype = 'text/plain'; | |
| 510 | $p->realtype = 'application/pkcs7-mime'; | |
| 511 | ||
| 512 | $this->parts[] = $p; | |
| 513 | } | |
| d311d8 | 514 | // message contains multiple parts |
| A | 515 | else if (is_array($structure->parts) && !empty($structure->parts)) { |
| 516 | // iterate over parts | |
| 517 | for ($i=0; $i < count($structure->parts); $i++) { | |
| 518 | $mail_part = &$structure->parts[$i]; | |
| 519 | $primary_type = $mail_part->ctype_primary; | |
| 520 | $secondary_type = $mail_part->ctype_secondary; | |
| 8fa58e | 521 | |
| d311d8 | 522 | // real content-type of message/rfc822 |
| A | 523 | if ($mail_part->real_mimetype) { |
| 524 | $part_orig_mimetype = $mail_part->mimetype; | |
| 525 | $part_mimetype = $mail_part->real_mimetype; | |
| 526 | list($primary_type, $secondary_type) = explode('/', $part_mimetype); | |
| 527 | } | |
| 528 | else | |
| 529 | $part_mimetype = $mail_part->mimetype; | |
| 6b6f2e | 530 | |
| d311d8 | 531 | // multipart/alternative |
| A | 532 | if ($primary_type == 'multipart') { |
| 533 | $this->parse_structure($mail_part, true); | |
| 534 | ||
| 535 | // list message/rfc822 as attachment as well (mostly .eml) | |
| 536 | if ($part_orig_mimetype == 'message/rfc822' && !empty($mail_part->filename)) | |
| 537 | $this->attachments[] = $mail_part; | |
| 538 | } | |
| f22ea7 | 539 | // part text/[plain|html] or delivery status |
| d311d8 | 540 | else if ((($part_mimetype == 'text/plain' || $part_mimetype == 'text/html') && $mail_part->disposition != 'attachment') || |
| f22ea7 | 541 | in_array($part_mimetype, array('message/delivery-status', 'text/rfc822-headers', 'message/disposition-notification')) |
| d311d8 | 542 | ) { |
| 1a2f83 | 543 | // Allow plugins to handle also this part |
| A | 544 | $plugin = $this->app->plugins->exec_hook('message_part_structure', |
| 545 | array('object' => $this, 'structure' => $mail_part, | |
| 546 | 'mimetype' => $part_mimetype, 'recursive' => true)); | |
| 547 | ||
| 548 | if ($plugin['abort']) | |
| 549 | continue; | |
| 550 | ||
| 9c299e | 551 | if ($part_mimetype == 'text/html' && $mail_part->size) { |
| 63f9de | 552 | $got_html_part = true; |
| A | 553 | } |
| 554 | ||
| 1a2f83 | 555 | $mail_part = $plugin['structure']; |
| A | 556 | list($primary_type, $secondary_type) = explode('/', $plugin['mimetype']); |
| 557 | ||
| d311d8 | 558 | // add text part if it matches the prefs |
| A | 559 | if (!$this->parse_alternative || |
| 560 | ($secondary_type == 'html' && $this->opt['prefer_html']) || | |
| 561 | ($secondary_type == 'plain' && !$this->opt['prefer_html']) | |
| 562 | ) { | |
| 563 | $mail_part->type = 'content'; | |
| 564 | $this->parts[] = $mail_part; | |
| 565 | } | |
| fd371a | 566 | |
| d311d8 | 567 | // list as attachment as well |
| f7c11e | 568 | if (!empty($mail_part->filename)) { |
| AM | 569 | $this->attachments[] = $mail_part; |
| 570 | } | |
| d311d8 | 571 | } |
| A | 572 | // part message/* |
| 8757f5 | 573 | else if ($primary_type == 'message') { |
| d311d8 | 574 | $this->parse_structure($mail_part, true); |
| A | 575 | |
| 576 | // list as attachment as well (mostly .eml) | |
| 577 | if (!empty($mail_part->filename)) | |
| 578 | $this->attachments[] = $mail_part; | |
| 579 | } | |
| 580 | // ignore "virtual" protocol parts | |
| 581 | else if ($primary_type == 'protocol') { | |
| 582 | continue; | |
| 583 | } | |
| 584 | // part is Microsoft Outlook TNEF (winmail.dat) | |
| 585 | else if ($part_mimetype == 'application/ms-tnef') { | |
| 586 | foreach ((array)$this->tnef_decode($mail_part) as $tpart) { | |
| 587 | $this->mime_parts[$tpart->mime_id] = $tpart; | |
| 588 | $this->attachments[] = $tpart; | |
| 589 | } | |
| 590 | } | |
| 591 | // part is a file/attachment | |
| 592 | else if (preg_match('/^(inline|attach)/', $mail_part->disposition) || | |
| 8794f1 | 593 | $mail_part->headers['content-id'] || |
| A | 594 | ($mail_part->filename && |
| 595 | (empty($mail_part->disposition) || preg_match('/^[a-z0-9!#$&.+^_-]+$/i', $mail_part->disposition))) | |
| d311d8 | 596 | ) { |
| A | 597 | // skip apple resource forks |
| 598 | if ($message_ctype_secondary == 'appledouble' && $secondary_type == 'applefile') | |
| 599 | continue; | |
| 600 | ||
| 601 | // part belongs to a related message and is linked | |
| cb0f03 | 602 | if (preg_match('/^multipart\/(related|relative)/', $mimetype) |
| d311d8 | 603 | && ($mail_part->headers['content-id'] || $mail_part->headers['content-location'])) { |
| A | 604 | if ($mail_part->headers['content-id']) |
| 605 | $mail_part->content_id = preg_replace(array('/^</', '/>$/'), '', $mail_part->headers['content-id']); | |
| 606 | if ($mail_part->headers['content-location']) | |
| 607 | $mail_part->content_location = $mail_part->headers['content-base'] . $mail_part->headers['content-location']; | |
| 608 | ||
| 609 | $this->inline_parts[] = $mail_part; | |
| 610 | } | |
| 611 | // attachment encapsulated within message/rfc822 part needs further decoding (#1486743) | |
| 612 | else if ($part_orig_mimetype == 'message/rfc822') { | |
| 613 | $this->parse_structure($mail_part, true); | |
| fd371a | 614 | |
| A | 615 | // list as attachment as well (mostly .eml) |
| 616 | if (!empty($mail_part->filename)) | |
| 617 | $this->attachments[] = $mail_part; | |
| d311d8 | 618 | } |
| b38925 | 619 | // regular attachment with valid content type |
| A | 620 | // (content-type name regexp according to RFC4288.4.2) |
| 2ae58f | 621 | else if (preg_match('/^[a-z0-9!#$&.+^_-]+\/[a-z0-9!#$&.+^_-]+$/i', $part_mimetype)) { |
| b38925 | 622 | $this->attachments[] = $mail_part; |
| A | 623 | } |
| 624 | // attachment with invalid content type | |
| 625 | // replace malformed content type with application/octet-stream (#1487767) | |
| 626 | else if ($mail_part->filename) { | |
| 627 | $mail_part->ctype_primary = 'application'; | |
| 628 | $mail_part->ctype_secondary = 'octet-stream'; | |
| 629 | $mail_part->mimetype = 'application/octet-stream'; | |
| 630 | ||
| d311d8 | 631 | $this->attachments[] = $mail_part; |
| A | 632 | } |
| 633 | } | |
| 8757f5 | 634 | // attachment part as message/rfc822 (#1488026) |
| A | 635 | else if ($mail_part->mimetype == 'message/rfc822') { |
| 636 | $this->parse_structure($mail_part); | |
| 637 | } | |
| d311d8 | 638 | } |
| A | 639 | |
| 640 | // if this was a related part try to resolve references | |
| cb0f03 | 641 | if (preg_match('/^multipart\/(related|relative)/', $mimetype) && sizeof($this->inline_parts)) { |
| d311d8 | 642 | $a_replaces = array(); |
| 89d19c | 643 | $img_regexp = '/^image\/(gif|jpe?g|png|tiff|bmp|svg)/'; |
| d311d8 | 644 | |
| A | 645 | foreach ($this->inline_parts as $inline_object) { |
| a021d6 | 646 | $part_url = $this->get_part_url($inline_object->mime_id, $inline_object->ctype_primary); |
| 8cfba1 | 647 | if (isset($inline_object->content_id)) |
| d311d8 | 648 | $a_replaces['cid:'.$inline_object->content_id] = $part_url; |
| 63f9de | 649 | if ($inline_object->content_location) { |
| d311d8 | 650 | $a_replaces[$inline_object->content_location] = $part_url; |
| 63f9de | 651 | } |
| 89d19c | 652 | |
| A | 653 | if (!empty($inline_object->filename)) { |
| 654 | // MS Outlook sends sometimes non-related attachments as related | |
| 655 | // In this case multipart/related message has only one text part | |
| 656 | // We'll add all such attachments to the attachments list | |
| 657 | if (!isset($got_html_part) && empty($inline_object->content_id)) { | |
| 658 | $this->attachments[] = $inline_object; | |
| 659 | } | |
| 660 | // MS Outlook sometimes also adds non-image attachments as related | |
| 661 | // We'll add all such attachments to the attachments list | |
| 662 | // Warning: some browsers support pdf in <img/> | |
| 663 | else if (!preg_match($img_regexp, $inline_object->mimetype)) { | |
| 664 | $this->attachments[] = $inline_object; | |
| 665 | } | |
| 666 | // @TODO: we should fetch HTML body and find attachment's content-id | |
| 667 | // to handle also image attachments without reference in the body | |
| 668 | // @TODO: should we list all image attachments in text mode? | |
| 02b6e6 | 669 | } |
| d311d8 | 670 | } |
| A | 671 | |
| 672 | // add replace array to each content part | |
| 673 | // (will be applied later when part body is available) | |
| 674 | foreach ($this->parts as $i => $part) { | |
| 675 | if ($part->type == 'content') | |
| 676 | $this->parts[$i]->replaces = $a_replaces; | |
| 677 | } | |
| 678 | } | |
| 679 | } | |
| 680 | // message is a single part non-text | |
| 681 | else if ($structure->filename) { | |
| 682 | $this->attachments[] = $structure; | |
| 683 | } | |
| 3e58bf | 684 | // message is a single part non-text (without filename) |
| A | 685 | else if (preg_match('/application\//i', $mimetype)) { |
| 686 | $this->attachments[] = $structure; | |
| c5d7c9 | 687 | } |
| AM | 688 | } |
| 689 | ||
| 690 | ||
| 691 | /** | |
| d311d8 | 692 | * Fill aflat array with references to all parts, indexed by part numbers |
| A | 693 | * |
| 5c461b | 694 | * @param rcube_message_part $part Message body structure |
| d311d8 | 695 | */ |
| A | 696 | private function get_mime_numbers(&$part) |
| 697 | { | |
| 698 | if (strlen($part->mime_id)) | |
| 699 | $this->mime_parts[$part->mime_id] = &$part; | |
| f19d86 | 700 | |
| d311d8 | 701 | if (is_array($part->parts)) |
| A | 702 | for ($i=0; $i<count($part->parts); $i++) |
| 703 | $this->get_mime_numbers($part->parts[$i]); | |
| 704 | } | |
| 705 | ||
| 706 | ||
| 707 | /** | |
| 708 | * Decode a Microsoft Outlook TNEF part (winmail.dat) | |
| 709 | * | |
| 5c461b | 710 | * @param rcube_message_part $part Message part to decode |
| A | 711 | * @return array |
| d311d8 | 712 | */ |
| A | 713 | function tnef_decode(&$part) |
| 714 | { | |
| 715 | // @TODO: attachment may be huge, hadle it via file | |
| 10562d | 716 | if (!isset($part->body)) { |
| AM | 717 | $this->storage->set_folder($this->folder); |
| c321a9 | 718 | $part->body = $this->storage->get_message_part($this->uid, $part->mime_id, $part); |
| 10562d | 719 | } |
| d311d8 | 720 | |
| A | 721 | $parts = array(); |
| f19d86 | 722 | $tnef = new tnef_decoder; |
| A | 723 | $tnef_arr = $tnef->decompress($part->body); |
| d311d8 | 724 | |
| A | 725 | foreach ($tnef_arr as $pid => $winatt) { |
| 726 | $tpart = new rcube_message_part; | |
| 727 | ||
| 728 | $tpart->filename = trim($winatt['name']); | |
| 729 | $tpart->encoding = 'stream'; | |
| f19d86 | 730 | $tpart->ctype_primary = trim(strtolower($winatt['type'])); |
| A | 731 | $tpart->ctype_secondary = trim(strtolower($winatt['subtype'])); |
| d311d8 | 732 | $tpart->mimetype = $tpart->ctype_primary . '/' . $tpart->ctype_secondary; |
| A | 733 | $tpart->mime_id = 'winmail.' . $part->mime_id . '.' . $pid; |
| 734 | $tpart->size = $winatt['size']; | |
| 735 | $tpart->body = $winatt['stream']; | |
| 736 | ||
| 737 | $parts[] = $tpart; | |
| 738 | unset($tnef_arr[$pid]); | |
| 739 | } | |
| f19d86 | 740 | |
| d311d8 | 741 | return $parts; |
| A | 742 | } |
| 743 | ||
| 744 | ||
| 745 | /** | |
| 746 | * Parse message body for UUencoded attachments bodies | |
| 747 | * | |
| 5c461b | 748 | * @param rcube_message_part $part Message part to decode |
| A | 749 | * @return array |
| d311d8 | 750 | */ |
| A | 751 | function uu_decode(&$part) |
| 752 | { | |
| 753 | // @TODO: messages may be huge, hadle body via file | |
| 10562d | 754 | if (!isset($part->body)) { |
| AM | 755 | $this->storage->set_folder($this->folder); |
| c321a9 | 756 | $part->body = $this->storage->get_message_part($this->uid, $part->mime_id, $part); |
| 10562d | 757 | } |
| d311d8 | 758 | |
| A | 759 | $parts = array(); |
| 760 | // FIXME: line length is max.65? | |
| 14f22f | 761 | $uu_regexp = '/begin [0-7]{3,4} ([^\n]+)\n/s'; |
| d311d8 | 762 | |
| A | 763 | if (preg_match_all($uu_regexp, $part->body, $matches, PREG_SET_ORDER)) { |
| 764 | // update message content-type | |
| 765 | $part->ctype_primary = 'multipart'; | |
| 766 | $part->ctype_secondary = 'mixed'; | |
| 767 | $part->mimetype = $part->ctype_primary . '/' . $part->ctype_secondary; | |
| 14f22f | 768 | $uu_endstring = "`\nend\n"; |
| d311d8 | 769 | |
| A | 770 | // add attachments to the structure |
| 771 | foreach ($matches as $pid => $att) { | |
| 14f22f | 772 | $startpos = strpos($part->body, $att[1]) + strlen($att[1]) + 1; // "\n" |
| GB | 773 | $endpos = strpos($part->body, $uu_endstring); |
| 774 | $filebody = substr($part->body, $startpos, $endpos-$startpos); | |
| 775 | ||
| 776 | // remove attachments bodies from the message body | |
| 777 | $part->body = substr_replace($part->body, "", $startpos, $endpos+strlen($uu_endstring)-$startpos); | |
| 778 | ||
| d311d8 | 779 | $uupart = new rcube_message_part; |
| A | 780 | |
| 781 | $uupart->filename = trim($att[1]); | |
| 782 | $uupart->encoding = 'stream'; | |
| 14f22f | 783 | $uupart->body = convert_uudecode($filebody); |
| d311d8 | 784 | $uupart->size = strlen($uupart->body); |
| A | 785 | $uupart->mime_id = 'uu.' . $part->mime_id . '.' . $pid; |
| 786 | ||
| 0c2596 | 787 | $ctype = rcube_mime::content_type($uupart->body, $uupart->filename, 'application/octet-stream', true); |
| d311d8 | 788 | $uupart->mimetype = $ctype; |
| A | 789 | list($uupart->ctype_primary, $uupart->ctype_secondary) = explode('/', $ctype); |
| 790 | ||
| 791 | $parts[] = $uupart; | |
| 792 | unset($matches[$pid]); | |
| 793 | } | |
| 14f22f | 794 | |
| GB | 795 | // remove attachments bodies from the message body |
| 796 | $part->body = preg_replace($uu_regexp, '', $part->body); | |
| d311d8 | 797 | } |
| f19d86 | 798 | |
| d311d8 | 799 | return $parts; |
| A | 800 | } |
| b91f04 | 801 | |
| T | 802 | |
| 803 | /** | |
| 804 | * Deprecated methods (to be removed) | |
| 805 | */ | |
| 806 | ||
| 807 | public static function unfold_flowed($text) | |
| 808 | { | |
| 809 | return rcube_mime::unfold_flowed($text); | |
| 810 | } | |
| 811 | ||
| 812 | public static function format_flowed($text, $length = 72) | |
| 813 | { | |
| 814 | return rcube_mime::format_flowed($text, $length); | |
| 815 | } | |
| 816 | ||
| 8fa58e | 817 | } |
