4 Copyright (C) 2001,2002,2003,2004,2005 $ThePhpWikiProgrammingTeam
6 This file is part of PhpWiki.
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.
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.
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
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.
29 * WikiTheme extension: WikiThemes are able to extend the predefined list
32 class WikiPlugin_UserPreferences
38 return _("UserPreferences");
41 function getDescription () {
42 return _("Allow any user to adjust his own preferences.");
45 function getVersion() {
46 return preg_replace("/[Revision: $]/", '',
50 function getDefaultArguments() {
52 $pagename = $request->getArg('pagename');
53 $user = $request->getUser();
54 if ( isset($user->_prefs) and
55 isset($user->_prefs->_prefs) and
56 isset($user->_prefs->_method) ) {
57 $pref =& $user->_prefs;
59 $pref = $user->getPreferences();
62 //we need a hash of pref => default_value
63 foreach ($pref->_prefs as $name => $obj) {
64 $prefs[$name] = $obj->default_value;
69 function run($dbi, $argstr, &$request, $basepage) {
70 $args = $this->getArgs($argstr, $request);
71 $user =& $request->_user;
72 if (isa($request,'MockRequest'))
74 if ((!$request->isActionPage($request->getArg('pagename'))
75 and (!isset($user->_prefs->_method)
76 or !in_array($user->_prefs->_method, array('ADODB','SQL','PDO'))))
77 or (in_array($request->getArg('action'), array('zip','ziphtml','dumphtml')))
78 or (isa($user,'_ForbiddenUser')))
80 $no_args = $this->getDefaultArguments();
82 // foreach ($no_args as $key => $value) {
83 // $no_args[$value] = false;
85 $no_args['errmsg'] = HTML(HTML::h2(_("Error: The user HomePage must be a valid WikiWord. Sorry, UserPreferences cannot be saved."),HTML::hr()));
86 $no_args['isForm'] = false;
87 return Template('userprefs', $no_args);
89 $userid = $user->UserName();
90 if (// ((defined('ALLOW_BOGO_LOGIN') && ALLOW_BOGO_LOGIN && $user->isSignedIn()) ||
91 $user->isAuthenticated() and !empty($userid))
93 $pref = &$request->_prefs;
94 $args['isForm'] = true;
95 //trigger_error("DEBUG: reading prefs from getPreferences".print_r($pref));
97 if ($request->isPost()) {
99 $delete = $request->getArg('delete');
100 if ($delete and $request->getArg('verify')) {
101 // deleting prefs, verified
102 $default_prefs = $pref->defaultPreferences();
103 $default_prefs['userid'] = $user->UserName();
104 $user->setPreferences($default_prefs);
105 $request->_setUser($user);
106 $request->setArg("verify",false);
107 $request->setArg("delete",false);
108 // Alert message removed, display directly the Preference form with the message.
109 // $alert = new Alert(_("Message"),
110 // _("Your UserPreferences have been successfully reset to default."));
113 $errmsg .= _("Your UserPreferences have been successfully reset to default.");
114 $args['errmsg'] = HTML::div(array('class' => 'feedback'), HTML::p($errmsg));
115 return Template('userprefs', $args);
116 } elseif ($delete and !$request->getArg('verify')) {
117 return HTML::form(array('action' => $request->getPostURL(),
119 HiddenInputs(array('verify' => 1)),
120 HiddenInputs($request->getArgs()),
121 HTML::p(_("Do you really want to reset all your UserPreferences?")),
122 HTML::p(Button('submit:delete', _("Yes"), 'delete'),
124 Button('cancel', _("Cancel")))
126 } elseif ($rp = $request->getArg('pref')) {
127 // replace only changed prefs in $pref with those from request
128 if (!empty($rp['passwd']) and ($rp['passwd2'] != $rp['passwd'])) {
129 $errmsg = _("Wrong password. Try again.");
131 //trigger_error("DEBUG: reading prefs from request".print_r($rp));
132 //trigger_error("DEBUG: writing prefs with setPreferences".print_r($pref));
133 if (empty($rp['passwd'])) unset($rp['passwd']);
134 // fix to set system pulldown's. empty values don't get posted
135 if (empty($rp['theme'])) $rp['theme'] = '';
136 if (empty($rp['lang'])) $rp['lang'] = '';
137 $num = $user->setPreferences($rp);
138 if (!empty($rp['passwd'])) {
139 $passchanged = false;
140 if ($user->mayChangePass()) {
141 if (method_exists($user, 'storePass')) {
142 $passchanged = $user->storePass($rp['passwd']);
144 if (!$passchanged and method_exists($user, 'changePass')) {
145 $passchanged = $user->changePass($rp['passwd']);
148 $errmsg = _("Password updated.");
150 $errmsg = _("Password was not changed.");
153 $errmsg = _("Password cannot be changed.");
157 $errmsg .= " " ._("No changes.");
159 $request->_setUser($user);
160 $pref = $user->_prefs;
162 $errmsg .= _("One UserPreferences field successfully updated.");
164 $errmsg .= sprintf(_("%d UserPreferences fields successfully updated."), $num);
168 $args['errmsg'] = HTML::div(array('class' => 'feedback'), HTML::p($errmsg));
172 $args['available_themes'] = listAvailableThemes();
173 $args['available_languages'] = listAvailableLanguages();
175 return Template('userprefs', $args);
177 // wrong or unauthenticated user
178 return $request->_notAuthorized(WIKIAUTH_BOGO);
179 //return $user->PrintLoginForm ($request, $args, false, false);
189 // c-hanging-comment-ender-p: nil
190 // indent-tabs-mode: nil