2 rcs_id('$Id: UserPreferences.php,v 1.15 2004-01-27 22:37:50 rurban Exp $');
4 Copyright 2001, 2002, 2003 $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 within the user's home page or in a cookie.
28 class WikiPlugin_UserPreferences
34 return _("UserPreferences");
37 function getVersion() {
38 return preg_replace("/[Revision: $]/", '',
39 "\$Revision: 1.15 $");
42 function getDefaultArguments() {
44 $pagename = $request->getArg('pagename');
45 $user = $request->getUser();
46 //we need a hash of pref => default_value
47 $pref = $user->getPreferences();
49 foreach ($pref->_prefs as $name => $obj) {
50 $prefs[$name] = $obj->default_value;
55 function run($dbi, $argstr, $request) {
56 $args = $this->getArgs($argstr, $request);
57 $user = &$request->getUser();
58 if (! $request->isActionPage($request->getArg('pagename'))) {
59 $no_args = $this->getDefaultArguments();
61 // foreach ($no_args as $key => $value) {
62 // $no_args[$value] = false;
64 $no_args['errmsg'] = HTML(HTML::h2(_("Error: The user HomePage must be a valid WikiWord. Sorry, UserPreferences cannot be saved."),HTML::hr()));
65 $no_args['isForm'] = false;
66 return Template('userprefs', $no_args);
68 $userid = $user->UserName();
69 if (((defined('ALLOW_BOGO_LOGIN') && ALLOW_BOGO_LOGIN && $user->isSignedIn())
70 || $user->isAuthenticated())
72 $pref = $user->getPreferences();
73 //trigger_error("DEBUG: reading prefs from getPreferences".print_r($pref));
75 if ($request->isPost()) {
76 //trigger_error("DEBUG: request is post");
77 if ($request->_prefs) {
78 // replace only changed prefs in $pref with those from request
79 $rp = $request->_prefs->_prefs;
80 //trigger_error("DEBUG: reading prefs from request".print_r($rp));
81 //trigger_error("DEBUG: writing prefs with setPreferences".print_r($pref));
82 $num = $user->setPreferences(new UserPreferences($rp));
84 $errmsg = _("No changes.");
87 $errmsg = fmt("%d UserPreferences fields successfully updated.", $num);
89 $args['errmsg'] = HTML(HTML::h2($errmsg), HTML::hr());
92 $available_themes = array();
93 $dir_root = 'themes/';
94 if (defined('PHPWIKI_DIR'))
95 $dir_root = PHPWIKI_DIR . "/$dir_root";
96 $dir = dir($dir_root);
98 while($entry = $dir->read()) {
99 if (is_dir($dir_root.$entry)
100 && (substr($entry,0,1) != '.')
101 && $entry != 'CVS') {
102 array_push($available_themes, $entry);
107 $args['available_themes'] = $available_themes;
109 $available_languages = array('en');
110 $dir_root = 'locale/';
111 if (defined('PHPWIKI_DIR'))
112 $dir_root = PHPWIKI_DIR . "/$dir_root";
113 $dir = dir($dir_root);
115 while($entry = $dir->read()) {
116 if (is_dir($dir_root.$entry)
117 && (substr($entry,0,1) != '.')
119 && $entry != 'CVS') {
120 array_push($available_languages, $entry);
125 $args['available_languages'] = $available_languages;
127 return Template('userprefs', $args);
130 return $user->PrintLoginForm ($request, $args, false, false);
135 // $Log: not supported by cvs2svn $
136 // Revision 1.14 2004/01/26 09:18:00 rurban
137 // * changed stored pref representation as before.
138 // the array of objects is 1) bigger and 2)
139 // less portable. If we would import packed pref
140 // objects and the object definition was changed, PHP would fail.
141 // This doesn't happen with an simple array of non-default values.
142 // * use $prefs->retrieve and $prefs->store methods, where retrieve
143 // understands the interim format of array of objects also.
144 // * simplified $prefs->get() and fixed $prefs->set()
145 // * added $user->_userid and class '_WikiUser' portability functions
146 // * fixed $user object ->_level upgrading, mostly using sessions.
147 // this fixes yesterdays problems with loosing authorization level.
148 // * fixed WikiUserNew::checkPass to return the _level
149 // * fixed WikiUserNew::isSignedIn
150 // * added explodePageList to class PageList, support sortby arg
151 // * fixed UserPreferences for WikiUserNew
152 // * fixed WikiPlugin for empty defaults array
153 // * UnfoldSubpages: added pagename arg, renamed pages arg,
154 // removed sort arg, support sortby arg
156 // Revision 1.13 2003/12/04 20:27:00 carstenklapp
159 // Revision 1.12 2003/12/01 22:21:33 carstenklapp
160 // Bugfix: UserPreferences are no longer clobbered when signing in after
161 // the previous session has ended (i.e. user closed browser then signed
162 // in again). This is still a bit of a mess, and the preferences do not
163 // take effect until the next page browse/link has been clicked.
165 // Revision 1.11 2003/09/19 22:01:19 carstenklapp
166 // BOGO users allowed preferences too when ALLOW_BOGO_LOGIN == true.
168 // Revision 1.10 2003/09/13 21:57:26 carstenklapp
169 // Reformatting only.
171 // Revision 1.9 2003/09/13 21:53:41 carstenklapp
172 // Added lang and theme arguments, getVersion(), copyright and cvs log.
180 // c-hanging-comment-ender-p: nil
181 // indent-tabs-mode: nil