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
25 use MediaWiki\MediaWikiServices
;
28 * Handles the page protection UI and backend
30 class ProtectionForm
{
31 /** @var array A map of action to restriction level, from request or default */
32 protected $mRestrictions = [];
34 /** @var string The custom/additional protection reason */
35 protected $mReason = '';
37 /** @var string The reason selected from the list, blank for other/additional */
38 protected $mReasonSelection = '';
40 /** @var bool True if the restrictions are cascading, from request or existing protection */
41 protected $mCascade = false;
43 /** @var array Map of action to "other" expiry time. Used in preference to mExpirySelection. */
44 protected $mExpiry = [];
47 * @var array Map of action to value selected in expiry drop-down list.
48 * Will be set to 'othertime' whenever mExpiry is set.
50 protected $mExpirySelection = [];
52 /** @var array Permissions errors for the protect action */
53 protected $mPermErrors = [];
55 /** @var array Types (i.e. actions) for which levels can be selected */
56 protected $mApplicableTypes = [];
58 /** @var array Map of action to the expiry time of the existing protection */
59 protected $mExistingExpiry = [];
61 /** @var IContextSource */
64 function __construct( Article
$article ) {
65 // Set instance variables.
66 $this->mArticle
= $article;
67 $this->mTitle
= $article->getTitle();
68 $this->mApplicableTypes
= $this->mTitle
->getRestrictionTypes();
69 $this->mContext
= $article->getContext();
71 // Check if the form should be disabled.
72 // If it is, the form will be available in read-only to show levels.
73 $this->mPermErrors
= $this->mTitle
->getUserPermissionsErrors(
75 $this->mContext
->getUser(),
76 $this->mContext
->getRequest()->wasPosted() ?
'secure' : 'full' // T92357
79 $this->mPermErrors
[] = [ 'readonlytext', wfReadOnlyReason() ];
81 $this->disabled
= $this->mPermErrors
!= [];
82 $this->disabledAttrib
= $this->disabled
83 ?
[ 'disabled' => 'disabled' ]
90 * Loads the current state of protection into the object.
93 $levels = MWNamespace
::getRestrictionLevels(
94 $this->mTitle
->getNamespace(), $this->mContext
->getUser()
96 $this->mCascade
= $this->mTitle
->areRestrictionsCascading();
98 $request = $this->mContext
->getRequest();
99 $this->mReason
= $request->getText( 'mwProtect-reason' );
100 $this->mReasonSelection
= $request->getText( 'wpProtectReasonSelection' );
101 $this->mCascade
= $request->getBool( 'mwProtect-cascade', $this->mCascade
);
103 foreach ( $this->mApplicableTypes
as $action ) {
104 // @todo FIXME: This form currently requires individual selections,
105 // but the db allows multiples separated by commas.
107 // Pull the actual restriction from the DB
108 $this->mRestrictions
[$action] = implode( '', $this->mTitle
->getRestrictions( $action ) );
110 if ( !$this->mRestrictions
[$action] ) {
111 // No existing expiry
112 $existingExpiry = '';
114 $existingExpiry = $this->mTitle
->getRestrictionExpiry( $action );
116 $this->mExistingExpiry
[$action] = $existingExpiry;
118 $requestExpiry = $request->getText( "mwProtect-expiry-$action" );
119 $requestExpirySelection = $request->getVal( "wpProtectExpirySelection-$action" );
121 if ( $requestExpiry ) {
122 // Custom expiry takes precedence
123 $this->mExpiry
[$action] = $requestExpiry;
124 $this->mExpirySelection
[$action] = 'othertime';
125 } elseif ( $requestExpirySelection ) {
126 // Expiry selected from list
127 $this->mExpiry
[$action] = '';
128 $this->mExpirySelection
[$action] = $requestExpirySelection;
129 } elseif ( $existingExpiry ) {
130 // Use existing expiry in its own list item
131 $this->mExpiry
[$action] = '';
132 $this->mExpirySelection
[$action] = $existingExpiry;
134 // Catches 'infinity' - Existing expiry is infinite, use "infinite" in drop-down
135 // Final default: infinite
136 $this->mExpiry
[$action] = '';
137 $this->mExpirySelection
[$action] = 'infinite';
140 $val = $request->getVal( "mwProtect-level-$action" );
141 if ( isset( $val ) && in_array( $val, $levels ) ) {
142 $this->mRestrictions
[$action] = $val;
148 * Get the expiry time for a given action, by combining the relevant inputs.
150 * @param string $action
152 * @return string|false 14-char timestamp or "infinity", or false if the input was invalid
154 function getExpiry( $action ) {
155 if ( $this->mExpirySelection
[$action] == 'existing' ) {
156 return $this->mExistingExpiry
[$action];
157 } elseif ( $this->mExpirySelection
[$action] == 'othertime' ) {
158 $value = $this->mExpiry
[$action];
160 $value = $this->mExpirySelection
[$action];
162 if ( wfIsInfinity( $value ) ) {
165 $unix = strtotime( $value );
167 if ( !$unix ||
$unix === -1 ) {
171 // @todo FIXME: Non-qualified absolute times are not in users specified timezone
172 // and there isn't notice about it in the ui
173 $time = wfTimestamp( TS_MW
, $unix );
179 * Main entry point for action=protect and action=unprotect
182 if ( MWNamespace
::getRestrictionLevels( $this->mTitle
->getNamespace() ) === [ '' ] ) {
183 throw new ErrorPageError( 'protect-badnamespace-title', 'protect-badnamespace-text' );
186 if ( $this->mContext
->getRequest()->wasPosted() ) {
187 if ( $this->save() ) {
188 $q = $this->mArticle
->isRedirect() ?
'redirect=no' : '';
189 $this->mContext
->getOutput()->redirect( $this->mTitle
->getFullURL( $q ) );
197 * Show the input form with optional error message
199 * @param string|null $err Error message or null if there's no error
201 function show( $err = null ) {
202 $out = $this->mContext
->getOutput();
203 $out->setRobotPolicy( 'noindex,nofollow' );
204 $out->addBacklinkSubtitle( $this->mTitle
);
206 if ( is_array( $err ) ) {
207 $out->wrapWikiMsg( "<p class='error'>\n$1\n</p>\n", $err );
208 } elseif ( is_string( $err ) ) {
209 $out->addHTML( "<p class='error'>{$err}</p>\n" );
212 if ( $this->mTitle
->getRestrictionTypes() === [] ) {
213 // No restriction types available for the current title
214 // this might happen if an extension alters the available types
215 $out->setPageTitle( $this->mContext
->msg(
216 'protect-norestrictiontypes-title',
217 $this->mTitle
->getPrefixedText()
219 $out->addWikiText( $this->mContext
->msg( 'protect-norestrictiontypes-text' )->plain() );
221 // Show the log in case protection was possible once
222 $this->showLogExtract( $out );
223 // return as there isn't anything else we can do
227 list( $cascadeSources, /* $restrictions */ ) = $this->mTitle
->getCascadeProtectionSources();
228 if ( $cascadeSources && count( $cascadeSources ) > 0 ) {
231 foreach ( $cascadeSources as $title ) {
232 $titles .= '* [[:' . $title->getPrefixedText() . "]]\n";
235 /** @todo FIXME: i18n issue, should use formatted number. */
237 "<div id=\"mw-protect-cascadeon\">\n$1\n" . $titles . "</div>",
238 [ 'protect-cascadeon', count( $cascadeSources ) ]
242 # Show an appropriate message if the user isn't allowed or able to change
243 # the protection settings at this time
244 if ( $this->disabled
) {
246 $this->mContext
->msg( 'protect-title-notallowed',
247 $this->mTitle
->getPrefixedText() )
249 $out->addWikiText( $out->formatPermissionsErrorMessage( $this->mPermErrors
, 'protect' ) );
251 $out->setPageTitle( $this->mContext
->msg( 'protect-title', $this->mTitle
->getPrefixedText() ) );
252 $out->addWikiMsg( 'protect-text',
253 wfEscapeWikiText( $this->mTitle
->getPrefixedText() ) );
256 $out->addHTML( $this->buildForm() );
257 $this->showLogExtract( $out );
261 * Save submitted protection form
263 * @return bool Success
267 if ( $this->disabled
) {
272 $request = $this->mContext
->getRequest();
273 $user = $this->mContext
->getUser();
274 $out = $this->mContext
->getOutput();
275 $token = $request->getVal( 'wpEditToken' );
276 if ( !$user->matchEditToken( $token, [ 'protect', $this->mTitle
->getPrefixedDBkey() ] ) ) {
277 $this->show( [ '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 .= $this->mContext
->msg( '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( [ 'protect_expiry_invalid' ] );
299 if ( $expiry[$action] < wfTimestampNow() ) {
300 $this->show( [ 'protect_expiry_old' ] );
305 $this->mCascade
= $request->getBool( 'mwProtect-cascade' );
307 $status = $this->mArticle
->doUpdateRestrictions(
308 $this->mRestrictions
,
315 if ( !$status->isOK() ) {
316 $this->show( $out->parseInline( $status->getWikiText() ) );
321 * Give extensions a change to handle added form items
323 * @since 1.19 you can (and you should) return false to abort saving;
324 * you can also return an array of message name and its parameters
327 if ( !Hooks
::run( 'ProtectionForm::save', [ $this->mArticle
, &$errorMsg, $reasonstr ] ) ) {
328 if ( $errorMsg == '' ) {
329 $errorMsg = [ 'hookaborted' ];
332 if ( $errorMsg != '' ) {
333 $this->show( $errorMsg );
337 WatchAction
::doWatchOrUnwatch( $request->getCheck( 'mwProtectWatch' ), $this->mTitle
, $user );
343 * Build the input form
345 * @return string HTML form
347 function buildForm() {
348 $context = $this->mContext
;
349 $user = $context->getUser();
350 $output = $context->getOutput();
351 $lang = $context->getLanguage();
352 $conf = $context->getConfig();
353 $cascadingRestrictionLevels = $conf->get( 'CascadingRestrictionLevels' );
354 $oldCommentSchema = $conf->get( 'CommentTableSchemaMigrationStage' ) === MIGRATION_OLD
;
356 if ( !$this->disabled
) {
357 $output->addModules( 'mediawiki.legacy.protect' );
358 $output->addJsConfigVars( 'wgCascadeableLevels', $cascadingRestrictionLevels );
359 $out .= Xml
::openElement( 'form', [ 'method' => 'post',
360 'action' => $this->mTitle
->getLocalURL( 'action=protect' ),
361 'id' => 'mw-Protect-Form' ] );
364 $out .= Xml
::openElement( 'fieldset' ) .
365 Xml
::element( 'legend', null, $context->msg( 'protect-legend' )->text() ) .
366 Xml
::openElement( 'table', [ 'id' => 'mwProtectSet' ] ) .
367 Xml
::openElement( 'tbody' );
369 $scExpiryOptions = wfMessage( 'protect-expiry-options' )->inContentLanguage()->text();
370 $showProtectOptions = $scExpiryOptions !== '-' && !$this->disabled
;
372 // Not all languages have V_x <-> N_x relation
373 foreach ( $this->mRestrictions
as $action => $selected ) {
375 // restriction-edit, restriction-move, restriction-create, restriction-upload
376 $msg = $context->msg( 'restriction-' . $action );
378 Xml
::openElement( 'fieldset' ) .
379 Xml
::element( 'legend', null, $msg->exists() ?
$msg->text() : $action ) .
380 Xml
::openElement( 'table', [ 'id' => "mw-protect-table-$action" ] ) .
381 "<tr><td>" . $this->buildSelector( $action, $selected ) . "</td></tr><tr><td>";
383 $mProtectexpiry = Xml
::label(
384 $context->msg( 'protectexpiry' )->text(),
385 "mwProtectExpirySelection-$action"
387 $mProtectother = Xml
::label(
388 $context->msg( 'protect-othertime' )->text(),
389 "mwProtect-$action-expires"
392 $expiryFormOptions = new XmlSelect(
393 "wpProtectExpirySelection-$action",
394 "mwProtectExpirySelection-$action",
395 $this->mExpirySelection
[$action]
397 $expiryFormOptions->setAttribute( 'tabindex', '2' );
398 if ( $this->disabled
) {
399 $expiryFormOptions->setAttribute( 'disabled', 'disabled' );
402 if ( $this->mExistingExpiry
[$action] ) {
403 if ( $this->mExistingExpiry
[$action] == 'infinity' ) {
404 $existingExpiryMessage = $context->msg( 'protect-existing-expiry-infinity' );
406 $timestamp = $lang->userTimeAndDate( $this->mExistingExpiry
[$action], $user );
407 $d = $lang->userDate( $this->mExistingExpiry
[$action], $user );
408 $t = $lang->userTime( $this->mExistingExpiry
[$action], $user );
409 $existingExpiryMessage = $context->msg(
410 'protect-existing-expiry',
416 $expiryFormOptions->addOption( $existingExpiryMessage->text(), 'existing' );
419 $expiryFormOptions->addOption(
420 $context->msg( 'protect-othertime-op' )->text(),
423 foreach ( explode( ',', $scExpiryOptions ) as $option ) {
424 if ( strpos( $option, ":" ) === false ) {
425 $show = $value = $option;
427 list( $show, $value ) = explode( ":", $option );
429 $expiryFormOptions->addOption( $show, htmlspecialchars( $value ) );
431 # Add expiry dropdown
432 if ( $showProtectOptions && !$this->disabled
) {
435 <td class='mw-label'>
438 <td class='mw-input'>" .
439 $expiryFormOptions->getHTML() .
443 # Add custom expiry field
444 $attribs = [ 'id' => "mwProtect-$action-expires" ] +
$this->disabledAttrib
;
446 <td class='mw-label'>" .
449 <td class="mw-input">' .
450 Xml
::input( "mwProtect-expiry-$action", 50, $this->mExpiry
[$action], $attribs ) .
453 $out .= "</td></tr>" .
454 Xml
::closeElement( 'table' ) .
455 Xml
::closeElement( 'fieldset' ) .
458 # Give extensions a chance to add items to the form
459 Hooks
::run( 'ProtectionForm::buildForm', [ $this->mArticle
, &$out ] );
461 $out .= Xml
::closeElement( 'tbody' ) . Xml
::closeElement( 'table' );
463 // JavaScript will add another row with a value-chaining checkbox
464 if ( $this->mTitle
->exists() ) {
465 $out .= Xml
::openElement( 'table', [ 'id' => 'mw-protect-table2' ] ) .
466 Xml
::openElement( 'tbody' );
469 <td class="mw-input">' .
471 $context->msg( 'protect-cascade' )->text(),
474 $this->mCascade
, $this->disabledAttrib
478 $out .= Xml
::closeElement( 'tbody' ) . Xml
::closeElement( 'table' );
481 # Add manual and custom reason field/selects as well as submit
482 if ( !$this->disabled
) {
483 $mProtectreasonother = Xml
::label(
484 $context->msg( 'protectcomment' )->text(),
485 'wpProtectReasonSelection'
488 $mProtectreason = Xml
::label(
489 $context->msg( 'protect-otherreason' )->text(),
493 $reasonDropDown = Xml
::listDropDown( 'wpProtectReasonSelection',
494 wfMessage( 'protect-dropdown' )->inContentLanguage()->text(),
495 wfMessage( 'protect-otherreason-op' )->inContentLanguage()->text(),
496 $this->mReasonSelection
,
497 'mwProtect-reason', 4 );
499 // HTML maxlength uses "UTF-16 code units", which means that characters outside BMP
500 // (e.g. emojis) count for two each. This limit is overridden in JS to instead count
501 // Unicode codepoints (or 180 UTF-8 bytes for old schema).
502 // Subtract arbitrary 75 to leave some space for the autogenerated null edit's summary
503 // and other texts chosen by dropdown menus on this page.
504 $maxlength = $oldCommentSchema ?
180 : CommentStore
::COMMENT_CHARACTER_LIMIT
- 75;
506 $out .= Xml
::openElement( 'table', [ 'id' => 'mw-protect-table3' ] ) .
507 Xml
::openElement( 'tbody' );
510 <td class='mw-label'>
511 {$mProtectreasonother}
513 <td class='mw-input'>
518 <td class='mw-label'>
521 <td class='mw-input'>" .
522 Xml
::input( 'mwProtect-reason', 60, $this->mReason
, [ 'type' => 'text',
523 'id' => 'mwProtect-reason', 'maxlength' => $maxlength ] ) .
526 # Disallow watching is user is not logged in
527 if ( $user->isLoggedIn() ) {
531 <td class='mw-input'>" .
532 Xml
::checkLabel( $context->msg( 'watchthis' )->text(),
533 'mwProtectWatch', 'mwProtectWatch',
534 $user->isWatched( $this->mTitle
) ||
$user->getOption( 'watchdefault' ) ) .
541 <td class='mw-submit'>" .
543 $context->msg( 'confirm' )->text(),
544 [ 'id' => 'mw-Protect-submit' ]
548 $out .= Xml
::closeElement( 'tbody' ) . Xml
::closeElement( 'table' );
550 $out .= Xml
::closeElement( 'fieldset' );
552 if ( $user->isAllowed( 'editinterface' ) ) {
553 $linkRenderer = MediaWikiServices
::getInstance()->getLinkRenderer();
554 $link = $linkRenderer->makeKnownLink(
555 $context->msg( 'protect-dropdown' )->inContentLanguage()->getTitle(),
556 $context->msg( 'protect-edit-reasonlist' )->text(),
558 [ 'action' => 'edit' ]
560 $out .= '<p class="mw-protect-editreasons">' . $link . '</p>';
563 if ( !$this->disabled
) {
564 $out .= Html
::hidden(
566 $user->getEditToken( [ 'protect', $this->mTitle
->getPrefixedDBkey() ] )
568 $out .= Xml
::closeElement( 'form' );
575 * Build protection level selector
577 * @param string $action Action to protect
578 * @param string $selected Current protection level
579 * @return string HTML fragment
581 function buildSelector( $action, $selected ) {
582 // If the form is disabled, display all relevant levels. Otherwise,
583 // just show the ones this user can use.
584 $levels = MWNamespace
::getRestrictionLevels( $this->mTitle
->getNamespace(),
585 $this->disabled ?
null : $this->mContext
->getUser()
588 $id = 'mwProtect-level-' . $action;
590 $select = new XmlSelect( $id, $id, $selected );
591 $select->setAttribute( 'size', count( $levels ) );
592 if ( $this->disabled
) {
593 $select->setAttribute( 'disabled', 'disabled' );
596 foreach ( $levels as $key ) {
597 $select->addOption( $this->getOptionLabel( $key ), $key );
600 return $select->getHTML();
604 * Prepare the label for a protection selector option
606 * @param string $permission Permission required
609 private function getOptionLabel( $permission ) {
610 if ( $permission == '' ) {
611 return $this->mContext
->msg( 'protect-default' )->text();
613 // Messages: protect-level-autoconfirmed, protect-level-sysop
614 $msg = $this->mContext
->msg( "protect-level-{$permission}" );
615 if ( $msg->exists() ) {
618 return $this->mContext
->msg( 'protect-fallback', $permission )->text();
623 * Show protection long extracts for this page
625 * @param OutputPage &$out
628 function showLogExtract( &$out ) {
629 # Show relevant lines from the protection log:
630 $protectLogPage = new LogPage( 'protect' );
631 $out->addHTML( Xml
::element( 'h2', null, $protectLogPage->getName()->text() ) );
632 LogEventsList
::showLogExtract( $out, 'protect', $this->mTitle
);
633 # Let extensions add other relevant log extracts
634 Hooks
::run( 'ProtectionForm::showLogExtract', [ $this->mArticle
, $out ] );