renamed variables for better readability
[mediawiki.git] / includes / SpecialPreferences.php
blobac9bd19e181e49e8fd249ebf5567a9542443488a
1 <?php
3 function wfSpecialPreferences()
5 global $wgUser, $wgOut, $wgUseDynamicDates, $action;
6 global $wpSaveprefs, $wpReset;
8 $fields = array( "wpOldpass", "wpNewpass", "wpRetypePass",
9 "wpUserEmail", "wpNick" );
10 wfCleanFormFields( $fields );
12 if ( 0 == $wgUser->getID() ) {
13 $wgOut->errorpage( "prefsnologin", "prefsnologintext" );
14 return;
16 if ( wfReadOnly() ) {
17 $wgOut->readOnlyPage();
18 return;
20 if ( isset( $wpReset ) ) {
21 resetPrefs();
22 mainPrefsForm( WfMsg( "prefsreset" ) );
23 } else if ( isset( $_POST['wpSaveprefs'] ) ) {
24 savePreferences();
25 } else {
26 resetPrefs();
27 mainPrefsForm( "" );
31 /* private */ function validateInt( &$val, $min=0, $max=0x7fffffff ) {
32 $val = intval($val);
33 $val = min($val, $max);
34 $val = max($val, $min);
35 return $val;
38 /* private */ function validateIntOrNull( &$val, $min=0, $max=0x7fffffff ) {
39 $val = trim($val);
40 if($val === "") {
41 return $val;
42 } else {
43 return validateInt( $val, $min, $max );
48 /* private */ function validateCheckbox( $cb )
50 if ( $cb )
52 return 1;
54 else
56 return 0;
60 /* private */ function validateTimeZone( $s )
63 if ( $s !== "" ) {
64 if ( strpos( $s, ":" ) ) {
65 # HH:MM
66 $array = explode( ":" , $s );
67 $hour = intval( $array[0] );
68 $minute = intval( $array[1] );
69 } else {
70 $minute = intval( $s * 60 );
71 $hour = intval( $minute / 60 );
72 $minute = abs( $minute ) % 60;
74 $hour = min( $hour, 15 );
75 $hour = max( $hour, -15 );
76 $minute = min( $minute, 59 );
77 $minute = max( $minute, 0 );
78 $s = sprintf( "%02d:%02d", $hour, $minute );
80 return $s;
83 /* private */ function savePreferences()
85 global $wgUser, $wgLang, $wgDeferredUpdateList;
86 global $wpQuickbar, $wpOldpass, $wpNewpass, $wpRetypePass;
87 global $wpSkin, $wpMath, $wpDate, $wpUserEmail, $wpEmailFlag, $wpNick, $wpSearch, $wpRecent;
88 global $wpSearchLines, $wpSearchChars, $wpStubs;
89 global $wpRows, $wpCols, $wpHourDiff, $HTTP_POST_VARS;
91 if ( "" != $wpNewpass ) {
92 if ( $wpNewpass != $wpRetypePass ) {
93 mainPrefsForm( wfMsg( "badretype" ) );
94 return;
96 $ep = $wgUser->encryptPassword( $wpOldpass );
97 if ( $ep != $wgUser->getPassword() ) {
98 if ( $ep != $wgUser->getNewpassword() ) {
99 mainPrefsForm( wfMsg( "wrongpassword" ) );
100 return;
103 $wgUser->setPassword( $wpNewpass );
105 $wgUser->setEmail( $wpUserEmail );
106 $wgUser->setOption( "nickname", $wpNick );
107 $wgUser->setOption( "quickbar", $wpQuickbar );
108 $wgUser->setOption( "skin", $wpSkin );
109 $wgUser->setOption( "math", $wpMath );
110 $wgUser->setOption( "date", $wpDate );
111 $wgUser->setOption( "searchlimit", validateIntOrNull( $wpSearch ) );
112 $wgUser->setOption( "contextlines", validateIntOrNull( $wpSearchLines ) );
113 $wgUser->setOption( "contextchars", validateIntOrNull( $wpSearchChars ) );
114 $wgUser->setOption( "rclimit", validateIntOrNull( $wpRecent ) );
115 $wgUser->setOption( "rows", validateInt( $wpRows, 4, 1000 ) );
116 $wgUser->setOption( "cols", validateInt( $wpCols, 4, 1000 ) );
117 $wgUser->setOption( "stubthreshold", validateIntOrNull( $wpStubs ) );
118 $wgUser->setOption( "timecorrection", validateTimeZone( $wpHourDiff, -12, 14 ) );
120 $namespaces = $wgLang->getNamespaces();
121 # Set search namespace options
122 # Note: namespaces don't necessarily have consecutive keys
123 foreach ( $namespaces as $i => $namespaces ) {
124 if ( $i >= 0 ) {
125 $nsvar = "wpNs$i";
126 global $$nsvar;
127 $wgUser->setOption( "searchNs{$i}", validateCheckbox( $$nsvar ) );
131 $wgUser->setOption( "disablemail", validateCheckbox( $wpEmailFlag ) );
133 $togs = $wgLang->getUserToggles();
134 foreach ( $togs as $tname => $ttext ) {
135 if ( array_key_exists( "wpOp$tname", $HTTP_POST_VARS ) ) {
136 $wgUser->setOption( $tname, 1 );
137 } else {
138 $wgUser->setOption( $tname, 0 );
141 $wgUser->setCookies();
142 $up = new UserUpdate();
143 array_push( $wgDeferredUpdateList, $up );
144 mainPrefsForm( wfMsg( "savedprefs" ) );
147 /* private */ function resetPrefs()
149 global $wgUser, $wgLang;
150 global $wpQuickbar, $wpOldpass, $wpNewpass, $wpRetypePass, $wpStubs;
151 global $wpRows, $wpCols, $wpSkin, $wpMath, $wpDate, $wpUserEmail, $wpEmailFlag, $wpNick;
152 global $wpSearch, $wpRecent, $HTTP_POST_VARS;
153 global $wpHourDiff, $wpSearchLines, $wpSearchChars;
155 $wpOldpass = $wpNewpass = $wpRetypePass = "";
156 $wpUserEmail = $wgUser->getEmail();
157 if ( 1 == $wgUser->getOption( "disablemail" ) ) { $wpEmailFlag = 1; }
158 else { $wpEmailFlag = 0; }
159 $wpNick = $wgUser->getOption( "nickname" );
161 $wpQuickbar = $wgUser->getOption( "quickbar" );
162 $wpSkin = $wgUser->getOption( "skin" );
163 $wpMath = $wgUser->getOption( "math" );
164 $wpDate = $wgUser->getOption( "date" );
165 $wpRows = $wgUser->getOption( "rows" );
166 $wpCols = $wgUser->getOption( "cols" );
167 $wpStubs = $wgUser->getOption( "stubthreshold" );
168 $wpHourDiff = $wgUser->getOption( "timecorrection" );
169 $wpSearch = $wgUser->getOption( "searchlimit" );
170 $wpSearchLines = $wgUser->getOption( "contextlines" );
171 $wpSearchChars = $wgUser->getOption( "contextchars" );
172 $wpRecent = $wgUser->getOption( "rclimit" );
174 $togs = $wgLang->getUserToggles();
175 foreach ( $togs as $tname => $ttext ) {
176 $HTTP_POST_VARS["wpOp$tname"] = $wgUser->getOption( $tname );
180 /* private */ function namespacesCheckboxes()
182 global $wgLang, $wgUser;
184 # Determine namespace checkboxes
185 $namespaces = $wgLang->getNamespaces();
186 $r1 = "";
188 foreach ( $namespaces as $i => $name ) {
189 # Skip special or anything similar
190 if ( $i >= 0 ) {
191 $checked = "";
192 if ( $wgUser->getOption( "searchNs$i" ) ) {
193 $checked = " checked";
195 $name = str_replace( "_", " ", $namespaces[$i] );
196 if ( "" == $name ) {
197 $name = wfMsg( "blanknamespace" );
200 if ( 0 != $i ) {
201 $r1 .= " ";
203 $r1 .= "<label><input type=checkbox value=\"1\" name=\"" .
204 "wpNs$i\"{$checked}>{$name}</label>\n";
208 return $r1;
214 /* private */ function mainPrefsForm( $err )
216 global $wgUser, $wgOut, $wgLang, $wgUseDynamicDates;
217 global $wpQuickbar, $wpOldpass, $wpNewpass, $wpRetypePass;
218 global $wpSkin, $wpMath, $wpDate, $wpUserEmail, $wpEmailFlag, $wpNick, $wpSearch, $wpRecent;
219 global $wpRows, $wpCols, $wpSaveprefs, $wpReset, $wpHourDiff;
220 global $wpSearchLines, $wpSearchChars, $wpStubs, $wgValidSkinNames;
222 $wgOut->setPageTitle( wfMsg( "preferences" ) );
223 $wgOut->setArticleRelated( false );
224 $wgOut->setRobotpolicy( "noindex,nofollow" );
226 if ( "" != $err ) {
227 $wgOut->addHTML( "<font size='+1' color='red'>$err</font>\n<p>" );
229 $uname = $wgUser->getName();
230 $uid = $wgUser->getID();
232 $wgOut->addWikiText( wfMsg( "prefslogintext", $uname, $uid ) );
234 $qbs = $wgLang->getQuickbarSettings();
235 $skins = $wgLang->getSkinNames();
236 $mathopts = $wgLang->getMathNames();
237 $dateopts = $wgLang->getDateFormats();
238 $togs = $wgLang->getUserToggles();
240 $action = wfLocalUrlE( $wgLang->specialPage( "Preferences" ));
242 $qb = wfMsg( "qbsettings" );
243 $cp = wfMsg( "changepassword" );
244 $sk = wfMsg( "skin" );
245 $math = wfMsg( "math" );
246 $dateFormat = wfMsg("dateformat");
247 $opw = wfMsg( "oldpassword" );
248 $npw = wfMsg( "newpassword" );
249 $rpw = wfMsg( "retypenew" );
250 $svp = wfMsg( "saveprefs" );
251 $rsp = wfMsg( "resetprefs" );
252 $tbs = wfMsg( "textboxsize" );
253 $tbr = wfMsg( "rows" );
254 $tbc = wfMsg( "columns" );
255 $ltz = wfMsg( "localtime" );
256 $tzt = wfMsg( "timezonetext" );
257 $tzo = wfMsg( "timezoneoffset" );
258 $tzGuess = wfMsg( "guesstimezone" );
259 $tzServerTime = wfMsg( "servertime" );
260 $yem = wfMsg( "youremail" );
261 $emf = wfMsg( "emailflag" );
262 $ynn = wfMsg( "yournick" );
263 $stt = wfMsg ( "stubthreshold" ) ;
264 $srh = wfMsg( "searchresultshead" );
265 $rpp = wfMsg( "resultsperpage" );
266 $scl = wfMsg( "contextlines" );
267 $scc = wfMsg( "contextchars" );
268 $rcc = wfMsg( "recentchangescount" );
269 $dsn = wfMsg( "defaultns" );
271 $wgOut->addHTML( "<form id=\"preferences\" name=\"preferences\" action=\"$action\"
272 method=\"post\"><table border=\"1\"><tr><td valign=top nowrap><b>$qb:</b><br>\n" );
274 # Quickbar setting
276 for ( $i = 0; $i < count( $qbs ); ++$i ) {
277 if ( $i == $wpQuickbar ) { $checked = " checked"; }
278 else { $checked = ""; }
279 $wgOut->addHTML( "<label><input type=radio name=\"wpQuickbar\"
280 value=\"$i\"$checked> {$qbs[$i]}</label><br>\n" );
283 # Fields for changing password
285 $wpOldpass = wfEscapeHTML( $wpOldpass );
286 $wpNewpass = wfEscapeHTML( $wpNewpass );
287 $wpRetypePass = wfEscapeHTML( $wpRetypePass );
289 $wgOut->addHTML( "</td><td vaign=top nowrap><b>$cp:</b><br>
290 <label>$opw: <input type=password name=\"wpOldpass\" value=\"$wpOldpass\" size=20></label><br>
291 <label>$npw: <input type=password name=\"wpNewpass\" value=\"$wpNewpass\" size=20></label><br>
292 <label>$rpw: <input type=password name=\"wpRetypePass\" value=\"$wpRetypePass\" size=20></label><br>
293 </td></tr>\n" );
295 # Skin setting
297 $wgOut->addHTML( "<tr><td valign=top nowrap><b>$sk:</b><br>\n" );
298 # Only count up to count($wgValidSkinNames) rather than
299 # count($skins), to allow global disabling of experimental
300 # skins.
301 for ( $i = 0; $i < count( $wgValidSkinNames ); ++$i ) {
302 if ( $i == $wpSkin ) {
303 $checked = " checked";
304 } else {
305 $checked = "";
307 $wgOut->addHTML( "<label><input type=radio name=\"wpSkin\"
308 value=\"$i\"$checked> {$skins[$i]}</label><br>\n" );
311 # Various checkbox options
313 if ( $wgUseDynamicDates ) {
314 $wgOut->addHTML( "</td><td rowspan=3 valign=top nowrap>\n" );
315 } else {
316 $wgOut->addHTML( "</td><td rowspan=2 valign=top nowrap>\n" );
318 $wgOut->addHTML("<table border=0>");
319 foreach ( $togs as $tname => $ttext ) {
320 if ( 1 == $wgUser->getOption( $tname ) ) {
321 $checked = " checked";
322 } else {
323 $checked = "";
325 $wgOut->addHTML( "<tr valign=\"top\"><td><input type=checkbox value=\"1\" "
326 . "id=\"$tname\" name=\"wpOp$tname\"$checked></td><td><label for=\"$tname\">$ttext</label></td></tr>\n" );
328 $wgOut->addHTML( "</table></td>" );
330 # Math setting
332 $wgOut->addHTML( "<tr><td valign=top nowrap><b>$math:</b><br>\n" );
333 for ( $i = 0; $i < count( $mathopts ); ++$i ) {
334 if ( $i == $wpMath ) { $checked = " checked"; }
335 else { $checked = ""; }
336 $wgOut->addHTML( "<label><input type=radio name=\"wpMath\"
337 value=\"$i\"$checked> {$mathopts[$i]}</label><br>\n" );
339 $wgOut->addHTML( "</td></tr>" );
341 # Date format
343 if ( $wgUseDynamicDates ) {
344 $wgOut->addHTML( "<tr><td valign=top nowrap><b>$dateFormat:</b><br>" );
345 for ( $i = 0; $i < count( $dateopts ); ++$i) {
346 if ( $i == $wpDate ) {
347 $checked = " checked";
348 } else {
349 $checked = "";
351 $wgOut->addHTML( "<label><input type=radio name=\"wpDate\" ".
352 "value=\"$i\"$checked> {$dateopts[$i]}</label><br>\n" );
354 $wgOut->addHTML( "</td></tr>");
356 # Textbox rows, cols
358 $nowlocal = $wgLang->time( $now = wfTimestampNow(), true );
359 $nowserver = $wgLang->time( $now, false );
360 $wgOut->addHTML( "<td valign=top nowrap><b>$tbs:</b><br>
361 <label>$tbr: <input type=text name=\"wpRows\" value=\"{$wpRows}\" size=6></label><br>
362 <label>$tbc: <input type=text name=\"wpCols\" value=\"{$wpCols}\" size=6></label><br><br>
363 <b>$tzServerTime:</b> $nowserver<br />
364 <b>$ltz:</b> $nowlocal<br />
365 <label>$tzo*: <input type=text name=\"wpHourDiff\" value=\"{$wpHourDiff}\" size=6></label><br />
366 <input type=\"button\" value=\"$tzGuess\" onClick=\"javascript:guessTimezone()\" />
367 </td>" );
369 # Email, etc.
371 $wpUserEmail = wfEscapeHTML( $wpUserEmail );
372 $wpNick = wfEscapeHTML( $wpNick );
373 if ( $wpEmailFlag ) { $emfc = "checked"; }
374 else { $emfc = ""; }
376 $ps = namespacesCheckboxes();
378 $wgOut->addHTML( "<td valign=top nowrap>
379 <label>$yem: <input type=text name=\"wpUserEmail\" value=\"{$wpUserEmail}\" size=20></label><br>
380 <label><input type=checkbox $emfc value=\"1\" name=\"wpEmailFlag\"> $emf</label><br>
381 <label>$ynn: <input type=text name=\"wpNick\" value=\"{$wpNick}\" size=12></label><br>
382 <label>$rcc: <input type=text name=\"wpRecent\" value=\"$wpRecent\" size=6></label><br>
383 <label>$stt: <input type=text name=\"wpStubs\" value=\"$wpStubs\" size=6></label><br>
384 <strong>{$srh}:</strong><br>
385 <label>$rpp: <input type=text name=\"wpSearch\" value=\"$wpSearch\" size=6></label><br>
386 <label>$scl: <input type=text name=\"wpSearchLines\" value=\"$wpSearchLines\" size=6></label><br>
387 <label>$scc: <input type=text name=\"wpSearchChars\" value=\"$wpSearchChars\" size=6></label></td>
388 </tr><tr>
389 <td colspan=2>
390 <b>$dsn</b><br>
392 </td>
393 </tr><tr>
394 <td align=center><input type=submit name=\"wpSaveprefs\" value=\"$svp\"></td>
395 <td align=center><input type=submit name=\"wpReset\" value=\"$rsp\"></td>
396 </tr></table>* {$tzt} </form>\n" );