* 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 * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License along * 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\HookContainer\HookRunner; use MediaWiki\MediaWikiServices; use MediaWiki\Permissions\PermissionManager; /** * Handles the page protection UI and backend */ class ProtectionForm { /** @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 Article */ protected $mArticle; /** @var Title */ protected $mTitle; /** @var bool */ protected $disabled; /** @var array */ protected $disabledAttrib; /** @var IContextSource */ private $mContext; /** @var PermissionManager */ private $permManager; /** @var HookRunner */ private $hookRunner; public function __construct( Article $article ) { // Set instance variables. $this->mArticle = $article; $this->mTitle = $article->getTitle(); $this->mApplicableTypes = $this->mTitle->getRestrictionTypes(); $this->mContext = $article->getContext(); $services = MediaWikiServices::getInstance(); $this->permManager = $services->getPermissionManager(); $this->hookRunner = new HookRunner( $services->getHookContainer() ); // Check if the form should be disabled. // If it is, the form will be available in read-only to show levels. $this->mPermErrors = $this->permManager->getPermissionErrors( 'protect', $this->mContext->getUser(), $this->mTitle, $this->mContext->getRequest()->wasPosted() ? PermissionManager::RIGOR_SECURE : PermissionManager::RIGOR_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. */ private function loadData() { $levels = $this->permManager->getNamespaceRestrictionLevels( $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 ); foreach ( $this->mApplicableTypes as $action ) { // @todo FIXME: This form currently requires individual selections, // but the db allows multiples separated by commas. // 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 { // 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; } } } /** * 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 */ private 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 */ public function execute() { if ( $this->permManager->getNamespaceRestrictionLevels( $this->mTitle->getNamespace() ) === [ '' ] ) { throw new ErrorPageError( 'protect-badnamespace-title', 'protect-badnamespace-text' ); } if ( $this->mContext->getRequest()->wasPosted() ) { if ( $this->save() ) { $q = $this->mArticle->getPage()->isRedirect() ? 'redirect=no' : ''; $this->mContext->getOutput()->redirect( $this->mTitle->getFullURL( $q ) ); } } else { $this->show(); } } /** * Show the input form with optional error message * * @param string|string[]|null $err Error message or null if there's no error */ private function show( $err = null ) { $out = $this->mContext->getOutput(); $out->setRobotPolicy( 'noindex,nofollow' ); $out->addBacklinkSubtitle( $this->mTitle ); if ( is_array( $err ) ) { $out->wrapWikiMsg( "
\n$1\n
\n", $err ); } elseif ( is_string( $err ) ) { $out->addHTML( "
{$err}
\n" ); } 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->addWikiTextAsInterface( $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 ( $cascadeSources && count( $cascadeSources ) > 0 ) { $titles = ''; foreach ( $cascadeSources as $title ) { $titles .= '* [[:' . $title->getPrefixedText() . "]]\n"; } /** @todo FIXME: i18n issue, should use formatted number. */ $out->wrapWikiMsg( "
\n$1\n" . $titles . "
", [ 'protect-cascadeon', count( $cascadeSources ) ] ); } # Show an appropriate message if the user isn't allowed or able to change # the protection settings at this time if ( $this->disabled ) { $out->setPageTitle( $this->mContext->msg( 'protect-title-notallowed', $this->mTitle->getPrefixedText() ) ); $out->addWikiTextAsInterface( $out->formatPermissionsErrorMessage( $this->mPermErrors, 'protect' ) ); } else { $out->setPageTitle( $this->mContext->msg( 'protect-title', $this->mTitle->getPrefixedText() ) ); $out->addWikiMsg( 'protect-text', wfEscapeWikiText( $this->mTitle->getPrefixedText() ) ); } $out->addHTML( $this->buildForm() ); $this->showLogExtract( $out ); } /** * Save submitted protection form * * @return bool Success */ private function save() { # Permission check! if ( $this->disabled ) { $this->show(); return false; } $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; } # 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; } $expiry = []; foreach ( $this->mApplicableTypes as $action ) { $expiry[$action] = $this->getExpiry( $action ); if ( empty( $this->mRestrictions[$action] ) ) { // unprotected continue; } if ( !$expiry[$action] ) { $this->show( [ 'protect_expiry_invalid' ] ); return false; } if ( $expiry[$action] < wfTimestampNow() ) { $this->show( [ 'protect_expiry_old' ] ); return false; } } $this->mCascade = $request->getBool( 'mwProtect-cascade' ); $status = $this->mArticle->getPage()->doUpdateRestrictions( $this->mRestrictions, $expiry, $this->mCascade, $reasonstr, $user ); if ( !$status->isOK() ) { $this->show( $out->parseInlineAsInterface( $status->getWikiText( false, false, $this->mContext->getLanguage() ) ) ); return false; } /** * 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 ( !$this->hookRunner->onProtectionForm__save( $this->mArticle, $errorMsg, $reasonstr ) ) { if ( $errorMsg == '' ) { $errorMsg = [ 'hookaborted' ]; } } if ( $errorMsg != '' ) { $this->show( $errorMsg ); return false; } WatchAction::doWatchOrUnwatch( $request->getCheck( 'mwProtectWatch' ), $this->mTitle, $user ); return true; } /** * Build the input form * * @return string HTML form */ private function buildForm() { $context = $this->mContext; $user = $context->getUser(); $output = $context->getOutput(); $lang = $context->getLanguage(); $out = ''; if ( !$this->disabled ) { $output->addModules( 'mediawiki.legacy.protect' ); $out .= Xml::openElement( 'form', [ 'method' => 'post', 'action' => $this->mTitle->getLocalURL( 'action=protect' ), 'id' => 'mw-Protect-Form' ] ); } $out .= Xml::openElement( 'fieldset' ) . Xml::element( 'legend', null, $context->msg( 'protect-legend' )->text() ) . Xml::openElement( 'table', [ 'id' => 'mwProtectSet' ] ) . Xml::openElement( 'tbody' ); $expiryOptionsMsg = wfMessage( 'protect-expiry-options' )->inContentLanguage()->text(); $showProtectOptions = $expiryOptionsMsg !== '-' && !$this->disabled; $expiryOptions = XmlSelect::parseOptionsMessage( $expiryOptionsMsg ); // 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 .= "" . Xml::openElement( 'fieldset' ) . Xml::element( 'legend', null, $msg->exists() ? $msg->text() : $action ) . Xml::openElement( 'table', [ 'id' => "mw-protect-table-$action" ] ) . "" . $this->buildSelector( $action, $selected ) . ""; $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' ); } 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' ); } $expiryFormOptions->addOption( $context->msg( 'protect-othertime-op' )->text(), 'othertime' ); $expiryFormOptions->addOptions( $expiryOptions ); # Add expiry dropdown if ( $showProtectOptions && !$this->disabled ) { $out .= "
{$mProtectexpiry} " . $expiryFormOptions->getHTML() . "
"; } # Add custom expiry field $attribs = [ 'id' => "mwProtect-$action-expires" ] + $this->disabledAttrib; $out .= "
" . $mProtectother . ' ' . Xml::input( "mwProtect-expiry-$action", 50, $this->mExpiry[$action], $attribs ) . '
'; $out .= "" . Xml::closeElement( 'table' ) . Xml::closeElement( 'fieldset' ) . ""; } # Give extensions a chance to add items to the form $this->hookRunner->onProtectionForm__buildForm( $this->mArticle, $out ); $out .= Xml::closeElement( 'tbody' ) . Xml::closeElement( 'table' ); // 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 .= ' ' . Xml::checkLabel( $context->msg( 'protect-cascade' )->text(), 'mwProtect-cascade', 'mwProtect-cascade', $this->mCascade, $this->disabledAttrib ) . " \n"; $out .= Xml::closeElement( 'tbody' ) . Xml::closeElement( 'table' ); } # 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 ); // HTML maxlength uses "UTF-16 code units", which means that characters outside BMP // (e.g. emojis) count for two each. This limit is overridden in JS to instead count // Unicode codepoints. // Subtract arbitrary 75 to leave some space for the autogenerated null edit's summary // and other texts chosen by dropdown menus on this page. $maxlength = CommentStore::COMMENT_CHARACTER_LIMIT - 75; $out .= Xml::openElement( 'table', [ 'id' => 'mw-protect-table3' ] ) . Xml::openElement( 'tbody' ); $out .= " {$mProtectreasonother} {$reasonDropDown} {$mProtectreason} " . Xml::input( 'mwProtect-reason', 60, $this->mReason, [ 'type' => 'text', 'id' => 'mwProtect-reason', 'maxlength' => $maxlength ] ) . " "; # Disallow watching is user is not logged in if ( $user->isLoggedIn() ) { $out .= " " . Xml::checkLabel( $context->msg( 'watchthis' )->text(), 'mwProtectWatch', 'mwProtectWatch', $user->isWatched( $this->mTitle ) || $user->getOption( 'watchdefault' ) ) . " "; } $out .= " " . Xml::submitButton( $context->msg( 'confirm' )->text(), [ 'id' => 'mw-Protect-submit' ] ) . " \n"; $out .= Xml::closeElement( 'tbody' ) . Xml::closeElement( 'table' ); } $out .= Xml::closeElement( 'fieldset' ); if ( $this->permManager->userHasRight( $user, 'editinterface' ) ) { $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer(); $link = $linkRenderer->makeKnownLink( $context->msg( 'protect-dropdown' )->inContentLanguage()->getTitle(), $context->msg( 'protect-edit-reasonlist' )->text(), [], [ 'action' => 'edit' ] ); $out .= '

' . $link . '

'; } if ( !$this->disabled ) { $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 */ private function buildSelector( $action, $selected ) { // If the form is disabled, display all relevant levels. Otherwise, // just show the ones this user can use. $levels = $this->permManager->getNamespaceRestrictionLevels( $this->mTitle->getNamespace(), $this->disabled ? null : $this->mContext->getUser() ); $id = 'mwProtect-level-' . $action; $select = new XmlSelect( $id, $id, $selected ); $select->setAttribute( 'size', count( $levels ) ); if ( $this->disabled ) { $select->setAttribute( 'disabled', 'disabled' ); } foreach ( $levels as $key ) { $select->addOption( $this->getOptionLabel( $key ), $key ); } return $select->getHTML(); } /** * Prepare the label for a protection selector option * * @param string $permission Permission required * @return string */ private function getOptionLabel( $permission ) { if ( $permission == '' ) { return $this->mContext->msg( 'protect-default' )->text(); } else { // 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(); } } /** * Show protection long extracts for this page * * @param OutputPage $out */ private function showLogExtract( OutputPage $out ) { # Show relevant lines from the protection log: $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 $this->hookRunner->onProtectionForm__showLogExtract( $this->mArticle, $out ); } }