EmailNotification.php

Go to the documentation of this file.

<?php
use MediaWiki\HookContainer\HookRunner;
use MediaWiki\Mail\UserEmailContact;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Permissions\Authority;
use MediaWiki\SpecialPage\SpecialPage;
use MediaWiki\Title\Title;
use MediaWiki\User\User;
use MediaWiki\User\UserArray;
use MediaWiki\User\UserIdentity;
 
class EmailNotification {
 
    private const USER_TALK = 'user_talk';
    private const WATCHLIST = 'watchlist';
    private const ALL_CHANGES = 'all_changes';
 
    protected string $subject = '';
 
    protected string $body = '';
 
    protected ?MailAddress $replyto;
 
    protected ?MailAddress $from;
 
    protected ?string $timestamp;
 
    protected string $summary = '';
 
    protected ?bool $minorEdit;
 
    protected $oldid;
 
    protected bool $composed_common = false;
 
    protected string $pageStatus = '';
 
    protected array $mailTargets = [];
 
    protected Title $title;
 
    protected User $editor;
 
    public function getPageStatus() {
        return $this->pageStatus;
    }
 
    public function notifyOnPageChange(
        Authority $editor,
        $title,
        $timestamp,
        $summary,
        $minorEdit,
        $oldid = false,
        $pageStatus = 'changed'
    ): bool {
        if ( $title->getNamespace() < 0 ) {
            return false;
        }
 
        $mwServices = MediaWikiServices::getInstance();
        $config = $mwServices->getMainConfig();
 
        // update wl_notificationtimestamp for watchers
        $watchers = [];
        if ( $config->get( MainConfigNames::EnotifWatchlist ) || $config->get( MainConfigNames::ShowUpdatedMarker ) ) {
            $watchers = $mwServices->getWatchedItemStore()->updateNotificationTimestamp(
                $editor->getUser(),
                $title,
                $timestamp
            );
        }
 
        // Don't send email for bots
        if ( $mwServices->getUserFactory()->newFromAuthority( $editor )->isBot() ) {
            return false;
        }
 
        $sendEmail = true;
        // $watchers deals with $wgEnotifWatchlist.
        // If nobody is watching the page, and there are no users notified on all changes
        // don't bother creating a job/trying to send emails, unless it's a
        // talk page with an applicable notification.
        if ( $watchers === [] &&
            !count( $config->get( MainConfigNames::UsersNotifiedOnAllChanges ) )
        ) {
            $sendEmail = false;
            // Only send notification for non minor edits, unless $wgEnotifMinorEdits
            if ( !$minorEdit ||
                ( $config->get( MainConfigNames::EnotifMinorEdits ) &&
                    !$editor->isAllowed( 'nominornewtalk' ) )
            ) {
                if ( $config->get( MainConfigNames::EnotifUserTalk )
                    && $title->getNamespace() === NS_USER_TALK
                    && $this->canSendUserTalkEmail( $editor->getUser(), $title, $minorEdit )
                ) {
                    $sendEmail = true;
                }
            }
        }
 
        if ( $sendEmail ) {
            $mwServices->getJobQueueGroup()->lazyPush( new EnotifNotifyJob(
                $title,
                [
                    'editor' => $editor->getUser()->getName(),
                    'editorID' => $editor->getUser()->getId(),
                    'timestamp' => $timestamp,
                    'summary' => $summary,
                    'minorEdit' => $minorEdit,
                    'oldid' => $oldid,
                    'watchers' => $watchers,
                    'pageStatus' => $pageStatus
                ]
            ) );
        }
 
        return $sendEmail;
    }
 
    public function actuallyNotifyOnPageChange(
        Authority $editor,
        $title,
        $timestamp,
        $summary,
        $minorEdit,
        $oldid,
        $watchers,
        $pageStatus = 'changed'
    ) {
        # we use $wgPasswordSender as sender's address
 
        $mwServices = MediaWikiServices::getInstance();
        $messageCache = $mwServices->getMessageCache();
        $config = $mwServices->getMainConfig();
 
        # The following code is only run, if several conditions are met:
        # 1. EmailNotification for pages (other than user_talk pages) must be enabled
        # 2. minor edits (changes) are only regarded if the global flag indicates so
 
        $this->title = $title;
        $this->timestamp = $timestamp;
        $this->summary = $summary;
        $this->minorEdit = $minorEdit;
        $this->oldid = $oldid;
        $this->editor = MediaWikiServices::getInstance()->getUserFactory()->newFromAuthority( $editor );
        $this->composed_common = false;
        $this->pageStatus = $pageStatus;
 
        $formattedPageStatus = [ 'deleted', 'created', 'moved', 'restored', 'changed' ];
 
        $hookRunner = new HookRunner( $mwServices->getHookContainer() );
        $hookRunner->onUpdateUserMailerFormattedPageStatus( $formattedPageStatus );
        if ( !in_array( $this->pageStatus, $formattedPageStatus ) ) {
            throw new UnexpectedValueException( 'Not a valid page status!' );
        }
 
        $userTalkId = false;
 
        if ( !$minorEdit ||
            ( $config->get( MainConfigNames::EnotifMinorEdits ) &&
                !$editor->isAllowed( 'nominornewtalk' ) )
        ) {
            if ( $config->get( MainConfigNames::EnotifUserTalk )
                && $title->getNamespace() === NS_USER_TALK
                && $this->canSendUserTalkEmail( $editor->getUser(), $title, $minorEdit )
            ) {
                $targetUser = User::newFromName( $title->getText() );
                $this->compose( $targetUser, self::USER_TALK, $messageCache );
                $userTalkId = $targetUser->getId();
            }
 
            if ( $config->get( MainConfigNames::EnotifWatchlist ) ) {
                $userOptionsLookup = $mwServices->getUserOptionsLookup();
                // Send updates to watchers other than the current editor
                // and don't send to watchers who are blocked and cannot login
                $userArray = UserArray::newFromIDs( $watchers );
                foreach ( $userArray as $watchingUser ) {
                    if ( $userOptionsLookup->getOption( $watchingUser, 'enotifwatchlistpages' )
                        && ( !$minorEdit || $userOptionsLookup->getOption( $watchingUser, 'enotifminoredits' ) )
                        && $watchingUser->isEmailConfirmed()
                        && $watchingUser->getId() != $userTalkId
                        && !in_array( $watchingUser->getName(),
                            $config->get( MainConfigNames::UsersNotifiedOnAllChanges ) )
                        // @TODO Partial blocks should not prevent the user from logging in.
                        //       see: https://phabricator.wikimedia.org/T208895
                        && !( $config->get( MainConfigNames::BlockDisablesLogin ) &&
                            $watchingUser->getBlock() )
                        && $hookRunner->onSendWatchlistEmailNotification( $watchingUser, $title, $this )
                    ) {
                        $this->compose( $watchingUser, self::WATCHLIST, $messageCache );
                    }
                }
            }
        }
 
        foreach ( $config->get( MainConfigNames::UsersNotifiedOnAllChanges ) as $name ) {
            if ( $editor->getUser()->getName() == $name ) {
                // No point notifying the user that actually made the change!
                continue;
            }
            $user = User::newFromName( $name );
            if ( $user instanceof User ) {
                $this->compose( $user, self::ALL_CHANGES, $messageCache );
            }
        }
        $this->sendMails();
    }
 
    private function canSendUserTalkEmail( UserIdentity $editor, $title, $minorEdit ) {
        $services = MediaWikiServices::getInstance();
        $config = $services->getMainConfig();
 
        if ( !$config->get( MainConfigNames::EnotifUserTalk ) || $title->getNamespace() !== NS_USER_TALK ) {
            return false;
        }
 
        $userOptionsLookup = $services->getUserOptionsLookup();
        $targetUser = User::newFromName( $title->getText() );
 
        if ( !$targetUser || $targetUser->isAnon() ) {
            wfDebug( __METHOD__ . ": user talk page edited, but user does not exist" );
        } elseif ( $targetUser->getId() == $editor->getId() ) {
            wfDebug( __METHOD__ . ": user edited their own talk page, no notification sent" );
        } elseif ( $targetUser->isTemp() ) {
            wfDebug( __METHOD__ . ": talk page owner is a temporary user so doesn't have email" );
        } elseif ( $config->get( MainConfigNames::BlockDisablesLogin ) &&
            $targetUser->getBlock()
        ) {
            // @TODO Partial blocks should not prevent the user from logging in.
            //       see: https://phabricator.wikimedia.org/T208895
            wfDebug( __METHOD__ . ": talk page owner is blocked and cannot login, no notification sent" );
        } elseif ( $userOptionsLookup->getOption( $targetUser, 'enotifusertalkpages' )
            && ( !$minorEdit || $userOptionsLookup->getOption( $targetUser, 'enotifminoredits' ) )
        ) {
            if ( !$targetUser->isEmailConfirmed() ) {
                wfDebug( __METHOD__ . ": talk page owner doesn't have validated email" );
            } elseif ( !( new HookRunner( $services->getHookContainer() ) )
                ->onAbortTalkPageEmailNotification( $targetUser, $title )
            ) {
                wfDebug( __METHOD__ . ": talk page update notification is aborted for this user" );
            } else {
                wfDebug( __METHOD__ . ": sending talk page update notification" );
                return true;
            }
        } else {
            wfDebug( __METHOD__ . ": talk page owner doesn't want notifications" );
        }
        return false;
    }
 
    private function composeCommonMailtext( MessageCache $messageCache ) {
        $services = MediaWikiServices::getInstance();
        $config = $services->getMainConfig();
        $userOptionsLookup = $services->getUserOptionsLookup();
 
        $this->composed_common = true;
 
        # You as the WikiAdmin and Sysops can make use of plenty of
        # named variables when composing your notification emails while
        # simply editing the Meta pages
 
        $keys = [];
        $postTransformKeys = [];
        $pageTitleUrl = $this->title->getCanonicalURL();
        $pageTitle = $this->title->getPrefixedText();
 
        if ( $this->oldid ) {
            // Always show a link to the diff which triggered the mail. See T34210.
            $keys['$NEWPAGE'] = "\n\n" . wfMessage(
                    'enotif_lastdiff',
                    $this->title->getCanonicalURL( [ 'diff' => 'next', 'oldid' => $this->oldid ] )
                )->inContentLanguage()->text();
 
            if ( !$config->get( MainConfigNames::EnotifImpersonal ) ) {
                // For personal mail, also show a link to the diff of all changes
                // since last visited.
                $keys['$NEWPAGE'] .= "\n\n" . wfMessage(
                        'enotif_lastvisited',
                        $this->title->getCanonicalURL( [ 'diff' => '0', 'oldid' => $this->oldid ] )
                    )->inContentLanguage()->text();
            }
            $keys['$OLDID'] = $this->oldid;
            $keys['$PAGELOG'] = '';
        } else {
            // If there is no revision to link to, link to the page log, which should have details. See T115183.
            $keys['$OLDID'] = '';
            $keys['$NEWPAGE'] = '';
            $keys['$PAGELOG'] = "\n\n" . wfMessage(
                    'enotif_pagelog',
                    SpecialPage::getTitleFor( 'Log' )->getCanonicalURL( [ 'page' => $this->title->getPrefixedDBkey() ] )
                )->inContentLanguage()->text();
 
        }
 
        $keys['$PAGETITLE'] = $this->title->getPrefixedText();
        $keys['$PAGETITLE_URL'] = $this->title->getCanonicalURL();
        $keys['$PAGEMINOREDIT'] = $this->minorEdit ?
            "\n\n" . wfMessage( 'enotif_minoredit' )->inContentLanguage()->text() :
            '';
        $keys['$UNWATCHURL'] = $this->title->getCanonicalURL( 'action=unwatch' );
 
        if ( $this->editor->isAnon() ) {
            # real anon (user:xxx.xxx.xxx.xxx)
            $keys['$PAGEEDITOR'] = wfMessage( 'enotif_anon_editor', $this->editor->getName() )
                ->inContentLanguage()->text();
            $keys['$PAGEEDITOR_EMAIL'] = wfMessage( 'noemailtitle' )->inContentLanguage()->text();
        } elseif ( $this->editor->isTemp() ) {
            $keys['$PAGEEDITOR'] = wfMessage( 'enotif_temp_editor', $this->editor->getName() )
                ->inContentLanguage()->text();
            $keys['$PAGEEDITOR_EMAIL'] = wfMessage( 'noemailtitle' )->inContentLanguage()->text();
        } else {
            $keys['$PAGEEDITOR'] = $config->get( MainConfigNames::EnotifUseRealName ) &&
                    $this->editor->getRealName() !== ''
                ? $this->editor->getRealName() : $this->editor->getName();
            $emailPage = SpecialPage::getSafeTitleFor( 'Emailuser', $this->editor->getName() );
            $keys['$PAGEEDITOR_EMAIL'] = $emailPage->getCanonicalURL();
        }
 
        $keys['$PAGEEDITOR_WIKI'] = $this->editor->getTalkPage()->getCanonicalURL();
        $keys['$HELPPAGE'] = wfExpandUrl(
            Skin::makeInternalOrExternalUrl( wfMessage( 'helppage' )->inContentLanguage()->text() )
        );
 
        # Replace this after transforming the message, T37019
        $postTransformKeys['$PAGESUMMARY'] = $this->summary == '' ? ' - ' : $this->summary;
 
        // Now build message's subject and body
 
        // Messages:
        // enotif_subject_deleted, enotif_subject_created, enotif_subject_moved,
        // enotif_subject_restored, enotif_subject_changed
        $this->subject = wfMessage( 'enotif_subject_' . $this->pageStatus )->inContentLanguage()
            ->params( $pageTitle, $keys['$PAGEEDITOR'] )->text();
 
        // Messages:
        // enotif_body_intro_deleted, enotif_body_intro_created, enotif_body_intro_moved,
        // enotif_body_intro_restored, enotif_body_intro_changed
        $keys['$PAGEINTRO'] = wfMessage( 'enotif_body_intro_' . $this->pageStatus )
            ->inContentLanguage()
            ->params( $pageTitle, $keys['$PAGEEDITOR'], "<{$pageTitleUrl}>" )
            ->text();
 
        $body = wfMessage( 'enotif_body' )->inContentLanguage()->plain();
        $body = strtr( $body, $keys );
        $body = $messageCache->transform( $body, false, null, $this->title );
        $this->body = wordwrap( strtr( $body, $postTransformKeys ), 72 );
 
        # Reveal the page editor's address as REPLY-TO address only if
        # the user has not opted-out and the option is enabled at the
        # global configuration level.
        $adminAddress = new MailAddress(
            $config->get( MainConfigNames::PasswordSender ),
            wfMessage( 'emailsender' )->inContentLanguage()->text()
        );
        if ( $config->get( MainConfigNames::EnotifRevealEditorAddress )
            && ( $this->editor->getEmail() != '' )
            && $userOptionsLookup->getOption( $this->editor, 'enotifrevealaddr' )
        ) {
            $editorAddress = MailAddress::newFromUser( $this->editor );
            if ( $config->get( MainConfigNames::EnotifFromEditor ) ) {
                $this->from = $editorAddress;
            } else {
                $this->from = $adminAddress;
                $this->replyto = $editorAddress;
            }
        } else {
            $this->from = $adminAddress;
            $this->replyto = new MailAddress(
                $config->get( MainConfigNames::NoReplyAddress )
            );
        }
    }
 
    private function compose( UserEmailContact $user, $source, MessageCache $messageCache ) {
        if ( !$this->composed_common ) {
            $this->composeCommonMailtext( $messageCache );
        }
 
        if ( MediaWikiServices::getInstance()->getMainConfig()->get( MainConfigNames::EnotifImpersonal ) ) {
            $this->mailTargets[] = MailAddress::newFromUser( $user );
        } else {
            $this->sendPersonalised( $user, $source );
        }
    }
 
    private function sendMails() {
        if ( MediaWikiServices::getInstance()->getMainConfig()->get( MainConfigNames::EnotifImpersonal ) ) {
            $this->sendImpersonal( $this->mailTargets );
        }
    }
 
    private function sendPersonalised( UserEmailContact $watchingUser, $source ): StatusValue {
        // From the PHP manual:
        //   Note: The to parameter cannot be an address in the form of
        //   "Something <someone@example.com>". The mail command will not parse
        //   this properly while talking with the MTA.
        $to = MailAddress::newFromUser( $watchingUser );
 
        # $PAGEEDITDATE is the time and date of the page change
        # expressed in terms of individual local time of the notification
        # recipient, i.e. watching user
        $mwServices = MediaWikiServices::getInstance();
        $contLang = $mwServices->getContentLanguage();
        $watchingUserName = (
            $mwServices->getMainConfig()->get( MainConfigNames::EnotifUseRealName ) &&
            $watchingUser->getRealName() !== ''
        ) ? $watchingUser->getRealName() : $watchingUser->getUser()->getName();
        $body = str_replace(
            [
                '$WATCHINGUSERNAME',
                '$PAGEEDITDATE',
                '$PAGEEDITTIME'
            ],
            [
                $watchingUserName,
                $contLang->userDate( $this->timestamp, $watchingUser->getUser() ),
                $contLang->userTime( $this->timestamp, $watchingUser->getUser() )
            ],
            $this->body
        );
 
        $headers = [];
        if ( $source === self::WATCHLIST ) {
            $headers['List-Help'] = 'https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Watchlist';
        }
 
        return $mwServices
            ->getEmailer()
            ->send(
                [ $to ],
                $this->from,
                $this->subject,
                $body,
                null,
                [
                    'replyTo' => $this->replyto,
                    'headers' => $headers,
                ]
            );
    }
 
    private function sendImpersonal( array $addresses ): ?StatusValue {
        if ( count( $addresses ) === 0 ) {
            return null;
        }
        $services = MediaWikiServices::getInstance();
        $contLang = $services->getContentLanguage();
        $body = str_replace(
            [
                '$WATCHINGUSERNAME',
                '$PAGEEDITDATE',
                '$PAGEEDITTIME'
            ],
            [
                wfMessage( 'enotif_impersonal_salutation' )->inContentLanguage()->text(),
                $contLang->date( $this->timestamp, false, false ),
                $contLang->time( $this->timestamp, false, false )
            ],
            $this->body
        );
 
        return $services
            ->getEmailer()
            ->send(
                $addresses,
                $this->from,
                $this->subject,
                $body,
                null,
                [
                    'replyTo' => $this->replyto,
                ]
            );
    }
 
}