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 = [];
71 protected $disabledAttrib;
73 /** @var IContextSource */
76 function __construct( Article
$article ) {
77 // Set instance variables.
78 $this->mArticle
= $article;
79 $this->mTitle
= $article->getTitle();
80 $this->mApplicableTypes
= $this->mTitle
->getRestrictionTypes();
81 $this->mContext
= $article->getContext();
83 // Check if the form should be disabled.
84 // If it is, the form will be available in read-only to show levels.
85 $this->mPermErrors
= $this->mTitle
->getUserPermissionsErrors(
87 $this->mContext
->getUser(),
88 $this->mContext
->getRequest()->wasPosted() ?
'secure' : 'full' // T92357
91 $this->mPermErrors
[] = [ 'readonlytext', wfReadOnlyReason() ];
93 $this->disabled
= $this->mPermErrors
!== [];
94 $this->disabledAttrib
= $this->disabled
95 ?
[ 'disabled' => 'disabled' ]
102 * Loads the current state of protection into the object.
104 function loadData() {
105 $levels = MediaWikiServices
::getInstance()->getPermissionManager()->getNamespaceRestrictionLevels(
106 $this->mTitle
->getNamespace(), $this->mContext
->getUser()
108 $this->mCascade
= $this->mTitle
->areRestrictionsCascading();
110 $request = $this->mContext
->getRequest();
111 $this->mReason
= $request->getText( 'mwProtect-reason' );
112 $this->mReasonSelection
= $request->getText( 'wpProtectReasonSelection' );
113 $this->mCascade
= $request->getBool( 'mwProtect-cascade', $this->mCascade
);
115 foreach ( $this->mApplicableTypes
as $action ) {
116 // @todo FIXME: This form currently requires individual selections,
117 // but the db allows multiples separated by commas.
119 // Pull the actual restriction from the DB
120 $this->mRestrictions
[$action] = implode( '', $this->mTitle
->getRestrictions( $action ) );
122 if ( !$this->mRestrictions
[$action] ) {
123 // No existing expiry
124 $existingExpiry = '';
126 $existingExpiry = $this->mTitle
->getRestrictionExpiry( $action );
128 $this->mExistingExpiry
[$action] = $existingExpiry;
130 $requestExpiry = $request->getText( "mwProtect-expiry-$action" );
131 $requestExpirySelection = $request->getVal( "wpProtectExpirySelection-$action" );
133 if ( $requestExpiry ) {
134 // Custom expiry takes precedence
135 $this->mExpiry
[$action] = $requestExpiry;
136 $this->mExpirySelection
[$action] = 'othertime';
137 } elseif ( $requestExpirySelection ) {
138 // Expiry selected from list
139 $this->mExpiry
[$action] = '';
140 $this->mExpirySelection
[$action] = $requestExpirySelection;
141 } elseif ( $existingExpiry ) {
142 // Use existing expiry in its own list item
143 $this->mExpiry
[$action] = '';
144 $this->mExpirySelection
[$action] = $existingExpiry;
146 // Catches 'infinity' - Existing expiry is infinite, use "infinite" in drop-down
147 // Final default: infinite
148 $this->mExpiry
[$action] = '';
149 $this->mExpirySelection
[$action] = 'infinite';
152 $val = $request->getVal( "mwProtect-level-$action" );
153 if ( isset( $val ) && in_array( $val, $levels ) ) {
154 $this->mRestrictions
[$action] = $val;
160 * Get the expiry time for a given action, by combining the relevant inputs.
162 * @param string $action
164 * @return string|false 14-char timestamp or "infinity", or false if the input was invalid
166 function getExpiry( $action ) {
167 if ( $this->mExpirySelection
[$action] == 'existing' ) {
168 return $this->mExistingExpiry
[$action];
169 } elseif ( $this->mExpirySelection
[$action] == 'othertime' ) {
170 $value = $this->mExpiry
[$action];
172 $value = $this->mExpirySelection
[$action];
174 if ( wfIsInfinity( $value ) ) {
177 $unix = strtotime( $value );
179 if ( !$unix ||
$unix === -1 ) {
183 // @todo FIXME: Non-qualified absolute times are not in users specified timezone
184 // and there isn't notice about it in the ui
185 $time = wfTimestamp( TS_MW
, $unix );
191 * Main entry point for action=protect and action=unprotect
195 MediaWikiServices
::getInstance()->getPermissionManager()->getNamespaceRestrictionLevels(
196 $this->mTitle
->getNamespace()
199 throw new ErrorPageError( 'protect-badnamespace-title', 'protect-badnamespace-text' );
202 if ( $this->mContext
->getRequest()->wasPosted() ) {
203 if ( $this->save() ) {
204 $q = $this->mArticle
->isRedirect() ?
'redirect=no' : '';
205 $this->mContext
->getOutput()->redirect( $this->mTitle
->getFullURL( $q ) );
213 * Show the input form with optional error message
215 * @param string|string[]|null $err Error message or null if there's no error
217 function show( $err = null ) {
218 $out = $this->mContext
->getOutput();
219 $out->setRobotPolicy( 'noindex,nofollow' );
220 $out->addBacklinkSubtitle( $this->mTitle
);
222 if ( is_array( $err ) ) {
223 $out->wrapWikiMsg( "<div class='error'>\n$1\n</div>\n", $err );
224 } elseif ( is_string( $err ) ) {
225 $out->addHTML( "<div class='error'>{$err}</div>\n" );
228 if ( $this->mTitle
->getRestrictionTypes() === [] ) {
229 // No restriction types available for the current title
230 // this might happen if an extension alters the available types
231 $out->setPageTitle( $this->mContext
->msg(
232 'protect-norestrictiontypes-title',
233 $this->mTitle
->getPrefixedText()
235 $out->addWikiTextAsInterface(
236 $this->mContext
->msg( 'protect-norestrictiontypes-text' )->plain()
239 // Show the log in case protection was possible once
240 $this->showLogExtract( $out );
241 // return as there isn't anything else we can do
245 list( $cascadeSources, /* $restrictions */ ) = $this->mTitle
->getCascadeProtectionSources();
246 if ( $cascadeSources && count( $cascadeSources ) > 0 ) {
249 foreach ( $cascadeSources as $title ) {
250 $titles .= '* [[:' . $title->getPrefixedText() . "]]\n";
253 /** @todo FIXME: i18n issue, should use formatted number. */
255 "<div id=\"mw-protect-cascadeon\">\n$1\n" . $titles . "</div>",
256 [ 'protect-cascadeon', count( $cascadeSources ) ]
260 # Show an appropriate message if the user isn't allowed or able to change
261 # the protection settings at this time
262 if ( $this->disabled
) {
264 $this->mContext
->msg( 'protect-title-notallowed',
265 $this->mTitle
->getPrefixedText() )
267 $out->addWikiTextAsInterface( $out->formatPermissionsErrorMessage(
268 $this->mPermErrors
, 'protect'
271 $out->setPageTitle( $this->mContext
->msg( 'protect-title', $this->mTitle
->getPrefixedText() ) );
272 $out->addWikiMsg( 'protect-text',
273 wfEscapeWikiText( $this->mTitle
->getPrefixedText() ) );
276 $out->addHTML( $this->buildForm() );
277 $this->showLogExtract( $out );
281 * Save submitted protection form
283 * @return bool Success
287 if ( $this->disabled
) {
292 $request = $this->mContext
->getRequest();
293 $user = $this->mContext
->getUser();
294 $out = $this->mContext
->getOutput();
295 $token = $request->getVal( 'wpEditToken' );
296 if ( !$user->matchEditToken( $token, [ 'protect', $this->mTitle
->getPrefixedDBkey() ] ) ) {
297 $this->show( [ 'sessionfailure' ] );
301 # Create reason string. Use list and/or custom string.
302 $reasonstr = $this->mReasonSelection
;
303 if ( $reasonstr != 'other' && $this->mReason
!= '' ) {
304 // Entry from drop down menu + additional comment
305 $reasonstr .= $this->mContext
->msg( 'colon-separator' )->text() . $this->mReason
;
306 } elseif ( $reasonstr == 'other' ) {
307 $reasonstr = $this->mReason
;
310 foreach ( $this->mApplicableTypes
as $action ) {
311 $expiry[$action] = $this->getExpiry( $action );
312 if ( empty( $this->mRestrictions
[$action] ) ) {
313 continue; // unprotected
315 if ( !$expiry[$action] ) {
316 $this->show( [ 'protect_expiry_invalid' ] );
319 if ( $expiry[$action] < wfTimestampNow() ) {
320 $this->show( [ 'protect_expiry_old' ] );
325 $this->mCascade
= $request->getBool( 'mwProtect-cascade' );
327 $status = $this->mArticle
->doUpdateRestrictions(
328 $this->mRestrictions
,
335 if ( !$status->isOK() ) {
336 $this->show( $out->parseInlineAsInterface(
337 $status->getWikiText( false, false, $this->mContext
->getLanguage() )
343 * Give extensions a change to handle added form items
345 * @since 1.19 you can (and you should) return false to abort saving;
346 * you can also return an array of message name and its parameters
349 if ( !Hooks
::run( 'ProtectionForm::save', [ $this->mArticle
, &$errorMsg, $reasonstr ] ) ) {
350 if ( $errorMsg == '' ) {
351 $errorMsg = [ 'hookaborted' ];
354 if ( $errorMsg != '' ) {
355 $this->show( $errorMsg );
359 WatchAction
::doWatchOrUnwatch( $request->getCheck( 'mwProtectWatch' ), $this->mTitle
, $user );
365 * Build the input form
367 * @return string HTML form
369 function buildForm() {
370 $context = $this->mContext
;
371 $user = $context->getUser();
372 $output = $context->getOutput();
373 $lang = $context->getLanguage();
375 if ( !$this->disabled
) {
376 $output->addModules( 'mediawiki.legacy.protect' );
377 $out .= Xml
::openElement( 'form', [ 'method' => 'post',
378 'action' => $this->mTitle
->getLocalURL( 'action=protect' ),
379 'id' => 'mw-Protect-Form' ] );
382 $out .= Xml
::openElement( 'fieldset' ) .
383 Xml
::element( 'legend', null, $context->msg( 'protect-legend' )->text() ) .
384 Xml
::openElement( 'table', [ 'id' => 'mwProtectSet' ] ) .
385 Xml
::openElement( 'tbody' );
387 $scExpiryOptions = wfMessage( 'protect-expiry-options' )->inContentLanguage()->text();
388 $showProtectOptions = $scExpiryOptions !== '-' && !$this->disabled
;
390 // Not all languages have V_x <-> N_x relation
391 foreach ( $this->mRestrictions
as $action => $selected ) {
393 // restriction-edit, restriction-move, restriction-create, restriction-upload
394 $msg = $context->msg( 'restriction-' . $action );
396 Xml
::openElement( 'fieldset' ) .
397 Xml
::element( 'legend', null, $msg->exists() ?
$msg->text() : $action ) .
398 Xml
::openElement( 'table', [ 'id' => "mw-protect-table-$action" ] ) .
399 "<tr><td>" . $this->buildSelector( $action, $selected ) . "</td></tr><tr><td>";
401 $mProtectexpiry = Xml
::label(
402 $context->msg( 'protectexpiry' )->text(),
403 "mwProtectExpirySelection-$action"
405 $mProtectother = Xml
::label(
406 $context->msg( 'protect-othertime' )->text(),
407 "mwProtect-$action-expires"
410 $expiryFormOptions = new XmlSelect(
411 "wpProtectExpirySelection-$action",
412 "mwProtectExpirySelection-$action",
413 $this->mExpirySelection
[$action]
415 $expiryFormOptions->setAttribute( 'tabindex', '2' );
416 if ( $this->disabled
) {
417 $expiryFormOptions->setAttribute( 'disabled', 'disabled' );
420 if ( $this->mExistingExpiry
[$action] ) {
421 if ( $this->mExistingExpiry
[$action] == 'infinity' ) {
422 $existingExpiryMessage = $context->msg( 'protect-existing-expiry-infinity' );
424 $timestamp = $lang->userTimeAndDate( $this->mExistingExpiry
[$action], $user );
425 $d = $lang->userDate( $this->mExistingExpiry
[$action], $user );
426 $t = $lang->userTime( $this->mExistingExpiry
[$action], $user );
427 $existingExpiryMessage = $context->msg(
428 'protect-existing-expiry',
434 $expiryFormOptions->addOption( $existingExpiryMessage->text(), 'existing' );
437 $expiryFormOptions->addOption(
438 $context->msg( 'protect-othertime-op' )->text(),
441 foreach ( explode( ',', $scExpiryOptions ) as $option ) {
442 if ( strpos( $option, ":" ) === false ) {
443 $show = $value = $option;
445 list( $show, $value ) = explode( ":", $option );
447 $expiryFormOptions->addOption( $show, htmlspecialchars( $value ) );
449 # Add expiry dropdown
450 if ( $showProtectOptions && !$this->disabled
) {
453 <td class='mw-label'>
456 <td class='mw-input'>" .
457 $expiryFormOptions->getHTML() .
461 # Add custom expiry field
462 $attribs = [ 'id' => "mwProtect-$action-expires" ] +
$this->disabledAttrib
;
464 <td class='mw-label'>" .
467 <td class="mw-input">' .
468 Xml
::input( "mwProtect-expiry-$action", 50, $this->mExpiry
[$action], $attribs ) .
471 $out .= "</td></tr>" .
472 Xml
::closeElement( 'table' ) .
473 Xml
::closeElement( 'fieldset' ) .
476 # Give extensions a chance to add items to the form
477 Hooks
::run( 'ProtectionForm::buildForm', [ $this->mArticle
, &$out ] );
479 $out .= Xml
::closeElement( 'tbody' ) . Xml
::closeElement( 'table' );
481 // JavaScript will add another row with a value-chaining checkbox
482 if ( $this->mTitle
->exists() ) {
483 $out .= Xml
::openElement( 'table', [ 'id' => 'mw-protect-table2' ] ) .
484 Xml
::openElement( 'tbody' );
487 <td class="mw-input">' .
489 $context->msg( 'protect-cascade' )->text(),
492 $this->mCascade
, $this->disabledAttrib
496 $out .= Xml
::closeElement( 'tbody' ) . Xml
::closeElement( 'table' );
499 # Add manual and custom reason field/selects as well as submit
500 if ( !$this->disabled
) {
501 $mProtectreasonother = Xml
::label(
502 $context->msg( 'protectcomment' )->text(),
503 'wpProtectReasonSelection'
506 $mProtectreason = Xml
::label(
507 $context->msg( 'protect-otherreason' )->text(),
511 $reasonDropDown = Xml
::listDropDown( 'wpProtectReasonSelection',
512 wfMessage( 'protect-dropdown' )->inContentLanguage()->text(),
513 wfMessage( 'protect-otherreason-op' )->inContentLanguage()->text(),
514 $this->mReasonSelection
,
515 'mwProtect-reason', 4 );
517 // HTML maxlength uses "UTF-16 code units", which means that characters outside BMP
518 // (e.g. emojis) count for two each. This limit is overridden in JS to instead count
519 // Unicode codepoints.
520 // Subtract arbitrary 75 to leave some space for the autogenerated null edit's summary
521 // and other texts chosen by dropdown menus on this page.
522 $maxlength = CommentStore
::COMMENT_CHARACTER_LIMIT
- 75;
524 $out .= Xml
::openElement( 'table', [ 'id' => 'mw-protect-table3' ] ) .
525 Xml
::openElement( 'tbody' );
528 <td class='mw-label'>
529 {$mProtectreasonother}
531 <td class='mw-input'>
536 <td class='mw-label'>
539 <td class='mw-input'>" .
540 Xml
::input( 'mwProtect-reason', 60, $this->mReason
, [ 'type' => 'text',
541 'id' => 'mwProtect-reason', 'maxlength' => $maxlength ] ) .
544 # Disallow watching is user is not logged in
545 if ( $user->isLoggedIn() ) {
549 <td class='mw-input'>" .
550 Xml
::checkLabel( $context->msg( 'watchthis' )->text(),
551 'mwProtectWatch', 'mwProtectWatch',
552 $user->isWatched( $this->mTitle
) ||
$user->getOption( 'watchdefault' ) ) .
559 <td class='mw-submit'>" .
561 $context->msg( 'confirm' )->text(),
562 [ 'id' => 'mw-Protect-submit' ]
566 $out .= Xml
::closeElement( 'tbody' ) . Xml
::closeElement( 'table' );
568 $out .= Xml
::closeElement( 'fieldset' );
570 if ( MediaWikiServices
::getInstance()->getPermissionManager()
571 ->userHasRight( $user, 'editinterface' ) ) {
572 $linkRenderer = MediaWikiServices
::getInstance()->getLinkRenderer();
573 $link = $linkRenderer->makeKnownLink(
574 $context->msg( 'protect-dropdown' )->inContentLanguage()->getTitle(),
575 $context->msg( 'protect-edit-reasonlist' )->text(),
577 [ 'action' => 'edit' ]
579 $out .= '<p class="mw-protect-editreasons">' . $link . '</p>';
582 if ( !$this->disabled
) {
583 $out .= Html
::hidden(
585 $user->getEditToken( [ 'protect', $this->mTitle
->getPrefixedDBkey() ] )
587 $out .= Xml
::closeElement( 'form' );
594 * Build protection level selector
596 * @param string $action Action to protect
597 * @param string $selected Current protection level
598 * @return string HTML fragment
600 function buildSelector( $action, $selected ) {
601 // If the form is disabled, display all relevant levels. Otherwise,
602 // just show the ones this user can use.
603 $levels = MediaWikiServices
::getInstance()
604 ->getPermissionManager()
605 ->getNamespaceRestrictionLevels(
606 $this->mTitle
->getNamespace(),
607 $this->disabled ?
null : $this->mContext
->getUser()
610 $id = 'mwProtect-level-' . $action;
612 $select = new XmlSelect( $id, $id, $selected );
613 $select->setAttribute( 'size', count( $levels ) );
614 if ( $this->disabled
) {
615 $select->setAttribute( 'disabled', 'disabled' );
618 foreach ( $levels as $key ) {
619 $select->addOption( $this->getOptionLabel( $key ), $key );
622 return $select->getHTML();
626 * Prepare the label for a protection selector option
628 * @param string $permission Permission required
631 private function getOptionLabel( $permission ) {
632 if ( $permission == '' ) {
633 return $this->mContext
->msg( 'protect-default' )->text();
635 // Messages: protect-level-autoconfirmed, protect-level-sysop
636 $msg = $this->mContext
->msg( "protect-level-{$permission}" );
637 if ( $msg->exists() ) {
640 return $this->mContext
->msg( 'protect-fallback', $permission )->text();
645 * Show protection long extracts for this page
647 * @param OutputPage $out
649 private function showLogExtract( OutputPage
$out ) {
650 # Show relevant lines from the protection log:
651 $protectLogPage = new LogPage( 'protect' );
652 $out->addHTML( Xml
::element( 'h2', null, $protectLogPage->getName()->text() ) );
653 LogEventsList
::showLogExtract( $out, 'protect', $this->mTitle
);
654 # Let extensions add other relevant log extracts
655 Hooks
::run( 'ProtectionForm::showLogExtract', [ $this->mArticle
, $out ] );