MediaWiki REL1_31
SpecialOATHDisable.php
Go to the documentation of this file.
1<?php
27
29 private $OATHUser;
30
37 public function __construct( OATHUserRepository $repository, OATHUser $user ) {
38 parent::__construct( 'OATH', '', false );
39 $this->OATHRepository = $repository;
40 $this->OATHUser = $user;
41 }
42
43 public function doesWrites() {
44 return true;
45 }
46
52 public function alterForm( HTMLForm $form ) {
53 $form->setMessagePrefix( 'oathauth' );
54 $form->setWrapperLegend( false );
55 $form->getOutput()->setPageTitle( $this->msg( 'oathauth-disable' ) );
56 }
57
61 protected function getDisplayFormat() {
62 return 'ooui';
63 }
64
68 public function requiresUnblock() {
69 return false;
70 }
71
79 protected function checkExecutePermissions( User $user ) {
80 parent::checkExecutePermissions( $user );
81
82 $this->requireLogin();
83 }
84
88 public function execute( $par ) {
89 $this->getOutput()->disallowUserJs();
90 parent::execute( $par );
91 }
92
96 protected function getFormFields() {
97 return [
98 'token' => [
99 'type' => 'text',
100 'label-message' => 'oathauth-entertoken',
101 'name' => 'token',
102 'required' => true,
103 'autofocus' => true,
104 ],
105 'returnto' => [
106 'type' => 'hidden',
107 'default' => $this->getRequest()->getVal( 'returnto' ),
108 'name' => 'returnto',
109 ],
110 'returntoquery' => [
111 'type' => 'hidden',
112 'default' => $this->getRequest()->getVal( 'returntoquery' ),
113 'name' => 'returntoquery',
114 ]
115 ];
116 }
117
123 public function onSubmit( array $formData ) {
124 // Don't increase pingLimiter, just check for limit exceeded.
125 if ( $this->OATHUser->getUser()->pingLimiter( 'badoath', 0 ) ) {
126 // Arbitrary duration given here
127 return [ 'oathauth-throttled', Message::durationParam( 60 ) ];
128 }
129
130 if ( !$this->OATHUser->getKey()->verifyToken( $formData['token'], $this->OATHUser ) ) {
131 return [ 'oathauth-failedtovalidateoath' ];
132 }
133
134 $this->OATHUser->setKey( null );
135 $this->OATHRepository->remove( $this->OATHUser );
136
137 return true;
138 }
139
140 public function onSuccess() {
141 $this->getOutput()->addWikiMsg( 'oathauth-disabledoath' );
142 $this->getOutput()->returnToMain();
143 }
144}
Special page which uses an HTMLForm to handle processing.
string $par
The sub-page of the special page.
Object handling generic submission, CSRF protection, layout and other logic for UI forms.
Definition HTMLForm.php:130
This program is free software; you can redistribute it and/or modify it under the terms of the GNU Ge...
Definition OATHUser.php:24
getKey()
Get the key associated with this user.
Definition OATHUser.php:71
setKey(OATHAuthKey $key=null)
Set the key associated with this user.
Definition OATHUser.php:80
This program is free software; you can redistribute it and/or modify it under the terms of the GNU Ge...
checkExecutePermissions(User $user)
Require users to be logged in.
__construct(OATHUserRepository $repository, OATHUser $user)
Initialize the OATH user based on the current local User object in the context.
onSubmit(array $formData)
doesWrites()
Indicates whether this special page may perform database writes.
onSuccess()
Do something exciting on successful processing of the form, most likely to show a confirmation messag...
alterForm(HTMLForm $form)
Set the page title and add JavaScript RL modules.
OATHUserRepository $OATHRepository
getOutput()
Get the OutputPage being used for this instance.
requireLogin( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
If the user is not logged in, throws UserNotLoggedIn error.
msg( $key)
Wrapper around wfMessage that sets the current context.
getRequest()
Get the WebRequest being used for this instance.
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition User.php:53
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition hooks.txt:247