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 ?
$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" );
227 } elseif ( !$target->isEmailConfirmed() ) {
228 wfDebug( "User has no valid email.\n" );
231 } elseif ( !$target->canReceiveEmail() ) {
232 wfDebug( "User does not allow user emails.\n" );
234 return 'nowikiemail';
235 } elseif ( $sender !== null ) {
236 $blacklist = $target->getOption( 'email-blacklist', [] );
238 $lookup = CentralIdLookup
::factory();
239 $senderId = $lookup->centralIdFromLocalUser( $sender );
240 if ( $senderId !== 0 && in_array( $senderId, $blacklist ) ) {
241 wfDebug( "User does not allow user emails from this user.\n" );
243 return 'nowikiemail';
252 * Check whether a user is allowed to send email
255 * @param string $editToken Edit token
256 * @param Config $config optional for backwards compatibility
257 * @return string|null Null on success or string on error
259 public static function getPermissionsError( $user, $editToken, Config
$config = null ) {
260 if ( $config === null ) {
261 wfDebug( __METHOD__
. ' called without a Config instance passed to it' );
262 $config = MediaWikiServices
::getInstance()->getMainConfig();
264 if ( !$config->get( 'EnableEmail' ) ||
!$config->get( 'EnableUserEmail' ) ) {
265 return 'usermaildisabled';
268 // Run this before $user->isAllowed, to show appropriate message to anons (T160309)
269 if ( !$user->isEmailConfirmed() ) {
270 return 'mailnologin';
273 if ( !$user->isAllowed( 'sendemail' ) ) {
277 if ( $user->isBlockedFromEmailuser() ) {
278 wfDebug( "User is blocked from sending e-mail.\n" );
280 return "blockedemailuser";
283 // Check the ping limiter without incrementing it - we'll check it
284 // again later and increment it on a successful send
285 if ( $user->pingLimiter( 'emailuser', 0 ) ) {
286 wfDebug( "Ping limiter triggered.\n" );
288 return 'actionthrottledtext';
293 Hooks
::run( 'UserCanSendEmail', [ &$user, &$hookErr ] );
294 Hooks
::run( 'EmailUserPermissionsErrors', [ $user, $editToken, &$hookErr ] );
304 * Form to ask for target user name.
306 * @param string $name User name submitted.
307 * @return string Form asking for user name.
309 protected function userForm( $name ) {
310 $this->getOutput()->addModules( 'mediawiki.userSuggest' );
311 $string = Html
::openElement(
313 [ 'method' => 'get', 'action' => wfScript(), 'id' => 'askusername' ]
315 Html
::hidden( 'title', $this->getPageTitle()->getPrefixedText() ) .
316 Html
::openElement( 'fieldset' ) .
317 Html
::rawElement( 'legend', null, $this->msg( 'emailtarget' )->parse() ) .
319 $this->msg( 'emailusername' )->text(),
327 'id' => 'emailusertarget',
328 'class' => 'mw-autocomplete-user', // used by mediawiki.userSuggest
334 Html
::submitButton( $this->msg( 'emailusernamesubmit' )->text(), [] ) .
335 Html
::closeElement( 'fieldset' ) .
336 Html
::closeElement( 'form' ) . "\n";
342 * Submit callback for an HTMLForm object, will simply call submit().
346 * @param HTMLForm $form
347 * @return Status|bool
349 public static function uiSubmit( array $data, HTMLForm
$form ) {
350 return self
::submit( $data, $form->getContext() );
354 * Really send a mail. Permissions should have been checked using
355 * getPermissionsError(). It is probably also a good
356 * idea to check the edit token and ping limiter in advance.
359 * @param IContextSource $context
360 * @return Status|bool
362 public static function submit( array $data, IContextSource
$context ) {
363 $config = $context->getConfig();
365 $target = self
::getTarget( $data['Target'], $context->getUser() );
366 if ( !$target instanceof User
) {
367 // Messages used here: notargettext, noemailtext, nowikiemailtext
368 return Status
::newFatal( $target . 'text' );
371 $to = MailAddress
::newFromUser( $target );
372 $from = MailAddress
::newFromUser( $context->getUser() );
373 $subject = $data['Subject'];
374 $text = $data['Text'];
376 // Add a standard footer and trim up trailing newlines
377 $text = rtrim( $text ) . "\n\n-- \n";
378 $text .= $context->msg( 'emailuserfooter',
379 $from->name
, $to->name
)->inContentLanguage()->text();
381 // Check and increment the rate limits
382 if ( $context->getUser()->pingLimiter( 'emailuser' ) ) {
383 throw new ThrottledError();
387 if ( !Hooks
::run( 'EmailUser', [ &$to, &$from, &$subject, &$text, &$error ] ) ) {
388 if ( $error instanceof Status
) {
390 } elseif ( $error === false ||
$error === '' ||
$error === [] ) {
391 // Possibly to tell HTMLForm to pretend there was no submission?
393 } elseif ( $error === true ) {
394 // Hook sent the mail itself and indicates success?
395 return Status
::newGood();
396 } elseif ( is_array( $error ) ) {
397 $status = Status
::newGood();
398 foreach ( $error as $e ) {
399 $status->fatal( $e );
402 } elseif ( $error instanceof MessageSpecifier
) {
403 return Status
::newFatal( $error );
405 // Ugh. Either a raw HTML string, or something that's supposed
406 // to be treated like one.
407 $type = is_object( $error ) ?
get_class( $error ) : gettype( $error );
408 wfDeprecated( "EmailUser hook returning a $type as \$error", '1.29' );
409 return Status
::newFatal( new ApiRawMessage(
410 [ '$1', Message
::rawParam( (string)$error ) ], 'hookaborted'
415 if ( $config->get( 'UserEmailUseReplyTo' ) ) {
417 * Put the generic wiki autogenerated address in the From:
418 * header and reserve the user for Reply-To.
420 * This is a bit ugly, but will serve to differentiate
421 * wiki-borne mails from direct mails and protects against
422 * SPF and bounce problems with some mailers (see below).
424 $mailFrom = new MailAddress( $config->get( 'PasswordSender' ),
425 wfMessage( 'emailsender' )->inContentLanguage()->text() );
429 * Put the sending user's e-mail address in the From: header.
431 * This is clean-looking and convenient, but has issues.
432 * One is that it doesn't as clearly differentiate the wiki mail
433 * from "directly" sent mails.
435 * Another is that some mailers (like sSMTP) will use the From
436 * address as the envelope sender as well. For open sites this
437 * can cause mails to be flunked for SPF violations (since the
438 * wiki server isn't an authorized sender for various users'
439 * domains) as well as creating a privacy issue as bounces
440 * containing the recipient's e-mail address may get sent to
447 $status = UserMailer
::send( $to, $mailFrom, $subject, $text, [
448 'replyTo' => $replyTo,
451 if ( !$status->isGood() ) {
454 // if the user requested a copy of this mail, do this now,
455 // unless they are emailing themselves, in which case one
456 // copy of the message is sufficient.
457 if ( $data['CCMe'] && $to != $from ) {
460 $ccSubject = $context->msg( 'emailccsubject' )->rawParams(
461 $target->getName(), $subject )->text();
464 Hooks
::run( 'EmailUserCC', [ &$ccTo, &$ccFrom, &$ccSubject, &$ccText ] );
466 if ( $config->get( 'UserEmailUseReplyTo' ) ) {
467 $mailFrom = new MailAddress(
468 $config->get( 'PasswordSender' ),
469 wfMessage( 'emailsender' )->inContentLanguage()->text()
477 $ccStatus = UserMailer
::send(
478 $ccTo, $mailFrom, $ccSubject, $ccText, [
479 'replyTo' => $replyTo,
481 $status->merge( $ccStatus );
484 Hooks
::run( 'EmailUserComplete', [ $to, $from, $subject, $text ] );
491 * Return an array of subpages beginning with $search that this special page will accept.
493 * @param string $search Prefix to search for
494 * @param int $limit Maximum number of results to return (usually 10)
495 * @param int $offset Number of results to skip (usually 0)
496 * @return string[] Matching subpages
498 public function prefixSearchSubpages( $search, $limit, $offset ) {
499 $user = User
::newFromName( $search );
501 // No prefix suggestion for invalid user
504 // Autocomplete subpage as user list - public to allow caching
505 return UserNamePrefixSearch
::search( 'public', $search, $limit, $offset );
508 protected function getGroupName() {