if $key is set to false, sqimap_login() function will use sqauth_read_password()
[squirrelmail.git] / plugins / message_details / message_details_bottom.php
1 <?php
2
3 /**
4 * Message Details plugin - bottom frame with message structure and rfc822 body
5 *
6 * Plugin to view the RFC822 raw message output and the bodystructure of a message
7 *
8 * @author Marc Groot Koerkamp
9 * @copyright &copy; 2002 Marc Groot Koerkamp, The Netherlands
10 * @copyright &copy; 2002-2006 The SquirrelMail Project Team
11 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
12 * @version $Id$
13 * @package plugins
14 * @subpackage message_details
15 */
16
17 /**
18 * Include the SquirrelMail initialization file.
19 */
20 require('../../include/init.php');
21 require(SM_PATH . 'functions/imap_general.php');
22 require(SM_PATH . 'functions/imap_messages.php');
23 require(SM_PATH . 'functions/mime.php');
24
25 sqgetGlobalVar('get_message_details', $md_action, SQ_GET);
26
27 /**
28 * Controls display of 8bit symbols in message source
29 * @global boolean $msgd_8bit_in_hex;
30 */
31 global $msgd_8bit_in_hex;
32 $msgd_8bit_in_hex=false;
33
34 if (!empty($md_action))
35 {
36 sqgetGlobalVar('passed_id', $passed_id, SQ_GET);
37 sqgetGlobalVar('mailbox', $mailbox, SQ_GET);
38 echo get_message_details($mailbox, $passed_id);
39 }
40
41
42 // ---------- function definitions ----------
43
44 /**
45 * Converts 8bit string to hex
46 *
47 * Replaces 8bit symbols with their hex strings,
48 * encloses them in curly brackets and uses different color.
49 * @param string $string text
50 * @return string
51 * @since 1.5.1
52 */
53 function msgd_convert_to_hex($string) {
54 global $color;
55 return preg_replace("/([\200-\377])/e","'<font color=\"$color[2]\">{'.dechex(ord('\\1')).'}</font>'",$string);
56 }
57
58 /**
59 * Calculates id of MIME entity
60 * @param string $entString
61 * @param integer $direction
62 * @return string
63 * @access private
64 */
65 function CalcEntity($entString, $direction) {
66 $result = $entString;
67 if ($direction == -1) {
68 $pos = strrpos($entString,'.');
69 $result = substr($entString,0,$pos);
70 }
71
72 switch ($direction) {
73 case 0:
74 $pos = strrpos($entString,'.');
75 if ($pos === false) {
76 $entString++;
77 $result= $entString;
78 }
79 else {
80 $level = substr($entString,0,$pos);
81 $sublevel = substr($entString,$pos+1);
82 $sublevel++;
83 $result = "$level".'.'."$sublevel";
84 }
85 break;
86 case 1:
87 $result = "$entString".".0";
88 break;
89 default:
90 break;
91 }
92 return ($result);
93 }
94
95
96
97 /**
98 * Returns time in microseconds between selected and current timestamp
99 *
100 * @param array $start see details about array format at http://www.php.net/gettimeofday
101 * @return integer time in microseconds
102 * @access private
103 */
104 function returnTime($start) {
105 $stop = gettimeofday();
106 $timepassed = 1000000 * ($stop['sec'] - $start['sec']) + $stop['usec'] - $start['usec'];
107 return $timepassed;
108 }
109
110
111
112 /**
113 * Returns actual message details
114 * @param string $mailbox
115 * @param string $passed_id
116 * @param boolean $stripHTML If TRUE, only plain text is returned,
117 * default is FALSE, wherein output contains
118 * pretty-HTMLification of message body
119 * @return string The formatted message details
120 * @access public
121 */
122 function get_message_details($mailbox, $passed_id, $stripHTML=FALSE) {
123
124 global $imapServerAddress, $imapPort, $color,$msgd_8bit_in_hex;
125
126 $returnValue = '';
127
128 sqgetGlobalVar('username', $username, SQ_SESSION);
129
130 $imapConnection = sqimap_login($username, false, $imapServerAddress, $imapPort, 0);
131 $read = sqimap_mailbox_select($imapConnection, $mailbox);
132 $start = gettimeofday();
133 $body = sqimap_run_command($imapConnection, "FETCH $passed_id RFC822",true, $response, $readmessage, TRUE);
134 $message_body = '';
135 $header = false;
136 $mimepart = false;
137 $bnd_end = false;
138 $messageheader = true;
139 $messageheaderstart=false;
140 $boundaries = array();
141 $entities = array();
142 session_unregister("entities");
143 $pre = '<b>';
144 $end = '</b>';
145 $entStr = '';
146 $bla ='';
147 $content = array ();
148 $content_indx = -1;
149 $contentset = false;
150
151 $count=count($body);
152 $body[$count-1] = substr($body[$count-1], -1);
153 for ($i=1; $i < $count; $i++) {
154 $line = trim($body[$i]);
155 if ($line == '') {
156 $pre = '';
157 $end = '';
158 if ($bnd_end) {
159 $header = true;
160 $mimepart = false;
161 } else if ($messageheader) {
162 if ($header) {
163 $header=false;
164 $end = "\n \n".'</div>'."\n \n".'<div class="ent_body" id="'.$entStr.'B">'."\n \n";
165 }
166 $mimepart = -$header;
167 $bnd_end = false;
168 if ($messageheaderstart) {
169 $messageheaderstart=false;
170 }
171 } else if ($messageheaderstart) {
172 $messageheader= false;
173 } else {
174 if ($header) {
175 $pre = '';
176 $end = "\n \n".'</div>'."\n \n".'<div class="ent_body" id="'.$entStr.'B">'."\n \n";
177 }
178 $header = false;
179 $mimepart=true;
180 }
181 $contentset = false;
182 $nameset = false;
183 } else {
184 if (!$header && $messageheader) {
185 $messageheaderstart=true;
186 if ($pre != '<b>') {
187 $pre = '<i><font color ="'.$color[1].'">';
188 $end = '</i></font>';
189 }
190 }
191 if (!$messageheader && !$header ) {
192 $mimepart=true;
193 } else {
194 $mimepart=false;
195 }
196 $pre = '';
197 $end = '';
198 }
199 if ( ( $header || $messageheader) && (preg_match("/^.*boundary=\"?(.+(?=\")|.+).*/i",$line,$reg)) ) {
200 $bnd = $reg[1];
201 $bndreg = $bnd;
202 $bndreg = str_replace("\\","\\\\",$bndreg);
203 $bndreg = str_replace("?","\\?",$bndreg);
204 $bndreg = str_replace("+","\\+",$bndreg);
205 $bndreg = str_replace(".","\\.",$bndreg);
206 $bndreg = str_replace("/","\\/",$bndreg);
207 $bndreg = str_replace("-","\\-",$bndreg);
208 $bndreg = str_replace("(","\\(",$bndreg);
209 $bndreg = str_replace(")","\\)",$bndreg);
210
211 $boundaries[] = array( 'bnd' => $bnd, 'bndreg' => $bndreg);
212 $messageheader = false;
213 $messageheaderstart=false;
214 $mimepart=false;
215 if ($entStr=='') {
216 $entStr='0';
217 } else {
218 $entStr = CalcEntity("$entStr",1);
219 }
220 }
221
222 if (($line != '' && $line{0} == '-' || $header) && isset($boundaries[0])) {
223 $cnt=count($boundaries)-1;
224 $bnd = $boundaries[$cnt]['bnd'];
225 $bndreg = $boundaries[$cnt]['bndreg'];
226
227 $regstr = '/^--'."($bndreg)".".*".'/';
228 if (preg_match($regstr,$line,$reg) ) {
229 $bndlen = strlen($reg[1]);
230 $bndend = false;
231 if (strlen($line) > ($bndlen + 3)) {
232 if ($line{$bndlen+2} == '-' && $line{$bndlen+3} == '-')
233 $bndend = true;
234 }
235 if ($bndend) {
236 $entStr = CalcEntity("$entStr",-1);
237 array_pop($boundaries);
238 $pre .= '<b><font color ="'.$color[2].'">';
239 $end .= '</font></b>';
240 $header = true;
241 $mimepart = false;
242 $bnd_end = true;
243 $encoding = '';
244 } else {
245 $header = true;
246 $bnd_end = false;
247 $entStr = CalcEntity("$entStr",0);
248 $content_indx++;
249 $content[$content_indx]=array();
250 $content[$content_indx]['ent'] = '<a href="#'."$entStr \">$entStr".'</a>';
251 $pre .= "\n \n".'</div>'."\n \n".'<div class="entheader" id="'.
252 $entStr.'H"><a name="'."$entStr".'"><b><font color="'.$color[2].'">';
253 $end .= '</font></b>'."\n";
254 $header = true;
255 $mimepart = false;
256 $encoding = '';
257 }
258 } else {
259 if ($header) {
260 if (!$contentset && preg_match("/^.*(content-type:)\s*(\w+)\/(\w+).*/i",$line,$reg)) {
261 if (strtolower($reg[2]) == 'message' && strtolower($reg[3]) == 'rfc822') {
262 $messageheader = true;
263 }
264 $content[$content_indx]['type'] = "$reg[2]/$reg[3]";
265 $contentset = true;
266 if ($reg[2] == 'image') {
267 $entities["$entStr"] = array();
268 $entities["$entStr"]['entity'] = $entStr;
269 $entities["$entStr"]['contenttype']=$reg[2].'/'.$reg[3];
270 }
271 } else if (!$nameset && preg_match("/^.*(name=\s*)\"(.*)\".*/i",$line,$reg)) {
272 $name = htmlspecialchars($reg[2]);
273 $content[$content_indx]['name'] = decodeHeader($name);
274 $nameset = true;
275 if (isset($entities["$entStr"])) {
276 $entities["$entStr"]['name'] = urlEncode($reg[2]);
277 }
278 } else if (preg_match("/^.*(content-transfer-encoding:)\s*(\w+-?(\w+)?).*/i",$line,$reg) ) {
279 $encoding = $reg[2];
280 if (isset($entities["$entStr"])) {
281 $entities["$entStr"]['encoding']=$reg[2];
282 }
283 $content[$content_indx]['encoding'] = $encoding;
284 $mimeentity = '';
285 }
286
287 $pre .= '<b><font color='.$color[7].'">';
288 $end .= '</font></b>';
289 //$mimepart=false;
290 }
291 }
292 }
293 /*
294 if ($mimepart) {
295 if (isset($entities["$entStr"])) {
296 if (isset($encoding) && $encoding == 'base64') {
297 if (!isset( $entities["$entStr"]['content'])) $entities[$entStr]['content'] = '';
298 $entities["$entStr"]['content'] .= $line;
299 }
300 }
301 }
302 */
303 if ($stripHTML) {
304 $message_body .= $line . "\r\n";
305 } else {
306 $line = htmlspecialchars($line);
307 if ($msgd_8bit_in_hex) $line = msgd_convert_to_hex($line);
308 $message_body .= "$pre"."$line"."$end".'<br />'."\r\n";
309 }
310 }
311
312 //$returnValue .= returnTime($start).'<br />';
313 $xtra = <<<ECHO
314
315 <style type="text/css">
316
317 <!--
318 .ent_body {
319 display:inline;
320 }
321
322 .header {
323 display:inline;
324 }
325
326 .entheader {
327 display:inline;
328 width:99%;
329 }
330 //-->
331
332 </style>
333
334 ECHO;
335
336 if (!$stripHTML) {
337 ob_start();
338 displayHtmlHeader( _("Message Details"), $xtra, FALSE );
339 $returnValue .= ob_get_contents();
340 ob_end_clean();
341 }
342
343 /* body */
344 if (!$stripHTML) {
345 $returnValue .= "<body text=\"$color[8]\" bgcolor=\"$color[4]\" link=\"$color[7]\" vlink=\"$color[7]\" alink=\"$color[7]\">\n";
346 $returnValue .= '<code>'."\n";
347 $returnValue .= '<font face="monospace">'."\n";
348 $returnValue .= '<br />'."\n";
349 }
350
351
352 //session_register("entities");
353 //$keys = array_keys($entities);
354 //$start = gettimeofday();
355 //foreach ($keys as $key) {
356 // if (isset($entities[$key])) {
357 // if ($entities[$key]['encoding'] == 'base64') {
358 // if (!$stripHTML) {
359 // $returnValue .= 'img src="message_viewentity.php?ent='.$entities[$key]['entity'].'&amp;name='.$entities[$key]['name'].'"><br />';
360 // }
361 // }
362 // }
363 //}
364 //session_unregister("entities");
365
366 if (count($content) > 0 && !$stripHTML) {
367 $returnValue .= '<h2>'._("Bodystructure")."</h2>\n\n";
368 $returnValue .= '<table border="1" width="98%"><thead>'.
369 '<tr bgcolor="'.$color[7].'">'.
370 '<td><b><font color="'.$color[5].'">'._("Entity").'</font></b></td>'.
371 '<td><b><font color="'.$color[5].'">'._("Content-Type").'</font></b></td>'.
372 '<td><b><font color="'.$color[5].'">'._("Name").'</font></b></td>'.
373 '<td><b><font color="'.$color[5].'">'._("Encoding").'</font></b></td>'.
374 '</tr>'.
375 '</thead><tbody>';
376 for ($i = 0; $i < count($content);$i++) {
377 $returnValue .= '<tr><td>';
378 $returnValue .= $content[$i]['ent'].'</td><td>';
379 if (isset($content[$i]['type'])) {
380 $returnValue .= $content[$i]['type'];
381 } else $returnValue .= 'TEXT/PLAIN';
382 $returnValue .= '</td><td>';
383 if (isset($content[$i]['name'])) {
384 $returnValue .= $content[$i]['name'];
385 } else $returnValue .= '&nbsp;';
386 $returnValue .= '</td><td>';
387 if (isset($content[$i]['encoding'])) {
388 $returnValue .= $content[$i]['encoding'];
389 } else $returnValue .= '&nbsp;';
390 $returnValue .= '</td></tr>'."\n";
391 }
392 $returnValue .= '</tbody></table><br />'."\n";
393 }
394
395 if (!$stripHTML) {
396 $returnValue .= '<h2>'._("RFC822 Message body")."</h2>\n\n";
397 $returnValue .= '<div><div class="header">'."\n\n";
398 }
399
400 $returnValue .= $message_body;
401
402 if (!$stripHTML)
403 $returnValue .= '</div></div></font></code></body></html>';
404
405 return $returnValue;
406
407 }
408
409 ?>