Code Forge

<?php

/**

*

* @package phpBB3

* @version $Id$

* @copyright (c) 2005 phpBB Group

* @license http://opensource.org/licenses/gpl-license.php GNU Public License

*

*/

/**

* @ignore

*/

if (!defined('IN_PHPBB'))

{

        exit;

}

/**

* Messenger

* @package phpBB3

*/

class messenger

{

        var $vars, $msg, $extra_headers, $replyto, $from, $subject;

        var $addresses = array();

        var $mail_priority = MAIL_NORMAL_PRIORITY;

        var $use_queue = true;

        var $tpl_obj = NULL;

        var $tpl_msg = array();

        var $eol = "\n";

        /**

        * Constructor

        */

        function messenger($use_queue = true)

        {

                global $config;

                $this->use_queue = (!$config['email_package_size']) ? false : $use_queue;

                $this->subject = '';

                // Determine EOL character (\n for UNIX, \r\n for Windows and \r for Mac)

                $this->eol = (!defined('PHP_EOL')) ? (($eol = strtolower(substr(PHP_OS, 0, 3))) == 'win') ? "\r\n" : (($eol == 'mac') ? "\r" : "\n") : PHP_EOL;

                $this->eol = (!$this->eol) ? "\n" : $this->eol;

        }

        /**

        * Resets all the data (address, template file, etc etc) to default

        */

        function reset()

        {

                $this->addresses = $this->extra_headers = array();

                $this->vars = $this->msg = $this->replyto = $this->from = '';

                $this->mail_priority = MAIL_NORMAL_PRIORITY;

        }

        /**

        * Sets an email address to send to

        */

        function to($address, $realname = '')

        {

                global $config;

                if (!trim($address))

                {

                        return;

                }

                $pos = isset($this->addresses['to']) ? sizeof($this->addresses['to']) : 0;

                $this->addresses['to'][$pos]['email'] = trim($address);

                // If empty sendmail_path on windows, PHP changes the to line

                if (!$config['smtp_delivery'] && DIRECTORY_SEPARATOR == '\\')

                {

                        $this->addresses['to'][$pos]['name'] = '';

                }

                else

                {

                        $this->addresses['to'][$pos]['name'] = trim($realname);

                }

        }

        /**

        * Sets an cc address to send to

        */

        function cc($address, $realname = '')

        {

                if (!trim($address))

                {

                        return;

                }

                $pos = isset($this->addresses['cc']) ? sizeof($this->addresses['cc']) : 0;

                $this->addresses['cc'][$pos]['email'] = trim($address);

                $this->addresses['cc'][$pos]['name'] = trim($realname);

        }

        /**

        * Sets an bcc address to send to

        */

        function bcc($address, $realname = '')

        {

                if (!trim($address))

                {

                        return;

                }

                $pos = isset($this->addresses['bcc']) ? sizeof($this->addresses['bcc']) : 0;

                $this->addresses['bcc'][$pos]['email'] = trim($address);

                $this->addresses['bcc'][$pos]['name'] = trim($realname);

        }

        /**

        * Sets a im contact to send to

        */

        function im($address, $realname = '')

        {

                // IM-Addresses could be empty

                if (!trim($address))

                {

                        return;

                }

                $pos = isset($this->addresses['im']) ? sizeof($this->addresses['im']) : 0;

                $this->addresses['im'][$pos]['uid'] = trim($address);

                $this->addresses['im'][$pos]['name'] = trim($realname);

        }

        /**

        * Set the reply to address

        */

        function replyto($address)

        {

                $this->replyto = trim($address);

        }

        /**

        * Set the from address

        */

        function from($address)

        {

                $this->from = trim($address);

        }

        /**

        * set up subject for mail

        */

        function subject($subject = '')

        {

                $this->subject = trim($subject);

        }

        /**

        * set up extra mail headers

        */

        function headers($headers)

        {

                $this->extra_headers[] = trim($headers);

        }

        /**

        * Adds X-AntiAbuse headers

        *

        * @param array $config                Configuration array

        * @param user $user                        A user object

        *

        * @return null

        */

        function anti_abuse_headers($config, $user)

        {

                $this->headers('X-AntiAbuse: Board servername - ' . mail_encode($config['server_name']));

                $this->headers('X-AntiAbuse: User_id - ' . $user->data['user_id']);

                $this->headers('X-AntiAbuse: Username - ' . mail_encode($user->data['username']));

                $this->headers('X-AntiAbuse: User IP - ' . $user->ip);

        }

        /**

        * Set the email priority

        */

        function set_mail_priority($priority = MAIL_NORMAL_PRIORITY)

        {

                $this->mail_priority = $priority;

        }

        /**

        * Set email template to use

        */

        function template($template_file, $template_lang = '', $template_path = '')

        {

                global $config, $phpbb_root_path, $user;

                if (!trim($template_file))

                {

                        trigger_error('No template file for emailing set.', E_USER_ERROR);

                }

                if (!trim($template_lang))

                {

                        // fall back to board default language if the user's language is

                        // missing $template_file.  If this does not exist either,

                        // $tpl->set_custom_template will do a trigger_error

                        $template_lang = basename($config['default_lang']);

                }

                // tpl_msg now holds a template object we can use to parse the template file

                if (!isset($this->tpl_msg[$template_lang . $template_file]))

                {

                        $this->tpl_msg[$template_lang . $template_file] = new template();

                        $tpl = &$this->tpl_msg[$template_lang . $template_file];

                        $fallback_template_path = false;

                        if (!$template_path)

                        {

                                $template_path = (!empty($user->lang_path)) ? $user->lang_path : $phpbb_root_path . 'language/';

                                $template_path .= $template_lang . '/email';

                                // we can only specify default language fallback when the path is not a custom one for which we

                                // do not know the default language alternative

                                if ($template_lang !== basename($config['default_lang']))

                                {

                                        $fallback_template_path = (!empty($user->lang_path)) ? $user->lang_path : $phpbb_root_path . 'language/';

                                        $fallback_template_path .= basename($config['default_lang']) . '/email';

                                }

                        }

                        $tpl->set_custom_template($template_path, $template_lang . '_email', $fallback_template_path);

                        $tpl->set_filenames(array(

                                'body'                => $template_file . '.txt',

                        ));

                }

                $this->tpl_obj = &$this->tpl_msg[$template_lang . $template_file];

                $this->vars = &$this->tpl_obj->_rootref;

                $this->tpl_msg = '';

                return true;

        }

        /**

        * assign variables to email template

        */

        function assign_vars($vars)

        {

                if (!is_object($this->tpl_obj))

                {

                        return;

                }

                $this->tpl_obj->assign_vars($vars);

        }

        function assign_block_vars($blockname, $vars)

        {

                if (!is_object($this->tpl_obj))

                {

                        return;

                }

                $this->tpl_obj->assign_block_vars($blockname, $vars);

        }

        /**

        * Send the mail out to the recipients set previously in var $this->addresses

        */

        function send($method = NOTIFY_EMAIL, $break = false)

        {

                global $config, $user;

                // We add some standard variables we always use, no need to specify them always

                if (!isset($this->vars['U_BOARD']))

                {

                        $this->assign_vars(array(

                                'U_BOARD'        => generate_board_url(),

                        ));

                }

                if (!isset($this->vars['EMAIL_SIG']))

                {

                        $this->assign_vars(array(

                                'EMAIL_SIG'        => str_replace('<br />', "\n", "-- \n" . htmlspecialchars_decode($config['board_email_sig'])),

                        ));

                }

                if (!isset($this->vars['SITENAME']))

                {

                        $this->assign_vars(array(

                                'SITENAME'        => htmlspecialchars_decode($config['sitename']),

                        ));

                }

                // Parse message through template

                $this->msg = trim($this->tpl_obj->assign_display('body'));

                // Because we use \n for newlines in the body message we need to fix line encoding errors for those admins who uploaded email template files in the wrong encoding

                $this->msg = str_replace("\r\n", "\n", $this->msg);

                // We now try and pull a subject from the email body ... if it exists,

                // do this here because the subject may contain a variable

                $drop_header = '';

                $match = array();

                if (preg_match('#^(Subject:(.*?))$#m', $this->msg, $match))

                {

                        $this->subject = (trim($match[2]) != '') ? trim($match[2]) : (($this->subject != '') ? $this->subject : $user->lang['NO_EMAIL_SUBJECT']);

                        $drop_header .= '[\r\n]*?' . preg_quote($match[1], '#');

                }

                else

                {

                        $this->subject = (($this->subject != '') ? $this->subject : $user->lang['NO_EMAIL_SUBJECT']);

                }

                if ($drop_header)

                {

                        $this->msg = trim(preg_replace('#' . $drop_header . '#s', '', $this->msg));

                }

                if ($break)

                {

                        return true;

                }

                switch ($method)

                {

                        case NOTIFY_EMAIL:

                                $result = $this->msg_email();

                        break;

                        case NOTIFY_IM:

                                $result = $this->msg_jabber();

                        break;

                        case NOTIFY_BOTH:

                                $result = $this->msg_email();

                                $this->msg_jabber();

                        break;

                }

                $this->reset();

                return $result;

        }

        /**

        * Add error message to log

        */

        function error($type, $msg)

        {

                global $user, $phpEx, $phpbb_root_path, $config;

                // Session doesn't exist, create it

                if (!isset($user->session_id) || $user->session_id === '')

                {

                        $user->session_begin();

                }

                $calling_page = (!empty($_SERVER['PHP_SELF'])) ? $_SERVER['PHP_SELF'] : $_ENV['PHP_SELF'];

                $message = '';

                switch ($type)

                {

                        case 'EMAIL':

                                $message = '<strong>EMAIL/' . (($config['smtp_delivery']) ? 'SMTP' : 'PHP/' . $config['email_function_name'] . '()') . '</strong>';

                        break;

                        default:

                                $message = "<strong>$type</strong>";

                        break;

                }

                $message .= '<br /><em>' . htmlspecialchars($calling_page) . '</em><br /><br />' . $msg . '<br />';

                add_log('critical', 'LOG_ERROR_' . $type, $message);

        }

        /**

        * Save to queue

        */

        function save_queue()

        {

                global $config;

                if ($config['email_package_size'] && $this->use_queue && !empty($this->queue))

                {

                        $this->queue->save();

                        return;

                }

        }

        /**

        * Return email header

        */

        function build_header($to, $cc, $bcc)

        {

                global $config;

                // We could use keys here, but we won't do this for 3.0.x to retain backwards compatibility

                $headers = array();

                $headers[] = 'From: ' . $this->from;

                if ($cc)

                {

                        $headers[] = 'Cc: ' . $cc;

                }

                if ($bcc)

                {

                        $headers[] = 'Bcc: ' . $bcc;

                }

                $headers[] = 'Reply-To: ' . $this->replyto;

                $headers[] = 'Return-Path: <' . $config['board_email'] . '>';

                $headers[] = 'Sender: <' . $config['board_email'] . '>';

                $headers[] = 'MIME-Version: 1.0';

                $headers[] = 'Message-ID: <' . md5(unique_id(time())) . '@' . $config['server_name'] . '>';

                $headers[] = 'Date: ' . date('r', time());

                $headers[] = 'Content-Type: text/plain; charset=UTF-8'; // format=flowed

                $headers[] = 'Content-Transfer-Encoding: 8bit'; // 7bit

                $headers[] = 'X-Priority: ' . $this->mail_priority;

                $headers[] = 'X-MSMail-Priority: ' . (($this->mail_priority == MAIL_LOW_PRIORITY) ? 'Low' : (($this->mail_priority == MAIL_NORMAL_PRIORITY) ? 'Normal' : 'High'));

                $headers[] = 'X-Mailer: phpBB3';

                $headers[] = 'X-MimeOLE: phpBB3';

                $headers[] = 'X-phpBB-Origin: phpbb://' . str_replace(array('http://', 'https://'), array('', ''), generate_board_url());

                if (sizeof($this->extra_headers))

                {

                        $headers = array_merge($headers, $this->extra_headers);

                }

                return $headers;

        }

        /**

        * Send out emails

        */

        function msg_email()

        {

                global $config, $user;

                if (empty($config['email_enable']))

                {

                        return false;

                }

                // Addresses to send to?

                if (empty($this->addresses) || (empty($this->addresses['to']) && empty($this->addresses['cc']) && empty($this->addresses['bcc'])))

                {

                        // Send was successful. ;)

                        return true;

                }

                $use_queue = false;

                if ($config['email_package_size'] && $this->use_queue)

                {

                        if (empty($this->queue))

                        {

                                $this->queue = new queue();

                                $this->queue->init('email', $config['email_package_size']);

                        }

                        $use_queue = true;

                }

                if (empty($this->replyto))

                {

                        $this->replyto = '<' . $config['board_contact'] . '>';

                }

                if (empty($this->from))

                {

                        $this->from = '<' . $config['board_contact'] . '>';

                }

                $encode_eol = ($config['smtp_delivery']) ? "\r\n" : $this->eol;

                // Build to, cc and bcc strings

                $to = $cc = $bcc = '';

                foreach ($this->addresses as $type => $address_ary)

                {

                        if ($type == 'im')

                        {

                                continue;

                        }

                        foreach ($address_ary as $which_ary)

                        {

                                $$type .= (($$type != '') ? ', ' : '') . (($which_ary['name'] != '') ? mail_encode($which_ary['name'], $encode_eol) . ' <' . $which_ary['email'] . '>' : $which_ary['email']);

                        }

                }

                // Build header

                $headers = $this->build_header($to, $cc, $bcc);

                // Send message ...

                if (!$use_queue)

                {

                        $mail_to = ($to == '') ? 'undisclosed-recipients:;' : $to;

                        $err_msg = '';

                        if ($config['smtp_delivery'])

                        {

                                $result = smtpmail($this->addresses, mail_encode($this->subject), wordwrap(utf8_wordwrap($this->msg), 997, "\n", true), $err_msg, $headers);

                        }

                        else

                        {

                                $result = phpbb_mail($mail_to, $this->subject, $this->msg, $headers, $this->eol, $err_msg);

                        }

                        if (!$result)

                        {

                                $this->error('EMAIL', $err_msg);

                                return false;

                        }

                }

                else

                {

                        $this->queue->put('email', array(

                                'to'                        => $to,

                                'addresses'                => $this->addresses,

                                'subject'                => $this->subject,

                                'msg'                        => $this->msg,

                                'headers'                => $headers)

                        );

                }

                return true;

        }

        /**

        * Send jabber message out

        */

        function msg_jabber()

        {

                global $config, $db, $user, $phpbb_root_path, $phpEx;

                if (empty($config['jab_enable']) || empty($config['jab_host']) || empty($config['jab_username']) || empty($config['jab_password']))

                {

                        return false;

                }

                if (empty($this->addresses['im']))

                {

                        // Send was successful. ;)

                        return true;

                }

                $use_queue = false;

                if ($config['jab_package_size'] && $this->use_queue)

                {

                        if (empty($this->queue))

                        {

                                $this->queue = new queue();

                                $this->queue->init('jabber', $config['jab_package_size']);

                        }

                        $use_queue = true;

                }

                $addresses = array();

                foreach ($this->addresses['im'] as $type => $uid_ary)

                {

                        $addresses[] = $uid_ary['uid'];

                }

                $addresses = array_unique($addresses);

                if (!$use_queue)

                {

                        include_once($phpbb_root_path . 'includes/functions_jabber.' . $phpEx);

                        $this->jabber = new jabber($config['jab_host'], $config['jab_port'], $config['jab_username'], htmlspecialchars_decode($config['jab_password']), $config['jab_use_ssl']);

                        if (!$this->jabber->connect())

                        {

                                $this->error('JABBER', $user->lang['ERR_JAB_CONNECT'] . '<br />' . $this->jabber->get_log());

                                return false;

                        }

                        if (!$this->jabber->login())

                        {

                                $this->error('JABBER', $user->lang['ERR_JAB_AUTH'] . '<br />' . $this->jabber->get_log());

                                return false;

                        }

                        foreach ($addresses as $address)

                        {

                                $this->jabber->send_message($address, $this->msg, $this->subject);

                        }

                        $this->jabber->disconnect();

                }

                else

                {

                        $this->queue->put('jabber', array(

                                'addresses'                => $addresses,

                                'subject'                => $this->subject,

                                'msg'                        => $this->msg)

                        );

                }

                unset($addresses);

                return true;

        }

}

/**

* handling email and jabber queue

* @package phpBB3

*/

class queue

{

        var $data = array();

        var $queue_data = array();

        var $package_size = 0;

        var $cache_file = '';

        var $eol = "\n";

        /**

        * constructor

        */

        function queue()

        {

                global $phpEx, $phpbb_root_path;

                $this->data = array();

                $this->cache_file = "{$phpbb_root_path}cache/queue.$phpEx";

                // Determine EOL character (\n for UNIX, \r\n for Windows and \r for Mac)

                $this->eol = (!defined('PHP_EOL')) ? (($eol = strtolower(substr(PHP_OS, 0, 3))) == 'win') ? "\r\n" : (($eol == 'mac') ? "\r" : "\n") : PHP_EOL;

                $this->eol = (!$this->eol) ? "\n" : $this->eol;

        }

        /**

        * Init a queue object

        */

        function init($object, $package_size)

        {

                $this->data[$object] = array();

                $this->data[$object]['package_size'] = $package_size;

                $this->data[$object]['data'] = array();

        }

        /**

        * Put object in queue

        */

        function put($object, $scope)

        {

                $this->data[$object]['data'][] = $scope;

        }

        /**

        * Obtains exclusive lock on queue cache file.

        * Returns resource representing the lock

        */

        function lock()

        {

                // For systems that can't have two processes opening

                // one file for writing simultaneously

                if (file_exists($this->cache_file . '.lock'))

                {

                        $mode = 'rb';

                }

                else

                {

                        $mode = 'wb';

                }

                $lock_fp = @fopen($this->cache_file . '.lock', $mode);

                if ($mode == 'wb')

                {

                        if (!$lock_fp)

                        {

                                // Two processes may attempt to create lock file at the same time.

                                // Have the losing process try opening the lock file again for reading

                                // on the assumption that the winning process created it

                                $mode = 'rb';

                                $lock_fp = @fopen($this->cache_file . '.lock', $mode);

                        }

                        else

                        {

                                // Only need to set mode when the lock file is written

                                @chmod($this->cache_file . '.lock', 0666);

                        }

                }

                if ($lock_fp)

                {

                        @flock($lock_fp, LOCK_EX);

                }

                return $lock_fp;

        }

        /**

        * Releases lock on queue cache file, using resource obtained from lock()

        */

        function unlock($lock_fp)

        {

                // lock() will return null if opening lock file, and thus locking, failed.

                // Accept null values here so that client code does not need to check them

                if ($lock_fp)

                {

                        @flock($lock_fp, LOCK_UN);

                        fclose($lock_fp);

                }

        }

        /**

        * Process queue

        * Using lock file

        */

        function process()

        {

                global $db, $config, $phpEx, $phpbb_root_path, $user;

                $lock_fp = $this->lock();

                set_config('last_queue_run', time(), true);

                if (!file_exists($this->cache_file) || filemtime($this->cache_file) > time() - $config['queue_interval'])

                {

                        $this->unlock($lock_fp);

                        return;

                }

                include($this->cache_file);

                foreach ($this->queue_data as $object => $data_ary)

                {

                        @set_time_limit(0);

                        if (!isset($data_ary['package_size']))

                        {

                                $data_ary['package_size'] = 0;

                        }

                        $package_size = $data_ary['package_size'];

                        $num_items = (!$package_size || sizeof($data_ary['data']) < $package_size) ? sizeof($data_ary['data']) : $package_size;

                        /*

                        * This code is commented out because it causes problems on some web hosts.

                        * The core problem is rather restrictive email sending limits.

                        * This code is nly useful if you have no such restrictions from the

                        * web host and the package size setting is wrong.

                        // If the amount of emails to be sent is way more than package_size than we need to increase it to prevent backlogs...

                        if (sizeof($data_ary['data']) > $package_size * 2.5)

                        {

                                $num_items = sizeof($data_ary['data']);

                        }

                        */

                        switch ($object)

                        {

                                case 'email':

                                        // Delete the email queued objects if mailing is disabled

                                        if (!$config['email_enable'])