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 = ''; |
66e1a00e |
31 | var $entity_id = 0, $message_id = 0, $name = ''; |
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> 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; |
4bbe6ccc |
164 | $properties = array(); |
8beafbbc |
165 | |
166 | while (strlen($structure) > 0) { |
167 | $structure = trim($structure); |
168 | $char = substr($structure, 0, 1); |
169 | |
e86ab872 |
170 | if (strtolower(substr($structure, 0, 3)) == "nil") { |
8beafbbc |
171 | $text = ""; |
172 | $structure = substr($structure, 3); |
173 | } else if ($char == "\"") { |
174 | // loop through until we find the matching quote, and return that as a string |
175 | $pos = 1; |
176 | $char = substr($structure, $pos, 1); |
245a6892 |
177 | $text = ""; |
8beafbbc |
178 | while ($char != "\"" && $pos < strlen($structure)) { |
179 | $text .= $char; |
180 | $pos++; |
181 | $char = substr($structure, $pos, 1); |
182 | } |
183 | $structure = substr($structure, strlen($text) + 2); |
184 | } else if ($char == "(") { |
185 | // comment me |
186 | $end = mime_match_parenthesis (0, $structure); |
187 | $sub = substr($structure, 1, $end-1); |
188 | $properties = mime_get_props($properties, $sub); |
189 | $structure = substr($structure, strlen($sub) + 2); |
190 | } else { |
191 | // loop through until we find a space or an end parenthesis |
192 | $pos = 0; |
193 | $char = substr($structure, $pos, 1); |
61d9e885 |
194 | $text = ""; |
8beafbbc |
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. |
4bbe6ccc |
354 | if ($char != '(') |
355 | return strlen($structure); |
8beafbbc |
356 | while ($pos < strlen($structure)) { |
357 | $pos++; |
358 | $char = substr($structure, $pos, 1); |
359 | if ($char == ")") { |
360 | return $pos; |
5ffe5a7e |
361 | } else if ($char == '"') { |
362 | $pos ++; |
363 | while (substr($structure, $pos, 1) != '"' && |
364 | $pos < strlen($structure)) { |
377a40b2 |
365 | if (substr($structure, $pos, 2) == '\\"') |
366 | $pos ++; |
367 | elseif (substr($structure, $pos, 2) == '\\\\') |
368 | $pos ++; |
5ffe5a7e |
369 | $pos ++; |
370 | } |
8beafbbc |
371 | } else if ($char == "(") { |
372 | $pos = mime_match_parenthesis ($pos, $structure); |
373 | } |
d4467150 |
374 | } |
377a40b2 |
375 | echo "Error decoding mime structure. Report this as a bug!<br>\n"; |
376 | return $pos; |
8beafbbc |
377 | } |
d4467150 |
378 | |
8beafbbc |
379 | function mime_fetch_body ($imap_stream, $id, $ent_id) { |
380 | // do a bit of error correction. If we couldn't find the entity id, just guess |
381 | // that it is the first one. That is usually the case anyway. |
382 | if (!$ent_id) $ent_id = 1; |
383 | |
4c5da285 |
384 | fputs ($imap_stream, "a010 FETCH $id BODY[$ent_id]\r\n"); |
385 | $data = sqimap_read_data ($imap_stream, 'a010', true, $response, $message); |
2d32cb9f |
386 | $topline = array_shift($data); |
146e0c45 |
387 | while (! ereg('\\* [0-9]+ FETCH ', $topline) && data) |
2d32cb9f |
388 | $topline = array_shift($data); |
6ff90ce9 |
389 | $wholemessage = implode('', $data); |
2d32cb9f |
390 | |
146e0c45 |
391 | if (ereg('\\{([^\\}]*)\\}', $topline, $regs)) { |
2d32cb9f |
392 | return substr($wholemessage, 0, $regs[1]); |
441f2d33 |
393 | } |
394 | else if (ereg('"([^"]*)"', $topline, $regs)) { |
395 | return $regs[1]; |
396 | } |
2d32cb9f |
397 | |
398 | $str = "Body retrival error. Please report this bug!\n"; |
399 | $str .= "Response: $response\n"; |
400 | $str .= "Message: $message\n"; |
401 | $str .= "FETCH line: $topline"; |
402 | $str .= "---------------\n$wholemessage"; |
403 | foreach ($data as $d) |
404 | { |
405 | $str .= htmlspecialchars($d) . "\n"; |
406 | } |
407 | return $str; |
408 | |
441f2d33 |
409 | return "Body retrival error, please report this bug!\n\nTop line is \"$topline\"\n"; |
d4467150 |
410 | } |
411 | |
beb9e459 |
412 | function mime_print_body_lines ($imap_stream, $id, $ent_id, $encoding) { |
413 | // do a bit of error correction. If we couldn't find the entity id, just guess |
414 | // that it is the first one. That is usually the case anyway. |
415 | if (!$ent_id) $ent_id = 1; |
416 | |
417 | fputs ($imap_stream, "a001 FETCH $id BODY[$ent_id]\r\n"); |
418 | $cnt = 0; |
419 | $continue = true; |
420 | $read = fgets ($imap_stream,4096); |
421 | while (!ereg("^a001 (OK|BAD|NO)(.*)$", $read, $regs)) { |
422 | if (trim($read) == ")==") { |
423 | $read1 = $read; |
424 | $read = fgets ($imap_stream,4096); |
425 | if (ereg("^a001 (OK|BAD|NO)(.*)$", $read, $regs)) { |
426 | return; |
427 | } else { |
428 | echo decodeBody($read1, $encoding); |
429 | echo decodeBody($read, $encoding); |
430 | } |
431 | } else if ($cnt) { |
432 | echo decodeBody($read, $encoding); |
433 | } |
434 | $read = fgets ($imap_stream,4096); |
435 | $cnt++; |
436 | } |
437 | } |
438 | |
8beafbbc |
439 | /* -[ END MIME DECODING ]----------------------------------------------------------- */ |
d4467150 |
440 | |
aceb0d5c |
441 | |
d4467150 |
442 | |
8beafbbc |
443 | /** This is the first function called. It decides if this is a multipart |
444 | message or if it should be handled as a single entity |
4809f489 |
445 | **/ |
090595e1 |
446 | function decodeMime ($imap_stream, &$header) { |
8beafbbc |
447 | global $username, $key, $imapServerAddress, $imapPort; |
8d8ab69a |
448 | return mime_structure ($imap_stream, $header); |
8beafbbc |
449 | } |
b1dadc61 |
450 | |
cbcf32f6 |
451 | // This is here for debugging purposese. It will print out a list |
452 | // of all the entity IDs that are in the $message object. |
ea48eb25 |
453 | function listEntities ($message) { |
454 | if ($message) { |
cbcf32f6 |
455 | if ($message->header->entity_id) |
456 | echo "<tt>" . $message->header->entity_id . " : " . $message->header->type0 . "/" . $message->header->type1 . "<br>"; |
457 | for ($i = 0; $message->entities[$i]; $i++) { |
458 | $msg = listEntities($message->entities[$i], $ent_id); |
459 | if ($msg) |
460 | return $msg; |
461 | } |
ea48eb25 |
462 | } |
463 | } |
464 | |
cbcf32f6 |
465 | // returns a $message object for a particular entity id |
8beafbbc |
466 | function getEntity ($message, $ent_id) { |
467 | if ($message) { |
ea48eb25 |
468 | if ($message->header->entity_id == $ent_id && strlen($ent_id) == strlen($message->header->entity_id)) { |
8beafbbc |
469 | return $message; |
b1dadc61 |
470 | } else { |
cd928157 |
471 | for ($i = 0; isset($message->entities[$i]); $i++) { |
8beafbbc |
472 | $msg = getEntity ($message->entities[$i], $ent_id); |
473 | if ($msg) |
474 | return $msg; |
b1dadc61 |
475 | } |
8beafbbc |
476 | } |
477 | } |
478 | } |
479 | |
cbcf32f6 |
480 | // figures out what entity to display and returns the $message object |
481 | // for that entity. |
8beafbbc |
482 | function findDisplayEntity ($message) { |
483 | if ($message) { |
484 | if ($message->header->type0 == "text") { |
485 | if ($message->header->type1 == "plain" || |
486 | $message->header->type1 == "html") { |
245a6892 |
487 | if (isset($message->header->entity_id)) |
488 | return $message->header->entity_id; |
489 | return 0; |
8beafbbc |
490 | } |
491 | } else { |
492 | for ($i=0; $message->entities[$i]; $i++) { |
493 | return findDisplayEntity($message->entities[$i]); |
494 | } |
495 | } |
d4467150 |
496 | } |
b1dadc61 |
497 | } |
8405ee35 |
498 | |
d068c0ec |
499 | /** This returns a parsed string called $body. That string can then |
500 | be displayed as the actual message in the HTML. It contains |
501 | everything needed, including HTML Tags, Attachments at the |
502 | bottom, etc. |
4809f489 |
503 | **/ |
8d8ab69a |
504 | function formatBody($imap_stream, $message, $color, $wrap_at) { |
cbcf32f6 |
505 | // this if statement checks for the entity to show as the |
506 | // primary message. To add more of them, just put them in the |
507 | // order that is their priority. |
a037624d |
508 | global $startMessage, $username, $key, $imapServerAddress, $imapPort; |
8beafbbc |
509 | |
8beafbbc |
510 | $id = $message->header->id; |
511 | $urlmailbox = urlencode($message->header->mailbox); |
512 | |
e4a256af |
513 | // Get the right entity and redefine message to be this entity |
8beafbbc |
514 | $ent_num = findDisplayEntity ($message); |
2c252f5a |
515 | $body_message = getEntity($message, $ent_num); |
d4ff4d67 |
516 | if (($body_message->header->type0 == "text") || |
517 | ($body_message->header->type0 == "rfc822")) { |
518 | |
d51894be |
519 | $body = mime_fetch_body ($imap_stream, $id, $ent_num); |
d4ff4d67 |
520 | $body = decodeBody($body, $body_message->header->encoding); |
521 | |
522 | // If there are other types that shouldn't be formatted, add |
523 | // them here |
f9b3e5d9 |
524 | if ($body_message->header->type1 != "html") { |
9eea179c |
525 | translateText($body, $wrap_at, $body_message->header->charset); |
d4ff4d67 |
526 | } |
527 | |
bc104ef3 |
528 | $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 |
529 | |
530 | /** Display the ATTACHMENTS: message if there's more than one part **/ |
dd389be5 |
531 | $body .= "</TD></TR></TABLE>"; |
719534f2 |
532 | if (isset($message->entities[0])) { |
d4ff4d67 |
533 | $body .= formatAttachments ($message, $ent_num, $message->header->mailbox, $id); |
d4ff4d67 |
534 | } |
535 | } else { |
dd389be5 |
536 | $body .= formatAttachments ($message, -1, $message->header->mailbox, $id); |
8405ee35 |
537 | } |
d4467150 |
538 | return $body; |
539 | } |
540 | |
8beafbbc |
541 | // A recursive function that returns a list of attachments with links |
542 | // to where to download these attachments |
543 | function formatAttachments ($message, $ent_id, $mailbox, $id) { |
f4991a86 |
544 | global $where, $what; |
dd389be5 |
545 | global $startMessage, $color; |
719534f2 |
546 | static $ShownHTML = 0; |
dd389be5 |
547 | |
61423189 |
548 | $body = ""; |
dd389be5 |
549 | if ($ShownHTML == 0) |
550 | { |
551 | $ShownHTML = 1; |
552 | |
553 | $body .= "<TABLE WIDTH=100% CELLSPACING=0 CELLPADDING=2 BORDER=0 BGCOLOR=\"$color[0]\"><TR>\n"; |
554 | $body .= "<TH ALIGN=\"left\" BGCOLOR=\"$color[9]\"><B>\n"; |
701c9c6b |
555 | $body .= _("Attachments") . ':'; |
dd389be5 |
556 | $body .= "</B></TH></TR><TR><TD>\n"; |
557 | |
558 | $body .= "<TABLE CELLSPACING=0 CELLPADDING=1 BORDER=0>\n"; |
559 | |
560 | $body .= formatAttachments ($message, $ent_id, $mailbox, $id); |
561 | |
562 | $body .= "</TABLE></TD></TR></TABLE>"; |
563 | |
564 | return $body; |
565 | } |
566 | |
8beafbbc |
567 | if ($message) { |
568 | if (!$message->entities) { |
569 | $type0 = strtolower($message->header->type0); |
570 | $type1 = strtolower($message->header->type1); |
66e1a00e |
571 | $name = decodeHeader($message->header->name); |
8beafbbc |
572 | |
573 | if ($message->header->entity_id != $ent_id) { |
888c82e2 |
574 | $filename = decodeHeader($message->header->filename); |
8beafbbc |
575 | if (trim($filename) == "") { |
66e1a00e |
576 | if (trim($name) == "") { |
577 | $display_filename = "untitled-".$message->header->entity_id; |
578 | } else { |
579 | $display_filename = $name; |
580 | $filename = $name; |
581 | } |
8beafbbc |
582 | } else { |
583 | $display_filename = $filename; |
584 | } |
585 | |
586 | $urlMailbox = urlencode($mailbox); |
587 | $ent = urlencode($message->header->entity_id); |
dd389be5 |
588 | |
589 | $DefaultLink = |
bc104ef3 |
590 | "../src/download.php?startMessage=$startMessage&passed_id=$id&mailbox=$urlMailbox&passed_ent_id=$ent"; |
dd389be5 |
591 | if ($where && $what) |
592 | $DefaultLink .= '&where=' . urlencode($where) . '&what=' . urlencode($what); |
701c9c6b |
593 | $Links['download link']['text'] = _("download"); |
dd389be5 |
594 | $Links['download link']['href'] = |
bc104ef3 |
595 | "../src/download.php?absolute_dl=true&passed_id=$id&mailbox=$urlMailbox&passed_ent_id=$ent"; |
dd389be5 |
596 | $ImageURL = ''; |
597 | |
598 | $HookResults = do_hook("attachment $type0/$type1", $Links, |
599 | $startMessage, $id, $urlMailbox, $ent, $DefaultLink, |
ef30bf50 |
600 | $display_filename, $where, $what); |
dd389be5 |
601 | |
602 | $Links = $HookResults[1]; |
603 | $DefaultLink = $HookResults[6]; |
604 | |
fde32e3f |
605 | $body .= '<TR><TD> </TD><TD>'; |
606 | $body .= "<A HREF=\"$DefaultLink\">$display_filename</A> </TD>"; |
6e7468f6 |
607 | $body .= '<TD><SMALL><b>' . show_readable_size($message->header->size) . |
608 | '</b> </small></TD>'; |
fde32e3f |
609 | $body .= "<TD><SMALL>[ $type0/$type1 ] </SMALL></TD>"; |
610 | $body .= '<TD><SMALL>'; |
ea48eb25 |
611 | if ($message->header->description) |
dd389be5 |
612 | $body .= '<b>' . htmlspecialchars($message->header->description) . '</b>'; |
fde32e3f |
613 | $body .= '</SMALL></TD><TD><SMALL> '; |
dd389be5 |
614 | |
615 | |
616 | $SkipSpaces = 1; |
617 | foreach ($Links as $Val) |
618 | { |
619 | if ($SkipSpaces) |
620 | { |
621 | $SkipSpaces = 0; |
622 | } |
623 | else |
624 | { |
fde32e3f |
625 | $body .= ' | '; |
dd389be5 |
626 | } |
fde32e3f |
627 | $body .= '<a href="' . $Val['href'] . '">' . $Val['text'] . '</a>'; |
dd389be5 |
628 | } |
629 | |
630 | unset($Links); |
631 | |
fde32e3f |
632 | $body .= "</SMALL></TD></TR>\n"; |
8beafbbc |
633 | } |
634 | return $body; |
635 | } else { |
636 | for ($i = 0; $i < count($message->entities); $i++) { |
637 | $body .= formatAttachments ($message->entities[$i], $ent_id, $mailbox, $id); |
638 | } |
639 | return $body; |
640 | } |
641 | } |
642 | } |
4809f489 |
643 | |
644 | |
645 | /** this function decodes the body depending on the encoding type. **/ |
d4467150 |
646 | function decodeBody($body, $encoding) { |
623332f3 |
647 | $body = str_replace("\r\n", "\n", $body); |
d4467150 |
648 | $encoding = strtolower($encoding); |
7831268e |
649 | |
ef3f274f |
650 | if ($encoding == "quoted-printable") { |
651 | $body = quoted_printable_decode($body); |
db87f79c |
652 | |
ef3f274f |
653 | while (ereg("=\n", $body)) |
654 | $body = ereg_replace ("=\n", "", $body); |
97be2168 |
655 | } else if ($encoding == "base64") { |
ef3f274f |
656 | $body = base64_decode($body); |
d4467150 |
657 | } |
ef3f274f |
658 | |
659 | // All other encodings are returned raw. |
660 | return $body; |
aceb0d5c |
661 | } |
a4c2cd49 |
662 | |
663 | |
664 | // This functions decode strings that is encoded according to |
665 | // RFC1522 (MIME Part Two: Message Header Extensions for Non-ASCII Text). |
2e434774 |
666 | function decodeHeader ($string) { |
146e0c45 |
667 | if (eregi('=\\?([^?]+)\\?(q|b)\\?([^?]+)\\?=', |
a4c2cd49 |
668 | $string, $res)) { |
1fd97780 |
669 | if (ucfirst($res[2]) == "B") { |
670 | $replace = base64_decode($res[3]); |
a4c2cd49 |
671 | } else { |
1fd97780 |
672 | $replace = ereg_replace("_", " ", $res[3]); |
5155cfcb |
673 | // Convert lowercase Quoted Printable to uppercase for |
674 | // quoted_printable_decode to understand it. |
b75d343f |
675 | while (ereg("(=([0-9][abcdef])|([abcdef][0-9])|([abcdef][abcdef]))", $replace, $res)) { |
5155cfcb |
676 | $replace = str_replace($res[1], strtoupper($res[1]), $replace); |
677 | } |
a4c2cd49 |
678 | $replace = quoted_printable_decode($replace); |
679 | } |
680 | |
1fd97780 |
681 | $replace = charset_decode ($res[1], $replace); |
a4c2cd49 |
682 | |
683 | $string = eregi_replace |
146e0c45 |
684 | ('=\\?([^?]+)\\?(q|b)\\?([^?]+)\\?=', |
a4c2cd49 |
685 | $replace, $string); |
2e434774 |
686 | // In case there should be more encoding in the string: recurse |
687 | return (decodeHeader($string)); |
a4c2cd49 |
688 | } else |
689 | return ($string); |
690 | } |
691 | |
c3084273 |
692 | // Encode a string according to RFC 1522 for use in headers if it |
bb60fa3f |
693 | // contains 8-bit characters or anything that looks like it should |
694 | // be encoded. |
c3084273 |
695 | function encodeHeader ($string) { |
696 | global $default_charset; |
697 | |
bb60fa3f |
698 | // Encode only if the string contains 8-bit characters or =? |
46562113 |
699 | if (ereg("([\200-\377]|=\\?)", $string)) { |
c3084273 |
700 | $newstring = "=?$default_charset?Q?"; |
c3084273 |
701 | |
bb60fa3f |
702 | // First the special characters |
703 | $string = str_replace("=", "=3D", $string); |
704 | $string = str_replace("?", "=3F", $string); |
705 | $string = str_replace("_", "=5F", $string); |
706 | $string = str_replace(" ", "_", $string); |
707 | |
b75d343f |
708 | for ( $ch = 127 ; $ch <= 255 ; $ch++ ) { |
709 | $replace = chr($ch); |
710 | $insert = sprintf("=%02X", $ch); |
bb60fa3f |
711 | $string = str_replace($replace, $insert, $string); |
b75d343f |
712 | $ch++; |
c3084273 |
713 | } |
714 | |
bb60fa3f |
715 | $newstring = "=?$default_charset?Q?".$string."?="; |
716 | |
c3084273 |
717 | return $newstring; |
718 | } |
719 | |
720 | return $string; |
721 | } |
722 | |
9f9d7d28 |
723 | ?> |