lib/plugin/UserPreferences.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id$');
   3 /**
   4  Copyright (C) 2001,2002,2003,2004,2005 $ThePhpWikiProgrammingTeam
   5
   6  This file is part of PhpWiki.
   7
   8  PhpWiki is free software; you can redistribute it and/or modify
   9  it under the terms of the GNU General Public License as published by
  10  the Free Software Foundation; either version 2 of the License, or
  11  (at your option) any later version.
  12
  13  PhpWiki is distributed in the hope that it will be useful,
  14  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  GNU General Public License for more details.
  17
  18  You should have received a copy of the GNU General Public License
  19  along with PhpWiki; if not, write to the Free Software
  20  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 /**
  24  * Plugin to allow any user to adjust his own preferences.
  25  * This must be used in the page "UserPreferences".
  26  * Prefs are stored in metadata in the current session,
  27  *  within the user's home page or in a database.
  28  *
  29  * WikiTheme extension: WikiThemes are able to extend the predefined list
  30  * of preferences.
  31  */
  32 class WikiPlugin_UserPreferences
  33 extends WikiPlugin
  34 {
  35     var $bool_args;
  36
  37     function getName () {
  38         return _("UserPreferences");
  39     }
  40
  41     function getDescription () {
  42         return _("Allow any user to adjust his own preferences.");
  43     }
  44
  45     function getVersion() {
  46         return preg_replace("/[Revision: $]/", '',
  47                             "\$Revision$");
  48     }
  49
  50     function getDefaultArguments() {
  51         global $request;
  52         $pagename = $request->getArg('pagename');
  53         $user = $request->getUser();
  54         if ( isset($user->_prefs) and
  55              isset($user->_prefs->_prefs) and
  56              isset($user->_prefs->_method) ) {
  57             $pref =& $user->_prefs;
  58         } else {
  59             $pref = $user->getPreferences();
  60         }
  61         $prefs = array();
  62         //we need a hash of pref => default_value
  63         foreach ($pref->_prefs as $name => $obj) {
  64             $prefs[$name] = $obj->default_value;
  65         }
  66         return $prefs;
  67     }
  68
  69     function run($dbi, $argstr, &$request, $basepage) {
  70         $args = $this->getArgs($argstr, $request);
  71         $user =& $request->_user;
  72         if (isa($request,'MockRequest'))
  73             return '';
  74         if ((!$request->isActionPage($request->getArg('pagename'))
  75              and (!isset($user->_prefs->_method)
  76                   or !in_array($user->_prefs->_method, array('ADODB','SQL','PDO'))))
  77             or (in_array($request->getArg('action'), array('zip','ziphtml','dumphtml')))
  78             or (isa($user,'_ForbiddenUser')))
  79         {
  80             $no_args = $this->getDefaultArguments();
  81 // ?
  82 //            foreach ($no_args as $key => $value) {
  83 //                $no_args[$value] = false;
  84 //            }
  85             $no_args['errmsg'] = HTML(HTML::h2(_("Error: The user HomePage must be a valid WikiWord. Sorry, UserPreferences cannot be saved."),HTML::hr()));
  86             $no_args['isForm'] = false;
  87             return Template('userprefs', $no_args);
  88         }
  89         $userid = $user->UserName();
  90         if (// ((defined('ALLOW_BOGO_LOGIN') && ALLOW_BOGO_LOGIN && $user->isSignedIn()) ||
  91              $user->isAuthenticated() and !empty($userid))
  92         {
  93             $pref = &$request->_prefs;
  94             $args['isForm'] = true;
  95             //trigger_error("DEBUG: reading prefs from getPreferences".print_r($pref));
  96
  97             if ($request->isPost()) {
  98                 $errmsg = '';
  99                 $delete = $request->getArg('delete');
 100                 if ($delete and $request->getArg('verify')) {
 101                     // deleting prefs, verified
 102                     $default_prefs = $pref->defaultPreferences();
 103                     $default_prefs['userid'] = $user->UserName();
 104                     $user->setPreferences($default_prefs);
 105                     $request->_setUser($user);
 106                     $request->setArg("verify",false);
 107                     $request->setArg("delete",false);
 108                     $errmsg .= _("Your UserPreferences have been successfully reset to default.");
 109                     $args['errmsg'] = HTML::div(array('class' => 'feedback'), HTML::p($errmsg));
 110                     return Template('userprefs', $args);
 111                 } elseif ($delete and !$request->getArg('verify')) {
 112                     return HTML::form(array('action' => $request->getPostURL(),
 113                                             'method' => 'post'),
 114                                        HiddenInputs(array('verify' => 1)),
 115                                        HiddenInputs($request->getArgs()),
 116                                        HTML::p(_("Do you really want to reset all your UserPreferences?")),
 117                                        HTML::p(Button('submit:delete', _("Yes"), 'delete'),
 118                                                HTML::Raw('&nbsp;'),
 119                                                Button('cancel', _("Cancel")))
 120                                        );
 121                 } elseif ($rp = $request->getArg('pref')) {
 122                     // replace only changed prefs in $pref with those from request
 123                     if (!empty($rp['passwd']) and ($rp['passwd2'] != $rp['passwd'])) {
 124                         $errmsg = _("Wrong password. Try again.");
 125                     } else {
 126                         //trigger_error("DEBUG: reading prefs from request".print_r($rp));
 127                         //trigger_error("DEBUG: writing prefs with setPreferences".print_r($pref));
 128                         if (empty($rp['passwd'])) unset($rp['passwd']);
 129                         // fix to set system pulldown's. empty values don't get posted
 130                         if (empty($rp['theme'])) $rp['theme'] = '';
 131                         if (empty($rp['lang']))  $rp['lang']  = '';
 132                         $num = $user->setPreferences($rp);
 133                         if (!empty($rp['passwd'])) {
 134                             $passchanged = false;
 135                             if ($user->mayChangePass()) {
 136                                 if (method_exists($user, 'storePass')) {
 137                                     $passchanged = $user->storePass($rp['passwd']);
 138                                 }
 139                                 if (!$passchanged and method_exists($user, 'changePass')) {
 140                                     $passchanged = $user->changePass($rp['passwd']);
 141                                 }
 142                                 if ($passchanged) {
 143                                     $errmsg = _("Password updated.");
 144                                 } else {
 145                                     $errmsg = _("Password was not changed.");
 146                                 }
 147                             } else {
 148                                 $errmsg = _("Password cannot be changed.");
 149                             }
 150                         }
 151                         if (!$num) {
 152                             $errmsg .= " " ._("No changes.");
 153                         } else {
 154                             $request->_setUser($user);
 155                             $pref = $user->_prefs;
 156                             if ($num == 1) {
 157                                 $errmsg .= _("One UserPreferences field successfully updated.");
 158                             } else {
 159                             $errmsg .= sprintf(_("%d UserPreferences fields successfully updated."), $num);
 160                         }
 161                     }
 162                     }
 163                     $args['errmsg'] = HTML::div(array('class' => 'feedback'), HTML::p($errmsg));
 164
 165                 }
 166             }
 167             $args['available_themes'] = listAvailableThemes();
 168             $args['available_languages'] = listAvailableLanguages();
 169
 170             return Template('userprefs', $args);
 171         } else {
 172             // wrong or unauthenticated user
 173             return $request->_notAuthorized(WIKIAUTH_BOGO);
 174             //return $user->PrintLoginForm ($request, $args, false, false);
 175         }
 176     }
 177 };
 178
 179 // For emacs users
 180 // Local Variables:
 181 // mode: php
 182 // tab-width: 8
 183 // c-basic-offset: 4
 184 // c-hanging-comment-ender-p: nil
 185 // indent-tabs-mode: nil
 186 // End:
 187 ?>