lib/plugin/UserPreferences.php

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