<?php
/**
- * Copyright (C) 2005 Brion Vibber <brion@pobox.com>
- * http://www.mediawiki.org/
+ * Page protection
+ *
+ * Copyright © 2005 Brion Vibber <brion@pobox.com>
+ * https://www.mediawiki.org/
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
*/
+use MediaWiki\MediaWikiServices;
/**
- * @todo document, briefly.
- * @addtogroup SpecialPage
+ * Handles the page protection UI and backend
*/
class ProtectionForm {
- var $mRestrictions = array();
- var $mReason = '';
- var $mCascade = false;
- var $mExpiry = null;
-
- function __construct( &$article ) {
- global $wgRequest, $wgUser;
- global $wgRestrictionTypes, $wgRestrictionLevels;
- $this->mArticle =& $article;
- $this->mTitle =& $article->mTitle;
-
- if( $this->mTitle ) {
- $this->mTitle->loadRestrictions();
-
- foreach( $wgRestrictionTypes as $action ) {
- // Fixme: this form currently requires individual selections,
- // but the db allows multiples separated by commas.
- $this->mRestrictions[$action] = implode( '', $this->mTitle->getRestrictions( $action ) );
- }
+ /** @var array A map of action to restriction level, from request or default */
+ protected $mRestrictions = [];
+
+ /** @var string The custom/additional protection reason */
+ protected $mReason = '';
+
+ /** @var string The reason selected from the list, blank for other/additional */
+ protected $mReasonSelection = '';
+
+ /** @var bool True if the restrictions are cascading, from request or existing protection */
+ protected $mCascade = false;
+
+ /** @var array Map of action to "other" expiry time. Used in preference to mExpirySelection. */
+ protected $mExpiry = [];
+
+ /**
+ * @var array Map of action to value selected in expiry drop-down list.
+ * Will be set to 'othertime' whenever mExpiry is set.
+ */
+ protected $mExpirySelection = [];
+
+ /** @var array Permissions errors for the protect action */
+ protected $mPermErrors = [];
+
+ /** @var array Types (i.e. actions) for which levels can be selected */
+ protected $mApplicableTypes = [];
+
+ /** @var array Map of action to the expiry time of the existing protection */
+ protected $mExistingExpiry = [];
+
+ /** @var IContextSource */
+ private $mContext;
+
+ function __construct( Article $article ) {
+ // Set instance variables.
+ $this->mArticle = $article;
+ $this->mTitle = $article->getTitle();
+ $this->mApplicableTypes = $this->mTitle->getRestrictionTypes();
+ $this->mContext = $article->getContext();
+
+ // Check if the form should be disabled.
+ // If it is, the form will be available in read-only to show levels.
+ $this->mPermErrors = $this->mTitle->getUserPermissionsErrors(
+ 'protect',
+ $this->mContext->getUser(),
+ $this->mContext->getRequest()->wasPosted() ? 'secure' : 'full' // T92357
+ );
+ if ( wfReadOnly() ) {
+ $this->mPermErrors[] = [ 'readonlytext', wfReadOnlyReason() ];
+ }
+ $this->disabled = $this->mPermErrors != [];
+ $this->disabledAttrib = $this->disabled
+ ? [ 'disabled' => 'disabled' ]
+ : [];
+
+ $this->loadData();
+ }
+
+ /**
+ * Loads the current state of protection into the object.
+ */
+ function loadData() {
+ $levels = MWNamespace::getRestrictionLevels(
+ $this->mTitle->getNamespace(), $this->mContext->getUser()
+ );
+ $this->mCascade = $this->mTitle->areRestrictionsCascading();
+
+ $request = $this->mContext->getRequest();
+ $this->mReason = $request->getText( 'mwProtect-reason' );
+ $this->mReasonSelection = $request->getText( 'wpProtectReasonSelection' );
+ $this->mCascade = $request->getBool( 'mwProtect-cascade', $this->mCascade );
- $this->mCascade = $this->mTitle->areRestrictionsCascading();
+ foreach ( $this->mApplicableTypes as $action ) {
+ // @todo FIXME: This form currently requires individual selections,
+ // but the db allows multiples separated by commas.
- if ( $this->mTitle->mRestrictionsExpiry == 'infinity' ) {
- $this->mExpiry = 'infinite';
- } else if ( strlen($this->mTitle->mRestrictionsExpiry) == 0 ) {
- $this->mExpiry = '';
+ // Pull the actual restriction from the DB
+ $this->mRestrictions[$action] = implode( '', $this->mTitle->getRestrictions( $action ) );
+
+ if ( !$this->mRestrictions[$action] ) {
+ // No existing expiry
+ $existingExpiry = '';
+ } else {
+ $existingExpiry = $this->mTitle->getRestrictionExpiry( $action );
+ }
+ $this->mExistingExpiry[$action] = $existingExpiry;
+
+ $requestExpiry = $request->getText( "mwProtect-expiry-$action" );
+ $requestExpirySelection = $request->getVal( "wpProtectExpirySelection-$action" );
+
+ if ( $requestExpiry ) {
+ // Custom expiry takes precedence
+ $this->mExpiry[$action] = $requestExpiry;
+ $this->mExpirySelection[$action] = 'othertime';
+ } elseif ( $requestExpirySelection ) {
+ // Expiry selected from list
+ $this->mExpiry[$action] = '';
+ $this->mExpirySelection[$action] = $requestExpirySelection;
+ } elseif ( $existingExpiry ) {
+ // Use existing expiry in its own list item
+ $this->mExpiry[$action] = '';
+ $this->mExpirySelection[$action] = $existingExpiry;
} else {
- $this->mExpiry = wfTimestamp( TS_RFC2822, $this->mTitle->mRestrictionsExpiry );
+ // Catches 'infinity' - Existing expiry is infinite, use "infinite" in drop-down
+ // Final default: infinite
+ $this->mExpiry[$action] = '';
+ $this->mExpirySelection[$action] = 'infinite';
+ }
+
+ $val = $request->getVal( "mwProtect-level-$action" );
+ if ( isset( $val ) && in_array( $val, $levels ) ) {
+ $this->mRestrictions[$action] = $val;
}
}
+ }
- // The form will be available in read-only to show levels.
- $this->disabled = !$wgUser->isAllowed( 'protect' ) || wfReadOnly() || $wgUser->isBlocked();
- $this->disabledAttrib = $this->disabled
- ? array( 'disabled' => 'disabled' )
- : array();
-
- if( $wgRequest->wasPosted() ) {
- $this->mReason = $wgRequest->getText( 'mwProtect-reason' );
- $this->mCascade = $wgRequest->getBool( 'mwProtect-cascade' );
- $this->mExpiry = $wgRequest->getText( 'mwProtect-expiry' );
-
- foreach( $wgRestrictionTypes as $action ) {
- $val = $wgRequest->getVal( "mwProtect-level-$action" );
- if( isset( $val ) && in_array( $val, $wgRestrictionLevels ) ) {
- $this->mRestrictions[$action] = $val;
- }
+ /**
+ * Get the expiry time for a given action, by combining the relevant inputs.
+ *
+ * @param string $action
+ *
+ * @return string|false 14-char timestamp or "infinity", or false if the input was invalid
+ */
+ function getExpiry( $action ) {
+ if ( $this->mExpirySelection[$action] == 'existing' ) {
+ return $this->mExistingExpiry[$action];
+ } elseif ( $this->mExpirySelection[$action] == 'othertime' ) {
+ $value = $this->mExpiry[$action];
+ } else {
+ $value = $this->mExpirySelection[$action];
+ }
+ if ( wfIsInfinity( $value ) ) {
+ $time = 'infinity';
+ } else {
+ $unix = strtotime( $value );
+
+ if ( !$unix || $unix === -1 ) {
+ return false;
}
+
+ // @todo FIXME: Non-qualified absolute times are not in users specified timezone
+ // and there isn't notice about it in the ui
+ $time = wfTimestamp( TS_MW, $unix );
}
+ return $time;
}
-
+
+ /**
+ * Main entry point for action=protect and action=unprotect
+ */
function execute() {
- global $wgRequest, $wgOut;
- if( $wgRequest->wasPosted() ) {
- if( $this->save() ) {
- $article = new Article( $this->mTitle );
- $q = $article->isRedirect() ? 'redirect=no' : '';
- $wgOut->redirect( $this->mTitle->getFullUrl( $q ) );
+ if ( MWNamespace::getRestrictionLevels( $this->mTitle->getNamespace() ) === [ '' ] ) {
+ throw new ErrorPageError( 'protect-badnamespace-title', 'protect-badnamespace-text' );
+ }
+
+ if ( $this->mContext->getRequest()->wasPosted() ) {
+ if ( $this->save() ) {
+ $q = $this->mArticle->isRedirect() ? 'redirect=no' : '';
+ $this->mContext->getOutput()->redirect( $this->mTitle->getFullURL( $q ) );
}
} else {
$this->show();
}
}
+ /**
+ * Show the input form with optional error message
+ *
+ * @param string $err Error message or null if there's no error
+ */
function show( $err = null ) {
- global $wgOut, $wgUser;
-
- $wgOut->setRobotpolicy( 'noindex,nofollow' );
+ $out = $this->mContext->getOutput();
+ $out->setRobotPolicy( 'noindex,nofollow' );
+ $out->addBacklinkSubtitle( $this->mTitle );
+
+ if ( is_array( $err ) ) {
+ $out->wrapWikiMsg( "<p class='error'>\n$1\n</p>\n", $err );
+ } elseif ( is_string( $err ) ) {
+ $out->addHTML( "<p class='error'>{$err}</p>\n" );
+ }
- if( is_null( $this->mTitle ) ||
- !$this->mTitle->exists() ||
- $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
- $wgOut->showFatalError( wfMsg( 'badarticleerror' ) );
+ if ( $this->mTitle->getRestrictionTypes() === [] ) {
+ // No restriction types available for the current title
+ // this might happen if an extension alters the available types
+ $out->setPageTitle( $this->mContext->msg(
+ 'protect-norestrictiontypes-title',
+ $this->mTitle->getPrefixedText()
+ ) );
+ $out->addWikiText( $this->mContext->msg( 'protect-norestrictiontypes-text' )->plain() );
+
+ // Show the log in case protection was possible once
+ $this->showLogExtract( $out );
+ // return as there isn't anything else we can do
return;
}
list( $cascadeSources, /* $restrictions */ ) = $this->mTitle->getCascadeProtectionSources();
-
- if ( "" != $err ) {
- $wgOut->setSubtitle( wfMsgHtml( 'formerror' ) );
- $wgOut->addHTML( "<p class='error'>{$err}</p>\n" );
- }
-
- if ( $cascadeSources && count($cascadeSources) > 0 ) {
+ if ( $cascadeSources && count( $cascadeSources ) > 0 ) {
$titles = '';
foreach ( $cascadeSources as $title ) {
$titles .= '* [[:' . $title->getPrefixedText() . "]]\n";
}
- $notice = wfMsgExt( 'protect-cascadeon', array('parsemag'), count($cascadeSources) ) . "\r\n$titles";
-
- $wgOut->addWikiText( $notice );
+ /** @todo FIXME: i18n issue, should use formatted number. */
+ $out->wrapWikiMsg(
+ "<div id=\"mw-protect-cascadeon\">\n$1\n" . $titles . "</div>",
+ [ 'protect-cascadeon', count( $cascadeSources ) ]
+ );
}
- $wgOut->setPageTitle( wfMsg( 'confirmprotect' ) );
- $wgOut->setSubtitle( wfMsg( 'protectsub', $this->mTitle->getPrefixedText() ) );
-
# Show an appropriate message if the user isn't allowed or able to change
# the protection settings at this time
- if( $this->disabled ) {
- if( $wgUser->isAllowed( 'protect' ) ) {
- if( $wgUser->isBlocked() ) {
- # Blocked
- $message = 'protect-locked-blocked';
- } else {
- # Database lock
- $message = 'protect-locked-dblock';
- }
- } else {
- # Permission error
- $message = 'protect-locked-access';
- }
+ if ( $this->disabled ) {
+ $out->setPageTitle(
+ $this->mContext->msg( 'protect-title-notallowed',
+ $this->mTitle->getPrefixedText() )
+ );
+ $out->addWikiText( $out->formatPermissionsErrorMessage( $this->mPermErrors, 'protect' ) );
} else {
- $message = 'protect-text';
+ $out->setPageTitle( $this->mContext->msg( 'protect-title', $this->mTitle->getPrefixedText() ) );
+ $out->addWikiMsg( 'protect-text',
+ wfEscapeWikiText( $this->mTitle->getPrefixedText() ) );
}
- $wgOut->addWikiText( wfMsg( $message, wfEscapeWikiText( $this->mTitle->getPrefixedText() ) ) );
- $wgOut->addHTML( $this->buildForm() );
-
- $this->showLogExtract( $wgOut );
+ $out->addHTML( $this->buildForm() );
+ $this->showLogExtract( $out );
}
+ /**
+ * Save submitted protection form
+ *
+ * @return bool Success
+ */
function save() {
- global $wgRequest, $wgUser, $wgOut;
-
- if( $this->disabled ) {
+ # Permission check!
+ if ( $this->disabled ) {
$this->show();
return false;
}
- $token = $wgRequest->getVal( 'wpEditToken' );
- if( !$wgUser->matchEditToken( $token ) ) {
- $this->show( wfMsg( 'sessionfailure' ) );
+ $request = $this->mContext->getRequest();
+ $user = $this->mContext->getUser();
+ $out = $this->mContext->getOutput();
+ $token = $request->getVal( 'wpEditToken' );
+ if ( !$user->matchEditToken( $token, [ 'protect', $this->mTitle->getPrefixedDBkey() ] ) ) {
+ $this->show( [ 'sessionfailure' ] );
return false;
}
- if ( strlen( $this->mExpiry ) == 0 ) {
- $this->mExpiry = 'infinite';
+ # Create reason string. Use list and/or custom string.
+ $reasonstr = $this->mReasonSelection;
+ if ( $reasonstr != 'other' && $this->mReason != '' ) {
+ // Entry from drop down menu + additional comment
+ $reasonstr .= $this->mContext->msg( 'colon-separator' )->text() . $this->mReason;
+ } elseif ( $reasonstr == 'other' ) {
+ $reasonstr = $this->mReason;
}
-
- if ( $this->mExpiry == 'infinite' || $this->mExpiry == 'indefinite' ) {
- $expiry = Block::infinity();
- } else {
- # Convert GNU-style date, on error returns -1 for PHP <5.1 and false for PHP >=5.1
- $expiry = strtotime( $this->mExpiry );
-
- if ( $expiry < 0 || $expiry === false ) {
- $this->show( wfMsg( 'protect_expiry_invalid' ) );
+ $expiry = [];
+ foreach ( $this->mApplicableTypes as $action ) {
+ $expiry[$action] = $this->getExpiry( $action );
+ if ( empty( $this->mRestrictions[$action] ) ) {
+ continue; // unprotected
+ }
+ if ( !$expiry[$action] ) {
+ $this->show( [ 'protect_expiry_invalid' ] );
return false;
}
-
- $expiry = wfTimestamp( TS_MW, $expiry );
-
- if ( $expiry < wfTimestampNow() ) {
- $this->show( wfMsg( 'protect_expiry_old' ) );
+ if ( $expiry[$action] < wfTimestampNow() ) {
+ $this->show( [ 'protect_expiry_old' ] );
return false;
}
+ }
+ $this->mCascade = $request->getBool( 'mwProtect-cascade' );
+
+ $status = $this->mArticle->doUpdateRestrictions(
+ $this->mRestrictions,
+ $expiry,
+ $this->mCascade,
+ $reasonstr,
+ $user
+ );
+
+ if ( !$status->isOK() ) {
+ $this->show( $out->parseInline( $status->getWikiText() ) );
+ return false;
}
- $ok = $this->mArticle->updateRestrictions( $this->mRestrictions, $this->mReason, $this->mCascade, $expiry );
- if( !$ok ) {
- throw new FatalError( "Unknown error at restriction save time." );
+ /**
+ * Give extensions a change to handle added form items
+ *
+ * @since 1.19 you can (and you should) return false to abort saving;
+ * you can also return an array of message name and its parameters
+ */
+ $errorMsg = '';
+ if ( !Hooks::run( 'ProtectionForm::save', [ $this->mArticle, &$errorMsg, $reasonstr ] ) ) {
+ if ( $errorMsg == '' ) {
+ $errorMsg = [ 'hookaborted' ];
+ }
}
-
- if( $wgRequest->getCheck( 'mwProtectWatch' ) ) {
- $this->mArticle->doWatch();
- } elseif( $this->mTitle->userIsWatching() ) {
- $this->mArticle->doUnwatch();
+ if ( $errorMsg != '' ) {
+ $this->show( $errorMsg );
+ return false;
}
-
- return $ok;
+
+ WatchAction::doWatchOrUnwatch( $request->getCheck( 'mwProtectWatch' ), $this->mTitle, $user );
+
+ return true;
}
+ /**
+ * Build the input form
+ *
+ * @return string HTML form
+ */
function buildForm() {
- global $wgUser;
-
+ $context = $this->mContext;
+ $user = $context->getUser();
+ $output = $context->getOutput();
+ $lang = $context->getLanguage();
+ $cascadingRestrictionLevels = $context->getConfig()->get( 'CascadingRestrictionLevels' );
$out = '';
- if( !$this->disabled ) {
- $out .= $this->buildScript();
- // The submission needs to reenable the move permission selector
- // if it's in locked mode, or some browsers won't submit the data.
- $out .= wfOpenElement( 'form', array(
- 'id' => 'mw-Protect-Form',
- 'action' => $this->mTitle->getLocalUrl( 'action=protect' ),
- 'method' => 'post',
- 'onsubmit' => 'protectEnable(true)' ) );
-
- $out .= wfElement( 'input', array(
- 'type' => 'hidden',
- 'name' => 'wpEditToken',
- 'value' => $wgUser->editToken() ) );
- }
-
- $out .= "<table id='mwProtectSet'>";
- $out .= "<tbody>";
- $out .= "<tr>\n";
- foreach( $this->mRestrictions as $action => $required ) {
- /* Not all languages have V_x <-> N_x relation */
- $out .= "<th>" . wfMsgHtml( 'restriction-' . $action ) . "</th>\n";
- }
- $out .= "</tr>\n";
- $out .= "<tr>\n";
- foreach( $this->mRestrictions as $action => $selected ) {
- $out .= "<td>\n";
- $out .= $this->buildSelector( $action, $selected );
- $out .= "</td>\n";
+ if ( !$this->disabled ) {
+ $output->addModules( 'mediawiki.legacy.protect' );
+ $output->addJsConfigVars( 'wgCascadeableLevels', $cascadingRestrictionLevels );
+ $out .= Xml::openElement( 'form', [ 'method' => 'post',
+ 'action' => $this->mTitle->getLocalURL( 'action=protect' ),
+ 'id' => 'mw-Protect-Form' ] );
}
- $out .= "</tr>\n";
-
- // JavaScript will add another row with a value-chaining checkbox
- $out .= "</tbody>\n";
- $out .= "</table>\n";
+ $out .= Xml::openElement( 'fieldset' ) .
+ Xml::element( 'legend', null, $context->msg( 'protect-legend' )->text() ) .
+ Xml::openElement( 'table', [ 'id' => 'mwProtectSet' ] ) .
+ Xml::openElement( 'tbody' );
+
+ $scExpiryOptions = wfMessage( 'protect-expiry-options' )->inContentLanguage()->text();
+ $showProtectOptions = $scExpiryOptions !== '-' && !$this->disabled;
+
+ // Not all languages have V_x <-> N_x relation
+ foreach ( $this->mRestrictions as $action => $selected ) {
+ // Messages:
+ // restriction-edit, restriction-move, restriction-create, restriction-upload
+ $msg = $context->msg( 'restriction-' . $action );
+ $out .= "<tr><td>" .
+ Xml::openElement( 'fieldset' ) .
+ Xml::element( 'legend', null, $msg->exists() ? $msg->text() : $action ) .
+ Xml::openElement( 'table', [ 'id' => "mw-protect-table-$action" ] ) .
+ "<tr><td>" . $this->buildSelector( $action, $selected ) . "</td></tr><tr><td>";
+
+ $mProtectexpiry = Xml::label(
+ $context->msg( 'protectexpiry' )->text(),
+ "mwProtectExpirySelection-$action"
+ );
+ $mProtectother = Xml::label(
+ $context->msg( 'protect-othertime' )->text(),
+ "mwProtect-$action-expires"
+ );
+
+ $expiryFormOptions = new XmlSelect(
+ "wpProtectExpirySelection-$action",
+ "mwProtectExpirySelection-$action",
+ $this->mExpirySelection[$action]
+ );
+ $expiryFormOptions->setAttribute( 'tabindex', '2' );
+ if ( $this->disabled ) {
+ $expiryFormOptions->setAttribute( 'disabled', 'disabled' );
+ }
- $out .= "<table>\n";
- $out .= "<tbody>\n";
+ if ( $this->mExistingExpiry[$action] ) {
+ if ( $this->mExistingExpiry[$action] == 'infinity' ) {
+ $existingExpiryMessage = $context->msg( 'protect-existing-expiry-infinity' );
+ } else {
+ $timestamp = $lang->userTimeAndDate( $this->mExistingExpiry[$action], $user );
+ $d = $lang->userDate( $this->mExistingExpiry[$action], $user );
+ $t = $lang->userTime( $this->mExistingExpiry[$action], $user );
+ $existingExpiryMessage = $context->msg(
+ 'protect-existing-expiry',
+ $timestamp,
+ $d,
+ $t
+ );
+ }
+ $expiryFormOptions->addOption( $existingExpiryMessage->text(), 'existing' );
+ }
- global $wgEnableCascadingProtection;
- if( $wgEnableCascadingProtection )
- $out .= '<tr><td></td><td>' . $this->buildCascadeInput() . "</td></tr>\n";
+ $expiryFormOptions->addOption(
+ $context->msg( 'protect-othertime-op' )->text(),
+ 'othertime'
+ );
+ foreach ( explode( ',', $scExpiryOptions ) as $option ) {
+ if ( strpos( $option, ":" ) === false ) {
+ $show = $value = $option;
+ } else {
+ list( $show, $value ) = explode( ":", $option );
+ }
+ $expiryFormOptions->addOption( $show, htmlspecialchars( $value ) );
+ }
+ # Add expiry dropdown
+ if ( $showProtectOptions && !$this->disabled ) {
+ $out .= "
+ <table><tr>
+ <td class='mw-label'>
+ {$mProtectexpiry}
+ </td>
+ <td class='mw-input'>" .
+ $expiryFormOptions->getHTML() .
+ "</td>
+ </tr></table>";
+ }
+ # Add custom expiry field
+ $attribs = [ 'id' => "mwProtect-$action-expires" ] + $this->disabledAttrib;
+ $out .= "<table><tr>
+ <td class='mw-label'>" .
+ $mProtectother .
+ '</td>
+ <td class="mw-input">' .
+ Xml::input( "mwProtect-expiry-$action", 50, $this->mExpiry[$action], $attribs ) .
+ '</td>
+ </tr></table>';
+ $out .= "</td></tr>" .
+ Xml::closeElement( 'table' ) .
+ Xml::closeElement( 'fieldset' ) .
+ "</td></tr>";
+ }
+ # Give extensions a chance to add items to the form
+ Hooks::run( 'ProtectionForm::buildForm', [ $this->mArticle, &$out ] );
- $out .= $this->buildExpiryInput();
+ $out .= Xml::closeElement( 'tbody' ) . Xml::closeElement( 'table' );
- if( !$this->disabled ) {
- $out .= "<tr><td>" . $this->buildReasonInput() . "</td></tr>\n";
- $out .= "<tr><td></td><td>" . $this->buildWatchInput() . "</td></tr>\n";
- $out .= "<tr><td></td><td>" . $this->buildSubmit() . "</td></tr>\n";
+ // JavaScript will add another row with a value-chaining checkbox
+ if ( $this->mTitle->exists() ) {
+ $out .= Xml::openElement( 'table', [ 'id' => 'mw-protect-table2' ] ) .
+ Xml::openElement( 'tbody' );
+ $out .= '<tr>
+ <td></td>
+ <td class="mw-input">' .
+ Xml::checkLabel(
+ $context->msg( 'protect-cascade' )->text(),
+ 'mwProtect-cascade',
+ 'mwProtect-cascade',
+ $this->mCascade, $this->disabledAttrib
+ ) .
+ "</td>
+ </tr>\n";
+ $out .= Xml::closeElement( 'tbody' ) . Xml::closeElement( 'table' );
}
- $out .= "</tbody>\n";
- $out .= "</table>\n";
+ # Add manual and custom reason field/selects as well as submit
+ if ( !$this->disabled ) {
+ $mProtectreasonother = Xml::label(
+ $context->msg( 'protectcomment' )->text(),
+ 'wpProtectReasonSelection'
+ );
+
+ $mProtectreason = Xml::label(
+ $context->msg( 'protect-otherreason' )->text(),
+ 'mwProtect-reason'
+ );
+
+ $reasonDropDown = Xml::listDropDown( 'wpProtectReasonSelection',
+ wfMessage( 'protect-dropdown' )->inContentLanguage()->text(),
+ wfMessage( 'protect-otherreason-op' )->inContentLanguage()->text(),
+ $this->mReasonSelection,
+ 'mwProtect-reason', 4 );
+
+ $out .= Xml::openElement( 'table', [ 'id' => 'mw-protect-table3' ] ) .
+ Xml::openElement( 'tbody' );
+ $out .= "
+ <tr>
+ <td class='mw-label'>
+ {$mProtectreasonother}
+ </td>
+ <td class='mw-input'>
+ {$reasonDropDown}
+ </td>
+ </tr>
+ <tr>
+ <td class='mw-label'>
+ {$mProtectreason}
+ </td>
+ <td class='mw-input'>" .
+ Xml::input( 'mwProtect-reason', 60, $this->mReason, [ 'type' => 'text',
+ 'id' => 'mwProtect-reason', 'maxlength' => 180 ] ) .
+ // Limited maxlength as the database trims at 255 bytes and other texts
+ // chosen by dropdown menus on this page are also included in this database field.
+ // The byte limit of 180 bytes is enforced in javascript
+ "</td>
+ </tr>";
+ # Disallow watching is user is not logged in
+ if ( $user->isLoggedIn() ) {
+ $out .= "
+ <tr>
+ <td></td>
+ <td class='mw-input'>" .
+ Xml::checkLabel( $context->msg( 'watchthis' )->text(),
+ 'mwProtectWatch', 'mwProtectWatch',
+ $user->isWatched( $this->mTitle ) || $user->getOption( 'watchdefault' ) ) .
+ "</td>
+ </tr>";
+ }
+ $out .= "
+ <tr>
+ <td></td>
+ <td class='mw-submit'>" .
+ Xml::submitButton(
+ $context->msg( 'confirm' )->text(),
+ [ 'id' => 'mw-Protect-submit' ]
+ ) .
+ "</td>
+ </tr>\n";
+ $out .= Xml::closeElement( 'tbody' ) . Xml::closeElement( 'table' );
+ }
+ $out .= Xml::closeElement( 'fieldset' );
+
+ if ( $user->isAllowed( 'editinterface' ) ) {
+ $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
+ $link = $linkRenderer->makeKnownLink(
+ $context->msg( 'protect-dropdown' )->inContentLanguage()->getTitle(),
+ $context->msg( 'protect-edit-reasonlist' )->text(),
+ [],
+ [ 'action' => 'edit' ]
+ );
+ $out .= '<p class="mw-protect-editreasons">' . $link . '</p>';
+ }
if ( !$this->disabled ) {
- $out .= "</form>\n";
- $out .= $this->buildCleanupScript();
+ $out .= Html::hidden(
+ 'wpEditToken',
+ $user->getEditToken( [ 'protect', $this->mTitle->getPrefixedDBkey() ] )
+ );
+ $out .= Xml::closeElement( 'form' );
}
return $out;
}
+ /**
+ * Build protection level selector
+ *
+ * @param string $action Action to protect
+ * @param string $selected Current protection level
+ * @return string HTML fragment
+ */
function buildSelector( $action, $selected ) {
- global $wgRestrictionLevels;
+ // If the form is disabled, display all relevant levels. Otherwise,
+ // just show the ones this user can use.
+ $levels = MWNamespace::getRestrictionLevels( $this->mTitle->getNamespace(),
+ $this->disabled ? null : $this->mContext->getUser()
+ );
+
$id = 'mwProtect-level-' . $action;
- $attribs = array(
- 'id' => $id,
- 'name' => $id,
- 'size' => count( $wgRestrictionLevels ),
- 'onchange' => 'protectLevelsUpdate(this)',
- ) + $this->disabledAttrib;
-
- $out = wfOpenElement( 'select', $attribs );
- foreach( $wgRestrictionLevels as $key ) {
- $out .= Xml::option( $this->getOptionLabel( $key ), $key, $key == $selected );
+
+ $select = new XmlSelect( $id, $id, $selected );
+ $select->setAttribute( 'size', count( $levels ) );
+ if ( $this->disabled ) {
+ $select->setAttribute( 'disabled', 'disabled' );
}
- $out .= "</select>\n";
- return $out;
+
+ foreach ( $levels as $key ) {
+ $select->addOption( $this->getOptionLabel( $key ), $key );
+ }
+
+ return $select->getHTML();
}
/**
* @return string
*/
private function getOptionLabel( $permission ) {
- if( $permission == '' ) {
- return wfMsg( 'protect-default' );
+ if ( $permission == '' ) {
+ return $this->mContext->msg( 'protect-default' )->text();
} else {
- $key = "protect-level-{$permission}";
- $msg = wfMsg( $key );
- if( wfEmptyMsg( $key, $msg ) )
- $msg = wfMsg( 'protect-fallback', $permission );
- return $msg;
- }
- }
-
- function buildReasonInput() {
- $id = 'mwProtect-reason';
- return wfElement( 'label', array(
- 'id' => "$id-label",
- 'for' => $id ),
- wfMsg( 'protectcomment' ) ) .
- '</td><td>' .
- wfElement( 'input', array(
- 'size' => 60,
- 'name' => $id,
- 'id' => $id,
- 'value' => $this->mReason ) );
- }
-
- function buildCascadeInput() {
- $id = 'mwProtect-cascade';
- $ci = wfCheckLabel( wfMsg( 'protect-cascade' ), $id, $id, $this->mCascade, $this->disabledAttrib);
- return $ci;
- }
-
- function buildExpiryInput() {
- $attribs = array( 'id' => 'expires' ) + $this->disabledAttrib;
- return '<tr>'
- . '<td><label for="expires">' . wfMsgExt( 'protectexpiry', array( 'parseinline' ) ) . '</label></td>'
- . '<td>' . Xml::input( 'mwProtect-expiry', 60, $this->mExpiry, $attribs ) . '</td>'
- . '</tr>';
- }
-
- function buildWatchInput() {
- global $wgUser;
- return Xml::checkLabel(
- wfMsg( 'watchthis' ),
- 'mwProtectWatch',
- 'mwProtectWatch',
- $this->mTitle->userIsWatching() || $wgUser->getOption( 'watchdefault' )
- );
- }
-
- function buildSubmit() {
- return wfElement( 'input', array(
- 'id' => 'mw-Protect-submit',
- 'type' => 'submit',
- 'value' => wfMsg( 'confirm' ) ) );
- }
-
- function buildScript() {
- global $wgStylePath, $wgStyleVersion;
- return '<script type="text/javascript" src="' .
- htmlspecialchars( $wgStylePath . "/common/protect.js?$wgStyleVersion" ) .
- '"></script>';
- }
-
- function buildCleanupScript() {
- global $wgRestrictionLevels, $wgGroupPermissions;
- $script = 'var wgCascadeableLevels=';
- $CascadeableLevels = array();
- foreach( $wgRestrictionLevels as $key ) {
- if ( isset($wgGroupPermissions[$key]['protect']) && $wgGroupPermissions[$key]['protect'] ) {
- $CascadeableLevels[]="'" . wfEscapeJsString($key) . "'";
+ // Messages: protect-level-autoconfirmed, protect-level-sysop
+ $msg = $this->mContext->msg( "protect-level-{$permission}" );
+ if ( $msg->exists() ) {
+ return $msg->text();
}
+ return $this->mContext->msg( 'protect-fallback', $permission )->text();
}
- $script .= "[" . implode(',',$CascadeableLevels) . "];\n";
- $script .= 'protectInitialize("mwProtectSet","' . wfEscapeJsString( wfMsg( 'protect-unchain' ) ) . '")';
- return '<script type="text/javascript">' . $script . '</script>';
}
/**
- * @param OutputPage $out
+ * Show protection long extracts for this page
+ *
+ * @param OutputPage &$out
* @access private
*/
function showLogExtract( &$out ) {
# Show relevant lines from the protection log:
- $out->addHTML( "<h2>" . htmlspecialchars( LogPage::logName( 'protect' ) ) . "</h2>\n" );
- $logViewer = new LogViewer(
- new LogReader(
- new FauxRequest(
- array( 'page' => $this->mTitle->getPrefixedText(),
- 'type' => 'protect' ) ) ) );
- $logViewer->showList( $out );
+ $protectLogPage = new LogPage( 'protect' );
+ $out->addHTML( Xml::element( 'h2', null, $protectLogPage->getName()->text() ) );
+ LogEventsList::showLogExtract( $out, 'protect', $this->mTitle );
+ # Let extensions add other relevant log extracts
+ Hooks::run( 'ProtectionForm::showLogExtract', [ $this->mArticle, $out ] );
}
-
-}
\ No newline at end of file
+}