**
**/
+ $debug_mime = false;
$mime_php = true;
if (!isset($i18n_php))
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 **/
var $type0, $type1, $boundary, $charset, $encoding;
var $to, $from, $date, $cc, $bcc, $reply_to, $subject;
- var $id, $mailbox;
- var $entity_id;
+ var $id, $mailbox, $description;
+ var $entity_id, $message_id;
}
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 = sqimap_read_data ($imap_stream, "a001", true, $a, $b);
- $read = strtolower($read[0]);
+ $read = fgets ($imap_stream, 10000);
+ $read = strtolower($read);
- //echo $read."<br><br>";
+ if ($debug_mime) echo "<tt>$read</tt><br><br>";
// 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, 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>";
$msg = mime_parse_structure ($read);
$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) {
- //echo "<font color=008800><tt>START: mime_parse_structure()</tt></font><br>";
+ global $debug_mime;
+ if ($debug_mime) echo "<font color=008800><tt>START: mime_parse_structure()</tt></font><br>";
$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 {
- //echo "<font color=008800><tt>Found entity...</tt></font><br>";
+ 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
- //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;
- //echo "<br>";
+ if ($debug_mime) echo "<br><font color=0000aa><tt>$structure</tt></font><br>";
+ $msg = mime_get_element (&$structure, $msg, $ent_id);
+ if ($debug_mime) echo "<br>";
}
return $msg;
- //echo "<font color=008800><tt> END: mime_parse_structure()</tt></font><br>";
+ if ($debug_mime) echo "<font color=008800><tt> END: mime_parse_structure()</tt></font><br>";
}
// Increments the element ID. An element id can look like any of
// 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);
}
$structure = substr($structure, strlen($text));
}
- //echo "$elem_num : $text<br>";
+ if ($debug_mime) echo "<tt>$elem_num : $text</tt><br>";
// This is where all the text parts get put into the header
switch ($elem_num) {
case 1:
- $header->type0 = $text;
- //echo "<tt>type0 = $text</tt><br>";
+ $msg->header->type0 = $text;
+ if ($debug_mime) echo "<tt>type0 = $text</tt><br>";
break;
case 2:
- $header->type1 = $text;
- //echo "<tt>type1 = $text</tt><br>";
+ $msg->header->type1 = $text;
+ if ($debug_mime) echo "<tt>type1 = $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;
- //echo "<tt>encoding = $text</tt><br>";
+ $msg->header->encoding = $text;
+ if ($debug_mime) echo "<tt>encoding = $text</tt><br>";
break;
case 7:
- $header->size = $text;
- //echo "<tt>size = $text</tt><br>";
+ $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;
- //echo "<tt>num_lines = $text</tt><br>";
+ 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"];
- //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"))
// $props[0]["name"] = "filename";
// $props[0]["value"] = "luke.tar.gz";
function mime_get_props ($props, $structure) {
+ global $debug_mime;
while (strlen($structure) > 0) {
$structure = trim($structure);
$char = substr($structure, 0, 1);
$sub = substr($structure, 1, $end-1);
$props = mime_get_props($props, $sub);
$structure = substr($structure, strlen($sub) + 2);
+ return $props;
} else {
return $props;
}
if (!$ent_id) $ent_id = 1;
fputs ($imap_stream, "a001 FETCH $id BODY[$ent_id]\r\n");
- $read = sqimap_read_data ($imap_stream, "a001", true, $a, $b);
- for ($i=1; $i < count($read)-1; $i++) {
- // This fixes a bug in UW. UW doesn't return what would normall be
- // expected from the BODY fetch command. It has an extra line at the
- // end. So if the second from the last line is a ), then remove it.
- if (trim($read[$i]) == ")" && $i == count($read)-2) {
- continue;
- }
- $text .= $read[$i];
- }
- return $text;
+ $topline = fgets ($imap_stream, 1024);
+ $size = substr ($topline, strpos($topline, "{")+1);
+ $size = substr ($size, 0, strpos($size, "}"));
+ $read = fread ($imap_stream, $size);
+ return $read;
}
/* -[ END MIME DECODING ]----------------------------------------------------------- */
global $username, $key, $imapServerAddress, $imapPort;
$imap_stream = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
sqimap_mailbox_select($imap_stream, $header->mailbox);
+ $struct = mime_structure ($imap_stream, $header);
+ sqimap_logout($imap_stream);
+ return $struct;
+ }
- 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") {
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.
- **/
+ // 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;
-
$id = $message->header->id;
$urlmailbox = urlencode($message->header->mailbox);
$ent_num = findDisplayEntity ($message);
$body = mime_fetch_body ($imap_stream, $id, $ent_num);
+ sqimap_logout($imap_stream);
- /** If there are other types that shouldn't be formatted, add
- them here **/
- //if ($->type1 != "html") {
+ // If there are other types that shouldn't be formatted, add
+ // them here
+ if ($message->header->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>";
+ $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 **/
if ($message->entities) {
if ($message->header->entity_id != $ent_id) {
$filename = $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>";
+ $body .= "<TT> <A HREF=\"../src/download.php?passed_id=$id&mailbox=$urlMailbox&passed_ent_id=$ent\">" . $display_filename . "</A> (TYPE: $type0/$type1)";
+ if ($message->header->description)
+ $body .= " <b>" . htmlspecialchars($message->header->description)."</b>";
+ if ($message->header->type0 == "image" &&
+ ($message->header->type1 == "jpg" ||
+ $message->header->type1 == "jpeg" ||
+ $message->header->type1 == "gif" ||
+ $message->header->type1 == "png"))
+ $body .= " (<a href=\"../src/download.php?passed_id=$id&mailbox=$urlMailbox&passed_ent_id=$ent&view=true\">"._("view")."</a>)\n";
+ $body .= "</TT><BR>";
$num++;
}
return $body;
}
// 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)) {
+ // First the special characters
+ $string = str_replace("=", "=3D", $string);
+ $string = str_replace("?", "=3F", $string);
+ $string = str_replace("_", "=5F", $string);
+ $string = str_replace(" ", "_", $string);
+
+
+ while (ereg("([\200-\377])", $string, $regs)) {
$replace = $regs[1];
- $insert = "=" . bin2hex($replace);
- $newstring = str_replace($replace, $insert, $newstring);
+ $insert = "=" . strtoupper(bin2hex($replace));
+ $string = str_replace($replace, $insert, $string);
}
- $newstring .= "?=";
-
+ $newstring = "=?$default_charset?Q?".$string."?=";
+
return $newstring;
}
projects / squirrelmail.git / blobdiff