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 editprotected
139 if ( !$wgUser->isAllowed( 'editprotected' ) ) {
142 } elseif ( $val == 'autoconfirmed' ) {
143 // Special case, rewrite autoconfirmed to editsemiprotected
144 if ( !$wgUser->isAllowed( 'editsemiprotected' ) ) {
147 } elseif ( !$wgUser->isAllowed( $val ) ) {
150 $this->mRestrictions
[$action] = $val;
156 * Get the expiry time for a given action, by combining the relevant inputs.
158 * @param $action string
160 * @return string 14-char timestamp or "infinity", or false if the input was invalid
162 function getExpiry( $action ) {
163 if ( $this->mExpirySelection
[$action] == 'existing' ) {
164 return $this->mExistingExpiry
[$action];
165 } elseif ( $this->mExpirySelection
[$action] == 'othertime' ) {
166 $value = $this->mExpiry
[$action];
168 $value = $this->mExpirySelection
[$action];
170 if ( $value == 'infinite' ||
$value == 'indefinite' ||
$value == 'infinity' ) {
171 $time = wfGetDB( DB_SLAVE
)->getInfinity();
173 $unix = strtotime( $value );
175 if ( !$unix ||
$unix === -1 ) {
179 // @todo FIXME: Non-qualified absolute times are not in users specified timezone
180 // and there isn't notice about it in the ui
181 $time = wfTimestamp( TS_MW
, $unix );
187 * Main entry point for action=protect and action=unprotect
190 global $wgRequest, $wgOut;
192 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
193 throw new ErrorPageError( 'protect-badnamespace-title', 'protect-badnamespace-text' );
196 if ( $wgRequest->wasPosted() ) {
197 if ( $this->save() ) {
198 $q = $this->mArticle
->isRedirect() ?
'redirect=no' : '';
199 $wgOut->redirect( $this->mTitle
->getFullURL( $q ) );
207 * Show the input form with optional error message
209 * @param string $err error message or null if there's no error
211 function show( $err = null ) {
214 $wgOut->setRobotPolicy( 'noindex,nofollow' );
215 $wgOut->addBacklinkSubtitle( $this->mTitle
);
217 if ( is_array( $err ) ) {
218 $wgOut->wrapWikiMsg( "<p class='error'>\n$1\n</p>\n", $err );
219 } elseif ( is_string( $err ) ) {
220 $wgOut->addHTML( "<p class='error'>{$err}</p>\n" );
223 if ( $this->mTitle
->getRestrictionTypes() === array() ) {
224 // No restriction types available for the current title
225 // this might happen if an extension alters the available types
226 $wgOut->setPageTitle( wfMessage( 'protect-norestrictiontypes-title', $this->mTitle
->getPrefixedText() ) );
227 $wgOut->addWikiText( wfMessage( 'protect-norestrictiontypes-text' )->text() );
229 // Show the log in case protection was possible once
230 $this->showLogExtract( $wgOut );
231 // return as there isn't anything else we can do
235 list( $cascadeSources, /* $restrictions */ ) = $this->mTitle
->getCascadeProtectionSources();
236 if ( $cascadeSources && count( $cascadeSources ) > 0 ) {
239 foreach ( $cascadeSources as $title ) {
240 $titles .= '* [[:' . $title->getPrefixedText() . "]]\n";
243 $wgOut->wrapWikiMsg( "<div id=\"mw-protect-cascadeon\">\n$1\n" . $titles . "</div>", array( 'protect-cascadeon', count( $cascadeSources ) ) );
246 # Show an appropriate message if the user isn't allowed or able to change
247 # the protection settings at this time
248 if ( $this->disabled
) {
249 $wgOut->setPageTitle( wfMessage( 'protect-title-notallowed', $this->mTitle
->getPrefixedText() ) );
250 $wgOut->addWikiText( $wgOut->formatPermissionsErrorMessage( $this->mPermErrors
, 'protect' ) );
252 $wgOut->setPageTitle( wfMessage( 'protect-title', $this->mTitle
->getPrefixedText() ) );
253 $wgOut->addWikiMsg( 'protect-text',
254 wfEscapeWikiText( $this->mTitle
->getPrefixedText() ) );
257 $wgOut->addHTML( $this->buildForm() );
258 $this->showLogExtract( $wgOut );
262 * Save submitted protection form
264 * @return Boolean: success
267 global $wgRequest, $wgUser, $wgOut;
270 if ( $this->disabled
) {
275 $token = $wgRequest->getVal( 'wpEditToken' );
276 if ( !$wgUser->matchEditToken( $token, array( 'protect', $this->mTitle
->getPrefixedDBkey() ) ) ) {
277 $this->show( array( 'sessionfailure' ) );
281 # Create reason string. Use list and/or custom string.
282 $reasonstr = $this->mReasonSelection
;
283 if ( $reasonstr != 'other' && $this->mReason
!= '' ) {
284 // Entry from drop down menu + additional comment
285 $reasonstr .= wfMessage( 'colon-separator' )->text() . $this->mReason
;
286 } elseif ( $reasonstr == 'other' ) {
287 $reasonstr = $this->mReason
;
290 foreach ( $this->mApplicableTypes
as $action ) {
291 $expiry[$action] = $this->getExpiry( $action );
292 if ( empty( $this->mRestrictions
[$action] ) ) {
293 continue; // unprotected
295 if ( !$expiry[$action] ) {
296 $this->show( array( 'protect_expiry_invalid' ) );
299 if ( $expiry[$action] < wfTimestampNow() ) {
300 $this->show( array( 'protect_expiry_old' ) );
305 $this->mCascade
= $wgRequest->getBool( 'mwProtect-cascade' );
307 $status = $this->mArticle
->doUpdateRestrictions( $this->mRestrictions
, $expiry, $this->mCascade
, $reasonstr, $wgUser );
309 if ( !$status->isOK() ) {
310 $this->show( $wgOut->parseInline( $status->getWikiText() ) );
315 * Give extensions a change to handle added form items
317 * @since 1.19 you can (and you should) return false to abort saving;
318 * you can also return an array of message name and its parameters
321 if ( !wfRunHooks( 'ProtectionForm::save', array( $this->mArticle
, &$errorMsg, $reasonstr ) ) ) {
322 if ( $errorMsg == '' ) {
323 $errorMsg = array( 'hookaborted' );
326 if ( $errorMsg != '' ) {
327 $this->show( $errorMsg );
331 WatchAction
::doWatchOrUnwatch( $wgRequest->getCheck( 'mwProtectWatch' ), $this->mTitle
, $wgUser );
337 * Build the input form
339 * @return String: HTML form
341 function buildForm() {
342 global $wgUser, $wgLang, $wgOut;
344 $mProtectreasonother = Xml
::label(
345 wfMessage( 'protectcomment' )->text(),
346 'wpProtectReasonSelection'
348 $mProtectreason = Xml
::label(
349 wfMessage( 'protect-otherreason' )->text(),
354 if ( !$this->disabled
) {
355 $wgOut->addModules( 'mediawiki.legacy.protect' );
356 $out .= Xml
::openElement( 'form', array( 'method' => 'post',
357 'action' => $this->mTitle
->getLocalURL( 'action=protect' ),
358 'id' => 'mw-Protect-Form', 'onsubmit' => 'ProtectionForm.enableUnchainedInputs(true)' ) );
361 $out .= Xml
::openElement( 'fieldset' ) .
362 Xml
::element( 'legend', null, wfMessage( 'protect-legend' )->text() ) .
363 Xml
::openElement( 'table', array( 'id' => 'mwProtectSet' ) ) .
364 Xml
::openElement( 'tbody' );
366 // Not all languages have V_x <-> N_x relation
367 foreach ( $this->mRestrictions
as $action => $selected ) {
369 // restriction-edit, restriction-move, restriction-create, restriction-upload
370 $msg = wfMessage( 'restriction-' . $action );
372 Xml
::openElement( 'fieldset' ) .
373 Xml
::element( 'legend', null, $msg->exists() ?
$msg->text() : $action ) .
374 Xml
::openElement( 'table', array( 'id' => "mw-protect-table-$action" ) ) .
375 "<tr><td>" . $this->buildSelector( $action, $selected ) . "</td></tr><tr><td>";
377 $reasonDropDown = Xml
::listDropDown( 'wpProtectReasonSelection',
378 wfMessage( 'protect-dropdown' )->inContentLanguage()->text(),
379 wfMessage( 'protect-otherreason-op' )->inContentLanguage()->text(),
380 $this->mReasonSelection
,
381 'mwProtect-reason', 4 );
382 $scExpiryOptions = wfMessage( 'protect-expiry-options' )->inContentLanguage()->text();
384 $showProtectOptions = $scExpiryOptions !== '-' && !$this->disabled
;
386 $mProtectexpiry = Xml
::label(
387 wfMessage( 'protectexpiry' )->text(),
388 "mwProtectExpirySelection-$action"
390 $mProtectother = Xml
::label(
391 wfMessage( 'protect-othertime' )->text(),
392 "mwProtect-$action-expires"
395 $expiryFormOptions = '';
396 if ( $this->mExistingExpiry
[$action] && $this->mExistingExpiry
[$action] != 'infinity' ) {
397 $timestamp = $wgLang->timeanddate( $this->mExistingExpiry
[$action], true );
398 $d = $wgLang->date( $this->mExistingExpiry
[$action], true );
399 $t = $wgLang->time( $this->mExistingExpiry
[$action], true );
400 $expiryFormOptions .=
402 wfMessage( 'protect-existing-expiry', $timestamp, $d, $t )->text(),
404 $this->mExpirySelection
[$action] == 'existing'
408 $expiryFormOptions .= Xml
::option(
409 wfMessage( 'protect-othertime-op' )->text(),
412 foreach ( explode( ',', $scExpiryOptions ) as $option ) {
413 if ( strpos( $option, ":" ) === false ) {
414 $show = $value = $option;
416 list( $show, $value ) = explode( ":", $option );
418 $show = htmlspecialchars( $show );
419 $value = htmlspecialchars( $value );
420 $expiryFormOptions .= Xml
::option( $show, $value, $this->mExpirySelection
[$action] === $value ) . "\n";
422 # Add expiry dropdown
423 if ( $showProtectOptions && !$this->disabled
) {
426 <td class='mw-label'>
429 <td class='mw-input'>" .
432 'id' => "mwProtectExpirySelection-$action",
433 'name' => "wpProtectExpirySelection-$action",
434 'onchange' => "ProtectionForm.updateExpiryList(this)",
435 'tabindex' => '2' ) +
$this->disabledAttrib
,
436 $expiryFormOptions ) .
440 # Add custom expiry field
441 $attribs = array( 'id' => "mwProtect-$action-expires",
442 'onkeyup' => 'ProtectionForm.updateExpiry(this)',
443 'onchange' => 'ProtectionForm.updateExpiry(this)' ) +
$this->disabledAttrib
;
445 <td class='mw-label'>" .
448 <td class="mw-input">' .
449 Xml
::input( "mwProtect-expiry-$action", 50, $this->mExpiry
[$action], $attribs ) .
452 $out .= "</td></tr>" .
453 Xml
::closeElement( 'table' ) .
454 Xml
::closeElement( 'fieldset' ) .
457 # Give extensions a chance to add items to the form
458 wfRunHooks( 'ProtectionForm::buildForm', array( $this->mArticle
, &$out ) );
460 $out .= Xml
::closeElement( 'tbody' ) . Xml
::closeElement( 'table' );
462 // JavaScript will add another row with a value-chaining checkbox
463 if ( $this->mTitle
->exists() ) {
464 $out .= Xml
::openElement( 'table', array( 'id' => 'mw-protect-table2' ) ) .
465 Xml
::openElement( 'tbody' );
468 <td class="mw-input">' .
470 wfMessage( 'protect-cascade' )->text(),
473 $this->mCascade
, $this->disabledAttrib
477 $out .= Xml
::closeElement( 'tbody' ) . Xml
::closeElement( 'table' );
480 # Add manual and custom reason field/selects as well as submit
481 if ( !$this->disabled
) {
482 $out .= Xml
::openElement( 'table', array( 'id' => 'mw-protect-table3' ) ) .
483 Xml
::openElement( 'tbody' );
486 <td class='mw-label'>
487 {$mProtectreasonother}
489 <td class='mw-input'>
494 <td class='mw-label'>
497 <td class='mw-input'>" .
498 Xml
::input( 'mwProtect-reason', 60, $this->mReason
, array( 'type' => 'text',
499 'id' => 'mwProtect-reason', 'maxlength' => 180 ) ) .
500 // Limited maxlength as the database trims at 255 bytes and other texts
501 // chosen by dropdown menus on this page are also included in this database field.
502 // The byte limit of 180 bytes is enforced in javascript
505 # Disallow watching is user is not logged in
506 if ( $wgUser->isLoggedIn() ) {
510 <td class='mw-input'>" .
511 Xml
::checkLabel( wfMessage( 'watchthis' )->text(),
512 'mwProtectWatch', 'mwProtectWatch',
513 $wgUser->isWatched( $this->mTitle
) ||
$wgUser->getOption( 'watchdefault' ) ) .
520 <td class='mw-submit'>" .
522 wfMessage( 'confirm' )->text(),
523 array( 'id' => 'mw-Protect-submit' )
527 $out .= Xml
::closeElement( 'tbody' ) . Xml
::closeElement( 'table' );
529 $out .= Xml
::closeElement( 'fieldset' );
531 if ( $wgUser->isAllowed( 'editinterface' ) ) {
532 $title = Title
::makeTitle( NS_MEDIAWIKI
, 'Protect-dropdown' );
533 $link = Linker
::link(
535 wfMessage( 'protect-edit-reasonlist' )->escaped(),
537 array( 'action' => 'edit' )
539 $out .= '<p class="mw-protect-editreasons">' . $link . '</p>';
542 if ( !$this->disabled
) {
543 $out .= Html
::hidden( 'wpEditToken', $wgUser->getEditToken( array( 'protect', $this->mTitle
->getPrefixedDBkey() ) ) );
544 $out .= Xml
::closeElement( 'form' );
545 $wgOut->addScript( $this->buildCleanupScript() );
552 * Build protection level selector
554 * @param string $action action to protect
555 * @param string $selected current protection level
556 * @return String: HTML fragment
558 function buildSelector( $action, $selected ) {
559 global $wgRestrictionLevels, $wgUser;
562 foreach ( $wgRestrictionLevels as $key ) {
563 //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
564 if ( $key == 'sysop' ) {
565 //special case, rewrite sysop to editprotected
566 if ( !$wgUser->isAllowed( 'editprotected' ) && !$this->disabled
) {
569 } elseif ( $key == 'autoconfirmed' ) {
570 //special case, rewrite autoconfirmed to editsemiprotected
571 if ( !$wgUser->isAllowed( 'editsemiprotected' ) && !$this->disabled
) {
575 if ( !$wgUser->isAllowed( $key ) && !$this->disabled
) {
582 $id = 'mwProtect-level-' . $action;
586 'size' => count( $levels ),
587 'onchange' => 'ProtectionForm.updateLevels(this)',
588 ) +
$this->disabledAttrib
;
590 $out = Xml
::openElement( 'select', $attribs );
591 foreach ( $levels as $key ) {
592 $out .= Xml
::option( $this->getOptionLabel( $key ), $key, $key == $selected );
594 $out .= Xml
::closeElement( 'select' );
599 * Prepare the label for a protection selector option
601 * @param string $permission permission required
604 private function getOptionLabel( $permission ) {
605 if ( $permission == '' ) {
606 return wfMessage( 'protect-default' )->text();
608 // Messages: protect-level-autoconfirmed, protect-level-sysop
609 $msg = wfMessage( "protect-level-{$permission}" );
610 if ( $msg->exists() ) {
613 return wfMessage( 'protect-fallback', $permission )->text();
617 function buildCleanupScript() {
618 global $wgCascadingRestrictionLevels, $wgOut;
620 $cascadeableLevels = $wgCascadingRestrictionLevels;
622 'tableId' => 'mwProtectSet',
623 'labelText' => wfMessage( 'protect-unchain-permissions' )->plain(),
624 'numTypes' => count( $this->mApplicableTypes
),
625 'existingMatch' => count( array_unique( $this->mExistingExpiry
) ) === 1,
628 $wgOut->addJsConfigVars( 'wgCascadeableLevels', $cascadeableLevels );
629 $script = Xml
::encodeJsCall( 'ProtectionForm.init', array( $options ) );
630 return Html
::inlineScript( ResourceLoader
::makeLoaderConditionalScript( $script ) );
634 * Show protection long extracts for this page
636 * @param $out OutputPage
639 function showLogExtract( &$out ) {
640 # Show relevant lines from the protection log:
641 $protectLogPage = new LogPage( 'protect' );
642 $out->addHTML( Xml
::element( 'h2', null, $protectLogPage->getName()->text() ) );
643 LogEventsList
::showLogExtract( $out, 'protect', $this->mTitle
);
644 # Let extensions add other relevant log extracts
645 wfRunHooks( 'ProtectionForm::showLogExtract', array( $this->mArticle
, $out ) );