go-mailzu/lib/DBEngine.class.php

<?php
/**
* DBEngine class
*
* @author Samuel Tran <stran2005@users.sourceforge.net>
* @author Brian Wong <bwsource@users.sourceforge.net>
* @author Jeremy Fowler <jfowler06@users.sourceforge.net>
* @version 02-21-2007
* @package DBEngine
*
* Following functions taken from PhpScheduleIt,
* @author Nick Korbel <lqqkout13@users.sourceforge.net>
* @version 03-29-05:
*	db_connect(), check_for_error(), cleanRow(), get_err()
*
* Copyright (C) 2005 - 2007 MailZu
* License: GPL, see LICENSE
*/
/**
* Base directory of application
*/
@define('BASE_DIR', dirname(__FILE__) . '/..');
/**
* CmnFns class
*/
include_once('CmnFns.class.php');
/**
* Auth class
*/
include_once('lib/Auth.class.php');
/**
* Pear::DB
*/
if ($GLOBALS['conf']['app']['safeMode']) {
	ini_set('include_path', ( dirname(__FILE__) . '/pear/' . PATH_SEPARATOR . ini_get('include_path') ));
	include_once('pear/DB.php');
}
else {
	include_once('DB.php');
}

/**
* Provide all database access/manipulation functionality
*/
class DBEngine {

	// Reference to the database object
	var $db;

        // The database hostname with port (hostname[:port])
	var $dbHost;

	// Database type
	var $dbType;
	// Database name
	var $dbName;

	// Database user
	var $dbUser;
	// Password for database user
	var $dbPass;
	
	var $err_msg = '';
	var $numRows;
	
	/**
	* DBEngine constructor to initialize object
	* @param none
	*/
	function DBEngine() {
		global $conf;

		$this->dbType = $conf['db']['dbType'];
		$this->dbName = $conf['db']['dbName'];
		$this->dbUser = $conf['db']['dbUser'];
		$this->dbPass = $conf['db']['dbPass'];
		$this->dbHost = $conf['db']['hostSpec'];

		$this->db_connect();
	}
	
	/**
	* Create a persistent connection to the database
	* @param none
	* @global $conf
	*/
	function db_connect() {
	
		/***********************************************************
		/ This uses PEAR::DB
		/ See http://www.pear.php.net/manual/en/package.database.php#package.database.db
		/ for more information and syntax on PEAR::DB
		/**********************************************************/
	
		// Data Source Name: This is the universal connection string
		// See http://www.pear.php.net/manual/en/package.database.php#package.database.db
		// for more information on DSN
		$dsn = $this->dbType . '://' . $this->dbUser . ':' . $this->dbPass
				. '@' . $this->dbHost . '/' . $this->dbName;

		// Make persistant connection to database
		$db = DB::connect($dsn, true);
	
		// If there is an error, print to browser, print to logfile and kill app
		if (DB::isError($db)) {
			CmnFns::write_log('Error connecting to database: ' . $db->getMessage(), $_SESSION['sessionID']);
			die ('Error connecting to database: ' . $db->getMessage() );
		}
		
		// Set fetch mode to return associatve array
		$db->setFetchMode(DB_FETCHMODE_ASSOC);
	
		$this->db = $db;
	}

	/**
	* Return counts for spam, banned, viruses, bad headers, and pending
	* @return array of the 5 counts
	*/
	function get_site_summary() {

		global $conf;

		$return = array();
		$total = array( 'spam' => 0, 'banned' => 0, 'virus' => 0, 'header' => 0, 'pending' => 0, 'total' => 0);

		$query = "SELECT date,
			MAX(stattable.spam) AS spam,
			MAX(stattable.banned) AS banned,
			MAX(stattable.viruses) AS viruses,
			MAX(stattable.badheaders) AS badheaders,
			MAX(stattable.pending) AS pending
			FROM (
				SELECT CAST(time_iso AS DATE) AS date,
					COUNT(content) AS spam,
					0 AS banned,
					0 AS viruses,
					0 AS badheaders,
					0 AS pending
					FROM msgs INNER JOIN msgrcpt ON msgs.mail_id=msgrcpt.mail_id
					WHERE content='S' AND NOT (msgs.quar_type = '')
					AND msgrcpt.rs IN ('','v')
					GROUP BY CAST(time_iso AS DATE)
				UNION
				SELECT CAST(time_iso AS DATE) AS date,
					0 AS spam,
					COUNT(content) AS banned,
					0 AS viruses,
					0 AS badheaders,
					0 AS pending 
					FROM msgs INNER JOIN msgrcpt ON msgs.mail_id=msgrcpt.mail_id
					WHERE content='B' AND NOT (msgs.quar_type = '')
					AND msgrcpt.rs IN ('','v')
					GROUP BY CAST(time_iso AS DATE)
				UNION
				SELECT CAST(time_iso AS DATE) AS date,
					0 AS spam,
					0 AS banned,
					COUNT(content) AS viruses,
					0 AS badheaders,
					0 AS pending
					FROM msgs INNER JOIN msgrcpt ON msgs.mail_id=msgrcpt.mail_id
					WHERE content='V' AND NOT (msgs.quar_type = '')
					AND msgrcpt.rs IN ('','v')
					GROUP BY CAST(time_iso AS DATE)
				UNION
				SELECT CAST(time_iso AS DATE) AS date,
					0 AS spam,
					0 AS banned,
					0 AS viruses,
					COUNT(content) AS badheaders,
					0 AS pending
					FROM msgs INNER JOIN msgrcpt ON msgs.mail_id=msgrcpt.mail_id
					WHERE content='H' AND NOT (msgs.quar_type = '')
					AND msgrcpt.rs IN ('','v')
					GROUP BY CAST(time_iso AS DATE)
				UNION
				SELECT CAST(time_iso AS DATE) AS date,
					0 AS spam,
					0 AS banned,
					0 AS viruses,
					0 AS badheaders,
					COUNT(content) AS pending
					FROM msgs JOIN msgrcpt ON msgs.mail_id=msgrcpt.mail_id
					WHERE msgrcpt.rs='p' AND NOT (msgs.quar_type = '')
					GROUP BY CAST(time_iso AS DATE)
			) AS stattable
			GROUP BY date
			ORDER BY date";


		// Prepare query
		$q = $this->db->prepare($query);
		// Execute query
		$result = $this->db->execute($q);
		// Check if error
		$this->check_for_error($result, $query); 
			
		while ($rs = $result->fetchRow()) {
			$timestamp = CmnFns::formatDateISO($rs['date']);
			$date = CmnFns::formatDate($timestamp);
			$totalthisdate = $rs['spam'] + $rs['banned'] + $rs['viruses'] + $rs['badheaders'] + $rs['pending'];
			$return[$date] = array('spam' => $rs['spam'],
				'banned' => $rs['banned'],
				'virus' => $rs['viruses'],
				'header' => $rs['badheaders'],
				'pending' => $rs['pending'],
				'total' => $totalthisdate);
		}

		// Total the data
		foreach ($return as $date => $typearray) {
			foreach ($typearray as $type => $count) {
				$total[$type] += $count;
			}
		}

		$return['Total'] = $total;
		$result->free();

		return $return;
	}
	
	// User methods -------------------------------------------	

	/**
	* Return counts for spam, banned, viruses, bad headers, and pending
	* @param string full email address
	* @return array of the 5 counts
	*/
	function get_user_summary($emailaddresses,$domainsonly=false) {

		global $conf;

		$return = array();
		$total = array('spam' => 0, 'banned' => 0, 'virus' => 0, 'header' => 0, 'pending' => 0, 'total' => 0);

		// Get where clause for recipient email address(es)
		$recipEmailClause =  $this->convertEmailaddresses2SQL($emailaddresses,$domainsonly);

		# mysql seems to run faster with a left join
		if ($conf['db']['dbtype'] == 'mysql') {
			$join_type = ' LEFT JOIN';
		} else {
			$join_type = ' INNER JOIN';
		}

		$query = "SELECT date,
			MAX(stattable.spam) AS spam,
			MAX(stattable.banned) AS banned,
			MAX(stattable.viruses) AS viruses,
			MAX(stattable.badheaders) AS badheaders,
			MAX(stattable.pending) AS pending
			FROM (
				SELECT CAST(time_iso AS DATE) AS date,
					COUNT(content) AS spam,
					0 AS banned,
					0 AS viruses,
					0 AS badheaders,
					0 AS pending
					FROM msgs INNER JOIN msgrcpt ON msgs.mail_id=msgrcpt.mail_id
					$join_type maddr AS recip ON msgrcpt.rid=recip.id
					WHERE content='S' AND NOT (msgs.quar_type = '') AND msgrcpt.rs IN ('','v')
					AND $recipEmailClause
					GROUP BY CAST(time_iso AS DATE)
				UNION
				SELECT CAST(time_iso AS DATE) AS date,
					0 AS spam,
					COUNT(content) AS banned,
					0 AS viruses,
					0 AS badheaders,
					0 AS pending 
					FROM msgs INNER JOIN msgrcpt ON msgs.mail_id=msgrcpt.mail_id
					$join_type maddr AS recip ON msgrcpt.rid=recip.id
					WHERE content='B' AND NOT (msgs.quar_type = '') AND msgrcpt.rs IN ('','v')
					AND $recipEmailClause
					GROUP BY CAST(time_iso AS DATE)
				UNION
				SELECT CAST(time_iso AS DATE) AS date,
					0 AS spam,
					0 AS banned,
					COUNT(content) AS viruses,
					0 AS badheaders,
					0 AS pending
					FROM msgs INNER JOIN msgrcpt ON msgs.mail_id=msgrcpt.mail_id
					$join_type maddr AS recip ON msgrcpt.rid=recip.id
					WHERE content='V' AND NOT (msgs.quar_type = '') AND msgrcpt.rs IN ('','v')
					AND $recipEmailClause
					GROUP BY CAST(time_iso AS DATE)
				UNION
				SELECT CAST(time_iso AS DATE) AS date,
					0 AS spam,
					0 AS banned,
					0 AS viruses,
					COUNT(content) AS badheaders,
					0 AS pending
					FROM msgs INNER JOIN msgrcpt ON msgs.mail_id=msgrcpt.mail_id
					$join_type maddr AS recip ON msgrcpt.rid=recip.id
					WHERE content='H' AND NOT (msgs.quar_type = '') AND msgrcpt.rs IN ('','v')
					AND $recipEmailClause
					GROUP BY CAST(time_iso AS DATE)
				UNION
				SELECT CAST(time_iso AS DATE) AS date,
					0 AS spam,
					0 AS banned,
					0 AS viruses,
					0 AS badheaders,
					COUNT(content) AS pending
					FROM msgs INNER JOIN msgrcpt ON msgs.mail_id=msgrcpt.mail_id
					$join_type maddr AS recip ON msgrcpt.rid=recip.id
					WHERE msgrcpt.rs='p' AND NOT (msgs.quar_type = '')
					AND $recipEmailClause
					GROUP BY CAST(time_iso AS DATE)
			) AS stattable
			GROUP BY date
			ORDER BY date";

		// Prepare query
		$q = $this->db->prepare($query);
		// Execute query
		$result = $this->db->execute($q);
		// Check if error
		$this->check_for_error($result, $query); 

		while ($rs = $result->fetchRow()) {
			$timestamp = CmnFns::formatDateISO($rs['date']);
			$date = CmnFns::formatDate($timestamp);
			$totalthisdate = $rs['spam'] + $rs['banned'] + $rs['viruses'] + $rs['badheaders'] + $rs['pending'];
			$return[$date] = array('spam' => $rs['spam'],
				'banned' => $rs['banned'],
				'virus' => $rs['viruses'],
				'header' => $rs['badheaders'],
				'pending' => $rs['pending'],
				'total' => $totalthisdate);
		}

		// Total the data
		foreach ($return as $date => $typearray) {
			foreach ($typearray as $type => $count) {
				$total[$type] += $count;
			}
		}

		$return['Total'] = $total;
		$result->free();

		return $return;
	}


	/**
	* Return all message in quarantine associated with $emailaddress
	* @param string $content_type message type ('B', 'S', ...)
	* @param array $emailaddresses user email address(es)
	* @param string $order sql order string
	* @param string $vert sql vertical order string
	* @param array $search_array for search engine
	* @param boolean $msgs_all if true get messages for all users, if false get messages for users in $emailaddresses
	* @param integer $rs_option: 0 for new and read messages; 1 for pending messagesr; 2 for new, read and pending 
	* @param integer $page: page number, 0 by default
	* @param boolean $get_all, if true get all messages. False by default. 
	* @return array of messages in quarantine
	*/
	function get_user_messages($content_type, $emailaddresses, $order = 'msgs.time_num', $vert = 'DESC', $search_array = '', $msgs_all = false, $rs_option = 0, $page = 0, $get_all = false, $domainsonly = false) {

		global $conf;

		# MySQL seems to run faster with a LEFT JOIN
		if ($conf['db']['dbType'] == 'mysql') {
				$join_type = ' LEFT JOIN';
		} else {
				$join_type = ' INNER JOIN';
		}

		// grab the display size limit set in config.php
		$sizeLimit = isset ( $conf['app']['displaySizeLimit'] ) && is_numeric( $conf['app']['displaySizeLimit'] ) ?
												 $conf['app']['displaySizeLimit'] : 50;

		$return = array();

		if (is_array($search_array)) {
			$search_clause = "";
			foreach($search_array as $filter) {
					$search_clause .= ' AND ' . $filter;
				}
		}

		if ( ! $msgs_all) {
			// Get where clause for recipient email address(es)
			$emailaddr_clause = ( ! empty($emailaddresses) ?
						' AND ' . $this->convertEmailaddresses2SQL($emailaddresses, $domainsonly) :
						'' ); 
		}

		switch ($rs_option) {
			case 0:
				$rs_clause = ' AND msgrcpt.rs in (\'\', \'v\')';
				break;
			case 1:
				$rs_clause = ' AND msgrcpt.rs=\'p\'';
				break;
			case 2:
				$rs_clause = ' AND msgrcpt.rs in (\'\', \'v\', \'p\')';
				break;
			default:
				$rs_clause = '';
		}

		if ( Auth::isMailAdmin() || Auth::isDomainAdmin() ) {
			$type_clause = ($content_type == 'A' ? ' msgs.content in (\'S\', \'B\', \'V\', \'H\')'
								: ' msgs.content=?');
		} else {
			if ( $content_type == 'A' ) {
				$type_clause = ' msgs.content in (\'S\', \'B\'';
				$type_clause = ( $conf['app']['allowBadHeaders'] ? $type_clause . ', \'H\'' : $type_clause );
				$type_clause = ( $conf['app']['allowViruses'] ? $type_clause . ', \'V\')' : $type_clause . ')' );
			} else {
				$type_clause = ' msgs.content=?';
			}
		}

		$query = "SELECT msgs.time_num, msgs.from_addr,
			msgs.mail_id, msgs.subject, msgs.spam_level, msgs.content,
			msgrcpt.rs, msgs.quar_type, recip.email
			FROM msgs
			INNER JOIN msgrcpt ON msgs.mail_id=msgrcpt.mail_id
			$join_type maddr AS sender ON msgs.sid=sender.id
			$join_type maddr AS recip  ON msgrcpt.rid=recip.id
			WHERE $type_clause"
			// Only check against the email address when not admin
			. ($msgs_all ? ' ' : $emailaddr_clause)
			. " $rs_clause
					$search_clause
					AND msgs.quar_type <> ''
					ORDER BY $order $vert ";

		// Prepare query
		$q = $this->db->prepare($query);

		if ($content_type != 'A') {
			// Prepend the content type if we want a specific type of mail
			$values = array($content_type);
			// Execute query
			$result = $this->db->execute($q, $values);
		} else {
			$result = $this->db->execute($q);
		}

		// Check if error
                $this->check_for_error($result, $query); 
	
		$this->numRows = $result->numRows();
	
		if ($this->numRows <= 0) {
			return NULL;
		}

		if ( $get_all ) {
			while ($rs = $result->fetchRow()) {
				$return[] = $this->cleanRow($rs);
			}
		} else {
			// the row to start fetching
			$from = $page * $sizeLimit;
			// how many results per page
			$res_per_page = $sizeLimit;
			// the last row to fetch for this page
			$to = $from + $res_per_page - 1;
			foreach (range($from, $to) as $rownum) {
    				if (!$row = $result->fetchrow(DB_FETCHMODE_ASSOC, $rownum)) {
        				break;
    				}
				$return[] = $this->cleanRow($row);
			}
		}
		
		$result->free();

		return $return;
	}
	
	/**
	* Return message(s) in quarantine associated with $emailaddress and $mail_id
	* @param string $emailaddress user email address
	* @param string $mail_id message mail_id
	* @param boolean $isAdmin is true is the logged in user is MailAdmin/SuperAdmin
	* @return array of message(s)
	*/
	function get_message($emailaddress, $mail_id) {

		global $conf;

		# MySQL seems to run faster with a LEFT JOIN
		if ($conf['db']['dbType'] == 'mysql') {
		  $join_type = ' LEFT JOIN';
		} else {
		  $join_type = ' INNER JOIN';
		}

		$recipEmailClause =  $this->convertEmailaddresses2SQL($emailaddresses);

		$return = array();
		
		$query = 'SELECT msgs.time_num, msgs.secret_id, msgs.subject, msgs.from_addr, msgs.spam_level,'
			. ' msgrcpt.rs, recip.email, msgs.host, msgs.content, msgs.quar_type, msgs.quar_loc' 
			. ' FROM msgs'
			. ' INNER JOIN msgrcpt ON msgs.mail_id=msgrcpt.mail_id'
			. $join_type . ' maddr AS sender ON msgs.sid=sender.id'
			. $join_type . ' maddr AS recip  ON msgrcpt.rid=recip.id'
			. ' WHERE recip.email=? ' 
			. ' AND msgs.mail_id=? ';

		$values = array($emailaddress, $mail_id);

		// Prepare query
		$q = $this->db->prepare($query);
		// Execute query
		$result = $this->db->execute($q, $values);
		// Check if error
                $this->check_for_error($result, $query); 
		
		if ($result->numRows() <= 0) {
			return NULL;
		}
		while ($rs = $result->fetchRow()) {
			$return[] = $this->cleanRow($rs);
		}
		
		$result->free();
		
		return $return;
	}

	/**
	* Set RS flag in table 'msgrcpt'
	* @param string $mail_id message mail_id
	* @param string $mail_rcpt user email address
	* @param string $flag status ('', 'R', 'D' ...)
	* @param boolean $isAdmin is true is the logged in user is MailAdmin/SuperAdmin
	* @return array of message(s)
	*/
	function update_msgrcpt_rs($mail_id, $mail_rcpt, $flag) {

		// If its a pending message, do not set the rs flag to 'v'
		$cur_msg_array = $this->get_message($mail_rcpt, $mail_id);
		$msg_status = $cur_msg_array[0];
		if ($msg_status['rs'] == 'p' && $flag == 'v') return true;

		$query = 'UPDATE msgrcpt SET rs=?'
                       . ' WHERE mail_id=?'
		       . ' AND rid=(SELECT id FROM maddr WHERE email=?)';

		$values = array($flag, $mail_id, $mail_rcpt);

		// Prepare query
		$q = $this->db->prepare($query);
		// Execute query
		$result = $this->db->execute($q, $values);
		// Check if error
		$this->check_for_error($result, $query);

		return true;
	}


	/**
	* Function that returns number of entries for logged in user
	* where RS flag is equal to $flag
	* @param array $emailaddresses user email address(es)
	* @param string $flag 'P', 'R', ...
	* @return number of message(s)
	*/
	function get_count_rs($emailaddresses, $flag) {

		// Get where clause for recipient email address(es)
		$emailaddr_clause = $this->convertEmailaddresses2SQL($emailaddresses);
		if ( $emailaddr_clause != '' )
			$emailaddr_clause = ' AND ' . $emailaddr_clause;
		
		$query = 'SELECT mail_id FROM msgrcpt, maddr as recip'
				. ' WHERE msgrcpt.rid=recip.id'
				. $emailaddr_clause
				. ' AND rs=?';

		$values = array($flag);

		// Prepare query
		$q = $this->db->prepare($query);
		// Execute query
		$result = $this->db->execute($q, $values);
		// Check if error
                $this->check_for_error($result, $query); 
	
		$count = $result->numRows();
	
		$result->free();
		
		return $count;
	}

	/**
	* Get the raw email from the database
	* @param string The unique identifying mail_id
	* @param string The recipient's email address
	* @return string The complete email string
	*/
	function get_raw_mail($mail_id, $email_recip) {
		global $conf;

		$mail_text_column = ' mail_text';
		# If using the bytea or BLOB type for sql quarantine use proper conversion
		# (since amavisd 2.4.4
		if ($conf['db']['binquar']) {
		  if ($conf['db']['dbType'] == 'mysql') {
		    $mail_text_column = ' CONVERT(mail_text USING utf8) AS mail_text';
		  } else {
		    $mail_text_column = " encode(mail_text,'escape') AS mail_text";
		  }
                }


		if (Auth::isMailAdmin()) {
		  $values = array($mail_id);
		  $query = 'SELECT' . $mail_text_column . ' FROM quarantine ' .
			   'WHERE mail_id=?';
		} else {
                  $values = array($mail_id, $email_recip);
		  $query = 'SELECT' . $mail_text_column . ' FROM quarantine Q, msgrcpt M, maddr recip ' .
		           'WHERE (Q.mail_id=?) AND (M.mail_id=Q.mail_id) AND (M.rid=recip.id) ' .
			   'AND (recip.email=?) ' .
			   'ORDER BY chunk_ind';
	        }

                // Prepare query
                $q = $this->db->prepare($query);
                // Execute query
                $result = $this->db->execute($q, $values);
                // Check if error
                $this->check_for_error($result, $query); 
                
                if ($result->numRows() <= 0){ 
                        return false;
                }
                while ($rs = $result->fetchRow()) {
                        $return .= $rs['mail_text'];
                }
                
                $result->free();
                
                return $return;
        }
		
	/**
	* Checks to see if there was a database error, log in file and die if there was
	* @param object $result result object of query
	* @param SQL query $query
	*/
	function check_for_error($result, $query) {
		global $conf;
		if (DB::isError($result)) {
			$this->err_msg = $result->getMessage();
			CmnFns::write_log($this->err_msg, $_SESSION['sessionID']);
			CmnFns::write_log('There was an error executing your query' . ' '
                                . $query, $_SESSION['sessionID']);
			CmnFns::do_error_box(translate('There was an error executing your query') . '<br />'
				. $this->err_msg
				. '<br />' . '<a href="javascript: history.back();">' . translate('Back') . '</a>');
		} else {
			if ($conf['app']['debug']) {
				CmnFns::write_log("[DEBUG SQL QUERY]: $query");
			}

		}
		return false;
	}
	
	/**
	* Strips out slashes for all data in the return row
	* - THIS MUST ONLY BE ONE ROW OF DATA -
	* @param array $data array of data to clean up
	* @return array with same key => value pairs (except slashes)
	*/
	function cleanRow($data) {
		$return = array();
			
		foreach ($data as $key => $val)
			$return[$key] = stripslashes($val);
		return $return;
	}
	
	/**
	* Returns the last database error message
	* @param none
	* @return last error message generated
	*/
	function get_err() {
		return $this->err_msg;
	}

	/**
	* Convert search filter into SQL code
	* @param string $field field of table to filter on
	* @param string $criterion search criterion
	* @param string $string search string
	* @return array containing SQL code
	*/
	function convertSearch2SQL($field, $criterion, $string) {
	
		$result = array();
	
		if ( $string != '' ) {

			switch ($criterion) {
                		case "contains":
                        		$search_clause = "(" . $field . " LIKE '%" . $string . "%')" ;
                        		break;
                		case "not_contain":
                        		$search_clause = "(" . $field . " NOT LIKE '%" . $string . "%')" ;
                        		break;
                		case "equals":
                        		$search_clause = "(" . $field . "='" . $string . "')" ;
                        		break;
                		case "not_equal":
                        		$search_clause = "NOT (" . $field . "='" . $string . "')" ;
                        		break;
                		default:
					$search_clause = "";
			}
			array_push($result, $search_clause);
		}

		return $result;
	}

	/**
	* Convert array of mail address(es) into SQL search clause
	* @param array $emailaddresses list of email address(es)
	* @return string containing SQL code
	*/
	function convertEmailaddresses2SQL($emailaddresses, $domainsonly=false) {

		global $conf;
		$result = '';
		$emailtuple = '';

		if ( is_array($emailaddresses) && !empty($emailaddresses) ) {
			foreach ( $emailaddresses as $value ) {
				// Append an address to lookup
				if ($domainsonly) {
					list($localpart, $domain) = explode("@", $value);
					$value = "%@".$domain;
				}
				$emailtuple .= ( $emailtuple != '' ? " OR recip.email LIKE '$value'" : "'$value'" );
			}
			$result = " recip.email LIKE $emailtuple ";
			if (!$domainsonly) {
				// Configured to support recipient delimiters?
				if(!empty($conf['recipient_delimiter']) ) {
					$delimiter = $conf['recipient_delimiter']; 
					foreach ( $emailaddresses as $value ) {
						// separate localpart and domain
						list($localpart, $domain) = explode("@", $value);
						// Append any recipient delimited addresses
						$result .= "OR recip.email LIKE '$localpart$delimiter%@$domain' ";
					}
				}
			}
		}
		// Return results within parentheses to isolate OR statements
		return "($result)";
	}


	/**
	* Fetch amavis userid according to email address,
	* if not found, then it returns domain-id or
	* creates user record and retrieves new id
	* @param string $recip_email
	* @return string containing user / domain id
	*/
	function mail2userid($recip_email, $domain_only = false) {
		global $conf;
		/*
		1) Return user-id from amavis.users that corresponds to $recip_email
		  # select id from users where email = $recip_email limit 1;
		*/
		$query = 'select id from users where email = ? limit 1;';

		if ($domain_only) {
			$recip_email = substr($recip_email,strpos($recip_email,"@"));
		}
		
		// Query
		$q = $this->db->prepare($query);
		$result = $this->db->execute($q, array($recip_email));
		$this->check_for_error($result, $query); 
	
		if ($result->numRows() == 1) {
			$return = $result->fetchRow();
			return $return['id'];
		} else if ($result->numRows() == 0
				  && strpos($recip_email,"@")) {
			
			// this result set is no longer needed
			$result->free();
			
			$create_or_use_domain = false;
			
			if (!$conf['app']['autocreate_wbl_users']) {
				/* If user-id was not found, then we fetch/return the domain id */
				return $this->mail2userid(substr($recip_email,strpos($recip_email,"@")));
				
			} else {
				/*
				  this should handle creation of user records, but im not sure what to
				  do about email aliases...
				  
				  1. Fetch domain policy_id, priority, local */
				  $query = 'select priority, policy_id, ("'.$recip_email.'") AS email, local from users where email = ? limit 1;';
				  $q = $this->db->prepare($query);
				  $result = $this->db->execute($q, array(substr($recip_email,strpos($recip_email,"@"))));
				  $this->check_for_error($result, $query);
				  $policy = $result->fetchRow();
				/*
				  2. Insert new user
				*/
				  $query = 'insert into users (priority, policy_id, email, fullname, local) values (?, ?, ?, "mailzu autocreated user", ?);';
				  $q = $this->db->prepare($query);
				  $result = $this->db->execute($q, $policy);
				  $this->check_for_error($result, $query);
				  return $this->mail2userid($recip_email);
			}
			
		} else if (strpos($recip_email,"@") == 0) {
			return 0;
		}
		
	}



	//function wblist($flag, $r, $mail_id) {
	function mailid2sid($mail_id, $domain_only = false) {
		/**
		return sender id from mailaddr for whitelisting purposes	
		*/
		
		$query = 
		'SELECT mailaddr.id AS sid, '
			.($domain_only ? 'SUBSTRING(maddr.email, INSTR(maddr.email, "@")) AS email' : 'maddr.email AS email')
		.' FROM msgs'
		.' LEFT JOIN maddr ON msgs.sid=maddr.id'
		.' LEFT JOIN mailaddr ON '.($domain_only ? 'SUBSTRING(maddr.email, INSTR(maddr.email, "@"))' : 'maddr.email').'=mailaddr.email'
		.' WHERE mail_id = ?'
		. 'LIMIT 1;';
		
		$q = $this->db->prepare($query);
		$result = $this->db->execute($q, array($mail_id));
		$this->check_for_error($result, $query); 
		$row = $result->fetchRow();
		
		if ($row['sid'] > 0) {
			return $row['sid'];
		} else {
			$query = 'INSERT INTO mailaddr (priority, email) VALUES (5, ?);';
			$q = $this->db->prepare($query);
			$result = $this->db->execute($q, array($row['email']));
			$this->check_for_error($result, $query);
			$query = 'SELECT id FROM mailaddr WHERE email LIKE ?;';
			$q = $this->db->prepare($query);
			$result = $this->db->execute($q, array($row['email']));
			$this->check_for_error($result, $query);
			$row = $result->fetchRow();
			return $row['id'];
		}

	}
	
	function wbinsert($wb, $rid, $sid) {
		/**
		   check for existence of the wb-listing rule.
		   insert/update wblist entry with approriate flag and id:s.
		*/

		$query = 'select wb from wblist where rid = ? and sid = ? limit 1;';
		$q = $this->db->prepare($query);
		$result = $this->db->execute($q, array($rid,$sid));
		$this->check_for_error($result, $query); 
		
		if (is_array($result->fetchRow())) {
			$query = 'update wblist set wb = ? where rid = ? and sid = ? limit 1;';
		} else {
			$query = 'insert into wblist (wb, rid, sid) values (?, ?, ?);';
		}
		$q = $this->db->prepare($query);
		$result = $this->db->execute($q, array($wb,$rid,$sid));
		$this->check_for_error($result, $query); 
		
	}

	function wbdelete($wb, $rid, $sid) {
		$query = "DELETE FROM wblist WHERE wb=? AND rid=? AND sid=? LIMIT 1;";
		// Prepare query
                $q = $this->db->prepare($query);
                // Execute query
                $result = $this->db->execute($q, array($wb,$rid,$sid));
                // Check if error
                $this->check_for_error($result, $query); 
       }
       
       
	/**
	* Return all wblist entries associated with $emailaddresses
	* used to delete wblist entries
	*/

	function get_user_control_list( $emailaddresses, $order = 'sender', $vert = 'ASC', $search_array, $page, $all = false) {
		global $conf;
		$return = Array();
		
		// grab the display size limit set in config.php
		$sizeLimit = (isset ( $conf['app']['displaySizeLimit'] ) && is_numeric( $conf['app']['displaySizeLimit'] ) ?
												 $conf['app']['displaySizeLimit'] : 50);
							
		if (is_array($search_array)) {
			$search_clause = "";
			foreach($search_array as $filter) {
					$search_clause .= ' AND ' . $filter;
				}
		}
					 
		if ( !$all ) {
			// Get where clause for recipient email address(es)
			$recipEmailClause =  $this->convertEmailaddresses2SQL($emailaddresses);
		} else {
			$recipEmailClause = 1; // palikka hakee kaikki, milloin tukee domaineja, no domain patsissa tietty!
		}
		$query = "
			SELECT mailaddr.email AS sender,
				recip.email AS recipient,
				wblist.wb AS rule,
				mailaddr.id AS sender_id,
				recip.id AS recip_id
			FROM wblist
				LEFT JOIN mailaddr ON wblist.sid=mailaddr.id
				LEFT JOIN users AS recip ON wblist.rid=recip.id
			WHERE $recipEmailClause $search_clause
			ORDER BY $order $vert;
		";
		
		//. ($msgs_all ? ' ' : $emailaddr_clause)
		
		// Prepare query
		$q = $this->db->prepare($query);
		// Execute query
		$result = $this->db->execute($q);
		// Check if error
		$this->check_for_error($result, $query); 
			
		$this->numRows = $result->numRows();
		
		// the row to start fetching
		$from = $page * $sizeLimit;
		// how many results per page
		$res_per_page = $sizeLimit;
		// the last row to fetch for this page
		$to = $from + $res_per_page - 1;
		foreach (range($from, $to) as $rownum) {
			if (!$row = $result->fetchrow(DB_FETCHMODE_ASSOC, $rownum)) {
				break;
			}
			$return[] = $this->cleanRow($row);
		}

		
		$result->free();

		return $return;
       }

}

?>