5 * Copyright © 2005 Brion Vibber <brion@pobox.com>
6 * https://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 /** @var array A map of action to restriction level, from request or default */
31 protected $mRestrictions = [];
33 /** @var string The custom/additional protection reason */
34 protected $mReason = '';
36 /** @var string The reason selected from the list, blank for other/additional */
37 protected $mReasonSelection = '';
39 /** @var bool True if the restrictions are cascading, from request or existing protection */
40 protected $mCascade = false;
42 /** @var array Map of action to "other" expiry time. Used in preference to mExpirySelection. */
43 protected $mExpiry = [];
46 * @var array Map of action to value selected in expiry drop-down list.
47 * Will be set to 'othertime' whenever mExpiry is set.
49 protected $mExpirySelection = [];
51 /** @var array Permissions errors for the protect action */
52 protected $mPermErrors = [];
54 /** @var array Types (i.e. actions) for which levels can be selected */
55 protected $mApplicableTypes = [];
57 /** @var array Map of action to the expiry time of the existing protection */
58 protected $mExistingExpiry = [];
60 /** @var IContextSource */
63 function __construct( Article
$article ) {
64 // Set instance variables.
65 $this->mArticle
= $article;
66 $this->mTitle
= $article->getTitle();
67 $this->mApplicableTypes
= $this->mTitle
->getRestrictionTypes();
68 $this->mContext
= $article->getContext();
70 // Check if the form should be disabled.
71 // If it is, the form will be available in read-only to show levels.
72 $this->mPermErrors
= $this->mTitle
->getUserPermissionsErrors(
73 'protect', $this->mContext
->getUser()
76 $this->mPermErrors
[] = [ 'readonlytext', wfReadOnlyReason() ];
78 $this->disabled
= $this->mPermErrors
!= [];
79 $this->disabledAttrib
= $this->disabled
80 ?
[ 'disabled' => 'disabled' ]
87 * Loads the current state of protection into the object.
90 $levels = MWNamespace
::getRestrictionLevels(
91 $this->mTitle
->getNamespace(), $this->mContext
->getUser()
93 $this->mCascade
= $this->mTitle
->areRestrictionsCascading();
95 $request = $this->mContext
->getRequest();
96 $this->mReason
= $request->getText( 'mwProtect-reason' );
97 $this->mReasonSelection
= $request->getText( 'wpProtectReasonSelection' );
98 $this->mCascade
= $request->getBool( 'mwProtect-cascade', $this->mCascade
);
100 foreach ( $this->mApplicableTypes
as $action ) {
101 // @todo FIXME: This form currently requires individual selections,
102 // but the db allows multiples separated by commas.
104 // Pull the actual restriction from the DB
105 $this->mRestrictions
[$action] = implode( '', $this->mTitle
->getRestrictions( $action ) );
107 if ( !$this->mRestrictions
[$action] ) {
108 // No existing expiry
109 $existingExpiry = '';
111 $existingExpiry = $this->mTitle
->getRestrictionExpiry( $action );
113 $this->mExistingExpiry
[$action] = $existingExpiry;
115 $requestExpiry = $request->getText( "mwProtect-expiry-$action" );
116 $requestExpirySelection = $request->getVal( "wpProtectExpirySelection-$action" );
118 if ( $requestExpiry ) {
119 // Custom expiry takes precedence
120 $this->mExpiry
[$action] = $requestExpiry;
121 $this->mExpirySelection
[$action] = 'othertime';
122 } elseif ( $requestExpirySelection ) {
123 // Expiry selected from list
124 $this->mExpiry
[$action] = '';
125 $this->mExpirySelection
[$action] = $requestExpirySelection;
126 } elseif ( $existingExpiry ) {
127 // Use existing expiry in its own list item
128 $this->mExpiry
[$action] = '';
129 $this->mExpirySelection
[$action] = $existingExpiry;
131 // Catches 'infinity' - Existing expiry is infinite, use "infinite" in drop-down
132 // Final default: infinite
133 $this->mExpiry
[$action] = '';
134 $this->mExpirySelection
[$action] = 'infinite';
137 $val = $request->getVal( "mwProtect-level-$action" );
138 if ( isset( $val ) && in_array( $val, $levels ) ) {
139 $this->mRestrictions
[$action] = $val;
145 * Get the expiry time for a given action, by combining the relevant inputs.
147 * @param string $action
149 * @return string 14-char timestamp or "infinity", or false if the input was invalid
151 function getExpiry( $action ) {
152 if ( $this->mExpirySelection
[$action] == 'existing' ) {
153 return $this->mExistingExpiry
[$action];
154 } elseif ( $this->mExpirySelection
[$action] == 'othertime' ) {
155 $value = $this->mExpiry
[$action];
157 $value = $this->mExpirySelection
[$action];
159 if ( wfIsInfinity( $value ) ) {
162 $unix = strtotime( $value );
164 if ( !$unix ||
$unix === -1 ) {
168 // @todo FIXME: Non-qualified absolute times are not in users specified timezone
169 // and there isn't notice about it in the ui
170 $time = wfTimestamp( TS_MW
, $unix );
176 * Main entry point for action=protect and action=unprotect
179 if ( MWNamespace
::getRestrictionLevels( $this->mTitle
->getNamespace() ) === [ '' ] ) {
180 throw new ErrorPageError( 'protect-badnamespace-title', 'protect-badnamespace-text' );
183 if ( $this->mContext
->getRequest()->wasPosted() ) {
184 if ( $this->save() ) {
185 $q = $this->mArticle
->isRedirect() ?
'redirect=no' : '';
186 $this->mContext
->getOutput()->redirect( $this->mTitle
->getFullURL( $q ) );
194 * Show the input form with optional error message
196 * @param string $err Error message or null if there's no error
198 function show( $err = null ) {
199 $out = $this->mContext
->getOutput();
200 $out->setRobotPolicy( 'noindex,nofollow' );
201 $out->addBacklinkSubtitle( $this->mTitle
);
203 if ( is_array( $err ) ) {
204 $out->wrapWikiMsg( "<p class='error'>\n$1\n</p>\n", $err );
205 } elseif ( is_string( $err ) ) {
206 $out->addHTML( "<p class='error'>{$err}</p>\n" );
209 if ( $this->mTitle
->getRestrictionTypes() === [] ) {
210 // No restriction types available for the current title
211 // this might happen if an extension alters the available types
212 $out->setPageTitle( $this->mContext
->msg(
213 'protect-norestrictiontypes-title',
214 $this->mTitle
->getPrefixedText()
216 $out->addWikiText( $this->mContext
->msg( 'protect-norestrictiontypes-text' )->plain() );
218 // Show the log in case protection was possible once
219 $this->showLogExtract( $out );
220 // return as there isn't anything else we can do
224 list( $cascadeSources, /* $restrictions */ ) = $this->mTitle
->getCascadeProtectionSources();
225 if ( $cascadeSources && count( $cascadeSources ) > 0 ) {
228 foreach ( $cascadeSources as $title ) {
229 $titles .= '* [[:' . $title->getPrefixedText() . "]]\n";
232 /** @todo FIXME: i18n issue, should use formatted number. */
234 "<div id=\"mw-protect-cascadeon\">\n$1\n" . $titles . "</div>",
235 [ 'protect-cascadeon', count( $cascadeSources ) ]
239 # Show an appropriate message if the user isn't allowed or able to change
240 # the protection settings at this time
241 if ( $this->disabled
) {
243 $this->mContext
->msg( 'protect-title-notallowed',
244 $this->mTitle
->getPrefixedText() )
246 $out->addWikiText( $out->formatPermissionsErrorMessage( $this->mPermErrors
, 'protect' ) );
248 $out->setPageTitle( $this->mContext
->msg( 'protect-title', $this->mTitle
->getPrefixedText() ) );
249 $out->addWikiMsg( 'protect-text',
250 wfEscapeWikiText( $this->mTitle
->getPrefixedText() ) );
253 $out->addHTML( $this->buildForm() );
254 $this->showLogExtract( $out );
258 * Save submitted protection form
260 * @return bool Success
264 if ( $this->disabled
) {
269 $request = $this->mContext
->getRequest();
270 $user = $this->mContext
->getUser();
271 $out = $this->mContext
->getOutput();
272 $token = $request->getVal( 'wpEditToken' );
273 if ( !$user->matchEditToken( $token, [ 'protect', $this->mTitle
->getPrefixedDBkey() ] ) ) {
274 $this->show( [ 'sessionfailure' ] );
278 # Create reason string. Use list and/or custom string.
279 $reasonstr = $this->mReasonSelection
;
280 if ( $reasonstr != 'other' && $this->mReason
!= '' ) {
281 // Entry from drop down menu + additional comment
282 $reasonstr .= $this->mContext
->msg( 'colon-separator' )->text() . $this->mReason
;
283 } elseif ( $reasonstr == 'other' ) {
284 $reasonstr = $this->mReason
;
287 foreach ( $this->mApplicableTypes
as $action ) {
288 $expiry[$action] = $this->getExpiry( $action );
289 if ( empty( $this->mRestrictions
[$action] ) ) {
290 continue; // unprotected
292 if ( !$expiry[$action] ) {
293 $this->show( [ 'protect_expiry_invalid' ] );
296 if ( $expiry[$action] < wfTimestampNow() ) {
297 $this->show( [ 'protect_expiry_old' ] );
302 $this->mCascade
= $request->getBool( 'mwProtect-cascade' );
304 $status = $this->mArticle
->doUpdateRestrictions(
305 $this->mRestrictions
,
312 if ( !$status->isOK() ) {
313 $this->show( $out->parseInline( $status->getWikiText() ) );
318 * Give extensions a change to handle added form items
320 * @since 1.19 you can (and you should) return false to abort saving;
321 * you can also return an array of message name and its parameters
324 if ( !Hooks
::run( 'ProtectionForm::save', [ $this->mArticle
, &$errorMsg, $reasonstr ] ) ) {
325 if ( $errorMsg == '' ) {
326 $errorMsg = [ 'hookaborted' ];
329 if ( $errorMsg != '' ) {
330 $this->show( $errorMsg );
334 WatchAction
::doWatchOrUnwatch( $request->getCheck( 'mwProtectWatch' ), $this->mTitle
, $user );
340 * Build the input form
342 * @return string HTML form
344 function buildForm() {
345 $context = $this->mContext
;
346 $user = $context->getUser();
347 $output = $context->getOutput();
348 $lang = $context->getLanguage();
349 $cascadingRestrictionLevels = $context->getConfig()->get( 'CascadingRestrictionLevels' );
351 if ( !$this->disabled
) {
352 $output->addModules( 'mediawiki.legacy.protect' );
353 $output->addJsConfigVars( 'wgCascadeableLevels', $cascadingRestrictionLevels );
354 $out .= Xml
::openElement( 'form', [ 'method' => 'post',
355 'action' => $this->mTitle
->getLocalURL( 'action=protect' ),
356 'id' => 'mw-Protect-Form' ] );
359 $out .= Xml
::openElement( 'fieldset' ) .
360 Xml
::element( 'legend', null, $context->msg( 'protect-legend' )->text() ) .
361 Xml
::openElement( 'table', [ 'id' => 'mwProtectSet' ] ) .
362 Xml
::openElement( 'tbody' );
364 $scExpiryOptions = wfMessage( 'protect-expiry-options' )->inContentLanguage()->text();
365 $showProtectOptions = $scExpiryOptions !== '-' && !$this->disabled
;
367 // Not all languages have V_x <-> N_x relation
368 foreach ( $this->mRestrictions
as $action => $selected ) {
370 // restriction-edit, restriction-move, restriction-create, restriction-upload
371 $msg = $context->msg( 'restriction-' . $action );
373 Xml
::openElement( 'fieldset' ) .
374 Xml
::element( 'legend', null, $msg->exists() ?
$msg->text() : $action ) .
375 Xml
::openElement( 'table', [ 'id' => "mw-protect-table-$action" ] ) .
376 "<tr><td>" . $this->buildSelector( $action, $selected ) . "</td></tr><tr><td>";
378 $mProtectexpiry = Xml
::label(
379 $context->msg( 'protectexpiry' )->text(),
380 "mwProtectExpirySelection-$action"
382 $mProtectother = Xml
::label(
383 $context->msg( 'protect-othertime' )->text(),
384 "mwProtect-$action-expires"
387 $expiryFormOptions = new XmlSelect(
388 "wpProtectExpirySelection-$action",
389 "mwProtectExpirySelection-$action",
390 $this->mExpirySelection
[$action]
392 $expiryFormOptions->setAttribute( 'tabindex', '2' );
393 if ( $this->disabled
) {
394 $expiryFormOptions->setAttribute( 'disabled', 'disabled' );
397 if ( $this->mExistingExpiry
[$action] ) {
398 if ( $this->mExistingExpiry
[$action] == 'infinity' ) {
399 $existingExpiryMessage = $context->msg( 'protect-existing-expiry-infinity' );
401 $timestamp = $lang->userTimeAndDate( $this->mExistingExpiry
[$action], $user );
402 $d = $lang->userDate( $this->mExistingExpiry
[$action], $user );
403 $t = $lang->userTime( $this->mExistingExpiry
[$action], $user );
404 $existingExpiryMessage = $context->msg(
405 'protect-existing-expiry',
411 $expiryFormOptions->addOption( $existingExpiryMessage->text(), 'existing' );
414 $expiryFormOptions->addOption(
415 $context->msg( 'protect-othertime-op' )->text(),
418 foreach ( explode( ',', $scExpiryOptions ) as $option ) {
419 if ( strpos( $option, ":" ) === false ) {
420 $show = $value = $option;
422 list( $show, $value ) = explode( ":", $option );
424 $expiryFormOptions->addOption( $show, htmlspecialchars( $value ) );
426 # Add expiry dropdown
427 if ( $showProtectOptions && !$this->disabled
) {
430 <td class='mw-label'>
433 <td class='mw-input'>" .
434 $expiryFormOptions->getHTML() .
438 # Add custom expiry field
439 $attribs = [ 'id' => "mwProtect-$action-expires" ] +
$this->disabledAttrib
;
441 <td class='mw-label'>" .
444 <td class="mw-input">' .
445 Xml
::input( "mwProtect-expiry-$action", 50, $this->mExpiry
[$action], $attribs ) .
448 $out .= "</td></tr>" .
449 Xml
::closeElement( 'table' ) .
450 Xml
::closeElement( 'fieldset' ) .
453 # Give extensions a chance to add items to the form
454 Hooks
::run( 'ProtectionForm::buildForm', [ $this->mArticle
, &$out ] );
456 $out .= Xml
::closeElement( 'tbody' ) . Xml
::closeElement( 'table' );
458 // JavaScript will add another row with a value-chaining checkbox
459 if ( $this->mTitle
->exists() ) {
460 $out .= Xml
::openElement( 'table', [ 'id' => 'mw-protect-table2' ] ) .
461 Xml
::openElement( 'tbody' );
464 <td class="mw-input">' .
466 $context->msg( 'protect-cascade' )->text(),
469 $this->mCascade
, $this->disabledAttrib
473 $out .= Xml
::closeElement( 'tbody' ) . Xml
::closeElement( 'table' );
476 # Add manual and custom reason field/selects as well as submit
477 if ( !$this->disabled
) {
478 $mProtectreasonother = Xml
::label(
479 $context->msg( 'protectcomment' )->text(),
480 'wpProtectReasonSelection'
483 $mProtectreason = Xml
::label(
484 $context->msg( 'protect-otherreason' )->text(),
488 $reasonDropDown = Xml
::listDropDown( 'wpProtectReasonSelection',
489 wfMessage( 'protect-dropdown' )->inContentLanguage()->text(),
490 wfMessage( 'protect-otherreason-op' )->inContentLanguage()->text(),
491 $this->mReasonSelection
,
492 'mwProtect-reason', 4 );
494 $out .= Xml
::openElement( 'table', [ 'id' => 'mw-protect-table3' ] ) .
495 Xml
::openElement( 'tbody' );
498 <td class='mw-label'>
499 {$mProtectreasonother}
501 <td class='mw-input'>
506 <td class='mw-label'>
509 <td class='mw-input'>" .
510 Xml
::input( 'mwProtect-reason', 60, $this->mReason
, [ 'type' => 'text',
511 'id' => 'mwProtect-reason', 'maxlength' => 180 ] ) .
512 // Limited maxlength as the database trims at 255 bytes and other texts
513 // chosen by dropdown menus on this page are also included in this database field.
514 // The byte limit of 180 bytes is enforced in javascript
517 # Disallow watching is user is not logged in
518 if ( $user->isLoggedIn() ) {
522 <td class='mw-input'>" .
523 Xml
::checkLabel( $context->msg( 'watchthis' )->text(),
524 'mwProtectWatch', 'mwProtectWatch',
525 $user->isWatched( $this->mTitle
) ||
$user->getOption( 'watchdefault' ) ) .
532 <td class='mw-submit'>" .
534 $context->msg( 'confirm' )->text(),
535 [ 'id' => 'mw-Protect-submit' ]
539 $out .= Xml
::closeElement( 'tbody' ) . Xml
::closeElement( 'table' );
541 $out .= Xml
::closeElement( 'fieldset' );
543 if ( $user->isAllowed( 'editinterface' ) ) {
544 $link = Linker
::linkKnown(
545 $context->msg( 'protect-dropdown' )->inContentLanguage()->getTitle(),
546 $context->msg( 'protect-edit-reasonlist' )->escaped(),
548 [ 'action' => 'edit' ]
550 $out .= '<p class="mw-protect-editreasons">' . $link . '</p>';
553 if ( !$this->disabled
) {
554 $out .= Html
::hidden(
556 $user->getEditToken( [ 'protect', $this->mTitle
->getPrefixedDBkey() ] )
558 $out .= Xml
::closeElement( 'form' );
565 * Build protection level selector
567 * @param string $action Action to protect
568 * @param string $selected Current protection level
569 * @return string HTML fragment
571 function buildSelector( $action, $selected ) {
572 // If the form is disabled, display all relevant levels. Otherwise,
573 // just show the ones this user can use.
574 $levels = MWNamespace
::getRestrictionLevels( $this->mTitle
->getNamespace(),
575 $this->disabled ?
null : $this->mContext
->getUser()
578 $id = 'mwProtect-level-' . $action;
580 $select = new XmlSelect( $id, $id, $selected );
581 $select->setAttribute( 'size', count( $levels ) );
582 if ( $this->disabled
) {
583 $select->setAttribute( 'disabled', 'disabled' );
586 foreach ( $levels as $key ) {
587 $select->addOption( $this->getOptionLabel( $key ), $key );
590 return $select->getHTML();
594 * Prepare the label for a protection selector option
596 * @param string $permission Permission required
599 private function getOptionLabel( $permission ) {
600 if ( $permission == '' ) {
601 return $this->mContext
->msg( 'protect-default' )->text();
603 // Messages: protect-level-autoconfirmed, protect-level-sysop
604 $msg = $this->mContext
->msg( "protect-level-{$permission}" );
605 if ( $msg->exists() ) {
608 return $this->mContext
->msg( 'protect-fallback', $permission )->text();
613 * Show protection long extracts for this page
615 * @param OutputPage $out
618 function showLogExtract( &$out ) {
619 # Show relevant lines from the protection log:
620 $protectLogPage = new LogPage( 'protect' );
621 $out->addHTML( Xml
::element( 'h2', null, $protectLogPage->getName()->text() ) );
622 LogEventsList
::showLogExtract( $out, 'protect', $this->mTitle
);
623 # Let extensions add other relevant log extracts
624 Hooks
::run( 'ProtectionForm::showLogExtract', [ $this->mArticle
, $out ] );