Retrieval typo
[squirrelmail.git] / functions / mime.php
CommitLineData
59177427 1<?php
aceb0d5c 2 /** mime.php
3 **
d068c0ec 4 ** This contains the functions necessary to detect and decode MIME
5 ** messages.
6 **
245a6892 7 ** $Id$
aceb0d5c 8 **/
b74ba498 9
f435778e 10 if (defined('mime_php'))
11 return;
12 define('mime_php', true);
aceb0d5c 13
0fc2aca0 14 require_once('../functions/imap.php');
8beafbbc 15
cbcf32f6 16 /** Setting up the objects that have the structure for the message **/
8beafbbc 17
18 class msg_header {
19 /** msg_header contains generic variables for values that **/
20 /** could be in a header. **/
b74ba498 21
245a6892 22 var $type0 = '', $type1 = '', $boundary = '', $charset = '';
40023540 23 var $encoding = '', $size = 0, $to = array(), $from = '', $date = '';
24 var $cc = array(), $bcc = array(), $reply_to = '', $subject = '';
61423189 25 var $id = 0, $mailbox = '', $description = '', $filename = '';
66e1a00e 26 var $entity_id = 0, $message_id = 0, $name = '';
8beafbbc 27 }
b74ba498 28
8beafbbc 29 class message {
30 /** message is the object that contains messages. It is a recursive
b74ba498 31 object in that through the $entities variable, it can contain
8beafbbc 32 more objects of type message. See documentation in mime.txt for
33 a better description of how this works.
b74ba498 34 **/
61423189 35 var $header = '';
2df6ca53 36 var $entities = array();
b74ba498 37
8beafbbc 38 function addEntity ($msg) {
61423189 39 $this->entities[] = $msg;
8beafbbc 40 }
41 }
1fd97780 42
8beafbbc 43 /* --------------------------------------------------------------------------------- */
44 /* MIME DECODING */
45 /* --------------------------------------------------------------------------------- */
b74ba498 46
cbcf32f6 47 // This function gets the structure of a message and stores it in the "message" class.
48 // It will return this object for use with all relevant header information and
49 // fully parsed into the standard "message" object format.
8beafbbc 50 function mime_structure ($imap_stream, $header) {
b74ba498 51
52 sqimap_messages_flag ($imap_stream, $header->id, $header->id, 'Seen');
53 $ssid = sqimap_session_id();
54 $lsid = strlen( $ssid );
8beafbbc 55 $id = $header->id;
b74ba498 56 fputs ($imap_stream, "$ssid FETCH $id BODYSTRUCTURE\r\n");
245a6892 57 //
58 // This should use sqimap_read_data instead of reading it itself
59 //
e79bed1b 60 $read = fgets ($imap_stream, 10000);
b74ba498 61 $bodystructure = '';
62 while( substr($read, 0, $lsid) <> $ssid &&
63 !feof( $imap_stream ) ) {
3e1266ef 64 $bodystructure .= $read;
254925d1 65 $read = fgets ($imap_stream, 10000);
254925d1 66 }
22ef7536 67 $read = $bodystructure;
8beafbbc 68
8beafbbc 69 // isolate the body structure and remove beginning and end parenthesis
b74ba498 70 $read = trim(substr ($read, strpos(strtolower($read), 'bodystructure') + 13));
ea48eb25 71 $read = trim(substr ($read, 0, -1));
72 $end = mime_match_parenthesis(0, $read);
73 while ($end == strlen($read)-1) {
74 $read = trim(substr ($read, 0, -1));
75 $read = trim(substr ($read, 1));
76 $end = mime_match_parenthesis(0, $read);
77 }
8beafbbc 78
85daa3ad 79 $msg = mime_parse_structure ($read, 0);
8beafbbc 80 $msg->header = $header;
81 return $msg;
82 }
83
cbcf32f6 84 // this starts the parsing of a particular structure. It is called recursively,
85 // so it can be passed different structures. It returns an object of type
86 // $message.
87 // First, it checks to see if it is a multipart message. If it is, then it
88 // handles that as it sees is necessary. If it is just a regular entity,
89 // then it parses it and adds the necessary header information (by calling out
90 // to mime_get_elements()
8beafbbc 91 function mime_parse_structure ($structure, $ent_id) {
b74ba498 92
8beafbbc 93 $msg = new message();
b74ba498 94 if ($structure{0} == '(') {
8beafbbc 95 $ent_id = mime_new_element_level($ent_id);
96 $start = $end = -1;
97 do {
8beafbbc 98 $start = $end+1;
99 $end = mime_match_parenthesis ($start, $structure);
b74ba498 100
8beafbbc 101 $element = substr($structure, $start+1, ($end - $start)-1);
ea48eb25 102 $ent_id = mime_increment_id ($ent_id);
8beafbbc 103 $newmsg = mime_parse_structure ($element, $ent_id);
104 $msg->addEntity ($newmsg);
b74ba498 105 } while ($structure{$end+1} == '(');
8beafbbc 106 } else {
107 // parse the elements
090595e1 108 $msg = mime_get_element ($structure, $msg, $ent_id);
8beafbbc 109 }
bc64f471 110 return $msg;
8beafbbc 111 }
112
113 // Increments the element ID. An element id can look like any of
114 // the following: 1, 1.2, 4.3.2.4.1, etc. This function increments
115 // the last number of the element id, changing 1.2 to 1.3.
116 function mime_increment_id ($id) {
b74ba498 117
8beafbbc 118 if (strpos($id, ".")) {
119 $first = substr($id, 0, strrpos($id, "."));
ea48eb25 120 $last = substr($id, strrpos($id, ".")+1);
8beafbbc 121 $last++;
ea48eb25 122 $new = $first . "." .$last;
8beafbbc 123 } else {
124 $new = $id + 1;
125 }
b74ba498 126
8beafbbc 127 return $new;
128 }
129
130 // See comment for mime_increment_id().
131 // This adds another level on to the entity_id changing 1.3 to 1.3.0
b74ba498 132 // NOTE: 1.3.0 is not a valid element ID. It MUST be incremented
8beafbbc 133 // before it can be used. I left it this way so as not to have
134 // to make a special case if it is the first entity_id. It
135 // always increments it, and that works fine.
136 function mime_new_element_level ($id) {
ea48eb25 137
b74ba498 138 if (!$id) {
139 $id = 0;
140 } else {
141 $id = $id . '.0';
142 }
143
144 return( $id );
8beafbbc 145 }
146
ea48eb25 147 function mime_get_element (&$structure, $msg, $ent_id) {
b74ba498 148
8beafbbc 149 $elem_num = 1;
ea48eb25 150 $msg->header = new msg_header();
151 $msg->header->entity_id = $ent_id;
4bbe6ccc 152 $properties = array();
b74ba498 153
8beafbbc 154 while (strlen($structure) > 0) {
155 $structure = trim($structure);
b74ba498 156 $char = $structure{0};
8beafbbc 157
b74ba498 158 if (strtolower(substr($structure, 0, 3)) == 'nil') {
159 $text = '';
8beafbbc 160 $structure = substr($structure, 3);
b74ba498 161 } else if ($char == '"') {
8beafbbc 162 // loop through until we find the matching quote, and return that as a string
163 $pos = 1;
b74ba498 164 $text = '';
165 while ( ($char = $structure{$pos} ) <> '"' && $pos < strlen($structure)) {
8beafbbc 166 $text .= $char;
167 $pos++;
b74ba498 168 }
8beafbbc 169 $structure = substr($structure, strlen($text) + 2);
b74ba498 170 } else if ($char == '(') {
8beafbbc 171 // comment me
172 $end = mime_match_parenthesis (0, $structure);
173 $sub = substr($structure, 1, $end-1);
174 $properties = mime_get_props($properties, $sub);
175 $structure = substr($structure, strlen($sub) + 2);
176 } else {
177 // loop through until we find a space or an end parenthesis
178 $pos = 0;
b74ba498 179 $char = $structure{$pos};
180 $text = '';
181 while ($char != ' ' && $char != ')' && $pos < strlen($structure)) {
8beafbbc 182 $text .= $char;
183 $pos++;
b74ba498 184 $char = $structure{$pos};
aceb0d5c 185 }
8beafbbc 186 $structure = substr($structure, strlen($text));
aceb0d5c 187 }
8beafbbc 188
189 // This is where all the text parts get put into the header
190 switch ($elem_num) {
b74ba498 191 case 1:
22ef7536 192 $msg->header->type0 = strtolower($text);
8beafbbc 193 break;
b74ba498 194 case 2:
22ef7536 195 $msg->header->type1 = strtolower($text);
8beafbbc 196 break;
b74ba498 197 case 4: // Id
198 // Invisimail enclose images with <>
199 $msg->header->id = str_replace( '<', '', str_replace( '>', '', $text ) );
200 break;
ea48eb25 201 case 5:
202 $msg->header->description = $text;
ea48eb25 203 break;
8beafbbc 204 case 6:
22ef7536 205 $msg->header->encoding = strtolower($text);
8beafbbc 206 break;
207 case 7:
ea48eb25 208 $msg->header->size = $text;
8beafbbc 209 break;
210 default:
b74ba498 211 if ($msg->header->type0 == 'text' && $elem_num == 8) {
cbcf32f6 212 // This is a plain text message, so lets get the number of lines
213 // that it contains.
ea48eb25 214 $msg->header->num_lines = $text;
cbcf32f6 215
b74ba498 216 } else if ($msg->header->type0 == 'message' && $msg->header->type1 == 'rfc822' && $elem_num == 8) {
217 // This is an encapsulated message, so lets start all over again and
ea48eb25 218 // parse this message adding it on to the existing one.
219 $structure = trim($structure);
b74ba498 220 if ( $structure{0} == '(' ) {
ea48eb25 221 $e = mime_match_parenthesis (0, $structure);
222 $structure = substr($structure, 0, $e);
223 $structure = substr($structure, 1);
224 $m = mime_parse_structure($structure, $msg->header->entity_id);
b74ba498 225
cbcf32f6 226 // the following conditional is there to correct a bug that wasn't
227 // incrementing the entity IDs correctly because of the special case
228 // that message/rfc822 is. This fixes it fine.
b74ba498 229 if (substr($structure, 1, 1) != '(')
ea48eb25 230 $m->header->entity_id = mime_increment_id(mime_new_element_level($ent_id));
b74ba498 231
cbcf32f6 232 // Now we'll go through and reformat the results.
ea48eb25 233 if ($m->entities) {
234 for ($i=0; $i < count($m->entities); $i++) {
ea48eb25 235 $msg->addEntity($m->entities[$i]);
236 }
237 } else {
ea48eb25 238 $msg->addEntity($m);
239 }
b74ba498 240 $structure = "";
ea48eb25 241 }
8beafbbc 242 }
243 break;
244 }
245 $elem_num++;
246 $text = "";
247 }
248 // loop through the additional properties and put those in the various headers
b74ba498 249 if ($msg->header->type0 != 'message') {
cbcf32f6 250 for ($i=0; $i < count($properties); $i++) {
b74ba498 251 $msg->header->{$properties[$i]['name']} = $properties[$i]['value'];
cbcf32f6 252 }
ea48eb25 253 }
e4a256af 254
ea48eb25 255 return $msg;
8beafbbc 256 }
257
258 // I did most of the MIME stuff yesterday (June 20, 2000), but I couldn't
259 // figure out how to do this part, so I decided to go to bed. I woke up
260 // in the morning and had a flash of insight. I went to the white-board
261 // and scribbled it out, then spent a bit programming it, and this is the
262 // result. Nothing complicated, but I think my brain was fried yesterday.
cbcf32f6 263 // Funny how that happens some times.
8beafbbc 264 //
265 // This gets properties in a nested parenthesisized list. For example,
266 // this would get passed something like: ("attachment" ("filename" "luke.tar.gz"))
267 // This returns an array called $props with all paired up properties.
b74ba498 268 // It ignores the "attachment" for now, maybe that should change later
8beafbbc 269 // down the road. In this case, what is returned is:
270 // $props[0]["name"] = "filename";
271 // $props[0]["value"] = "luke.tar.gz";
272 function mime_get_props ($props, $structure) {
b74ba498 273
8beafbbc 274 while (strlen($structure) > 0) {
275 $structure = trim($structure);
b74ba498 276 $char = $structure{0};
8beafbbc 277
b74ba498 278 if ($char == '"') {
8beafbbc 279 $pos = 1;
b74ba498 280 $tmp = '';
281 while ( ( $char = $structure{$pos} ) != '"' &&
282 $pos < strlen($structure)) {
8beafbbc 283 $tmp .= $char;
284 $pos++;
b74ba498 285 }
8beafbbc 286 $structure = trim(substr($structure, strlen($tmp) + 2));
b74ba498 287 $char = $structure{0};
8beafbbc 288
b74ba498 289 if ($char == '"') {
8beafbbc 290 $pos = 1;
b74ba498 291 $value = '';
292 while ( ( $char = $structure{$pos} ) != '"' &&
293 $pos < strlen($structure) ) {
8beafbbc 294 $value .= $char;
295 $pos++;
b74ba498 296 }
8beafbbc 297 $structure = trim(substr($structure, strlen($tmp) + 2));
b74ba498 298
8beafbbc 299 $k = count($props);
b74ba498 300 $props[$k]['name'] = strtolower($tmp);
301 $props[$k]['value'] = $value;
302 } else if ($char == '(') {
8beafbbc 303 $end = mime_match_parenthesis (0, $structure);
304 $sub = substr($structure, 1, $end-1);
b74ba498 305 if (! isset($props))
306 $props = array();
8beafbbc 307 $props = mime_get_props($props, $sub);
308 $structure = substr($structure, strlen($sub) + 2);
309 }
310 return $props;
b74ba498 311 } else if ($char == '(') {
8beafbbc 312 $end = mime_match_parenthesis (0, $structure);
313 $sub = substr($structure, 1, $end-1);
314 $props = mime_get_props($props, $sub);
315 $structure = substr($structure, strlen($sub) + 2);
ea48eb25 316 return $props;
8beafbbc 317 } else {
318 return $props;
7831268e 319 }
8beafbbc 320 }
321 }
7831268e 322
8beafbbc 323 // Matches parenthesis. It will return the position of the matching
324 // parenthesis in $structure. For instance, if $structure was:
325 // ("text" "plain" ("val1name", "1") nil ... )
326 // x x
327 // then this would return 42 to match up those two.
328 function mime_match_parenthesis ($pos, $structure) {
b74ba498 329
330 $j = strlen( $structure );
8beafbbc 331
332 // ignore all extra characters
5ffe5a7e 333 // If inside of a string, skip string -- Boundary IDs and other
334 // things can have ) in them.
b74ba498 335 if( $structure{$pos} != '(' )
336 return( $j );
337
338 while( $pos < $j ) {
8beafbbc 339 $pos++;
b74ba498 340 if ($structure{$pos} == ')') {
8beafbbc 341 return $pos;
b74ba498 342 } elseif ($structure{$pos} == '"') {
343 $pos++;
344 while( $structure{$pos} != '"' &&
345 $pos < $j ) {
346 if (substr($structure, $pos, 2) == '\\"')
347 $pos++;
348 elseif (substr($structure, $pos, 2) == '\\\\')
349 $pos++;
350 $pos++;
5ffe5a7e 351 }
b74ba498 352 } elseif ( $structure{$pos} == '(' ) {
8beafbbc 353 $pos = mime_match_parenthesis ($pos, $structure);
354 }
d4467150 355 }
377a40b2 356 echo "Error decoding mime structure. Report this as a bug!<br>\n";
b74ba498 357 return( $pos );
8beafbbc 358 }
d4467150 359
a3daaaf3 360 function mime_fetch_body ($imap_stream, $id, $ent_id ) {
361 // do a bit of error correction. If we couldn't find the entity id, just guess
362 // that it is the first one. That is usually the case anyway.
363 if (!$ent_id)
364 $ent_id = 1;
365 $sid = sqimap_session_id();
366 fputs ($imap_stream, "$sid FETCH $id BODY[$ent_id]\r\n");
367 $data = sqimap_read_data ($imap_stream, $sid, true, $response, $message);
368 $topline = array_shift($data);
369 while (! ereg('\\* [0-9]+ FETCH ', $topline) && $data)
370 $topline = array_shift($data);
371 $wholemessage = implode('', $data);
372 if (ereg('\\{([^\\}]*)\\}', $topline, $regs)) {
373 $ret = substr( $wholemessage, 0, $regs[1] );
374 /*
375 There is some information in the content info header that could be important
376 in order to parse html messages. Let's get them here.
377 */
378 if( $ret{0} == '<' ) {
379 fputs ($imap_stream, "$sid FETCH $id BODY[$ent_id.MIME]\r\n");
380 $data = sqimap_read_data ($imap_stream, $sid, true, $response, $message);
381 $base = '';
382 $k = 10;
383 foreach( $data as $d ) {
384 if( substr( $d, 0, 13 ) == 'Content-Base:' ) {
385 $j = strlen( $d );
386 $i = 13;
387 $base = '';
388 while( $i < $j &&
389 ( !isNoSep( $d{$i} ) || $d{$i} == '"' ) )
390 $i++;
391 while( $i < $j ) {
392 if( isNoSep( $d{$i} ) )
393 $base .= $d{$i};
394 $i++;
395 }
396 $k = 0;
397 } elseif( $k == 1 && !isnosep( $d{0} ) ) {
398 $base .= substr( $d, 1 );
399 }
400 $k++;
401 }
402 if( $base <> '' )
403 $ret = "<base href=\"$base\">" . $ret;
404 }
405 } else if (ereg('"([^"]*)"', $topline, $regs)) {
406 $ret = $regs[1];
407 } else {
ae3fac8d 408 $ret = "Body retrieval error. Please report this bug!\n" .
a3daaaf3 409 "Response: $response\n" .
410 "Message: $message\n" .
411 "FETCH line: $topline" .
412 "---------------\n$wholemessage";
413
414 foreach ($data as $d) {
415 $ret .= htmlspecialchars($d) . "\n";
416 }
417 }
418 return( $ret );
419 }
d4467150 420
beb9e459 421 function mime_print_body_lines ($imap_stream, $id, $ent_id, $encoding) {
422 // do a bit of error correction. If we couldn't find the entity id, just guess
423 // that it is the first one. That is usually the case anyway.
424 if (!$ent_id) $ent_id = 1;
b74ba498 425 $sid = sqimap_session_id();
1d1e02f4 426 // Don't kill the connection if the browser is over a dialup
427 // and it would take over 30 seconds to download it.
428 set_time_limit(0);
429
b74ba498 430 fputs ($imap_stream, "$sid FETCH $id BODY[$ent_id]\r\n");
431 $cnt = 0;
432 $continue = true;
433 $read = fgets ($imap_stream,4096);
434 // This could be bad -- if the section has sqimap_session_id() . ' OK'
435 // or similar, it will kill the download.
436 while (!ereg("^".$sid." (OK|BAD|NO)(.*)$", $read, $regs)) {
437 if (trim($read) == ')==') {
438 $read1 = $read;
439 $read = fgets ($imap_stream,4096);
440 if (ereg("^".$sid." (OK|BAD|NO)(.*)$", $read, $regs)) {
441 return;
442 } else {
443 echo decodeBody($read1, $encoding) .
444 decodeBody($read, $encoding);
445 }
446 } else if ($cnt) {
447 echo decodeBody($read, $encoding);
448 }
449 $read = fgets ($imap_stream,4096);
450 $cnt++;
451 }
beb9e459 452 }
453
8beafbbc 454 /* -[ END MIME DECODING ]----------------------------------------------------------- */
d4467150 455
aceb0d5c 456
d4467150 457
8beafbbc 458 /** This is the first function called. It decides if this is a multipart
459 message or if it should be handled as a single entity
4809f489 460 **/
090595e1 461 function decodeMime ($imap_stream, &$header) {
8beafbbc 462 global $username, $key, $imapServerAddress, $imapPort;
8d8ab69a 463 return mime_structure ($imap_stream, $header);
8beafbbc 464 }
b1dadc61 465
cbcf32f6 466 // This is here for debugging purposese. It will print out a list
467 // of all the entity IDs that are in the $message object.
b74ba498 468 /*
ea48eb25 469 function listEntities ($message) {
470 if ($message) {
cbcf32f6 471 if ($message->header->entity_id)
b74ba498 472 echo "<tt>" . $message->header->entity_id . ' : ' . $message->header->type0 . '/' . $message->header->type1 . '<br>';
cbcf32f6 473 for ($i = 0; $message->entities[$i]; $i++) {
474 $msg = listEntities($message->entities[$i], $ent_id);
475 if ($msg)
476 return $msg;
477 }
ea48eb25 478 }
479 }
b74ba498 480 */
ea48eb25 481
cbcf32f6 482 // returns a $message object for a particular entity id
8beafbbc 483 function getEntity ($message, $ent_id) {
484 if ($message) {
ea48eb25 485 if ($message->header->entity_id == $ent_id && strlen($ent_id) == strlen($message->header->entity_id)) {
8beafbbc 486 return $message;
b1dadc61 487 } else {
cd928157 488 for ($i = 0; isset($message->entities[$i]); $i++) {
8beafbbc 489 $msg = getEntity ($message->entities[$i], $ent_id);
490 if ($msg)
491 return $msg;
b1dadc61 492 }
b74ba498 493 }
8beafbbc 494 }
495 }
496
a3daaaf3 497 // figures out what entity to display and returns the $message object
498 // for that entity.
499 function findDisplayEntity ($message, $textOnly = 1) {
500 global $show_html_default;
501
502 $entity = 0;
503
504 if ($message) {
505 if ( $message->header->type0 == 'multipart' &&
506 ( $message->header->type1 == 'alternative' ||
507 $message->header->type1 == 'related' ) &&
508 $show_html_default && ! $textOnly ) {
509 $entity = findDisplayEntityHTML($message);
510 }
511
512 // Show text/plain or text/html -- the first one we find.
513 if ( $entity == 0 &&
514 $message->header->type0 == 'text' &&
515 ( $message->header->type1 == 'plain' ||
516 $message->header->type1 == 'html' ) &&
517 isset($message->header->entity_id) ) {
518 $entity = $message->header->entity_id;
519 }
520
521 $i = 0;
522 while ($entity == 0 && isset($message->entities[$i]) ) {
523 $entity = findDisplayEntity($message->entities[$i], $textOnly);
524 $i++;
525 }
526 }
527
528 return( $entity );
529 }
b74ba498 530
c3a80dac 531 // Shows the HTML version
532 function findDisplayEntityHTML ($message) {
b74ba498 533 if ($message->header->type0 == 'text' &&
c3a80dac 534 $message->header->type1 == 'html' &&
b74ba498 535 isset($message->header->entity_id))
536 return $message->header->entity_id;
c3a80dac 537 for ($i = 0; isset($message->entities[$i]); $i ++) {
538 $entity = findDisplayEntityHTML($message->entities[$i]);
b74ba498 539 if ($entity != 0)
540 return $entity;
c3a80dac 541 }
e2ab93e5 542 return 0;
b1dadc61 543 }
8405ee35 544
d068c0ec 545 /** This returns a parsed string called $body. That string can then
546 be displayed as the actual message in the HTML. It contains
547 everything needed, including HTML Tags, Attachments at the
548 bottom, etc.
4809f489 549 **/
8d8ab69a 550 function formatBody($imap_stream, $message, $color, $wrap_at) {
cbcf32f6 551 // this if statement checks for the entity to show as the
552 // primary message. To add more of them, just put them in the
553 // order that is their priority.
5f1c529a 554 global $startMessage, $username, $key, $imapServerAddress, $imapPort,
555 $show_html_default;
8beafbbc 556
8beafbbc 557 $id = $message->header->id;
558 $urlmailbox = urlencode($message->header->mailbox);
559
e4a256af 560 // Get the right entity and redefine message to be this entity
3ae6e629 561 // Pass the 0 to mean that we want the 'best' viewable one
562 $ent_num = findDisplayEntity ($message, 0);
2c252f5a 563 $body_message = getEntity($message, $ent_num);
b74ba498 564 if (($body_message->header->type0 == 'text') ||
565 ($body_message->header->type0 == 'rfc822')) {
566
d51894be 567 $body = mime_fetch_body ($imap_stream, $id, $ent_num);
d4ff4d67 568 $body = decodeBody($body, $body_message->header->encoding);
b74ba498 569 $hookResults = do_hook("message_body", $body);
570 $body = $hookResults[1];
b36d403c 571
d4ff4d67 572 // If there are other types that shouldn't be formatted, add
b74ba498 573 // them here
a3daaaf3 574 if ($body_message->header->type1 == 'html') {
575 if( $show_html_default <> 1 ) {
576 $body = strip_tags( $body );
577 translateText($body, $wrap_at, $body_message->header->charset);
578 } else {
579 $body = MagicHTML( $body, $id );
580 }
581 } else {
9eea179c 582 translateText($body, $wrap_at, $body_message->header->charset);
b74ba498 583 }
584
7b9592dc 585 $body .= "<SMALL><CENTER><A HREF=\"../src/download.php?absolute_dl=true&passed_id=$id&passed_ent_id=$ent_num&mailbox=$urlmailbox&showHeaders=1\">". _("Download this as a file") ."</A></CENTER><BR></SMALL>";
b74ba498 586
d4ff4d67 587 /** Display the ATTACHMENTS: message if there's more than one part **/
dd389be5 588 $body .= "</TD></TR></TABLE>";
719534f2 589 if (isset($message->entities[0])) {
d4ff4d67 590 $body .= formatAttachments ($message, $ent_num, $message->header->mailbox, $id);
d4ff4d67 591 }
b74ba498 592 $body .= "</TD></TR></TABLE>";
d4ff4d67 593 } else {
cba164a0 594 $body = formatAttachments ($message, -1, $message->header->mailbox, $id);
8405ee35 595 }
b74ba498 596 return( $body );
d4467150 597 }
598
8beafbbc 599 // A recursive function that returns a list of attachments with links
600 // to where to download these attachments
601 function formatAttachments ($message, $ent_id, $mailbox, $id) {
f4991a86 602 global $where, $what;
dd389be5 603 global $startMessage, $color;
719534f2 604 static $ShownHTML = 0;
b74ba498 605
606 $body = "";
607 if ($ShownHTML == 0) {
dd389be5 608 $ShownHTML = 1;
b74ba498 609
610 $body .= "<TABLE WIDTH=100% CELLSPACING=0 CELLPADDING=2 BORDER=0 BGCOLOR=\"$color[0]\"><TR>\n" .
611 "<TH ALIGN=\"left\" BGCOLOR=\"$color[9]\"><B>\n" .
612 _("Attachments") . ':' .
613 "</B></TH></TR><TR><TD>\n" .
614 "<TABLE CELLSPACING=0 CELLPADDING=1 BORDER=0>\n" .
615 formatAttachments ($message, $ent_id, $mailbox, $id) .
616 "</TABLE></TD></TR></TABLE>";
617
618 return( $body );
dd389be5 619 }
b74ba498 620
8beafbbc 621 if ($message) {
622 if (!$message->entities) {
623 $type0 = strtolower($message->header->type0);
624 $type1 = strtolower($message->header->type1);
66e1a00e 625 $name = decodeHeader($message->header->name);
b74ba498 626
8beafbbc 627 if ($message->header->entity_id != $ent_id) {
888c82e2 628 $filename = decodeHeader($message->header->filename);
b74ba498 629 if (trim($filename) == '') {
630 if (trim($name) == '') {
631 if( trim( $message->header->id ) == '' )
632 $display_filename = 'untitled-[' . $message->header->entity_id . ']' ;
633 else
634 $display_filename = 'cid: ' . $message->header->id;
635 // $display_filename = 'untitled-[' . $message->header->entity_id . ']' ;
636 } else {
637 $display_filename = $name;
638 $filename = $name;
639 }
8beafbbc 640 } else {
641 $display_filename = $filename;
642 }
b74ba498 643
8beafbbc 644 $urlMailbox = urlencode($mailbox);
645 $ent = urlencode($message->header->entity_id);
b74ba498 646
647 $DefaultLink =
bc104ef3 648 "../src/download.php?startMessage=$startMessage&passed_id=$id&mailbox=$urlMailbox&passed_ent_id=$ent";
dd389be5 649 if ($where && $what)
650 $DefaultLink .= '&where=' . urlencode($where) . '&what=' . urlencode($what);
701c9c6b 651 $Links['download link']['text'] = _("download");
b74ba498 652 $Links['download link']['href'] =
bc104ef3 653 "../src/download.php?absolute_dl=true&passed_id=$id&mailbox=$urlMailbox&passed_ent_id=$ent";
dd389be5 654 $ImageURL = '';
b74ba498 655
dd389be5 656 $HookResults = do_hook("attachment $type0/$type1", $Links,
b74ba498 657 $startMessage, $id, $urlMailbox, $ent, $DefaultLink,
ef30bf50 658 $display_filename, $where, $what);
dd389be5 659
660 $Links = $HookResults[1];
661 $DefaultLink = $HookResults[6];
662
b74ba498 663 $body .= '<TR><TD>&nbsp;&nbsp;</TD><TD>' .
664 "<A HREF=\"$DefaultLink\">$display_filename</A>&nbsp;</TD>" .
665 '<TD><SMALL><b>' . show_readable_size($message->header->size) .
666 '</b>&nbsp;&nbsp;</small></TD>' .
667 "<TD><SMALL>[ $type0/$type1 ]&nbsp;</SMALL></TD>" .
668 '<TD><SMALL>';
ea48eb25 669 if ($message->header->description)
dd389be5 670 $body .= '<b>' . htmlspecialchars($message->header->description) . '</b>';
fde32e3f 671 $body .= '</SMALL></TD><TD><SMALL>&nbsp;';
b74ba498 672
673
dd389be5 674 $SkipSpaces = 1;
b74ba498 675 foreach ($Links as $Val) {
676 if ($SkipSpaces) {
dd389be5 677 $SkipSpaces = 0;
b74ba498 678 } else {
fde32e3f 679 $body .= '&nbsp;&nbsp;|&nbsp;&nbsp;';
dd389be5 680 }
fde32e3f 681 $body .= '<a href="' . $Val['href'] . '">' . $Val['text'] . '</a>';
dd389be5 682 }
b74ba498 683
dd389be5 684 unset($Links);
b74ba498 685
fde32e3f 686 $body .= "</SMALL></TD></TR>\n";
8beafbbc 687 }
8beafbbc 688 } else {
689 for ($i = 0; $i < count($message->entities); $i++) {
690 $body .= formatAttachments ($message->entities[$i], $ent_id, $mailbox, $id);
691 }
8beafbbc 692 }
b74ba498 693 return( $body );
8beafbbc 694 }
695 }
4809f489 696
697
698 /** this function decodes the body depending on the encoding type. **/
d4467150 699 function decodeBody($body, $encoding) {
623332f3 700 $body = str_replace("\r\n", "\n", $body);
d4467150 701 $encoding = strtolower($encoding);
7831268e 702
358f007e 703 global $show_html_default;
704
b74ba498 705 if ($encoding == 'quoted-printable') {
ef3f274f 706 $body = quoted_printable_decode($body);
b74ba498 707
708
709 /*
710 Following code has been comented as I see no reason for it.
711 If there is any please tell me a mingo@rotedic.com
712
ef3f274f 713 while (ereg("=\n", $body))
714 $body = ereg_replace ("=\n", "", $body);
b74ba498 715 */
716 } else if ($encoding == 'base64') {
ef3f274f 717 $body = base64_decode($body);
d4467150 718 }
b74ba498 719
a47b5200 720 // All other encodings are returned raw.
ef3f274f 721 return $body;
aceb0d5c 722 }
a4c2cd49 723
724
b74ba498 725 // This functions decode strings that is encoded according to
a4c2cd49 726 // RFC1522 (MIME Part Two: Message Header Extensions for Non-ASCII Text).
2e434774 727 function decodeHeader ($string) {
b74ba498 728 if (eregi('=\\?([^?]+)\\?(q|b)\\?([^?]+)\\?=',
a4c2cd49 729 $string, $res)) {
1fd97780 730 if (ucfirst($res[2]) == "B") {
731 $replace = base64_decode($res[3]);
a4c2cd49 732 } else {
1fd97780 733 $replace = ereg_replace("_", " ", $res[3]);
b74ba498 734 // Convert lowercase Quoted Printable to uppercase for
735 // quoted_printable_decode to understand it.
736 while (ereg("(=(([0-9][abcdef])|([abcdef][0-9])|([abcdef][abcdef])))", $replace, $res)) {
737 $replace = str_replace($res[1], strtoupper($res[1]), $replace);
738 }
a4c2cd49 739 $replace = quoted_printable_decode($replace);
740 }
741
1fd97780 742 $replace = charset_decode ($res[1], $replace);
a4c2cd49 743
9be55c4b 744 // Remove the name of the character set.
745 $string = eregi_replace ('=\\?([^?]+)\\?(q|b)\\?([^?]+)\\?=',
a4c2cd49 746 $replace, $string);
9be55c4b 747
2e434774 748 // In case there should be more encoding in the string: recurse
749 return (decodeHeader($string));
b74ba498 750 } else
a4c2cd49 751 return ($string);
752 }
753
c3084273 754 // Encode a string according to RFC 1522 for use in headers if it
bb60fa3f 755 // contains 8-bit characters or anything that looks like it should
756 // be encoded.
c3084273 757 function encodeHeader ($string) {
758 global $default_charset;
b74ba498 759
f7b3ba37 760 // Encode only if the string contains 8-bit characters or =?
761 $j = strlen( $string );
762 $l = FALSE; // Must be encoded ?
763 $ret = '';
764 for( $i=0; $i < $j; ++$i) {
765 switch( $string{$i} ) {
766 case '=':
b74ba498 767 $ret .= '=3D';
768 break;
769 case '?':
770 $l = TRUE;
771 $ret .= '=3F';
772 break;
773 case '_':
774 $ret .= '=5F';
775 break;
776 case ' ':
777 $ret .= '_';
778 break;
779 default:
780 $k = ord( $string{$i} );
781 if( $k > 126 ) {
782 $ret .= sprintf("=%02X", $k);
783 $l = TRUE;
784 } else
785 $ret .= $string{$i};
f7b3ba37 786 }
787 }
b74ba498 788
f7b3ba37 789 if( $l )
790 $string = "=?$default_charset?Q?$ret?=";
b74ba498 791
f7b3ba37 792 return( $string );
793 }
c3084273 794
a3daaaf3 795 /*
796 Strips dangerous tags from html messages.
797 */
798
799 function MagicHTML( $body, $id ) {
800
801 global $message, $PHP_SELF, $HTTP_SERVER_VARS;
802
803 $j = strlen( $body ); // Legnth of the HTML
804 $ret = ''; // Returned string
805 $bgcolor = '#ffffff'; // Background style color (defaults to white)
806 $leftmargin = ''; // Left margin style
807 $title = ''; // HTML title if any
808
809 $i = 0;
810 while( $i < $j ) {
811 if( $body{$i} == '<' ) {
812 $tag = $body{$i+1}.$body{$i+2}.$body{$i+3}.$body{$i+4};
813 switch( strtoupper( $tag ) ) {
814 // Strips the entire tag and contents
815 case 'APPL':
816 case 'EMBB':
817 case 'FRAM':
818 case 'SCRI':
819 case 'OBJE':
820 $etg = '/' . $tag;
821 while( $body{$i+1}.$body{$i+2}.$body{$i+3}.$body{$i+4}.$body{$i+5} <> $etg &&
822 $i < $j ) $i++;
823 while( $i < $j && $body{++$i} <> '>' );
824 // $ret .= "<!-- $tag removed -->";
825 break;
826 // Substitute Title
827 case 'TITL':
828 $i += 5;
829 while( $body{$i} <> '>' && // </title>
830 $i < $j )
831 $i++;
832 $i++;
833 $title = '';
834 while( $body{$i} <> '<' && // </title>
835 $i < $j ) {
836 $title .= $body{$i};
837 $i++;
838 }
839 $i += 7;
840 break;
841 // Destroy these tags
842 case 'HTML':
843 case 'HEAD':
844 case '/HTM':
845 case '/HEA':
846 case '!DOC':
847 case 'META':
848 case 'DIV ':
849 case '/DIV':
850 case '!-- ':
851 $i += 4;
852 while( $body{$i} <> '>' &&
853 $i < $j )
854 $i++;
855 // $i++;
856 break;
857 case 'STYL':
858 $i += 5;
859 while( $body{$i} <> '>' && // </title>
860 $i < $j )
861 $i++;
862 $i++;
863 // We parse the style to look for interesting stuff
864 $styleblk = '';
865 while( $body{$i} <> '>' &&
866 $i < $j ) {
867 // First we get the name of the style
868 $style = '';
869 while( $body{$i} <> '>' &&
870 $body{$i} <> '<' &&
871 $body{$i} <> '{' &&
872 $i < $j ) {
873 if( isnoSep( $body{$i} ) )
874 $style .= $body{$i};
875 $i++;
876 }
877 stripComments( &$i, $j, &$body );
878 $style = strtoupper( trim( $style ) );
879 if( $style == 'BODY' ) {
880 // Next we look into the definitions of the body style
881 while( $body{$i} <> '>' &&
882 $body{$i} <> '}' &&
883 $i < $j ) {
884 // We look for the background color if any.
885 if( substr( $body, $i, 17 ) == 'BACKGROUND-COLOR:' ) {
886 $i += 17;
887 $bgcolor = getStyleData( $i, $j, $body );
888 } elseif ( substr( $body, $i, 12 ) == 'MARGIN-LEFT:' ) {
889 $i += 12;
890 $leftmargin = getStyleData( $i, $j, $body );
891 }
892 $i++;
893 }
894 } else {
895 // Other style are mantained
896 $styleblk .= "$style ";
897 while( $body{$i} <> '>' &&
898 $body{$i} <> '<' &&
899 $body{$i} <> '}' &&
900 $i < $j ) {
901 $styleblk .= $body{$i};
902 $i++;
903 }
904 $styleblk .= $body{$i};
905 }
906 stripComments( &$i, $j, &$body );
907 if( $body{$i} <> '>' )
908 $i++;
909 }
910 if( $styleblk <> '' )
911 $ret .= "<style>$styleblk";
912 break;
913 case 'BODY':
914 if( $title <> '' )
915 $ret .= '<b>' . _("Title:") . " </b>$title<br>\n";
916 $ret .= "<TABLE";
917 $i += 5;
918 $ret .= stripEvent( $i, $j, $body, $id, $base );
919 //if( $bgcolor <> '' )
920 $ret .= " bgcolor=$bgcolor";
921 $ret .= ' width=100%><tr>';
922 if( $leftmargin <> '' )
923 $ret .= "<td width=$leftmargin>&nbsp;</td>";
924 $ret .= '<td>';
925 break;
926 case 'BASE':
927 $i += 5;
928 $base = '';
929 while( !isNoSep( $body{$i} ) &&
930 $i < $j )
931 $i++;
932 if( strcasecmp( substr( $base, 0, 4 ), 'href' ) ) {
933 $i += 5;
934 while( !isNoSep( $body{$i} ) &&
935 $i < $j )
936 $i++;
937 while( $body{$i} <> '>' &&
938 $i < $j ) {
939 if( $body{$i} <> '"' )
940 $base .= $body{$i};
941 $i++;
942 }
943 // Debuging $ret .= "<!-- base == $base -->";
944 if( strcasecmp( substr( $base, 0, 4 ), 'file' ) <> 0 )
945 $ret .= "\n<BASE HREF=\"$base\">\n";
946 }
947 break;
948 case '/BOD':
949 $ret .= '</td></tr></TABLE>';
950 $i += 6;
951 break;
952 default:
953 // Following tags can contain some event handler, lets search it
954 stripComments( $i, $j, $body );
955 $ret .= stripEvent( $i, $j, $body, $id, $base ) . '>';
956 // $ret .= "<!-- $tag detected -->";
957 }
958 } else {
959 $ret .= $body{$i};
960 }
961 $i++;
962 }
963
964 return( "\n\n<!-- HTML Output ahead -->\n" .
965 $ret .
966 "\n<!-- END of HTML Output --><base href=\"".
967 $HTTP_SERVER_VARS["SERVER_NAME"] . substr( $PHP_SELF, 0, strlen( $PHP_SELF ) - 13 ) .
968 "\">\n\n" );
969 }
970
971 function isNoSep( $char ) {
972
973 switch( $char ) {
974 case ' ':
975 case "\n":
976 case "\t":
977 case "\r":
978 case '>':
979 case '"':
980 return( FALSE );
981 break;
982 default:
983 return( TRUE );
984 }
985
986 }
987
988 /*
989 The following function is usefull to remove extra data that can cause
990 html not to display properly. Especialy with MS stuff.
991 */
992
993 function stripComments( &$i, $j, &$body ) {
994
995 while( $body{$i}.$body{$i+1}.$body{$i+2}.$body{$i+3} == '<!--' &&
996 $i < $j ) {
997 $i += 5;
998 while( $body{$i-2}.$body{$i-1}.$body{$i} <> '-->' &&
999 $i < $j )
1000 $i++;
1001 $i++;
1002 }
1003
1004 return;
1005
1006 }
1007
1008 /* Gets the style data of a specific style */
1009
1010 function getStyleData( &$i, $j, &$body ) {
1011
1012 // We skip spaces
1013 while( $body{$i} <> '>' && !isNoSep( $body{$i} ) &&
1014 $i < $j ) {
1015 $i++;
1016 }
1017 // And get the color
1018 $ret = '';
1019 while( isNoSep( $body{$i} ) &&
1020 $i < $j ) {
1021 $ret .= $body{$i};
1022 $i++;
1023 }
1024
1025 return( $ret );
1026 }
1027
1028 /*
1029 Private function for strip_dangerous_tag. Look for event based coded and "remove" it
1030 change on with no (onload -> noload)
1031 */
1032
1033 function stripEvent( &$i, $j, &$body, $id, $base ) {
1034
1035 global $message;
1036
1037 $ret = '';
1038
1039 while( $body{$i} <> '>' &&
1040 $i < $j ) {
1041 $etg = strtolower($body{$i}.$body{$i+1}.$body{$i+2});
1042 switch( $etg ) {
1043 case '../':
1044 // Retrolinks are not allowed without a base because they mess with SM security
1045 if( $base == '' ) {
1046 $i += 2;
1047 } else {
1048 $ret .= '.';
1049 }
1050 break;
1051 case 'cid':
1052 // Internal link
1053 $k = $i-1;
1054 if( $body{$i+3} == ':') {
1055 $i +=4;
1056 $name = '';
1057 while( isNoSep( $body{$i} ) &&
1058 $i < $j )
1059 $name .= $body{$i++};
1060 if( $name <> '' ) {
1061 $ret .= "../src/download.php?absolute_dl=true&passed_id=$id&mailbox=" .
1062 urlencode( $message->header->mailbox ) .
1063 "&passed_ent_id=" . find_ent_id( $name, $message );
1064 if( $body{$k} == '"' )
1065 $ret .= '" ';
1066 else
1067 $ret .= ' ';
1068 }
1069 if( $body{$i} == '>' )
1070 $i -= 1;
1071 }
1072 break;
1073 case ' on':
1074 case "\non":
1075 case "\ron":
1076 case "\ton":
1077 $ret .= ' no';
1078 $i += 2;
1079 break;
1080 case 'pt:':
1081 if( strcasecmp( $body{$i-4}.$body{$i-3}.$body{$i-2}.$body{$i-1}.$body{$i}.$body{$i+1}.$body{$i+2}, 'script:') == 0 ) {
1082 $ret .= '_no/';
1083 } else {
1084 $ret .= $etg;
1085 }
1086 $i += 2;
1087 break;
1088 default:
1089 $ret .= $body{$i};
1090 }
1091 $i++;
1092 }
1093 return( $ret );
1094 }
1095
1096
1097 /* This function trys to locate the entity_id of a specific mime element */
1098
1099 function find_ent_id( $id, $message ) {
1100
1101 $ret = '';
1102 for ($i=0; $ret == '' && $i < count($message->entities); $i++) {
1103
1104 if( $message->entities[$i]->header->entity_id == '' ) {
1105 $ret = find_ent_id( $id, $message->entities[$i] );
1106 } else {
1107 if( strcasecmp( $message->entities[$i]->header->id, $id ) == 0 )
1108 $ret = $message->entities[$i]->header->entity_id;
1109 }
1110
1111 }
1112
1113 return( $ret );
1114
1115 }
1116?>