<?php
-/** Message Source
+/**
+ * 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
*
- * Copyright (c) 2002 Marc Groot Koerkamp, The Netherlands
- * Licensed under the GNU GPL. For full terms see the file COPYING.
- *
- * $Id$
+ * @author Marc Groot Koerkamp
+ * @copyright 2002 Marc Groot Koerkamp, The Netherlands
+ * @copyright 2002-2020 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)
-/** @ignore */
-define('SM_PATH','../../');
+/**
+ * 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');
-/* SquirrelMail required files. */
-require_once(SM_PATH . 'include/validate.php');
-require_once(SM_PATH . 'functions/imap.php');
-require_once(SM_PATH . 'functions/mime.php');
-require_once(SM_PATH . 'config/config.php');
-require_once(SM_PATH . 'functions/prefs.php');
+sqgetGlobalVar('get_message_details', $md_action, SQ_GET);
-global $color;
+/**
+ * Controls display of 8bit symbols in message source
+ * @global boolean $msgd_8bit_in_hex;
+ */
+global $msgd_8bit_in_hex;
+$msgd_8bit_in_hex=false;
-sqgetGlobalVar('passed_id', $passed_id, SQ_GET);
-sqgetGlobalVar('mailbox', $mailbox, 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);
+ /*
+ * 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);
+}
-sqgetGlobalVar('username', $username, SQ_SESSION);
-sqgetGlobalVar('key', $key, SQ_COOKIE);
-sqgetGlobalVar('onetimepad', $onetimepad, SQ_SESSION);
+// ---------- 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) {
if ($pos === false) {
$entString++;
$result= $entString;
- }
+ }
else {
$level = substr($entString,0,$pos);
$sublevel = substr($entString,$pos+1);
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, $imap_stream_options,
+ $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, 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;
+ $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;
+ $imapConnection = sqimap_login($username, false, $imapServerAddress, $imapPort, 0, $imap_stream_options);
+ $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();
+ sqsession_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;
}
- }
- if (!$messageheader && !$header ) {
- $mimepart=true;
- } else {
- $mimepart=false;
+ $pre = '';
+ $end = '';
}
- $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 ( ( $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 {
- $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".'"></a><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 = sm_encode_html_special_chars($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 = sm_encode_html_special_chars($line);
+ if ($msgd_8bit_in_hex) $line = msgd_convert_to_hex($line);
+ $message_body .= "$pre"."$line"."$end"."\r\n";
}
}
-*/
- $line = htmlspecialchars($line);
- $message_body .= "$pre"."$line"."$end".'<br />'."\r\n";
-}
-//echo returnTime($start).'<br />';
+
+//$returnValue .= returnTime($start).'<br />';
$xtra = <<<ECHO
-<style>
-
+<style type="text/css">
<!--
.ent_body {
display:inline;
display:inline;
width:99%;
}
-//-->
-
+-->
</style>
ECHO;
-displayHtmlHeader( _("Message Details"), $xtra, FALSE );
-/* body */
-echo "<body text=\"$color[8]\" bgcolor=\"$color[4]\" link=\"$color[7]\" vlink=\"$color[7]\" alink=\"$color[7]\">\n";
-echo '<code>'."\n";
-echo '<font face="monospace">'."\n";
-echo '<br />'."\n";
+ 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 .= ' ';
+ $returnValue .= '</td><td>';
+ if (isset($content[$i]['encoding'])) {
+ $returnValue .= $content[$i]['encoding'];
+ } else $returnValue .= ' ';
+ $returnValue .= '</td></tr>'."\n";
+ }
+ $returnValue .= '</tbody></table><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'].'&name='.$entities[$key]['name'].'"><br />';
-// }
-// }
-//}
-//session_unregister("entities");
+ if (!$stripHTML) {
+ $returnValue .= '<h2>'._("RFC822 Message body")."</h2>\n\n";
+ $returnValue .= '<pre><div><div class="header">';
+ } else {
+ $returnValue .= '<pre>';
+ }
-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>'.
- '</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 ' ';
- echo '</td><td>';
- if (isset($content[$i]['encoding'])) {
- echo $content[$i]['encoding'];
- } else echo ' ';
- 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>';
-?>
projects / squirrelmail.git / blobdiff