3 * Hold things related to displaying and saving user preferences.
5 * @subpackage SpecialPage
9 * Entry point that create the "Preferences" object
11 function wfSpecialPreferences() {
14 $form = new PreferencesForm( $wgRequest );
19 * Preferences form handling
20 * This object will show the preferences form and can save it as well.
22 * @subpackage SpecialPage
24 class PreferencesForm
{
25 var $mQuickbar, $mOldpass, $mNewpass, $mRetypePass, $mStubs;
26 var $mRows, $mCols, $mSkin, $mMath, $mDate, $mUserEmail, $mEmailFlag, $mNick;
27 var $mSearch, $mRecent, $mHourDiff, $mSearchLines, $mSearchChars, $mAction;
28 var $mReset, $mPosted, $mToggles, $mSearchNs, $mRealName;
34 function PreferencesForm( &$request ) {
35 global $wgLang, $wgAllowRealName;
37 $this->mQuickbar
= $request->getVal( 'wpQuickbar' );
38 $this->mOldpass
= $request->getVal( 'wpOldpass' );
39 $this->mNewpass
= $request->getVal( 'wpNewpass' );
40 $this->mRetypePass
=$request->getVal( 'wpRetypePass' );
41 $this->mStubs
= $request->getVal( 'wpStubs' );
42 $this->mRows
= $request->getVal( 'wpRows' );
43 $this->mCols
= $request->getVal( 'wpCols' );
44 $this->mSkin
= $request->getVal( 'wpSkin' );
45 $this->mMath
= $request->getVal( 'wpMath' );
46 $this->mDate
= $request->getVal( 'wpDate' );
47 $this->mUserEmail
= $request->getVal( 'wpUserEmail' );
48 $this->mRealName
= ($wgAllowRealName) ?
$request->getVal( 'wpRealName' ) : '';
49 $this->mEmailFlag
= $request->getCheck( 'wpEmailFlag' ) ?
1 : 0;
50 $this->mNick
= $request->getVal( 'wpNick' );
51 $this->mSearch
= $request->getVal( 'wpSearch' );
52 $this->mRecent
= $request->getVal( 'wpRecent' );
53 $this->mHourDiff
= $request->getVal( 'wpHourDiff' );
54 $this->mSearchLines
= $request->getVal( 'wpSearchLines' );
55 $this->mSearchChars
= $request->getVal( 'wpSearchChars' );
56 $this->mAction
= $request->getVal( 'action' );
57 $this->mReset
= $request->getCheck( 'wpReset' );
58 $this->mPosted
= $request->wasPosted();
59 $this->mSaveprefs
= $request->getCheck( 'wpSaveprefs' ) && $this->mPosted
;
61 # User toggles (the big ugly unsorted list of checkboxes)
62 $this->mToggles
= array();
63 if ( $this->mPosted
) {
64 $togs = $wgLang->getUserToggles();
65 foreach ( $togs as $tname ) {
66 $this->mToggles
[$tname] = $request->getCheck( "wpOp$tname" ) ?
1 : 0;
70 $this->mUsedToggles
= array();
72 # Search namespace options
73 # Note: namespaces don't necessarily have consecutive keys
74 $this->mSearchNs
= array();
75 if ( $this->mPosted
) {
76 $namespaces = $wgLang->getNamespaces();
77 foreach ( $namespaces as $i => $namespace ) {
79 $this->mSearchNs
[$i] = $request->getCheck( "wpNs$i" ) ?
1 : 0;
86 global $wgUser, $wgOut, $wgUseDynamicDates;
88 if ( 0 == $wgUser->getID() ) {
89 $wgOut->errorpage( 'prefsnologin', 'prefsnologintext' );
93 $wgOut->readOnlyPage();
96 if ( $this->mReset
) {
98 $this->mainPrefsForm( wfMsg( 'prefsreset' ) );
99 } else if ( $this->mSaveprefs
) {
100 $this->savePreferences();
103 $this->mainPrefsForm( '' );
110 function validateInt( &$val, $min=0, $max=0x7fffffff ) {
112 $val = min($val, $max);
113 $val = max($val, $min);
120 function validateIntOrNull( &$val, $min=0, $max=0x7fffffff ) {
125 return $this->validateInt( $val, $min, $max );
132 function validateTimeZone( $s ) {
134 if ( strpos( $s, ':' ) ) {
136 $array = explode( ':' , $s );
137 $hour = intval( $array[0] );
138 $minute = intval( $array[1] );
140 $minute = intval( $s * 60 );
141 $hour = intval( $minute / 60 );
142 $minute = abs( $minute ) %
60;
144 $hour = min( $hour, 15 );
145 $hour = max( $hour, -15 );
146 $minute = min( $minute, 59 );
147 $minute = max( $minute, 0 );
148 $s = sprintf( "%02d:%02d", $hour, $minute );
156 function savePreferences() {
157 global $wgUser, $wgLang, $wgDeferredUpdateList, $wgOut;
159 if ( '' != $this->mNewpass
) {
160 if ( $this->mNewpass
!= $this->mRetypePass
) {
161 $this->mainPrefsForm( wfMsg( 'badretype' ) );
165 if (!$wgUser->checkPassword( $this->mOldpass
)) {
166 $this->mainPrefsForm( wfMsg( 'wrongpassword' ) );
169 $wgUser->setPassword( $this->mNewpass
);
171 $wgUser->setEmail( $this->mUserEmail
);
172 $wgUser->setRealName( $this->mRealName
);
173 $wgUser->setOption( 'nickname', $this->mNick
);
174 $wgUser->setOption( 'quickbar', $this->mQuickbar
);
175 $wgUser->setOption( 'skin', $this->mSkin
);
176 $wgUser->setOption( 'math', $this->mMath
);
177 $wgUser->setOption( 'date', $this->mDate
);
178 $wgUser->setOption( 'searchlimit', $this->validateIntOrNull( $this->mSearch
) );
179 $wgUser->setOption( 'contextlines', $this->validateIntOrNull( $this->mSearchLines
) );
180 $wgUser->setOption( 'contextchars', $this->validateIntOrNull( $this->mSearchChars
) );
181 $wgUser->setOption( 'rclimit', $this->validateIntOrNull( $this->mRecent
) );
182 $wgUser->setOption( 'rows', $this->validateInt( $this->mRows
, 4, 1000 ) );
183 $wgUser->setOption( 'cols', $this->validateInt( $this->mCols
, 4, 1000 ) );
184 $wgUser->setOption( 'stubthreshold', $this->validateIntOrNull( $this->mStubs
) );
185 $wgUser->setOption( 'timecorrection', $this->validateTimeZone( $this->mHourDiff
, -12, 14 ) );
187 # Set search namespace options
188 foreach( $this->mSearchNs
as $i => $value ) {
189 $wgUser->setOption( "searchNs{$i}", $value );
192 $wgUser->setOption( 'disablemail', $this->mEmailFlag
);
195 foreach ( $this->mToggles
as $tname => $tvalue ) {
196 $wgUser->setOption( $tname, $tvalue );
198 $wgUser->setCookies();
199 $up = new UserUpdate();
200 array_push( $wgDeferredUpdateList, $up );
201 $wgOut->setParserOptions( ParserOptions
::newFromUser( $wgUser ) );
202 $po = ParserOptions
::newFromUser( $wgUser );
203 $this->mainPrefsForm( wfMsg( 'savedprefs' ) );
208 */ function resetPrefs() {
209 global $wgUser, $wgLang, $wgAllowRealName;
211 $this->mOldpass
= $this->mNewpass
= $this->mRetypePass
= '';
212 $this->mUserEmail
= $wgUser->getEmail();
213 $this->mRealName
= ($wgAllowRealName) ?
$wgUser->getRealName() : '';
214 if ( 1 == $wgUser->getOption( 'disablemail' ) ) { $this->mEmailFlag
= 1; }
215 else { $this->mEmailFlag
= 0; }
216 $this->mNick
= $wgUser->getOption( 'nickname' );
218 $this->mQuickbar
= $wgUser->getOption( 'quickbar' );
219 $this->mSkin
= $wgUser->getOption( 'skin' );
220 $this->mMath
= $wgUser->getOption( 'math' );
221 $this->mDate
= $wgUser->getOption( 'date' );
222 $this->mRows
= $wgUser->getOption( 'rows' );
223 $this->mCols
= $wgUser->getOption( 'cols' );
224 $this->mStubs
= $wgUser->getOption( 'stubthreshold' );
225 $this->mHourDiff
= $wgUser->getOption( 'timecorrection' );
226 $this->mSearch
= $wgUser->getOption( 'searchlimit' );
227 $this->mSearchLines
= $wgUser->getOption( 'contextlines' );
228 $this->mSearchChars
= $wgUser->getOption( 'contextchars' );
229 $this->mRecent
= $wgUser->getOption( 'rclimit' );
231 $togs = $wgLang->getUserToggles();
232 foreach ( $togs as $tname ) {
233 $ttext = wfMsg('tog-'.$tname);
234 $this->mToggles
[$tname] = $wgUser->getOption( $tname );
237 $namespaces = $wgLang->getNamespaces();
238 foreach ( $namespaces as $i => $namespace ) {
240 $this->mSearchNs
[$i] = $wgUser->getOption( 'searchNs'.$i );
248 function namespacesCheckboxes() {
249 global $wgLang, $wgUser;
251 # Determine namespace checkboxes
252 $namespaces = $wgLang->getNamespaces();
255 foreach ( $namespaces as $i => $name ) {
256 # Skip special or anything similar
259 if ( $this->mSearchNs
[$i] ) {
260 $checked = ' checked="checked"';
262 $name = str_replace( '_', ' ', $namespaces[$i] );
264 $name = wfMsg( 'blanknamespace' );
270 $r1 .= "<label><input type='checkbox' value=\"1\" name=\"" .
271 "wpNs$i\"{$checked} />{$name}</label>\n";
279 function getToggle( $tname ) {
280 global $wgUser, $wgLang;
282 $this->mUsedToggles
[$tname] = true;
283 $ttext = $wgLang->getUserToggle( $tname );
285 if ( 1 == $wgUser->getOption( $tname ) ) {
286 $checked = ' checked="checked"';
290 return "<div><input type='checkbox' value=\"1\" "
291 . "id=\"$tname\" name=\"wpOp$tname\"$checked /><label for=\"$tname\">$ttext</label></div>\n";
297 function mainPrefsForm( $err ) {
298 global $wgUser, $wgOut, $wgLang, $wgUseDynamicDates, $wgValidSkinNames;
299 global $wgAllowRealName;
301 $wgOut->setPageTitle( wfMsg( 'preferences' ) );
302 $wgOut->setArticleRelated( false );
303 $wgOut->setRobotpolicy( 'noindex,nofollow' );
306 $wgOut->addHTML( "<p class='error'>" . htmlspecialchars( $err ) . "</p>\n" );
308 $uname = $wgUser->getName();
309 $uid = $wgUser->getID();
311 $wgOut->addWikiText( wfMsg( 'prefslogintext', $uname, $uid ) );
312 $wgOut->addWikiText( wfMsg('clearyourcache'));
314 $qbs = $wgLang->getQuickbarSettings();
315 $skinNames = $wgLang->getSkinNames();
316 $mathopts = $wgLang->getMathNames();
317 $dateopts = $wgLang->getDateFormats();
318 $togs = $wgLang->getUserToggles();
320 $titleObj = Title
::makeTitle( NS_SPECIAL
, 'Preferences' );
321 $action = $titleObj->escapeLocalURL();
323 $qb = wfMsg( 'qbsettings' );
324 $cp = wfMsg( 'changepassword' );
325 $sk = wfMsg( 'skin' );
326 $math = wfMsg( 'math' );
327 $dateFormat = wfMsg('dateformat');
328 $opw = wfMsg( 'oldpassword' );
329 $npw = wfMsg( 'newpassword' );
330 $rpw = wfMsg( 'retypenew' );
331 $svp = wfMsg( 'saveprefs' );
332 $rsp = wfMsg( 'resetprefs' );
333 $tbs = wfMsg( 'textboxsize' );
334 $tbr = wfMsg( 'rows' );
335 $tbc = wfMsg( 'columns' );
336 $ltz = wfMsg( 'localtime' );
337 $timezone = wfMsg( 'timezonelegend' );
338 $tzt = wfMsg( 'timezonetext' );
339 $tzo = wfMsg( 'timezoneoffset' );
340 $tzGuess = wfMsg( 'guesstimezone' );
341 $tzServerTime = wfMsg( 'servertime' );
342 $yem = wfMsg( 'youremail' );
343 $yrn = ($wgAllowRealName) ?
wfMsg( 'yourrealname' ) : '';
344 $emf = wfMsg( 'emailflag' );
345 $ynn = wfMsg( 'yournick' );
346 $stt = wfMsg ( 'stubthreshold' ) ;
347 $srh = wfMsg( 'searchresultshead' );
348 $rpp = wfMsg( 'resultsperpage' );
349 $scl = wfMsg( 'contextlines' );
350 $scc = wfMsg( 'contextchars' );
351 $rcc = wfMsg( 'recentchangescount' );
352 $dsn = wfMsg( 'defaultns' );
354 $wgOut->addHTML( "<form id=\"preferences\" name=\"preferences\" action=\"$action\"
357 # First section: identity
360 $this->mUserEmail
= htmlspecialchars( $this->mUserEmail
);
361 $this->mRealName
= htmlspecialchars( $this->mRealName
);
362 $this->mNick
= htmlspecialchars( $this->mNick
);
363 if ( $this->mEmailFlag
) { $emfc = 'checked="checked"'; }
366 $ps = $this->namespacesCheckboxes();
368 $wgOut->addHTML( "<fieldset>
369 <legend>".wfMsg('prefs-personal')."</legend>");
370 if ($wgAllowRealName) {
371 $wgOut->addHTML("<div><label>$yrn: <input type='text' name=\"wpRealName\" value=\"{$this->mRealName}\" size='20' /></label></div>");
374 <div><label>$yem: <input type='text' name=\"wpUserEmail\" value=\"{$this->mUserEmail}\" size='20' /></label></div>
375 <div><label><input type='checkbox' $emfc value=\"1\" name=\"wpEmailFlag\" /> $emf</label></div>
376 <div><label>$ynn: <input type='text' name=\"wpNick\" value=\"{$this->mNick}\" size='12' /></label></div>\n" );
378 # Fields for changing password
380 $this->mOldpass
= htmlspecialchars( $this->mOldpass
);
381 $this->mNewpass
= htmlspecialchars( $this->mNewpass
);
382 $this->mRetypePass
= htmlspecialchars( $this->mRetypePass
);
384 $wgOut->addHTML( "<fieldset>
386 <div><label>$opw: <input type='password' name=\"wpOldpass\" value=\"{$this->mOldpass}\" size='20' /></label></div>
387 <div><label>$npw: <input type='password' name=\"wpNewpass\" value=\"{$this->mNewpass}\" size='20' /></label></div>
388 <div><label>$rpw: <input type='password' name=\"wpRetypePass\" value=\"{$this->mRetypePass}\" size='20' /></label></div>
389 " . $this->getToggle( "rememberpassword" ) . "
391 <div class='prefsectiontip'>".wfMsg('prefs-help-userdata')."</div>\n</fieldset>\n" );
396 $wgOut->addHtml( "<fieldset>\n<legend>$qb</legend>\n" );
397 for ( $i = 0; $i < count( $qbs ); ++
$i ) {
398 if ( $i == $this->mQuickbar
) { $checked = ' checked="checked"'; }
399 else { $checked = ""; }
400 $wgOut->addHTML( "<div><label><input type='radio' name=\"wpQuickbar\"
401 value=\"$i\"$checked /> {$qbs[$i]}</label></div>\n" );
403 $wgOut->addHtml('<div class="prefsectiontip">'.wfMsg('qbsettingsnote').'</div>');
404 $wgOut->addHtml( "</fieldset>\n\n" );
408 $wgOut->addHTML( "<fieldset>\n<legend>$sk</legend>\n" );
409 # Only show members of $wgValidSkinNames rather than
410 # $skinNames (skins is all skin names from Language.php)
411 foreach ($wgValidSkinNames as $skinkey => $skinname ) {
412 if ( $skinkey == $this->mSkin
) {
413 $checked = ' checked="checked"';
417 if ( isset( $skinNames[$skinkey] ) ) {
418 $sn = $skinNames[$skinkey];
422 $wgOut->addHTML( "<div><label><input type='radio' name=\"wpSkin\"
423 value=\"$skinkey\"$checked /> {$sn}</label></div>\n" );
425 $wgOut->addHTML( "</fieldset>\n\n" );
429 $wgOut->addHTML( "<fieldset>\n<legend>$math</legend>\n" );
430 for ( $i = 0; $i < count( $mathopts ); ++
$i ) {
431 if ( $i == $this->mMath
) { $checked = ' checked="checked"'; }
432 else { $checked = ""; }
433 $wgOut->addHTML( "<div><label><input type='radio' name=\"wpMath\"
434 value=\"$i\"$checked /> ".wfMsg($mathopts[$i])."</label></div>\n" );
436 $wgOut->addHTML( "</fieldset>\n\n" );
440 if ( $wgUseDynamicDates ) {
441 $wgOut->addHTML( "<fieldset>\n<legend>$dateFormat</legend>\n" );
442 for ( $i = 0; $i < count( $dateopts ); ++
$i) {
443 if ( $i == $this->mDate
) {
444 $checked = ' checked="checked"';
448 $wgOut->addHTML( "<div><label><input type='radio' name=\"wpDate\" ".
449 "value=\"$i\"$checked /> {$dateopts[$i]}</label></div>\n" );
451 $wgOut->addHTML( "</fieldset>\n\n");
456 $nowlocal = $wgLang->time( $now = wfTimestampNow(), true );
457 $nowserver = $wgLang->time( $now, false );
458 $wgOut->addHTML( "<fieldset>
459 <legend>$tbs</legend>\n
461 <label>$tbr: <input type='text' name=\"wpRows\" value=\"{$this->mRows}\" size='6' /></label>
462 <label>$tbc: <input type='text' name=\"wpCols\" value=\"{$this->mCols}\" size='6' /></label>
464 $this->getToggle( "editwidth" ) .
465 $this->getToggle( "showtoolbar" ) .
466 $this->getToggle( "previewontop" ) .
467 $this->getToggle( "watchdefault" ) .
468 $this->getToggle( "minordefault" ) . "
472 <legend>$timezone</legend>
473 <div><b>$tzServerTime:</b> $nowserver</div>
474 <div><b>$ltz:</b> $nowlocal</div>
475 <div><label>$tzo*: <input type='text' name=\"wpHourDiff\" value=\"{$this->mHourDiff}\" size='6' /></label></div>
476 <div><input type=\"button\" value=\"$tzGuess\" onClick=\"javascript:guessTimezone()\" id=\"guesstimezonebutton\" style=\"display:none\" /></div>
477 <div class='prefsectiontip'>* {$tzt}</div>
481 <fieldset><legend>".wfMsg('prefs-rc')."</legend>
482 <div><label>$rcc: <input type='text' name=\"wpRecent\" value=\"$this->mRecent\" size='6' /></label></div>
483 " . $this->getToggle( "hideminor" ) .
484 $this->getToggle( "usenewrc" ) . "
485 <div><label>$stt: <input type='text' name=\"wpStubs\" value=\"$this->mStubs\" size='6' /></label></div>
489 <legend>$srh</legend>
490 <div><label>$rpp: <input type='text' name=\"wpSearch\" value=\"$this->mSearch\" size='6' /></label></div>
491 <div><label>$scl: <input type='text' name=\"wpSearchLines\" value=\"$this->mSearchLines\" size='6' /></label></div>
492 <div><label>$scc: <input type='text' name=\"wpSearchChars\" value=\"$this->mSearchChars\" size='6' /></label></div>
495 <legend>$dsn</legend>
501 # Various checkbox options
503 $wgOut->addHTML("<fieldset><legend>".wfMsg('prefs-misc')."</legend>");
504 foreach ( $togs as $tname ) {
505 if( !array_key_exists( $tname, $this->mUsedToggles
) ) {
506 $wgOut->addHTML( $this->getToggle( $tname ) );
509 $wgOut->addHTML( "</fieldset>\n\n" );
512 <div id='prefsubmit'>
514 <input type='submit' name=\"wpSaveprefs\" value=\"$svp\" accesskey=\"".
515 wfMsg('accesskey-save')."\" title=\"[alt-".wfMsg('accesskey-save')."]\" />
516 <input type='submit' name=\"wpReset\" value=\"$rsp\" />