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 $out = $this->mContext
->getOutput();
187 if ( !wfMessage( 'protect-dropdown' )->inContentLanguage()->isDisabled() ) {
188 $reasonsList = Xml
::getArrayFromWikiTextList(
189 wfMessage( 'protect-dropdown' )->inContentLanguage()->text()
191 $out->addModules( 'mediawiki.reasonSuggest' );
192 $out->addJsConfigVars( [
193 'reasons' => $reasonsList
197 if ( $this->mContext
->getRequest()->wasPosted() ) {
198 if ( $this->save() ) {
199 $q = $this->mArticle
->isRedirect() ?
'redirect=no' : '';
200 $out->redirect( $this->mTitle
->getFullURL( $q ) );
208 * Show the input form with optional error message
210 * @param string $err Error message or null if there's no error
212 function show( $err = null ) {
213 $out = $this->mContext
->getOutput();
214 $out->setRobotPolicy( 'noindex,nofollow' );
215 $out->addBacklinkSubtitle( $this->mTitle
);
217 if ( is_array( $err ) ) {
218 $out->wrapWikiMsg( "<p class='error'>\n$1\n</p>\n", $err );
219 } elseif ( is_string( $err ) ) {
220 $out->addHTML( "<p class='error'>{$err}</p>\n" );
223 if ( $this->mTitle
->getRestrictionTypes() === [] ) {
224 // No restriction types available for the current title
225 // this might happen if an extension alters the available types
226 $out->setPageTitle( $this->mContext
->msg(
227 'protect-norestrictiontypes-title',
228 $this->mTitle
->getPrefixedText()
230 $out->addWikiText( $this->mContext
->msg( 'protect-norestrictiontypes-text' )->plain() );
232 // Show the log in case protection was possible once
233 $this->showLogExtract( $out );
234 // return as there isn't anything else we can do
238 list( $cascadeSources, /* $restrictions */ ) = $this->mTitle
->getCascadeProtectionSources();
239 if ( $cascadeSources && count( $cascadeSources ) > 0 ) {
242 foreach ( $cascadeSources as $title ) {
243 $titles .= '* [[:' . $title->getPrefixedText() . "]]\n";
246 /** @todo FIXME: i18n issue, should use formatted number. */
248 "<div id=\"mw-protect-cascadeon\">\n$1\n" . $titles . "</div>",
249 [ 'protect-cascadeon', count( $cascadeSources ) ]
253 # Show an appropriate message if the user isn't allowed or able to change
254 # the protection settings at this time
255 if ( $this->disabled
) {
257 $this->mContext
->msg( 'protect-title-notallowed',
258 $this->mTitle
->getPrefixedText() )
260 $out->addWikiText( $out->formatPermissionsErrorMessage( $this->mPermErrors
, 'protect' ) );
262 $out->setPageTitle( $this->mContext
->msg( 'protect-title', $this->mTitle
->getPrefixedText() ) );
263 $out->addWikiMsg( 'protect-text',
264 wfEscapeWikiText( $this->mTitle
->getPrefixedText() ) );
267 $out->addHTML( $this->buildForm() );
268 $this->showLogExtract( $out );
272 * Save submitted protection form
274 * @return bool Success
278 if ( $this->disabled
) {
283 $request = $this->mContext
->getRequest();
284 $user = $this->mContext
->getUser();
285 $out = $this->mContext
->getOutput();
286 $token = $request->getVal( 'wpEditToken' );
287 if ( !$user->matchEditToken( $token, [ 'protect', $this->mTitle
->getPrefixedDBkey() ] ) ) {
288 $this->show( [ 'sessionfailure' ] );
292 # Create reason string. Use list and/or custom string.
293 $reasonstr = $this->mReasonSelection
;
294 if ( $reasonstr != 'other' && $this->mReason
!= '' ) {
295 // Entry from drop down menu + additional comment
296 $reasonstr .= $this->mContext
->msg( 'colon-separator' )->text() . $this->mReason
;
297 } elseif ( $reasonstr == 'other' ) {
298 $reasonstr = $this->mReason
;
301 foreach ( $this->mApplicableTypes
as $action ) {
302 $expiry[$action] = $this->getExpiry( $action );
303 if ( empty( $this->mRestrictions
[$action] ) ) {
304 continue; // unprotected
306 if ( !$expiry[$action] ) {
307 $this->show( [ 'protect_expiry_invalid' ] );
310 if ( $expiry[$action] < wfTimestampNow() ) {
311 $this->show( [ 'protect_expiry_old' ] );
316 $this->mCascade
= $request->getBool( 'mwProtect-cascade' );
318 $status = $this->mArticle
->doUpdateRestrictions(
319 $this->mRestrictions
,
326 if ( !$status->isOK() ) {
327 $this->show( $out->parseInline( $status->getWikiText() ) );
332 * Give extensions a change to handle added form items
334 * @since 1.19 you can (and you should) return false to abort saving;
335 * you can also return an array of message name and its parameters
338 if ( !Hooks
::run( 'ProtectionForm::save', [ $this->mArticle
, &$errorMsg, $reasonstr ] ) ) {
339 if ( $errorMsg == '' ) {
340 $errorMsg = [ 'hookaborted' ];
343 if ( $errorMsg != '' ) {
344 $this->show( $errorMsg );
348 WatchAction
::doWatchOrUnwatch( $request->getCheck( 'mwProtectWatch' ), $this->mTitle
, $user );
354 * Build the input form
356 * @return string HTML form
358 function buildForm() {
359 $context = $this->mContext
;
360 $user = $context->getUser();
361 $output = $context->getOutput();
362 $lang = $context->getLanguage();
363 $cascadingRestrictionLevels = $context->getConfig()->get( 'CascadingRestrictionLevels' );
365 if ( !$this->disabled
) {
366 $output->addModules( 'mediawiki.legacy.protect' );
367 $output->addJsConfigVars( 'wgCascadeableLevels', $cascadingRestrictionLevels );
368 $out .= Xml
::openElement( 'form', [ 'method' => 'post',
369 'action' => $this->mTitle
->getLocalURL( 'action=protect' ),
370 'id' => 'mw-Protect-Form' ] );
373 $out .= Xml
::openElement( 'fieldset' ) .
374 Xml
::element( 'legend', null, $context->msg( 'protect-legend' )->text() ) .
375 Xml
::openElement( 'table', [ 'id' => 'mwProtectSet' ] ) .
376 Xml
::openElement( 'tbody' );
378 $scExpiryOptions = wfMessage( 'protect-expiry-options' )->inContentLanguage()->text();
379 $showProtectOptions = $scExpiryOptions !== '-' && !$this->disabled
;
381 // Not all languages have V_x <-> N_x relation
382 foreach ( $this->mRestrictions
as $action => $selected ) {
384 // restriction-edit, restriction-move, restriction-create, restriction-upload
385 $msg = $context->msg( 'restriction-' . $action );
387 Xml
::openElement( 'fieldset' ) .
388 Xml
::element( 'legend', null, $msg->exists() ?
$msg->text() : $action ) .
389 Xml
::openElement( 'table', [ 'id' => "mw-protect-table-$action" ] ) .
390 "<tr><td>" . $this->buildSelector( $action, $selected ) . "</td></tr><tr><td>";
392 $mProtectexpiry = Xml
::label(
393 $context->msg( 'protectexpiry' )->text(),
394 "mwProtectExpirySelection-$action"
396 $mProtectother = Xml
::label(
397 $context->msg( 'protect-othertime' )->text(),
398 "mwProtect-$action-expires"
401 $expiryFormOptions = new XmlSelect(
402 "wpProtectExpirySelection-$action",
403 "mwProtectExpirySelection-$action",
404 $this->mExpirySelection
[$action]
406 $expiryFormOptions->setAttribute( 'tabindex', '2' );
407 if ( $this->disabled
) {
408 $expiryFormOptions->setAttribute( 'disabled', 'disabled' );
411 if ( $this->mExistingExpiry
[$action] ) {
412 if ( $this->mExistingExpiry
[$action] == 'infinity' ) {
413 $existingExpiryMessage = $context->msg( 'protect-existing-expiry-infinity' );
415 $timestamp = $lang->userTimeAndDate( $this->mExistingExpiry
[$action], $user );
416 $d = $lang->userDate( $this->mExistingExpiry
[$action], $user );
417 $t = $lang->userTime( $this->mExistingExpiry
[$action], $user );
418 $existingExpiryMessage = $context->msg(
419 'protect-existing-expiry',
425 $expiryFormOptions->addOption( $existingExpiryMessage->text(), 'existing' );
428 $expiryFormOptions->addOption(
429 $context->msg( 'protect-othertime-op' )->text(),
432 foreach ( explode( ',', $scExpiryOptions ) as $option ) {
433 if ( strpos( $option, ":" ) === false ) {
434 $show = $value = $option;
436 list( $show, $value ) = explode( ":", $option );
438 $expiryFormOptions->addOption( $show, htmlspecialchars( $value ) );
440 # Add expiry dropdown
441 if ( $showProtectOptions && !$this->disabled
) {
444 <td class='mw-label'>
447 <td class='mw-input'>" .
448 $expiryFormOptions->getHTML() .
452 # Add custom expiry field
453 $attribs = [ 'id' => "mwProtect-$action-expires" ] +
$this->disabledAttrib
;
455 <td class='mw-label'>" .
458 <td class="mw-input">' .
459 Xml
::input( "mwProtect-expiry-$action", 50, $this->mExpiry
[$action], $attribs ) .
462 $out .= "</td></tr>" .
463 Xml
::closeElement( 'table' ) .
464 Xml
::closeElement( 'fieldset' ) .
467 # Give extensions a chance to add items to the form
468 Hooks
::run( 'ProtectionForm::buildForm', [ $this->mArticle
, &$out ] );
470 $out .= Xml
::closeElement( 'tbody' ) . Xml
::closeElement( 'table' );
472 // JavaScript will add another row with a value-chaining checkbox
473 if ( $this->mTitle
->exists() ) {
474 $out .= Xml
::openElement( 'table', [ 'id' => 'mw-protect-table2' ] ) .
475 Xml
::openElement( 'tbody' );
478 <td class="mw-input">' .
480 $context->msg( 'protect-cascade' )->text(),
483 $this->mCascade
, $this->disabledAttrib
487 $out .= Xml
::closeElement( 'tbody' ) . Xml
::closeElement( 'table' );
490 # Add manual and custom reason field/selects as well as submit
491 if ( !$this->disabled
) {
492 $mProtectreasonother = Xml
::label(
493 $context->msg( 'protectcomment' )->text(),
494 'wpProtectReasonSelection'
497 $mProtectreason = Xml
::label(
498 $context->msg( 'protect-otherreason' )->text(),
502 $reasonDropDown = Xml
::listDropDown( 'wpProtectReasonSelection',
503 wfMessage( 'protect-dropdown' )->inContentLanguage()->text(),
504 wfMessage( 'protect-otherreason-op' )->inContentLanguage()->text(),
505 $this->mReasonSelection
,
506 'mwProtect-reason', 4 );
508 $out .= Xml
::openElement( 'table', [ 'id' => 'mw-protect-table3' ] ) .
509 Xml
::openElement( 'tbody' );
512 <td class='mw-label'>
513 {$mProtectreasonother}
515 <td class='mw-input'>
520 <td class='mw-label'>
523 <td class='mw-input'>" .
524 Xml
::input( 'mwProtect-reason', 60, $this->mReason
, [ 'type' => 'text',
525 'id' => 'mwProtect-reason', 'maxlength' => 180 ] ) .
526 // Limited maxlength as the database trims at 255 bytes and other texts
527 // chosen by dropdown menus on this page are also included in this database field.
528 // The byte limit of 180 bytes is enforced in javascript
531 # Disallow watching is user is not logged in
532 if ( $user->isLoggedIn() ) {
536 <td class='mw-input'>" .
537 Xml
::checkLabel( $context->msg( 'watchthis' )->text(),
538 'mwProtectWatch', 'mwProtectWatch',
539 $user->isWatched( $this->mTitle
) ||
$user->getOption( 'watchdefault' ) ) .
546 <td class='mw-submit'>" .
548 $context->msg( 'confirm' )->text(),
549 [ 'id' => 'mw-Protect-submit' ]
553 $out .= Xml
::closeElement( 'tbody' ) . Xml
::closeElement( 'table' );
555 $out .= Xml
::closeElement( 'fieldset' );
557 if ( $user->isAllowed( 'editinterface' ) ) {
558 $linkRenderer = MediaWikiServices
::getInstance()->getLinkRenderer();
559 $link = $linkRenderer->makeKnownLink(
560 $context->msg( 'protect-dropdown' )->inContentLanguage()->getTitle(),
561 $context->msg( 'protect-edit-reasonlist' )->text(),
563 [ 'action' => 'edit' ]
565 $out .= '<p class="mw-protect-editreasons">' . $link . '</p>';
568 if ( !$this->disabled
) {
569 $out .= Html
::hidden(
571 $user->getEditToken( [ 'protect', $this->mTitle
->getPrefixedDBkey() ] )
573 $out .= Xml
::closeElement( 'form' );
580 * Build protection level selector
582 * @param string $action Action to protect
583 * @param string $selected Current protection level
584 * @return string HTML fragment
586 function buildSelector( $action, $selected ) {
587 // If the form is disabled, display all relevant levels. Otherwise,
588 // just show the ones this user can use.
589 $levels = MWNamespace
::getRestrictionLevels( $this->mTitle
->getNamespace(),
590 $this->disabled ?
null : $this->mContext
->getUser()
593 $id = 'mwProtect-level-' . $action;
595 $select = new XmlSelect( $id, $id, $selected );
596 $select->setAttribute( 'size', count( $levels ) );
597 if ( $this->disabled
) {
598 $select->setAttribute( 'disabled', 'disabled' );
601 foreach ( $levels as $key ) {
602 $select->addOption( $this->getOptionLabel( $key ), $key );
605 return $select->getHTML();
609 * Prepare the label for a protection selector option
611 * @param string $permission Permission required
614 private function getOptionLabel( $permission ) {
615 if ( $permission == '' ) {
616 return $this->mContext
->msg( 'protect-default' )->text();
618 // Messages: protect-level-autoconfirmed, protect-level-sysop
619 $msg = $this->mContext
->msg( "protect-level-{$permission}" );
620 if ( $msg->exists() ) {
623 return $this->mContext
->msg( 'protect-fallback', $permission )->text();
628 * Show protection long extracts for this page
630 * @param OutputPage $out
633 function showLogExtract( &$out ) {
634 # Show relevant lines from the protection log:
635 $protectLogPage = new LogPage( 'protect' );
636 $out->addHTML( Xml
::element( 'h2', null, $protectLogPage->getName()->text() ) );
637 LogEventsList
::showLogExtract( $out, 'protect', $this->mTitle
);
638 # Let extensions add other relevant log extracts
639 Hooks
::run( 'ProtectionForm::showLogExtract', [ $this->mArticle
, $out ] );