includes/specials/SpecialConfirmemail.php

   1 <?php
   2 /**
   3  * Implements Special:Confirmemail and Special:Invalidateemail
   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  * Special page allows users to request email confirmation message, and handles
  26  * processing of the confirmation code when the link in the email is followed
  27  *
  28  * @ingroup SpecialPage
  29  * @author Brion Vibber
  30  * @author Rob Church <robchur@gmail.com>
  31  */
  32 class EmailConfirmation extends UnlistedSpecialPage {
  33         public function __construct() {
  34                 parent::__construct( 'Confirmemail', 'editmyprivateinfo' );
  35         }
  36
  37         /**
  38          * Main execution point
  39          *
  40          * @param null|string $code Confirmation code passed to the page
  41          * @throws PermissionsError
  42          * @throws ReadOnlyError
  43          * @throws UserNotLoggedIn
  44          */
  45         function execute( $code ) {
  46                 $this->setHeaders();
  47
  48                 $this->checkReadOnly();
  49                 $this->checkPermissions();
  50
  51                 $this->requireLogin( 'confirmemail_needlogin' );
  52
  53                 // This could also let someone check the current email address, so
  54                 // require both permissions.
  55                 if ( !$this->getUser()->isAllowed( 'viewmyprivateinfo' ) ) {
  56                         throw new PermissionsError( 'viewmyprivateinfo' );
  57                 }
  58
  59                 if ( $code === null || $code === '' ) {
  60                         if ( Sanitizer::validateEmail( $this->getUser()->getEmail() ) ) {
  61                                 $this->showRequestForm();
  62                         } else {
  63                                 $this->getOutput()->addWikiMsg( 'confirmemail_noemail' );
  64                         }
  65                 } else {
  66                         $this->attemptConfirm( $code );
  67                 }
  68         }
  69
  70         /**
  71          * Show a nice form for the user to request a confirmation mail
  72          */
  73         function showRequestForm() {
  74                 $user = $this->getUser();
  75                 $out = $this->getOutput();
  76
  77                 if ( $this->getRequest()->wasPosted() &&
  78                         $user->matchEditToken( $this->getRequest()->getText( 'token' ) )
  79                 ) {
  80                         $status = $user->sendConfirmationMail();
  81                         if ( $status->isGood() ) {
  82                                 $out->addWikiMsg( 'confirmemail_sent' );
  83                         } else {
  84                                 $out->addWikiText( $status->getWikiText( 'confirmemail_sendfailed' ) );
  85                         }
  86                 } elseif ( $user->isEmailConfirmed() ) {
  87                         // date and time are separate parameters to facilitate localisation.
  88                         // $time is kept for backward compat reasons.
  89                         // 'emailauthenticated' is also used in SpecialPreferences.php
  90                         $lang = $this->getLanguage();
  91                         $emailAuthenticated = $user->getEmailAuthenticationTimestamp();
  92                         $time = $lang->userTimeAndDate( $emailAuthenticated, $user );
  93                         $d = $lang->userDate( $emailAuthenticated, $user );
  94                         $t = $lang->userTime( $emailAuthenticated, $user );
  95                         $out->addWikiMsg( 'emailauthenticated', $time, $d, $t );
  96                 } else {
  97                         if ( $user->isEmailConfirmationPending() ) {
  98                                 $out->wrapWikiMsg(
  99                                         "<div class=\"error mw-confirmemail-pending\">\n$1\n</div>",
 100                                         'confirmemail_pending'
 101                                 );
 102                         }
 103
 104                         $out->addWikiMsg( 'confirmemail_text' );
 105                         $form = Html::openElement(
 106                                 'form',
 107                                 array( 'method' => 'post', 'action' => $this->getPageTitle()->getLocalURL() )
 108                         ) . "\n";
 109                         $form .= Html::hidden( 'token', $user->getEditToken() ) . "\n";
 110                         $form .= Xml::submitButton( $this->msg( 'confirmemail_send' )->text() ) . "\n";
 111                         $form .= Html::closeElement( 'form' ) . "\n";
 112                         $out->addHTML( $form );
 113                 }
 114         }
 115
 116         /**
 117          * Attempt to confirm the user's email address and show success or failure
 118          * as needed; if successful, take the user to log in
 119          *
 120          * @param string $code Confirmation code
 121          */
 122         function attemptConfirm( $code ) {
 123                 $user = User::newFromConfirmationCode( $code );
 124                 if ( !is_object( $user ) ) {
 125                         $this->getOutput()->addWikiMsg( 'confirmemail_invalid' );
 126
 127                         return;
 128                 }
 129
 130                 $user->confirmEmail();
 131                 $user->saveSettings();
 132                 $message = $this->getUser()->isLoggedIn() ? 'confirmemail_loggedin' : 'confirmemail_success';
 133                 $this->getOutput()->addWikiMsg( $message );
 134
 135                 if ( !$this->getUser()->isLoggedIn() ) {
 136                         $title = SpecialPage::getTitleFor( 'Userlogin' );
 137                         $this->getOutput()->returnToMain( true, $title );
 138                 }
 139         }
 140 }
 141
 142 /**
 143  * Special page allows users to cancel an email confirmation using the e-mail
 144  * confirmation code
 145  *
 146  * @ingroup SpecialPage
 147  */
 148 class EmailInvalidation extends UnlistedSpecialPage {
 149         public function __construct() {
 150                 parent::__construct( 'Invalidateemail', 'editmyprivateinfo' );
 151         }
 152
 153         function execute( $code ) {
 154                 $this->setHeaders();
 155                 $this->checkReadOnly();
 156                 $this->checkPermissions();
 157                 $this->attemptInvalidate( $code );
 158         }
 159
 160         /**
 161          * Attempt to invalidate the user's email address and show success or failure
 162          * as needed; if successful, link to main page
 163          *
 164          * @param string $code Confirmation code
 165          */
 166         function attemptInvalidate( $code ) {
 167                 $user = User::newFromConfirmationCode( $code );
 168                 if ( !is_object( $user ) ) {
 169                         $this->getOutput()->addWikiMsg( 'confirmemail_invalid' );
 170
 171                         return;
 172                 }
 173
 174                 $user->invalidateEmail();
 175                 $user->saveSettings();
 176                 $this->getOutput()->addWikiMsg( 'confirmemail_invalidated' );
 177
 178                 if ( !$this->getUser()->isLoggedIn() ) {
 179                         $this->getOutput()->returnToMain();
 180                 }
 181         }
 182 }