added capability to detect if imap server supports searching on specific
[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 **/
9
e79bed1b 10 $debug_mime = false;
d068c0ec 11 $mime_php = true;
aceb0d5c 12
1fd97780 13 if (!isset($i18n_php))
14 include "../functions/i18n.php";
8beafbbc 15 if (!isset($imap_php))
16 include "../functions/imap.php";
17 if (!isset($config_php))
18 include "../config/config.php";
19
20
cbcf32f6 21 /** Setting up the objects that have the structure for the message **/
8beafbbc 22
23 class msg_header {
24 /** msg_header contains generic variables for values that **/
25 /** could be in a header. **/
26
245a6892 27 var $type0 = '', $type1 = '', $boundary = '', $charset = '';
40023540 28 var $encoding = '', $size = 0, $to = array(), $from = '', $date = '';
29 var $cc = array(), $bcc = array(), $reply_to = '', $subject = '';
61423189 30 var $id = 0, $mailbox = '', $description = '', $filename = '';
245a6892 31 var $entity_id = 0, $message_id = 0;
8beafbbc 32 }
33
34 class message {
35 /** message is the object that contains messages. It is a recursive
36 object in that through the $entities variable, it can contain
37 more objects of type message. See documentation in mime.txt for
38 a better description of how this works.
39 **/
61423189 40 var $header = '';
2df6ca53 41 var $entities = array();
8beafbbc 42
43 function addEntity ($msg) {
61423189 44 $this->entities[] = $msg;
8beafbbc 45 }
46 }
1fd97780 47
bcb432a3 48
bcb432a3 49
8beafbbc 50 /* --------------------------------------------------------------------------------- */
51 /* MIME DECODING */
52 /* --------------------------------------------------------------------------------- */
53
cbcf32f6 54 // This function gets the structure of a message and stores it in the "message" class.
55 // It will return this object for use with all relevant header information and
56 // fully parsed into the standard "message" object format.
8beafbbc 57 function mime_structure ($imap_stream, $header) {
e79bed1b 58 global $debug_mime;
8beafbbc 59 sqimap_messages_flag ($imap_stream, $header->id, $header->id, "Seen");
60
61 $id = $header->id;
62 fputs ($imap_stream, "a001 FETCH $id BODYSTRUCTURE\r\n");
245a6892 63 //
64 // This should use sqimap_read_data instead of reading it itself
65 //
e79bed1b 66 $read = fgets ($imap_stream, 10000);
254925d1 67 $response = substr($read, 0, 4);
245a6892 68 $bodystructure = "";
254925d1 69 while ($response != "a001") {
3e1266ef 70 $bodystructure .= $read;
254925d1 71 $read = fgets ($imap_stream, 10000);
72 $response = substr($read, 0, 4);
73 }
22ef7536 74 $read = $bodystructure;
8beafbbc 75
04632dbc 76 if ($debug_mime) echo "<tt>$read</tt><br><br>\n";
8beafbbc 77 // isolate the body structure and remove beginning and end parenthesis
22ef7536 78 $read = trim(substr ($read, strpos(strtolower($read), "bodystructure") + 13));
ea48eb25 79 $read = trim(substr ($read, 0, -1));
80 $end = mime_match_parenthesis(0, $read);
81 while ($end == strlen($read)-1) {
82 $read = trim(substr ($read, 0, -1));
83 $read = trim(substr ($read, 1));
84 $end = mime_match_parenthesis(0, $read);
85 }
8beafbbc 86
04632dbc 87 if ($debug_mime) echo "<tt>$read</tt><br><br>\n";
e79bed1b 88
85daa3ad 89 $msg = mime_parse_structure ($read, 0);
8beafbbc 90 $msg->header = $header;
91 return $msg;
92 }
93
cbcf32f6 94 // this starts the parsing of a particular structure. It is called recursively,
95 // so it can be passed different structures. It returns an object of type
96 // $message.
97 // First, it checks to see if it is a multipart message. If it is, then it
98 // handles that as it sees is necessary. If it is just a regular entity,
99 // then it parses it and adds the necessary header information (by calling out
100 // to mime_get_elements()
8beafbbc 101 function mime_parse_structure ($structure, $ent_id) {
e79bed1b 102 global $debug_mime;
04632dbc 103 if ($debug_mime) echo "<font color=008800><tt>START: mime_parse_structure()</tt></font><br>\n";
8beafbbc 104 $msg = new message();
105 if (substr($structure, 0, 1) == "(") {
106 $ent_id = mime_new_element_level($ent_id);
107 $start = $end = -1;
ea48eb25 108 if ($debug_mime) echo "<br><font color=0000aa><tt>$structure</tt></font><br>";
8beafbbc 109 do {
e79bed1b 110 if ($debug_mime) echo "<font color=008800><tt>Found entity...</tt></font><br>";
8beafbbc 111 $start = $end+1;
112 $end = mime_match_parenthesis ($start, $structure);
113
114 $element = substr($structure, $start+1, ($end - $start)-1);
ea48eb25 115 $ent_id = mime_increment_id ($ent_id);
8beafbbc 116 $newmsg = mime_parse_structure ($element, $ent_id);
117 $msg->addEntity ($newmsg);
118 } while (substr($structure, $end+1, 1) == "(");
119 } else {
120 // parse the elements
e79bed1b 121 if ($debug_mime) echo "<br><font color=0000aa><tt>$structure</tt></font><br>";
090595e1 122 $msg = mime_get_element ($structure, $msg, $ent_id);
e79bed1b 123 if ($debug_mime) echo "<br>";
8beafbbc 124 }
125 return $msg;
e79bed1b 126 if ($debug_mime) echo "<font color=008800><tt>&nbsp;&nbsp;END: mime_parse_structure()</tt></font><br>";
8beafbbc 127 }
128
129 // Increments the element ID. An element id can look like any of
130 // the following: 1, 1.2, 4.3.2.4.1, etc. This function increments
131 // the last number of the element id, changing 1.2 to 1.3.
132 function mime_increment_id ($id) {
ea48eb25 133 global $debug_mime;
8beafbbc 134 if (strpos($id, ".")) {
135 $first = substr($id, 0, strrpos($id, "."));
ea48eb25 136 $last = substr($id, strrpos($id, ".")+1);
8beafbbc 137 $last++;
ea48eb25 138 $new = $first . "." .$last;
8beafbbc 139 } else {
140 $new = $id + 1;
141 }
ea48eb25 142 if ($debug_mime) echo "<b>INCREMENT: $new</b><br>";
8beafbbc 143 return $new;
144 }
145
146 // See comment for mime_increment_id().
147 // This adds another level on to the entity_id changing 1.3 to 1.3.0
148 // NOTE: 1.3.0 is not a valid element ID. It MUST be incremented
149 // before it can be used. I left it this way so as not to have
150 // to make a special case if it is the first entity_id. It
151 // always increments it, and that works fine.
152 function mime_new_element_level ($id) {
ea48eb25 153 if (!$id) $id = 0;
154 else $id = $id . ".0";
155
8beafbbc 156 return $id;
157 }
158
ea48eb25 159 function mime_get_element (&$structure, $msg, $ent_id) {
e79bed1b 160 global $debug_mime;
8beafbbc 161 $elem_num = 1;
ea48eb25 162 $msg->header = new msg_header();
163 $msg->header->entity_id = $ent_id;
8beafbbc 164
165 while (strlen($structure) > 0) {
166 $structure = trim($structure);
167 $char = substr($structure, 0, 1);
168
e86ab872 169 if (strtolower(substr($structure, 0, 3)) == "nil") {
8beafbbc 170 $text = "";
171 $structure = substr($structure, 3);
172 } else if ($char == "\"") {
173 // loop through until we find the matching quote, and return that as a string
174 $pos = 1;
175 $char = substr($structure, $pos, 1);
245a6892 176 $text = "";
8beafbbc 177 while ($char != "\"" && $pos < strlen($structure)) {
178 $text .= $char;
179 $pos++;
180 $char = substr($structure, $pos, 1);
181 }
182 $structure = substr($structure, strlen($text) + 2);
183 } else if ($char == "(") {
184 // comment me
185 $end = mime_match_parenthesis (0, $structure);
186 $sub = substr($structure, 1, $end-1);
245a6892 187 if (! isset($properties))
188 $properties = array();
8beafbbc 189 $properties = mime_get_props($properties, $sub);
190 $structure = substr($structure, strlen($sub) + 2);
191 } else {
192 // loop through until we find a space or an end parenthesis
193 $pos = 0;
194 $char = substr($structure, $pos, 1);
195 while ($char != " " && $char != ")" && $pos < strlen($structure)) {
196 $text .= $char;
197 $pos++;
198 $char = substr($structure, $pos, 1);
aceb0d5c 199 }
8beafbbc 200 $structure = substr($structure, strlen($text));
aceb0d5c 201 }
e79bed1b 202 if ($debug_mime) echo "<tt>$elem_num : $text</tt><br>";
8beafbbc 203
204 // This is where all the text parts get put into the header
205 switch ($elem_num) {
206 case 1:
22ef7536 207 $msg->header->type0 = strtolower($text);
208 if ($debug_mime) echo "<tt>type0 = ".strtolower($text)."</tt><br>";
8beafbbc 209 break;
210 case 2:
22ef7536 211 $msg->header->type1 = strtolower($text);
212 if ($debug_mime) echo "<tt>type1 = ".strtolower($text)."</tt><br>";
8beafbbc 213 break;
ea48eb25 214 case 5:
215 $msg->header->description = $text;
216 if ($debug_mime) echo "<tt>description = $text</tt><br>";
217 break;
8beafbbc 218 case 6:
22ef7536 219 $msg->header->encoding = strtolower($text);
220 if ($debug_mime) echo "<tt>encoding = ".strtolower($text)."</tt><br>";
8beafbbc 221 break;
222 case 7:
ea48eb25 223 $msg->header->size = $text;
e79bed1b 224 if ($debug_mime) echo "<tt>size = $text</tt><br>";
8beafbbc 225 break;
226 default:
ea48eb25 227 if ($msg->header->type0 == "text" && $elem_num == 8) {
cbcf32f6 228 // This is a plain text message, so lets get the number of lines
229 // that it contains.
ea48eb25 230 $msg->header->num_lines = $text;
e79bed1b 231 if ($debug_mime) echo "<tt>num_lines = $text</tt><br>";
cbcf32f6 232
ea48eb25 233 } else if ($msg->header->type0 == "message" && $msg->header->type1 == "rfc822" && $elem_num == 8) {
234 // This is an encapsulated message, so lets start all over again and
235 // parse this message adding it on to the existing one.
236 $structure = trim($structure);
237 if (substr($structure, 0, 1) == "(") {
238 $e = mime_match_parenthesis (0, $structure);
239 $structure = substr($structure, 0, $e);
240 $structure = substr($structure, 1);
241 $m = mime_parse_structure($structure, $msg->header->entity_id);
cbcf32f6 242
243 // the following conditional is there to correct a bug that wasn't
244 // incrementing the entity IDs correctly because of the special case
245 // that message/rfc822 is. This fixes it fine.
ea48eb25 246 if (substr($structure, 1, 1) != "(")
247 $m->header->entity_id = mime_increment_id(mime_new_element_level($ent_id));
cbcf32f6 248
249 // Now we'll go through and reformat the results.
ea48eb25 250 if ($m->entities) {
251 for ($i=0; $i < count($m->entities); $i++) {
ea48eb25 252 $msg->addEntity($m->entities[$i]);
253 }
254 } else {
ea48eb25 255 $msg->addEntity($m);
256 }
257 $structure = "";
258 }
8beafbbc 259 }
260 break;
261 }
262 $elem_num++;
263 $text = "";
264 }
265 // loop through the additional properties and put those in the various headers
ea48eb25 266 if ($msg->header->type0 != "message") {
cbcf32f6 267 for ($i=0; $i < count($properties); $i++) {
268 $msg->header->{$properties[$i]["name"]} = $properties[$i]["value"];
269 if ($debug_mime) echo "<tt>".$properties[$i]["name"]." = " . $properties[$i]["value"] . "</tt><br>";
270 }
ea48eb25 271 }
e4a256af 272
ea48eb25 273 return $msg;
8beafbbc 274 }
275
276 // I did most of the MIME stuff yesterday (June 20, 2000), but I couldn't
277 // figure out how to do this part, so I decided to go to bed. I woke up
278 // in the morning and had a flash of insight. I went to the white-board
279 // and scribbled it out, then spent a bit programming it, and this is the
280 // result. Nothing complicated, but I think my brain was fried yesterday.
cbcf32f6 281 // Funny how that happens some times.
8beafbbc 282 //
283 // This gets properties in a nested parenthesisized list. For example,
284 // this would get passed something like: ("attachment" ("filename" "luke.tar.gz"))
285 // This returns an array called $props with all paired up properties.
286 // It ignores the "attachment" for now, maybe that should change later
287 // down the road. In this case, what is returned is:
288 // $props[0]["name"] = "filename";
289 // $props[0]["value"] = "luke.tar.gz";
290 function mime_get_props ($props, $structure) {
e79bed1b 291 global $debug_mime;
8beafbbc 292 while (strlen($structure) > 0) {
293 $structure = trim($structure);
294 $char = substr($structure, 0, 1);
295
296 if ($char == "\"") {
297 $pos = 1;
298 $char = substr($structure, $pos, 1);
245a6892 299 $tmp = "";
8beafbbc 300 while ($char != "\"" && $pos < strlen($structure)) {
301 $tmp .= $char;
302 $pos++;
303 $char = substr($structure, $pos, 1);
304 }
305 $structure = trim(substr($structure, strlen($tmp) + 2));
306 $char = substr($structure, 0, 1);
307
308 if ($char == "\"") {
309 $pos = 1;
310 $char = substr($structure, $pos, 1);
245a6892 311 $value = "";
8beafbbc 312 while ($char != "\"" && $pos < strlen($structure)) {
313 $value .= $char;
314 $pos++;
315 $char = substr($structure, $pos, 1);
316 }
317 $structure = trim(substr($structure, strlen($tmp) + 2));
318
319 $k = count($props);
22ef7536 320 $props[$k]["name"] = strtolower($tmp);
8beafbbc 321 $props[$k]["value"] = $value;
322 } else if ($char == "(") {
323 $end = mime_match_parenthesis (0, $structure);
324 $sub = substr($structure, 1, $end-1);
245a6892 325 if (! isset($props))
326 $props = array();
8beafbbc 327 $props = mime_get_props($props, $sub);
328 $structure = substr($structure, strlen($sub) + 2);
329 }
330 return $props;
331 } else if ($char == "(") {
332 $end = mime_match_parenthesis (0, $structure);
333 $sub = substr($structure, 1, $end-1);
334 $props = mime_get_props($props, $sub);
335 $structure = substr($structure, strlen($sub) + 2);
ea48eb25 336 return $props;
8beafbbc 337 } else {
338 return $props;
7831268e 339 }
8beafbbc 340 }
341 }
7831268e 342
8beafbbc 343 // Matches parenthesis. It will return the position of the matching
344 // parenthesis in $structure. For instance, if $structure was:
345 // ("text" "plain" ("val1name", "1") nil ... )
346 // x x
347 // then this would return 42 to match up those two.
348 function mime_match_parenthesis ($pos, $structure) {
349 $char = substr($structure, $pos, 1);
350
351 // ignore all extra characters
5ffe5a7e 352 // If inside of a string, skip string -- Boundary IDs and other
353 // things can have ) in them.
8beafbbc 354 while ($pos < strlen($structure)) {
355 $pos++;
356 $char = substr($structure, $pos, 1);
357 if ($char == ")") {
358 return $pos;
5ffe5a7e 359 } else if ($char == '"') {
360 $pos ++;
361 while (substr($structure, $pos, 1) != '"' &&
362 $pos < strlen($structure)) {
363 $pos ++;
364 }
8beafbbc 365 } else if ($char == "(") {
366 $pos = mime_match_parenthesis ($pos, $structure);
367 }
d4467150 368 }
8beafbbc 369 }
d4467150 370
8beafbbc 371 function mime_fetch_body ($imap_stream, $id, $ent_id) {
372 // do a bit of error correction. If we couldn't find the entity id, just guess
373 // that it is the first one. That is usually the case anyway.
374 if (!$ent_id) $ent_id = 1;
375
4c5da285 376 fputs ($imap_stream, "a010 FETCH $id BODY[$ent_id]\r\n");
377 $data = sqimap_read_data ($imap_stream, 'a010', true, $response, $message);
2d32cb9f 378 $topline = array_shift($data);
379 while (! ereg('\* [0-9]+ FETCH ', $topline) && data)
380 $topline = array_shift($data);
6ff90ce9 381 $wholemessage = implode('', $data);
2d32cb9f 382
441f2d33 383 if (ereg('\{([^\}]*)\}', $topline, $regs)) {
2d32cb9f 384 return substr($wholemessage, 0, $regs[1]);
441f2d33 385 }
386 else if (ereg('"([^"]*)"', $topline, $regs)) {
387 return $regs[1];
388 }
2d32cb9f 389
390 $str = "Body retrival error. Please report this bug!\n";
391 $str .= "Response: $response\n";
392 $str .= "Message: $message\n";
393 $str .= "FETCH line: $topline";
394 $str .= "---------------\n$wholemessage";
395 foreach ($data as $d)
396 {
397 $str .= htmlspecialchars($d) . "\n";
398 }
399 return $str;
400
441f2d33 401 return "Body retrival error, please report this bug!\n\nTop line is \"$topline\"\n";
d4467150 402 }
403
beb9e459 404 function mime_print_body_lines ($imap_stream, $id, $ent_id, $encoding) {
405 // do a bit of error correction. If we couldn't find the entity id, just guess
406 // that it is the first one. That is usually the case anyway.
407 if (!$ent_id) $ent_id = 1;
408
409 fputs ($imap_stream, "a001 FETCH $id BODY[$ent_id]\r\n");
410 $cnt = 0;
411 $continue = true;
412 $read = fgets ($imap_stream,4096);
413 while (!ereg("^a001 (OK|BAD|NO)(.*)$", $read, $regs)) {
414 if (trim($read) == ")==") {
415 $read1 = $read;
416 $read = fgets ($imap_stream,4096);
417 if (ereg("^a001 (OK|BAD|NO)(.*)$", $read, $regs)) {
418 return;
419 } else {
420 echo decodeBody($read1, $encoding);
421 echo decodeBody($read, $encoding);
422 }
423 } else if ($cnt) {
424 echo decodeBody($read, $encoding);
425 }
426 $read = fgets ($imap_stream,4096);
427 $cnt++;
428 }
429 }
430
8beafbbc 431 /* -[ END MIME DECODING ]----------------------------------------------------------- */
d4467150 432
aceb0d5c 433
d4467150 434
8beafbbc 435 /** This is the first function called. It decides if this is a multipart
436 message or if it should be handled as a single entity
4809f489 437 **/
090595e1 438 function decodeMime ($imap_stream, &$header) {
8beafbbc 439 global $username, $key, $imapServerAddress, $imapPort;
8d8ab69a 440 return mime_structure ($imap_stream, $header);
8beafbbc 441 }
b1dadc61 442
cbcf32f6 443 // This is here for debugging purposese. It will print out a list
444 // of all the entity IDs that are in the $message object.
ea48eb25 445 function listEntities ($message) {
446 if ($message) {
cbcf32f6 447 if ($message->header->entity_id)
448 echo "<tt>" . $message->header->entity_id . " : " . $message->header->type0 . "/" . $message->header->type1 . "<br>";
449 for ($i = 0; $message->entities[$i]; $i++) {
450 $msg = listEntities($message->entities[$i], $ent_id);
451 if ($msg)
452 return $msg;
453 }
ea48eb25 454 }
455 }
456
cbcf32f6 457 // returns a $message object for a particular entity id
8beafbbc 458 function getEntity ($message, $ent_id) {
459 if ($message) {
ea48eb25 460 if ($message->header->entity_id == $ent_id && strlen($ent_id) == strlen($message->header->entity_id)) {
8beafbbc 461 return $message;
b1dadc61 462 } else {
8beafbbc 463 for ($i = 0; $message->entities[$i]; $i++) {
464 $msg = getEntity ($message->entities[$i], $ent_id);
465 if ($msg)
466 return $msg;
b1dadc61 467 }
8beafbbc 468 }
469 }
470 }
471
cbcf32f6 472 // figures out what entity to display and returns the $message object
473 // for that entity.
8beafbbc 474 function findDisplayEntity ($message) {
475 if ($message) {
476 if ($message->header->type0 == "text") {
477 if ($message->header->type1 == "plain" ||
478 $message->header->type1 == "html") {
245a6892 479 if (isset($message->header->entity_id))
480 return $message->header->entity_id;
481 return 0;
8beafbbc 482 }
483 } else {
484 for ($i=0; $message->entities[$i]; $i++) {
485 return findDisplayEntity($message->entities[$i]);
486 }
487 }
d4467150 488 }
b1dadc61 489 }
8405ee35 490
d068c0ec 491 /** This returns a parsed string called $body. That string can then
492 be displayed as the actual message in the HTML. It contains
493 everything needed, including HTML Tags, Attachments at the
494 bottom, etc.
4809f489 495 **/
8d8ab69a 496 function formatBody($imap_stream, $message, $color, $wrap_at) {
cbcf32f6 497 // this if statement checks for the entity to show as the
498 // primary message. To add more of them, just put them in the
499 // order that is their priority.
a037624d 500 global $startMessage, $username, $key, $imapServerAddress, $imapPort;
8beafbbc 501
8beafbbc 502 $id = $message->header->id;
503 $urlmailbox = urlencode($message->header->mailbox);
504
e4a256af 505 // Get the right entity and redefine message to be this entity
8beafbbc 506 $ent_num = findDisplayEntity ($message);
2c252f5a 507 $body_message = getEntity($message, $ent_num);
d4ff4d67 508 if (($body_message->header->type0 == "text") ||
509 ($body_message->header->type0 == "rfc822")) {
510
511 $body = mime_fetch_body ($imap_stream, $id, $ent_num);
512 $body = decodeBody($body, $body_message->header->encoding);
513
514 // If there are other types that shouldn't be formatted, add
515 // them here
f9b3e5d9 516 if ($body_message->header->type1 != "html") {
9eea179c 517 translateText($body, $wrap_at, $body_message->header->charset);
d4ff4d67 518 }
519
bc104ef3 520 $body .= "<SMALL><CENTER><A HREF=\"../src/download.php?absolute_dl=true&passed_id=$id&passed_ent_id=$ent_num&mailbox=$urlmailbox\">". _("Download this as a file") ."</A></CENTER><BR></SMALL>";
d4ff4d67 521
522 /** Display the ATTACHMENTS: message if there's more than one part **/
dd389be5 523 $body .= "</TD></TR></TABLE>";
719534f2 524 if (isset($message->entities[0])) {
d4ff4d67 525 $body .= formatAttachments ($message, $ent_num, $message->header->mailbox, $id);
d4ff4d67 526 }
527 } else {
dd389be5 528 $body .= formatAttachments ($message, -1, $message->header->mailbox, $id);
8405ee35 529 }
d4467150 530 return $body;
531 }
532
8beafbbc 533 // A recursive function that returns a list of attachments with links
534 // to where to download these attachments
535 function formatAttachments ($message, $ent_id, $mailbox, $id) {
f4991a86 536 global $where, $what;
dd389be5 537 global $startMessage, $color;
719534f2 538 static $ShownHTML = 0;
dd389be5 539
61423189 540 $body = "";
dd389be5 541 if ($ShownHTML == 0)
542 {
543 $ShownHTML = 1;
544
545 $body .= "<TABLE WIDTH=100% CELLSPACING=0 CELLPADDING=2 BORDER=0 BGCOLOR=\"$color[0]\"><TR>\n";
546 $body .= "<TH ALIGN=\"left\" BGCOLOR=\"$color[9]\"><B>\n";
701c9c6b 547 $body .= _("Attachments") . ':';
dd389be5 548 $body .= "</B></TH></TR><TR><TD>\n";
549
550 $body .= "<TABLE CELLSPACING=0 CELLPADDING=1 BORDER=0>\n";
551
552 $body .= formatAttachments ($message, $ent_id, $mailbox, $id);
553
554 $body .= "</TABLE></TD></TR></TABLE>";
555
556 return $body;
557 }
558
8beafbbc 559 if ($message) {
560 if (!$message->entities) {
561 $type0 = strtolower($message->header->type0);
562 $type1 = strtolower($message->header->type1);
563
564 if ($message->header->entity_id != $ent_id) {
888c82e2 565 $filename = decodeHeader($message->header->filename);
8beafbbc 566 if (trim($filename) == "") {
ea48eb25 567 $display_filename = "untitled-".$message->header->entity_id;
8beafbbc 568 } else {
569 $display_filename = $filename;
570 }
571
572 $urlMailbox = urlencode($mailbox);
573 $ent = urlencode($message->header->entity_id);
dd389be5 574
575 $DefaultLink =
bc104ef3 576 "../src/download.php?startMessage=$startMessage&passed_id=$id&mailbox=$urlMailbox&passed_ent_id=$ent";
dd389be5 577 if ($where && $what)
578 $DefaultLink .= '&where=' . urlencode($where) . '&what=' . urlencode($what);
701c9c6b 579 $Links['download link']['text'] = _("download");
dd389be5 580 $Links['download link']['href'] =
bc104ef3 581 "../src/download.php?absolute_dl=true&passed_id=$id&mailbox=$urlMailbox&passed_ent_id=$ent";
dd389be5 582 $ImageURL = '';
583
584 $HookResults = do_hook("attachment $type0/$type1", $Links,
585 $startMessage, $id, $urlMailbox, $ent, $DefaultLink,
ef30bf50 586 $display_filename, $where, $what);
dd389be5 587
588 $Links = $HookResults[1];
589 $DefaultLink = $HookResults[6];
590
fde32e3f 591 $body .= '<TR><TD>&nbsp;&nbsp;</TD><TD>';
592 $body .= "<A HREF=\"$DefaultLink\">$display_filename</A>&nbsp;</TD>";
6e7468f6 593 $body .= '<TD><SMALL><b>' . show_readable_size($message->header->size) .
594 '</b>&nbsp;&nbsp;</small></TD>';
fde32e3f 595 $body .= "<TD><SMALL>[ $type0/$type1 ]&nbsp;</SMALL></TD>";
596 $body .= '<TD><SMALL>';
ea48eb25 597 if ($message->header->description)
dd389be5 598 $body .= '<b>' . htmlspecialchars($message->header->description) . '</b>';
fde32e3f 599 $body .= '</SMALL></TD><TD><SMALL>&nbsp;';
dd389be5 600
601
602 $SkipSpaces = 1;
603 foreach ($Links as $Val)
604 {
605 if ($SkipSpaces)
606 {
607 $SkipSpaces = 0;
608 }
609 else
610 {
fde32e3f 611 $body .= '&nbsp;&nbsp;|&nbsp;&nbsp;';
dd389be5 612 }
fde32e3f 613 $body .= '<a href="' . $Val['href'] . '">' . $Val['text'] . '</a>';
dd389be5 614 }
615
616 unset($Links);
617
fde32e3f 618 $body .= "</SMALL></TD></TR>\n";
8beafbbc 619 }
620 return $body;
621 } else {
622 for ($i = 0; $i < count($message->entities); $i++) {
623 $body .= formatAttachments ($message->entities[$i], $ent_id, $mailbox, $id);
624 }
625 return $body;
626 }
627 }
628 }
4809f489 629
630
631 /** this function decodes the body depending on the encoding type. **/
d4467150 632 function decodeBody($body, $encoding) {
623332f3 633 $body = str_replace("\r\n", "\n", $body);
d4467150 634 $encoding = strtolower($encoding);
7831268e 635
ef3f274f 636 if ($encoding == "quoted-printable") {
637 $body = quoted_printable_decode($body);
db87f79c 638
ef3f274f 639 while (ereg("=\n", $body))
640 $body = ereg_replace ("=\n", "", $body);
97be2168 641 } else if ($encoding == "base64") {
ef3f274f 642 $body = base64_decode($body);
d4467150 643 }
ef3f274f 644
645 // All other encodings are returned raw.
646 return $body;
aceb0d5c 647 }
a4c2cd49 648
649
650 // This functions decode strings that is encoded according to
651 // RFC1522 (MIME Part Two: Message Header Extensions for Non-ASCII Text).
2e434774 652 function decodeHeader ($string) {
1fd97780 653 if (eregi('=\?([^?]+)\?(q|b)\?([^?]+)\?=',
a4c2cd49 654 $string, $res)) {
1fd97780 655 if (ucfirst($res[2]) == "B") {
656 $replace = base64_decode($res[3]);
a4c2cd49 657 } else {
1fd97780 658 $replace = ereg_replace("_", " ", $res[3]);
5155cfcb 659 // Convert lowercase Quoted Printable to uppercase for
660 // quoted_printable_decode to understand it.
b75d343f 661 while (ereg("(=([0-9][abcdef])|([abcdef][0-9])|([abcdef][abcdef]))", $replace, $res)) {
5155cfcb 662 $replace = str_replace($res[1], strtoupper($res[1]), $replace);
663 }
a4c2cd49 664 $replace = quoted_printable_decode($replace);
665 }
666
1fd97780 667 $replace = charset_decode ($res[1], $replace);
a4c2cd49 668
669 $string = eregi_replace
1fd97780 670 ('=\?([^?]+)\?(q|b)\?([^?]+)\?=',
a4c2cd49 671 $replace, $string);
2e434774 672 // In case there should be more encoding in the string: recurse
673 return (decodeHeader($string));
a4c2cd49 674 } else
675 return ($string);
676 }
677
c3084273 678 // Encode a string according to RFC 1522 for use in headers if it
bb60fa3f 679 // contains 8-bit characters or anything that looks like it should
680 // be encoded.
c3084273 681 function encodeHeader ($string) {
682 global $default_charset;
683
bb60fa3f 684 // Encode only if the string contains 8-bit characters or =?
46562113 685 if (ereg("([\200-\377]|=\\?)", $string)) {
c3084273 686 $newstring = "=?$default_charset?Q?";
c3084273 687
bb60fa3f 688 // First the special characters
689 $string = str_replace("=", "=3D", $string);
690 $string = str_replace("?", "=3F", $string);
691 $string = str_replace("_", "=5F", $string);
692 $string = str_replace(" ", "_", $string);
693
b75d343f 694 for ( $ch = 127 ; $ch <= 255 ; $ch++ ) {
695 $replace = chr($ch);
696 $insert = sprintf("=%02X", $ch);
bb60fa3f 697 $string = str_replace($replace, $insert, $string);
b75d343f 698 $ch++;
c3084273 699 }
700
bb60fa3f 701 $newstring = "=?$default_charset?Q?".$string."?=";
702
c3084273 703 return $newstring;
704 }
705
706 return $string;
707 }
708
9f9d7d28 709?>