includes/specials/SpecialChangeEmail.php

   1 <?php
   2 /**
   3  * Implements Special:ChangeEmail
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @file
  21  * @ingroup SpecialPage
  22  */
  23
  24 /**
  25  * Let users change their email address.
  26  *
  27  * @ingroup SpecialPage
  28  */
  29 class SpecialChangeEmail extends FormSpecialPage {
  30         /**
  31          * @var Status
  32          */
  33         private $status;
  34
  35         public function __construct() {
  36                 parent::__construct( 'ChangeEmail', 'editmyprivateinfo' );
  37         }
  38
  39         /**
  40          * @return bool
  41          */
  42         public function isListed() {
  43                 global $wgAuth;
  44
  45                 return $wgAuth->allowPropChange( 'emailaddress' );
  46         }
  47
  48         /**
  49          * Main execution point
  50          * @param string $par
  51          */
  52         function execute( $par ) {
  53                 $out = $this->getOutput();
  54                 $out->disallowUserJs();
  55                 $out->addModules( 'mediawiki.special.changeemail' );
  56
  57                 parent::execute( $par );
  58         }
  59
  60         protected function checkExecutePermissions( User $user ) {
  61                 global $wgAuth;
  62
  63                 if ( !$wgAuth->allowPropChange( 'emailaddress' ) ) {
  64                         throw new ErrorPageError( 'changeemail', 'cannotchangeemail' );
  65                 }
  66
  67                 $this->requireLogin( 'changeemail-no-info' );
  68
  69                 // This could also let someone check the current email address, so
  70                 // require both permissions.
  71                 if ( !$this->getUser()->isAllowed( 'viewmyprivateinfo' ) ) {
  72                         throw new PermissionsError( 'viewmyprivateinfo' );
  73                 }
  74
  75                 parent::checkExecutePermissions( $user );
  76         }
  77
  78         protected function getFormFields() {
  79                 $user = $this->getUser();
  80
  81                 $fields = array(
  82                         'Name' => array(
  83                                 'type' => 'info',
  84                                 'label-message' => 'username',
  85                                 'default' => $user->getName(),
  86                         ),
  87                         'OldEmail' => array(
  88                                 'type' => 'info',
  89                                 'label-message' => 'changeemail-oldemail',
  90                                 'default' => $user->getEmail() ?: $this->msg( 'changeemail-none' )->text(),
  91                         ),
  92                         'NewEmail' => array(
  93                                 'type' => 'email',
  94                                 'label-message' => 'changeemail-newemail',
  95                         ),
  96                 );
  97
  98                 if ( $this->getConfig()->get( 'RequirePasswordforEmailChange' ) ) {
  99                         $fields['Password'] = array(
 100                                 'type' => 'password',
 101                                 'label-message' => 'changeemail-password',
 102                                 'autofocus' => true,
 103                         );
 104                 }
 105
 106                 return $fields;
 107         }
 108
 109         protected function getDisplayFormat() {
 110                 return 'vform';
 111         }
 112
 113         protected function alterForm( HTMLForm $form ) {
 114                 $form->setId( 'mw-changeemail-form' );
 115                 $form->setTableId( 'mw-changeemail-table' );
 116                 $form->setSubmitTextMsg( 'changeemail-submit' );
 117                 $form->addHiddenFields( $this->getRequest()->getValues( 'returnto', 'returntoquery' ) );
 118         }
 119
 120         public function onSubmit( array $data ) {
 121                 $password = isset( $data['Password'] ) ? $data['Password'] : null;
 122                 $status = $this->attemptChange( $this->getUser(), $password, $data['NewEmail'] );
 123
 124                 $this->status = $status;
 125
 126                 return $status;
 127         }
 128
 129         public function onSuccess() {
 130                 $request = $this->getRequest();
 131
 132                 $titleObj = Title::newFromText( $request->getVal( 'returnto' ) );
 133                 if ( !$titleObj instanceof Title ) {
 134                         $titleObj = Title::newMainPage();
 135                 }
 136                 $query = $request->getVal( 'returntoquery' );
 137
 138                 if ( $this->status->value === true ) {
 139                         $this->getOutput()->redirect( $titleObj->getFullURL( $query ) );
 140                 } elseif ( $this->status->value === 'eauth' ) {
 141                         # Notify user that a confirmation email has been sent...
 142                         $this->getOutput()->wrapWikiMsg( "<div class='error' style='clear: both;'>\n$1\n</div>",
 143                                 'eauthentsent', $this->getUser()->getName() );
 144                         // just show the link to go back
 145                         $this->getOutput()->addReturnTo( $titleObj, wfCgiToArray( $query ) );
 146                 }
 147         }
 148
 149         /**
 150          * @param User $user
 151          * @param string $pass
 152          * @param string $newaddr
 153          * @return Status
 154          */
 155         private function attemptChange( User $user, $pass, $newaddr ) {
 156                 global $wgAuth;
 157
 158                 if ( $newaddr != '' && !Sanitizer::validateEmail( $newaddr ) ) {
 159                         return Status::newFatal( 'invalidemailaddress' );
 160                 }
 161
 162                 $throttleCount = LoginForm::incLoginThrottle( $user->getName() );
 163                 if ( $throttleCount === true ) {
 164                         $lang = $this->getLanguage();
 165                         $throttleInfo = $this->getConfig()->get( 'PasswordAttemptThrottle' );
 166                         return Status::newFatal(
 167                                 'changeemail-throttled',
 168                                 $lang->formatDuration( $throttleInfo['seconds'] )
 169                         );
 170                 }
 171
 172                 if ( $this->getConfig()->get( 'RequirePasswordforEmailChange' )
 173                         && !$user->checkTemporaryPassword( $pass )
 174                         && !$user->checkPassword( $pass )
 175                 ) {
 176                         return Status::newFatal( 'wrongpassword' );
 177                 }
 178
 179                 if ( $throttleCount ) {
 180                         LoginForm::clearLoginThrottle( $user->getName() );
 181                 }
 182
 183                 $oldaddr = $user->getEmail();
 184                 $status = $user->setEmailWithConfirmation( $newaddr );
 185                 if ( !$status->isGood() ) {
 186                         return $status;
 187                 }
 188
 189                 Hooks::run( 'PrefsEmailAudit', array( $user, $oldaddr, $newaddr ) );
 190
 191                 $user->saveSettings();
 192
 193                 $wgAuth->updateExternalDB( $user );
 194
 195                 return $status;
 196         }
 197
 198         public function requiresUnblock() {
 199                 return false;
 200         }
 201
 202         protected function getGroupName() {
 203                 return 'users';
 204         }
 205 }