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 getDefaultArguments() {
  47         global $request;
  48         $pagename = $request->getArg('pagename');
  49         $user = $request->getUser();
  50         if ( isset($user->_prefs) and
  51              isset($user->_prefs->_prefs) and
  52              isset($user->_prefs->_method) ) {
  53             $pref =& $user->_prefs;
  54         } else {
  55             $pref = $user->getPreferences();
  56         }
  57         $prefs = array();
  58         //we need a hash of pref => default_value
  59         foreach ($pref->_prefs as $name => $obj) {
  60             $prefs[$name] = $obj->default_value;
  61         }
  62         return $prefs;
  63     }
  64
  65     function run($dbi, $argstr, &$request, $basepage) {
  66         $args = $this->getArgs($argstr, $request);
  67         $user =& $request->_user;
  68         if (isa($request,'MockRequest'))
  69             return '';
  70         if (defined('GFORGE') and GFORGE) {
  71             if (!($user->isAuthenticated())) {
  72                 return HTML::div(array('class' => 'errors'),
  73                                  _("Error: You are not logged in, cannot display UserPreferences."));
  74             }
  75         }
  76         if ((!isActionPage($request->getArg('pagename'))
  77              and (!isset($user->_prefs->_method)
  78                   or !in_array($user->_prefs->_method, array('ADODB','SQL','PDO'))))
  79             or (in_array($request->getArg('action'), array('zip','ziphtml','dumphtml')))
  80             or (isa($user,'_ForbiddenUser')))
  81         {
  82             $no_args = $this->getDefaultArguments();
  83 // ?
  84 //            foreach ($no_args as $key => $value) {
  85 //                $no_args[$value] = false;
  86 //            }
  87             $no_args['errmsg'] = HTML::div(array('class' => 'errors'),
  88                                            _("Error: The user HomePage must be a valid WikiWord. Sorry, UserPreferences cannot be saved."));
  89             $no_args['isForm'] = false;
  90             return Template('userprefs', $no_args);
  91         }
  92         $userid = $user->UserName();
  93         if (// ((defined('ALLOW_BOGO_LOGIN') && ALLOW_BOGO_LOGIN && $user->isSignedIn()) ||
  94              $user->isAuthenticated() and !empty($userid))
  95         {
  96             $pref = &$request->_prefs;
  97             $args['isForm'] = true;
  98             //trigger_error("DEBUG: reading prefs from getPreferences".print_r($pref));
  99
 100             if ($request->isPost()) {
 101                     $errmsg = '';
 102                 $delete = $request->getArg('delete');
 103                 if ($delete and $request->getArg('verify')) {
 104                     // deleting prefs, verified
 105                     $default_prefs = $pref->defaultPreferences();
 106                     $default_prefs['userid'] = $user->UserName();
 107                     $user->setPreferences($default_prefs);
 108                     $request->_setUser($user);
 109                     $request->setArg("verify",false);
 110                     $request->setArg("delete",false);
 111                     $errmsg .= _("Your UserPreferences have been successfully reset to default.");
 112                     $args['errmsg'] = HTML::div(array('class' => 'feedback'), HTML::p($errmsg));
 113                     return Template('userprefs', $args);
 114                 } elseif ($delete and !$request->getArg('verify')) {
 115                     return HTML::fieldset(
 116                                  HTML::form(array('action' => $request->getPostURL(),
 117                                             'method' => 'post'),
 118                                        HiddenInputs(array('verify' => 1)),
 119                                        HiddenInputs($request->getArgs()),
 120                                        HTML::p(_("Do you really want to reset all your UserPreferences?")),
 121                                        HTML::p(Button('submit:delete', _("Yes"), 'delete'),
 122                                                HTML::Raw('&nbsp;'),
 123                                                Button('cancel', _("Cancel")))
 124                                        ));
 125                 } elseif ($rp = $request->getArg('pref')) {
 126                     // replace only changed prefs in $pref with those from request
 127                     if (!empty($rp['passwd']) and ($rp['passwd2'] != $rp['passwd'])) {
 128                         $errmsg = _("Wrong password. Try again.");
 129                     } else {
 130                         //trigger_error("DEBUG: reading prefs from request".print_r($rp));
 131                         //trigger_error("DEBUG: writing prefs with setPreferences".print_r($pref));
 132                         if (empty($rp['passwd'])) unset($rp['passwd']);
 133                         // fix to set system pulldown's. empty values don't get posted
 134                         if (empty($rp['theme'])) $rp['theme'] = '';
 135                         if (empty($rp['lang']))  $rp['lang']  = '';
 136                         $num = $user->setPreferences($rp);
 137                         if (!empty($rp['passwd'])) {
 138                             $passchanged = false;
 139                             if ($user->mayChangePass()) {
 140                                 if (method_exists($user, 'storePass')) {
 141                                     $passchanged = $user->storePass($rp['passwd']);
 142                                 }
 143                                 if (!$passchanged and method_exists($user, 'changePass')) {
 144                                     $passchanged = $user->changePass($rp['passwd']);
 145                                 }
 146                                 if ($passchanged) {
 147                                     $errmsg = _("Password updated.");
 148                                 } else {
 149                                     $errmsg = _("Password was not changed.");
 150                                 }
 151                             } else {
 152                                 $errmsg = _("Password cannot be changed.");
 153                             }
 154                         }
 155                         if (!$num) {
 156                             $errmsg .= " " ._("No changes.");
 157                         } else {
 158                             $request->_setUser($user);
 159                             $pref = $user->_prefs;
 160                             if ($num == 1) {
 161                                 $errmsg .= _("One UserPreferences field successfully updated.");
 162                             } else {
 163                             $errmsg .= sprintf(_("%d UserPreferences fields successfully updated."), $num);
 164                         }
 165                     }
 166                     }
 167                     $args['errmsg'] = HTML::div(array('class' => 'feedback'), HTML::p($errmsg));
 168
 169                 }
 170             }
 171             $args['available_themes'] = listAvailableThemes();
 172             $args['available_languages'] = listAvailableLanguages();
 173
 174             return Template('userprefs', $args);
 175         } else {
 176             // wrong or unauthenticated user
 177             return $request->_notAuthorized(WIKIAUTH_BOGO);
 178             //return $user->PrintLoginForm ($request, $args, false, false);
 179         }
 180     }
 181 };
 182
 183 // For emacs users
 184 // Local Variables:
 185 // mode: php
 186 // tab-width: 8
 187 // c-basic-offset: 4
 188 // c-hanging-comment-ender-p: nil
 189 // indent-tabs-mode: nil
 190 // End:
 191 ?>