5 * Copyright © 2005 Brion Vibber <brion@pobox.com>
6 * http://www.mediawiki.org/
8 * This program 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 * This program 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 along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 * http://www.gnu.org/copyleft/gpl.html
27 * Handles the page protection UI and backend
29 class ProtectionForm
{
30 /** A map of action to restriction level, from request or default */
31 var $mRestrictions = array();
33 /** The custom/additional protection reason */
36 /** The reason selected from the list, blank for other/additional */
37 var $mReasonSelection = '';
39 /** True if the restrictions are cascading, from request or existing protection */
40 var $mCascade = false;
42 /** Map of action to "other" expiry time. Used in preference to mExpirySelection. */
43 var $mExpiry = array();
46 * Map of action to value selected in expiry drop-down list.
47 * Will be set to 'othertime' whenever mExpiry is set.
49 var $mExpirySelection = array();
51 /** Permissions errors for the protect action */
52 var $mPermErrors = array();
54 /** Types (i.e. actions) for which levels can be selected */
55 var $mApplicableTypes = array();
57 /** Map of action to the expiry time of the existing protection */
58 var $mExistingExpiry = array();
60 function __construct( Page
$article ) {
62 // Set instance variables.
63 $this->mArticle
= $article;
64 $this->mTitle
= $article->getTitle();
65 $this->mApplicableTypes
= $this->mTitle
->getRestrictionTypes();
67 // Check if the form should be disabled.
68 // If it is, the form will be available in read-only to show levels.
69 $this->mPermErrors
= $this->mTitle
->getUserPermissionsErrors( 'protect', $wgUser );
71 $this->mPermErrors
[] = array( 'readonlytext', wfReadOnlyReason() );
73 $this->disabled
= $this->mPermErrors
!= array();
74 $this->disabledAttrib
= $this->disabled
75 ?
array( 'disabled' => 'disabled' )
82 * Loads the current state of protection into the object.
85 global $wgRequest, $wgUser;
86 global $wgRestrictionLevels;
88 $this->mCascade
= $this->mTitle
->areRestrictionsCascading();
90 $this->mReason
= $wgRequest->getText( 'mwProtect-reason' );
91 $this->mReasonSelection
= $wgRequest->getText( 'wpProtectReasonSelection' );
92 $this->mCascade
= $wgRequest->getBool( 'mwProtect-cascade', $this->mCascade
);
94 foreach( $this->mApplicableTypes
as $action ) {
95 // @todo FIXME: This form currently requires individual selections,
96 // but the db allows multiples separated by commas.
98 // Pull the actual restriction from the DB
99 $this->mRestrictions
[$action] = implode( '', $this->mTitle
->getRestrictions( $action ) );
101 if ( !$this->mRestrictions
[$action] ) {
102 // No existing expiry
103 $existingExpiry = '';
105 $existingExpiry = $this->mTitle
->getRestrictionExpiry( $action );
107 $this->mExistingExpiry
[$action] = $existingExpiry;
109 $requestExpiry = $wgRequest->getText( "mwProtect-expiry-$action" );
110 $requestExpirySelection = $wgRequest->getVal( "wpProtectExpirySelection-$action" );
112 if ( $requestExpiry ) {
113 // Custom expiry takes precedence
114 $this->mExpiry
[$action] = $requestExpiry;
115 $this->mExpirySelection
[$action] = 'othertime';
116 } elseif ( $requestExpirySelection ) {
117 // Expiry selected from list
118 $this->mExpiry
[$action] = '';
119 $this->mExpirySelection
[$action] = $requestExpirySelection;
120 } elseif ( $existingExpiry == 'infinity' ) {
121 // Existing expiry is infinite, use "infinite" in drop-down
122 $this->mExpiry
[$action] = '';
123 $this->mExpirySelection
[$action] = 'infinite';
124 } elseif ( $existingExpiry ) {
125 // Use existing expiry in its own list item
126 $this->mExpiry
[$action] = '';
127 $this->mExpirySelection
[$action] = $existingExpiry;
129 // Final default: infinite
130 $this->mExpiry
[$action] = '';
131 $this->mExpirySelection
[$action] = 'infinite';
134 $val = $wgRequest->getVal( "mwProtect-level-$action" );
135 if( isset( $val ) && in_array( $val, $wgRestrictionLevels ) ) {
136 // Prevent users from setting levels that they cannot later unset
137 if( $val == 'sysop' ) {
138 // Special case, rewrite sysop to either protect and editprotected
139 if( !$wgUser->isAllowedAny( 'protect', 'editprotected' ) )
142 if( !$wgUser->isAllowed($val) )
145 $this->mRestrictions
[$action] = $val;
151 * Get the expiry time for a given action, by combining the relevant inputs.
153 * @param $action string
155 * @return string 14-char timestamp or "infinity", or false if the input was invalid
157 function getExpiry( $action ) {
158 if ( $this->mExpirySelection
[$action] == 'existing' ) {
159 return $this->mExistingExpiry
[$action];
160 } elseif ( $this->mExpirySelection
[$action] == 'othertime' ) {
161 $value = $this->mExpiry
[$action];
163 $value = $this->mExpirySelection
[$action];
165 if ( $value == 'infinite' ||
$value == 'indefinite' ||
$value == 'infinity' ) {
166 $time = wfGetDB( DB_SLAVE
)->getInfinity();
168 $unix = strtotime( $value );
170 if ( !$unix ||
$unix === -1 ) {
174 // @todo FIXME: Non-qualified absolute times are not in users specified timezone
175 // and there isn't notice about it in the ui
176 $time = wfTimestamp( TS_MW
, $unix );
182 * Main entry point for action=protect and action=unprotect
185 global $wgRequest, $wgOut;
187 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
188 throw new ErrorPageError( 'protect-badnamespace-title', 'protect-badnamespace-text' );
191 if( $wgRequest->wasPosted() ) {
192 if( $this->save() ) {
193 $q = $this->mArticle
->isRedirect() ?
'redirect=no' : '';
194 $wgOut->redirect( $this->mTitle
->getFullUrl( $q ) );
202 * Show the input form with optional error message
204 * @param $err String: error message or null if there's no error
206 function show( $err = null ) {
209 $wgOut->setRobotPolicy( 'noindex,nofollow' );
211 if ( is_array( $err ) ) {
212 $wgOut->wrapWikiMsg( "<p class='error'>\n$1\n</p>\n", $err );
213 } elseif ( is_string( $err ) ) {
214 $wgOut->addHTML( "<p class='error'>{$err}</p>\n" );
217 list( $cascadeSources, /* $restrictions */ ) = $this->mTitle
->getCascadeProtectionSources();
218 if ( $cascadeSources && count($cascadeSources) > 0 ) {
221 foreach ( $cascadeSources as $title ) {
222 $titles .= '* [[:' . $title->getPrefixedText() . "]]\n";
225 $wgOut->wrapWikiMsg( "<div id=\"mw-protect-cascadeon\">\n$1\n" . $titles . "</div>", array( 'protect-cascadeon', count($cascadeSources) ) );
228 # Show an appropriate message if the user isn't allowed or able to change
229 # the protection settings at this time
230 if ( $this->disabled
) {
231 $wgOut->setPageTitle( wfMessage( 'protect-title-notallowed', $this->mTitle
->getPrefixedText() ) );
232 $wgOut->addWikiText( $wgOut->formatPermissionsErrorMessage( $this->mPermErrors
, 'protect' ) );
234 $wgOut->setPageTitle( wfMessage( 'protect-title', $this->mTitle
->getPrefixedText() ) );
235 $wgOut->addWikiMsg( 'protect-text',
236 wfEscapeWikiText( $this->mTitle
->getPrefixedText() ) );
239 $wgOut->addBacklinkSubtitle( $this->mTitle
);
240 $wgOut->addHTML( $this->buildForm() );
241 $this->showLogExtract( $wgOut );
245 * Save submitted protection form
247 * @return Boolean: success
250 global $wgRequest, $wgUser;
253 if ( $this->disabled
) {
258 $token = $wgRequest->getVal( 'wpEditToken' );
259 if ( !$wgUser->matchEditToken( $token, array( 'protect', $this->mTitle
->getPrefixedDBkey() ) ) ) {
260 $this->show( array( 'sessionfailure' ) );
264 # Create reason string. Use list and/or custom string.
265 $reasonstr = $this->mReasonSelection
;
266 if ( $reasonstr != 'other' && $this->mReason
!= '' ) {
267 // Entry from drop down menu + additional comment
268 $reasonstr .= wfMsgForContent( 'colon-separator' ) . $this->mReason
;
269 } elseif ( $reasonstr == 'other' ) {
270 $reasonstr = $this->mReason
;
273 foreach( $this->mApplicableTypes
as $action ) {
274 $expiry[$action] = $this->getExpiry( $action );
275 if( empty($this->mRestrictions
[$action]) )
276 continue; // unprotected
277 if ( !$expiry[$action] ) {
278 $this->show( array( 'protect_expiry_invalid' ) );
281 if ( $expiry[$action] < wfTimestampNow() ) {
282 $this->show( array( 'protect_expiry_old' ) );
287 # They shouldn't be able to do this anyway, but just to make sure, ensure that cascading restrictions aren't being applied
288 # to a semi-protected page.
289 global $wgGroupPermissions;
291 $edit_restriction = isset( $this->mRestrictions
['edit'] ) ?
$this->mRestrictions
['edit'] : '';
292 $this->mCascade
= $wgRequest->getBool( 'mwProtect-cascade' );
293 if ($this->mCascade
&& ($edit_restriction != 'protect') &&
294 !(isset($wgGroupPermissions[$edit_restriction]['protect']) && $wgGroupPermissions[$edit_restriction]['protect'] ) )
295 $this->mCascade
= false;
297 if ($this->mTitle
->exists()) {
298 $ok = $this->mArticle
->updateRestrictions( $this->mRestrictions
, $reasonstr, $this->mCascade
, $expiry );
300 $ok = $this->mTitle
->updateTitleProtection( $this->mRestrictions
['create'], $reasonstr, $expiry['create'] );
304 throw new FatalError( "Unknown error at restriction save time." );
308 * Give extensions a change to handle added form items
310 * @since 1.19 you can (and you should) return false to abort saving;
311 * you can also return an array of message name and its parameters
314 if( !wfRunHooks( 'ProtectionForm::save', array( $this->mArticle
, &$errorMsg ) ) ) {
315 if ( $errorMsg == '' ) {
316 $errorMsg = array( 'hookaborted' );
319 if( $errorMsg != '' ) {
320 $this->show( $errorMsg );
324 if ( $wgRequest->getCheck( 'mwProtectWatch' ) && $wgUser->isLoggedIn() ) {
325 WatchAction
::doWatch( $this->mTitle
, $wgUser );
326 } elseif ( $this->mTitle
->userIsWatching() ) {
327 WatchAction
::doUnwatch( $this->mTitle
, $wgUser );
333 * Build the input form
335 * @return String: HTML form
337 function buildForm() {
338 global $wgUser, $wgLang, $wgOut;
340 $mProtectreasonother = Xml
::label( wfMsg( 'protectcomment' ), 'wpProtectReasonSelection' );
341 $mProtectreason = Xml
::label( wfMsg( 'protect-otherreason' ), 'mwProtect-reason' );
344 if( !$this->disabled
) {
345 $wgOut->addModules( 'mediawiki.legacy.protect' );
346 $out .= Xml
::openElement( 'form', array( 'method' => 'post',
347 'action' => $this->mTitle
->getLocalUrl( 'action=protect' ),
348 'id' => 'mw-Protect-Form', 'onsubmit' => 'ProtectionForm.enableUnchainedInputs(true)' ) );
351 $out .= Xml
::openElement( 'fieldset' ) .
352 Xml
::element( 'legend', null, wfMsg( 'protect-legend' ) ) .
353 Xml
::openElement( 'table', array( 'id' => 'mwProtectSet' ) ) .
354 Xml
::openElement( 'tbody' );
356 foreach( $this->mRestrictions
as $action => $selected ) {
357 /* Not all languages have V_x <-> N_x relation */
358 $msg = wfMessage( 'restriction-' . $action );
360 Xml
::openElement( 'fieldset' ) .
361 Xml
::element( 'legend', null, $msg->exists() ?
$msg->text() : $action ) .
362 Xml
::openElement( 'table', array( 'id' => "mw-protect-table-$action" ) ) .
363 "<tr><td>" . $this->buildSelector( $action, $selected ) . "</td></tr><tr><td>";
365 $reasonDropDown = Xml
::listDropDown( 'wpProtectReasonSelection',
366 wfMsgForContent( 'protect-dropdown' ),
367 wfMsgForContent( 'protect-otherreason-op' ),
368 $this->mReasonSelection
,
369 'mwProtect-reason', 4 );
370 $scExpiryOptions = wfMsgForContent( 'protect-expiry-options' );
372 $showProtectOptions = ($scExpiryOptions !== '-' && !$this->disabled
);
374 $mProtectexpiry = Xml
::label( wfMsg( 'protectexpiry' ), "mwProtectExpirySelection-$action" );
375 $mProtectother = Xml
::label( wfMsg( 'protect-othertime' ), "mwProtect-$action-expires" );
377 $expiryFormOptions = '';
378 if ( $this->mExistingExpiry
[$action] && $this->mExistingExpiry
[$action] != 'infinity' ) {
379 $timestamp = $wgLang->timeanddate( $this->mExistingExpiry
[$action], true );
380 $d = $wgLang->date( $this->mExistingExpiry
[$action], true );
381 $t = $wgLang->time( $this->mExistingExpiry
[$action], true );
382 $expiryFormOptions .=
384 wfMsg( 'protect-existing-expiry', $timestamp, $d, $t ),
386 $this->mExpirySelection
[$action] == 'existing'
390 $expiryFormOptions .= Xml
::option( wfMsg( 'protect-othertime-op' ), "othertime" ) . "\n";
391 foreach( explode(',', $scExpiryOptions) as $option ) {
392 if ( strpos($option, ":") === false ) {
393 $show = $value = $option;
395 list($show, $value) = explode(":", $option);
397 $show = htmlspecialchars($show);
398 $value = htmlspecialchars($value);
399 $expiryFormOptions .= Xml
::option( $show, $value, $this->mExpirySelection
[$action] === $value ) . "\n";
401 # Add expiry dropdown
402 if( $showProtectOptions && !$this->disabled
) {
405 <td class='mw-label'>
408 <td class='mw-input'>" .
411 'id' => "mwProtectExpirySelection-$action",
412 'name' => "wpProtectExpirySelection-$action",
413 'onchange' => "ProtectionForm.updateExpiryList(this)",
414 'tabindex' => '2' ) +
$this->disabledAttrib
,
415 $expiryFormOptions ) .
419 # Add custom expiry field
420 $attribs = array( 'id' => "mwProtect-$action-expires",
421 'onkeyup' => 'ProtectionForm.updateExpiry(this)',
422 'onchange' => 'ProtectionForm.updateExpiry(this)' ) +
$this->disabledAttrib
;
424 <td class='mw-label'>" .
427 <td class="mw-input">' .
428 Xml
::input( "mwProtect-expiry-$action", 50, $this->mExpiry
[$action], $attribs ) .
431 $out .= "</td></tr>" .
432 Xml
::closeElement( 'table' ) .
433 Xml
::closeElement( 'fieldset' ) .
436 # Give extensions a chance to add items to the form
437 wfRunHooks( 'ProtectionForm::buildForm', array($this->mArticle
,&$out) );
439 $out .= Xml
::closeElement( 'tbody' ) . Xml
::closeElement( 'table' );
441 // JavaScript will add another row with a value-chaining checkbox
442 if( $this->mTitle
->exists() ) {
443 $out .= Xml
::openElement( 'table', array( 'id' => 'mw-protect-table2' ) ) .
444 Xml
::openElement( 'tbody' );
447 <td class="mw-input">' .
448 Xml
::checkLabel( wfMsg( 'protect-cascade' ), 'mwProtect-cascade', 'mwProtect-cascade',
449 $this->mCascade
, $this->disabledAttrib
) .
452 $out .= Xml
::closeElement( 'tbody' ) . Xml
::closeElement( 'table' );
455 # Add manual and custom reason field/selects as well as submit
456 if( !$this->disabled
) {
457 $out .= Xml
::openElement( 'table', array( 'id' => 'mw-protect-table3' ) ) .
458 Xml
::openElement( 'tbody' );
461 <td class='mw-label'>
462 {$mProtectreasonother}
464 <td class='mw-input'>
469 <td class='mw-label'>
472 <td class='mw-input'>" .
473 Xml
::input( 'mwProtect-reason', 60, $this->mReason
, array( 'type' => 'text',
474 'id' => 'mwProtect-reason', 'maxlength' => 180 ) ) .
475 // Limited maxlength as the database trims at 255 bytes and other texts
476 // chosen by dropdown menus on this page are also included in this database field.
477 // The byte limit of 180 bytes is enforced in javascript
480 # Disallow watching is user is not logged in
481 if( $wgUser->isLoggedIn() ) {
485 <td class='mw-input'>" .
486 Xml
::checkLabel( wfMsg( 'watchthis' ),
487 'mwProtectWatch', 'mwProtectWatch',
488 $this->mTitle
->userIsWatching() ||
$wgUser->getOption( 'watchdefault' ) ) .
495 <td class='mw-submit'>" .
496 Xml
::submitButton( wfMsg( 'confirm' ), array( 'id' => 'mw-Protect-submit' ) ) .
499 $out .= Xml
::closeElement( 'tbody' ) . Xml
::closeElement( 'table' );
501 $out .= Xml
::closeElement( 'fieldset' );
503 if ( $wgUser->isAllowed( 'editinterface' ) ) {
504 $title = Title
::makeTitle( NS_MEDIAWIKI
, 'Protect-dropdown' );
505 $link = Linker
::link(
507 wfMsgHtml( 'protect-edit-reasonlist' ),
509 array( 'action' => 'edit' )
511 $out .= '<p class="mw-protect-editreasons">' . $link . '</p>';
514 if ( !$this->disabled
) {
515 $out .= Html
::hidden( 'wpEditToken', $wgUser->getEditToken( array( 'protect', $this->mTitle
->getPrefixedDBkey() ) ) );
516 $out .= Xml
::closeElement( 'form' );
517 $wgOut->addScript( $this->buildCleanupScript() );
524 * Build protection level selector
526 * @param $action String: action to protect
527 * @param $selected String: current protection level
528 * @return String: HTML fragment
530 function buildSelector( $action, $selected ) {
531 global $wgRestrictionLevels, $wgUser;
534 foreach( $wgRestrictionLevels as $key ) {
535 //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
536 if( $key == 'sysop' ) {
537 //special case, rewrite sysop to protect and editprotected
538 if( !$wgUser->isAllowedAny( 'protect', 'editprotected' ) && !$this->disabled
)
541 if( !$wgUser->isAllowed($key) && !$this->disabled
)
547 $id = 'mwProtect-level-' . $action;
551 'size' => count( $levels ),
552 'onchange' => 'ProtectionForm.updateLevels(this)',
553 ) +
$this->disabledAttrib
;
555 $out = Xml
::openElement( 'select', $attribs );
556 foreach( $levels as $key ) {
557 $out .= Xml
::option( $this->getOptionLabel( $key ), $key, $key == $selected );
559 $out .= Xml
::closeElement( 'select' );
564 * Prepare the label for a protection selector option
566 * @param $permission String: permission required
569 private function getOptionLabel( $permission ) {
570 if( $permission == '' ) {
571 return wfMsg( 'protect-default' );
573 $msg = wfMessage( "protect-level-{$permission}" );
574 if( $msg->exists() ) {
577 return wfMsg( 'protect-fallback', $permission );
581 function buildCleanupScript() {
582 global $wgRestrictionLevels, $wgGroupPermissions, $wgOut;
584 $cascadeableLevels = array();
585 foreach( $wgRestrictionLevels as $key ) {
586 if ( ( isset( $wgGroupPermissions[$key]['protect'] ) && $wgGroupPermissions[$key]['protect'] )
589 $cascadeableLevels[] = $key;
593 'tableId' => 'mwProtectSet',
594 'labelText' => wfMessage( 'protect-unchain-permissions' )->plain(),
595 'numTypes' => count( $this->mApplicableTypes
),
596 'existingMatch' => count( array_unique( $this->mExistingExpiry
) ) === 1,
599 $wgOut->addJsConfigVars( 'wgCascadeableLevels', $cascadeableLevels );
600 $script = Xml
::encodeJsCall( 'ProtectionForm.init', array( $options ) );
601 return Html
::inlineScript( ResourceLoader
::makeLoaderConditionalScript( $script ) );
605 * Show protection long extracts for this page
607 * @param $out OutputPage
610 function showLogExtract( &$out ) {
611 # Show relevant lines from the protection log:
612 $out->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'protect' ) ) );
613 LogEventsList
::showLogExtract( $out, 'protect', $this->mTitle
);
614 # Let extensions add other relevant log extracts
615 wfRunHooks( 'ProtectionForm::showLogExtract', array($this->mArticle
,$out) );