X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2Fspecials%2FSpecialEmailuser.php;h=b3ba9c5cf588fbb13701c147ab418a0ca2abb70d;hb=86288855bb9f574b84c55c7f5e5dfd279b1cf9bd;hp=58e2514e0882b8c61e632491d2bb29f975965719;hpb=4ce54af762235e3509d9e733d101c328e75f94e0;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/specials/SpecialEmailuser.php b/includes/specials/SpecialEmailuser.php index 58e2514e08..b3ba9c5cf5 100644 --- a/includes/specials/SpecialEmailuser.php +++ b/includes/specials/SpecialEmailuser.php @@ -1,314 +1,324 @@ showErrorPage( 'nosuchspecialpage', 'nospecialpagetext' ); - return; + public function __construct() { + parent::__construct( 'Emailuser' ); } - $action = $wgRequest->getVal( 'action' ); - $target = isset($par) ? $par : $wgRequest->getVal( 'target' ); - $targetUser = EmailUserForm::validateEmailTarget( $target ); - - if ( !( $targetUser instanceof User ) ) { - $wgOut->showErrorPage( $targetUser.'title', $targetUser.'text' ); - return; - } - - $form = new EmailUserForm( $targetUser, - $wgRequest->getText( 'wpText' ), - $wgRequest->getText( 'wpSubject' ), - $wgRequest->getBool( 'wpCCMe' ) ); - if ( $action == 'success' ) { - $form->showSuccess(); - return; + protected function getFormFields() { + global $wgUser; + return array( + 'From' => array( + 'type' => 'info', + 'raw' => 1, + 'default' => $wgUser->getSkin()->link( + $wgUser->getUserPage(), + htmlspecialchars( $wgUser->getName() ) + ), + 'label-message' => 'emailfrom', + 'id' => 'mw-emailuser-sender', + ), + 'To' => array( + 'type' => 'info', + 'raw' => 1, + 'default' => $wgUser->getSkin()->link( + $this->mTargetObj->getUserPage(), + htmlspecialchars( $this->mTargetObj->getName() ) + ), + 'label-message' => 'emailto', + 'id' => 'mw-emailuser-recipient', + ), + 'Target' => array( + 'type' => 'hidden', + 'default' => $this->mTargetObj->getName(), + ), + 'Subject' => array( + 'type' => 'text', + 'default' => wfMsgExt( 'defemailsubject', array( 'content', 'parsemag' ) ), + 'label-message' => 'emailsubject', + 'maxlength' => 200, + 'size' => 60, + 'required' => 1, + ), + 'Text' => array( + 'type' => 'textarea', + 'rows' => 20, + 'cols' => 80, + 'label-message' => 'emailmessage', + 'required' => 1, + ), + 'CCMe' => array( + 'type' => 'check', + 'label-message' => 'emailccme', + 'default' => $wgUser->getBoolOption( 'ccmeonemails' ), + ), + ); } - - $error = EmailUserForm::getPermissionsError( $wgUser, $wgRequest->getVal( 'wpEditToken' ) ); - if ( $error ) { + + public function execute( $par ) { + global $wgRequest, $wgOut, $wgUser; + + $this->setHeaders(); + $this->outputHeader(); + $wgOut->addModuleStyles( 'mediawiki.special' ); + $this->mTarget = is_null( $par ) + ? $wgRequest->getVal( 'wpTarget', $wgRequest->getVal( 'target', '' ) ) + : $par; + // error out if sending user cannot do this + $error = self::getPermissionsError( $wgUser, $wgRequest->getVal( 'wpEditToken' ) ); switch ( $error ) { + case null: + # Wahey! + break; + case 'badaccess': + $wgOut->permissionRequired( 'sendemail' ); + return; case 'blockedemailuser': $wgOut->blockedPage(); return; case 'actionthrottledtext': $wgOut->rateLimited(); return; - case 'sessionfailure': - $form->showForm(); - return; case 'mailnologin': - $wgOut->showErrorPage( 'mailnologin', 'mailnologintext' ); + case 'usermaildisabled': + $wgOut->showErrorPage( $error, "{$error}text" ); + return; + default: + # It's a hook error + list( $title, $msg, $params ) = $error; + $wgOut->showErrorPage( $title, $msg, $params ); return; } - } - - if ( "submit" == $action && $wgRequest->wasPosted() ) { - $result = $form->doSubmit(); - - if ( !is_null( $result ) ) { - $wgOut->addHTML( wfMsg( "usermailererror" ) . - ' ' . htmlspecialchars( $result->getMessage() ) ); - } else { - $titleObj = SpecialPage::getTitleFor( "Emailuser" ); - $encTarget = wfUrlencode( $form->getTarget()->getName() ); - $wgOut->redirect( $titleObj->getFullURL( "target={$encTarget}&action=success" ) ); + // Got a valid target user name? Else ask for one. + $ret = self::getTarget( $this->mTarget ); + if( !$ret instanceof User ) { + if( $this->mTarget != '' ) { + $ret = ( $ret == 'notarget' ) ? 'emailnotarget' : ( $ret . 'text' ); + $wgOut->addHTML( '

' . wfMessage( $ret )->parse() . '

' ); + } + $wgOut->addHTML( self::userForm( $this->mTarget ) ); + return false; } - } else { - $form->showForm(); - } -} - -/** - * Implements the Special:Emailuser web interface, and invokes userMailer for sending the email message. - * @ingroup SpecialPage - */ -class EmailUserForm { - - var $target; - var $text, $subject; - var $cc_me; // Whether user requested to be sent a separate copy of their email. - - /** - * @param User $target - */ - function EmailUserForm( $target, $text, $subject, $cc_me ) { - $this->target = $target; - $this->text = $text; - $this->subject = $subject; - $this->cc_me = $cc_me; - } - function showForm() { - global $wgOut, $wgUser; - $skin = $wgUser->getSkin(); + $this->mTargetObj = $ret; - $wgOut->setPagetitle( wfMsg( "emailpage" ) ); - $wgOut->addWikiMsg( "emailpagetext" ); + $form = new HTMLForm( $this->getFormFields() ); + $form->addPreText( wfMsgExt( 'emailpagetext', 'parseinline' ) ); + $form->setSubmitText( wfMsg( 'emailsend' ) ); + $form->setTitle( $this->getTitle() ); + $form->setSubmitCallback( array( __CLASS__, 'submit' ) ); + $form->setWrapperLegend( wfMsgExt( 'email-legend', 'parsemag' ) ); + $form->loadData(); - if ( $this->subject === "" ) { - $this->subject = wfMsgExt( 'defemailsubject', array( 'content', 'parsemag' ) ); + if( !wfRunHooks( 'EmailUserForm', array( &$form ) ) ) { + return false; } - $titleObj = SpecialPage::getTitleFor( "Emailuser" ); - $action = $titleObj->getLocalURL( "target=" . - urlencode( $this->target->getName() ) . "&action=submit" ); + $wgOut->setPageTitle( wfMsg( 'emailpage' ) ); + $result = $form->show(); - $wgOut->addHTML( - Xml::openElement( 'form', array( 'method' => 'post', 'action' => $action, 'id' => 'emailuser' ) ) . - Xml::openElement( 'fieldset' ) . - Xml::element( 'legend', null, wfMsgExt( 'email-legend', 'parsemag' ) ) . - Xml::openElement( 'table', array( 'class' => 'mw-emailuser-table' ) ) . - " - " . - Xml::label( wfMsg( 'emailfrom' ), 'emailfrom' ) . - " - " . - $skin->link( $wgUser->getUserPage(), htmlspecialchars( $wgUser->getName() ) ) . - " - - - " . - Xml::label( wfMsg( 'emailto' ), 'emailto' ) . - " - " . - $skin->link( $this->target->getUserPage(), htmlspecialchars( $this->target->getName() ) ) . - " - - - " . - Xml::label( wfMsg( 'emailsubject' ), 'wpSubject' ) . - " - " . - Xml::input( 'wpSubject', 60, $this->subject, array( 'type' => 'text', 'maxlength' => 200 ) ) . - " - - - " . - Xml::label( wfMsg( 'emailmessage' ), 'wpText' ) . - " - " . - Xml::textarea( 'wpText', $this->text, 80, 20, array( 'id' => 'wpText' ) ) . - " - - - - " . - Xml::checkLabel( wfMsg( 'emailccme' ), 'wpCCMe', 'wpCCMe', $wgUser->getBoolOption( 'ccmeonemails' ) ) . - " - - - - " . - Xml::submitButton( wfMsg( 'emailsend' ), array( 'name' => 'wpSend', 'accesskey' => 's' ) ) . - " - " . - Xml::hidden( 'wpEditToken', $wgUser->editToken() ) . - Xml::closeElement( 'table' ) . - Xml::closeElement( 'fieldset' ) . - Xml::closeElement( 'form' ) - ); - } - - /* - * Really send a mail. Permissions should have been checked using - * EmailUserForm::getPermissionsError. It is probably also a good idea to - * check the edit token and ping limiter in advance. - */ - function doSubmit() { - global $wgUser, $wgUserEmailUseReplyTo, $wgSiteName; - - $to = new MailAddress( $this->target ); - $from = new MailAddress( $wgUser ); - $subject = $this->subject; - - // Add a standard footer and trim up trailing newlines - $this->text = rtrim($this->text) . "\n\n-- \n" . wfMsgExt( 'emailuserfooter', - array( 'content', 'parsemag' ), array( $from->name, $to->name ) ); - - if( wfRunHooks( 'EmailUser', array( &$to, &$from, &$subject, &$this->text ) ) ) { - - if( $wgUserEmailUseReplyTo ) { - // Put the generic wiki autogenerated address in the From: - // header and reserve the user for Reply-To. - // - // This is a bit ugly, but will serve to differentiate - // wiki-borne mails from direct mails and protects against - // SPF and bounce problems with some mailers (see below). - global $wgPasswordSender; - $mailFrom = new MailAddress( $wgPasswordSender ); - $replyTo = $from; - } else { - // Put the sending user's e-mail address in the From: header. - // - // This is clean-looking and convenient, but has issues. - // One is that it doesn't as clearly differentiate the wiki mail - // from "directly" sent mails. - // - // Another is that some mailers (like sSMTP) will use the From - // address as the envelope sender as well. For open sites this - // can cause mails to be flunked for SPF violations (since the - // wiki server isn't an authorized sender for various users' - // domains) as well as creating a privacy issue as bounces - // containing the recipient's e-mail address may get sent to - // the sending user. - $mailFrom = $from; - $replyTo = null; - } - - $mailResult = UserMailer::send( $to, $mailFrom, $subject, $this->text, $replyTo ); - - if( WikiError::isError( $mailResult ) ) { - return $mailResult; - - } else { - - // if the user requested a copy of this mail, do this now, - // unless they are emailing themselves, in which case one copy of the message is sufficient. - if ($this->cc_me && $to != $from) { - $cc_subject = wfMsg('emailccsubject', $this->target->getName(), $subject); - if( wfRunHooks( 'EmailUser', array( &$from, &$from, &$cc_subject, &$this->text ) ) ) { - $ccResult = UserMailer::send( $from, $from, $cc_subject, $this->text ); - if( WikiError::isError( $ccResult ) ) { - // At this stage, the user's CC mail has failed, but their - // original mail has succeeded. It's unlikely, but still, what to do? - // We can either show them an error, or we can say everything was fine, - // or we can say we sort of failed AND sort of succeeded. Of these options, - // simply saying there was an error is probably best. - return $ccResult; - } - } - } - - wfRunHooks( 'EmailUserComplete', array( $to, $from, $subject, $this->text ) ); - return; - } + if( $result === true || ( $result instanceof Status && $result->isGood() ) ) { + $wgOut->setPageTitle( wfMsg( 'emailsent' ) ); + $wgOut->addWikiMsg( 'emailsenttext' ); + $wgOut->returnToMain( false, $this->mTargetObj->getUserPage() ); } } - function showSuccess( &$user = null ) { - global $wgOut; - - if ( is_null($user) ) - $user = $this->target; - - $wgOut->setPagetitle( wfMsg( "emailsent" ) ); - $wgOut->addWikiMsg( 'emailsenttext' ); - - $wgOut->returnToMain( false, $user->getUserPage() ); - } - - function getTarget() { - return $this->target; - } - - static function userEmailEnabled() { - global $wgEnableEmail, $wgEnableUserEmail; - return $wgEnableEmail && $wgEnableUserEmail; - - } - static function validateEmailTarget ( $target ) { - if ( "" == $target ) { + /** + * Validate target User + * + * @param $target String: target user name + * @return User object on success or a string on error + */ + public static function getTarget( $target ) { + if ( $target == '' ) { wfDebug( "Target is empty.\n" ); - return "notarget"; - } - - $nt = Title::newFromURL( $target ); - if ( is_null( $nt ) ) { - wfDebug( "Target is invalid title.\n" ); - return "notarget"; + return 'notarget'; } - - $nu = User::newFromName( $nt->getText() ); - if( is_null( $nu ) || !$nu->getId() ) { + + $nu = User::newFromName( $target ); + if( !$nu instanceof User || !$nu->getId() ) { wfDebug( "Target is invalid user.\n" ); - return "notarget"; - } else if ( !$nu->isEmailConfirmed() ) { + return 'notarget'; + } elseif ( !$nu->isEmailConfirmed() ) { wfDebug( "User has no valid email.\n" ); - return "noemail"; - } else if ( !$nu->canReceiveEmail() ) { + return 'noemail'; + } elseif ( !$nu->canReceiveEmail() ) { wfDebug( "User does not allow user emails.\n" ); - return "nowikiemail"; + return 'nowikiemail'; } - + return $nu; } - static function getPermissionsError ( $user, $editToken ) { - if( !$user->canSendEmail() ) { - wfDebug( "User can't send.\n" ); - return "mailnologin"; + + /** + * Check whether a user is allowed to send email + * + * @param $user User object + * @param $editToken String: edit token + * @return null on success or string on error + */ + public static function getPermissionsError( $user, $editToken ) { + global $wgEnableEmail, $wgEnableUserEmail; + if( !$wgEnableEmail || !$wgEnableUserEmail ) { + return 'usermaildisabled'; + } + + if( !$user->isAllowed( 'sendemail' ) ) { + return 'badaccess'; } - + + if( !$user->isEmailConfirmed() ) { + return 'mailnologin'; + } + if( $user->isBlockedFromEmailuser() ) { wfDebug( "User is blocked from sending e-mail.\n" ); return "blockedemailuser"; } - + if( $user->pingLimiter( 'emailuser' ) ) { - wfDebug( "Ping limiter triggered.\n" ); + wfDebug( "Ping limiter triggered.\n" ); return 'actionthrottledtext'; } - - if( !$user->matchEditToken( $editToken ) ) { - wfDebug( "Matching edit token failed.\n" ); - return 'sessionfailure'; + + $hookErr = false; + wfRunHooks( 'UserCanSendEmail', array( &$user, &$hookErr ) ); + wfRunHooks( 'EmailUserPermissionsErrors', array( $user, $editToken, &$hookErr ) ); + if ( $hookErr ) { + return $hookErr; } - - return; + + return null; + } + + /** + * Form to ask for target user name. + * + * @param $name String: user name submitted. + * @return String: form asking for user name. + */ + static function userForm( $name ) { + $string = Xml::openElement( 'form', array( 'method' => 'get', 'action' => '', 'id' => 'askusername' ) ) . + Xml::openElement( 'fieldset' ) . + Html::rawElement( 'legend', null, wfMessage( 'emailtarget' )->parse() ) . + Xml::inputLabel( wfMessage( 'emailusername' )->text(), 'target', 'emailusertarget', 30, $name ) . ' ' . + Xml::submitButton( wfMessage( 'emailusernamesubmit' )->text() ) . + Xml::closeElement( 'fieldset' ) . + Xml::closeElement( 'form' ) . "\n"; + return $string; } - - static function newFromURL( $target, $text, $subject, $cc_me ) - { - $nt = Title::newFromURL( $target ); - $nu = User::newFromName( $nt->getText() ); - return new EmailUserForm( $nu, $text, $subject, $cc_me ); + + /** + * Really send a mail. Permissions should have been checked using + * getPermissionsError(). It is probably also a good + * idea to check the edit token and ping limiter in advance. + * + * @return Mixed: Status object, or potentially a String on error + * or maybe even true on success if anything uses the EmailUser hook. + */ + public static function submit( $data ) { + global $wgUser, $wgUserEmailUseReplyTo; + + $target = self::getTarget( $data['Target'] ); + if( !$target instanceof User ) { + return wfMsgExt( $target . 'text', 'parse' ); + } + $to = new MailAddress( $target ); + $from = new MailAddress( $wgUser ); + $subject = $data['Subject']; + $text = $data['Text']; + + // Add a standard footer and trim up trailing newlines + $text = rtrim( $text ) . "\n\n-- \n"; + $text .= wfMsgExt( + 'emailuserfooter', + array( 'content', 'parsemag' ), + array( $from->name, $to->name ) + ); + + $error = ''; + if( !wfRunHooks( 'EmailUser', array( &$to, &$from, &$subject, &$text, &$error ) ) ) { + return $error; + } + + if( $wgUserEmailUseReplyTo ) { + // Put the generic wiki autogenerated address in the From: + // header and reserve the user for Reply-To. + // + // This is a bit ugly, but will serve to differentiate + // wiki-borne mails from direct mails and protects against + // SPF and bounce problems with some mailers (see below). + global $wgPasswordSender, $wgPasswordSenderName; + $mailFrom = new MailAddress( $wgPasswordSender, $wgPasswordSenderName ); + $replyTo = $from; + } else { + // Put the sending user's e-mail address in the From: header. + // + // This is clean-looking and convenient, but has issues. + // One is that it doesn't as clearly differentiate the wiki mail + // from "directly" sent mails. + // + // Another is that some mailers (like sSMTP) will use the From + // address as the envelope sender as well. For open sites this + // can cause mails to be flunked for SPF violations (since the + // wiki server isn't an authorized sender for various users' + // domains) as well as creating a privacy issue as bounces + // containing the recipient's e-mail address may get sent to + // the sending user. + $mailFrom = $from; + $replyTo = null; + } + + $status = UserMailer::send( $to, $mailFrom, $subject, $text, $replyTo ); + + if( !$status->isGood() ) { + return $status; + } else { + // if the user requested a copy of this mail, do this now, + // unless they are emailing themselves, in which case one + // copy of the message is sufficient. + if ( $data['CCMe'] && $to != $from ) { + $cc_subject = wfMsg( + 'emailccsubject', + $target->getName(), + $subject + ); + wfRunHooks( 'EmailUserCC', array( &$from, &$from, &$cc_subject, &$text ) ); + $ccStatus = UserMailer::send( $from, $from, $cc_subject, $text ); + $status->merge( $ccStatus ); + } + + wfRunHooks( 'EmailUserComplete', array( $to, $from, $subject, $text ) ); + return $status; + } } }