lib/plugin/UserPreferences.php

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