From 0d853433eb9b3e6d7bd4305f42bad739ca7a7e48 Mon Sep 17 00:00:00 2001
From: Chris Case <kahotep@bunda.dreamhost.com>
Date: Tue, 15 Feb 2011 03:31:20 -0800
Subject: [PATCH] fixed error which was causing multiple line breaks, added
 comments to better document what is occuring, cleaned up code, removed
 unnecessary parameters from templating step

---
 mod/dfrn_notify.php | 75 +++++++++++++++++++++++++--------------------
 1 file changed, 41 insertions(+), 34 deletions(-)

diff --git a/mod/dfrn_notify.php b/mod/dfrn_notify.php
index 7231e8fd29..5f91f1b1be 100644
--- a/mod/dfrn_notify.php
+++ b/mod/dfrn_notify.php
@@ -173,63 +173,70 @@ function dfrn_notify_post(&$a) {
 		require_once('bbcode.php');
 		if($importer['notify-flags'] & NOTIFY_MAIL) {
 
-//			$body = html_entity_decode(strip_tags(bbcode(stripslashes(nl2br($msg['body'])))),ENT_QUOTES,'UTF-8');
-//			$body = strip_tags(bbcode(stripslashes(nl2br($msg['body']))));
-			
-			/*if(function_exists('quoted_printable_encode'))
-				$body = quoted_printable_encode($body);
-			else
-				$body = qp($body);*/
-
-			//$msg['body'] = str_replace(array("\\r\\n", "\\r", "\\n"), "<br />", $msg['body']);
-			//$msg['body'] = html_entity_decode(strip_tags(bbcode($msg['body'])));	
+			// generate a mime boundary
 			$msg['mimeboundary']   =rand(0,9)."-"
 				.rand(10000000000,9999999999)."-"
 				.rand(10000000000,9999999999)."=:"
 				.rand(10000,99999);
 
+			// name of the automated email sender
 			$msg['notificationfromname']	= t('Administrator');
+			// noreply address to send from
 			$msg['notificationfromemail']	= t('noreply') . '@' . $a->get_hostname();				
+			// message headers
 			$msg['headers'] =
 				"From: {$msg['notificationfromname']} <{$msg['notificationfromemail']}>\n" . 
 				"Reply-To: {$msg['notificationfromemail']}\n" .
 				"MIME-Version: 1.0\n" .
 				"Content-Type: multipart/alternative; boundary=\"{$msg['mimeboundary']}\"";
 
-
+			// text version
+			// process the message body to display properly in text mode
+			// 		1) substitute a \n character for the "\" then "n", so it behaves properly (it doesn't come in as a \n character)
+			//		2) remove escape slashes
+			//		3) decode any bbcode from the message editor
+			//		4) decode any encoded html tags
+			//		5) remove html tags
 			$msg['textversion']
 				= strip_tags(html_entity_decode(bbcode(stripslashes(str_replace(array("\\r\\n", "\\r", "\\n"), "\n",$msg['body']))),ENT_QUOTES,'UTF-8'));
-			//$TextMessage	= html_entity_decode(strip_tags(bbcode(str_replace(array("\\r\\n", "\\r", "\\n"), "\n",$msg['body']))));	;
+				
+			// html version
+			// process the message body to display properly in text mode
+			// 		1) substitute a <br /> tag for the "\" then "n", so it behaves properly (it doesn't come in as a \n character)
+			//		2) remove escape slashes
+			//		3) decode any bbcode from the message editor
+			//		4) decode any encoded html tags
 			$msg['htmlversion']	
-				= html_entity_decode(bbcode(stripslashes(str_replace(array("\\r\\n", "\\r", "\\n"), "<br />\n",$msg['body']))));
-								
-			$tpl = load_view_file('view/mail_received_eml.tpl');			
+				= html_entity_decode(bbcode(stripslashes(str_replace(array("\\r\\n", "\\r","\\n\\n" ,"\\n"), "<br />\n",$msg['body']))));
+			
+			// load the template for private message notifications
+			$tpl = load_view_file('view/mail_received_eml.tpl');
+			
+			// import the data into the template			
 			$email_tpl = replace_macros($tpl, array(
-				'$siteName'		=> $a->config['sitename'],
-				'$siteurl'		=> $a->get_baseurl(),
-				'$username'		=> $importer['username'],
-				'$thumb'		=> $importer['thumb'],
-				'$email'		=> $importer['email'],
-				'$url'			=> $importer['url'],
-				'$senderName'	=> $importer['senderName'],
-				'$from'			=> $msg['from-name'],
-				'$title'		=> stripslashes($msg['title']),
-				'$textversion'	=> $msg['textversion'],
-				'$htmlversion'	=> $msg['htmlversion'],
-				'$mimeboundary'	=> $msg['mimeboundary'],
-				'$hostname'		=> $a->get_hostname()
+				'$siteName'		=> $a->config['sitename'],				// name of this site
+				'$siteurl'		=> $a->get_baseurl(),					// descriptive url of this site
+				'$thumb'		=> $importer['thumb'],					// thumbnail url for sender icon
+				'$email'		=> $importer['email'],					// email address to send to
+				'$url'			=> $importer['url'],					// full url for the site
+				'$from'			=> $msg['from-name'],					// name of the person sending the message
+				'$title'		=> stripslashes($msg['title']),			// subject of the message
+				'$textversion'	=> $msg['textversion'],					// text version of the message
+				'$htmlversion'	=> $msg['htmlversion'],					// html version of the message
+				'$mimeboundary'	=> $msg['mimeboundary'],				// mime message divider
+				'$hostname'		=> $a->get_hostname()					// name of this host
 			));
 			
 			logger("message headers: " . $msg['headers']);
 			logger("message body: " . $mail_tpl);
 			
 			
-			$res = mail($importer['email'], t('New mail received at ') . $a->config['sitename'],
-				$email_tpl, $msg['headers']
-			/*		'From: ' . t('Administrator') . '@' . $a->get_hostname() . "\r\n"
-					. 'MIME-Version: 1.0' . "\r\n"
-					. 'Content-type: text/html; charset=utf-8' . "\r\n" 
-					. 'Content-transfer-encoding: quoted-printable' . "\r\n" */
+			// send the message
+			$res = mail(
+				$importer['email'], 									// send to address
+				t('New mail received at ') . $a->config['sitename'],	// subject
+				$email_tpl, 											// message body
+				$msg['headers']											// message headers
 			);
 		}
 		xml_status(0);