<?php
/**
* Special page to allow managing user group membership
*
* @addtogroup SpecialPage
* @todo This code is disgusting and needs a total rewrite
*/
/** */
require_once( dirname(__FILE__) . '/HTMLForm.php');
/** Entry point */
function wfSpecialUserrights() {
global $wgRequest;
$form = new UserrightsForm($wgRequest);
$form->execute();
}
/**
* A class to manage user levels rights.
* @addtogroup SpecialPage
*/
class UserrightsForm extends HTMLForm {
var $mPosted, $mRequest, $mSaveprefs;
/** Escaped local url name*/
var $action;
/** Constructor*/
public function __construct( &$request ) {
$this->mPosted = $request->wasPosted();
$this->mRequest =& $request;
$this->mName = 'userrights';
$titleObj = SpecialPage::getTitleFor( 'Userrights' );
$this->action = $titleObj->escapeLocalURL();
}
/**
* Manage forms to be shown according to posted data.
* Depending on the submit button used, call a form or a save function.
*/
function execute() {
// show the general form
$this->switchForm();
if( $this->mPosted ) {
// show some more forms
if( $this->mRequest->getCheck( 'ssearchuser' ) ) {
$this->editUserGroupsForm( $this->mRequest->getVal( 'user-editname' ) );
}
// save settings
if( $this->mRequest->getCheck( 'saveusergroups' ) ) {
global $wgUser;
$username = $this->mRequest->getVal( 'user-editname' );
$reason = $this->mRequest->getVal( 'user-reason' );
if( $wgUser->matchEditToken( $this->mRequest->getVal( 'wpEditToken' ), $username ) ) {
$this->saveUserGroups( $username,
$this->mRequest->getArray( 'member' ),
$this->mRequest->getArray( 'available' ),
$reason );
}
}
}
}
/**
* 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
*
*/
function saveUserGroups( $username, $removegroup, $addgroup, $reason = '' ) {
global $wgOut;
$u = User::newFromName($username);
if(is_null($u)) {
$wgOut->addWikiText( wfMsg( 'nosuchusershort', htmlspecialchars( $username ) ) );
return;
}
if($u->getID() == 0) {
$wgOut->addWikiText( wfMsg( 'nosuchusershort', htmlspecialchars( $username ) ) );
return;
}
$oldGroups = $u->getGroups();
$newGroups = $oldGroups;
// remove then add groups
if(isset($removegroup)) {
$newGroups = array_diff($newGroups, $removegroup);
foreach( $removegroup as $group ) {
if ( $this->canRemove( $group ) ) {
$u->removeGroup( $group );
}
}
}
if(isset($addgroup)) {
$newGroups = array_merge($newGroups, $addgroup);
foreach( $addgroup as $group ) {
if ( $this->canAdd( $group ) ) {
$u->addGroup( $group );
}
}
}
$newGroups = array_unique( $newGroups );
wfDebug( 'oldGroups: ' . print_r( $oldGroups, true ) );
wfDebug( 'newGroups: ' . print_r( $newGroups, true ) );
wfRunHooks( 'UserRights', array( &$u, $addgroup, $removegroup ) );
$log = new LogPage( 'rights' );
$log->addEntry( 'rights', Title::makeTitle( NS_USER, $u->getName() ), $reason, array( $this->makeGroupNameList( $oldGroups ),
$this->makeGroupNameList( $newGroups ) ) );
}
function makeGroupNameList( $ids ) {
return implode( ', ', $ids );
}
/**
* Output a form to allow searching for a user
*/
function switchForm() {
global $wgOut, $wgRequest;
$username = $wgRequest->getText( 'user-editname' );
$form = Xml::openElement( 'form', array( 'method' => 'post', 'action' => $this->action, 'name' => 'uluser' ) );
$form .= '<fieldset><legend>' . wfMsgHtml( 'userrights-lookup-user' ) . '</legend>';
$form .= '<p>' . Xml::inputLabel( wfMsg( 'userrights-user-editname' ), 'user-editname', 'username', 30, $username ) . '</p>';
$form .= '<p>' . Xml::submitButton( wfMsg( 'editusergroup' ), array( 'name' => 'ssearchuser' ) ) . '</p>';
$form .= '</fieldset>';
$form .= '</form>';
$wgOut->addHTML( $form );
}
/**
* Edit user groups membership
* @param string $username Name of the user.
*/
function editUserGroupsForm($username) {
global $wgOut;
$user = User::newFromName($username);
if( is_null( $user ) ) {
$wgOut->addWikiText( wfMsg( 'nouserspecified' ) );
return;
} elseif( $user->getID() == 0 ) {
$wgOut->addWikiText( wfMsg( 'nosuchusershort', wfEscapeWikiText( $username ) ) );
return;
}
$this->showEditUserGroupsForm( $username, $user->getGroups() );
$this->showLogFragment( $user, $wgOut );
}
/**
* 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 ) {
list($addable, $removable) = array_values( $this->changeableGroups() );
$removable = array_intersect($removable, $groups ); // Can't remove groups the user doesn't have
$addable = array_diff( $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 $username String: Name of user you're editing
* @param $groups Array: Array of groups the user is in
*/
protected function showEditUserGroupsForm( $username, $groups ) {
global $wgOut, $wgUser;
list( $addable, $removable ) = $this->splitGroups( $groups );
$wgOut->addHTML(
Xml::openElement( 'form', array( 'method' => 'post', 'action' => $this->action, 'name' => 'editGroup' ) ) .
Xml::hidden( 'user-editname', $username ) .
Xml::hidden( 'wpEditToken', $wgUser->editToken( $username ) ) .
Xml::openElement( 'fieldset' ) .
Xml::element( 'legend', array(), wfMsg( 'userrights-editusergroup' ) ) .
$wgOut->parse( wfMsg( 'editinguser', $username ) ) .
$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' ) ) .
"</td>
</tr>
<tr>
<td></td>
<td>" .
Xml::submitButton( wfMsg( 'saveusergroups' ), array( 'name' => 'saveusergroups' ) ) .
"</td>
</tr>
</table>\n" .
Xml::closeElement( 'fieldset' ) .
Xml::closeElement( 'form' ) . "\n"
);
}
/**
* 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 ) = array_values( $this->changeableGroups() );
if( count( $add ) > 0 )
$out[] = wfMsgExt( 'userrights-available-add', 'parseinline', $wgLang->listToText( $add ) );
if( count( $remove ) > 0 )
$out[] = wfMsgExt( 'userrights-available-remove', 'parseinline', $wgLang->listToText( $remove ) );
return count( $out ) > 0
? implode( ' ', $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, 'member' );
}
/**
* 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 'member' 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 ) )
*/
private function changeableGroups() {
global $wgUser;
$groups = array( 'add' => array(), 'remove' => array() );
$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 $wgGroupPermissions, $wgAddGroups, $wgRemoveGroups;
if( empty($wgGroupPermissions[$group]['userrights']) ) {
// This group doesn't give the right to modify anything
return array( 'add' => array(), 'remove' => array() );
}
if( empty($wgAddGroups[$group]) and empty($wgRemoveGroups[$group]) ) {
// This group gives the right to modify everything (reverse-
// compatibility with old "userrights lets you change
// everything")
return array(
'add' => User::getAllGroups(),
'remove' => User::getAllGroups()
);
}
// Okay, it's not so simple, we have to go through the arrays
$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()->getPrefixedUrl(),
)
)
)
);
$output->addHtml( "<h2>" . htmlspecialchars( LogPage::logName( 'rights' ) ) . "</h2>\n" );
$viewer->showList( $output );
}
}
