Properly deprecate srprop=score|hasrelated
[mediawiki.git] / includes / ProtectionForm.php
blob4aa65d9403334be4724944cd13e5021915948ccc
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
26 /**
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 = array();
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 = array();
45 /**
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 = array();
51 /** @var array Permissions errors for the protect action */
52 protected $mPermErrors = array();
54 /** @var array Types (i.e. actions) for which levels can be selected */
55 protected $mApplicableTypes = array();
57 /** @var array Map of action to the expiry time of the existing protection */
58 protected $mExistingExpiry = array();
60 /** @var IContextSource */
61 private $mContext;
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()
75 if ( wfReadOnly() ) {
76 $this->mPermErrors[] = array( 'readonlytext', wfReadOnlyReason() );
78 $this->disabled = $this->mPermErrors != array();
79 $this->disabledAttrib = $this->disabled
80 ? array( 'disabled' => 'disabled' )
81 : array();
83 $this->loadData();
86 /**
87 * Loads the current state of protection into the object.
89 function loadData() {
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 = '';
110 } else {
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;
130 } else {
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];
156 } else {
157 $value = $this->mExpirySelection[$action];
159 if ( $value == 'infinite' || $value == 'indefinite' || $value == 'infinity' ) {
160 $time = wfGetDB( DB_SLAVE )->getInfinity();
161 } else {
162 $unix = strtotime( $value );
164 if ( !$unix || $unix === -1 ) {
165 return false;
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 );
172 return $time;
176 * Main entry point for action=protect and action=unprotect
178 function execute() {
179 if ( MWNamespace::getRestrictionLevels( $this->mTitle->getNamespace() ) === array( '' ) ) {
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 ) );
188 } else {
189 $this->show();
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() === array() ) {
210 // No restriction types available for the current title
211 // this might happen if an extension alters the available types
212 $out->setPageTitle( wfMessage(
213 'protect-norestrictiontypes-title',
214 $this->mTitle->getPrefixedText()
215 ) );
216 $out->addWikiText( wfMessage( 'protect-norestrictiontypes-text' )->text() );
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
221 return;
224 list( $cascadeSources, /* $restrictions */ ) = $this->mTitle->getCascadeProtectionSources();
225 if ( $cascadeSources && count( $cascadeSources ) > 0 ) {
226 $titles = '';
228 foreach ( $cascadeSources as $title ) {
229 $titles .= '* [[:' . $title->getPrefixedText() . "]]\n";
232 /** @todo FIXME: i18n issue, should use formatted number. */
233 $out->wrapWikiMsg(
234 "<div id=\"mw-protect-cascadeon\">\n$1\n" . $titles . "</div>",
235 array( '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 ) {
242 $out->setPageTitle(
243 wfMessage( 'protect-title-notallowed',
244 $this->mTitle->getPrefixedText() )
246 $out->addWikiText( $out->formatPermissionsErrorMessage( $this->mPermErrors, 'protect' ) );
247 } else {
248 $out->setPageTitle( wfMessage( '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
262 function save() {
263 # Permission check!
264 if ( $this->disabled ) {
265 $this->show();
266 return false;
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, array( 'protect', $this->mTitle->getPrefixedDBkey() ) ) ) {
274 $this->show( array( 'sessionfailure' ) );
275 return false;
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 .= wfMessage( 'colon-separator' )->text() . $this->mReason;
283 } elseif ( $reasonstr == 'other' ) {
284 $reasonstr = $this->mReason;
286 $expiry = array();
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( array( 'protect_expiry_invalid' ) );
294 return false;
296 if ( $expiry[$action] < wfTimestampNow() ) {
297 $this->show( array( 'protect_expiry_old' ) );
298 return false;
302 $this->mCascade = $request->getBool( 'mwProtect-cascade' );
304 $status = $this->mArticle->doUpdateRestrictions(
305 $this->mRestrictions,
306 $expiry,
307 $this->mCascade,
308 $reasonstr,
309 $user
312 if ( !$status->isOK() ) {
313 $this->show( $out->parseInline( $status->getWikiText() ) );
314 return false;
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
323 $errorMsg = '';
324 if ( !wfRunHooks( 'ProtectionForm::save', array( $this->mArticle, &$errorMsg, $reasonstr ) ) ) {
325 if ( $errorMsg == '' ) {
326 $errorMsg = array( 'hookaborted' );
329 if ( $errorMsg != '' ) {
330 $this->show( $errorMsg );
331 return false;
334 WatchAction::doWatchOrUnwatch( $request->getCheck( 'mwProtectWatch' ), $this->mTitle, $user );
336 return true;
340 * Build the input form
342 * @return string HTML form
344 function buildForm() {
345 $user = $this->mContext->getUser();
346 $output = $this->mContext->getOutput();
347 $lang = $this->mContext->getLanguage();
348 $cascadingRestrictionLevels = $this->mContext->getConfig()->get( 'CascadingRestrictionLevels' );
349 $out = '';
350 if ( !$this->disabled ) {
351 $output->addModules( 'mediawiki.legacy.protect' );
352 $output->addJsConfigVars( 'wgCascadeableLevels', $cascadingRestrictionLevels );
353 $out .= Xml::openElement( 'form', array( 'method' => 'post',
354 'action' => $this->mTitle->getLocalURL( 'action=protect' ),
355 'id' => 'mw-Protect-Form', 'onsubmit' => 'ProtectionForm.enableUnchainedInputs(true)' ) );
358 $out .= Xml::openElement( 'fieldset' ) .
359 Xml::element( 'legend', null, wfMessage( 'protect-legend' )->text() ) .
360 Xml::openElement( 'table', array( 'id' => 'mwProtectSet' ) ) .
361 Xml::openElement( 'tbody' );
363 $scExpiryOptions = wfMessage( 'protect-expiry-options' )->inContentLanguage()->text();
364 $showProtectOptions = $scExpiryOptions !== '-' && !$this->disabled;
366 // Not all languages have V_x <-> N_x relation
367 foreach ( $this->mRestrictions as $action => $selected ) {
368 // Messages:
369 // restriction-edit, restriction-move, restriction-create, restriction-upload
370 $msg = wfMessage( 'restriction-' . $action );
371 $out .= "<tr><td>" .
372 Xml::openElement( 'fieldset' ) .
373 Xml::element( 'legend', null, $msg->exists() ? $msg->text() : $action ) .
374 Xml::openElement( 'table', array( 'id' => "mw-protect-table-$action" ) ) .
375 "<tr><td>" . $this->buildSelector( $action, $selected ) . "</td></tr><tr><td>";
377 $mProtectexpiry = Xml::label(
378 wfMessage( 'protectexpiry' )->text(),
379 "mwProtectExpirySelection-$action"
381 $mProtectother = Xml::label(
382 wfMessage( 'protect-othertime' )->text(),
383 "mwProtect-$action-expires"
386 $expiryFormOptions = '';
387 if ( $this->mExistingExpiry[$action] && $this->mExistingExpiry[$action] != 'infinity' ) {
388 $timestamp = $lang->timeanddate( $this->mExistingExpiry[$action], true );
389 $d = $lang->date( $this->mExistingExpiry[$action], true );
390 $t = $lang->time( $this->mExistingExpiry[$action], true );
391 $expiryFormOptions .=
392 Xml::option(
393 wfMessage( 'protect-existing-expiry', $timestamp, $d, $t )->text(),
394 'existing',
395 $this->mExpirySelection[$action] == 'existing'
396 ) . "\n";
399 $expiryFormOptions .= Xml::option(
400 wfMessage( 'protect-othertime-op' )->text(),
401 "othertime"
402 ) . "\n";
403 foreach ( explode( ',', $scExpiryOptions ) as $option ) {
404 if ( strpos( $option, ":" ) === false ) {
405 $show = $value = $option;
406 } else {
407 list( $show, $value ) = explode( ":", $option );
409 $show = htmlspecialchars( $show );
410 $value = htmlspecialchars( $value );
411 $expiryFormOptions .= Xml::option(
412 $show,
413 $value,
414 $this->mExpirySelection[$action] === $value
415 ) . "\n";
417 # Add expiry dropdown
418 if ( $showProtectOptions && !$this->disabled ) {
419 $out .= "
420 <table><tr>
421 <td class='mw-label'>
422 {$mProtectexpiry}
423 </td>
424 <td class='mw-input'>" .
425 Xml::tags( 'select',
426 array(
427 'id' => "mwProtectExpirySelection-$action",
428 'name' => "wpProtectExpirySelection-$action",
429 'onchange' => "ProtectionForm.updateExpiryList(this)",
430 'tabindex' => '2' ) + $this->disabledAttrib,
431 $expiryFormOptions ) .
432 "</td>
433 </tr></table>";
435 # Add custom expiry field
436 $attribs = array( 'id' => "mwProtect-$action-expires",
437 'onkeyup' => 'ProtectionForm.updateExpiry(this)',
438 'onchange' => 'ProtectionForm.updateExpiry(this)' ) + $this->disabledAttrib;
439 $out .= "<table><tr>
440 <td class='mw-label'>" .
441 $mProtectother .
442 '</td>
443 <td class="mw-input">' .
444 Xml::input( "mwProtect-expiry-$action", 50, $this->mExpiry[$action], $attribs ) .
445 '</td>
446 </tr></table>';
447 $out .= "</td></tr>" .
448 Xml::closeElement( 'table' ) .
449 Xml::closeElement( 'fieldset' ) .
450 "</td></tr>";
452 # Give extensions a chance to add items to the form
453 wfRunHooks( 'ProtectionForm::buildForm', array( $this->mArticle, &$out ) );
455 $out .= Xml::closeElement( 'tbody' ) . Xml::closeElement( 'table' );
457 // JavaScript will add another row with a value-chaining checkbox
458 if ( $this->mTitle->exists() ) {
459 $out .= Xml::openElement( 'table', array( 'id' => 'mw-protect-table2' ) ) .
460 Xml::openElement( 'tbody' );
461 $out .= '<tr>
462 <td></td>
463 <td class="mw-input">' .
464 Xml::checkLabel(
465 wfMessage( 'protect-cascade' )->text(),
466 'mwProtect-cascade',
467 'mwProtect-cascade',
468 $this->mCascade, $this->disabledAttrib
470 "</td>
471 </tr>\n";
472 $out .= Xml::closeElement( 'tbody' ) . Xml::closeElement( 'table' );
475 # Add manual and custom reason field/selects as well as submit
476 if ( !$this->disabled ) {
477 $mProtectreasonother = Xml::label(
478 wfMessage( 'protectcomment' )->text(),
479 'wpProtectReasonSelection'
482 $mProtectreason = Xml::label(
483 wfMessage( 'protect-otherreason' )->text(),
484 'mwProtect-reason'
487 $reasonDropDown = Xml::listDropDown( 'wpProtectReasonSelection',
488 wfMessage( 'protect-dropdown' )->inContentLanguage()->text(),
489 wfMessage( 'protect-otherreason-op' )->inContentLanguage()->text(),
490 $this->mReasonSelection,
491 'mwProtect-reason', 4 );
493 $out .= Xml::openElement( 'table', array( 'id' => 'mw-protect-table3' ) ) .
494 Xml::openElement( 'tbody' );
495 $out .= "
496 <tr>
497 <td class='mw-label'>
498 {$mProtectreasonother}
499 </td>
500 <td class='mw-input'>
501 {$reasonDropDown}
502 </td>
503 </tr>
504 <tr>
505 <td class='mw-label'>
506 {$mProtectreason}
507 </td>
508 <td class='mw-input'>" .
509 Xml::input( 'mwProtect-reason', 60, $this->mReason, array( 'type' => 'text',
510 'id' => 'mwProtect-reason', 'maxlength' => 180 ) ) .
511 // Limited maxlength as the database trims at 255 bytes and other texts
512 // chosen by dropdown menus on this page are also included in this database field.
513 // The byte limit of 180 bytes is enforced in javascript
514 "</td>
515 </tr>";
516 # Disallow watching is user is not logged in
517 if ( $user->isLoggedIn() ) {
518 $out .= "
519 <tr>
520 <td></td>
521 <td class='mw-input'>" .
522 Xml::checkLabel( wfMessage( 'watchthis' )->text(),
523 'mwProtectWatch', 'mwProtectWatch',
524 $user->isWatched( $this->mTitle ) || $user->getOption( 'watchdefault' ) ) .
525 "</td>
526 </tr>";
528 $out .= "
529 <tr>
530 <td></td>
531 <td class='mw-submit'>" .
532 Xml::submitButton(
533 wfMessage( 'confirm' )->text(),
534 array( 'id' => 'mw-Protect-submit' )
536 "</td>
537 </tr>\n";
538 $out .= Xml::closeElement( 'tbody' ) . Xml::closeElement( 'table' );
540 $out .= Xml::closeElement( 'fieldset' );
542 if ( $user->isAllowed( 'editinterface' ) ) {
543 $title = Title::makeTitle( NS_MEDIAWIKI, 'Protect-dropdown' );
544 $link = Linker::link(
545 $title,
546 wfMessage( 'protect-edit-reasonlist' )->escaped(),
547 array(),
548 array( 'action' => 'edit' )
550 $out .= '<p class="mw-protect-editreasons">' . $link . '</p>';
553 if ( !$this->disabled ) {
554 $out .= Html::hidden(
555 'wpEditToken',
556 $user->getEditToken( array( 'protect', $this->mTitle->getPrefixedDBkey() ) )
558 $out .= Xml::closeElement( 'form' );
559 $output->addScript( $this->buildCleanupScript() );
562 return $out;
566 * Build protection level selector
568 * @param string $action Action to protect
569 * @param string $selected Current protection level
570 * @return string HTML fragment
572 function buildSelector( $action, $selected ) {
573 // If the form is disabled, display all relevant levels. Otherwise,
574 // just show the ones this user can use.
575 $levels = MWNamespace::getRestrictionLevels( $this->mTitle->getNamespace(),
576 $this->disabled ? null : $this->mContext->getUser()
579 $id = 'mwProtect-level-' . $action;
580 $attribs = array(
581 'id' => $id,
582 'name' => $id,
583 'size' => count( $levels ),
584 'onchange' => 'ProtectionForm.updateLevels(this)',
585 ) + $this->disabledAttrib;
587 $out = Xml::openElement( 'select', $attribs );
588 foreach ( $levels as $key ) {
589 $out .= Xml::option( $this->getOptionLabel( $key ), $key, $key == $selected );
591 $out .= Xml::closeElement( 'select' );
592 return $out;
596 * Prepare the label for a protection selector option
598 * @param string $permission Permission required
599 * @return string
601 private function getOptionLabel( $permission ) {
602 if ( $permission == '' ) {
603 return wfMessage( 'protect-default' )->text();
604 } else {
605 // Messages: protect-level-autoconfirmed, protect-level-sysop
606 $msg = wfMessage( "protect-level-{$permission}" );
607 if ( $msg->exists() ) {
608 return $msg->text();
610 return wfMessage( 'protect-fallback', $permission )->text();
614 function buildCleanupScript() {
615 $options = array(
616 'tableId' => 'mwProtectSet',
617 'labelText' => wfMessage( 'protect-unchain-permissions' )->plain(),
618 'numTypes' => count( $this->mApplicableTypes ),
619 'existingMatch' => count( array_unique( $this->mExistingExpiry ) ) === 1,
622 $script = Xml::encodeJsCall( 'ProtectionForm.init', array( $options ) );
624 return Html::inlineScript( ResourceLoader::makeLoaderConditionalScript( $script ) );
628 * Show protection long extracts for this page
630 * @param OutputPage $out
631 * @access private
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 wfRunHooks( 'ProtectionForm::showLogExtract', array( $this->mArticle, $out ) );