1<?php 2/* 3 * User Manager 4 * 5 * Dokuwiki Admin Plugin 6 * 7 * This version of the user manager has been modified to only work with 8 * objectified version of auth system 9 * 10 * @author neolao <neolao@neolao.com> 11 * @author Chris Smith <chris@jalakai.co.uk> 12 */ 13if(!defined('DOKU_INC')) define('DOKU_INC',realpath(dirname(__FILE__).'/../../../').'/'); 14if(!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/'); 15if(!defined('DOKU_PLUGIN_IMAGES')) define('DOKU_PLUGIN_IMAGES',DOKU_BASE.'lib/plugins/usermanager/images/'); 16require_once(DOKU_PLUGIN.'admin.php'); 17 18/** 19 * All DokuWiki plugins to extend the admin function 20 * need to inherit from this class 21 */ 22class admin_plugin_usermanager extends DokuWiki_Admin_Plugin { 23 24 var $_auth = null; // auth object 25 var $_user_total = 0; // number of registered users 26 var $_filter = array(); // user selection filter(s) 27 var $_start = 0; // index of first user to be displayed 28 var $_last = 0; // index of the last user to be displayed 29 var $_pagesize = 20; // number of users to list on one page 30 var $_user_edit = null; // set to user selected for editing 31 32 /** 33 * Constructor 34 */ 35 function admin_plugin_usermanager(){ 36 global $auth; 37 38 $this->setupLocale(); 39 if (isset($auth)) $this->_auth = & $auth; 40 } 41 42 /** 43 * return some info 44 */ 45 function getInfo(){ 46 $disabled = is_null($this->_auth) ? '(disabled)' : ''; 47 48 return array( 49 'author' => 'Chris Smith', 50 'email' => 'chris@jalakai.co.uk', 51 'date' => '2005-11-24', 52 'name' => 'User Manager', 53 'desc' => 'Manage users '.$disabled, 54 'url' => 'http://wiki.splitbrain.org/plugin:user_manager', 55 ); 56 } 57 /** 58 * return prompt for admin menu 59 */ 60 function getMenuText($language) { 61 62 if (!is_null($this->_auth)) 63 return parent::getMenuText($language); 64 65 return $this->getLang["menu"]." (objectified auth only)"; 66 } 67 68 /** 69 * return sort order for position in admin menu 70 */ 71 function getMenuSort() { 72 return 2; 73 } 74 75 /** 76 * handle user request 77 */ 78 function handle() { 79 global $ID; 80 81 if (is_null($this->_auth)) return false; 82 83 // extract the command and any specific parameters 84 // submit button name is of the form - fn[cmd][param(s)] 85 $fn = $_REQUEST['fn']; 86 87 if (is_array($fn)) { 88 $cmd = key($fn); 89 $param = is_array($fn[$cmd]) ? key($fn[$cmd]) : null; 90 } else { 91 $cmd = $fn; 92 $param = null; 93 } 94 95 if ($cmd != "search") { 96 $this->_start = $_REQUEST['start']; 97 $this->_filter = $this->_retrieveFilter(); 98 } 99 100 switch($cmd){ 101 case "add" : $this->_addUser(); break; 102 case "delete" : $this->_deleteUser(); break; 103 case "modify" : $this->_modifyUser(); break; 104 case "edit" : $this->_edit_user = $param; break; // no extra handling required - only html 105 case "search" : $this->_setFilter($param); 106 $this->_start = 0; 107 break; 108 } 109 110 $this->_user_total = $this->_auth->getUserCount($this->_filter); 111 112 // page handling 113 switch($cmd){ 114 case 'start' : $this->_start = 0; break; 115 case 'prev' : $this->_start -= $this->_pagesize; break; 116 case 'next' : $this->_start += $this->_pagesize; break; 117 case 'last' : $this->_start = $this->_user_total; break; 118 } 119 $this->_validatePagination(); 120 } 121 122 /** 123 * output appropriate html 124 */ 125 function html() { 126 global $ID; 127 128 if(is_null($this->_auth)) { 129 print $this->lang['badauth']; 130 return false; 131 } 132 133 $user_list = $this->_auth->retrieveUsers($this->_start, $this->_pagesize, $this->_filter); 134 $users = array_keys($user_list); 135 136 $page_buttons = $this->_pagination(); 137 $edit_disable = $this->_auth->canDo('modifyUser') ? '' : 'disabled="disabled"'; 138 $delete_disable = $this->_auth->canDo('deleteUsers') ? '' : 'disabled="disabled"'; 139 140 print $this->locale_xhtml('intro'); 141 print $this->locale_xhtml('list'); 142 143 ptln("<div class=\"level2\" style=\"margin-bottom: 2em;\">"); 144 145 if ($this->_user_total) { 146 ptln("<p>".sprintf($this->lang['summary'],$this->_start+1,$this->_last,$this->_user_total,$this->_auth->getUserCount())."</p>"); 147 } else { 148 ptln("<p>".sprintf($this->lang['nonefound'],$this->_auth->getUserCount())."</p>"); 149 } 150 ptln("<form action=\"".wl($ID)."\" method=\"post\">"); 151 ptln(" <table class=\"inline\">"); 152 ptln(" <thead>"); 153 ptln(" <tr>"); 154 ptln(" <th colspan=\"2\"> </th><th>".$this->lang["user_id"]."</th><th>".$this->lang["user_name"]."</th><th>".$this->lang["user_mail"]."</th><th>".$this->lang["user_groups"]."</th>"); 155 ptln(" </tr>"); 156 157 ptln(" <tr>"); 158// ptln(" <td colspan=\"2\"><input type=\"submit\" name=\"fn[search][new]\" value=\"".$this->lang['search']."\" /></td>"); 159 ptln(" <td colspan=\"2\" style=\"vertical-align:middle; text-align:right;\"><input type=\"image\" src=\"".DOKU_PLUGIN_IMAGES."search.png\" name=\"fn[search][new]\" title=\"".$this->lang['search_prompt']."\" alt=\"".$this->lang['search']."\" /></td>"); 160 ptln(" <td><input type=\"text\" name=\"userid\" value=\"".$this->_htmlFilter('user')."\" /></td>"); 161 ptln(" <td><input type=\"text\" name=\"username\" value=\"".$this->_htmlFilter('name')."\" /></td>"); 162 ptln(" <td><input type=\"text\" name=\"usermail\" value=\"".$this->_htmlFilter('mail')."\" /></td>"); 163 ptln(" <td><input type=\"text\" name=\"usergroups\" value=\"".$this->_htmlFilter('grps')."\" /></td>"); 164 ptln(" </tr>"); 165 ptln(" </thead>"); 166 167 if ($this->_user_total) { 168 ptln(" <tbody>"); 169 foreach ($user_list as $user => $userinfo) { 170 extract($userinfo); 171 $groups = join(', ',$grps); 172 ptln(" <tr valign=\"top\" align=\"left\">"); 173 ptln(" <td class=\"centeralign\"><input type=\"checkbox\" name=\"delete[".$user."]\" ".$delete_disable." /></td>"); 174// ptln(" <td class=\"centeralign\"><input type=\"submit\" name=\"fn[edit][".$user."]\" ".$edit_disable." value=\"".$this->lang['edit']."\"/></td>"); 175 ptln(" <td class=\"centeralign\"><input type=\"image\" name=\"fn[edit][".$user."]\" ".$edit_disable." src=\"".DOKU_PLUGIN_IMAGES."user_edit.png\" title=\"".$this->lang['edit_prompt']."\" alt=\"".$this->lang['edit']."\"/></td>"); 176 ptln(" <td>".hsc($user)."</td><td>".hsc($name)."</td><td>".hsc($mail)."</td><td>".hsc($groups)."</td>"); 177 ptln(" </tr>"); 178 } 179 ptln(" </tbody>"); 180 } 181 182 ptln(" <tbody>"); 183 ptln(" <tr><td colspan=\"6\" style=\"text-align:center\">"); 184 ptln(" <span style=\"float:left\">"); 185 ptln(" <input type=\"submit\" name=\"fn[delete]\" ".$delete_disable." value=\"".$this->lang['delete_selected']."\"/>"); 186 ptln(" </span>"); 187 ptln(" <span style=\"float:right\">"); 188 ptln(" <input type=\"submit\" name=\"fn[start]\" ".$page_buttons['start']." value=\"".$this->lang['start']."\" />"); 189 ptln(" <input type=\"submit\" name=\"fn[prev]\" ".$page_buttons['prev']." value=\"".$this->lang['prev']."\" />"); 190 ptln(" <input type=\"submit\" name=\"fn[next]\" ".$page_buttons['next']." value=\"".$this->lang['next']."\" />"); 191 ptln(" <input type=\"submit\" name=\"fn[last]\" ".$page_buttons['last']." value=\"".$this->lang['last']."\" />"); 192 ptln(" </span>"); 193 ptln(" <input type=\"submit\" name=\"fn[search][clear]\" value=\"".$this->lang['clear']."\" />"); 194 ptln(" </td></tr>"); 195 ptln(" </tbody>"); 196 ptln(" </table>"); 197 ptln(" <input type=\"hidden\" name=\"do\" value=\"admin\" />"); 198 ptln(" <input type=\"hidden\" name=\"page\" value=\"usermanager\" />"); 199 200 $this->_htmlFilterSettings(2); 201 202 ptln("</form>"); 203 ptln("</div>"); 204 205 $style = $this->_edit_user ? " style=\"width: 46%; float: left;\"" : ""; 206 207 if ($this->_auth->canDo('createUser')) { 208 ptln("<div".$style.">"); 209 print $this->locale_xhtml('add'); 210 ptln(" <div class=\"level2\">"); 211 212 $this->_htmlUserForm('add',null,4); 213 214 ptln(" </div>"); 215 ptln("</div>"); 216 } 217 218 if($this->_edit_user && $this->_auth->canDo('modifyUser')){ 219 ptln("<div".$style.">"); 220 print $this->locale_xhtml('edit'); 221 ptln(" <div class=\"level2\">"); 222 223 $this->_htmlUserForm('modify',$this->_edit_user,4); 224 225 ptln(" </div>"); 226 ptln("</div>"); 227 } 228 } 229 230 function _htmlUserForm($cmd,$user=null,$indent=0) { 231 232 if ($user) { 233 extract($this->_auth->getUserData($user)); 234 $groups = join(',',$grps); 235 } else { 236 $user = $name = $mail = $groups = ''; 237 } 238 239 ptln("<form action=\"".wl($ID)."\" method=\"post\">",$indent); 240 ptln(" <table class=\"inline\">",$indent); 241 ptln(" <thead>",$indent); 242 ptln(" <tr><th>".$this->lang["field"]."</th><th>".$this->lang["value"]."</th></tr>",$indent); 243 ptln(" </thead>",$indent); 244 ptln(" <tbody>",$indent); 245 ptln(" <tr><td><label for=\"".$cmd."_userid\" >".$this->lang["user_id"]." : </label></td><td><input type=\"text\" id=\"".$cmd."_userid\" name=\"userid\" value=\"".$user."\" /></td></tr>",$indent); 246 ptln(" <tr><td><label for=\"".$cmd."_userpass\" >".$this->lang["user_pass"]." : </label></td><td><input type=\"text\" id=\"".$cmd."_userpass\" name=\"userpass\" value=\"\" /></td></tr>",$indent); 247 ptln(" <tr><td><label for=\"".$cmd."_username\" >".$this->lang["user_name"]." : </label></td><td><input type=\"text\" id=\"".$cmd."_username\" name=\"username\" value=\"".$name."\" /></td></tr>",$indent); 248 ptln(" <tr><td><label for=\"".$cmd."_usermail\" >".$this->lang["user_mail"]." : </label></td><td><input type=\"text\" id=\"".$cmd."_usermail\" name=\"usermail\" value=\"".$mail."\" /></td></tr>",$indent); 249 ptln(" <tr><td><label for=\"".$cmd."_usergroups\" >".$this->lang["user_groups"]." : </label></td><td><input type=\"text\" id=\"".$cmd."_usergroups\" name=\"usergroups\" value=\"".$groups."\" /></td></tr>",$indent); 250 ptln(" </tbody>",$indent); 251 ptln(" <tbody>",$indent); 252 ptln(" <tr>",$indent); 253 ptln(" <td colspan=\"2\">",$indent); 254 ptln(" <input type=\"hidden\" name=\"do\" value=\"admin\" />",$indent); 255 ptln(" <input type=\"hidden\" name=\"page\" value=\"usermanager\" />",$indent); 256 257 // save current $user, we need this to access details if the name is changed 258 if ($user) 259 ptln(" <input type=\"hidden\" name=\"userid_old\" value=\"".$user."\" />",$indent); 260 261 $this->_htmlFilterSettings($indent+10); 262 263 ptln(" <input type=\"submit\" name=\"fn[".$cmd."]\" value=\"".$this->lang[$cmd]."\" />",$indent); 264 ptln(" </td>",$indent); 265 ptln(" </tr>",$indent); 266 ptln(" </tbody>",$indent); 267 ptln(" </table>",$indent); 268 ptln("</form>",$indent); 269 } 270 271 function _htmlFilter($key) { 272 if (empty($this->_filter)) return ''; 273 return (isset($this->_filter[$key]) ? hsc($this->_filter[$key]) : ''); 274 } 275 276 function _htmlFilterSettings($indent=0) { 277 278 ptln("<input type=\"hidden\" name=\"start\" value=\"".$this->_start."\" />",$indent); 279 280 foreach ($this->_filter as $key => $filter) { 281 ptln("<input type=\"hidden\" name=\"filter[".$key."]\" value=\"".hsc($filter)."\" />",$indent); 282 } 283 } 284 285 function _addUser(){ 286 287 if (!$this->_auth->canDo('createUser')) return false; 288 289 list($user,$pass,$name,$mail,$grps) = $this->_retrieveUser(); 290 if (empty($user)) return false; 291 292 return $this->_auth->createUser($user,$pass,$name,$mail,$grps); 293 } 294 295 /** 296 * Delete user 297 */ 298 function _deleteUser(){ 299 300 if (!$this->_auth->canDo('deleteUsers')) return false; 301 302 $selected = $_REQUEST['delete']; 303 if (!is_array($selected) || empty($selected)) return false; 304 $selected = array_keys($selected); 305 306 $count = $this->_auth->deleteUsers($selected); 307 if ($count == count($selected)) { 308 $text = str_replace('%d', $count, $this->lang['delete_ok']); 309 msg("$text.", 1); 310 } else { 311 $part1 = str_replace('%d', $count, $this->lang['delete_ok']); 312 $part2 = str_replace('%d', (count($selected)-$count), $this->lang['delete_fail']); 313 msg("$part1, $part2",-1); 314 } 315 } 316 317 /** 318 * Modify user 319 */ 320 function _modifyUser(){ 321 if (!$this->_auth->canDo('modifyUser')) return false; 322 323 list($user,$pass,$name,$mail,$grps) = $this->_retrieveUser(); 324 if (empty($user)) return false; 325 326 $changes = array(); 327 $user_old = cleanID(preg_replace('/.*:/','',$_REQUEST['userid_old'])); 328 if ($user != $user_old) { 329 // check $user doesn't already exist 330 if ($this->_auth->getUserData($user)) { 331 msg(sprintf($this->lang['update_exists'],$user),-1); 332 $this->_edit_user = $user = $user_old; 333 } else { 334 $changes['user'] = $user; 335 $user = $user_old; 336 } 337 } 338 339 if (!empty($pass)) $changes['pass'] = $pass; 340 if (!empty($name)) $changes['name'] = $name; 341 if (!empty($mail)) $changes['mail'] = $mail; 342 if (!empty($grps)) $changes['grps'] = $grps; 343 344 if ($this->_auth->modifyUser($user, $changes)) { 345 msg($this->lang['update_ok'],1); 346 } else { 347 msg($this->lang['update_fail'],-1); 348 } 349 } 350 351 /* 352 * retrieve & clean user data from the form 353 * return an array(user, password, full name, email, array(groups)) 354 */ 355 function _retrieveUser($clean=true) { 356 357 $user[0] = ($clean) ? cleanID(preg_replace('/.*:/','',$_REQUEST['userid'])) : $_REQUEST['userid']; 358 $user[1] = $_REQUEST['userpass']; 359 $user[2] = $_REQUEST['username']; 360 $user[3] = $_REQUEST['usermail']; 361 $user[4] = preg_split('/\s*,\s*/',$_REQUEST['usergroups'],-1,PREG_SPLIT_NO_EMPTY); 362 363 if (is_array($user[4]) && (count($user[4]) == 1) && (trim($user[4][0]) == '')) { 364 $user[4] = null; 365 } 366 367 return $user; 368 } 369 370 function _setFilter($op) { 371 372 $this->_filter = array(); 373 374 if ($op == 'new') { 375 list($user,$pass,$name,$mail,$grps) = $this->_retrieveUser(false); 376 377 if (!empty($user)) $this->_filter['user'] = $user; 378 if (!empty($name)) $this->_filter['name'] = $name; 379 if (!empty($mail)) $this->_filter['mail'] = $mail; 380 if (!empty($grps)) $this->_filter['grps'] = join('|',$grps); 381 } 382 } 383 384 function _retrieveFilter() { 385 386 $t_filter = $_REQUEST['filter']; 387 if (!is_array($t_filter)) return array(); 388 389 // messy, but this way we ensure we aren't getting any additional crap from malicious users 390 $filter = array(); 391 392 if (isset($t_filter['user'])) $filter['user'] = $t_filter['user']; 393 if (isset($t_filter['name'])) $filter['name'] = $t_filter['name']; 394 if (isset($t_filter['mail'])) $filter['mail'] = $t_filter['mail']; 395 if (isset($t_filter['grps'])) $filter['grps'] = $t_filter['grps']; 396 397 return $filter; 398 } 399 400 function _validatePagination() { 401 402 if ($this->_start >= $this->_user_total) { 403 $this->_start = $this->_user_total - $this->_pagesize; 404 } 405 if ($this->_start < 0) $this->_start = 0; 406 407 $this->_last = min($this->_user_total, $this->_start + $this->_pagesize); 408 } 409 410 /* 411 * return an array of strings to enable/disable pagination buttons 412 */ 413 function _pagination() { 414 415 $buttons['start'] = $buttons['prev'] = ($this->_start == 0) ? 'disabled="disabled"' : ''; 416 $buttons['last'] = $buttons['next'] = (($this->_start + $this->_pagesize) >= $this->_user_total) ? 'disabled="disabled"' : ''; 417 418 return $buttons; 419 } 420} 421