mediawiki-extensions-Echo/includes/Notifier.php

140 lines
4.8 KiB
PHP
Raw Normal View History

<?php
// @todo Fill in
class EchoNotifier {
/**
* Record an EchoNotification for an EchoEvent
* Currently used for web-based notifications.
*
* @param User $user User to notify.
* @param EchoEvent $event EchoEvent to notify about.
*/
public static function notifyWithNotification( $user, $event ) {
// Only create the notification if the user wants to receive that type
// of notification and they are eligible to receive it. See bug 47664.
$attributeManager = EchoAttributeManager::newFromGlobalVars();
$userWebNotifications = $attributeManager->getUserEnabledEvents( $user, 'web' );
if ( !in_array( $event->getType(), $userWebNotifications ) ) {
return;
}
EchoNotification::create( [ 'user' => $user, 'event' => $event ] );
MWEchoEventLogging::logSchemaEcho( $user, $event, 'web' );
}
/**
* Send a Notification to a user by email
*
* @param User $user User to notify.
* @param EchoEvent $event EchoEvent to notify about.
* @return bool
*/
public static function notifyWithEmail( $user, $event ) {
global $wgEnableEmail, $wgBlockDisablesLogin;
if (
// Email is globally disabled
!$wgEnableEmail ||
// User does not have a valid and confirmed email address
!$user->isEmailConfirmed() ||
// User has disabled Echo emails
$user->getOption( 'echo-email-frequency' ) < 0 ||
// User is blocked and cannot log in (T199993)
( $wgBlockDisablesLogin && $user->isBlocked() )
) {
return false;
}
// Final check on whether to send email for this user & event
if ( !Hooks::run( 'EchoAbortEmailNotification', [ $user, $event ] ) ) {
return false;
}
$attributeManager = EchoAttributeManager::newFromGlobalVars();
$userEmailNotifications = $attributeManager->getUserEnabledEvents( $user, 'email' );
// See if the user wants to receive emails for this category or the user is eligible to receive this email
if ( in_array( $event->getType(), $userEmailNotifications ) ) {
global $wgEchoEnableEmailBatch, $wgEchoNotifications, $wgPasswordSender, $wgNoReplyAddress;
$priority = $attributeManager->getNotificationPriority( $event->getType() );
$bundleString = $bundleHash = '';
// We should have bundling for email digest as long as either web or email bundling is on,
// for example, talk page email bundling is off, but if a user decides to receive email
// digest, we should bundle those messages
if ( !empty( $wgEchoNotifications[$event->getType()]['bundle']['web'] ) ||
!empty( $wgEchoNotifications[$event->getType()]['bundle']['email'] )
) {
Hooks::run( 'EchoGetBundleRules', [ $event, &$bundleString ] );
}
// @phan-suppress-next-line PhanImpossibleCondition May be set by hook
if ( $bundleString ) {
$bundleHash = md5( $bundleString );
}
MWEchoEventLogging::logSchemaEcho( $user, $event, 'email' );
// email digest notification ( weekly or daily )
if ( $wgEchoEnableEmailBatch && $user->getOption( 'echo-email-frequency' ) > 0 ) {
// always create a unique event hash for those events don't support bundling
// this is mainly for group by
if ( !$bundleHash ) {
$bundleHash = md5( $event->getType() . '-' . $event->getId() );
}
MWEchoEmailBatch::addToQueue( $user->getId(), $event->getId(), $priority, $bundleHash );
return true;
}
// instant email notification
$toAddress = MailAddress::newFromUser( $user );
$fromAddress = new MailAddress( $wgPasswordSender, wfMessage( 'emailsender' )->inContentLanguage()->text() );
$replyAddress = new MailAddress( $wgNoReplyAddress );
// Since we are sending a single email, should set the bundle hash to null
// if it is set with a value from somewhere else
$event->setBundleHash( null );
$email = self::generateEmail( $event, $user );
if ( !$email ) {
return false;
}
$subject = $email['subject'];
$body = $email['body'];
$options = [ 'replyTo' => $replyAddress ];
UserMailer::send( $toAddress, $fromAddress, $subject, $body, $options );
MWEchoEventLogging::logSchemaEchoMail( $user, 'single' );
}
return true;
}
/**
* @param EchoEvent $event
* @param User $user
* @return array|false An array of 'subject' and 'body', or false if things went wrong
*/
private static function generateEmail( EchoEvent $event, User $user ) {
$emailFormat = MWEchoNotifUser::newFromUser( $user )->getEmailFormat();
$lang = Language::factory( $user->getOption( 'language' ) );
$formatter = new EchoPlainTextEmailFormatter( $user, $lang );
$content = $formatter->format( $event );
if ( !$content ) {
return false;
}
if ( $emailFormat === EchoEmailFormat::HTML ) {
$htmlEmailFormatter = new EchoHtmlEmailFormatter( $user, $lang );
$htmlContent = $htmlEmailFormatter->format( $event );
$multipartBody = [
'text' => $content['body'],
'html' => $htmlContent['body']
];
$content['body'] = $multipartBody;
}
return $content;
}
}