Go to the documentation of this file.
44 parent::__construct(
'BotPasswords',
'editmyprivateinfo' );
51 return $this->
getConfig()->get(
'EnableBotPasswords' );
63 if ( strlen(
$par ) === 0 ) {
66 throw new ErrorPageError(
'botpasswords',
'botpasswords-bad-appid',
67 [ htmlspecialchars(
$par ) ] );
74 parent::checkExecutePermissions(
$user );
76 if ( !$this->
getConfig()->
get(
'EnableBotPasswords' ) ) {
77 throw new ErrorPageError(
'botpasswords',
'botpasswords-disabled' );
81 if ( !$this->userId ) {
82 throw new ErrorPageError(
'botpasswords',
'botpasswords-no-central-id' );
89 if ( $this->par !==
null ) {
91 if ( !$this->botPassword ) {
93 'centralId' => $this->userId,
94 'appId' => $this->par,
101 'label-message' =>
'username',
105 if ( $this->botPassword->isSaved() ) {
106 $fields[
'resetPassword'] = [
108 'label-message' =>
'botpasswords-label-resetpassword',
114 $fields[
'grants'] = [
115 'type' =>
'checkmatrix',
116 'label-message' =>
'botpasswords-label-grants',
117 'help-message' =>
'botpasswords-help-grants',
119 $this->
msg(
'botpasswords-label-grants-column' )->escaped() =>
'grant'
121 'rows' => array_combine(
122 array_map(
'MWGrants::getGrantsLink', $showGrants ),
125 'default' => array_map(
129 $this->botPassword->getGrants()
131 'tooltips' => array_combine(
132 array_map(
'MWGrants::getGrantsLink', $showGrants ),
134 function ( $rights )
use (
$lang ) {
135 return $lang->semicolonList( array_map(
'User::getRightDescription', $rights ) );
140 'force-options-on' => array_map(
148 $fields[
'restrictions'] = [
149 'class' =>
'HTMLRestrictionsField',
151 'default' => $this->botPassword->getRestrictions(),
160 [
'bp_user' => $this->userId ],
163 foreach (
$res as $row ) {
165 'section' =>
'existing',
176 'section' =>
'createnew',
177 'type' =>
'textwithbutton',
178 'label-message' =>
'botpasswords-label-appid',
179 'buttondefault' => $this->
msg(
'botpasswords-label-create' )->text(),
180 'buttonflags' => [
'progressive',
'primary' ],
184 'validation-callback' =>
function ( $v ) {
201 $form->
setId(
'mw-botpasswords-form' );
203 $form->
addPreText( $this->
msg(
'botpasswords-summary' )->parseAsBlock() );
206 if ( $this->par !==
null ) {
207 if ( $this->botPassword->isSaved() ) {
212 'label-message' =>
'botpasswords-label-update',
213 'flags' => [
'primary',
'progressive' ],
218 'label-message' =>
'botpasswords-label-delete',
219 'flags' => [
'destructive' ],
226 'label-message' =>
'botpasswords-label-create',
227 'flags' => [
'primary',
'progressive' ],
234 'label-message' =>
'botpasswords-label-cancel'
240 $op = $this->
getRequest()->getVal(
'op',
'' );
248 $this->operation =
'insert';
249 return $this->
save( $data );
252 $this->operation =
'update';
253 return $this->
save( $data );
256 $this->operation =
'delete';
273 'centralId' => $this->userId,
274 'appId' => $this->par,
275 'restrictions' => $data[
'restrictions'],
276 'grants' => array_merge(
278 preg_replace(
'/^grant-/',
'', $data[
'grants'] )
282 if ( $this->operation ===
'insert' || !empty( $data[
'resetPassword'] ) ) {
286 $password = $passwordFactory->newFromPlaintext( $this->password );
291 if ( $bp->save( $this->operation,
$password ) ) {
295 return Status::newFatal(
"botpasswords-{$this->operation}-failed", $this->par );
303 switch ( $this->operation ) {
305 $out->setPageTitle( $this->
msg(
'botpasswords-created-title' )->
text() );
306 $out->addWikiMsg(
'botpasswords-created-body', $this->par,
$username );
310 $out->setPageTitle( $this->
msg(
'botpasswords-updated-title' )->
text() );
311 $out->addWikiMsg(
'botpasswords-updated-body', $this->par,
$username );
315 $out->setPageTitle( $this->
msg(
'botpasswords-deleted-title' )->
text() );
316 $out->addWikiMsg(
'botpasswords-deleted-body', $this->par,
$username );
317 $this->password =
null;
321 if ( $this->password !==
null ) {
324 'botpasswords-newpassword',
325 htmlspecialchars(
$username . $sep . $this->par ),
326 htmlspecialchars( $this->password ),
328 htmlspecialchars( $this->par . $sep . $this->password )
330 $this->password =
null;
getPageTitle( $subpage=false)
Get a self-referential title object.
Let users manage bot passwords.
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 account $user
msg( $key)
Wrapper around wfMessage that sets the current context.
getOutput()
Get the OutputPage being used for this instance.
if(!isset( $args[0])) $lang
checkExecutePermissions(User $user)
Called from execute() to check if the given user can perform this action.
Utility class for bot passwords.
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
static getSeparator()
Get the separator for combined user name + app ID.
static generatePassword( $config)
Returns a (raw, unhashed) random password string.
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
static newFatal( $message)
Factory function for fatal errors.
Special page which uses an HTMLForm to handle processing.
getFormFields()
Get an HTMLForm descriptor array.
static getDB( $db)
Get a database connection for the bot passwords database.
getLanguage()
Shortcut to get user's language.
static getHiddenGrants()
Get the list of grants that are hidden and should always be granted.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
getConfig()
Shortcut to get main config object.
static newUnsaved(array $data, $flags=self::READ_NORMAL)
Create an unsaved BotPassword.
onSuccess()
Do something exciting on successful processing of the form, most likely to show a confirmation messag...
getUser()
Shortcut to get the User executing this instance.
static getValidGrants()
List all known grants.
getDisplayFormat()
Get display format for the form.
alterForm(HTMLForm $form)
Play with the HTMLForm if you need to more substantially.
requireLogin( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
If the user is not logged in, throws UserNotLoggedIn error.
string $password
New password set, for communication between onSubmit() and onSuccess()
static newGood( $value=null)
Factory function for good results.
string $par
The sub-page of the special page.
getRequest()
Get the WebRequest being used for this instance.
static getMain()
Static methods.
static newFromCentralId( $centralId, $appId, $flags=self::READ_NORMAL)
Load a BotPassword from the database.
int $userId
Central user ID.
static getRightsByGrant()
Map all grants to corresponding user rights.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
onSubmit(array $data)
Process the form on POST submission.
Factory class for creating and checking Password objects.
MediaWiki Linker LinkRenderer null $linkRenderer
string $operation
Operation being performed: create, update, delete.
An error page which can definitely be safely rendered using the OutputPage.
static factory( $providerId=null)
Fetch a CentralIdLookup.
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
this hook is for auditing only or null if authentication failed before getting that far $username
execute( $par)
Main execution point.
BotPassword null $botPassword
Bot password being edited, if any.
the array() calling protocol came about after MediaWiki 1.4rc1.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out