aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/includes/notifications/method
diff options
context:
space:
mode:
Diffstat (limited to 'phpBB/includes/notifications/method')
-rw-r--r--phpBB/includes/notifications/method/base.php92
-rw-r--r--phpBB/includes/notifications/method/email.php104
-rw-r--r--phpBB/includes/notifications/method/interface.php27
-rw-r--r--phpBB/includes/notifications/method/jabber.php62
4 files changed, 285 insertions, 0 deletions
diff --git a/phpBB/includes/notifications/method/base.php b/phpBB/includes/notifications/method/base.php
new file mode 100644
index 0000000000..b860fcffda
--- /dev/null
+++ b/phpBB/includes/notifications/method/base.php
@@ -0,0 +1,92 @@
+<?php
+/**
+*
+* @package notifications
+* @copyright (c) 2012 phpBB Group
+* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
+*
+*/
+
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+/**
+* @ignore
+*/
+if (!defined('IN_PHPBB'))
+{
+ exit;
+}
+
+/**
+* Base notifications method class
+* @package notifications
+*/
+abstract class phpbb_notifications_method_base implements phpbb_notifications_method_interface
+{
+ protected $phpbb_container;
+ protected $service;
+ protected $db;
+ protected $user;
+ protected $phpbb_root_path;
+ protected $php_ext;
+
+ /**
+ * Desired notifications
+ * unique by (type, type_id, user_id, method)
+ * if multiple methods are desired, multiple rows will exist.
+ *
+ * method of "none" will over-ride any other options
+ *
+ * item_type
+ * item_id
+ * user_id
+ * method
+ * none (will never receive notifications)
+ * standard (listed in notifications window
+ * popup?
+ * email
+ * jabber
+ * sms?
+ */
+
+ /**
+ * Queue of messages to be sent
+ *
+ * @var array
+ */
+ protected $queue = array();
+
+ public function __construct(ContainerBuilder $phpbb_container)
+ {
+ // phpBB Container
+ $this->phpbb_container = $phpbb_container;
+
+ // Service
+ $this->service = $phpbb_container->get('notifications');
+
+ // Some common things we're going to use
+ $this->db = $phpbb_container->get('dbal.conn');
+ $this->user = $phpbb_container->get('user');
+
+ $this->phpbb_root_path = $phpbb_container->getParameter('core.root_path');
+ $this->php_ext = $phpbb_container->getParameter('core.php_ext');
+ }
+
+ /**
+ * Add a notification to the queue
+ *
+ * @param phpbb_notifications_type_interface $notification
+ */
+ public function add_to_queue(phpbb_notifications_type_interface $notification)
+ {
+ $this->queue[] = $notification;
+ }
+
+ /**
+ * Empty the queue
+ */
+ protected function empty_queue()
+ {
+ $this->queue = array();
+ }
+}
diff --git a/phpBB/includes/notifications/method/email.php b/phpBB/includes/notifications/method/email.php
new file mode 100644
index 0000000000..ebfc0c7c71
--- /dev/null
+++ b/phpBB/includes/notifications/method/email.php
@@ -0,0 +1,104 @@
+<?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_notifications_method_email extends phpbb_notifications_method_base
+{
+ /**
+ * 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;
+
+ /**
+ * Is this method available for the user?
+ * This is checked on the notifications options
+ */
+ public function is_available()
+ {
+ // Email is always available
+ return true;
+ }
+
+ 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_container->getParameter('core.root_path') . 'includes/functions_user.' . $this->phpbb_container->getParameter('core.php_ext'));
+ }
+ $banned_users = phpbb_get_banned_user_ids($user_ids);
+
+ // Load all the users we need
+ $this->service->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)
+ {
+ $user = $this->service->get_user($notification->user_id);
+
+ if ($user['user_type'] == USER_IGNORE || in_array($notification->user_id, $banned_users))
+ {
+ continue;
+ }
+
+ $messenger->template($notification->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/notifications/method/interface.php b/phpBB/includes/notifications/method/interface.php
new file mode 100644
index 0000000000..820cf4fc12
--- /dev/null
+++ b/phpBB/includes/notifications/method/interface.php
@@ -0,0 +1,27 @@
+<?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_notifications_method_interface
+{
+ public function is_available();
+
+ public function notify();
+}
diff --git a/phpBB/includes/notifications/method/jabber.php b/phpBB/includes/notifications/method/jabber.php
new file mode 100644
index 0000000000..738400a50e
--- /dev/null
+++ b/phpBB/includes/notifications/method/jabber.php
@@ -0,0 +1,62 @@
+<?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_notifications_method_jabber extends phpbb_notifications_method_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_IM;
+
+ /**
+ * Is this method available for the user?
+ * This is checked on the notifications options
+ */
+ public function is_available()
+ {
+ return ($this->global_available() && $this->phpbb_container->get('user')->data['jabber']);
+ }
+
+ /**
+ * Is this method available at all?
+ * This is checked before notifications are sent
+ */
+ public function global_available()
+ {
+ $config = $this->phpbb_container->get('config');
+
+ return ($config['jab_enable'] && @extension_loaded('xml'));
+ }
+
+ public function notify()
+ {
+ if (!$this->global_available())
+ {
+ return;
+ }
+
+ return parent::notify();
+ }
+}