3 * Copyright (C) 2005 Brion Vibber <brion@pobox.com>
4 * http://www.mediawiki.org/
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 * http://www.gnu.org/copyleft/gpl.html
23 * Handles the page protection UI and backend
25 class ProtectionForm
{
26 /** A map of action to restriction level, from request or default */
27 var $mRestrictions = array();
29 /** The custom/additional protection reason */
32 /** The reason selected from the list, blank for other/additional */
33 var $mReasonSelection = '';
35 /** True if the restrictions are cascading, from request or existing protection */
36 var $mCascade = false;
38 /** Map of action to "other" expiry time. Used in preference to mExpirySelection. */
39 var $mExpiry = array();
42 * Map of action to value selected in expiry drop-down list.
43 * Will be set to 'othertime' whenever mExpiry is set.
45 var $mExpirySelection = array();
47 /** Permissions errors for the protect action */
48 var $mPermErrors = array();
50 /** Types (i.e. actions) for which levels can be selected */
51 var $mApplicableTypes = array();
53 /** Map of action to the expiry time of the existing protection */
54 var $mExistingExpiry = array();
56 function __construct( Article
$article ) {
57 global $wgRequest, $wgUser;
58 global $wgRestrictionTypes, $wgRestrictionLevels;
59 $this->mArticle
= $article;
60 $this->mTitle
= $article->mTitle
;
61 $this->mApplicableTypes
= $this->mTitle
->exists() ?
$wgRestrictionTypes : array('create');
63 $this->mCascade
= $this->mTitle
->areRestrictionsCascading();
65 // The form will be available in read-only to show levels.
66 $this->mPermErrors
= $this->mTitle
->getUserPermissionsErrors('protect',$wgUser);
67 $this->disabled
= wfReadOnly() ||
$this->mPermErrors
!= array();
68 $this->disabledAttrib
= $this->disabled
69 ?
array( 'disabled' => 'disabled' )
72 $this->mReason
= $wgRequest->getText( 'mwProtect-reason' );
73 $this->mReasonSelection
= $wgRequest->getText( 'wpProtectReasonSelection' );
74 $this->mCascade
= $wgRequest->getBool( 'mwProtect-cascade', $this->mCascade
);
76 foreach( $this->mApplicableTypes
as $action ) {
77 // Fixme: this form currently requires individual selections,
78 // but the db allows multiples separated by commas.
79 $this->mRestrictions
[$action] = implode( '', $this->mTitle
->getRestrictions( $action ) );
81 if ( !$this->mRestrictions
[$action] ) {
85 $existingExpiry = $this->mTitle
->getRestrictionExpiry( $action );
87 $this->mExistingExpiry
[$action] = $existingExpiry;
89 $requestExpiry = $wgRequest->getText( "mwProtect-expiry-$action" );
90 $requestExpirySelection = $wgRequest->getVal( "wpProtectExpirySelection-$action" );
92 if ( $requestExpiry ) {
93 // Custom expiry takes precedence
94 $this->mExpiry
[$action] = $requestExpiry;
95 $this->mExpirySelection
[$action] = 'othertime';
96 } elseif ( $requestExpirySelection ) {
97 // Expiry selected from list
98 $this->mExpiry
[$action] = '';
99 $this->mExpirySelection
[$action] = $requestExpirySelection;
100 } elseif ( $existingExpiry == 'infinity' ) {
101 // Existing expiry is infinite, use "infinite" in drop-down
102 $this->mExpiry
[$action] = '';
103 $this->mExpirySelection
[$action] = 'infinite';
104 } elseif ( $existingExpiry ) {
105 // Use existing expiry in its own list item
106 $this->mExpiry
[$action] = '';
107 $this->mExpirySelection
[$action] = $existingExpiry;
109 // Final default: infinite
110 $this->mExpiry
[$action] = '';
111 $this->mExpirySelection
[$action] = 'infinite';
114 $val = $wgRequest->getVal( "mwProtect-level-$action" );
115 if( isset( $val ) && in_array( $val, $wgRestrictionLevels ) ) {
116 // Prevent users from setting levels that they cannot later unset
117 if( $val == 'sysop' ) {
118 // Special case, rewrite sysop to either protect and editprotected
119 if( !$wgUser->isAllowed('protect') && !$wgUser->isAllowed('editprotected') )
122 if( !$wgUser->isAllowed($val) )
125 $this->mRestrictions
[$action] = $val;
131 * Get the expiry time for a given action, by combining the relevant inputs.
132 * Returns a 14-char timestamp or "infinity", or false if the input was invalid
134 function getExpiry( $action ) {
135 if ( $this->mExpirySelection
[$action] == 'existing' ) {
136 return $this->mExistingExpiry
[$action];
137 } elseif ( $this->mExpirySelection
[$action] == 'othertime' ) {
138 $value = $this->mExpiry
[$action];
140 $value = $this->mExpirySelection
[$action];
142 if ( $value == 'infinite' ||
$value == 'indefinite' ||
$value == 'infinity' ) {
143 $time = Block
::infinity();
145 $unix = strtotime( $value );
147 if ( !$unix ||
$unix === -1 ) {
151 // Fixme: non-qualified absolute times are not in users specified timezone
152 // and there isn't notice about it in the ui
153 $time = wfTimestamp( TS_MW
, $unix );
159 global $wgRequest, $wgOut;
160 if( $wgRequest->wasPosted() ) {
161 if( $this->save() ) {
162 $q = $this->mArticle
->isRedirect() ?
'redirect=no' : '';
163 $wgOut->redirect( $this->mTitle
->getFullUrl( $q ) );
170 function show( $err = null ) {
171 global $wgOut, $wgUser;
173 $wgOut->setRobotPolicy( 'noindex,nofollow' );
175 if( is_null( $this->mTitle
) ||
176 $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
177 $wgOut->showFatalError( wfMsg( 'badarticleerror' ) );
181 list( $cascadeSources, /* $restrictions */ ) = $this->mTitle
->getCascadeProtectionSources();
184 $wgOut->setSubtitle( wfMsgHtml( 'formerror' ) );
185 $wgOut->addHTML( "<p class='error'>{$err}</p>\n" );
188 if ( $cascadeSources && count($cascadeSources) > 0 ) {
191 foreach ( $cascadeSources as $title ) {
192 $titles .= '* [[:' . $title->getPrefixedText() . "]]\n";
195 $wgOut->wrapWikiMsg( "$1\n$titles", array( 'protect-cascadeon', count($cascadeSources) ) );
198 $sk = $wgUser->getSkin();
199 $titleLink = $sk->makeLinkObj( $this->mTitle
);
200 $wgOut->setPageTitle( wfMsg( 'protect-title', $this->mTitle
->getPrefixedText() ) );
201 $wgOut->setSubtitle( wfMsg( 'protect-backlink', $titleLink ) );
203 # Show an appropriate message if the user isn't allowed or able to change
204 # the protection settings at this time
205 if( $this->disabled
) {
207 $wgOut->readOnlyPage();
208 } elseif( $this->mPermErrors
) {
209 $wgOut->addWikiText( $wgOut->formatPermissionsErrorMessage( $this->mPermErrors
) );
212 $wgOut->addWikiMsg( 'protect-text', $this->mTitle
->getPrefixedText() );
215 $wgOut->addHTML( $this->buildForm() );
217 $this->showLogExtract( $wgOut );
221 global $wgRequest, $wgUser, $wgOut;
223 if ( $this->disabled
) {
228 $token = $wgRequest->getVal( 'wpEditToken' );
229 if ( !$wgUser->matchEditToken( $token ) ) {
230 $this->show( wfMsg( 'sessionfailure' ) );
234 # Create reason string. Use list and/or custom string.
235 $reasonstr = $this->mReasonSelection
;
236 if ( $reasonstr != 'other' && $this->mReason
!= '' ) {
237 // Entry from drop down menu + additional comment
238 $reasonstr .= ': ' . $this->mReason
;
239 } elseif ( $reasonstr == 'other' ) {
240 $reasonstr = $this->mReason
;
243 foreach( $this->mApplicableTypes
as $action ) {
244 $expiry[$action] = $this->getExpiry( $action );
245 if ( !$expiry[$action] ) {
246 $this->show( wfMsg( 'protect_expiry_invalid' ) );
249 if ( $expiry[$action] < wfTimestampNow() ) {
250 $this->show( wfMsg( 'protect_expiry_old' ) );
255 # They shouldn't be able to do this anyway, but just to make sure, ensure that cascading restrictions aren't being applied
256 # to a semi-protected page.
257 global $wgGroupPermissions;
259 $edit_restriction = $this->mRestrictions
['edit'];
260 $this->mCascade
= $wgRequest->getBool( 'mwProtect-cascade' );
261 if ($this->mCascade
&& ($edit_restriction != 'protect') &&
262 !(isset($wgGroupPermissions[$edit_restriction]['protect']) && $wgGroupPermissions[$edit_restriction]['protect'] ) )
263 $this->mCascade
= false;
265 if ($this->mTitle
->exists()) {
266 $ok = $this->mArticle
->updateRestrictions( $this->mRestrictions
, $reasonstr, $this->mCascade
, $expiry );
268 $ok = $this->mTitle
->updateTitleProtection( $this->mRestrictions
['create'], $reasonstr, $expiry['create'] );
272 throw new FatalError( "Unknown error at restriction save time." );
275 if( $wgRequest->getCheck( 'mwProtectWatch' ) ) {
276 $this->mArticle
->doWatch();
277 } elseif( $this->mTitle
->userIsWatching() ) {
278 $this->mArticle
->doUnwatch();
284 * Build the input form
286 * @return $out string HTML form
288 function buildForm() {
289 global $wgUser, $wgLang;
291 $mProtectreasonother = Xml
::label( wfMsg( 'protectcomment' ), 'wpProtectReasonSelection' );
292 $mProtectreason = Xml
::label( wfMsg( 'protect-otherreason' ), 'mwProtect-reason' );
295 if( !$this->disabled
) {
296 $out .= $this->buildScript();
297 $out .= Xml
::openElement( 'form', array( 'method' => 'post',
298 'action' => $this->mTitle
->getLocalUrl( 'action=protect' ),
299 'id' => 'mw-Protect-Form', 'onsubmit' => 'ProtectionForm.enableUnchainedInputs(true)' ) );
300 $out .= Xml
::hidden( 'wpEditToken',$wgUser->editToken() );
303 $out .= Xml
::openElement( 'fieldset' ) .
304 Xml
::element( 'legend', null, wfMsg( 'protect-legend' ) ) .
305 Xml
::openElement( 'table', array( 'id' => 'mwProtectSet' ) ) .
306 Xml
::openElement( 'tbody' );
308 foreach( $this->mRestrictions
as $action => $selected ) {
309 /* Not all languages have V_x <-> N_x relation */
310 $msg = wfMsg( 'restriction-' . $action );
311 if( wfEmptyMsg( 'restriction-' . $action, $msg ) ) {
315 Xml
::openElement( 'fieldset' ) .
316 Xml
::element( 'legend', null, $msg ) .
317 Xml
::openElement( 'table', array( 'id' => "mw-protect-table-$action" ) ) .
318 "<tr><td>" . $this->buildSelector( $action, $selected ) . "</td></tr><tr><td>";
320 $reasonDropDown = Xml
::listDropDown( 'wpProtectReasonSelection',
321 wfMsgForContent( 'protect-dropdown' ),
322 wfMsgForContent( 'protect-otherreason-op' ),
323 $this->mReasonSelection
,
324 'mwProtect-reason', 4 );
325 $scExpiryOptions = wfMsgForContent( 'protect-expiry-options' );
327 $showProtectOptions = ($scExpiryOptions !== '-' && !$this->disabled
);
329 $mProtectexpiry = Xml
::label( wfMsg( 'protectexpiry' ), "mwProtectExpirySelection-$action" );
330 $mProtectother = Xml
::label( wfMsg( 'protect-othertime' ), "mwProtect-$action-expires" );
332 $expiryFormOptions = '';
333 if ( $this->mExistingExpiry
[$action] && $this->mExistingExpiry
[$action] != 'infinity' ) {
334 $expiryFormOptions .=
336 wfMsg( 'protect-existing-expiry', $wgLang->timeanddate( $this->mExistingExpiry
[$action] ) ),
338 $this->mExpirySelection
[$action] == 'existing'
342 $expiryFormOptions .= Xml
::option( wfMsg( 'protect-othertime-op' ), "othertime" ) . "\n";
343 foreach( explode(',', $scExpiryOptions) as $option ) {
344 if ( strpos($option, ":") === false ) {
345 $show = $value = $option;
347 list($show, $value) = explode(":", $option);
349 $show = htmlspecialchars($show);
350 $value = htmlspecialchars($value);
351 $expiryFormOptions .= Xml
::option( $show, $value, $this->mExpirySelection
[$action] === $value ) . "\n";
353 # Add expiry dropdown
354 if( $showProtectOptions && !$this->disabled
) {
357 <td class='mw-label'>
360 <td class='mw-input'>" .
363 'id' => "mwProtectExpirySelection-$action",
364 'name' => "wpProtectExpirySelection-$action",
365 'onchange' => "ProtectionForm.updateExpiryList(this)",
366 'tabindex' => '2' ) +
$this->disabledAttrib
,
367 $expiryFormOptions ) .
371 # Add custom expiry field
372 $attribs = array( 'id' => "mwProtect-$action-expires", 'onkeyup' => 'ProtectionForm.updateExpiry(this)' ) +
$this->disabledAttrib
;
374 <td class='mw-label'>" .
377 <td class="mw-input">' .
378 Xml
::input( "mwProtect-expiry-$action", 50, $this->mExpiry
[$action], $attribs ) .
381 $out .= "</td></tr>" .
382 Xml
::closeElement( 'table' ) .
383 Xml
::closeElement( 'fieldset' ) .
387 $out .= Xml
::closeElement( 'tbody' ) . Xml
::closeElement( 'table' );
389 // JavaScript will add another row with a value-chaining checkbox
390 if( $this->mTitle
->exists() ) {
391 $out .= Xml
::openElement( 'table', array( 'id' => 'mw-protect-table2' ) ) .
392 Xml
::openElement( 'tbody' );
395 <td class="mw-input">' .
396 Xml
::checkLabel( wfMsg( 'protect-cascade' ), 'mwProtect-cascade', 'mwProtect-cascade',
397 $this->mCascade
, $this->disabledAttrib
) .
400 $out .= Xml
::closeElement( 'tbody' ) . Xml
::closeElement( 'table' );
403 # Add manual and custom reason field/selects as well as submit
404 if( !$this->disabled
) {
405 $out .= Xml
::openElement( 'table', array( 'id' => 'mw-protect-table3' ) ) .
406 Xml
::openElement( 'tbody' );
409 <td class='mw-label'>
410 {$mProtectreasonother}
412 <td class='mw-input'>
417 <td class='mw-label'>
420 <td class='mw-input'>" .
421 Xml
::input( 'mwProtect-reason', 60, $this->mReason
, array( 'type' => 'text',
422 'id' => 'mwProtect-reason', 'maxlength' => 255 ) ) .
427 <td class='mw-input'>" .
428 Xml
::checkLabel( wfMsg( 'watchthis' ),
429 'mwProtectWatch', 'mwProtectWatch',
430 $this->mTitle
->userIsWatching() ||
$wgUser->getOption( 'watchdefault' ) ) .
435 <td class='mw-submit'>" .
436 Xml
::submitButton( wfMsg( 'confirm' ), array( 'id' => 'mw-Protect-submit' ) ) .
439 $out .= Xml
::closeElement( 'tbody' ) . Xml
::closeElement( 'table' );
441 $out .= Xml
::closeElement( 'fieldset' );
443 if ( $wgUser->isAllowed( 'editinterface' ) ) {
444 $linkTitle = Title
::makeTitleSafe( NS_MEDIAWIKI
, 'protect-dropdown' );
445 $link = $wgUser->getSkin()->Link ( $linkTitle, wfMsgHtml( 'protect-edit-reasonlist' ) );
446 $out .= '<p class="mw-protect-editreasons">' . $link . '</p>';
449 if ( !$this->disabled
) {
450 $out .= Xml
::closeElement( 'form' ) .
451 $this->buildCleanupScript();
457 function buildSelector( $action, $selected ) {
458 global $wgRestrictionLevels, $wgUser;
461 foreach( $wgRestrictionLevels as $key ) {
462 //don't let them choose levels above their own (aka so they can still unprotect and edit the page). but only when the form isn't disabled
463 if( $key == 'sysop' ) {
464 //special case, rewrite sysop to protect and editprotected
465 if( !$wgUser->isAllowed('protect') && !$wgUser->isAllowed('editprotected') && !$this->disabled
)
468 if( !$wgUser->isAllowed($key) && !$this->disabled
)
474 $id = 'mwProtect-level-' . $action;
478 'size' => count( $levels ),
479 'onchange' => 'ProtectionForm.updateLevels(this)',
480 ) +
$this->disabledAttrib
;
482 $out = Xml
::openElement( 'select', $attribs );
483 foreach( $levels as $key ) {
484 $out .= Xml
::option( $this->getOptionLabel( $key ), $key, $key == $selected );
486 $out .= Xml
::closeElement( 'select' );
491 * Prepare the label for a protection selector option
493 * @param string $permission Permission required
496 private function getOptionLabel( $permission ) {
497 if( $permission == '' ) {
498 return wfMsg( 'protect-default' );
500 $key = "protect-level-{$permission}";
501 $msg = wfMsg( $key );
502 if( wfEmptyMsg( $key, $msg ) )
503 $msg = wfMsg( 'protect-fallback', $permission );
508 function buildScript() {
509 global $wgStylePath, $wgStyleVersion;
510 return Xml
::tags( 'script', array(
511 'type' => 'text/javascript',
512 'src' => $wgStylePath . "/common/protect.js?$wgStyleVersion.1" ), '' );
515 function buildCleanupScript() {
516 global $wgRestrictionLevels, $wgGroupPermissions;
517 $script = 'var wgCascadeableLevels=';
518 $CascadeableLevels = array();
519 foreach( $wgRestrictionLevels as $key ) {
520 if ( (isset($wgGroupPermissions[$key]['protect']) && $wgGroupPermissions[$key]['protect']) ||
$key == 'protect' ) {
521 $CascadeableLevels[] = "'" . Xml
::escapeJsString( $key ) . "'";
524 $script .= "[" . implode(',',$CascadeableLevels) . "];\n";
525 $options = (object)array(
526 'tableId' => 'mw-protect-table-move',
527 'labelText' => wfMsg( 'protect-unchain' ),
528 'numTypes' => count($this->mApplicableTypes
),
529 'existingMatch' => 1 == count( array_unique( $this->mExistingExpiry
) ),
531 $encOptions = Xml
::encodeJsVar( $options );
533 $script .= "ProtectionForm.init($encOptions)";
534 return Xml
::tags( 'script', array( 'type' => 'text/javascript' ), $script );
538 * @param OutputPage $out
541 function showLogExtract( &$out ) {
542 # Show relevant lines from the protection log:
543 $out->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'protect' ) ) );
544 LogEventsList
::showLogExtract( $out, 'protect', $this->mTitle
->getPrefixedText() );