MediaWiki  master
SpecialUserrights.php
Go to the documentation of this file.
1 <?php
29 class UserrightsPage extends SpecialPage {
36  protected $mTarget;
37  /*
38  * @var null|User $mFetchedUser The user object of the target username or null.
39  */
40  protected $mFetchedUser = null;
41  protected $isself = false;
42 
43  public function __construct() {
44  parent::__construct( 'Userrights' );
45  }
46 
47  public function doesWrites() {
48  return true;
49  }
50 
60  public function userCanChangeRights( $targetUser, $checkIfSelf = true ) {
61  $isself = $this->getUser()->equals( $targetUser );
62 
63  $available = $this->changeableGroups();
64  if ( $targetUser->getId() === 0 ) {
65  return false;
66  }
67 
68  if ( $available['add'] || $available['remove'] ) {
69  // can change some rights for any user
70  return true;
71  }
72 
73  if ( ( $available['add-self'] || $available['remove-self'] )
74  && ( $isself || !$checkIfSelf )
75  ) {
76  // can change some rights for self
77  return true;
78  }
79 
80  return false;
81  }
82 
90  public function execute( $par ) {
91  $user = $this->getUser();
92  $request = $this->getRequest();
93  $session = $request->getSession();
94  $out = $this->getOutput();
95 
96  $out->addModules( [ 'mediawiki.special.userrights' ] );
97 
98  $this->mTarget = $par ?? $request->getVal( 'user' );
99 
100  if ( is_string( $this->mTarget ) ) {
101  $this->mTarget = trim( $this->mTarget );
102  }
103 
104  if ( $this->mTarget !== null && User::getCanonicalName( $this->mTarget ) === $user->getName() ) {
105  $this->isself = true;
106  }
107 
108  $fetchedStatus = $this->fetchUser( $this->mTarget, true );
109  if ( $fetchedStatus->isOK() ) {
110  $this->mFetchedUser = $fetchedStatus->value;
111  if ( $this->mFetchedUser instanceof User ) {
112  // Set the 'relevant user' in the skin, so it displays links like Contributions,
113  // User logs, UserRights, etc.
114  $this->getSkin()->setRelevantUser( $this->mFetchedUser );
115  }
116  }
117 
118  // show a successbox, if the user rights was saved successfully
119  if (
120  $session->get( 'specialUserrightsSaveSuccess' ) &&
121  $this->mFetchedUser !== null
122  ) {
123  // Remove session data for the success message
124  $session->remove( 'specialUserrightsSaveSuccess' );
125 
126  $out->addModuleStyles( 'mediawiki.notification.convertmessagebox.styles' );
127  $out->addHTML(
129  'div',
130  [
131  'class' => 'mw-notify-success successbox',
132  'id' => 'mw-preferences-success',
133  'data-mw-autohide' => 'false',
134  ],
136  'p',
137  [],
138  $this->msg( 'savedrights', $this->mFetchedUser->getName() )->text()
139  )
140  )
141  );
142  }
143 
144  $this->setHeaders();
145  $this->outputHeader();
146 
147  $out->addModuleStyles( 'mediawiki.special' );
148  $this->addHelpLink( 'Help:Assigning permissions' );
149 
150  $this->switchForm();
151 
152  if (
153  $request->wasPosted() &&
154  $request->getCheck( 'saveusergroups' ) &&
155  $this->mTarget !== null &&
156  $user->matchEditToken( $request->getVal( 'wpEditToken' ), $this->mTarget )
157  ) {
158  /*
159  * If the user is blocked and they only have "partial" access
160  * (e.g. they don't have the userrights permission), then don't
161  * allow them to change any user rights.
162  */
163  if ( !$user->isAllowed( 'userrights' ) ) {
164  $block = $user->getBlock();
165  if ( $block && $block->isSitewide() ) {
166  throw new UserBlockedError( $block );
167  }
168  }
169 
170  $this->checkReadOnly();
171 
172  // save settings
173  if ( !$fetchedStatus->isOK() ) {
174  $this->getOutput()->addWikiTextAsInterface( $fetchedStatus->getWikiText() );
175 
176  return;
177  }
178 
179  $targetUser = $this->mFetchedUser;
180  if ( $targetUser instanceof User ) { // UserRightsProxy doesn't have this method (T63252)
181  $targetUser->clearInstanceCache(); // T40989
182  }
183 
184  $conflictCheck = $request->getVal( 'conflictcheck-originalgroups' );
185  $conflictCheck = ( $conflictCheck === '' ) ? [] : explode( ',', $conflictCheck );
186  $userGroups = $targetUser->getGroups();
187 
188  if ( $userGroups !== $conflictCheck ) {
189  $out->wrapWikiMsg( '<span class="error">$1</span>', 'userrights-conflict' );
190  } else {
191  $status = $this->saveUserGroups(
192  $this->mTarget,
193  $request->getVal( 'user-reason' ),
194  $targetUser
195  );
196 
197  if ( $status->isOK() ) {
198  // Set session data for the success message
199  $session->set( 'specialUserrightsSaveSuccess', 1 );
200 
201  $out->redirect( $this->getSuccessURL() );
202  return;
203  } else {
204  // Print an error message and redisplay the form
205  $out->wrapWikiTextAsInterface( 'error', $status->getWikiText() );
206  }
207  }
208  }
209 
210  // show some more forms
211  if ( $this->mTarget !== null ) {
212  $this->editUserGroupsForm( $this->mTarget );
213  }
214  }
215 
216  function getSuccessURL() {
217  return $this->getPageTitle( $this->mTarget )->getFullURL();
218  }
219 
226  public function canProcessExpiries() {
227  return true;
228  }
229 
239  public static function expiryToTimestamp( $expiry ) {
240  if ( wfIsInfinity( $expiry ) ) {
241  return null;
242  }
243 
244  $unix = strtotime( $expiry );
245 
246  if ( !$unix || $unix === -1 ) {
247  return false;
248  }
249 
250  // @todo FIXME: Non-qualified absolute times are not in users specified timezone
251  // and there isn't notice about it in the ui (see ProtectionForm::getExpiry)
252  return wfTimestamp( TS_MW, $unix );
253  }
254 
264  protected function saveUserGroups( $username, $reason, $user ) {
265  $allgroups = $this->getAllGroups();
266  $addgroup = [];
267  $groupExpiries = []; // associative array of (group name => expiry)
268  $removegroup = [];
269  $existingUGMs = $user->getGroupMemberships();
270 
271  // This could possibly create a highly unlikely race condition if permissions are changed between
272  // when the form is loaded and when the form is saved. Ignoring it for the moment.
273  foreach ( $allgroups as $group ) {
274  // We'll tell it to remove all unchecked groups, and add all checked groups.
275  // Later on, this gets filtered for what can actually be removed
276  if ( $this->getRequest()->getCheck( "wpGroup-$group" ) ) {
277  $addgroup[] = $group;
278 
279  if ( $this->canProcessExpiries() ) {
280  // read the expiry information from the request
281  $expiryDropdown = $this->getRequest()->getVal( "wpExpiry-$group" );
282  if ( $expiryDropdown === 'existing' ) {
283  continue;
284  }
285 
286  if ( $expiryDropdown === 'other' ) {
287  $expiryValue = $this->getRequest()->getVal( "wpExpiry-$group-other" );
288  } else {
289  $expiryValue = $expiryDropdown;
290  }
291 
292  // validate the expiry
293  $groupExpiries[$group] = self::expiryToTimestamp( $expiryValue );
294 
295  if ( $groupExpiries[$group] === false ) {
296  return Status::newFatal( 'userrights-invalid-expiry', $group );
297  }
298 
299  // not allowed to have things expiring in the past
300  if ( $groupExpiries[$group] && $groupExpiries[$group] < wfTimestampNow() ) {
301  return Status::newFatal( 'userrights-expiry-in-past', $group );
302  }
303 
304  // if the user can only add this group (not remove it), the expiry time
305  // cannot be brought forward (T156784)
306  if ( !$this->canRemove( $group ) &&
307  isset( $existingUGMs[$group] ) &&
308  ( $existingUGMs[$group]->getExpiry() ?: 'infinity' ) >
309  ( $groupExpiries[$group] ?: 'infinity' )
310  ) {
311  return Status::newFatal( 'userrights-cannot-shorten-expiry', $group );
312  }
313  }
314  } else {
315  $removegroup[] = $group;
316  }
317  }
318 
319  $this->doSaveUserGroups( $user, $addgroup, $removegroup, $reason, [], $groupExpiries );
320 
321  return Status::newGood();
322  }
323 
337  function doSaveUserGroups( $user, array $add, array $remove, $reason = '',
338  array $tags = [], array $groupExpiries = []
339  ) {
340  // Validate input set...
341  $isself = $user->getName() == $this->getUser()->getName();
342  $groups = $user->getGroups();
343  $ugms = $user->getGroupMemberships();
344  $changeable = $this->changeableGroups();
345  $addable = array_merge( $changeable['add'], $isself ? $changeable['add-self'] : [] );
346  $removable = array_merge( $changeable['remove'], $isself ? $changeable['remove-self'] : [] );
347 
348  $remove = array_unique(
349  array_intersect( (array)$remove, $removable, $groups ) );
350  $add = array_intersect( (array)$add, $addable );
351 
352  // add only groups that are not already present or that need their expiry updated,
353  // UNLESS the user can only add this group (not remove it) and the expiry time
354  // is being brought forward (T156784)
355  $add = array_filter( $add,
356  function ( $group ) use ( $groups, $groupExpiries, $removable, $ugms ) {
357  if ( isset( $groupExpiries[$group] ) &&
358  !in_array( $group, $removable ) &&
359  isset( $ugms[$group] ) &&
360  ( $ugms[$group]->getExpiry() ?: 'infinity' ) >
361  ( $groupExpiries[$group] ?: 'infinity' )
362  ) {
363  return false;
364  }
365  return !in_array( $group, $groups ) || array_key_exists( $group, $groupExpiries );
366  } );
367 
368  Hooks::run( 'ChangeUserGroups', [ $this->getUser(), $user, &$add, &$remove ] );
369 
370  $oldGroups = $groups;
371  $oldUGMs = $user->getGroupMemberships();
372  $newGroups = $oldGroups;
373 
374  // Remove groups, then add new ones/update expiries of existing ones
375  if ( $remove ) {
376  foreach ( $remove as $index => $group ) {
377  if ( !$user->removeGroup( $group ) ) {
378  unset( $remove[$index] );
379  }
380  }
381  $newGroups = array_diff( $newGroups, $remove );
382  }
383  if ( $add ) {
384  foreach ( $add as $index => $group ) {
385  $expiry = $groupExpiries[$group] ?? null;
386  if ( !$user->addGroup( $group, $expiry ) ) {
387  unset( $add[$index] );
388  }
389  }
390  $newGroups = array_merge( $newGroups, $add );
391  }
392  $newGroups = array_unique( $newGroups );
393  $newUGMs = $user->getGroupMemberships();
394 
395  // Ensure that caches are cleared
396  $user->invalidateCache();
397 
398  // update groups in external authentication database
399  Hooks::run( 'UserGroupsChanged', [ $user, $add, $remove, $this->getUser(),
400  $reason, $oldUGMs, $newUGMs ] );
401 
402  wfDebug( 'oldGroups: ' . print_r( $oldGroups, true ) . "\n" );
403  wfDebug( 'newGroups: ' . print_r( $newGroups, true ) . "\n" );
404  wfDebug( 'oldUGMs: ' . print_r( $oldUGMs, true ) . "\n" );
405  wfDebug( 'newUGMs: ' . print_r( $newUGMs, true ) . "\n" );
406 
407  // Only add a log entry if something actually changed
408  if ( $newGroups != $oldGroups || $newUGMs != $oldUGMs ) {
409  $this->addLogEntry( $user, $oldGroups, $newGroups, $reason, $tags, $oldUGMs, $newUGMs );
410  }
411 
412  return [ $add, $remove ];
413  }
414 
422  protected static function serialiseUgmForLog( $ugm ) {
423  if ( !$ugm instanceof UserGroupMembership ) {
424  return null;
425  }
426  return [ 'expiry' => $ugm->getExpiry() ];
427  }
428 
439  protected function addLogEntry( $user, array $oldGroups, array $newGroups, $reason,
440  array $tags, array $oldUGMs, array $newUGMs
441  ) {
442  // make sure $oldUGMs and $newUGMs are in the same order, and serialise
443  // each UGM object to a simplified array
444  $oldUGMs = array_map( function ( $group ) use ( $oldUGMs ) {
445  return isset( $oldUGMs[$group] ) ?
446  self::serialiseUgmForLog( $oldUGMs[$group] ) :
447  null;
448  }, $oldGroups );
449  $newUGMs = array_map( function ( $group ) use ( $newUGMs ) {
450  return isset( $newUGMs[$group] ) ?
451  self::serialiseUgmForLog( $newUGMs[$group] ) :
452  null;
453  }, $newGroups );
454 
455  $logEntry = new ManualLogEntry( 'rights', 'rights' );
456  $logEntry->setPerformer( $this->getUser() );
457  $logEntry->setTarget( $user->getUserPage() );
458  $logEntry->setComment( $reason );
459  $logEntry->setParameters( [
460  '4::oldgroups' => $oldGroups,
461  '5::newgroups' => $newGroups,
462  'oldmetadata' => $oldUGMs,
463  'newmetadata' => $newUGMs,
464  ] );
465  $logid = $logEntry->insert();
466  if ( count( $tags ) ) {
467  $logEntry->setTags( $tags );
468  }
469  $logEntry->publish( $logid );
470  }
471 
477  $status = $this->fetchUser( $username, true );
478  if ( !$status->isOK() ) {
479  $this->getOutput()->addWikiTextAsInterface( $status->getWikiText() );
480 
481  return;
482  } else {
483  $user = $status->value;
484  }
485 
486  $groups = $user->getGroups();
487  $groupMemberships = $user->getGroupMemberships();
488  $this->showEditUserGroupsForm( $user, $groups, $groupMemberships );
489 
490  // This isn't really ideal logging behavior, but let's not hide the
491  // interwiki logs if we're using them as is.
492  $this->showLogFragment( $user, $this->getOutput() );
493  }
494 
504  public function fetchUser( $username, $writing = true ) {
505  $parts = explode( $this->getConfig()->get( 'UserrightsInterwikiDelimiter' ), $username );
506  if ( count( $parts ) < 2 ) {
507  $name = trim( $username );
508  $dbDomain = '';
509  } else {
510  list( $name, $dbDomain ) = array_map( 'trim', $parts );
511 
512  if ( WikiMap::isCurrentWikiId( $dbDomain ) ) {
513  $dbDomain = '';
514  } else {
515  if ( $writing && !$this->getUser()->isAllowed( 'userrights-interwiki' ) ) {
516  return Status::newFatal( 'userrights-no-interwiki' );
517  }
518  if ( !UserRightsProxy::validDatabase( $dbDomain ) ) {
519  return Status::newFatal( 'userrights-nodatabase', $dbDomain );
520  }
521  }
522  }
523 
524  if ( $name === '' ) {
525  return Status::newFatal( 'nouserspecified' );
526  }
527 
528  if ( $name[0] == '#' ) {
529  // Numeric ID can be specified...
530  // We'll do a lookup for the name internally.
531  $id = intval( substr( $name, 1 ) );
532 
533  if ( $dbDomain == '' ) {
534  $name = User::whoIs( $id );
535  } else {
536  $name = UserRightsProxy::whoIs( $dbDomain, $id );
537  }
538 
539  if ( !$name ) {
540  return Status::newFatal( 'noname' );
541  }
542  } else {
544  if ( $name === false ) {
545  // invalid name
546  return Status::newFatal( 'nosuchusershort', $username );
547  }
548  }
549 
550  if ( $dbDomain == '' ) {
552  } else {
553  $user = UserRightsProxy::newFromName( $dbDomain, $name );
554  }
555 
556  if ( !$user || $user->isAnon() ) {
557  return Status::newFatal( 'nosuchusershort', $username );
558  }
559 
560  return Status::newGood( $user );
561  }
562 
570  public function makeGroupNameList( $ids ) {
571  if ( empty( $ids ) ) {
572  return $this->msg( 'rightsnone' )->inContentLanguage()->text();
573  } else {
574  return implode( ', ', $ids );
575  }
576  }
577 
581  function switchForm() {
582  $this->getOutput()->addModules( 'mediawiki.userSuggest' );
583 
584  $this->getOutput()->addHTML(
586  'form',
587  [
588  'method' => 'get',
589  'action' => wfScript(),
590  'name' => 'uluser',
591  'id' => 'mw-userrights-form1'
592  ]
593  ) .
594  Html::hidden( 'title', $this->getPageTitle()->getPrefixedText() ) .
595  Xml::fieldset( $this->msg( 'userrights-lookup-user' )->text() ) .
597  $this->msg( 'userrights-user-editname' )->text(),
598  'user',
599  'username',
600  30,
601  str_replace( '_', ' ', $this->mTarget ),
602  [
603  'class' => 'mw-autocomplete-user', // used by mediawiki.userSuggest
604  ] + (
605  // Set autofocus on blank input and error input
606  $this->mFetchedUser === null ? [ 'autofocus' => '' ] : []
607  )
608  ) . ' ' .
610  $this->msg( 'editusergroup' )->text()
611  ) .
612  Html::closeElement( 'fieldset' ) .
613  Html::closeElement( 'form' ) . "\n"
614  );
615  }
616 
626  protected function showEditUserGroupsForm( $user, $groups, $groupMemberships ) {
627  $list = $membersList = $tempList = $tempMembersList = [];
628  foreach ( $groupMemberships as $ugm ) {
629  $linkG = UserGroupMembership::getLink( $ugm, $this->getContext(), 'html' );
630  $linkM = UserGroupMembership::getLink( $ugm, $this->getContext(), 'html',
631  $user->getName() );
632  if ( $ugm->getExpiry() ) {
633  $tempList[] = $linkG;
634  $tempMembersList[] = $linkM;
635  } else {
636  $list[] = $linkG;
637  $membersList[] = $linkM;
638 
639  }
640  }
641 
642  $autoList = [];
643  $autoMembersList = [];
644  if ( $user instanceof User ) {
645  foreach ( Autopromote::getAutopromoteGroups( $user ) as $group ) {
646  $autoList[] = UserGroupMembership::getLink( $group, $this->getContext(), 'html' );
647  $autoMembersList[] = UserGroupMembership::getLink( $group, $this->getContext(),
648  'html', $user->getName() );
649  }
650  }
651 
652  $language = $this->getLanguage();
653  $displayedList = $this->msg( 'userrights-groupsmember-type' )
654  ->rawParams(
655  $language->commaList( array_merge( $tempList, $list ) ),
656  $language->commaList( array_merge( $tempMembersList, $membersList ) )
657  )->escaped();
658  $displayedAutolist = $this->msg( 'userrights-groupsmember-type' )
659  ->rawParams(
660  $language->commaList( $autoList ),
661  $language->commaList( $autoMembersList )
662  )->escaped();
663 
664  $grouplist = '';
665  $count = count( $list ) + count( $tempList );
666  if ( $count > 0 ) {
667  $grouplist = $this->msg( 'userrights-groupsmember' )
668  ->numParams( $count )
669  ->params( $user->getName() )
670  ->parse();
671  $grouplist = '<p>' . $grouplist . ' ' . $displayedList . "</p>\n";
672  }
673 
674  $count = count( $autoList );
675  if ( $count > 0 ) {
676  $autogrouplistintro = $this->msg( 'userrights-groupsmember-auto' )
677  ->numParams( $count )
678  ->params( $user->getName() )
679  ->parse();
680  $grouplist .= '<p>' . $autogrouplistintro . ' ' . $displayedAutolist . "</p>\n";
681  }
682 
683  $userToolLinks = Linker::userToolLinks(
684  $user->getId(),
685  $user->getName(),
686  false, /* default for redContribsWhenNoEdits */
687  Linker::TOOL_LINKS_EMAIL /* Add "send e-mail" link */
688  );
689 
690  list( $groupCheckboxes, $canChangeAny ) =
691  $this->groupCheckboxes( $groupMemberships, $user );
692  $this->getOutput()->addHTML(
694  'form',
695  [
696  'method' => 'post',
697  'action' => $this->getPageTitle()->getLocalURL(),
698  'name' => 'editGroup',
699  'id' => 'mw-userrights-form2'
700  ]
701  ) .
702  Html::hidden( 'user', $this->mTarget ) .
703  Html::hidden( 'wpEditToken', $this->getUser()->getEditToken( $this->mTarget ) ) .
704  Html::hidden(
705  'conflictcheck-originalgroups',
706  implode( ',', $user->getGroups() )
707  ) . // Conflict detection
708  Xml::openElement( 'fieldset' ) .
709  Xml::element(
710  'legend',
711  [],
712  $this->msg(
713  $canChangeAny ? 'userrights-editusergroup' : 'userrights-viewusergroup',
714  $user->getName()
715  )->text()
716  ) .
717  $this->msg(
718  $canChangeAny ? 'editinguser' : 'viewinguserrights'
719  )->params( wfEscapeWikiText( $user->getName() ) )
720  ->rawParams( $userToolLinks )->parse()
721  );
722  if ( $canChangeAny ) {
723  $this->getOutput()->addHTML(
724  $this->msg( 'userrights-groups-help', $user->getName() )->parse() .
725  $grouplist .
726  $groupCheckboxes .
727  Xml::openElement( 'table', [ 'id' => 'mw-userrights-table-outer' ] ) .
728  "<tr>
729  <td class='mw-label'>" .
730  Xml::label( $this->msg( 'userrights-reason' )->text(), 'wpReason' ) .
731  "</td>
732  <td class='mw-input'>" .
733  Xml::input( 'user-reason', 60, $this->getRequest()->getVal( 'user-reason', false ), [
734  'id' => 'wpReason',
735  // HTML maxlength uses "UTF-16 code units", which means that characters outside BMP
736  // (e.g. emojis) count for two each. This limit is overridden in JS to instead count
737  // Unicode codepoints.
739  ] ) .
740  "</td>
741  </tr>
742  <tr>
743  <td></td>
744  <td class='mw-submit'>" .
745  Xml::submitButton( $this->msg( 'saveusergroups', $user->getName() )->text(),
746  [ 'name' => 'saveusergroups' ] +
747  Linker::tooltipAndAccesskeyAttribs( 'userrights-set' )
748  ) .
749  "</td>
750  </tr>" .
751  Xml::closeElement( 'table' ) . "\n"
752  );
753  } else {
754  $this->getOutput()->addHTML( $grouplist );
755  }
756  $this->getOutput()->addHTML(
757  Xml::closeElement( 'fieldset' ) .
758  Xml::closeElement( 'form' ) . "\n"
759  );
760  }
761 
766  protected static function getAllGroups() {
767  return User::getAllGroups();
768  }
769 
779  private function groupCheckboxes( $usergroups, $user ) {
780  $allgroups = $this->getAllGroups();
781  $ret = '';
782 
783  // Get the list of preset expiry times from the system message
784  $expiryOptionsMsg = $this->msg( 'userrights-expiry-options' )->inContentLanguage();
785  $expiryOptions = $expiryOptionsMsg->isDisabled() ?
786  [] :
787  explode( ',', $expiryOptionsMsg->text() );
788 
789  // Put all column info into an associative array so that extensions can
790  // more easily manage it.
791  $columns = [ 'unchangeable' => [], 'changeable' => [] ];
792 
793  foreach ( $allgroups as $group ) {
794  $set = isset( $usergroups[$group] );
795  // Users who can add the group, but not remove it, can only lengthen
796  // expiries, not shorten them. So they should only see the expiry
797  // dropdown if the group currently has a finite expiry
798  $canOnlyLengthenExpiry = ( $set && $this->canAdd( $group ) &&
799  !$this->canRemove( $group ) && $usergroups[$group]->getExpiry() );
800  // Should the checkbox be disabled?
801  $disabledCheckbox = !(
802  ( $set && $this->canRemove( $group ) ) ||
803  ( !$set && $this->canAdd( $group ) ) );
804  // Should the expiry elements be disabled?
805  $disabledExpiry = $disabledCheckbox && !$canOnlyLengthenExpiry;
806  // Do we need to point out that this action is irreversible?
807  $irreversible = !$disabledCheckbox && (
808  ( $set && !$this->canAdd( $group ) ) ||
809  ( !$set && !$this->canRemove( $group ) ) );
810 
811  $checkbox = [
812  'set' => $set,
813  'disabled' => $disabledCheckbox,
814  'disabled-expiry' => $disabledExpiry,
815  'irreversible' => $irreversible
816  ];
817 
818  if ( $disabledCheckbox && $disabledExpiry ) {
819  $columns['unchangeable'][$group] = $checkbox;
820  } else {
821  $columns['changeable'][$group] = $checkbox;
822  }
823  }
824 
825  // Build the HTML table
826  $ret .= Xml::openElement( 'table', [ 'class' => 'mw-userrights-groups' ] ) .
827  "<tr>\n";
828  foreach ( $columns as $name => $column ) {
829  if ( $column === [] ) {
830  continue;
831  }
832  // Messages: userrights-changeable-col, userrights-unchangeable-col
833  $ret .= Xml::element(
834  'th',
835  null,
836  $this->msg( 'userrights-' . $name . '-col', count( $column ) )->text()
837  );
838  }
839 
840  $ret .= "</tr>\n<tr>\n";
841  foreach ( $columns as $column ) {
842  if ( $column === [] ) {
843  continue;
844  }
845  $ret .= "\t<td style='vertical-align:top;'>\n";
846  foreach ( $column as $group => $checkbox ) {
847  $attr = [ 'class' => 'mw-userrights-groupcheckbox' ];
848  if ( $checkbox['disabled'] ) {
849  $attr['disabled'] = 'disabled';
850  }
851 
852  $member = UserGroupMembership::getGroupMemberName( $group, $user->getName() );
853  if ( $checkbox['irreversible'] ) {
854  $text = $this->msg( 'userrights-irreversible-marker', $member )->text();
855  } elseif ( $checkbox['disabled'] && !$checkbox['disabled-expiry'] ) {
856  $text = $this->msg( 'userrights-no-shorten-expiry-marker', $member )->text();
857  } else {
858  $text = $member;
859  }
860  $checkboxHtml = Xml::checkLabel( $text, "wpGroup-" . $group,
861  "wpGroup-" . $group, $checkbox['set'], $attr );
862 
863  if ( $this->canProcessExpiries() ) {
864  $uiUser = $this->getUser();
865  $uiLanguage = $this->getLanguage();
866 
867  $currentExpiry = isset( $usergroups[$group] ) ?
868  $usergroups[$group]->getExpiry() :
869  null;
870 
871  // If the user can't modify the expiry, print the current expiry below
872  // it in plain text. Otherwise provide UI to set/change the expiry
873  if ( $checkbox['set'] &&
874  ( $checkbox['irreversible'] || $checkbox['disabled-expiry'] )
875  ) {
876  if ( $currentExpiry ) {
877  $expiryFormatted = $uiLanguage->userTimeAndDate( $currentExpiry, $uiUser );
878  $expiryFormattedD = $uiLanguage->userDate( $currentExpiry, $uiUser );
879  $expiryFormattedT = $uiLanguage->userTime( $currentExpiry, $uiUser );
880  $expiryHtml = $this->msg( 'userrights-expiry-current' )->params(
881  $expiryFormatted, $expiryFormattedD, $expiryFormattedT )->text();
882  } else {
883  $expiryHtml = $this->msg( 'userrights-expiry-none' )->text();
884  }
885  // T171345: Add a hidden form element so that other groups can still be manipulated,
886  // otherwise saving errors out with an invalid expiry time for this group.
887  $expiryHtml .= Html::hidden( "wpExpiry-$group",
888  $currentExpiry ? 'existing' : 'infinite' );
889  $expiryHtml .= "<br />\n";
890  } else {
891  $expiryHtml = Xml::element( 'span', null,
892  $this->msg( 'userrights-expiry' )->text() );
893  $expiryHtml .= Xml::openElement( 'span' );
894 
895  // add a form element to set the expiry date
896  $expiryFormOptions = new XmlSelect(
897  "wpExpiry-$group",
898  "mw-input-wpExpiry-$group", // forward compatibility with HTMLForm
899  $currentExpiry ? 'existing' : 'infinite'
900  );
901  if ( $checkbox['disabled-expiry'] ) {
902  $expiryFormOptions->setAttribute( 'disabled', 'disabled' );
903  }
904 
905  if ( $currentExpiry ) {
906  $timestamp = $uiLanguage->userTimeAndDate( $currentExpiry, $uiUser );
907  $d = $uiLanguage->userDate( $currentExpiry, $uiUser );
908  $t = $uiLanguage->userTime( $currentExpiry, $uiUser );
909  $existingExpiryMessage = $this->msg( 'userrights-expiry-existing',
910  $timestamp, $d, $t );
911  $expiryFormOptions->addOption( $existingExpiryMessage->text(), 'existing' );
912  }
913 
914  $expiryFormOptions->addOption(
915  $this->msg( 'userrights-expiry-none' )->text(),
916  'infinite'
917  );
918  $expiryFormOptions->addOption(
919  $this->msg( 'userrights-expiry-othertime' )->text(),
920  'other'
921  );
922  foreach ( $expiryOptions as $option ) {
923  if ( strpos( $option, ":" ) === false ) {
924  $displayText = $value = $option;
925  } else {
926  list( $displayText, $value ) = explode( ":", $option );
927  }
928  $expiryFormOptions->addOption( $displayText, htmlspecialchars( $value ) );
929  }
930 
931  // Add expiry dropdown
932  $expiryHtml .= $expiryFormOptions->getHTML() . '<br />';
933 
934  // Add custom expiry field
935  $attribs = [
936  'id' => "mw-input-wpExpiry-$group-other",
937  'class' => 'mw-userrights-expiryfield',
938  ];
939  if ( $checkbox['disabled-expiry'] ) {
940  $attribs['disabled'] = 'disabled';
941  }
942  $expiryHtml .= Xml::input( "wpExpiry-$group-other", 30, '', $attribs );
943 
944  // If the user group is set but the checkbox is disabled, mimic a
945  // checked checkbox in the form submission
946  if ( $checkbox['set'] && $checkbox['disabled'] ) {
947  $expiryHtml .= Html::hidden( "wpGroup-$group", 1 );
948  }
949 
950  $expiryHtml .= Xml::closeElement( 'span' );
951  }
952 
953  $divAttribs = [
954  'id' => "mw-userrights-nested-wpGroup-$group",
955  'class' => 'mw-userrights-nested',
956  ];
957  $checkboxHtml .= "\t\t\t" . Xml::tags( 'div', $divAttribs, $expiryHtml ) . "\n";
958  }
959  $ret .= "\t\t" . ( ( $checkbox['disabled'] && $checkbox['disabled-expiry'] )
960  ? Xml::tags( 'div', [ 'class' => 'mw-userrights-disabled' ], $checkboxHtml )
961  : Xml::tags( 'div', [], $checkboxHtml )
962  ) . "\n";
963  }
964  $ret .= "\t</td>\n";
965  }
966  $ret .= Xml::closeElement( 'tr' ) . Xml::closeElement( 'table' );
967 
968  return [ $ret, (bool)$columns['changeable'] ];
969  }
970 
975  private function canRemove( $group ) {
976  $groups = $this->changeableGroups();
977 
978  return in_array(
979  $group,
980  $groups['remove'] ) || ( $this->isself && in_array( $group, $groups['remove-self'] )
981  );
982  }
983 
988  private function canAdd( $group ) {
989  $groups = $this->changeableGroups();
990 
991  return in_array(
992  $group,
993  $groups['add'] ) || ( $this->isself && in_array( $group, $groups['add-self'] )
994  );
995  }
996 
1007  function changeableGroups() {
1008  return $this->getUser()->changeableGroups();
1009  }
1010 
1017  protected function showLogFragment( $user, $output ) {
1018  $rightsLogPage = new LogPage( 'rights' );
1019  $output->addHTML( Xml::element( 'h2', null, $rightsLogPage->getName()->text() ) );
1020  LogEventsList::showLogExtract( $output, 'rights', $user->getUserPage() );
1021  }
1022 
1031  public function prefixSearchSubpages( $search, $limit, $offset ) {
1032  $user = User::newFromName( $search );
1033  if ( !$user ) {
1034  // No prefix suggestion for invalid user
1035  return [];
1036  }
1037  // Autocomplete subpage as user list - public to allow caching
1038  return UserNamePrefixSearch::search( 'public', $search, $limit, $offset );
1039  }
1040 
1041  protected function getGroupName() {
1042  return 'users';
1043  }
1044 }
editUserGroupsForm( $username)
Edit user groups membership.
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking, formatting, etc.
static expiryToTimestamp( $expiry)
Converts a user group membership expiry string into a timestamp.
static whoIs( $id)
Get the username corresponding to a given user ID.
Definition: User.php:844
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:231
static whoIs( $dbDomain, $id, $ignoreInvalidDB=false)
Same as User::whoIs()
static newFromName( $dbDomain, $name, $ignoreInvalidDB=false)
Factory function; get a remote user entry by name.
addLogEntry( $user, array $oldGroups, array $newGroups, $reason, array $tags, array $oldUGMs, array $newUGMs)
Add a rights log entry for an action.
getContext()
Gets the context this SpecialPage is executed in.
doSaveUserGroups( $user, array $add, array $remove, $reason='', array $tags=[], array $groupExpiries=[])
Save user groups changes in the database.
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition: hooks.txt:1972
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
execute( $par)
Manage forms to be shown according to posted data.
changeableGroups()
Returns $this->getUser()->changeableGroups()
static openElement( $element, $attribs=[])
Identical to rawElement(), but has no third parameter and omits the end tag (and the self-closing &#39;/&#39;...
Definition: Html.php:251
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:209
Class for generating HTML <select> or <datalist> elements.
Definition: XmlSelect.php:26
static input( $name, $size=false, $value=false, $attribs=[])
Convenience function to build an HTML text input field.
Definition: Xml.php:274
$value
wfIsInfinity( $str)
Determine input string is represents as infinity.
addHelpLink( $to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
getOutput()
Get the OutputPage being used for this instance.
const COMMENT_CHARACTER_LIMIT
Maximum length of a comment in UTF-8 characters.
fetchUser( $username, $writing=true)
Normalize the input username, which may be local or remote, and return a user (or proxy) object for m...
static serialiseUgmForLog( $ugm)
Serialise a UserGroupMembership object for storage in the log_params section of the logging table...
static getLink( $ugm, IContextSource $context, $format, $userName=null)
Gets a link for a user group, possibly including the expiry date if relevant.
This list may contain false positives That usually means there is additional text with links below the first Each row contains links to the first and second as well as the first line of the second redirect text
static search( $audience, $search, $limit, $offset=0)
Do a prefix search of user names and return a list of matching user names.
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place $output
Definition: hooks.txt:2205
static getAllGroups()
Return the set of defined explicit groups.
Definition: User.php:4864
Class to simplify the use of log pages.
Definition: LogPage.php:33
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Definition: User.php:51
wfScript( $script='index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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
Definition: hooks.txt:767
static getCanonicalName( $name, $validate='valid')
Given unvalidated user input, return a canonical username, or false if the username is invalid...
Definition: User.php:1174
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1244
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
switchForm()
Output a form to allow searching for a user.
static openElement( $element, $attribs=null)
This opens an XML element.
Definition: Xml.php:108
static validDatabase( $dbDomain)
Confirm the selected database name is a valid local interwiki database name.
static getGroupMemberName( $group, $username)
Gets the localized name for a member of a group, if it exists.
static fieldset( $legend=false, $content=false, $attribs=[])
Shortcut for creating fieldsets.
Definition: Xml.php:609
static userToolLinks( $userId, $userText, $redContribsWhenNoEdits=false, $flags=0, $edits=null, $useParentheses=true)
Generate standard user tool links (talk, contributions, block link, etc.)
Definition: Linker.php:940
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
prefixSearchSubpages( $search, $limit, $offset)
Return an array of subpages beginning with $search that this special page will accept.
static submitButton( $value, $attribs=[])
Convenience function to build an HTML submit button When $wgUseMediaWikiUIEverywhere is true it will ...
Definition: Xml.php:459
userCanChangeRights( $targetUser, $checkIfSelf=true)
Check whether the current user (from context) can change the target user&#39;s rights.
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
getSkin()
Shortcut to get the skin being used for this instance.
static tags( $element, $attribs, $contents)
Same as Xml::element(), but does not escape contents.
Definition: Xml.php:130
static closeElement( $element)
Returns "</$element>".
Definition: Html.php:315
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes! ...
$mTarget
The target of the local right-adjuster&#39;s interest.
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing & $attribs
Definition: hooks.txt:1972
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:767
static getAutopromoteGroups(User $user)
Get the groups for the given user based on $wgAutopromote.
Definition: Autopromote.php:35
Show an error when the user tries to do something whilst blocked.
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
Definition: distributors.txt:9
static label( $label, $id, $attribs=[])
Convenience function to build an HTML form label.
Definition: Xml.php:358
saveUserGroups( $username, $reason, $user)
Save user groups changes in the database.
canProcessExpiries()
Returns true if this user rights form can set and change user group expiries.
showEditUserGroupsForm( $user, $groups, $groupMemberships)
Show the form to edit group memberships.
static getAllGroups()
Returns an array of all groups that may be edited.
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
Definition: injection.txt:35
this hook is for auditing only or null if authentication failed before getting that far $username
Definition: hooks.txt:767
static closeElement( $element)
Shortcut to close an XML element.
Definition: Xml.php:117
static isCurrentWikiId( $wikiId)
Definition: WikiMap.php:313
getUser()
Shortcut to get the User executing this instance.
static hidden( $name, $value, array $attribs=[])
Convenience function to produce an input element with type=hidden.
Definition: Html.php:796
getConfig()
Shortcut to get main config object.
static element( $element, $attribs=null, $contents='', $allowShortTag=true)
Format an XML element with given attributes and, optionally, text content.
Definition: Xml.php:41
getLanguage()
Shortcut to get user&#39;s language.
msg( $key)
Wrapper around wfMessage that sets the current context.
Special page to allow managing user group membership.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
static inputLabel( $label, $name, $id, $size=false, $value=false, $attribs=[])
Convenience function to build an HTML text input field with a label.
Definition: Xml.php:380
static checkLabel( $label, $name, $id, $checked=false, $attribs=[])
Convenience function to build an HTML checkbox with a label.
Definition: Xml.php:419
groupCheckboxes( $usergroups, $user)
Adds a table with checkboxes where you can select what groups to add/remove.
getRequest()
Get the WebRequest being used for this instance.
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:535
showLogFragment( $user, $output)
Show a rights log fragment for the specified user.
static tooltipAndAccesskeyAttribs( $name, array $msgParams=[], $options=null)
Returns the attributes for the tooltip and access key.
Definition: Linker.php:2188
checkReadOnly()
If the wiki is currently in readonly mode, throws a ReadOnlyError.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2621
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
getPageTitle( $subpage=false)
Get a self-referential title object.
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1454
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
const TOOL_LINKS_EMAIL
Definition: Linker.php:40
static showLogExtract(&$out, $types=[], $page='', $user='', $param=[])
Show log extract.