3 * Hold things related to displaying and saving user preferences.
5 * @subpackage SpecialPage
8 /* to get a list of languages in setting user's language preference */
9 require_once('languages/Names.php');
12 * Entry point that create the "Preferences" object
14 function wfSpecialPreferences() {
17 $form = new PreferencesForm( $wgRequest );
22 * Preferences form handling
23 * This object will show the preferences form and can save it as well.
25 * @subpackage SpecialPage
27 class PreferencesForm
{
28 var $mQuickbar, $mOldpass, $mNewpass, $mRetypePass, $mStubs;
29 var $mRows, $mCols, $mSkin, $mMath, $mDate, $mUserEmail, $mEmailFlag, $mNick;
30 var $mUserLanguage, $mUserVariant;
31 var $mSearch, $mRecent, $mHourDiff, $mSearchLines, $mSearchChars, $mAction;
32 var $mReset, $mPosted, $mToggles, $mSearchNs, $mRealName, $mImageSize;
38 function PreferencesForm( &$request ) {
39 global $wgLang, $wgAllowRealName;
41 $this->mQuickbar
= $request->getVal( 'wpQuickbar' );
42 $this->mOldpass
= $request->getVal( 'wpOldpass' );
43 $this->mNewpass
= $request->getVal( 'wpNewpass' );
44 $this->mRetypePass
=$request->getVal( 'wpRetypePass' );
45 $this->mStubs
= $request->getVal( 'wpStubs' );
46 $this->mRows
= $request->getVal( 'wpRows' );
47 $this->mCols
= $request->getVal( 'wpCols' );
48 $this->mSkin
= $request->getVal( 'wpSkin' );
49 $this->mMath
= $request->getVal( 'wpMath' );
50 $this->mDate
= $request->getVal( 'wpDate' );
51 $this->mUserEmail
= $request->getVal( 'wpUserEmail' );
52 $this->mRealName
= ($wgAllowRealName) ?
$request->getVal( 'wpRealName' ) : '';
53 $this->mEmailFlag
= $request->getCheck( 'wpEmailFlag' ) ?
1 : 0;
54 $this->mNick
= $request->getVal( 'wpNick' );
55 $this->mUserLanguage
= $request->getVal( 'wpUserLanguage' );
56 $this->mUserVariant
= $request->getVal( 'wpUserVariant' );
57 $this->mSearch
= $request->getVal( 'wpSearch' );
58 $this->mRecent
= $request->getVal( 'wpRecent' );
59 $this->mHourDiff
= $request->getVal( 'wpHourDiff' );
60 $this->mSearchLines
= $request->getVal( 'wpSearchLines' );
61 $this->mSearchChars
= $request->getVal( 'wpSearchChars' );
62 $this->mImageSize
= $request->getVal( 'wpImageSize' );
64 $this->mAction
= $request->getVal( 'action' );
65 $this->mReset
= $request->getCheck( 'wpReset' );
66 $this->mPosted
= $request->wasPosted();
67 $this->mSaveprefs
= $request->getCheck( 'wpSaveprefs' ) && $this->mPosted
;
69 # User toggles (the big ugly unsorted list of checkboxes)
70 $this->mToggles
= array();
71 if ( $this->mPosted
) {
72 $togs = $wgLang->getUserToggles();
73 foreach ( $togs as $tname ) {
74 $this->mToggles
[$tname] = $request->getCheck( "wpOp$tname" ) ?
1 : 0;
78 $this->mUsedToggles
= array();
80 # Search namespace options
81 # Note: namespaces don't necessarily have consecutive keys
82 $this->mSearchNs
= array();
83 if ( $this->mPosted
) {
84 $namespaces = $wgLang->getNamespaces();
85 foreach ( $namespaces as $i => $namespace ) {
87 $this->mSearchNs
[$i] = $request->getCheck( "wpNs$i" ) ?
1 : 0;
94 global $wgUser, $wgOut, $wgUseDynamicDates;
96 if ( 0 == $wgUser->getID() ) {
97 $wgOut->errorpage( 'prefsnologin', 'prefsnologintext' );
100 if ( wfReadOnly() ) {
101 $wgOut->readOnlyPage();
104 if ( $this->mReset
) {
106 $this->mainPrefsForm( wfMsg( 'prefsreset' ) );
107 } else if ( $this->mSaveprefs
) {
108 $this->savePreferences();
111 $this->mainPrefsForm( '' );
118 function validateInt( &$val, $min=0, $max=0x7fffffff ) {
120 $val = min($val, $max);
121 $val = max($val, $min);
128 function validateIntOrNull( &$val, $min=0, $max=0x7fffffff ) {
133 return $this->validateInt( $val, $min, $max );
140 function validateTimeZone( $s ) {
142 if ( strpos( $s, ':' ) ) {
144 $array = explode( ':' , $s );
145 $hour = intval( $array[0] );
146 $minute = intval( $array[1] );
148 $minute = intval( $s * 60 );
149 $hour = intval( $minute / 60 );
150 $minute = abs( $minute ) %
60;
152 $hour = min( $hour, 15 );
153 $hour = max( $hour, -15 );
154 $minute = min( $minute, 59 );
155 $minute = max( $minute, 0 );
156 $s = sprintf( "%02d:%02d", $hour, $minute );
164 function savePreferences() {
165 global $wgUser, $wgLang, $wgDeferredUpdateList, $wgOut;
167 if ( '' != $this->mNewpass
) {
168 if ( $this->mNewpass
!= $this->mRetypePass
) {
169 $this->mainPrefsForm( wfMsg( 'badretype' ) );
173 if (!$wgUser->checkPassword( $this->mOldpass
)) {
174 $this->mainPrefsForm( wfMsg( 'wrongpassword' ) );
177 $wgUser->setPassword( $this->mNewpass
);
179 $wgUser->setEmail( $this->mUserEmail
);
180 $wgUser->setRealName( $this->mRealName
);
181 $wgUser->setOption( 'language', $this->mUserLanguage
);
182 $wgUser->setOption( 'variant', $this->mUserVariant
);
183 $wgUser->setOption( 'nickname', $this->mNick
);
184 $wgUser->setOption( 'quickbar', $this->mQuickbar
);
185 $wgUser->setOption( 'skin', $this->mSkin
);
186 $wgUser->setOption( 'math', $this->mMath
);
187 $wgUser->setOption( 'date', $this->mDate
);
188 $wgUser->setOption( 'searchlimit', $this->validateIntOrNull( $this->mSearch
) );
189 $wgUser->setOption( 'contextlines', $this->validateIntOrNull( $this->mSearchLines
) );
190 $wgUser->setOption( 'contextchars', $this->validateIntOrNull( $this->mSearchChars
) );
191 $wgUser->setOption( 'rclimit', $this->validateIntOrNull( $this->mRecent
) );
192 $wgUser->setOption( 'rows', $this->validateInt( $this->mRows
, 4, 1000 ) );
193 $wgUser->setOption( 'cols', $this->validateInt( $this->mCols
, 4, 1000 ) );
194 $wgUser->setOption( 'stubthreshold', $this->validateIntOrNull( $this->mStubs
) );
195 $wgUser->setOption( 'timecorrection', $this->validateTimeZone( $this->mHourDiff
, -12, 14 ) );
196 $wgUser->setOption( 'imagesize', $this->mImageSize
);
198 # Set search namespace options
199 foreach( $this->mSearchNs
as $i => $value ) {
200 $wgUser->setOption( "searchNs{$i}", $value );
203 $wgUser->setOption( 'disablemail', $this->mEmailFlag
);
206 foreach ( $this->mToggles
as $tname => $tvalue ) {
207 $wgUser->setOption( $tname, $tvalue );
209 $wgUser->setCookies();
210 $up = new UserUpdate();
211 array_push( $wgDeferredUpdateList, $up );
212 $wgOut->setParserOptions( ParserOptions
::newFromUser( $wgUser ) );
213 $po = ParserOptions
::newFromUser( $wgUser );
214 $this->mainPrefsForm( wfMsg( 'savedprefs' ) );
220 function resetPrefs() {
221 global $wgUser, $wgLang, $wgAllowRealName;
223 $this->mOldpass
= $this->mNewpass
= $this->mRetypePass
= '';
224 $this->mUserEmail
= $wgUser->getEmail();
225 $this->mRealName
= ($wgAllowRealName) ?
$wgUser->getRealName() : '';
226 $this->mUserLanguage
= $wgUser->getOption( 'language');
227 $this->mUserVariant
= $wgUser->getOption( 'variant');
228 if ( 1 == $wgUser->getOption( 'disablemail' ) ) { $this->mEmailFlag
= 1; }
229 else { $this->mEmailFlag
= 0; }
230 $this->mNick
= $wgUser->getOption( 'nickname' );
232 $this->mQuickbar
= $wgUser->getOption( 'quickbar' );
233 $this->mSkin
= $wgUser->getOption( 'skin' );
234 $this->mMath
= $wgUser->getOption( 'math' );
235 $this->mDate
= $wgUser->getOption( 'date' );
236 $this->mRows
= $wgUser->getOption( 'rows' );
237 $this->mCols
= $wgUser->getOption( 'cols' );
238 $this->mStubs
= $wgUser->getOption( 'stubthreshold' );
239 $this->mHourDiff
= $wgUser->getOption( 'timecorrection' );
240 $this->mSearch
= $wgUser->getOption( 'searchlimit' );
241 $this->mSearchLines
= $wgUser->getOption( 'contextlines' );
242 $this->mSearchChars
= $wgUser->getOption( 'contextchars' );
243 $this->mImageSize
= $wgUser->getOption( 'imagesize' );
244 $this->mRecent
= $wgUser->getOption( 'rclimit' );
246 $togs = $wgLang->getUserToggles();
247 foreach ( $togs as $tname ) {
248 $ttext = wfMsg('tog-'.$tname);
249 $this->mToggles
[$tname] = $wgUser->getOption( $tname );
252 $namespaces = $wgLang->getNamespaces();
253 foreach ( $namespaces as $i => $namespace ) {
255 $this->mSearchNs
[$i] = $wgUser->getOption( 'searchNs'.$i );
263 function namespacesCheckboxes() {
264 global $wgLang, $wgUser;
266 # Determine namespace checkboxes
267 $namespaces = $wgLang->getNamespaces();
270 foreach ( $namespaces as $i => $name ) {
271 # Skip special or anything similar
274 if ( $this->mSearchNs
[$i] ) {
275 $checked = ' checked="checked"';
277 $name = str_replace( '_', ' ', $namespaces[$i] );
279 $name = wfMsg( 'blanknamespace' );
285 $r1 .= "<label><input type='checkbox' value=\"1\" name=\"" .
286 "wpNs$i\"{$checked} />{$name}</label>\n";
294 function getToggle( $tname ) {
295 global $wgUser, $wgLang;
297 $this->mUsedToggles
[$tname] = true;
298 $ttext = $wgLang->getUserToggle( $tname );
300 if ( 1 == $wgUser->getOption( $tname ) ) {
301 $checked = ' checked="checked"';
305 return "<div><input type='checkbox' value=\"1\" "
306 . "id=\"$tname\" name=\"wpOp$tname\"$checked /><label for=\"$tname\">$ttext</label></div>\n";
312 function mainPrefsForm( $err ) {
313 global $wgUser, $wgOut, $wgLang, $wgContLang, $wgUseDynamicDates, $wgValidSkinNames;
314 global $wgAllowRealName, $wgImageLimits;
316 global $wgLanguageNames;
318 $wgOut->setPageTitle( wfMsg( 'preferences' ) );
319 $wgOut->setArticleRelated( false );
320 $wgOut->setRobotpolicy( 'noindex,nofollow' );
323 $wgOut->addHTML( "<p class='error'>" . htmlspecialchars( $err ) . "</p>\n" );
325 $uname = $wgUser->getName();
326 $uid = $wgUser->getID();
328 $wgOut->addWikiText( wfMsg( 'prefslogintext', $uname, $uid ) );
329 $wgOut->addWikiText( wfMsg('clearyourcache'));
331 $qbs = $wgLang->getQuickbarSettings();
332 $skinNames = $wgLang->getSkinNames();
333 $mathopts = $wgLang->getMathNames();
334 $dateopts = $wgLang->getDateFormats();
335 $togs = $wgLang->getUserToggles();
337 $titleObj = Title
::makeTitle( NS_SPECIAL
, 'Preferences' );
338 $action = $titleObj->escapeLocalURL();
340 $qb = wfMsg( 'qbsettings' );
341 $cp = wfMsg( 'changepassword' );
342 $sk = wfMsg( 'skin' );
343 $math = wfMsg( 'math' );
344 $dateFormat = wfMsg('dateformat');
345 $opw = wfMsg( 'oldpassword' );
346 $npw = wfMsg( 'newpassword' );
347 $rpw = wfMsg( 'retypenew' );
348 $svp = wfMsg( 'saveprefs' );
349 $rsp = wfMsg( 'resetprefs' );
350 $tbs = wfMsg( 'textboxsize' );
351 $tbr = wfMsg( 'rows' );
352 $tbc = wfMsg( 'columns' );
353 $ltz = wfMsg( 'localtime' );
354 $timezone = wfMsg( 'timezonelegend' );
355 $tzt = wfMsg( 'timezonetext' );
356 $tzo = wfMsg( 'timezoneoffset' );
357 $tzGuess = wfMsg( 'guesstimezone' );
358 $tzServerTime = wfMsg( 'servertime' );
359 $yem = wfMsg( 'youremail' );
360 $yrn = ($wgAllowRealName) ?
wfMsg( 'yourrealname' ) : '';
361 $yl = wfMsg( 'yourlanguage' );
362 $yv = wfMsg( 'yourvariant' );
363 $emf = wfMsg( 'emailflag' );
364 $ynn = wfMsg( 'yournick' );
365 $stt = wfMsg ( 'stubthreshold' ) ;
366 $srh = wfMsg( 'searchresultshead' );
367 $rpp = wfMsg( 'resultsperpage' );
368 $scl = wfMsg( 'contextlines' );
369 $scc = wfMsg( 'contextchars' );
370 $rcc = wfMsg( 'recentchangescount' );
371 $dsn = wfMsg( 'defaultns' );
373 $wgOut->addHTML( "<form id=\"preferences\" name=\"preferences\" action=\"$action\"
376 # First section: identity
379 $this->mUserEmail
= htmlspecialchars( $this->mUserEmail
);
380 $this->mRealName
= htmlspecialchars( $this->mRealName
);
381 $this->mNick
= htmlspecialchars( $this->mNick
);
382 if ( $this->mEmailFlag
) { $emfc = 'checked="checked"'; }
385 $ps = $this->namespacesCheckboxes();
387 $wgOut->addHTML( "<fieldset>
388 <legend>".wfMsg('prefs-personal')."</legend>");
389 if ($wgAllowRealName) {
390 $wgOut->addHTML("<div><label>$yrn: <input type='text' name=\"wpRealName\" value=\"{$this->mRealName}\" size='20' /></label></div>");
393 <div><label>$yem: <input type='text' name=\"wpUserEmail\" value=\"{$this->mUserEmail}\" size='20' /></label></div>
394 <div><label><input type='checkbox' $emfc value=\"1\" name=\"wpEmailFlag\" /> $emf</label></div>
395 <div><label>$ynn: <input type='text' name=\"wpNick\" value=\"{$this->mNick}\" size='12' /></label></div>
396 <div><label>$yl: <select name=\"wpUserLanguage\" />\n");
398 foreach($wgLanguageNames as $code => $name) {
400 /* only add languages that have a file */
401 $langfile="$IP/languages/Language".str_replace('-', '_', ucfirst($code)).".php";
402 if(file_exists($langfile)) {
403 $sel = ($code == $this->mUserLanguage
)?
"selected" : "";
404 $wgOut->addHtml("\t<option value=\"$code\" $sel>$code - $name</option>\n");
407 $wgOut->addHtml("</select></label></div>\n" );
409 /* see if there are multiple language variants to choose from*/
410 $variants = $wgContLang->getVariants();
411 $size=sizeof($variants);
413 $variantArray=array();
414 foreach($variants as $v) {
415 $v = str_replace( '_', '-', strtolower($v));
416 if($name=$wgLanguageNames[$v]) {
417 $variantArray[$v] = $name;
420 $size=sizeof($variantArray);
422 if(sizeof($variantArray) > 1) {
424 <div><label>$yv: <select name=\"wpUserVariant\" />\n");
425 foreach($variantArray as $code => $name) {
426 $sel = ($code==$this->mUserVariant
)?
"selected" : "";
427 $wgOut->addHtml("\t<option value=\"$code\" $sel>$code - $name</option>\n");
429 $wgOut->addHtml("</select></label></div>\n");
432 # Fields for changing password
434 $this->mOldpass
= htmlspecialchars( $this->mOldpass
);
435 $this->mNewpass
= htmlspecialchars( $this->mNewpass
);
436 $this->mRetypePass
= htmlspecialchars( $this->mRetypePass
);
438 $wgOut->addHTML( "<fieldset>
440 <div><label>$opw: <input type='password' name=\"wpOldpass\" value=\"{$this->mOldpass}\" size='20' /></label></div>
441 <div><label>$npw: <input type='password' name=\"wpNewpass\" value=\"{$this->mNewpass}\" size='20' /></label></div>
442 <div><label>$rpw: <input type='password' name=\"wpRetypePass\" value=\"{$this->mRetypePass}\" size='20' /></label></div>
443 " . $this->getToggle( "rememberpassword" ) . "
445 <div class='prefsectiontip'>".wfMsg('prefs-help-userdata')."</div>\n</fieldset>\n" );
450 $wgOut->addHtml( "<fieldset>\n<legend>$qb</legend>\n" );
451 for ( $i = 0; $i < count( $qbs ); ++
$i ) {
452 if ( $i == $this->mQuickbar
) { $checked = ' checked="checked"'; }
453 else { $checked = ""; }
454 $wgOut->addHTML( "<div><label><input type='radio' name=\"wpQuickbar\"
455 value=\"$i\"$checked /> {$qbs[$i]}</label></div>\n" );
457 $wgOut->addHtml('<div class="prefsectiontip">'.wfMsg('qbsettingsnote').'</div>');
458 $wgOut->addHtml( "</fieldset>\n\n" );
462 $wgOut->addHTML( "<fieldset>\n<legend>$sk</legend>\n" );
463 # Only show members of $wgValidSkinNames rather than
464 # $skinNames (skins is all skin names from Language.php)
465 foreach ($wgValidSkinNames as $skinkey => $skinname ) {
466 if ( $skinkey == $this->mSkin
) {
467 $checked = ' checked="checked"';
471 if ( isset( $skinNames[$skinkey] ) ) {
472 $sn = $skinNames[$skinkey];
476 $wgOut->addHTML( "<div><label><input type='radio' name=\"wpSkin\"
477 value=\"$skinkey\"$checked /> {$sn}</label></div>\n" );
479 $wgOut->addHTML( "</fieldset>\n\n" );
483 $wgOut->addHTML( "<fieldset>\n<legend>$math</legend>\n" );
484 for ( $i = 0; $i < count( $mathopts ); ++
$i ) {
485 if ( $i == $this->mMath
) { $checked = ' checked="checked"'; }
486 else { $checked = ""; }
487 $wgOut->addHTML( "<div><label><input type='radio' name=\"wpMath\"
488 value=\"$i\"$checked /> ".wfMsg($mathopts[$i])."</label></div>\n" );
490 $wgOut->addHTML( "</fieldset>\n\n" );
494 if ( $wgUseDynamicDates ) {
495 $wgOut->addHTML( "<fieldset>\n<legend>$dateFormat</legend>\n" );
496 for ( $i = 0; $i < count( $dateopts ); ++
$i) {
497 if ( $i == $this->mDate
) {
498 $checked = ' checked="checked"';
502 $wgOut->addHTML( "<div><label><input type='radio' name=\"wpDate\" ".
503 "value=\"$i\"$checked /> {$dateopts[$i]}</label></div>\n" );
505 $wgOut->addHTML( "</fieldset>\n\n");
510 $nowlocal = $wgLang->time( $now = wfTimestampNow(), true );
511 $nowserver = $wgLang->time( $now, false );
512 $wgOut->addHTML( "<fieldset>
513 <legend>$tbs</legend>\n
515 <label>$tbr: <input type='text' name=\"wpRows\" value=\"{$this->mRows}\" size='6' /></label>
516 <label>$tbc: <input type='text' name=\"wpCols\" value=\"{$this->mCols}\" size='6' /></label>
518 $this->getToggle( "editwidth" ) .
519 $this->getToggle( "showtoolbar" ) .
520 $this->getToggle( "previewonfirst" ) .
521 $this->getToggle( "previewontop" ) .
522 $this->getToggle( "watchdefault" ) .
523 $this->getToggle( "minordefault" ) . "
527 <legend>$timezone</legend>
528 <div><b>$tzServerTime:</b> $nowserver</div>
529 <div><b>$ltz:</b> $nowlocal</div>
530 <div><label>$tzo*: <input type='text' name=\"wpHourDiff\" value=\"{$this->mHourDiff}\" size='6' /></label></div>
531 <div><input type=\"button\" value=\"$tzGuess\" onClick=\"javascript:guessTimezone()\" id=\"guesstimezonebutton\" style=\"display:none\" /></div>
532 <div class='prefsectiontip'>* {$tzt}</div>
536 <fieldset><legend>".wfMsg('prefs-rc')."</legend>
537 <div><label>$rcc: <input type='text' name=\"wpRecent\" value=\"$this->mRecent\" size='6' /></label></div>
538 " . $this->getToggle( "hideminor" ) .
539 $this->getToggle( "usenewrc" ) . "
540 <div><label>$stt: <input type='text' name=\"wpStubs\" value=\"$this->mStubs\" size='6' /></label></div>
541 <div><label>".wfMsg('imagemaxsize')."<select name=\"wpImageSize\">");
543 $imageLimitOptions='';
544 foreach ( $wgImageLimits as $index => $limits ) {
545 $selected = ($index == $this->mImageSize
) ?
' selected ': '';
546 $imageLimitOptions .= "<option value=\"{$index}\" {$selected}>{$limits[0]}x{$limits[1]}</option>\n";
548 $wgOut->addHTML( "{$imageLimitOptions}</select></label></div>
553 <legend>$srh</legend>
554 <div><label>$rpp: <input type='text' name=\"wpSearch\" value=\"$this->mSearch\" size='6' /></label></div>
555 <div><label>$scl: <input type='text' name=\"wpSearchLines\" value=\"$this->mSearchLines\" size='6' /></label></div>
556 <div><label>$scc: <input type='text' name=\"wpSearchChars\" value=\"$this->mSearchChars\" size='6' /></label></div>
559 <legend>$dsn</legend>
565 # Various checkbox options
567 $wgOut->addHTML("<fieldset><legend>".wfMsg('prefs-misc')."</legend>");
568 foreach ( $togs as $tname ) {
569 if( !array_key_exists( $tname, $this->mUsedToggles
) ) {
570 $wgOut->addHTML( $this->getToggle( $tname ) );
573 $wgOut->addHTML( "</fieldset>\n\n" );
576 <div id='prefsubmit'>
578 <input type='submit' name=\"wpSaveprefs\" value=\"$svp\" accesskey=\"".
579 wfMsg('accesskey-save')."\" title=\"[alt-".wfMsg('accesskey-save')."]\" />
580 <input type='submit' name=\"wpReset\" value=\"$rsp\" />