xref: /dokuwiki/lib/plugins/usermanager/admin.php (revision ed6bf75f5a78a346e3c3192b2bab79450e206598) 
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 */
13// must be run within Dokuwiki
14if(!defined('DOKU_INC')) die();
15
16if(!defined('DOKU_PLUGIN_IMAGES')) define('DOKU_PLUGIN_IMAGES',DOKU_BASE.'lib/plugins/usermanager/images/');
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    protected $_auth = null;        // auth object
25    protected $_user_total = 0;     // number of registered users
26    protected $_filter = array();   // user selection filter(s)
27    protected $_start = 0;          // index of first user to be displayed
28    protected $_last = 0;           // index of the last user to be displayed
29    protected $_pagesize = 20;      // number of users to list on one page
30    protected $_edit_user = '';     // set to user selected for editing
31    protected $_edit_userdata = array();
32    protected $_disabled = '';      // if disabled set to explanatory string
33    protected $_import_failures = array();
34
35    /**
36     * Constructor
37     */
38    public function admin_plugin_usermanager(){
39        /** @var DokuWiki_Auth_Plugin $auth */
40        global $auth;
41
42        $this->setupLocale();
43
44        if (!isset($auth)) {
45            $this->_disabled = $this->lang['noauth'];
46        } else if (!$auth->canDo('getUsers')) {
47            $this->_disabled = $this->lang['nosupport'];
48        } else {
49
50            // we're good to go
51            $this->_auth = & $auth;
52
53        }
54
55        // attempt to retrieve any import failures from the session
56        if ($_SESSION['import_failures']){
57            $this->_import_failures = $_SESSION['import_failures'];
58        }
59    }
60
61     /**
62      * Return prompt for admin menu
63      */
64    public function getMenuText($language) {
65
66        if (!is_null($this->_auth))
67          return parent::getMenuText($language);
68
69        return $this->getLang('menu').' '.$this->_disabled;
70    }
71
72    /**
73     * return sort order for position in admin menu
74     */
75    public function getMenuSort() {
76        return 2;
77    }
78
79    /**
80     * Handle user request
81     */
82    public function handle() {
83        global $INPUT;
84        if (is_null($this->_auth)) return false;
85
86        // extract the command and any specific parameters
87        // submit button name is of the form - fn[cmd][param(s)]
88        $fn   = $INPUT->param('fn');
89
90        if (is_array($fn)) {
91            $cmd = key($fn);
92            $param = is_array($fn[$cmd]) ? key($fn[$cmd]) : null;
93        } else {
94            $cmd = $fn;
95            $param = null;
96        }
97
98        if ($cmd != "search") {
99            $this->_start = $INPUT->int('start', 0);
100            $this->_filter = $this->_retrieveFilter();
101        }
102
103        switch($cmd){
104            case "add"    : $this->_addUser(); break;
105            case "delete" : $this->_deleteUser(); break;
106            case "modify" : $this->_modifyUser(); break;
107            case "edit"   : $this->_editUser($param); break;
108            case "search" : $this->_setFilter($param);
109                            $this->_start = 0;
110                            break;
111            case "export" : $this->_export(); break;
112            case "import" : $this->_import(); break;
113            case "importfails" : $this->_downloadImportFailures(); break;
114        }
115
116        $this->_user_total = $this->_auth->canDo('getUserCount') ? $this->_auth->getUserCount($this->_filter) : -1;
117
118        // page handling
119        switch($cmd){
120            case 'start' : $this->_start = 0; break;
121            case 'prev'  : $this->_start -= $this->_pagesize; break;
122            case 'next'  : $this->_start += $this->_pagesize; break;
123            case 'last'  : $this->_start = $this->_user_total; break;
124        }
125        $this->_validatePagination();
126        return true;
127    }
128
129    /**
130     * Output appropriate html
131     */
132    public function html() {
133        global $ID;
134
135        if(is_null($this->_auth)) {
136            print $this->lang['badauth'];
137            return false;
138        }
139
140        $user_list = $this->_auth->retrieveUsers($this->_start, $this->_pagesize, $this->_filter);
141
142        $page_buttons = $this->_pagination();
143        $delete_disable = $this->_auth->canDo('delUser') ? '' : 'disabled="disabled"';
144
145        $editable = $this->_auth->canDo('UserMod');
146        $export_label = empty($this->_filter) ? $this->lang['export_all'] : $this->lang['export_filtered'];
147
148        print $this->locale_xhtml('intro');
149        print $this->locale_xhtml('list');
150
151        ptln("<div id=\"user__manager\">");
152        ptln("<div class=\"level2\">");
153
154        if ($this->_user_total > 0) {
155            ptln("<p>".sprintf($this->lang['summary'],$this->_start+1,$this->_last,$this->_user_total,$this->_auth->getUserCount())."</p>");
156        } else {
157            if($this->_user_total < 0) {
158                $allUserTotal = 0;
159            } else {
160                $allUserTotal = $this->_auth->getUserCount();
161            }
162            ptln("<p>".sprintf($this->lang['nonefound'], $allUserTotal)."</p>");
163        }
164        ptln("<form action=\"".wl($ID)."\" method=\"post\">");
165        formSecurityToken();
166        ptln("  <div class=\"table\">");
167        ptln("  <table class=\"inline\">");
168        ptln("    <thead>");
169        ptln("      <tr>");
170        ptln("        <th>&#160;</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>");
171        ptln("      </tr>");
172
173        ptln("      <tr>");
174        ptln("        <td class=\"rightalign\"><input type=\"image\" src=\"".DOKU_PLUGIN_IMAGES."search.png\" name=\"fn[search][new]\" title=\"".$this->lang['search_prompt']."\" alt=\"".$this->lang['search']."\" class=\"button\" /></td>");
175        ptln("        <td><input type=\"text\" name=\"userid\" class=\"edit\" value=\"".$this->_htmlFilter('user')."\" /></td>");
176        ptln("        <td><input type=\"text\" name=\"username\" class=\"edit\" value=\"".$this->_htmlFilter('name')."\" /></td>");
177        ptln("        <td><input type=\"text\" name=\"usermail\" class=\"edit\" value=\"".$this->_htmlFilter('mail')."\" /></td>");
178        ptln("        <td><input type=\"text\" name=\"usergroups\" class=\"edit\" value=\"".$this->_htmlFilter('grps')."\" /></td>");
179        ptln("      </tr>");
180        ptln("    </thead>");
181
182        if ($this->_user_total) {
183            ptln("    <tbody>");
184            foreach ($user_list as $user => $userinfo) {
185                extract($userinfo);
186                /**
187                 * @var string $name
188                 * @var string $pass
189                 * @var string $mail
190                 * @var array  $grps
191                 */
192                $groups = join(', ',$grps);
193                ptln("    <tr class=\"user_info\">");
194                ptln("      <td class=\"centeralign\"><input type=\"checkbox\" name=\"delete[".$user."]\" ".$delete_disable." /></td>");
195                if ($editable) {
196                    ptln("    <td><a href=\"".wl($ID,array('fn[edit]['.hsc($user).']' => 1,
197                                                           'do' => 'admin',
198                                                           'page' => 'usermanager',
199                                                           'sectok' => getSecurityToken())).
200                         "\" title=\"".$this->lang['edit_prompt']."\">".hsc($user)."</a></td>");
201                } else {
202                    ptln("    <td>".hsc($user)."</td>");
203                }
204                ptln("      <td>".hsc($name)."</td><td>".hsc($mail)."</td><td>".hsc($groups)."</td>");
205                ptln("    </tr>");
206            }
207            ptln("    </tbody>");
208        }
209
210        ptln("    <tbody>");
211        ptln("      <tr><td colspan=\"5\" class=\"centeralign\">");
212        ptln("        <span class=\"medialeft\">");
213        ptln("          <input type=\"submit\" name=\"fn[delete]\" ".$delete_disable." class=\"button\" value=\"".$this->lang['delete_selected']."\" id=\"usrmgr__del\" />");
214        ptln("        </span>");
215        ptln("        <span class=\"mediaright\">");
216        ptln("          <input type=\"submit\" name=\"fn[start]\" ".$page_buttons['start']." class=\"button\" value=\"".$this->lang['start']."\" />");
217        ptln("          <input type=\"submit\" name=\"fn[prev]\" ".$page_buttons['prev']." class=\"button\" value=\"".$this->lang['prev']."\" />");
218        ptln("          <input type=\"submit\" name=\"fn[next]\" ".$page_buttons['next']." class=\"button\" value=\"".$this->lang['next']."\" />");
219        ptln("          <input type=\"submit\" name=\"fn[last]\" ".$page_buttons['last']." class=\"button\" value=\"".$this->lang['last']."\" />");
220        ptln("        </span>");
221        if (!empty($this->_filter)) {
222            ptln("    <input type=\"submit\" name=\"fn[search][clear]\" class=\"button\" value=\"".$this->lang['clear']."\" />");
223        }
224        ptln("        <input type=\"submit\" name=\"fn[export]\" class=\"button\" value=\"".$export_label."\" />");
225        ptln("        <input type=\"hidden\" name=\"do\"    value=\"admin\" />");
226        ptln("        <input type=\"hidden\" name=\"page\"  value=\"usermanager\" />");
227
228        $this->_htmlFilterSettings(2);
229
230        ptln("      </td></tr>");
231        ptln("    </tbody>");
232        ptln("  </table>");
233        ptln("  </div>");
234
235        ptln("</form>");
236        ptln("</div>");
237
238        $style = $this->_edit_user ? " class=\"edit_user\"" : "";
239
240        if ($this->_auth->canDo('addUser')) {
241            ptln("<div".$style.">");
242            print $this->locale_xhtml('add');
243            ptln("  <div class=\"level2\">");
244
245            $this->_htmlUserForm('add',null,array(),4);
246
247            ptln("  </div>");
248            ptln("</div>");
249        }
250
251        if($this->_edit_user  && $this->_auth->canDo('UserMod')){
252            ptln("<div".$style." id=\"scroll__here\">");
253            print $this->locale_xhtml('edit');
254            ptln("  <div class=\"level2\">");
255
256            $this->_htmlUserForm('modify',$this->_edit_user,$this->_edit_userdata,4);
257
258            ptln("  </div>");
259            ptln("</div>");
260        }
261
262        if ($this->_auth->canDo('addUser')) {
263            $this->_htmlImportForm();
264        }
265        ptln("</div>");
266        return true;
267    }
268
269    /**
270     * Display form to add or modify a user
271     *
272     * @param string $cmd 'add' or 'modify'
273     * @param string $user id of user
274     * @param array  $userdata array with name, mail, pass and grps
275     * @param int    $indent
276     */
277    protected function _htmlUserForm($cmd,$user='',$userdata=array(),$indent=0) {
278        global $conf;
279        global $ID;
280
281        $name = $mail = $groups = '';
282        $notes = array();
283
284        if ($user) {
285            extract($userdata);
286            if (!empty($grps)) $groups = join(',',$grps);
287        } else {
288            $notes[] = sprintf($this->lang['note_group'],$conf['defaultgroup']);
289        }
290
291        ptln("<form action=\"".wl($ID)."\" method=\"post\">",$indent);
292        formSecurityToken();
293        ptln("  <div class=\"table\">",$indent);
294        ptln("  <table class=\"inline\">",$indent);
295        ptln("    <thead>",$indent);
296        ptln("      <tr><th>".$this->lang["field"]."</th><th>".$this->lang["value"]."</th></tr>",$indent);
297        ptln("    </thead>",$indent);
298        ptln("    <tbody>",$indent);
299
300        $this->_htmlInputField($cmd."_userid",    "userid",    $this->lang["user_id"],    $user,  $this->_auth->canDo("modLogin"), $indent+6);
301        $this->_htmlInputField($cmd."_userpass",  "userpass",  $this->lang["user_pass"],  "",     $this->_auth->canDo("modPass"),  $indent+6);
302        $this->_htmlInputField($cmd."_username",  "username",  $this->lang["user_name"],  $name,  $this->_auth->canDo("modName"),  $indent+6);
303        $this->_htmlInputField($cmd."_usermail",  "usermail",  $this->lang["user_mail"],  $mail,  $this->_auth->canDo("modMail"),  $indent+6);
304        $this->_htmlInputField($cmd."_usergroups","usergroups",$this->lang["user_groups"],$groups,$this->_auth->canDo("modGroups"),$indent+6);
305
306        if ($this->_auth->canDo("modPass")) {
307            if ($cmd == 'add') {
308                $notes[] = $this->lang['note_pass'];
309            }
310            if ($user) {
311                $notes[] = $this->lang['note_notify'];
312            }
313
314            ptln("<tr><td><label for=\"".$cmd."_usernotify\" >".$this->lang["user_notify"].": </label></td><td><input type=\"checkbox\" id=\"".$cmd."_usernotify\" name=\"usernotify\" value=\"1\" /></td></tr>", $indent);
315        }
316
317        ptln("    </tbody>",$indent);
318        ptln("    <tbody>",$indent);
319        ptln("      <tr>",$indent);
320        ptln("        <td colspan=\"2\">",$indent);
321        ptln("          <input type=\"hidden\" name=\"do\"    value=\"admin\" />",$indent);
322        ptln("          <input type=\"hidden\" name=\"page\"  value=\"usermanager\" />",$indent);
323
324        // save current $user, we need this to access details if the name is changed
325        if ($user)
326          ptln("          <input type=\"hidden\" name=\"userid_old\"  value=\"".$user."\" />",$indent);
327
328        $this->_htmlFilterSettings($indent+10);
329
330        ptln("          <input type=\"submit\" name=\"fn[".$cmd."]\" class=\"button\" value=\"".$this->lang[$cmd]."\" />",$indent);
331        ptln("        </td>",$indent);
332        ptln("      </tr>",$indent);
333        ptln("    </tbody>",$indent);
334        ptln("  </table>",$indent);
335
336        if ($notes) {
337            ptln("    <ul class=\"notes\">");
338            foreach ($notes as $note) {
339                ptln("      <li><span class=\"li\">".$note."</span></li>",$indent);
340            }
341            ptln("    </ul>");
342        }
343        ptln("  </div>",$indent);
344        ptln("</form>",$indent);
345    }
346
347    /**
348     * Prints a inputfield
349     *
350     * @param string $id
351     * @param string $name
352     * @param string $label
353     * @param string $value
354     * @param bool   $cando whether auth backend is capable to do this action
355     * @param int $indent
356     */
357    protected function _htmlInputField($id, $name, $label, $value, $cando, $indent=0) {
358        $class = $cando ? '' : ' class="disabled"';
359        echo str_pad('',$indent);
360
361        if($name == 'userpass'){
362            $fieldtype = 'password';
363            $autocomp  = 'autocomplete="off"';
364        }elseif($name == 'usermail'){
365            $fieldtype = 'email';
366            $autocomp  = '';
367        }else{
368            $fieldtype = 'text';
369            $autocomp  = '';
370        }
371
372        echo "<tr $class>";
373        echo "<td><label for=\"$id\" >$label: </label></td>";
374        echo "<td>";
375        if($cando){
376            echo "<input type=\"$fieldtype\" id=\"$id\" name=\"$name\" value=\"$value\" class=\"edit\" $autocomp />";
377        }else{
378            echo "<input type=\"hidden\" name=\"$name\" value=\"$value\" />";
379            echo "<input type=\"$fieldtype\" id=\"$id\" name=\"$name\" value=\"$value\" class=\"edit disabled\" disabled=\"disabled\" />";
380        }
381        echo "</td>";
382        echo "</tr>";
383    }
384
385    /**
386     * Returns htmlescaped filter value
387     *
388     * @param string $key name of search field
389     * @return string html escaped value
390     */
391    protected function _htmlFilter($key) {
392        if (empty($this->_filter)) return '';
393        return (isset($this->_filter[$key]) ? hsc($this->_filter[$key]) : '');
394    }
395
396    /**
397     * Print hidden inputs with the current filter values
398     *
399     * @param int $indent
400     */
401    protected function _htmlFilterSettings($indent=0) {
402
403        ptln("<input type=\"hidden\" name=\"start\" value=\"".$this->_start."\" />",$indent);
404
405        foreach ($this->_filter as $key => $filter) {
406            ptln("<input type=\"hidden\" name=\"filter[".$key."]\" value=\"".hsc($filter)."\" />",$indent);
407        }
408    }
409
410    /**
411     * Print import form and summary of previous import
412     *
413     * @param int $indent
414     */
415    protected function _htmlImportForm($indent=0) {
416        global $ID;
417
418        $failure_download_link = wl($ID,array('do'=>'admin','page'=>'usermanager','fn[importfails]'=>1));
419
420        ptln('<div class="level2 import_users">',$indent);
421        print $this->locale_xhtml('import');
422        ptln('  <form action="'.wl($ID).'" method="post" enctype="multipart/form-data">',$indent);
423        formSecurityToken();
424        ptln('    <label>'.$this->lang['import_userlistcsv'].'<input type="file" name="import" /></label>',$indent);
425        ptln('    <input type="submit" name="fn[import]" value="'.$this->lang['import'].'" />',$indent);
426        ptln('    <input type="hidden" name="do"    value="admin" />',$indent);
427        ptln('    <input type="hidden" name="page"  value="usermanager" />',$indent);
428
429        $this->_htmlFilterSettings($indent+4);
430        ptln('  </form>',$indent);
431        ptln('</div>');
432
433        // list failures from the previous import
434        if ($this->_import_failures) {
435            $digits = strlen(count($this->_import_failures));
436            ptln('<div class="level3 import_failures">',$indent);
437            ptln('  <h3>'.$this->lang['import_header'].'</h3>');
438            ptln('  <table class="import_failures">',$indent);
439            ptln('    <thead>',$indent);
440            ptln('      <tr>',$indent);
441            ptln('        <th class="line">'.$this->lang['line'].'</th>',$indent);
442            ptln('        <th class="error">'.$this->lang['error'].'</th>',$indent);
443            ptln('        <th class="userid">'.$this->lang['user_id'].'</th>',$indent);
444            ptln('        <th class="username">'.$this->lang['user_name'].'</th>',$indent);
445            ptln('        <th class="usermail">'.$this->lang['user_mail'].'</th>',$indent);
446            ptln('        <th class="usergroups">'.$this->lang['user_groups'].'</th>',$indent);
447            ptln('      </tr>',$indent);
448            ptln('    </thead>',$indent);
449            ptln('    <tbody>',$indent);
450            foreach ($this->_import_failures as $line => $failure) {
451                ptln('      <tr>',$indent);
452                ptln('        <td class="lineno"> '.sprintf('%0'.$digits.'d',$line).' </td>',$indent);
453                ptln('        <td class="error">' .$failure['error'].' </td>', $indent);
454                ptln('        <td class="field userid"> '.hsc($failure['user'][0]).' </td>',$indent);
455                ptln('        <td class="field username"> '.hsc($failure['user'][2]).' </td>',$indent);
456                ptln('        <td class="field usermail"> '.hsc($failure['user'][3]).' </td>',$indent);
457                ptln('        <td class="field usergroups"> '.hsc($failure['user'][4]).' </td>',$indent);
458                ptln('      </tr>',$indent);
459            }
460            ptln('    </tbody>',$indent);
461            ptln('  </table>',$indent);
462            ptln('  <p><a href="'.$failure_download_link.'">'.$this->lang['import_downloadfailures'].'</a></p>');
463            ptln('</div>');
464        }
465
466    }
467
468    /**
469     * Add an user to auth backend
470     *
471     * @return bool whether succesful
472     */
473    protected function _addUser(){
474        global $INPUT;
475        if (!checkSecurityToken()) return false;
476        if (!$this->_auth->canDo('addUser')) return false;
477
478        list($user,$pass,$name,$mail,$grps) = $this->_retrieveUser();
479        if (empty($user)) return false;
480
481        if ($this->_auth->canDo('modPass')){
482            if (empty($pass)){
483                if($INPUT->has('usernotify')){
484                    $pass = auth_pwgen($user);
485                } else {
486                    msg($this->lang['add_fail'], -1);
487                    return false;
488                }
489            }
490        } else {
491            if (!empty($pass)){
492                msg($this->lang['add_fail'], -1);
493                return false;
494            }
495        }
496
497        if ($this->_auth->canDo('modName')){
498            if (empty($name)){
499                msg($this->lang['add_fail'], -1);
500                return false;
501            }
502        } else {
503            if (!empty($name)){
504                return false;
505            }
506        }
507
508        if ($this->_auth->canDo('modMail')){
509            if (empty($mail)){
510                msg($this->lang['add_fail'], -1);
511                return false;
512            }
513        } else {
514            if (!empty($mail)){
515                return false;
516            }
517        }
518
519        if ($ok = $this->_auth->triggerUserMod('create', array($user,$pass,$name,$mail,$grps))) {
520
521            msg($this->lang['add_ok'], 1);
522
523            if ($INPUT->has('usernotify') && $pass) {
524                $this->_notifyUser($user,$pass);
525            }
526        } else {
527            msg($this->lang['add_fail'], -1);
528        }
529
530        return $ok;
531    }
532
533    /**
534     * Delete user from auth backend
535     *
536     * @return bool whether succesful
537     */
538    protected function _deleteUser(){
539        global $conf, $INPUT;
540
541        if (!checkSecurityToken()) return false;
542        if (!$this->_auth->canDo('delUser')) return false;
543
544        $selected = $INPUT->arr('delete');
545        if (empty($selected)) return false;
546        $selected = array_keys($selected);
547
548        if(in_array($_SERVER['REMOTE_USER'], $selected)) {
549            msg("You can't delete yourself!", -1);
550            return false;
551        }
552
553        $count = $this->_auth->triggerUserMod('delete', array($selected));
554        if ($count == count($selected)) {
555            $text = str_replace('%d', $count, $this->lang['delete_ok']);
556            msg("$text.", 1);
557        } else {
558            $part1 = str_replace('%d', $count, $this->lang['delete_ok']);
559            $part2 = str_replace('%d', (count($selected)-$count), $this->lang['delete_fail']);
560            msg("$part1, $part2",-1);
561        }
562
563        // invalidate all sessions
564        io_saveFile($conf['cachedir'].'/sessionpurge',time());
565
566        return true;
567    }
568
569    /**
570     * Edit user (a user has been selected for editing)
571     *
572     * @param string $param id of the user
573     * @return bool whether succesful
574     */
575    protected function _editUser($param) {
576        if (!checkSecurityToken()) return false;
577        if (!$this->_auth->canDo('UserMod')) return false;
578        $user = $this->_auth->cleanUser(preg_replace('/.*[:\/]/','',$param));
579        $userdata = $this->_auth->getUserData($user);
580
581        // no user found?
582        if (!$userdata) {
583            msg($this->lang['edit_usermissing'],-1);
584            return false;
585        }
586
587        $this->_edit_user = $user;
588        $this->_edit_userdata = $userdata;
589
590        return true;
591    }
592
593    /**
594     * Modify user in the auth backend (modified user data has been recieved)
595     *
596     * @return bool whether succesful
597     */
598    protected function _modifyUser(){
599        global $conf, $INPUT;
600
601        if (!checkSecurityToken()) return false;
602        if (!$this->_auth->canDo('UserMod')) return false;
603
604        // get currently valid  user data
605        $olduser = $this->_auth->cleanUser(preg_replace('/.*[:\/]/','',$INPUT->str('userid_old')));
606        $oldinfo = $this->_auth->getUserData($olduser);
607
608        // get new user data subject to change
609        list($newuser,$newpass,$newname,$newmail,$newgrps) = $this->_retrieveUser();
610        if (empty($newuser)) return false;
611
612        $changes = array();
613        if ($newuser != $olduser) {
614
615            if (!$this->_auth->canDo('modLogin')) {        // sanity check, shouldn't be possible
616                msg($this->lang['update_fail'],-1);
617                return false;
618            }
619
620            // check if $newuser already exists
621            if ($this->_auth->getUserData($newuser)) {
622                msg(sprintf($this->lang['update_exists'],$newuser),-1);
623                $re_edit = true;
624            } else {
625                $changes['user'] = $newuser;
626            }
627        }
628
629        // generate password if left empty and notification is on
630        if($INPUT->has('usernotify') && empty($newpass)){
631            $newpass = auth_pwgen($olduser);
632        }
633
634        if (!empty($newpass) && $this->_auth->canDo('modPass'))
635          $changes['pass'] = $newpass;
636        if (!empty($newname) && $this->_auth->canDo('modName') && $newname != $oldinfo['name'])
637          $changes['name'] = $newname;
638        if (!empty($newmail) && $this->_auth->canDo('modMail') && $newmail != $oldinfo['mail'])
639          $changes['mail'] = $newmail;
640        if (!empty($newgrps) && $this->_auth->canDo('modGroups') && $newgrps != $oldinfo['grps'])
641          $changes['grps'] = $newgrps;
642
643        if ($ok = $this->_auth->triggerUserMod('modify', array($olduser, $changes))) {
644            msg($this->lang['update_ok'],1);
645
646            if ($INPUT->has('usernotify') && $newpass) {
647                $notify = empty($changes['user']) ? $olduser : $newuser;
648                $this->_notifyUser($notify,$newpass);
649            }
650
651            // invalidate all sessions
652            io_saveFile($conf['cachedir'].'/sessionpurge',time());
653
654        } else {
655            msg($this->lang['update_fail'],-1);
656        }
657
658        if (!empty($re_edit)) {
659            $this->_editUser($olduser);
660        }
661
662        return $ok;
663    }
664
665    /**
666     * Send password change notification email
667     *
668     * @param string $user         id of user
669     * @param string $password     plain text
670     * @param bool   $status_alert whether status alert should be shown
671     * @return bool whether succesful
672     */
673    protected function _notifyUser($user, $password, $status_alert=true) {
674
675        if ($sent = auth_sendPassword($user,$password)) {
676            if ($status_alert) {
677                msg($this->lang['notify_ok'], 1);
678            }
679        } else {
680            if ($status_alert) {
681                msg($this->lang['notify_fail'], -1);
682            }
683        }
684
685        return $sent;
686    }
687
688    /**
689     * Retrieve & clean user data from the form
690     *
691     * @param bool $clean whether the cleanUser method of the authentication backend is applied
692     * @return array (user, password, full name, email, array(groups))
693     */
694    protected function _retrieveUser($clean=true) {
695        /** @var DokuWiki_Auth_Plugin $auth */
696        global $auth;
697        global $INPUT;
698
699        $user[0] = ($clean) ? $auth->cleanUser($INPUT->str('userid')) : $INPUT->str('userid');
700        $user[1] = $INPUT->str('userpass');
701        $user[2] = $INPUT->str('username');
702        $user[3] = $INPUT->str('usermail');
703        $user[4] = explode(',',$INPUT->str('usergroups'));
704
705        $user[4] = array_map('trim',$user[4]);
706        if($clean) $user[4] = array_map(array($auth,'cleanGroup'),$user[4]);
707        $user[4] = array_filter($user[4]);
708        $user[4] = array_unique($user[4]);
709        if(!count($user[4])) $user[4] = null;
710
711        return $user;
712    }
713
714    /**
715     * Set the filter with the current search terms or clear the filter
716     *
717     * @param string $op 'new' or 'clear'
718     */
719    protected function _setFilter($op) {
720
721        $this->_filter = array();
722
723        if ($op == 'new') {
724            list($user,$pass,$name,$mail,$grps) = $this->_retrieveUser(false);
725
726            if (!empty($user)) $this->_filter['user'] = $user;
727            if (!empty($name)) $this->_filter['name'] = $name;
728            if (!empty($mail)) $this->_filter['mail'] = $mail;
729            if (!empty($grps)) $this->_filter['grps'] = join('|',$grps);
730        }
731    }
732
733    /**
734     * Get the current search terms
735     *
736     * @return array
737     */
738    protected function _retrieveFilter() {
739        global $INPUT;
740
741        $t_filter = $INPUT->arr('filter');
742
743        // messy, but this way we ensure we aren't getting any additional crap from malicious users
744        $filter = array();
745
746        if (isset($t_filter['user'])) $filter['user'] = $t_filter['user'];
747        if (isset($t_filter['name'])) $filter['name'] = $t_filter['name'];
748        if (isset($t_filter['mail'])) $filter['mail'] = $t_filter['mail'];
749        if (isset($t_filter['grps'])) $filter['grps'] = $t_filter['grps'];
750
751        return $filter;
752    }
753
754    /**
755     * Validate and improve the pagination values
756     */
757    protected function _validatePagination() {
758
759        if ($this->_start >= $this->_user_total) {
760            $this->_start = $this->_user_total - $this->_pagesize;
761        }
762        if ($this->_start < 0) $this->_start = 0;
763
764        $this->_last = min($this->_user_total, $this->_start + $this->_pagesize);
765    }
766
767    /**
768     * Return an array of strings to enable/disable pagination buttons
769     *
770     * @return array with enable/disable attributes
771     */
772    protected function _pagination() {
773
774        $disabled = 'disabled="disabled"';
775
776        $buttons['start'] = $buttons['prev'] = ($this->_start == 0) ? $disabled : '';
777
778        if ($this->_user_total == -1) {
779            $buttons['last'] = $disabled;
780            $buttons['next'] = '';
781        } else {
782            $buttons['last'] = $buttons['next'] = (($this->_start + $this->_pagesize) >= $this->_user_total) ? $disabled : '';
783        }
784
785        return $buttons;
786    }
787
788    /**
789     * Export a list of users in csv format using the current filter criteria
790     */
791    protected function _export() {
792        // list of users for export - based on current filter criteria
793        $user_list = $this->_auth->retrieveUsers(0, 0, $this->_filter);
794        $column_headings = array(
795            $this->lang["user_id"],
796            $this->lang["user_name"],
797            $this->lang["user_mail"],
798            $this->lang["user_groups"]
799        );
800
801        // ==============================================================================================
802        // GENERATE OUTPUT
803        // normal headers for downloading...
804        header('Content-type: text/csv;charset=utf-8');
805        header('Content-Disposition: attachment; filename="wikiusers.csv"');
806#       // for debugging assistance, send as text plain to the browser
807#       header('Content-type: text/plain;charset=utf-8');
808
809        // output the csv
810        $fd = fopen('php://output','w');
811        fputcsv($fd, $column_headings);
812        foreach ($user_list as $user => $info) {
813            $line = array($user, $info['name'], $info['mail'], join(',',$info['grps']));
814            fputcsv($fd, $line);
815        }
816        fclose($fd);
817        if (defined('DOKU_UNITTEST')){ return; }
818
819        die;
820    }
821
822    /**
823     * Import a file of users in csv format
824     *
825     * csv file should have 4 columns, user_id, full name, email, groups (comma separated)
826     *
827     * @return bool whether successful
828     */
829    protected function _import() {
830        // check we are allowed to add users
831        if (!checkSecurityToken()) return false;
832        if (!$this->_auth->canDo('addUser')) return false;
833
834        // check file uploaded ok.
835        if (empty($_FILES['import']['size']) || !empty($_FILES['import']['error']) && $this->_isUploadedFile($_FILES['import']['tmp_name'])) {
836            msg($this->lang['import_error_upload'],-1);
837            return false;
838        }
839        // retrieve users from the file
840        $this->_import_failures = array();
841        $import_success_count = 0;
842        $import_fail_count = 0;
843        $line = 0;
844        $fd = fopen($_FILES['import']['tmp_name'],'r');
845        if ($fd) {
846            while($csv = fgets($fd)){
847                if (!utf8_check($csv)) {
848                    $csv = utf8_encode($csv);
849                }
850                $raw = str_getcsv($csv);
851                $error = '';                        // clean out any errors from the previous line
852                // data checks...
853                if (1 == ++$line) {
854                    if ($raw[0] == 'user_id' || $raw[0] == $this->lang['user_id']) continue;    // skip headers
855                }
856                if (count($raw) < 4) {                                        // need at least four fields
857                    $import_fail_count++;
858                    $error = sprintf($this->lang['import_error_fields'], count($raw));
859                    $this->_import_failures[$line] = array('error' => $error, 'user' => $raw, 'orig' => $csv);
860                    continue;
861                }
862                array_splice($raw,1,0,auth_pwgen());                          // splice in a generated password
863                $clean = $this->_cleanImportUser($raw, $error);
864                if ($clean && $this->_addImportUser($clean, $error)) {
865                    $sent = $this->_notifyUser($clean[0],$clean[1],false);
866                    if (!$sent){
867                        msg(sprintf($this->lang['import_notify_fail'],$clean[0],$clean[3]),-1);
868                    }
869                    $import_success_count++;
870                } else {
871                    $import_fail_count++;
872                    array_splice($raw, 1, 1);                                  // remove the spliced in password
873                    $this->_import_failures[$line] = array('error' => $error, 'user' => $raw, 'orig' => $csv);
874                }
875            }
876            msg(sprintf($this->lang['import_success_count'], ($import_success_count+$import_fail_count), $import_success_count),($import_success_count ? 1 : -1));
877            if ($import_fail_count) {
878                msg(sprintf($this->lang['import_failure_count'], $import_fail_count),-1);
879            }
880        } else {
881            msg($this->lang['import_error_readfail'],-1);
882        }
883
884        // save import failures into the session
885        if (!headers_sent()) {
886            session_start();
887            $_SESSION['import_failures'] = $this->_import_failures;
888            session_write_close();
889        }
890        return true;
891    }
892
893    /**
894     * Returns cleaned user data
895     *
896     * @param array $candidate raw values of line from input file
897     * @param $error
898     * @return array|bool cleaned data or false
899     */
900    protected function _cleanImportUser($candidate, & $error){
901        global $INPUT;
902
903        // kludgy ....
904        $INPUT->set('userid', $candidate[0]);
905        $INPUT->set('userpass', $candidate[1]);
906        $INPUT->set('username', $candidate[2]);
907        $INPUT->set('usermail', $candidate[3]);
908        $INPUT->set('usergroups', $candidate[4]);
909
910        $cleaned = $this->_retrieveUser();
911        list($user,$pass,$name,$mail,$grps) = $cleaned;
912        if (empty($user)) {
913            $error = $this->lang['import_error_baduserid'];
914            return false;
915        }
916
917        // no need to check password, handled elsewhere
918
919        if (!($this->_auth->canDo('modName') xor empty($name))){
920            $error = $this->lang['import_error_badname'];
921            return false;
922        }
923
924        if ($this->_auth->canDo('modMail')) {
925            if (empty($mail) || !mail_isvalid($mail)) {
926                $error = $this->lang['import_error_badmail'];
927                return false;
928            }
929        } else {
930            if (!empty($mail)) {
931                $error = $this->lang['import_error_badmail'];
932                return false;
933            }
934        }
935
936        return $cleaned;
937    }
938
939    /**
940     * Adds imported user to auth backend
941     *
942     * Required a check of canDo('addUser') before
943     *
944     * @param array  $user   data of user
945     * @param string &$error reference catched error message
946     * @return bool whether successful
947     */
948    protected function _addImportUser($user, & $error){
949        if (!$this->_auth->triggerUserMod('create', $user)) {
950            $error = $this->lang['import_error_create'];
951            return false;
952        }
953
954        return true;
955    }
956
957    /**
958     * Downloads failures as csv file
959     */
960    protected function _downloadImportFailures(){
961
962        // ==============================================================================================
963        // GENERATE OUTPUT
964        // normal headers for downloading...
965        header('Content-type: text/csv;charset=utf-8');
966        header('Content-Disposition: attachment; filename="importfails.csv"');
967#       // for debugging assistance, send as text plain to the browser
968#       header('Content-type: text/plain;charset=utf-8');
969
970        // output the csv
971        $fd = fopen('php://output','w');
972        foreach ($this->_import_failures as $fail) {
973            fputs($fd, $fail['orig']);
974        }
975        fclose($fd);
976        die;
977    }
978
979    /**
980     * wrapper for is_uploaded_file to facilitate overriding by test suite
981     */
982    protected function _isUploadedFile($file) {
983        return is_uploaded_file($file);
984    }
985
986}
987