diff options
Diffstat (limited to 'phpBB/includes/notification/method')
| -rw-r--r-- | phpBB/includes/notification/method/base.php | 116 | ||||
| -rw-r--r-- | phpBB/includes/notification/method/email.php | 129 | ||||
| -rw-r--r-- | phpBB/includes/notification/method/interface.php | 48 | ||||
| -rw-r--r-- | phpBB/includes/notification/method/jabber.php | 77 | 
4 files changed, 370 insertions, 0 deletions
diff --git a/phpBB/includes/notification/method/base.php b/phpBB/includes/notification/method/base.php new file mode 100644 index 0000000000..22418c9be8 --- /dev/null +++ b/phpBB/includes/notification/method/base.php @@ -0,0 +1,116 @@ +<?php +/** +* +* @package notifications +* @copyright (c) 2012 phpBB Group +* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2 +* +*/ + +/** +* @ignore +*/ +if (!defined('IN_PHPBB')) +{ +	exit; +} + +/** +* Base notifications method class +* @package notifications +*/ +abstract class phpbb_notification_method_base implements phpbb_notification_method_interface +{ +	/** @var phpbb_notification_manager */ +	protected $notification_manager; + +	/** @var phpbb_user_loader */ +	protected $user_loader; + +	/** @var phpbb_db_driver */ +	protected $db; + +	/** @var phpbb_cache_service */ +	protected $cache; + +	/** @var phpbb_template */ +	protected $template; + +	/** @var phpbb_extension_manager */ +	protected $extension_manager; + +	/** @var phpbb_user */ +	protected $user; + +	/** @var phpbb_auth */ +	protected $auth; + +	/** @var phpbb_config */ +	protected $config; + +	/** @var string */ +	protected $phpbb_root_path; + +	/** @var string */ +	protected $php_ext; + +	/** +	* Queue of messages to be sent +	* +	* @var array +	*/ +	protected $queue = array(); + +	/** +	* Notification Method Base Constructor +	*  +	* @param phpbb_user_loader $user_loader +	* @param phpbb_db_driver $db +	* @param phpbb_cache_driver_interface $cache +	* @param phpbb_user $user +	* @param phpbb_auth $auth +	* @param phpbb_config $config +	* @param string $phpbb_root_path +	* @param string $php_ext +	* @return phpbb_notification_method_base +	*/ +	public function __construct(phpbb_user_loader $user_loader, phpbb_db_driver $db, phpbb_cache_driver_interface $cache, $user, phpbb_auth $auth, phpbb_config $config, $phpbb_root_path, $php_ext) +	{ +		$this->user_loader = $user_loader; +		$this->db = $db; +		$this->cache = $cache; +		$this->user = $user; +		$this->auth = $auth; +		$this->config = $config; +		$this->phpbb_root_path = $phpbb_root_path; +		$this->php_ext = $php_ext; +	} + +	/** +	* Set notification manager (required) +	*  +	* @param phpbb_notification_manager $notification_manager +	*/ +	public function set_notification_manager(phpbb_notification_manager $notification_manager) +	{ +		$this->notification_manager = $notification_manager; +	} + +	/** +	* Add a notification to the queue +	* +	* @param phpbb_notification_type_interface $notification +	*/ +	public function add_to_queue(phpbb_notification_type_interface $notification) +	{ +		$this->queue[] = $notification; +	} + +	/** +	* Empty the queue +	*/ +	protected function empty_queue() +	{ +		$this->queue = array(); +	} +} diff --git a/phpBB/includes/notification/method/email.php b/phpBB/includes/notification/method/email.php new file mode 100644 index 0000000000..429dfda2ba --- /dev/null +++ b/phpBB/includes/notification/method/email.php @@ -0,0 +1,129 @@ +<?php +/** +* +* @package notifications +* @copyright (c) 2012 phpBB Group +* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2 +* +*/ + +/** +* @ignore +*/ +if (!defined('IN_PHPBB')) +{ +	exit; +} + +/** +* Email notification method class +* This class handles sending emails for notifications +* +* @package notifications +*/ +class phpbb_notification_method_email extends phpbb_notification_method_base +{ +	/** +	* Get notification method name +	* +	* @return string +	*/ +	public function get_type() +	{ +		return 'email'; +	} + +	/** +	* Notify method (since jabber gets sent through the same messenger, we let the jabber class inherit from this to reduce code duplication) +	* +	* @var mixed +	*/ +	protected $notify_method = NOTIFY_EMAIL; + +	/** +	* Base directory to prepend to the email template name +	* +	* @var string +	*/ +	protected $email_template_base_dir = ''; + +	/** +	* Is this method available for the user? +	* This is checked on the notifications options +	*/ +	public function is_available() +	{ +		// Email is always available +		return true; +	} + +	/** +	* Parse the queue and notify the users +	*/ +	public function notify() +	{ +		if (!sizeof($this->queue)) +		{ +			return; +		} + +		// Load all users we want to notify (we need their email address) +		$user_ids = $users = array(); +		foreach ($this->queue as $notification) +		{ +			$user_ids[] = $notification->user_id; +		} + +		// We do not send emails to banned users +		if (!function_exists('phpbb_get_banned_user_ids')) +		{ +			include($this->phpbb_root_path . 'includes/functions_user.' . $this->php_ext); +		} +		$banned_users = phpbb_get_banned_user_ids($user_ids); + +		// Load all the users we need +		$this->user_loader->load_users($user_ids); + +		// Load the messenger +		if (!class_exists('messenger')) +		{ +			include($this->phpbb_root_path . 'includes/functions_messenger.' . $this->php_ext); +		} +		$messenger = new messenger(); +		$board_url = generate_board_url(); + +		// Time to go through the queue and send emails +		foreach ($this->queue as $notification) +		{ +			if ($notification->get_email_template() === false) +			{ +				continue; +			} + +			$user = $this->user_loader->get_user($notification->user_id); + +			if ($user['user_type'] == USER_IGNORE || in_array($notification->user_id, $banned_users)) +			{ +				continue; +			} + +			$messenger->template($this->email_template_base_dir . $notification->get_email_template(), $user['user_lang']); + +			$messenger->to($user['user_email'], $user['username']); + +			$messenger->assign_vars(array_merge(array( +				'USERNAME'						=> $user['username'], + +				'U_NOTIFICATION_SETTINGS'		=> generate_board_url() . '/ucp.' . $this->php_ext . '?i=ucp_notifications', +			), $notification->get_email_template_variables())); + +			$messenger->send($this->notify_method); +		} + +		// Save the queue in the messenger class (has to be called or these emails could be lost?) +		$messenger->save_queue(); + +		// We're done, empty the queue +		$this->empty_queue(); +	} +} diff --git a/phpBB/includes/notification/method/interface.php b/phpBB/includes/notification/method/interface.php new file mode 100644 index 0000000000..ef875942cc --- /dev/null +++ b/phpBB/includes/notification/method/interface.php @@ -0,0 +1,48 @@ +<?php +/** +* +* @package notifications +* @copyright (c) 2012 phpBB Group +* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2 +* +*/ + +/** +* @ignore +*/ +if (!defined('IN_PHPBB')) +{ +	exit; +} + +/** +* Base notifications method interface +* @package notifications +*/ +interface phpbb_notification_method_interface +{ +	/** +	* Get notification method name +	* +	* @return string +	*/ +	public function get_type(); + +	/** +	* Is this method available for the user? +	* This is checked on the notifications options +	*/ +	public function is_available(); + +	/** +	* Add a notification to the queue +	* +	* @param phpbb_notification_type_interface $notification +	*/ +	public function add_to_queue(phpbb_notification_type_interface $notification); + +	/** +	* Parse the queue and notify the users +	*/ +	public function notify(); +} diff --git a/phpBB/includes/notification/method/jabber.php b/phpBB/includes/notification/method/jabber.php new file mode 100644 index 0000000000..e3eb571fbc --- /dev/null +++ b/phpBB/includes/notification/method/jabber.php @@ -0,0 +1,77 @@ +<?php +/** +* +* @package notifications +* @copyright (c) 2012 phpBB Group +* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2 +* +*/ + +/** +* @ignore +*/ +if (!defined('IN_PHPBB')) +{ +	exit; +} + +/** +* Jabber notification method class +* This class handles sending Jabber messages for notifications +* +* @package notifications +*/ +class phpbb_notification_method_jabber extends phpbb_notification_method_email +{ +	/** +	* Get notification method name +	* +	* @return string +	*/ +	public function get_type() +	{ +		return 'jabber'; +	} + +	/** +	* Notify method (since jabber gets sent through the same messenger, we let the jabber class inherit from this to reduce code duplication) +	* +	* @var mixed +	*/ +	protected $notify_method = NOTIFY_IM; + +	/** +	* Base directory to prepend to the email template name +	* +	* @var string +	*/ +	protected $email_template_base_dir = 'short/'; + +	/** +	* Is this method available for the user? +	* This is checked on the notifications options +	*/ +	public function is_available() +	{ +		return ($this->global_available() && $this->user->data['jabber']); +	} + +	/** +	* Is this method available at all? +	* This is checked before notifications are sent +	*/ +	public function global_available() +	{ +		return ($this->config['jab_enable'] && @extension_loaded('xml')); +	} + +	public function notify() +	{ +		if (!$this->global_available()) +		{ +			return; +		} + +		return parent::notify(); +	} +}  | 
