3 * Implements Special:Emailuser
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup SpecialPage
23 use MediaWiki\MediaWikiServices
;
26 * A special page that allows users to send e-mails to other users
28 * @ingroup SpecialPage
30 class SpecialEmailUser
extends UnlistedSpecialPage
{
34 * @var User|string $mTargetObj
36 protected $mTargetObj;
38 public function __construct() {
39 parent
::__construct( 'Emailuser' );
42 public function doesWrites() {
46 public function getDescription() {
47 $target = self
::getTarget( $this->mTarget
, $this->getUser() );
48 if ( !$target instanceof User
) {
49 return $this->msg( 'emailuser-title-notarget' )->text();
52 return $this->msg( 'emailuser-title-target', $target->getName() )->text();
55 protected function getFormFields() {
56 $linkRenderer = $this->getLinkRenderer();
61 'default' => $linkRenderer->makeLink(
62 $this->getUser()->getUserPage(),
63 $this->getUser()->getName()
65 'label-message' => 'emailfrom',
66 'id' => 'mw-emailuser-sender',
71 'default' => $linkRenderer->makeLink(
72 $this->mTargetObj
->getUserPage(),
73 $this->mTargetObj
->getName()
75 'label-message' => 'emailto',
76 'id' => 'mw-emailuser-recipient',
80 'default' => $this->mTargetObj
->getName(),
84 'default' => $this->msg( 'defemailsubject',
85 $this->getUser()->getName() )->inContentLanguage()->text(),
86 'label-message' => 'emailsubject',
95 'label-message' => 'emailmessage',
100 'label-message' => 'emailccme',
101 'default' => $this->getUser()->getBoolOption( 'ccmeonemails' ),
106 public function execute( $par ) {
107 $out = $this->getOutput();
108 $out->addModuleStyles( 'mediawiki.special' );
110 $this->mTarget
= is_null( $par )
111 ?
$this->getRequest()->getVal( 'wpTarget', $this->getRequest()->getVal( 'target', '' ) )
114 // This needs to be below assignment of $this->mTarget because
115 // getDescription() needs it to determine the correct page title.
117 $this->outputHeader();
119 // error out if sending user cannot do this
120 $error = self
::getPermissionsError(
122 $this->getRequest()->getVal( 'wpEditToken' ),
131 throw new PermissionsError( 'sendemail' );
132 case 'blockedemailuser':
133 throw new UserBlockedError( $this->getUser()->mBlock
);
134 case 'actionthrottledtext':
135 throw new ThrottledError
;
137 case 'usermaildisabled':
138 throw new ErrorPageError( $error, "{$error}text" );
141 list( $title, $msg, $params ) = $error;
142 throw new ErrorPageError( $title, $msg, $params );
144 // Got a valid target user name? Else ask for one.
145 $ret = self
::getTarget( $this->mTarget
, $this->getUser() );
146 if ( !$ret instanceof User
) {
147 if ( $this->mTarget
!= '' ) {
148 // Messages used here: notargettext, noemailtext, nowikiemailtext
149 $ret = ( $ret == 'notarget' ) ?
'emailnotarget' : ( $ret . 'text' );
150 $out->wrapWikiMsg( "<p class='error'>$1</p>", $ret );
152 $out->addHTML( $this->userForm( $this->mTarget
) );
157 $this->mTargetObj
= $ret;
159 // Set the 'relevant user' in the skin, so it displays links like Contributions,
160 // User logs, UserRights, etc.
161 $this->getSkin()->setRelevantUser( $this->mTargetObj
);
163 $context = new DerivativeContext( $this->getContext() );
164 $context->setTitle( $this->getPageTitle() ); // Remove subpage
165 $form = new HTMLForm( $this->getFormFields(), $context );
166 // By now we are supposed to be sure that $this->mTarget is a user name
167 $form->addPreText( $this->msg( 'emailpagetext', $this->mTarget
)->parse() );
168 $form->setSubmitTextMsg( 'emailsend' );
169 $form->setSubmitCallback( [ __CLASS__
, 'uiSubmit' ] );
170 $form->setWrapperLegendMsg( 'email-legend' );
173 if ( !Hooks
::run( 'EmailUserForm', [ &$form ] ) ) {
177 $result = $form->show();
179 if ( $result === true ||
( $result instanceof Status
&& $result->isGood() ) ) {
180 $out->setPageTitle( $this->msg( 'emailsent' ) );
181 $out->addWikiMsg( 'emailsenttext', $this->mTarget
);
182 $out->returnToMain( false, $this->mTargetObj
->getUserPage() );
187 * Validate target User
189 * @param string $target Target user name
190 * @param User|null $sender User sending the email
191 * @return User|string User object on success or a string on error
193 public static function getTarget( $target, User
$sender = null ) {
194 if ( $sender === null ) {
195 wfDeprecated( __METHOD__
. ' without specifying the sending user', '1.30' );
198 if ( $target == '' ) {
199 wfDebug( "Target is empty.\n" );
204 $nu = User
::newFromName( $target );
205 $error = self
::validateTarget( $nu, $sender );
207 return $error ?
: $nu;
211 * Validate target User
213 * @param User $target Target user
214 * @param User|null $sender User sending the email
215 * @return string Error message or empty string if valid.
218 public static function validateTarget( $target, User
$sender = null ) {
219 if ( $sender === null ) {
220 wfDeprecated( __METHOD__
. ' without specifying the sending user', '1.30' );
223 if ( !$target instanceof User ||
!$target->getId() ) {
224 wfDebug( "Target is invalid user.\n" );
229 if ( !$target->isEmailConfirmed() ) {
230 wfDebug( "User has no valid email.\n" );
235 if ( !$target->canReceiveEmail() ) {
236 wfDebug( "User does not allow user emails.\n" );
238 return 'nowikiemail';
241 if ( $sender !== null && !$target->getOption( 'email-allow-new-users' ) &&
244 wfDebug( "User does not allow user emails from new users.\n" );
246 return 'nowikiemail';
249 if ( $sender !== null ) {
250 $blacklist = $target->getOption( 'email-blacklist', [] );
252 $lookup = CentralIdLookup
::factory();
253 $senderId = $lookup->centralIdFromLocalUser( $sender );
254 if ( $senderId !== 0 && in_array( $senderId, $blacklist ) ) {
255 wfDebug( "User does not allow user emails from this user.\n" );
257 return 'nowikiemail';
266 * Check whether a user is allowed to send email
269 * @param string $editToken Edit token
270 * @param Config|null $config optional for backwards compatibility
271 * @return string|null Null on success or string on error
273 public static function getPermissionsError( $user, $editToken, Config
$config = null ) {
274 if ( $config === null ) {
275 wfDebug( __METHOD__
. ' called without a Config instance passed to it' );
276 $config = MediaWikiServices
::getInstance()->getMainConfig();
278 if ( !$config->get( 'EnableEmail' ) ||
!$config->get( 'EnableUserEmail' ) ) {
279 return 'usermaildisabled';
282 // Run this before $user->isAllowed, to show appropriate message to anons (T160309)
283 if ( !$user->isEmailConfirmed() ) {
284 return 'mailnologin';
287 if ( !$user->isAllowed( 'sendemail' ) ) {
291 if ( $user->isBlockedFromEmailuser() ) {
292 wfDebug( "User is blocked from sending e-mail.\n" );
294 return "blockedemailuser";
297 // Check the ping limiter without incrementing it - we'll check it
298 // again later and increment it on a successful send
299 if ( $user->pingLimiter( 'emailuser', 0 ) ) {
300 wfDebug( "Ping limiter triggered.\n" );
302 return 'actionthrottledtext';
307 Hooks
::run( 'UserCanSendEmail', [ &$user, &$hookErr ] );
308 Hooks
::run( 'EmailUserPermissionsErrors', [ $user, $editToken, &$hookErr ] );
318 * Form to ask for target user name.
320 * @param string $name User name submitted.
321 * @return string Form asking for user name.
323 protected function userForm( $name ) {
324 $this->getOutput()->addModules( 'mediawiki.userSuggest' );
325 $string = Html
::openElement(
327 [ 'method' => 'get', 'action' => wfScript(), 'id' => 'askusername' ]
329 Html
::hidden( 'title', $this->getPageTitle()->getPrefixedText() ) .
330 Html
::openElement( 'fieldset' ) .
331 Html
::rawElement( 'legend', null, $this->msg( 'emailtarget' )->parse() ) .
333 $this->msg( 'emailusername' )->text(),
341 'id' => 'emailusertarget',
342 'class' => 'mw-autocomplete-user', // used by mediawiki.userSuggest
348 Html
::submitButton( $this->msg( 'emailusernamesubmit' )->text(), [] ) .
349 Html
::closeElement( 'fieldset' ) .
350 Html
::closeElement( 'form' ) . "\n";
356 * Submit callback for an HTMLForm object, will simply call submit().
360 * @param HTMLForm $form
361 * @return Status|bool
363 public static function uiSubmit( array $data, HTMLForm
$form ) {
364 return self
::submit( $data, $form->getContext() );
368 * Really send a mail. Permissions should have been checked using
369 * getPermissionsError(). It is probably also a good
370 * idea to check the edit token and ping limiter in advance.
373 * @param IContextSource $context
374 * @return Status|bool
376 public static function submit( array $data, IContextSource
$context ) {
377 $config = $context->getConfig();
379 $target = self
::getTarget( $data['Target'], $context->getUser() );
380 if ( !$target instanceof User
) {
381 // Messages used here: notargettext, noemailtext, nowikiemailtext
382 return Status
::newFatal( $target . 'text' );
385 $to = MailAddress
::newFromUser( $target );
386 $from = MailAddress
::newFromUser( $context->getUser() );
387 $subject = $data['Subject'];
388 $text = $data['Text'];
390 // Add a standard footer and trim up trailing newlines
391 $text = rtrim( $text ) . "\n\n-- \n";
392 $text .= $context->msg( 'emailuserfooter',
393 $from->name
, $to->name
)->inContentLanguage()->text();
395 // Check and increment the rate limits
396 if ( $context->getUser()->pingLimiter( 'emailuser' ) ) {
397 throw new ThrottledError();
401 if ( !Hooks
::run( 'EmailUser', [ &$to, &$from, &$subject, &$text, &$error ] ) ) {
402 if ( $error instanceof Status
) {
404 } elseif ( $error === false ||
$error === '' ||
$error === [] ) {
405 // Possibly to tell HTMLForm to pretend there was no submission?
407 } elseif ( $error === true ) {
408 // Hook sent the mail itself and indicates success?
409 return Status
::newGood();
410 } elseif ( is_array( $error ) ) {
411 $status = Status
::newGood();
412 foreach ( $error as $e ) {
413 $status->fatal( $e );
416 } elseif ( $error instanceof MessageSpecifier
) {
417 return Status
::newFatal( $error );
419 // Ugh. Either a raw HTML string, or something that's supposed
420 // to be treated like one.
421 $type = is_object( $error ) ?
get_class( $error ) : gettype( $error );
422 wfDeprecated( "EmailUser hook returning a $type as \$error", '1.29' );
423 return Status
::newFatal( new ApiRawMessage(
424 [ '$1', Message
::rawParam( (string)$error ) ], 'hookaborted'
429 if ( $config->get( 'UserEmailUseReplyTo' ) ) {
431 * Put the generic wiki autogenerated address in the From:
432 * header and reserve the user for Reply-To.
434 * This is a bit ugly, but will serve to differentiate
435 * wiki-borne mails from direct mails and protects against
436 * SPF and bounce problems with some mailers (see below).
438 $mailFrom = new MailAddress( $config->get( 'PasswordSender' ),
439 wfMessage( 'emailsender' )->inContentLanguage()->text() );
443 * Put the sending user's e-mail address in the From: header.
445 * This is clean-looking and convenient, but has issues.
446 * One is that it doesn't as clearly differentiate the wiki mail
447 * from "directly" sent mails.
449 * Another is that some mailers (like sSMTP) will use the From
450 * address as the envelope sender as well. For open sites this
451 * can cause mails to be flunked for SPF violations (since the
452 * wiki server isn't an authorized sender for various users'
453 * domains) as well as creating a privacy issue as bounces
454 * containing the recipient's e-mail address may get sent to
461 $status = UserMailer
::send( $to, $mailFrom, $subject, $text, [
462 'replyTo' => $replyTo,
465 if ( !$status->isGood() ) {
468 // if the user requested a copy of this mail, do this now,
469 // unless they are emailing themselves, in which case one
470 // copy of the message is sufficient.
471 if ( $data['CCMe'] && $to != $from ) {
474 $ccSubject = $context->msg( 'emailccsubject' )->rawParams(
475 $target->getName(), $subject )->text();
478 Hooks
::run( 'EmailUserCC', [ &$ccTo, &$ccFrom, &$ccSubject, &$ccText ] );
480 if ( $config->get( 'UserEmailUseReplyTo' ) ) {
481 $mailFrom = new MailAddress(
482 $config->get( 'PasswordSender' ),
483 wfMessage( 'emailsender' )->inContentLanguage()->text()
491 $ccStatus = UserMailer
::send(
492 $ccTo, $mailFrom, $ccSubject, $ccText, [
493 'replyTo' => $replyTo,
495 $status->merge( $ccStatus );
498 Hooks
::run( 'EmailUserComplete', [ $to, $from, $subject, $text ] );
505 * Return an array of subpages beginning with $search that this special page will accept.
507 * @param string $search Prefix to search for
508 * @param int $limit Maximum number of results to return (usually 10)
509 * @param int $offset Number of results to skip (usually 0)
510 * @return string[] Matching subpages
512 public function prefixSearchSubpages( $search, $limit, $offset ) {
513 $user = User
::newFromName( $search );
515 // No prefix suggestion for invalid user
518 // Autocomplete subpage as user list - public to allow caching
519 return UserNamePrefixSearch
::search( 'public', $search, $limit, $offset );
522 protected function getGroupName() {