add fixme
[squirrelmail.git] / plugins / message_details / message_details_bottom.php
index f70ea3fdeb0e7472e6d06f28add2ce8f836443a2..b9cd0f6a260eaa8ba09eeba6e47f45a9c00a9e0d 100644 (file)
 <?php
 
-/** Message Source  
-*
-* Plugin to view the RFC822 raw message output and the bodystructure of a message
-*
-* Copyright (c) 2002 Marc Groot Koerkamp, The Netherlands
-* Licensed under the GNU GPL. For full terms see the file COPYING.
-* 
-* $Id$
-**/
+/**
+ * Message Details plugin - bottom frame with message structure and rfc822 body
+ *
+ * Plugin to view the RFC822 raw message output and the bodystructure of a message
+ *
+ * @author Marc Groot Koerkamp
+ * @copyright &copy; 2002 Marc Groot Koerkamp, The Netherlands
+ * @copyright &copy; 2002-2007 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.
+ */
+require('../../include/init.php');
+require(SM_PATH . 'functions/imap_general.php');
+require(SM_PATH . 'functions/imap_messages.php');
+require(SM_PATH . 'functions/mime.php');
 
-//require_once('./message_viewentity.php');
-chdir('..');
-require_once('../functions/imap.php');
-require_once('../functions/mime.php');
-require_once('../config/config.php');
-require_once('../src/validate.php');
-require_once('../src/load_prefs.php');
+sqgetGlobalVar('get_message_details', $md_action, SQ_GET);
 
-global $color, $uid_support;
+/**
+ * Controls display of 8bit symbols in message source
+ * @global boolean $msgd_8bit_in_hex;
+ */
+global $msgd_8bit_in_hex;
+$msgd_8bit_in_hex=false;
 
+if (!empty($md_action)) {
+    sqgetGlobalVar('passed_id', $passed_id, SQ_GET);
+    if (!sqgetGlobalVar('passed_ent_id', $passed_ent_id, SQ_GET))
+        $passed_ent_id = 0;
+    sqgetGlobalVar('mailbox', $mailbox, SQ_GET);
+    /* 
+     * 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);
+}
+
+
+// ---------- function definitions ----------
+
+/**
+ * Converts 8bit string to hex
+ *
+ * Replaces 8bit symbols with their hex strings,
+ * encloses them in curly brackets and uses different color.
+ * @param string $string text
+ * @return string
+ * @since 1.5.1
+ */
+function msgd_convert_to_hex($string) {
+     global $color;
+     return preg_replace("/([\200-\377])/e","'<font color=\"$color[2]\">{'.dechex(ord('\\1')).'}</font>'",$string);
+}
+
+/**
+ * Calculates id of MIME entity
+ * @param string $entString
+ * @param integer $direction
+ * @return string
+ * @access private
+ */
 function CalcEntity($entString, $direction) {
     $result = $entString;
     if ($direction == -1) {
-         $pos = strrpos($entString,'.');
-         $result = substr($entString,0,$pos);
+        $pos = strrpos($entString,'.');
+        $result = substr($entString,0,$pos);
     }
 
     switch ($direction) {
-       case 0:
-          $pos = strrpos($entString,'.');
-          if ($pos === false) {
-            $entString++;
-            $result= $entString;
-          } 
-         else {
-             $level = substr($entString,0,$pos);
-            $sublevel = substr($entString,$pos+1);
-            $sublevel++;
-            $result = "$level".'.'."$sublevel";
-         }
-         break;
-       case 1:
-          $result = "$entString".".0";
-         break;
-       default:
-          break;
+        case 0:
+            $pos = strrpos($entString,'.');
+            if ($pos === false) {
+                $entString++;
+                $result= $entString;
+            }
+            else {
+                $level = substr($entString,0,$pos);
+                $sublevel = substr($entString,$pos+1);
+                $sublevel++;
+                $result = "$level".'.'."$sublevel";
+            }
+            break;
+        case 1:
+            $result = "$entString".".0";
+            break;
+        default:
+            break;
     }
     return ($result);
 }
 
-function returnTime($start) {
- $stop = gettimeofday();
- $timepassed =  1000000 * ($stop['sec'] - $start['sec']) + $stop['usec'] - $start['usec'];
- return $timepassed;
-}
 
-function GetMimeProperties($header) {
-}
+/**
+ * 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, $passed_ent_id=0, $stripHTML=FALSE) {
+    global $imapServerAddress, $imapPort, $color,$msgd_8bit_in_hex, $username;
 
-$imapConnection = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
-$read = sqimap_mailbox_select($imapConnection, $mailbox);
-$start = gettimeofday();
-$body = sqimap_run_command($imapConnection, "FETCH $passed_id RFC822",true, $response, $readmessage, $uid_support);
-$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;
+    $returnValue = '';
 
-$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;
-           }
-       } else if ($messageheaderstart) {
-           $messageheader= false;
-       } else {
-           if ($header) {
-               $pre = '';
-               $end = "\n \n".'</div>'."\n \n".'<div class="ent_body" ID="'.$entStr.'B">'."\n \n"; 
-           }
-           $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 (  ( $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);
+    $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;
 
-       $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 = '';
-           } 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 = '';
-           }
-       }  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 = '';
-               }
+    $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;
+            }
+            $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 (  ( $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'];
 
-               $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;
-           }
+            $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;
+                }
+            }
         }
-    }  
-*/
-    $line = htmlspecialchars($line);
-    $message_body .= "$pre"."$line"."$end".'<BR>'."\r\n";
-}
-//echo returnTime($start).'<BR>';
-$xtra = <<<ECHO
 
-<STYLE>
+        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";
+        }
+    }
+    
+//$returnValue .= returnTime($start).'<br />';
+$xtra = <<<ECHO
 
+<style type="text/css">
 <!--
 .ent_body {
   display:inline;
@@ -251,66 +306,70 @@ $xtra = <<<ECHO
 
 .entheader {
   display:inline;
-  margin-bottom:1em;
-  padding-bottom:1em;
-  border-style: solid none solid none;
-  border-width:0.1em;
   width:99%;
 }
-//-->
-
-</STYLE>
+-->
+</style>
 
 ECHO;
 
-displayHtmlHeader( _("Message Details"), $xtra, FALSE );
-/* body */
-echo '<body><code>'."\n";
-echo '<font face = "monospace">'."\n";
-echo '<BR>'."\n";
-//session_register("entities");
-//$keys = array_keys($entities);
-//$start = gettimeofday();
-//foreach ($keys as $key) {
-//    if (isset($entities[$key])) {
-//    if ($entities[$key]['encoding'] == 'base64') {
-//     echo '<img src="message_viewentity.php?ent='.$entities[$key]['entity'].'&amp;name='.$entities[$key]['name'].'"><br>';
-//    }
-//    }
-//}
-//session_unregister("entities");
+    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 .= '<font face="monospace">'."\n";
+        $returnValue .= '<br />'."\n";
+    }
+
+    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";
+    }
 
-if (count($content) > 0) {
-    echo '<h2> Bodystructure </h2>'."\n\n";
-    echo '<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>'.
+    if (!$stripHTML) {
+        $returnValue .= '<h2>'._("RFC822 Message body")."</h2>\n\n";
+        $returnValue .= '<pre><div><div class="header">';
+    } else {
+        $returnValue .= '<pre>';
+    }
 
-         '</tr>'.
-         '</thead><tbody>';
-    for ($i = 0; $i < count($content);$i++) {
-       echo '<tr><td>';
-       echo $content[$i]['ent'].'</td><td>';
-       if (isset($content[$i]['type'])) {
-           echo $content[$i]['type'];
-       } else echo 'TEXT/PLAIN';
-       echo '</td><td>';
-       if (isset($content[$i]['name'])) {
-           echo $content[$i]['name'];
-       } else echo '&nbsp';
-       echo '</td><td>';
-       if (isset($content[$i]['encoding'])) {
-           echo $content[$i]['encoding'];
-       } else echo '&nbsp';
-       echo '</td></tr>'."\n";
+    $returnValue .= $message_body;
+    
+    if (!$stripHTML) {
+        $returnValue .= '</div></div></pre></font></body></html>';
+    } else {
+        $returnValue .= '</pre>';
     }
-    echo '</tbody></table><br>'."\n";
+    return $returnValue;
 }
-echo '<h2> RFC822 Message body </h2>'."\n\n";
-echo '<div><div class="header">'."\n\n";
-echo $message_body;
-echo '</div></div></font></code></body></html>';
 ?>