4 * Copyright (C) 2001,2002,2003,2004,2005 $ThePhpWikiProgrammingTeam
5 * Copyright 2008-2009 Marc-Etienne Vargenau, Alcatel-Lucent
7 * This file is part of PhpWiki.
9 * PhpWiki is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * PhpWiki is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with PhpWiki; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 * Plugin to allow any user to adjust his own preferences.
26 * This must be used in the page "UserPreferences".
27 * Prefs are stored in metadata in the current session,
28 * within the user's home page or in a database.
30 * WikiTheme extension: WikiThemes are able to extend the predefined list
33 class WikiPlugin_UserPreferences
39 return _("UserPreferences");
42 function getDescription () {
43 return _("Allow any user to adjust his own preferences.");
46 function getVersion() {
47 return preg_replace("/[Revision: $]/", '',
51 function getDefaultArguments() {
53 $pagename = $request->getArg('pagename');
54 $user = $request->getUser();
55 if ( isset($user->_prefs) and
56 isset($user->_prefs->_prefs) and
57 isset($user->_prefs->_method) ) {
58 $pref =& $user->_prefs;
60 $pref = $user->getPreferences();
63 //we need a hash of pref => default_value
64 foreach ($pref->_prefs as $name => $obj) {
65 $prefs[$name] = $obj->default_value;
70 function run($dbi, $argstr, &$request, $basepage) {
71 $args = $this->getArgs($argstr, $request);
72 $user =& $request->_user;
73 if (isa($request,'MockRequest'))
75 if (defined('GFORGE') and GFORGE) {
76 if (!($user->isAuthenticated())) {
77 return HTML::div(array('class' => 'errors'),
78 _("Error: You are not logged in, cannot display UserPreferences."));
81 if ((!$request->isActionPage($request->getArg('pagename'))
82 and (!isset($user->_prefs->_method)
83 or !in_array($user->_prefs->_method, array('ADODB','SQL','PDO'))))
84 or (in_array($request->getArg('action'), array('zip','ziphtml','dumphtml')))
85 or (isa($user,'_ForbiddenUser')))
87 $no_args = $this->getDefaultArguments();
89 // foreach ($no_args as $key => $value) {
90 // $no_args[$value] = false;
92 $no_args['errmsg'] = HTML::div(array('class' => 'errors'),
93 _("Error: The user HomePage must be a valid WikiWord. Sorry, UserPreferences cannot be saved."));
94 $no_args['isForm'] = false;
95 return Template('userprefs', $no_args);
97 $userid = $user->UserName();
98 if (// ((defined('ALLOW_BOGO_LOGIN') && ALLOW_BOGO_LOGIN && $user->isSignedIn()) ||
99 $user->isAuthenticated() and !empty($userid))
101 $pref = &$request->_prefs;
102 $args['isForm'] = true;
103 //trigger_error("DEBUG: reading prefs from getPreferences".print_r($pref));
105 if ($request->isPost()) {
107 $delete = $request->getArg('delete');
108 if ($delete and $request->getArg('verify')) {
109 // deleting prefs, verified
110 $default_prefs = $pref->defaultPreferences();
111 $default_prefs['userid'] = $user->UserName();
112 $user->setPreferences($default_prefs);
113 $request->_setUser($user);
114 $request->setArg("verify",false);
115 $request->setArg("delete",false);
116 $errmsg .= _("Your UserPreferences have been successfully reset to default.");
117 $args['errmsg'] = HTML::div(array('class' => 'feedback'), HTML::p($errmsg));
118 return Template('userprefs', $args);
119 } elseif ($delete and !$request->getArg('verify')) {
120 return HTML::fieldset(
121 HTML::form(array('action' => $request->getPostURL(),
123 HiddenInputs(array('verify' => 1)),
124 HiddenInputs($request->getArgs()),
125 HTML::p(_("Do you really want to reset all your UserPreferences?")),
126 HTML::p(Button('submit:delete', _("Yes"), 'delete'),
128 Button('cancel', _("Cancel")))
130 } elseif ($rp = $request->getArg('pref')) {
131 // replace only changed prefs in $pref with those from request
132 if (!empty($rp['passwd']) and ($rp['passwd2'] != $rp['passwd'])) {
133 $errmsg = _("Wrong password. Try again.");
135 //trigger_error("DEBUG: reading prefs from request".print_r($rp));
136 //trigger_error("DEBUG: writing prefs with setPreferences".print_r($pref));
137 if (empty($rp['passwd'])) unset($rp['passwd']);
138 // fix to set system pulldown's. empty values don't get posted
139 if (empty($rp['theme'])) $rp['theme'] = '';
140 if (empty($rp['lang'])) $rp['lang'] = '';
141 $num = $user->setPreferences($rp);
142 if (!empty($rp['passwd'])) {
143 $passchanged = false;
144 if ($user->mayChangePass()) {
145 if (method_exists($user, 'storePass')) {
146 $passchanged = $user->storePass($rp['passwd']);
148 if (!$passchanged and method_exists($user, 'changePass')) {
149 $passchanged = $user->changePass($rp['passwd']);
152 $errmsg = _("Password updated.");
154 $errmsg = _("Password was not changed.");
157 $errmsg = _("Password cannot be changed.");
161 $errmsg .= " " ._("No changes.");
163 $request->_setUser($user);
164 $pref = $user->_prefs;
166 $errmsg .= _("One UserPreferences field successfully updated.");
168 $errmsg .= sprintf(_("%d UserPreferences fields successfully updated."), $num);
172 $args['errmsg'] = HTML::div(array('class' => 'feedback'), HTML::p($errmsg));
176 $args['available_themes'] = listAvailableThemes();
177 $args['available_languages'] = listAvailableLanguages();
179 return Template('userprefs', $args);
181 // wrong or unauthenticated user
182 return $request->_notAuthorized(WIKIAUTH_BOGO);
183 //return $user->PrintLoginForm ($request, $args, false, false);
193 // c-hanging-comment-ender-p: nil
194 // indent-tabs-mode: nil