1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
|
<?php
class SpotNotifications {
private $_notificationTemplate = array();
private $_notificationServices = array();
private $_spotSecTmp;
private $_spotSec;
private $_currentSession;
private $_settings;
private $_db;
/*
* Constants used for securing the system
*/
const notifytype_nzb_handled = 'nzb_handled';
const notifytype_watchlist_handled = 'watchlist_handled';
const notifytype_retriever_finished = 'retriever_finished';
const notifytype_report_posted = 'report_posted';
const notifytype_spot_posted = 'spot_posted';
const notifytype_user_added = 'user_added';
const notifytype_newspots_for_filter = 'newspots_for_filter';
function __construct(SpotDb $db, SpotSettings $settings, array $currentSession) {
$this->_db = $db;
$this->_settings = $settings;
$this->_currentSession = $currentSession;
$this->_spotSec = $currentSession['security'];
$this->_notificationTemplate = new SpotNotificationTemplate($this->_db, $this->_settings, $this->_currentSession);
} # ctor
/*
* Some notification providers need explicit registration (eg,
* a twitter signup/approval). We use this function to provide
* for this
*/
function register() {
if ($this->_spotSec->allowed(SpotSecurity::spotsec_send_notifications_services, '')) {
# Boxcar requires additional settings
$this->_currentSession['user']['prefs']['notifications']['boxcar']['api_key'] = $this->_settings->get('boxcar_api_key');
$this->_currentSession['user']['prefs']['notifications']['boxcar']['api_secret'] = $this->_settings->get('boxcar_api_secret');
$notifProviders = Notifications_Factory::getActiveServices();
foreach ($notifProviders as $notifProvider) {
if ($this->_currentSession['user']['prefs']['notifications'][$notifProvider]['enabled']) {
if ($this->_spotSec->allowed(SpotSecurity::spotsec_send_notifications_services, $notifProvider)) {
$this->_notificationServices[$notifProvider] = Notifications_Factory::build('Spotweb', $notifProvider, $this->_currentSession['user']['prefs']['notifications'][$notifProvider]);
} # if
} # if
} # foreach
} # if
foreach($this->_notificationServices as $notificationService) {
$notificationService->register();
} # foreach
} # register
/*
* Send a notification when an watchlist addition or removal
* is handled
*/
function sendWatchlistHandled($action, $messageid) {
$spot = $this->_db->getSpotHeader($messageid);
switch ($action) {
case 'remove' : $notification = $this->_notificationTemplate->template('watchlist_removed', array('spot' => $spot)); break;
case 'add' : $notification = $this->_notificationTemplate->template('watchlist_added', array('spot' => $spot)); break;
} # switch
$this->newSingleMessage($this->_currentSession, SpotNotifications::notifytype_watchlist_handled, 'Single', $notification);
} # sendWatchlistHandled
/*
* Send a notification when an NZB file is handled by Spotweb
* Because Spotweb does not handle the download itself, the
* SpotWeb cannot send this message until the file is actually
* downloaded, so this message might come too early.
*/
function sendNzbHandled($action, $spot) {
switch ($action) {
case 'save' : $notification = $this->_notificationTemplate->template('nzb_save', array('spot' => $spot, 'nzbhandling' => $this->_currentSession['user']['prefs']['nzbhandling'])); break;
case 'runcommand' : $notification = $this->_notificationTemplate->template('nzb_runcommand', array('spot' => $spot, 'nzbhandling' => $this->_currentSession['user']['prefs']['nzbhandling'])); break;
case 'push-sabnzbd' :
case 'client-sabnzbd' : $notification = $this->_notificationTemplate->template('nzb_sabnzbd', array('spot' => $spot)); break;
case 'nzbget' : $notification = $this->_notificationTemplate->template('nzb_nzbget', array('spot' => $spot)); break;
default : return;
} # switch
$this->newSingleMessage($this->_currentSession, SpotNotifications::notifytype_nzb_handled, 'Single', $notification);
} # sendNzbHandled
/*
* When a specific user defined filter in Spotweb has new spots
* we can send the user for this filter a notification.
*/
function sendNewSpotsForFilter($userId, $filterTitle, $newSpotCount) {
$notification = $this->_notificationTemplate->template('newspots_for_filter', array('filtertitle' => $filterTitle, 'newCount' => $newSpotCount));
echo 'Sending notification to user: ' . $userId . ' for filter: ' . $filterTitle . ', it has ' . $newSpotCount . ' new spots' . PHP_EOL;
/* and send the message */
$user = array('user' => array('userid' => $userId),
'session' => array('ipaddr' => '127.0.0.1'));
$this->newSingleMessage($user, SpotNotifications::notifytype_newspots_for_filter, 'Single', $notification);
} # sendNewSpotsForFilter
/*
* We can notify the user when the retrieve process has done
* retrievinjg and actually retrieved new spots.
*/
function sendRetrieverFinished($newSpotCount, $newCommentCount, $newReportCount) {
if ($newSpotCount > 0) {
$notification = $this->_notificationTemplate->template('retriever_finished', array('newSpotCount' => $newSpotCount, 'newCommentCount' => $newCommentCount, 'newReportCount' => $newReportCount));
$this->newMultiMessage(SpotNotifications::notifytype_retriever_finished, $notification);
} # if
} # sendRetrieverFinished
/*
* If a spot is reported to be spam or incorect, we can
* send this notification.
*/
function sendReportPosted($messageid) {
# haal de spot op
$spot = $this->_db->getSpotHeader($messageid);
$notification = $this->_notificationTemplate->template('report_posted', array('spot' => $spot));
$this->newSingleMessage($this->_currentSession, SpotNotifications::notifytype_report_posted, 'Single', $notification);
} # sendReportPosted
/*
* Send a notification after a new spot has been
* posted
*/
function sendSpotPosted($spot) {
$notification = $this->_notificationTemplate->template('spot_posted', array('spot' => $spot));
$this->newSingleMessage($this->_currentSession, SpotNotifications::notifytype_spot_posted, 'Single', $notification);
} # sendSpotPosted
/*
* send a notification when a new user is added
*/
function sendUserAdded($username, $password) {
$notification = $this->_notificationTemplate->template('user_added', array('username' => $username, 'password' => $password));
$this->newMultiMessage(SpotNotifications::notifytype_user_added, $notification);
} # sendUserAdded
/*
* Send the new user itself a notification mail
* that his / her account has been created
*/
function sendNewUserMail($user) {
# Omdat het versturen van dit bericht expliciet is opgegeven, worden er
# geen security-checks gedaan voor de ontvanger.
if ($this->_spotSec->allowed(SpotSecurity::spotsec_send_notifications_services, 'welcomemail')) {
$notification = $this->_notificationTemplate->template('user_added_email', array('user' => $user, 'adminUser' => $this->_currentSession['user']));
$user['prefs']['notifications']['email']['sender'] = $this->_settings->get('systemfrommail');
$user['prefs']['notifications']['email']['receiver'] = $user['mail'];
$this->_notificationServices['email'] = Notifications_Factory::build('Spotweb', 'email', $user['prefs']['notifications']['email']);
$this->_notificationServices['email']->sendMessage('Single', $notification['title'], implode(PHP_EOL, $notification['body']), $this->_settings->get('spotweburl'));
$this->_notificationServices = array();
} # if
} # sendNewUserMail
/*
* utility function to send a message to one person
* only
*/
private function newSingleMessage($user, $objectId, $type, $notification) {
# Aangezien het niet zeker kunnen zijn als welke user we dit stuk
# code uitvoeren, halen we voor de zekerheid opnieuw het user record op
$tmpUser['user'] = $this->_db->getUser($user['user']['userid']);
$tmpUser['security'] = new SpotSecurity($this->_db, $this->_settings, $tmpUser['user'], $user['session']['ipaddr']);
$this->_spotSecTmp = $tmpUser['security'];
if ($this->_spotSecTmp->allowed(SpotSecurity::spotsec_send_notifications_services, '')) {
$notifProviders = Notifications_Factory::getActiveServices();
foreach ($notifProviders as $notifProvider) {
if ($tmpUser['user']['prefs']['notifications'][$notifProvider]['enabled'] && $tmpUser['user']['prefs']['notifications'][$notifProvider]['events'][$objectId]) {
if ($this->_spotSecTmp->allowed(SpotSecurity::spotsec_send_notifications_types, '') &&
$this->_spotSecTmp->allowed(SpotSecurity::spotsec_send_notifications_types, $objectId) &&
$this->_spotSecTmp->allowed(SpotSecurity::spotsec_send_notifications_services, $notifProvider)
) {
$this->_db->addNewNotification($tmpUser['user']['userid'], $objectId, $type, $notification['title'], implode(PHP_EOL, $notification['body']));
break;
} # if
} # if
} # foreach
} # if
if ($type == 'Single') {
$this->sendNowOrLater($tmpUser['user']['userid']);
} # if
} # newSingleMessage
/*
* Send a notification to multiple users
*/
private function newMultiMessage($objectId, $notification) {
$userArray = $this->_db->getUserList();
foreach ($userArray as $user['user']) {
# Create a fake session array
$user['session'] = array('ipaddr' => '');
$this->newSingleMessage($user, $objectId, 'Multi', $notification);
} # foreach
$this->sendNowOrLater(0);
} # newMultiMessage
function sendNowOrLater($userId) {
# TODO: optioneel maken of berichten direct worden verstuurd of via cron
# Tot die tijd versturen we ze direct
$this->sendMessages($userId);
} # sendNowOrLater
function sendMessages($userId) {
if ($userId == 0) {
$userList = $this->_db->getUserList();
} else {
$thisUser = $this->_db->getUser($userId);
$userList = array($thisUser);
} # else
foreach ($userList as $user) {
# Omdat we vanuit getUserList() niet alle velden meekrijgen
# vragen we opnieuw het user record op
$user = $this->_db->getUser($user['userid']);
$security = new SpotSecurity($this->_db, $this->_settings, $user, '');
# Om e-mail te kunnen versturen hebben we iets meer data nodig
$user['prefs']['notifications']['email']['sender'] = $this->_settings->get('systemfrommail');
$user['prefs']['notifications']['email']['receiver'] = $user['mail'];
# Twitter heeft ook extra settings nodig
$user['prefs']['notifications']['twitter']['consumer_key'] = $this->_settings->get('twitter_consumer_key');
$user['prefs']['notifications']['twitter']['consumer_secret'] = $this->_settings->get('twitter_consumer_secret');
# Evenals Boxcar
$user['prefs']['notifications']['boxcar']['api_key'] = $this->_settings->get('boxcar_api_key');
$user['prefs']['notifications']['boxcar']['api_secret'] = $this->_settings->get('boxcar_api_secret');
$newMessages = $this->_db->getUnsentNotifications($user['userid']);
foreach ($newMessages as $newMessage) {
$objectId = $newMessage['objectid'];
$spotweburl = ($this->_settings->get('spotweburl') == 'http://mijnuniekeservernaam/spotweb/') ? '' : $this->_settings->get('spotweburl');
$notifProviders = Notifications_Factory::getActiveServices();
foreach ($notifProviders as $notifProvider) {
if ($user['prefs']['notifications'][$notifProvider]['enabled'] && $user['prefs']['notifications'][$notifProvider]['events'][$objectId]) {
if ($security->allowed(SpotSecurity::spotsec_send_notifications_services, $notifProvider)) {
$this->_notificationServices[$notifProvider] = Notifications_Factory::build('Spotweb', $notifProvider, $user['prefs']['notifications'][$notifProvider]);
} # if
} # if
} # foreach
# nu wordt het bericht pas echt verzonden
foreach($this->_notificationServices as $notificationService) {
$notificationService->sendMessage($newMessage['type'], utf8_decode($newMessage['title']), utf8_decode($newMessage['body']), $spotweburl);
} # foreach
# Alle services resetten, deze mogen niet hergebruikt worden
$this->_notificationServices = array();
# Als dit bericht ging over het aanmaken van een nieuwe user, verwijderen we
# het plaintext wachtwoord uit de database uit veiligheidsoverwegingen.
if ($objectId == SpotNotifications::notifytype_user_added) {
$body = explode(" ", $newMessage['body']);
$body[4] = '[deleted]';
$newMessage['body'] = implode(" ", $body);
} # if
$newMessage['sent'] = true;
$this->_db->updateNotification($newMessage);
} # foreach message
} # foreach user
} # sendMessages
} # SpotsNotifications
|