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'])) { |
3725cf
|
365 |
list($headers, ) = explode("\r\n\r\n", $this->get_part_content($structure->mime_id, null, true, 32768)); |
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 |
ddfdd8
|
373 |
if ($recursive && is_array($structure->headers) && |
TB |
374 |
(isset($structure->headers['subject']) || $structure->headers['from'] || $structure->headers['to'])) { |
d311d8
|
375 |
$c = new stdClass; |
A |
376 |
$c->type = 'headers'; |
c5d7c9
|
377 |
$c->headers = $structure->headers; |
d311d8
|
378 |
$this->parts[] = $c; |
A |
379 |
} |
5ced9c
|
380 |
|
A |
381 |
// Allow plugins to handle message parts |
|
382 |
$plugin = $this->app->plugins->exec_hook('message_part_structure', |
|
383 |
array('object' => $this, 'structure' => $structure, |
|
384 |
'mimetype' => $mimetype, 'recursive' => $recursive)); |
|
385 |
|
|
386 |
if ($plugin['abort']) |
|
387 |
return; |
|
388 |
|
|
389 |
$structure = $plugin['structure']; |
|
390 |
list($message_ctype_primary, $message_ctype_secondary) = explode('/', $plugin['mimetype']); |
d311d8
|
391 |
|
A |
392 |
// print body if message doesn't have multiple parts |
|
393 |
if ($message_ctype_primary == 'text' && !$recursive) { |
c23dc8
|
394 |
// parts with unsupported type add to attachments list |
AM |
395 |
if (!in_array($message_ctype_secondary, array('plain', 'html', 'enriched'))) { |
|
396 |
$this->attachments[] = $structure; |
|
397 |
return; |
|
398 |
} |
|
399 |
|
d311d8
|
400 |
$structure->type = 'content'; |
c5d7c9
|
401 |
$this->parts[] = $structure; |
8757f5
|
402 |
|
d311d8
|
403 |
// Parse simple (plain text) message body |
c23dc8
|
404 |
if ($message_ctype_secondary == 'plain') { |
d311d8
|
405 |
foreach ((array)$this->uu_decode($structure) as $uupart) { |
A |
406 |
$this->mime_parts[$uupart->mime_id] = $uupart; |
|
407 |
$this->attachments[] = $uupart; |
|
408 |
} |
c23dc8
|
409 |
} |
d311d8
|
410 |
} |
A |
411 |
// the same for pgp signed messages |
|
412 |
else if ($mimetype == 'application/pgp' && !$recursive) { |
|
413 |
$structure->type = 'content'; |
c5d7c9
|
414 |
$this->parts[] = $structure; |
d311d8
|
415 |
} |
e730cd
|
416 |
// message contains (more than one!) alternative parts |
A |
417 |
else if ($mimetype == 'multipart/alternative' |
|
418 |
&& is_array($structure->parts) && count($structure->parts) > 1 |
|
419 |
) { |
c5d7c9
|
420 |
$plain_part = null; |
AM |
421 |
$html_part = null; |
|
422 |
$print_part = null; |
|
423 |
$related_part = null; |
|
424 |
$attach_part = null; |
d311d8
|
425 |
|
c5d7c9
|
426 |
// get html/plaintext parts, other add to attachments list |
d311d8
|
427 |
foreach ($structure->parts as $p => $sub_part) { |
A |
428 |
$sub_mimetype = $sub_part->mimetype; |
cb0f03
|
429 |
$is_multipart = preg_match('/^multipart\/(related|relative|mixed|alternative)/', $sub_mimetype); |
8757f5
|
430 |
|
5fbfde
|
431 |
// skip empty text parts |
c5d7c9
|
432 |
if (!$sub_part->size && !$is_multipart) { |
5f4095
|
433 |
continue; |
5fbfde
|
434 |
} |
5f4095
|
435 |
|
d311d8
|
436 |
// check if sub part is |
c5d7c9
|
437 |
if ($is_multipart) |
AM |
438 |
$related_part = $p; |
|
439 |
else if ($sub_mimetype == 'text/plain') |
d311d8
|
440 |
$plain_part = $p; |
A |
441 |
else if ($sub_mimetype == 'text/html') |
|
442 |
$html_part = $p; |
|
443 |
else if ($sub_mimetype == 'text/enriched') |
|
444 |
$enriched_part = $p; |
c5d7c9
|
445 |
else |
AM |
446 |
$attach_part = $p; |
d311d8
|
447 |
} |
A |
448 |
|
|
449 |
// parse related part (alternative part could be in here) |
|
450 |
if ($related_part !== null && !$this->parse_alternative) { |
|
451 |
$this->parse_alternative = true; |
|
452 |
$this->parse_structure($structure->parts[$related_part], true); |
|
453 |
$this->parse_alternative = false; |
8757f5
|
454 |
|
d311d8
|
455 |
// if plain part was found, we should unset it if html is preferred |
A |
456 |
if ($this->opt['prefer_html'] && count($this->parts)) |
|
457 |
$plain_part = null; |
|
458 |
} |
|
459 |
|
|
460 |
// choose html/plain part to print |
|
461 |
if ($html_part !== null && $this->opt['prefer_html']) { |
c5d7c9
|
462 |
$print_part = $structure->parts[$html_part]; |
d311d8
|
463 |
} |
A |
464 |
else if ($enriched_part !== null) { |
c5d7c9
|
465 |
$print_part = $structure->parts[$enriched_part]; |
d311d8
|
466 |
} |
A |
467 |
else if ($plain_part !== null) { |
c5d7c9
|
468 |
$print_part = $structure->parts[$plain_part]; |
d311d8
|
469 |
} |
A |
470 |
|
|
471 |
// add the right message body |
|
472 |
if (is_object($print_part)) { |
|
473 |
$print_part->type = 'content'; |
|
474 |
$this->parts[] = $print_part; |
|
475 |
} |
|
476 |
// show plaintext warning |
|
477 |
else if ($html_part !== null && empty($this->parts)) { |
|
478 |
$c = new stdClass; |
|
479 |
$c->type = 'content'; |
|
480 |
$c->ctype_primary = 'text'; |
|
481 |
$c->ctype_secondary = 'plain'; |
0c2596
|
482 |
$c->mimetype = 'text/plain'; |
A |
483 |
$c->realtype = 'text/html'; |
d311d8
|
484 |
|
A |
485 |
$this->parts[] = $c; |
|
486 |
} |
|
487 |
|
c5d7c9
|
488 |
// add unsupported/unrecognized parts to attachments list |
AM |
489 |
if ($attach_part) { |
|
490 |
$this->attachments[] = $structure->parts[$attach_part]; |
d311d8
|
491 |
} |
A |
492 |
} |
|
493 |
// this is an ecrypted message -> create a plaintext body with the according message |
|
494 |
else if ($mimetype == 'multipart/encrypted') { |
|
495 |
$p = new stdClass; |
|
496 |
$p->type = 'content'; |
|
497 |
$p->ctype_primary = 'text'; |
|
498 |
$p->ctype_secondary = 'plain'; |
0c2596
|
499 |
$p->mimetype = 'text/plain'; |
A |
500 |
$p->realtype = 'multipart/encrypted'; |
c054ec
|
501 |
|
A |
502 |
$this->parts[] = $p; |
d311d8
|
503 |
} |
ee89c6
|
504 |
// this is an S/MIME ecrypted message -> create a plaintext body with the according message |
AM |
505 |
else if ($mimetype == 'application/pkcs7-mime') { |
|
506 |
$p = new stdClass; |
|
507 |
$p->type = 'content'; |
|
508 |
$p->ctype_primary = 'text'; |
|
509 |
$p->ctype_secondary = 'plain'; |
|
510 |
$p->mimetype = 'text/plain'; |
|
511 |
$p->realtype = 'application/pkcs7-mime'; |
|
512 |
|
|
513 |
$this->parts[] = $p; |
|
514 |
} |
d311d8
|
515 |
// message contains multiple parts |
A |
516 |
else if (is_array($structure->parts) && !empty($structure->parts)) { |
|
517 |
// iterate over parts |
|
518 |
for ($i=0; $i < count($structure->parts); $i++) { |
|
519 |
$mail_part = &$structure->parts[$i]; |
|
520 |
$primary_type = $mail_part->ctype_primary; |
|
521 |
$secondary_type = $mail_part->ctype_secondary; |
8fa58e
|
522 |
|
d311d8
|
523 |
// real content-type of message/rfc822 |
A |
524 |
if ($mail_part->real_mimetype) { |
|
525 |
$part_orig_mimetype = $mail_part->mimetype; |
|
526 |
$part_mimetype = $mail_part->real_mimetype; |
|
527 |
list($primary_type, $secondary_type) = explode('/', $part_mimetype); |
|
528 |
} |
|
529 |
else |
|
530 |
$part_mimetype = $mail_part->mimetype; |
6b6f2e
|
531 |
|
d311d8
|
532 |
// multipart/alternative |
A |
533 |
if ($primary_type == 'multipart') { |
|
534 |
$this->parse_structure($mail_part, true); |
|
535 |
|
|
536 |
// list message/rfc822 as attachment as well (mostly .eml) |
|
537 |
if ($part_orig_mimetype == 'message/rfc822' && !empty($mail_part->filename)) |
|
538 |
$this->attachments[] = $mail_part; |
|
539 |
} |
f22ea7
|
540 |
// part text/[plain|html] or delivery status |
d311d8
|
541 |
else if ((($part_mimetype == 'text/plain' || $part_mimetype == 'text/html') && $mail_part->disposition != 'attachment') || |
f22ea7
|
542 |
in_array($part_mimetype, array('message/delivery-status', 'text/rfc822-headers', 'message/disposition-notification')) |
d311d8
|
543 |
) { |
1a2f83
|
544 |
// Allow plugins to handle also this part |
A |
545 |
$plugin = $this->app->plugins->exec_hook('message_part_structure', |
|
546 |
array('object' => $this, 'structure' => $mail_part, |
|
547 |
'mimetype' => $part_mimetype, 'recursive' => true)); |
|
548 |
|
|
549 |
if ($plugin['abort']) |
|
550 |
continue; |
|
551 |
|
9c299e
|
552 |
if ($part_mimetype == 'text/html' && $mail_part->size) { |
63f9de
|
553 |
$got_html_part = true; |
A |
554 |
} |
|
555 |
|
1a2f83
|
556 |
$mail_part = $plugin['structure']; |
A |
557 |
list($primary_type, $secondary_type) = explode('/', $plugin['mimetype']); |
|
558 |
|
d311d8
|
559 |
// add text part if it matches the prefs |
A |
560 |
if (!$this->parse_alternative || |
|
561 |
($secondary_type == 'html' && $this->opt['prefer_html']) || |
|
562 |
($secondary_type == 'plain' && !$this->opt['prefer_html']) |
|
563 |
) { |
|
564 |
$mail_part->type = 'content'; |
|
565 |
$this->parts[] = $mail_part; |
|
566 |
} |
fd371a
|
567 |
|
d311d8
|
568 |
// list as attachment as well |
f7c11e
|
569 |
if (!empty($mail_part->filename)) { |
AM |
570 |
$this->attachments[] = $mail_part; |
|
571 |
} |
d311d8
|
572 |
} |
A |
573 |
// part message/* |
8757f5
|
574 |
else if ($primary_type == 'message') { |
d311d8
|
575 |
$this->parse_structure($mail_part, true); |
A |
576 |
|
|
577 |
// list as attachment as well (mostly .eml) |
|
578 |
if (!empty($mail_part->filename)) |
|
579 |
$this->attachments[] = $mail_part; |
|
580 |
} |
|
581 |
// ignore "virtual" protocol parts |
|
582 |
else if ($primary_type == 'protocol') { |
|
583 |
continue; |
|
584 |
} |
|
585 |
// part is Microsoft Outlook TNEF (winmail.dat) |
|
586 |
else if ($part_mimetype == 'application/ms-tnef') { |
|
587 |
foreach ((array)$this->tnef_decode($mail_part) as $tpart) { |
|
588 |
$this->mime_parts[$tpart->mime_id] = $tpart; |
|
589 |
$this->attachments[] = $tpart; |
|
590 |
} |
|
591 |
} |
|
592 |
// part is a file/attachment |
|
593 |
else if (preg_match('/^(inline|attach)/', $mail_part->disposition) || |
8794f1
|
594 |
$mail_part->headers['content-id'] || |
A |
595 |
($mail_part->filename && |
|
596 |
(empty($mail_part->disposition) || preg_match('/^[a-z0-9!#$&.+^_-]+$/i', $mail_part->disposition))) |
d311d8
|
597 |
) { |
A |
598 |
// skip apple resource forks |
|
599 |
if ($message_ctype_secondary == 'appledouble' && $secondary_type == 'applefile') |
|
600 |
continue; |
|
601 |
|
|
602 |
// part belongs to a related message and is linked |
cb0f03
|
603 |
if (preg_match('/^multipart\/(related|relative)/', $mimetype) |
d311d8
|
604 |
&& ($mail_part->headers['content-id'] || $mail_part->headers['content-location'])) { |
A |
605 |
if ($mail_part->headers['content-id']) |
|
606 |
$mail_part->content_id = preg_replace(array('/^</', '/>$/'), '', $mail_part->headers['content-id']); |
|
607 |
if ($mail_part->headers['content-location']) |
|
608 |
$mail_part->content_location = $mail_part->headers['content-base'] . $mail_part->headers['content-location']; |
|
609 |
|
|
610 |
$this->inline_parts[] = $mail_part; |
|
611 |
} |
|
612 |
// attachment encapsulated within message/rfc822 part needs further decoding (#1486743) |
|
613 |
else if ($part_orig_mimetype == 'message/rfc822') { |
|
614 |
$this->parse_structure($mail_part, true); |
fd371a
|
615 |
|
A |
616 |
// list as attachment as well (mostly .eml) |
|
617 |
if (!empty($mail_part->filename)) |
|
618 |
$this->attachments[] = $mail_part; |
d311d8
|
619 |
} |
b38925
|
620 |
// regular attachment with valid content type |
A |
621 |
// (content-type name regexp according to RFC4288.4.2) |
2ae58f
|
622 |
else if (preg_match('/^[a-z0-9!#$&.+^_-]+\/[a-z0-9!#$&.+^_-]+$/i', $part_mimetype)) { |
b38925
|
623 |
$this->attachments[] = $mail_part; |
A |
624 |
} |
|
625 |
// attachment with invalid content type |
|
626 |
// replace malformed content type with application/octet-stream (#1487767) |
|
627 |
else if ($mail_part->filename) { |
|
628 |
$mail_part->ctype_primary = 'application'; |
|
629 |
$mail_part->ctype_secondary = 'octet-stream'; |
|
630 |
$mail_part->mimetype = 'application/octet-stream'; |
|
631 |
|
d311d8
|
632 |
$this->attachments[] = $mail_part; |
A |
633 |
} |
|
634 |
} |
8757f5
|
635 |
// attachment part as message/rfc822 (#1488026) |
A |
636 |
else if ($mail_part->mimetype == 'message/rfc822') { |
|
637 |
$this->parse_structure($mail_part); |
|
638 |
} |
d311d8
|
639 |
} |
A |
640 |
|
|
641 |
// if this was a related part try to resolve references |
cb0f03
|
642 |
if (preg_match('/^multipart\/(related|relative)/', $mimetype) && sizeof($this->inline_parts)) { |
d311d8
|
643 |
$a_replaces = array(); |
89d19c
|
644 |
$img_regexp = '/^image\/(gif|jpe?g|png|tiff|bmp|svg)/'; |
d311d8
|
645 |
|
A |
646 |
foreach ($this->inline_parts as $inline_object) { |
a021d6
|
647 |
$part_url = $this->get_part_url($inline_object->mime_id, $inline_object->ctype_primary); |
8cfba1
|
648 |
if (isset($inline_object->content_id)) |
d311d8
|
649 |
$a_replaces['cid:'.$inline_object->content_id] = $part_url; |
63f9de
|
650 |
if ($inline_object->content_location) { |
d311d8
|
651 |
$a_replaces[$inline_object->content_location] = $part_url; |
63f9de
|
652 |
} |
89d19c
|
653 |
|
A |
654 |
if (!empty($inline_object->filename)) { |
|
655 |
// MS Outlook sends sometimes non-related attachments as related |
|
656 |
// In this case multipart/related message has only one text part |
|
657 |
// We'll add all such attachments to the attachments list |
|
658 |
if (!isset($got_html_part) && empty($inline_object->content_id)) { |
|
659 |
$this->attachments[] = $inline_object; |
|
660 |
} |
|
661 |
// MS Outlook sometimes also adds non-image attachments as related |
|
662 |
// We'll add all such attachments to the attachments list |
|
663 |
// Warning: some browsers support pdf in <img/> |
|
664 |
else if (!preg_match($img_regexp, $inline_object->mimetype)) { |
|
665 |
$this->attachments[] = $inline_object; |
|
666 |
} |
|
667 |
// @TODO: we should fetch HTML body and find attachment's content-id |
|
668 |
// to handle also image attachments without reference in the body |
|
669 |
// @TODO: should we list all image attachments in text mode? |
02b6e6
|
670 |
} |
d311d8
|
671 |
} |
A |
672 |
|
|
673 |
// add replace array to each content part |
|
674 |
// (will be applied later when part body is available) |
|
675 |
foreach ($this->parts as $i => $part) { |
|
676 |
if ($part->type == 'content') |
|
677 |
$this->parts[$i]->replaces = $a_replaces; |
|
678 |
} |
|
679 |
} |
|
680 |
} |
|
681 |
// message is a single part non-text |
|
682 |
else if ($structure->filename) { |
|
683 |
$this->attachments[] = $structure; |
|
684 |
} |
3e58bf
|
685 |
// message is a single part non-text (without filename) |
A |
686 |
else if (preg_match('/application\//i', $mimetype)) { |
|
687 |
$this->attachments[] = $structure; |
c5d7c9
|
688 |
} |
AM |
689 |
} |
|
690 |
|
|
691 |
|
|
692 |
/** |
d311d8
|
693 |
* Fill aflat array with references to all parts, indexed by part numbers |
A |
694 |
* |
5c461b
|
695 |
* @param rcube_message_part $part Message body structure |
d311d8
|
696 |
*/ |
A |
697 |
private function get_mime_numbers(&$part) |
|
698 |
{ |
|
699 |
if (strlen($part->mime_id)) |
|
700 |
$this->mime_parts[$part->mime_id] = &$part; |
f19d86
|
701 |
|
d311d8
|
702 |
if (is_array($part->parts)) |
A |
703 |
for ($i=0; $i<count($part->parts); $i++) |
|
704 |
$this->get_mime_numbers($part->parts[$i]); |
|
705 |
} |
|
706 |
|
|
707 |
|
|
708 |
/** |
|
709 |
* Decode a Microsoft Outlook TNEF part (winmail.dat) |
|
710 |
* |
5c461b
|
711 |
* @param rcube_message_part $part Message part to decode |
A |
712 |
* @return array |
d311d8
|
713 |
*/ |
A |
714 |
function tnef_decode(&$part) |
|
715 |
{ |
|
716 |
// @TODO: attachment may be huge, hadle it via file |
10562d
|
717 |
if (!isset($part->body)) { |
AM |
718 |
$this->storage->set_folder($this->folder); |
c321a9
|
719 |
$part->body = $this->storage->get_message_part($this->uid, $part->mime_id, $part); |
10562d
|
720 |
} |
d311d8
|
721 |
|
A |
722 |
$parts = array(); |
f19d86
|
723 |
$tnef = new tnef_decoder; |
A |
724 |
$tnef_arr = $tnef->decompress($part->body); |
d311d8
|
725 |
|
A |
726 |
foreach ($tnef_arr as $pid => $winatt) { |
|
727 |
$tpart = new rcube_message_part; |
|
728 |
|
|
729 |
$tpart->filename = trim($winatt['name']); |
|
730 |
$tpart->encoding = 'stream'; |
f19d86
|
731 |
$tpart->ctype_primary = trim(strtolower($winatt['type'])); |
A |
732 |
$tpart->ctype_secondary = trim(strtolower($winatt['subtype'])); |
d311d8
|
733 |
$tpart->mimetype = $tpart->ctype_primary . '/' . $tpart->ctype_secondary; |
A |
734 |
$tpart->mime_id = 'winmail.' . $part->mime_id . '.' . $pid; |
|
735 |
$tpart->size = $winatt['size']; |
|
736 |
$tpart->body = $winatt['stream']; |
|
737 |
|
|
738 |
$parts[] = $tpart; |
|
739 |
unset($tnef_arr[$pid]); |
|
740 |
} |
f19d86
|
741 |
|
d311d8
|
742 |
return $parts; |
A |
743 |
} |
|
744 |
|
|
745 |
|
|
746 |
/** |
|
747 |
* Parse message body for UUencoded attachments bodies |
|
748 |
* |
5c461b
|
749 |
* @param rcube_message_part $part Message part to decode |
A |
750 |
* @return array |
d311d8
|
751 |
*/ |
A |
752 |
function uu_decode(&$part) |
|
753 |
{ |
|
754 |
// @TODO: messages may be huge, hadle body via file |
10562d
|
755 |
if (!isset($part->body)) { |
AM |
756 |
$this->storage->set_folder($this->folder); |
c321a9
|
757 |
$part->body = $this->storage->get_message_part($this->uid, $part->mime_id, $part); |
10562d
|
758 |
} |
d311d8
|
759 |
|
A |
760 |
$parts = array(); |
|
761 |
// FIXME: line length is max.65? |
14f22f
|
762 |
$uu_regexp = '/begin [0-7]{3,4} ([^\n]+)\n/s'; |
d311d8
|
763 |
|
A |
764 |
if (preg_match_all($uu_regexp, $part->body, $matches, PREG_SET_ORDER)) { |
|
765 |
// update message content-type |
|
766 |
$part->ctype_primary = 'multipart'; |
|
767 |
$part->ctype_secondary = 'mixed'; |
|
768 |
$part->mimetype = $part->ctype_primary . '/' . $part->ctype_secondary; |
14f22f
|
769 |
$uu_endstring = "`\nend\n"; |
d311d8
|
770 |
|
A |
771 |
// add attachments to the structure |
|
772 |
foreach ($matches as $pid => $att) { |
14f22f
|
773 |
$startpos = strpos($part->body, $att[1]) + strlen($att[1]) + 1; // "\n" |
GB |
774 |
$endpos = strpos($part->body, $uu_endstring); |
|
775 |
$filebody = substr($part->body, $startpos, $endpos-$startpos); |
|
776 |
|
|
777 |
// remove attachments bodies from the message body |
|
778 |
$part->body = substr_replace($part->body, "", $startpos, $endpos+strlen($uu_endstring)-$startpos); |
|
779 |
|
d311d8
|
780 |
$uupart = new rcube_message_part; |
A |
781 |
|
|
782 |
$uupart->filename = trim($att[1]); |
|
783 |
$uupart->encoding = 'stream'; |
14f22f
|
784 |
$uupart->body = convert_uudecode($filebody); |
d311d8
|
785 |
$uupart->size = strlen($uupart->body); |
A |
786 |
$uupart->mime_id = 'uu.' . $part->mime_id . '.' . $pid; |
|
787 |
|
0c2596
|
788 |
$ctype = rcube_mime::content_type($uupart->body, $uupart->filename, 'application/octet-stream', true); |
d311d8
|
789 |
$uupart->mimetype = $ctype; |
A |
790 |
list($uupart->ctype_primary, $uupart->ctype_secondary) = explode('/', $ctype); |
|
791 |
|
|
792 |
$parts[] = $uupart; |
|
793 |
unset($matches[$pid]); |
|
794 |
} |
14f22f
|
795 |
|
GB |
796 |
// remove attachments bodies from the message body |
|
797 |
$part->body = preg_replace($uu_regexp, '', $part->body); |
d311d8
|
798 |
} |
f19d86
|
799 |
|
d311d8
|
800 |
return $parts; |
A |
801 |
} |
b91f04
|
802 |
|
T |
803 |
|
|
804 |
/** |
|
805 |
* Deprecated methods (to be removed) |
|
806 |
*/ |
|
807 |
|
|
808 |
public static function unfold_flowed($text) |
|
809 |
{ |
|
810 |
return rcube_mime::unfold_flowed($text); |
|
811 |
} |
|
812 |
|
|
813 |
public static function format_flowed($text, $length = 72) |
|
814 |
{ |
|
815 |
return rcube_mime::format_flowed($text, $length); |
|
816 |
} |
|
817 |
|
8fa58e
|
818 |
} |