lib/plugin/UserPreferences.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id: UserPreferences.php,v 1.26 2004-05-03 11:40:42 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.26 $");
  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->getUser();
  69         if (! $request->isActionPage($request->getArg('pagename'))) {
  70             $no_args = $this->getDefaultArguments();
  71 // ?
  72 //            foreach ($no_args as $key => $value) {
  73 //                $no_args[$value] = false;
  74 //            }
  75             $no_args['errmsg'] = HTML(HTML::h2(_("Error: The user HomePage must be a valid WikiWord. Sorry, UserPreferences cannot be saved."),HTML::hr()));
  76             $no_args['isForm'] = false;
  77             return Template('userprefs', $no_args);
  78         }
  79         $userid = $user->UserName();
  80         if (// ((defined('ALLOW_BOGO_LOGIN') && ALLOW_BOGO_LOGIN && $user->isSignedIn()) ||
  81              $user->isAuthenticated() and !empty($userid))
  82         {
  83             $pref = $user->getPreferences();
  84             //trigger_error("DEBUG: reading prefs from getPreferences".print_r($pref));
  85
  86             if ($request->isPost()) {
  87                 $errmsg = '';
  88                 if ($rp = $request->getArg('pref')) {
  89                     // replace only changed prefs in $pref with those from request
  90                     if (!empty($rp['passwd']) and ($rp['passwd2'] != $rp['passwd'])) {
  91                         $errmsg = _("Wrong password. Try again.");
  92                     } else {
  93                         //trigger_error("DEBUG: reading prefs from request".print_r($rp));
  94                         //trigger_error("DEBUG: writing prefs with setPreferences".print_r($pref));
  95                         if (empty($rp['passwd'])) unset($rp['passwd']);
  96                         // fix to set system pulldown's. empty values don't get posted
  97                         if (empty($rp['theme'])) $rp['theme'] = '';
  98                         if (empty($rp['lang']))  $rp['lang']  = '';
  99                         $num = $user->setPreferences($rp);
 100                         if (!empty($rp['passwd'])) {
 101                             $passchanged = false;
 102                             if ($user->mayChangePass()) {
 103                                 if (method_exists($user, 'storePass')) {
 104                                     $passchanged = $user->storePass($rp['passwd']);
 105                                 }
 106                                 if (!$passchanged and method_exists($user, 'changePass')) {
 107                                     $passchanged = $user->changePass($rp['passwd']);
 108                                 }
 109                                 if ($passchanged) {
 110                                     $errmsg = _("Password updated.");
 111                                 } else {
 112                                     $errmsg = _("Password cannot be changed.");
 113                                 }
 114                             } else {
 115                                 $errmsg = _("Password cannot be changed.");
 116                             }
 117                         }
 118                         if (!$num) {
 119                             $errmsg .= " " ._("No changes.");
 120                         } else {
 121                             $request->_setUser($user);
 122                             $pref = $user->_prefs;
 123                             $errmsg .= sprintf(_("%d UserPreferences fields successfully updated."), $num);
 124                         }
 125                     }
 126                     $args['errmsg'] = HTML(HTML::h2($errmsg), HTML::hr());
 127                 }
 128             }
 129             $args['available_themes'] = listAvailableThemes();
 130             $args['available_languages'] = listAvailableLanguages();
 131
 132             return Template('userprefs', $args);
 133         }
 134         else {
 135             // wrong or unauthenticated user
 136             return $request->_notAuthorized(WIKIAUTH_BOGO);
 137             //return $user->PrintLoginForm ($request, $args, false, false);
 138         }
 139     }
 140 };
 141
 142 // $Log: not supported by cvs2svn $
 143 // Revision 1.25  2004/04/07 23:13:19  rurban
 144 // fixed pear/File_Passwd for Windows
 145 // fixed FilePassUser sessions (filehandle revive) and password update
 146 //
 147 // Revision 1.24  2004/04/06 20:00:11  rurban
 148 // Cleanup of special PageList column types
 149 // Added support of plugin and theme specific Pagelist Types
 150 // Added support for theme specific UserPreferences
 151 // Added session support for ip-based throttling
 152 //   sql table schema change: ALTER TABLE session ADD sess_ip CHAR(15);
 153 // Enhanced postgres schema
 154 // Added DB_Session_dba support
 155 //
 156 // Revision 1.23  2004/04/02 15:06:56  rurban
 157 // fixed a nasty ADODB_mysql session update bug
 158 // improved UserPreferences layout (tabled hints)
 159 // fixed UserPreferences auth handling
 160 // improved auth stability
 161 // improved old cookie handling: fixed deletion of old cookies with paths
 162 //
 163 // Revision 1.22  2004/03/24 19:39:03  rurban
 164 // php5 workaround code (plus some interim debugging code in XmlElement)
 165 //   php5 doesn't work yet with the current XmlElement class constructors,
 166 //   WikiUserNew does work better than php4.
 167 // rewrote WikiUserNew user upgrading to ease php5 update
 168 // fixed pref handling in WikiUserNew
 169 // added Email Notification
 170 // added simple Email verification
 171 // removed emailVerify userpref subclass: just a email property
 172 // changed pref binary storage layout: numarray => hash of non default values
 173 // print optimize message only if really done.
 174 // forced new cookie policy: delete pref cookies, use only WIKI_ID as plain string.
 175 //   prefs should be stored in db or homepage, besides the current session.
 176 //
 177 // Revision 1.21  2004/03/14 16:26:21  rurban
 178 // copyright line
 179 //
 180 // Revision 1.20  2004/03/12 23:20:58  rurban
 181 // pref fixes (base64)
 182 //
 183 // Revision 1.19  2004/02/27 13:21:17  rurban
 184 // several performance improvements, esp. with peardb
 185 // simplified loops
 186 // storepass seperated from prefs if defined so
 187 // stacked and strict still not working
 188 //
 189 // Revision 1.18  2004/02/24 15:20:06  rurban
 190 // fixed minor warnings: unchecked args, POST => Get urls for sortby e.g.
 191 //
 192 // Revision 1.17  2004/02/17 12:11:36  rurban
 193 // 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, ...)
 194 //
 195 // Revision 1.16  2004/02/15 21:34:37  rurban
 196 // PageList enhanced and improved.
 197 // fixed new WikiAdmin... plugins
 198 // editpage, Theme with exp. htmlarea framework
 199 //   (htmlarea yet committed, this is really questionable)
 200 // WikiUser... code with better session handling for prefs
 201 // enhanced UserPreferences (again)
 202 // RecentChanges for show_deleted: how should pages be deleted then?
 203 //
 204 // Revision 1.15  2004/01/27 22:37:50  rurban
 205 // fixed default args: no objects
 206 //
 207 // Revision 1.14  2004/01/26 09:18:00  rurban
 208 // * changed stored pref representation as before.
 209 //   the array of objects is 1) bigger and 2)
 210 //   less portable. If we would import packed pref
 211 //   objects and the object definition was changed, PHP would fail.
 212 //   This doesn't happen with an simple array of non-default values.
 213 // * use $prefs->retrieve and $prefs->store methods, where retrieve
 214 //   understands the interim format of array of objects also.
 215 // * simplified $prefs->get() and fixed $prefs->set()
 216 // * added $user->_userid and class '_WikiUser' portability functions
 217 // * fixed $user object ->_level upgrading, mostly using sessions.
 218 //   this fixes yesterdays problems with loosing authorization level.
 219 // * fixed WikiUserNew::checkPass to return the _level
 220 // * fixed WikiUserNew::isSignedIn
 221 // * added explodePageList to class PageList, support sortby arg
 222 // * fixed UserPreferences for WikiUserNew
 223 // * fixed WikiPlugin for empty defaults array
 224 // * UnfoldSubpages: added pagename arg, renamed pages arg,
 225 //   removed sort arg, support sortby arg
 226 //
 227 // Revision 1.13  2003/12/04 20:27:00  carstenklapp
 228 // Use the API.
 229 //
 230 // Revision 1.12  2003/12/01 22:21:33  carstenklapp
 231 // Bugfix: UserPreferences are no longer clobbered when signing in after
 232 // the previous session has ended (i.e. user closed browser then signed
 233 // in again). This is still a bit of a mess, and the preferences do not
 234 // take effect until the next page browse/link has been clicked.
 235 //
 236 // Revision 1.11  2003/09/19 22:01:19  carstenklapp
 237 // BOGO users allowed preferences too when ALLOW_BOGO_LOGIN == true.
 238 //
 239 // Revision 1.10  2003/09/13 21:57:26  carstenklapp
 240 // Reformatting only.
 241 //
 242 // Revision 1.9  2003/09/13 21:53:41  carstenklapp
 243 // Added lang and theme arguments, getVersion(), copyright and cvs log.
 244 //
 245
 246 // For emacs users
 247 // Local Variables:
 248 // mode: php
 249 // tab-width: 8
 250 // c-basic-offset: 4
 251 // c-hanging-comment-ender-p: nil
 252 // indent-tabs-mode: nil
 253 // End:
 254 ?>