* Special page to allow managing user group membership
*
* @addtogroup SpecialPage
- * @todo This code is disgusting and needs a total rewrite
+ * @todo Use checkboxes or something, this list thing is incomprehensible to
+ * normal human beings.
*/
-/** */
-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';
- $this->mReason = $request->getText( 'user-reason' );
-
- $titleObj = SpecialPage::getTitleFor( 'Userrights' );
- $this->action = $titleObj->escapeLocalURL();
+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() {
+ 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( $this->mPosted ) {
- // show some more forms
- if( $this->mRequest->getCheck( 'ssearchuser' ) ) {
- $this->editUserGroupsForm( $this->mRequest->getVal( 'user-editname' ) );
- }
+ if( $wgRequest->wasPosted() ) {
// 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 );
+ 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.
* @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 = '') {
- $split = $this->splitUsername( $username );
- if( WikiError::isError( $split ) ) {
- $wgOut->addWikiText( wfMsg( 'userrights-nodatabase', $split->getMessage() ) );
- return;
- }
-
- list( $database, $name ) = $split;
- $this->db =& $this->getDB( $database );
- $userid = $this->getUserId( $database, $name );
+ global $wgUser, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
- if( $userid == 0) {
- $wgOut->addWikiText( wfMsg( 'nosuchusershort', wfEscapeWikiText( $username ) ) );
+ $user = $this->fetchUser( $username );
+ if( !$user ) {
return;
}
-
- global $wgUser;
- if ($database != '' && !$wgUser->isAllowed('userrights-interwiki')) {
- $wgOut->addWikiText( wfMsg( 'userrights-no-interwiki' ) );
- 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'];
}
- $oldGroups = $this->getUserGroups( $database, $userid );
+ $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(isset($removegroup)) {
+ // remove then add groups
+ if( $removegroup ) {
$newGroups = array_diff($newGroups, $removegroup);
foreach( $removegroup as $group ) {
- $this->removeUserGroup( $database, $userid, $group );
+ $user->removeGroup( $group );
}
}
- if(isset($addgroup)) {
+ if( $addgroup ) {
$newGroups = array_merge($newGroups, $addgroup);
foreach( $addgroup as $group ) {
- $this->addUserGroup( $database, $userid, $group );
+ $user->addGroup( $group );
}
}
$newGroups = array_unique( $newGroups );
// Ensure that caches are cleared
- $this->touchUser( $database, $userid );
+ $user->invalidateCache();
wfDebug( 'oldGroups: ' . print_r( $oldGroups, true ) );
wfDebug( 'newGroups: ' . print_r( $newGroups, true ) );
- wfRunHooks( 'UserRights', array( &$u, $addgroup, $removegroup ) );
+ if( $user instanceof User ) {
+ // hmmm
+ wfRunHooks( 'UserRights', array( &$user, $addgroup, $removegroup ) );
+ }
- $log = new LogPage( 'rights' );
- $log->addEntry( 'rights', Title::makeTitle( NS_USER, $username ), $this->mReason, array( $this->makeGroupNameList( $oldGroups ),
- $this->makeGroupNameList( $newGroups ) ) );
+ 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, $wgUser;
-
- $split = $this->splitUsername( $username );
- if( WikiError::isError( $split ) ) {
- $wgOut->addWikiText( wfMsg( 'userrights-nodatabase', $split->getMessage() ) );
- return;
- }
-
- list( $database, $name ) = $split;
- $this->db =& $this->getDB( $database );
- $userid = $this->getUserId( $database, $name );
-
- if( $name == '' ) {
- $wgOut->addWikiText( wfMsg( 'nouserspecified' ) );
- return;
- } elseif( $userid == 0) {
- $wgOut->addWikiText( wfMsg( 'nosuchusershort', wfEscapeWikiText( $username ) ) );
- return;
- }
+ function editUserGroupsForm( $username ) {
+ global $wgOut;
- global $wgUser;
- if ($database != '' && !$wgUser->isAllowed('userrights-interwiki')) {
- $wgOut->addWikiText( wfMsg( 'userrights-no-interwiki' ) );
+ $user = $this->fetchUser( $username );
+ if( !$user ) {
return;
}
- $groups = $this->getUserGroups( $database, $userid );
+ $groups = $user->getGroups();
- $this->showEditUserGroupsForm( $username, $groups );
-
- if ($database == '') {
- $this->showLogFragment( User::newFromName($username), $wgOut );
- }
- }
-
- function splitUsername( $username ) {
- $parts = explode( '@', $username );
- if( count( $parts ) < 2 ) {
- return array( '', $username );
- }
- list( $name, $database ) = $parts;
+ $this->showEditUserGroupsForm( $user, $groups );
- global $wgLocalDatabases;
- return array_search( $database, $wgLocalDatabases ) !== false
- ? array( $database, $name )
- : new WikiError( 'Bogus database suffix "' . wfEscapeWikiText( $database ) . '"' );
+ // 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 );
}
/**
- * Open a database connection to work on for the requested user.
- * This may be a new connection to another database for remote users.
- * @param string $database
- * @return Database
+ * 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 &getDB( $database ) {
- if( $database == '' ) {
- $db =& wfGetDB( DB_MASTER );
+ function fetchUser( $username ) {
+ global $wgOut, $wgUser;
+
+ $parts = explode( '@', $username );
+ if( count( $parts ) < 2 ) {
+ $name = trim( $username );
+ $database = '';
} else {
- global $wgDBuser, $wgDBpassword;
- $server = $this->getMaster( $database );
- $db = new Database( $server, $wgDBuser, $wgDBpassword, $database );
+ 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;
+ }
}
- return $db;
- }
-
- /**
- * Return the master server to connect to for the requested database.
- */
- function getMaster( $database ) {
- global $wgDBserver, $wgAlternateMaster;
- if( isset( $wgAlternateMaster[$database] ) ) {
- return $wgAlternateMaster[$database];
+
+ if( $name == '' ) {
+ $wgOut->addWikiMsg( 'nouserspecified' );
+ return false;
}
- return $wgDBserver;
- }
-
- function getUserId( $database, $name ) {
- if( $name === '' )
- return 0;
- return ( $name{0} == "#" )
- ? IntVal( substr( $name, 1 ) )
- : IntVal( $this->db->selectField( 'user',
- 'user_id',
- array( 'user_name' => $name ),
- 'MakesysopStewardForm::getUserId' ) );
- }
-
- function getUserGroups( $database, $userid ) {
- $res = $this->db->select( 'user_groups',
- array( 'ug_group' ),
- array( 'ug_user' => $userid ),
- 'MakesysopStewardForm::getUserGroups' );
- $groups = array();
- while( $row = $this->db->fetchObject( $res ) ) {
- $groups[] = $row->ug_group;
+
+ 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;
+ }
}
- return $groups;
- }
-
- function addUserGroup( $database, $userid, $group ) {
- $this->db->insert( 'user_groups',
- array(
- 'ug_user' => $userid,
- 'ug_group' => $group,
- ),
- 'MakesysopStewardForm::addUserGroup',
- array( 'IGNORE' ) );
- }
-
- function removeUserGroup( $database, $userid, $group ) {
- $this->db->delete( 'user_groups',
- array(
- 'ug_user' => $userid,
- 'ug_group' => $group,
- ),
- 'MakesysopStewardForm::addUserGroup' );
- }
-
- function touchUser( $database, $userid ) {
- $this->db->update( 'user',
- array( 'user_touched' => $this->db->timestamp() ),
- array( 'user_id' => $userid ),
- 'MakesysopStewardForm::touchUser' );
- global $wgMemc;
- if ( function_exists( 'wfForeignMemcKey' ) ) {
- $key = wfForeignMemcKey( $database, false, 'user', 'id', $userid );
+ if( $database == '' ) {
+ $user = User::newFromName( $name );
} else {
- $key = "$database:user:id:$userid";
+ $user = UserRightsProxy::newFromName( $database, $name );
+ }
+
+ if( !$user || $user->isAnon() ) {
+ $wgOut->addWikiMsg( 'nosuchusershort', $username );
+ return null;
}
- $wgMemc->delete( $key );
+
+ return $user;
}
function makeGroupNameList( $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' ) );
+ 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-editname', 'username', 30, $username ) . '</p>';
- $form .= '<p>' . Xml::submitButton( wfMsg( 'editusergroup' ), array( 'name' => 'ssearchuser' ) ) . '</p>';
+ $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 );
* @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($removable, $groups ); // Can't remove groups the user doesn't have
- $addable = array_diff( $addable, $groups ); // Can't add groups the user does have
+
+ $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 $username String: Name of user you're editing
+ * @param $user User or UserRightsProxy you're editing
* @param $groups Array: Array of groups the user is in
*/
- protected function showEditUserGroupsForm( $username, $groups ) {
+ 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->action, 'name' => 'editGroup' ) ) .
- Xml::hidden( 'user-editname', $username ) .
- Xml::hidden( 'wpEditToken', $wgUser->editToken( $username ) ) .
+ Xml::openElement( 'form', array( 'method' => 'post', 'action' => $this->getTitle()->escapeLocalURL(), 'name' => 'editGroup' ) ) .
+ Xml::hidden( 'user', $this->mTarget ) .
+ Xml::hidden( 'wpEditToken', $wgUser->editToken( $this->mTarget ) ) .
Xml::openElement( 'fieldset' ) .
Xml::element( 'legend', array(), wfMsg( 'userrights-editusergroup' ) ) .
- $wgOut->parse( wfMsg( 'editinguser', $username ) ) .
+ wfMsgExt( 'editinguser', array( 'parse' ),
+ wfEscapeWikiText( $user->getName() ) ) .
+ $grouplist .
$this->explainRights() .
"<table border='0'>
<tr>
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
*/
private function explainRights() {
global $wgUser, $wgLang;
-
+
$out = array();
- list( $add, $remove ) = array_values( $this->changeableGroups() );
-
+ list( $add, $remove, $addself, $rmself ) = array_values( $this->changeableGroups() );
+
if( count( $add ) > 0 )
- $out[] = wfMsgExt( 'userrights-available-add', 'parseinline', $wgLang->listToText( $add ) );
+ $out[] = wfMsgExt( 'userrights-available-add', 'parseinline',
+ $wgLang->listToText( $add ), count( $add ) );
if( count( $remove ) > 0 )
- $out[] = wfMsgExt( 'userrights-available-remove', 'parseinline', $wgLang->listToText( $remove ) );
-
+ $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( ' ', $out )
+ ? implode( '<br />', $out )
: wfMsgExt( 'userrights-available-none', 'parseinline' );
}
* @return string XHTML <select> element
*/
private function removeSelect( $groups ) {
- return $this->doSelect( $groups, 'member' );
+ return $this->doSelect( $groups, 'removable' );
}
/**
* 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'
+ * @param string $name 'removable' or 'available'
* @return string XHTML <select> element
*/
private function doSelect( $groups, $name ) {
* @return Array array( 'add' => array( addablegroups ), 'remove' => array( removablegroups ) )
*/
function changeableGroups() {
- global $wgUser;
+ global $wgUser, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
- $groups = array( 'add' => array(), 'remove' => array() );
+ 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) {
*
* @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( $wgGroupPermissions[$group]['userrights'] == true ) {
- // 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
+ global $wgAddGroups, $wgRemoveGroups;
+
$groups = array( 'add' => array(), 'remove' => array() );
if( empty($wgAddGroups[$group]) ) {
// Don't add anything to $groups
$viewer->showList( $output );
}
-}
\ No newline at end of file
+}
dépôts / lhc / web / wiklou.git / blobdiff