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  * Theme extension: Themes 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 getVersion() {
  42         return preg_replace("/[Revision: $]/", '',
  43                             "\$Revision: 1.39 $");
  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 ((!$request->isActionPage($request->getArg('pagename'))
  71              and (!isset($user->_prefs->_method)
  72                   or !in_array($user->_prefs->_method, array('ADODB','SQL','PDO'))))
  73             or (in_array($request->getArg('action'), array('zip','ziphtml','dumphtml')))
  74             or (isa($user,'_ForbiddenUser')))
  75         {
  76             $no_args = $this->getDefaultArguments();
  77 // ?
  78 //            foreach ($no_args as $key => $value) {
  79 //                $no_args[$value] = false;
  80 //            }
  81             $no_args['errmsg'] = HTML(HTML::h2(_("Error: The user HomePage must be a valid WikiWord. Sorry, UserPreferences cannot be saved."),HTML::hr()));
  82             $no_args['isForm'] = false;
  83             return Template('userprefs', $no_args);
  84         }
  85         $userid = $user->UserName();
  86         if (// ((defined('ALLOW_BOGO_LOGIN') && ALLOW_BOGO_LOGIN && $user->isSignedIn()) ||
  87              $user->isAuthenticated() and !empty($userid))
  88         {
  89             $pref = &$request->_prefs;
  90             $args['isForm'] = true;
  91             //trigger_error("DEBUG: reading prefs from getPreferences".print_r($pref));
  92
  93             if ($request->isPost()) {
  94                 $errmsg = '';
  95                 $delete = $request->getArg('delete');
  96                 if ($delete and $request->getArg('verify')) {
  97                     // deleting prefs, verified
  98                     $default_prefs = $pref->defaultPreferences();
  99                     $default_prefs['userid'] = $user->UserName();
 100                     $user->setPreferences($default_prefs);
 101                     $request->_setUser($user);
 102                     $request->setArg("verify",false);
 103                     $request->setArg("delete",false);
 104 // Alert message removed, display directly the Preference form with the message.
 105 //                    $alert = new Alert(_("Message"),
 106 //                                       _("Your UserPreferences have been successfully reset to default."));
 107 //                    $alert->show();
 108 //                    return;
 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::form(array('action' => $request->getPostURL(),
 114                                             'method' => 'post'),
 115                                        HiddenInputs(array('verify' => 1)),
 116                                        HiddenInputs($request->getArgs()),
 117                                        HTML::p(_("Do you really want to reset all your UserPreferences?")),
 118                                        HTML::p(Button('submit:delete', _("Yes"), 'delete'),
 119                                                HTML::Raw('&nbsp;'),
 120                                                Button('cancel', _("Cancel")))
 121                                        );
 122                 } elseif ($rp = $request->getArg('pref')) {
 123                     // replace only changed prefs in $pref with those from request
 124                     if (!empty($rp['passwd']) and ($rp['passwd2'] != $rp['passwd'])) {
 125                         $errmsg = _("Wrong password. Try again.");
 126                     } else {
 127                         //trigger_error("DEBUG: reading prefs from request".print_r($rp));
 128                         //trigger_error("DEBUG: writing prefs with setPreferences".print_r($pref));
 129                         if (empty($rp['passwd'])) unset($rp['passwd']);
 130                         // fix to set system pulldown's. empty values don't get posted
 131                         if (empty($rp['theme'])) $rp['theme'] = '';
 132                         if (empty($rp['lang']))  $rp['lang']  = '';
 133                         $num = $user->setPreferences($rp);
 134                         if (!empty($rp['passwd'])) {
 135                             $passchanged = false;
 136                             if ($user->mayChangePass()) {
 137                                 if (method_exists($user, 'storePass')) {
 138                                     $passchanged = $user->storePass($rp['passwd']);
 139                                 }
 140                                 if (!$passchanged and method_exists($user, 'changePass')) {
 141                                     $passchanged = $user->changePass($rp['passwd']);
 142                                 }
 143                                 if ($passchanged) {
 144                                     $errmsg = _("Password updated.");
 145                                 } else {
 146                                     $errmsg = _("Password was not changed.");
 147                                 }
 148                             } else {
 149                                 $errmsg = _("Password cannot be changed.");
 150                             }
 151                         }
 152                         if (!$num) {
 153                             $errmsg .= " " ._("No changes.");
 154                         } else {
 155                             $request->_setUser($user);
 156                             $pref = $user->_prefs;
 157                             if ($num == 1) {
 158                                 $errmsg .= _("One UserPreferences field successfully updated.");
 159                             } else {
 160                             $errmsg .= sprintf(_("%d UserPreferences fields successfully updated."), $num);
 161                         }
 162                     }
 163                     }
 164                     $args['errmsg'] = HTML::div(array('class' => 'feedback'), HTML::p($errmsg));
 165
 166                 }
 167             }
 168             $args['available_themes'] = listAvailableThemes();
 169             $args['available_languages'] = listAvailableLanguages();
 170
 171             return Template('userprefs', $args);
 172         } else {
 173             // wrong or unauthenticated user
 174             return $request->_notAuthorized(WIKIAUTH_BOGO);
 175             //return $user->PrintLoginForm ($request, $args, false, false);
 176         }
 177     }
 178 };
 179
 180 // $Log: not supported by cvs2svn $
 181 // Revision 1.38  2008/01/30 19:22:53  vargenau
 182 // Specific message when only one preference is updated
 183 //
 184 // Revision 1.37  2006/03/07 21:06:56  rurban
 185 // add PdoDbPassUser
 186 //
 187 // Revision 1.36  2005/06/30 05:17:14  rurban
 188 // update (c) date
 189 //
 190 // Revision 1.35  2004/10/13 14:13:55  rurban
 191 // fix cannot edit prefs
 192 //
 193 // Revision 1.34  2004/10/05 00:10:49  rurban
 194 // adjust for unittests. They finally pass all tests
 195 //
 196 // Revision 1.33  2004/10/04 23:39:34  rurban
 197 // just aesthetics
 198 //
 199 // Revision 1.32  2004/06/28 12:51:41  rurban
 200 // improved dumphtml and virgin setup
 201 //
 202 // Revision 1.31  2004/06/27 10:26:03  rurban
 203 // oci8 patch by Philippe Vanhaesendonck + some ADODB notes+fixes
 204 //
 205 // Revision 1.30  2004/06/15 09:15:52  rurban
 206 // IMPORTANT: fixed passwd handling for passwords stored in prefs:
 207 //   fix encrypted usage, actually store and retrieve them from db
 208 //   fix bogologin with passwd set.
 209 // fix php crashes with call-time pass-by-reference (references wrongly used
 210 //   in declaration AND call). This affected mainly Apache2 and IIS.
 211 //   (Thanks to John Cole to detect this!)
 212 //
 213 // Revision 1.29  2004/05/06 13:26:01  rurban
 214 // omit "Okay", this is default
 215 //
 216 // Revision 1.28  2004/05/05 13:38:09  rurban
 217 // Support to remove all UserPreferences
 218 //
 219 // Revision 1.27  2004/05/03 13:16:47  rurban
 220 // fixed UserPreferences update, esp for boolean and int
 221 //
 222 // Revision 1.26  2004/05/03 11:40:42  rurban
 223 // put listAvailableLanguages() and listAvailableThemes() from SystemInfo and
 224 // UserPreferences into Themes.php
 225 //
 226 // Revision 1.25  2004/04/07 23:13:19  rurban
 227 // fixed pear/File_Passwd for Windows
 228 // fixed FilePassUser sessions (filehandle revive) and password update
 229 //
 230 // Revision 1.24  2004/04/06 20:00:11  rurban
 231 // Cleanup of special PageList column types
 232 // Added support of plugin and theme specific Pagelist Types
 233 // Added support for theme specific UserPreferences
 234 // Added session support for ip-based throttling
 235 //   sql table schema change: ALTER TABLE session ADD sess_ip CHAR(15);
 236 // Enhanced postgres schema
 237 // Added DB_Session_dba support
 238 //
 239 // Revision 1.23  2004/04/02 15:06:56  rurban
 240 // fixed a nasty ADODB_mysql session update bug
 241 // improved UserPreferences layout (tabled hints)
 242 // fixed UserPreferences auth handling
 243 // improved auth stability
 244 // improved old cookie handling: fixed deletion of old cookies with paths
 245 //
 246 // Revision 1.22  2004/03/24 19:39:03  rurban
 247 // php5 workaround code (plus some interim debugging code in XmlElement)
 248 //   php5 doesn't work yet with the current XmlElement class constructors,
 249 //   WikiUserNew does work better than php4.
 250 // rewrote WikiUserNew user upgrading to ease php5 update
 251 // fixed pref handling in WikiUserNew
 252 // added Email Notification
 253 // added simple Email verification
 254 // removed emailVerify userpref subclass: just a email property
 255 // changed pref binary storage layout: numarray => hash of non default values
 256 // print optimize message only if really done.
 257 // forced new cookie policy: delete pref cookies, use only WIKI_ID as plain string.
 258 //   prefs should be stored in db or homepage, besides the current session.
 259 //
 260 // Revision 1.21  2004/03/14 16:26:21  rurban
 261 // copyright line
 262 //
 263 // Revision 1.20  2004/03/12 23:20:58  rurban
 264 // pref fixes (base64)
 265 //
 266 // Revision 1.19  2004/02/27 13:21:17  rurban
 267 // several performance improvements, esp. with peardb
 268 // simplified loops
 269 // storepass seperated from prefs if defined so
 270 // stacked and strict still not working
 271 //
 272 // Revision 1.18  2004/02/24 15:20:06  rurban
 273 // fixed minor warnings: unchecked args, POST => Get urls for sortby e.g.
 274 //
 275 // Revision 1.17  2004/02/17 12:11:36  rurban
 276 // added missing 4th basepage arg at plugin->run() to almost all plugins. This caused no harm so far, because it was silently dropped on normal usage. However on plugin internal ->run invocations it failed. (InterWikiSearch, IncludeSiteMap, ...)
 277 //
 278 // Revision 1.16  2004/02/15 21:34:37  rurban
 279 // PageList enhanced and improved.
 280 // fixed new WikiAdmin... plugins
 281 // editpage, Theme with exp. htmlarea framework
 282 //   (htmlarea yet committed, this is really questionable)
 283 // WikiUser... code with better session handling for prefs
 284 // enhanced UserPreferences (again)
 285 // RecentChanges for show_deleted: how should pages be deleted then?
 286 //
 287 // Revision 1.15  2004/01/27 22:37:50  rurban
 288 // fixed default args: no objects
 289 //
 290 // Revision 1.14  2004/01/26 09:18:00  rurban
 291 // * changed stored pref representation as before.
 292 //   the array of objects is 1) bigger and 2)
 293 //   less portable. If we would import packed pref
 294 //   objects and the object definition was changed, PHP would fail.
 295 //   This doesn't happen with an simple array of non-default values.
 296 // * use $prefs->retrieve and $prefs->store methods, where retrieve
 297 //   understands the interim format of array of objects also.
 298 // * simplified $prefs->get() and fixed $prefs->set()
 299 // * added $user->_userid and class '_WikiUser' portability functions
 300 // * fixed $user object ->_level upgrading, mostly using sessions.
 301 //   this fixes yesterdays problems with loosing authorization level.
 302 // * fixed WikiUserNew::checkPass to return the _level
 303 // * fixed WikiUserNew::isSignedIn
 304 // * added explodePageList to class PageList, support sortby arg
 305 // * fixed UserPreferences for WikiUserNew
 306 // * fixed WikiPlugin for empty defaults array
 307 // * UnfoldSubpages: added pagename arg, renamed pages arg,
 308 //   removed sort arg, support sortby arg
 309 //
 310 // Revision 1.13  2003/12/04 20:27:00  carstenklapp
 311 // Use the API.
 312 //
 313 // Revision 1.12  2003/12/01 22:21:33  carstenklapp
 314 // Bugfix: UserPreferences are no longer clobbered when signing in after
 315 // the previous session has ended (i.e. user closed browser then signed
 316 // in again). This is still a bit of a mess, and the preferences do not
 317 // take effect until the next page browse/link has been clicked.
 318 //
 319 // Revision 1.11  2003/09/19 22:01:19  carstenklapp
 320 // BOGO users allowed preferences too when ALLOW_BOGO_LOGIN == true.
 321 //
 322 // Revision 1.10  2003/09/13 21:57:26  carstenklapp
 323 // Reformatting only.
 324 //
 325 // Revision 1.9  2003/09/13 21:53:41  carstenklapp
 326 // Added lang and theme arguments, getVersion(), copyright and cvs log.
 327 //
 328
 329 // For emacs users
 330 // Local Variables:
 331 // mode: php
 332 // tab-width: 8
 333 // c-basic-offset: 4
 334 // c-hanging-comment-ender-p: nil
 335 // indent-tabs-mode: nil
 336 // End:
 337 ?>