Initialize $output

[squirrelmail.git] / src / read_body.php

<?php

/**
 * read_body.php
 *
 * Copyright (c) 1999-2002 The SquirrelMail Project Team
 * Licensed under the GNU GPL. For full terms see the file COPYING.
 *
 * This file is used for reading the msgs array and displaying
 * the resulting emails in the right frame.
 *
 * $Id$
 */

require_once('../src/validate.php');
require_once('../functions/imap.php');
require_once('../functions/mime.php');
require_once('../functions/date.php');
require_once('../functions/url_parser.php');
require_once('../functions/smtp.php');
require_once('../functions/html.php');

/**
 * Given an IMAP message id number, this will look it up in the cached
 * and sorted msgs array and return the index. Used for finding the next
 * and previous messages.
 *
 * @return the index of the next valid message from the array
 */
function findNextMessage($passed_id) {
    global $msort, $msgs, $sort, 
           $thread_sort_messages, $allow_server_sort,
           $server_sort_array;
    if (!is_array($server_sort_array)) {
        $thread_sort_messages = 0;
        $allow_server_sort = FALSE;
    }
    $result = -1;
    if ($thread_sort_messages || $allow_server_sort) {
        reset($server_sort_array);
        while(list($key, $value) = each ($server_sort_array)) {
            if ($passed_id == $value) {
                if ($key == (count($server_sort_array) - 1)) {
                    $result = -1;
                    break;
                }
                $result = $server_sort_array[$key + 1];
                break; 
            }
        }
    } 
    elseif ($sort == 6 && !$allow_server_sort  &&
            !$thread_sort_messages ) {
        if ($passed_id != 1) {
            $result = $passed_id - 1;
        }
    }
    elseif (!$allow_server_sort  && !$thread_sort_messages ) {
        if (!is_array($msort)) {
            return -1;
        }
        for (reset($msort); ($key = key($msort)), (isset($key)); next($msort)) {
            if ($passed_id == $msgs[$key]['ID']) {
                next($msort);
                $key = key($msort);
                if (isset($key)){
                    $result = $msgs[$key]['ID'];
                    break;
                }
            }
        }
    }
    return ($result);
}

/** returns the index of the previous message from the array. */
function findPreviousMessage($numMessages, $passed_id) {
    global $msort, $sort, $msgs,
           $thread_sort_messages,
           $allow_server_sort, $server_sort_array;
    $result = -1;
    if (!is_array($server_sort_array)) {
        $thread_sort_messages = 0;
        $allow_server_sort = FALSE;
    }
    if ($thread_sort_messages || $allow_server_sort ) {
        reset($server_sort_array);
        while(list($key, $value) = each ($server_sort_array)) {
            if ($passed_id == $value) {
                if ($key == 0) {
                    $result = -1;
                    break;
                }
                $result = $server_sort_array[$key -1];
                break;
            }
        }
    }
    elseif ($sort == 6 && !$allow_server_sort  && 
            !$thread_sort_messages) {
        if ($passed_id != $numMessages) {
            $result = $passed_id + 1;
        }
    } 
    elseif (!$thread_sort_messages  && !$allow_server_sort) {
        if (!is_array($msort)) {
            return -1;
        }
        for (reset($msort); ($key = key($msort)), (isset($key)); next($msort)) {
            if ($passed_id == $msgs[$key]['ID']) {
                prev($msort);
                $key = key($msort);
                if (isset($key)) {
		    echo $msort[$key];
                    $result = $msgs[$key]['ID'];
                    break;
                }
            }
        }
    }
    return ($result);
}

/**
 * Displays a link to a page where the message is displayed more
 * "printer friendly".
 */
function printer_friendly_link($mailbox, $passed_id, $passed_ent_id, $color) {
    global $javascript_on;

    $params = '?passed_ent_id=' . $passed_ent_id .
        '&mailbox=' . urlencode($mailbox) .
        '&passed_id=' . $passed_id;

    $print_text = _("View Printable Version");

    $result = '';
    /* Output the link. */
    if ($javascript_on) {
        $result .= '<script language="javascript" type="text/javascript">' . "\n" .
                '<!--' . "\n" .
                "  function printFormat() {\n" .
                '    window.open("../src/printer_friendly_main.php' .
                        $params . '","Print","width=800,height=600");' . "\n".
                "  }\n" .
                "// -->\n" .
                "</script>\n" .
                "<a href=\"javascript:printFormat();\">$print_text</a>\n";
    } else {
        $result .= '<A target="_blank" HREF="../src/printer_friendly_bottom.php' .
                "$params\">$print_text</a>\n";
    }
    return ($result);
}

function ServerMDNSupport( $read ) {
    /* escaping $ doesn't work -> \x36 */    
    $ret = preg_match( '/(\x36MDNSent|\\\*)/i', $read );
    return ( $ret );
}

function SendMDN ( $mailbox, $passed_id, $sender, $message) {
    global $username, $attachment_dir, $SERVER_NAME,
           $version, $attachments;

    $header = $message->rfc822_header;
    $hashed_attachment_dir = getHashedDir($username, $attachment_dir);
    
    $recipient_o = $header->dnt;
    $recipient = $recipient_o->getAddress(true);

    // part 1 (RFC2298)

    $senton = getLongDateString( $header->date );
    $to_array = $header->to;
    $to = '';
    foreach ($to_array as $line) {
        $to .= ' '.$line->getAddress();
    }

    $subject = $header->subject;
    $now = getLongDateString( time() );

    set_my_charset();

    $body = _("Your message") . "\r\n\r\n" .
            "\t" . _("To:") . ' ' . $to . "\r\n" .
            "\t" . _("Subject:") . ' ' . $subject . "\r\n" .
            "\t" . _("Sent:") . ' ' . $senton . "\r\n" .
            "\r\n" .
            sprintf( _("Was displayed on %s"), $now );

    // part2  (RFC2298)
    $original_recipient = $to;
    $original_message_id = $header->message_id;

    $part2 = "Reporting-UA : $SERVER_NAME ; SquirrelMail (version $version) \r\n";
    if ($original_recipient != '') {
        $part2 .= "Original-Recipient : $original_recipient\r\n";
    }
    $final_recipient = $sender;
    $part2 .= "Final-Recipient: rfc822; $final_recipient\r\n" .
              "Original-Message-ID : $original_message_id\r\n" .
              "Disposition: manual-action/MDN-sent-manually; displayed\r\n";

    $localfilename = GenerateRandomString(32, 'FILE', 7);
    $full_localfilename = "$hashed_attachment_dir/$localfilename";

    $fp = fopen( $full_localfilename, 'w');
    fwrite ($fp, $part2);
    fclose($fp);

    $newAttachment = array();
    $newAttachment['localfilename'] = $localfilename;
    $newAttachment['type'] = "message/disposition-notification";
    $newAttachment['session']=-1;
    $attachments[] = $newAttachment;

    return (SendMessage($recipient, '', '', _("Read:") . ' ' . $subject, 
                        $body, 0, True, 3, -1) );
}


function ToggleMDNflag ( $set ,$imapConnection, $mailbox, $passed_id, $uid_support) {
    $sg =  $set?'+':'-';
    $cmd = 'STORE ' . $passed_id . ' ' . $sg . 'FLAGS ($MDNSent)';
    $read = sqimap_run_command ($imapConnection, $cmd, true, $response, 
                                $readmessage, $uid_support);
}

function ClearAttachments() {
        global $username, $attachments, $attachment_dir;

        $hashed_attachment_dir = getHashedDir($username, $attachment_dir);

	$rem_attachments = array();
        foreach ($attachments as $info) {
	    if ($info['session'] == -1) {
        	$attached_file = "$hashed_attachment_dir/$info[localfilename]";
        	if (file_exists($attached_file)) {
            	    unlink($attached_file);
        	}
    	    } else {
		$rem_attachments[] = $info;
	    }
	}
        $attachments = $rem_attachments;
}

function formatRecipientString($recipients, $item ) {
    global $show_more_cc, $show_more, $show_more_bcc, 
	   $PHP_SELF;

    if ((is_array($recipients)) && (isset($recipients[0]))) {
        $string = '';
        $ary = $recipients;
	$show = false;

        if ($item == 'to') {
	   if ($show_more) {
	       $show = true;
	       $url = set_url_var($PHP_SELF, 'show_more',0);
	   } else {
	       $url = set_url_var($PHP_SELF, 'show_more',1);
	   }       
	} else if ($item == 'cc') {
	   if ($show_more_cc) {
	       $url = set_url_var($PHP_SELF, 'show_more_cc',0);
	       $show = true;
	   } else {
	      $url = set_url_var($PHP_SELF, 'show_more_cc',1);
	   }
	} else if ($item == 'bcc') {
	   if ($show_more_bcc) {
	      $url = set_url_var($PHP_SELF, 'show_more_bcc',0);
	      $show = true;
	   } else {
	      $url = set_url_var($PHP_SELF, 'show_more_bcc',1);
	   }       
	}

	$cnt = count($ary);
	$i = 0;
        while ($i < $cnt) {
	    $ary[$i] = htmlspecialchars($ary[$i]->getAddress());
    	    if ($string) {
                $string .= '<BR>'.$ary[$i];
    	    } else {
                $string = $ary[$i];
		if ($cnt>1) {
                    $string .= '&nbsp;(<A HREF="'.$url;
		    if ($show) {
		       $string .= '">'._("less").'</A>)';
		    } else {
		       $string .= '">'._("more").'</A>)';
		       break;
		    }
		} 
    	    }
    	    $i++;
        }
    }
    else {
        $string = '';
    }
    return $string;
}

function formatEnvheader($mailbox, $passed_id, $passed_ent_id, $message, 
                         $color, $FirstTimeSee) {
  global $msn_user_support, $default_use_mdn, $draft_folder, $sent_folder,
         $default_use_priority, $show_xmailer_default, 
	 $mdn_user_support, $PHP_SELF, $javascript_on;

   $header = $message->rfc822_header;
   $env = array();
   $env[_("Subject")] = htmlspecialchars($header->subject);   
   $from_name = $header->getAddr_s('from');
   if (!$from_name) {
     $from_name = $header->getAddr_s('sender');
     if (!$from_name) {
         $from_name = _("Unknown sender");
     }
   }
   $env[_("From")] = htmlspecialchars($from_name);
   $env[_("Date")] = getLongDateString($header->date);
   $env[_("To")] = formatRecipientString($header->to, "to");
   $env[_("Cc")] = formatRecipientString($header->cc, "cc");
   $env[_("Bcc")] = formatRecipientString($header->bcc, "bcc");
   if ($default_use_priority) {
      $env[_("Priority")] = getPriorityStr($header->priority);
   }
   if ($show_xmailer_default) {
       $env[_("Mailer")] = $header->xmailer;
   }
   if ($default_use_mdn) {
      if ($mdn_user_support) {
        if ($header->dnt) {
	   if ($message->is_mdnsent) {
	      $env[_("Read receipt")] = _("send");
	   } else {
	      if ( !($mailbox == $draft_folder || 
	             $mailbox == $sent_folder  || $message->is_deleted)) {
		$mdn_url = $PHP_SELF . '&sendreceipt=1';
		if ($FirstTimeSee && $javascript_on) {
		   $script  = '<script language="JavaScript" type="text/javascript">' ."\n";
		   $script .= '<!--'. "\n";
                   $script .= 'if(window.confirm("' .
                       _("The message sender has requested a response to indicate that you have read this message. Would you like to send a receipt?") .
                       '")) {  '."\n" .
		       '    sendMDN()'.
                       '}' . "\n";
		   $script .= '// -->'. "\n";
		   $script .= '</script>'. "\n";
		   echo $script;
		}
		$env[_("Read receipt")] = _("requested") . 
		   '&nbsp;<a href="'.$mdn_url.'">['. _("Send read receipt now") .']</a>';
	      } else {
	        $env[_("Read receipt")] = _("requested"); 
	      }
	   }
	}
      }	         
   }

   $s = '<table width="100%" cellpadding="0" cellspacing="0" border="0" ' .
        'align="center">';
   foreach ($env as $key => $val) {
     if ($val) {      
        $s .= '<tr>';
        $s .=  html_tag( 'td', '<b>'.$key.':&nbsp;&nbsp;</b>', 'right', $color[0], 'valign="top" width="20%"') . "\n";
        $s .=  html_tag( 'td', $val, 'left', $color[0], 'valign="top" width="80%"');
        $s .=  "\n</tr>";
     }
   }
   $s .= '</table>';
   echo $s;
}	     

function formatMenubar($mailbox, $passed_id, $passed_ent_id, $message, $mbx_response) {
   global $base_uri, $sent_folder, $draft_folder, $where, $what, $color, $sort,
          $startMessage, $compose_new_win, $PHP_SELF, $save_as_draft;

   $topbar_delimiter = '&nbsp;|&nbsp;';
   $urlMailbox = urlencode($mailbox);
   $s = '<table width="100%" cellpadding="3" cellspacing="0" align="center"'.
         ' border="0" bgcolor="'.$color[9].'"><tr><td align="left" width="33%"><small>';

   $msgs_url = $base_uri . 'src/';
   if (isset($where) && isset($what)) {
      $msgs_url .= 'search.php?where='.urlencode($where).
                   '&amp;what='.urlencode($what).'&amp;mailbox='.$urlMailbox;
      $msgs_str = _("Search results");		   
   } else {
      $msgs_url .= 'right_main.php?sort='.$sort.'&amp;startMessage='.
                  $startMessage.'&amp;mailbox='.$urlMailbox;
      $msgs_str = _("Message List");
   }
   $s .= '<a href="'. $msgs_url.'">'.$msgs_str.'</a>';
   $s .= $topbar_delimiter;
   
   $delete_url = $base_uri . 'src/delete_message.php?mailbox='.$urlMailbox.
              '&amp;message='.$passed_id.'&amp;';
   if (!(isset($passed_ent_id) && $passed_ent_id)) {
      if ($where && $what) {
         $delete_url .= 'where=' . urlencode($where) . '&amp;what=' . urlencode($what);
      } else {
         $delete_url .= 'sort='. $sort . '&amp;startMessage='. $startMessage;
      }
      $s .= '<a href="'. $delete_url.'">'._("Delete").'</a>';
   }

   $comp_uri = $base_uri . 'src/compose.php'.
                         '?passed_id='.$passed_id.
			 '&amp;mailbox='.$urlMailbox.
			 (isset($passed_ent_id)?'&amp;passed_ent_id='.$passed_ent_id:'');

   if (($mailbox == $draft_folder) && ($save_as_draft)) {
      $comp_alt_uri = $comp_uri . '&amp;action=draft';
      $comp_alt_string = _("Resume Draft");
   } else if ($mailbox == $sent_folder) {
      $comp_alt_uri = $comp_uri . '&amp;action=edit_as_new';
      $comp_alt_string = _("Edit Message as New");
   }
   if (isset($comp_alt_uri)) {
      $s .= $topbar_delimiter;   
      if ($compose_new_win == '1') {
         $s .= '<a href="javascript:void(0)" '. 
	         'onclick="comp_in_new(\''.$comp_alt_uri.'\')">'.$comp_alt_string.'</a>';
      } else {
         $s .= '<a href="'.$comp_alt_uri.'">'.$comp_alt_string.'</a>';
      }
   }
   
   $s .= '</small></td><td align="center" width="33%"><small>';
   
   if (!(isset($where) && isset($what)) && !$passed_ent_id) {
      $prev = findPreviousMessage($mbx_response['EXISTS'], $passed_id);
      $next = findNextMessage($passed_id);
      if ($prev != -1) {
         $uri = $base_uri . 'src/read_body.php?passed_id='.$prev.
               '&amp;mailbox='.$urlMailbox.'&amp;sort='.$sort.
               '&amp;startMessage='.$startMessage.'&amp;show_more=0';
         $s .= '<a href="'.$uri.'">'._("Previous").'</a>';	 
      } else {
         $s .= _("Previous");
      }
      $s .= $topbar_delimiter;
      if ($next != -1) {
         $uri = $base_uri . 'src/read_body.php?passed_id='.$next.
                '&amp;mailbox='.$urlMailbox.'&amp;sort='.$sort.
                '&amp;startMessage='.$startMessage.'&amp;show_more=0';
         $s .= '<a href="'.$uri.'">'._("Next").'</a>';	 
      } else {
         $s .= _("Next");
      }
   } else if (isset($passed_ent_id) && $passed_ent_id) {
      /* code for navigating through attached message/rfc822 messages */
      $url = set_url_var($PHP_SELF, 'passed_ent_id',0);
      $s .= '<a href="'.$url.'">'._("View Message").'</a>';
      $par_ent_id = $message->parent->entity_id;
      if ($par_ent_id) {
         $par_ent_id = substr($par_ent_id,0,-2);
         $s .= $topbar_delimiter;
	 $url = set_url_var($PHP_SELF, 'passed_ent_id',$par_ent_id);
	 $s .= '<a href="'.$url.'">'._("Up").'</a>';
      }
   }      

   $s .= '</small></td><td align="right" width="33%"><small>';

   $comp_action_uri = $comp_uri . '&amp;action=forward';
   if ($compose_new_win == '1') {
      $s .= '<a href="javascript:void(0)" '. 
            'onclick="comp_in_new(\''.$comp_action_uri.'\')">'._("Forward").'</a>';
   } else {
      $s .= '<a href="'.$comp_action_uri.'">'._("Forward").'</a>';
   }
   $s .= $topbar_delimiter;

   $comp_action_uri = decodeHeader($comp_uri . '&amp;action=reply');
   if ($compose_new_win == '1') {
      $s .= '<a href="javascript:void(0)" '. 
            'onclick="comp_in_new(\''.$comp_action_uri.'\')">'._("Reply").'</a>';
   } else {
      $s .= '<a href="'.$comp_action_uri.'">'._("Reply").'</a>';
   }
   $s .= $topbar_delimiter;

   $comp_action_uri = $comp_uri . '&amp;action=reply_all';
   if ($compose_new_win == '1') {
      $s .= '<a href="javascript:void(0)" '. 
            'onclick="comp_in_new(\''.$comp_action_uri.'\')">'._("Reply All").'</a>';
   } else {
      $s .= '<a href="'.$comp_action_uri.'">'._("Reply All").'</a>';
   }
   $s .= '</small></td></tr></table>';
   echo $s;
}

function formatToolbar($mailbox, $passed_id, $passed_ent_id, $message, $color) {
   global $QUERY_STRING, $base_uri;
   
   $urlMailbox = urlencode($mailbox);
   $s = '<table width="100%" cellpadding="3" cellspacing="0" align="center"'.
         ' border="0" bgcolor="'.$color[9].'">'. "\n".
	 '<tr align="right"><td valign="top" align="right"><small>';
   $url = $base_uri.'src/view_header.php?'.$QUERY_STRING;
   $s .= '<a href="'.$url.'">'.("View Full Header").'</a>';
  /* Output the printer friendly link if we are in subtle mode. */
   $s .= '&nbsp;|&nbsp;'. 
         printer_friendly_link($mailbox, $passed_id, $passed_ent_id, $color);
   echo $s;
   do_hook("read_body_header_right");
   echo '</small></td></tr>';
   echo '</table>'."\n";
}


/*
 *   Main of read_boby.php  --------------------------------------------------
 */

/*
    Urled vars
    ----------
    $passed_id
*/

global $uid_support, $sqimap_capabilities;

if (isset($mailbox)) {
    $mailbox = urldecode( $mailbox );
}

$imapConnection = sqimap_login($username, $key, $imapServerAddress, 
                               $imapPort, 0);

$mbx_response = sqimap_mailbox_select($imapConnection, $mailbox, false, false, true);

if (!isset($messages)) {
    $messages = array();
    session_register('messages');
}

/**
 * $message contains all information about the message
 * including header and body
 */

$uidvalidity = $mbx_response['UIDVALIDITY'];
 
if (!isset($messages[$uidvalidity])) {
   $messages[$uidvalidity] = array();
}  
if (!isset($messages[$uidvalidity][$passed_id]) || !$uid_support) {
   $message = sqimap_get_message($imapConnection, $passed_id, $mailbox);
   $messages[$uidvalidity][$passed_id] = $message;
} else {
   $message = sqimap_get_message($imapConnection, $passed_id, $mailbox);
//   $message = $messages[$uidvalidity][$passed_id];
}
$FirstTimeSee = !$message->is_seen;
$message->is_seen = true;
$messages[$uidvalidity][$passed_id] = $message;

if (isset($passed_ent_id)) {
   $message = $message->getEntity($passed_ent_id);
   $message->id = $passed_id;
   $message->mailbox = $mailbox;
} else {
   $passed_ent_id = 0;
}
$header = $message->header;

//do_hook('html_top');

/* ============================================================================= 
 *   block for handling incoming url vars 
 *
 * =============================================================================
 */

if (isset($sendreceipt)) {
   if ( !$message->is_mdnsent ) {
      if (isset($identity) ) {
         $final_recipient = getPref($data_dir, $username, 'email_address' . '0', '' );
      } else {
         $final_recipient = getPref($data_dir, $username, 'email_address', '' );
      }

      $final_recipient = trim($final_recipient);
      if ($final_recipient == '' ) {
         $final_recipient = getPref($data_dir, $username, 'email_address', '' );
      }
      $supportMDN = ServerMDNSupport($mbx_response["PERMANENTFLAGS"]);
      if ( SendMDN( $mailbox, $passed_id, $final_recipient, $message ) > 0 && $supportMDN ) {
         ToggleMDNflag( true, $imapConnection, $mailbox, $passed_id, $uid_support);
         $message->is_mdnsent = true;
         $messages[$uidvalidity][$passed_id]=$message;
      }
      ClearAttachments();
   }
}
/* ============================================================================= 
 *   end block for handling incoming url vars 
 *
 * =============================================================================
 */
$msgs[$passed_id]['FLAG_SEEN'] = true;
 
$messagebody = ''; 
$ent_ar = $message->findDisplayEntity(array());
for ($i = 0; $i < count($ent_ar); $i++) {
   $messagebody .= formatBody($imapConnection, $message, $color, $wrap_at, $ent_ar[$i], $passed_id, $mailbox);
   $messagebody .= '<hr noshade size=1>';
}

displayPageHeader($color, $mailbox);
do_hook('read_body_top');
formatMenuBar($mailbox, $passed_id, $passed_ent_id, $message, $mbx_response);
formatEnvheader($mailbox, $passed_id, $passed_ent_id, $message, $color, $FirstTimeSee);
do_hook("read_body_header");   
formatToolbar($mailbox,$passed_id,$passed_ent_id,$message, $color);
echo '<table width="100%" cellpadding="3" cellspacing="3" align="center"'.
      ' border="0" bgcolor="'.$color[4].'">';
echo '<tr><td>'.$messagebody.'</td></tr>';      
echo '<tr><td>'.formatAttachments($message,$ent_ar,$mailbox, $passed_id).'</td></tr>';      
echo '</table>';

/* show attached images inline -- if pref'fed so */
if (($attachment_common_show_images) &&
    is_array($attachment_common_show_images_list)) {
    foreach ($attachment_common_show_images_list as $img) {
        $imgurl = '../src/download.php' .
                '?' .
                'passed_id='     . urlencode($img['passed_id']) .
                '&amp;mailbox='       . urlencode($mailbox) .
                '&amp;passed_ent_id=' . urlencode($img['ent_id']) .
                '&amp;absolute_dl=true';

        echo html_tag( 'table', "\n" .
	            html_tag( 'tr', "\n" .
	                html_tag( 'td', '<img src="' . $imgurl . '">' ."\n", 'left'
	                )
	            ) ,
        'center', '', 'cellspacing=0 border="0" cellpadding="2"');
    }
}

do_hook('read_body_bottom');
do_hook('html_bottom');
//$message->clean_up();
sqimap_logout($imapConnection);
?>
</body>
</html>