Merge "Update docs/hooks.txt for ShowSearchHitTitle"
[mediawiki.git] / includes / specials / SpecialEmailInvalidate.php
blobc54abadd541b1b45c330f0fc8123b23e13f5dd90
1 <?php
2 /**
3 * Implements Special:EmailInvalidation
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
20 * @file
21 * @ingroup SpecialPage
24 /**
25 * Special page allows users to cancel an email confirmation using the e-mail
26 * confirmation code
28 * @ingroup SpecialPage
30 class EmailInvalidation extends UnlistedSpecialPage {
31 public function __construct() {
32 parent::__construct( 'Invalidateemail', 'editmyprivateinfo' );
35 public function doesWrites() {
36 return true;
39 function execute( $code ) {
40 // Ignore things like master queries/connections on GET requests.
41 // It's very convenient to just allow formless link usage.
42 $trxProfiler = Profiler::instance()->getTransactionProfiler();
44 $this->setHeaders();
45 $this->checkReadOnly();
46 $this->checkPermissions();
48 $old = $trxProfiler->setSilenced( true );
49 $this->attemptInvalidate( $code );
50 $trxProfiler->setSilenced( $old );
53 /**
54 * Attempt to invalidate the user's email address and show success or failure
55 * as needed; if successful, link to main page
57 * @param string $code Confirmation code
59 private function attemptInvalidate( $code ) {
60 $user = User::newFromConfirmationCode( $code, User::READ_LATEST );
61 if ( !is_object( $user ) ) {
62 $this->getOutput()->addWikiMsg( 'confirmemail_invalid' );
64 return;
67 $user->invalidateEmail();
68 $user->saveSettings();
69 $this->getOutput()->addWikiMsg( 'confirmemail_invalidated' );
71 if ( !$this->getUser()->isLoggedIn() ) {
72 $this->getOutput()->returnToMain();