3 * Copyright © 2001,2002,2003,2004,2005 $ThePhpWikiProgrammingTeam
4 * Copyright © 2008-2009 Marc-Etienne Vargenau, Alcatel-Lucent
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 along
19 * with PhpWiki; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 * SPDX-License-Identifier: GPL-2.0-or-later
27 * Plugin to allow any user to adjust his own preferences.
28 * This must be used in the page "UserPreferences".
29 * Prefs are stored in metadata in the current session,
30 * within the user's home page or in a database.
32 * WikiTheme extension: WikiThemes are able to extend the predefined list
36 class WikiPlugin_UserPreferences
42 function getDescription()
44 return _("Allow any user to adjust his own preferences.");
47 function getDefaultArguments()
50 $user = $request->getUser();
51 if (isset($user->_prefs) and
52 isset($user->_prefs->_prefs) and
53 isset($user->_prefs->_method)
55 $pref =& $user->_prefs;
57 $pref = $user->getPreferences();
61 // We need a hash of pref => default_value
62 foreach ($pref->_prefs as $name => $obj) {
63 $prefs[$name] = $obj->default_value;
71 * @param string $argstr
72 * @param WikiRequest $request
73 * @param string $basepage
76 function run($dbi, $argstr, &$request, $basepage)
78 $args = $this->getArgs($argstr, $request);
79 $user =& $request->_user;
80 $user->_request = $request;
82 if (defined('FUSIONFORGE') && FUSIONFORGE) {
83 if (!($user->isAuthenticated())) {
84 return HTML::p(array('class' => 'error'),
85 _("Error: You are not logged in, cannot display UserPreferences."));
88 if ((!isActionPage($request->getArg('pagename'))
89 and (!isset($user->_prefs->_method)
90 or (in_array($request->getArg('action'), array('zip', 'ziphtml', 'dumphtml')))
91 or (is_a($user, '_ForbiddenUser'))))
93 $no_args = $this->getDefaultArguments();
94 $no_args['errmsg'] = HTML::p(array('class' => 'error'),
95 _("Error: The user HomePage must be a valid WikiWord. Sorry, UserPreferences cannot be saved."));
96 $no_args['isForm'] = false;
97 return Template('userprefs', $no_args);
99 $userid = $user->UserName();
100 if ($user->isAuthenticated() and !empty($userid)) {
101 $pref = &$request->_prefs;
102 $args['isForm'] = true;
104 if ($request->isPost()) {
106 $delete = $request->getArg('delete');
107 if ($delete and $request->getArg('verify')) {
108 // deleting prefs, verified
109 $default_prefs = $pref->defaultPreferences();
110 $default_prefs['userid'] = $user->UserName();
111 $user->setPreferences($default_prefs);
112 $request->_setUser($user);
113 $request->setArg("verify", false);
114 $request->setArg("delete", false);
115 $errmsg .= _("Your UserPreferences have been successfully reset to default.");
116 $args['errmsg'] = HTML::div(array('class' => 'feedback'), HTML::p($errmsg));
117 return Template('userprefs', $args);
118 } elseif ($delete and !$request->getArg('verify')) {
119 return HTML::fieldset(
120 HTML::form(array('action' => $request->getPostURL(),
122 HiddenInputs(array('verify' => 1)),
123 HiddenInputs($request->getArgs()),
124 HTML::p(_("Do you really want to reset all your UserPreferences?")),
125 HTML::p(Button('submit:delete', _("Yes"), 'delete'),
127 Button('cancel', _("Cancel")))
129 } elseif ($rp = $request->getArg('pref')) {
130 // replace only changed prefs in $pref with those from request
131 if (!empty($rp['passwd']) and ($rp['passwd2'] != $rp['passwd'])) {
133 $errmsg = _("Wrong password. Try again.");
135 if (empty($rp['passwd'])) unset($rp['passwd']);
136 // fix to set system pulldown's. empty values don't get posted
137 if (empty($rp['theme'])) $rp['theme'] = '';
138 if (empty($rp['lang'])) $rp['lang'] = '';
139 $num = $user->setPreferences($rp);
140 if (!empty($rp['passwd'])) {
141 $passchanged = false;
142 if ($user->mayChangePass()) {
143 if (method_exists($user, 'storePass')) {
144 $passchanged = $user->storePass($rp['passwd']);
146 if (!$passchanged and method_exists($user, 'changePass')) {
147 $passchanged = $user->changePass($rp['passwd']);
150 $errmsg = _("Password updated.") . " ";
153 $errmsg = _("Password was not changed.") . " ";
157 $errmsg = _("Password cannot be changed.");
161 $errmsg .= " " . _("No changes.");
163 $request->_setUser($user);
164 $pref = $user->_prefs;
165 update_locale($rp['lang']); // Update locale in case user has changed language
167 $errmsg .= _("One UserPreferences field successfully updated.");
169 $errmsg .= sprintf(_("%d UserPreferences fields successfully updated."), $num);
174 $args['errmsg'] = HTML::div(array('class' => 'error'), HTML::p($errmsg));
176 $args['errmsg'] = HTML::div(array('class' => 'feedback'), HTML::p($errmsg));
181 $args['available_themes'] = listAvailableThemes();
182 $args['available_languages'] = listAvailableLanguages();
184 return Template('userprefs', $args);
186 // wrong or unauthenticated user
187 return $request->_notAuthorized(WIKIAUTH_BOGO);