include "../config/config.php";
- /** Setting up the object that has the structure for the message **/
+ /** Setting up the objects that have the structure for the message **/
class msg_header {
/** msg_header contains generic variables for values that **/
/** could be in a header. **/
- var $type0, $type1, $boundary, $charset, $encoding;
+ var $type0, $type1, $boundary, $charset, $encoding, $size;
var $to, $from, $date, $cc, $bcc, $reply_to, $subject;
- var $id, $mailbox;
- var $entity_id;
+ var $id, $mailbox, $description;
+ var $entity_id, $message_id, $charset;
}
class message {
/* MIME DECODING */
/* --------------------------------------------------------------------------------- */
- /** This function gets the structure of a message and stores it in the "message" class.
- It will return this object for use with all relevant header information and
- fully parsed into the standard "message" object format.
- **/
+ // This function gets the structure of a message and stores it in the "message" class.
+ // It will return this object for use with all relevant header information and
+ // fully parsed into the standard "message" object format.
function mime_structure ($imap_stream, $header) {
global $debug_mime;
sqimap_messages_flag ($imap_stream, $header->id, $header->id, "Seen");
$id = $header->id;
fputs ($imap_stream, "a001 FETCH $id BODYSTRUCTURE\r\n");
$read = fgets ($imap_stream, 10000);
- $read = strtolower($read);
+ $response = substr($read, 0, 4);
+ while ($response != "a001") {
+ $bodystructure .= $read;
+ $read = fgets ($imap_stream, 10000);
+ $response = substr($read, 0, 4);
+ }
+ // $read = strtolower($bodystructure);
+ $read = $bodystructure;
- if ($debug_mime) echo "<tt>$read</tt><br><br>";
+ if ($debug_mime) echo "<tt>$read</tt><br><br>\n";
// isolate the body structure and remove beginning and end parenthesis
- $read = trim(substr ($read, strpos($read, "bodystructure") + 13));
- $read = trim(substr ($read, 0, -2));
- $read = trim(substr ($read, 1));
+ $read = trim(substr ($read, strpos(strtolower($read), "bodystructure") + 13));
+ $read = trim(substr ($read, 0, -1));
+ $end = mime_match_parenthesis(0, $read);
+ while ($end == strlen($read)-1) {
+ $read = trim(substr ($read, 0, -1));
+ $read = trim(substr ($read, 1));
+ $end = mime_match_parenthesis(0, $read);
+ }
- if ($debug_mime) echo "<tt>$read</tt><br><br>";
+ if ($debug_mime) echo "<tt>$read</tt><br><br>\n";
- $msg = mime_parse_structure ($read);
+ $msg = mime_parse_structure ($read, 0);
$msg->header = $header;
return $msg;
}
+ // this starts the parsing of a particular structure. It is called recursively,
+ // so it can be passed different structures. It returns an object of type
+ // $message.
+ // First, it checks to see if it is a multipart message. If it is, then it
+ // handles that as it sees is necessary. If it is just a regular entity,
+ // then it parses it and adds the necessary header information (by calling out
+ // to mime_get_elements()
function mime_parse_structure ($structure, $ent_id) {
global $debug_mime;
- if ($debug_mime) echo "<font color=008800><tt>START: mime_parse_structure()</tt></font><br>";
+ if ($debug_mime) echo "<font color=008800><tt>START: mime_parse_structure()</tt></font><br>\n";
$msg = new message();
if (substr($structure, 0, 1) == "(") {
$ent_id = mime_new_element_level($ent_id);
$start = $end = -1;
+ if ($debug_mime) echo "<br><font color=0000aa><tt>$structure</tt></font><br>";
do {
if ($debug_mime) echo "<font color=008800><tt>Found entity...</tt></font><br>";
$start = $end+1;
$end = mime_match_parenthesis ($start, $structure);
$element = substr($structure, $start+1, ($end - $start)-1);
- $ent_id = mime_increment_id($ent_id);
+ $ent_id = mime_increment_id ($ent_id);
$newmsg = mime_parse_structure ($element, $ent_id);
$msg->addEntity ($newmsg);
} while (substr($structure, $end+1, 1) == "(");
} else {
// parse the elements
if ($debug_mime) echo "<br><font color=0000aa><tt>$structure</tt></font><br>";
- $msg->header = new msg_header();
- $msg->header = mime_get_element (&$structure, $header);
- $msg->header->entity_id = $ent_id;
+ $msg = mime_get_element (&$structure, $msg, $ent_id);
if ($debug_mime) echo "<br>";
}
return $msg;
// the following: 1, 1.2, 4.3.2.4.1, etc. This function increments
// the last number of the element id, changing 1.2 to 1.3.
function mime_increment_id ($id) {
+ global $debug_mime;
if (strpos($id, ".")) {
$first = substr($id, 0, strrpos($id, "."));
- $last = substr($id, strlen($id) - strlen($first));
+ $last = substr($id, strrpos($id, ".")+1);
$last++;
- $new = $first . $last;
+ $new = $first . "." .$last;
} else {
$new = $id + 1;
}
+ if ($debug_mime) echo "<b>INCREMENT: $new</b><br>";
return $new;
}
// to make a special case if it is the first entity_id. It
// always increments it, and that works fine.
function mime_new_element_level ($id) {
- if (!$id)
- $id = 0;
- else
- $id . ".0";
+ if (!$id) $id = 0;
+ else $id = $id . ".0";
+
return $id;
}
- function mime_get_element (&$structure, $header) {
+ function mime_get_element (&$structure, $msg, $ent_id) {
global $debug_mime;
$elem_num = 1;
+ $msg->header = new msg_header();
+ $msg->header->entity_id = $ent_id;
while (strlen($structure) > 0) {
$structure = trim($structure);
$char = substr($structure, 0, 1);
- if (substr($structure, 0, 3) == "nil") {
+ if (strtolower(substr($structure, 0, 3)) == "nil") {
$text = "";
$structure = substr($structure, 3);
} else if ($char == "\"") {
// This is where all the text parts get put into the header
switch ($elem_num) {
case 1:
- $header->type0 = $text;
- if ($debug_mime) echo "<tt>type0 = $text</tt><br>";
+ $msg->header->type0 = strtolower($text);
+ if ($debug_mime) echo "<tt>type0 = ".strtolower($text)."</tt><br>";
break;
case 2:
- $header->type1 = $text;
- if ($debug_mime) echo "<tt>type1 = $text</tt><br>";
+ $msg->header->type1 = strtolower($text);
+ if ($debug_mime) echo "<tt>type1 = ".strtolower($text)."</tt><br>";
+ break;
+ case 5:
+ $msg->header->description = $text;
+ if ($debug_mime) echo "<tt>description = $text</tt><br>";
break;
case 6:
- $header->encoding = $text;
- if ($debug_mime) echo "<tt>encoding = $text</tt><br>";
+ $msg->header->encoding = strtolower($text);
+ if ($debug_mime) echo "<tt>encoding = ".strtolower($text)."</tt><br>";
break;
case 7:
- $header->size = $text;
+ $msg->header->size = $text;
if ($debug_mime) echo "<tt>size = $text</tt><br>";
break;
default:
- if ($header->type0 == "text" && $elem_num == 8) {
- $header->num_lines = $text;
+ if ($msg->header->type0 == "text" && $elem_num == 8) {
+ // This is a plain text message, so lets get the number of lines
+ // that it contains.
+ $msg->header->num_lines = $text;
if ($debug_mime) echo "<tt>num_lines = $text</tt><br>";
+
+ } else if ($msg->header->type0 == "message" && $msg->header->type1 == "rfc822" && $elem_num == 8) {
+ // This is an encapsulated message, so lets start all over again and
+ // parse this message adding it on to the existing one.
+ $structure = trim($structure);
+ if (substr($structure, 0, 1) == "(") {
+ $e = mime_match_parenthesis (0, $structure);
+ $structure = substr($structure, 0, $e);
+ $structure = substr($structure, 1);
+ $m = mime_parse_structure($structure, $msg->header->entity_id);
+
+ // the following conditional is there to correct a bug that wasn't
+ // incrementing the entity IDs correctly because of the special case
+ // that message/rfc822 is. This fixes it fine.
+ if (substr($structure, 1, 1) != "(")
+ $m->header->entity_id = mime_increment_id(mime_new_element_level($ent_id));
+
+ // Now we'll go through and reformat the results.
+ if ($m->entities) {
+ for ($i=0; $i < count($m->entities); $i++) {
+ $msg->addEntity($m->entities[$i]);
+ }
+ } else {
+ $msg->addEntity($m);
+ }
+ $structure = "";
+ }
}
break;
}
$text = "";
}
// loop through the additional properties and put those in the various headers
- for ($i=0; $i < count($properties); $i++) {
- $header->{$properties[$i]["name"]} = $properties[$i]["value"];
- if ($debug_mime) echo "<tt>".$properties[$i]["name"]." = " . $properties[$i]["value"] . "</tt><br>";
+ if ($msg->header->type0 != "message") {
+ for ($i=0; $i < count($properties); $i++) {
+ $msg->header->{$properties[$i]["name"]} = $properties[$i]["value"];
+ if ($debug_mime) echo "<tt>".$properties[$i]["name"]." = " . $properties[$i]["value"] . "</tt><br>";
+ }
}
- return $header;
+
+ return $msg;
}
// I did most of the MIME stuff yesterday (June 20, 2000), but I couldn't
// in the morning and had a flash of insight. I went to the white-board
// and scribbled it out, then spent a bit programming it, and this is the
// result. Nothing complicated, but I think my brain was fried yesterday.
+ // Funny how that happens some times.
//
// This gets properties in a nested parenthesisized list. For example,
// this would get passed something like: ("attachment" ("filename" "luke.tar.gz"))
$structure = trim(substr($structure, strlen($tmp) + 2));
$k = count($props);
- $props[$k]["name"] = $tmp;
+ $props[$k]["name"] = strtolower($tmp);
$props[$k]["value"] = $value;
} else if ($char == "(") {
$end = mime_match_parenthesis (0, $structure);
$sub = substr($structure, 1, $end-1);
$props = mime_get_props($props, $sub);
$structure = substr($structure, strlen($sub) + 2);
+ return $props;
} else {
return $props;
}
$char = substr($structure, $pos, 1);
// ignore all extra characters
+ // If inside of a string, skip string -- Boundary IDs and other
+ // things can have ) in them.
while ($pos < strlen($structure)) {
$pos++;
$char = substr($structure, $pos, 1);
if ($char == ")") {
return $pos;
+ } else if ($char == '"') {
+ $pos ++;
+ while (substr($structure, $pos, 1) != '"' &&
+ $pos < strlen($structure)) {
+ $pos ++;
+ }
} else if ($char == "(") {
$pos = mime_match_parenthesis ($pos, $structure);
}
if (!$ent_id) $ent_id = 1;
fputs ($imap_stream, "a001 FETCH $id BODY[$ent_id]\r\n");
- $topline = fgets ($imap_stream, 1024);
- $size = substr ($topline, strpos($topline, "{")+1);
- $size = substr ($size, 0, strpos($size, "}"));
- $read = fread ($imap_stream, $size);
- return $read;
+ $data = sqimap_read_data ($imap_stream, 'a001', true, $response, $message);
+ $topline = array_shift($data);
+ while (! ereg('\* [0-9]+ FETCH ', $topline) && data)
+ $topline = array_shift($data);
+ $wholemessage = implode('', $data);
+
+ if (ereg('\{([^\}]*)\}', $topline, $regs)) {
+ return substr($wholemessage, 0, $regs[1]);
+ }
+ else if (ereg('"([^"]*)"', $topline, $regs)) {
+ return $regs[1];
+ }
+
+ $str = "Body retrival error. Please report this bug!\n";
+ $str .= "Response: $response\n";
+ $str .= "Message: $message\n";
+ $str .= "FETCH line: $topline";
+ $str .= "---------------\n$wholemessage";
+ foreach ($data as $d)
+ {
+ $str .= htmlspecialchars($d) . "\n";
+ }
+ return $str;
+
+ return "Body retrival error, please report this bug!\n\nTop line is \"$topline\"\n";
}
/* -[ END MIME DECODING ]----------------------------------------------------------- */
/** This is the first function called. It decides if this is a multipart
message or if it should be handled as a single entity
**/
- function decodeMime ($body, $header) {
+ function decodeMime ($imap_stream, $body, $header) {
global $username, $key, $imapServerAddress, $imapPort;
- $imap_stream = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
- sqimap_mailbox_select($imap_stream, $header->mailbox);
-
return mime_structure ($imap_stream, $header);
}
+ // This is here for debugging purposese. It will print out a list
+ // of all the entity IDs that are in the $message object.
+ function listEntities ($message) {
+ if ($message) {
+ if ($message->header->entity_id)
+ echo "<tt>" . $message->header->entity_id . " : " . $message->header->type0 . "/" . $message->header->type1 . "<br>";
+ for ($i = 0; $message->entities[$i]; $i++) {
+ $msg = listEntities($message->entities[$i], $ent_id);
+ if ($msg)
+ return $msg;
+ }
+ }
+ }
+
+ // returns a $message object for a particular entity id
function getEntity ($message, $ent_id) {
if ($message) {
- if ($message->header->entity_id == $ent_id) {
+ if ($message->header->entity_id == $ent_id && strlen($ent_id) == strlen($message->header->entity_id)) {
return $message;
} else {
for ($i = 0; $message->entities[$i]; $i++) {
}
}
+ // figures out what entity to display and returns the $message object
+ // for that entity.
function findDisplayEntity ($message) {
if ($message) {
if ($message->header->type0 == "text") {
everything needed, including HTML Tags, Attachments at the
bottom, etc.
**/
- function formatBody($message, $color, $wrap_at) {
- /** this if statement checks for the entity to show as the
- primary message. To add more of them, just put them in the
- order that is their priority.
- **/
- global $username, $key, $imapServerAddress, $imapPort;
-
+ function formatBody($imap_stream, $message, $color, $wrap_at) {
+ // this if statement checks for the entity to show as the
+ // primary message. To add more of them, just put them in the
+ // order that is their priority.
+ global $startMessage, $username, $key, $imapServerAddress, $imapPort;
$id = $message->header->id;
$urlmailbox = urlencode($message->header->mailbox);
- $imap_stream = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
- sqimap_mailbox_select($imap_stream, $message->header->mailbox);
-
+ // Get the right entity and redefine message to be this entity
$ent_num = findDisplayEntity ($message);
- $body = mime_fetch_body ($imap_stream, $id, $ent_num);
-
- /** If there are other types that shouldn't be formatted, add
- them here **/
- //if ($->type1 != "html") {
- $body = translateText($body, $wrap_at, $charset);
- //}
-
- $body .= "<BR><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>";
-
- /** Display the ATTACHMENTS: message if there's more than one part **/
- if ($message->entities) {
- $body .= "<TABLE WIDTH=100% CELLSPACING=0 CELLPADDING=4 BORDER=0><TR><TD BGCOLOR=\"$color[0]\">";
- $body .= "<TT><B>ATTACHMENTS:</B></TT>";
- $body .= "</TD></TR><TR><TD BGCOLOR=\"$color[0]\">";
- $num = 0;
-
- /** make this recurisve at some point **/
- $body .= formatAttachments ($message, $ent_num, $message->header->mailbox, $id);
+ $body_message = getEntity($message, $ent_num);
+ if (($body_message->header->type0 == "text") ||
+ ($body_message->header->type0 == "rfc822")) {
+
+ $body = mime_fetch_body ($imap_stream, $id, $ent_num);
+ $body = decodeBody($body, $body_message->header->encoding);
+
+ // If there are other types that shouldn't be formatted, add
+ // them here
+ if ($body_message->header->type1 != "html") {
+ translateText($body, $wrap_at, $body_message->header->charset);
+ }
+
+ $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>";
+
+ /** Display the ATTACHMENTS: message if there's more than one part **/
$body .= "</TD></TR></TABLE>";
+ if ($message->entities) {
+ $body .= formatAttachments ($message, $ent_num, $message->header->mailbox, $id);
+ }
+ } else {
+ $body .= formatAttachments ($message, -1, $message->header->mailbox, $id);
}
return $body;
}
// A recursive function that returns a list of attachments with links
// to where to download these attachments
function formatAttachments ($message, $ent_id, $mailbox, $id) {
+ global $where, $what;
+ global $startMessage, $color;
+ static $ShownHTML;
+
+ if ($ShownHTML == 0)
+ {
+ $ShownHTML = 1;
+
+ $body .= "<TABLE WIDTH=100% CELLSPACING=0 CELLPADDING=2 BORDER=0 BGCOLOR=\"$color[0]\"><TR>\n";
+ $body .= "<TH ALIGN=\"left\" BGCOLOR=\"$color[9]\"><B>\n";
+ $body .= _('Attachments') . ':';
+ $body .= "</B></TH></TR><TR><TD>\n";
+
+ $body .= "<TABLE CELLSPACING=0 CELLPADDING=1 BORDER=0>\n";
+
+ $body .= formatAttachments ($message, $ent_id, $mailbox, $id);
+
+ $body .= "</TABLE></TD></TR></TABLE>";
+
+ return $body;
+ }
+
if ($message) {
if (!$message->entities) {
$type0 = strtolower($message->header->type0);
$type1 = strtolower($message->header->type1);
if ($message->header->entity_id != $ent_id) {
- $filename = $message->header->filename;
+ $filename = decodeHeader($message->header->filename);
if (trim($filename) == "") {
- $display_filename = "untitled-$ent_id";
+ $display_filename = "untitled-".$message->header->entity_id;
} else {
$display_filename = $filename;
}
$urlMailbox = urlencode($mailbox);
$ent = urlencode($message->header->entity_id);
- $body .= "<TT> <A HREF=\"../src/download.php?passed_id=$id&mailbox=$urlMailbox&passed_ent_id=$ent\">" . $display_filename . "</A> <SMALL>(TYPE: $type0/$type1)</SMALL></TT><BR>";
- $num++;
+
+ $DefaultLink =
+ "../src/download.php?startMessage=$startMessage&passed_id=$id&mailbox=$urlMailbox&passed_ent_id=$ent";
+ if ($where && $what)
+ $DefaultLink .= '&where=' . urlencode($where) . '&what=' . urlencode($what);
+ $Links['download link']['text'] = _('download');
+ $Links['download link']['href'] =
+ "../src/download.php?absolute_dl=true&passed_id=$id&mailbox=$urlMailbox&passed_ent_id=$ent";
+ $ImageURL = '';
+
+ $HookResults = do_hook("attachment $type0/$type1", $Links,
+ $startMessage, $id, $urlMailbox, $ent, $DefaultLink,
+ $display_filename, $where, $what);
+
+ $Links = $HookResults[1];
+ $DefaultLink = $HookResults[6];
+
+ $body .= '<TR><TD> </TD><TD>';
+ $body .= "<A HREF=\"$DefaultLink\">$display_filename</A> </TD>";
+ $body .= '<TD><SMALL><b>' . show_readable_size($message->header->size) .
+ '</b> </small></TD>';
+ $body .= "<TD><SMALL>[ $type0/$type1 ] </SMALL></TD>";
+ $body .= '<TD><SMALL>';
+ if ($message->header->description)
+ $body .= '<b>' . htmlspecialchars($message->header->description) . '</b>';
+ $body .= '</SMALL></TD><TD><SMALL> ';
+
+
+ $SkipSpaces = 1;
+ foreach ($Links as $Val)
+ {
+ if ($SkipSpaces)
+ {
+ $SkipSpaces = 0;
+ }
+ else
+ {
+ $body .= ' | ';
+ }
+ $body .= '<a href="' . $Val['href'] . '">' . $Val['text'] . '</a>';
+ }
+
+ unset($Links);
+
+ $body .= "</SMALL></TD></TR>\n";
}
return $body;
} else {
/** this function decodes the body depending on the encoding type. **/
function decodeBody($body, $encoding) {
+ $body = str_replace("\r\n", "\n", $body);
$encoding = strtolower($encoding);
if ($encoding == "quoted-printable") {
$replace = base64_decode($res[3]);
} else {
$replace = ereg_replace("_", " ", $res[3]);
+ // Convert lowercase Quoted Printable to uppercase for
+ // quoted_printable_decode to understand it.
+ while (ereg("(=([0-9][abcdef])|([abcdef][0-9])|([abcdef][abcdef]))", $replace, $res)) {
+ $replace = str_replace($res[1], strtoupper($res[1]), $replace);
+ }
$replace = quoted_printable_decode($replace);
}
}
// Encode a string according to RFC 1522 for use in headers if it
- // contains 8-bit characters
+ // contains 8-bit characters or anything that looks like it should
+ // be encoded.
function encodeHeader ($string) {
global $default_charset;
- // Encode only if the string contains 8-bit characters
- if (ereg("[\200-\377]", $string)) {
+ // Encode only if the string contains 8-bit characters or =?
+ if (ereg("([\200-\377]|=\\?)", $string)) {
$newstring = "=?$default_charset?Q?";
- $newstring .= str_replace(" ", "_", $string);
- while (ereg("([\200-\377])", $newstring, $regs)) {
- $replace = $regs[1];
- $insert = "=" . bin2hex($replace);
- $newstring = str_replace($replace, $insert, $newstring);
+ // First the special characters
+ $string = str_replace("=", "=3D", $string);
+ $string = str_replace("?", "=3F", $string);
+ $string = str_replace("_", "=5F", $string);
+ $string = str_replace(" ", "_", $string);
+
+ for ( $ch = 127 ; $ch <= 255 ; $ch++ ) {
+ $replace = chr($ch);
+ $insert = sprintf("=%02X", $ch);
+ $string = str_replace($replace, $insert, $string);
+ $ch++;
}
- $newstring .= "?=";
-
+ $newstring = "=?$default_charset?Q?".$string."?=";
+
return $newstring;
}
projects / squirrelmail.git / blobdiff