Fix what seems to have been a copy/paste bug
[squirrelmail.git] / plugins / message_details / message_details_bottom.php
index f66817db624ac81dd237b3b4de35c27cdccb3392..955ea6d174c9862963774262c877d1aa10d433c3 100644 (file)
@@ -6,13 +6,14 @@
  * Plugin to view the RFC822 raw message output and the bodystructure of a message
  *
  * @author Marc Groot Koerkamp
- * @copyright © 2002 Marc Groot Koerkamp, The Netherlands
- * @copyright © 2002-2006 The SquirrelMail Project Team
+ * @copyright 2002 Marc Groot Koerkamp, The Netherlands
+ * @copyright 2002-2011 The SquirrelMail Project Team
  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package plugins
  * @subpackage message_details
  */
+//FIXME: this file uses HTML extensively and eventually needs to be "templatized" (don't echo HTML directly)
 
 /**
  * Include the SquirrelMail initialization file.
@@ -31,11 +32,17 @@ sqgetGlobalVar('get_message_details', $md_action, SQ_GET);
 global $msgd_8bit_in_hex;
 $msgd_8bit_in_hex=false;
 
-if (!empty($md_action))
-{
-    sqgetGlobalVar('passed_id', $passed_id, SQ_GET);
+if (!empty($md_action)) {
+    sqgetGlobalVar('passed_id', $passed_id, SQ_GET, NULL, SQ_TYPE_BIGINT);
+    if (!sqgetGlobalVar('passed_ent_id', $passed_ent_id, SQ_GET))
+        $passed_ent_id = 0;
     sqgetGlobalVar('mailbox', $mailbox, SQ_GET);
-    echo get_message_details($mailbox, $passed_id);
+    /* 
+     * change $unformatted to TRUE if you want to see 
+     * message source without formating
+     */
+    $unformatted = FALSE;
+    echo get_message_details($mailbox, $passed_id, $passed_ent_id, $unformatted);
 }
 
 
@@ -93,227 +100,201 @@ function CalcEntity($entString, $direction) {
 }
 
 
-
-/**
- * Returns time in microseconds between selected and current timestamp
- *
- * @param array $start see details about array format at http://www.php.net/gettimeofday
- * @return integer time in microseconds
- * @access private
- */
-function returnTime($start) {
- $stop = gettimeofday();
- $timepassed =  1000000 * ($stop['sec'] - $start['sec']) + $stop['usec'] - $start['usec'];
- return $timepassed;
-}
-
-
-
 /**
  * Returns actual message details
  * @param string $mailbox
  * @param string $passed_id
+ * @param string $passed_ent_id
  * @param boolean $stripHTML If TRUE, only plain text is returned,
  *                           default is FALSE, wherein output contains
  *                           pretty-HTMLification of message body
  * @return string The formatted message details
  * @access public
  */
-function get_message_details($mailbox, $passed_id, $stripHTML=FALSE) {
-
-global $imapServerAddress, $imapPort, $color,$msgd_8bit_in_hex;
-
-$returnValue = '';
-
-sqgetGlobalVar('username', $username, SQ_SESSION);
-
-$imapConnection = sqimap_login($username, false, $imapServerAddress, $imapPort, 0);
-$read = sqimap_mailbox_select($imapConnection, $mailbox);
-$start = gettimeofday();
-$body = sqimap_run_command($imapConnection, "FETCH $passed_id RFC822",true, $response, $readmessage, TRUE);
-$message_body = '';
-$header = false;
-$mimepart = false;
-$bnd_end = false;
-$messageheader = true;
-$messageheaderstart=false;
-$boundaries = array();
-$entities = array();
-session_unregister("entities");
-$pre = '<b>';
-$end = '</b>';
-$entStr = '';
-$bla ='';
-$content = array ();
-$content_indx = -1;
-$contentset = false;
-
-$count=count($body);
-$body[$count-1] = substr($body[$count-1], -1);
-for ($i=1; $i < $count; $i++) {
-    $line = trim($body[$i]);
-    if ($line == '') {
-        $pre = '';
-        $end = '';
-        if ($bnd_end) {
-            $header = true;
-            $mimepart = false;
-        } else if ($messageheader) {
-            if ($header) {
-                $header=false;
-                $end = "\n \n".'</div>'."\n \n".'<div class="ent_body" id="'.$entStr.'B">'."\n \n";
-            }
-            $mimepart = -$header;
-            $bnd_end = false;
-            if ($messageheaderstart) {
-                $messageheaderstart=false;
+function get_message_details($mailbox, $passed_id, $passed_ent_id=0, $stripHTML=FALSE) {
+    global $imapServerAddress, $imapPort, $color,$msgd_8bit_in_hex, $username;
+
+    $returnValue = '';
+
+    $imapConnection = sqimap_login($username, false, $imapServerAddress, $imapPort, 0);
+    $read = sqimap_mailbox_select($imapConnection, $mailbox);
+    if (!empty($passed_ent_id))
+        $body = sqimap_run_command($imapConnection, "FETCH $passed_id BODY[$passed_ent_id]",true, $response, $readmessage, TRUE);
+    else
+        $body = sqimap_run_command($imapConnection, "FETCH $passed_id RFC822",true, $response, $readmessage, TRUE);
+    $message_body = '';
+    $header = false;
+    $mimepart = false;
+    $bnd_end = false;
+    $messageheader = true;
+    $messageheaderstart=false;
+    $boundaries = array();
+    $entities = array();
+    session_unregister("entities");
+    $pre = '<b>';
+    $end = '</b>';
+    $entStr = '';
+    $bla ='';
+    $content = array ();
+    $content_indx = -1;
+    $contentset = false;
+
+    $count=count($body);
+    $body[$count-1] = substr($body[$count-1], -1);
+    for ($i=1; $i < $count; $i++) {
+        $line = rtrim($body[$i]);
+        if ($line == '') {
+            $pre = '';
+            $end = '';
+            if ($bnd_end) {
+                $header = true;
+                $mimepart = false;
+            } else if ($messageheader) {
+                if ($header) {
+                    $header=false;
+                    $end = '</div><div class="ent_body" id="'.$entStr.'B">';
+                }
+                $mimepart = -$header;
+                $bnd_end = false;
+                if ($messageheaderstart) {
+                    $messageheaderstart=false;
+                }
+            } else if ($messageheaderstart) {
+                $messageheader= false;
+            } else {
+                if ($header) {
+                    $pre = '';
+                    $end = '</div><div class="ent_body" id="'.$entStr.'B">';
+                }
+                $header = false;
+                $mimepart=true;
             }
-        } else if ($messageheaderstart) {
-            $messageheader= false;
+            $contentset = false;
+            $nameset = false;
         } else {
-            if ($header) {
-                $pre = '';
-                $end = "\n \n".'</div>'."\n \n".'<div class="ent_body" id="'.$entStr.'B">'."\n \n";
+            if (!$header && $messageheader) {
+                $messageheaderstart=true;
+                if ($pre != '<b>') {
+                    $pre = '<i><font color ="'.$color[1].'">';
+                    $end = '</i></font>';
+                }
             }
-            $header = false;
-            $mimepart=true;
-        }
-        $contentset = false;
-        $nameset = false;
-    } else {
-        if (!$header && $messageheader) {
-            $messageheaderstart=true;
-            if ($pre != '<b>') {
-                $pre = '<i><font color ="'.$color[1].'">';
-                $end = '</i></font>';
+            if (!$messageheader && !$header ) {
+                $mimepart=true;
+            }  else {
+                $mimepart=false;
             }
+            $pre = '';
+            $end = '';
         }
-        if (!$messageheader && !$header ) {
-            $mimepart=true;
-        }  else {
+        if (  ( $header || $messageheader) && (preg_match("/^.*boundary=\"?(.+(?=\")|.+).*/i",$line,$reg)) )  {
+            $bnd = $reg[1];
+            $bndreg = $bnd;
+            $bndreg = str_replace("\\","\\\\",$bndreg);
+            $bndreg = str_replace("?","\\?",$bndreg);
+            $bndreg = str_replace("+","\\+",$bndreg);
+            $bndreg = str_replace(".","\\.",$bndreg);
+            $bndreg = str_replace("/","\\/",$bndreg);
+            $bndreg = str_replace("-","\\-",$bndreg);
+            $bndreg = str_replace("(","\\(",$bndreg);
+            $bndreg = str_replace(")","\\)",$bndreg);
+            
+            $boundaries[] = array( 'bnd' => $bnd, 'bndreg' => $bndreg);
+            $messageheader = false;
+            $messageheaderstart=false;
             $mimepart=false;
-        }
-        $pre = '';
-        $end = '';
-    }
-    if (  ( $header || $messageheader) && (preg_match("/^.*boundary=\"?(.+(?=\")|.+).*/i",$line,$reg)) )  {
-        $bnd = $reg[1];
-        $bndreg = $bnd;
-        $bndreg = str_replace("\\","\\\\",$bndreg);
-        $bndreg = str_replace("?","\\?",$bndreg);
-        $bndreg = str_replace("+","\\+",$bndreg);
-        $bndreg = str_replace(".","\\.",$bndreg);
-        $bndreg = str_replace("/","\\/",$bndreg);
-        $bndreg = str_replace("-","\\-",$bndreg);
-        $bndreg = str_replace("(","\\(",$bndreg);
-        $bndreg = str_replace(")","\\)",$bndreg);
-
-        $boundaries[] = array( 'bnd' => $bnd, 'bndreg' => $bndreg);
-        $messageheader = false;
-        $messageheaderstart=false;
-        $mimepart=false;
-        if ($entStr=='') {
-            $entStr='0';
-        } else {
-            $entStr = CalcEntity("$entStr",1);
-        }
-    }
-
-    if (($line != '' && $line{0} == '-' || $header)  && isset($boundaries[0])) {
-        $cnt=count($boundaries)-1;
-        $bnd = $boundaries[$cnt]['bnd'];
-        $bndreg = $boundaries[$cnt]['bndreg'];
-
-        $regstr = '/^--'."($bndreg)".".*".'/';
-        if (preg_match($regstr,$line,$reg) ) {
-            $bndlen = strlen($reg[1]);
-            $bndend = false;
-            if (strlen($line) > ($bndlen + 3)) {
-                if ($line{$bndlen+2} == '-' && $line{$bndlen+3} == '-')
-                    $bndend = true;
-            }
-            if ($bndend) {
-                $entStr = CalcEntity("$entStr",-1);
-                array_pop($boundaries);
-                $pre .= '<b><font color ="'.$color[2].'">';
-                $end .= '</font></b>';
-                $header = true;
-                $mimepart = false;
-                $bnd_end = true;
-                $encoding = '';
+            if ($entStr=='') {
+                $entStr='0';
             } else {
-                $header = true;
-                $bnd_end = false;
-                $entStr = CalcEntity("$entStr",0);
-                $content_indx++;
-                $content[$content_indx]=array();
-                $content[$content_indx]['ent'] = '<a href="#'."$entStr \">$entStr".'</a>';
-                $pre .= "\n \n".'</div>'."\n \n".'<div class="entheader" id="'.
-                    $entStr.'H"><a name="'."$entStr".'"><b><font color="'.$color[2].'">';
-                $end .= '</font></b>'."\n";
-                $header = true;
-                $mimepart = false;
-                $encoding = '';
+                $entStr = CalcEntity("$entStr",1);
             }
-        }  else {
-            if ($header) {
-                if (!$contentset && preg_match("/^.*(content-type:)\s*(\w+)\/(\w+).*/i",$line,$reg)) {
-                    if (strtolower($reg[2]) == 'message' && strtolower($reg[3]) == 'rfc822') {
-                        $messageheader = true;
-                    }
-                    $content[$content_indx]['type'] = "$reg[2]/$reg[3]";
-                    $contentset = true;
-                    if ($reg[2] == 'image') {
-                        $entities["$entStr"] = array();
-                        $entities["$entStr"]['entity'] = $entStr;
-                        $entities["$entStr"]['contenttype']=$reg[2].'/'.$reg[3];
-                    }
-                   } else if (!$nameset && preg_match("/^.*(name=\s*)\"(.*)\".*/i",$line,$reg)) {
-                    $name = htmlspecialchars($reg[2]);
-                    $content[$content_indx]['name'] = decodeHeader($name);
-                    $nameset = true;
-                    if (isset($entities["$entStr"])) {
-                        $entities["$entStr"]['name'] = urlEncode($reg[2]);
-                    }
-                   } else if (preg_match("/^.*(content-transfer-encoding:)\s*(\w+-?(\w+)?).*/i",$line,$reg) ) {
-                    $encoding = $reg[2];
-                    if (isset($entities["$entStr"])) {
-                        $entities["$entStr"]['encoding']=$reg[2];
-                    }
-                    $content[$content_indx]['encoding'] = $encoding;
-                    $mimeentity = '';
+        }
+
+        if (($line != '' && $line{0} == '-' || $header)  && isset($boundaries[0])) {
+            $cnt=count($boundaries)-1;
+            $bnd = $boundaries[$cnt]['bnd'];
+            $bndreg = $boundaries[$cnt]['bndreg'];
+
+            $regstr = '/^--'."($bndreg)".".*".'/';
+            if (preg_match($regstr,$line,$reg) ) {
+                $bndlen = strlen($reg[1]);
+                $bndend = false;
+                if (strlen($line) > ($bndlen + 3)) {
+                    if ($line{$bndlen+2} == '-' && $line{$bndlen+3} == '-')
+                        $bndend = true;
                 }
+                if ($bndend) {
+                    $entStr = CalcEntity("$entStr",-1);
+                    array_pop($boundaries);
+                    $pre .= '<b><font color ="'.$color[2].'">';
+                    $end .= '</font></b>';
+                    $header = true;
+                    $mimepart = false;
+                    $bnd_end = true;
+                    $encoding = '';
+                } else {
+                    $header = true;
+                    $bnd_end = false;
+                    $entStr = CalcEntity("$entStr",0);
+                    $content_indx++;
+                    $content[$content_indx]=array();
+                    $content[$content_indx]['ent'] = '<a href="#'."$entStr \">$entStr".'</a>';
+                    $pre .= '</div><div class="entheader" id="'.
+                        $entStr.'H"><a name="'."$entStr".'"><b><font color="'.$color[2].'">';
+                    $end .= '</font></b>';
+                    $header = true;
+                    $mimepart = false;
+                    $encoding = '';
+                }
+            }  else {
+                if ($header) {
+                    if (!$contentset && preg_match("/^.*(content-type:)\s*(\w+)\/(\w+).*/i",$line,$reg)) {
+                        if (strtolower($reg[2]) == 'message' && strtolower($reg[3]) == 'rfc822') {
+                            $messageheader = true;
+                        }
+                        $content[$content_indx]['type'] = "$reg[2]/$reg[3]";
+                        $contentset = true;
+                        if ($reg[2] == 'image') {
+                            $entities["$entStr"] = array();
+                            $entities["$entStr"]['entity'] = $entStr;
+                            $entities["$entStr"]['contenttype']=$reg[2].'/'.$reg[3];
+                        }
+                    } else if (!$nameset && preg_match("/^.*(name=\s*)\"(.*)\".*/i",$line,$reg)) {
+                        $name = htmlspecialchars($reg[2]);
+                        $content[$content_indx]['name'] = decodeHeader($name);
+                        $nameset = true;
+                        if (isset($entities["$entStr"])) {
+                            $entities["$entStr"]['name'] = urlEncode($reg[2]);
+                        }
+                    } else if (preg_match("/^.*(content-transfer-encoding:)\s*(\w+-?(\w+)?).*/i",$line,$reg) ) {
+                        $encoding = $reg[2];
+                        if (isset($entities["$entStr"])) {
+                            $entities["$entStr"]['encoding']=$reg[2];
+                        }
+                        $content[$content_indx]['encoding'] = $encoding;
+                        $mimeentity = '';
+                    }
 
-                $pre .= '<b><font color='.$color[7].'">';
-                $end .= '</font></b>';
-                //$mimepart=false;
+                    $pre .= '<b><font color='.$color[7].'">';
+                    $end .= '</font></b>';
+                    //$mimepart=false;
+                }
             }
         }
-    }
-/*
-    if ($mimepart) {
-            if (isset($entities["$entStr"])) {
-            if (isset($encoding) && $encoding == 'base64') {
-                    if (!isset( $entities["$entStr"]['content'])) $entities[$entStr]['content'] = '';
-                $entities["$entStr"]['content'] .= $line;
-            }
+
+        if ($stripHTML) {
+            $message_body .= $line . "\r\n";
+        } else {
+            $line = htmlspecialchars($line);
+            if ($msgd_8bit_in_hex) $line = msgd_convert_to_hex($line);
+            $message_body .= "$pre"."$line"."$end"."\r\n";
         }
     }
-*/
-    if ($stripHTML) {
-        $message_body .= $line . "\r\n";
-    } else {
-        $line = htmlspecialchars($line);
-        if ($msgd_8bit_in_hex) $line = msgd_convert_to_hex($line);
-        $message_body .= "$pre"."$line"."$end".'<br />'."\r\n";
-    }
-}
-
+    
 //$returnValue .= returnTime($start).'<br />';
 $xtra = <<<ECHO
 
 <style type="text/css">
-
 <!--
 .ent_body {
   display:inline;
@@ -327,83 +308,67 @@ $xtra = <<<ECHO
   display:inline;
   width:99%;
 }
-//-->
-
+-->
 </style>
 
 ECHO;
 
-if (!$stripHTML) {
-    ob_start();
-    displayHtmlHeader( _("Message Details"), $xtra, FALSE );
-    $returnValue .= ob_get_contents();
-    ob_end_clean();
-}
-
-/* body */
-if (!$stripHTML) {
-    $returnValue .= "<body text=\"$color[8]\" bgcolor=\"$color[4]\" link=\"$color[7]\" vlink=\"$color[7]\" alink=\"$color[7]\">\n";
-    $returnValue .= '<code>'."\n";
-    $returnValue .= '<font face="monospace">'."\n";
-    $returnValue .= '<br />'."\n";
-}
-
-
-//session_register("entities");
-//$keys = array_keys($entities);
-//$start = gettimeofday();
-//foreach ($keys as $key) {
-//    if (isset($entities[$key])) {
-//    if ($entities[$key]['encoding'] == 'base64') {
-//        if (!$stripHTML) {
-//            $returnValue .= 'img src="message_viewentity.php?ent='.$entities[$key]['entity'].'&amp;name='.$entities[$key]['name'].'"><br />';
-//        }
-//    }
-//    }
-//}
-//session_unregister("entities");
-
-if (count($content) > 0 && !$stripHTML) {
-    $returnValue .= '<h2>'._("Bodystructure")."</h2>\n\n";
-    $returnValue .= '<table border="1" width="98%"><thead>'.
-         '<tr bgcolor="'.$color[7].'">'.
-         '<td><b><font color="'.$color[5].'">'._("Entity").'</font></b></td>'.
-         '<td><b><font color="'.$color[5].'">'._("Content-Type").'</font></b></td>'.
-         '<td><b><font color="'.$color[5].'">'._("Name").'</font></b></td>'.
-         '<td><b><font color="'.$color[5].'">'._("Encoding").'</font></b></td>'.
-         '</tr>'.
-         '</thead><tbody>';
-    for ($i = 0; $i < count($content);$i++) {
-        $returnValue .= '<tr><td>';
-        $returnValue .= $content[$i]['ent'].'</td><td>';
-        if (isset($content[$i]['type'])) {
-            $returnValue .= $content[$i]['type'];
-        } else $returnValue .= 'TEXT/PLAIN';
-        $returnValue .= '</td><td>';
-        if (isset($content[$i]['name'])) {
-            $returnValue .= $content[$i]['name'];
-        } else $returnValue .= '&nbsp;';
-        $returnValue .= '</td><td>';
-        if (isset($content[$i]['encoding'])) {
-            $returnValue .= $content[$i]['encoding'];
-        } else $returnValue .= '&nbsp;';
-        $returnValue .= '</td></tr>'."\n";
+    if (!$stripHTML) {
+        ob_start();
+        displayHtmlHeader( _("Message Details"), $xtra, FALSE );
+        $returnValue .= ob_get_contents();
+        ob_end_clean();
     }
-    $returnValue .= '</tbody></table><br />'."\n";
-}
 
-if (!$stripHTML) {
-    $returnValue .= '<h2>'._("RFC822 Message body")."</h2>\n\n";
-    $returnValue .= '<div><div class="header">'."\n\n";
-}
-
-$returnValue .= $message_body;
+    /* body */
+    if (!$stripHTML) {
+        $returnValue .= "<body text=\"$color[8]\" bgcolor=\"$color[4]\" link=\"$color[7]\" vlink=\"$color[7]\" alink=\"$color[7]\">\n";
+        $returnValue .= '<font face="monospace">'."\n";
+        $returnValue .= '<br />'."\n";
+    }
 
-if (!$stripHTML)
-    $returnValue .= '</div></div></font></code></body></html>';
+    if (count($content) > 0 && !$stripHTML) {
+        $returnValue .= '<h2>'._("Bodystructure")."</h2>\n\n";
+        $returnValue .= '<table border="1" width="98%"><thead>'.
+            '<tr bgcolor="'.$color[7].'">'.
+            '<td><b><font color="'.$color[5].'">'._("Entity").'</font></b></td>'.
+            '<td><b><font color="'.$color[5].'">'._("Content-Type").'</font></b></td>'.
+            '<td><b><font color="'.$color[5].'">'._("Name").'</font></b></td>'.
+            '<td><b><font color="'.$color[5].'">'._("Encoding").'</font></b></td>'.
+            '</tr>'.
+            '</thead><tbody>';
+        for ($i = 0; $i < count($content);$i++) {
+            $returnValue .= '<tr><td>';
+            $returnValue .= $content[$i]['ent'].'</td><td>';
+            if (isset($content[$i]['type'])) {
+                $returnValue .= $content[$i]['type'];
+            } else $returnValue .= 'TEXT/PLAIN';
+            $returnValue .= '</td><td>';
+            if (isset($content[$i]['name'])) {
+                $returnValue .= $content[$i]['name'];
+            } else $returnValue .= '&nbsp;';
+            $returnValue .= '</td><td>';
+            if (isset($content[$i]['encoding'])) {
+                $returnValue .= $content[$i]['encoding'];
+            } else $returnValue .= '&nbsp;';
+            $returnValue .= '</td></tr>'."\n";
+        }
+        $returnValue .= '</tbody></table><br />'."\n";
+    }
 
-return $returnValue;
+    if (!$stripHTML) {
+        $returnValue .= '<h2>'._("RFC822 Message body")."</h2>\n\n";
+        $returnValue .= '<pre><div><div class="header">';
+    } else {
+        $returnValue .= '<pre>';
+    }
 
+    $returnValue .= $message_body;
+    
+    if (!$stripHTML) {
+        $returnValue .= '</div></div></pre></font></body></html>';
+    } else {
+        $returnValue .= '</pre>';
+    }
+    return $returnValue;
 }
-
-?>
\ No newline at end of file