summaryrefslogtreecommitdiff
path: root/includes/SpecialUserrights.php
diff options
context:
space:
mode:
Diffstat (limited to 'includes/SpecialUserrights.php')
-rw-r--r--includes/SpecialUserrights.php575
1 files changed, 0 insertions, 575 deletions
diff --git a/includes/SpecialUserrights.php b/includes/SpecialUserrights.php
deleted file mode 100644
index 48fb3628..00000000
--- a/includes/SpecialUserrights.php
+++ /dev/null
@@ -1,575 +0,0 @@
-<?php
-
-/**
- * Special page to allow managing user group membership
- *
- * @addtogroup SpecialPage
- * @todo Use checkboxes or something, this list thing is incomprehensible to
- * normal human beings.
- */
-
-/**
- * A class to manage user levels rights.
- * @addtogroup SpecialPage
- */
-class UserrightsPage extends SpecialPage {
- # The target of the local right-adjuster's interest. Can be gotten from
- # either a GET parameter or a subpage-style parameter, so have a member
- # variable for it.
- protected $mTarget;
- protected $isself = false;
-
- public function __construct() {
- parent::__construct( 'Userrights' );
- }
-
- public function isRestricted() {
- return true;
- }
-
- public function userCanExecute( $user ) {
- $available = $this->changeableGroups();
- return !empty( $available['add'] )
- or !empty( $available['remove'] )
- or ($this->isself and
- (!empty( $available['add-self'] )
- or !empty( $available['remove-self'] )));
- }
-
- /**
- * Manage forms to be shown according to posted data.
- * Depending on the submit button used, call a form or a save function.
- *
- * @param mixed $par String if any subpage provided, else null
- */
- function execute( $par ) {
- // If the visitor doesn't have permissions to assign or remove
- // any groups, it's a bit silly to give them the user search prompt.
- global $wgUser, $wgRequest;
-
- if( $par ) {
- $this->mTarget = $par;
- } else {
- $this->mTarget = $wgRequest->getVal( 'user' );
- }
-
- if (!$this->mTarget) {
- /*
- * If the user specified no target, and they can only
- * edit their own groups, automatically set them as the
- * target.
- */
- $available = $this->changeableGroups();
- if (empty($available['add']) && empty($available['remove']))
- $this->mTarget = $wgUser->getName();
- }
-
- if ($this->mTarget == $wgUser->getName())
- $this->isself = true;
-
- if( !$this->userCanExecute( $wgUser ) ) {
- // fixme... there may be intermediate groups we can mention.
- global $wgOut;
- $wgOut->showPermissionsErrorPage( array(
- $wgUser->isAnon()
- ? 'userrights-nologin'
- : 'userrights-notallowed' ) );
- return;
- }
-
- if ( wfReadOnly() ) {
- global $wgOut;
- $wgOut->readOnlyPage();
- return;
- }
-
- $this->outputHeader();
-
- $this->setHeaders();
-
- // show the general form
- $this->switchForm();
-
- if( $wgRequest->wasPosted() ) {
- // save settings
- if( $wgRequest->getCheck( 'saveusergroups' ) ) {
- $reason = $wgRequest->getVal( 'user-reason' );
- if( $wgUser->matchEditToken( $wgRequest->getVal( 'wpEditToken' ), $this->mTarget ) ) {
- $this->saveUserGroups(
- $this->mTarget,
- $wgRequest->getArray( 'removable' ),
- $wgRequest->getArray( 'available' ),
- $reason
- );
- }
- }
- }
-
- // show some more forms
- if( $this->mTarget ) {
- $this->editUserGroupsForm( $this->mTarget );
- }
- }
-
- /**
- * Save user groups changes in the database.
- * Data comes from the editUserGroupsForm() form function
- *
- * @param string $username Username to apply changes to.
- * @param array $removegroup id of groups to be removed.
- * @param array $addgroup id of groups to be added.
- * @param string $reason Reason for group change
- * @return null
- */
- function saveUserGroups( $username, $removegroup, $addgroup, $reason = '') {
- global $wgUser, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
-
- $user = $this->fetchUser( $username );
- if( !$user ) {
- return;
- }
-
- // Validate input set...
- $changeable = $this->changeableGroups();
- if ($wgUser->getId() != 0 && $wgUser->getId() == $user->getId()) {
- $addable = array_merge($changeable['add'], $wgGroupsAddToSelf);
- $removable = array_merge($changeable['remove'], $wgGroupsRemoveFromSelf);
- } else {
- $addable = $changeable['add'];
- $removable = $changeable['remove'];
- }
-
- $removegroup = array_unique(
- array_intersect( (array)$removegroup, $removable ) );
- $addgroup = array_unique(
- array_intersect( (array)$addgroup, $addable ) );
-
- $oldGroups = $user->getGroups();
- $newGroups = $oldGroups;
- // remove then add groups
- if( $removegroup ) {
- $newGroups = array_diff($newGroups, $removegroup);
- foreach( $removegroup as $group ) {
- $user->removeGroup( $group );
- }
- }
- if( $addgroup ) {
- $newGroups = array_merge($newGroups, $addgroup);
- foreach( $addgroup as $group ) {
- $user->addGroup( $group );
- }
- }
- $newGroups = array_unique( $newGroups );
-
- // Ensure that caches are cleared
- $user->invalidateCache();
-
- wfDebug( 'oldGroups: ' . print_r( $oldGroups, true ) );
- wfDebug( 'newGroups: ' . print_r( $newGroups, true ) );
- if( $user instanceof User ) {
- // hmmm
- wfRunHooks( 'UserRights', array( &$user, $addgroup, $removegroup ) );
- }
-
- if( $newGroups != $oldGroups ) {
- $log = new LogPage( 'rights' );
-
- global $wgRequest;
- $log->addEntry( 'rights',
- $user->getUserPage(),
- $wgRequest->getText( 'user-reason' ),
- array(
- $this->makeGroupNameList( $oldGroups ),
- $this->makeGroupNameList( $newGroups )
- )
- );
- }
- }
-
- /**
- * Edit user groups membership
- * @param string $username Name of the user.
- */
- function editUserGroupsForm( $username ) {
- global $wgOut;
-
- $user = $this->fetchUser( $username );
- if( !$user ) {
- return;
- }
-
- $groups = $user->getGroups();
-
- $this->showEditUserGroupsForm( $user, $groups );
-
- // This isn't really ideal logging behavior, but let's not hide the
- // interwiki logs if we're using them as is.
- $this->showLogFragment( $user, $wgOut );
- }
-
- /**
- * Normalize the input username, which may be local or remote, and
- * return a user (or proxy) object for manipulating it.
- *
- * Side effects: error output for invalid access
- * @return mixed User, UserRightsProxy, or null
- */
- function fetchUser( $username ) {
- global $wgOut, $wgUser;
-
- $parts = explode( '@', $username );
- if( count( $parts ) < 2 ) {
- $name = trim( $username );
- $database = '';
- } else {
- list( $name, $database ) = array_map( 'trim', $parts );
-
- if( !$wgUser->isAllowed( 'userrights-interwiki' ) ) {
- $wgOut->addWikiMsg( 'userrights-no-interwiki' );
- return null;
- }
- if( !UserRightsProxy::validDatabase( $database ) ) {
- $wgOut->addWikiMsg( 'userrights-nodatabase', $database );
- return null;
- }
- }
-
- if( $name == '' ) {
- $wgOut->addWikiMsg( 'nouserspecified' );
- return false;
- }
-
- if( $name{0} == '#' ) {
- // Numeric ID can be specified...
- // We'll do a lookup for the name internally.
- $id = intval( substr( $name, 1 ) );
-
- if( $database == '' ) {
- $name = User::whoIs( $id );
- } else {
- $name = UserRightsProxy::whoIs( $database, $id );
- }
-
- if( !$name ) {
- $wgOut->addWikiMsg( 'noname' );
- return null;
- }
- }
-
- if( $database == '' ) {
- $user = User::newFromName( $name );
- } else {
- $user = UserRightsProxy::newFromName( $database, $name );
- }
-
- if( !$user || $user->isAnon() ) {
- $wgOut->addWikiMsg( 'nosuchusershort', $username );
- return null;
- }
-
- return $user;
- }
-
- function makeGroupNameList( $ids ) {
- return implode( ', ', $ids );
- }
-
- /**
- * Output a form to allow searching for a user
- */
- function switchForm() {
- global $wgOut, $wgScript;
- $form = Xml::openElement( 'form', array( 'method' => 'get', 'action' => $wgScript, 'name' => 'uluser' ) );
- $form .= Xml::hidden( 'title', 'Special:Userrights' );
- $form .= '<fieldset><legend>' . wfMsgHtml( 'userrights-lookup-user' ) . '</legend>';
- $form .= '<p>' . Xml::inputLabel( wfMsg( 'userrights-user-editname' ), 'user', 'username', 30, $this->mTarget ) . '</p>';
- $form .= '<p>' . Xml::submitButton( wfMsg( 'editusergroup' ) ) . '</p>';
- $form .= '</fieldset>';
- $form .= '</form>';
- $wgOut->addHTML( $form );
- }
-
- /**
- * Go through used and available groups and return the ones that this
- * form will be able to manipulate based on the current user's system
- * permissions.
- *
- * @param $groups Array: list of groups the given user is in
- * @return Array: Tuple of addable, then removable groups
- */
- protected function splitGroups( $groups ) {
- global $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
- list($addable, $removable) = array_values( $this->changeableGroups() );
-
- $removable = array_intersect(
- array_merge($this->isself ? $wgGroupsRemoveFromSelf : array(), $removable),
- $groups ); // Can't remove groups the user doesn't have
- $addable = array_diff(
- array_merge($this->isself ? $wgGroupsAddToSelf : array(), $addable),
- $groups ); // Can't add groups the user does have
-
- return array( $addable, $removable );
- }
-
- /**
- * Show the form to edit group memberships.
- *
- * @todo make all CSS-y and semantic
- * @param $user User or UserRightsProxy you're editing
- * @param $groups Array: Array of groups the user is in
- */
- protected function showEditUserGroupsForm( $user, $groups ) {
- global $wgOut, $wgUser;
-
- list( $addable, $removable ) = $this->splitGroups( $groups );
-
- $list = array();
- foreach( $user->getGroups() as $group )
- $list[] = self::buildGroupLink( $group );
-
- $grouplist = '';
- if( count( $list ) > 0 ) {
- $grouplist = '<p>' . wfMsgHtml( 'userrights-groupsmember' ) . ' ' . implode( ', ', $list ) . '</p>';
- }
- $wgOut->addHTML(
- Xml::openElement( 'form', array( 'method' => 'post', 'action' => $this->getTitle()->escapeLocalURL(), 'name' => 'editGroup' ) ) .
- Xml::hidden( 'user', $user->getName() ) .
- Xml::hidden( 'wpEditToken', $wgUser->editToken( $user->getName() ) ) .
- Xml::openElement( 'fieldset' ) .
- Xml::element( 'legend', array(), wfMsg( 'userrights-editusergroup' ) ) .
- wfMsgExt( 'editinguser', array( 'parse' ),
- wfEscapeWikiText( $user->getName() ) ) .
- $grouplist .
- $this->explainRights() .
- "<table border='0'>
- <tr>
- <td></td>
- <td>
- <table width='400'>
- <tr>
- <td width='50%'>" . $this->removeSelect( $removable ) . "</td>
- <td width='50%'>" . $this->addSelect( $addable ) . "</td>
- </tr>
- </table>
- </tr>
- <tr>
- <td colspan='2'>" .
- $wgOut->parse( wfMsg('userrights-groupshelp') ) .
- "</td>
- </tr>
- <tr>
- <td>" .
- Xml::label( wfMsg( 'userrights-reason' ), 'wpReason' ) .
- "</td>
- <td>" .
- Xml::input( 'user-reason', 60, false, array( 'id' => 'wpReason', 'maxlength' => 255 ) ) .
- "</td>
- </tr>
- <tr>
- <td></td>
- <td>" .
- Xml::submitButton( wfMsg( 'saveusergroups' ), array( 'name' => 'saveusergroups' ) ) .
- "</td>
- </tr>
- </table>\n" .
- Xml::closeElement( 'fieldset' ) .
- Xml::closeElement( 'form' ) . "\n"
- );
- }
-
- /**
- * Format a link to a group description page
- *
- * @param string $group
- * @return string
- */
- private static function buildGroupLink( $group ) {
- static $cache = array();
- if( !isset( $cache[$group] ) )
- $cache[$group] = User::makeGroupLinkHtml( $group, User::getGroupMember( $group ) );
- return $cache[$group];
- }
-
- /**
- * Prepare a list of groups the user is able to add and remove
- *
- * @return string
- */
- private function explainRights() {
- global $wgUser, $wgLang;
-
- $out = array();
- list( $add, $remove, $addself, $rmself ) = array_values( $this->changeableGroups() );
-
- if( count( $add ) > 0 )
- $out[] = wfMsgExt( 'userrights-available-add', 'parseinline',
- $wgLang->listToText( $add ), count( $add ) );
- if( count( $remove ) > 0 )
- $out[] = wfMsgExt( 'userrights-available-remove', 'parseinline',
- $wgLang->listToText( $remove ), count( $add ) );
- if( count( $addself ) > 0 )
- $out[] = wfMsgExt( 'userrights-available-add-self', 'parseinline',
- $wgLang->listToText( $addself ), count( $addself ) );
- if( count( $rmself ) > 0 )
- $out[] = wfMsgExt( 'userrights-available-remove-self', 'parseinline',
- $wgLang->listToText( $rmself ), count( $rmself ) );
-
- return count( $out ) > 0
- ? implode( '<br />', $out )
- : wfMsgExt( 'userrights-available-none', 'parseinline' );
- }
-
- /**
- * Adds the <select> thingie where you can select what groups to remove
- *
- * @param array $groups The groups that can be removed
- * @return string XHTML <select> element
- */
- private function removeSelect( $groups ) {
- return $this->doSelect( $groups, 'removable' );
- }
-
- /**
- * Adds the <select> thingie where you can select what groups to add
- *
- * @param array $groups The groups that can be added
- * @return string XHTML <select> element
- */
- private function addSelect( $groups ) {
- return $this->doSelect( $groups, 'available' );
- }
-
- /**
- * Adds the <select> thingie where you can select what groups to add/remove
- *
- * @param array $groups The groups that can be added/removed
- * @param string $name 'removable' or 'available'
- * @return string XHTML <select> element
- */
- private function doSelect( $groups, $name ) {
- $ret = wfMsgHtml( "{$this->mName}-groups$name" ) .
- Xml::openElement( 'select', array(
- 'name' => "{$name}[]",
- 'multiple' => 'multiple',
- 'size' => '6',
- 'style' => 'width: 100%;'
- )
- );
- foreach ($groups as $group) {
- $ret .= Xml::element( 'option', array( 'value' => $group ), User::getGroupName( $group ) );
- }
- $ret .= Xml::closeElement( 'select' );
- return $ret;
- }
-
- /**
- * @param string $group The name of the group to check
- * @return bool Can we remove the group?
- */
- private function canRemove( $group ) {
- // $this->changeableGroups()['remove'] doesn't work, of course. Thanks,
- // PHP.
- $groups = $this->changeableGroups();
- return in_array( $group, $groups['remove'] );
- }
-
- /**
- * @param string $group The name of the group to check
- * @return bool Can we add the group?
- */
- private function canAdd( $group ) {
- $groups = $this->changeableGroups();
- return in_array( $group, $groups['add'] );
- }
-
- /**
- * Returns an array of the groups that the user can add/remove.
- *
- * @return Array array( 'add' => array( addablegroups ), 'remove' => array( removablegroups ) )
- */
- function changeableGroups() {
- global $wgUser, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
-
- if( $wgUser->isAllowed( 'userrights' ) ) {
- // This group gives the right to modify everything (reverse-
- // compatibility with old "userrights lets you change
- // everything")
- // Using array_merge to make the groups reindexed
- $all = array_merge( User::getAllGroups() );
- return array(
- 'add' => $all,
- 'remove' => $all,
- 'add-self' => array(),
- 'remove-self' => array()
- );
- }
-
- // Okay, it's not so simple, we will have to go through the arrays
- $groups = array(
- 'add' => array(),
- 'remove' => array(),
- 'add-self' => $wgGroupsAddToSelf,
- 'remove-self' => $wgGroupsRemoveFromSelf);
- $addergroups = $wgUser->getEffectiveGroups();
-
- foreach ($addergroups as $addergroup) {
- $groups = array_merge_recursive(
- $groups, $this->changeableByGroup($addergroup)
- );
- $groups['add'] = array_unique( $groups['add'] );
- $groups['remove'] = array_unique( $groups['remove'] );
- }
- return $groups;
- }
-
- /**
- * Returns an array of the groups that a particular group can add/remove.
- *
- * @param String $group The group to check for whether it can add/remove
- * @return Array array( 'add' => array( addablegroups ), 'remove' => array( removablegroups ) )
- */
- private function changeableByGroup( $group ) {
- global $wgAddGroups, $wgRemoveGroups;
-
- $groups = array( 'add' => array(), 'remove' => array() );
- if( empty($wgAddGroups[$group]) ) {
- // Don't add anything to $groups
- } elseif( $wgAddGroups[$group] === true ) {
- // You get everything
- $groups['add'] = User::getAllGroups();
- } elseif( is_array($wgAddGroups[$group]) ) {
- $groups['add'] = $wgAddGroups[$group];
- }
-
- // Same thing for remove
- if( empty($wgRemoveGroups[$group]) ) {
- } elseif($wgRemoveGroups[$group] === true ) {
- $groups['remove'] = User::getAllGroups();
- } elseif( is_array($wgRemoveGroups[$group]) ) {
- $groups['remove'] = $wgRemoveGroups[$group];
- }
- return $groups;
- }
-
- /**
- * Show a rights log fragment for the specified user
- *
- * @param User $user User to show log for
- * @param OutputPage $output OutputPage to use
- */
- protected function showLogFragment( $user, $output ) {
- $viewer = new LogViewer(
- new LogReader(
- new FauxRequest(
- array(
- 'type' => 'rights',
- 'page' => $user->getUserPage()->getPrefixedText(),
- )
- )
- )
- );
- $output->addHtml( "<h2>" . htmlspecialchars( LogPage::logName( 'rights' ) ) . "</h2>\n" );
- $viewer->showList( $output );
- }
-
-}
generated by cgit v1.2.2 (git 2.25.0) at 2024-04-25 21:20:21 +0000