Move remaining LoadBalancer classes to Rdbms
[mediawiki.git] / includes / ProtectionForm.php
bloba68c36fb6babdf4a211631292c79740045d66a59
1 <?php
2 /**
3 * Page protection
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
23 * @file
25 use MediaWiki\MediaWikiServices;
27 /**
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 = [];
46 /**
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 */
62 private $mContext;
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(
74 'protect',
75 $this->mContext->getUser(),
76 $this->mContext->getRequest()->wasPosted() ? 'secure' : 'full' // T92357
78 if ( wfReadOnly() ) {
79 $this->mPermErrors[] = [ 'readonlytext', wfReadOnlyReason() ];
81 $this->disabled = $this->mPermErrors != [];
82 $this->disabledAttrib = $this->disabled
83 ? [ 'disabled' => 'disabled' ]
84 : [];
86 $this->loadData();
89 /**
90 * Loads the current state of protection into the object.
92 function loadData() {
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 = '';
113 } else {
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;
133 } else {
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];
159 } else {
160 $value = $this->mExpirySelection[$action];
162 if ( wfIsInfinity( $value ) ) {
163 $time = 'infinity';
164 } else {
165 $unix = strtotime( $value );
167 if ( !$unix || $unix === -1 ) {
168 return false;
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 );
175 return $time;
179 * Main entry point for action=protect and action=unprotect
181 function execute() {
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 ) );
191 } else {
192 $this->show();
197 * Show the input form with optional error message
199 * @param string $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()
218 ) );
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
224 return;
227 list( $cascadeSources, /* $restrictions */ ) = $this->mTitle->getCascadeProtectionSources();
228 if ( $cascadeSources && count( $cascadeSources ) > 0 ) {
229 $titles = '';
231 foreach ( $cascadeSources as $title ) {
232 $titles .= '* [[:' . $title->getPrefixedText() . "]]\n";
235 /** @todo FIXME: i18n issue, should use formatted number. */
236 $out->wrapWikiMsg(
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 ) {
245 $out->setPageTitle(
246 $this->mContext->msg( 'protect-title-notallowed',
247 $this->mTitle->getPrefixedText() )
249 $out->addWikiText( $out->formatPermissionsErrorMessage( $this->mPermErrors, 'protect' ) );
250 } else {
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
265 function save() {
266 # Permission check!
267 if ( $this->disabled ) {
268 $this->show();
269 return false;
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' ] );
278 return false;
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;
289 $expiry = [];
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' ] );
297 return false;
299 if ( $expiry[$action] < wfTimestampNow() ) {
300 $this->show( [ 'protect_expiry_old' ] );
301 return false;
305 $this->mCascade = $request->getBool( 'mwProtect-cascade' );
307 $status = $this->mArticle->doUpdateRestrictions(
308 $this->mRestrictions,
309 $expiry,
310 $this->mCascade,
311 $reasonstr,
312 $user
315 if ( !$status->isOK() ) {
316 $this->show( $out->parseInline( $status->getWikiText() ) );
317 return false;
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
326 $errorMsg = '';
327 if ( !Hooks::run( 'ProtectionForm::save', [ $this->mArticle, &$errorMsg, $reasonstr ] ) ) {
328 if ( $errorMsg == '' ) {
329 $errorMsg = [ 'hookaborted' ];
332 if ( $errorMsg != '' ) {
333 $this->show( $errorMsg );
334 return false;
337 WatchAction::doWatchOrUnwatch( $request->getCheck( 'mwProtectWatch' ), $this->mTitle, $user );
339 return true;
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 $cascadingRestrictionLevels = $context->getConfig()->get( 'CascadingRestrictionLevels' );
353 $out = '';
354 if ( !$this->disabled ) {
355 $output->addModules( 'mediawiki.legacy.protect' );
356 $output->addJsConfigVars( 'wgCascadeableLevels', $cascadingRestrictionLevels );
357 $out .= Xml::openElement( 'form', [ 'method' => 'post',
358 'action' => $this->mTitle->getLocalURL( 'action=protect' ),
359 'id' => 'mw-Protect-Form' ] );
362 $out .= Xml::openElement( 'fieldset' ) .
363 Xml::element( 'legend', null, $context->msg( 'protect-legend' )->text() ) .
364 Xml::openElement( 'table', [ 'id' => 'mwProtectSet' ] ) .
365 Xml::openElement( 'tbody' );
367 $scExpiryOptions = wfMessage( 'protect-expiry-options' )->inContentLanguage()->text();
368 $showProtectOptions = $scExpiryOptions !== '-' && !$this->disabled;
370 // Not all languages have V_x <-> N_x relation
371 foreach ( $this->mRestrictions as $action => $selected ) {
372 // Messages:
373 // restriction-edit, restriction-move, restriction-create, restriction-upload
374 $msg = $context->msg( 'restriction-' . $action );
375 $out .= "<tr><td>" .
376 Xml::openElement( 'fieldset' ) .
377 Xml::element( 'legend', null, $msg->exists() ? $msg->text() : $action ) .
378 Xml::openElement( 'table', [ 'id' => "mw-protect-table-$action" ] ) .
379 "<tr><td>" . $this->buildSelector( $action, $selected ) . "</td></tr><tr><td>";
381 $mProtectexpiry = Xml::label(
382 $context->msg( 'protectexpiry' )->text(),
383 "mwProtectExpirySelection-$action"
385 $mProtectother = Xml::label(
386 $context->msg( 'protect-othertime' )->text(),
387 "mwProtect-$action-expires"
390 $expiryFormOptions = new XmlSelect(
391 "wpProtectExpirySelection-$action",
392 "mwProtectExpirySelection-$action",
393 $this->mExpirySelection[$action]
395 $expiryFormOptions->setAttribute( 'tabindex', '2' );
396 if ( $this->disabled ) {
397 $expiryFormOptions->setAttribute( 'disabled', 'disabled' );
400 if ( $this->mExistingExpiry[$action] ) {
401 if ( $this->mExistingExpiry[$action] == 'infinity' ) {
402 $existingExpiryMessage = $context->msg( 'protect-existing-expiry-infinity' );
403 } else {
404 $timestamp = $lang->userTimeAndDate( $this->mExistingExpiry[$action], $user );
405 $d = $lang->userDate( $this->mExistingExpiry[$action], $user );
406 $t = $lang->userTime( $this->mExistingExpiry[$action], $user );
407 $existingExpiryMessage = $context->msg(
408 'protect-existing-expiry',
409 $timestamp,
414 $expiryFormOptions->addOption( $existingExpiryMessage->text(), 'existing' );
417 $expiryFormOptions->addOption(
418 $context->msg( 'protect-othertime-op' )->text(),
419 'othertime'
421 foreach ( explode( ',', $scExpiryOptions ) as $option ) {
422 if ( strpos( $option, ":" ) === false ) {
423 $show = $value = $option;
424 } else {
425 list( $show, $value ) = explode( ":", $option );
427 $expiryFormOptions->addOption( $show, htmlspecialchars( $value ) );
429 # Add expiry dropdown
430 if ( $showProtectOptions && !$this->disabled ) {
431 $out .= "
432 <table><tr>
433 <td class='mw-label'>
434 {$mProtectexpiry}
435 </td>
436 <td class='mw-input'>" .
437 $expiryFormOptions->getHTML() .
438 "</td>
439 </tr></table>";
441 # Add custom expiry field
442 $attribs = [ 'id' => "mwProtect-$action-expires" ] + $this->disabledAttrib;
443 $out .= "<table><tr>
444 <td class='mw-label'>" .
445 $mProtectother .
446 '</td>
447 <td class="mw-input">' .
448 Xml::input( "mwProtect-expiry-$action", 50, $this->mExpiry[$action], $attribs ) .
449 '</td>
450 </tr></table>';
451 $out .= "</td></tr>" .
452 Xml::closeElement( 'table' ) .
453 Xml::closeElement( 'fieldset' ) .
454 "</td></tr>";
456 # Give extensions a chance to add items to the form
457 Hooks::run( 'ProtectionForm::buildForm', [ $this->mArticle, &$out ] );
459 $out .= Xml::closeElement( 'tbody' ) . Xml::closeElement( 'table' );
461 // JavaScript will add another row with a value-chaining checkbox
462 if ( $this->mTitle->exists() ) {
463 $out .= Xml::openElement( 'table', [ 'id' => 'mw-protect-table2' ] ) .
464 Xml::openElement( 'tbody' );
465 $out .= '<tr>
466 <td></td>
467 <td class="mw-input">' .
468 Xml::checkLabel(
469 $context->msg( 'protect-cascade' )->text(),
470 'mwProtect-cascade',
471 'mwProtect-cascade',
472 $this->mCascade, $this->disabledAttrib
474 "</td>
475 </tr>\n";
476 $out .= Xml::closeElement( 'tbody' ) . Xml::closeElement( 'table' );
479 # Add manual and custom reason field/selects as well as submit
480 if ( !$this->disabled ) {
481 $mProtectreasonother = Xml::label(
482 $context->msg( 'protectcomment' )->text(),
483 'wpProtectReasonSelection'
486 $mProtectreason = Xml::label(
487 $context->msg( 'protect-otherreason' )->text(),
488 'mwProtect-reason'
491 $reasonDropDown = Xml::listDropDown( 'wpProtectReasonSelection',
492 wfMessage( 'protect-dropdown' )->inContentLanguage()->text(),
493 wfMessage( 'protect-otherreason-op' )->inContentLanguage()->text(),
494 $this->mReasonSelection,
495 'mwProtect-reason', 4 );
497 $out .= Xml::openElement( 'table', [ 'id' => 'mw-protect-table3' ] ) .
498 Xml::openElement( 'tbody' );
499 $out .= "
500 <tr>
501 <td class='mw-label'>
502 {$mProtectreasonother}
503 </td>
504 <td class='mw-input'>
505 {$reasonDropDown}
506 </td>
507 </tr>
508 <tr>
509 <td class='mw-label'>
510 {$mProtectreason}
511 </td>
512 <td class='mw-input'>" .
513 Xml::input( 'mwProtect-reason', 60, $this->mReason, [ 'type' => 'text',
514 'id' => 'mwProtect-reason', 'maxlength' => 180 ] ) .
515 // Limited maxlength as the database trims at 255 bytes and other texts
516 // chosen by dropdown menus on this page are also included in this database field.
517 // The byte limit of 180 bytes is enforced in javascript
518 "</td>
519 </tr>";
520 # Disallow watching is user is not logged in
521 if ( $user->isLoggedIn() ) {
522 $out .= "
523 <tr>
524 <td></td>
525 <td class='mw-input'>" .
526 Xml::checkLabel( $context->msg( 'watchthis' )->text(),
527 'mwProtectWatch', 'mwProtectWatch',
528 $user->isWatched( $this->mTitle ) || $user->getOption( 'watchdefault' ) ) .
529 "</td>
530 </tr>";
532 $out .= "
533 <tr>
534 <td></td>
535 <td class='mw-submit'>" .
536 Xml::submitButton(
537 $context->msg( 'confirm' )->text(),
538 [ 'id' => 'mw-Protect-submit' ]
540 "</td>
541 </tr>\n";
542 $out .= Xml::closeElement( 'tbody' ) . Xml::closeElement( 'table' );
544 $out .= Xml::closeElement( 'fieldset' );
546 if ( $user->isAllowed( 'editinterface' ) ) {
547 $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
548 $link = $linkRenderer->makeKnownLink(
549 $context->msg( 'protect-dropdown' )->inContentLanguage()->getTitle(),
550 $context->msg( 'protect-edit-reasonlist' )->text(),
552 [ 'action' => 'edit' ]
554 $out .= '<p class="mw-protect-editreasons">' . $link . '</p>';
557 if ( !$this->disabled ) {
558 $out .= Html::hidden(
559 'wpEditToken',
560 $user->getEditToken( [ 'protect', $this->mTitle->getPrefixedDBkey() ] )
562 $out .= Xml::closeElement( 'form' );
565 return $out;
569 * Build protection level selector
571 * @param string $action Action to protect
572 * @param string $selected Current protection level
573 * @return string HTML fragment
575 function buildSelector( $action, $selected ) {
576 // If the form is disabled, display all relevant levels. Otherwise,
577 // just show the ones this user can use.
578 $levels = MWNamespace::getRestrictionLevels( $this->mTitle->getNamespace(),
579 $this->disabled ? null : $this->mContext->getUser()
582 $id = 'mwProtect-level-' . $action;
584 $select = new XmlSelect( $id, $id, $selected );
585 $select->setAttribute( 'size', count( $levels ) );
586 if ( $this->disabled ) {
587 $select->setAttribute( 'disabled', 'disabled' );
590 foreach ( $levels as $key ) {
591 $select->addOption( $this->getOptionLabel( $key ), $key );
594 return $select->getHTML();
598 * Prepare the label for a protection selector option
600 * @param string $permission Permission required
601 * @return string
603 private function getOptionLabel( $permission ) {
604 if ( $permission == '' ) {
605 return $this->mContext->msg( 'protect-default' )->text();
606 } else {
607 // Messages: protect-level-autoconfirmed, protect-level-sysop
608 $msg = $this->mContext->msg( "protect-level-{$permission}" );
609 if ( $msg->exists() ) {
610 return $msg->text();
612 return $this->mContext->msg( 'protect-fallback', $permission )->text();
617 * Show protection long extracts for this page
619 * @param OutputPage $out
620 * @access private
622 function showLogExtract( &$out ) {
623 # Show relevant lines from the protection log:
624 $protectLogPage = new LogPage( 'protect' );
625 $out->addHTML( Xml::element( 'h2', null, $protectLogPage->getName()->text() ) );
626 LogEventsList::showLogExtract( $out, 'protect', $this->mTitle );
627 # Let extensions add other relevant log extracts
628 Hooks::run( 'ProtectionForm::showLogExtract', [ $this->mArticle, $out ] );