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  // @TODO Should the user be blocked from changing user rights if they
165  // are partially blocked?
166  $block = $user->getBlock();
167  if ( $block ) {
168  throw new UserBlockedError( $user->getBlock() );
169  }
170  }
171 
172  $this->checkReadOnly();
173 
174  // save settings
175  if ( !$fetchedStatus->isOK() ) {
176  $this->getOutput()->addWikiTextAsInterface( $fetchedStatus->getWikiText() );
177 
178  return;
179  }
180 
181  $targetUser = $this->mFetchedUser;
182  if ( $targetUser instanceof User ) { // UserRightsProxy doesn't have this method (T63252)
183  $targetUser->clearInstanceCache(); // T40989
184  }
185 
186  $conflictCheck = $request->getVal( 'conflictcheck-originalgroups' );
187  $conflictCheck = ( $conflictCheck === '' ) ? [] : explode( ',', $conflictCheck );
188  $userGroups = $targetUser->getGroups();
189 
190  if ( $userGroups !== $conflictCheck ) {
191  $out->wrapWikiMsg( '<span class="error">$1</span>', 'userrights-conflict' );
192  } else {
193  $status = $this->saveUserGroups(
194  $this->mTarget,
195  $request->getVal( 'user-reason' ),
196  $targetUser
197  );
198 
199  if ( $status->isOK() ) {
200  // Set session data for the success message
201  $session->set( 'specialUserrightsSaveSuccess', 1 );
202 
203  $out->redirect( $this->getSuccessURL() );
204  return;
205  } else {
206  // Print an error message and redisplay the form
207  $out->wrapWikiTextAsInterface( 'error', $status->getWikiText() );
208  }
209  }
210  }
211 
212  // show some more forms
213  if ( $this->mTarget !== null ) {
214  $this->editUserGroupsForm( $this->mTarget );
215  }
216  }
217 
218  function getSuccessURL() {
219  return $this->getPageTitle( $this->mTarget )->getFullURL();
220  }
221 
228  public function canProcessExpiries() {
229  return true;
230  }
231 
241  public static function expiryToTimestamp( $expiry ) {
242  if ( wfIsInfinity( $expiry ) ) {
243  return null;
244  }
245 
246  $unix = strtotime( $expiry );
247 
248  if ( !$unix || $unix === -1 ) {
249  return false;
250  }
251 
252  // @todo FIXME: Non-qualified absolute times are not in users specified timezone
253  // and there isn't notice about it in the ui (see ProtectionForm::getExpiry)
254  return wfTimestamp( TS_MW, $unix );
255  }
256 
266  protected function saveUserGroups( $username, $reason, $user ) {
267  $allgroups = $this->getAllGroups();
268  $addgroup = [];
269  $groupExpiries = []; // associative array of (group name => expiry)
270  $removegroup = [];
271  $existingUGMs = $user->getGroupMemberships();
272 
273  // This could possibly create a highly unlikely race condition if permissions are changed between
274  // when the form is loaded and when the form is saved. Ignoring it for the moment.
275  foreach ( $allgroups as $group ) {
276  // We'll tell it to remove all unchecked groups, and add all checked groups.
277  // Later on, this gets filtered for what can actually be removed
278  if ( $this->getRequest()->getCheck( "wpGroup-$group" ) ) {
279  $addgroup[] = $group;
280 
281  if ( $this->canProcessExpiries() ) {
282  // read the expiry information from the request
283  $expiryDropdown = $this->getRequest()->getVal( "wpExpiry-$group" );
284  if ( $expiryDropdown === 'existing' ) {
285  continue;
286  }
287 
288  if ( $expiryDropdown === 'other' ) {
289  $expiryValue = $this->getRequest()->getVal( "wpExpiry-$group-other" );
290  } else {
291  $expiryValue = $expiryDropdown;
292  }
293 
294  // validate the expiry
295  $groupExpiries[$group] = self::expiryToTimestamp( $expiryValue );
296 
297  if ( $groupExpiries[$group] === false ) {
298  return Status::newFatal( 'userrights-invalid-expiry', $group );
299  }
300 
301  // not allowed to have things expiring in the past
302  if ( $groupExpiries[$group] && $groupExpiries[$group] < wfTimestampNow() ) {
303  return Status::newFatal( 'userrights-expiry-in-past', $group );
304  }
305 
306  // if the user can only add this group (not remove it), the expiry time
307  // cannot be brought forward (T156784)
308  if ( !$this->canRemove( $group ) &&
309  isset( $existingUGMs[$group] ) &&
310  ( $existingUGMs[$group]->getExpiry() ?: 'infinity' ) >
311  ( $groupExpiries[$group] ?: 'infinity' )
312  ) {
313  return Status::newFatal( 'userrights-cannot-shorten-expiry', $group );
314  }
315  }
316  } else {
317  $removegroup[] = $group;
318  }
319  }
320 
321  $this->doSaveUserGroups( $user, $addgroup, $removegroup, $reason, [], $groupExpiries );
322 
323  return Status::newGood();
324  }
325 
339  function doSaveUserGroups( $user, array $add, array $remove, $reason = '',
340  array $tags = [], array $groupExpiries = []
341  ) {
342  // Validate input set...
343  $isself = $user->getName() == $this->getUser()->getName();
344  $groups = $user->getGroups();
345  $ugms = $user->getGroupMemberships();
346  $changeable = $this->changeableGroups();
347  $addable = array_merge( $changeable['add'], $isself ? $changeable['add-self'] : [] );
348  $removable = array_merge( $changeable['remove'], $isself ? $changeable['remove-self'] : [] );
349 
350  $remove = array_unique(
351  array_intersect( (array)$remove, $removable, $groups ) );
352  $add = array_intersect( (array)$add, $addable );
353 
354  // add only groups that are not already present or that need their expiry updated,
355  // UNLESS the user can only add this group (not remove it) and the expiry time
356  // is being brought forward (T156784)
357  $add = array_filter( $add,
358  function ( $group ) use ( $groups, $groupExpiries, $removable, $ugms ) {
359  if ( isset( $groupExpiries[$group] ) &&
360  !in_array( $group, $removable ) &&
361  isset( $ugms[$group] ) &&
362  ( $ugms[$group]->getExpiry() ?: 'infinity' ) >
363  ( $groupExpiries[$group] ?: 'infinity' )
364  ) {
365  return false;
366  }
367  return !in_array( $group, $groups ) || array_key_exists( $group, $groupExpiries );
368  } );
369 
370  Hooks::run( 'ChangeUserGroups', [ $this->getUser(), $user, &$add, &$remove ] );
371 
372  $oldGroups = $groups;
373  $oldUGMs = $user->getGroupMemberships();
374  $newGroups = $oldGroups;
375 
376  // Remove groups, then add new ones/update expiries of existing ones
377  if ( $remove ) {
378  foreach ( $remove as $index => $group ) {
379  if ( !$user->removeGroup( $group ) ) {
380  unset( $remove[$index] );
381  }
382  }
383  $newGroups = array_diff( $newGroups, $remove );
384  }
385  if ( $add ) {
386  foreach ( $add as $index => $group ) {
387  $expiry = $groupExpiries[$group] ?? null;
388  if ( !$user->addGroup( $group, $expiry ) ) {
389  unset( $add[$index] );
390  }
391  }
392  $newGroups = array_merge( $newGroups, $add );
393  }
394  $newGroups = array_unique( $newGroups );
395  $newUGMs = $user->getGroupMemberships();
396 
397  // Ensure that caches are cleared
398  $user->invalidateCache();
399 
400  // update groups in external authentication database
401  Hooks::run( 'UserGroupsChanged', [ $user, $add, $remove, $this->getUser(),
402  $reason, $oldUGMs, $newUGMs ] );
403 
404  wfDebug( 'oldGroups: ' . print_r( $oldGroups, true ) . "\n" );
405  wfDebug( 'newGroups: ' . print_r( $newGroups, true ) . "\n" );
406  wfDebug( 'oldUGMs: ' . print_r( $oldUGMs, true ) . "\n" );
407  wfDebug( 'newUGMs: ' . print_r( $newUGMs, true ) . "\n" );
408  // Deprecated in favor of UserGroupsChanged hook
409  Hooks::run( 'UserRights', [ &$user, $add, $remove ], '1.26' );
410 
411  // Only add a log entry if something actually changed
412  if ( $newGroups != $oldGroups || $newUGMs != $oldUGMs ) {
413  $this->addLogEntry( $user, $oldGroups, $newGroups, $reason, $tags, $oldUGMs, $newUGMs );
414  }
415 
416  return [ $add, $remove ];
417  }
418 
426  protected static function serialiseUgmForLog( $ugm ) {
427  if ( !$ugm instanceof UserGroupMembership ) {
428  return null;
429  }
430  return [ 'expiry' => $ugm->getExpiry() ];
431  }
432 
443  protected function addLogEntry( $user, array $oldGroups, array $newGroups, $reason,
444  array $tags, array $oldUGMs, array $newUGMs
445  ) {
446  // make sure $oldUGMs and $newUGMs are in the same order, and serialise
447  // each UGM object to a simplified array
448  $oldUGMs = array_map( function ( $group ) use ( $oldUGMs ) {
449  return isset( $oldUGMs[$group] ) ?
450  self::serialiseUgmForLog( $oldUGMs[$group] ) :
451  null;
452  }, $oldGroups );
453  $newUGMs = array_map( function ( $group ) use ( $newUGMs ) {
454  return isset( $newUGMs[$group] ) ?
455  self::serialiseUgmForLog( $newUGMs[$group] ) :
456  null;
457  }, $newGroups );
458 
459  $logEntry = new ManualLogEntry( 'rights', 'rights' );
460  $logEntry->setPerformer( $this->getUser() );
461  $logEntry->setTarget( $user->getUserPage() );
462  $logEntry->setComment( $reason );
463  $logEntry->setParameters( [
464  '4::oldgroups' => $oldGroups,
465  '5::newgroups' => $newGroups,
466  'oldmetadata' => $oldUGMs,
467  'newmetadata' => $newUGMs,
468  ] );
469  $logid = $logEntry->insert();
470  if ( count( $tags ) ) {
471  $logEntry->setTags( $tags );
472  }
473  $logEntry->publish( $logid );
474  }
475 
481  $status = $this->fetchUser( $username, true );
482  if ( !$status->isOK() ) {
483  $this->getOutput()->addWikiTextAsInterface( $status->getWikiText() );
484 
485  return;
486  } else {
487  $user = $status->value;
488  }
489 
490  $groups = $user->getGroups();
491  $groupMemberships = $user->getGroupMemberships();
492  $this->showEditUserGroupsForm( $user, $groups, $groupMemberships );
493 
494  // This isn't really ideal logging behavior, but let's not hide the
495  // interwiki logs if we're using them as is.
496  $this->showLogFragment( $user, $this->getOutput() );
497  }
498 
508  public function fetchUser( $username, $writing = true ) {
509  $parts = explode( $this->getConfig()->get( 'UserrightsInterwikiDelimiter' ), $username );
510  if ( count( $parts ) < 2 ) {
511  $name = trim( $username );
512  $wikiId = '';
513  } else {
514  list( $name, $wikiId ) = array_map( 'trim', $parts );
515 
516  if ( WikiMap::isCurrentWikiId( $wikiId ) ) {
517  $wikiId = '';
518  } else {
519  if ( $writing && !$this->getUser()->isAllowed( 'userrights-interwiki' ) ) {
520  return Status::newFatal( 'userrights-no-interwiki' );
521  }
522  if ( !UserRightsProxy::validDatabase( $wikiId ) ) {
523  return Status::newFatal( 'userrights-nodatabase', $wikiId );
524  }
525  }
526  }
527 
528  if ( $name === '' ) {
529  return Status::newFatal( 'nouserspecified' );
530  }
531 
532  if ( $name[0] == '#' ) {
533  // Numeric ID can be specified...
534  // We'll do a lookup for the name internally.
535  $id = intval( substr( $name, 1 ) );
536 
537  if ( $wikiId == '' ) {
538  $name = User::whoIs( $id );
539  } else {
540  $name = UserRightsProxy::whoIs( $wikiId, $id );
541  }
542 
543  if ( !$name ) {
544  return Status::newFatal( 'noname' );
545  }
546  } else {
548  if ( $name === false ) {
549  // invalid name
550  return Status::newFatal( 'nosuchusershort', $username );
551  }
552  }
553 
554  if ( $wikiId == '' ) {
556  } else {
558  }
559 
560  if ( !$user || $user->isAnon() ) {
561  return Status::newFatal( 'nosuchusershort', $username );
562  }
563 
564  return Status::newGood( $user );
565  }
566 
574  public function makeGroupNameList( $ids ) {
575  if ( empty( $ids ) ) {
576  return $this->msg( 'rightsnone' )->inContentLanguage()->text();
577  } else {
578  return implode( ', ', $ids );
579  }
580  }
581 
585  function switchForm() {
586  $this->getOutput()->addModules( 'mediawiki.userSuggest' );
587 
588  $this->getOutput()->addHTML(
590  'form',
591  [
592  'method' => 'get',
593  'action' => wfScript(),
594  'name' => 'uluser',
595  'id' => 'mw-userrights-form1'
596  ]
597  ) .
598  Html::hidden( 'title', $this->getPageTitle()->getPrefixedText() ) .
599  Xml::fieldset( $this->msg( 'userrights-lookup-user' )->text() ) .
601  $this->msg( 'userrights-user-editname' )->text(),
602  'user',
603  'username',
604  30,
605  str_replace( '_', ' ', $this->mTarget ),
606  [
607  'class' => 'mw-autocomplete-user', // used by mediawiki.userSuggest
608  ] + (
609  // Set autofocus on blank input and error input
610  $this->mFetchedUser === null ? [ 'autofocus' => '' ] : []
611  )
612  ) . ' ' .
614  $this->msg( 'editusergroup' )->text()
615  ) .
616  Html::closeElement( 'fieldset' ) .
617  Html::closeElement( 'form' ) . "\n"
618  );
619  }
620 
630  protected function showEditUserGroupsForm( $user, $groups, $groupMemberships ) {
631  $list = $membersList = $tempList = $tempMembersList = [];
632  foreach ( $groupMemberships as $ugm ) {
633  $linkG = UserGroupMembership::getLink( $ugm, $this->getContext(), 'html' );
634  $linkM = UserGroupMembership::getLink( $ugm, $this->getContext(), 'html',
635  $user->getName() );
636  if ( $ugm->getExpiry() ) {
637  $tempList[] = $linkG;
638  $tempMembersList[] = $linkM;
639  } else {
640  $list[] = $linkG;
641  $membersList[] = $linkM;
642 
643  }
644  }
645 
646  $autoList = [];
647  $autoMembersList = [];
648  if ( $user instanceof User ) {
649  foreach ( Autopromote::getAutopromoteGroups( $user ) as $group ) {
650  $autoList[] = UserGroupMembership::getLink( $group, $this->getContext(), 'html' );
651  $autoMembersList[] = UserGroupMembership::getLink( $group, $this->getContext(),
652  'html', $user->getName() );
653  }
654  }
655 
656  $language = $this->getLanguage();
657  $displayedList = $this->msg( 'userrights-groupsmember-type' )
658  ->rawParams(
659  $language->commaList( array_merge( $tempList, $list ) ),
660  $language->commaList( array_merge( $tempMembersList, $membersList ) )
661  )->escaped();
662  $displayedAutolist = $this->msg( 'userrights-groupsmember-type' )
663  ->rawParams(
664  $language->commaList( $autoList ),
665  $language->commaList( $autoMembersList )
666  )->escaped();
667 
668  $grouplist = '';
669  $count = count( $list ) + count( $tempList );
670  if ( $count > 0 ) {
671  $grouplist = $this->msg( 'userrights-groupsmember' )
672  ->numParams( $count )
673  ->params( $user->getName() )
674  ->parse();
675  $grouplist = '<p>' . $grouplist . ' ' . $displayedList . "</p>\n";
676  }
677 
678  $count = count( $autoList );
679  if ( $count > 0 ) {
680  $autogrouplistintro = $this->msg( 'userrights-groupsmember-auto' )
681  ->numParams( $count )
682  ->params( $user->getName() )
683  ->parse();
684  $grouplist .= '<p>' . $autogrouplistintro . ' ' . $displayedAutolist . "</p>\n";
685  }
686 
687  $userToolLinks = Linker::userToolLinks(
688  $user->getId(),
689  $user->getName(),
690  false, /* default for redContribsWhenNoEdits */
691  Linker::TOOL_LINKS_EMAIL /* Add "send e-mail" link */
692  );
693 
694  list( $groupCheckboxes, $canChangeAny ) =
695  $this->groupCheckboxes( $groupMemberships, $user );
696  $this->getOutput()->addHTML(
698  'form',
699  [
700  'method' => 'post',
701  'action' => $this->getPageTitle()->getLocalURL(),
702  'name' => 'editGroup',
703  'id' => 'mw-userrights-form2'
704  ]
705  ) .
706  Html::hidden( 'user', $this->mTarget ) .
707  Html::hidden( 'wpEditToken', $this->getUser()->getEditToken( $this->mTarget ) ) .
708  Html::hidden(
709  'conflictcheck-originalgroups',
710  implode( ',', $user->getGroups() )
711  ) . // Conflict detection
712  Xml::openElement( 'fieldset' ) .
713  Xml::element(
714  'legend',
715  [],
716  $this->msg(
717  $canChangeAny ? 'userrights-editusergroup' : 'userrights-viewusergroup',
718  $user->getName()
719  )->text()
720  ) .
721  $this->msg(
722  $canChangeAny ? 'editinguser' : 'viewinguserrights'
723  )->params( wfEscapeWikiText( $user->getName() ) )
724  ->rawParams( $userToolLinks )->parse()
725  );
726  if ( $canChangeAny ) {
727  $this->getOutput()->addHTML(
728  $this->msg( 'userrights-groups-help', $user->getName() )->parse() .
729  $grouplist .
730  $groupCheckboxes .
731  Xml::openElement( 'table', [ 'id' => 'mw-userrights-table-outer' ] ) .
732  "<tr>
733  <td class='mw-label'>" .
734  Xml::label( $this->msg( 'userrights-reason' )->text(), 'wpReason' ) .
735  "</td>
736  <td class='mw-input'>" .
737  Xml::input( 'user-reason', 60, $this->getRequest()->getVal( 'user-reason', false ), [
738  'id' => 'wpReason',
739  // HTML maxlength uses "UTF-16 code units", which means that characters outside BMP
740  // (e.g. emojis) count for two each. This limit is overridden in JS to instead count
741  // Unicode codepoints.
743  ] ) .
744  "</td>
745  </tr>
746  <tr>
747  <td></td>
748  <td class='mw-submit'>" .
749  Xml::submitButton( $this->msg( 'saveusergroups', $user->getName() )->text(),
750  [ 'name' => 'saveusergroups' ] +
751  Linker::tooltipAndAccesskeyAttribs( 'userrights-set' )
752  ) .
753  "</td>
754  </tr>" .
755  Xml::closeElement( 'table' ) . "\n"
756  );
757  } else {
758  $this->getOutput()->addHTML( $grouplist );
759  }
760  $this->getOutput()->addHTML(
761  Xml::closeElement( 'fieldset' ) .
762  Xml::closeElement( 'form' ) . "\n"
763  );
764  }
765 
770  protected static function getAllGroups() {
771  return User::getAllGroups();
772  }
773 
783  private function groupCheckboxes( $usergroups, $user ) {
784  $allgroups = $this->getAllGroups();
785  $ret = '';
786 
787  // Get the list of preset expiry times from the system message
788  $expiryOptionsMsg = $this->msg( 'userrights-expiry-options' )->inContentLanguage();
789  $expiryOptions = $expiryOptionsMsg->isDisabled() ?
790  [] :
791  explode( ',', $expiryOptionsMsg->text() );
792 
793  // Put all column info into an associative array so that extensions can
794  // more easily manage it.
795  $columns = [ 'unchangeable' => [], 'changeable' => [] ];
796 
797  foreach ( $allgroups as $group ) {
798  $set = isset( $usergroups[$group] );
799  // Users who can add the group, but not remove it, can only lengthen
800  // expiries, not shorten them. So they should only see the expiry
801  // dropdown if the group currently has a finite expiry
802  $canOnlyLengthenExpiry = ( $set && $this->canAdd( $group ) &&
803  !$this->canRemove( $group ) && $usergroups[$group]->getExpiry() );
804  // Should the checkbox be disabled?
805  $disabledCheckbox = !(
806  ( $set && $this->canRemove( $group ) ) ||
807  ( !$set && $this->canAdd( $group ) ) );
808  // Should the expiry elements be disabled?
809  $disabledExpiry = $disabledCheckbox && !$canOnlyLengthenExpiry;
810  // Do we need to point out that this action is irreversible?
811  $irreversible = !$disabledCheckbox && (
812  ( $set && !$this->canAdd( $group ) ) ||
813  ( !$set && !$this->canRemove( $group ) ) );
814 
815  $checkbox = [
816  'set' => $set,
817  'disabled' => $disabledCheckbox,
818  'disabled-expiry' => $disabledExpiry,
819  'irreversible' => $irreversible
820  ];
821 
822  if ( $disabledCheckbox && $disabledExpiry ) {
823  $columns['unchangeable'][$group] = $checkbox;
824  } else {
825  $columns['changeable'][$group] = $checkbox;
826  }
827  }
828 
829  // Build the HTML table
830  $ret .= Xml::openElement( 'table', [ 'class' => 'mw-userrights-groups' ] ) .
831  "<tr>\n";
832  foreach ( $columns as $name => $column ) {
833  if ( $column === [] ) {
834  continue;
835  }
836  // Messages: userrights-changeable-col, userrights-unchangeable-col
837  $ret .= Xml::element(
838  'th',
839  null,
840  $this->msg( 'userrights-' . $name . '-col', count( $column ) )->text()
841  );
842  }
843 
844  $ret .= "</tr>\n<tr>\n";
845  foreach ( $columns as $column ) {
846  if ( $column === [] ) {
847  continue;
848  }
849  $ret .= "\t<td style='vertical-align:top;'>\n";
850  foreach ( $column as $group => $checkbox ) {
851  $attr = [ 'class' => 'mw-userrights-groupcheckbox' ];
852  if ( $checkbox['disabled'] ) {
853  $attr['disabled'] = 'disabled';
854  }
855 
856  $member = UserGroupMembership::getGroupMemberName( $group, $user->getName() );
857  if ( $checkbox['irreversible'] ) {
858  $text = $this->msg( 'userrights-irreversible-marker', $member )->text();
859  } elseif ( $checkbox['disabled'] && !$checkbox['disabled-expiry'] ) {
860  $text = $this->msg( 'userrights-no-shorten-expiry-marker', $member )->text();
861  } else {
862  $text = $member;
863  }
864  $checkboxHtml = Xml::checkLabel( $text, "wpGroup-" . $group,
865  "wpGroup-" . $group, $checkbox['set'], $attr );
866 
867  if ( $this->canProcessExpiries() ) {
868  $uiUser = $this->getUser();
869  $uiLanguage = $this->getLanguage();
870 
871  $currentExpiry = isset( $usergroups[$group] ) ?
872  $usergroups[$group]->getExpiry() :
873  null;
874 
875  // If the user can't modify the expiry, print the current expiry below
876  // it in plain text. Otherwise provide UI to set/change the expiry
877  if ( $checkbox['set'] &&
878  ( $checkbox['irreversible'] || $checkbox['disabled-expiry'] )
879  ) {
880  if ( $currentExpiry ) {
881  $expiryFormatted = $uiLanguage->userTimeAndDate( $currentExpiry, $uiUser );
882  $expiryFormattedD = $uiLanguage->userDate( $currentExpiry, $uiUser );
883  $expiryFormattedT = $uiLanguage->userTime( $currentExpiry, $uiUser );
884  $expiryHtml = $this->msg( 'userrights-expiry-current' )->params(
885  $expiryFormatted, $expiryFormattedD, $expiryFormattedT )->text();
886  } else {
887  $expiryHtml = $this->msg( 'userrights-expiry-none' )->text();
888  }
889  // T171345: Add a hidden form element so that other groups can still be manipulated,
890  // otherwise saving errors out with an invalid expiry time for this group.
891  $expiryHtml .= Html::hidden( "wpExpiry-$group",
892  $currentExpiry ? 'existing' : 'infinite' );
893  $expiryHtml .= "<br />\n";
894  } else {
895  $expiryHtml = Xml::element( 'span', null,
896  $this->msg( 'userrights-expiry' )->text() );
897  $expiryHtml .= Xml::openElement( 'span' );
898 
899  // add a form element to set the expiry date
900  $expiryFormOptions = new XmlSelect(
901  "wpExpiry-$group",
902  "mw-input-wpExpiry-$group", // forward compatibility with HTMLForm
903  $currentExpiry ? 'existing' : 'infinite'
904  );
905  if ( $checkbox['disabled-expiry'] ) {
906  $expiryFormOptions->setAttribute( 'disabled', 'disabled' );
907  }
908 
909  if ( $currentExpiry ) {
910  $timestamp = $uiLanguage->userTimeAndDate( $currentExpiry, $uiUser );
911  $d = $uiLanguage->userDate( $currentExpiry, $uiUser );
912  $t = $uiLanguage->userTime( $currentExpiry, $uiUser );
913  $existingExpiryMessage = $this->msg( 'userrights-expiry-existing',
914  $timestamp, $d, $t );
915  $expiryFormOptions->addOption( $existingExpiryMessage->text(), 'existing' );
916  }
917 
918  $expiryFormOptions->addOption(
919  $this->msg( 'userrights-expiry-none' )->text(),
920  'infinite'
921  );
922  $expiryFormOptions->addOption(
923  $this->msg( 'userrights-expiry-othertime' )->text(),
924  'other'
925  );
926  foreach ( $expiryOptions as $option ) {
927  if ( strpos( $option, ":" ) === false ) {
928  $displayText = $value = $option;
929  } else {
930  list( $displayText, $value ) = explode( ":", $option );
931  }
932  $expiryFormOptions->addOption( $displayText, htmlspecialchars( $value ) );
933  }
934 
935  // Add expiry dropdown
936  $expiryHtml .= $expiryFormOptions->getHTML() . '<br />';
937 
938  // Add custom expiry field
939  $attribs = [
940  'id' => "mw-input-wpExpiry-$group-other",
941  'class' => 'mw-userrights-expiryfield',
942  ];
943  if ( $checkbox['disabled-expiry'] ) {
944  $attribs['disabled'] = 'disabled';
945  }
946  $expiryHtml .= Xml::input( "wpExpiry-$group-other", 30, '', $attribs );
947 
948  // If the user group is set but the checkbox is disabled, mimic a
949  // checked checkbox in the form submission
950  if ( $checkbox['set'] && $checkbox['disabled'] ) {
951  $expiryHtml .= Html::hidden( "wpGroup-$group", 1 );
952  }
953 
954  $expiryHtml .= Xml::closeElement( 'span' );
955  }
956 
957  $divAttribs = [
958  'id' => "mw-userrights-nested-wpGroup-$group",
959  'class' => 'mw-userrights-nested',
960  ];
961  $checkboxHtml .= "\t\t\t" . Xml::tags( 'div', $divAttribs, $expiryHtml ) . "\n";
962  }
963  $ret .= "\t\t" . ( ( $checkbox['disabled'] && $checkbox['disabled-expiry'] )
964  ? Xml::tags( 'div', [ 'class' => 'mw-userrights-disabled' ], $checkboxHtml )
965  : Xml::tags( 'div', [], $checkboxHtml )
966  ) . "\n";
967  }
968  $ret .= "\t</td>\n";
969  }
970  $ret .= Xml::closeElement( 'tr' ) . Xml::closeElement( 'table' );
971 
972  return [ $ret, (bool)$columns['changeable'] ];
973  }
974 
979  private function canRemove( $group ) {
980  $groups = $this->changeableGroups();
981 
982  return in_array(
983  $group,
984  $groups['remove'] ) || ( $this->isself && in_array( $group, $groups['remove-self'] )
985  );
986  }
987 
992  private function canAdd( $group ) {
993  $groups = $this->changeableGroups();
994 
995  return in_array(
996  $group,
997  $groups['add'] ) || ( $this->isself && in_array( $group, $groups['add-self'] )
998  );
999  }
1000 
1011  function changeableGroups() {
1012  return $this->getUser()->changeableGroups();
1013  }
1014 
1021  protected function showLogFragment( $user, $output ) {
1022  $rightsLogPage = new LogPage( 'rights' );
1023  $output->addHTML( Xml::element( 'h2', null, $rightsLogPage->getName()->text() ) );
1024  LogEventsList::showLogExtract( $output, 'rights', $user->getUserPage() );
1025  }
1026 
1035  public function prefixSearchSubpages( $search, $limit, $offset ) {
1036  $user = User::newFromName( $search );
1037  if ( !$user ) {
1038  // No prefix suggestion for invalid user
1039  return [];
1040  }
1041  // Autocomplete subpage as user list - public to allow caching
1042  return UserNamePrefixSearch::search( 'public', $search, $limit, $offset );
1043  }
1044 
1045  protected function getGroupName() {
1046  return 'users';
1047  }
1048 }
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:903
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:232
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:1982
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:252
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:210
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:2217
static getAllGroups()
Return the set of defined explicit groups.
Definition: User.php:5007
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:780
static getCanonicalName( $name, $validate='valid')
Given unvalidated user input, return a canonical username, or false if the username is invalid...
Definition: User.php:1233
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:1263
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 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:945
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:316
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:1982
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:780
static getAutopromoteGroups(User $user)
Get the groups for the given user based on $wgAutopromote.
Definition: Autopromote.php:35
static newFromName( $wikiId, $name, $ignoreInvalidDB=false)
Factory function; get a remote user entry by name.
static whoIs( $wikiId, $id, $ignoreInvalidDB=false)
Same as User::whoIs()
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 validDatabase( $wikiId)
Confirm the selected database name is a valid local interwiki database name.
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:780
static closeElement( $element)
Shortcut to close an XML element.
Definition: Xml.php:117
static isCurrentWikiId( $wikiId)
Definition: WikiMap.php:322
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:797
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:594
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:2194
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:2633
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:1473
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:39
static showLogExtract(&$out, $types=[], $page='', $user='', $param=[])
Show log extract.