File Source for BitMailer.php

<?php
/**
* $Header: /cvsroot/bitweaver/_bit_newsletters/BitMailer.php,v 1.25 2006/10/13 09:22:47 lsces Exp $
*
* Copyright (c) 2004 bitweaver.org
* All Rights Reserved. See copyright.txt for details and a complete list of authors.
* Licensed under the GNU LESSER GENERAL PUBLIC LICENSE. See license.txt for details
*
* $Id: BitMailer.php,v 1.25 2006/10/13 09:22:47 lsces Exp $
*
* Class that handles editions of newsletters
* @package newsletters
*
* created 2005/12/08
*
* @author spiderr <spider@steelsun.com>
*
* @version $Revision: 1.25 $ $Date: 2006/10/13 09:22:47 $ $Author: lsces $
*/
/**
* required setup
*/
require_once( NEWSLETTERS_PKG_PATH.'BitNewsletter.php' );
require_once( UTIL_PKG_PATH.'phpmailer/class.phpmailer.php' );
/**
* @package newsletters
*/
class BitMailer extends phpmailer {
// Set default variables for all new objects
var $From;
var $FromName;
var $Host;
var $Mailer; // Alternative to IsSMTP()
var $WordWrap;
function BitMailer () {
global $gBitDb, $gBitSystem, $gBitLanguage;
$this->mDb = $gBitDb;
$this->From = $gBitSystem->getConfig( 'bitmailer_sender_email', $gBitSystem->getConfig( 'site_sender_email', $_SERVER['SERVER_ADMIN'] ) );
$this->FromName = $gBitSystem->getConfig( 'bitmailer_from', $gBitSystem->getConfig( 'siteTitle' ) );
$this->Host = $gBitSystem->getConfig( 'bitmailer_servers', $gBitSystem->getConfig( 'kernel_server_name', '127.0.0.1' ) );
$this->Mailer = $gBitSystem->getConfig( 'bitmailer_protocol', 'smtp' ); // Alternative to IsSMTP()
$this->WordWrap = $gBitSystem->getConfig( 'bitmailer_word_wrap', 75 );
if( !$this->SetLanguage( $gBitLanguage->getLanguage(), UTIL_PKG_PATH.'phpmailer/language/' ) ) {
$this->SetLanguage( 'en' );
}
}
// Replace the default error_handler
function error_handler( $msg ) {
global $gBitDb;
bit_error_handler( NULL, NULL, NULL, "FULFILLMENT ERROR: MISSSING PDF for ORDER $pOrderId CID ".$prod->mInfo['related_content_id'], $pdfInfo['pdf_file'], '', $prod->mDb );
print("My Site Error");
print("Description:");
printf("%s", $msg);
exit;
}
function queueRecipients( $pContentId, $pNewsletterContentId, $pRecipients ) {
$ret = 0;
if( !empty( $pRecipients ) && BitBase::verifyId( $pContentId ) ) {
$queueTime = time();
foreach( array_keys( $pRecipients ) AS $email ) {
$insertHash['mail_queue_id'] = $this->mDb->GenID( 'mail_queue_id' );
$insertHash['email'] = $email;
if( !empty( $pRecipients[$email]['user_id'] ) ) {
$insertHash['user_id'] = $pRecipients[$email]['user_id'];
}
$insertHash['content_id'] = $pContentId;
$insertHash['nl_content_id'] = $pNewsletterContentId;
$insertHash['queue_date'] = $queueTime;
$this->mDb->associateInsert( BIT_DB_PREFIX.'mail_queue', $insertHash );
$ret++;
}
}
return $ret;
}
function tendQueue() {
global $gBitSmarty, $gBitSystem;
$body = array();
$this->mDb->StartTrans();
$query = "SELECT *
FROM `".BIT_DB_PREFIX."mail_queue` mq
WHERE `sent_date` IS NULL ".$this->mDb->SQLForUpdate();
if( $rs = $this->mDb->query( $query, NULL ) ) {
while( $pick = $rs->fetchRow() ) {
if( !empty( $pick['user_id'] ) ) {
$userHash = $this->mDb->getRow( "SELECT * FROM `".BIT_DB_PREFIX."users_users` WHERE `user_id`=?", array( $pick['user_id'] ) );
$pick['full_name'] = BitUser::getDisplayName( FALSE, $userHash );
} else {
$pick['full_name'] = NULL;
}
if( !isset( $body[$pick['content_id']] ) ) {
$gBitSmarty->assign( 'sending', TRUE );
// We only support sending of newsletters currently
$content = new BitNewsletterEdition( NULL, $pick['content_id'] );
if( $content->load() ) {
$body[$pick['content_id']]['body'] = $content->render();
$body[$pick['content_id']]['subject'] = $content->getTitle();
$body[$pick['content_id']]['reply_to'] = $content->getField( 'reply_to', $gBitSystem->getConfig( 'site_sender_email', $_SERVER['SERVER_ADMIN'] ) );
$body[$pick['content_id']]['object'] = $content;
}
// $content[$pick['content_id']] = LibertyBase::getLibertyObject();
}
if( !empty( $body[$pick['content_id']] ) ) {
$pick['url_code'] = md5( $pick['content_id'].$pick['email'].$pick['queue_date'] );
$unsub = '';
if( $body[$pick['content_id']]['object']->mNewsletter->getField('unsub_msg') ) {
$gBitSmarty->assign( 'url_code', $pick['url_code'] );
$gBitSmarty->assign( 'sending', TRUE );
}
$gBitSystem->preDisplay('');
$gBitSmarty->assign( 'mid', 'bitpackage:newsletters/view_edition.tpl' );
$htmlBody = $gBitSmarty->fetch( 'bitpackage:kernel/bitweaver.tpl' );
$gBitSmarty->assign( 'unsubMessage', $unsub );
$gBitSmarty->assign( 'trackCode', $pick['url_code'] );
$this->ClearReplyTos();
$this->AddReplyTo( $body[$pick['content_id']]['reply_to'], $gBitSystem->getConfig( 'bitmailer_from' ) );
print "TO: $pick[email]\t";
if( $this->sendMail( $pick, $body[$pick['content_id']]['subject'], $htmlBody ) ) {
print "SENT\n";
$updateQuery = "UPDATE `".BIT_DB_PREFIX."mail_queue` SET `sent_date`=?,`url_code`=? WHERE `content_id`=? AND `email`=?";
$this->mDb->query( $updateQuery, array( time(), $pick['url_code'], $pick['content_id'], $pick['email'] ) );
} else {
$this->logError( $pick );
}
$this->mDb->CompleteTrans();
$this->mDb->StartTrans();
}
}
}
$this->mDb->CompleteTrans();
}
function sendMail( $pRecipient, $pSubject, $pHtmlBody ) {
$ret = TRUE;
$this->Body = $pHtmlBody;
$this->Subject = $pSubject;
$this->IsHTML( TRUE );
$this->AltBody = '';
$this->AddAddress( $pRecipient['email'], $pRecipient["full_name"] );
if(!$this->Send()) {
$ret = FALSE;
}
// Clear all addresses and attachments for next loop
$this->ClearAddresses();
$this->ClearAttachments();
return $ret;
}
function trackMail( $pUrlCode ) {
global $gBitDb;
$query = "UPDATE `".BIT_DB_PREFIX."mail_queue` SET `reads`=`reads`+1, `last_read_date`=? WHERE `url_code`=? ";
$gBitDb->query( $query, array( time(), $pUrlCode ) );
}
function logError( $pInfo ) {
if( !empty( $pInfo['url_code'] ) && !$this->mDb->getOne( "SELECT `url_code` FROM `".BIT_DB_PREFIX."mail_errors` WHERE `url_code`=?", array( $pInfo['url_code'] ) ) ) {
$store['url_code'] = $pInfo['url_code'];
$store['user_id'] = !empty( $pInfo['user_id'] ) ? $pInfo['user_id'] : NULL;
$store['content_id'] = !empty( $pInfo['content_id'] ) ? $pInfo['content_id'] : NULL;
$store['email'] = !empty( $pInfo['email'] ) ? $pInfo['email'] : NULL;
$store['error_message'] = $this->ErrorInfo;
$store['error_date'] = time();
$this->mDb->associateInsert( BIT_DB_PREFIX."mail_errors", $store );
}
print "ERROR: ".$this->ErrorInfo."\n";
}
// Looks up the code from the url to determine if the unsubscribe URL is valid.
// Can be statically called
function lookupSubscription( $pLookup ) {
global $gBitDb;
$ret = NULL;
if( is_array( $pLookup ) ) {
$query = "SELECT mq.*, lc.title, tct.*, uu.`real_name`, uu.`login`, uu.`email` FROM `".BIT_DB_PREFIX."mail_queue` mq
INNER JOIN `".BIT_DB_PREFIX."liberty_content` lc ON( mq.`content_id`=lc.`content_id` )
INNER JOIN `".BIT_DB_PREFIX."liberty_content_types` tct ON( tct.`content_type_guid`=lc.`content_type_guid` )
LEFT OUTER JOIN `".BIT_DB_PREFIX."users_users` uu ON( mq.`user_id`=uu.`user_id` )
WHERE mq.`".key( $pLookup )."`=? ";
$ret = $gBitDb->getRow( $query, array( current( $pLookup ) ) );
}
return( $ret );
}
// Accepts a single row has containing the column of mail_subscriptions as the key to lookup the unsubscription info
// Can be statically called
function getUnsubscriptions( $pMixed ) {
global $gBitDb;
$ret = NULL;
if( is_array( $pMixed ) ) {
$col = key( $pMixed );
$bindVars[] = current( $pMixed );
$query = "SELECT ms.`content_id` AS `hash_key`, ms.*, uu.*, lc.title
FROM `".BIT_DB_PREFIX."mail_subscriptions` ms
LEFT OUTER JOIN `".BIT_DB_PREFIX."users_users` uu ON( ms.`user_id`=uu.`user_id` )
LEFT OUTER JOIN `".BIT_DB_PREFIX."liberty_content` lc ON( ms.`content_id`=lc.`content_id` )
WHERE ms.`$col`=? ";
$ret = $gBitDb->getAssoc( $query, $bindVars );
}
return( $ret );
}
function storeSubscriptions( $pSubHash ) {
global $gBitSystem, $gBitDb;
$ret = FALSE;
$query = "delete from `".BIT_DB_PREFIX."mail_subscriptions` where `".key( $pSubHash['sub_lookup'] )."`=?";
$result = $gBitDb->query($query, array( current( $pSubHash['sub_lookup'] ) ) );
$ret = TRUE;
if( !empty( $pSubHash['unsub_content'] ) ) {
foreach( $pSubHash['unsub_content'] as $conId ) {
$storeHash = array();
$storeHash['content_id'] = $conId;
$storeHash['unsubscribe_all'] = !empty( $pSubHash['unsubscribe_all'] ) ? 'y' : NULL;
$storeHash['unsubscribe_date'] = time();
$storeHash[key( $pSubHash['sub_lookup'] )] = current( $pSubHash['sub_lookup'] );
if( !empty( $pSubHash['response_content_id'] ) ) {
$storeHash['response_content_id'] = $pSubHash['response_content_id'];
}
$gBitDb->associateInsert( BIT_DB_PREFIX."mail_subscriptions", $storeHash );
}
}
return $ret;
}
function getQueue( &$pListHash ) {
$ret = array();
LibertyContent::prepGetList( $pListHash );
$query = "SELECT mq.`mail_queue_id` AS `hash_key`, mq.*, lc.`title`, lc2.`title` AS newsletter_title
FROM `".BIT_DB_PREFIX."mail_queue` mq
INNER JOIN `".BIT_DB_PREFIX."liberty_content` lc ON (lc.content_id=mq.content_id)
LEFT OUTER JOIN `".BIT_DB_PREFIX."liberty_content` lc2 ON (lc2.content_id=mq.nl_content_id)
WHERE begin_date IS NULL
ORDER BY queue_date";
if( $rs = $this->mDb->query( $query ) ) {
$ret = $rs->getAssoc();
}
return $ret;
}
function expungeQueueRow( $pQueueId ) {
if( BitBase::verifyId( $pQueueId ) ) {
$this->mDb->query( "DELETE FROM ".BIT_DB_PREFIX."mail_queue` WHERE `mail_queue_id`=?", array( $pQueueId ) );
}
}
}
?>

Source for file BitMailer.php