includes/SpecialUserrights.php

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