Allow emails to be sent with documents as attachments.

git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@3334 c91229c3-7414-0410-bfa2-8a42b809f60b

Allow emails to be sent with documents as attachments.
git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@3334 c91229c3-7414-0410-bfa2-8a42b809f60b
Neil Blakey-Milner
1 parent 326bcfd3
Showing 5 changed files with 129 additions and 15 deletions
lib/documentmanagement/DocumentTransaction.inc
lib/email/Email.inc
presentation/lookAndFeel/knowledgeTree/documentmanagement/emailBL.php
presentation/lookAndFeel/knowledgeTree/documentmanagement/emailUI.inc
sql/mysql/upgrade/2.0.6/email_attachment_transaction_type.sql
@@ -14,6 +14,7 @@ DEFINE(&quot;EXPUNGE&quot;, 11);
 DEFINE("FORCE_CHECKIN", 12);
 DEFINE("EMAIL_LINK", 13);
 DEFINE("COLLAB_ACCEPT", 14);
+DEFINE("EMAIL_ATTACH", 15);
 /**
  * $Id$
  *
@@ -62,7 +62,7 @@ class Email {
      * @return boolean true on email successfully sent, false otherwise and set $_SESSION["errorMessage"]
      */
     function send($mToEmail, $sSubject, $sBody, $sFromEmail = "", $sFromName = "") {
-        global $default, $lang_err_email;
+        global $default;
         // set defaults for optional params
         $sFromEmail = ((strlen($sFromEmail) == 0) || ($sFromEmail == "")) ? $default->system->get("emailFrom") : $sFromEmail;
@@ -115,6 +115,70 @@ class Email {
     }
     /**
+     * Sends an email to a specified recipient.
+     *
+     * @param string the recipients email address
+     * @param string the subject of the email
+     * @param string the body of the email
+     * @param string the path to the document to attach
+     * @param string the name to the document to attach
+     * @return boolean true on email successfully sent, false otherwise and set $_SESSION["errorMessage"]
+     */
+    function sendAttachment($mToEmail, $sSubject, $sBody, $sDocumentPath, $sDocumentName) {
+        global $default;
+        
+        // set defaults for optional params
+        $sFromEmail = $default->system->get("emailFrom");
+        $sFromName = $default->system->get("emailFromName");
+
+        // set optional params
+        if ((strlen($sFromEmail) > 0) && ($sFromEmail != "")) {
+            $this->oMailer->From = $sFromEmail;
+        }
+        if ((strlen($sFromName) > 0) && ($sFromName != "")) {
+            $this->oMailer->FromName = $sFromName;
+        }
+              
+        if ( (is_string($mToEmail) && (strlen($mToEmail) > 0)) || 
+        	 (is_array($mToEmail) && (count($mToEmail) > 0)) ) {        
+
+	        // just one email address, add it
+	        if (is_string($mToEmail) && (strpos($mToEmail, ";") === false)) {
+	            $this->oMailer->AddAddress($mToEmail);
+	        } else {
+                $aEmailAddresses = array();
+	        	// if we're passed an array, then use it
+	        	if (is_array($mToEmail)) {
+	        		$aEmailAddresses = $mToEmail;
+	        	// if there are multiple addresses (; separated), explode it	        	
+	        	} elseif (strpos($mToEmail, ";") > 0) {
+		            $aEmailAddresses = explode(";", $mToEmail);
+	        	}
+	            for ($i=0; $i<count($aEmailAddresses); $i++) {
+	                $this->oMailer->AddAddress($aEmailAddresses[$i]);
+	                $default->log->debug("Email.inc adding " . $aEmailAddresses[$i]);
+	            }
+	        }
+
+	        $this->oMailer->Subject = stripslashes($sSubject);
+	        $this->oMailer->Body = stripslashes($sBody);
+	        $this->oMailer->AddAttachment($sDocumentPath, $sDocumentName);
+	
+	        //send the email
+	        if(!$this->oMailer->Send()) {
+	            $default->log->error("Error sending mail to $mToEmail; mailer error code=" . $this->oMailer->ErrorInfo);
+	            return PEAR::raiseError("Error sending mail to $mToEmail; mailer error code=" .  $this->oMailer->ErrorInfo);
+	        } else {
+	        	$default->log->info("Successfully sent mail to $mToEmail");
+	        }
+	        return true;
+        } else {
+        	// no valid email addresses supplied
+        	return PEAR::raiseError("No valid email addresses supplied");
+        }
+    }
+
+    /**
     * Sends an email containing a hyperlink to a specified recipient
     *
     * @param  The sender's email address
@@ -27,7 +27,7 @@
 require_once("../../../../config/dmsDefaults.php");
-KTUtil::extractGPC('fComment', 'fDocumentID', 'fSendEmail', 'groupNewRight', 'userNewRight');
+KTUtil::extractGPC('fAttachDocument', 'fComment', 'fDocumentID', 'fSendEmail', 'groupNewRight', 'userNewRight');
 require_once("$default->fileSystemRoot/lib/security/Permission.inc");
 require_once("$default->fileSystemRoot/lib/documentmanagement/Document.inc");
@@ -44,7 +44,7 @@ require_once(&quot;emailUI.inc&quot;);
 /**
  * Sends emails to the selected groups
  */
-function sendGroupEmails($aGroupIDs, $oDocument, $sComment = "") {
+function sendGroupEmails($aGroupIDs, $oDocument, $sComment = "", $bAttachDocument) {
 	global $default;
     // loop through groups
@@ -62,7 +62,7 @@ function sendGroupEmails($aGroupIDs, $oDocument, $sComment = &quot;&quot;) {
 				if (strlen($aUsers[$j]->getEmail())>0 && $aUsers[$j]->getEmailNotification()) {
 					//if the to address is valid, send the mail
 					if (validateEmailAddress($aUsers[$j]->getEmail())) {	    
-						sendEmail($aUsers[$j]->getEmail(), $aUsers[$j]->getName(), $oDocument->getID(), $oDocument->getName(), $sComment);
+						sendEmail($aUsers[$j]->getEmail(), $aUsers[$j]->getName(), $oDocument->getID(), $oDocument->getName(), $sComment, $bAttachDocument);
 					} else {
 						$default->log->error("email validation failed for " . $aUsers[$j]->getEmail());
 					}
@@ -79,7 +79,7 @@ function sendGroupEmails($aGroupIDs, $oDocument, $sComment = &quot;&quot;) {
 /**
  * Sends emails to the selected users
  */
-function sendUserEmails($aUserIDs, $oDocument, $sComment = "") {
+function sendUserEmails($aUserIDs, $oDocument, $sComment = "", $bAttachDocument) {
 	global $default;
     // loop through users
@@ -91,7 +91,7 @@ function sendUserEmails($aUserIDs, $oDocument, $sComment = &quot;&quot;) {
 			if (strlen($oDestUser->getEmail())>0 && $oDestUser->getEmailNotification()) {
 				//if the to address is valid, send the mail
 				if (validateEmailAddress($oDestUser->getEmail())) {	    
-					sendEmail($oDestUser->getEmail(), $oDestUser->getName(), $oDocument->getID(), $oDocument->getName(), $sComment);
+					sendEmail($oDestUser->getEmail(), $oDestUser->getName(), $oDocument->getID(), $oDocument->getName(), $sComment, $bAttachDocument);
 				}
 			} else {
 				$default->log->info("either " . $oDestUser->getUserName() . " has no email address, or notification is not enabled");
@@ -105,17 +105,64 @@ function sendUserEmails($aUserIDs, $oDocument, $sComment = &quot;&quot;) {
 /**
  * Constructs the email message text and sends the message
  */
-function sendEmail($sDestEmailAddress, $sDestUserName, $fDocumentID, $sDocumentName, $sComment) {
+function sendEmail($sDestEmailAddress, $sDestUserName, $iDocumentID, $sDocumentName, $sComment, $bAttachDocument = false) {
+    if ($bAttachDocument !== true) {
+        return sendEmailHyperlink($sDestEmailAddress, $sDestUserName, $iDocumentID, $sDocumentName, $sComment);
+    } else {
+        return sendEmailDocument($sDestEmailAddress, $sDestUserName, $iDocumentID, $sDocumentName, $sComment);
+    }
+}
+
+function sendEmailDocument($sDestEmailAddress, $sDestUserName, $iDocumentID, $sDocumentName, $sComment) {
+    global $default;
+    global $emailerrors;
+    $oSendingUser = User::get($_SESSION["userID"]);
+
+    $sMessage = 'Your colleague, ' . $oSendingUser->getName() . ', wishes you to view the attached document entitled "' .  $sDocumentName . '".';
+    $sMessage .= "\n\n";
+	if (strlen($sComment) > 0) {
+		$sMessage .= "<br><br>Comments:<br>$sComment";
+	}
+    $sTitle = "Document: " . $sDocumentName . " from " .  $oSendingUser->getName();
+    $oEmail = new Email();
+    $oDocument = Document::get($iDocumentID);
+    $sDocumentPath = $oDocument->getPath();
+    $sDocumentFileName = $oDocument->getFileName();
+    $res = $oEmail->sendAttachment($sDestEmailAddress, $sTitle, $sMessage, $sDocumentPath, $sDocumentFileName);
+    if (PEAR::isError($res)) {
+        $default->log->error($res->getMessage());
+        $emailerrors[] = $res->getMessage();
+        return $res;
+    } else if ($res === false) {
+        $default->log->error("Error sending email ($sTitle) to $sDestEmailAddress");
+        $emailerrors[] = "Error sending email ($sTitle) to $sDestEmailAddress";
+        return PEAR::raiseError("Error sending email ($sTitle) to $sDestEmailAddress");
+    } else {
+        $default->log->info("Send email ($sTitle) to $sDestEmailAddress");
+    }
+
+    // emailed link transaction
+    $oDocumentTransaction = & new DocumentTransaction($iDocumentID, "Document link emailed to $sDestEmailAddress", EMAIL_ATTACH);
+    if ($oDocumentTransaction->create()) {
+        $default->log->debug("emailBL.php created email link document transaction for document ID=$iDocumentID");
+    } else {
+        $default->log->error("emailBL.php couldn't create email link document transaction for document ID=$iDocumentID");
+    }
+}
+
+function sendEmailHyperlink($sDestEmailAddress, $sDestUserName, $iDocumentID, $sDocumentName, $sComment) {
     global $default;
     global $emailerrors;
     $oSendingUser = User::get($_SESSION["userID"]);
 	$sMessage = "<font face=\"arial\" size=\"2\">";
-	$sMessage .= $sDestUserName . ",<br><br>";
+    if ($sDestUserName) {
+        $sMessage .= $sDestUserName . ",<br><br>";
+    }
 	$sMessage .= "Your colleague, " . $oSendingUser->getName() . ", wishes you to view the document entitled '" . $sDocumentName . "'.\n  ";
 	$sMessage .= "Click on the hyperlink below to view it.";
 	// add the link to the document to the mail
-	$sMessage .= "<br>" . generateControllerLink("viewDocument", "fDocumentID=$fDocumentID", $sDocumentName);
+	$sMessage .= "<br>" . generateControllerLink("viewDocument", "fDocumentID=$iDocumentID", $sDocumentName);
 	// add optional comment
 	if (strlen($sComment) > 0) {
 		$sMessage .= "<br><br>Comments:<br>$sComment";
@@ -131,18 +178,18 @@ function sendEmail($sDestEmailAddress, $sDestUserName, $fDocumentID, $sDocumentN
         return $res;
     } else if ($res === false) {
 		$default->log->error("Error sending email ($sTitle) to $sDestEmailAddress");		
-		$emailerrors[] = "Error sending email ($sTitle) to $sDestEmailAddress");
+		$emailerrors[] = "Error sending email ($sTitle) to $sDestEmailAddress";
         return PEAR::raiseError("Error sending email ($sTitle) to $sDestEmailAddress");
     } else {
 		$default->log->info("Send email ($sTitle) to $sDestEmailAddress");
 	}
 	// emailed link transaction
-	$oDocumentTransaction = & new DocumentTransaction($fDocumentID, "Document link emailed to $sDestEmailAddress", EMAIL_LINK);
+	$oDocumentTransaction = & new DocumentTransaction($iDocumentID, "Document link emailed to $sDestEmailAddress", EMAIL_LINK);
 	if ($oDocumentTransaction->create()) {
-		$default->log->debug("emailBL.php created email link document transaction for document ID=$fDocumentID");                                    	
+		$default->log->debug("emailBL.php created email link document transaction for document ID=$iDocumentID");                                    	
 	} else {
-		$default->log->error("emailBL.php couldn't create email link document transaction for document ID=$fDocumentID");
+		$default->log->error("emailBL.php couldn't create email link document transaction for document ID=$iDocumentID");
 	}
 }
@@ -164,9 +211,9 @@ if (checkSession()) {
                 //if we're going to send a mail, first make there is someone to send it to
                 if ((count($aGroupIDs) > 1) || (count($aUserIDs) > 1)) {
 	            	// send group emails
-	            	sendGroupEmails($aGroupIDs, $oDocument, $fComment);
+	            	sendGroupEmails($aGroupIDs, $oDocument, $fComment, (boolean)$fAttachDocument);
 	            	// send user emails
-	            	sendUserEmails($aUserIDs, $oDocument, $fComment);
+	            	sendUserEmails($aUserIDs, $oDocument, $fComment, (boolean)$fAttachDocument);
                     if (count($emailerrors)) {
                         $_SESSION['errorMessage'] = join("<br />\n", $emailerrors);
@@ -91,6 +91,7 @@ function getDocumentEmailPage($oDocument) {
 	$sToRender .= renderUserPicker();	
 	$sToRender .= "</table></td></tr>";
 	$sToRender .= "<tr><td><table>\n";
+	$sToRender .= "<tr><td valign=\"top\">" . _("Attach Document") . "</td><td><input type=\"checkbox\" name=\"fAttachDocument\" /></td></tr>";//</tr>\n";
 	$sToRender .= "<tr><td valign=\"top\">" . _("Comment") . "</td><td><textarea rows=\"5\" cols=\"30\" name=\"fComment\"></textarea></td>";//</tr>\n";
 	$sToRender .= "<td valign=\"bottom\"><table><tr><td><input type=\"image\" src=\"" . KTHtml::getEmailButton() . "\" border=\"0\" /></td><td><a href=\"$default->rootUrl/control.php?action=viewDocument&fDocumentID=" . $oDocument->getID() . "\"><img src=\"" . KTHtml::getCancelButton() . "\" border=\"0\"/></a></td></tr></table></td></tr>\n";
 	$sToRender .= "</table></td></tr>\n";
+INSERT INTO document_transaction_types_lookup VALUES (15, 'Email Attachment');