includes/SpecialUserrights.php

   1 <?php
   2
   3 /**
   4  * Special page to allow managing user group membership
   5  *
   6  * @package MediaWiki
   7  * @subpackage Special pages
   8  * @todo This code is disgusting and needs a total rewrite
   9  */
  10
  11 /** */
  12 require_once('HTMLForm.php');
  13
  14 /** Entry point */
  15 function wfSpecialUserrights() {
  16         global $wgRequest;
  17         $form = new UserrightsForm($wgRequest);
  18         $form->execute();
  19 }
  20
  21 /**
  22  * A class to manage user levels rights.
  23  * @package MediaWiki
  24  * @subpackage SpecialPage
  25  */
  26 class UserrightsForm extends HTMLForm {
  27         var $mPosted, $mRequest, $mSaveprefs;
  28         /** Escaped local url name*/
  29         var $action;
  30
  31         /** Constructor*/
  32         function UserrightsForm ( &$request ) {
  33                 $this->mPosted = $request->wasPosted();
  34                 $this->mRequest =& $request;
  35                 $this->mName = 'userrights';
  36
  37                 $titleObj = SpecialPage::getTitleFor( 'Userrights' );
  38                 $this->action = $titleObj->escapeLocalURL();
  39         }
  40
  41         /**
  42          * Manage forms to be shown according to posted data.
  43          * Depending on the submit button used, call a form or a save function.
  44          */
  45         function execute() {
  46                 // show the general form
  47                 $this->switchForm();
  48                 if( $this->mPosted ) {
  49                         // show some more forms
  50                         if( $this->mRequest->getCheck( 'ssearchuser' ) ) {
  51                                 $this->editUserGroupsForm( $this->mRequest->getVal( 'user-editname' ) );
  52                         }
  53
  54                         // save settings
  55                         if( $this->mRequest->getCheck( 'saveusergroups' ) ) {
  56                                 global $wgUser;
  57                                 $username = $this->mRequest->getVal( 'user-editname' );
  58                                 if( $wgUser->matchEditToken( $this->mRequest->getVal( 'wpEditToken' ), $username ) ) {
  59                                         $this->saveUserGroups( $username,
  60                                                 $this->mRequest->getArray( 'member' ),
  61                                                 $this->mRequest->getArray( 'available' ) );
  62                                 }
  63                         }
  64                 }
  65         }
  66
  67         /**
  68          * Save user groups changes in the database.
  69          * Data comes from the editUserGroupsForm() form function
  70          *
  71          * @param string $username Username to apply changes to.
  72          * @param array $removegroup id of groups to be removed.
  73          * @param array $addgroup id of groups to be added.
  74          *
  75          */
  76         function saveUserGroups( $username, $removegroup, $addgroup) {
  77                 global $wgOut;
  78                 $u = User::newFromName($username);
  79
  80                 if(is_null($u)) {
  81                         $wgOut->addWikiText( wfMsg( 'nosuchusershort', htmlspecialchars( $username ) ) );
  82                         return;
  83                 }
  84
  85                 if($u->getID() == 0) {
  86                         $wgOut->addWikiText( wfMsg( 'nosuchusershort', htmlspecialchars( $username ) ) );
  87                         return;
  88                 }
  89
  90                 $oldGroups = $u->getGroups();
  91                 $newGroups = $oldGroups;
  92                 // remove then add groups
  93                 if(isset($removegroup)) {
  94                         $newGroups = array_diff($newGroups, $removegroup);
  95                         foreach( $removegroup as $group ) {
  96                                 $u->removeGroup( $group );
  97                         }
  98                 }
  99                 if(isset($addgroup)) {
 100                         $newGroups = array_merge($newGroups, $addgroup);
 101                         foreach( $addgroup as $group ) {
 102                                 $u->addGroup( $group );
 103                         }
 104                 }
 105                 $newGroups = array_unique( $newGroups );
 106
 107                 wfDebug( 'oldGroups: ' . print_r( $oldGroups, true ) );
 108                 wfDebug( 'newGroups: ' . print_r( $newGroups, true ) );
 109
 110                 wfRunHooks( 'UserRights', array( &$u, $addgroup, $removegroup ) );
 111                 $log = new LogPage( 'rights' );
 112                 $log->addEntry( 'rights', Title::makeTitle( NS_USER, $u->getName() ), '', array( $this->makeGroupNameList( $oldGroups ),
 113                         $this->makeGroupNameList( $newGroups ) ) );
 114         }
 115
 116         function makeGroupNameList( $ids ) {
 117                 return implode( ', ', $ids );
 118         }
 119
 120         /**
 121          * Output a form to allow searching for a user
 122          */
 123         function switchForm() {
 124                 global $wgOut, $wgRequest;
 125                 $username = $wgRequest->getText( 'user-editname' );
 126                 $form  = Xml::openElement( 'form', array( 'method' => 'post', 'action' => $this->action, 'name' => 'uluser' ) );
 127                 $form .= '<fieldset><legend>' . wfMsgHtml( 'userrights-lookup-user' ) . '</legend>';
 128                 $form .= '<p>' . Xml::inputLabel( wfMsg( 'userrights-user-editname' ), 'user-editname', 'username', 30, $username ) . '</p>';
 129                 $form .= '<p>' . Xml::submitButton( wfMsg( 'editusergroup' ), array( 'name' => 'ssearchuser' ) ) . '</p>';
 130                 $form .= '</fieldset>';
 131                 $form .= '</form>';
 132                 $wgOut->addHTML( $form );
 133         }
 134
 135         /**
 136          * Edit user groups membership
 137          * @param string $username Name of the user.
 138          */
 139         function editUserGroupsForm($username) {
 140                 global $wgOut, $wgUser;
 141
 142                 $user = User::newFromName($username);
 143                 if( is_null( $user ) ) {
 144                         $wgOut->addWikiText( wfMsg( 'nouserspecified' ) );
 145                         return;
 146                 } elseif( $user->getID() == 0 ) {
 147                         $wgOut->addWikiText( wfMsg( 'nosuchusershort', wfEscapeWikiText( $username ) ) );
 148                         return;
 149                 }
 150
 151                 $groups = $user->getGroups();
 152
 153                 $wgOut->addHTML( "<form name=\"editGroup\" action=\"$this->action\" method=\"post\">\n".
 154                         wfElement( 'input', array(
 155                                 'type'  => 'hidden',
 156                                 'name'  => 'user-editname',
 157                                 'value' => $username ) ) .
 158                         wfElement( 'input', array(
 159                                 'type'  => 'hidden',
 160                                 'name'  => 'wpEditToken',
 161                                 'value' => $wgUser->editToken( $username ) ) ) .
 162                         $this->fieldset( 'editusergroup',
 163                         $wgOut->parse( wfMsg('editinguser', $username ) ) .
 164                         '<table border="0" align="center"><tr><td>'.
 165                         HTMLSelectGroups('member', $this->mName.'-groupsmember', $groups,true,6).
 166                         '</td><td>'.
 167                         HTMLSelectGroups('available', $this->mName.'-groupsavailable', $groups,true,6,true).
 168                         '</td></tr></table>'."\n".
 169                         $wgOut->parse( wfMsg('userrights-groupshelp') ) .
 170                         wfElement( 'input', array(
 171                                 'type'  => 'submit',
 172                                 'name'  => 'saveusergroups',
 173                                 'value' => wfMsg( 'saveusergroups' ) ) )
 174                         ));
 175                 $wgOut->addHTML( "</form>\n" );
 176         }
 177 } // end class UserrightsForm
 178 ?>